Package com.google.cloud.shell.v1

Interface EnvironmentOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
Environment, Environment.Builder
@Generated public interface EnvironmentOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Details

    • getName

      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:
      The name.

    • getNameBytes

      com.google.protobuf.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:
      The bytes for name.

    • getId

      String getId()
       Output only. The environment's identifier, unique among the user's
 environments.
      string id = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The id.

    • getIdBytes

      com.google.protobuf.ByteString getIdBytes()
       Output only. The environment's identifier, unique among the user's
 environments.
      string id = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The bytes for id.

    • getDockerImage

      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:
      The dockerImage.

    • getDockerImageBytes

      com.google.protobuf.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:
      The bytes for dockerImage.

    • getStateValue

      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:
      The enum numeric value on the wire for state.

    • getState

      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:
      The state.

    • getWebHost

      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:
      The webHost.

    • getWebHostBytes

      com.google.protobuf.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:
      The bytes for webHost.

    • getSshUsername

      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:
      The sshUsername.

    • getSshUsernameBytes

      com.google.protobuf.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:
      The bytes for sshUsername.

    • getSshHost

      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:
      The sshHost.

    • getSshHostBytes

      com.google.protobuf.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:
      The bytes for sshHost.

    • getSshPort

      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:
      The sshPort.

    • getPublicKeysList

      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:
      A list containing the publicKeys.

    • getPublicKeysCount

      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:
      The count of publicKeys.

    • getPublicKeys

      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];
      Parameters:
      index - The index of the element to return.
      Returns:
      The publicKeys at the given index.

    • getPublicKeysBytes

      com.google.protobuf.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];
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the publicKeys at the given index.