- 2.52.0 (latest)
- 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
public static final class Environment.Builder extends GeneratedMessageV3.Builder<Environment.Builder> implements EnvironmentOrBuilderA 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.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > Environment.BuilderImplements
EnvironmentOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Type | Description |
| Descriptor |
Methods
addAllPublicKeys(Iterable<String> values)
public Environment.Builder addAllPublicKeys(Iterable<String> values)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];
| Name | Description |
| values | Iterable<String>The publicKeys to add. |
| Type | Description |
| Environment.Builder | This builder for chaining. |
addPublicKeys(String value)
public Environment.Builder addPublicKeys(String value)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];
| Name | Description |
| value | StringThe publicKeys to add. |
| Type | Description |
| Environment.Builder | This builder for chaining. |
addPublicKeysBytes(ByteString value)
public Environment.Builder addPublicKeysBytes(ByteString value)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];
| Name | Description |
| value | ByteStringThe bytes of the publicKeys to add. |
| Type | Description |
| Environment.Builder | This builder for chaining. |
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public Environment.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)| Name | Description |
| field | FieldDescriptor |
| value | Object |
| Type | Description |
| Environment.Builder |
build()
public Environment build()| Type | Description |
| Environment |
buildPartial()
public Environment buildPartial()| Type | Description |
| Environment |
clear()
public Environment.Builder clear()| Type | Description |
| Environment.Builder |
clearDockerImage()
public Environment.Builder clearDockerImage()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];
| Type | Description |
| Environment.Builder | This builder for chaining. |
clearField(Descriptors.FieldDescriptor field)
public Environment.Builder clearField(Descriptors.FieldDescriptor field)| Name | Description |
| field | FieldDescriptor |
| Type | Description |
| Environment.Builder |
clearId()
public Environment.Builder clearId()Output only. The environment's identifier, unique among the user's environments.
string id = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Type | Description |
| Environment.Builder | This builder for chaining. |
clearName()
public Environment.Builder clearName() 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];
| Type | Description |
| Environment.Builder | This builder for chaining. |
clearOneof(Descriptors.OneofDescriptor oneof)
public Environment.Builder clearOneof(Descriptors.OneofDescriptor oneof)| Name | Description |
| oneof | OneofDescriptor |
| Type | Description |
| Environment.Builder |
clearPublicKeys()
public Environment.Builder clearPublicKeys()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];
| Type | Description |
| Environment.Builder | This builder for chaining. |
clearSshHost()
public Environment.Builder clearSshHost()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];
| Type | Description |
| Environment.Builder | This builder for chaining. |
clearSshPort()
public Environment.Builder clearSshPort()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];
| Type | Description |
| Environment.Builder | This builder for chaining. |
clearSshUsername()
public Environment.Builder clearSshUsername()Output only. Username that clients should use when initiating SSH sessions with the environment.
string ssh_username = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Type | Description |
| Environment.Builder | This builder for chaining. |
clearState()
public Environment.Builder clearState()Output only. Current execution state of this environment.
.google.cloud.shell.v1.Environment.State state = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Type | Description |
| Environment.Builder | This builder for chaining. |
clearWebHost()
public Environment.Builder clearWebHost()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];
| Type | Description |
| Environment.Builder | This builder for chaining. |
clone()
public Environment.Builder clone()| Type | Description |
| Environment.Builder |
getDefaultInstanceForType()
public Environment getDefaultInstanceForType()| Type | Description |
| Environment |
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()| Type | Description |
| Descriptor |
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];
| 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];
| 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];
| 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];
| 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];
| 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];
| Type | Description |
| ByteString | The bytes for name. |
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];
| Name | Description |
| index | intThe index of the element to return. |
| 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];
| Name | Description |
| index | intThe index of the value to return. |
| 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];
| 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];
| Type | Description |
| ProtocolStringList | A list containing the publicKeys. |
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];
| 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];
| 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];
| 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];
| 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];
| 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];
| 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];
| 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];
| 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];
| Type | Description |
| ByteString | The bytes for webHost. |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()| Type | Description |
| FieldAccessorTable |
isInitialized()
public final boolean isInitialized()| Type | Description |
| boolean |
mergeFrom(Environment other)
public Environment.Builder mergeFrom(Environment other)| Name | Description |
| other | Environment |
| Type | Description |
| Environment.Builder |
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public Environment.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Name | Description |
| input | CodedInputStream |
| extensionRegistry | ExtensionRegistryLite |
| Type | Description |
| Environment.Builder |
| Type | Description |
| IOException |
mergeFrom(Message other)
public Environment.Builder mergeFrom(Message other)| Name | Description |
| other | Message |
| Type | Description |
| Environment.Builder |
mergeUnknownFields(UnknownFieldSet unknownFields)
public final Environment.Builder mergeUnknownFields(UnknownFieldSet unknownFields)| Name | Description |
| unknownFields | UnknownFieldSet |
| Type | Description |
| Environment.Builder |
setDockerImage(String value)
public Environment.Builder setDockerImage(String value)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];
| Name | Description |
| value | StringThe dockerImage to set. |
| Type | Description |
| Environment.Builder | This builder for chaining. |
setDockerImageBytes(ByteString value)
public Environment.Builder setDockerImageBytes(ByteString value)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];
| Name | Description |
| value | ByteStringThe bytes for dockerImage to set. |
| Type | Description |
| Environment.Builder | This builder for chaining. |
setField(Descriptors.FieldDescriptor field, Object value)
public Environment.Builder setField(Descriptors.FieldDescriptor field, Object value)| Name | Description |
| field | FieldDescriptor |
| value | Object |
| Type | Description |
| Environment.Builder |
setId(String value)
public Environment.Builder setId(String value)Output only. The environment's identifier, unique among the user's environments.
string id = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Name | Description |
| value | StringThe id to set. |
| Type | Description |
| Environment.Builder | This builder for chaining. |
setIdBytes(ByteString value)
public Environment.Builder setIdBytes(ByteString value)Output only. The environment's identifier, unique among the user's environments.
string id = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Name | Description |
| value | ByteStringThe bytes for id to set. |
| Type | Description |
| Environment.Builder | This builder for chaining. |
setName(String value)
public Environment.Builder setName(String value) 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];
| Name | Description |
| value | StringThe name to set. |
| Type | Description |
| Environment.Builder | This builder for chaining. |
setNameBytes(ByteString value)
public Environment.Builder setNameBytes(ByteString value) 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];
| Name | Description |
| value | ByteStringThe bytes for name to set. |
| Type | Description |
| Environment.Builder | This builder for chaining. |
setPublicKeys(int index, String value)
public Environment.Builder setPublicKeys(int index, String value)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];
| Name | Description |
| index | intThe index to set the value at. |
| value | StringThe publicKeys to set. |
| Type | Description |
| Environment.Builder | This builder for chaining. |
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public Environment.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)| Name | Description |
| field | FieldDescriptor |
| index | int |
| value | Object |
| Type | Description |
| Environment.Builder |
setSshHost(String value)
public Environment.Builder setSshHost(String value)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];
| Name | Description |
| value | StringThe sshHost to set. |
| Type | Description |
| Environment.Builder | This builder for chaining. |
setSshHostBytes(ByteString value)
public Environment.Builder setSshHostBytes(ByteString value)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];
| Name | Description |
| value | ByteStringThe bytes for sshHost to set. |
| Type | Description |
| Environment.Builder | This builder for chaining. |
setSshPort(int value)
public Environment.Builder setSshPort(int value)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];
| Name | Description |
| value | intThe sshPort to set. |
| Type | Description |
| Environment.Builder | This builder for chaining. |
setSshUsername(String value)
public Environment.Builder setSshUsername(String value)Output only. Username that clients should use when initiating SSH sessions with the environment.
string ssh_username = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Name | Description |
| value | StringThe sshUsername to set. |
| Type | Description |
| Environment.Builder | This builder for chaining. |
setSshUsernameBytes(ByteString value)
public Environment.Builder setSshUsernameBytes(ByteString value)Output only. Username that clients should use when initiating SSH sessions with the environment.
string ssh_username = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Name | Description |
| value | ByteStringThe bytes for sshUsername to set. |
| Type | Description |
| Environment.Builder | This builder for chaining. |
setState(Environment.State value)
public Environment.Builder setState(Environment.State value)Output only. Current execution state of this environment.
.google.cloud.shell.v1.Environment.State state = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Name | Description |
| value | Environment.StateThe state to set. |
| Type | Description |
| Environment.Builder | This builder for chaining. |
setStateValue(int value)
public Environment.Builder setStateValue(int value)Output only. Current execution state of this environment.
.google.cloud.shell.v1.Environment.State state = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Name | Description |
| value | intThe enum numeric value on the wire for state to set. |
| Type | Description |
| Environment.Builder | This builder for chaining. |
setUnknownFields(UnknownFieldSet unknownFields)
public final Environment.Builder setUnknownFields(UnknownFieldSet unknownFields)| Name | Description |
| unknownFields | UnknownFieldSet |
| Type | Description |
| Environment.Builder |
setWebHost(String value)
public Environment.Builder setWebHost(String value)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];
| Name | Description |
| value | StringThe webHost to set. |
| Type | Description |
| Environment.Builder | This builder for chaining. |
setWebHostBytes(ByteString value)
public Environment.Builder setWebHostBytes(ByteString value)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];
| Name | Description |
| value | ByteStringThe bytes for webHost to set. |
| Type | Description |
| Environment.Builder | This builder for chaining. |