Google Cloud Vmware Engine V1 Client - Class UpdateExternalAddressRequest (1.1.0)

Reference documentation and code samples for the Google Cloud Vmware Engine V1 Client class UpdateExternalAddressRequest.

Request message for VmwareEngine.UpdateExternalAddress

Generated from protobuf message google.cloud.vmwareengine.v1.UpdateExternalAddressRequest

Namespace

Google \ Cloud \ VmwareEngine \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.
↳ update_mask Google\Protobuf\FieldMask

Required. Field mask is used to specify the fields to be overwritten in the ExternalAddress resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten.
↳ external_address Google\Cloud\VmwareEngine\V1\ExternalAddress

Required. External IP address description.
↳ 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 will know 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 if the 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).

getUpdateMask

Required. Field mask is used to specify the fields to be overwritten in the ExternalAddress resource by the update.

The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten.

Returns
Type Description
Google\Protobuf\FieldMask|null

hasUpdateMask

clearUpdateMask

setUpdateMask

Required. Field mask is used to specify the fields to be overwritten in the ExternalAddress resource by the update.

The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten.

Parameter
Name Description
var Google\Protobuf\FieldMask
Returns
Type Description
$this

getExternalAddress

Required. External IP address description.

Returns
Type Description
Google\Cloud\VmwareEngine\V1\ExternalAddress|null

hasExternalAddress

clearExternalAddress

setExternalAddress

Required. External IP address description.

Parameter
Name Description
var Google\Cloud\VmwareEngine\V1\ExternalAddress
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 will know 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 if the 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
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 will know 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 if the 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
Name Description
var string
Returns
Type Description
$this

static::build

Parameters
Name Description
externalAddress Google\Cloud\VmwareEngine\V1\ExternalAddress

Required. External IP address description.
updateMask Google\Protobuf\FieldMask

Required. Field mask is used to specify the fields to be overwritten in the ExternalAddress resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten.
Returns
Type Description
Google\Cloud\VmwareEngine\V1\UpdateExternalAddressRequest