type Bucket struct {// Bucket: Required. Bucket name for the objects to be transformed.Bucketstring `json:"bucket,omitempty"`// Manifest: Specifies objects in a manifest file.Manifest *Manifest `json:"manifest,omitempty"`// PrefixList: Specifies objects matching a prefix set.PrefixList *PrefixList `json:"prefixList,omitempty"`// ForceSendFields is a list of field names (e.g. "Bucket") 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. "Bucket") 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:"-"`}

func (Bucket)MarshalJSON¶

func (sBucket) MarshalJSON() ([]byte,error)

type BucketList struct {// Buckets: Required. List of buckets and their objects to be transformed.// Currently, only one bucket configuration is supported. If multiple buckets// are specified, an error will be returned.Buckets []*Bucket `json:"buckets,omitempty"`// ForceSendFields is a list of field names (e.g. "Buckets") 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. "Buckets") 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:"-"`}

func (BucketList)MarshalJSON¶

func (sBucketList) MarshalJSON() ([]byte,error)

type CancelJobRequest struct {// RequestId: Optional. An optional request ID to identify requests. Specify a// unique request ID in case you need to retry your request. Requests with same// `request_id` will be ignored for at least 60 minutes since the first// request. The request ID must be a valid UUID with the exception that zero// UUID is not supported (00000000-0000-0000-0000-000000000000).RequestIdstring `json:"requestId,omitempty"`// ForceSendFields is a list of field names (e.g. "RequestId") 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. "RequestId") 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:"-"`}

func (CancelJobRequest)MarshalJSON¶

func (sCancelJobRequest) MarshalJSON() ([]byte,error)

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

type CancelOperationRequest struct {}

type Counters struct {// FailedObjectCount: Output only. Number of objects failed.FailedObjectCountint64 `json:"failedObjectCount,omitempty,string"`// SucceededObjectCount: Output only. Number of objects completed.SucceededObjectCountint64 `json:"succeededObjectCount,omitempty,string"`// TotalBytesFound: Output only. Number of bytes found from source. This field// is only populated for jobs with a prefix list object configuration.TotalBytesFoundint64 `json:"totalBytesFound,omitempty,string"`// TotalObjectCount: Output only. Number of objects listed.TotalObjectCountint64 `json:"totalObjectCount,omitempty,string"`// ForceSendFields is a list of field names (e.g. "FailedObjectCount") 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. "FailedObjectCount") 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:"-"`}

func (Counters)MarshalJSON¶

func (sCounters) MarshalJSON() ([]byte,error)

type DeleteObject struct {// PermanentObjectDeletionEnabled: Required. Controls deletion behavior when// versioning is enabled for the object's bucket. If true both live and// noncurrent objects will be permanently deleted. Otherwise live objects in// versioned buckets will become noncurrent and objects that were already// noncurrent will be skipped. This setting doesn't have any impact on the Soft// Delete feature. All objects deleted by this service can be be restored for// the duration of the Soft Delete retention duration if enabled. If enabled// and the manifest doesn't specify an object's generation, a GetObjectMetadata// call (a Class B operation) will be made to determine the live object// generation.PermanentObjectDeletionEnabledbool `json:"permanentObjectDeletionEnabled,omitempty"`// ForceSendFields is a list of field names (e.g.// "PermanentObjectDeletionEnabled") 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. "PermanentObjectDeletionEnabled")// 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:"-"`}

func (DeleteObject)MarshalJSON¶

func (sDeleteObject) MarshalJSON() ([]byte,error)

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

type ErrorLogEntry struct {// ErrorDetails: Optional. Output only. At most 5 error log entries are// recorded for a given error code for a job.ErrorDetails []string `json:"errorDetails,omitempty"`// ObjectUri: Required. Output only. Object URL. e.g. gs://my_bucket/object.txtObjectUristring `json:"objectUri,omitempty"`// ForceSendFields is a list of field names (e.g. "ErrorDetails") 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. "ErrorDetails") 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:"-"`}

func (ErrorLogEntry)MarshalJSON¶

func (sErrorLogEntry) MarshalJSON() ([]byte,error)

type ErrorSummary struct {// ErrorCode: Required. The canonical error code.//// Possible values://   "OK" - Not an error; returned on success. HTTP Mapping: 200 OK//   "CANCELLED" - The operation was cancelled, typically by the caller. HTTP// Mapping: 499 Client Closed Request//   "UNKNOWN" - Unknown error. For example, this error may be returned when a// `Status` value received from another address space belongs to an error space// that is not known in this address space. Also errors raised by APIs that do// not return enough error information may be converted to this error. HTTP// Mapping: 500 Internal Server Error//   "INVALID_ARGUMENT" - The client specified an invalid argument. Note that// this differs from `FAILED_PRECONDITION`. `INVALID_ARGUMENT` indicates// arguments that are problematic regardless of the state of the system (e.g.,// a malformed file name). HTTP Mapping: 400 Bad Request//   "DEADLINE_EXCEEDED" - The deadline expired before the operation could// complete. For operations that change the state of the system, this error may// be returned even if the operation has completed successfully. For example, a// successful response from a server could have been delayed long enough for// the deadline to expire. HTTP Mapping: 504 Gateway Timeout//   "NOT_FOUND" - Some requested entity (e.g., file or directory) was not// found. Note to server developers: if a request is denied for an entire class// of users, such as gradual feature rollout or undocumented allowlist,// `NOT_FOUND` may be used. If a request is denied for some users within a// class of users, such as user-based access control, `PERMISSION_DENIED` must// be used. HTTP Mapping: 404 Not Found//   "ALREADY_EXISTS" - The entity that a client attempted to create (e.g.,// file or directory) already exists. HTTP Mapping: 409 Conflict//   "PERMISSION_DENIED" - The caller does not have permission to execute the// specified operation. `PERMISSION_DENIED` must not be used for rejections// caused by exhausting some resource (use `RESOURCE_EXHAUSTED` instead for// those errors). `PERMISSION_DENIED` must not be used if the caller can not be// identified (use `UNAUTHENTICATED` instead for those errors). This error code// does not imply the request is valid or the requested entity exists or// satisfies other pre-conditions. HTTP Mapping: 403 Forbidden//   "UNAUTHENTICATED" - The request does not have valid authentication// credentials for the operation. HTTP Mapping: 401 Unauthorized//   "RESOURCE_EXHAUSTED" - Some resource has been exhausted, perhaps a// per-user quota, or perhaps the entire file system is out of space. HTTP// Mapping: 429 Too Many Requests//   "FAILED_PRECONDITION" - The operation was rejected because the system is// not in a state required for the operation's execution. For example, the// directory to be deleted is non-empty, an rmdir operation is applied to a// non-directory, etc. Service implementors can use the following guidelines to// decide between `FAILED_PRECONDITION`, `ABORTED`, and `UNAVAILABLE`: (a) Use// `UNAVAILABLE` if the client can retry just the failing call. (b) Use// `ABORTED` if the client should retry at a higher level. For example, when a// client-specified test-and-set fails, indicating the client should restart a// read-modify-write sequence. (c) Use `FAILED_PRECONDITION` if the client// should not retry until the system state has been explicitly fixed. For// example, if an "rmdir" fails because the directory is non-empty,// `FAILED_PRECONDITION` should be returned since the client should not retry// unless the files are deleted from the directory. HTTP Mapping: 400 Bad// Request//   "ABORTED" - The operation was aborted, typically due to a concurrency// issue such as a sequencer check failure or transaction abort. See the// guidelines above for deciding between `FAILED_PRECONDITION`, `ABORTED`, and// `UNAVAILABLE`. HTTP Mapping: 409 Conflict//   "OUT_OF_RANGE" - The operation was attempted past the valid range. E.g.,// seeking or reading past end-of-file. Unlike `INVALID_ARGUMENT`, this error// indicates a problem that may be fixed if the system state changes. For// example, a 32-bit file system will generate `INVALID_ARGUMENT` if asked to// read at an offset that is not in the range [0,2^32-1], but it will generate// `OUT_OF_RANGE` if asked to read from an offset past the current file size.// There is a fair bit of overlap between `FAILED_PRECONDITION` and// `OUT_OF_RANGE`. We recommend using `OUT_OF_RANGE` (the more specific error)// when it applies so that callers who are iterating through a space can easily// look for an `OUT_OF_RANGE` error to detect when they are done. HTTP Mapping:// 400 Bad Request//   "UNIMPLEMENTED" - The operation is not implemented or is not// supported/enabled in this service. HTTP Mapping: 501 Not Implemented//   "INTERNAL" - Internal errors. This means that some invariants expected by// the underlying system have been broken. This error code is reserved for// serious errors. HTTP Mapping: 500 Internal Server Error//   "UNAVAILABLE" - The service is currently unavailable. This is most likely// a transient condition, which can be corrected by retrying with a backoff.// Note that it is not always safe to retry non-idempotent operations. See the// guidelines above for deciding between `FAILED_PRECONDITION`, `ABORTED`, and// `UNAVAILABLE`. HTTP Mapping: 503 Service Unavailable//   "DATA_LOSS" - Unrecoverable data loss or corruption. HTTP Mapping: 500// Internal Server ErrorErrorCodestring `json:"errorCode,omitempty"`// ErrorCount: Required. Number of errors encountered per `error_code`.ErrorCountint64 `json:"errorCount,omitempty,string"`// ErrorLogEntries: Required. Sample error logs.ErrorLogEntries []*ErrorLogEntry `json:"errorLogEntries,omitempty"`// ForceSendFields is a list of field names (e.g. "ErrorCode") 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. "ErrorCode") 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:"-"`}

func (ErrorSummary)MarshalJSON¶

func (sErrorSummary) MarshalJSON() ([]byte,error)

type Job struct {// BucketList: Specifies a list of buckets and their objects to be transformed.BucketList *BucketList `json:"bucketList,omitempty"`// CompleteTime: Output only. The time that the job was completed.CompleteTimestring `json:"completeTime,omitempty"`// Counters: Output only. Information about the progress of the job.Counters *Counters `json:"counters,omitempty"`// CreateTime: Output only. The time that the job was created.CreateTimestring `json:"createTime,omitempty"`// DeleteObject: Delete objects.DeleteObject *DeleteObject `json:"deleteObject,omitempty"`// Description: Optional. A description provided by the user for the job. Its// max length is 1024 bytes when Unicode-encoded.Descriptionstring `json:"description,omitempty"`// DryRun: Optional. If true, the job will run in dry run mode, returning the// total object count and, if the object configuration is a prefix list, the// bytes found from source. No transformations will be performed.DryRunbool `json:"dryRun,omitempty"`// ErrorSummaries: Output only. Summarizes errors encountered with sample error// log entries.ErrorSummaries []*ErrorSummary `json:"errorSummaries,omitempty"`// LoggingConfig: Optional. Logging configuration.LoggingConfig *LoggingConfig `json:"loggingConfig,omitempty"`// Name: Identifier. The resource name of the Job. job_id is unique within the// project, that is either set by the customer or defined by the service.// Format: projects/{project}/locations/global/jobs/{job_id} . For example:// "projects/123456/locations/global/jobs/job01".Namestring `json:"name,omitempty"`// PutMetadata: Updates object metadata. Allows updating fixed-key and custom// metadata and fixed-key metadata i.e. Cache-Control, Content-Disposition,// Content-Encoding, Content-Language, Content-Type, Custom-Time.PutMetadata *PutMetadata `json:"putMetadata,omitempty"`// PutObjectHold: Changes object hold status.PutObjectHold *PutObjectHold `json:"putObjectHold,omitempty"`// RewriteObject: Rewrite the object and updates metadata like KMS key.RewriteObject *RewriteObject `json:"rewriteObject,omitempty"`// ScheduleTime: Output only. The time that the job was scheduled.ScheduleTimestring `json:"scheduleTime,omitempty"`// State: Output only. State of the job.//// Possible values://   "STATE_UNSPECIFIED" - Default value. This value is unused.//   "RUNNING" - In progress.//   "SUCCEEDED" - Completed successfully.//   "CANCELED" - Cancelled by the user.//   "FAILED" - Terminated due to an unrecoverable failure.Statestring `json:"state,omitempty"`// ServerResponse contains the HTTP response code and headers from the server.googleapi.ServerResponse `json:"-"`// ForceSendFields is a list of field names (e.g. "BucketList") 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. "BucketList") 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:"-"`}

func (Job)MarshalJSON¶

func (sJob) MarshalJSON() ([]byte,error)

type ListJobsResponse struct {// Jobs: A list of storage batch jobs.Jobs []*Job `json:"jobs,omitempty"`// NextPageToken: A token identifying a page of results.NextPageTokenstring `json:"nextPageToken,omitempty"`// Unreachable: Locations that could not be reached.Unreachable []string `json:"unreachable,omitempty"`// ServerResponse contains the HTTP response code and headers from the server.googleapi.ServerResponse `json:"-"`// ForceSendFields is a list of field names (e.g. "Jobs") 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. "Jobs") 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:"-"`}

func (ListJobsResponse)MarshalJSON¶

func (sListJobsResponse) MarshalJSON() ([]byte,error)

type ListLocationsResponse struct {// Locations: A list of locations that matches the specified filter in the// request.Locations []*Location `json:"locations,omitempty"`// NextPageToken: The standard List next-page token.NextPageTokenstring `json:"nextPageToken,omitempty"`// ServerResponse contains the HTTP response code and headers from the server.googleapi.ServerResponse `json:"-"`// ForceSendFields is a list of field names (e.g. "Locations") 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. "Locations") 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:"-"`}

func (ListLocationsResponse)MarshalJSON¶

func (sListLocationsResponse) MarshalJSON() ([]byte,error)

type ListOperationsResponse struct {// NextPageToken: The standard List next-page token.NextPageTokenstring `json:"nextPageToken,omitempty"`// Operations: A list of operations that matches the specified filter in the// request.Operations []*Operation `json:"operations,omitempty"`// Unreachable: Unordered list. Unreachable resources. Populated when the// request sets `ListOperationsRequest.return_partial_success` and reads across// collections e.g. when attempting to list all resources across all supported// locations.Unreachable []string `json:"unreachable,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:"-"`}

func (ListOperationsResponse)MarshalJSON¶

func (sListOperationsResponse) MarshalJSON() ([]byte,error)

type Location struct {// DisplayName: The friendly name for this location, typically a nearby city// name. For example, "Tokyo".DisplayNamestring `json:"displayName,omitempty"`// Labels: Cross-service attributes for the location. For example// {"cloud.googleapis.com/region": "us-east1"}Labels map[string]string `json:"labels,omitempty"`// LocationId: The canonical id for this location. For example: "us-east1".LocationIdstring `json:"locationId,omitempty"`// Metadata: Service-specific metadata. For example the available capacity at// the given location.Metadatagoogleapi.RawMessage `json:"metadata,omitempty"`// Name: Resource name for the location, which may vary between// implementations. For example:// "projects/example-project/locations/us-east1"Namestring `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. "DisplayName") 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. "DisplayName") 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:"-"`}

func (Location)MarshalJSON¶

func (sLocation) MarshalJSON() ([]byte,error)

type LoggingConfig struct {// LogActionStates: Required. States in which Action are logged.If empty, no// logs are generated.//// Possible values://   "LOGGABLE_ACTION_STATE_UNSPECIFIED" - Illegal value, to avoid allowing a// default.//   "SUCCEEDED" - `LoggableAction` completed successfully. `SUCCEEDED` actions// are logged as INFO.//   "FAILED" - `LoggableAction` terminated in an error state. `FAILED` actions// are logged as ERROR.LogActionStates []string `json:"logActionStates,omitempty"`// LogActions: Required. Specifies the actions to be logged.//// Possible values://   "LOGGABLE_ACTION_UNSPECIFIED" - Illegal value, to avoid allowing a// default.//   "TRANSFORM" - The corresponding transform action in this job.LogActions []string `json:"logActions,omitempty"`// ForceSendFields is a list of field names (e.g. "LogActionStates") 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. "LogActionStates") 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:"-"`}

func (LoggingConfig)MarshalJSON¶

func (sLoggingConfig) MarshalJSON() ([]byte,error)

type Manifest struct {// ManifestLocation: Required. `manifest_location` must contain the manifest// source file that is a CSV file in a Google Cloud Storage bucket. Each row in// the file must include the object details i.e. BucketId and Name. Generation// may optionally be specified. When it is not specified the live object is// acted upon. `manifest_location` should either be 1) An absolute path to the// object in the format of `gs://bucket_name/path/file_name.csv`. 2) An// absolute path with a single wildcard character in the file name, for example// `gs://bucket_name/path/file_name*.csv`. If manifest location is specified// with a wildcard, objects in all manifest files matching the pattern will be// acted upon.ManifestLocationstring `json:"manifestLocation,omitempty"`// ForceSendFields is a list of field names (e.g. "ManifestLocation") 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. "ManifestLocation") 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:"-"`}

func (Manifest)MarshalJSON¶

func (sManifest) MarshalJSON() ([]byte,error)

type ObjectRetention struct {// RetainUntilTime: Required. The time when the object will be retained until.// UNSET will clear the retention. Must be specified inRFC 3339 format e.g.// YYYY-MM-DD'T'HH:MM:SS.SS'Z' or YYYY-MM-DD'T'HH:MM:SS'Z'.RetainUntilTimestring `json:"retainUntilTime,omitempty"`// RetentionMode: Required. The retention mode of the object.//// Possible values://   "RETENTION_MODE_UNSPECIFIED" - If set and retain_until_time is empty,// clears the retention.//   "LOCKED" - Sets the retention mode to locked.//   "UNLOCKED" - Sets the retention mode to unlocked.RetentionModestring `json:"retentionMode,omitempty"`// ForceSendFields is a list of field names (e.g. "RetainUntilTime") 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. "RetainUntilTime") 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:"-"`}

func (ObjectRetention)MarshalJSON¶added inv0.253.0

func (sObjectRetention) MarshalJSON() ([]byte,error)

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.Donebool `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.Metadatagoogleapi.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}`.Namestring `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`.Responsegoogleapi.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:"-"`}

func (Operation)MarshalJSON¶

func (sOperation) MarshalJSON() ([]byte,error)

type OperationMetadata struct {// ApiVersion: Output only. API version used to start the operation.ApiVersionstring `json:"apiVersion,omitempty"`// CreateTime: Output only. The time the operation was created.CreateTimestring `json:"createTime,omitempty"`// EndTime: Output only. The time the operation finished running.EndTimestring `json:"endTime,omitempty"`// Job: Output only. The Job associated with the operation.Job *Job `json:"job,omitempty"`// Operation: Output only. The unique operation resource name. Format:// projects/{project}/locations/global/operations/{operation}.Operationstring `json:"operation,omitempty"`// RequestedCancellation: Output only. Identifies whether the user has// requested cancellation of the operation. Operations that have been cancelled// successfully have google.longrunning.Operation.error value with a// google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.RequestedCancellationbool `json:"requestedCancellation,omitempty"`// ForceSendFields is a list of field names (e.g. "ApiVersion") 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. "ApiVersion") 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:"-"`}

func (OperationMetadata)MarshalJSON¶

func (sOperationMetadata) MarshalJSON() ([]byte,error)

type PrefixList struct {// IncludedObjectPrefixes: Optional. Include prefixes of the objects to be// transformed. * Supports full object name * Supports prefix of the object// name * Wildcards are not supported * Supports empty string for all objects// in a bucket.IncludedObjectPrefixes []string `json:"includedObjectPrefixes,omitempty"`// ForceSendFields is a list of field names (e.g. "IncludedObjectPrefixes") 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. "IncludedObjectPrefixes") 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:"-"`}

func (PrefixList)MarshalJSON¶

func (sPrefixList) MarshalJSON() ([]byte,error)

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

func (*ProjectsLocationsGetCall)Context¶

func (c *ProjectsLocationsGetCall) Context(ctxcontext.Context) *ProjectsLocationsGetCall

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

func (*ProjectsLocationsGetCall)Do¶

func (c *ProjectsLocationsGetCall) Do(opts ...googleapi.CallOption) (*Location,error)

Do executes the "storagebatchoperations.projects.locations.get" call.Any non-2xx status code is an error. Response headers are in either*Location.ServerResponse.Header or (if a response was returned at all) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsGetCall)Fields¶

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

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsLocationsGetCall)Header¶

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

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

func (*ProjectsLocationsGetCall)IfNoneMatch¶

func (c *ProjectsLocationsGetCall) IfNoneMatch(entityTagstring) *ProjectsLocationsGetCall

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

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

func (*ProjectsLocationsJobsCancelCall)Context¶

func (c *ProjectsLocationsJobsCancelCall) Context(ctxcontext.Context) *ProjectsLocationsJobsCancelCall

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

func (*ProjectsLocationsJobsCancelCall)Do¶

func (c *ProjectsLocationsJobsCancelCall) Do(opts ...googleapi.CallOption) (*CancelJobResponse,error)

Do executes the "storagebatchoperations.projects.locations.jobs.cancel" call.Any non-2xx status code is an error. Response headers are in either*CancelJobResponse.ServerResponse.Header or (if a response was returned atall) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified tocheck whether the returned error was because http.StatusNotModified wasreturned.

func (*ProjectsLocationsJobsCancelCall)Fields¶

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

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsLocationsJobsCancelCall)Header¶

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

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

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

func (*ProjectsLocationsJobsCreateCall)Context¶

func (c *ProjectsLocationsJobsCreateCall) Context(ctxcontext.Context) *ProjectsLocationsJobsCreateCall

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

func (*ProjectsLocationsJobsCreateCall)Do¶

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

Do executes the "storagebatchoperations.projects.locations.jobs.create" 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) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsJobsCreateCall)Fields¶

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

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsLocationsJobsCreateCall)Header¶

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

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

func (*ProjectsLocationsJobsCreateCall)JobId¶

func (c *ProjectsLocationsJobsCreateCall) JobId(jobIdstring) *ProjectsLocationsJobsCreateCall

JobId sets the optional parameter "jobId": Required. The optional `job_id`for this Job . If not specified, an id is generated. `job_id` should be nomore than 128 characters and must include only characters available in DNSnames, as defined by RFC-1123.

func (*ProjectsLocationsJobsCreateCall)RequestId¶

func (c *ProjectsLocationsJobsCreateCall) RequestId(requestIdstring) *ProjectsLocationsJobsCreateCall

RequestId sets the optional parameter "requestId": An optional request ID toidentify requests. Specify a unique request ID in case you need to retryyour request. Requests with same `request_id` will be ignored for at least60 minutes since the first request. The request ID must be a valid UUID withthe exception that zero UUID is not supported(00000000-0000-0000-0000-000000000000).

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

func (*ProjectsLocationsJobsDeleteCall)Context¶

func (c *ProjectsLocationsJobsDeleteCall) Context(ctxcontext.Context) *ProjectsLocationsJobsDeleteCall

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

func (*ProjectsLocationsJobsDeleteCall)Do¶

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

Do executes the "storagebatchoperations.projects.locations.jobs.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) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsJobsDeleteCall)Fields¶

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

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsLocationsJobsDeleteCall)Header¶

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

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

func (*ProjectsLocationsJobsDeleteCall)RequestId¶

func (c *ProjectsLocationsJobsDeleteCall) RequestId(requestIdstring) *ProjectsLocationsJobsDeleteCall

RequestId sets the optional parameter "requestId": An optional request ID toidentify requests. Specify a unique request ID in case you need to retryyour request. Requests with same `request_id` will be ignored for at least60 minutes since the first request. The request ID must be a valid UUID withthe exception that zero UUID is not supported(00000000-0000-0000-0000-000000000000).

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

func (*ProjectsLocationsJobsGetCall)Context¶

func (c *ProjectsLocationsJobsGetCall) Context(ctxcontext.Context) *ProjectsLocationsJobsGetCall

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

func (*ProjectsLocationsJobsGetCall)Do¶

func (c *ProjectsLocationsJobsGetCall) Do(opts ...googleapi.CallOption) (*Job,error)

Do executes the "storagebatchoperations.projects.locations.jobs.get" call.Any non-2xx status code is an error. Response headers are in either*Job.ServerResponse.Header or (if a response was returned at all) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsJobsGetCall)Fields¶

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

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsLocationsJobsGetCall)Header¶

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

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

func (*ProjectsLocationsJobsGetCall)IfNoneMatch¶

func (c *ProjectsLocationsJobsGetCall) IfNoneMatch(entityTagstring) *ProjectsLocationsJobsGetCall

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

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

func (*ProjectsLocationsJobsListCall)Context¶

func (c *ProjectsLocationsJobsListCall) Context(ctxcontext.Context) *ProjectsLocationsJobsListCall

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

func (*ProjectsLocationsJobsListCall)Do¶

func (c *ProjectsLocationsJobsListCall) Do(opts ...googleapi.CallOption) (*ListJobsResponse,error)

Do executes the "storagebatchoperations.projects.locations.jobs.list" call.Any non-2xx status code is an error. Response headers are in either*ListJobsResponse.ServerResponse.Header or (if a response was returned atall) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified tocheck whether the returned error was because http.StatusNotModified wasreturned.

func (*ProjectsLocationsJobsListCall)Fields¶

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

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsLocationsJobsListCall)Filter¶

func (c *ProjectsLocationsJobsListCall) Filter(filterstring) *ProjectsLocationsJobsListCall

Filter sets the optional parameter "filter": Filters results as defined byhttps://google.aip.dev/160.

func (*ProjectsLocationsJobsListCall)Header¶

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

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

func (*ProjectsLocationsJobsListCall)IfNoneMatch¶

func (c *ProjectsLocationsJobsListCall) IfNoneMatch(entityTagstring) *ProjectsLocationsJobsListCall

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

func (*ProjectsLocationsJobsListCall)OrderBy¶

func (c *ProjectsLocationsJobsListCall) OrderBy(orderBystring) *ProjectsLocationsJobsListCall

OrderBy sets the optional parameter "orderBy": Field to sort by. Supportedfields are name, create_time.

func (*ProjectsLocationsJobsListCall)PageSize¶

func (c *ProjectsLocationsJobsListCall) PageSize(pageSizeint64) *ProjectsLocationsJobsListCall

PageSize sets the optional parameter "pageSize": The list page size. defaultpage size is 100.

func (*ProjectsLocationsJobsListCall)PageToken¶

func (c *ProjectsLocationsJobsListCall) PageToken(pageTokenstring) *ProjectsLocationsJobsListCall

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

func (*ProjectsLocationsJobsListCall)Pages¶

func (c *ProjectsLocationsJobsListCall) Pages(ctxcontext.Context, f func(*ListJobsResponse)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 ProjectsLocationsJobsService struct {// contains filtered or unexported fields}

funcNewProjectsLocationsJobsService¶

func NewProjectsLocationsJobsService(s *Service) *ProjectsLocationsJobsService

func (*ProjectsLocationsJobsService)Cancel¶

func (r *ProjectsLocationsJobsService) Cancel(namestring, canceljobrequest *CancelJobRequest) *ProjectsLocationsJobsCancelCall

Cancel: Cancels a batch job.

• name: The `name` of the job to cancel. Format:projects/{project_id}/locations/global/jobs/{job_id}.

func (*ProjectsLocationsJobsService)Create¶

func (r *ProjectsLocationsJobsService) Create(parentstring, job *Job) *ProjectsLocationsJobsCreateCall

Create: Creates a batch job.

- parent: Value for parent.

func (*ProjectsLocationsJobsService)Delete¶

func (r *ProjectsLocationsJobsService) Delete(namestring) *ProjectsLocationsJobsDeleteCall

Delete: Deletes a batch job.

• name: The `name` of the job to delete. Format:projects/{project_id}/locations/global/jobs/{job_id} .

func (*ProjectsLocationsJobsService)Get¶

func (r *ProjectsLocationsJobsService) Get(namestring) *ProjectsLocationsJobsGetCall

Get: Gets a batch job.

• name: `name` of the job to retrieve. Format:projects/{project_id}/locations/global/jobs/{job_id} .

func (*ProjectsLocationsJobsService)List¶

func (r *ProjectsLocationsJobsService) List(parentstring) *ProjectsLocationsJobsListCall

List: Lists Jobs in a given project.

- parent: Format: projects/{project_id}/locations/global.

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

func (*ProjectsLocationsListCall)Context¶

func (c *ProjectsLocationsListCall) Context(ctxcontext.Context) *ProjectsLocationsListCall

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

func (*ProjectsLocationsListCall)Do¶

func (c *ProjectsLocationsListCall) Do(opts ...googleapi.CallOption) (*ListLocationsResponse,error)

Do executes the "storagebatchoperations.projects.locations.list" call.Any non-2xx status code is an error. Response headers are in either*ListLocationsResponse.ServerResponse.Header or (if a response was returnedat all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified tocheck whether the returned error was because http.StatusNotModified wasreturned.

func (*ProjectsLocationsListCall)ExtraLocationTypes¶

func (c *ProjectsLocationsListCall) ExtraLocationTypes(extraLocationTypes ...string) *ProjectsLocationsListCall

ExtraLocationTypes sets the optional parameter "extraLocationTypes": Do notuse this field. It is unsupported and is ignored unless explicitlydocumented otherwise. This is primarily for internal usage.

func (*ProjectsLocationsListCall)Fields¶

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

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsLocationsListCall)Filter¶

func (c *ProjectsLocationsListCall) Filter(filterstring) *ProjectsLocationsListCall

Filter sets the optional parameter "filter": A filter to narrow down resultsto a preferred subset. The filtering language accepts strings like"displayName=tokyo", and is documented in more detail in AIP-160(https://google.aip.dev/160).

func (*ProjectsLocationsListCall)Header¶

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

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

func (*ProjectsLocationsListCall)IfNoneMatch¶

func (c *ProjectsLocationsListCall) IfNoneMatch(entityTagstring) *ProjectsLocationsListCall

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

func (*ProjectsLocationsListCall)PageSize¶

func (c *ProjectsLocationsListCall) PageSize(pageSizeint64) *ProjectsLocationsListCall

PageSize sets the optional parameter "pageSize": The maximum number ofresults to return. If not set, the service selects a default.

func (*ProjectsLocationsListCall)PageToken¶

func (c *ProjectsLocationsListCall) PageToken(pageTokenstring) *ProjectsLocationsListCall

PageToken sets the optional parameter "pageToken": A page token receivedfrom the `next_page_token` field in the response. Send that page token toreceive the subsequent page.

func (*ProjectsLocationsListCall)Pages¶

func (c *ProjectsLocationsListCall) Pages(ctxcontext.Context, f func(*ListLocationsResponse)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 ProjectsLocationsOperationsCancelCall struct {// contains filtered or unexported fields}

func (*ProjectsLocationsOperationsCancelCall)Context¶

func (c *ProjectsLocationsOperationsCancelCall) Context(ctxcontext.Context) *ProjectsLocationsOperationsCancelCall

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

func (*ProjectsLocationsOperationsCancelCall)Do¶

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

Do executes the "storagebatchoperations.projects.locations.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) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsOperationsCancelCall)Fields¶

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

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsLocationsOperationsCancelCall)Header¶

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

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

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

func (*ProjectsLocationsOperationsDeleteCall)Context¶

func (c *ProjectsLocationsOperationsDeleteCall) Context(ctxcontext.Context) *ProjectsLocationsOperationsDeleteCall

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

func (*ProjectsLocationsOperationsDeleteCall)Do¶

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

Do executes the "storagebatchoperations.projects.locations.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) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsOperationsDeleteCall)Fields¶

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

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsLocationsOperationsDeleteCall)Header¶

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

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

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

func (*ProjectsLocationsOperationsGetCall)Context¶

func (c *ProjectsLocationsOperationsGetCall) Context(ctxcontext.Context) *ProjectsLocationsOperationsGetCall

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

func (*ProjectsLocationsOperationsGetCall)Do¶

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

Do executes the "storagebatchoperations.projects.locations.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) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsOperationsGetCall)Fields¶

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

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsLocationsOperationsGetCall)Header¶

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

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

func (*ProjectsLocationsOperationsGetCall)IfNoneMatch¶

func (c *ProjectsLocationsOperationsGetCall) IfNoneMatch(entityTagstring) *ProjectsLocationsOperationsGetCall

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

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

func (*ProjectsLocationsOperationsListCall)Context¶

func (c *ProjectsLocationsOperationsListCall) Context(ctxcontext.Context) *ProjectsLocationsOperationsListCall

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

func (*ProjectsLocationsOperationsListCall)Do¶

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

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

func (*ProjectsLocationsOperationsListCall)Fields¶

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

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsLocationsOperationsListCall)Filter¶

func (c *ProjectsLocationsOperationsListCall) Filter(filterstring) *ProjectsLocationsOperationsListCall

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

func (*ProjectsLocationsOperationsListCall)Header¶

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

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

func (*ProjectsLocationsOperationsListCall)IfNoneMatch¶

func (c *ProjectsLocationsOperationsListCall) IfNoneMatch(entityTagstring) *ProjectsLocationsOperationsListCall

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

func (*ProjectsLocationsOperationsListCall)PageSize¶

func (c *ProjectsLocationsOperationsListCall) PageSize(pageSizeint64) *ProjectsLocationsOperationsListCall

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

func (*ProjectsLocationsOperationsListCall)PageToken¶

func (c *ProjectsLocationsOperationsListCall) PageToken(pageTokenstring) *ProjectsLocationsOperationsListCall

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

func (*ProjectsLocationsOperationsListCall)Pages¶

func (c *ProjectsLocationsOperationsListCall) Pages(ctxcontext.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.

func (*ProjectsLocationsOperationsListCall)ReturnPartialSuccess¶added inv0.252.0

func (c *ProjectsLocationsOperationsListCall) ReturnPartialSuccess(returnPartialSuccessbool) *ProjectsLocationsOperationsListCall

ReturnPartialSuccess sets the optional parameter "returnPartialSuccess":When set to `true`, operations that are reachable are returned as normal,and those that are unreachable are returned in the[ListOperationsResponse.unreachable] field. This can only be `true` whenreading across collections e.g. when `parent` is set to"projects/example/locations/-". This field is not by default supported andwill result in an `UNIMPLEMENTED` error if set unless explicitly documentedotherwise in service or product specific documentation.

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

funcNewProjectsLocationsOperationsService¶

func NewProjectsLocationsOperationsService(s *Service) *ProjectsLocationsOperationsService

func (*ProjectsLocationsOperationsService)Cancel¶

func (r *ProjectsLocationsOperationsService) Cancel(namestring, canceloperationrequest *CancelOperationRequest) *ProjectsLocationsOperationsCancelCall

Cancel: Starts asynchronous cancellation on a long-running operation. Theserver makes a best effort to cancel the operation, but success is notguaranteed. If the server doesn't support this method, it returns`google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation orother methods to check whether the cancellation succeeded or whether theoperation completed despite cancellation. On successful cancellation, theoperation is not deleted; instead, it becomes an operation with anOperation.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 (*ProjectsLocationsOperationsService)Delete¶

func (r *ProjectsLocationsOperationsService) Delete(namestring) *ProjectsLocationsOperationsDeleteCall

Delete: Deletes a long-running operation. This method indicates that theclient is no longer interested in the operation result. It does not cancelthe 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 (*ProjectsLocationsOperationsService)Get¶

func (r *ProjectsLocationsOperationsService) Get(namestring) *ProjectsLocationsOperationsGetCall

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

- name: The name of the operation resource.

func (*ProjectsLocationsOperationsService)List¶

func (r *ProjectsLocationsOperationsService) List(namestring) *ProjectsLocationsOperationsListCall

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

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

type ProjectsLocationsService struct {Jobs *ProjectsLocationsJobsServiceOperations *ProjectsLocationsOperationsService// contains filtered or unexported fields}

funcNewProjectsLocationsService¶

func NewProjectsLocationsService(s *Service) *ProjectsLocationsService

func (*ProjectsLocationsService)Get¶

func (r *ProjectsLocationsService) Get(namestring) *ProjectsLocationsGetCall

Get: Gets information about a location.

- name: Resource name for the location.

func (*ProjectsLocationsService)List¶

func (r *ProjectsLocationsService) List(namestring) *ProjectsLocationsListCall

List: Lists information about the supported locations for this service.

- name: The resource that owns the locations collection, if applicable.

type ProjectsService struct {Locations *ProjectsLocationsService// contains filtered or unexported fields}

funcNewProjectsService¶

func NewProjectsService(s *Service) *ProjectsService

type PutMetadata struct {// CacheControl: Optional. Updates objects Cache-Control fixed metadata. Unset// values will be ignored. Set empty values to clear the metadata.// Additionally, the value for Custom-Time cannot decrease. Refer to// documentation in//https://cloud.google.com/storage/docs/metadata#caching_data.CacheControlstring `json:"cacheControl,omitempty"`// ContentDisposition: Optional. Updates objects Content-Disposition fixed// metadata. Unset values will be ignored. Set empty values to clear the// metadata. Refer//https://cloud.google.com/storage/docs/metadata#content-disposition for// additional documentation.ContentDispositionstring `json:"contentDisposition,omitempty"`// ContentEncoding: Optional. Updates objects Content-Encoding fixed metadata.// Unset values will be ignored. Set empty values to clear the metadata. Refer// to documentation in//https://cloud.google.com/storage/docs/metadata#content-encoding.ContentEncodingstring `json:"contentEncoding,omitempty"`// ContentLanguage: Optional. Updates objects Content-Language fixed metadata.// Refer to ISO 639-1 language codes for typical values of this metadata. Max// length 100 characters. Unset values will be ignored. Set empty values to// clear the metadata. Refer to documentation in//https://cloud.google.com/storage/docs/metadata#content-language.ContentLanguagestring `json:"contentLanguage,omitempty"`// ContentType: Optional. Updates objects Content-Type fixed metadata. Unset// values will be ignored. Set empty values to clear the metadata. Refer to// documentation inhttps://cloud.google.com/storage/docs/metadata#content-typeContentTypestring `json:"contentType,omitempty"`// CustomMetadata: Optional. Updates objects custom metadata. Adds or sets// individual custom metadata key value pairs on objects. Keys that are set// with empty custom metadata values will have its value cleared. Existing// custom metadata not specified with this flag is not changed. Refer to// documentation in//https://cloud.google.com/storage/docs/metadata#custom-metadataCustomMetadata map[string]string `json:"customMetadata,omitempty"`// CustomTime: Optional. Updates objects Custom-Time fixed metadata. Unset// values will be ignored. Set empty values to clear the metadata. Refer to// documentation inhttps://cloud.google.com/storage/docs/metadata#custom-time.CustomTimestring `json:"customTime,omitempty"`// ObjectRetention: Optional. Updates objects retention lock configuration.// Unset values will be ignored. Set empty values to clear the retention for// the object with existing `Unlocked` retention mode. Object with existing// `Locked` retention mode cannot be cleared or reduce retain_until_time. Refer// to documentation inhttps://cloud.google.com/storage/docs/object-lockObjectRetention *ObjectRetention `json:"objectRetention,omitempty"`// ForceSendFields is a list of field names (e.g. "CacheControl") 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. "CacheControl") 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:"-"`}

func (PutMetadata)MarshalJSON¶

func (sPutMetadata) MarshalJSON() ([]byte,error)

type PutObjectHold struct {// EventBasedHold: Required. Updates object event based holds state. When// object event based hold is set, object cannot be deleted or replaced. Resets// object's time in the bucket for the purposes of the retention period.//// Possible values://   "HOLD_STATUS_UNSPECIFIED" - Default value, Object hold status will not be// changed.//   "SET" - Places the hold.//   "UNSET" - Releases the hold.EventBasedHoldstring `json:"eventBasedHold,omitempty"`// TemporaryHold: Required. Updates object temporary holds state. When object// temporary hold is set, object cannot be deleted or replaced.//// Possible values://   "HOLD_STATUS_UNSPECIFIED" - Default value, Object hold status will not be// changed.//   "SET" - Places the hold.//   "UNSET" - Releases the hold.TemporaryHoldstring `json:"temporaryHold,omitempty"`// ForceSendFields is a list of field names (e.g. "EventBasedHold") 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. "EventBasedHold") 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:"-"`}

func (PutObjectHold)MarshalJSON¶

func (sPutObjectHold) MarshalJSON() ([]byte,error)

type RewriteObject struct {// KmsKey: Required. Resource name of the Cloud KMS key that will be used to// encrypt the object. The Cloud KMS key must be located in same location as// the object. Refer to//https://cloud.google.com/storage/docs/encryption/using-customer-managed-keys#add-object-key// for additional documentation. Format:// projects/{project}/locations/{location}/keyRings/{keyring}/cryptoKeys/{key}// For example:// "projects/123456/locations/us-central1/keyRings/my-keyring/cryptoKeys/my-key"// . The object will be rewritten and set with the specified KMS key.KmsKeystring `json:"kmsKey,omitempty"`// ForceSendFields is a list of field names (e.g. "KmsKey") 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. "KmsKey") 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:"-"`}

func (RewriteObject)MarshalJSON¶

func (sRewriteObject) MarshalJSON() ([]byte,error)

type Service struct {BasePathstring// API endpoint base URLUserAgentstring// optional additional User-Agent fragmentProjects *ProjectsService// contains filtered or unexported fields}

funcNewService¶

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

NewService creates a new Service.

type Status struct {// Code: The status code, which should be an enum value of google.rpc.Code.Codeint64 `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.Messagestring `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:"-"`}

func (Status)MarshalJSON¶

func (sStatus) MarshalJSON() ([]byte,error)