Package com.google.cloud.workstations.v1

Class WorkstationCluster

  • All Implemented Interfaces:
    WorkstationClusterOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
    public final class WorkstationCluster
extends com.google.protobuf.GeneratedMessageV3
implements WorkstationClusterOrBuilder
     A workstation cluster resource in the Cloud Workstations API.

 Defines a group of workstations in a particular region and the
 VPC network they're attached to.
    Protobuf type google.cloud.workstations.v1.WorkstationCluster
    See Also:
    Serialized Form

    • Method Detail

      • newInstance

        protected Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
        Overrides:
        newInstance in class com.google.protobuf.GeneratedMessageV3

      • getDescriptor

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

      • internalGetMapField

        protected com.google.protobuf.MapField internalGetMapField​(int number)
        Overrides:
        internalGetMapField in class com.google.protobuf.GeneratedMessageV3

      • internalGetFieldAccessorTable

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

      • getNameBytes

        public com.google.protobuf.ByteString getNameBytes()
         Full name of this workstation cluster.
        string name = 1;
        Specified by:
        getNameBytes in interface WorkstationClusterOrBuilder
        Returns:
        The bytes for name.

      • getDisplayName

        public String getDisplayName()
         Optional. Human-readable name for this workstation cluster.
        string display_name = 2 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getDisplayName in interface WorkstationClusterOrBuilder
        Returns:
        The displayName.

      • getDisplayNameBytes

        public com.google.protobuf.ByteString getDisplayNameBytes()
         Optional. Human-readable name for this workstation cluster.
        string display_name = 2 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getDisplayNameBytes in interface WorkstationClusterOrBuilder
        Returns:
        The bytes for displayName.

      • getUid

        public String getUid()
         Output only. A system-assigned unique identifier for this workstation
 cluster.
        string uid = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getUid in interface WorkstationClusterOrBuilder
        Returns:
        The uid.

      • getUidBytes

        public com.google.protobuf.ByteString getUidBytes()
         Output only. A system-assigned unique identifier for this workstation
 cluster.
        string uid = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getUidBytes in interface WorkstationClusterOrBuilder
        Returns:
        The bytes for uid.

      • getReconciling

        public boolean getReconciling()
         Output only. Indicates whether this workstation cluster is currently being
 updated to match its intended state.
        bool reconciling = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getReconciling in interface WorkstationClusterOrBuilder
        Returns:
        The reconciling.

      • containsAnnotations

        public boolean containsAnnotations​(String key)
         Optional. Client-specified annotations.
        map<string, string> annotations = 5 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        containsAnnotations in interface WorkstationClusterOrBuilder

      • getLabelsCount

        public int getLabelsCount()
        Description copied from interface: WorkstationClusterOrBuilder
         Optional.
 [Labels](https://cloud.google.com/workstations/docs/label-resources) that
 are applied to the workstation cluster and that are also propagated to the
 underlying Compute Engine resources.
        map<string, string> labels = 15 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getLabelsCount in interface WorkstationClusterOrBuilder

      • containsLabels

        public boolean containsLabels​(String key)
         Optional.
 [Labels](https://cloud.google.com/workstations/docs/label-resources) that
 are applied to the workstation cluster and that are also propagated to the
 underlying Compute Engine resources.
        map<string, string> labels = 15 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        containsLabels in interface WorkstationClusterOrBuilder

      • getLabelsMap

        public Map<String,​String> getLabelsMap()
         Optional.
 [Labels](https://cloud.google.com/workstations/docs/label-resources) that
 are applied to the workstation cluster and that are also propagated to the
 underlying Compute Engine resources.
        map<string, string> labels = 15 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getLabelsMap in interface WorkstationClusterOrBuilder

      • getLabelsOrDefault

        public String getLabelsOrDefault​(String key,
                                 String defaultValue)
         Optional.
 [Labels](https://cloud.google.com/workstations/docs/label-resources) that
 are applied to the workstation cluster and that are also propagated to the
 underlying Compute Engine resources.
        map<string, string> labels = 15 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getLabelsOrDefault in interface WorkstationClusterOrBuilder

      • getLabelsOrThrow

        public String getLabelsOrThrow​(String key)
         Optional.
 [Labels](https://cloud.google.com/workstations/docs/label-resources) that
 are applied to the workstation cluster and that are also propagated to the
 underlying Compute Engine resources.
        map<string, string> labels = 15 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getLabelsOrThrow in interface WorkstationClusterOrBuilder

      • hasCreateTime

        public boolean hasCreateTime()
         Output only. Time when this workstation cluster was created.
        .google.protobuf.Timestamp create_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        hasCreateTime in interface WorkstationClusterOrBuilder
        Returns:
        Whether the createTime field is set.

      • getCreateTime

        public com.google.protobuf.Timestamp getCreateTime()
         Output only. Time when this workstation cluster was created.
        .google.protobuf.Timestamp create_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getCreateTime in interface WorkstationClusterOrBuilder
        Returns:
        The createTime.

      • getCreateTimeOrBuilder

        public com.google.protobuf.TimestampOrBuilder getCreateTimeOrBuilder()
         Output only. Time when this workstation cluster was created.
        .google.protobuf.Timestamp create_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getCreateTimeOrBuilder in interface WorkstationClusterOrBuilder

      • hasUpdateTime

        public boolean hasUpdateTime()
         Output only. Time when this workstation cluster was most recently updated.
        .google.protobuf.Timestamp update_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        hasUpdateTime in interface WorkstationClusterOrBuilder
        Returns:
        Whether the updateTime field is set.

      • getUpdateTime

        public com.google.protobuf.Timestamp getUpdateTime()
         Output only. Time when this workstation cluster was most recently updated.
        .google.protobuf.Timestamp update_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getUpdateTime in interface WorkstationClusterOrBuilder
        Returns:
        The updateTime.

      • getUpdateTimeOrBuilder

        public com.google.protobuf.TimestampOrBuilder getUpdateTimeOrBuilder()
         Output only. Time when this workstation cluster was most recently updated.
        .google.protobuf.Timestamp update_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getUpdateTimeOrBuilder in interface WorkstationClusterOrBuilder

      • hasDeleteTime

        public boolean hasDeleteTime()
         Output only. Time when this workstation cluster was soft-deleted.
        .google.protobuf.Timestamp delete_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        hasDeleteTime in interface WorkstationClusterOrBuilder
        Returns:
        Whether the deleteTime field is set.

      • getDeleteTime

        public com.google.protobuf.Timestamp getDeleteTime()
         Output only. Time when this workstation cluster was soft-deleted.
        .google.protobuf.Timestamp delete_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getDeleteTime in interface WorkstationClusterOrBuilder
        Returns:
        The deleteTime.

      • getDeleteTimeOrBuilder

        public com.google.protobuf.TimestampOrBuilder getDeleteTimeOrBuilder()
         Output only. Time when this workstation cluster was soft-deleted.
        .google.protobuf.Timestamp delete_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getDeleteTimeOrBuilder in interface WorkstationClusterOrBuilder

      • getEtag

        public String getEtag()
         Optional. Checksum computed by the server. May be sent on update and delete
 requests to make sure that the client has an up-to-date value before
 proceeding.
        string etag = 9 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getEtag in interface WorkstationClusterOrBuilder
        Returns:
        The etag.

      • getEtagBytes

        public com.google.protobuf.ByteString getEtagBytes()
         Optional. Checksum computed by the server. May be sent on update and delete
 requests to make sure that the client has an up-to-date value before
 proceeding.
        string etag = 9 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getEtagBytes in interface WorkstationClusterOrBuilder
        Returns:
        The bytes for etag.

      • getNetwork

        public String getNetwork()
         Immutable. Name of the Compute Engine network in which instances associated
 with this workstation cluster will be created.
        string network = 10 [(.google.api.field_behavior) = IMMUTABLE];
        Specified by:
        getNetwork in interface WorkstationClusterOrBuilder
        Returns:
        The network.

      • getNetworkBytes

        public com.google.protobuf.ByteString getNetworkBytes()
         Immutable. Name of the Compute Engine network in which instances associated
 with this workstation cluster will be created.
        string network = 10 [(.google.api.field_behavior) = IMMUTABLE];
        Specified by:
        getNetworkBytes in interface WorkstationClusterOrBuilder
        Returns:
        The bytes for network.

      • getSubnetwork

        public String getSubnetwork()
         Immutable. Name of the Compute Engine subnetwork in which instances
 associated with this workstation cluster will be created. Must be part of
 the subnetwork specified for this workstation cluster.
        string subnetwork = 11 [(.google.api.field_behavior) = IMMUTABLE];
        Specified by:
        getSubnetwork in interface WorkstationClusterOrBuilder
        Returns:
        The subnetwork.

      • getSubnetworkBytes

        public com.google.protobuf.ByteString getSubnetworkBytes()
         Immutable. Name of the Compute Engine subnetwork in which instances
 associated with this workstation cluster will be created. Must be part of
 the subnetwork specified for this workstation cluster.
        string subnetwork = 11 [(.google.api.field_behavior) = IMMUTABLE];
        Specified by:
        getSubnetworkBytes in interface WorkstationClusterOrBuilder
        Returns:
        The bytes for subnetwork.

      • getControlPlaneIp

        public String getControlPlaneIp()
         Output only. The private IP address of the control plane for this
 workstation cluster. Workstation VMs need access to this IP address to work
 with the service, so make sure that your firewall rules allow egress from
 the workstation VMs to this address.
        string control_plane_ip = 16 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getControlPlaneIp in interface WorkstationClusterOrBuilder
        Returns:
        The controlPlaneIp.

      • getControlPlaneIpBytes

        public com.google.protobuf.ByteString getControlPlaneIpBytes()
         Output only. The private IP address of the control plane for this
 workstation cluster. Workstation VMs need access to this IP address to work
 with the service, so make sure that your firewall rules allow egress from
 the workstation VMs to this address.
        string control_plane_ip = 16 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getControlPlaneIpBytes in interface WorkstationClusterOrBuilder
        Returns:
        The bytes for controlPlaneIp.

      • hasPrivateClusterConfig

        public boolean hasPrivateClusterConfig()
         Optional. Configuration for private workstation cluster.
        .google.cloud.workstations.v1.WorkstationCluster.PrivateClusterConfig private_cluster_config = 12 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        hasPrivateClusterConfig in interface WorkstationClusterOrBuilder
        Returns:
        Whether the privateClusterConfig field is set.

      • getDegraded

        public boolean getDegraded()
         Output only. Whether this workstation cluster is in degraded mode, in which
 case it may require user action to restore full functionality. Details can
 be found in
 [conditions][google.cloud.workstations.v1.WorkstationCluster.conditions].
        bool degraded = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getDegraded in interface WorkstationClusterOrBuilder
        Returns:
        The degraded.

      • getConditionsList

        public List<com.google.rpc.Status> getConditionsList()
         Output only. Status conditions describing the workstation cluster's current
 state.
        repeated .google.rpc.Status conditions = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getConditionsList in interface WorkstationClusterOrBuilder

      • getConditionsOrBuilderList

        public List<? extends com.google.rpc.StatusOrBuilder> getConditionsOrBuilderList()
         Output only. Status conditions describing the workstation cluster's current
 state.
        repeated .google.rpc.Status conditions = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getConditionsOrBuilderList in interface WorkstationClusterOrBuilder

      • getConditionsCount

        public int getConditionsCount()
         Output only. Status conditions describing the workstation cluster's current
 state.
        repeated .google.rpc.Status conditions = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getConditionsCount in interface WorkstationClusterOrBuilder

      • getConditions

        public com.google.rpc.Status getConditions​(int index)
         Output only. Status conditions describing the workstation cluster's current
 state.
        repeated .google.rpc.Status conditions = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getConditions in interface WorkstationClusterOrBuilder

      • getConditionsOrBuilder

        public com.google.rpc.StatusOrBuilder getConditionsOrBuilder​(int index)
         Output only. Status conditions describing the workstation cluster's current
 state.
        repeated .google.rpc.Status conditions = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getConditionsOrBuilder in interface WorkstationClusterOrBuilder

      • isInitialized

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

      • 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.GeneratedMessageV3
        Throws:
        IOException

      • getSerializedSize

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

      • 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 WorkstationCluster parseFrom​(ByteBuffer data)
                                    throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • newBuilderForType

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

      • toBuilder

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

      • newBuilderForType

        protected WorkstationCluster.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3

      • getParserForType

        public com.google.protobuf.Parser<WorkstationCluster> 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.GeneratedMessageV3

      • getDefaultInstanceForType

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