Class Environment (2.74.0)

publicfinalclass EnvironmentextendsGeneratedMessageV3implementsEnvironmentOrBuilder

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

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > Environment

Implements

EnvironmentOrBuilder

Inherited Members

publicstaticfinalintDOCKER_IMAGE_FIELD_NUMBER

publicstaticfinalintID_FIELD_NUMBER

publicstaticfinalintNAME_FIELD_NUMBER

publicstaticfinalintPUBLIC_KEYS_FIELD_NUMBER

publicstaticfinalintSSH_HOST_FIELD_NUMBER

publicstaticfinalintSSH_PORT_FIELD_NUMBER

publicstaticfinalintSSH_USERNAME_FIELD_NUMBER

publicstaticfinalintSTATE_FIELD_NUMBER

publicstaticfinalintWEB_HOST_FIELD_NUMBER

publicstaticEnvironmentgetDefaultInstance()

publicstaticfinalDescriptors.DescriptorgetDescriptor()

publicstaticEnvironment.BuildernewBuilder()

publicstaticEnvironment.BuildernewBuilder(Environmentprototype)

publicstaticEnvironmentparseDelimitedFrom(InputStreaminput)

publicstaticEnvironmentparseDelimitedFrom(InputStreaminput,ExtensionRegistryLiteextensionRegistry)

publicstaticEnvironmentparseFrom(byte[]data)

publicstaticEnvironmentparseFrom(byte[]data,ExtensionRegistryLiteextensionRegistry)

publicstaticEnvironmentparseFrom(ByteStringdata)

publicstaticEnvironmentparseFrom(ByteStringdata,ExtensionRegistryLiteextensionRegistry)

publicstaticEnvironmentparseFrom(CodedInputStreaminput)

publicstaticEnvironmentparseFrom(CodedInputStreaminput,ExtensionRegistryLiteextensionRegistry)

publicstaticEnvironmentparseFrom(InputStreaminput)

publicstaticEnvironmentparseFrom(InputStreaminput,ExtensionRegistryLiteextensionRegistry)

publicstaticEnvironmentparseFrom(ByteBufferdata)

publicstaticEnvironmentparseFrom(ByteBufferdata,ExtensionRegistryLiteextensionRegistry)

publicstaticParser<Environment>parser()

publicbooleanequals(Objectobj)

AbstractMessage.equals(Object other)

publicEnvironmentgetDefaultInstanceForType()

publicStringgetDockerImage()

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

publicByteStringgetDockerImageBytes()

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

publicStringgetId()

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

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

publicByteStringgetIdBytes()

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

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

publicStringgetName()

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

publicByteStringgetNameBytes()

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

publicParser<Environment>getParserForType()

GeneratedMessageV3.getParserForType()

publicStringgetPublicKeys(intindex)

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

publicByteStringgetPublicKeysBytes(intindex)

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

publicintgetPublicKeysCount()

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

publicProtocolStringListgetPublicKeysList()

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

publicintgetSerializedSize()

GeneratedMessageV3.getSerializedSize()

publicStringgetSshHost()

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

publicByteStringgetSshHostBytes()

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

publicintgetSshPort()

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

publicStringgetSshUsername()

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

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

publicByteStringgetSshUsernameBytes()

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

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

publicEnvironment.StategetState()

Output only. Current execution state of this environment.

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

publicintgetStateValue()

Output only. Current execution state of this environment.

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

publicStringgetWebHost()

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

publicByteStringgetWebHostBytes()

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

publicinthashCode()

AbstractMessage.hashCode()

protectedGeneratedMessageV3.FieldAccessorTableinternalGetFieldAccessorTable()

GeneratedMessageV3.internalGetFieldAccessorTable()

publicfinalbooleanisInitialized()

GeneratedMessageV3.isInitialized()

publicEnvironment.BuildernewBuilderForType()

protectedEnvironment.BuildernewBuilderForType(GeneratedMessageV3.BuilderParentparent)

GeneratedMessageV3.newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protectedObjectnewInstance(GeneratedMessageV3.UnusedPrivateParameterunused)

GeneratedMessageV3.newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

publicEnvironment.BuildertoBuilder()

publicvoidwriteTo(CodedOutputStreamoutput)

GeneratedMessageV3.writeTo(CodedOutputStream output)