/*
 * Copyright 2020 Google LLC
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     https://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
// Generated by the protocol buffer compiler.  DO NOT EDIT!
// source: google/cloud/shell/v1/cloudshell.proto

package com.google.cloud.shell.v1;

public interface EnvironmentOrBuilder
    extends
    // @@protoc_insertion_point(interface_extends:google.cloud.shell.v1.Environment)
    com.google.protobuf.MessageOrBuilder {

  /**
   *
   *
   * <pre>
   * 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&#64;example.com/environments/default`.
   * </pre>
   *
   * <code>string name = 1 [(.google.api.field_behavior) = IMMUTABLE];</code>
   *
   * @return The name.
   */
  java.lang.String getName();
  /**
   *
   *
   * <pre>
   * 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&#64;example.com/environments/default`.
   * </pre>
   *
   * <code>string name = 1 [(.google.api.field_behavior) = IMMUTABLE];</code>
   *
   * @return The bytes for name.
   */
  com.google.protobuf.ByteString getNameBytes();

  /**
   *
   *
   * <pre>
   * Output only. The environment's identifier, unique among the user's
   * environments.
   * </pre>
   *
   * <code>string id = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];</code>
   *
   * @return The id.
   */
  java.lang.String getId();
  /**
   *
   *
   * <pre>
   * Output only. The environment's identifier, unique among the user's
   * environments.
   * </pre>
   *
   * <code>string id = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];</code>
   *
   * @return The bytes for id.
   */
  com.google.protobuf.ByteString getIdBytes();

  /**
   *
   *
   * <pre>
   * Required. Immutable. Full path to the Docker image used to run this environment, e.g.
   * "gcr.io/dev-con/cloud-devshell:latest".
   * </pre>
   *
   * <code>
   * string docker_image = 3 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];
   * </code>
   *
   * @return The dockerImage.
   */
  java.lang.String getDockerImage();
  /**
   *
   *
   * <pre>
   * Required. Immutable. Full path to the Docker image used to run this environment, e.g.
   * "gcr.io/dev-con/cloud-devshell:latest".
   * </pre>
   *
   * <code>
   * string docker_image = 3 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];
   * </code>
   *
   * @return The bytes for dockerImage.
   */
  com.google.protobuf.ByteString getDockerImageBytes();

  /**
   *
   *
   * <pre>
   * Output only. Current execution state of this environment.
   * </pre>
   *
   * <code>
   * .google.cloud.shell.v1.Environment.State state = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
   * </code>
   *
   * @return The enum numeric value on the wire for state.
   */
  int getStateValue();
  /**
   *
   *
   * <pre>
   * Output only. Current execution state of this environment.
   * </pre>
   *
   * <code>
   * .google.cloud.shell.v1.Environment.State state = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
   * </code>
   *
   * @return The state.
   */
  com.google.cloud.shell.v1.Environment.State getState();

  /**
   *
   *
   * <pre>
   * Output only. Host to which clients can connect to initiate HTTPS or WSS
   * connections with the environment.
   * </pre>
   *
   * <code>string web_host = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];</code>
   *
   * @return The webHost.
   */
  java.lang.String getWebHost();
  /**
   *
   *
   * <pre>
   * Output only. Host to which clients can connect to initiate HTTPS or WSS
   * connections with the environment.
   * </pre>
   *
   * <code>string web_host = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];</code>
   *
   * @return The bytes for webHost.
   */
  com.google.protobuf.ByteString getWebHostBytes();

  /**
   *
   *
   * <pre>
   * Output only. Username that clients should use when initiating SSH sessions
   * with the environment.
   * </pre>
   *
   * <code>string ssh_username = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];</code>
   *
   * @return The sshUsername.
   */
  java.lang.String getSshUsername();
  /**
   *
   *
   * <pre>
   * Output only. Username that clients should use when initiating SSH sessions
   * with the environment.
   * </pre>
   *
   * <code>string ssh_username = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];</code>
   *
   * @return The bytes for sshUsername.
   */
  com.google.protobuf.ByteString getSshUsernameBytes();

  /**
   *
   *
   * <pre>
   * Output only. Host to which clients can connect to initiate SSH sessions
   * with the environment.
   * </pre>
   *
   * <code>string ssh_host = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];</code>
   *
   * @return The sshHost.
   */
  java.lang.String getSshHost();
  /**
   *
   *
   * <pre>
   * Output only. Host to which clients can connect to initiate SSH sessions
   * with the environment.
   * </pre>
   *
   * <code>string ssh_host = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];</code>
   *
   * @return The bytes for sshHost.
   */
  com.google.protobuf.ByteString getSshHostBytes();

  /**
   *
   *
   * <pre>
   * Output only. Port to which clients can connect to initiate SSH sessions
   * with the environment.
   * </pre>
   *
   * <code>int32 ssh_port = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];</code>
   *
   * @return The sshPort.
   */
  int getSshPort();

  /**
   *
   *
   * <pre>
   * 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.
   * </pre>
   *
   * <code>repeated string public_keys = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];</code>
   *
   * @return A list containing the publicKeys.
   */
  java.util.List<java.lang.String> getPublicKeysList();
  /**
   *
   *
   * <pre>
   * 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.
   * </pre>
   *
   * <code>repeated string public_keys = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];</code>
   *
   * @return The count of publicKeys.
   */
  int getPublicKeysCount();
  /**
   *
   *
   * <pre>
   * 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.
   * </pre>
   *
   * <code>repeated string public_keys = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];</code>
   *
   * @param index The index of the element to return.
   * @return The publicKeys at the given index.
   */
  java.lang.String getPublicKeys(int index);
  /**
   *
   *
   * <pre>
   * 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.
   * </pre>
   *
   * <code>repeated string public_keys = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];</code>
   *
   * @param index The index of the value to return.
   * @return The bytes of the publicKeys at the given index.
   */
  com.google.protobuf.ByteString getPublicKeysBytes(int index);
}