Class RestoreConfig.ClusterResourceRestoreScope (0.20.0)

public static final class RestoreConfig.ClusterResourceRestoreScope extends GeneratedMessageV3 implements RestoreConfig.ClusterResourceRestoreScopeOrBuilder

Defines the scope of cluster-scoped resources to restore.

Some group kinds are not reasonable choices for a restore, and will cause an error if selected here. Any scope selection that would restore "all valid" resources automatically excludes these group kinds.

  • gkebackup.gke.io/BackupJob
  • gkebackup.gke.io/RestoreJob
  • metrics.k8s.io/NodeMetrics
  • migration.k8s.io/StorageState
  • migration.k8s.io/StorageVersionMigration
  • Node
  • snapshot.storage.k8s.io/VolumeSnapshotContent
  • storage.k8s.io/CSINode

    Some group kinds are driven by restore configuration elsewhere, and will cause an error if selected here.

  • Namespace
  • PersistentVolume

Protobuf type google.cloud.gkebackup.v1.RestoreConfig.ClusterResourceRestoreScope

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > RestoreConfig.ClusterResourceRestoreScope

Static Fields

ALL_GROUP_KINDS_FIELD_NUMBER

public static final int ALL_GROUP_KINDS_FIELD_NUMBER
Field Value
TypeDescription
int

EXCLUDED_GROUP_KINDS_FIELD_NUMBER

public static final int EXCLUDED_GROUP_KINDS_FIELD_NUMBER
Field Value
TypeDescription
int

NO_GROUP_KINDS_FIELD_NUMBER

public static final int NO_GROUP_KINDS_FIELD_NUMBER
Field Value
TypeDescription
int

SELECTED_GROUP_KINDS_FIELD_NUMBER

public static final int SELECTED_GROUP_KINDS_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static RestoreConfig.ClusterResourceRestoreScope getDefaultInstance()
Returns
TypeDescription
RestoreConfig.ClusterResourceRestoreScope

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

public static RestoreConfig.ClusterResourceRestoreScope.Builder newBuilder()
Returns
TypeDescription
RestoreConfig.ClusterResourceRestoreScope.Builder

newBuilder(RestoreConfig.ClusterResourceRestoreScope prototype)

public static RestoreConfig.ClusterResourceRestoreScope.Builder newBuilder(RestoreConfig.ClusterResourceRestoreScope prototype)
Parameter
NameDescription
prototypeRestoreConfig.ClusterResourceRestoreScope
Returns
TypeDescription
RestoreConfig.ClusterResourceRestoreScope.Builder

parseDelimitedFrom(InputStream input)

public static RestoreConfig.ClusterResourceRestoreScope parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
RestoreConfig.ClusterResourceRestoreScope
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static RestoreConfig.ClusterResourceRestoreScope parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
RestoreConfig.ClusterResourceRestoreScope
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static RestoreConfig.ClusterResourceRestoreScope parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
RestoreConfig.ClusterResourceRestoreScope
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static RestoreConfig.ClusterResourceRestoreScope parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
RestoreConfig.ClusterResourceRestoreScope
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static RestoreConfig.ClusterResourceRestoreScope parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
RestoreConfig.ClusterResourceRestoreScope
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static RestoreConfig.ClusterResourceRestoreScope parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
RestoreConfig.ClusterResourceRestoreScope
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static RestoreConfig.ClusterResourceRestoreScope parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
RestoreConfig.ClusterResourceRestoreScope
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static RestoreConfig.ClusterResourceRestoreScope parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
RestoreConfig.ClusterResourceRestoreScope
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static RestoreConfig.ClusterResourceRestoreScope parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
RestoreConfig.ClusterResourceRestoreScope
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static RestoreConfig.ClusterResourceRestoreScope parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
RestoreConfig.ClusterResourceRestoreScope
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static RestoreConfig.ClusterResourceRestoreScope parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
RestoreConfig.ClusterResourceRestoreScope
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static RestoreConfig.ClusterResourceRestoreScope parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
RestoreConfig.ClusterResourceRestoreScope
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<RestoreConfig.ClusterResourceRestoreScope> parser()
Returns
TypeDescription
Parser<ClusterResourceRestoreScope>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getAllGroupKinds()

public boolean getAllGroupKinds()

If True, all valid cluster-scoped resources will be restored. Mutually exclusive to any other field in the message.

bool all_group_kinds = 3;

Returns
TypeDescription
boolean

The allGroupKinds.

getDefaultInstanceForType()

public RestoreConfig.ClusterResourceRestoreScope getDefaultInstanceForType()
Returns
TypeDescription
RestoreConfig.ClusterResourceRestoreScope

getExcludedGroupKinds(int index)

public RestoreConfig.GroupKind getExcludedGroupKinds(int index)

A list of cluster-scoped resource group kinds to NOT restore from the backup. If specified, all valid cluster-scoped resources will be restored except for those specified in the list. Mutually exclusive to any other field in the message.

repeated .google.cloud.gkebackup.v1.RestoreConfig.GroupKind excluded_group_kinds = 2;

Parameter
NameDescription
indexint
Returns
TypeDescription
RestoreConfig.GroupKind

getExcludedGroupKindsCount()

public int getExcludedGroupKindsCount()

A list of cluster-scoped resource group kinds to NOT restore from the backup. If specified, all valid cluster-scoped resources will be restored except for those specified in the list. Mutually exclusive to any other field in the message.

repeated .google.cloud.gkebackup.v1.RestoreConfig.GroupKind excluded_group_kinds = 2;

Returns
TypeDescription
int

getExcludedGroupKindsList()

public List<RestoreConfig.GroupKind> getExcludedGroupKindsList()

A list of cluster-scoped resource group kinds to NOT restore from the backup. If specified, all valid cluster-scoped resources will be restored except for those specified in the list. Mutually exclusive to any other field in the message.

repeated .google.cloud.gkebackup.v1.RestoreConfig.GroupKind excluded_group_kinds = 2;

Returns
TypeDescription
List<GroupKind>

getExcludedGroupKindsOrBuilder(int index)

public RestoreConfig.GroupKindOrBuilder getExcludedGroupKindsOrBuilder(int index)

A list of cluster-scoped resource group kinds to NOT restore from the backup. If specified, all valid cluster-scoped resources will be restored except for those specified in the list. Mutually exclusive to any other field in the message.

repeated .google.cloud.gkebackup.v1.RestoreConfig.GroupKind excluded_group_kinds = 2;

Parameter
NameDescription
indexint
Returns
TypeDescription
RestoreConfig.GroupKindOrBuilder

getExcludedGroupKindsOrBuilderList()

public List<? extends RestoreConfig.GroupKindOrBuilder> getExcludedGroupKindsOrBuilderList()

A list of cluster-scoped resource group kinds to NOT restore from the backup. If specified, all valid cluster-scoped resources will be restored except for those specified in the list. Mutually exclusive to any other field in the message.

repeated .google.cloud.gkebackup.v1.RestoreConfig.GroupKind excluded_group_kinds = 2;

Returns
TypeDescription
List<? extends com.google.cloud.gkebackup.v1.RestoreConfig.GroupKindOrBuilder>

getNoGroupKinds()

public boolean getNoGroupKinds()

If True, no cluster-scoped resources will be restored. This has the same restore scope as if the message is not defined. Mutually exclusive to any other field in the message.

bool no_group_kinds = 4;

Returns
TypeDescription
boolean

The noGroupKinds.

getParserForType()

public Parser<RestoreConfig.ClusterResourceRestoreScope> getParserForType()
Returns
TypeDescription
Parser<ClusterResourceRestoreScope>
Overrides

getSelectedGroupKinds(int index)

public RestoreConfig.GroupKind getSelectedGroupKinds(int index)

A list of cluster-scoped resource group kinds to restore from the backup. If specified, only the selected resources will be restored. Mutually exclusive to any other field in the message.

repeated .google.cloud.gkebackup.v1.RestoreConfig.GroupKind selected_group_kinds = 1;

Parameter
NameDescription
indexint
Returns
TypeDescription
RestoreConfig.GroupKind

getSelectedGroupKindsCount()

public int getSelectedGroupKindsCount()

A list of cluster-scoped resource group kinds to restore from the backup. If specified, only the selected resources will be restored. Mutually exclusive to any other field in the message.

repeated .google.cloud.gkebackup.v1.RestoreConfig.GroupKind selected_group_kinds = 1;

Returns
TypeDescription
int

getSelectedGroupKindsList()

public List<RestoreConfig.GroupKind> getSelectedGroupKindsList()

A list of cluster-scoped resource group kinds to restore from the backup. If specified, only the selected resources will be restored. Mutually exclusive to any other field in the message.

repeated .google.cloud.gkebackup.v1.RestoreConfig.GroupKind selected_group_kinds = 1;

Returns
TypeDescription
List<GroupKind>

getSelectedGroupKindsOrBuilder(int index)

public RestoreConfig.GroupKindOrBuilder getSelectedGroupKindsOrBuilder(int index)

A list of cluster-scoped resource group kinds to restore from the backup. If specified, only the selected resources will be restored. Mutually exclusive to any other field in the message.

repeated .google.cloud.gkebackup.v1.RestoreConfig.GroupKind selected_group_kinds = 1;

Parameter
NameDescription
indexint
Returns
TypeDescription
RestoreConfig.GroupKindOrBuilder

getSelectedGroupKindsOrBuilderList()

public List<? extends RestoreConfig.GroupKindOrBuilder> getSelectedGroupKindsOrBuilderList()

A list of cluster-scoped resource group kinds to restore from the backup. If specified, only the selected resources will be restored. Mutually exclusive to any other field in the message.

repeated .google.cloud.gkebackup.v1.RestoreConfig.GroupKind selected_group_kinds = 1;

Returns
TypeDescription
List<? extends com.google.cloud.gkebackup.v1.RestoreConfig.GroupKindOrBuilder>

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public RestoreConfig.ClusterResourceRestoreScope.Builder newBuilderForType()
Returns
TypeDescription
RestoreConfig.ClusterResourceRestoreScope.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected RestoreConfig.ClusterResourceRestoreScope.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
RestoreConfig.ClusterResourceRestoreScope.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public RestoreConfig.ClusterResourceRestoreScope.Builder toBuilder()
Returns
TypeDescription
RestoreConfig.ClusterResourceRestoreScope.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides
Exceptions
TypeDescription
IOException