cloudshell

package
v0.207.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Nov 19, 2024 License: BSD-3-Clause Imports: 16 Imported by: 1

Documentation

Overview

Package cloudshell provides access to the Cloud Shell API.

For product documentation, see: https://cloud.google.com/shell/docs/

Library status

These client libraries are officially supported by Google. However, this library is considered complete and is in maintenance mode. This means that we will address critical bugs and security issues but will not add any new features.

When possible, we recommend using our newer [Cloud Client Libraries for Go](https://pkg.go.dev/cloud.google.com/go) that are still actively being worked and iterated on.

Creating a client

Usage example: 

import "google.golang.org/api/cloudshell/v1"
...
ctx := context.Background()
cloudshellService, err := cloudshell.NewService(ctx)

In this example, Google Application Default Credentials are used for authentication. For information on how to create and obtain Application Default Credentials, see https://developers.google.com/identity/protocols/application-default-credentials.

Other authentication options

To use an API key for authentication (note: some APIs do not support API keys), use google.golang.org/api/option.WithAPIKey: 

cloudshellService, err := cloudshell.NewService(ctx, option.WithAPIKey("AIza..."))

To use an OAuth token (e.g., a user token obtained via a three-legged OAuth flow, use google.golang.org/api/option.WithTokenSource: 

config := &oauth2.Config{...}
// ...
token, err := config.Exchange(ctx, ...)
cloudshellService, err := cloudshell.NewService(ctx, option.WithTokenSource(config.TokenSource(ctx, token)))

See google.golang.org/api/option.ClientOption for details on options.

Index

Constants

View Source 
const (
	// See, edit, configure, and delete your Google Cloud data and see the email
	// address for your Google Account.
	CloudPlatformScope = "https://www.googleapis.com/auth/cloud-platform"
)

OAuth2 scopes used by this API.

Variables

This section is empty.

Functions

This section is empty.

Types

type AddPublicKeyMetadata added in v0.33.0 

type AddPublicKeyMetadata struct {
}

AddPublicKeyMetadata: Message included in the metadata field of operations returned from AddPublicKey.

type AddPublicKeyRequest added in v0.33.0 

type AddPublicKeyRequest struct {
	// Key: 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 `json:"key,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Key") to unconditionally
	// include in API requests. By default, fields with empty or default values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Key") to include in API requests
	// with the JSON null value. By default, fields with empty values are omitted
	// from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

AddPublicKeyRequest: Request message for AddPublicKey.

func (AddPublicKeyRequest) MarshalJSON added in v0.33.0 

func (s AddPublicKeyRequest) MarshalJSON() ([]byte, error)

type AddPublicKeyResponse added in v0.33.0 

type AddPublicKeyResponse struct {
	// Key: Key that was added to the environment.
	Key string `json:"key,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Key") to unconditionally
	// include in API requests. By default, fields with empty or default values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Key") to include in API requests
	// with the JSON null value. By default, fields with empty values are omitted
	// from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

AddPublicKeyResponse: Response message for AddPublicKey.

func (AddPublicKeyResponse) MarshalJSON added in v0.33.0 

func (s AddPublicKeyResponse) MarshalJSON() ([]byte, error)

type AuthorizeEnvironmentMetadata added in v0.33.0 

type AuthorizeEnvironmentMetadata struct {
}

AuthorizeEnvironmentMetadata: Message included in the metadata field of operations returned from AuthorizeEnvironment.

type AuthorizeEnvironmentRequest added in v0.33.0 

type AuthorizeEnvironmentRequest struct {
	// AccessToken: The OAuth access token that should be sent to the environment.
	AccessToken string `json:"accessToken,omitempty"`
	// ExpireTime: The time when the credentials expire. If not set, defaults to
	// one hour from when the server received the request.
	ExpireTime string `json:"expireTime,omitempty"`
	// IdToken: The OAuth ID token that should be sent to the environment.
	IdToken string `json:"idToken,omitempty"`
	// ForceSendFields is a list of field names (e.g. "AccessToken") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "AccessToken") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

AuthorizeEnvironmentRequest: Request message for AuthorizeEnvironment.

func (AuthorizeEnvironmentRequest) MarshalJSON added in v0.33.0 

func (s AuthorizeEnvironmentRequest) MarshalJSON() ([]byte, error)

type AuthorizeEnvironmentResponse added in v0.33.0 

type AuthorizeEnvironmentResponse struct {
}

AuthorizeEnvironmentResponse: Response message for AuthorizeEnvironment.

type CancelOperationRequest 

type CancelOperationRequest struct {
}

CancelOperationRequest: The request message for Operations.CancelOperation.

type CreateEnvironmentMetadata added in v0.33.0 

type CreateEnvironmentMetadata struct {
}

CreateEnvironmentMetadata: Message included in the metadata field of operations returned from CreateEnvironment.

type DeleteEnvironmentMetadata added in v0.33.0 

type DeleteEnvironmentMetadata struct {
}

DeleteEnvironmentMetadata: Message included in the metadata field of operations returned from DeleteEnvironment.

type Empty 

type Empty struct {
	// ServerResponse contains the HTTP response code and headers from the server.
	googleapi.ServerResponse `json:"-"`
}

Empty: A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }

type Environment 

type Environment struct {
	// DockerImage: Required. Immutable. Full path to the Docker image used to run
	// this environment, e.g. "gcr.io/dev-con/cloud-devshell:latest".
	DockerImage string `json:"dockerImage,omitempty"`
	// Id: Output only. The environment's identifier, unique among the user's
	// environments.
	Id string `json:"id,omitempty"`
	// Name: 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 `json:"name,omitempty"`
	// PublicKeys: 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 `json:"publicKeys,omitempty"`
	// SshHost: Output only. Host to which clients can connect to initiate SSH
	// sessions with the environment.
	SshHost string `json:"sshHost,omitempty"`
	// SshPort: Output only. Port to which clients can connect to initiate SSH
	// sessions with the environment.
	SshPort int64 `json:"sshPort,omitempty"`
	// SshUsername: Output only. Username that clients should use when initiating
	// SSH sessions with the environment.
	SshUsername string `json:"sshUsername,omitempty"`
	// State: Output only. Current execution state of this environment.
	//
	// Possible values:
	//   "STATE_UNSPECIFIED" - The environment's states is unknown.
	//   "SUSPENDED" - The environment is not running and can't be connected to.
	// Starting the environment will transition it to the PENDING state.
	//   "PENDING" - The environment is being started but is not yet ready to
	// accept connections.
	//   "RUNNING" - 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.
	//   "DELETING" - The environment is being deleted and can't be connected to.
	State string `json:"state,omitempty"`
	// WebHost: Output only. Host to which clients can connect to initiate HTTPS or
	// WSS connections with the environment.
	WebHost string `json:"webHost,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the server.
	googleapi.ServerResponse `json:"-"`
	// ForceSendFields is a list of field names (e.g. "DockerImage") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "DockerImage") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

Environment: 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) MarshalJSON 

func (s Environment) MarshalJSON() ([]byte, error)

type ListOperationsResponse 

type ListOperationsResponse struct {
	// NextPageToken: The standard List next-page token.
	NextPageToken string `json:"nextPageToken,omitempty"`
	// Operations: A list of operations that matches the specified filter in the
	// request.
	Operations []*Operation `json:"operations,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the server.
	googleapi.ServerResponse `json:"-"`
	// ForceSendFields is a list of field names (e.g. "NextPageToken") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "NextPageToken") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

ListOperationsResponse: The response message for Operations.ListOperations.

func (ListOperationsResponse) MarshalJSON 

func (s ListOperationsResponse) MarshalJSON() ([]byte, error)

type Operation 

type Operation struct {
	// Done: If the value is `false`, it means the operation is still in progress.
	// If `true`, the operation is completed, and either `error` or `response` is
	// available.
	Done bool `json:"done,omitempty"`
	// Error: The error result of the operation in case of failure or cancellation.
	Error *Status `json:"error,omitempty"`
	// Metadata: Service-specific metadata associated with the operation. It
	// typically contains progress information and common metadata such as create
	// time. Some services might not provide such metadata. Any method that returns
	// a long-running operation should document the metadata type, if any.
	Metadata googleapi.RawMessage `json:"metadata,omitempty"`
	// Name: The server-assigned name, which is only unique within the same service
	// that originally returns it. If you use the default HTTP mapping, the `name`
	// should be a resource name ending with `operations/{unique_id}`.
	Name string `json:"name,omitempty"`
	// Response: The normal, successful response of the operation. If the original
	// method returns no data on success, such as `Delete`, the response is
	// `google.protobuf.Empty`. If the original method is standard
	// `Get`/`Create`/`Update`, the response should be the resource. For other
	// methods, the response should have the type `XxxResponse`, where `Xxx` is the
	// original method name. For example, if the original method name is
	// `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
	Response googleapi.RawMessage `json:"response,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the server.
	googleapi.ServerResponse `json:"-"`
	// ForceSendFields is a list of field names (e.g. "Done") to unconditionally
	// include in API requests. By default, fields with empty or default values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Done") to include in API requests
	// with the JSON null value. By default, fields with empty values are omitted
	// from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

Operation: This resource represents a long-running operation that is the result of a network API call.

func (Operation) MarshalJSON 

func (s Operation) MarshalJSON() ([]byte, error)

type OperationsCancelCall 

type OperationsCancelCall struct {
	// contains filtered or unexported fields
}

func (*OperationsCancelCall) Context 

func (c *OperationsCancelCall) Context(ctx context.Context) *OperationsCancelCall

Context sets the context to be used in this call's Do method.

func (*OperationsCancelCall) Do 

func (c *OperationsCancelCall) Do(opts ...googleapi.CallOption) (*Empty, error)

Do executes the "cloudshell.operations.cancel" call. Any non-2xx status code is an error. Response headers are in either *Empty.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*OperationsCancelCall) Fields 

func (c *OperationsCancelCall) Fields(s ...googleapi.Field) *OperationsCancelCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*OperationsCancelCall) Header 

func (c *OperationsCancelCall) Header() http.Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

type OperationsDeleteCall 

type OperationsDeleteCall struct {
	// contains filtered or unexported fields
}

func (*OperationsDeleteCall) Context 

func (c *OperationsDeleteCall) Context(ctx context.Context) *OperationsDeleteCall

Context sets the context to be used in this call's Do method.

func (*OperationsDeleteCall) Do 

func (c *OperationsDeleteCall) Do(opts ...googleapi.CallOption) (*Empty, error)

Do executes the "cloudshell.operations.delete" call. Any non-2xx status code is an error. Response headers are in either *Empty.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*OperationsDeleteCall) Fields 

func (c *OperationsDeleteCall) Fields(s ...googleapi.Field) *OperationsDeleteCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*OperationsDeleteCall) Header 

func (c *OperationsDeleteCall) Header() http.Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

type OperationsGetCall 

type OperationsGetCall struct {
	// contains filtered or unexported fields
}

func (*OperationsGetCall) Context 

func (c *OperationsGetCall) Context(ctx context.Context) *OperationsGetCall

Context sets the context to be used in this call's Do method.

func (*OperationsGetCall) Do 

func (c *OperationsGetCall) Do(opts ...googleapi.CallOption) (*Operation, error)

Do executes the "cloudshell.operations.get" call. Any non-2xx status code is an error. Response headers are in either *Operation.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*OperationsGetCall) Fields 

func (c *OperationsGetCall) Fields(s ...googleapi.Field) *OperationsGetCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*OperationsGetCall) Header 

func (c *OperationsGetCall) Header() http.Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*OperationsGetCall) IfNoneMatch 

func (c *OperationsGetCall) IfNoneMatch(entityTag string) *OperationsGetCall

IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.

type OperationsListCall 

type OperationsListCall struct {
	// contains filtered or unexported fields
}

func (*OperationsListCall) Context 

func (c *OperationsListCall) Context(ctx context.Context) *OperationsListCall

Context sets the context to be used in this call's Do method.

func (*OperationsListCall) Do 

func (c *OperationsListCall) Do(opts ...googleapi.CallOption) (*ListOperationsResponse, error)

Do executes the "cloudshell.operations.list" call. Any non-2xx status code is an error. Response headers are in either *ListOperationsResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*OperationsListCall) Fields 

func (c *OperationsListCall) Fields(s ...googleapi.Field) *OperationsListCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*OperationsListCall) Filter 

func (c *OperationsListCall) Filter(filter string) *OperationsListCall

Filter sets the optional parameter "filter": The standard list filter.

func (*OperationsListCall) Header 

func (c *OperationsListCall) Header() http.Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*OperationsListCall) IfNoneMatch 

func (c *OperationsListCall) IfNoneMatch(entityTag string) *OperationsListCall

IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.

func (*OperationsListCall) PageSize 

func (c *OperationsListCall) PageSize(pageSize int64) *OperationsListCall

PageSize sets the optional parameter "pageSize": The standard list page size.

func (*OperationsListCall) PageToken 

func (c *OperationsListCall) PageToken(pageToken string) *OperationsListCall

PageToken sets the optional parameter "pageToken": The standard list page token.

func (*OperationsListCall) Pages 

func (c *OperationsListCall) Pages(ctx context.Context, f func(*ListOperationsResponse) error) error

Pages invokes f for each page of results. A non-nil error returned from f will halt the iteration. The provided context supersedes any context provided to the Context method.

type OperationsService 

type OperationsService struct {
	// contains filtered or unexported fields
}

func NewOperationsService 

func NewOperationsService(s *Service) *OperationsService

func (*OperationsService) Cancel 

func (r *OperationsService) Cancel(name string, canceloperationrequest *CancelOperationRequest) *OperationsCancelCall

Cancel: Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.

- name: The name of the operation resource to be cancelled.

func (*OperationsService) Delete 

func (r *OperationsService) Delete(name string) *OperationsDeleteCall

Delete: Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.

- name: The name of the operation resource to be deleted.

func (*OperationsService) Get 

func (r *OperationsService) Get(name string) *OperationsGetCall

Get: Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

- name: The name of the operation resource.

func (*OperationsService) List 

func (r *OperationsService) List(name string) *OperationsListCall

List: Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.

- name: The name of the operation's parent resource.

type RemovePublicKeyMetadata added in v0.33.0 

type RemovePublicKeyMetadata struct {
}

RemovePublicKeyMetadata: Message included in the metadata field of operations returned from RemovePublicKey.

type RemovePublicKeyRequest added in v0.33.0 

type RemovePublicKeyRequest struct {
	// Key: Key that should be removed from the environment.
	Key string `json:"key,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Key") to unconditionally
	// include in API requests. By default, fields with empty or default values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Key") to include in API requests
	// with the JSON null value. By default, fields with empty values are omitted
	// from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

RemovePublicKeyRequest: Request message for RemovePublicKey.

func (RemovePublicKeyRequest) MarshalJSON added in v0.33.0 

func (s RemovePublicKeyRequest) MarshalJSON() ([]byte, error)

type RemovePublicKeyResponse added in v0.33.0 

type RemovePublicKeyResponse struct {
}

RemovePublicKeyResponse: Response message for RemovePublicKey.

type Service 

type Service struct {
	BasePath  string // API endpoint base URL
	UserAgent string // optional additional User-Agent fragment

	Operations *OperationsService

	Users *UsersService
	// contains filtered or unexported fields
}

func New deprecated 

func New(client *http.Client) (*Service, error)

New creates a new Service. It uses the provided http.Client for requests.

Deprecated: please use NewService instead. To provide a custom HTTP client, use option.WithHTTPClient. If you are using google.golang.org/api/googleapis/transport.APIKey, use option.WithAPIKey with NewService instead.

func NewService added in v0.3.0 

func NewService(ctx context.Context, opts ...option.ClientOption) (*Service, error)

NewService creates a new Service.

type StartEnvironmentMetadata 

type StartEnvironmentMetadata struct {
	// State: Current state of the environment being started.
	//
	// Possible values:
	//   "STATE_UNSPECIFIED" - The environment's start state is unknown.
	//   "STARTING" - The environment is in the process of being started, but no
	// additional details are available.
	//   "UNARCHIVING_DISK" - 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.
	//   "AWAITING_COMPUTE_RESOURCES" - 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.
	//   "FINISHED" - 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.
	State string `json:"state,omitempty"`
	// ForceSendFields is a list of field names (e.g. "State") to unconditionally
	// include in API requests. By default, fields with empty or default values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "State") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

StartEnvironmentMetadata: Message included in the metadata field of operations returned from StartEnvironment.

func (StartEnvironmentMetadata) MarshalJSON 

func (s StartEnvironmentMetadata) MarshalJSON() ([]byte, error)

type StartEnvironmentRequest added in v0.33.0 

type StartEnvironmentRequest struct {
	// AccessToken: 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 `json:"accessToken,omitempty"`
	// PublicKeys: Public keys that should be added to the environment before it is
	// started.
	PublicKeys []string `json:"publicKeys,omitempty"`
	// ForceSendFields is a list of field names (e.g. "AccessToken") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "AccessToken") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

StartEnvironmentRequest: Request message for StartEnvironment.

func (StartEnvironmentRequest) MarshalJSON added in v0.33.0 

func (s StartEnvironmentRequest) MarshalJSON() ([]byte, error)

type StartEnvironmentResponse 

type StartEnvironmentResponse struct {
	// Environment: Environment that was started.
	Environment *Environment `json:"environment,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Environment") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Environment") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

StartEnvironmentResponse: Message included in the response field of operations returned from StartEnvironment once the operation is complete.

func (StartEnvironmentResponse) MarshalJSON 

func (s StartEnvironmentResponse) MarshalJSON() ([]byte, error)

type Status 

type Status struct {
	// Code: The status code, which should be an enum value of google.rpc.Code.
	Code int64 `json:"code,omitempty"`
	// Details: A list of messages that carry the error details. There is a common
	// set of message types for APIs to use.
	Details []googleapi.RawMessage `json:"details,omitempty"`
	// Message: A developer-facing error message, which should be in English. Any
	// user-facing error message should be localized and sent in the
	// google.rpc.Status.details field, or localized by the client.
	Message string `json:"message,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Code") to unconditionally
	// include in API requests. By default, fields with empty or default values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Code") to include in API requests
	// with the JSON null value. By default, fields with empty values are omitted
	// from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

Status: The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC (https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the API Design Guide (https://cloud.google.com/apis/design/errors).

func (Status) MarshalJSON 

func (s Status) MarshalJSON() ([]byte, error)

type UsersEnvironmentsAddPublicKeyCall added in v0.33.0 

type UsersEnvironmentsAddPublicKeyCall struct {
	// contains filtered or unexported fields
}

func (*UsersEnvironmentsAddPublicKeyCall) Context added in v0.33.0 

func (c *UsersEnvironmentsAddPublicKeyCall) Context(ctx context.Context) *UsersEnvironmentsAddPublicKeyCall

Context sets the context to be used in this call's Do method.

func (*UsersEnvironmentsAddPublicKeyCall) Do added in v0.33.0 

func (c *UsersEnvironmentsAddPublicKeyCall) Do(opts ...googleapi.CallOption) (*Operation, error)

Do executes the "cloudshell.users.environments.addPublicKey" call. Any non-2xx status code is an error. Response headers are in either *Operation.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*UsersEnvironmentsAddPublicKeyCall) Fields added in v0.33.0 

func (c *UsersEnvironmentsAddPublicKeyCall) Fields(s ...googleapi.Field) *UsersEnvironmentsAddPublicKeyCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*UsersEnvironmentsAddPublicKeyCall) Header added in v0.33.0 

func (c *UsersEnvironmentsAddPublicKeyCall) Header() http.Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

type UsersEnvironmentsAuthorizeCall added in v0.33.0 

type UsersEnvironmentsAuthorizeCall struct {
	// contains filtered or unexported fields
}

func (*UsersEnvironmentsAuthorizeCall) Context added in v0.33.0 

func (c *UsersEnvironmentsAuthorizeCall) Context(ctx context.Context) *UsersEnvironmentsAuthorizeCall

Context sets the context to be used in this call's Do method.

func (*UsersEnvironmentsAuthorizeCall) Do added in v0.33.0 

func (c *UsersEnvironmentsAuthorizeCall) Do(opts ...googleapi.CallOption) (*Operation, error)

Do executes the "cloudshell.users.environments.authorize" call. Any non-2xx status code is an error. Response headers are in either *Operation.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*UsersEnvironmentsAuthorizeCall) Fields added in v0.33.0 

func (c *UsersEnvironmentsAuthorizeCall) Fields(s ...googleapi.Field) *UsersEnvironmentsAuthorizeCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*UsersEnvironmentsAuthorizeCall) Header added in v0.33.0 

func (c *UsersEnvironmentsAuthorizeCall) Header() http.Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

type UsersEnvironmentsGetCall added in v0.33.0 

type UsersEnvironmentsGetCall struct {
	// contains filtered or unexported fields
}

func (*UsersEnvironmentsGetCall) Context added in v0.33.0 

func (c *UsersEnvironmentsGetCall) Context(ctx context.Context) *UsersEnvironmentsGetCall

Context sets the context to be used in this call's Do method.

func (*UsersEnvironmentsGetCall) Do added in v0.33.0 

func (c *UsersEnvironmentsGetCall) Do(opts ...googleapi.CallOption) (*Environment, error)

Do executes the "cloudshell.users.environments.get" call. Any non-2xx status code is an error. Response headers are in either *Environment.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*UsersEnvironmentsGetCall) Fields added in v0.33.0 

func (c *UsersEnvironmentsGetCall) Fields(s ...googleapi.Field) *UsersEnvironmentsGetCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*UsersEnvironmentsGetCall) Header added in v0.33.0 

func (c *UsersEnvironmentsGetCall) Header() http.Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*UsersEnvironmentsGetCall) IfNoneMatch added in v0.33.0 

func (c *UsersEnvironmentsGetCall) IfNoneMatch(entityTag string) *UsersEnvironmentsGetCall

IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.

type UsersEnvironmentsRemovePublicKeyCall added in v0.33.0 

type UsersEnvironmentsRemovePublicKeyCall struct {
	// contains filtered or unexported fields
}

func (*UsersEnvironmentsRemovePublicKeyCall) Context added in v0.33.0 

func (c *UsersEnvironmentsRemovePublicKeyCall) Context(ctx context.Context) *UsersEnvironmentsRemovePublicKeyCall

Context sets the context to be used in this call's Do method.

func (*UsersEnvironmentsRemovePublicKeyCall) Do added in v0.33.0 

func (c *UsersEnvironmentsRemovePublicKeyCall) Do(opts ...googleapi.CallOption) (*Operation, error)

Do executes the "cloudshell.users.environments.removePublicKey" call. Any non-2xx status code is an error. Response headers are in either *Operation.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*UsersEnvironmentsRemovePublicKeyCall) Fields added in v0.33.0 

func (c *UsersEnvironmentsRemovePublicKeyCall) Fields(s ...googleapi.Field) *UsersEnvironmentsRemovePublicKeyCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*UsersEnvironmentsRemovePublicKeyCall) Header added in v0.33.0 

func (c *UsersEnvironmentsRemovePublicKeyCall) Header() http.Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

type UsersEnvironmentsService added in v0.33.0 

type UsersEnvironmentsService struct {
	// contains filtered or unexported fields
}

func NewUsersEnvironmentsService added in v0.33.0 

func NewUsersEnvironmentsService(s *Service) *UsersEnvironmentsService

func (*UsersEnvironmentsService) AddPublicKey added in v0.33.0 

func (r *UsersEnvironmentsService) AddPublicKey(environment string, addpublickeyrequest *AddPublicKeyRequest) *UsersEnvironmentsAddPublicKeyCall

AddPublicKey: 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.

  • environment: Environment this key should be added to, e.g. `users/me/environments/default`.

func (*UsersEnvironmentsService) Authorize added in v0.33.0 

func (r *UsersEnvironmentsService) Authorize(name string, authorizeenvironmentrequest *AuthorizeEnvironmentRequest) *UsersEnvironmentsAuthorizeCall

Authorize: 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.

  • name: Name of the resource that should receive the credentials, for example `users/me/environments/default` or `users/someone@example.com/environments/default`.

func (*UsersEnvironmentsService) Get added in v0.33.0 

func (r *UsersEnvironmentsService) Get(name string) *UsersEnvironmentsGetCall

Get: Gets an environment. Returns NOT_FOUND if the environment does not exist.

  • name: Name of the requested resource, for example `users/me/environments/default` or `users/someone@example.com/environments/default`.

func (*UsersEnvironmentsService) RemovePublicKey added in v0.33.0 

func (r *UsersEnvironmentsService) RemovePublicKey(environment string, removepublickeyrequest *RemovePublicKeyRequest) *UsersEnvironmentsRemovePublicKeyCall

RemovePublicKey: 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.

  • environment: Environment this key should be removed from, e.g. `users/me/environments/default`.

func (*UsersEnvironmentsService) Start added in v0.33.0 

func (r *UsersEnvironmentsService) Start(name string, startenvironmentrequest *StartEnvironmentRequest) *UsersEnvironmentsStartCall

Start: 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.

  • name: Name of the resource that should be started, for example `users/me/environments/default` or `users/someone@example.com/environments/default`.

type UsersEnvironmentsStartCall added in v0.33.0 

type UsersEnvironmentsStartCall struct {
	// contains filtered or unexported fields
}

func (*UsersEnvironmentsStartCall) Context added in v0.33.0 

func (c *UsersEnvironmentsStartCall) Context(ctx context.Context) *UsersEnvironmentsStartCall

Context sets the context to be used in this call's Do method.

func (*UsersEnvironmentsStartCall) Do added in v0.33.0 

func (c *UsersEnvironmentsStartCall) Do(opts ...googleapi.CallOption) (*Operation, error)

Do executes the "cloudshell.users.environments.start" call. Any non-2xx status code is an error. Response headers are in either *Operation.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*UsersEnvironmentsStartCall) Fields added in v0.33.0 

func (c *UsersEnvironmentsStartCall) Fields(s ...googleapi.Field) *UsersEnvironmentsStartCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*UsersEnvironmentsStartCall) Header added in v0.33.0 

func (c *UsersEnvironmentsStartCall) Header() http.Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

type UsersService added in v0.33.0 

type UsersService struct {
	Environments *UsersEnvironmentsService
	// contains filtered or unexported fields
}

func NewUsersService added in v0.33.0 

func NewUsersService(s *Service) *UsersService

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.