Google Cloud Lustre V1 Client - Class CreateMirrorRequest (0.6.0)

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

Request for CreateMirror.

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

Namespace

Google \ Cloud \ Lustre \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.
↳ parent string

Required. Parent instance resource where the mirror will be created, in the format: projects/{project}/locations/{location}/instances/{instance}
↳ mirror_id string

Required. The ID to use for the mirror. * * Must contain only lowercase letters, numbers, and hyphens. * * Must start with a letter. * * Must be between 1-63 characters. * * Must end with a number or a letter. The ID cannot be changed after the mirror is created.
↳ mirror Mirror

Required. The mirror to create.
↳ 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 creation of duplicate mirrors 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. This prevents clients from accidentally creating duplicate mirrors. 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.

getParent

Required. Parent instance resource where the mirror will be created, in the format: projects/{project}/locations/{location}/instances/{instance}

Returns
Type Description
string

setParent

Required. Parent instance resource where the mirror will be created, in the format: projects/{project}/locations/{location}/instances/{instance}

Parameter
Name Description
var string
Returns
Type Description
$this

getMirrorId

Required. The ID to use for the mirror.

  • Must contain only lowercase letters, numbers, and hyphens.
  • Must start with a letter.
  • Must be between 1-63 characters.
  • Must end with a number or a letter. The ID cannot be changed after the mirror is created.
Returns
Type Description
string

setMirrorId

Required. The ID to use for the mirror.

  • Must contain only lowercase letters, numbers, and hyphens.
  • Must start with a letter.
  • Must be between 1-63 characters.
  • Must end with a number or a letter. The ID cannot be changed after the mirror is created.
Parameter
Name Description
var string
Returns
Type Description
$this

getMirror

Required. The mirror to create.

Returns
Type Description
Mirror|null

hasMirror

clearMirror

setMirror

Required. The mirror to create.

Parameter
Name Description
var Mirror
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 creation of duplicate mirrors 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. This prevents clients from accidentally creating duplicate mirrors. 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 creation of duplicate mirrors 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. This prevents clients from accidentally creating duplicate mirrors. 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
parent string

Required. Parent instance resource where the mirror will be created, in the format: projects/{project}/locations/{location}/instances/{instance} Please see LustreClient::instanceName() for help formatting this field.
mirror Mirror

Required. The mirror to create.
mirrorId string

Required. The ID to use for the mirror.

    • Must contain only lowercase letters, numbers, and hyphens.
    • Must start with a letter.
    • Must be between 1-63 characters.
    • Must end with a number or a letter.

The ID cannot be changed after the mirror is created.
Returns
Type Description
CreateMirrorRequest