Class Workstation (0.10.0)

public final class Workstation extends GeneratedMessageV3 implements WorkstationOrBuilder

A single instance of a developer workstation with its own persistent storage.

Protobuf type google.cloud.workstations.v1beta.Workstation

Static Fields

ANNOTATIONS_FIELD_NUMBER

public static final int ANNOTATIONS_FIELD_NUMBER
Field Value
TypeDescription
int

CREATE_TIME_FIELD_NUMBER

public static final int CREATE_TIME_FIELD_NUMBER
Field Value
TypeDescription
int

DELETE_TIME_FIELD_NUMBER

public static final int DELETE_TIME_FIELD_NUMBER
Field Value
TypeDescription
int

DISPLAY_NAME_FIELD_NUMBER

public static final int DISPLAY_NAME_FIELD_NUMBER
Field Value
TypeDescription
int

ENV_FIELD_NUMBER

public static final int ENV_FIELD_NUMBER
Field Value
TypeDescription
int

ETAG_FIELD_NUMBER

public static final int ETAG_FIELD_NUMBER
Field Value
TypeDescription
int

HOST_FIELD_NUMBER

public static final int HOST_FIELD_NUMBER
Field Value
TypeDescription
int

LABELS_FIELD_NUMBER

public static final int LABELS_FIELD_NUMBER
Field Value
TypeDescription
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
TypeDescription
int

RECONCILING_FIELD_NUMBER

public static final int RECONCILING_FIELD_NUMBER
Field Value
TypeDescription
int

STATE_FIELD_NUMBER

public static final int STATE_FIELD_NUMBER
Field Value
TypeDescription
int

UID_FIELD_NUMBER

public static final int UID_FIELD_NUMBER
Field Value
TypeDescription
int

UPDATE_TIME_FIELD_NUMBER

public static final int UPDATE_TIME_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static Workstation getDefaultInstance()
Returns
TypeDescription
Workstation

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

public static Workstation.Builder newBuilder()
Returns
TypeDescription
Workstation.Builder

newBuilder(Workstation prototype)

public static Workstation.Builder newBuilder(Workstation prototype)
Parameter
NameDescription
prototypeWorkstation
Returns
TypeDescription
Workstation.Builder

parseDelimitedFrom(InputStream input)

public static Workstation parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
Workstation
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Workstation parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Workstation
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static Workstation parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
Workstation
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static Workstation parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Workstation
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static Workstation parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
Workstation
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static Workstation parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Workstation
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static Workstation parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
Workstation
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static Workstation parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Workstation
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static Workstation parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
Workstation
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Workstation parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Workstation
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static Workstation parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
Workstation
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static Workstation parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Workstation
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<Workstation> parser()
Returns
TypeDescription
Parser<Workstation>

Methods

containsAnnotations(String key)

public boolean containsAnnotations(String key)

Client-specified annotations.

map<string, string> annotations = 5;

Parameter
NameDescription
keyString
Returns
TypeDescription
boolean

containsEnv(String key)

public boolean containsEnv(String key)

Environment variables passed to the workstation container's entrypoint.

map<string, string> env = 12;

Parameter
NameDescription
keyString
Returns
TypeDescription
boolean

containsLabels(String key)

public boolean containsLabels(String key)

Client-specified labels that are applied to the resource and that are also propagated to the underlying Compute Engine resources.

map<string, string> labels = 13;

Parameter
NameDescription
keyString
Returns
TypeDescription
boolean

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getAnnotations()

public Map<String,String> getAnnotations()

Use #getAnnotationsMap() instead.

Returns
TypeDescription
Map<String,String>

getAnnotationsCount()

public int getAnnotationsCount()

Client-specified annotations.

map<string, string> annotations = 5;

Returns
TypeDescription
int

getAnnotationsMap()

public Map<String,String> getAnnotationsMap()

Client-specified annotations.

map<string, string> annotations = 5;

Returns
TypeDescription
Map<String,String>

getAnnotationsOrDefault(String key, String defaultValue)

public String getAnnotationsOrDefault(String key, String defaultValue)

Client-specified annotations.

map<string, string> annotations = 5;

Parameters
NameDescription
keyString
defaultValueString
Returns
TypeDescription
String

getAnnotationsOrThrow(String key)

public String getAnnotationsOrThrow(String key)

Client-specified annotations.

map<string, string> annotations = 5;

Parameter
NameDescription
keyString
Returns
TypeDescription
String

getCreateTime()

public Timestamp getCreateTime()

Output only. Time when this resource was created.

.google.protobuf.Timestamp create_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
Timestamp

The createTime.

getCreateTimeOrBuilder()

public TimestampOrBuilder getCreateTimeOrBuilder()

Output only. Time when this resource was created.

.google.protobuf.Timestamp create_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
TimestampOrBuilder

getDefaultInstanceForType()

public Workstation getDefaultInstanceForType()
Returns
TypeDescription
Workstation

getDeleteTime()

public Timestamp getDeleteTime()

Output only. Time when this resource was soft-deleted.

.google.protobuf.Timestamp delete_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
Timestamp

The deleteTime.

getDeleteTimeOrBuilder()

public TimestampOrBuilder getDeleteTimeOrBuilder()

Output only. Time when this resource was soft-deleted.

.google.protobuf.Timestamp delete_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
TimestampOrBuilder

getDisplayName()

public String getDisplayName()

Human-readable name for this resource.

string display_name = 2;

Returns
TypeDescription
String

The displayName.

getDisplayNameBytes()

public ByteString getDisplayNameBytes()

Human-readable name for this resource.

string display_name = 2;

Returns
TypeDescription
ByteString

The bytes for displayName.

getEnv()

public Map<String,String> getEnv()

Use #getEnvMap() instead.

Returns
TypeDescription
Map<String,String>

getEnvCount()

public int getEnvCount()

Environment variables passed to the workstation container's entrypoint.

map<string, string> env = 12;

Returns
TypeDescription
int

getEnvMap()

public Map<String,String> getEnvMap()

Environment variables passed to the workstation container's entrypoint.

map<string, string> env = 12;

Returns
TypeDescription
Map<String,String>

getEnvOrDefault(String key, String defaultValue)

public String getEnvOrDefault(String key, String defaultValue)

Environment variables passed to the workstation container's entrypoint.

map<string, string> env = 12;

Parameters
NameDescription
keyString
defaultValueString
Returns
TypeDescription
String

getEnvOrThrow(String key)

public String getEnvOrThrow(String key)

Environment variables passed to the workstation container's entrypoint.

map<string, string> env = 12;

Parameter
NameDescription
keyString
Returns
TypeDescription
String

getEtag()

public String getEtag()

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;

Returns
TypeDescription
String

The etag.

getEtagBytes()

public ByteString getEtagBytes()

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;

Returns
TypeDescription
ByteString

The bytes for etag.

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

Returns
TypeDescription
String

The host.

getHostBytes()

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

Returns
TypeDescription
ByteString

The bytes for host.

getLabels()

public Map<String,String> getLabels()

Use #getLabelsMap() instead.

Returns
TypeDescription
Map<String,String>

getLabelsCount()

public int getLabelsCount()

Client-specified labels that are applied to the resource and that are also propagated to the underlying Compute Engine resources.

map<string, string> labels = 13;

Returns
TypeDescription
int

getLabelsMap()

public Map<String,String> getLabelsMap()

Client-specified labels that are applied to the resource and that are also propagated to the underlying Compute Engine resources.

map<string, string> labels = 13;

Returns
TypeDescription
Map<String,String>

getLabelsOrDefault(String key, String defaultValue)

public String getLabelsOrDefault(String key, String defaultValue)

Client-specified labels that are applied to the resource and that are also propagated to the underlying Compute Engine resources.

map<string, string> labels = 13;

Parameters
NameDescription
keyString
defaultValueString
Returns
TypeDescription
String

getLabelsOrThrow(String key)

public String getLabelsOrThrow(String key)

Client-specified labels that are applied to the resource and that are also propagated to the underlying Compute Engine resources.

map<string, string> labels = 13;

Parameter
NameDescription
keyString
Returns
TypeDescription
String

getName()

public String getName()

Full name of this resource.

string name = 1;

Returns
TypeDescription
String

The name.

getNameBytes()

public ByteString getNameBytes()

Full name of this resource.

string name = 1;

Returns
TypeDescription
ByteString

The bytes for name.

getParserForType()

public Parser<Workstation> getParserForType()
Returns
TypeDescription
Parser<Workstation>
Overrides

getReconciling()

public boolean getReconciling()

Output only. Indicates whether this resource is currently being updated to match its intended state.

bool reconciling = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
boolean

The reconciling.

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

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

Returns
TypeDescription
Workstation.State

The state.

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

Returns
TypeDescription
int

The enum numeric value on the wire for state.

getUid()

public String getUid()

Output only. A system-assigned unique identified for this resource.

string uid = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
String

The uid.

getUidBytes()

public ByteString getUidBytes()

Output only. A system-assigned unique identified for this resource.

string uid = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
ByteString

The bytes for uid.

getUpdateTime()

public Timestamp getUpdateTime()

Output only. Time when this resource was most recently updated.

.google.protobuf.Timestamp update_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
Timestamp

The updateTime.

getUpdateTimeOrBuilder()

public TimestampOrBuilder getUpdateTimeOrBuilder()

Output only. Time when this resource was most recently updated.

.google.protobuf.Timestamp update_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
TimestampOrBuilder

hasCreateTime()

public boolean hasCreateTime()

Output only. Time when this resource was created.

.google.protobuf.Timestamp create_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
boolean

Whether the createTime field is set.

hasDeleteTime()

public boolean hasDeleteTime()

Output only. Time when this resource was soft-deleted.

.google.protobuf.Timestamp delete_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
boolean

Whether the deleteTime field is set.

hasUpdateTime()

public boolean hasUpdateTime()

Output only. Time when this resource was most recently updated.

.google.protobuf.Timestamp update_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
boolean

Whether the updateTime field is set.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

internalGetMapField(int number)

protected MapField internalGetMapField(int number)
Parameter
NameDescription
numberint
Returns
TypeDescription
MapField
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public Workstation.Builder newBuilderForType()
Returns
TypeDescription
Workstation.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected Workstation.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
Workstation.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public Workstation.Builder toBuilder()
Returns
TypeDescription
Workstation.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides
Exceptions
TypeDescription
IOException