Class Mirror (0.39.0)

public final class Mirror extends GeneratedMessage implements MirrorOrBuilder

Represents a Cloud Storage mirror.

Protobuf type google.cloud.lustre.v1.Mirror

Implements

MirrorOrBuilder

Static Fields

CREATE_TIME_FIELD_NUMBER

public static final int CREATE_TIME_FIELD_NUMBER
Field Value
Type Description
int

DELETED_FILES_RETAINED_FIELD_NUMBER

public static final int DELETED_FILES_RETAINED_FIELD_NUMBER
Field Value
Type Description
int

DESCRIPTION_FIELD_NUMBER

public static final int DESCRIPTION_FIELD_NUMBER
Field Value
Type Description
int

DIRECTION_FIELD_NUMBER

public static final int DIRECTION_FIELD_NUMBER
Field Value
Type Description
int

GCS_PATH_FIELD_NUMBER

public static final int GCS_PATH_FIELD_NUMBER
Field Value
Type Description
int

LABELS_FIELD_NUMBER

public static final int LABELS_FIELD_NUMBER
Field Value
Type Description
int

LUSTRE_PATH_FIELD_NUMBER

public static final int LUSTRE_PATH_FIELD_NUMBER
Field Value
Type Description
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
Type Description
int

STATE_FIELD_NUMBER

public static final int STATE_FIELD_NUMBER
Field Value
Type Description
int

UID_FIELD_NUMBER

public static final int UID_FIELD_NUMBER
Field Value
Type Description
int

UPDATE_TIME_FIELD_NUMBER

public static final int UPDATE_TIME_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static Mirror getDefaultInstance()
Returns
Type Description
Mirror

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static Mirror.Builder newBuilder()
Returns
Type Description
Mirror.Builder

newBuilder(Mirror prototype)

public static Mirror.Builder newBuilder(Mirror prototype)
Parameter
Name Description
prototype Mirror
Returns
Type Description
Mirror.Builder

parseDelimitedFrom(InputStream input)

public static Mirror parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
Mirror
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Mirror parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Mirror
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static Mirror parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
Mirror
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static Mirror parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Mirror
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static Mirror parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
Mirror
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static Mirror parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Mirror
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static Mirror parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
Mirror
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static Mirror parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Mirror
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static Mirror parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
Mirror
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Mirror parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Mirror
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static Mirror parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
Mirror
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static Mirror parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Mirror
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<Mirror> parser()
Returns
Type Description
Parser<Mirror>

Methods

containsLabels(String key)

public boolean containsLabels(String key)

Optional. Labels to apply to the mirror.

map<string, string> labels = 8 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
key String
Returns
Type Description
boolean

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getCreateTime()

public Timestamp getCreateTime()

Output only. [Output only] Create time stamp.

.google.protobuf.Timestamp create_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Timestamp

The createTime.

getCreateTimeOrBuilder()

public TimestampOrBuilder getCreateTimeOrBuilder()

Output only. [Output only] Create time stamp.

.google.protobuf.Timestamp create_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
TimestampOrBuilder

getDefaultInstanceForType()

public Mirror getDefaultInstanceForType()
Returns
Type Description
Mirror

getDeletedFilesRetained()

public boolean getDeletedFilesRetained()

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

bool deleted_files_retained = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

The deletedFilesRetained.

getDescription()

public String getDescription()

Optional. Description of the mirror.

string description = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The description.

getDescriptionBytes()

public ByteString getDescriptionBytes()

Optional. Description of the mirror.

string description = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for description.

getDirection()

public Mirror.Direction getDirection()

Required. Immutable. Represents the direction of the mirror.

.google.cloud.lustre.v1.Mirror.Direction direction = 5 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];

Returns
Type Description
Mirror.Direction

The direction.

getDirectionValue()

public int getDirectionValue()

Required. Immutable. Represents the direction of the mirror.

.google.cloud.lustre.v1.Mirror.Direction direction = 5 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];

Returns
Type Description
int

The enum numeric value on the wire for direction.

getGcsPath()

public GcsPath 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 (/).

.google.cloud.lustre.v1.GcsPath gcs_path = 3 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];

Returns
Type Description
GcsPath

The gcsPath.

getGcsPathOrBuilder()

public GcsPathOrBuilder getGcsPathOrBuilder()

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 (/).

.google.cloud.lustre.v1.GcsPath gcs_path = 3 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];

Returns
Type Description
GcsPathOrBuilder

getLabels() (deprecated)

public Map<String,String> getLabels()

Use #getLabelsMap() instead.

Returns
Type Description
Map<String,String>

getLabelsCount()

public int getLabelsCount()

Optional. Labels to apply to the mirror.

map<string, string> labels = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

getLabelsMap()

public Map<String,String> getLabelsMap()

Optional. Labels to apply to the mirror.

map<string, string> labels = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Map<String,String>

getLabelsOrDefault(String key, String defaultValue)

public String getLabelsOrDefault(String key, String defaultValue)

Optional. Labels to apply to the mirror.

map<string, string> labels = 8 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name Description
key String
defaultValue String
Returns
Type Description
String

getLabelsOrThrow(String key)

public String getLabelsOrThrow(String key)

Optional. Labels to apply to the mirror.

map<string, string> labels = 8 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
key String
Returns
Type Description
String

getLustrePath()

public LustrePath 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.

.google.cloud.lustre.v1.LustrePath lustre_path = 4 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];

Returns
Type Description
LustrePath

The lustrePath.

getLustrePathOrBuilder()

public LustrePathOrBuilder getLustrePathOrBuilder()

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.

.google.cloud.lustre.v1.LustrePath lustre_path = 4 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];

Returns
Type Description
LustrePathOrBuilder

getName()

public String getName()

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

string name = 1 [(.google.api.field_behavior) = IDENTIFIER];

Returns
Type Description
String

The name.

getNameBytes()

public ByteString getNameBytes()

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

string name = 1 [(.google.api.field_behavior) = IDENTIFIER];

Returns
Type Description
ByteString

The bytes for name.

getParserForType()

public Parser<Mirror> getParserForType()
Returns
Type Description
Parser<Mirror>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getState()

public Mirror.State getState()

Output only. [Output only] The current state of the mirror.

.google.cloud.lustre.v1.Mirror.State state = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Mirror.State

The state.

getStateValue()

public int getStateValue()

Output only. [Output only] The current state of the mirror.

.google.cloud.lustre.v1.Mirror.State state = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
int

The enum numeric value on the wire for state.

getUid()

public String getUid()

Output only. Unique ID of the resource.

string uid = 11 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.field_info) = { ... }

Returns
Type Description
String

The uid.

getUidBytes()

public ByteString getUidBytes()

Output only. Unique ID of the resource.

string uid = 11 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.field_info) = { ... }

Returns
Type Description
ByteString

The bytes for uid.

getUpdateTime()

public Timestamp getUpdateTime()

Output only. [Output only] Update time stamp.

.google.protobuf.Timestamp update_time = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Timestamp

The updateTime.

getUpdateTimeOrBuilder()

public TimestampOrBuilder getUpdateTimeOrBuilder()

Output only. [Output only] Update time stamp.

.google.protobuf.Timestamp update_time = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
TimestampOrBuilder

hasCreateTime()

public boolean hasCreateTime()

Output only. [Output only] Create time stamp.

.google.protobuf.Timestamp create_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the createTime field is set.

hasGcsPath()

public boolean hasGcsPath()

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 (/).

.google.cloud.lustre.v1.GcsPath gcs_path = 3 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];

Returns
Type Description
boolean

Whether the gcsPath field is set.

hasLustrePath()

public boolean hasLustrePath()

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.

.google.cloud.lustre.v1.LustrePath lustre_path = 4 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];

Returns
Type Description
boolean

Whether the lustrePath field is set.

hasUpdateTime()

public boolean hasUpdateTime()

Output only. [Output only] Update time stamp.

.google.protobuf.Timestamp update_time = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the updateTime field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

internalGetMapFieldReflection(int number)

protected MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
Parameter
Name Description
number int
Returns
Type Description
com.google.protobuf.MapFieldReflectionAccessor
Overrides
com.google.protobuf.GeneratedMessage.internalGetMapFieldReflection(int)

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public Mirror.Builder newBuilderForType()
Returns
Type Description
Mirror.Builder

newBuilderForType(AbstractMessage.BuilderParent parent)

protected Mirror.Builder newBuilderForType(AbstractMessage.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
Mirror.Builder
Overrides

toBuilder()

public Mirror.Builder toBuilder()
Returns
Type Description
Mirror.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException