Google Cloud Network Connectivity V1 Client - Class CreateSpokeRequest (1.3.0)

Reference documentation and code samples for the Google Cloud Network Connectivity V1 Client class CreateSpokeRequest.

The request for HubService.CreateSpoke.

Generated from protobuf message google.cloud.networkconnectivity.v1.CreateSpokeRequest

Namespace

Google \ Cloud \ NetworkConnectivity \ V1

Methods

__construct

Constructor.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

↳ parent string

Required. The parent resource.

↳ spoke_id string

Required. Unique id for the spoke to create.

↳ spoke Google\Cloud\NetworkConnectivity\V1\Spoke

Required. The initial values for a new spoke.

↳ request_id string

Optional. A unique request ID (optional). If you specify this ID, you can use it in cases when you need to retry your request. When you need to retry, this ID lets the server know that it can ignore the request if it has already been completed. The server guarantees that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check to see whether the original operation was received. If it was, the server ignores the second request. This behavior prevents clients from mistakenly creating duplicate commitments. The request ID must be a valid UUID, with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

getParent

Required. The parent resource.

Returns
TypeDescription
string

setParent

Required. The parent resource.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getSpokeId

Required. Unique id for the spoke to create.

Returns
TypeDescription
string

setSpokeId

Required. Unique id for the spoke to create.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getSpoke

Required. The initial values for a new spoke.

Returns
TypeDescription
Google\Cloud\NetworkConnectivity\V1\Spoke|null

hasSpoke

clearSpoke

setSpoke

Required. The initial values for a new spoke.

Parameter
NameDescription
var Google\Cloud\NetworkConnectivity\V1\Spoke
Returns
TypeDescription
$this

getRequestId

Optional. A unique request ID (optional). If you specify this ID, you can use it in cases when you need to retry your request. When you need to retry, this ID lets the server know that it can ignore the request if it has already been completed. The server guarantees that for at least 60 minutes after the first request.

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check to see whether the original operation was received. If it was, the server ignores the second request. This behavior prevents clients from mistakenly creating duplicate commitments. The request ID must be a valid UUID, with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Returns
TypeDescription
string

setRequestId

Optional. A unique request ID (optional). If you specify this ID, you can use it in cases when you need to retry your request. When you need to retry, this ID lets the server know that it can ignore the request if it has already been completed. The server guarantees that for at least 60 minutes after the first request.

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check to see whether the original operation was received. If it was, the server ignores the second request. This behavior prevents clients from mistakenly creating duplicate commitments. The request ID must be a valid UUID, with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Parameter
NameDescription
var string
Returns
TypeDescription
$this

static::build

Parameters
NameDescription
parent string

Required. The parent resource. Please see Google\Cloud\NetworkConnectivity\V1\HubServiceClient::locationName() for help formatting this field.

spoke Google\Cloud\NetworkConnectivity\V1\Spoke

Required. The initial values for a new spoke.

spokeId string

Required. Unique id for the spoke to create.

Returns
TypeDescription
Google\Cloud\NetworkConnectivity\V1\CreateSpokeRequest