public interface EnvironmentOrBuilder extends MessageOrBuilder
Implements
MessageOrBuilderMethods
getDockerImage()
public abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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. |
getPublicKeys(int index)
public abstract 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 abstract 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 abstract 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 abstract List<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()
public abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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. |