Package com.google.cloud.workstations.v1

Interface WorkstationClusterOrBuilder

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

    • Method Detail

      • getName

        String getName()
         Full name of this workstation cluster.
        string name = 1;
        Returns:
        The name.

      • getNameBytes

        com.google.protobuf.ByteString getNameBytes()
         Full name of this workstation cluster.
        string name = 1;
        Returns:
        The bytes for name.

      • getDisplayName

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

      • getDisplayNameBytes

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

      • getUid

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

      • getUidBytes

        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];
        Returns:
        The bytes for uid.

      • getReconciling

        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];
        Returns:
        The reconciling.

      • getAnnotationsCount

        int getAnnotationsCount()
         Optional. Client-specified annotations.
        map<string, string> annotations = 5 [(.google.api.field_behavior) = OPTIONAL];

      • containsAnnotations

        boolean containsAnnotations​(String key)
         Optional. Client-specified annotations.
        map<string, string> annotations = 5 [(.google.api.field_behavior) = OPTIONAL];

      • getAnnotationsMap

        Map<String,​String> getAnnotationsMap()
         Optional. Client-specified annotations.
        map<string, string> annotations = 5 [(.google.api.field_behavior) = OPTIONAL];

      • getAnnotationsOrDefault

        String getAnnotationsOrDefault​(String key,
                               String defaultValue)
         Optional. Client-specified annotations.
        map<string, string> annotations = 5 [(.google.api.field_behavior) = OPTIONAL];

      • getAnnotationsOrThrow

        String getAnnotationsOrThrow​(String key)
         Optional. Client-specified annotations.
        map<string, string> annotations = 5 [(.google.api.field_behavior) = OPTIONAL];

      • getLabelsCount

        int getLabelsCount()
         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];

      • containsLabels

        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];

      • getLabelsMap

        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];

      • getLabelsOrDefault

        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];

      • getLabelsOrThrow

        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];

      • hasCreateTime

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

      • getCreateTime

        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];
        Returns:
        The createTime.

      • getCreateTimeOrBuilder

        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];

      • hasUpdateTime

        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];
        Returns:
        Whether the updateTime field is set.

      • getUpdateTime

        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];
        Returns:
        The updateTime.

      • getUpdateTimeOrBuilder

        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];

      • hasDeleteTime

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

      • getDeleteTime

        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];
        Returns:
        The deleteTime.

      • getDeleteTimeOrBuilder

        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];

      • getEtag

        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];
        Returns:
        The etag.

      • getEtagBytes

        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];
        Returns:
        The bytes for etag.

      • getNetwork

        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];
        Returns:
        The network.

      • getNetworkBytes

        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];
        Returns:
        The bytes for network.

      • getSubnetwork

        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];
        Returns:
        The subnetwork.

      • getSubnetworkBytes

        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];
        Returns:
        The bytes for subnetwork.

      • getControlPlaneIp

        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];
        Returns:
        The controlPlaneIp.

      • getControlPlaneIpBytes

        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];
        Returns:
        The bytes for controlPlaneIp.

      • hasPrivateClusterConfig

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

      • getPrivateClusterConfig

        WorkstationCluster.PrivateClusterConfig getPrivateClusterConfig()
         Optional. Configuration for private workstation cluster.
        .google.cloud.workstations.v1.WorkstationCluster.PrivateClusterConfig private_cluster_config = 12 [(.google.api.field_behavior) = OPTIONAL];
        Returns:
        The privateClusterConfig.

      • getPrivateClusterConfigOrBuilder

        WorkstationCluster.PrivateClusterConfigOrBuilder getPrivateClusterConfigOrBuilder()
         Optional. Configuration for private workstation cluster.
        .google.cloud.workstations.v1.WorkstationCluster.PrivateClusterConfig private_cluster_config = 12 [(.google.api.field_behavior) = OPTIONAL];

      • getDegraded

        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];
        Returns:
        The degraded.

      • getConditionsList

        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];

      • getConditions

        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];

      • getConditionsCount

        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];

      • getConditionsOrBuilderList

        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];

      • getConditionsOrBuilder

        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];