cloudshell

package
v0.0.0-...-ff3b5ee Latest Latest
Warning

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

 Go to latest Published: Mar 12, 2024 License: BSD-3-Clause Imports: 15 Imported by: 0

Documentation

Overview

Package cloudshell provides access to the Cloud Shell API.

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

Creating a client

Usage example: 

import "google.golang.org/api/cloudshell/v1alpha1"
...
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 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 option.WithTokenSource: 

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

See https://godoc.org/google.golang.org/api/option/ for details on options.

Index

Constants

View Source 
const (
	// View and manage your data across Google Cloud Platform services
	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 AuthorizeEnvironmentRequest 

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 values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	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. However, any field with
	// an empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

AuthorizeEnvironmentRequest: Request message for AuthorizeEnvironment.

func (*AuthorizeEnvironmentRequest) MarshalJSON 

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

type CreatePublicKeyRequest 

type CreatePublicKeyRequest struct {
	// Key: Key that should be added to the environment.
	Key *PublicKey `json:"key,omitempty"`

	// ForceSendFields is a list of field names (e.g. "Key") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	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. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

CreatePublicKeyRequest: Request message for CreatePublicKey.

func (*CreatePublicKeyRequest) MarshalJSON 

func (s *CreatePublicKeyRequest) MarshalJSON() ([]byte, error)

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); } The JSON representation for `Empty` is empty JSON object `{}`.

type Environment 

type Environment struct {
	// DockerImage: Required. 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: Output only. 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
	// CreatePublicKey and DeletePublicKey methods.
	PublicKeys []*PublicKey `json:"publicKeys,omitempty"`

	// Size: Indicates the size of the backing VM running the environment.
	// If set to something other than DEFAULT, it will be reverted to the
	// default VM size after vm_size_expire_time.
	//
	// Possible values:
	//   "VM_SIZE_UNSPECIFIED" - The VM size is unknown.
	//   "DEFAULT" - The default VM size.
	//   "BOOSTED" - The boosted VM size.
	Size string `json:"size,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.
	//   "DISABLED" - The environment is not running and can't be connected
	// to. Starting the environment will transition it to the STARTING
	// state.
	//   "STARTING" - 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"`

	// VmSizeExpireTime: Output only. The time when the Environment will
	// expire back to the default VM size.
	VmSizeExpireTime string `json:"vmSizeExpireTime,omitempty"`

	// WebHost: Output only. Host to which clients can connect to initiate
	// HTTPS or WSS connections with the environment.
	WebHost string `json:"webHost,omitempty"`

	// WebPorts: Output only. Ports to which clients can connect to initiate
	// HTTPS or WSS connections with the environment.
	WebPorts []int64 `json:"webPorts,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 values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	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. However, any field with
	// an empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	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 a single environment with the ID "default".

func (*Environment) MarshalJSON 

func (s *Environment) 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 response of the operation in case of success. 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 values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	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. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	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 PublicKey 

type PublicKey struct {
	// Format: Required. Format of this key's content.
	//
	// Possible values:
	//   "FORMAT_UNSPECIFIED" - Unknown format. Do not use.
	//   "SSH_DSS" - `ssh-dss` key format (see RFC4253).
	//   "SSH_RSA" - `ssh-rsa` key format (see RFC4253).
	//   "ECDSA_SHA2_NISTP256" - `ecdsa-sha2-nistp256` key format (see
	// RFC5656).
	//   "ECDSA_SHA2_NISTP384" - `ecdsa-sha2-nistp384` key format (see
	// RFC5656).
	//   "ECDSA_SHA2_NISTP521" - `ecdsa-sha2-nistp521` key format (see
	// RFC5656).
	Format string `json:"format,omitempty"`

	// Key: Required. Content of this key.
	Key string `json:"key,omitempty"`

	// Name: Output only. Full name of this resource, in the format
	// `users/{owner_email}/environments/{environment_id}/publicKeys/{key_id}
	// `. `{owner_email}` is the email address of the user to whom the key
	// belongs. `{environment_id}` is the identifier of the environment to
	// which the key grants access. `{key_id}` is the unique identifier of
	// the key. For example,
	// `users/someone@example.com/environments/default/publicKeys/myKey`.
	Name string `json:"name,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the
	// server.
	googleapi.ServerResponse `json:"-"`

	// ForceSendFields is a list of field names (e.g. "Format") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "Format") to include in API
	// requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

PublicKey: A public SSH key, corresponding to a private SSH key held by the client.

func (*PublicKey) MarshalJSON 

func (s *PublicKey) MarshalJSON() ([]byte, error)

type Service 

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

	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 

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_VM" - Startup is waiting for a VM 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.
	//   "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 values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	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. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	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 

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 []*PublicKey `json:"publicKeys,omitempty"`

	// ForceSendFields is a list of field names (e.g. "AccessToken") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	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. However, any field with
	// an empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

StartEnvironmentRequest: Request message for StartEnvironment.

func (*StartEnvironmentRequest) MarshalJSON 

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 values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	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. However, any field with
	// an empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	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 values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	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. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	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 UsersEnvironmentsAuthorizeCall 

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

func (*UsersEnvironmentsAuthorizeCall) Context 

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

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*UsersEnvironmentsAuthorizeCall) Do 

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

Do executes the "cloudshell.users.environments.authorize" call. Exactly one of *Empty or error will be non-nil. 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 (*UsersEnvironmentsAuthorizeCall) Fields 

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

func (*UsersEnvironmentsAuthorizeCall) Header 

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

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

type UsersEnvironmentsGetCall 

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

func (*UsersEnvironmentsGetCall) Context 

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

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*UsersEnvironmentsGetCall) Do 

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

Do executes the "cloudshell.users.environments.get" call. Exactly one of *Environment or error will be non-nil. 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 

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

func (*UsersEnvironmentsGetCall) Header 

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

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

func (*UsersEnvironmentsGetCall) IfNoneMatch 

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

IfNoneMatch sets the 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. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

type UsersEnvironmentsPatchCall 

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

func (*UsersEnvironmentsPatchCall) Context 

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

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*UsersEnvironmentsPatchCall) Do 

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

Do executes the "cloudshell.users.environments.patch" call. Exactly one of *Environment or error will be non-nil. 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 (*UsersEnvironmentsPatchCall) Fields 

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

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

func (*UsersEnvironmentsPatchCall) Header 

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

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

func (*UsersEnvironmentsPatchCall) UpdateMask 

func (c *UsersEnvironmentsPatchCall) UpdateMask(updateMask string) *UsersEnvironmentsPatchCall

UpdateMask sets the optional parameter "updateMask": Mask specifying which fields in the environment should be updated.

type UsersEnvironmentsPublicKeysCreateCall 

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

func (*UsersEnvironmentsPublicKeysCreateCall) Context 

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

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*UsersEnvironmentsPublicKeysCreateCall) Do 

func (c *UsersEnvironmentsPublicKeysCreateCall) Do(opts ...googleapi.CallOption) (*PublicKey, error)

Do executes the "cloudshell.users.environments.publicKeys.create" call. Exactly one of *PublicKey or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *PublicKey.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 (*UsersEnvironmentsPublicKeysCreateCall) Fields 

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

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

func (*UsersEnvironmentsPublicKeysCreateCall) Header 

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

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

type UsersEnvironmentsPublicKeysDeleteCall 

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

func (*UsersEnvironmentsPublicKeysDeleteCall) Context 

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

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*UsersEnvironmentsPublicKeysDeleteCall) Do 

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

Do executes the "cloudshell.users.environments.publicKeys.delete" call. Exactly one of *Empty or error will be non-nil. 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 (*UsersEnvironmentsPublicKeysDeleteCall) Fields 

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

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

func (*UsersEnvironmentsPublicKeysDeleteCall) Header 

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

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

type UsersEnvironmentsPublicKeysService 

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

func NewUsersEnvironmentsPublicKeysService 

func NewUsersEnvironmentsPublicKeysService(s *Service) *UsersEnvironmentsPublicKeysService

func (*UsersEnvironmentsPublicKeysService) Create 

func (r *UsersEnvironmentsPublicKeysService) Create(parent string, createpublickeyrequest *CreatePublicKeyRequest) *UsersEnvironmentsPublicKeysCreateCall

Create: 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 format and content already exists, this will return the existing key.

func (*UsersEnvironmentsPublicKeysService) Delete 

func (r *UsersEnvironmentsPublicKeysService) Delete(name string) *UsersEnvironmentsPublicKeysDeleteCall

Delete: Removes a public SSH key from an environment. Clients will no longer be able to connect to the environment using the corresponding private key.

type UsersEnvironmentsService 

type UsersEnvironmentsService struct {
	PublicKeys *UsersEnvironmentsPublicKeysService
	// contains filtered or unexported fields
}

func NewUsersEnvironmentsService 

func NewUsersEnvironmentsService(s *Service) *UsersEnvironmentsService

func (*UsersEnvironmentsService) Authorize 

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.

func (*UsersEnvironmentsService) Get 

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

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

func (*UsersEnvironmentsService) Patch 

func (r *UsersEnvironmentsService) Patch(name string, environment *Environment) *UsersEnvironmentsPatchCall

Patch: Updates an existing environment.

func (*UsersEnvironmentsService) Start 

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.

type UsersEnvironmentsStartCall 

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

func (*UsersEnvironmentsStartCall) Context 

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

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*UsersEnvironmentsStartCall) Do 

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

Do executes the "cloudshell.users.environments.start" call. Exactly one of *Operation or error will be non-nil. 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 

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

func (*UsersEnvironmentsStartCall) Header 

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

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

type UsersService 

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

func NewUsersService 

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.