Package com.google.cloud.workstations.v1beta

Class Workstation

  • All Implemented Interfaces:
    WorkstationOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
    public final class Workstation
extends com.google.protobuf.GeneratedMessageV3
implements WorkstationOrBuilder
     A single instance of a developer workstation with its own persistent storage.
    Protobuf type google.cloud.workstations.v1beta.Workstation
    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.
        string name = 1;
        Specified by:
        getNameBytes in interface WorkstationOrBuilder
        Returns:
        The bytes for name.

      • getDisplayName

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

      • getDisplayNameBytes

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

      • getUid

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

      • getUidBytes

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

      • getReconciling

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

      • getAnnotationsCount

        public int getAnnotationsCount()
        Description copied from interface: WorkstationOrBuilder
         Optional. Client-specified annotations.
        map<string, string> annotations = 5 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getAnnotationsCount in interface WorkstationOrBuilder

      • 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 WorkstationOrBuilder

      • getAnnotationsOrThrow

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

      • getLabelsCount

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

      • containsLabels

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

      • getLabelsMap

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

      • getLabelsOrDefault

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

      • getLabelsOrThrow

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

      • hasCreateTime

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

      • getCreateTime

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

      • getCreateTimeOrBuilder

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

      • hasUpdateTime

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

      • getUpdateTime

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

      • getUpdateTimeOrBuilder

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

      • hasStartTime

        public boolean hasStartTime()
         Output only. Time when this workstation was most recently successfully
 started, regardless of the workstation's initial state.
        .google.protobuf.Timestamp start_time = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        hasStartTime in interface WorkstationOrBuilder
        Returns:
        Whether the startTime field is set.

      • getStartTime

        public com.google.protobuf.Timestamp getStartTime()
         Output only. Time when this workstation was most recently successfully
 started, regardless of the workstation's initial state.
        .google.protobuf.Timestamp start_time = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getStartTime in interface WorkstationOrBuilder
        Returns:
        The startTime.

      • getStartTimeOrBuilder

        public com.google.protobuf.TimestampOrBuilder getStartTimeOrBuilder()
         Output only. Time when this workstation was most recently successfully
 started, regardless of the workstation's initial state.
        .google.protobuf.Timestamp start_time = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getStartTimeOrBuilder in interface WorkstationOrBuilder

      • hasDeleteTime

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

      • getDeleteTime

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

      • getDeleteTimeOrBuilder

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

      • 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 WorkstationOrBuilder
        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 WorkstationOrBuilder
        Returns:
        The bytes for etag.

      • getStateValue

        public int getStateValue()
         Output only. Current state of the workstation.
        .google.cloud.workstations.v1beta.Workstation.State state = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getStateValue in interface WorkstationOrBuilder
        Returns:
        The enum numeric value on the wire for state.

      • getState

        public Workstation.State getState()
         Output only. Current state of the workstation.
        .google.cloud.workstations.v1beta.Workstation.State state = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getState in interface WorkstationOrBuilder
        Returns:
        The state.

      • getHost

        public String getHost()
         Output only. Host to which clients can send HTTPS traffic that will be
 received by the workstation. Authorized traffic will be received to the
 workstation as HTTP on port 80. To send traffic to a different port,
 clients may prefix the host with the destination port in the format
 `{port}-{host}`.
        string host = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getHost in interface WorkstationOrBuilder
        Returns:
        The host.

      • getHostBytes

        public com.google.protobuf.ByteString getHostBytes()
         Output only. Host to which clients can send HTTPS traffic that will be
 received by the workstation. Authorized traffic will be received to the
 workstation as HTTP on port 80. To send traffic to a different port,
 clients may prefix the host with the destination port in the format
 `{port}-{host}`.
        string host = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getHostBytes in interface WorkstationOrBuilder
        Returns:
        The bytes for host.

      • getEnvCount

        public int getEnvCount()
        Description copied from interface: WorkstationOrBuilder
         Optional. Environment variables passed to the workstation container's
 entrypoint.
        map<string, string> env = 12 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getEnvCount in interface WorkstationOrBuilder

      • containsEnv

        public boolean containsEnv​(String key)
         Optional. Environment variables passed to the workstation container's
 entrypoint.
        map<string, string> env = 12 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        containsEnv in interface WorkstationOrBuilder

      • getEnvMap

        public Map<String,​String> getEnvMap()
         Optional. Environment variables passed to the workstation container's
 entrypoint.
        map<string, string> env = 12 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getEnvMap in interface WorkstationOrBuilder

      • getEnvOrDefault

        public String getEnvOrDefault​(String key,
                              String defaultValue)
         Optional. Environment variables passed to the workstation container's
 entrypoint.
        map<string, string> env = 12 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getEnvOrDefault in interface WorkstationOrBuilder

      • getEnvOrThrow

        public String getEnvOrThrow​(String key)
         Optional. Environment variables passed to the workstation container's
 entrypoint.
        map<string, string> env = 12 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getEnvOrThrow in interface WorkstationOrBuilder

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • newBuilderForType

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

      • toBuilder

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

      • newBuilderForType

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

      • getDefaultInstance

        public static Workstation getDefaultInstance()

      • parser

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

      • getParserForType

        public com.google.protobuf.Parser<Workstation> 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 Workstation getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder