Class RestoreConfig.ClusterResourceRestoreScope (0.52.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
Type Description
int

EXCLUDED_GROUP_KINDS_FIELD_NUMBER

public static final int EXCLUDED_GROUP_KINDS_FIELD_NUMBER
Field Value
Type Description
int

NO_GROUP_KINDS_FIELD_NUMBER

public static final int NO_GROUP_KINDS_FIELD_NUMBER
Field Value
Type Description
int

SELECTED_GROUP_KINDS_FIELD_NUMBER

public static final int SELECTED_GROUP_KINDS_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static RestoreConfig.ClusterResourceRestoreScope getDefaultInstance()
Returns
Type Description
RestoreConfig.ClusterResourceRestoreScope

getDescriptor()

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

newBuilder()

public static RestoreConfig.ClusterResourceRestoreScope.Builder newBuilder()
Returns
Type Description
RestoreConfig.ClusterResourceRestoreScope.Builder

newBuilder(RestoreConfig.ClusterResourceRestoreScope prototype)

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

parseDelimitedFrom(InputStream input)

public static RestoreConfig.ClusterResourceRestoreScope parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
RestoreConfig.ClusterResourceRestoreScope
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

public static RestoreConfig.ClusterResourceRestoreScope parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
RestoreConfig.ClusterResourceRestoreScope
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

public static RestoreConfig.ClusterResourceRestoreScope parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
RestoreConfig.ClusterResourceRestoreScope
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

public static RestoreConfig.ClusterResourceRestoreScope parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
RestoreConfig.ClusterResourceRestoreScope
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

public static RestoreConfig.ClusterResourceRestoreScope parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
RestoreConfig.ClusterResourceRestoreScope
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

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

getAllGroupKinds()

public boolean getAllGroupKinds()

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

bool all_group_kinds = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

The allGroupKinds.

getDefaultInstanceForType()

public RestoreConfig.ClusterResourceRestoreScope getDefaultInstanceForType()
Returns
Type Description
RestoreConfig.ClusterResourceRestoreScope

getExcludedGroupKinds(int index)

public RestoreConfig.GroupKind getExcludedGroupKinds(int index)

Optional. 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 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int
Returns
Type Description
RestoreConfig.GroupKind

getExcludedGroupKindsCount()

public int getExcludedGroupKindsCount()

Optional. 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 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

getExcludedGroupKindsList()

public List<RestoreConfig.GroupKind> getExcludedGroupKindsList()

Optional. 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 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
List<GroupKind>

getExcludedGroupKindsOrBuilder(int index)

public RestoreConfig.GroupKindOrBuilder getExcludedGroupKindsOrBuilder(int index)

Optional. 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 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int
Returns
Type Description
RestoreConfig.GroupKindOrBuilder

getExcludedGroupKindsOrBuilderList()

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

Optional. 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 [(.google.api.field_behavior) = OPTIONAL];

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

getNoGroupKinds()

public boolean getNoGroupKinds()

Optional. 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 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

The noGroupKinds.

getParserForType()

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

getSelectedGroupKinds(int index)

public RestoreConfig.GroupKind getSelectedGroupKinds(int index)

Optional. 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 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int
Returns
Type Description
RestoreConfig.GroupKind

getSelectedGroupKindsCount()

public int getSelectedGroupKindsCount()

Optional. 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 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

getSelectedGroupKindsList()

public List<RestoreConfig.GroupKind> getSelectedGroupKindsList()

Optional. 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 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
List<GroupKind>

getSelectedGroupKindsOrBuilder(int index)

public RestoreConfig.GroupKindOrBuilder getSelectedGroupKindsOrBuilder(int index)

Optional. 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 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int
Returns
Type Description
RestoreConfig.GroupKindOrBuilder

getSelectedGroupKindsOrBuilderList()

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

Optional. 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 [(.google.api.field_behavior) = OPTIONAL];

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

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public RestoreConfig.ClusterResourceRestoreScope.Builder newBuilderForType()
Returns
Type Description
RestoreConfig.ClusterResourceRestoreScope.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

public RestoreConfig.ClusterResourceRestoreScope.Builder toBuilder()
Returns
Type Description
RestoreConfig.ClusterResourceRestoreScope.Builder

writeTo(CodedOutputStream output)

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