Class ResourceBackupConfig (0.41.0)

public final class ResourceBackupConfig extends GeneratedMessageV3 implements ResourceBackupConfigOrBuilder

ResourceBackupConfig represents a resource along with its backup configurations.

Protobuf type google.cloud.backupdr.v1.ResourceBackupConfig

Static Fields

BACKUP_CONFIGS_DETAILS_FIELD_NUMBER

public static final int BACKUP_CONFIGS_DETAILS_FIELD_NUMBER
Field Value
Type Description
int

BACKUP_CONFIGURED_FIELD_NUMBER

public static final int BACKUP_CONFIGURED_FIELD_NUMBER
Field Value
Type Description
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
Type Description
int

TARGET_RESOURCE_DISPLAY_NAME_FIELD_NUMBER

public static final int TARGET_RESOURCE_DISPLAY_NAME_FIELD_NUMBER
Field Value
Type Description
int

TARGET_RESOURCE_FIELD_NUMBER

public static final int TARGET_RESOURCE_FIELD_NUMBER
Field Value
Type Description
int

TARGET_RESOURCE_LABELS_FIELD_NUMBER

public static final int TARGET_RESOURCE_LABELS_FIELD_NUMBER
Field Value
Type Description
int

TARGET_RESOURCE_TYPE_FIELD_NUMBER

public static final int TARGET_RESOURCE_TYPE_FIELD_NUMBER
Field Value
Type Description
int

UID_FIELD_NUMBER

public static final int UID_FIELD_NUMBER
Field Value
Type Description
int

VAULTED_FIELD_NUMBER

public static final int VAULTED_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static ResourceBackupConfig getDefaultInstance()
Returns
Type Description
ResourceBackupConfig

getDescriptor()

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

newBuilder()

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

newBuilder(ResourceBackupConfig prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

containsTargetResourceLabels(String key)

public boolean containsTargetResourceLabels(String key)

Labels associated with the target resource.

map<string, string> target_resource_labels = 6;

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

getBackupConfigsDetails(int index)

public BackupConfigDetails getBackupConfigsDetails(int index)

Backup configurations applying to the target resource, including those targeting its related/child resources. For example, backup configuration applicable to Compute Engine disks will be populated in this field for a Compute Engine VM which has the disk associated.

repeated .google.cloud.backupdr.v1.BackupConfigDetails backup_configs_details = 7;

Parameter
Name Description
index int
Returns
Type Description
BackupConfigDetails

getBackupConfigsDetailsCount()

public int getBackupConfigsDetailsCount()

Backup configurations applying to the target resource, including those targeting its related/child resources. For example, backup configuration applicable to Compute Engine disks will be populated in this field for a Compute Engine VM which has the disk associated.

repeated .google.cloud.backupdr.v1.BackupConfigDetails backup_configs_details = 7;

Returns
Type Description
int

getBackupConfigsDetailsList()

public List<BackupConfigDetails> getBackupConfigsDetailsList()

Backup configurations applying to the target resource, including those targeting its related/child resources. For example, backup configuration applicable to Compute Engine disks will be populated in this field for a Compute Engine VM which has the disk associated.

repeated .google.cloud.backupdr.v1.BackupConfigDetails backup_configs_details = 7;

Returns
Type Description
List<BackupConfigDetails>

getBackupConfigsDetailsOrBuilder(int index)

public BackupConfigDetailsOrBuilder getBackupConfigsDetailsOrBuilder(int index)

Backup configurations applying to the target resource, including those targeting its related/child resources. For example, backup configuration applicable to Compute Engine disks will be populated in this field for a Compute Engine VM which has the disk associated.

repeated .google.cloud.backupdr.v1.BackupConfigDetails backup_configs_details = 7;

Parameter
Name Description
index int
Returns
Type Description
BackupConfigDetailsOrBuilder

getBackupConfigsDetailsOrBuilderList()

public List<? extends BackupConfigDetailsOrBuilder> getBackupConfigsDetailsOrBuilderList()

Backup configurations applying to the target resource, including those targeting its related/child resources. For example, backup configuration applicable to Compute Engine disks will be populated in this field for a Compute Engine VM which has the disk associated.

repeated .google.cloud.backupdr.v1.BackupConfigDetails backup_configs_details = 7;

Returns
Type Description
List<? extends com.google.cloud.backupdr.v1.BackupConfigDetailsOrBuilder>

getBackupConfigured()

public boolean getBackupConfigured()

Output only. Whether the target resource is configured for backup. This is true if the backup_configs_details is not empty.

bool backup_configured = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

The backupConfigured.

getDefaultInstanceForType()

public ResourceBackupConfig getDefaultInstanceForType()
Returns
Type Description
ResourceBackupConfig

getName()

public String getName()

Identifier. The resource name of the ResourceBackupConfig. Format: projects/{project}/locations/{location}/resourceBackupConfigs/{uid}

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

Returns
Type Description
String

The name.

getNameBytes()

public ByteString getNameBytes()

Identifier. The resource name of the ResourceBackupConfig. Format: projects/{project}/locations/{location}/resourceBackupConfigs/{uid}

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

Returns
Type Description
ByteString

The bytes for name.

getParserForType()

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

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getTargetResource()

public String getTargetResource()

Output only. The full resource name of the cloud resource that this configuration applies to. Supported resource types are ResourceBackupConfig.ResourceType.

string target_resource = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
String

The targetResource.

getTargetResourceBytes()

public ByteString getTargetResourceBytes()

Output only. The full resource name of the cloud resource that this configuration applies to. Supported resource types are ResourceBackupConfig.ResourceType.

string target_resource = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ByteString

The bytes for targetResource.

getTargetResourceDisplayName()

public String getTargetResourceDisplayName()

Output only. The human friendly name of the target resource.

string target_resource_display_name = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
String

The targetResourceDisplayName.

getTargetResourceDisplayNameBytes()

public ByteString getTargetResourceDisplayNameBytes()

Output only. The human friendly name of the target resource.

string target_resource_display_name = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ByteString

The bytes for targetResourceDisplayName.

getTargetResourceLabels() (deprecated)

public Map<String,String> getTargetResourceLabels()
Returns
Type Description
Map<String,String>

getTargetResourceLabelsCount()

public int getTargetResourceLabelsCount()

Labels associated with the target resource.

map<string, string> target_resource_labels = 6;

Returns
Type Description
int

getTargetResourceLabelsMap()

public Map<String,String> getTargetResourceLabelsMap()

Labels associated with the target resource.

map<string, string> target_resource_labels = 6;

Returns
Type Description
Map<String,String>

getTargetResourceLabelsOrDefault(String key, String defaultValue)

public String getTargetResourceLabelsOrDefault(String key, String defaultValue)

Labels associated with the target resource.

map<string, string> target_resource_labels = 6;

Parameters
Name Description
key String
defaultValue String
Returns
Type Description
String

getTargetResourceLabelsOrThrow(String key)

public String getTargetResourceLabelsOrThrow(String key)

Labels associated with the target resource.

map<string, string> target_resource_labels = 6;

Parameter
Name Description
key String
Returns
Type Description
String

getTargetResourceType()

public ResourceBackupConfig.ResourceType getTargetResourceType()

Output only. The type of the target resource.

.google.cloud.backupdr.v1.ResourceBackupConfig.ResourceType target_resource_type = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ResourceBackupConfig.ResourceType

The targetResourceType.

getTargetResourceTypeValue()

public int getTargetResourceTypeValue()

Output only. The type of the target resource.

.google.cloud.backupdr.v1.ResourceBackupConfig.ResourceType target_resource_type = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
int

The enum numeric value on the wire for targetResourceType.

getUid()

public String getUid()

Output only. The unique identifier of the resource backup config.

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

Returns
Type Description
String

The uid.

getUidBytes()

public ByteString getUidBytes()

Output only. The unique identifier of the resource backup config.

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

Returns
Type Description
ByteString

The bytes for uid.

getVaulted()

public boolean getVaulted()

Output only. Whether the target resource is protected by a backup vault. This is true if the backup_configs_details is not empty and any of the ResourceBackupConfig.backup_configs_details has a backup configuration with BackupConfigDetails.backup_vault set. set.

bool vaulted = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

The vaulted.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.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.GeneratedMessageV3.internalGetMapFieldReflection(int)

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

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

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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