REST Resource: projects.locations.instances.mirrors

Resource: Mirror

Represents a Cloud Storage mirror.

JSON representation 
{
  "name": string,
  "gcsPath": {
    object (GcsPath)
  },
  "lustrePath": {
    object (LustrePath)
  },
  "direction": enum (Direction),
  "deletedFilesRetained": boolean,
  "description": string,
  "labels": {
    string: string,
    ...
  },
  "createTime": string,
  "updateTime": string,
  "uid": string,
  "state": enum (State)
}
Fields
name

string

Identifier. Name of the mirror. Format: projects/{project}/locations/{location}/instances/{instance}/mirrors/{mirror}
gcsPath

object (GcsPath)

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, /.
lustrePath

object (LustrePath)

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.
direction

enum (Direction)

Required. Immutable. Represents the direction of the mirror.
deletedFilesRetained

boolean

Optional. If true, files are not deleted from Managed Lustre when the source files are deleted from Cloud Storage. Default is false.
description

string

Optional. Description of the mirror.
labels

map (key: string, value: string)

Optional. Labels to apply to the mirror.

An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
createTime

string (Timestamp format)

Output only. Create time stamp.

Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".
updateTime

string (Timestamp format)

Output only. Update time stamp.

Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".
uid

string

Output only. Unique ID of the resource.
state

enum (State)

Output only. The current state of the mirror.

GcsPath

Specifies a Cloud Storage bucket and, optionally, a path inside the bucket.

JSON representation 
{
  "uri": string
}
Fields
uri

string

Required. The URI to a Cloud Storage bucket, or a path within a bucket, using the format gs://<bucket_name>/<optional_path_inside_bucket>/. If a path inside the bucket is specified, it must end with a forward slash, /.

LustrePath

The root directory path to the Lustre file system.

JSON representation 
{
  "path": string
}
Fields
path

string

Optional. The root directory path to the Managed Lustre file system. Must start with /. Default is /. If you're importing data into Managed Lustre, any path other than the default must already exist on the file system.

Direction

Represents the direction of the mirror.

Enums
DIRECTION_UNSPECIFIED Invalid value.
FROM_CLOUD_STORAGE Mirror from Cloud Storage to Lustre.

State

State of the mirror.

Enums
STATE_UNSPECIFIED State is unspecified.
CREATING The mirror resource is being created.
INITIAL_SYNC The initial sync is copying existing objects from Cloud Storage.
DELETING The mirror is being deleted.
ACTIVE The mirror is synchronizing changes as they occur.
SUSPENDED Synchronization is paused because the file system is close to capacity.

Methods

create

 Creates a new mirror in a given instance.

delete

 Deletes a single mirror.

get

 Gets details of a single mirror.

list

 Gets details of multiple mirrors under a given instance.

patch

 Updates the parameters of a single mirror.