| // Copyright 2020 Google LLC. | |
| // Use of this source code is governed by a BSD-style | |
| // license that can be found in the LICENSE file. | |
| // Code generated file. DO NOT EDIT. | |
| // 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/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 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. | |
| package cloudshell // import "google.golang.org/api/cloudshell/v1" | |
| import ( | |
| "bytes" | |
| "context" | |
| "encoding/json" | |
| "errors" | |
| "fmt" | |
| "io" | |
| "net/http" | |
| "net/url" | |
| "strconv" | |
| "strings" | |
| googleapi "google.golang.org/api/googleapi" | |
| gensupport "google.golang.org/api/internal/gensupport" | |
| option "google.golang.org/api/option" | |
| internaloption "google.golang.org/api/option/internaloption" | |
| htransport "google.golang.org/api/transport/http" | |
| ) | |
| // Always reference these packages, just in case the auto-generated code | |
| // below doesn't. | |
| var _ = bytes.NewBuffer | |
| var _ = strconv.Itoa | |
| var _ = fmt.Sprintf | |
| var _ = json.NewDecoder | |
| var _ = io.Copy | |
| var _ = url.Parse | |
| var _ = gensupport.MarshalJSON | |
| var _ = googleapi.Version | |
| var _ = errors.New | |
| var _ = strings.Replace | |
| var _ = context.Canceled | |
| var _ = internaloption.WithDefaultEndpoint | |
| const apiId = "cloudshell:v1" | |
| const apiName = "cloudshell" | |
| const apiVersion = "v1" | |
| const basePath = "https://cloudshell.googleapis.com/" | |
| const mtlsBasePath = "https://cloudshell.mtls.googleapis.com/" | |
| // OAuth2 scopes used by this API. | |
| const ( | |
| // View and manage your data across Google Cloud Platform services | |
| CloudPlatformScope = "https://www.googleapis.com/auth/cloud-platform" | |
| ) | |
| // NewService creates a new Service. | |
| func NewService(ctx context.Context, opts ...option.ClientOption) (*Service, error) { | |
| scopesOption := option.WithScopes( | |
| "https://www.googleapis.com/auth/cloud-platform", | |
| ) | |
| // NOTE: prepend, so we don't override user-specified scopes. | |
| opts = append([]option.ClientOption{scopesOption}, opts...) | |
| opts = append(opts, internaloption.WithDefaultEndpoint(basePath)) | |
| opts = append(opts, internaloption.WithDefaultMTLSEndpoint(mtlsBasePath)) | |
| client, endpoint, err := htransport.NewClient(ctx, opts...) | |
| if err != nil { | |
| return nil, err | |
| } | |
| s, err := New(client) | |
| if err != nil { | |
| return nil, err | |
| } | |
| if endpoint != "" { | |
| s.BasePath = endpoint | |
| } | |
| return s, nil | |
| } | |
| // 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 New(client *http.Client) (*Service, error) { | |
| if client == nil { | |
| return nil, errors.New("client is nil") | |
| } | |
| s := &Service{client: client, BasePath: basePath} | |
| s.Operations = NewOperationsService(s) | |
| return s, nil | |
| } | |
| type Service struct { | |
| client *http.Client | |
| BasePath string // API endpoint base URL | |
| UserAgent string // optional additional User-Agent fragment | |
| Operations *OperationsService | |
| } | |
| func (s *Service) userAgent() string { | |
| if s.UserAgent == "" { | |
| return googleapi.UserAgent | |
| } | |
| return googleapi.UserAgent + " " + s.UserAgent | |
| } | |
| func NewOperationsService(s *Service) *OperationsService { | |
| rs := &OperationsService{s: s} | |
| return rs | |
| } | |
| type OperationsService struct { | |
| s *Service | |
| } | |
| // CancelOperationRequest: The request message for | |
| // Operations.CancelOperation. | |
| type CancelOperationRequest struct { | |
| } | |
| // 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 Empty struct { | |
| // ServerResponse contains the HTTP response code and headers from the | |
| // server. | |
| googleapi.ServerResponse `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". | |
| 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"` | |
| // 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:"-"` | |
| } | |
| func (s *Environment) MarshalJSON() ([]byte, error) { | |
| type NoMethod Environment | |
| raw := NoMethod(*s) | |
| return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) | |
| } | |
| // ListOperationsResponse: The response message for | |
| // Operations.ListOperations. | |
| 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 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. "NextPageToken") 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:"-"` | |
| } | |
| func (s *ListOperationsResponse) MarshalJSON() ([]byte, error) { | |
| type NoMethod ListOperationsResponse | |
| raw := NoMethod(*s) | |
| return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) | |
| } | |
| // Operation: This resource represents a long-running operation that is | |
| // the result of a | |
| // network API call. | |
| 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:"-"` | |
| } | |
| func (s *Operation) MarshalJSON() ([]byte, error) { | |
| type NoMethod Operation | |
| raw := NoMethod(*s) | |
| return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) | |
| } | |
| // PublicKey: A public SSH key, corresponding to a private SSH key held | |
| // by the client. | |
| 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/my | |
| // Key`. | |
| Name string `json:"name,omitempty"` | |
| // 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:"-"` | |
| } | |
| func (s *PublicKey) MarshalJSON() ([]byte, error) { | |
| type NoMethod PublicKey | |
| raw := NoMethod(*s) | |
| return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) | |
| } | |
| // StartEnvironmentMetadata: Message included in the metadata field of | |
| // operations returned from | |
| // StartEnvironment. | |
| 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:"-"` | |
| } | |
| func (s *StartEnvironmentMetadata) MarshalJSON() ([]byte, error) { | |
| type NoMethod StartEnvironmentMetadata | |
| raw := NoMethod(*s) | |
| return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) | |
| } | |
| // StartEnvironmentResponse: Message included in the response field of | |
| // operations returned from | |
| // StartEnvironment once the | |
| // operation is complete. | |
| 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:"-"` | |
| } | |
| func (s *StartEnvironmentResponse) MarshalJSON() ([]byte, error) { | |
| type NoMethod StartEnvironmentResponse | |
| raw := NoMethod(*s) | |
| return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) | |
| } | |
| // 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). | |
| 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:"-"` | |
| } | |
| func (s *Status) MarshalJSON() ([]byte, error) { | |
| type NoMethod Status | |
| raw := NoMethod(*s) | |
| return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) | |
| } | |
| // method id "cloudshell.operations.cancel": | |
| type OperationsCancelCall struct { | |
| s *Service | |
| name string | |
| canceloperationrequest *CancelOperationRequest | |
| urlParams_ gensupport.URLParams | |
| ctx_ context.Context | |
| header_ http.Header | |
| } | |
| // 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`. | |
| func (r *OperationsService) Cancel(name string, canceloperationrequest *CancelOperationRequest) *OperationsCancelCall { | |
| c := &OperationsCancelCall{s: r.s, urlParams_: make(gensupport.URLParams)} | |
| c.name = name | |
| c.canceloperationrequest = canceloperationrequest | |
| return c | |
| } | |
| // Fields allows partial responses to be retrieved. See | |
| // https://developers.google.com/gdata/docs/2.0/basics#PartialResponse | |
| // for more information. | |
| func (c *OperationsCancelCall) Fields(s ...googleapi.Field) *OperationsCancelCall { | |
| c.urlParams_.Set("fields", googleapi.CombineFields(s)) | |
| return c | |
| } | |
| // 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 (c *OperationsCancelCall) Context(ctx context.Context) *OperationsCancelCall { | |
| c.ctx_ = ctx | |
| return c | |
| } | |
| // Header returns an http.Header that can be modified by the caller to | |
| // add HTTP headers to the request. | |
| func (c *OperationsCancelCall) Header() http.Header { | |
| if c.header_ == nil { | |
| c.header_ = make(http.Header) | |
| } | |
| return c.header_ | |
| } | |
| func (c *OperationsCancelCall) doRequest(alt string) (*http.Response, error) { | |
| reqHeaders := make(http.Header) | |
| reqHeaders.Set("x-goog-api-client", "gl-go/"+gensupport.GoVersion()+" gdcl/20200623") | |
| for k, v := range c.header_ { | |
| reqHeaders[k] = v | |
| } | |
| reqHeaders.Set("User-Agent", c.s.userAgent()) | |
| var body io.Reader = nil | |
| body, err := googleapi.WithoutDataWrapper.JSONReader(c.canceloperationrequest) | |
| if err != nil { | |
| return nil, err | |
| } | |
| reqHeaders.Set("Content-Type", "application/json") | |
| c.urlParams_.Set("alt", alt) | |
| c.urlParams_.Set("prettyPrint", "false") | |
| urls := googleapi.ResolveRelative(c.s.BasePath, "v1/{+name}:cancel") | |
| urls += "?" + c.urlParams_.Encode() | |
| req, err := http.NewRequest("POST", urls, body) | |
| if err != nil { | |
| return nil, err | |
| } | |
| req.Header = reqHeaders | |
| googleapi.Expand(req.URL, map[string]string{ | |
| "name": c.name, | |
| }) | |
| return gensupport.SendRequest(c.ctx_, c.s.client, req) | |
| } | |
| // Do executes the "cloudshell.operations.cancel" 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 (c *OperationsCancelCall) Do(opts ...googleapi.CallOption) (*Empty, error) { | |
| gensupport.SetOptions(c.urlParams_, opts...) | |
| res, err := c.doRequest("json") | |
| if res != nil && res.StatusCode == http.StatusNotModified { | |
| if res.Body != nil { | |
| res.Body.Close() | |
| } | |
| return nil, &googleapi.Error{ | |
| Code: res.StatusCode, | |
| Header: res.Header, | |
| } | |
| } | |
| if err != nil { | |
| return nil, err | |
| } | |
| defer googleapi.CloseBody(res) | |
| if err := googleapi.CheckResponse(res); err != nil { | |
| return nil, err | |
| } | |
| ret := &Empty{ | |
| ServerResponse: googleapi.ServerResponse{ | |
| Header: res.Header, | |
| HTTPStatusCode: res.StatusCode, | |
| }, | |
| } | |
| target := &ret | |
| if err := gensupport.DecodeResponse(target, res); err != nil { | |
| return nil, err | |
| } | |
| return ret, nil | |
| // { | |
| // "description": "Starts asynchronous cancellation on a long-running operation. The server\nmakes a best effort to cancel the operation, but success is not\nguaranteed. If the server doesn't support this method, it returns\n`google.rpc.Code.UNIMPLEMENTED`. Clients can use\nOperations.GetOperation or\nother methods to check whether the cancellation succeeded or whether the\noperation completed despite cancellation. On successful cancellation,\nthe operation is not deleted; instead, it becomes an operation with\nan Operation.error value with a google.rpc.Status.code of 1,\ncorresponding to `Code.CANCELLED`.", | |
| // "flatPath": "v1/operations/{operationsId}:cancel", | |
| // "httpMethod": "POST", | |
| // "id": "cloudshell.operations.cancel", | |
| // "parameterOrder": [ | |
| // "name" | |
| // ], | |
| // "parameters": { | |
| // "name": { | |
| // "description": "The name of the operation resource to be cancelled.", | |
| // "location": "path", | |
| // "pattern": "^operations/.*$", | |
| // "required": true, | |
| // "type": "string" | |
| // } | |
| // }, | |
| // "path": "v1/{+name}:cancel", | |
| // "request": { | |
| // "$ref": "CancelOperationRequest" | |
| // }, | |
| // "response": { | |
| // "$ref": "Empty" | |
| // }, | |
| // "scopes": [ | |
| // "https://www.googleapis.com/auth/cloud-platform" | |
| // ] | |
| // } | |
| } | |
| // method id "cloudshell.operations.delete": | |
| type OperationsDeleteCall struct { | |
| s *Service | |
| name string | |
| urlParams_ gensupport.URLParams | |
| ctx_ context.Context | |
| header_ http.Header | |
| } | |
| // 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`. | |
| func (r *OperationsService) Delete(name string) *OperationsDeleteCall { | |
| c := &OperationsDeleteCall{s: r.s, urlParams_: make(gensupport.URLParams)} | |
| c.name = name | |
| return c | |
| } | |
| // Fields allows partial responses to be retrieved. See | |
| // https://developers.google.com/gdata/docs/2.0/basics#PartialResponse | |
| // for more information. | |
| func (c *OperationsDeleteCall) Fields(s ...googleapi.Field) *OperationsDeleteCall { | |
| c.urlParams_.Set("fields", googleapi.CombineFields(s)) | |
| return c | |
| } | |
| // 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 (c *OperationsDeleteCall) Context(ctx context.Context) *OperationsDeleteCall { | |
| c.ctx_ = ctx | |
| return c | |
| } | |
| // Header returns an http.Header that can be modified by the caller to | |
| // add HTTP headers to the request. | |
| func (c *OperationsDeleteCall) Header() http.Header { | |
| if c.header_ == nil { | |
| c.header_ = make(http.Header) | |
| } | |
| return c.header_ | |
| } | |
| func (c *OperationsDeleteCall) doRequest(alt string) (*http.Response, error) { | |
| reqHeaders := make(http.Header) | |
| reqHeaders.Set("x-goog-api-client", "gl-go/"+gensupport.GoVersion()+" gdcl/20200623") | |
| for k, v := range c.header_ { | |
| reqHeaders[k] = v | |
| } | |
| reqHeaders.Set("User-Agent", c.s.userAgent()) | |
| var body io.Reader = nil | |
| c.urlParams_.Set("alt", alt) | |
| c.urlParams_.Set("prettyPrint", "false") | |
| urls := googleapi.ResolveRelative(c.s.BasePath, "v1/{+name}") | |
| urls += "?" + c.urlParams_.Encode() | |
| req, err := http.NewRequest("DELETE", urls, body) | |
| if err != nil { | |
| return nil, err | |
| } | |
| req.Header = reqHeaders | |
| googleapi.Expand(req.URL, map[string]string{ | |
| "name": c.name, | |
| }) | |
| return gensupport.SendRequest(c.ctx_, c.s.client, req) | |
| } | |
| // Do executes the "cloudshell.operations.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 (c *OperationsDeleteCall) Do(opts ...googleapi.CallOption) (*Empty, error) { | |
| gensupport.SetOptions(c.urlParams_, opts...) | |
| res, err := c.doRequest("json") | |
| if res != nil && res.StatusCode == http.StatusNotModified { | |
| if res.Body != nil { | |
| res.Body.Close() | |
| } | |
| return nil, &googleapi.Error{ | |
| Code: res.StatusCode, | |
| Header: res.Header, | |
| } | |
| } | |
| if err != nil { | |
| return nil, err | |
| } | |
| defer googleapi.CloseBody(res) | |
| if err := googleapi.CheckResponse(res); err != nil { | |
| return nil, err | |
| } | |
| ret := &Empty{ | |
| ServerResponse: googleapi.ServerResponse{ | |
| Header: res.Header, | |
| HTTPStatusCode: res.StatusCode, | |
| }, | |
| } | |
| target := &ret | |
| if err := gensupport.DecodeResponse(target, res); err != nil { | |
| return nil, err | |
| } | |
| return ret, nil | |
| // { | |
| // "description": "Deletes a long-running operation. This method indicates that the client is\nno longer interested in the operation result. It does not cancel the\noperation. If the server doesn't support this method, it returns\n`google.rpc.Code.UNIMPLEMENTED`.", | |
| // "flatPath": "v1/operations/{operationsId}", | |
| // "httpMethod": "DELETE", | |
| // "id": "cloudshell.operations.delete", | |
| // "parameterOrder": [ | |
| // "name" | |
| // ], | |
| // "parameters": { | |
| // "name": { | |
| // "description": "The name of the operation resource to be deleted.", | |
| // "location": "path", | |
| // "pattern": "^operations/.*$", | |
| // "required": true, | |
| // "type": "string" | |
| // } | |
| // }, | |
| // "path": "v1/{+name}", | |
| // "response": { | |
| // "$ref": "Empty" | |
| // }, | |
| // "scopes": [ | |
| // "https://www.googleapis.com/auth/cloud-platform" | |
| // ] | |
| // } | |
| } | |
| // method id "cloudshell.operations.get": | |
| type OperationsGetCall struct { | |
| s *Service | |
| name string | |
| urlParams_ gensupport.URLParams | |
| ifNoneMatch_ string | |
| ctx_ context.Context | |
| header_ http.Header | |
| } | |
| // 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. | |
| func (r *OperationsService) Get(name string) *OperationsGetCall { | |
| c := &OperationsGetCall{s: r.s, urlParams_: make(gensupport.URLParams)} | |
| c.name = name | |
| return c | |
| } | |
| // Fields allows partial responses to be retrieved. See | |
| // https://developers.google.com/gdata/docs/2.0/basics#PartialResponse | |
| // for more information. | |
| func (c *OperationsGetCall) Fields(s ...googleapi.Field) *OperationsGetCall { | |
| c.urlParams_.Set("fields", googleapi.CombineFields(s)) | |
| return c | |
| } | |
| // 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. | |
| func (c *OperationsGetCall) IfNoneMatch(entityTag string) *OperationsGetCall { | |
| c.ifNoneMatch_ = entityTag | |
| return c | |
| } | |
| // 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 (c *OperationsGetCall) Context(ctx context.Context) *OperationsGetCall { | |
| c.ctx_ = ctx | |
| return c | |
| } | |
| // Header returns an http.Header that can be modified by the caller to | |
| // add HTTP headers to the request. | |
| func (c *OperationsGetCall) Header() http.Header { | |
| if c.header_ == nil { | |
| c.header_ = make(http.Header) | |
| } | |
| return c.header_ | |
| } | |
| func (c *OperationsGetCall) doRequest(alt string) (*http.Response, error) { | |
| reqHeaders := make(http.Header) | |
| reqHeaders.Set("x-goog-api-client", "gl-go/"+gensupport.GoVersion()+" gdcl/20200623") | |
| for k, v := range c.header_ { | |
| reqHeaders[k] = v | |
| } | |
| reqHeaders.Set("User-Agent", c.s.userAgent()) | |
| if c.ifNoneMatch_ != "" { | |
| reqHeaders.Set("If-None-Match", c.ifNoneMatch_) | |
| } | |
| var body io.Reader = nil | |
| c.urlParams_.Set("alt", alt) | |
| c.urlParams_.Set("prettyPrint", "false") | |
| urls := googleapi.ResolveRelative(c.s.BasePath, "v1/{+name}") | |
| urls += "?" + c.urlParams_.Encode() | |
| req, err := http.NewRequest("GET", urls, body) | |
| if err != nil { | |
| return nil, err | |
| } | |
| req.Header = reqHeaders | |
| googleapi.Expand(req.URL, map[string]string{ | |
| "name": c.name, | |
| }) | |
| return gensupport.SendRequest(c.ctx_, c.s.client, req) | |
| } | |
| // Do executes the "cloudshell.operations.get" 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 (c *OperationsGetCall) Do(opts ...googleapi.CallOption) (*Operation, error) { | |
| gensupport.SetOptions(c.urlParams_, opts...) | |
| res, err := c.doRequest("json") | |
| if res != nil && res.StatusCode == http.StatusNotModified { | |
| if res.Body != nil { | |
| res.Body.Close() | |
| } | |
| return nil, &googleapi.Error{ | |
| Code: res.StatusCode, | |
| Header: res.Header, | |
| } | |
| } | |
| if err != nil { | |
| return nil, err | |
| } | |
| defer googleapi.CloseBody(res) | |
| if err := googleapi.CheckResponse(res); err != nil { | |
| return nil, err | |
| } | |
| ret := &Operation{ | |
| ServerResponse: googleapi.ServerResponse{ | |
| Header: res.Header, | |
| HTTPStatusCode: res.StatusCode, | |
| }, | |
| } | |
| target := &ret | |
| if err := gensupport.DecodeResponse(target, res); err != nil { | |
| return nil, err | |
| } | |
| return ret, nil | |
| // { | |
| // "description": "Gets the latest state of a long-running operation. Clients can use this\nmethod to poll the operation result at intervals as recommended by the API\nservice.", | |
| // "flatPath": "v1/operations/{operationsId}", | |
| // "httpMethod": "GET", | |
| // "id": "cloudshell.operations.get", | |
| // "parameterOrder": [ | |
| // "name" | |
| // ], | |
| // "parameters": { | |
| // "name": { | |
| // "description": "The name of the operation resource.", | |
| // "location": "path", | |
| // "pattern": "^operations/.*$", | |
| // "required": true, | |
| // "type": "string" | |
| // } | |
| // }, | |
| // "path": "v1/{+name}", | |
| // "response": { | |
| // "$ref": "Operation" | |
| // }, | |
| // "scopes": [ | |
| // "https://www.googleapis.com/auth/cloud-platform" | |
| // ] | |
| // } | |
| } | |
| // method id "cloudshell.operations.list": | |
| type OperationsListCall struct { | |
| s *Service | |
| name string | |
| urlParams_ gensupport.URLParams | |
| ifNoneMatch_ string | |
| ctx_ context.Context | |
| header_ http.Header | |
| } | |
| // List: Lists operations that match the specified filter in the | |
| // request. If the | |
| // server doesn't support this method, it returns | |
| // `UNIMPLEMENTED`. | |
| // | |
| // NOTE: the `name` binding allows API services to override the | |
| // binding | |
| // to use different resource name schemes, such as `users/*/operations`. | |
| // To | |
| // override the binding, API services can add a binding such | |
| // as | |
| // "/v1/{name=users/*}/operations" to their service configuration. | |
| // For backwards compatibility, the default name includes the | |
| // operations | |
| // collection id, however overriding users must ensure the name | |
| // binding | |
| // is the parent resource, without the operations collection id. | |
| func (r *OperationsService) List(name string) *OperationsListCall { | |
| c := &OperationsListCall{s: r.s, urlParams_: make(gensupport.URLParams)} | |
| c.name = name | |
| return c | |
| } | |
| // Filter sets the optional parameter "filter": The standard list | |
| // filter. | |
| func (c *OperationsListCall) Filter(filter string) *OperationsListCall { | |
| c.urlParams_.Set("filter", filter) | |
| return c | |
| } | |
| // PageSize sets the optional parameter "pageSize": The standard list | |
| // page size. | |
| func (c *OperationsListCall) PageSize(pageSize int64) *OperationsListCall { | |
| c.urlParams_.Set("pageSize", fmt.Sprint(pageSize)) | |
| return c | |
| } | |
| // PageToken sets the optional parameter "pageToken": The standard list | |
| // page token. | |
| func (c *OperationsListCall) PageToken(pageToken string) *OperationsListCall { | |
| c.urlParams_.Set("pageToken", pageToken) | |
| return c | |
| } | |
| // Fields allows partial responses to be retrieved. See | |
| // https://developers.google.com/gdata/docs/2.0/basics#PartialResponse | |
| // for more information. | |
| func (c *OperationsListCall) Fields(s ...googleapi.Field) *OperationsListCall { | |
| c.urlParams_.Set("fields", googleapi.CombineFields(s)) | |
| return c | |
| } | |
| // 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. | |
| func (c *OperationsListCall) IfNoneMatch(entityTag string) *OperationsListCall { | |
| c.ifNoneMatch_ = entityTag | |
| return c | |
| } | |
| // 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 (c *OperationsListCall) Context(ctx context.Context) *OperationsListCall { | |
| c.ctx_ = ctx | |
| return c | |
| } | |
| // Header returns an http.Header that can be modified by the caller to | |
| // add HTTP headers to the request. | |
| func (c *OperationsListCall) Header() http.Header { | |
| if c.header_ == nil { | |
| c.header_ = make(http.Header) | |
| } | |
| return c.header_ | |
| } | |
| func (c *OperationsListCall) doRequest(alt string) (*http.Response, error) { | |
| reqHeaders := make(http.Header) | |
| reqHeaders.Set("x-goog-api-client", "gl-go/"+gensupport.GoVersion()+" gdcl/20200623") | |
| for k, v := range c.header_ { | |
| reqHeaders[k] = v | |
| } | |
| reqHeaders.Set("User-Agent", c.s.userAgent()) | |
| if c.ifNoneMatch_ != "" { | |
| reqHeaders.Set("If-None-Match", c.ifNoneMatch_) | |
| } | |
| var body io.Reader = nil | |
| c.urlParams_.Set("alt", alt) | |
| c.urlParams_.Set("prettyPrint", "false") | |
| urls := googleapi.ResolveRelative(c.s.BasePath, "v1/{+name}") | |
| urls += "?" + c.urlParams_.Encode() | |
| req, err := http.NewRequest("GET", urls, body) | |
| if err != nil { | |
| return nil, err | |
| } | |
| req.Header = reqHeaders | |
| googleapi.Expand(req.URL, map[string]string{ | |
| "name": c.name, | |
| }) | |
| return gensupport.SendRequest(c.ctx_, c.s.client, req) | |
| } | |
| // Do executes the "cloudshell.operations.list" call. | |
| // Exactly one of *ListOperationsResponse or error will be non-nil. 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 (c *OperationsListCall) Do(opts ...googleapi.CallOption) (*ListOperationsResponse, error) { | |
| gensupport.SetOptions(c.urlParams_, opts...) | |
| res, err := c.doRequest("json") | |
| if res != nil && res.StatusCode == http.StatusNotModified { | |
| if res.Body != nil { | |
| res.Body.Close() | |
| } | |
| return nil, &googleapi.Error{ | |
| Code: res.StatusCode, | |
| Header: res.Header, | |
| } | |
| } | |
| if err != nil { | |
| return nil, err | |
| } | |
| defer googleapi.CloseBody(res) | |
| if err := googleapi.CheckResponse(res); err != nil { | |
| return nil, err | |
| } | |
| ret := &ListOperationsResponse{ | |
| ServerResponse: googleapi.ServerResponse{ | |
| Header: res.Header, | |
| HTTPStatusCode: res.StatusCode, | |
| }, | |
| } | |
| target := &ret | |
| if err := gensupport.DecodeResponse(target, res); err != nil { | |
| return nil, err | |
| } | |
| return ret, nil | |
| // { | |
| // "description": "Lists operations that match the specified filter in the request. If the\nserver doesn't support this method, it returns `UNIMPLEMENTED`.\n\nNOTE: the `name` binding allows API services to override the binding\nto use different resource name schemes, such as `users/*/operations`. To\noverride the binding, API services can add a binding such as\n`\"/v1/{name=users/*}/operations\"` to their service configuration.\nFor backwards compatibility, the default name includes the operations\ncollection id, however overriding users must ensure the name binding\nis the parent resource, without the operations collection id.", | |
| // "flatPath": "v1/operations", | |
| // "httpMethod": "GET", | |
| // "id": "cloudshell.operations.list", | |
| // "parameterOrder": [ | |
| // "name" | |
| // ], | |
| // "parameters": { | |
| // "filter": { | |
| // "description": "The standard list filter.", | |
| // "location": "query", | |
| // "type": "string" | |
| // }, | |
| // "name": { | |
| // "description": "The name of the operation's parent resource.", | |
| // "location": "path", | |
| // "pattern": "^operations$", | |
| // "required": true, | |
| // "type": "string" | |
| // }, | |
| // "pageSize": { | |
| // "description": "The standard list page size.", | |
| // "format": "int32", | |
| // "location": "query", | |
| // "type": "integer" | |
| // }, | |
| // "pageToken": { | |
| // "description": "The standard list page token.", | |
| // "location": "query", | |
| // "type": "string" | |
| // } | |
| // }, | |
| // "path": "v1/{+name}", | |
| // "response": { | |
| // "$ref": "ListOperationsResponse" | |
| // }, | |
| // "scopes": [ | |
| // "https://www.googleapis.com/auth/cloud-platform" | |
| // ] | |
| // } | |
| } | |
| // 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. | |
| func (c *OperationsListCall) Pages(ctx context.Context, f func(*ListOperationsResponse) error) error { | |
| c.ctx_ = ctx | |
| defer c.PageToken(c.urlParams_.Get("pageToken")) // reset paging to original point | |
| for { | |
| x, err := c.Do() | |
| if err != nil { | |
| return err | |
| } | |
| if err := f(x); err != nil { | |
| return err | |
| } | |
| if x.NextPageToken == "" { | |
| return nil | |
| } | |
| c.PageToken(x.NextPageToken) | |
| } | |
| } |