Package com.google.cloud.compute.v1

Interface InstancePropertiesOrBuilder

  • All Superinterfaces:
    com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
    All Known Implementing Classes:
    InstanceProperties, InstanceProperties.Builder
    public interface InstancePropertiesOrBuilder
extends com.google.protobuf.MessageOrBuilder

    • Method Detail

      • hasAdvancedMachineFeatures

        boolean hasAdvancedMachineFeatures()
         Controls for advanced machine-related behavior features. Note that for MachineImage, this is not supported yet.
        optional .google.cloud.compute.v1.AdvancedMachineFeatures advanced_machine_features = 409646002;
        Returns:
        Whether the advancedMachineFeatures field is set.

      • getAdvancedMachineFeatures

        AdvancedMachineFeatures getAdvancedMachineFeatures()
         Controls for advanced machine-related behavior features. Note that for MachineImage, this is not supported yet.
        optional .google.cloud.compute.v1.AdvancedMachineFeatures advanced_machine_features = 409646002;
        Returns:
        The advancedMachineFeatures.

      • getAdvancedMachineFeaturesOrBuilder

        AdvancedMachineFeaturesOrBuilder getAdvancedMachineFeaturesOrBuilder()
         Controls for advanced machine-related behavior features. Note that for MachineImage, this is not supported yet.
        optional .google.cloud.compute.v1.AdvancedMachineFeatures advanced_machine_features = 409646002;

      • hasCanIpForward

        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 Enable IP forwarding documentation for more information.
        optional bool can_ip_forward = 467731324;
        Returns:
        Whether the canIpForward field is set.

      • getCanIpForward

        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 Enable IP forwarding documentation for more information.
        optional bool can_ip_forward = 467731324;
        Returns:
        The canIpForward.

      • hasConfidentialInstanceConfig

        boolean hasConfidentialInstanceConfig()
         Specifies the Confidential Instance options. Note that for MachineImage, this is not supported yet.
        optional .google.cloud.compute.v1.ConfidentialInstanceConfig confidential_instance_config = 490637685;
        Returns:
        Whether the confidentialInstanceConfig field is set.

      • getConfidentialInstanceConfig

        ConfidentialInstanceConfig getConfidentialInstanceConfig()
         Specifies the Confidential Instance options. Note that for MachineImage, this is not supported yet.
        optional .google.cloud.compute.v1.ConfidentialInstanceConfig confidential_instance_config = 490637685;
        Returns:
        The confidentialInstanceConfig.

      • getConfidentialInstanceConfigOrBuilder

        ConfidentialInstanceConfigOrBuilder getConfidentialInstanceConfigOrBuilder()
         Specifies the Confidential Instance options. Note that for MachineImage, this is not supported yet.
        optional .google.cloud.compute.v1.ConfidentialInstanceConfig confidential_instance_config = 490637685;

      • hasDescription

        boolean hasDescription()
         An optional text description for the instances that are created from these properties.
        optional string description = 422937596;
        Returns:
        Whether the description field is set.

      • getDescription

        String getDescription()
         An optional text description for the instances that are created from these properties.
        optional string description = 422937596;
        Returns:
        The description.

      • getDescriptionBytes

        com.google.protobuf.ByteString getDescriptionBytes()
         An optional text description for the instances that are created from these properties.
        optional string description = 422937596;
        Returns:
        The bytes for description.

      • getDisksList

        List<AttachedDisk> getDisksList()
         An array of disks that are associated with the instances that are created from these properties.
        repeated .google.cloud.compute.v1.AttachedDisk disks = 95594102;

      • getDisks

        AttachedDisk getDisks​(int index)
         An array of disks that are associated with the instances that are created from these properties.
        repeated .google.cloud.compute.v1.AttachedDisk disks = 95594102;

      • getDisksCount

        int getDisksCount()
         An array of disks that are associated with the instances that are created from these properties.
        repeated .google.cloud.compute.v1.AttachedDisk disks = 95594102;

      • getDisksOrBuilderList

        List<? extends AttachedDiskOrBuilder> getDisksOrBuilderList()
         An array of disks that are associated with the instances that are created from these properties.
        repeated .google.cloud.compute.v1.AttachedDisk disks = 95594102;

      • getDisksOrBuilder

        AttachedDiskOrBuilder getDisksOrBuilder​(int index)
         An array of disks that are associated with the instances that are created from these properties.
        repeated .google.cloud.compute.v1.AttachedDisk disks = 95594102;

      • getGuestAcceleratorsList

        List<AcceleratorConfig> getGuestAcceleratorsList()
         A list of guest accelerator cards' type and count to use for instances created from these properties.
        repeated .google.cloud.compute.v1.AcceleratorConfig guest_accelerators = 463595119;

      • getGuestAccelerators

        AcceleratorConfig getGuestAccelerators​(int index)
         A list of guest accelerator cards' type and count to use for instances created from these properties.
        repeated .google.cloud.compute.v1.AcceleratorConfig guest_accelerators = 463595119;

      • getGuestAcceleratorsCount

        int getGuestAcceleratorsCount()
         A list of guest accelerator cards' type and count to use for instances created from these properties.
        repeated .google.cloud.compute.v1.AcceleratorConfig guest_accelerators = 463595119;

      • getGuestAcceleratorsOrBuilderList

        List<? extends AcceleratorConfigOrBuilder> getGuestAcceleratorsOrBuilderList()
         A list of guest accelerator cards' type and count to use for instances created from these properties.
        repeated .google.cloud.compute.v1.AcceleratorConfig guest_accelerators = 463595119;

      • getGuestAcceleratorsOrBuilder

        AcceleratorConfigOrBuilder getGuestAcceleratorsOrBuilder​(int index)
         A list of guest accelerator cards' type and count to use for instances created from these properties.
        repeated .google.cloud.compute.v1.AcceleratorConfig guest_accelerators = 463595119;

      • hasKeyRevocationActionType

        boolean hasKeyRevocationActionType()
         KeyRevocationActionType of the instance. Supported options are "STOP" and "NONE". The default value is "NONE" if it is not specified.
 Check the KeyRevocationActionType enum for the list of possible values.
        optional string key_revocation_action_type = 235941474;
        Returns:
        Whether the keyRevocationActionType field is set.

      • getKeyRevocationActionType

        String getKeyRevocationActionType()
         KeyRevocationActionType of the instance. Supported options are "STOP" and "NONE". The default value is "NONE" if it is not specified.
 Check the KeyRevocationActionType enum for the list of possible values.
        optional string key_revocation_action_type = 235941474;
        Returns:
        The keyRevocationActionType.

      • getKeyRevocationActionTypeBytes

        com.google.protobuf.ByteString getKeyRevocationActionTypeBytes()
         KeyRevocationActionType of the instance. Supported options are "STOP" and "NONE". The default value is "NONE" if it is not specified.
 Check the KeyRevocationActionType enum for the list of possible values.
        optional string key_revocation_action_type = 235941474;
        Returns:
        The bytes for keyRevocationActionType.

      • getLabelsCount

        int getLabelsCount()
         Labels to apply to instances that are created from these properties.
        map<string, string> labels = 500195327;

      • containsLabels

        boolean containsLabels​(String key)
         Labels to apply to instances that are created from these properties.
        map<string, string> labels = 500195327;

      • getLabelsMap

        Map<String,​String> getLabelsMap()
         Labels to apply to instances that are created from these properties.
        map<string, string> labels = 500195327;

      • getLabelsOrDefault

        String getLabelsOrDefault​(String key,
                          String defaultValue)
         Labels to apply to instances that are created from these properties.
        map<string, string> labels = 500195327;

      • getLabelsOrThrow

        String getLabelsOrThrow​(String key)
         Labels to apply to instances that are created from these properties.
        map<string, string> labels = 500195327;

      • hasMachineType

        boolean hasMachineType()
         The machine type to use for instances that are created from these properties.
        optional string machine_type = 227711026;
        Returns:
        Whether the machineType field is set.

      • getMachineType

        String getMachineType()
         The machine type to use for instances that are created from these properties.
        optional string machine_type = 227711026;
        Returns:
        The machineType.

      • getMachineTypeBytes

        com.google.protobuf.ByteString getMachineTypeBytes()
         The machine type to use for instances that are created from these properties.
        optional string machine_type = 227711026;
        Returns:
        The bytes for machineType.

      • hasMetadata

        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 Project and instance metadata for more information.
        optional .google.cloud.compute.v1.Metadata metadata = 86866735;
        Returns:
        Whether the metadata field is set.

      • getMetadata

        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 Project and instance metadata for more information.
        optional .google.cloud.compute.v1.Metadata metadata = 86866735;
        Returns:
        The metadata.

      • getMetadataOrBuilder

        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 Project and instance metadata for more information.
        optional .google.cloud.compute.v1.Metadata metadata = 86866735;

      • hasMinCpuPlatform

        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 Specifying a Minimum CPU Platform.
        optional string min_cpu_platform = 242912759;
        Returns:
        Whether the minCpuPlatform field is set.

      • getMinCpuPlatform

        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 Specifying a Minimum CPU Platform.
        optional string min_cpu_platform = 242912759;
        Returns:
        The minCpuPlatform.

      • getMinCpuPlatformBytes

        com.google.protobuf.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 Specifying a Minimum CPU Platform.
        optional string min_cpu_platform = 242912759;
        Returns:
        The bytes for minCpuPlatform.

      • getNetworkInterfacesList

        List<NetworkInterface> getNetworkInterfacesList()
         An array of network access configurations for this interface.
        repeated .google.cloud.compute.v1.NetworkInterface network_interfaces = 52735243;

      • getNetworkInterfaces

        NetworkInterface getNetworkInterfaces​(int index)
         An array of network access configurations for this interface.
        repeated .google.cloud.compute.v1.NetworkInterface network_interfaces = 52735243;

      • getNetworkInterfacesCount

        int getNetworkInterfacesCount()
         An array of network access configurations for this interface.
        repeated .google.cloud.compute.v1.NetworkInterface network_interfaces = 52735243;

      • getNetworkInterfacesOrBuilderList

        List<? extends NetworkInterfaceOrBuilder> getNetworkInterfacesOrBuilderList()
         An array of network access configurations for this interface.
        repeated .google.cloud.compute.v1.NetworkInterface network_interfaces = 52735243;

      • getNetworkInterfacesOrBuilder

        NetworkInterfaceOrBuilder getNetworkInterfacesOrBuilder​(int index)
         An array of network access configurations for this interface.
        repeated .google.cloud.compute.v1.NetworkInterface network_interfaces = 52735243;

      • hasNetworkPerformanceConfig

        boolean hasNetworkPerformanceConfig()
         Note that for MachineImage, this is not supported yet.
        optional .google.cloud.compute.v1.NetworkPerformanceConfig network_performance_config = 398330850;
        Returns:
        Whether the networkPerformanceConfig field is set.

      • getNetworkPerformanceConfig

        NetworkPerformanceConfig getNetworkPerformanceConfig()
         Note that for MachineImage, this is not supported yet.
        optional .google.cloud.compute.v1.NetworkPerformanceConfig network_performance_config = 398330850;
        Returns:
        The networkPerformanceConfig.

      • getNetworkPerformanceConfigOrBuilder

        NetworkPerformanceConfigOrBuilder getNetworkPerformanceConfigOrBuilder()
         Note that for MachineImage, this is not supported yet.
        optional .google.cloud.compute.v1.NetworkPerformanceConfig network_performance_config = 398330850;

      • hasPrivateIpv6GoogleAccess

        boolean hasPrivateIpv6GoogleAccess()
         The private IPv6 google access type for VMs. If not specified, use INHERIT_FROM_SUBNETWORK as default. Note that for MachineImage, this is not supported yet.
 Check the PrivateIpv6GoogleAccess enum for the list of possible values.
        optional string private_ipv6_google_access = 48277006;
        Returns:
        Whether the privateIpv6GoogleAccess field is set.

      • getPrivateIpv6GoogleAccess

        String getPrivateIpv6GoogleAccess()
         The private IPv6 google access type for VMs. If not specified, use INHERIT_FROM_SUBNETWORK as default. Note that for MachineImage, this is not supported yet.
 Check the PrivateIpv6GoogleAccess enum for the list of possible values.
        optional string private_ipv6_google_access = 48277006;
        Returns:
        The privateIpv6GoogleAccess.

      • getPrivateIpv6GoogleAccessBytes

        com.google.protobuf.ByteString getPrivateIpv6GoogleAccessBytes()
         The private IPv6 google access type for VMs. If not specified, use INHERIT_FROM_SUBNETWORK as default. Note that for MachineImage, this is not supported yet.
 Check the PrivateIpv6GoogleAccess enum for the list of possible values.
        optional string private_ipv6_google_access = 48277006;
        Returns:
        The bytes for privateIpv6GoogleAccess.

      • hasReservationAffinity

        boolean hasReservationAffinity()
         Specifies the reservations that instances can consume from. Note that for MachineImage, this is not supported yet.
        optional .google.cloud.compute.v1.ReservationAffinity reservation_affinity = 157850683;
        Returns:
        Whether the reservationAffinity field is set.

      • getReservationAffinity

        ReservationAffinity getReservationAffinity()
         Specifies the reservations that instances can consume from. Note that for MachineImage, this is not supported yet.
        optional .google.cloud.compute.v1.ReservationAffinity reservation_affinity = 157850683;
        Returns:
        The reservationAffinity.

      • getReservationAffinityOrBuilder

        ReservationAffinityOrBuilder getReservationAffinityOrBuilder()
         Specifies the reservations that instances can consume from. Note that for MachineImage, this is not supported yet.
        optional .google.cloud.compute.v1.ReservationAffinity reservation_affinity = 157850683;

      • getResourceManagerTagsCount

        int getResourceManagerTagsCount()
         Resource manager tags to be bound to the instance. Tag keys and values have the same definition as resource manager tags. Keys must be in the format `tagKeys/{tag_key_id}`, and values are in the format `tagValues/456`. The field is ignored (both PUT & PATCH) when empty.
        map<string, string> resource_manager_tags = 377671164;

      • containsResourceManagerTags

        boolean containsResourceManagerTags​(String key)
         Resource manager tags to be bound to the instance. Tag keys and values have the same definition as resource manager tags. Keys must be in the format `tagKeys/{tag_key_id}`, and values are in the format `tagValues/456`. The field is ignored (both PUT & PATCH) when empty.
        map<string, string> resource_manager_tags = 377671164;

      • getResourceManagerTagsMap

        Map<String,​String> getResourceManagerTagsMap()
         Resource manager tags to be bound to the instance. Tag keys and values have the same definition as resource manager tags. Keys must be in the format `tagKeys/{tag_key_id}`, and values are in the format `tagValues/456`. The field is ignored (both PUT & PATCH) when empty.
        map<string, string> resource_manager_tags = 377671164;

      • getResourceManagerTagsOrDefault

        String getResourceManagerTagsOrDefault​(String key,
                                       String defaultValue)
         Resource manager tags to be bound to the instance. Tag keys and values have the same definition as resource manager tags. Keys must be in the format `tagKeys/{tag_key_id}`, and values are in the format `tagValues/456`. The field is ignored (both PUT & PATCH) when empty.
        map<string, string> resource_manager_tags = 377671164;

      • getResourceManagerTagsOrThrow

        String getResourceManagerTagsOrThrow​(String key)
         Resource manager tags to be bound to the instance. Tag keys and values have the same definition as resource manager tags. Keys must be in the format `tagKeys/{tag_key_id}`, and values are in the format `tagValues/456`. The field is ignored (both PUT & PATCH) when empty.
        map<string, string> resource_manager_tags = 377671164;

      • getResourcePoliciesList

        List<String> getResourcePoliciesList()
         Resource policies (names, not URLs) applied to instances created from these properties. Note that for MachineImage, this is not supported yet.
        repeated string resource_policies = 22220385;
        Returns:
        A list containing the resourcePolicies.

      • getResourcePoliciesCount

        int getResourcePoliciesCount()
         Resource policies (names, not URLs) applied to instances created from these properties. Note that for MachineImage, this is not supported yet.
        repeated string resource_policies = 22220385;
        Returns:
        The count of resourcePolicies.

      • getResourcePolicies

        String getResourcePolicies​(int index)
         Resource policies (names, not URLs) applied to instances created from these properties. Note that for MachineImage, this is not supported yet.
        repeated string resource_policies = 22220385;
        Parameters:
        index - The index of the element to return.
        Returns:
        The resourcePolicies at the given index.

      • getResourcePoliciesBytes

        com.google.protobuf.ByteString getResourcePoliciesBytes​(int index)
         Resource policies (names, not URLs) applied to instances created from these properties. Note that for MachineImage, this is not supported yet.
        repeated string resource_policies = 22220385;
        Parameters:
        index - The index of the value to return.
        Returns:
        The bytes of the resourcePolicies at the given index.

      • hasScheduling

        boolean hasScheduling()
         Specifies the scheduling options for the instances that are created from these properties.
        optional .google.cloud.compute.v1.Scheduling scheduling = 386688404;
        Returns:
        Whether the scheduling field is set.

      • getScheduling

        Scheduling getScheduling()
         Specifies the scheduling options for the instances that are created from these properties.
        optional .google.cloud.compute.v1.Scheduling scheduling = 386688404;
        Returns:
        The scheduling.

      • getSchedulingOrBuilder

        SchedulingOrBuilder getSchedulingOrBuilder()
         Specifies the scheduling options for the instances that are created from these properties.
        optional .google.cloud.compute.v1.Scheduling scheduling = 386688404;

      • getServiceAccountsList

        List<ServiceAccount> getServiceAccountsList()
         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.compute.v1.ServiceAccount service_accounts = 277537328;

      • getServiceAccounts

        ServiceAccount getServiceAccounts​(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.compute.v1.ServiceAccount service_accounts = 277537328;

      • getServiceAccountsCount

        int getServiceAccountsCount()
         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.compute.v1.ServiceAccount service_accounts = 277537328;

      • getServiceAccountsOrBuilderList

        List<? extends ServiceAccountOrBuilder> getServiceAccountsOrBuilderList()
         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.compute.v1.ServiceAccount service_accounts = 277537328;

      • getServiceAccountsOrBuilder

        ServiceAccountOrBuilder getServiceAccountsOrBuilder​(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.compute.v1.ServiceAccount service_accounts = 277537328;

      • hasShieldedInstanceConfig

        boolean hasShieldedInstanceConfig()
         Note that for MachineImage, this is not supported yet.
        optional .google.cloud.compute.v1.ShieldedInstanceConfig shielded_instance_config = 12862901;
        Returns:
        Whether the shieldedInstanceConfig field is set.

      • getShieldedInstanceConfig

        ShieldedInstanceConfig getShieldedInstanceConfig()
         Note that for MachineImage, this is not supported yet.
        optional .google.cloud.compute.v1.ShieldedInstanceConfig shielded_instance_config = 12862901;
        Returns:
        The shieldedInstanceConfig.

      • getShieldedInstanceConfigOrBuilder

        ShieldedInstanceConfigOrBuilder getShieldedInstanceConfigOrBuilder()
         Note that for MachineImage, this is not supported yet.
        optional .google.cloud.compute.v1.ShieldedInstanceConfig shielded_instance_config = 12862901;

      • hasTags

        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.
        optional .google.cloud.compute.v1.Tags tags = 3552281;
        Returns:
        Whether the tags field is set.

      • getTags

        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.
        optional .google.cloud.compute.v1.Tags tags = 3552281;
        Returns:
        The tags.

      • getTagsOrBuilder

        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.
        optional .google.cloud.compute.v1.Tags tags = 3552281;