Class: Google::Cloud::Shell::V1::Environment

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/cloud/shell/v1/cloudshell.rb

Overview

A 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".

Defined Under Namespace

Modules: State

Instance Attribute Summary collapse

Instance Attribute Details

#docker_image ⇒ ::String

Returns Required. Immutable. Full path to the Docker image used to run this environment, e.g. "gcr.io/dev-con/cloud-devshell:latest".

Returns:

  • (::String) —

    Required. Immutable. Full path to the Docker image used to run this environment, e.g. "gcr.io/dev-con/cloud-devshell:latest".



69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
 
# File 'proto_docs/google/cloud/shell/v1/cloudshell.rb', line 69

class Environment
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Possible execution states for an environment.
  module State
    # The environment's states is unknown.
    STATE_UNSPECIFIED = 0

    # The environment is not running and can't be connected to. Starting the
    # environment will transition it to the PENDING state.
    SUSPENDED = 1

    # The environment is being started but is not yet ready to accept
    # connections.
    PENDING = 2

    # The environment is running and ready to accept connections. It will
    # automatically transition back to DISABLED after a period of inactivity or
    # if another environment is started.
    RUNNING = 3

    # The environment is being deleted and can't be connected to.
    DELETING = 4
  end
end

#id ⇒ ::String (readonly)

Returns Output only. The environment's identifier, unique among the user's environments.

Returns:

  • (::String) —

    Output only. The environment's identifier, unique among the user's environments.



69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
 
# File 'proto_docs/google/cloud/shell/v1/cloudshell.rb', line 69

class Environment
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Possible execution states for an environment.
  module State
    # The environment's states is unknown.
    STATE_UNSPECIFIED = 0

    # The environment is not running and can't be connected to. Starting the
    # environment will transition it to the PENDING state.
    SUSPENDED = 1

    # The environment is being started but is not yet ready to accept
    # connections.
    PENDING = 2

    # The environment is running and ready to accept connections. It will
    # automatically transition back to DISABLED after a period of inactivity or
    # if another environment is started.
    RUNNING = 3

    # The environment is being deleted and can't be connected to.
    DELETING = 4
  end
end

#name ⇒ ::String

Returns 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/[email protected]/environments/default.

Returns:

  • (::String) —

    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/[email protected]/environments/default.



69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
 
# File 'proto_docs/google/cloud/shell/v1/cloudshell.rb', line 69

class Environment
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Possible execution states for an environment.
  module State
    # The environment's states is unknown.
    STATE_UNSPECIFIED = 0

    # The environment is not running and can't be connected to. Starting the
    # environment will transition it to the PENDING state.
    SUSPENDED = 1

    # The environment is being started but is not yet ready to accept
    # connections.
    PENDING = 2

    # The environment is running and ready to accept connections. It will
    # automatically transition back to DISABLED after a period of inactivity or
    # if another environment is started.
    RUNNING = 3

    # The environment is being deleted and can't be connected to.
    DELETING = 4
  end
end

#public_keys ⇒ ::Array<::String> (readonly)

Returns 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.

Returns:

  • (::Array<::String>) —

    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.



69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
 
# File 'proto_docs/google/cloud/shell/v1/cloudshell.rb', line 69

class Environment
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Possible execution states for an environment.
  module State
    # The environment's states is unknown.
    STATE_UNSPECIFIED = 0

    # The environment is not running and can't be connected to. Starting the
    # environment will transition it to the PENDING state.
    SUSPENDED = 1

    # The environment is being started but is not yet ready to accept
    # connections.
    PENDING = 2

    # The environment is running and ready to accept connections. It will
    # automatically transition back to DISABLED after a period of inactivity or
    # if another environment is started.
    RUNNING = 3

    # The environment is being deleted and can't be connected to.
    DELETING = 4
  end
end

#ssh_host ⇒ ::String (readonly)

Returns Output only. Host to which clients can connect to initiate SSH sessions with the environment.

Returns:

  • (::String) —

    Output only. Host to which clients can connect to initiate SSH sessions with the environment.



69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
 
# File 'proto_docs/google/cloud/shell/v1/cloudshell.rb', line 69

class Environment
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Possible execution states for an environment.
  module State
    # The environment's states is unknown.
    STATE_UNSPECIFIED = 0

    # The environment is not running and can't be connected to. Starting the
    # environment will transition it to the PENDING state.
    SUSPENDED = 1

    # The environment is being started but is not yet ready to accept
    # connections.
    PENDING = 2

    # The environment is running and ready to accept connections. It will
    # automatically transition back to DISABLED after a period of inactivity or
    # if another environment is started.
    RUNNING = 3

    # The environment is being deleted and can't be connected to.
    DELETING = 4
  end
end

#ssh_port ⇒ ::Integer (readonly)

Returns Output only. Port to which clients can connect to initiate SSH sessions with the environment.

Returns:

  • (::Integer) —

    Output only. Port to which clients can connect to initiate SSH sessions with the environment.



69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
 
# File 'proto_docs/google/cloud/shell/v1/cloudshell.rb', line 69

class Environment
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Possible execution states for an environment.
  module State
    # The environment's states is unknown.
    STATE_UNSPECIFIED = 0

    # The environment is not running and can't be connected to. Starting the
    # environment will transition it to the PENDING state.
    SUSPENDED = 1

    # The environment is being started but is not yet ready to accept
    # connections.
    PENDING = 2

    # The environment is running and ready to accept connections. It will
    # automatically transition back to DISABLED after a period of inactivity or
    # if another environment is started.
    RUNNING = 3

    # The environment is being deleted and can't be connected to.
    DELETING = 4
  end
end

#ssh_username ⇒ ::String (readonly)

Returns Output only. Username that clients should use when initiating SSH sessions with the environment.

Returns:

  • (::String) —

    Output only. Username that clients should use when initiating SSH sessions with the environment.



69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
 
# File 'proto_docs/google/cloud/shell/v1/cloudshell.rb', line 69

class Environment
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Possible execution states for an environment.
  module State
    # The environment's states is unknown.
    STATE_UNSPECIFIED = 0

    # The environment is not running and can't be connected to. Starting the
    # environment will transition it to the PENDING state.
    SUSPENDED = 1

    # The environment is being started but is not yet ready to accept
    # connections.
    PENDING = 2

    # The environment is running and ready to accept connections. It will
    # automatically transition back to DISABLED after a period of inactivity or
    # if another environment is started.
    RUNNING = 3

    # The environment is being deleted and can't be connected to.
    DELETING = 4
  end
end

#state ⇒ ::Google::Cloud::Shell::V1::Environment::State (readonly)

Returns Output only. Current execution state of this environment.

Returns:



69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
 
# File 'proto_docs/google/cloud/shell/v1/cloudshell.rb', line 69

class Environment
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Possible execution states for an environment.
  module State
    # The environment's states is unknown.
    STATE_UNSPECIFIED = 0

    # The environment is not running and can't be connected to. Starting the
    # environment will transition it to the PENDING state.
    SUSPENDED = 1

    # The environment is being started but is not yet ready to accept
    # connections.
    PENDING = 2

    # The environment is running and ready to accept connections. It will
    # automatically transition back to DISABLED after a period of inactivity or
    # if another environment is started.
    RUNNING = 3

    # The environment is being deleted and can't be connected to.
    DELETING = 4
  end
end

#web_host ⇒ ::String (readonly)

Returns Output only. Host to which clients can connect to initiate HTTPS or WSS connections with the environment.

Returns:

  • (::String) —

    Output only. Host to which clients can connect to initiate HTTPS or WSS connections with the environment.



69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
 
# File 'proto_docs/google/cloud/shell/v1/cloudshell.rb', line 69

class Environment
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Possible execution states for an environment.
  module State
    # The environment's states is unknown.
    STATE_UNSPECIFIED = 0

    # The environment is not running and can't be connected to. Starting the
    # environment will transition it to the PENDING state.
    SUSPENDED = 1

    # The environment is being started but is not yet ready to accept
    # connections.
    PENDING = 2

    # The environment is running and ready to accept connections. It will
    # automatically transition back to DISABLED after a period of inactivity or
    # if another environment is started.
    RUNNING = 3

    # The environment is being deleted and can't be connected to.
    DELETING = 4
  end
end