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 



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) 



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 



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) 



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) 



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) 



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) 



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) 



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) 



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