Variables
Environment_State_name, Environment_State_value
var (
Environment_State_name = map[int32]string{
0: "STATE_UNSPECIFIED",
1: "SUSPENDED",
2: "PENDING",
3: "RUNNING",
4: "DELETING",
}
Environment_State_value = map[string]int32{
"STATE_UNSPECIFIED": 0,
"SUSPENDED": 1,
"PENDING": 2,
"RUNNING": 3,
"DELETING": 4,
}
)
Enum value maps for Environment_State.
StartEnvironmentMetadata_State_name, StartEnvironmentMetadata_State_value
var (
StartEnvironmentMetadata_State_name = map[int32]string{
0: "STATE_UNSPECIFIED",
1: "STARTING",
2: "UNARCHIVING_DISK",
4: "AWAITING_COMPUTE_RESOURCES",
3: "FINISHED",
}
StartEnvironmentMetadata_State_value = map[string]int32{
"STATE_UNSPECIFIED": 0,
"STARTING": 1,
"UNARCHIVING_DISK": 2,
"AWAITING_COMPUTE_RESOURCES": 4,
"FINISHED": 3,
}
)
Enum value maps for StartEnvironmentMetadata_State.
CloudShellErrorDetails_CloudShellErrorCode_name, CloudShellErrorDetails_CloudShellErrorCode_value
var (
CloudShellErrorDetails_CloudShellErrorCode_name = map[int32]string{
0: "CLOUD_SHELL_ERROR_CODE_UNSPECIFIED",
1: "IMAGE_UNAVAILABLE",
2: "CLOUD_SHELL_DISABLED",
4: "TOS_VIOLATION",
5: "QUOTA_EXCEEDED",
6: "ENVIRONMENT_UNAVAILABLE",
}
CloudShellErrorDetails_CloudShellErrorCode_value = map[string]int32{
"CLOUD_SHELL_ERROR_CODE_UNSPECIFIED": 0,
"IMAGE_UNAVAILABLE": 1,
"CLOUD_SHELL_DISABLED": 2,
"TOS_VIOLATION": 4,
"QUOTA_EXCEEDED": 5,
"ENVIRONMENT_UNAVAILABLE": 6,
}
)
Enum value maps for CloudShellErrorDetails_CloudShellErrorCode.
File_google_cloud_shell_v1_cloudshell_proto
var File_google_cloud_shell_v1_cloudshell_proto protoreflect.FileDescriptor
Functions
func RegisterCloudShellServiceServer
func RegisterCloudShellServiceServer(s *grpc.Server, srv CloudShellServiceServer)
AddPublicKeyMetadata
type AddPublicKeyMetadata struct {
// contains filtered or unexported fields
}
Message included in the metadata field of operations returned from [AddPublicKey][google.cloud.shell.v1.CloudShellService.AddPublicKey].
func (*AddPublicKeyMetadata) Descriptor
func (*AddPublicKeyMetadata) Descriptor() ([]byte, []int)
Deprecated: Use AddPublicKeyMetadata.ProtoReflect.Descriptor instead.
func (*AddPublicKeyMetadata) ProtoMessage
func (*AddPublicKeyMetadata) ProtoMessage()
func (*AddPublicKeyMetadata) ProtoReflect
func (x *AddPublicKeyMetadata) ProtoReflect() protoreflect.Message
func (*AddPublicKeyMetadata) Reset
func (x *AddPublicKeyMetadata) Reset()
func (*AddPublicKeyMetadata) String
func (x *AddPublicKeyMetadata) String() string
AddPublicKeyRequest
type AddPublicKeyRequest struct {
// Environment this key should be added to, e.g.
// `users/me/environments/default`.
Environment string `protobuf:"bytes,1,opt,name=environment,proto3" json:"environment,omitempty"`
// Key that should be added to the environment. Supported formats are
// `ssh-dss` (see RFC4253), `ssh-rsa` (see RFC4253), `ecdsa-sha2-nistp256`
// (see RFC5656), `ecdsa-sha2-nistp384` (see RFC5656) and
// `ecdsa-sha2-nistp521` (see RFC5656). It should be structured as
// <format> <content>, where <content> part is encoded with
// Base64.
Key string `protobuf:"bytes,2,opt,name=key,proto3" json:"key,omitempty"`
// contains filtered or unexported fields
}
Request message for [AddPublicKey][google.cloud.shell.v1.CloudShellService.AddPublicKey].
func (*AddPublicKeyRequest) Descriptor
func (*AddPublicKeyRequest) Descriptor() ([]byte, []int)
Deprecated: Use AddPublicKeyRequest.ProtoReflect.Descriptor instead.
func (*AddPublicKeyRequest) GetEnvironment
func (x *AddPublicKeyRequest) GetEnvironment() string
func (*AddPublicKeyRequest) GetKey
func (x *AddPublicKeyRequest) GetKey() string
func (*AddPublicKeyRequest) ProtoMessage
func (*AddPublicKeyRequest) ProtoMessage()
func (*AddPublicKeyRequest) ProtoReflect
func (x *AddPublicKeyRequest) ProtoReflect() protoreflect.Message
func (*AddPublicKeyRequest) Reset
func (x *AddPublicKeyRequest) Reset()
func (*AddPublicKeyRequest) String
func (x *AddPublicKeyRequest) String() string
AddPublicKeyResponse
type AddPublicKeyResponse struct {
// Key that was added to the environment.
Key string `protobuf:"bytes,1,opt,name=key,proto3" json:"key,omitempty"`
// contains filtered or unexported fields
}
Response message for [AddPublicKey][google.cloud.shell.v1.CloudShellService.AddPublicKey].
func (*AddPublicKeyResponse) Descriptor
func (*AddPublicKeyResponse) Descriptor() ([]byte, []int)
Deprecated: Use AddPublicKeyResponse.ProtoReflect.Descriptor instead.
func (*AddPublicKeyResponse) GetKey
func (x *AddPublicKeyResponse) GetKey() string
func (*AddPublicKeyResponse) ProtoMessage
func (*AddPublicKeyResponse) ProtoMessage()
func (*AddPublicKeyResponse) ProtoReflect
func (x *AddPublicKeyResponse) ProtoReflect() protoreflect.Message
func (*AddPublicKeyResponse) Reset
func (x *AddPublicKeyResponse) Reset()
func (*AddPublicKeyResponse) String
func (x *AddPublicKeyResponse) String() string
AuthorizeEnvironmentMetadata
type AuthorizeEnvironmentMetadata struct {
// contains filtered or unexported fields
}
Message included in the metadata field of operations returned from [AuthorizeEnvironment][google.cloud.shell.v1.CloudShellService.AuthorizeEnvironment].
func (*AuthorizeEnvironmentMetadata) Descriptor
func (*AuthorizeEnvironmentMetadata) Descriptor() ([]byte, []int)
Deprecated: Use AuthorizeEnvironmentMetadata.ProtoReflect.Descriptor instead.
func (*AuthorizeEnvironmentMetadata) ProtoMessage
func (*AuthorizeEnvironmentMetadata) ProtoMessage()
func (*AuthorizeEnvironmentMetadata) ProtoReflect
func (x *AuthorizeEnvironmentMetadata) ProtoReflect() protoreflect.Message
func (*AuthorizeEnvironmentMetadata) Reset
func (x *AuthorizeEnvironmentMetadata) Reset()
func (*AuthorizeEnvironmentMetadata) String
func (x *AuthorizeEnvironmentMetadata) String() string
AuthorizeEnvironmentRequest
type AuthorizeEnvironmentRequest struct {
// Name of the resource that should receive the credentials, for example
// `users/me/environments/default` or
// `users/someone@example.com/environments/default`.
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// The OAuth access token that should be sent to the environment.
AccessToken string `protobuf:"bytes,2,opt,name=access_token,json=accessToken,proto3" json:"access_token,omitempty"`
// The OAuth ID token that should be sent to the environment.
IdToken string `protobuf:"bytes,4,opt,name=id_token,json=idToken,proto3" json:"id_token,omitempty"`
// The time when the credentials expire. If not set, defaults to one hour from
// when the server received the request.
ExpireTime *timestamppb.Timestamp `protobuf:"bytes,3,opt,name=expire_time,json=expireTime,proto3" json:"expire_time,omitempty"`
// contains filtered or unexported fields
}
Request message for [AuthorizeEnvironment][google.cloud.shell.v1.CloudShellService.AuthorizeEnvironment].
func (*AuthorizeEnvironmentRequest) Descriptor
func (*AuthorizeEnvironmentRequest) Descriptor() ([]byte, []int)
Deprecated: Use AuthorizeEnvironmentRequest.ProtoReflect.Descriptor instead.
func (*AuthorizeEnvironmentRequest) GetAccessToken
func (x *AuthorizeEnvironmentRequest) GetAccessToken() string
func (*AuthorizeEnvironmentRequest) GetExpireTime
func (x *AuthorizeEnvironmentRequest) GetExpireTime() *timestamppb.Timestamp
func (*AuthorizeEnvironmentRequest) GetIdToken
func (x *AuthorizeEnvironmentRequest) GetIdToken() string
func (*AuthorizeEnvironmentRequest) GetName
func (x *AuthorizeEnvironmentRequest) GetName() string
func (*AuthorizeEnvironmentRequest) ProtoMessage
func (*AuthorizeEnvironmentRequest) ProtoMessage()
func (*AuthorizeEnvironmentRequest) ProtoReflect
func (x *AuthorizeEnvironmentRequest) ProtoReflect() protoreflect.Message
func (*AuthorizeEnvironmentRequest) Reset
func (x *AuthorizeEnvironmentRequest) Reset()
func (*AuthorizeEnvironmentRequest) String
func (x *AuthorizeEnvironmentRequest) String() string
AuthorizeEnvironmentResponse
type AuthorizeEnvironmentResponse struct {
// contains filtered or unexported fields
}
Response message for [AuthorizeEnvironment][google.cloud.shell.v1.CloudShellService.AuthorizeEnvironment].
func (*AuthorizeEnvironmentResponse) Descriptor
func (*AuthorizeEnvironmentResponse) Descriptor() ([]byte, []int)
Deprecated: Use AuthorizeEnvironmentResponse.ProtoReflect.Descriptor instead.
func (*AuthorizeEnvironmentResponse) ProtoMessage
func (*AuthorizeEnvironmentResponse) ProtoMessage()
func (*AuthorizeEnvironmentResponse) ProtoReflect
func (x *AuthorizeEnvironmentResponse) ProtoReflect() protoreflect.Message
func (*AuthorizeEnvironmentResponse) Reset
func (x *AuthorizeEnvironmentResponse) Reset()
func (*AuthorizeEnvironmentResponse) String
func (x *AuthorizeEnvironmentResponse) String() string
CloudShellErrorDetails
type CloudShellErrorDetails struct {
Code CloudShellErrorDetails_CloudShellErrorCode "" /* 132 byte string literal not displayed */
}
Cloud-shell specific information that will be included as details in failure responses.
func (*CloudShellErrorDetails) Descriptor
func (*CloudShellErrorDetails) Descriptor() ([]byte, []int)
Deprecated: Use CloudShellErrorDetails.ProtoReflect.Descriptor instead.
func (*CloudShellErrorDetails) GetCode
func (x *CloudShellErrorDetails) GetCode() CloudShellErrorDetails_CloudShellErrorCode
func (*CloudShellErrorDetails) ProtoMessage
func (*CloudShellErrorDetails) ProtoMessage()
func (*CloudShellErrorDetails) ProtoReflect
func (x *CloudShellErrorDetails) ProtoReflect() protoreflect.Message
func (*CloudShellErrorDetails) Reset
func (x *CloudShellErrorDetails) Reset()
func (*CloudShellErrorDetails) String
func (x *CloudShellErrorDetails) String() string
CloudShellErrorDetails_CloudShellErrorCode
type CloudShellErrorDetails_CloudShellErrorCode int32
Set of possible errors returned from API calls.
CloudShellErrorDetails_CLOUD_SHELL_ERROR_CODE_UNSPECIFIED, CloudShellErrorDetails_IMAGE_UNAVAILABLE, CloudShellErrorDetails_CLOUD_SHELL_DISABLED, CloudShellErrorDetails_TOS_VIOLATION, CloudShellErrorDetails_QUOTA_EXCEEDED, CloudShellErrorDetails_ENVIRONMENT_UNAVAILABLE
const (
// An unknown error occurred.
CloudShellErrorDetails_CLOUD_SHELL_ERROR_CODE_UNSPECIFIED CloudShellErrorDetails_CloudShellErrorCode = 0
// The image used by the Cloud Shell environment either does not exist or
// the user does not have access to it.
CloudShellErrorDetails_IMAGE_UNAVAILABLE CloudShellErrorDetails_CloudShellErrorCode = 1
// Cloud Shell has been disabled by an administrator for the user making the
// request.
CloudShellErrorDetails_CLOUD_SHELL_DISABLED CloudShellErrorDetails_CloudShellErrorCode = 2
// Cloud Shell has been permanently disabled due to a Terms of Service
// violation by the user.
CloudShellErrorDetails_TOS_VIOLATION CloudShellErrorDetails_CloudShellErrorCode = 4
// The user has exhausted their weekly Cloud Shell quota, and Cloud Shell
// will be disabled until the quota resets.
CloudShellErrorDetails_QUOTA_EXCEEDED CloudShellErrorDetails_CloudShellErrorCode = 5
// The Cloud Shell environment is unavailable and cannot be connected to at
// the moment.
CloudShellErrorDetails_ENVIRONMENT_UNAVAILABLE CloudShellErrorDetails_CloudShellErrorCode = 6
)
func (CloudShellErrorDetails_CloudShellErrorCode) Descriptor
func (CloudShellErrorDetails_CloudShellErrorCode) Descriptor() protoreflect.EnumDescriptor
func (CloudShellErrorDetails_CloudShellErrorCode) Enum
func (x CloudShellErrorDetails_CloudShellErrorCode) Enum() *CloudShellErrorDetails_CloudShellErrorCode
func (CloudShellErrorDetails_CloudShellErrorCode) EnumDescriptor
func (CloudShellErrorDetails_CloudShellErrorCode) EnumDescriptor() ([]byte, []int)
Deprecated: Use CloudShellErrorDetails_CloudShellErrorCode.Descriptor instead.
func (CloudShellErrorDetails_CloudShellErrorCode) Number
func (x CloudShellErrorDetails_CloudShellErrorCode) Number() protoreflect.EnumNumber
func (CloudShellErrorDetails_CloudShellErrorCode) String
func (x CloudShellErrorDetails_CloudShellErrorCode) String() string
func (CloudShellErrorDetails_CloudShellErrorCode) Type
func (CloudShellErrorDetails_CloudShellErrorCode) Type() protoreflect.EnumType
CloudShellServiceClient
type CloudShellServiceClient interface {
// Gets an environment. Returns NOT_FOUND if the environment does not exist.
GetEnvironment(ctx context.Context, in *GetEnvironmentRequest, opts ...grpc.CallOption) (*Environment, error)
// Starts an existing environment, allowing clients to connect to it. The
// returned operation will contain an instance of StartEnvironmentMetadata in
// its metadata field. Users can wait for the environment to start by polling
// this operation via GetOperation. Once the environment has finished starting
// and is ready to accept connections, the operation will contain a
// StartEnvironmentResponse in its response field.
StartEnvironment(ctx context.Context, in *StartEnvironmentRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
// Sends OAuth credentials to a running environment on behalf of a user. When
// this completes, the environment will be authorized to run various Google
// Cloud command line tools without requiring the user to manually
// authenticate.
AuthorizeEnvironment(ctx context.Context, in *AuthorizeEnvironmentRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
// Adds a public SSH key to an environment, allowing clients with the
// corresponding private key to connect to that environment via SSH. If a key
// with the same content already exists, this will error with ALREADY_EXISTS.
AddPublicKey(ctx context.Context, in *AddPublicKeyRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
// Removes a public SSH key from an environment. Clients will no longer be
// able to connect to the environment using the corresponding private key.
// If a key with the same content is not present, this will error with
// NOT_FOUND.
RemovePublicKey(ctx context.Context, in *RemovePublicKeyRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
}
CloudShellServiceClient is the client API for CloudShellService service.
For semantics around ctx use and closing/ending streaming RPCs, please refer to https://godoc.org/google.golang.org/grpc#ClientConn.NewStream.
func NewCloudShellServiceClient
func NewCloudShellServiceClient(cc grpc.ClientConnInterface) CloudShellServiceClient
CloudShellServiceServer
type CloudShellServiceServer interface {
// Gets an environment. Returns NOT_FOUND if the environment does not exist.
GetEnvironment(context.Context, *GetEnvironmentRequest) (*Environment, error)
// Starts an existing environment, allowing clients to connect to it. The
// returned operation will contain an instance of StartEnvironmentMetadata in
// its metadata field. Users can wait for the environment to start by polling
// this operation via GetOperation. Once the environment has finished starting
// and is ready to accept connections, the operation will contain a
// StartEnvironmentResponse in its response field.
StartEnvironment(context.Context, *StartEnvironmentRequest) (*longrunningpb.Operation, error)
// Sends OAuth credentials to a running environment on behalf of a user. When
// this completes, the environment will be authorized to run various Google
// Cloud command line tools without requiring the user to manually
// authenticate.
AuthorizeEnvironment(context.Context, *AuthorizeEnvironmentRequest) (*longrunningpb.Operation, error)
// Adds a public SSH key to an environment, allowing clients with the
// corresponding private key to connect to that environment via SSH. If a key
// with the same content already exists, this will error with ALREADY_EXISTS.
AddPublicKey(context.Context, *AddPublicKeyRequest) (*longrunningpb.Operation, error)
// Removes a public SSH key from an environment. Clients will no longer be
// able to connect to the environment using the corresponding private key.
// If a key with the same content is not present, this will error with
// NOT_FOUND.
RemovePublicKey(context.Context, *RemovePublicKeyRequest) (*longrunningpb.Operation, error)
}
CloudShellServiceServer is the server API for CloudShellService service.
CreateEnvironmentMetadata
type CreateEnvironmentMetadata struct {
// contains filtered or unexported fields
}
Message included in the metadata field of operations returned from [CreateEnvironment][google.cloud.shell.v1.CloudShellService.CreateEnvironment].
func (*CreateEnvironmentMetadata) Descriptor
func (*CreateEnvironmentMetadata) Descriptor() ([]byte, []int)
Deprecated: Use CreateEnvironmentMetadata.ProtoReflect.Descriptor instead.
func (*CreateEnvironmentMetadata) ProtoMessage
func (*CreateEnvironmentMetadata) ProtoMessage()
func (*CreateEnvironmentMetadata) ProtoReflect
func (x *CreateEnvironmentMetadata) ProtoReflect() protoreflect.Message
func (*CreateEnvironmentMetadata) Reset
func (x *CreateEnvironmentMetadata) Reset()
func (*CreateEnvironmentMetadata) String
func (x *CreateEnvironmentMetadata) String() string
DeleteEnvironmentMetadata
type DeleteEnvironmentMetadata struct {
// contains filtered or unexported fields
}
Message included in the metadata field of operations returned from [DeleteEnvironment][google.cloud.shell.v1.CloudShellService.DeleteEnvironment].
func (*DeleteEnvironmentMetadata) Descriptor
func (*DeleteEnvironmentMetadata) Descriptor() ([]byte, []int)
Deprecated: Use DeleteEnvironmentMetadata.ProtoReflect.Descriptor instead.
func (*DeleteEnvironmentMetadata) ProtoMessage
func (*DeleteEnvironmentMetadata) ProtoMessage()
func (*DeleteEnvironmentMetadata) ProtoReflect
func (x *DeleteEnvironmentMetadata) ProtoReflect() protoreflect.Message
func (*DeleteEnvironmentMetadata) Reset
func (x *DeleteEnvironmentMetadata) Reset()
func (*DeleteEnvironmentMetadata) String
func (x *DeleteEnvironmentMetadata) String() string
Environment
type Environment struct {
// 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`.
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// Output only. The environment's identifier, unique among the user's
// environments.
Id string `protobuf:"bytes,2,opt,name=id,proto3" json:"id,omitempty"`
// Required. Immutable. Full path to the Docker image used to run this environment, e.g.
// "gcr.io/dev-con/cloud-devshell:latest".
DockerImage string `protobuf:"bytes,3,opt,name=docker_image,json=dockerImage,proto3" json:"docker_image,omitempty"`
// Output only. Current execution state of this environment.
State Environment_State `protobuf:"varint,4,opt,name=state,proto3,enum=google.cloud.shell.v1.Environment_State" json:"state,omitempty"`
// Output only. Host to which clients can connect to initiate HTTPS or WSS
// connections with the environment.
WebHost string `protobuf:"bytes,12,opt,name=web_host,json=webHost,proto3" json:"web_host,omitempty"`
// Output only. Username that clients should use when initiating SSH sessions
// with the environment.
SshUsername string `protobuf:"bytes,5,opt,name=ssh_username,json=sshUsername,proto3" json:"ssh_username,omitempty"`
// Output only. Host to which clients can connect to initiate SSH sessions
// with the environment.
SshHost string `protobuf:"bytes,6,opt,name=ssh_host,json=sshHost,proto3" json:"ssh_host,omitempty"`
// Output only. Port to which clients can connect to initiate SSH sessions
// with the environment.
SshPort int32 `protobuf:"varint,7,opt,name=ssh_port,json=sshPort,proto3" json:"ssh_port,omitempty"`
// 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.
PublicKeys []string `protobuf:"bytes,8,rep,name=public_keys,json=publicKeys,proto3" json:"public_keys,omitempty"`
// contains filtered or unexported fields
}
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".
func (*Environment) Descriptor
func (*Environment) Descriptor() ([]byte, []int)
Deprecated: Use Environment.ProtoReflect.Descriptor instead.
func (*Environment) GetDockerImage
func (x *Environment) GetDockerImage() string
func (*Environment) GetId
func (x *Environment) GetId() string
func (*Environment) GetName
func (x *Environment) GetName() string
func (*Environment) GetPublicKeys
func (x *Environment) GetPublicKeys() []string
func (*Environment) GetSshHost
func (x *Environment) GetSshHost() string
func (*Environment) GetSshPort
func (x *Environment) GetSshPort() int32
func (*Environment) GetSshUsername
func (x *Environment) GetSshUsername() string
func (*Environment) GetState
func (x *Environment) GetState() Environment_State
func (*Environment) GetWebHost
func (x *Environment) GetWebHost() string
func (*Environment) ProtoMessage
func (*Environment) ProtoMessage()
func (*Environment) ProtoReflect
func (x *Environment) ProtoReflect() protoreflect.Message
func (*Environment) Reset
func (x *Environment) Reset()
func (*Environment) String
func (x *Environment) String() string
Environment_State
type Environment_State int32
Possible execution states for an environment.
Environment_STATE_UNSPECIFIED, Environment_SUSPENDED, Environment_PENDING, Environment_RUNNING, Environment_DELETING
const (
// The environment's states is unknown.
Environment_STATE_UNSPECIFIED Environment_State = 0
// The environment is not running and can't be connected to. Starting the
// environment will transition it to the PENDING state.
Environment_SUSPENDED Environment_State = 1
// The environment is being started but is not yet ready to accept
// connections.
Environment_PENDING Environment_State = 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.
Environment_RUNNING Environment_State = 3
// The environment is being deleted and can't be connected to.
Environment_DELETING Environment_State = 4
)
func (Environment_State) Descriptor
func (Environment_State) Descriptor() protoreflect.EnumDescriptor
func (Environment_State) Enum
func (x Environment_State) Enum() *Environment_State
func (Environment_State) EnumDescriptor
func (Environment_State) EnumDescriptor() ([]byte, []int)
Deprecated: Use Environment_State.Descriptor instead.
func (Environment_State) Number
func (x Environment_State) Number() protoreflect.EnumNumber
func (Environment_State) String
func (x Environment_State) String() string
func (Environment_State) Type
func (Environment_State) Type() protoreflect.EnumType
GetEnvironmentRequest
type GetEnvironmentRequest struct {
// Required. Name of the requested resource, for example `users/me/environments/default`
// or `users/someone@example.com/environments/default`.
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// contains filtered or unexported fields
}
Request message for [GetEnvironment][google.cloud.shell.v1.CloudShellService.GetEnvironment].
func (*GetEnvironmentRequest) Descriptor
func (*GetEnvironmentRequest) Descriptor() ([]byte, []int)
Deprecated: Use GetEnvironmentRequest.ProtoReflect.Descriptor instead.
func (*GetEnvironmentRequest) GetName
func (x *GetEnvironmentRequest) GetName() string
func (*GetEnvironmentRequest) ProtoMessage
func (*GetEnvironmentRequest) ProtoMessage()
func (*GetEnvironmentRequest) ProtoReflect
func (x *GetEnvironmentRequest) ProtoReflect() protoreflect.Message
func (*GetEnvironmentRequest) Reset
func (x *GetEnvironmentRequest) Reset()
func (*GetEnvironmentRequest) String
func (x *GetEnvironmentRequest) String() string
RemovePublicKeyMetadata
type RemovePublicKeyMetadata struct {
// contains filtered or unexported fields
}
Message included in the metadata field of operations returned from [RemovePublicKey][google.cloud.shell.v1.CloudShellService.RemovePublicKey].
func (*RemovePublicKeyMetadata) Descriptor
func (*RemovePublicKeyMetadata) Descriptor() ([]byte, []int)
Deprecated: Use RemovePublicKeyMetadata.ProtoReflect.Descriptor instead.
func (*RemovePublicKeyMetadata) ProtoMessage
func (*RemovePublicKeyMetadata) ProtoMessage()
func (*RemovePublicKeyMetadata) ProtoReflect
func (x *RemovePublicKeyMetadata) ProtoReflect() protoreflect.Message
func (*RemovePublicKeyMetadata) Reset
func (x *RemovePublicKeyMetadata) Reset()
func (*RemovePublicKeyMetadata) String
func (x *RemovePublicKeyMetadata) String() string
RemovePublicKeyRequest
type RemovePublicKeyRequest struct {
// Environment this key should be removed from, e.g.
// `users/me/environments/default`.
Environment string `protobuf:"bytes,1,opt,name=environment,proto3" json:"environment,omitempty"`
// Key that should be removed from the environment.
Key string `protobuf:"bytes,2,opt,name=key,proto3" json:"key,omitempty"`
// contains filtered or unexported fields
}
Request message for [RemovePublicKey][google.cloud.shell.v1.CloudShellService.RemovePublicKey].
func (*RemovePublicKeyRequest) Descriptor
func (*RemovePublicKeyRequest) Descriptor() ([]byte, []int)
Deprecated: Use RemovePublicKeyRequest.ProtoReflect.Descriptor instead.
func (*RemovePublicKeyRequest) GetEnvironment
func (x *RemovePublicKeyRequest) GetEnvironment() string
func (*RemovePublicKeyRequest) GetKey
func (x *RemovePublicKeyRequest) GetKey() string
func (*RemovePublicKeyRequest) ProtoMessage
func (*RemovePublicKeyRequest) ProtoMessage()
func (*RemovePublicKeyRequest) ProtoReflect
func (x *RemovePublicKeyRequest) ProtoReflect() protoreflect.Message
func (*RemovePublicKeyRequest) Reset
func (x *RemovePublicKeyRequest) Reset()
func (*RemovePublicKeyRequest) String
func (x *RemovePublicKeyRequest) String() string
RemovePublicKeyResponse
type RemovePublicKeyResponse struct {
// contains filtered or unexported fields
}
Response message for [RemovePublicKey][google.cloud.shell.v1.CloudShellService.RemovePublicKey].
func (*RemovePublicKeyResponse) Descriptor
func (*RemovePublicKeyResponse) Descriptor() ([]byte, []int)
Deprecated: Use RemovePublicKeyResponse.ProtoReflect.Descriptor instead.
func (*RemovePublicKeyResponse) ProtoMessage
func (*RemovePublicKeyResponse) ProtoMessage()
func (*RemovePublicKeyResponse) ProtoReflect
func (x *RemovePublicKeyResponse) ProtoReflect() protoreflect.Message
func (*RemovePublicKeyResponse) Reset
func (x *RemovePublicKeyResponse) Reset()
func (*RemovePublicKeyResponse) String
func (x *RemovePublicKeyResponse) String() string
StartEnvironmentMetadata
type StartEnvironmentMetadata struct {
// Current state of the environment being started.
State StartEnvironmentMetadata_State `protobuf:"varint,1,opt,name=state,proto3,enum=google.cloud.shell.v1.StartEnvironmentMetadata_State" json:"state,omitempty"`
// contains filtered or unexported fields
}
Message included in the metadata field of operations returned from [StartEnvironment][google.cloud.shell.v1.CloudShellService.StartEnvironment].
func (*StartEnvironmentMetadata) Descriptor
func (*StartEnvironmentMetadata) Descriptor() ([]byte, []int)
Deprecated: Use StartEnvironmentMetadata.ProtoReflect.Descriptor instead.
func (*StartEnvironmentMetadata) GetState
func (x *StartEnvironmentMetadata) GetState() StartEnvironmentMetadata_State
func (*StartEnvironmentMetadata) ProtoMessage
func (*StartEnvironmentMetadata) ProtoMessage()
func (*StartEnvironmentMetadata) ProtoReflect
func (x *StartEnvironmentMetadata) ProtoReflect() protoreflect.Message
func (*StartEnvironmentMetadata) Reset
func (x *StartEnvironmentMetadata) Reset()
func (*StartEnvironmentMetadata) String
func (x *StartEnvironmentMetadata) String() string
StartEnvironmentMetadata_State
type StartEnvironmentMetadata_State int32
Possible states an environment might transition between during startup. These states are not normally actionable by clients, but may be used to show a progress message to the user. An environment won't necessarily go through all of these states when starting. More states are likely to be added in the future.
StartEnvironmentMetadata_STATE_UNSPECIFIED, StartEnvironmentMetadata_STARTING, StartEnvironmentMetadata_UNARCHIVING_DISK, StartEnvironmentMetadata_AWAITING_COMPUTE_RESOURCES, StartEnvironmentMetadata_FINISHED
const (
// The environment's start state is unknown.
StartEnvironmentMetadata_STATE_UNSPECIFIED StartEnvironmentMetadata_State = 0
// The environment is in the process of being started, but no additional
// details are available.
StartEnvironmentMetadata_STARTING StartEnvironmentMetadata_State = 1
// Startup is waiting for the user's disk to be unarchived. This can happen
// when the user returns to Cloud Shell after not having used it for a
// while, and suggests that startup will take longer than normal.
StartEnvironmentMetadata_UNARCHIVING_DISK StartEnvironmentMetadata_State = 2
// Startup is waiting for compute resources to be assigned to the
// environment. This should normally happen very quickly, but an environment
// might stay in this state for an extended period of time if the system is
// experiencing heavy load.
StartEnvironmentMetadata_AWAITING_COMPUTE_RESOURCES StartEnvironmentMetadata_State = 4
// Startup has completed. If the start operation was successful, the user
// should be able to establish an SSH connection to their environment.
// Otherwise, the operation will contain details of the failure.
StartEnvironmentMetadata_FINISHED StartEnvironmentMetadata_State = 3
)
func (StartEnvironmentMetadata_State) Descriptor
func (StartEnvironmentMetadata_State) Descriptor() protoreflect.EnumDescriptor
func (StartEnvironmentMetadata_State) Enum
func (x StartEnvironmentMetadata_State) Enum() *StartEnvironmentMetadata_State
func (StartEnvironmentMetadata_State) EnumDescriptor
func (StartEnvironmentMetadata_State) EnumDescriptor() ([]byte, []int)
Deprecated: Use StartEnvironmentMetadata_State.Descriptor instead.
func (StartEnvironmentMetadata_State) Number
func (x StartEnvironmentMetadata_State) Number() protoreflect.EnumNumber
func (StartEnvironmentMetadata_State) String
func (x StartEnvironmentMetadata_State) String() string
func (StartEnvironmentMetadata_State) Type
func (StartEnvironmentMetadata_State) Type() protoreflect.EnumType
StartEnvironmentRequest
type StartEnvironmentRequest struct {
// Name of the resource that should be started, for example
// `users/me/environments/default` or
// `users/someone@example.com/environments/default`.
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// The initial access token passed to the environment. If this is present and
// valid, the environment will be pre-authenticated with gcloud so that the
// user can run gcloud commands in Cloud Shell without having to log in. This
// code can be updated later by calling AuthorizeEnvironment.
AccessToken string `protobuf:"bytes,2,opt,name=access_token,json=accessToken,proto3" json:"access_token,omitempty"`
// Public keys that should be added to the environment before it is started.
PublicKeys []string `protobuf:"bytes,3,rep,name=public_keys,json=publicKeys,proto3" json:"public_keys,omitempty"`
// contains filtered or unexported fields
}
Request message for [StartEnvironment][google.cloud.shell.v1.CloudShellService.StartEnvironment].
func (*StartEnvironmentRequest) Descriptor
func (*StartEnvironmentRequest) Descriptor() ([]byte, []int)
Deprecated: Use StartEnvironmentRequest.ProtoReflect.Descriptor instead.
func (*StartEnvironmentRequest) GetAccessToken
func (x *StartEnvironmentRequest) GetAccessToken() string
func (*StartEnvironmentRequest) GetName
func (x *StartEnvironmentRequest) GetName() string
func (*StartEnvironmentRequest) GetPublicKeys
func (x *StartEnvironmentRequest) GetPublicKeys() []string
func (*StartEnvironmentRequest) ProtoMessage
func (*StartEnvironmentRequest) ProtoMessage()
func (*StartEnvironmentRequest) ProtoReflect
func (x *StartEnvironmentRequest) ProtoReflect() protoreflect.Message
func (*StartEnvironmentRequest) Reset
func (x *StartEnvironmentRequest) Reset()
func (*StartEnvironmentRequest) String
func (x *StartEnvironmentRequest) String() string
StartEnvironmentResponse
type StartEnvironmentResponse struct {
// Environment that was started.
Environment *Environment `protobuf:"bytes,1,opt,name=environment,proto3" json:"environment,omitempty"`
// contains filtered or unexported fields
}
Message included in the response field of operations returned from [StartEnvironment][google.cloud.shell.v1.CloudShellService.StartEnvironment] once the operation is complete.
func (*StartEnvironmentResponse) Descriptor
func (*StartEnvironmentResponse) Descriptor() ([]byte, []int)
Deprecated: Use StartEnvironmentResponse.ProtoReflect.Descriptor instead.
func (*StartEnvironmentResponse) GetEnvironment
func (x *StartEnvironmentResponse) GetEnvironment() *Environment
func (*StartEnvironmentResponse) ProtoMessage
func (*StartEnvironmentResponse) ProtoMessage()
func (*StartEnvironmentResponse) ProtoReflect
func (x *StartEnvironmentResponse) ProtoReflect() protoreflect.Message
func (*StartEnvironmentResponse) Reset
func (x *StartEnvironmentResponse) Reset()
func (*StartEnvironmentResponse) String
func (x *StartEnvironmentResponse) String() string
UnimplementedCloudShellServiceServer
type UnimplementedCloudShellServiceServer struct {
}
UnimplementedCloudShellServiceServer can be embedded to have forward compatible implementations.
func (*UnimplementedCloudShellServiceServer) AddPublicKey
func (*UnimplementedCloudShellServiceServer) AddPublicKey(context.Context, *AddPublicKeyRequest) (*longrunningpb.Operation, error)
func (*UnimplementedCloudShellServiceServer) AuthorizeEnvironment
func (*UnimplementedCloudShellServiceServer) AuthorizeEnvironment(context.Context, *AuthorizeEnvironmentRequest) (*longrunningpb.Operation, error)
func (*UnimplementedCloudShellServiceServer) GetEnvironment
func (*UnimplementedCloudShellServiceServer) GetEnvironment(context.Context, *GetEnvironmentRequest) (*Environment, error)
func (*UnimplementedCloudShellServiceServer) RemovePublicKey
func (*UnimplementedCloudShellServiceServer) RemovePublicKey(context.Context, *RemovePublicKeyRequest) (*longrunningpb.Operation, error)
func (*UnimplementedCloudShellServiceServer) StartEnvironment
func (*UnimplementedCloudShellServiceServer) StartEnvironment(context.Context, *StartEnvironmentRequest) (*longrunningpb.Operation, error)