Class Restore (0.15.0) 

public final class Restore extends GeneratedMessageV3 implements RestoreOrBuilder

Represents both a request to Restore some portion of a Backup into a target GKE cluster and a record of the restore operation itself. Next id: 18

Protobuf type google.events.cloud.gkebackup.v1.Restore

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > Restore

Implements

RestoreOrBuilder

Static Fields

BACKUP_FIELD_NUMBER

public static final int BACKUP_FIELD_NUMBER
Field Value
Type Description
int

CLUSTER_FIELD_NUMBER

public static final int CLUSTER_FIELD_NUMBER
Field Value
Type Description
int

COMPLETE_TIME_FIELD_NUMBER

public static final int COMPLETE_TIME_FIELD_NUMBER
Field Value
Type Description
int

CREATE_TIME_FIELD_NUMBER

public static final int CREATE_TIME_FIELD_NUMBER
Field Value
Type Description
int

DESCRIPTION_FIELD_NUMBER

public static final int DESCRIPTION_FIELD_NUMBER
Field Value
Type Description
int

ETAG_FIELD_NUMBER

public static final int ETAG_FIELD_NUMBER
Field Value
Type Description
int

LABELS_FIELD_NUMBER

public static final int LABELS_FIELD_NUMBER
Field Value
Type Description
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
Type Description
int

RESOURCES_EXCLUDED_COUNT_FIELD_NUMBER

public static final int RESOURCES_EXCLUDED_COUNT_FIELD_NUMBER
Field Value
Type Description
int

RESOURCES_FAILED_COUNT_FIELD_NUMBER

public static final int RESOURCES_FAILED_COUNT_FIELD_NUMBER
Field Value
Type Description
int

RESOURCES_RESTORED_COUNT_FIELD_NUMBER

public static final int RESOURCES_RESTORED_COUNT_FIELD_NUMBER
Field Value
Type Description
int

RESTORE_CONFIG_FIELD_NUMBER

public static final int RESTORE_CONFIG_FIELD_NUMBER
Field Value
Type Description
int

STATE_FIELD_NUMBER

public static final int STATE_FIELD_NUMBER
Field Value
Type Description
int

STATE_REASON_FIELD_NUMBER

public static final int STATE_REASON_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

VOLUMES_RESTORED_COUNT_FIELD_NUMBER

public static final int VOLUMES_RESTORED_COUNT_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static Restore getDefaultInstance()
Returns
Type Description
Restore

getDescriptor()

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

newBuilder()

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

newBuilder(Restore prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

containsLabels(String key)

public boolean containsLabels(String key)

A set of custom labels supplied by user.

map<string, string> labels = 9;

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

getBackup()

public String getBackup()

Required. Immutable. A reference to the Backup used as the source from which this Restore will restore. Note that this Backup must be a sub-resource of the RestorePlan's backup_plan. Format: projects/*/locations/*/backupPlans/*/backups/*.

string backup = 6;

Returns
Type Description
String

The backup.

getBackupBytes()

public ByteString getBackupBytes()

Required. Immutable. A reference to the Backup used as the source from which this Restore will restore. Note that this Backup must be a sub-resource of the RestorePlan's backup_plan. Format: projects/*/locations/*/backupPlans/*/backups/*.

string backup = 6;

Returns
Type Description
ByteString

The bytes for backup.

getCluster()

public String getCluster()

Output only. The target cluster into which this Restore will restore data. Valid formats:

  • projects/*/locations/*/clusters/*
  • projects/*/zones/*/clusters/* Inherited from parent RestorePlan's cluster value.

string cluster = 7;

Returns
Type Description
String

The cluster.

getClusterBytes()

public ByteString getClusterBytes()

Output only. The target cluster into which this Restore will restore data. Valid formats:

  • projects/*/locations/*/clusters/*
  • projects/*/zones/*/clusters/* Inherited from parent RestorePlan's cluster value.

string cluster = 7;

Returns
Type Description
ByteString

The bytes for cluster.

getCompleteTime()

public Timestamp getCompleteTime()

Output only. Timestamp of when the restore operation completed.

.google.protobuf.Timestamp complete_time = 12;

Returns
Type Description
Timestamp

The completeTime.

getCompleteTimeOrBuilder()

public TimestampOrBuilder getCompleteTimeOrBuilder()

Output only. Timestamp of when the restore operation completed.

.google.protobuf.Timestamp complete_time = 12;

Returns
Type Description
TimestampOrBuilder

getCreateTime()

public Timestamp getCreateTime()

Output only. The timestamp when this Restore resource was created.

.google.protobuf.Timestamp create_time = 3;

Returns
Type Description
Timestamp

The createTime.

getCreateTimeOrBuilder()

public TimestampOrBuilder getCreateTimeOrBuilder()

Output only. The timestamp when this Restore resource was created.

.google.protobuf.Timestamp create_time = 3;

Returns
Type Description
TimestampOrBuilder

getDefaultInstanceForType()

public Restore getDefaultInstanceForType()
Returns
Type Description
Restore

getDescription()

public String getDescription()

User specified descriptive string for this Restore.

string description = 5;

Returns
Type Description
String

The description.

getDescriptionBytes()

public ByteString getDescriptionBytes()

User specified descriptive string for this Restore.

string description = 5;

Returns
Type Description
ByteString

The bytes for description.

getEtag()

public String getEtag()

Output only. etag is used for optimistic concurrency control as a way to help prevent simultaneous updates of a restore from overwriting each other. It is strongly suggested that systems make use of the etag in the read-modify-write cycle to perform restore updates in order to avoid race conditions: An etag is returned in the response to GetRestore, and systems are expected to put that etag in the request to UpdateRestore or DeleteRestore to ensure that their change will be applied to the same version of the resource.

string etag = 17;

Returns
Type Description
String

The etag.

getEtagBytes()

public ByteString getEtagBytes()

Output only. etag is used for optimistic concurrency control as a way to help prevent simultaneous updates of a restore from overwriting each other. It is strongly suggested that systems make use of the etag in the read-modify-write cycle to perform restore updates in order to avoid race conditions: An etag is returned in the response to GetRestore, and systems are expected to put that etag in the request to UpdateRestore or DeleteRestore to ensure that their change will be applied to the same version of the resource.

string etag = 17;

Returns
Type Description
ByteString

The bytes for etag.

getLabels()

public Map<String,String> getLabels()

Use #getLabelsMap() instead.

Returns
Type Description
Map<String,String>

getLabelsCount()

public int getLabelsCount()

A set of custom labels supplied by user.

map<string, string> labels = 9;

Returns
Type Description
int

getLabelsMap()

public Map<String,String> getLabelsMap()

A set of custom labels supplied by user.

map<string, string> labels = 9;

Returns
Type Description
Map<String,String>

getLabelsOrDefault(String key, String defaultValue)

public String getLabelsOrDefault(String key, String defaultValue)

A set of custom labels supplied by user.

map<string, string> labels = 9;

Parameters
Name Description
key String
defaultValue String
Returns
Type Description
String

getLabelsOrThrow(String key)

public String getLabelsOrThrow(String key)

A set of custom labels supplied by user.

map<string, string> labels = 9;

Parameter
Name Description
key String
Returns
Type Description
String

getName()

public String getName()

Output only. The full name of the Restore resource. Format: projects/*/locations/*/restorePlans/*/restores/*

string name = 1;

Returns
Type Description
String

The name.

getNameBytes()

public ByteString getNameBytes()

Output only. The full name of the Restore resource. Format: projects/*/locations/*/restorePlans/*/restores/*

string name = 1;

Returns
Type Description
ByteString

The bytes for name.

getParserForType()

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

getResourcesExcludedCount()

public int getResourcesExcludedCount()

Output only. Number of resources excluded during the restore execution.

int32 resources_excluded_count = 14;

Returns
Type Description
int

The resourcesExcludedCount.

getResourcesFailedCount()

public int getResourcesFailedCount()

Output only. Number of resources that failed to be restored during the restore execution.

int32 resources_failed_count = 15;

Returns
Type Description
int

The resourcesFailedCount.

getResourcesRestoredCount()

public int getResourcesRestoredCount()

Output only. Number of resources restored during the restore execution.

int32 resources_restored_count = 13;

Returns
Type Description
int

The resourcesRestoredCount.

getRestoreConfig()

public RestoreConfig getRestoreConfig()

Output only. Configuration of the Restore. Inherited from parent RestorePlan's restore_config.

.google.events.cloud.gkebackup.v1.RestoreConfig restore_config = 8;

Returns
Type Description
RestoreConfig

The restoreConfig.

getRestoreConfigOrBuilder()

public RestoreConfigOrBuilder getRestoreConfigOrBuilder()

Output only. Configuration of the Restore. Inherited from parent RestorePlan's restore_config.

.google.events.cloud.gkebackup.v1.RestoreConfig restore_config = 8;

Returns
Type Description
RestoreConfigOrBuilder

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getState()

public Restore.State getState()

Output only. The current state of the Restore.

.google.events.cloud.gkebackup.v1.Restore.State state = 10;

Returns
Type Description
Restore.State

The state.

getStateReason()

public String getStateReason()

Output only. Human-readable description of why the Restore is in its current state.

string state_reason = 11;

Returns
Type Description
String

The stateReason.

getStateReasonBytes()

public ByteString getStateReasonBytes()

Output only. Human-readable description of why the Restore is in its current state.

string state_reason = 11;

Returns
Type Description
ByteString

The bytes for stateReason.

getStateValue()

public int getStateValue()

Output only. The current state of the Restore.

.google.events.cloud.gkebackup.v1.Restore.State state = 10;

Returns
Type Description
int

The enum numeric value on the wire for state.

getUid()

public String getUid()

Output only. Server generated global unique identifier of UUID format.

string uid = 2;

Returns
Type Description
String

The uid.

getUidBytes()

public ByteString getUidBytes()

Output only. Server generated global unique identifier of UUID format.

string uid = 2;

Returns
Type Description
ByteString

The bytes for uid.

getUnknownFields()

public final UnknownFieldSet getUnknownFields()
Returns
Type Description
UnknownFieldSet
Overrides

getUpdateTime()

public Timestamp getUpdateTime()

Output only. The timestamp when this Restore resource was last updated.

.google.protobuf.Timestamp update_time = 4;

Returns
Type Description
Timestamp

The updateTime.

getUpdateTimeOrBuilder()

public TimestampOrBuilder getUpdateTimeOrBuilder()

Output only. The timestamp when this Restore resource was last updated.

.google.protobuf.Timestamp update_time = 4;

Returns
Type Description
TimestampOrBuilder

getVolumesRestoredCount()

public int getVolumesRestoredCount()

Output only. Number of volumes restored during the restore execution.

int32 volumes_restored_count = 16;

Returns
Type Description
int

The volumesRestoredCount.

hasCompleteTime()

public boolean hasCompleteTime()

Output only. Timestamp of when the restore operation completed.

.google.protobuf.Timestamp complete_time = 12;

Returns
Type Description
boolean

Whether the completeTime field is set.

hasCreateTime()

public boolean hasCreateTime()

Output only. The timestamp when this Restore resource was created.

.google.protobuf.Timestamp create_time = 3;

Returns
Type Description
boolean

Whether the createTime field is set.

hasRestoreConfig()

public boolean hasRestoreConfig()

Output only. Configuration of the Restore. Inherited from parent RestorePlan's restore_config.

.google.events.cloud.gkebackup.v1.RestoreConfig restore_config = 8;

Returns
Type Description
boolean

Whether the restoreConfig field is set.

hasUpdateTime()

public boolean hasUpdateTime()

Output only. The timestamp when this Restore resource was last updated.

.google.protobuf.Timestamp update_time = 4;

Returns
Type Description
boolean

Whether the updateTime field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

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

internalGetMapField(int number)

protected MapField internalGetMapField(int number)
Parameter
Name Description
number int
Returns
Type Description
MapField
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

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

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected Restore.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
Restore.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

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

writeTo(CodedOutputStream output)

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