Class Environment (2.46.0)

public final class Environment extends GeneratedMessageV3 implements EnvironmentOrBuilder

A Cloud Shell environment, which is defined as the combination of a Docker image specifying what is installed on the environment and a home directory containing the user's data that will remain across sessions. Each user has at least an environment with the ID "default".

Protobuf type google.cloud.shell.v1.Environment

Static Fields

DOCKER_IMAGE_FIELD_NUMBER

public static final int DOCKER_IMAGE_FIELD_NUMBER
Field Value
Type Description
int

ID_FIELD_NUMBER

public static final int ID_FIELD_NUMBER
Field Value
Type Description
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
Type Description
int

PUBLIC_KEYS_FIELD_NUMBER

public static final int PUBLIC_KEYS_FIELD_NUMBER
Field Value
Type Description
int

SSH_HOST_FIELD_NUMBER

public static final int SSH_HOST_FIELD_NUMBER
Field Value
Type Description
int

SSH_PORT_FIELD_NUMBER

public static final int SSH_PORT_FIELD_NUMBER
Field Value
Type Description
int

SSH_USERNAME_FIELD_NUMBER

public static final int SSH_USERNAME_FIELD_NUMBER
Field Value
Type Description
int

STATE_FIELD_NUMBER

public static final int STATE_FIELD_NUMBER
Field Value
Type Description
int

WEB_HOST_FIELD_NUMBER

public static final int WEB_HOST_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static Environment getDefaultInstance()
Returns
Type Description
Environment

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static Environment.Builder newBuilder()
Returns
Type Description
Environment.Builder

newBuilder(Environment prototype)

public static Environment.Builder newBuilder(Environment prototype)
Parameter
Name Description
prototype Environment
Returns
Type Description
Environment.Builder

parseDelimitedFrom(InputStream input)

public static Environment parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
Environment
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Environment parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Environment
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static Environment parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
Environment
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static Environment parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Environment
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static Environment parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
Environment
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static Environment parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Environment
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static Environment parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
Environment
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static Environment parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Environment
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static Environment parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
Environment
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Environment parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Environment
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static Environment parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
Environment
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static Environment parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Environment
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<Environment> parser()
Returns
Type Description
Parser<Environment>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getDefaultInstanceForType()

public Environment getDefaultInstanceForType()
Returns
Type Description
Environment

getDockerImage()

public String getDockerImage()

Required. Immutable. Full path to the Docker image used to run this environment, e.g. "gcr.io/dev-con/cloud-devshell:latest".

string docker_image = 3 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];

Returns
Type Description
String

The dockerImage.

getDockerImageBytes()

public ByteString getDockerImageBytes()

Required. Immutable. Full path to the Docker image used to run this environment, e.g. "gcr.io/dev-con/cloud-devshell:latest".

string docker_image = 3 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];

Returns
Type Description
ByteString

The bytes for dockerImage.

getId()

public String getId()

Output only. The environment's identifier, unique among the user's environments.

string id = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
String

The id.

getIdBytes()

public ByteString getIdBytes()

Output only. The environment's identifier, unique among the user's environments.

string id = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ByteString

The bytes for id.

getName()

public String getName()

Immutable. Full name of this resource, in the format users/{owner_email}/environments/{environment_id}. {owner_email} is the email address of the user to whom this environment belongs, and {environment_id} is the identifier of this environment. For example, users/someone@example.com/environments/default.

string name = 1 [(.google.api.field_behavior) = IMMUTABLE];

Returns
Type Description
String

The name.

getNameBytes()

public ByteString getNameBytes()

Immutable. Full name of this resource, in the format users/{owner_email}/environments/{environment_id}. {owner_email} is the email address of the user to whom this environment belongs, and {environment_id} is the identifier of this environment. For example, users/someone@example.com/environments/default.

string name = 1 [(.google.api.field_behavior) = IMMUTABLE];

Returns
Type Description
ByteString

The bytes for name.

getParserForType()

public Parser<Environment> getParserForType()
Returns
Type Description
Parser<Environment>
Overrides

getPublicKeys(int index)

public String getPublicKeys(int index)

Output only. Public keys associated with the environment. Clients can connect to this environment via SSH only if they possess a private key corresponding to at least one of these public keys. Keys can be added to or removed from the environment using the AddPublicKey and RemovePublicKey methods.

repeated string public_keys = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
index int

The index of the element to return.

Returns
Type Description
String

The publicKeys at the given index.

getPublicKeysBytes(int index)

public ByteString getPublicKeysBytes(int index)

Output only. Public keys associated with the environment. Clients can connect to this environment via SSH only if they possess a private key corresponding to at least one of these public keys. Keys can be added to or removed from the environment using the AddPublicKey and RemovePublicKey methods.

repeated string public_keys = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
index int

The index of the value to return.

Returns
Type Description
ByteString

The bytes of the publicKeys at the given index.

getPublicKeysCount()

public int getPublicKeysCount()

Output only. Public keys associated with the environment. Clients can connect to this environment via SSH only if they possess a private key corresponding to at least one of these public keys. Keys can be added to or removed from the environment using the AddPublicKey and RemovePublicKey methods.

repeated string public_keys = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
int

The count of publicKeys.

getPublicKeysList()

public ProtocolStringList getPublicKeysList()

Output only. Public keys associated with the environment. Clients can connect to this environment via SSH only if they possess a private key corresponding to at least one of these public keys. Keys can be added to or removed from the environment using the AddPublicKey and RemovePublicKey methods.

repeated string public_keys = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ProtocolStringList

A list containing the publicKeys.

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getSshHost()

public String getSshHost()

Output only. Host to which clients can connect to initiate SSH sessions with the environment.

string ssh_host = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
String

The sshHost.

getSshHostBytes()

public ByteString getSshHostBytes()

Output only. Host to which clients can connect to initiate SSH sessions with the environment.

string ssh_host = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ByteString

The bytes for sshHost.

getSshPort()

public int getSshPort()

Output only. Port to which clients can connect to initiate SSH sessions with the environment.

int32 ssh_port = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
int

The sshPort.

getSshUsername()

public String getSshUsername()

Output only. Username that clients should use when initiating SSH sessions with the environment.

string ssh_username = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
String

The sshUsername.

getSshUsernameBytes()

public ByteString getSshUsernameBytes()

Output only. Username that clients should use when initiating SSH sessions with the environment.

string ssh_username = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ByteString

The bytes for sshUsername.

getState()

public Environment.State getState()

Output only. Current execution state of this environment.

.google.cloud.shell.v1.Environment.State state = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Environment.State

The state.

getStateValue()

public int getStateValue()

Output only. Current execution state of this environment.

.google.cloud.shell.v1.Environment.State state = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
int

The enum numeric value on the wire for state.

getWebHost()

public String getWebHost()

Output only. Host to which clients can connect to initiate HTTPS or WSS connections with the environment.

string web_host = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
String

The webHost.

getWebHostBytes()

public ByteString getWebHostBytes()

Output only. Host to which clients can connect to initiate HTTPS or WSS connections with the environment.

string web_host = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ByteString

The bytes for webHost.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public Environment.Builder newBuilderForType()
Returns
Type Description
Environment.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected Environment.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
Environment.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public Environment.Builder toBuilder()
Returns
Type Description
Environment.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException