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

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
Name Description
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 request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server knows to ignore the request if it has already been completed. The server guarantees that a request doesn't result in creation of duplicate commitments for at least 60 minutes. 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
Type Description
string

setParent

Required. The parent resource.

Parameter
Name Description
var string
Returns
Type Description
$this

getSpokeId

Required. Unique id for the spoke to create.

Returns
Type Description
string

setSpokeId

Required. Unique id for the spoke to create.

Parameter
Name Description
var string
Returns
Type Description
$this

getSpoke

Required. The initial values for a new spoke.

Returns
Type Description
Google\Cloud\NetworkConnectivity\V1\Spoke|null

hasSpoke

clearSpoke

setSpoke

Required. The initial values for a new spoke.

Parameter
Name Description
var Google\Cloud\NetworkConnectivity\V1\Spoke
Returns
Type Description
$this

getRequestId

Optional. A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server knows to ignore the request if it has already been completed. The server guarantees that a request doesn't result in creation of duplicate commitments for at least 60 minutes.

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
Type Description
string

setRequestId

Optional. A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server knows to ignore the request if it has already been completed. The server guarantees that a request doesn't result in creation of duplicate commitments for at least 60 minutes.

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
Name Description
var string
Returns
Type Description
$this

static::build

Parameters
Name Description
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
Type Description
Google\Cloud\NetworkConnectivity\V1\CreateSpokeRequest