Class RestoreConfig.ClusterResourceRestoreScope (0.34.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

Implements

RestoreConfig.ClusterResourceRestoreScopeOrBuilder

Inherited Members

AbstractMessage.equals(Object)

AbstractMessage.findInitializationErrors()

AbstractMessage.getInitializationErrorString()

AbstractMessage.hashBoolean(boolean)

AbstractMessage.hashCode()

AbstractMessage.hashEnum(Internal.EnumLite)

AbstractMessage.hashEnumList(List<? extends Internal.EnumLite>)

AbstractMessage.hashFields(int,Map<Descriptors.FieldDescriptor,Object>)

AbstractMessage.hashLong(long)

AbstractMessage.toString()

AbstractMessageLite.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.checkByteStringIsUtf8(ByteString)

AbstractMessageLite.toByteArray()

AbstractMessageLite.toByteString()

AbstractMessageLite.writeDelimitedTo(OutputStream)

AbstractMessageLite.writeTo(OutputStream)

com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)

com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)

GeneratedMessageV3.<M>parseDelimitedWithIOException(Parser<M>,InputStream)

GeneratedMessageV3.<M>parseDelimitedWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,CodedInputStream)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,CodedInputStream,ExtensionRegistryLite)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,InputStream)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)

GeneratedMessageV3.<V>serializeBooleanMapTo(CodedOutputStream,MapField<Boolean,V>,MapEntry<Boolean,V>,int)

GeneratedMessageV3.<V>serializeIntegerMapTo(CodedOutputStream,MapField<Integer,V>,MapEntry<Integer,V>,int)

GeneratedMessageV3.<V>serializeLongMapTo(CodedOutputStream,MapField<Long,V>,MapEntry<Long,V>,int)

GeneratedMessageV3.<V>serializeStringMapTo(CodedOutputStream,MapField<String,V>,MapEntry<String,V>,int)

GeneratedMessageV3.canUseUnsafe()

GeneratedMessageV3.computeStringSize(int,Object)

GeneratedMessageV3.computeStringSizeNoTag(Object)

GeneratedMessageV3.emptyBooleanList()

GeneratedMessageV3.emptyDoubleList()

GeneratedMessageV3.emptyFloatList()

GeneratedMessageV3.emptyIntList()

GeneratedMessageV3.emptyLongList()

GeneratedMessageV3.getAllFields()

GeneratedMessageV3.getDescriptorForType()

GeneratedMessageV3.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.getParserForType()

GeneratedMessageV3.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.getRepeatedFieldCount(Descriptors.FieldDescriptor)

GeneratedMessageV3.getSerializedSize()

GeneratedMessageV3.getUnknownFields()

GeneratedMessageV3.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.internalGetFieldAccessorTable()

GeneratedMessageV3.internalGetMapField(int)

com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)

GeneratedMessageV3.isInitialized()

GeneratedMessageV3.isStringEmpty(Object)

GeneratedMessageV3.makeExtensionsImmutable()

GeneratedMessageV3.mergeFromAndMakeImmutableInternal(CodedInputStream,ExtensionRegistryLite)

GeneratedMessageV3.mutableCopy(Internal.BooleanList)

GeneratedMessageV3.mutableCopy(Internal.DoubleList)

GeneratedMessageV3.mutableCopy(Internal.FloatList)

GeneratedMessageV3.mutableCopy(Internal.IntList)

GeneratedMessageV3.mutableCopy(Internal.LongList)

GeneratedMessageV3.newBooleanList()

GeneratedMessageV3.newBuilderForType(AbstractMessage.BuilderParent)

GeneratedMessageV3.newBuilderForType(GeneratedMessageV3.BuilderParent)

GeneratedMessageV3.newDoubleList()

GeneratedMessageV3.newFloatList()

GeneratedMessageV3.newInstance(GeneratedMessageV3.UnusedPrivateParameter)

GeneratedMessageV3.newIntList()

GeneratedMessageV3.newLongList()

GeneratedMessageV3.parseUnknownField(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

GeneratedMessageV3.parseUnknownFieldProto3(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

GeneratedMessageV3.writeReplace()

GeneratedMessageV3.writeString(CodedOutputStream,int,Object)

GeneratedMessageV3.writeStringNoTag(CodedOutputStream,Object)

GeneratedMessageV3.writeTo(CodedOutputStream)

Object.clone()

Object.finalize()

Object.getClass()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

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

AbstractMessage.equals(Object other)

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
Type	Description
`boolean`	The allGroupKinds.

getDefaultInstanceForType()

public RestoreConfig.ClusterResourceRestoreScope getDefaultInstanceForType()

Returns
Type	Description
`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
Name	Description
`index`	`int`

Returns
Type	Description
`RestoreConfig.GroupKind`

getExcludedGroupKindsCount()

public int getExcludedGroupKindsCount()

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

Returns
Type	Description
`int`

getExcludedGroupKindsList()

public List<RestoreConfig.GroupKind> getExcludedGroupKindsList()

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

Returns
Type	Description
`List<GroupKind>`

getExcludedGroupKindsOrBuilder(int index)

public RestoreConfig.GroupKindOrBuilder getExcludedGroupKindsOrBuilder(int index)

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

Parameter
Name	Description
`index`	`int`

Returns
Type	Description
`RestoreConfig.GroupKindOrBuilder`

getExcludedGroupKindsOrBuilderList()

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

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

Returns
Type	Description
`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
Type	Description
`boolean`	The noGroupKinds.

getParserForType()

public Parser<RestoreConfig.ClusterResourceRestoreScope> getParserForType()

Returns
Type	Description
`Parser<ClusterResourceRestoreScope>`

Overrides

GeneratedMessageV3.getParserForType()

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.