Reference documentation and code samples for the Google Cloud Lustre V1 Client class Mirror.
Represents a Cloud Storage mirror.
Generated from protobuf message google.cloud.lustre.v1.Mirror
Namespace
Google \ Cloud \ Lustre \ V1Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ name |
string
Identifier. Name of the mirror. Format: |
↳ gcs_path |
GcsPath
Required. Immutable. The URI to a Cloud Storage bucket, or a path within a bucket, using the format |
↳ lustre_path |
LustrePath
Required. Immutable. The Managed Lustre directory to mirror to. Must be an absolute path starting with |
↳ direction |
int
Required. Immutable. Represents the direction of the mirror. |
↳ deleted_files_retained |
bool
Optional. If |
↳ description |
string
Optional. Description of the mirror. |
↳ labels |
array|Google\Protobuf\Internal\MapField
Optional. Labels to apply to the mirror. |
↳ create_time |
Google\Protobuf\Timestamp
Output only. [Output only] Create time stamp. |
↳ update_time |
Google\Protobuf\Timestamp
Output only. [Output only] Update time stamp. |
↳ uid |
string
Output only. Unique ID of the resource. |
↳ state |
int
Output only. [Output only] The current state of the mirror. |
getName
Identifier. Name of the mirror.
Format:
projects/{project}/locations/{location}/instances/{instance}/mirrors/{mirror}
| Returns | |
|---|---|
| Type | Description |
string |
|
setName
Identifier. Name of the mirror.
Format:
projects/{project}/locations/{location}/instances/{instance}/mirrors/{mirror}
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getGcsPath
Required. Immutable. The URI to a Cloud Storage bucket, or a path within a
bucket, using the format gs://{BUCKET_NAME}/{OPTIONAL_PATH}/. If a path
inside the bucket is specified, it must end with a forward slash (/).
| Returns | |
|---|---|
| Type | Description |
GcsPath|null |
|
hasGcsPath
clearGcsPath
setGcsPath
Required. Immutable. The URI to a Cloud Storage bucket, or a path within a
bucket, using the format gs://{BUCKET_NAME}/{OPTIONAL_PATH}/. If a path
inside the bucket is specified, it must end with a forward slash (/).
| Parameter | |
|---|---|
| Name | Description |
var |
GcsPath
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getLustrePath
Required. Immutable. The Managed Lustre directory to mirror to. Must be an
absolute path starting with /, for example /data or /data/subdir.
Defaults to the root directory, /. If the specified directory doesn't
exist, it is created.
| Returns | |
|---|---|
| Type | Description |
LustrePath|null |
|
hasLustrePath
clearLustrePath
setLustrePath
Required. Immutable. The Managed Lustre directory to mirror to. Must be an
absolute path starting with /, for example /data or /data/subdir.
Defaults to the root directory, /. If the specified directory doesn't
exist, it is created.
| Parameter | |
|---|---|
| Name | Description |
var |
LustrePath
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getDirection
Required. Immutable. Represents the direction of the mirror.
| Returns | |
|---|---|
| Type | Description |
int |
Enum of type Direction. |
setDirection
Required. Immutable. Represents the direction of the mirror.
| Parameter | |
|---|---|
| Name | Description |
var |
int
Enum of type Direction. |
| Returns | |
|---|---|
| Type | Description |
$this |
|
getDeletedFilesRetained
Optional. If true, files are not deleted from Managed Lustre when the
source files are deleted from Cloud Storage. Default is false.
| Returns | |
|---|---|
| Type | Description |
bool |
|
setDeletedFilesRetained
Optional. If true, files are not deleted from Managed Lustre when the
source files are deleted from Cloud Storage. Default is false.
| Parameter | |
|---|---|
| Name | Description |
var |
bool
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getDescription
Optional. Description of the mirror.
| Returns | |
|---|---|
| Type | Description |
string |
|
setDescription
Optional. Description of the mirror.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getLabels
Optional. Labels to apply to the mirror.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\MapField |
|
setLabels
Optional. Labels to apply to the mirror.
| Parameter | |
|---|---|
| Name | Description |
var |
array|Google\Protobuf\Internal\MapField
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getCreateTime
Output only. [Output only] Create time stamp.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null |
|
hasCreateTime
clearCreateTime
setCreateTime
Output only. [Output only] Create time stamp.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Timestamp
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getUpdateTime
Output only. [Output only] Update time stamp.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null |
|
hasUpdateTime
clearUpdateTime
setUpdateTime
Output only. [Output only] Update time stamp.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Timestamp
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getUid
Output only. Unique ID of the resource.
| Returns | |
|---|---|
| Type | Description |
string |
|
setUid
Output only. Unique ID of the resource.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getState
Output only. [Output only] The current state of the mirror.
| Returns | |
|---|---|
| Type | Description |
int |
Enum of type State. |
setState
Output only. [Output only] The current state of the mirror.
| Parameter | |
|---|---|
| Name | Description |
var |
int
Enum of type State. |
| Returns | |
|---|---|
| Type | Description |
$this |
|