Interface ComputeInstanceBackupPropertiesOrBuilder (0.12.0)

Version latest

• 0.12.0 (latest)
• 0.11.0
• 0.10.0
• 0.8.0
• 0.7.0
• 0.6.0
• 0.5.0
• 0.4.0
• 0.3.0
• 0.2.0
• 0.1.0

public interface ComputeInstanceBackupPropertiesOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

containsLabels(String key)

public abstract boolean containsLabels(String key)

Labels to apply to instances that are created from these properties.

map<string, string> labels = 14;

Parameter
Name	Description
key	String

Returns
Type	Description
boolean

getCanIpForward()

public abstract boolean getCanIpForward()

Enables instances created based on these properties to send packets with source IP addresses other than their own and receive packets with destination IP addresses other than their own. If these instances will be used as an IP gateway or it will be set as the next-hop in a Route resource, specify true. If unsure, leave this set to false. See the https://cloud.google.com/vpc/docs/using-routes#canipforward documentation for more information.

optional bool can_ip_forward = 4;

Returns
Type	Description
boolean	The canIpForward.

getDescription()

public abstract String getDescription()

An optional text description for the instances that are created from these properties.

optional string description = 1;

Returns
Type	Description
String	The description.

getDescriptionBytes()

public abstract ByteString getDescriptionBytes()

An optional text description for the instances that are created from these properties.

optional string description = 1;

Returns
Type	Description
ByteString	The bytes for description.

getDisk(int index)

public abstract AttachedDisk getDisk(int index)

An array of disks that are associated with the instances that are created from these properties.

repeated .google.cloud.backupdr.v1.AttachedDisk disk = 6;

Parameter
Name	Description
index	int

Returns
Type	Description
AttachedDisk

getDiskCount()

public abstract int getDiskCount()

An array of disks that are associated with the instances that are created from these properties.

repeated .google.cloud.backupdr.v1.AttachedDisk disk = 6;

Returns
Type	Description
int

getDiskList()

public abstract List<AttachedDisk> getDiskList()

An array of disks that are associated with the instances that are created from these properties.

repeated .google.cloud.backupdr.v1.AttachedDisk disk = 6;

Returns
Type	Description
List<AttachedDisk>

getDiskOrBuilder(int index)

public abstract AttachedDiskOrBuilder getDiskOrBuilder(int index)

An array of disks that are associated with the instances that are created from these properties.

repeated .google.cloud.backupdr.v1.AttachedDisk disk = 6;

Parameter
Name	Description
index	int

Returns
Type	Description
AttachedDiskOrBuilder

getDiskOrBuilderList()

public abstract List<? extends AttachedDiskOrBuilder> getDiskOrBuilderList()

An array of disks that are associated with the instances that are created from these properties.

repeated .google.cloud.backupdr.v1.AttachedDisk disk = 6;

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

getGuestAccelerator(int index)

public abstract AcceleratorConfig getGuestAccelerator(int index)

A list of guest accelerator cards' type and count to use for instances created from these properties.

repeated .google.cloud.backupdr.v1.AcceleratorConfig guest_accelerator = 10;

Parameter
Name	Description
index	int

Returns
Type	Description
AcceleratorConfig

getGuestAcceleratorCount()

public abstract int getGuestAcceleratorCount()

A list of guest accelerator cards' type and count to use for instances created from these properties.

repeated .google.cloud.backupdr.v1.AcceleratorConfig guest_accelerator = 10;

Returns
Type	Description
int

getGuestAcceleratorList()

public abstract List<AcceleratorConfig> getGuestAcceleratorList()

A list of guest accelerator cards' type and count to use for instances created from these properties.

repeated .google.cloud.backupdr.v1.AcceleratorConfig guest_accelerator = 10;

Returns
Type	Description
List<AcceleratorConfig>

getGuestAcceleratorOrBuilder(int index)

public abstract AcceleratorConfigOrBuilder getGuestAcceleratorOrBuilder(int index)

A list of guest accelerator cards' type and count to use for instances created from these properties.

repeated .google.cloud.backupdr.v1.AcceleratorConfig guest_accelerator = 10;

Parameter
Name	Description
index	int

Returns
Type	Description
AcceleratorConfigOrBuilder

getGuestAcceleratorOrBuilderList()

public abstract List<? extends AcceleratorConfigOrBuilder> getGuestAcceleratorOrBuilderList()

A list of guest accelerator cards' type and count to use for instances created from these properties.

repeated .google.cloud.backupdr.v1.AcceleratorConfig guest_accelerator = 10;

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

getKeyRevocationActionType()

public abstract KeyRevocationActionType getKeyRevocationActionType()

KeyRevocationActionType of the instance. Supported options are "STOP" and "NONE". The default value is "NONE" if it is not specified.

optional .google.cloud.backupdr.v1.KeyRevocationActionType key_revocation_action_type = 12;

Returns
Type	Description
KeyRevocationActionType	The keyRevocationActionType.

getKeyRevocationActionTypeValue()

public abstract int getKeyRevocationActionTypeValue()

KeyRevocationActionType of the instance. Supported options are "STOP" and "NONE". The default value is "NONE" if it is not specified.

optional .google.cloud.backupdr.v1.KeyRevocationActionType key_revocation_action_type = 12;

Returns
Type	Description
int	The enum numeric value on the wire for keyRevocationActionType.

getLabels() (deprecated)

public abstract Map<String,String> getLabels()

Use #getLabelsMap() instead.

Returns
Type	Description
Map<String,String>

getLabelsCount()

public abstract int getLabelsCount()

Labels to apply to instances that are created from these properties.

map<string, string> labels = 14;

Returns
Type	Description
int

getLabelsMap()

public abstract Map<String,String> getLabelsMap()

Labels to apply to instances that are created from these properties.

map<string, string> labels = 14;

Returns
Type	Description
Map<String,String>

getLabelsOrDefault(String key, String defaultValue)

public abstract String getLabelsOrDefault(String key, String defaultValue)

Labels to apply to instances that are created from these properties.

map<string, string> labels = 14;

Parameters
Name	Description
key	String
defaultValue	String

Returns
Type	Description
String

getLabelsOrThrow(String key)

public abstract String getLabelsOrThrow(String key)

Labels to apply to instances that are created from these properties.

map<string, string> labels = 14;

Parameter
Name	Description
key	String

Returns
Type	Description
String

getMachineType()

public abstract String getMachineType()

The machine type to use for instances that are created from these properties.

optional string machine_type = 3;

Returns
Type	Description
String	The machineType.

getMachineTypeBytes()

public abstract ByteString getMachineTypeBytes()

The machine type to use for instances that are created from these properties.

optional string machine_type = 3;

Returns
Type	Description
ByteString	The bytes for machineType.

getMetadata()

public abstract Metadata getMetadata()

The metadata key/value pairs to assign to instances that are created from these properties. These pairs can consist of custom metadata or predefined keys. See https://cloud.google.com/compute/docs/metadata/overview for more information.

optional .google.cloud.backupdr.v1.Metadata metadata = 7;

Returns
Type	Description
Metadata	The metadata.

getMetadataOrBuilder()

public abstract MetadataOrBuilder getMetadataOrBuilder()

The metadata key/value pairs to assign to instances that are created from these properties. These pairs can consist of custom metadata or predefined keys. See https://cloud.google.com/compute/docs/metadata/overview for more information.

optional .google.cloud.backupdr.v1.Metadata metadata = 7;

Returns
Type	Description
MetadataOrBuilder

getMinCpuPlatform()

public abstract String getMinCpuPlatform()

Minimum cpu/platform to be used by instances. The instance may be scheduled on the specified or newer cpu/platform. Applicable values are the friendly names of CPU platforms, such as minCpuPlatform: Intel Haswell or minCpuPlatform: Intel Sandy Bridge. For more information, read https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform.

optional string min_cpu_platform = 11;

Returns
Type	Description
String	The minCpuPlatform.

getMinCpuPlatformBytes()

public abstract ByteString getMinCpuPlatformBytes()

Minimum cpu/platform to be used by instances. The instance may be scheduled on the specified or newer cpu/platform. Applicable values are the friendly names of CPU platforms, such as minCpuPlatform: Intel Haswell or minCpuPlatform: Intel Sandy Bridge. For more information, read https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform.

optional string min_cpu_platform = 11;

Returns
Type	Description
ByteString	The bytes for minCpuPlatform.

getNetworkInterface(int index)

public abstract NetworkInterface getNetworkInterface(int index)

An array of network access configurations for this interface.

repeated .google.cloud.backupdr.v1.NetworkInterface network_interface = 5;

Parameter
Name	Description
index	int

Returns
Type	Description
NetworkInterface

getNetworkInterfaceCount()

public abstract int getNetworkInterfaceCount()

An array of network access configurations for this interface.

repeated .google.cloud.backupdr.v1.NetworkInterface network_interface = 5;

Returns
Type	Description
int

getNetworkInterfaceList()

public abstract List<NetworkInterface> getNetworkInterfaceList()

An array of network access configurations for this interface.

repeated .google.cloud.backupdr.v1.NetworkInterface network_interface = 5;

Returns
Type	Description
List<NetworkInterface>

getNetworkInterfaceOrBuilder(int index)

public abstract NetworkInterfaceOrBuilder getNetworkInterfaceOrBuilder(int index)

An array of network access configurations for this interface.

repeated .google.cloud.backupdr.v1.NetworkInterface network_interface = 5;

Parameter
Name	Description
index	int

Returns
Type	Description
NetworkInterfaceOrBuilder

getNetworkInterfaceOrBuilderList()

public abstract List<? extends NetworkInterfaceOrBuilder> getNetworkInterfaceOrBuilderList()

An array of network access configurations for this interface.

repeated .google.cloud.backupdr.v1.NetworkInterface network_interface = 5;

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

getScheduling()

public abstract Scheduling getScheduling()

Specifies the scheduling options for the instances that are created from these properties.

optional .google.cloud.backupdr.v1.Scheduling scheduling = 9;

Returns
Type	Description
Scheduling	The scheduling.

getSchedulingOrBuilder()

public abstract SchedulingOrBuilder getSchedulingOrBuilder()

Specifies the scheduling options for the instances that are created from these properties.

optional .google.cloud.backupdr.v1.Scheduling scheduling = 9;

Returns
Type	Description
SchedulingOrBuilder

getServiceAccount(int index)

public abstract ServiceAccount getServiceAccount(int index)

A list of service accounts with specified scopes. Access tokens for these service accounts are available to the instances that are created from these properties. Use metadata queries to obtain the access tokens for these instances.

repeated .google.cloud.backupdr.v1.ServiceAccount service_account = 8;

Parameter
Name	Description
index	int

Returns
Type	Description
ServiceAccount

getServiceAccountCount()

public abstract int getServiceAccountCount()

A list of service accounts with specified scopes. Access tokens for these service accounts are available to the instances that are created from these properties. Use metadata queries to obtain the access tokens for these instances.

repeated .google.cloud.backupdr.v1.ServiceAccount service_account = 8;

Returns
Type	Description
int

getServiceAccountList()

public abstract List<ServiceAccount> getServiceAccountList()

A list of service accounts with specified scopes. Access tokens for these service accounts are available to the instances that are created from these properties. Use metadata queries to obtain the access tokens for these instances.

repeated .google.cloud.backupdr.v1.ServiceAccount service_account = 8;

Returns
Type	Description
List<ServiceAccount>

getServiceAccountOrBuilder(int index)

public abstract ServiceAccountOrBuilder getServiceAccountOrBuilder(int index)

A list of service accounts with specified scopes. Access tokens for these service accounts are available to the instances that are created from these properties. Use metadata queries to obtain the access tokens for these instances.

repeated .google.cloud.backupdr.v1.ServiceAccount service_account = 8;

Parameter
Name	Description
index	int

Returns
Type	Description
ServiceAccountOrBuilder

getServiceAccountOrBuilderList()

public abstract List<? extends ServiceAccountOrBuilder> getServiceAccountOrBuilderList()

A list of service accounts with specified scopes. Access tokens for these service accounts are available to the instances that are created from these properties. Use metadata queries to obtain the access tokens for these instances.

repeated .google.cloud.backupdr.v1.ServiceAccount service_account = 8;

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

getSourceInstance()

public abstract String getSourceInstance()

The source instance used to create this backup. This can be a partial or full URL to the resource. For example, the following are valid values: -https://www.googleapis.com/compute/v1/projects/project/zones/zone/instances/instance -projects/project/zones/zone/instances/instance

optional string source_instance = 13;

Returns
Type	Description
String	The sourceInstance.

getSourceInstanceBytes()

public abstract ByteString getSourceInstanceBytes()

The source instance used to create this backup. This can be a partial or full URL to the resource. For example, the following are valid values: -https://www.googleapis.com/compute/v1/projects/project/zones/zone/instances/instance -projects/project/zones/zone/instances/instance

optional string source_instance = 13;

Returns
Type	Description
ByteString	The bytes for sourceInstance.

getTags()

public abstract Tags getTags()

A list of tags to apply to the instances that are created from these properties. The tags identify valid sources or targets for network firewalls. The setTags method can modify this list of tags. Each tag within the list must comply with RFC1035 (https://www.ietf.org/rfc/rfc1035.txt).

optional .google.cloud.backupdr.v1.Tags tags = 2;

Returns
Type	Description
Tags	The tags.

getTagsOrBuilder()

public abstract TagsOrBuilder getTagsOrBuilder()

A list of tags to apply to the instances that are created from these properties. The tags identify valid sources or targets for network firewalls. The setTags method can modify this list of tags. Each tag within the list must comply with RFC1035 (https://www.ietf.org/rfc/rfc1035.txt).

optional .google.cloud.backupdr.v1.Tags tags = 2;

Returns
Type	Description
TagsOrBuilder

hasCanIpForward()

public abstract boolean hasCanIpForward()

Enables instances created based on these properties to send packets with source IP addresses other than their own and receive packets with destination IP addresses other than their own. If these instances will be used as an IP gateway or it will be set as the next-hop in a Route resource, specify true. If unsure, leave this set to false. See the https://cloud.google.com/vpc/docs/using-routes#canipforward documentation for more information.

optional bool can_ip_forward = 4;

Returns
Type	Description
boolean	Whether the canIpForward field is set.

hasDescription()

public abstract boolean hasDescription()

An optional text description for the instances that are created from these properties.

optional string description = 1;

Returns
Type	Description
boolean	Whether the description field is set.

hasKeyRevocationActionType()

public abstract boolean hasKeyRevocationActionType()

KeyRevocationActionType of the instance. Supported options are "STOP" and "NONE". The default value is "NONE" if it is not specified.

optional .google.cloud.backupdr.v1.KeyRevocationActionType key_revocation_action_type = 12;

Returns
Type	Description
boolean	Whether the keyRevocationActionType field is set.

hasMachineType()

public abstract boolean hasMachineType()

The machine type to use for instances that are created from these properties.

optional string machine_type = 3;

Returns
Type	Description
boolean	Whether the machineType field is set.

hasMetadata()

public abstract boolean hasMetadata()

The metadata key/value pairs to assign to instances that are created from these properties. These pairs can consist of custom metadata or predefined keys. See https://cloud.google.com/compute/docs/metadata/overview for more information.

optional .google.cloud.backupdr.v1.Metadata metadata = 7;

Returns
Type	Description
boolean	Whether the metadata field is set.

hasMinCpuPlatform()

public abstract boolean hasMinCpuPlatform()

Minimum cpu/platform to be used by instances. The instance may be scheduled on the specified or newer cpu/platform. Applicable values are the friendly names of CPU platforms, such as minCpuPlatform: Intel Haswell or minCpuPlatform: Intel Sandy Bridge. For more information, read https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform.

optional string min_cpu_platform = 11;

Returns
Type	Description
boolean	Whether the minCpuPlatform field is set.

hasScheduling()

public abstract boolean hasScheduling()

Specifies the scheduling options for the instances that are created from these properties.

optional .google.cloud.backupdr.v1.Scheduling scheduling = 9;

Returns
Type	Description
boolean	Whether the scheduling field is set.

hasSourceInstance()

public abstract boolean hasSourceInstance()

The source instance used to create this backup. This can be a partial or full URL to the resource. For example, the following are valid values: -https://www.googleapis.com/compute/v1/projects/project/zones/zone/instances/instance -projects/project/zones/zone/instances/instance

optional string source_instance = 13;

Returns
Type	Description
boolean	Whether the sourceInstance field is set.

hasTags()

public abstract boolean hasTags()

A list of tags to apply to the instances that are created from these properties. The tags identify valid sources or targets for network firewalls. The setTags method can modify this list of tags. Each tag within the list must comply with RFC1035 (https://www.ietf.org/rfc/rfc1035.txt).

optional .google.cloud.backupdr.v1.Tags tags = 2;

Returns
Type	Description
boolean	Whether the tags field is set.