Compute V1 Client - Class PatchSubnetworkRequest (1.13.0)

Reference documentation and code samples for the Compute V1 Client class PatchSubnetworkRequest.

A request message for Subnetworks.Patch. See the method description for details.

Generated from protobuf message google.cloud.compute.v1.PatchSubnetworkRequest

Namespace

Google \ Cloud \ Compute \ V1

Methods

__construct

Constructor.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

↳ drain_timeout_seconds int

The drain timeout specifies the upper bound in seconds on the amount of time allowed to drain connections from the current ACTIVE subnetwork to the current BACKUP subnetwork. The drain timeout is only applicable when the following conditions are true: - the subnetwork being patched has purpose = INTERNAL_HTTPS_LOAD_BALANCER - the subnetwork being patched has role = BACKUP - the patch request is setting the role to ACTIVE. Note that after this patch operation the roles of the ACTIVE and BACKUP subnetworks will be swapped.

↳ project string

Project ID for this request.

↳ region string

Name of the region scoping this request.

↳ request_id string

An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. 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 if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally 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).

↳ subnetwork string

Name of the Subnetwork resource to patch.

↳ subnetwork_resource Google\Cloud\Compute\V1\Subnetwork

The body resource for this request

getDrainTimeoutSeconds

The drain timeout specifies the upper bound in seconds on the amount of time allowed to drain connections from the current ACTIVE subnetwork to the current BACKUP subnetwork. The drain timeout is only applicable when the following conditions are true: - the subnetwork being patched has purpose = INTERNAL_HTTPS_LOAD_BALANCER - the subnetwork being patched has role = BACKUP - the patch request is setting the role to ACTIVE. Note that after this patch operation the roles of the ACTIVE and BACKUP subnetworks will be swapped.

Returns
TypeDescription
int

hasDrainTimeoutSeconds

clearDrainTimeoutSeconds

setDrainTimeoutSeconds

The drain timeout specifies the upper bound in seconds on the amount of time allowed to drain connections from the current ACTIVE subnetwork to the current BACKUP subnetwork. The drain timeout is only applicable when the following conditions are true: - the subnetwork being patched has purpose = INTERNAL_HTTPS_LOAD_BALANCER - the subnetwork being patched has role = BACKUP - the patch request is setting the role to ACTIVE. Note that after this patch operation the roles of the ACTIVE and BACKUP subnetworks will be swapped.

Parameter
NameDescription
var int
Returns
TypeDescription
$this

getProject

Project ID for this request.

Returns
TypeDescription
string

setProject

Project ID for this request.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getRegion

Name of the region scoping this request.

Returns
TypeDescription
string

setRegion

Name of the region scoping this request.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getRequestId

An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. 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 if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally 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

hasRequestId

clearRequestId

setRequestId

An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. 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 if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally 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

getSubnetwork

Name of the Subnetwork resource to patch.

Returns
TypeDescription
string

setSubnetwork

Name of the Subnetwork resource to patch.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getSubnetworkResource

The body resource for this request

Returns
TypeDescription
Google\Cloud\Compute\V1\Subnetwork|null

hasSubnetworkResource

clearSubnetworkResource

setSubnetworkResource

The body resource for this request

Parameter
NameDescription
var Google\Cloud\Compute\V1\Subnetwork
Returns
TypeDescription
$this

static::build

Parameters
NameDescription
project string

Project ID for this request.

region string

Name of the region scoping this request.

subnetwork string

Name of the Subnetwork resource to patch.

subnetworkResource Google\Cloud\Compute\V1\Subnetwork

The body resource for this request

Returns
TypeDescription
Google\Cloud\Compute\V1\PatchSubnetworkRequest