Google Cloud Network Connectivity V1 Client - Class RejectHubSpokeRequest (1.4.2)

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

The request for HubService.RejectHubSpoke.

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

Namespace

Google \ Cloud \ NetworkConnectivity \ V1

Methods

__construct

Constructor.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

↳ name string

Required. The name of the hub from which to reject the spoke.

↳ spoke_uri string

Required. The URI of the spoke to reject from the hub.

↳ 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).

↳ details string

Optional. Additional information provided by the hub administrator.

getName

Required. The name of the hub from which to reject the spoke.

Returns
TypeDescription
string

setName

Required. The name of the hub from which to reject the spoke.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getSpokeUri

Required. The URI of the spoke to reject from the hub.

Returns
TypeDescription
string

setSpokeUri

Required. The URI of the spoke to reject from the hub.

Parameter
NameDescription
var string
Returns
TypeDescription
$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
TypeDescription
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
NameDescription
var string
Returns
TypeDescription
$this

getDetails

Optional. Additional information provided by the hub administrator.

Returns
TypeDescription
string

setDetails

Optional. Additional information provided by the hub administrator.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

static::build

Parameters
NameDescription
name string

Required. The name of the hub from which to reject the spoke. Please see Google\Cloud\NetworkConnectivity\V1\HubServiceClient::hubName() for help formatting this field.

spokeUri string

Required. The URI of the spoke to reject from the hub. Please see Google\Cloud\NetworkConnectivity\V1\HubServiceClient::spokeName() for help formatting this field.

Returns
TypeDescription
Google\Cloud\NetworkConnectivity\V1\RejectHubSpokeRequest