Interface EnvironmentOrBuilder (2.51.0)
Stay organized with collections
Save and categorize content based on your preferences.
- 2.79.0 (latest)
- 2.77.0
- 2.75.0
- 2.74.0
- 2.73.0
- 2.72.0
- 2.71.0
- 2.69.0
- 2.67.0
- 2.66.0
- 2.63.0
- 2.62.0
- 2.61.0
- 2.59.0
- 2.58.0
- 2.57.0
- 2.56.0
- 2.55.0
- 2.54.0
- 2.53.0
- 2.52.0
- 2.51.0
- 2.50.0
- 2.48.0
- 2.47.0
- 2.46.0
- 2.45.0
- 2.44.0
- 2.43.0
- 2.42.0
- 2.41.0
- 2.40.0
- 2.39.0
- 2.38.0
- 2.36.0
- 2.35.0
- 2.34.0
- 2.33.0
- 2.32.0
- 2.31.0
- 2.30.0
- 2.29.0
- 2.28.0
- 2.27.0
- 2.26.0
- 2.23.0
- 2.22.0
- 2.21.0
- 2.20.0
- 2.19.0
- 2.18.0
- 2.17.0
- 2.16.0
- 2.15.0
- 2.14.0
- 2.13.0
- 2.12.0
- 2.11.0
- 2.10.0
- 2.8.0
- 2.7.0
- 2.6.0
- 2.5.0
- 2.4.0
- 2.3.0
- 2.1.11
publicinterface EnvironmentOrBuilderextendsMessageOrBuilderImplements
MessageOrBuilderMethods
getDockerImage()
publicabstractStringgetDockerImage()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()
publicabstractByteStringgetDockerImageBytes()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()
publicabstractStringgetId()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()
publicabstractByteStringgetIdBytes()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()
publicabstractStringgetName() 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()
publicabstractByteStringgetNameBytes() 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. |
getPublicKeys(int index)
publicabstractStringgetPublicKeys(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];
| 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)
publicabstractByteStringgetPublicKeysBytes(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];
| 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()
publicabstractintgetPublicKeysCount()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()
publicabstractList<String>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 |
List<String> |
A list containing the publicKeys. |
getSshHost()
publicabstractStringgetSshHost()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()
publicabstractByteStringgetSshHostBytes()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()
publicabstractintgetSshPort()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()
publicabstractStringgetSshUsername()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()
publicabstractByteStringgetSshUsernameBytes()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()
publicabstractEnvironment.StategetState()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()
publicabstractintgetStateValue()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()
publicabstractStringgetWebHost()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()
publicabstractByteStringgetWebHostBytes()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. |