Google Cloud Memorystore V1beta Client - Class UpdateInstanceRequest (0.1.0)

Beta

This library is covered by the Pre-GA Offerings Terms of the Terms of Service. Pre-GA libraries might have limited support, and changes to pre-GA libraries might not be compatible with other pre-GA versions. For more information, see the launch stage descriptions.

Reference documentation and code samples for the Google Cloud Memorystore V1beta Client class UpdateInstanceRequest.

Request message for UpdateInstance.

Generated from protobuf message google.cloud.memorystore.v1beta.UpdateInstanceRequest

Namespace

Google \ Cloud \ Memorystore \ V1beta

Methods

__construct

Constructor.

Parameters
Name	Description
data	array Optional. Data for populating the Message object.
↳ update_mask	Google\Protobuf\FieldMask Optional. The list of fields to be updated on the instance. At least one field must be specified.
↳ instance	Instance Required. The instance to update.
↳ request_id	string Optional. 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. The server will guarantee that for at least 60 minutes since 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 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).

getUpdateMask

Optional. The list of fields to be updated on the instance. At least one field must be specified.

Returns
Type	Description
Google\Protobuf\FieldMask|null

hasUpdateMask

clearUpdateMask

setUpdateMask

Optional. The list of fields to be updated on the instance. At least one field must be specified.

Parameter
Name	Description
var	Google\Protobuf\FieldMask

Returns
Type	Description
$this

getInstance

Required. The instance to update.

Returns
Type	Description
Instance|null

hasInstance

clearInstance

setInstance

Required. The instance to update.

Parameter
Name	Description
var	Instance

Returns
Type	Description
$this

getRequestId

Optional. 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. The server will guarantee that for at least 60 minutes since 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 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
Type	Description
string

setRequestId

Optional. 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. The server will guarantee that for at least 60 minutes since 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 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
Name	Description
var	string

Returns
Type	Description
$this

static::build

Parameters
Name	Description
instance	Instance Required. The instance to update.
updateMask	Google\Protobuf\FieldMask Optional. The list of fields to be updated on the instance. At least one field must be specified.

Returns
Type	Description
UpdateInstanceRequest