Package com.google.cloud.compute.v1

Class InstanceGroup

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.cloud.compute.v1.InstanceGroup
All Implemented Interfaces:
InstanceGroupOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
@Generated public final class InstanceGroup extends com.google.protobuf.GeneratedMessage implements InstanceGroupOrBuilder
 Represents an Instance Group resource.

 Instance Groups can be used to configure a target forload
 balancing.

 Instance groups can either be managed or unmanaged.

 To create
 managed instance groups, use the instanceGroupManager orregionInstanceGroupManager resource instead.

 Use zonal unmanaged instance groups if you need to applyload
 balancing to groups of heterogeneous instances or if you need to manage
 the instances yourself. You cannot create regional unmanaged instance groups.

 For more information, readInstance
 groups.
Protobuf type google.cloud.compute.v1.InstanceGroup
See Also:

  • Field Details

  • Method Details

    • getDescriptor

      public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage

    • hasCreationTimestamp

      public boolean hasCreationTimestamp()
       Output only. [Output Only] The creation timestamp for this instance group inRFC3339
 text format.
      optional string creation_timestamp = 30525366;
      Specified by:
      hasCreationTimestamp in interface InstanceGroupOrBuilder
      Returns:
      Whether the creationTimestamp field is set.

    • getCreationTimestamp

      public String getCreationTimestamp()
       Output only. [Output Only] The creation timestamp for this instance group inRFC3339
 text format.
      optional string creation_timestamp = 30525366;
      Specified by:
      getCreationTimestamp in interface InstanceGroupOrBuilder
      Returns:
      The creationTimestamp.

    • getCreationTimestampBytes

      public com.google.protobuf.ByteString getCreationTimestampBytes()
       Output only. [Output Only] The creation timestamp for this instance group inRFC3339
 text format.
      optional string creation_timestamp = 30525366;
      Specified by:
      getCreationTimestampBytes in interface InstanceGroupOrBuilder
      Returns:
      The bytes for creationTimestamp.

    • hasDescription

      public boolean hasDescription()
       An optional description of this resource. Provide this property when you
 create the resource.
      optional string description = 422937596;
      Specified by:
      hasDescription in interface InstanceGroupOrBuilder
      Returns:
      Whether the description field is set.

    • getDescription

      public String getDescription()
       An optional description of this resource. Provide this property when you
 create the resource.
      optional string description = 422937596;
      Specified by:
      getDescription in interface InstanceGroupOrBuilder
      Returns:
      The description.

    • getDescriptionBytes

      public com.google.protobuf.ByteString getDescriptionBytes()
       An optional description of this resource. Provide this property when you
 create the resource.
      optional string description = 422937596;
      Specified by:
      getDescriptionBytes in interface InstanceGroupOrBuilder
      Returns:
      The bytes for description.

    • hasFingerprint

      public boolean hasFingerprint()
       Output only. [Output Only] The fingerprint of the named ports. The system
 uses this fingerprint to detect conflicts when multiple users change the
 named ports concurrently.
      optional string fingerprint = 234678500;
      Specified by:
      hasFingerprint in interface InstanceGroupOrBuilder
      Returns:
      Whether the fingerprint field is set.

    • getFingerprint

      public String getFingerprint()
       Output only. [Output Only] The fingerprint of the named ports. The system
 uses this fingerprint to detect conflicts when multiple users change the
 named ports concurrently.
      optional string fingerprint = 234678500;
      Specified by:
      getFingerprint in interface InstanceGroupOrBuilder
      Returns:
      The fingerprint.

    • getFingerprintBytes

      public com.google.protobuf.ByteString getFingerprintBytes()
       Output only. [Output Only] The fingerprint of the named ports. The system
 uses this fingerprint to detect conflicts when multiple users change the
 named ports concurrently.
      optional string fingerprint = 234678500;
      Specified by:
      getFingerprintBytes in interface InstanceGroupOrBuilder
      Returns:
      The bytes for fingerprint.

    • hasId

      public boolean hasId()
       Output only. [Output Only] A unique identifier for this instance group, generated
 by the server.
      optional uint64 id = 3355;
      Specified by:
      hasId in interface InstanceGroupOrBuilder
      Returns:
      Whether the id field is set.

    • getId

      public long getId()
       Output only. [Output Only] A unique identifier for this instance group, generated
 by the server.
      optional uint64 id = 3355;
      Specified by:
      getId in interface InstanceGroupOrBuilder
      Returns:
      The id.

    • hasKind

      public boolean hasKind()
       Output only. [Output Only] The resource type, which is alwayscompute#instanceGroup for instance groups.
      optional string kind = 3292052;
      Specified by:
      hasKind in interface InstanceGroupOrBuilder
      Returns:
      Whether the kind field is set.

    • getKind

      public String getKind()
       Output only. [Output Only] The resource type, which is alwayscompute#instanceGroup for instance groups.
      optional string kind = 3292052;
      Specified by:
      getKind in interface InstanceGroupOrBuilder
      Returns:
      The kind.

    • getKindBytes

      public com.google.protobuf.ByteString getKindBytes()
       Output only. [Output Only] The resource type, which is alwayscompute#instanceGroup for instance groups.
      optional string kind = 3292052;
      Specified by:
      getKindBytes in interface InstanceGroupOrBuilder
      Returns:
      The bytes for kind.

    • hasName

      public boolean hasName()
       The name of the instance group. The name must be 1-63 characters
 long, and comply withRFC1035.
      optional string name = 3373707;
      Specified by:
      hasName in interface InstanceGroupOrBuilder
      Returns:
      Whether the name field is set.

    • getName

      public String getName()
       The name of the instance group. The name must be 1-63 characters
 long, and comply withRFC1035.
      optional string name = 3373707;
      Specified by:
      getName in interface InstanceGroupOrBuilder
      Returns:
      The name.

    • getNameBytes

      public com.google.protobuf.ByteString getNameBytes()
       The name of the instance group. The name must be 1-63 characters
 long, and comply withRFC1035.
      optional string name = 3373707;
      Specified by:
      getNameBytes in interface InstanceGroupOrBuilder
      Returns:
      The bytes for name.

    • getNamedPortsList

      public List<NamedPort> getNamedPortsList()
       Optional. Assigns a name to a port number. For example:{name: "http", port: 80}

 This
 allows the system to reference ports by the assigned name instead of a
 port number. Named ports can also contain multiple ports. For example:[{name: "app1", port: 8080}, {name:
 "app1", port: 8081}, {name: "app2", port:
 8082}]

 Named ports apply to all instances in this instance group.
      repeated .google.cloud.compute.v1.NamedPort named_ports = 427598732;
      Specified by:
      getNamedPortsList in interface InstanceGroupOrBuilder

    • getNamedPortsOrBuilderList

      public List<? extends NamedPortOrBuilder> getNamedPortsOrBuilderList()
       Optional. Assigns a name to a port number. For example:{name: "http", port: 80}

 This
 allows the system to reference ports by the assigned name instead of a
 port number. Named ports can also contain multiple ports. For example:[{name: "app1", port: 8080}, {name:
 "app1", port: 8081}, {name: "app2", port:
 8082}]

 Named ports apply to all instances in this instance group.
      repeated .google.cloud.compute.v1.NamedPort named_ports = 427598732;
      Specified by:
      getNamedPortsOrBuilderList in interface InstanceGroupOrBuilder

    • getNamedPortsCount

      public int getNamedPortsCount()
       Optional. Assigns a name to a port number. For example:{name: "http", port: 80}

 This
 allows the system to reference ports by the assigned name instead of a
 port number. Named ports can also contain multiple ports. For example:[{name: "app1", port: 8080}, {name:
 "app1", port: 8081}, {name: "app2", port:
 8082}]

 Named ports apply to all instances in this instance group.
      repeated .google.cloud.compute.v1.NamedPort named_ports = 427598732;
      Specified by:
      getNamedPortsCount in interface InstanceGroupOrBuilder

    • getNamedPorts

      public NamedPort getNamedPorts(int index)
       Optional. Assigns a name to a port number. For example:{name: "http", port: 80}

 This
 allows the system to reference ports by the assigned name instead of a
 port number. Named ports can also contain multiple ports. For example:[{name: "app1", port: 8080}, {name:
 "app1", port: 8081}, {name: "app2", port:
 8082}]

 Named ports apply to all instances in this instance group.
      repeated .google.cloud.compute.v1.NamedPort named_ports = 427598732;
      Specified by:
      getNamedPorts in interface InstanceGroupOrBuilder

    • getNamedPortsOrBuilder

      public NamedPortOrBuilder getNamedPortsOrBuilder(int index)
       Optional. Assigns a name to a port number. For example:{name: "http", port: 80}

 This
 allows the system to reference ports by the assigned name instead of a
 port number. Named ports can also contain multiple ports. For example:[{name: "app1", port: 8080}, {name:
 "app1", port: 8081}, {name: "app2", port:
 8082}]

 Named ports apply to all instances in this instance group.
      repeated .google.cloud.compute.v1.NamedPort named_ports = 427598732;
      Specified by:
      getNamedPortsOrBuilder in interface InstanceGroupOrBuilder

    • hasNetwork

      public boolean hasNetwork()
       [Output Only] The URL of the network to which all instances in the
 instance group belong. If your instance has multiple network interfaces,
 then the network and subnetwork fields only refer to the
 network and subnet used by your primary interface (nic0).
      optional string network = 232872494;
      Specified by:
      hasNetwork in interface InstanceGroupOrBuilder
      Returns:
      Whether the network field is set.

    • getNetwork

      public String getNetwork()
       [Output Only] The URL of the network to which all instances in the
 instance group belong. If your instance has multiple network interfaces,
 then the network and subnetwork fields only refer to the
 network and subnet used by your primary interface (nic0).
      optional string network = 232872494;
      Specified by:
      getNetwork in interface InstanceGroupOrBuilder
      Returns:
      The network.

    • getNetworkBytes

      public com.google.protobuf.ByteString getNetworkBytes()
       [Output Only] The URL of the network to which all instances in the
 instance group belong. If your instance has multiple network interfaces,
 then the network and subnetwork fields only refer to the
 network and subnet used by your primary interface (nic0).
      optional string network = 232872494;
      Specified by:
      getNetworkBytes in interface InstanceGroupOrBuilder
      Returns:
      The bytes for network.

    • hasRegion

      public boolean hasRegion()
       Output only. [Output Only] The URL of theregion
 where the instance group is located (for regional resources).
      optional string region = 138946292;
      Specified by:
      hasRegion in interface InstanceGroupOrBuilder
      Returns:
      Whether the region field is set.

    • getRegion

      public String getRegion()
       Output only. [Output Only] The URL of theregion
 where the instance group is located (for regional resources).
      optional string region = 138946292;
      Specified by:
      getRegion in interface InstanceGroupOrBuilder
      Returns:
      The region.

    • getRegionBytes

      public com.google.protobuf.ByteString getRegionBytes()
       Output only. [Output Only] The URL of theregion
 where the instance group is located (for regional resources).
      optional string region = 138946292;
      Specified by:
      getRegionBytes in interface InstanceGroupOrBuilder
      Returns:
      The bytes for region.

    • hasSelfLink

      public boolean hasSelfLink()
       Output only. [Output Only] The URL for this instance group. The server generates
 this URL.
      optional string self_link = 456214797;
      Specified by:
      hasSelfLink in interface InstanceGroupOrBuilder
      Returns:
      Whether the selfLink field is set.

    • getSelfLink

      public String getSelfLink()
       Output only. [Output Only] The URL for this instance group. The server generates
 this URL.
      optional string self_link = 456214797;
      Specified by:
      getSelfLink in interface InstanceGroupOrBuilder
      Returns:
      The selfLink.

    • getSelfLinkBytes

      public com.google.protobuf.ByteString getSelfLinkBytes()
       Output only. [Output Only] The URL for this instance group. The server generates
 this URL.
      optional string self_link = 456214797;
      Specified by:
      getSelfLinkBytes in interface InstanceGroupOrBuilder
      Returns:
      The bytes for selfLink.

    • hasSize

      public boolean hasSize()
       Output only. [Output Only] The total number of instances in the instance group.
      optional int32 size = 3530753;
      Specified by:
      hasSize in interface InstanceGroupOrBuilder
      Returns:
      Whether the size field is set.

    • getSize

      public int getSize()
       Output only. [Output Only] The total number of instances in the instance group.
      optional int32 size = 3530753;
      Specified by:
      getSize in interface InstanceGroupOrBuilder
      Returns:
      The size.

    • hasSubnetwork

      public boolean hasSubnetwork()
       Output only. [Output Only] The URL of the subnetwork to which all instances in the
 instance group belong. If your instance has multiple network interfaces,
 then the network and subnetwork fields only refer to the
 network and subnet used by your primary interface (nic0).
      optional string subnetwork = 307827694;
      Specified by:
      hasSubnetwork in interface InstanceGroupOrBuilder
      Returns:
      Whether the subnetwork field is set.

    • getSubnetwork

      public String getSubnetwork()
       Output only. [Output Only] The URL of the subnetwork to which all instances in the
 instance group belong. If your instance has multiple network interfaces,
 then the network and subnetwork fields only refer to the
 network and subnet used by your primary interface (nic0).
      optional string subnetwork = 307827694;
      Specified by:
      getSubnetwork in interface InstanceGroupOrBuilder
      Returns:
      The subnetwork.

    • getSubnetworkBytes

      public com.google.protobuf.ByteString getSubnetworkBytes()
       Output only. [Output Only] The URL of the subnetwork to which all instances in the
 instance group belong. If your instance has multiple network interfaces,
 then the network and subnetwork fields only refer to the
 network and subnet used by your primary interface (nic0).
      optional string subnetwork = 307827694;
      Specified by:
      getSubnetworkBytes in interface InstanceGroupOrBuilder
      Returns:
      The bytes for subnetwork.

    • hasZone

      public boolean hasZone()
       Output only. [Output Only] The URL of thezone
 where the instance group is located (for zonal resources).
      optional string zone = 3744684;
      Specified by:
      hasZone in interface InstanceGroupOrBuilder
      Returns:
      Whether the zone field is set.

    • getZone

      public String getZone()
       Output only. [Output Only] The URL of thezone
 where the instance group is located (for zonal resources).
      optional string zone = 3744684;
      Specified by:
      getZone in interface InstanceGroupOrBuilder
      Returns:
      The zone.

    • getZoneBytes

      public com.google.protobuf.ByteString getZoneBytes()
       Output only. [Output Only] The URL of thezone
 where the instance group is located (for zonal resources).
      optional string zone = 3744684;
      Specified by:
      getZoneBytes in interface InstanceGroupOrBuilder
      Returns:
      The bytes for zone.

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage

    • writeTo

      public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException
      Specified by:
      writeTo in interface com.google.protobuf.MessageLite
      Overrides:
      writeTo in class com.google.protobuf.GeneratedMessage
      Throws:
      IOException

    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessage

    • equals

      public boolean equals(Object obj)
      Specified by:
      equals in interface com.google.protobuf.Message
      Overrides:
      equals in class com.google.protobuf.AbstractMessage

    • hashCode

      public int hashCode()
      Specified by:
      hashCode in interface com.google.protobuf.Message
      Overrides:
      hashCode in class com.google.protobuf.AbstractMessage

    • parseFrom

      public static InstanceGroup parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static InstanceGroup parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static InstanceGroup parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static InstanceGroup parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static InstanceGroup parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static InstanceGroup parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static InstanceGroup parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static InstanceGroup parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static InstanceGroup parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static InstanceGroup parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static InstanceGroup parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static InstanceGroup parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilderForType

      public InstanceGroup.Builder newBuilderForType()
      Specified by:
      newBuilderForType in interface com.google.protobuf.Message
      Specified by:
      newBuilderForType in interface com.google.protobuf.MessageLite

    • newBuilder

      public static InstanceGroup.Builder newBuilder()

    • newBuilder

      public static InstanceGroup.Builder newBuilder(InstanceGroup prototype)

    • toBuilder

      public InstanceGroup.Builder toBuilder()
      Specified by:
      toBuilder in interface com.google.protobuf.Message
      Specified by:
      toBuilder in interface com.google.protobuf.MessageLite

    • newBuilderForType

      protected InstanceGroup.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
      Overrides:
      newBuilderForType in class com.google.protobuf.AbstractMessage

    • getDefaultInstance

      public static InstanceGroup getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<InstanceGroup> parser()

    • getParserForType

      public com.google.protobuf.Parser<InstanceGroup> getParserForType()
      Specified by:
      getParserForType in interface com.google.protobuf.Message
      Specified by:
      getParserForType in interface com.google.protobuf.MessageLite
      Overrides:
      getParserForType in class com.google.protobuf.GeneratedMessage

    • getDefaultInstanceForType

      public InstanceGroup getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder