Google Cloud Lustre V1 Client - Class UpdateMirrorRequest (0.6.0)

0.6.0 (latest) 0.4.0 0.3.2 0.2.0 0.1.1

Reference documentation and code samples for the Google Cloud Lustre V1 Client class UpdateMirrorRequest.

Request for UpdateMirror.

Generated from protobuf message google.cloud.lustre.v1.UpdateMirrorRequest

Namespace

Google \ Cloud \ Lustre \ V1

Methods

__construct

Constructor.

Parameters
Name	Description
data	array Optional. Data for populating the Message object.
↳ mirror	Mirror Required. Mirror to update. The mirror's name field is used to identify the mirror to update, in the format: projects/{project}/locations/{location}/instances/{instance}/mirrors/{mirror}
↳ update_mask	Google\Protobuf\FieldMask Optional. 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 no mask is provided then all fields present in the request are overwritten.
↳ request_id	string Optional. The unique 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 the same update request being executed 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 original operation with the same request ID was received, and if so, will ignore the second request. The request ID must be a valid UUID version 4 with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). This request is only idempotent if a request_id is provided.

getMirror

Required. Mirror to update. The mirror's name field is used to identify the mirror to update, in the format: projects/{project}/locations/{location}/instances/{instance}/mirrors/{mirror}

Returns
Type	Description
Mirror|null

hasMirror

clearMirror

setMirror

Required. Mirror to update. The mirror's name field is used to identify the mirror to update, in the format: projects/{project}/locations/{location}/instances/{instance}/mirrors/{mirror}

Parameter
Name	Description
var	Mirror

Returns
Type	Description
$this

getUpdateMask

Optional. 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 no mask is provided then all fields present in the request are overwritten.

Returns
Type	Description
Google\Protobuf\FieldMask|null

hasUpdateMask

clearUpdateMask

setUpdateMask

Optional. 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 no mask is provided then all fields present in the request are overwritten.

Parameter
Name	Description
var	Google\Protobuf\FieldMask

Returns
Type	Description
$this

getRequestId

Optional. The unique 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 the same update request being executed 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 original operation with the same request ID was received, and if so, will ignore the second request. The request ID must be a valid UUID version 4 with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). This request is only idempotent if a request_id is provided.

Returns
Type	Description
string

setRequestId

Optional. The unique 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 the same update request being executed 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 original operation with the same request ID was received, and if so, will ignore the second request. The request ID must be a valid UUID version 4 with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). This request is only idempotent if a request_id is provided.

Parameter
Name	Description
var	string

Returns
Type	Description
$this

static::build

Parameters
Name	Description
mirror	Mirror Required. Mirror to update. The mirror's name field is used to identify the mirror to update, in the format: projects/{project}/locations/{location}/instances/{instance}/mirrors/{mirror}
updateMask	Google\Protobuf\FieldMask Optional. 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 no mask is provided then all fields present in the request are overwritten.

Returns
Type	Description
UpdateMirrorRequest