Movatterモバイル変換


[0]ホーム

URL:


storage

package
v0.257.0Latest Latest
Warning

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

Go to latest
Published: Dec 2, 2025 License:BSD-3-ClauseImports:19Imported by:1,117

Details

Repository

github.com/googleapis/google-api-go-client

Links

Documentation

Overview

Package storage provides access to the Cloud Storage JSON API.

This package is DEPRECATED. Use package cloud.google.com/go/storage instead.

For product documentation, see:https://developers.google.com/storage/docs/json_api/

Library status

These client libraries are officially supported by Google. However, thislibrary is considered complete and is in maintenance mode. This meansthat we will address critical bugs and security issues but will not addany new features.

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

Creating a client

Usage example:

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

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

Other authentication options

By default, all available scopes (see "Constants") are used to authenticate.To restrict scopes, usegoogle.golang.org/api/option.WithScopes:

storageService, err := storage.NewService(ctx, option.WithScopes(storage.DevstorageReadWriteScope))

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

storageService, err := storage.NewService(ctx, option.WithAPIKey("AIza..."))

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

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

Seegoogle.golang.org/api/option.ClientOption for details on options.

Index

Constants

View Source
const (// View and manage your data across Google Cloud Platform servicesCloudPlatformScope = "https://www.googleapis.com/auth/cloud-platform"// View your data across Google Cloud Platform servicesCloudPlatformReadOnlyScope = "https://www.googleapis.com/auth/cloud-platform.read-only"// Manage your data and permissions in Google Cloud StorageDevstorageFullControlScope = "https://www.googleapis.com/auth/devstorage.full_control"// View your data in Google Cloud StorageDevstorageReadOnlyScope = "https://www.googleapis.com/auth/devstorage.read_only"// Manage your data in Google Cloud StorageDevstorageReadWriteScope = "https://www.googleapis.com/auth/devstorage.read_write")

OAuth2 scopes used by this API.

Variables

This section is empty.

Functions

This section is empty.

Types

typeAdvanceRelocateBucketOperationRequestadded inv0.201.0

type AdvanceRelocateBucketOperationRequest struct {// ExpireTime: Specifies the time when the relocation will revert to the sync// stage if the relocation hasn't succeeded.ExpireTimestring `json:"expireTime,omitempty"`// Ttl: Specifies the duration after which the relocation will revert to the// sync stage if the relocation hasn't succeeded. Optional, if not supplied, a// default value of 12h will be used.Ttlstring `json:"ttl,omitempty"`// ForceSendFields is a list of field names (e.g. "ExpireTime") 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. "ExpireTime") 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:"-"`}

AdvanceRelocateBucketOperationRequest: An AdvanceRelocateBucketOperationrequest.

func (AdvanceRelocateBucketOperationRequest)MarshalJSONadded inv0.201.0

typeAnywhereCacheadded inv0.150.0

type AnywhereCache struct {// AdmissionPolicy: The cache-level entry admission policy.AdmissionPolicystring `json:"admissionPolicy,omitempty"`// AnywhereCacheId: The ID of the Anywhere cache instance.AnywhereCacheIdstring `json:"anywhereCacheId,omitempty"`// Bucket: The name of the bucket containing this cache instance.Bucketstring `json:"bucket,omitempty"`// CreateTime: The creation time of the cache instance inRFC 3339 format.CreateTimestring `json:"createTime,omitempty"`// Id: The ID of the resource, including the project number, bucket name and// anywhere cache ID.Idstring `json:"id,omitempty"`// Kind: The kind of item this is. For Anywhere Cache, this is always// storage#anywhereCache.Kindstring `json:"kind,omitempty"`// PendingUpdate: True if the cache instance has an active Update long-running// operation.PendingUpdatebool `json:"pendingUpdate,omitempty"`// SelfLink: The link to this cache instance.SelfLinkstring `json:"selfLink,omitempty"`// State: The current state of the cache instance.Statestring `json:"state,omitempty"`// Ttl: The TTL of all cache entries in whole seconds. e.g., "7200s".Ttlstring `json:"ttl,omitempty"`// UpdateTime: The modification time of the cache instance metadata inRFC 3339// format.UpdateTimestring `json:"updateTime,omitempty"`// Zone: The zone in which the cache instance is running. For example,// us-central1-a.Zonestring `json:"zone,omitempty"`// ServerResponse contains the HTTP response code and headers from the server.googleapi.ServerResponse `json:"-"`// ForceSendFields is a list of field names (e.g. "AdmissionPolicy") 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. "AdmissionPolicy") 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:"-"`}

AnywhereCache: An Anywhere Cache instance.

func (AnywhereCache)MarshalJSONadded inv0.150.0

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

typeAnywhereCachesadded inv0.150.0

type AnywhereCaches struct {// Items: The list of items.Items []*AnywhereCache `json:"items,omitempty"`// Kind: The kind of item this is. For lists of Anywhere Caches, this is always// storage#anywhereCaches.Kindstring `json:"kind,omitempty"`// NextPageToken: The continuation token, used to page through large result// sets. Provide this value in a subsequent request to return the next page of// results.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. "Items") 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. "Items") 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:"-"`}

AnywhereCaches: A list of Anywhere Caches.

func (AnywhereCaches)MarshalJSONadded inv0.150.0

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

typeAnywhereCachesDisableCalladded inv0.156.0

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

func (*AnywhereCachesDisableCall)Contextadded inv0.156.0

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

func (*AnywhereCachesDisableCall)Doadded inv0.156.0

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

func (*AnywhereCachesDisableCall)Fieldsadded inv0.156.0

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

func (*AnywhereCachesDisableCall)Headeradded inv0.156.0

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

typeAnywhereCachesGetCalladded inv0.156.0

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

func (*AnywhereCachesGetCall)Contextadded inv0.156.0

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

func (*AnywhereCachesGetCall)Doadded inv0.156.0

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

func (*AnywhereCachesGetCall)Fieldsadded inv0.156.0

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

func (*AnywhereCachesGetCall)Headeradded inv0.156.0

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

func (*AnywhereCachesGetCall)IfNoneMatchadded inv0.156.0

func (c *AnywhereCachesGetCall) IfNoneMatch(entityTagstring) *AnywhereCachesGetCall

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.

typeAnywhereCachesInsertCalladded inv0.156.0

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

func (*AnywhereCachesInsertCall)Contextadded inv0.156.0

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

func (*AnywhereCachesInsertCall)Doadded inv0.156.0

Do executes the "storage.anywhereCaches.insert" call.Any non-2xx status code is an error. Response headers are in either*GoogleLongrunningOperation.ServerResponse.Header or (if a response wasreturned at all) in error.(*googleapi.Error).Header. Usegoogleapi.IsNotModified to check whether the returned error was becausehttp.StatusNotModified was returned.

func (*AnywhereCachesInsertCall)Fieldsadded inv0.156.0

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

func (*AnywhereCachesInsertCall)Headeradded inv0.156.0

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

typeAnywhereCachesListCalladded inv0.156.0

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

func (*AnywhereCachesListCall)Contextadded inv0.156.0

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

func (*AnywhereCachesListCall)Doadded inv0.156.0

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

func (*AnywhereCachesListCall)Fieldsadded inv0.156.0

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

func (*AnywhereCachesListCall)Headeradded inv0.156.0

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

func (*AnywhereCachesListCall)IfNoneMatchadded inv0.156.0

func (c *AnywhereCachesListCall) IfNoneMatch(entityTagstring) *AnywhereCachesListCall

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 (*AnywhereCachesListCall)PageSizeadded inv0.156.0

PageSize sets the optional parameter "pageSize": Maximum number of items toreturn in a single page of responses. Maximum 1000.

func (*AnywhereCachesListCall)PageTokenadded inv0.156.0

PageToken sets the optional parameter "pageToken": A previously-returnedpage token representing part of the larger set of results to view.

func (*AnywhereCachesListCall)Pagesadded inv0.156.0

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.

typeAnywhereCachesPauseCalladded inv0.156.0

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

func (*AnywhereCachesPauseCall)Contextadded inv0.156.0

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

func (*AnywhereCachesPauseCall)Doadded inv0.156.0

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

func (*AnywhereCachesPauseCall)Fieldsadded inv0.156.0

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

func (*AnywhereCachesPauseCall)Headeradded inv0.156.0

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

typeAnywhereCachesResumeCalladded inv0.156.0

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

func (*AnywhereCachesResumeCall)Contextadded inv0.156.0

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

func (*AnywhereCachesResumeCall)Doadded inv0.156.0

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

func (*AnywhereCachesResumeCall)Fieldsadded inv0.156.0

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

func (*AnywhereCachesResumeCall)Headeradded inv0.156.0

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

typeAnywhereCachesServiceadded inv0.156.0

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

funcNewAnywhereCachesServiceadded inv0.156.0

func NewAnywhereCachesService(s *Service) *AnywhereCachesService

func (*AnywhereCachesService)Disableadded inv0.156.0

func (r *AnywhereCachesService) Disable(bucketstring, anywhereCacheIdstring) *AnywhereCachesDisableCall

Disable: Disables an Anywhere Cache instance.

- anywhereCacheId: The ID of requested Anywhere Cache instance.- bucket: Name of the parent bucket.

func (*AnywhereCachesService)Getadded inv0.156.0

func (r *AnywhereCachesService) Get(bucketstring, anywhereCacheIdstring) *AnywhereCachesGetCall

Get: Returns the metadata of an Anywhere Cache instance.

- anywhereCacheId: The ID of requested Anywhere Cache instance.- bucket: Name of the parent bucket.

func (*AnywhereCachesService)Insertadded inv0.156.0

func (r *AnywhereCachesService) Insert(bucketstring, anywherecache *AnywhereCache) *AnywhereCachesInsertCall

Insert: Creates an Anywhere Cache instance.

- bucket: Name of the parent bucket.

func (*AnywhereCachesService)Listadded inv0.156.0

List: Returns a list of Anywhere Cache instances of the bucket matching thecriteria.

- bucket: Name of the parent bucket.

func (*AnywhereCachesService)Pauseadded inv0.156.0

func (r *AnywhereCachesService) Pause(bucketstring, anywhereCacheIdstring) *AnywhereCachesPauseCall

Pause: Pauses an Anywhere Cache instance.

- anywhereCacheId: The ID of requested Anywhere Cache instance.- bucket: Name of the parent bucket.

func (*AnywhereCachesService)Resumeadded inv0.156.0

func (r *AnywhereCachesService) Resume(bucketstring, anywhereCacheIdstring) *AnywhereCachesResumeCall

Resume: Resumes a paused or disabled Anywhere Cache instance.

- anywhereCacheId: The ID of requested Anywhere Cache instance.- bucket: Name of the parent bucket.

func (*AnywhereCachesService)Updateadded inv0.156.0

func (r *AnywhereCachesService) Update(bucketstring, anywhereCacheIdstring, anywherecache *AnywhereCache) *AnywhereCachesUpdateCall

Update: Updates the config(ttl and admissionPolicy) of an Anywhere Cacheinstance.

- anywhereCacheId: The ID of requested Anywhere Cache instance.- bucket: Name of the parent bucket.

typeAnywhereCachesUpdateCalladded inv0.156.0

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

func (*AnywhereCachesUpdateCall)Contextadded inv0.156.0

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

func (*AnywhereCachesUpdateCall)Doadded inv0.156.0

Do executes the "storage.anywhereCaches.update" call.Any non-2xx status code is an error. Response headers are in either*GoogleLongrunningOperation.ServerResponse.Header or (if a response wasreturned at all) in error.(*googleapi.Error).Header. Usegoogleapi.IsNotModified to check whether the returned error was becausehttp.StatusNotModified was returned.

func (*AnywhereCachesUpdateCall)Fieldsadded inv0.156.0

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

func (*AnywhereCachesUpdateCall)Headeradded inv0.156.0

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

typeBucket

type Bucket struct {// Acl: Access controls on the bucket.Acl []*BucketAccessControl `json:"acl,omitempty"`// Autoclass: The bucket's Autoclass configuration.Autoclass *BucketAutoclass `json:"autoclass,omitempty"`// Billing: The bucket's billing configuration.Billing *BucketBilling `json:"billing,omitempty"`// Cors: The bucket's Cross-Origin Resource Sharing (CORS) configuration.Cors []*BucketCors `json:"cors,omitempty"`// CustomPlacementConfig: The bucket's custom placement configuration for// Custom Dual Regions.CustomPlacementConfig *BucketCustomPlacementConfig `json:"customPlacementConfig,omitempty"`// DefaultEventBasedHold: The default value for event-based hold on newly// created objects in this bucket. Event-based hold is a way to retain objects// indefinitely until an event occurs, signified by the hold's release. After// being released, such objects will be subject to bucket-level retention (if// any). One sample use case of this flag is for banks to hold loan documents// for at least 3 years after loan is paid in full. Here, bucket-level// retention is 3 years and the event is loan being paid in full. In this// example, these objects will be held intact for any number of years until the// event has occurred (event-based hold on the object is released) and then 3// more years after that. That means retention duration of the objects begins// from the moment event-based hold transitioned from true to false. Objects// under event-based hold cannot be deleted, overwritten or archived until the// hold is removed.DefaultEventBasedHoldbool `json:"defaultEventBasedHold,omitempty"`// DefaultObjectAcl: Default access controls to apply to new objects when no// ACL is provided.DefaultObjectAcl []*ObjectAccessControl `json:"defaultObjectAcl,omitempty"`// Encryption: Encryption configuration for a bucket.Encryption *BucketEncryption `json:"encryption,omitempty"`// Etag: HTTP 1.1 Entity tag for the bucket.Etagstring `json:"etag,omitempty"`// Generation: The generation of this bucket.Generationint64 `json:"generation,omitempty,string"`// HardDeleteTime: The hard delete time of the bucket inRFC 3339 format.HardDeleteTimestring `json:"hardDeleteTime,omitempty"`// HierarchicalNamespace: The bucket's hierarchical namespace configuration.HierarchicalNamespace *BucketHierarchicalNamespace `json:"hierarchicalNamespace,omitempty"`// IamConfiguration: The bucket's IAM configuration.IamConfiguration *BucketIamConfiguration `json:"iamConfiguration,omitempty"`// Id: The ID of the bucket. For buckets, the id and name properties are the// same.Idstring `json:"id,omitempty"`// IpFilter: The bucket's IP filter configuration. Specifies the network// sources that are allowed to access the operations on the bucket, as well as// its underlying objects. Only enforced when the mode is set to 'Enabled'.IpFilter *BucketIpFilter `json:"ipFilter,omitempty"`// Kind: The kind of item this is. For buckets, this is always storage#bucket.Kindstring `json:"kind,omitempty"`// Labels: User-provided labels, in key/value pairs.Labels map[string]string `json:"labels,omitempty"`// Lifecycle: The bucket's lifecycle configuration. See Lifecycle Management// (https://cloud.google.com/storage/docs/lifecycle) for more information.Lifecycle *BucketLifecycle `json:"lifecycle,omitempty"`// Location: The location of the bucket. Object data for objects in the bucket// resides in physical storage within this region. Defaults to US. See the// Developer's Guide (https://cloud.google.com/storage/docs/locations) for the// authoritative list.Locationstring `json:"location,omitempty"`// LocationType: The type of the bucket location.LocationTypestring `json:"locationType,omitempty"`// Logging: The bucket's logging configuration, which defines the destination// bucket and optional name prefix for the current bucket's logs.Logging *BucketLogging `json:"logging,omitempty"`// Metageneration: The metadata generation of this bucket.Metagenerationint64 `json:"metageneration,omitempty,string"`// Name: The name of the bucket.Namestring `json:"name,omitempty"`// ObjectRetention: The bucket's object retention config.ObjectRetention *BucketObjectRetention `json:"objectRetention,omitempty"`// Owner: The owner of the bucket. This is always the project team's owner// group.Owner *BucketOwner `json:"owner,omitempty"`// ProjectNumber: The project number of the project the bucket belongs to.ProjectNumberuint64 `json:"projectNumber,omitempty,string"`// RetentionPolicy: The bucket's retention policy. The retention policy// enforces a minimum retention time for all objects contained in the bucket,// based on their creation time. Any attempt to overwrite or delete objects// younger than the retention period will result in a PERMISSION_DENIED error.// An unlocked retention policy can be modified or removed from the bucket via// a storage.buckets.update operation. A locked retention policy cannot be// removed or shortened in duration for the lifetime of the bucket. Attempting// to remove or decrease period of a locked retention policy will result in a// PERMISSION_DENIED error.RetentionPolicy *BucketRetentionPolicy `json:"retentionPolicy,omitempty"`// Rpo: The Recovery Point Objective (RPO) of this bucket. Set to ASYNC_TURBO// to turn on Turbo Replication on a bucket.Rpostring `json:"rpo,omitempty"`// SatisfiesPZI: Reserved for future use.SatisfiesPZIbool `json:"satisfiesPZI,omitempty"`// SatisfiesPZS: Reserved for future use.SatisfiesPZSbool `json:"satisfiesPZS,omitempty"`// SelfLink: The URI of this bucket.SelfLinkstring `json:"selfLink,omitempty"`// SoftDeletePolicy: The bucket's soft delete policy, which defines the period// of time that soft-deleted objects will be retained, and cannot be// permanently deleted.SoftDeletePolicy *BucketSoftDeletePolicy `json:"softDeletePolicy,omitempty"`// SoftDeleteTime: The soft delete time of the bucket inRFC 3339 format.SoftDeleteTimestring `json:"softDeleteTime,omitempty"`// StorageClass: The bucket's default storage class, used whenever no// storageClass is specified for a newly-created object. This defines how// objects in the bucket are stored and determines the SLA and the cost of// storage. Values include MULTI_REGIONAL, REGIONAL, STANDARD, NEARLINE,// COLDLINE, ARCHIVE, and DURABLE_REDUCED_AVAILABILITY. If this value is not// specified when the bucket is created, it will default to STANDARD. For more// information, see Storage Classes// (https://cloud.google.com/storage/docs/storage-classes).StorageClassstring `json:"storageClass,omitempty"`// TimeCreated: The creation time of the bucket inRFC 3339 format.TimeCreatedstring `json:"timeCreated,omitempty"`// Updated: The modification time of the bucket inRFC 3339 format.Updatedstring `json:"updated,omitempty"`// Versioning: The bucket's versioning configuration.Versioning *BucketVersioning `json:"versioning,omitempty"`// Website: The bucket's website configuration, controlling how the service// behaves when accessing bucket contents as a web site. See the Static Website// Examples (https://cloud.google.com/storage/docs/static-website) for more// information.Website *BucketWebsite `json:"website,omitempty"`// ServerResponse contains the HTTP response code and headers from the server.googleapi.ServerResponse `json:"-"`// ForceSendFields is a list of field names (e.g. "Acl") 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. "Acl") 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:"-"`}

Bucket: A bucket.

func (Bucket)MarshalJSON

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

typeBucketAccessControl

type BucketAccessControl struct {// Bucket: The name of the bucket.Bucketstring `json:"bucket,omitempty"`// Domain: The domain associated with the entity, if any.Domainstring `json:"domain,omitempty"`// Email: The email address associated with the entity, if any.Emailstring `json:"email,omitempty"`// Entity: The entity holding the permission, in one of the following forms:// - user-userId// - user-email// - group-groupId// - group-email// - domain-domain// - project-team-projectId// - allUsers// - allAuthenticatedUsers Examples:// - The user liz@example.com would be user-liz@example.com.// - The group example@googlegroups.com would be// group-example@googlegroups.com.// - To refer to all members of the Google Apps for Business domain// example.com, the entity would be domain-example.com.Entitystring `json:"entity,omitempty"`// EntityId: The ID for the entity, if any.EntityIdstring `json:"entityId,omitempty"`// Etag: HTTP 1.1 Entity tag for the access-control entry.Etagstring `json:"etag,omitempty"`// Id: The ID of the access-control entry.Idstring `json:"id,omitempty"`// Kind: The kind of item this is. For bucket access control entries, this is// always storage#bucketAccessControl.Kindstring `json:"kind,omitempty"`// ProjectTeam: The project team associated with the entity, if any.ProjectTeam *BucketAccessControlProjectTeam `json:"projectTeam,omitempty"`// Role: The access permission for the entity.Rolestring `json:"role,omitempty"`// SelfLink: The link to this access-control entry.SelfLinkstring `json:"selfLink,omitempty"`// ServerResponse contains the HTTP response code and headers from the server.googleapi.ServerResponse `json:"-"`// 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:"-"`}

BucketAccessControl: An access-control entry.

func (BucketAccessControl)MarshalJSON

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

typeBucketAccessControlProjectTeam

type BucketAccessControlProjectTeam struct {// ProjectNumber: The project number.ProjectNumberstring `json:"projectNumber,omitempty"`// Team: The team.Teamstring `json:"team,omitempty"`// ForceSendFields is a list of field names (e.g. "ProjectNumber") 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. "ProjectNumber") 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:"-"`}

BucketAccessControlProjectTeam: The project team associated with the entity,if any.

func (BucketAccessControlProjectTeam)MarshalJSON

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

typeBucketAccessControls

type BucketAccessControls struct {// Items: The list of items.Items []*BucketAccessControl `json:"items,omitempty"`// Kind: The kind of item this is. For lists of bucket access control entries,// this is always storage#bucketAccessControls.Kindstring `json:"kind,omitempty"`// ServerResponse contains the HTTP response code and headers from the server.googleapi.ServerResponse `json:"-"`// ForceSendFields is a list of field names (e.g. "Items") 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. "Items") 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:"-"`}

BucketAccessControls: An access-control list.

func (BucketAccessControls)MarshalJSON

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

typeBucketAccessControlsDeleteCall

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

func (*BucketAccessControlsDeleteCall)Context

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

func (*BucketAccessControlsDeleteCall)Do

Do executes the "storage.bucketAccessControls.delete" call.

func (*BucketAccessControlsDeleteCall)Fields

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

func (*BucketAccessControlsDeleteCall)Header

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

func (*BucketAccessControlsDeleteCall)UserProject

UserProject sets the optional parameter "userProject": The project to bebilled for this request. Required for Requester Pays buckets.

typeBucketAccessControlsGetCall

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

func (*BucketAccessControlsGetCall)Context

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

func (*BucketAccessControlsGetCall)Do

Do executes the "storage.bucketAccessControls.get" call.Any non-2xx status code is an error. Response headers are in either*BucketAccessControl.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 (*BucketAccessControlsGetCall)Fields

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

func (*BucketAccessControlsGetCall)Header

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

func (*BucketAccessControlsGetCall)IfNoneMatch

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 (*BucketAccessControlsGetCall)UserProject

UserProject sets the optional parameter "userProject": The project to bebilled for this request. Required for Requester Pays buckets.

typeBucketAccessControlsInsertCall

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

func (*BucketAccessControlsInsertCall)Context

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

func (*BucketAccessControlsInsertCall)Do

Do executes the "storage.bucketAccessControls.insert" call.Any non-2xx status code is an error. Response headers are in either*BucketAccessControl.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 (*BucketAccessControlsInsertCall)Fields

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

func (*BucketAccessControlsInsertCall)Header

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

func (*BucketAccessControlsInsertCall)UserProject

UserProject sets the optional parameter "userProject": The project to bebilled for this request. Required for Requester Pays buckets.

typeBucketAccessControlsListCall

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

func (*BucketAccessControlsListCall)Context

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

func (*BucketAccessControlsListCall)Do

Do executes the "storage.bucketAccessControls.list" call.Any non-2xx status code is an error. Response headers are in either*BucketAccessControls.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 (*BucketAccessControlsListCall)Fields

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

func (*BucketAccessControlsListCall)Header

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

func (*BucketAccessControlsListCall)IfNoneMatch

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 (*BucketAccessControlsListCall)UserProject

UserProject sets the optional parameter "userProject": The project to bebilled for this request. Required for Requester Pays buckets.

typeBucketAccessControlsPatchCall

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

func (*BucketAccessControlsPatchCall)Context

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

func (*BucketAccessControlsPatchCall)Do

Do executes the "storage.bucketAccessControls.patch" call.Any non-2xx status code is an error. Response headers are in either*BucketAccessControl.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 (*BucketAccessControlsPatchCall)Fields

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

func (*BucketAccessControlsPatchCall)Header

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

func (*BucketAccessControlsPatchCall)UserProject

UserProject sets the optional parameter "userProject": The project to bebilled for this request. Required for Requester Pays buckets.

typeBucketAccessControlsService

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

funcNewBucketAccessControlsService

func NewBucketAccessControlsService(s *Service) *BucketAccessControlsService

func (*BucketAccessControlsService)Delete

Delete: Permanently deletes the ACL entry for the specified entity on thespecified bucket.

  • bucket: Name of a bucket.
  • entity: The entity holding the permission. Can be user-userId,user-emailAddress, group-groupId, group-emailAddress, allUsers, orallAuthenticatedUsers.

func (*BucketAccessControlsService)Get

Get: Returns the ACL entry for the specified entity on the specified bucket.

  • bucket: Name of a bucket.
  • entity: The entity holding the permission. Can be user-userId,user-emailAddress, group-groupId, group-emailAddress, allUsers, orallAuthenticatedUsers.

func (*BucketAccessControlsService)Insert

Insert: Creates a new ACL entry on the specified bucket.

- bucket: Name of a bucket.

func (*BucketAccessControlsService)List

List: Retrieves ACL entries on the specified bucket.

- bucket: Name of a bucket.

func (*BucketAccessControlsService)Patch

Patch: Patches an ACL entry on the specified bucket.

  • bucket: Name of a bucket.
  • entity: The entity holding the permission. Can be user-userId,user-emailAddress, group-groupId, group-emailAddress, allUsers, orallAuthenticatedUsers.

func (*BucketAccessControlsService)Update

Update: Updates an ACL entry on the specified bucket.

  • bucket: Name of a bucket.
  • entity: The entity holding the permission. Can be user-userId,user-emailAddress, group-groupId, group-emailAddress, allUsers, orallAuthenticatedUsers.

typeBucketAccessControlsUpdateCall

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

func (*BucketAccessControlsUpdateCall)Context

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

func (*BucketAccessControlsUpdateCall)Do

Do executes the "storage.bucketAccessControls.update" call.Any non-2xx status code is an error. Response headers are in either*BucketAccessControl.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 (*BucketAccessControlsUpdateCall)Fields

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

func (*BucketAccessControlsUpdateCall)Header

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

func (*BucketAccessControlsUpdateCall)UserProject

UserProject sets the optional parameter "userProject": The project to bebilled for this request. Required for Requester Pays buckets.

typeBucketAutoclassadded inv0.60.0

type BucketAutoclass struct {// Enabled: Whether or not Autoclass is enabled on this bucketEnabledbool `json:"enabled,omitempty"`// TerminalStorageClass: The storage class that objects in the bucket// eventually transition to if they are not read for a certain length of time.// Valid values are NEARLINE and ARCHIVE.TerminalStorageClassstring `json:"terminalStorageClass,omitempty"`// TerminalStorageClassUpdateTime: A date and time inRFC 3339 format// representing the time of the most recent update to "terminalStorageClass".TerminalStorageClassUpdateTimestring `json:"terminalStorageClassUpdateTime,omitempty"`// ToggleTime: A date and time inRFC 3339 format representing the instant at// which "enabled" was last toggled.ToggleTimestring `json:"toggleTime,omitempty"`// ForceSendFields is a list of field names (e.g. "Enabled") 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. "Enabled") 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:"-"`}

BucketAutoclass: The bucket's Autoclass configuration.

func (BucketAutoclass)MarshalJSONadded inv0.60.0

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

typeBucketBilling

type BucketBilling struct {// RequesterPays: When set to true, Requester Pays is enabled for this bucket.RequesterPaysbool `json:"requesterPays,omitempty"`// ForceSendFields is a list of field names (e.g. "RequesterPays") 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. "RequesterPays") 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:"-"`}

BucketBilling: The bucket's billing configuration.

func (BucketBilling)MarshalJSON

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

typeBucketCors

type BucketCors struct {// MaxAgeSeconds: The value, in seconds, to return in the// Access-Control-Max-Age header used in preflight responses.MaxAgeSecondsint64 `json:"maxAgeSeconds,omitempty"`// Method: The list of HTTP methods on which to include CORS response headers,// (GET, OPTIONS, POST, etc) Note: "*" is permitted in the list of methods, and// means "any method".Method []string `json:"method,omitempty"`// Origin: The list of Origins eligible to receive CORS response headers. Note:// "*" is permitted in the list of origins, and means "any Origin".Origin []string `json:"origin,omitempty"`// ResponseHeader: The list of HTTP headers other than the simple response// headers to give permission for the user-agent to share across domains.ResponseHeader []string `json:"responseHeader,omitempty"`// ForceSendFields is a list of field names (e.g. "MaxAgeSeconds") 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. "MaxAgeSeconds") 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 (BucketCors)MarshalJSON

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

typeBucketCustomPlacementConfigadded inv0.58.0

type BucketCustomPlacementConfig struct {// DataLocations: The list of regional locations in which data is placed.DataLocations []string `json:"dataLocations,omitempty"`// ForceSendFields is a list of field names (e.g. "DataLocations") 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. "DataLocations") 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:"-"`}

BucketCustomPlacementConfig: The bucket's custom placement configuration forCustom Dual Regions.

func (BucketCustomPlacementConfig)MarshalJSONadded inv0.58.0

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

typeBucketEncryption

type BucketEncryption struct {// CustomerManagedEncryptionEnforcementConfig: If set, the new objects created// in this bucket must comply with this enforcement config. Changing this has// no effect on existing objects; it applies to new objects only. If omitted,// the new objects are allowed to be encrypted with Customer Managed Encryption// type by default.CustomerManagedEncryptionEnforcementConfig *BucketEncryptionCustomerManagedEncryptionEnforcementConfig `json:"customerManagedEncryptionEnforcementConfig,omitempty"`// CustomerSuppliedEncryptionEnforcementConfig: If set, the new objects created// in this bucket must comply with this enforcement config. Changing this has// no effect on existing objects; it applies to new objects only. If omitted,// the new objects are allowed to be encrypted with Customer Supplied// Encryption type by default.CustomerSuppliedEncryptionEnforcementConfig *BucketEncryptionCustomerSuppliedEncryptionEnforcementConfig `json:"customerSuppliedEncryptionEnforcementConfig,omitempty"`// DefaultKmsKeyName: A Cloud KMS key that will be used to encrypt objects// inserted into this bucket, if no encryption method is specified.DefaultKmsKeyNamestring `json:"defaultKmsKeyName,omitempty"`// GoogleManagedEncryptionEnforcementConfig: If set, the new objects created in// this bucket must comply with this enforcement config. Changing this has no// effect on existing objects; it applies to new objects only. If omitted, the// new objects are allowed to be encrypted with Google Managed Encryption type// by default.GoogleManagedEncryptionEnforcementConfig *BucketEncryptionGoogleManagedEncryptionEnforcementConfig `json:"googleManagedEncryptionEnforcementConfig,omitempty"`// ForceSendFields is a list of field names (e.g.// "CustomerManagedEncryptionEnforcementConfig") 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.// "CustomerManagedEncryptionEnforcementConfig") 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:"-"`}

BucketEncryption: Encryption configuration for a bucket.

func (BucketEncryption)MarshalJSON

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

typeBucketEncryptionCustomerManagedEncryptionEnforcementConfigadded inv0.244.0

type BucketEncryptionCustomerManagedEncryptionEnforcementConfig struct {// EffectiveTime: Server-determined value that indicates the time from which// configuration was enforced and effective. This value is inRFC 3339 format.EffectiveTimestring `json:"effectiveTime,omitempty"`// RestrictionMode: Restriction mode for Customer-Managed Encryption Keys.// Defaults to NotRestricted.//// Possible values://   "NotRestricted" - Creation of new objects with Customer-Managed Encryption// is not restricted.//   "FullyRestricted" - Creation of new objects with Customer-Managed// Encryption is fully restricted.RestrictionModestring `json:"restrictionMode,omitempty"`// ForceSendFields is a list of field names (e.g. "EffectiveTime") 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. "EffectiveTime") 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:"-"`}

BucketEncryptionCustomerManagedEncryptionEnforcementConfig: If set, the newobjects created in this bucket must comply with this enforcement config.Changing this has no effect on existing objects; it applies to new objectsonly. If omitted, the new objects are allowed to be encrypted with CustomerManaged Encryption type by default.

func (BucketEncryptionCustomerManagedEncryptionEnforcementConfig)MarshalJSONadded inv0.244.0

typeBucketEncryptionCustomerSuppliedEncryptionEnforcementConfigadded inv0.244.0

type BucketEncryptionCustomerSuppliedEncryptionEnforcementConfig struct {// EffectiveTime: Server-determined value that indicates the time from which// configuration was enforced and effective. This value is inRFC 3339 format.EffectiveTimestring `json:"effectiveTime,omitempty"`// RestrictionMode: Restriction mode for Customer-Supplied Encryption Keys.// Defaults to NotRestricted.//// Possible values://   "NotRestricted" - Creation of new objects with Customer-Supplied// Encryption is not restricted.//   "FullyRestricted" - Creation of new objects with Customer-Supplied// Encryption is fully restricted.RestrictionModestring `json:"restrictionMode,omitempty"`// ForceSendFields is a list of field names (e.g. "EffectiveTime") 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. "EffectiveTime") 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:"-"`}

BucketEncryptionCustomerSuppliedEncryptionEnforcementConfig: If set, the newobjects created in this bucket must comply with this enforcement config.Changing this has no effect on existing objects; it applies to new objectsonly. If omitted, the new objects are allowed to be encrypted with CustomerSupplied Encryption type by default.

func (BucketEncryptionCustomerSuppliedEncryptionEnforcementConfig)MarshalJSONadded inv0.244.0

typeBucketEncryptionGoogleManagedEncryptionEnforcementConfigadded inv0.244.0

type BucketEncryptionGoogleManagedEncryptionEnforcementConfig struct {// EffectiveTime: Server-determined value that indicates the time from which// configuration was enforced and effective. This value is inRFC 3339 format.EffectiveTimestring `json:"effectiveTime,omitempty"`// RestrictionMode: Restriction mode for Google-Managed Encryption Keys.// Defaults to NotRestricted.//// Possible values://   "NotRestricted" - Creation of new objects with Google Managed Encryption// is not restricted.//   "FullyRestricted" - Creation of new objects with Google Managed Encryption// is fully restricted.RestrictionModestring `json:"restrictionMode,omitempty"`// ForceSendFields is a list of field names (e.g. "EffectiveTime") 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. "EffectiveTime") 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:"-"`}

BucketEncryptionGoogleManagedEncryptionEnforcementConfig: If set, the newobjects created in this bucket must comply with this enforcement config.Changing this has no effect on existing objects; it applies to new objectsonly. If omitted, the new objects are allowed to be encrypted with GoogleManaged Encryption type by default.

func (BucketEncryptionGoogleManagedEncryptionEnforcementConfig)MarshalJSONadded inv0.244.0

typeBucketHierarchicalNamespaceadded inv0.156.0

type BucketHierarchicalNamespace struct {// Enabled: When set to true, hierarchical namespace is enabled for this// bucket.Enabledbool `json:"enabled,omitempty"`// ForceSendFields is a list of field names (e.g. "Enabled") 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. "Enabled") 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:"-"`}

BucketHierarchicalNamespace: The bucket's hierarchical namespaceconfiguration.

func (BucketHierarchicalNamespace)MarshalJSONadded inv0.156.0

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

typeBucketIamConfiguration

type BucketIamConfiguration struct {// BucketPolicyOnly: The bucket's uniform bucket-level access configuration.// The feature was formerly known as Bucket Policy Only. For backward// compatibility, this field will be populated with identical information as// the uniformBucketLevelAccess field. We recommend using the// uniformBucketLevelAccess field to enable and disable the feature.BucketPolicyOnly *BucketIamConfigurationBucketPolicyOnly `json:"bucketPolicyOnly,omitempty"`// PublicAccessPrevention: The bucket's Public Access Prevention configuration.// Currently, 'inherited' and 'enforced' are supported.PublicAccessPreventionstring `json:"publicAccessPrevention,omitempty"`// UniformBucketLevelAccess: The bucket's uniform bucket-level access// configuration.UniformBucketLevelAccess *BucketIamConfigurationUniformBucketLevelAccess `json:"uniformBucketLevelAccess,omitempty"`// ForceSendFields is a list of field names (e.g. "BucketPolicyOnly") 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. "BucketPolicyOnly") 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:"-"`}

BucketIamConfiguration: The bucket's IAM configuration.

func (BucketIamConfiguration)MarshalJSON

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

typeBucketIamConfigurationBucketPolicyOnly

type BucketIamConfigurationBucketPolicyOnly struct {// Enabled: If set, access is controlled only by bucket-level or above IAM// policies.Enabledbool `json:"enabled,omitempty"`// LockedTime: The deadline for changing// iamConfiguration.bucketPolicyOnly.enabled from true to false inRFC 3339// format. iamConfiguration.bucketPolicyOnly.enabled may be changed from true// to false until the locked time, after which the field is immutable.LockedTimestring `json:"lockedTime,omitempty"`// ForceSendFields is a list of field names (e.g. "Enabled") 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. "Enabled") 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:"-"`}

BucketIamConfigurationBucketPolicyOnly: The bucket's uniform bucket-levelaccess configuration. The feature was formerly known as Bucket Policy Only.For backward compatibility, this field will be populated with identicalinformation as the uniformBucketLevelAccess field. We recommend using theuniformBucketLevelAccess field to enable and disable the feature.

func (BucketIamConfigurationBucketPolicyOnly)MarshalJSON

typeBucketIamConfigurationUniformBucketLevelAccessadded inv0.8.0

type BucketIamConfigurationUniformBucketLevelAccess struct {// Enabled: If set, access is controlled only by bucket-level or above IAM// policies.Enabledbool `json:"enabled,omitempty"`// LockedTime: The deadline for changing// iamConfiguration.uniformBucketLevelAccess.enabled from true to false in RFC// 3339  format. iamConfiguration.uniformBucketLevelAccess.enabled may be// changed from true to false until the locked time, after which the field is// immutable.LockedTimestring `json:"lockedTime,omitempty"`// ForceSendFields is a list of field names (e.g. "Enabled") 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. "Enabled") 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:"-"`}

BucketIamConfigurationUniformBucketLevelAccess: The bucket's uniformbucket-level access configuration.

func (BucketIamConfigurationUniformBucketLevelAccess)MarshalJSONadded inv0.8.0

typeBucketIpFilteradded inv0.189.0

type BucketIpFilter struct {// AllowAllServiceAgentAccess: Whether to allow all service agents to access// the bucket regardless of the IP filter configuration.AllowAllServiceAgentAccessbool `json:"allowAllServiceAgentAccess,omitempty"`// AllowCrossOrgVpcs: Whether to allow cross-org VPCs in the bucket's IP filter// configuration.AllowCrossOrgVpcsbool `json:"allowCrossOrgVpcs,omitempty"`// Mode: The mode of the IP filter. Valid values are 'Enabled' and 'Disabled'.Modestring `json:"mode,omitempty"`// PublicNetworkSource: The public network source of the bucket's IP filter.PublicNetworkSource *BucketIpFilterPublicNetworkSource `json:"publicNetworkSource,omitempty"`// VpcNetworkSources: The list of VPC network// (https://cloud.google.com/vpc/docs/vpc) sources of the bucket's IP filter.VpcNetworkSources []*BucketIpFilterVpcNetworkSources `json:"vpcNetworkSources,omitempty"`// ForceSendFields is a list of field names (e.g. "AllowAllServiceAgentAccess")// 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. "AllowAllServiceAgentAccess") 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:"-"`}

BucketIpFilter: The bucket's IP filter configuration. Specifies the networksources that are allowed to access the operations on the bucket, as well asits underlying objects. Only enforced when the mode is set to 'Enabled'.

func (BucketIpFilter)MarshalJSONadded inv0.189.0

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

typeBucketIpFilterPublicNetworkSourceadded inv0.189.0

type BucketIpFilterPublicNetworkSource struct {// AllowedIpCidrRanges: The list of public IPv4, IPv6 cidr ranges that are// allowed to access the bucket.AllowedIpCidrRanges []string `json:"allowedIpCidrRanges,omitempty"`// ForceSendFields is a list of field names (e.g. "AllowedIpCidrRanges") 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. "AllowedIpCidrRanges") 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:"-"`}

BucketIpFilterPublicNetworkSource: The public network source of the bucket'sIP filter.

func (BucketIpFilterPublicNetworkSource)MarshalJSONadded inv0.189.0

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

typeBucketIpFilterVpcNetworkSourcesadded inv0.189.0

type BucketIpFilterVpcNetworkSources struct {// AllowedIpCidrRanges: The list of IPv4, IPv6 cidr ranges subnetworks that are// allowed to access the bucket.AllowedIpCidrRanges []string `json:"allowedIpCidrRanges,omitempty"`// Network: Name of the network. Format:// projects/{PROJECT_ID}/global/networks/{NETWORK_NAME}Networkstring `json:"network,omitempty"`// ForceSendFields is a list of field names (e.g. "AllowedIpCidrRanges") 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. "AllowedIpCidrRanges") 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 (BucketIpFilterVpcNetworkSources)MarshalJSONadded inv0.189.0

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

typeBucketLifecycle

type BucketLifecycle struct {// Rule: A lifecycle management rule, which is made of an action to take and// the condition(s) under which the action will be taken.Rule []*BucketLifecycleRule `json:"rule,omitempty"`// ForceSendFields is a list of field names (e.g. "Rule") 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. "Rule") 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:"-"`}

BucketLifecycle: The bucket's lifecycle configuration. See LifecycleManagement (https://cloud.google.com/storage/docs/lifecycle) for moreinformation.

func (BucketLifecycle)MarshalJSON

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

typeBucketLifecycleRule

type BucketLifecycleRule struct {// Action: The action to take.Action *BucketLifecycleRuleAction `json:"action,omitempty"`// Condition: The condition(s) under which the action will be taken.Condition *BucketLifecycleRuleCondition `json:"condition,omitempty"`// ForceSendFields is a list of field names (e.g. "Action") 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. "Action") 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 (BucketLifecycleRule)MarshalJSON

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

typeBucketLifecycleRuleAction

type BucketLifecycleRuleAction struct {// StorageClass: Target storage class. Required iff the type of the action is// SetStorageClass.StorageClassstring `json:"storageClass,omitempty"`// Type: Type of the action. Currently, only Delete, SetStorageClass, and// AbortIncompleteMultipartUpload are supported.Typestring `json:"type,omitempty"`// ForceSendFields is a list of field names (e.g. "StorageClass") 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. "StorageClass") 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:"-"`}

BucketLifecycleRuleAction: The action to take.

func (BucketLifecycleRuleAction)MarshalJSON

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

typeBucketLifecycleRuleCondition

type BucketLifecycleRuleCondition struct {// Age: Age of an object (in days). This condition is satisfied when an object// reaches the specified age.Age *int64 `json:"age,omitempty"`// CreatedBefore: A date inRFC 3339 format with only the date part (for// instance, "2013-01-15"). This condition is satisfied when an object is// created before midnight of the specified date in UTC.CreatedBeforestring `json:"createdBefore,omitempty"`// CustomTimeBefore: A date inRFC 3339 format with only the date part (for// instance, "2013-01-15"). This condition is satisfied when the custom time on// an object is before this date in UTC.CustomTimeBeforestring `json:"customTimeBefore,omitempty"`// DaysSinceCustomTime: Number of days elapsed since the user-specified// timestamp set on an object. The condition is satisfied if the days elapsed// is at least this number. If no custom timestamp is specified on an object,// the condition does not apply.DaysSinceCustomTimeint64 `json:"daysSinceCustomTime,omitempty"`// DaysSinceNoncurrentTime: Number of days elapsed since the noncurrent// timestamp of an object. The condition is satisfied if the days elapsed is at// least this number. This condition is relevant only for versioned objects.// The value of the field must be a nonnegative integer. If it's zero, the// object version will become eligible for Lifecycle action as soon as it// becomes noncurrent.DaysSinceNoncurrentTimeint64 `json:"daysSinceNoncurrentTime,omitempty"`// IsLive: Relevant only for versioned objects. If the value is true, this// condition matches live objects; if the value is false, it matches archived// objects.IsLive *bool `json:"isLive,omitempty"`// MatchesPattern: A regular expression that satisfies the RE2 syntax. This// condition is satisfied when the name of the object matches the RE2 pattern.// Note: This feature is currently in the "Early Access" launch stage and is// only available to a whitelisted set of users; that means that this feature// may be changed in backward-incompatible ways and that it is not guaranteed// to be released.MatchesPatternstring `json:"matchesPattern,omitempty"`// MatchesPrefix: List of object name prefixes. This condition will be// satisfied when at least one of the prefixes exactly matches the beginning of// the object name.MatchesPrefix []string `json:"matchesPrefix,omitempty"`// MatchesStorageClass: Objects having any of the storage classes specified by// this condition will be matched. Values include MULTI_REGIONAL, REGIONAL,// NEARLINE, COLDLINE, ARCHIVE, STANDARD, and DURABLE_REDUCED_AVAILABILITY.MatchesStorageClass []string `json:"matchesStorageClass,omitempty"`// MatchesSuffix: List of object name suffixes. This condition will be// satisfied when at least one of the suffixes exactly matches the end of the// object name.MatchesSuffix []string `json:"matchesSuffix,omitempty"`// NoncurrentTimeBefore: A date inRFC 3339 format with only the date part (for// instance, "2013-01-15"). This condition is satisfied when the noncurrent// time on an object is before this date in UTC. This condition is relevant// only for versioned objects.NoncurrentTimeBeforestring `json:"noncurrentTimeBefore,omitempty"`// NumNewerVersions: Relevant only for versioned objects. If the value is N,// this condition is satisfied when there are at least N versions (including// the live version) newer than this version of the object.NumNewerVersionsint64 `json:"numNewerVersions,omitempty"`// ForceSendFields is a list of field names (e.g. "Age") 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. "Age") 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:"-"`}

BucketLifecycleRuleCondition: The condition(s) under which the action willbe taken.

func (BucketLifecycleRuleCondition)MarshalJSON

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

typeBucketLogging

type BucketLogging struct {// LogBucket: The destination bucket where the current bucket's logs should be// placed.LogBucketstring `json:"logBucket,omitempty"`// LogObjectPrefix: A prefix for log object names.LogObjectPrefixstring `json:"logObjectPrefix,omitempty"`// ForceSendFields is a list of field names (e.g. "LogBucket") 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. "LogBucket") 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:"-"`}

BucketLogging: The bucket's logging configuration, which defines thedestination bucket and optional name prefix for the current bucket's logs.

func (BucketLogging)MarshalJSON

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

typeBucketObjectRetentionadded inv0.142.0

type BucketObjectRetention struct {// Mode: The bucket's object retention mode. Can be Enabled.Modestring `json:"mode,omitempty"`// ForceSendFields is a list of field names (e.g. "Mode") 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. "Mode") 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:"-"`}

BucketObjectRetention: The bucket's object retention config.

func (BucketObjectRetention)MarshalJSONadded inv0.142.0

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

typeBucketOwner

type BucketOwner struct {// Entity: The entity, in the form project-owner-projectId.Entitystring `json:"entity,omitempty"`// EntityId: The ID for the entity.EntityIdstring `json:"entityId,omitempty"`// ForceSendFields is a list of field names (e.g. "Entity") 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. "Entity") 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:"-"`}

BucketOwner: The owner of the bucket. This is always the project team'sowner group.

func (BucketOwner)MarshalJSON

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

typeBucketRetentionPolicy

type BucketRetentionPolicy struct {// EffectiveTime: Server-determined value that indicates the time from which// policy was enforced and effective. This value is inRFC 3339 format.EffectiveTimestring `json:"effectiveTime,omitempty"`// IsLocked: Once locked, an object retention policy cannot be modified.IsLockedbool `json:"isLocked,omitempty"`// RetentionPeriod: The duration in seconds that objects need to be retained.// Retention duration must be greater than zero and less than 100 years. Note// that enforcement of retention periods less than a day is not guaranteed.// Such periods should only be used for testing purposes.RetentionPeriodint64 `json:"retentionPeriod,omitempty,string"`// ForceSendFields is a list of field names (e.g. "EffectiveTime") 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. "EffectiveTime") 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:"-"`}

BucketRetentionPolicy: The bucket's retention policy. The retention policyenforces a minimum retention time for all objects contained in the bucket,based on their creation time. Any attempt to overwrite or delete objectsyounger than the retention period will result in a PERMISSION_DENIED error.An unlocked retention policy can be modified or removed from the bucket viaa storage.buckets.update operation. A locked retention policy cannot beremoved or shortened in duration for the lifetime of the bucket. Attemptingto remove or decrease period of a locked retention policy will result in aPERMISSION_DENIED error.

func (BucketRetentionPolicy)MarshalJSON

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

typeBucketSoftDeletePolicyadded inv0.142.0

type BucketSoftDeletePolicy struct {// EffectiveTime: Server-determined value that indicates the time from which// the policy, or one with a greater retention, was effective. This value is in//RFC 3339 format.EffectiveTimestring `json:"effectiveTime,omitempty"`// RetentionDurationSeconds: The duration in seconds that soft-deleted objects// in the bucket will be retained and cannot be permanently deleted.RetentionDurationSecondsint64 `json:"retentionDurationSeconds,omitempty,string"`// ForceSendFields is a list of field names (e.g. "EffectiveTime") 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. "EffectiveTime") 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:"-"`}

BucketSoftDeletePolicy: The bucket's soft delete policy, which defines theperiod of time that soft-deleted objects will be retained, and cannot bepermanently deleted.

func (BucketSoftDeletePolicy)MarshalJSONadded inv0.142.0

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

typeBucketStorageLayoutadded inv0.182.0

type BucketStorageLayout struct {// Bucket: The name of the bucket.Bucketstring `json:"bucket,omitempty"`// CustomPlacementConfig: The bucket's custom placement configuration for// Custom Dual Regions.CustomPlacementConfig *BucketStorageLayoutCustomPlacementConfig `json:"customPlacementConfig,omitempty"`// HierarchicalNamespace: The bucket's hierarchical namespace configuration.HierarchicalNamespace *BucketStorageLayoutHierarchicalNamespace `json:"hierarchicalNamespace,omitempty"`// Kind: The kind of item this is. For storage layout, this is always// storage#storageLayout.Kindstring `json:"kind,omitempty"`// Location: The location of the bucket.Locationstring `json:"location,omitempty"`// LocationType: The type of the bucket location.LocationTypestring `json:"locationType,omitempty"`// ServerResponse contains the HTTP response code and headers from the server.googleapi.ServerResponse `json:"-"`// 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:"-"`}

BucketStorageLayout: The storage layout configuration of a bucket.

func (BucketStorageLayout)MarshalJSONadded inv0.182.0

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

typeBucketStorageLayoutCustomPlacementConfigadded inv0.182.0

type BucketStorageLayoutCustomPlacementConfig struct {// DataLocations: The list of regional locations in which data is placed.DataLocations []string `json:"dataLocations,omitempty"`// ForceSendFields is a list of field names (e.g. "DataLocations") 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. "DataLocations") 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:"-"`}

BucketStorageLayoutCustomPlacementConfig: The bucket's custom placementconfiguration for Custom Dual Regions.

func (BucketStorageLayoutCustomPlacementConfig)MarshalJSONadded inv0.182.0

typeBucketStorageLayoutHierarchicalNamespaceadded inv0.182.0

type BucketStorageLayoutHierarchicalNamespace struct {// Enabled: When set to true, hierarchical namespace is enabled for this// bucket.Enabledbool `json:"enabled,omitempty"`// ForceSendFields is a list of field names (e.g. "Enabled") 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. "Enabled") 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:"-"`}

BucketStorageLayoutHierarchicalNamespace: The bucket's hierarchicalnamespace configuration.

func (BucketStorageLayoutHierarchicalNamespace)MarshalJSONadded inv0.182.0

typeBucketVersioning

type BucketVersioning struct {// Enabled: While set to true, versioning is fully enabled for this bucket.Enabledbool `json:"enabled,omitempty"`// ForceSendFields is a list of field names (e.g. "Enabled") 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. "Enabled") 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:"-"`}

BucketVersioning: The bucket's versioning configuration.

func (BucketVersioning)MarshalJSON

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

typeBucketWebsite

type BucketWebsite struct {// MainPageSuffix: If the requested object path is missing, the service will// ensure the path has a trailing '/', append this suffix, and attempt to// retrieve the resulting object. This allows the creation of index.html// objects to represent directory pages.MainPageSuffixstring `json:"mainPageSuffix,omitempty"`// NotFoundPage: If the requested object path is missing, and any// mainPageSuffix object is missing, if applicable, the service will return the// named object from this bucket as the content for a 404 Not Found result.NotFoundPagestring `json:"notFoundPage,omitempty"`// ForceSendFields is a list of field names (e.g. "MainPageSuffix") 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. "MainPageSuffix") 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:"-"`}

BucketWebsite: The bucket's website configuration, controlling how theservice behaves when accessing bucket contents as a web site. See the StaticWebsite Examples (https://cloud.google.com/storage/docs/static-website) formore information.

func (BucketWebsite)MarshalJSON

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

typeBuckets

type Buckets struct {// Items: The list of items.Items []*Bucket `json:"items,omitempty"`// Kind: The kind of item this is. For lists of buckets, this is always// storage#buckets.Kindstring `json:"kind,omitempty"`// NextPageToken: The continuation token, used to page through large result// sets. Provide this value in a subsequent request to return the next page of// results.NextPageTokenstring `json:"nextPageToken,omitempty"`// Unreachable: The list of bucket resource names that could not be reached// during the listing operation.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. "Items") 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. "Items") 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:"-"`}

Buckets: A list of buckets.

func (Buckets)MarshalJSON

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

typeBucketsDeleteCall

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

func (*BucketsDeleteCall)Context

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

func (*BucketsDeleteCall)Do

Do executes the "storage.buckets.delete" call.

func (*BucketsDeleteCall)Fields

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

func (*BucketsDeleteCall)Header

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

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

func (*BucketsDeleteCall)IfMetagenerationMatch

func (c *BucketsDeleteCall) IfMetagenerationMatch(ifMetagenerationMatchint64) *BucketsDeleteCall

IfMetagenerationMatch sets the optional parameter "ifMetagenerationMatch":If set, only deletes the bucket if its metageneration matches this value.

func (*BucketsDeleteCall)IfMetagenerationNotMatch

func (c *BucketsDeleteCall) IfMetagenerationNotMatch(ifMetagenerationNotMatchint64) *BucketsDeleteCall

IfMetagenerationNotMatch sets the optional parameter"ifMetagenerationNotMatch": If set, only deletes the bucket if itsmetageneration does not match this value.

func (*BucketsDeleteCall)UserProject

func (c *BucketsDeleteCall) UserProject(userProjectstring) *BucketsDeleteCall

UserProject sets the optional parameter "userProject": The project to bebilled for this request. Required for Requester Pays buckets.

typeBucketsGetCall

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

func (*BucketsGetCall)Context

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

func (*BucketsGetCall)Do

Do executes the "storage.buckets.get" call.Any non-2xx status code is an error. Response headers are in either*Bucket.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 (*BucketsGetCall)Fields

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

func (*BucketsGetCall)Generationadded inv0.192.0

func (c *BucketsGetCall) Generation(generationint64) *BucketsGetCall

Generation sets the optional parameter "generation": If present, specifiesthe generation of the bucket. This is required if softDeleted is true.

func (*BucketsGetCall)Header

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

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

func (*BucketsGetCall)IfMetagenerationMatch

func (c *BucketsGetCall) IfMetagenerationMatch(ifMetagenerationMatchint64) *BucketsGetCall

IfMetagenerationMatch sets the optional parameter "ifMetagenerationMatch":Makes the return of the bucket metadata conditional on whether the bucket'scurrent metageneration matches the given value.

func (*BucketsGetCall)IfMetagenerationNotMatch

func (c *BucketsGetCall) IfMetagenerationNotMatch(ifMetagenerationNotMatchint64) *BucketsGetCall

IfMetagenerationNotMatch sets the optional parameter"ifMetagenerationNotMatch": Makes the return of the bucket metadataconditional on whether the bucket's current metageneration does not matchthe given value.

func (*BucketsGetCall)IfNoneMatch

func (c *BucketsGetCall) IfNoneMatch(entityTagstring) *BucketsGetCall

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 (*BucketsGetCall)Projection

func (c *BucketsGetCall) Projection(projectionstring) *BucketsGetCall

Projection sets the optional parameter "projection": Set of properties toreturn. Defaults to noAcl.

Possible values:

"full" - Include all properties."noAcl" - Omit owner, acl and defaultObjectAcl properties.

func (*BucketsGetCall)SoftDeletedadded inv0.192.0

func (c *BucketsGetCall) SoftDeleted(softDeletedbool) *BucketsGetCall

SoftDeleted sets the optional parameter "softDeleted": If true, return thesoft-deleted version of this bucket. The default is false. For moreinformation, see Soft Delete(https://cloud.google.com/storage/docs/soft-delete).

func (*BucketsGetCall)UserProject

func (c *BucketsGetCall) UserProject(userProjectstring) *BucketsGetCall

UserProject sets the optional parameter "userProject": The project to bebilled for this request. Required for Requester Pays buckets.

typeBucketsGetIamPolicyCall

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

func (*BucketsGetIamPolicyCall)Context

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

func (*BucketsGetIamPolicyCall)Do

Do executes the "storage.buckets.getIamPolicy" call.Any non-2xx status code is an error. Response headers are in either*Policy.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 (*BucketsGetIamPolicyCall)Fields

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

func (*BucketsGetIamPolicyCall)Header

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

func (*BucketsGetIamPolicyCall)IfNoneMatch

func (c *BucketsGetIamPolicyCall) IfNoneMatch(entityTagstring) *BucketsGetIamPolicyCall

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 (*BucketsGetIamPolicyCall)OptionsRequestedPolicyVersionadded inv0.10.0

func (c *BucketsGetIamPolicyCall) OptionsRequestedPolicyVersion(optionsRequestedPolicyVersionint64) *BucketsGetIamPolicyCall

OptionsRequestedPolicyVersion sets the optional parameter"optionsRequestedPolicyVersion": The IAM policy format version to bereturned. If the optionsRequestedPolicyVersion is for an older version thatdoesn't support part of the requested IAM policy, the request fails.

func (*BucketsGetIamPolicyCall)UserProject

func (c *BucketsGetIamPolicyCall) UserProject(userProjectstring) *BucketsGetIamPolicyCall

UserProject sets the optional parameter "userProject": The project to bebilled for this request. Required for Requester Pays buckets.

typeBucketsGetStorageLayoutCalladded inv0.182.0

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

func (*BucketsGetStorageLayoutCall)Contextadded inv0.182.0

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

func (*BucketsGetStorageLayoutCall)Doadded inv0.182.0

Do executes the "storage.buckets.getStorageLayout" call.Any non-2xx status code is an error. Response headers are in either*BucketStorageLayout.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 (*BucketsGetStorageLayoutCall)Fieldsadded inv0.182.0

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

func (*BucketsGetStorageLayoutCall)Headeradded inv0.182.0

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

func (*BucketsGetStorageLayoutCall)IfNoneMatchadded inv0.182.0

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 (*BucketsGetStorageLayoutCall)Prefixadded inv0.182.0

Prefix sets the optional parameter "prefix": An optional prefix used forpermission check. It is useful when the caller only has storage.objects.listpermission under a specific prefix.

typeBucketsInsertCall

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

func (*BucketsInsertCall)Context

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

func (*BucketsInsertCall)Do

Do executes the "storage.buckets.insert" call.Any non-2xx status code is an error. Response headers are in either*Bucket.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 (*BucketsInsertCall)EnableObjectRetentionadded inv0.142.0

func (c *BucketsInsertCall) EnableObjectRetention(enableObjectRetentionbool) *BucketsInsertCall

EnableObjectRetention sets the optional parameter "enableObjectRetention":When set to true, object retention is enabled for this bucket.

func (*BucketsInsertCall)Fields

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

func (*BucketsInsertCall)Header

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

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

func (*BucketsInsertCall)PredefinedAcl

func (c *BucketsInsertCall) PredefinedAcl(predefinedAclstring) *BucketsInsertCall

PredefinedAcl sets the optional parameter "predefinedAcl": Apply apredefined set of access controls to this bucket.

Possible values:

"authenticatedRead" - Project team owners get OWNER access, and

allAuthenticatedUsers get READER access.

"private" - Project team owners get OWNER access."projectPrivate" - Project team members get access according to their

roles.

"publicRead" - Project team owners get OWNER access, and allUsers get

READER access.

"publicReadWrite" - Project team owners get OWNER access, and allUsers get

WRITER access.

func (*BucketsInsertCall)PredefinedDefaultObjectAcl

func (c *BucketsInsertCall) PredefinedDefaultObjectAcl(predefinedDefaultObjectAclstring) *BucketsInsertCall

PredefinedDefaultObjectAcl sets the optional parameter"predefinedDefaultObjectAcl": Apply a predefined set of default objectaccess controls to this bucket.

Possible values:

"authenticatedRead" - Object owner gets OWNER access, and

allAuthenticatedUsers get READER access.

"bucketOwnerFullControl" - Object owner gets OWNER access, and project

team owners get OWNER access.

"bucketOwnerRead" - Object owner gets OWNER access, and project team

owners get READER access.

"private" - Object owner gets OWNER access."projectPrivate" - Object owner gets OWNER access, and project team

members get access according to their roles.

"publicRead" - Object owner gets OWNER access, and allUsers get READER

access.

func (*BucketsInsertCall)Projection

func (c *BucketsInsertCall) Projection(projectionstring) *BucketsInsertCall

Projection sets the optional parameter "projection": Set of properties toreturn. Defaults to noAcl, unless the bucket resource specifies acl ordefaultObjectAcl properties, when it defaults to full.

Possible values:

"full" - Include all properties."noAcl" - Omit owner, acl and defaultObjectAcl properties.

func (*BucketsInsertCall)UserProject

func (c *BucketsInsertCall) UserProject(userProjectstring) *BucketsInsertCall

UserProject sets the optional parameter "userProject": The project to bebilled for this request.

typeBucketsListCall

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

func (*BucketsListCall)Context

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

func (*BucketsListCall)Do

Do executes the "storage.buckets.list" call.Any non-2xx status code is an error. Response headers are in either*Buckets.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 (*BucketsListCall)Fields

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

func (*BucketsListCall)Header

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

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

func (*BucketsListCall)IfNoneMatch

func (c *BucketsListCall) IfNoneMatch(entityTagstring) *BucketsListCall

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 (*BucketsListCall)MaxResults

func (c *BucketsListCall) MaxResults(maxResultsint64) *BucketsListCall

MaxResults sets the optional parameter "maxResults": Maximum number ofbuckets to return in a single response. The service will use this parameteror 1,000 items, whichever is smaller.

func (*BucketsListCall)PageToken

func (c *BucketsListCall) PageToken(pageTokenstring) *BucketsListCall

PageToken sets the optional parameter "pageToken": A previously-returnedpage token representing part of the larger set of results to view.

func (*BucketsListCall)Pages

func (c *BucketsListCall) Pages(ctxcontext.Context, f func(*Buckets)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 (*BucketsListCall)Prefix

func (c *BucketsListCall) Prefix(prefixstring) *BucketsListCall

Prefix sets the optional parameter "prefix": Filter results to buckets whosenames begin with this prefix.

func (*BucketsListCall)Projection

func (c *BucketsListCall) Projection(projectionstring) *BucketsListCall

Projection sets the optional parameter "projection": Set of properties toreturn. Defaults to noAcl.

Possible values:

"full" - Include all properties."noAcl" - Omit owner, acl and defaultObjectAcl properties.

func (*BucketsListCall)ReturnPartialSuccessadded inv0.251.0

func (c *BucketsListCall) ReturnPartialSuccess(returnPartialSuccessbool) *BucketsListCall

ReturnPartialSuccess sets the optional parameter "returnPartialSuccess": Iftrue, return a list of bucket resource names for buckets that are inunreachable locations.

func (*BucketsListCall)SoftDeletedadded inv0.192.0

func (c *BucketsListCall) SoftDeleted(softDeletedbool) *BucketsListCall

SoftDeleted sets the optional parameter "softDeleted": If true, onlysoft-deleted bucket versions will be returned. The default is false. Formore information, see Soft Delete(https://cloud.google.com/storage/docs/soft-delete).

func (*BucketsListCall)UserProject

func (c *BucketsListCall) UserProject(userProjectstring) *BucketsListCall

UserProject sets the optional parameter "userProject": The project to bebilled for this request.

typeBucketsLockRetentionPolicyCall

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

func (*BucketsLockRetentionPolicyCall)Context

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

func (*BucketsLockRetentionPolicyCall)Do

Do executes the "storage.buckets.lockRetentionPolicy" call.Any non-2xx status code is an error. Response headers are in either*Bucket.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 (*BucketsLockRetentionPolicyCall)Fields

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

func (*BucketsLockRetentionPolicyCall)Header

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

func (*BucketsLockRetentionPolicyCall)UserProject

UserProject sets the optional parameter "userProject": The project to bebilled for this request. Required for Requester Pays buckets.

typeBucketsPatchCall

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

func (*BucketsPatchCall)Context

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

func (*BucketsPatchCall)Do

Do executes the "storage.buckets.patch" call.Any non-2xx status code is an error. Response headers are in either*Bucket.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 (*BucketsPatchCall)Fields

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

func (*BucketsPatchCall)Header

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

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

func (*BucketsPatchCall)IfMetagenerationMatch

func (c *BucketsPatchCall) IfMetagenerationMatch(ifMetagenerationMatchint64) *BucketsPatchCall

IfMetagenerationMatch sets the optional parameter "ifMetagenerationMatch":Makes the return of the bucket metadata conditional on whether the bucket'scurrent metageneration matches the given value.

func (*BucketsPatchCall)IfMetagenerationNotMatch

func (c *BucketsPatchCall) IfMetagenerationNotMatch(ifMetagenerationNotMatchint64) *BucketsPatchCall

IfMetagenerationNotMatch sets the optional parameter"ifMetagenerationNotMatch": Makes the return of the bucket metadataconditional on whether the bucket's current metageneration does not matchthe given value.

func (*BucketsPatchCall)PredefinedAcl

func (c *BucketsPatchCall) PredefinedAcl(predefinedAclstring) *BucketsPatchCall

PredefinedAcl sets the optional parameter "predefinedAcl": Apply apredefined set of access controls to this bucket.

Possible values:

"authenticatedRead" - Project team owners get OWNER access, and

allAuthenticatedUsers get READER access.

"private" - Project team owners get OWNER access."projectPrivate" - Project team members get access according to their

roles.

"publicRead" - Project team owners get OWNER access, and allUsers get

READER access.

"publicReadWrite" - Project team owners get OWNER access, and allUsers get

WRITER access.

func (*BucketsPatchCall)PredefinedDefaultObjectAcl

func (c *BucketsPatchCall) PredefinedDefaultObjectAcl(predefinedDefaultObjectAclstring) *BucketsPatchCall

PredefinedDefaultObjectAcl sets the optional parameter"predefinedDefaultObjectAcl": Apply a predefined set of default objectaccess controls to this bucket.

Possible values:

"authenticatedRead" - Object owner gets OWNER access, and

allAuthenticatedUsers get READER access.

"bucketOwnerFullControl" - Object owner gets OWNER access, and project

team owners get OWNER access.

"bucketOwnerRead" - Object owner gets OWNER access, and project team

owners get READER access.

"private" - Object owner gets OWNER access."projectPrivate" - Object owner gets OWNER access, and project team

members get access according to their roles.

"publicRead" - Object owner gets OWNER access, and allUsers get READER

access.

func (*BucketsPatchCall)Projection

func (c *BucketsPatchCall) Projection(projectionstring) *BucketsPatchCall

Projection sets the optional parameter "projection": Set of properties toreturn. Defaults to full.

Possible values:

"full" - Include all properties."noAcl" - Omit owner, acl and defaultObjectAcl properties.

func (*BucketsPatchCall)UserProject

func (c *BucketsPatchCall) UserProject(userProjectstring) *BucketsPatchCall

UserProject sets the optional parameter "userProject": The project to bebilled for this request. Required for Requester Pays buckets.

typeBucketsRelocateCalladded inv0.200.0

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

func (*BucketsRelocateCall)Contextadded inv0.200.0

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

func (*BucketsRelocateCall)Doadded inv0.200.0

Do executes the "storage.buckets.relocate" call.Any non-2xx status code is an error. Response headers are in either*GoogleLongrunningOperation.ServerResponse.Header or (if a response wasreturned at all) in error.(*googleapi.Error).Header. Usegoogleapi.IsNotModified to check whether the returned error was becausehttp.StatusNotModified was returned.

func (*BucketsRelocateCall)Fieldsadded inv0.200.0

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

func (*BucketsRelocateCall)Headeradded inv0.200.0

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

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

typeBucketsRestoreCalladded inv0.192.0

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

func (*BucketsRestoreCall)Contextadded inv0.192.0

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

func (*BucketsRestoreCall)Doadded inv0.192.0

Do executes the "storage.buckets.restore" call.Any non-2xx status code is an error. Response headers are in either*Bucket.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 (*BucketsRestoreCall)Fieldsadded inv0.192.0

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

func (*BucketsRestoreCall)Headeradded inv0.192.0

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

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

func (*BucketsRestoreCall)Projectionadded inv0.207.0

func (c *BucketsRestoreCall) Projection(projectionstring) *BucketsRestoreCall

Projection sets the optional parameter "projection": Set of properties toreturn. Defaults to full.

Possible values:

"full" - Include all properties."noAcl" - Omit owner, acl and defaultObjectAcl properties.

func (*BucketsRestoreCall)UserProjectadded inv0.192.0

func (c *BucketsRestoreCall) UserProject(userProjectstring) *BucketsRestoreCall

UserProject sets the optional parameter "userProject": The project to bebilled for this request. Required for Requester Pays buckets.

typeBucketsService

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

funcNewBucketsService

func NewBucketsService(s *Service) *BucketsService

func (*BucketsService)Delete

func (r *BucketsService) Delete(bucketstring) *BucketsDeleteCall

Delete: Deletes an empty bucket. Deletions are permanent unless soft deleteis enabled on the bucket.

- bucket: Name of a bucket.

func (*BucketsService)Get

func (r *BucketsService) Get(bucketstring) *BucketsGetCall

Get: Returns metadata for the specified bucket.

- bucket: Name of a bucket.

func (*BucketsService)GetIamPolicy

func (r *BucketsService) GetIamPolicy(bucketstring) *BucketsGetIamPolicyCall

GetIamPolicy: Returns an IAM policy for the specified bucket.

- bucket: Name of a bucket.

func (*BucketsService)GetStorageLayoutadded inv0.182.0

func (r *BucketsService) GetStorageLayout(bucketstring) *BucketsGetStorageLayoutCall

GetStorageLayout: Returns the storage layout configuration for the specifiedbucket. Note that this operation requires storage.objects.list permission.

- bucket: Name of a bucket.

func (*BucketsService)Insert

func (r *BucketsService) Insert(projectidstring, bucket *Bucket) *BucketsInsertCall

Insert: Creates a new bucket.

- project: A valid API project identifier.

func (*BucketsService)List

func (r *BucketsService) List(projectidstring) *BucketsListCall

List: Retrieves a list of buckets for a given project.

- project: A valid API project identifier.

func (*BucketsService)LockRetentionPolicy

func (r *BucketsService) LockRetentionPolicy(bucketstring, ifMetagenerationMatchint64) *BucketsLockRetentionPolicyCall

LockRetentionPolicy: Locks retention policy on a bucket.

  • bucket: Name of a bucket.
  • ifMetagenerationMatch: Makes the operation conditional on whether bucket'scurrent metageneration matches the given value.

func (*BucketsService)Patch

func (r *BucketsService) Patch(bucketstring, bucket2 *Bucket) *BucketsPatchCall

Patch: Patches a bucket. Changes to the bucket will be readable immediatelyafter writing, but configuration changes may take time to propagate.

- bucket: Name of a bucket.

func (*BucketsService)Relocateadded inv0.200.0

func (r *BucketsService) Relocate(bucketstring, relocatebucketrequest *RelocateBucketRequest) *BucketsRelocateCall

Relocate: Initiates a long-running Relocate Bucket operation on thespecified bucket.

- bucket: Name of the bucket to be moved.

func (*BucketsService)Restoreadded inv0.192.0

func (r *BucketsService) Restore(bucketstring, generationint64) *BucketsRestoreCall

Restore: Restores a soft-deleted bucket.

- bucket: Name of a bucket.- generation: Generation of a bucket.

func (*BucketsService)SetIamPolicy

func (r *BucketsService) SetIamPolicy(bucketstring, policy *Policy) *BucketsSetIamPolicyCall

SetIamPolicy: Updates an IAM policy for the specified bucket.

- bucket: Name of a bucket.

func (*BucketsService)TestIamPermissions

func (r *BucketsService) TestIamPermissions(bucketstring, permissions []string) *BucketsTestIamPermissionsCall

TestIamPermissions: Tests a set of permissions on the given bucket to seewhich, if any, are held by the caller.

- bucket: Name of a bucket.- permissions: Permissions to test.

func (*BucketsService)Update

func (r *BucketsService) Update(bucketstring, bucket2 *Bucket) *BucketsUpdateCall

Update: Updates a bucket. Changes to the bucket will be readable immediatelyafter writing, but configuration changes may take time to propagate.

- bucket: Name of a bucket.

typeBucketsSetIamPolicyCall

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

func (*BucketsSetIamPolicyCall)Context

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

func (*BucketsSetIamPolicyCall)Do

Do executes the "storage.buckets.setIamPolicy" call.Any non-2xx status code is an error. Response headers are in either*Policy.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 (*BucketsSetIamPolicyCall)Fields

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

func (*BucketsSetIamPolicyCall)Header

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

func (*BucketsSetIamPolicyCall)UserProject

func (c *BucketsSetIamPolicyCall) UserProject(userProjectstring) *BucketsSetIamPolicyCall

UserProject sets the optional parameter "userProject": The project to bebilled for this request. Required for Requester Pays buckets.

typeBucketsTestIamPermissionsCall

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

func (*BucketsTestIamPermissionsCall)Context

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

func (*BucketsTestIamPermissionsCall)Do

Do executes the "storage.buckets.testIamPermissions" call.Any non-2xx status code is an error. Response headers are in either*TestIamPermissionsResponse.ServerResponse.Header or (if a response wasreturned at all) in error.(*googleapi.Error).Header. Usegoogleapi.IsNotModified to check whether the returned error was becausehttp.StatusNotModified was returned.

func (*BucketsTestIamPermissionsCall)Fields

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

func (*BucketsTestIamPermissionsCall)Header

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

func (*BucketsTestIamPermissionsCall)IfNoneMatch

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 (*BucketsTestIamPermissionsCall)UserProject

UserProject sets the optional parameter "userProject": The project to bebilled for this request. Required for Requester Pays buckets.

typeBucketsUpdateCall

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

func (*BucketsUpdateCall)Context

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

func (*BucketsUpdateCall)Do

Do executes the "storage.buckets.update" call.Any non-2xx status code is an error. Response headers are in either*Bucket.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 (*BucketsUpdateCall)Fields

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

func (*BucketsUpdateCall)Header

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

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

func (*BucketsUpdateCall)IfMetagenerationMatch

func (c *BucketsUpdateCall) IfMetagenerationMatch(ifMetagenerationMatchint64) *BucketsUpdateCall

IfMetagenerationMatch sets the optional parameter "ifMetagenerationMatch":Makes the return of the bucket metadata conditional on whether the bucket'scurrent metageneration matches the given value.

func (*BucketsUpdateCall)IfMetagenerationNotMatch

func (c *BucketsUpdateCall) IfMetagenerationNotMatch(ifMetagenerationNotMatchint64) *BucketsUpdateCall

IfMetagenerationNotMatch sets the optional parameter"ifMetagenerationNotMatch": Makes the return of the bucket metadataconditional on whether the bucket's current metageneration does not matchthe given value.

func (*BucketsUpdateCall)PredefinedAcl

func (c *BucketsUpdateCall) PredefinedAcl(predefinedAclstring) *BucketsUpdateCall

PredefinedAcl sets the optional parameter "predefinedAcl": Apply apredefined set of access controls to this bucket.

Possible values:

"authenticatedRead" - Project team owners get OWNER access, and

allAuthenticatedUsers get READER access.

"private" - Project team owners get OWNER access."projectPrivate" - Project team members get access according to their

roles.

"publicRead" - Project team owners get OWNER access, and allUsers get

READER access.

"publicReadWrite" - Project team owners get OWNER access, and allUsers get

WRITER access.

func (*BucketsUpdateCall)PredefinedDefaultObjectAcl

func (c *BucketsUpdateCall) PredefinedDefaultObjectAcl(predefinedDefaultObjectAclstring) *BucketsUpdateCall

PredefinedDefaultObjectAcl sets the optional parameter"predefinedDefaultObjectAcl": Apply a predefined set of default objectaccess controls to this bucket.

Possible values:

"authenticatedRead" - Object owner gets OWNER access, and

allAuthenticatedUsers get READER access.

"bucketOwnerFullControl" - Object owner gets OWNER access, and project

team owners get OWNER access.

"bucketOwnerRead" - Object owner gets OWNER access, and project team

owners get READER access.

"private" - Object owner gets OWNER access."projectPrivate" - Object owner gets OWNER access, and project team

members get access according to their roles.

"publicRead" - Object owner gets OWNER access, and allUsers get READER

access.

func (*BucketsUpdateCall)Projection

func (c *BucketsUpdateCall) Projection(projectionstring) *BucketsUpdateCall

Projection sets the optional parameter "projection": Set of properties toreturn. Defaults to full.

Possible values:

"full" - Include all properties."noAcl" - Omit owner, acl and defaultObjectAcl properties.

func (*BucketsUpdateCall)UserProject

func (c *BucketsUpdateCall) UserProject(userProjectstring) *BucketsUpdateCall

UserProject sets the optional parameter "userProject": The project to bebilled for this request. Required for Requester Pays buckets.

typeBulkRestoreObjectsRequestadded inv0.141.0

type BulkRestoreObjectsRequest struct {// AllowOverwrite: If false (default), the restore will not overwrite live// objects with the same name at the destination. This means some deleted// objects may be skipped. If true, live objects will be overwritten resulting// in a noncurrent object (if versioning is enabled). If versioning is not// enabled, overwriting the object will result in a soft-deleted object. In// either case, if a noncurrent object already exists with the same name, a// live version can be written without issue.AllowOverwritebool `json:"allowOverwrite,omitempty"`// CopySourceAcl: If true, copies the source object's ACL; otherwise, uses the// bucket's default object ACL. The default is false.CopySourceAclbool `json:"copySourceAcl,omitempty"`// CreatedAfterTime: Restores only the objects that were created after this// time.CreatedAfterTimestring `json:"createdAfterTime,omitempty"`// CreatedBeforeTime: Restores only the objects that were created before this// time.CreatedBeforeTimestring `json:"createdBeforeTime,omitempty"`// MatchGlobs: Restores only the objects matching any of the specified glob(s).// If this parameter is not specified, all objects will be restored within the// specified time range.MatchGlobs []string `json:"matchGlobs,omitempty"`// SoftDeletedAfterTime: Restores only the objects that were soft-deleted after// this time.SoftDeletedAfterTimestring `json:"softDeletedAfterTime,omitempty"`// SoftDeletedBeforeTime: Restores only the objects that were soft-deleted// before this time.SoftDeletedBeforeTimestring `json:"softDeletedBeforeTime,omitempty"`// ForceSendFields is a list of field names (e.g. "AllowOverwrite") 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. "AllowOverwrite") 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:"-"`}

BulkRestoreObjectsRequest: A bulk restore objects request.

func (BulkRestoreObjectsRequest)MarshalJSONadded inv0.141.0

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

typeChannel

type Channel struct {// Address: The address where notifications are delivered for this channel.Addressstring `json:"address,omitempty"`// Expiration: Date and time of notification channel expiration, expressed as a// Unix timestamp, in milliseconds. Optional.Expirationint64 `json:"expiration,omitempty,string"`// Id: A UUID or similar unique string that identifies this channel.Idstring `json:"id,omitempty"`// Kind: Identifies this as a notification channel used to watch for changes to// a resource, which is "api#channel".Kindstring `json:"kind,omitempty"`// Params: Additional parameters controlling delivery channel behavior.// Optional.Params map[string]string `json:"params,omitempty"`// Payload: A Boolean value to indicate whether payload is wanted. Optional.Payloadbool `json:"payload,omitempty"`// ResourceId: An opaque ID that identifies the resource being watched on this// channel. Stable across different API versions.ResourceIdstring `json:"resourceId,omitempty"`// ResourceUri: A version-specific identifier for the watched resource.ResourceUristring `json:"resourceUri,omitempty"`// Token: An arbitrary string delivered to the target address with each// notification delivered over this channel. Optional.Tokenstring `json:"token,omitempty"`// Type: The type of delivery mechanism used for this channel.Typestring `json:"type,omitempty"`// ServerResponse contains the HTTP response code and headers from the server.googleapi.ServerResponse `json:"-"`// ForceSendFields is a list of field names (e.g. "Address") 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. "Address") 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:"-"`}

Channel: An notification channel used to watch for resource changes.

func (Channel)MarshalJSON

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

typeChannelsService

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

funcNewChannelsService

func NewChannelsService(s *Service) *ChannelsService

func (*ChannelsService)Stop

func (r *ChannelsService) Stop(channel *Channel) *ChannelsStopCall

Stop: Stop watching resources through this channel

typeChannelsStopCall

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

func (*ChannelsStopCall)Context

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

func (*ChannelsStopCall)Do

Do executes the "storage.channels.stop" call.

func (*ChannelsStopCall)Fields

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

func (*ChannelsStopCall)Header

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

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

typeComposeRequest

type ComposeRequest struct {// Destination: Properties of the resulting object.Destination *Object `json:"destination,omitempty"`// Kind: The kind of item this is.Kindstring `json:"kind,omitempty"`// SourceObjects: The list of source objects that will be concatenated into a// single object.SourceObjects []*ComposeRequestSourceObjects `json:"sourceObjects,omitempty"`// ForceSendFields is a list of field names (e.g. "Destination") 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. "Destination") 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:"-"`}

ComposeRequest: A Compose request.

func (ComposeRequest)MarshalJSON

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

typeComposeRequestSourceObjects

type ComposeRequestSourceObjects struct {// Generation: The generation of this object to use as the source.Generationint64 `json:"generation,omitempty,string"`// Name: The source object's name. All source objects must reside in the same// bucket.Namestring `json:"name,omitempty"`// ObjectPreconditions: Conditions that must be met for this operation to// execute.ObjectPreconditions *ComposeRequestSourceObjectsObjectPreconditions `json:"objectPreconditions,omitempty"`// ForceSendFields is a list of field names (e.g. "Generation") 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. "Generation") 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 (ComposeRequestSourceObjects)MarshalJSON

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

typeComposeRequestSourceObjectsObjectPreconditions

type ComposeRequestSourceObjectsObjectPreconditions struct {// IfGenerationMatch: Only perform the composition if the generation of the// source object that would be used matches this value. If this value and a// generation are both specified, they must be the same value or the call will// fail.IfGenerationMatchint64 `json:"ifGenerationMatch,omitempty,string"`// ForceSendFields is a list of field names (e.g. "IfGenerationMatch") 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. "IfGenerationMatch") 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:"-"`}

ComposeRequestSourceObjectsObjectPreconditions: Conditions that must be metfor this operation to execute.

func (ComposeRequestSourceObjectsObjectPreconditions)MarshalJSON

typeDefaultObjectAccessControlsDeleteCall

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

func (*DefaultObjectAccessControlsDeleteCall)Context

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

func (*DefaultObjectAccessControlsDeleteCall)Do

Do executes the "storage.defaultObjectAccessControls.delete" call.

func (*DefaultObjectAccessControlsDeleteCall)Fields

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

func (*DefaultObjectAccessControlsDeleteCall)Header

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

func (*DefaultObjectAccessControlsDeleteCall)UserProject

UserProject sets the optional parameter "userProject": The project to bebilled for this request. Required for Requester Pays buckets.

typeDefaultObjectAccessControlsGetCall

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

func (*DefaultObjectAccessControlsGetCall)Context

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

func (*DefaultObjectAccessControlsGetCall)Do

Do executes the "storage.defaultObjectAccessControls.get" call.Any non-2xx status code is an error. Response headers are in either*ObjectAccessControl.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 (*DefaultObjectAccessControlsGetCall)Fields

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

func (*DefaultObjectAccessControlsGetCall)Header

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

func (*DefaultObjectAccessControlsGetCall)IfNoneMatch

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 (*DefaultObjectAccessControlsGetCall)UserProject

UserProject sets the optional parameter "userProject": The project to bebilled for this request. Required for Requester Pays buckets.

typeDefaultObjectAccessControlsInsertCall

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

func (*DefaultObjectAccessControlsInsertCall)Context

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

func (*DefaultObjectAccessControlsInsertCall)Do

Do executes the "storage.defaultObjectAccessControls.insert" call.Any non-2xx status code is an error. Response headers are in either*ObjectAccessControl.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 (*DefaultObjectAccessControlsInsertCall)Fields

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

func (*DefaultObjectAccessControlsInsertCall)Header

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

func (*DefaultObjectAccessControlsInsertCall)UserProject

UserProject sets the optional parameter "userProject": The project to bebilled for this request. Required for Requester Pays buckets.

typeDefaultObjectAccessControlsListCall

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

func (*DefaultObjectAccessControlsListCall)Context

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

func (*DefaultObjectAccessControlsListCall)Do

Do executes the "storage.defaultObjectAccessControls.list" call.Any non-2xx status code is an error. Response headers are in either*ObjectAccessControls.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 (*DefaultObjectAccessControlsListCall)Fields

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

func (*DefaultObjectAccessControlsListCall)Header

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

func (*DefaultObjectAccessControlsListCall)IfMetagenerationMatch

func (c *DefaultObjectAccessControlsListCall) IfMetagenerationMatch(ifMetagenerationMatchint64) *DefaultObjectAccessControlsListCall

IfMetagenerationMatch sets the optional parameter "ifMetagenerationMatch":If present, only return default ACL listing if the bucket's currentmetageneration matches this value.

func (*DefaultObjectAccessControlsListCall)IfMetagenerationNotMatch

func (c *DefaultObjectAccessControlsListCall) IfMetagenerationNotMatch(ifMetagenerationNotMatchint64) *DefaultObjectAccessControlsListCall

IfMetagenerationNotMatch sets the optional parameter"ifMetagenerationNotMatch": If present, only return default ACL listing ifthe bucket's current metageneration does not match the given value.

func (*DefaultObjectAccessControlsListCall)IfNoneMatch

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 (*DefaultObjectAccessControlsListCall)UserProject

UserProject sets the optional parameter "userProject": The project to bebilled for this request. Required for Requester Pays buckets.

typeDefaultObjectAccessControlsPatchCall

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

func (*DefaultObjectAccessControlsPatchCall)Context

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

func (*DefaultObjectAccessControlsPatchCall)Do

Do executes the "storage.defaultObjectAccessControls.patch" call.Any non-2xx status code is an error. Response headers are in either*ObjectAccessControl.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 (*DefaultObjectAccessControlsPatchCall)Fields

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

func (*DefaultObjectAccessControlsPatchCall)Header

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

func (*DefaultObjectAccessControlsPatchCall)UserProject

UserProject sets the optional parameter "userProject": The project to bebilled for this request. Required for Requester Pays buckets.

typeDefaultObjectAccessControlsService

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

func (*DefaultObjectAccessControlsService)Delete

Delete: Permanently deletes the default object ACL entry for the specifiedentity on the specified bucket.

  • bucket: Name of a bucket.
  • entity: The entity holding the permission. Can be user-userId,user-emailAddress, group-groupId, group-emailAddress, allUsers, orallAuthenticatedUsers.

func (*DefaultObjectAccessControlsService)Get

Get: Returns the default object ACL entry for the specified entity on thespecified bucket.

  • bucket: Name of a bucket.
  • entity: The entity holding the permission. Can be user-userId,user-emailAddress, group-groupId, group-emailAddress, allUsers, orallAuthenticatedUsers.

func (*DefaultObjectAccessControlsService)Insert

Insert: Creates a new default object ACL entry on the specified bucket.

- bucket: Name of a bucket.

func (*DefaultObjectAccessControlsService)List

List: Retrieves default object ACL entries on the specified bucket.

- bucket: Name of a bucket.

func (*DefaultObjectAccessControlsService)Patch

Patch: Patches a default object ACL entry on the specified bucket.

  • bucket: Name of a bucket.
  • entity: The entity holding the permission. Can be user-userId,user-emailAddress, group-groupId, group-emailAddress, allUsers, orallAuthenticatedUsers.

func (*DefaultObjectAccessControlsService)Update

Update: Updates a default object ACL entry on the specified bucket.

  • bucket: Name of a bucket.
  • entity: The entity holding the permission. Can be user-userId,user-emailAddress, group-groupId, group-emailAddress, allUsers, orallAuthenticatedUsers.

typeDefaultObjectAccessControlsUpdateCall

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

func (*DefaultObjectAccessControlsUpdateCall)Context

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

func (*DefaultObjectAccessControlsUpdateCall)Do

Do executes the "storage.defaultObjectAccessControls.update" call.Any non-2xx status code is an error. Response headers are in either*ObjectAccessControl.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 (*DefaultObjectAccessControlsUpdateCall)Fields

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

func (*DefaultObjectAccessControlsUpdateCall)Header

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

func (*DefaultObjectAccessControlsUpdateCall)UserProject

UserProject sets the optional parameter "userProject": The project to bebilled for this request. Required for Requester Pays buckets.

typeExpradded inv0.2.0

type Expr struct {// Description: An optional description of the expression. This is a longer// text which describes the expression, e.g. when hovered over it in a UI.Descriptionstring `json:"description,omitempty"`// Expression: Textual representation of an expression in Common Expression// Language syntax. The application context of the containing message// determines which well-known feature set of CEL is supported.Expressionstring `json:"expression,omitempty"`// Location: An optional string indicating the location of the expression for// error reporting, e.g. a file name and a position in the file.Locationstring `json:"location,omitempty"`// Title: An optional title for the expression, i.e. a short string describing// its purpose. This can be used e.g. in UIs which allow to enter the// expression.Titlestring `json:"title,omitempty"`// ForceSendFields is a list of field names (e.g. "Description") 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. "Description") 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:"-"`}

Expr: Represents an expression text. Example: title: "User account presence"description: "Determines whether the request has a user account" expression:"size(request.user) > 0"

func (Expr)MarshalJSONadded inv0.2.0

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

typeFolderadded inv0.156.0

type Folder struct {// Bucket: The name of the bucket containing this folder.Bucketstring `json:"bucket,omitempty"`// CreateTime: The creation time of the folder inRFC 3339 format.CreateTimestring `json:"createTime,omitempty"`// Id: The ID of the folder, including the bucket name, folder name.Idstring `json:"id,omitempty"`// Kind: The kind of item this is. For folders, this is always storage#folder.Kindstring `json:"kind,omitempty"`// Metageneration: The version of the metadata for this folder. Used for// preconditions and for detecting changes in metadata.Metagenerationint64 `json:"metageneration,omitempty,string"`// Name: The name of the folder. Required if not specified by URL parameter.Namestring `json:"name,omitempty"`// PendingRenameInfo: Only present if the folder is part of an ongoing rename// folder operation. Contains information which can be used to query the// operation status.PendingRenameInfo *FolderPendingRenameInfo `json:"pendingRenameInfo,omitempty"`// SelfLink: The link to this folder.SelfLinkstring `json:"selfLink,omitempty"`// UpdateTime: The modification time of the folder metadata inRFC 3339 format.UpdateTimestring `json:"updateTime,omitempty"`// ServerResponse contains the HTTP response code and headers from the server.googleapi.ServerResponse `json:"-"`// 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:"-"`}

Folder: A folder. Only available in buckets with hierarchical namespaceenabled.

func (Folder)MarshalJSONadded inv0.156.0

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

typeFolderPendingRenameInfoadded inv0.156.0

type FolderPendingRenameInfo struct {// OperationId: The ID of the rename folder operation.OperationIdstring `json:"operationId,omitempty"`// ForceSendFields is a list of field names (e.g. "OperationId") 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. "OperationId") 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:"-"`}

FolderPendingRenameInfo: Only present if the folder is part of an ongoingrename folder operation. Contains information which can be used to query theoperation status.

func (FolderPendingRenameInfo)MarshalJSONadded inv0.156.0

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

typeFoldersadded inv0.156.0

type Folders struct {// Items: The list of items.Items []*Folder `json:"items,omitempty"`// Kind: The kind of item this is. For lists of folders, this is always// storage#folders.Kindstring `json:"kind,omitempty"`// NextPageToken: The continuation token, used to page through large result// sets. Provide this value in a subsequent request to return the next page of// results.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. "Items") 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. "Items") 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:"-"`}

Folders: A list of folders.

func (Folders)MarshalJSONadded inv0.156.0

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

typeFoldersDeleteCalladded inv0.156.0

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

func (*FoldersDeleteCall)Contextadded inv0.156.0

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

func (*FoldersDeleteCall)Doadded inv0.156.0

Do executes the "storage.folders.delete" call.

func (*FoldersDeleteCall)Fieldsadded inv0.156.0

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

func (*FoldersDeleteCall)Headeradded inv0.156.0

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

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

func (*FoldersDeleteCall)IfMetagenerationMatchadded inv0.156.0

func (c *FoldersDeleteCall) IfMetagenerationMatch(ifMetagenerationMatchint64) *FoldersDeleteCall

IfMetagenerationMatch sets the optional parameter "ifMetagenerationMatch":If set, only deletes the folder if its metageneration matches this value.

func (*FoldersDeleteCall)IfMetagenerationNotMatchadded inv0.156.0

func (c *FoldersDeleteCall) IfMetagenerationNotMatch(ifMetagenerationNotMatchint64) *FoldersDeleteCall

IfMetagenerationNotMatch sets the optional parameter"ifMetagenerationNotMatch": If set, only deletes the folder if itsmetageneration does not match this value.

typeFoldersGetCalladded inv0.156.0

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

func (*FoldersGetCall)Contextadded inv0.156.0

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

func (*FoldersGetCall)Doadded inv0.156.0

Do executes the "storage.folders.get" call.Any non-2xx status code is an error. Response headers are in either*Folder.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 (*FoldersGetCall)Fieldsadded inv0.156.0

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

func (*FoldersGetCall)Headeradded inv0.156.0

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

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

func (*FoldersGetCall)IfMetagenerationMatchadded inv0.156.0

func (c *FoldersGetCall) IfMetagenerationMatch(ifMetagenerationMatchint64) *FoldersGetCall

IfMetagenerationMatch sets the optional parameter "ifMetagenerationMatch":Makes the return of the folder metadata conditional on whether the folder'scurrent metageneration matches the given value.

func (*FoldersGetCall)IfMetagenerationNotMatchadded inv0.156.0

func (c *FoldersGetCall) IfMetagenerationNotMatch(ifMetagenerationNotMatchint64) *FoldersGetCall

IfMetagenerationNotMatch sets the optional parameter"ifMetagenerationNotMatch": Makes the return of the folder metadataconditional on whether the folder's current metageneration does not matchthe given value.

func (*FoldersGetCall)IfNoneMatchadded inv0.156.0

func (c *FoldersGetCall) IfNoneMatch(entityTagstring) *FoldersGetCall

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.

typeFoldersInsertCalladded inv0.156.0

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

func (*FoldersInsertCall)Contextadded inv0.156.0

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

func (*FoldersInsertCall)Doadded inv0.156.0

Do executes the "storage.folders.insert" call.Any non-2xx status code is an error. Response headers are in either*Folder.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 (*FoldersInsertCall)Fieldsadded inv0.156.0

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

func (*FoldersInsertCall)Headeradded inv0.156.0

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

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

func (*FoldersInsertCall)Recursiveadded inv0.156.0

func (c *FoldersInsertCall) Recursive(recursivebool) *FoldersInsertCall

Recursive sets the optional parameter "recursive": If true, any parentfolder which doesn't exist will be created automatically.

typeFoldersListCalladded inv0.156.0

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

func (*FoldersListCall)Contextadded inv0.156.0

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

func (*FoldersListCall)Delimiteradded inv0.156.0

func (c *FoldersListCall) Delimiter(delimiterstring) *FoldersListCall

Delimiter sets the optional parameter "delimiter": Returns results in adirectory-like mode. The only supported value is '/'. If set, items willonly contain folders that either exactly match the prefix, or are one levelbelow the prefix.

func (*FoldersListCall)Doadded inv0.156.0

Do executes the "storage.folders.list" call.Any non-2xx status code is an error. Response headers are in either*Folders.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 (*FoldersListCall)EndOffsetadded inv0.156.0

func (c *FoldersListCall) EndOffset(endOffsetstring) *FoldersListCall

EndOffset sets the optional parameter "endOffset": Filter results to folderswhose names are lexicographically before endOffset. If startOffset is alsoset, the folders listed will have names between startOffset (inclusive) andendOffset (exclusive).

func (*FoldersListCall)Fieldsadded inv0.156.0

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

func (*FoldersListCall)Headeradded inv0.156.0

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

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

func (*FoldersListCall)IfNoneMatchadded inv0.156.0

func (c *FoldersListCall) IfNoneMatch(entityTagstring) *FoldersListCall

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 (*FoldersListCall)PageSizeadded inv0.156.0

func (c *FoldersListCall) PageSize(pageSizeint64) *FoldersListCall

PageSize sets the optional parameter "pageSize": Maximum number of items toreturn in a single page of responses.

func (*FoldersListCall)PageTokenadded inv0.156.0

func (c *FoldersListCall) PageToken(pageTokenstring) *FoldersListCall

PageToken sets the optional parameter "pageToken": A previously-returnedpage token representing part of the larger set of results to view.

func (*FoldersListCall)Pagesadded inv0.156.0

func (c *FoldersListCall) Pages(ctxcontext.Context, f func(*Folders)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 (*FoldersListCall)Prefixadded inv0.156.0

func (c *FoldersListCall) Prefix(prefixstring) *FoldersListCall

Prefix sets the optional parameter "prefix": Filter results to folders whosepaths begin with this prefix. If set, the value must either be an emptystring or end with a '/'.

func (*FoldersListCall)StartOffsetadded inv0.156.0

func (c *FoldersListCall) StartOffset(startOffsetstring) *FoldersListCall

StartOffset sets the optional parameter "startOffset": Filter results tofolders whose names are lexicographically equal to or after startOffset. IfendOffset is also set, the folders listed will have names betweenstartOffset (inclusive) and endOffset (exclusive).

typeFoldersRenameCalladded inv0.156.0

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

func (*FoldersRenameCall)Contextadded inv0.156.0

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

func (*FoldersRenameCall)Doadded inv0.156.0

Do executes the "storage.folders.rename" call.Any non-2xx status code is an error. Response headers are in either*GoogleLongrunningOperation.ServerResponse.Header or (if a response wasreturned at all) in error.(*googleapi.Error).Header. Usegoogleapi.IsNotModified to check whether the returned error was becausehttp.StatusNotModified was returned.

func (*FoldersRenameCall)Fieldsadded inv0.156.0

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

func (*FoldersRenameCall)Headeradded inv0.156.0

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

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

func (*FoldersRenameCall)IfSourceMetagenerationMatchadded inv0.156.0

func (c *FoldersRenameCall) IfSourceMetagenerationMatch(ifSourceMetagenerationMatchint64) *FoldersRenameCall

IfSourceMetagenerationMatch sets the optional parameter"ifSourceMetagenerationMatch": Makes the operation conditional on whetherthe source object's current metageneration matches the given value.

func (*FoldersRenameCall)IfSourceMetagenerationNotMatchadded inv0.156.0

func (c *FoldersRenameCall) IfSourceMetagenerationNotMatch(ifSourceMetagenerationNotMatchint64) *FoldersRenameCall

IfSourceMetagenerationNotMatch sets the optional parameter"ifSourceMetagenerationNotMatch": Makes the operation conditional on whetherthe source object's current metageneration does not match the given value.

typeFoldersServiceadded inv0.156.0

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

funcNewFoldersServiceadded inv0.156.0

func NewFoldersService(s *Service) *FoldersService

func (*FoldersService)Deleteadded inv0.156.0

func (r *FoldersService) Delete(bucketstring, folderstring) *FoldersDeleteCall

Delete: Permanently deletes a folder. Only applicable to buckets withhierarchical namespace enabled.

- bucket: Name of the bucket in which the folder resides.- folder: Name of a folder.

func (*FoldersService)Getadded inv0.156.0

func (r *FoldersService) Get(bucketstring, folderstring) *FoldersGetCall

Get: Returns metadata for the specified folder. Only applicable to bucketswith hierarchical namespace enabled.

- bucket: Name of the bucket in which the folder resides.- folder: Name of a folder.

func (*FoldersService)Insertadded inv0.156.0

func (r *FoldersService) Insert(bucketstring, folder *Folder) *FoldersInsertCall

Insert: Creates a new folder. Only applicable to buckets with hierarchicalnamespace enabled.

- bucket: Name of the bucket in which the folder resides.

func (*FoldersService)Listadded inv0.156.0

func (r *FoldersService) List(bucketstring) *FoldersListCall

List: Retrieves a list of folders matching the criteria. Only applicable tobuckets with hierarchical namespace enabled.

- bucket: Name of the bucket in which to look for folders.

func (*FoldersService)Renameadded inv0.156.0

func (r *FoldersService) Rename(bucketstring, sourceFolderstring, destinationFolderstring) *FoldersRenameCall

Rename: Renames a source folder to a destination folder. Only applicable tobuckets with hierarchical namespace enabled.

- bucket: Name of the bucket in which the folders are in.- destinationFolder: Name of the destination folder.- sourceFolder: Name of the source folder.

typeGoogleLongrunningListOperationsResponseadded inv0.141.0

type GoogleLongrunningListOperationsResponse struct {// Kind: The kind of item this is. For lists of operations, this is always// storage#operations.Kindstring `json:"kind,omitempty"`// NextPageToken: The continuation token, used to page through large result// sets. Provide this value in a subsequent request to return the next page of// results.NextPageTokenstring `json:"nextPageToken,omitempty"`// Operations: A list of operations that matches the specified filter in the// request.Operations []*GoogleLongrunningOperation `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. "Kind") 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. "Kind") 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:"-"`}

GoogleLongrunningListOperationsResponse: The response message forstorage.buckets.operations.list.

func (GoogleLongrunningListOperationsResponse)MarshalJSONadded inv0.141.0

typeGoogleLongrunningOperationadded inv0.141.0

type GoogleLongrunningOperation 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 *GoogleRpcStatus `json:"error,omitempty"`// Kind: The kind of item this is. For operations, this is always// storage#operation.Kindstring `json:"kind,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/{operationId}".Namestring `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".Responsegoogleapi.RawMessage `json:"response,omitempty"`// SelfLink: The link to this long running operation.SelfLinkstring `json:"selfLink,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:"-"`}

GoogleLongrunningOperation: This resource represents a long-runningoperation that is the result of a network API call.

func (GoogleLongrunningOperation)MarshalJSONadded inv0.141.0

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

typeGoogleRpcStatusadded inv0.141.0

type GoogleRpcStatus 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.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:"-"`}

GoogleRpcStatus: The "Status" type defines a logical error model that issuitable for different programming environments, including REST APIs and RPCAPIs. It is used by gRPC (https://github.com/grpc). Each "Status" messagecontains 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 theAPI Design Guide (https://cloud.google.com/apis/design/errors).

func (GoogleRpcStatus)MarshalJSONadded inv0.141.0

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

typeHmacKeyadded inv0.4.0

type HmacKey struct {// Kind: The kind of item this is. For HMAC keys, this is always// storage#hmacKey.Kindstring `json:"kind,omitempty"`// Metadata: Key metadata.Metadata *HmacKeyMetadata `json:"metadata,omitempty"`// Secret: HMAC secret key material.Secretstring `json:"secret,omitempty"`// ServerResponse contains the HTTP response code and headers from the server.googleapi.ServerResponse `json:"-"`// ForceSendFields is a list of field names (e.g. "Kind") 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. "Kind") 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:"-"`}

HmacKey: JSON template to produce a JSON-style HMAC Key resource for Createresponses.

func (HmacKey)MarshalJSONadded inv0.4.0

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

typeHmacKeyMetadataadded inv0.4.0

type HmacKeyMetadata struct {// AccessId: The ID of the HMAC Key.AccessIdstring `json:"accessId,omitempty"`// Etag: HTTP 1.1 Entity tag for the HMAC key.Etagstring `json:"etag,omitempty"`// Id: The ID of the HMAC key, including the Project ID and the Access ID.Idstring `json:"id,omitempty"`// Kind: The kind of item this is. For HMAC Key metadata, this is always// storage#hmacKeyMetadata.Kindstring `json:"kind,omitempty"`// ProjectId: Project ID owning the service account to which the key// authenticates.ProjectIdstring `json:"projectId,omitempty"`// SelfLink: The link to this resource.SelfLinkstring `json:"selfLink,omitempty"`// ServiceAccountEmail: The email address of the key's associated service// account.ServiceAccountEmailstring `json:"serviceAccountEmail,omitempty"`// State: The state of the key. Can be one of ACTIVE, INACTIVE, or DELETED.Statestring `json:"state,omitempty"`// TimeCreated: The creation time of the HMAC key inRFC 3339 format.TimeCreatedstring `json:"timeCreated,omitempty"`// Updated: The last modification time of the HMAC key metadata inRFC 3339// format.Updatedstring `json:"updated,omitempty"`// ServerResponse contains the HTTP response code and headers from the server.googleapi.ServerResponse `json:"-"`// ForceSendFields is a list of field names (e.g. "AccessId") 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. "AccessId") 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:"-"`}

HmacKeyMetadata: JSON template to produce a JSON-style HMAC Key metadataresource.

func (HmacKeyMetadata)MarshalJSONadded inv0.4.0

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

typeHmacKeysMetadataadded inv0.4.0

type HmacKeysMetadata struct {// Items: The list of items.Items []*HmacKeyMetadata `json:"items,omitempty"`// Kind: The kind of item this is. For lists of hmacKeys, this is always// storage#hmacKeysMetadata.Kindstring `json:"kind,omitempty"`// NextPageToken: The continuation token, used to page through large result// sets. Provide this value in a subsequent request to return the next page of// results.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. "Items") 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. "Items") 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:"-"`}

HmacKeysMetadata: A list of hmacKeys.

func (HmacKeysMetadata)MarshalJSONadded inv0.4.0

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

typeManagedFolderadded inv0.148.0

type ManagedFolder struct {// Bucket: The name of the bucket containing this managed folder.Bucketstring `json:"bucket,omitempty"`// CreateTime: The creation time of the managed folder inRFC 3339 format.CreateTimestring `json:"createTime,omitempty"`// Id: The ID of the managed folder, including the bucket name and managed// folder name.Idstring `json:"id,omitempty"`// Kind: The kind of item this is. For managed folders, this is always// storage#managedFolder.Kindstring `json:"kind,omitempty"`// Metageneration: The version of the metadata for this managed folder. Used// for preconditions and for detecting changes in metadata.Metagenerationint64 `json:"metageneration,omitempty,string"`// Name: The name of the managed folder. Required if not specified by URL// parameter.Namestring `json:"name,omitempty"`// SelfLink: The link to this managed folder.SelfLinkstring `json:"selfLink,omitempty"`// UpdateTime: The last update time of the managed folder metadata inRFC 3339// format.UpdateTimestring `json:"updateTime,omitempty"`// ServerResponse contains the HTTP response code and headers from the server.googleapi.ServerResponse `json:"-"`// 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:"-"`}

ManagedFolder: A managed folder.

func (ManagedFolder)MarshalJSONadded inv0.148.0

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

typeManagedFoldersadded inv0.148.0

type ManagedFolders struct {// Items: The list of items.Items []*ManagedFolder `json:"items,omitempty"`// Kind: The kind of item this is. For lists of managed folders, this is always// storage#managedFolders.Kindstring `json:"kind,omitempty"`// NextPageToken: The continuation token, used to page through large result// sets. Provide this value in a subsequent request to return the next page of// results.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. "Items") 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. "Items") 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:"-"`}

ManagedFolders: A list of managed folders.

func (ManagedFolders)MarshalJSONadded inv0.148.0

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

typeManagedFoldersDeleteCalladded inv0.148.0

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

func (*ManagedFoldersDeleteCall)AllowNonEmptyadded inv0.163.0

func (c *ManagedFoldersDeleteCall) AllowNonEmpty(allowNonEmptybool) *ManagedFoldersDeleteCall

AllowNonEmpty sets the optional parameter "allowNonEmpty": Allows thedeletion of a managed folder even if it is not empty. A managed folder isempty if there are no objects or managed folders that it applies to. Callersmust have storage.managedFolders.setIamPolicy permission.

func (*ManagedFoldersDeleteCall)Contextadded inv0.148.0

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

func (*ManagedFoldersDeleteCall)Doadded inv0.148.0

Do executes the "storage.managedFolders.delete" call.

func (*ManagedFoldersDeleteCall)Fieldsadded inv0.148.0

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

func (*ManagedFoldersDeleteCall)Headeradded inv0.148.0

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

func (*ManagedFoldersDeleteCall)IfMetagenerationMatchadded inv0.148.0

func (c *ManagedFoldersDeleteCall) IfMetagenerationMatch(ifMetagenerationMatchint64) *ManagedFoldersDeleteCall

IfMetagenerationMatch sets the optional parameter "ifMetagenerationMatch":If set, only deletes the managed folder if its metageneration matches thisvalue.

func (*ManagedFoldersDeleteCall)IfMetagenerationNotMatchadded inv0.148.0

func (c *ManagedFoldersDeleteCall) IfMetagenerationNotMatch(ifMetagenerationNotMatchint64) *ManagedFoldersDeleteCall

IfMetagenerationNotMatch sets the optional parameter"ifMetagenerationNotMatch": If set, only deletes the managed folder if itsmetageneration does not match this value.

typeManagedFoldersGetCalladded inv0.148.0

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

func (*ManagedFoldersGetCall)Contextadded inv0.148.0

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

func (*ManagedFoldersGetCall)Doadded inv0.148.0

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

func (*ManagedFoldersGetCall)Fieldsadded inv0.148.0

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

func (*ManagedFoldersGetCall)Headeradded inv0.148.0

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

func (*ManagedFoldersGetCall)IfMetagenerationMatchadded inv0.148.0

func (c *ManagedFoldersGetCall) IfMetagenerationMatch(ifMetagenerationMatchint64) *ManagedFoldersGetCall

IfMetagenerationMatch sets the optional parameter "ifMetagenerationMatch":Makes the return of the managed folder metadata conditional on whether themanaged folder's current metageneration matches the given value.

func (*ManagedFoldersGetCall)IfMetagenerationNotMatchadded inv0.148.0

func (c *ManagedFoldersGetCall) IfMetagenerationNotMatch(ifMetagenerationNotMatchint64) *ManagedFoldersGetCall

IfMetagenerationNotMatch sets the optional parameter"ifMetagenerationNotMatch": Makes the return of the managed folder metadataconditional on whether the managed folder's current metageneration does notmatch the given value.

func (*ManagedFoldersGetCall)IfNoneMatchadded inv0.148.0

func (c *ManagedFoldersGetCall) IfNoneMatch(entityTagstring) *ManagedFoldersGetCall

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.

typeManagedFoldersGetIamPolicyCalladded inv0.148.0

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

func (*ManagedFoldersGetIamPolicyCall)Contextadded inv0.148.0

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

func (*ManagedFoldersGetIamPolicyCall)Doadded inv0.148.0

Do executes the "storage.managedFolders.getIamPolicy" call.Any non-2xx status code is an error. Response headers are in either*Policy.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 (*ManagedFoldersGetIamPolicyCall)Fieldsadded inv0.148.0

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

func (*ManagedFoldersGetIamPolicyCall)Headeradded inv0.148.0

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

func (*ManagedFoldersGetIamPolicyCall)IfNoneMatchadded inv0.148.0

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 (*ManagedFoldersGetIamPolicyCall)OptionsRequestedPolicyVersionadded inv0.148.0

func (c *ManagedFoldersGetIamPolicyCall) OptionsRequestedPolicyVersion(optionsRequestedPolicyVersionint64) *ManagedFoldersGetIamPolicyCall

OptionsRequestedPolicyVersion sets the optional parameter"optionsRequestedPolicyVersion": The IAM policy format version to bereturned. If the optionsRequestedPolicyVersion is for an older version thatdoesn't support part of the requested IAM policy, the request fails.

func (*ManagedFoldersGetIamPolicyCall)UserProjectadded inv0.148.0

UserProject sets the optional parameter "userProject": The project to bebilled for this request. Required for Requester Pays buckets.

typeManagedFoldersInsertCalladded inv0.148.0

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

func (*ManagedFoldersInsertCall)Contextadded inv0.148.0

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

func (*ManagedFoldersInsertCall)Doadded inv0.148.0

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

func (*ManagedFoldersInsertCall)Fieldsadded inv0.148.0

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

func (*ManagedFoldersInsertCall)Headeradded inv0.148.0

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

typeManagedFoldersListCalladded inv0.148.0

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

func (*ManagedFoldersListCall)Contextadded inv0.148.0

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

func (*ManagedFoldersListCall)Doadded inv0.148.0

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

func (*ManagedFoldersListCall)Fieldsadded inv0.148.0

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

func (*ManagedFoldersListCall)Headeradded inv0.148.0

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

func (*ManagedFoldersListCall)IfNoneMatchadded inv0.148.0

func (c *ManagedFoldersListCall) IfNoneMatch(entityTagstring) *ManagedFoldersListCall

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 (*ManagedFoldersListCall)PageSizeadded inv0.148.0

PageSize sets the optional parameter "pageSize": Maximum number of items toreturn in a single page of responses.

func (*ManagedFoldersListCall)PageTokenadded inv0.148.0

PageToken sets the optional parameter "pageToken": A previously-returnedpage token representing part of the larger set of results to view.

func (*ManagedFoldersListCall)Pagesadded inv0.148.0

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 (*ManagedFoldersListCall)Prefixadded inv0.148.0

Prefix sets the optional parameter "prefix": The managed folder name/pathprefix to filter the output list of results.

typeManagedFoldersServiceadded inv0.148.0

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

funcNewManagedFoldersServiceadded inv0.148.0

func NewManagedFoldersService(s *Service) *ManagedFoldersService

func (*ManagedFoldersService)Deleteadded inv0.148.0

func (r *ManagedFoldersService) Delete(bucketstring, managedFolderstring) *ManagedFoldersDeleteCall

Delete: Permanently deletes a managed folder.

- bucket: Name of the bucket containing the managed folder.- managedFolder: The managed folder name/path.

func (*ManagedFoldersService)Getadded inv0.148.0

func (r *ManagedFoldersService) Get(bucketstring, managedFolderstring) *ManagedFoldersGetCall

Get: Returns metadata of the specified managed folder.

- bucket: Name of the bucket containing the managed folder.- managedFolder: The managed folder name/path.

func (*ManagedFoldersService)GetIamPolicyadded inv0.148.0

func (r *ManagedFoldersService) GetIamPolicy(bucketstring, managedFolderstring) *ManagedFoldersGetIamPolicyCall

GetIamPolicy: Returns an IAM policy for the specified managed folder.

- bucket: Name of the bucket containing the managed folder.- managedFolder: The managed folder name/path.

func (*ManagedFoldersService)Insertadded inv0.148.0

func (r *ManagedFoldersService) Insert(bucketstring, managedfolder *ManagedFolder) *ManagedFoldersInsertCall

Insert: Creates a new managed folder.

- bucket: Name of the bucket containing the managed folder.

func (*ManagedFoldersService)Listadded inv0.148.0

List: Lists managed folders in the given bucket.

- bucket: Name of the bucket containing the managed folder.

func (*ManagedFoldersService)SetIamPolicyadded inv0.148.0

func (r *ManagedFoldersService) SetIamPolicy(bucketstring, managedFolderstring, policy *Policy) *ManagedFoldersSetIamPolicyCall

SetIamPolicy: Updates an IAM policy for the specified managed folder.

- bucket: Name of the bucket containing the managed folder.- managedFolder: The managed folder name/path.

func (*ManagedFoldersService)TestIamPermissionsadded inv0.148.0

func (r *ManagedFoldersService) TestIamPermissions(bucketstring, managedFolderstring, permissions []string) *ManagedFoldersTestIamPermissionsCall

TestIamPermissions: Tests a set of permissions on the given managed folderto see which, if any, are held by the caller.

- bucket: Name of the bucket containing the managed folder.- managedFolder: The managed folder name/path.- permissions: Permissions to test.

typeManagedFoldersSetIamPolicyCalladded inv0.148.0

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

func (*ManagedFoldersSetIamPolicyCall)Contextadded inv0.148.0

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

func (*ManagedFoldersSetIamPolicyCall)Doadded inv0.148.0

Do executes the "storage.managedFolders.setIamPolicy" call.Any non-2xx status code is an error. Response headers are in either*Policy.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 (*ManagedFoldersSetIamPolicyCall)Fieldsadded inv0.148.0

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

func (*ManagedFoldersSetIamPolicyCall)Headeradded inv0.148.0

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

func (*ManagedFoldersSetIamPolicyCall)UserProjectadded inv0.148.0

UserProject sets the optional parameter "userProject": The project to bebilled for this request. Required for Requester Pays buckets.

typeManagedFoldersTestIamPermissionsCalladded inv0.148.0

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

func (*ManagedFoldersTestIamPermissionsCall)Contextadded inv0.148.0

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

func (*ManagedFoldersTestIamPermissionsCall)Doadded inv0.148.0

Do executes the "storage.managedFolders.testIamPermissions" call.Any non-2xx status code is an error. Response headers are in either*TestIamPermissionsResponse.ServerResponse.Header or (if a response wasreturned at all) in error.(*googleapi.Error).Header. Usegoogleapi.IsNotModified to check whether the returned error was becausehttp.StatusNotModified was returned.

func (*ManagedFoldersTestIamPermissionsCall)Fieldsadded inv0.148.0

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

func (*ManagedFoldersTestIamPermissionsCall)Headeradded inv0.148.0

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

func (*ManagedFoldersTestIamPermissionsCall)IfNoneMatchadded inv0.148.0

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 (*ManagedFoldersTestIamPermissionsCall)UserProjectadded inv0.148.0

UserProject sets the optional parameter "userProject": The project to bebilled for this request. Required for Requester Pays buckets.

typeNotification

type Notification struct {// CustomAttributes: An optional list of additional attributes to attach to// each Cloud PubSub message published for this notification subscription.CustomAttributes map[string]string `json:"custom_attributes,omitempty"`// Etag: HTTP 1.1 Entity tag for this subscription notification.Etagstring `json:"etag,omitempty"`// EventTypes: If present, only send notifications about listed event types. If// empty, sent notifications for all event types.EventTypes []string `json:"event_types,omitempty"`// Id: The ID of the notification.Idstring `json:"id,omitempty"`// Kind: The kind of item this is. For notifications, this is always// storage#notification.Kindstring `json:"kind,omitempty"`// ObjectNamePrefix: If present, only apply this notification configuration to// object names that begin with this prefix.ObjectNamePrefixstring `json:"object_name_prefix,omitempty"`// PayloadFormat: The desired content of the Payload.PayloadFormatstring `json:"payload_format,omitempty"`// SelfLink: The canonical URL of this notification.SelfLinkstring `json:"selfLink,omitempty"`// Topic: The Cloud PubSub topic to which this subscription publishes.// Formatted as:// '//pubsub.googleapis.com/projects/{project-identifier}/topics/{my-topic}'Topicstring `json:"topic,omitempty"`// ServerResponse contains the HTTP response code and headers from the server.googleapi.ServerResponse `json:"-"`// ForceSendFields is a list of field names (e.g. "CustomAttributes") 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. "CustomAttributes") 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:"-"`}

Notification: A subscription to receive Google PubSub notifications.

func (Notification)MarshalJSON

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

typeNotifications

type Notifications struct {// Items: The list of items.Items []*Notification `json:"items,omitempty"`// Kind: The kind of item this is. For lists of notifications, this is always// storage#notifications.Kindstring `json:"kind,omitempty"`// ServerResponse contains the HTTP response code and headers from the server.googleapi.ServerResponse `json:"-"`// ForceSendFields is a list of field names (e.g. "Items") 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. "Items") 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:"-"`}

Notifications: A list of notification subscriptions.

func (Notifications)MarshalJSON

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

typeNotificationsDeleteCall

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

func (*NotificationsDeleteCall)Context

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

func (*NotificationsDeleteCall)Do

Do executes the "storage.notifications.delete" call.

func (*NotificationsDeleteCall)Fields

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

func (*NotificationsDeleteCall)Header

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

func (*NotificationsDeleteCall)UserProject

func (c *NotificationsDeleteCall) UserProject(userProjectstring) *NotificationsDeleteCall

UserProject sets the optional parameter "userProject": The project to bebilled for this request. Required for Requester Pays buckets.

typeNotificationsGetCall

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

func (*NotificationsGetCall)Context

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

func (*NotificationsGetCall)Do

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

func (*NotificationsGetCall)Fields

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

func (*NotificationsGetCall)Header

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

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

func (*NotificationsGetCall)IfNoneMatch

func (c *NotificationsGetCall) IfNoneMatch(entityTagstring) *NotificationsGetCall

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 (*NotificationsGetCall)UserProject

func (c *NotificationsGetCall) UserProject(userProjectstring) *NotificationsGetCall

UserProject sets the optional parameter "userProject": The project to bebilled for this request. Required for Requester Pays buckets.

typeNotificationsInsertCall

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

func (*NotificationsInsertCall)Context

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

func (*NotificationsInsertCall)Do

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

func (*NotificationsInsertCall)Fields

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

func (*NotificationsInsertCall)Header

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

func (*NotificationsInsertCall)UserProject

func (c *NotificationsInsertCall) UserProject(userProjectstring) *NotificationsInsertCall

UserProject sets the optional parameter "userProject": The project to bebilled for this request. Required for Requester Pays buckets.

typeNotificationsListCall

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

func (*NotificationsListCall)Context

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

func (*NotificationsListCall)Do

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

func (*NotificationsListCall)Fields

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

func (*NotificationsListCall)Header

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

func (*NotificationsListCall)IfNoneMatch

func (c *NotificationsListCall) IfNoneMatch(entityTagstring) *NotificationsListCall

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 (*NotificationsListCall)UserProject

func (c *NotificationsListCall) UserProject(userProjectstring) *NotificationsListCall

UserProject sets the optional parameter "userProject": The project to bebilled for this request. Required for Requester Pays buckets.

typeNotificationsService

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

funcNewNotificationsService

func NewNotificationsService(s *Service) *NotificationsService

func (*NotificationsService)Delete

func (r *NotificationsService) Delete(bucketstring, notificationstring) *NotificationsDeleteCall

Delete: Permanently deletes a notification subscription.

- bucket: The parent bucket of the notification.- notification: ID of the notification to delete.

func (*NotificationsService)Get

func (r *NotificationsService) Get(bucketstring, notificationstring) *NotificationsGetCall

Get: View a notification configuration.

- bucket: The parent bucket of the notification.- notification: Notification ID.

func (*NotificationsService)Insert

func (r *NotificationsService) Insert(bucketstring, notification *Notification) *NotificationsInsertCall

Insert: Creates a notification subscription for a given bucket.

- bucket: The parent bucket of the notification.

func (*NotificationsService)List

List: Retrieves a list of notification subscriptions for a given bucket.

- bucket: Name of a Google Cloud Storage bucket.

typeObject

type Object struct {// Acl: Access controls on the object.Acl []*ObjectAccessControl `json:"acl,omitempty"`// Bucket: The name of the bucket containing this object.Bucketstring `json:"bucket,omitempty"`// CacheControl: Cache-Control directive for the object data. If omitted, and// the object is accessible to all anonymous users, the default will be public,// max-age=3600.CacheControlstring `json:"cacheControl,omitempty"`// ComponentCount: Number of underlying components that make up this object.// Components are accumulated by compose operations.ComponentCountint64 `json:"componentCount,omitempty"`// ContentDisposition: Content-Disposition of the object data.ContentDispositionstring `json:"contentDisposition,omitempty"`// ContentEncoding: Content-Encoding of the object data.ContentEncodingstring `json:"contentEncoding,omitempty"`// ContentLanguage: Content-Language of the object data.ContentLanguagestring `json:"contentLanguage,omitempty"`// ContentType: Content-Type of the object data. If an object is stored without// a Content-Type, it is served as application/octet-stream.ContentTypestring `json:"contentType,omitempty"`// Contexts: User-defined or system-defined object contexts. Each object// context is a key-payload pair, where the key provides the identification and// the payload holds the associated value and additional metadata.Contexts *ObjectContexts `json:"contexts,omitempty"`// Crc32c: CRC32c checksum, as described inRFC 4960, Appendix B; encoded using// base64 in big-endian byte order. For more information about using the CRC32c// checksum, see Data Validation and Change Detection// (https://cloud.google.com/storage/docs/data-validation).Crc32cstring `json:"crc32c,omitempty"`// CustomTime: A timestamp inRFC 3339 format specified by the user for an// object.CustomTimestring `json:"customTime,omitempty"`// CustomerEncryption: Metadata of customer-supplied encryption key, if the// object is encrypted by such a key.CustomerEncryption *ObjectCustomerEncryption `json:"customerEncryption,omitempty"`// Etag: HTTP 1.1 Entity tag for the object.Etagstring `json:"etag,omitempty"`// EventBasedHold: Whether an object is under event-based hold. Event-based// hold is a way to retain objects until an event occurs, which is signified by// the hold's release (i.e. this value is set to false). After being released// (set to false), such objects will be subject to bucket-level retention (if// any). One sample use case of this flag is for banks to hold loan documents// for at least 3 years after loan is paid in full. Here, bucket-level// retention is 3 years and the event is the loan being paid in full. In this// example, these objects will be held intact for any number of years until the// event has occurred (event-based hold on the object is released) and then 3// more years after that. That means retention duration of the objects begins// from the moment event-based hold transitioned from true to false.EventBasedHoldbool `json:"eventBasedHold,omitempty"`// Generation: The content generation of this object. Used for object// versioning.Generationint64 `json:"generation,omitempty,string"`// HardDeleteTime: This is the time (in the future) when the soft-deleted// object will no longer be restorable. It is equal to the soft delete time// plus the current soft delete retention duration of the bucket.HardDeleteTimestring `json:"hardDeleteTime,omitempty"`// Id: The ID of the object, including the bucket name, object name, and// generation number.Idstring `json:"id,omitempty"`// Kind: The kind of item this is. For objects, this is always storage#object.Kindstring `json:"kind,omitempty"`// KmsKeyName: Not currently supported. Specifying the parameter causes the// request to fail with status code 400 - Bad Request.KmsKeyNamestring `json:"kmsKeyName,omitempty"`// Md5Hash: MD5 hash of the data; encoded using base64. For more information// about using the MD5 hash, see Data Validation and Change Detection// (https://cloud.google.com/storage/docs/data-validation).Md5Hashstring `json:"md5Hash,omitempty"`// MediaLink: Media download link.MediaLinkstring `json:"mediaLink,omitempty"`// Metadata: User-provided metadata, in key/value pairs.Metadata map[string]string `json:"metadata,omitempty"`// Metageneration: The version of the metadata for this object at this// generation. Used for preconditions and for detecting changes in metadata. A// metageneration number is only meaningful in the context of a particular// generation of a particular object.Metagenerationint64 `json:"metageneration,omitempty,string"`// Name: The name of the object. Required if not specified by URL parameter.Namestring `json:"name,omitempty"`// Owner: The owner of the object. This will always be the uploader of the// object.Owner *ObjectOwner `json:"owner,omitempty"`// RestoreToken: Restore token used to differentiate deleted objects with the// same name and generation. This field is only returned for deleted objects in// hierarchical namespace buckets.RestoreTokenstring `json:"restoreToken,omitempty"`// Retention: A collection of object level retention parameters.Retention *ObjectRetention `json:"retention,omitempty"`// RetentionExpirationTime: A server-determined value that specifies the// earliest time that the object's retention period expires. This value is in//RFC 3339 format. Note 1: This field is not provided for objects with an// active event-based hold, since retention expiration is unknown until the// hold is removed. Note 2: This value can be provided even when temporary hold// is set (so that the user can reason about policy without having to first// unset the temporary hold).RetentionExpirationTimestring `json:"retentionExpirationTime,omitempty"`// SelfLink: The link to this object.SelfLinkstring `json:"selfLink,omitempty"`// Size: Content-Length of the data in bytes.Sizeuint64 `json:"size,omitempty,string"`// SoftDeleteTime: The time at which the object became soft-deleted inRFC 3339// format.SoftDeleteTimestring `json:"softDeleteTime,omitempty"`// StorageClass: Storage class of the object.StorageClassstring `json:"storageClass,omitempty"`// TemporaryHold: Whether an object is under temporary hold. While this flag is// set to true, the object is protected against deletion and overwrites. A// common use case of this flag is regulatory investigations where objects need// to be retained while the investigation is ongoing. Note that unlike// event-based hold, temporary hold does not impact retention expiration time// of an object.TemporaryHoldbool `json:"temporaryHold,omitempty"`// TimeCreated: The creation time of the object inRFC 3339 format.TimeCreatedstring `json:"timeCreated,omitempty"`// TimeDeleted: The time at which the object became noncurrent inRFC 3339// format. Will be returned if and only if this version of the object has been// deleted.TimeDeletedstring `json:"timeDeleted,omitempty"`// TimeFinalized: The time when the object was finalized.TimeFinalizedstring `json:"timeFinalized,omitempty"`// TimeStorageClassUpdated: The time at which the object's storage class was// last changed. When the object is initially created, it will be set to// timeCreated.TimeStorageClassUpdatedstring `json:"timeStorageClassUpdated,omitempty"`// Updated: The modification time of the object metadata inRFC 3339 format.// Set initially to object creation time and then updated whenever any metadata// of the object changes. This includes changes made by a requester, such as// modifying custom metadata, as well as changes made by Cloud Storage on// behalf of a requester, such as changing the storage class based on an Object// Lifecycle Configuration.Updatedstring `json:"updated,omitempty"`// ServerResponse contains the HTTP response code and headers from the server.googleapi.ServerResponse `json:"-"`// ForceSendFields is a list of field names (e.g. "Acl") 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. "Acl") 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:"-"`}

Object: An object.

func (Object)MarshalJSON

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

typeObjectAccessControl

type ObjectAccessControl struct {// Bucket: The name of the bucket.Bucketstring `json:"bucket,omitempty"`// Domain: The domain associated with the entity, if any.Domainstring `json:"domain,omitempty"`// Email: The email address associated with the entity, if any.Emailstring `json:"email,omitempty"`// Entity: The entity holding the permission, in one of the following forms:// - user-userId// - user-email// - group-groupId// - group-email// - domain-domain// - project-team-projectId// - allUsers// - allAuthenticatedUsers Examples:// - The user liz@example.com would be user-liz@example.com.// - The group example@googlegroups.com would be// group-example@googlegroups.com.// - To refer to all members of the Google Apps for Business domain// example.com, the entity would be domain-example.com.Entitystring `json:"entity,omitempty"`// EntityId: The ID for the entity, if any.EntityIdstring `json:"entityId,omitempty"`// Etag: HTTP 1.1 Entity tag for the access-control entry.Etagstring `json:"etag,omitempty"`// Generation: The content generation of the object, if applied to an object.Generationint64 `json:"generation,omitempty,string"`// Id: The ID of the access-control entry.Idstring `json:"id,omitempty"`// Kind: The kind of item this is. For object access control entries, this is// always storage#objectAccessControl.Kindstring `json:"kind,omitempty"`// Object: The name of the object, if applied to an object.Objectstring `json:"object,omitempty"`// ProjectTeam: The project team associated with the entity, if any.ProjectTeam *ObjectAccessControlProjectTeam `json:"projectTeam,omitempty"`// Role: The access permission for the entity.Rolestring `json:"role,omitempty"`// SelfLink: The link to this access-control entry.SelfLinkstring `json:"selfLink,omitempty"`// ServerResponse contains the HTTP response code and headers from the server.googleapi.ServerResponse `json:"-"`// 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:"-"`}

ObjectAccessControl: An access-control entry.

func (ObjectAccessControl)MarshalJSON

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

typeObjectAccessControlProjectTeam

type ObjectAccessControlProjectTeam struct {// ProjectNumber: The project number.ProjectNumberstring `json:"projectNumber,omitempty"`// Team: The team.Teamstring `json:"team,omitempty"`// ForceSendFields is a list of field names (e.g. "ProjectNumber") 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. "ProjectNumber") 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:"-"`}

ObjectAccessControlProjectTeam: The project team associated with the entity,if any.

func (ObjectAccessControlProjectTeam)MarshalJSON

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

typeObjectAccessControls

type ObjectAccessControls struct {// Items: The list of items.Items []*ObjectAccessControl `json:"items,omitempty"`// Kind: The kind of item this is. For lists of object access control entries,// this is always storage#objectAccessControls.Kindstring `json:"kind,omitempty"`// ServerResponse contains the HTTP response code and headers from the server.googleapi.ServerResponse `json:"-"`// ForceSendFields is a list of field names (e.g. "Items") 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. "Items") 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:"-"`}

ObjectAccessControls: An access-control list.

func (ObjectAccessControls)MarshalJSON

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

typeObjectAccessControlsDeleteCall

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

func (*ObjectAccessControlsDeleteCall)Context

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

func (*ObjectAccessControlsDeleteCall)Do

Do executes the "storage.objectAccessControls.delete" call.

func (*ObjectAccessControlsDeleteCall)Fields

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

func (*ObjectAccessControlsDeleteCall)Generation

Generation sets the optional parameter "generation": If present, selects aspecific revision of this object (as opposed to the latest version, thedefault).

func (*ObjectAccessControlsDeleteCall)Header

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

func (*ObjectAccessControlsDeleteCall)UserProject

UserProject sets the optional parameter "userProject": The project to bebilled for this request. Required for Requester Pays buckets.

typeObjectAccessControlsGetCall

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

func (*ObjectAccessControlsGetCall)Context

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

func (*ObjectAccessControlsGetCall)Do

Do executes the "storage.objectAccessControls.get" call.Any non-2xx status code is an error. Response headers are in either*ObjectAccessControl.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 (*ObjectAccessControlsGetCall)Fields

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

func (*ObjectAccessControlsGetCall)Generation

Generation sets the optional parameter "generation": If present, selects aspecific revision of this object (as opposed to the latest version, thedefault).

func (*ObjectAccessControlsGetCall)Header

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

func (*ObjectAccessControlsGetCall)IfNoneMatch

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 (*ObjectAccessControlsGetCall)UserProject

UserProject sets the optional parameter "userProject": The project to bebilled for this request. Required for Requester Pays buckets.

typeObjectAccessControlsInsertCall

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

func (*ObjectAccessControlsInsertCall)Context

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

func (*ObjectAccessControlsInsertCall)Do

Do executes the "storage.objectAccessControls.insert" call.Any non-2xx status code is an error. Response headers are in either*ObjectAccessControl.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 (*ObjectAccessControlsInsertCall)Fields

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

func (*ObjectAccessControlsInsertCall)Generation

Generation sets the optional parameter "generation": If present, selects aspecific revision of this object (as opposed to the latest version, thedefault).

func (*ObjectAccessControlsInsertCall)Header

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

func (*ObjectAccessControlsInsertCall)UserProject

UserProject sets the optional parameter "userProject": The project to bebilled for this request. Required for Requester Pays buckets.

typeObjectAccessControlsListCall

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

func (*ObjectAccessControlsListCall)Context

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

func (*ObjectAccessControlsListCall)Do

Do executes the "storage.objectAccessControls.list" call.Any non-2xx status code is an error. Response headers are in either*ObjectAccessControls.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 (*ObjectAccessControlsListCall)Fields

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

func (*ObjectAccessControlsListCall)Generation

Generation sets the optional parameter "generation": If present, selects aspecific revision of this object (as opposed to the latest version, thedefault).

func (*ObjectAccessControlsListCall)Header

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

func (*ObjectAccessControlsListCall)IfNoneMatch

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 (*ObjectAccessControlsListCall)UserProject

UserProject sets the optional parameter "userProject": The project to bebilled for this request. Required for Requester Pays buckets.

typeObjectAccessControlsPatchCall

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

func (*ObjectAccessControlsPatchCall)Context

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

func (*ObjectAccessControlsPatchCall)Do

Do executes the "storage.objectAccessControls.patch" call.Any non-2xx status code is an error. Response headers are in either*ObjectAccessControl.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 (*ObjectAccessControlsPatchCall)Fields

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

func (*ObjectAccessControlsPatchCall)Generation

Generation sets the optional parameter "generation": If present, selects aspecific revision of this object (as opposed to the latest version, thedefault).

func (*ObjectAccessControlsPatchCall)Header

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

func (*ObjectAccessControlsPatchCall)UserProject

UserProject sets the optional parameter "userProject": The project to bebilled for this request. Required for Requester Pays buckets.

typeObjectAccessControlsService

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

funcNewObjectAccessControlsService

func NewObjectAccessControlsService(s *Service) *ObjectAccessControlsService

func (*ObjectAccessControlsService)Delete

Delete: Permanently deletes the ACL entry for the specified entity on thespecified object.

  • bucket: Name of a bucket.
  • entity: The entity holding the permission. Can be user-userId,user-emailAddress, group-groupId, group-emailAddress, allUsers, orallAuthenticatedUsers.
  • object: Name of the object. For information about how to URL encode objectnames to be path safe, see Encoding URI Path Parts(https://cloud.google.com/storage/docs/request-endpoints#encoding).

func (*ObjectAccessControlsService)Get

Get: Returns the ACL entry for the specified entity on the specified object.

  • bucket: Name of a bucket.
  • entity: The entity holding the permission. Can be user-userId,user-emailAddress, group-groupId, group-emailAddress, allUsers, orallAuthenticatedUsers.
  • object: Name of the object. For information about how to URL encode objectnames to be path safe, see Encoding URI Path Parts(https://cloud.google.com/storage/docs/request-endpoints#encoding).

func (*ObjectAccessControlsService)Insert

Insert: Creates a new ACL entry on the specified object.

func (*ObjectAccessControlsService)List

List: Retrieves ACL entries on the specified object.

func (*ObjectAccessControlsService)Patch

func (r *ObjectAccessControlsService) Patch(bucketstring, objectstring, entitystring, objectaccesscontrol *ObjectAccessControl) *ObjectAccessControlsPatchCall

Patch: Patches an ACL entry on the specified object.

  • bucket: Name of a bucket.
  • entity: The entity holding the permission. Can be user-userId,user-emailAddress, group-groupId, group-emailAddress, allUsers, orallAuthenticatedUsers.
  • object: Name of the object. For information about how to URL encode objectnames to be path safe, see Encoding URI Path Parts(https://cloud.google.com/storage/docs/request-endpoints#encoding).

func (*ObjectAccessControlsService)Update

func (r *ObjectAccessControlsService) Update(bucketstring, objectstring, entitystring, objectaccesscontrol *ObjectAccessControl) *ObjectAccessControlsUpdateCall

Update: Updates an ACL entry on the specified object.

  • bucket: Name of a bucket.
  • entity: The entity holding the permission. Can be user-userId,user-emailAddress, group-groupId, group-emailAddress, allUsers, orallAuthenticatedUsers.
  • object: Name of the object. For information about how to URL encode objectnames to be path safe, see Encoding URI Path Parts(https://cloud.google.com/storage/docs/request-endpoints#encoding).

typeObjectAccessControlsUpdateCall

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

func (*ObjectAccessControlsUpdateCall)Context

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

func (*ObjectAccessControlsUpdateCall)Do

Do executes the "storage.objectAccessControls.update" call.Any non-2xx status code is an error. Response headers are in either*ObjectAccessControl.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 (*ObjectAccessControlsUpdateCall)Fields

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

func (*ObjectAccessControlsUpdateCall)Generation

Generation sets the optional parameter "generation": If present, selects aspecific revision of this object (as opposed to the latest version, thedefault).

func (*ObjectAccessControlsUpdateCall)Header

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

func (*ObjectAccessControlsUpdateCall)UserProject

UserProject sets the optional parameter "userProject": The project to bebilled for this request. Required for Requester Pays buckets.

typeObjectContextsadded inv0.241.0

type ObjectContexts struct {// Custom: User-defined object contexts.Custom map[string]ObjectCustomContextPayload `json:"custom,omitempty"`// ForceSendFields is a list of field names (e.g. "Custom") 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. "Custom") 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:"-"`}

ObjectContexts: User-defined or system-defined object contexts. Each objectcontext is a key-payload pair, where the key provides the identification andthe payload holds the associated value and additional metadata.

func (ObjectContexts)MarshalJSONadded inv0.241.0

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

typeObjectCustomContextPayloadadded inv0.241.0

type ObjectCustomContextPayload struct {// CreateTime: The time at which the object context was created inRFC 3339// format.CreateTimestring `json:"createTime,omitempty"`// UpdateTime: The time at which the object context was last updated in RFC// 3339 format.UpdateTimestring `json:"updateTime,omitempty"`// Value: The value of the object context.Valuestring `json:"value,omitempty"`// ForceSendFields is a list of field names (e.g. "CreateTime") 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. "CreateTime") 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:"-"`}

ObjectCustomContextPayload: The payload of a single user-defined objectcontext.

func (ObjectCustomContextPayload)MarshalJSONadded inv0.241.0

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

typeObjectCustomerEncryption

type ObjectCustomerEncryption struct {// EncryptionAlgorithm: The encryption algorithm.EncryptionAlgorithmstring `json:"encryptionAlgorithm,omitempty"`// KeySha256: SHA256 hash value of the encryption key.KeySha256string `json:"keySha256,omitempty"`// ForceSendFields is a list of field names (e.g. "EncryptionAlgorithm") 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. "EncryptionAlgorithm") 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:"-"`}

ObjectCustomerEncryption: Metadata of customer-supplied encryption key, ifthe object is encrypted by such a key.

func (ObjectCustomerEncryption)MarshalJSON

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

typeObjectOwner

type ObjectOwner struct {// Entity: The entity, in the form user-userId.Entitystring `json:"entity,omitempty"`// EntityId: The ID for the entity.EntityIdstring `json:"entityId,omitempty"`// ForceSendFields is a list of field names (e.g. "Entity") 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. "Entity") 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:"-"`}

ObjectOwner: The owner of the object. This will always be the uploader ofthe object.

func (ObjectOwner)MarshalJSON

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

typeObjectRetentionadded inv0.142.0

type ObjectRetention struct {// Mode: The bucket's object retention mode, can only be Unlocked or Locked.Modestring `json:"mode,omitempty"`// RetainUntilTime: A time inRFC 3339 format until which object retention// protects this object.RetainUntilTimestring `json:"retainUntilTime,omitempty"`// ForceSendFields is a list of field names (e.g. "Mode") 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. "Mode") 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:"-"`}

ObjectRetention: A collection of object level retention parameters.

func (ObjectRetention)MarshalJSONadded inv0.142.0

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

typeObjects

type Objects struct {// Items: The list of items.Items []*Object `json:"items,omitempty"`// Kind: The kind of item this is. For lists of objects, this is always// storage#objects.Kindstring `json:"kind,omitempty"`// NextPageToken: The continuation token, used to page through large result// sets. Provide this value in a subsequent request to return the next page of// results.NextPageTokenstring `json:"nextPageToken,omitempty"`// Prefixes: The list of prefixes of objects matching-but-not-listed up to and// including the requested delimiter.Prefixes []string `json:"prefixes,omitempty"`// ServerResponse contains the HTTP response code and headers from the server.googleapi.ServerResponse `json:"-"`// ForceSendFields is a list of field names (e.g. "Items") 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. "Items") 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:"-"`}

Objects: A list of objects.

func (Objects)MarshalJSON

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

typeObjectsBulkRestoreCalladded inv0.141.0

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

func (*ObjectsBulkRestoreCall)Contextadded inv0.141.0

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

func (*ObjectsBulkRestoreCall)Doadded inv0.141.0

Do executes the "storage.objects.bulkRestore" call.Any non-2xx status code is an error. Response headers are in either*GoogleLongrunningOperation.ServerResponse.Header or (if a response wasreturned at all) in error.(*googleapi.Error).Header. Usegoogleapi.IsNotModified to check whether the returned error was becausehttp.StatusNotModified was returned.

func (*ObjectsBulkRestoreCall)Fieldsadded inv0.141.0

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

func (*ObjectsBulkRestoreCall)Headeradded inv0.141.0

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

typeObjectsComposeCall

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

func (*ObjectsComposeCall)Context

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

func (*ObjectsComposeCall)DestinationPredefinedAcl

func (c *ObjectsComposeCall) DestinationPredefinedAcl(destinationPredefinedAclstring) *ObjectsComposeCall

DestinationPredefinedAcl sets the optional parameter"destinationPredefinedAcl": Apply a predefined set of access controls to thedestination object.

Possible values:

"authenticatedRead" - Object owner gets OWNER access, and

allAuthenticatedUsers get READER access.

"bucketOwnerFullControl" - Object owner gets OWNER access, and project

team owners get OWNER access.

"bucketOwnerRead" - Object owner gets OWNER access, and project team

owners get READER access.

"private" - Object owner gets OWNER access."projectPrivate" - Object owner gets OWNER access, and project team

members get access according to their roles.

"publicRead" - Object owner gets OWNER access, and allUsers get READER

access.

func (*ObjectsComposeCall)Do

Do executes the "storage.objects.compose" call.Any non-2xx status code is an error. Response headers are in either*Object.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 (*ObjectsComposeCall)Fields

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

func (*ObjectsComposeCall)Header

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

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

func (*ObjectsComposeCall)IfGenerationMatch

func (c *ObjectsComposeCall) IfGenerationMatch(ifGenerationMatchint64) *ObjectsComposeCall

IfGenerationMatch sets the optional parameter "ifGenerationMatch": Makes theoperation conditional on whether the object's current generation matches thegiven value. Setting to 0 makes the operation succeed only if there are nolive versions of the object.

func (*ObjectsComposeCall)IfMetagenerationMatch

func (c *ObjectsComposeCall) IfMetagenerationMatch(ifMetagenerationMatchint64) *ObjectsComposeCall

IfMetagenerationMatch sets the optional parameter "ifMetagenerationMatch":Makes the operation conditional on whether the object's currentmetageneration matches the given value.

func (*ObjectsComposeCall)KmsKeyName

func (c *ObjectsComposeCall) KmsKeyName(kmsKeyNamestring) *ObjectsComposeCall

KmsKeyName sets the optional parameter "kmsKeyName": Resource name of theCloud KMS key, of the formprojects/my-project/locations/global/keyRings/my-kr/cryptoKeys/my-key, thatwill be used to encrypt the object. Overrides the object metadata'skms_key_name value, if any.

func (*ObjectsComposeCall)UserProject

func (c *ObjectsComposeCall) UserProject(userProjectstring) *ObjectsComposeCall

UserProject sets the optional parameter "userProject": The project to bebilled for this request. Required for Requester Pays buckets.

typeObjectsCopyCall

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

func (*ObjectsCopyCall)Context

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

func (*ObjectsCopyCall)DestinationKmsKeyNameadded inv0.22.0

func (c *ObjectsCopyCall) DestinationKmsKeyName(destinationKmsKeyNamestring) *ObjectsCopyCall

DestinationKmsKeyName sets the optional parameter "destinationKmsKeyName":Resource name of the Cloud KMS key, of the formprojects/my-project/locations/global/keyRings/my-kr/cryptoKeys/my-key, thatwill be used to encrypt the object. Overrides the object metadata'skms_key_name value, if any.

func (*ObjectsCopyCall)DestinationPredefinedAcl

func (c *ObjectsCopyCall) DestinationPredefinedAcl(destinationPredefinedAclstring) *ObjectsCopyCall

DestinationPredefinedAcl sets the optional parameter"destinationPredefinedAcl": Apply a predefined set of access controls to thedestination object.

Possible values:

"authenticatedRead" - Object owner gets OWNER access, and

allAuthenticatedUsers get READER access.

"bucketOwnerFullControl" - Object owner gets OWNER access, and project

team owners get OWNER access.

"bucketOwnerRead" - Object owner gets OWNER access, and project team

owners get READER access.

"private" - Object owner gets OWNER access."projectPrivate" - Object owner gets OWNER access, and project team

members get access according to their roles.

"publicRead" - Object owner gets OWNER access, and allUsers get READER

access.

func (*ObjectsCopyCall)Do

Do executes the "storage.objects.copy" call.Any non-2xx status code is an error. Response headers are in either*Object.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 (*ObjectsCopyCall)Fields

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

func (*ObjectsCopyCall)Header

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

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

func (*ObjectsCopyCall)IfGenerationMatch

func (c *ObjectsCopyCall) IfGenerationMatch(ifGenerationMatchint64) *ObjectsCopyCall

IfGenerationMatch sets the optional parameter "ifGenerationMatch": Makes theoperation conditional on whether the destination object's current generationmatches the given value. Setting to 0 makes the operation succeed only ifthere are no live versions of the object.

func (*ObjectsCopyCall)IfGenerationNotMatch

func (c *ObjectsCopyCall) IfGenerationNotMatch(ifGenerationNotMatchint64) *ObjectsCopyCall

IfGenerationNotMatch sets the optional parameter "ifGenerationNotMatch":Makes the operation conditional on whether the destination object's currentgeneration does not match the given value. If no live object exists, theprecondition fails. Setting to 0 makes the operation succeed only if thereis a live version of the object.

func (*ObjectsCopyCall)IfMetagenerationMatch

func (c *ObjectsCopyCall) IfMetagenerationMatch(ifMetagenerationMatchint64) *ObjectsCopyCall

IfMetagenerationMatch sets the optional parameter "ifMetagenerationMatch":Makes the operation conditional on whether the destination object's currentmetageneration matches the given value.

func (*ObjectsCopyCall)IfMetagenerationNotMatch

func (c *ObjectsCopyCall) IfMetagenerationNotMatch(ifMetagenerationNotMatchint64) *ObjectsCopyCall

IfMetagenerationNotMatch sets the optional parameter"ifMetagenerationNotMatch": Makes the operation conditional on whether thedestination object's current metageneration does not match the given value.

func (*ObjectsCopyCall)IfSourceGenerationMatch

func (c *ObjectsCopyCall) IfSourceGenerationMatch(ifSourceGenerationMatchint64) *ObjectsCopyCall

IfSourceGenerationMatch sets the optional parameter"ifSourceGenerationMatch": Makes the operation conditional on whether thesource object's current generation matches the given value.

func (*ObjectsCopyCall)IfSourceGenerationNotMatch

func (c *ObjectsCopyCall) IfSourceGenerationNotMatch(ifSourceGenerationNotMatchint64) *ObjectsCopyCall

IfSourceGenerationNotMatch sets the optional parameter"ifSourceGenerationNotMatch": Makes the operation conditional on whether thesource object's current generation does not match the given value.

func (*ObjectsCopyCall)IfSourceMetagenerationMatch

func (c *ObjectsCopyCall) IfSourceMetagenerationMatch(ifSourceMetagenerationMatchint64) *ObjectsCopyCall

IfSourceMetagenerationMatch sets the optional parameter"ifSourceMetagenerationMatch": Makes the operation conditional on whetherthe source object's current metageneration matches the given value.

func (*ObjectsCopyCall)IfSourceMetagenerationNotMatch

func (c *ObjectsCopyCall) IfSourceMetagenerationNotMatch(ifSourceMetagenerationNotMatchint64) *ObjectsCopyCall

IfSourceMetagenerationNotMatch sets the optional parameter"ifSourceMetagenerationNotMatch": Makes the operation conditional on whetherthe source object's current metageneration does not match the given value.

func (*ObjectsCopyCall)Projection

func (c *ObjectsCopyCall) Projection(projectionstring) *ObjectsCopyCall

Projection sets the optional parameter "projection": Set of properties toreturn. Defaults to noAcl, unless the object resource specifies the aclproperty, when it defaults to full.

Possible values:

"full" - Include all properties."noAcl" - Omit the owner, acl property.

func (*ObjectsCopyCall)SourceGeneration

func (c *ObjectsCopyCall) SourceGeneration(sourceGenerationint64) *ObjectsCopyCall

SourceGeneration sets the optional parameter "sourceGeneration": If present,selects a specific revision of the source object (as opposed to the latestversion, the default).

func (*ObjectsCopyCall)UserProject

func (c *ObjectsCopyCall) UserProject(userProjectstring) *ObjectsCopyCall

UserProject sets the optional parameter "userProject": The project to bebilled for this request. Required for Requester Pays buckets.

typeObjectsDeleteCall

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

func (*ObjectsDeleteCall)Context

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

func (*ObjectsDeleteCall)Do

Do executes the "storage.objects.delete" call.

func (*ObjectsDeleteCall)Fields

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

func (*ObjectsDeleteCall)Generation

func (c *ObjectsDeleteCall) Generation(generationint64) *ObjectsDeleteCall

Generation sets the optional parameter "generation": If present, permanentlydeletes a specific revision of this object (as opposed to the latestversion, the default).

func (*ObjectsDeleteCall)Header

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

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

func (*ObjectsDeleteCall)IfGenerationMatch

func (c *ObjectsDeleteCall) IfGenerationMatch(ifGenerationMatchint64) *ObjectsDeleteCall

IfGenerationMatch sets the optional parameter "ifGenerationMatch": Makes theoperation conditional on whether the object's current generation matches thegiven value. Setting to 0 makes the operation succeed only if there are nolive versions of the object.

func (*ObjectsDeleteCall)IfGenerationNotMatch

func (c *ObjectsDeleteCall) IfGenerationNotMatch(ifGenerationNotMatchint64) *ObjectsDeleteCall

IfGenerationNotMatch sets the optional parameter "ifGenerationNotMatch":Makes the operation conditional on whether the object's current generationdoes not match the given value. If no live object exists, the preconditionfails. Setting to 0 makes the operation succeed only if there is a liveversion of the object.

func (*ObjectsDeleteCall)IfMetagenerationMatch

func (c *ObjectsDeleteCall) IfMetagenerationMatch(ifMetagenerationMatchint64) *ObjectsDeleteCall

IfMetagenerationMatch sets the optional parameter "ifMetagenerationMatch":Makes the operation conditional on whether the object's currentmetageneration matches the given value.

func (*ObjectsDeleteCall)IfMetagenerationNotMatch

func (c *ObjectsDeleteCall) IfMetagenerationNotMatch(ifMetagenerationNotMatchint64) *ObjectsDeleteCall

IfMetagenerationNotMatch sets the optional parameter"ifMetagenerationNotMatch": Makes the operation conditional on whether theobject's current metageneration does not match the given value.

func (*ObjectsDeleteCall)UserProject

func (c *ObjectsDeleteCall) UserProject(userProjectstring) *ObjectsDeleteCall

UserProject sets the optional parameter "userProject": The project to bebilled for this request. Required for Requester Pays buckets.

typeObjectsGetCall

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

func (*ObjectsGetCall)Context

Context sets the context to be used in this call's Do and Download methods.

func (*ObjectsGetCall)Do

Do executes the "storage.objects.get" call.Any non-2xx status code is an error. Response headers are in either*Object.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 (*ObjectsGetCall)Download

func (c *ObjectsGetCall) Download(opts ...googleapi.CallOption) (*http.Response,error)

Download fetches the API endpoint's "media" value, instead of the normalAPI response value. If the returned error is nil, the Response is guaranteed tohave a 2xx status code. Callers must close the Response.Body as usual.

func (*ObjectsGetCall)Fields

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

func (*ObjectsGetCall)Generation

func (c *ObjectsGetCall) Generation(generationint64) *ObjectsGetCall

Generation sets the optional parameter "generation": If present, selects aspecific revision of this object (as opposed to the latest version, thedefault).

func (*ObjectsGetCall)Header

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

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

func (*ObjectsGetCall)IfGenerationMatch

func (c *ObjectsGetCall) IfGenerationMatch(ifGenerationMatchint64) *ObjectsGetCall

IfGenerationMatch sets the optional parameter "ifGenerationMatch": Makes theoperation conditional on whether the object's current generation matches thegiven value. Setting to 0 makes the operation succeed only if there are nolive versions of the object.

func (*ObjectsGetCall)IfGenerationNotMatch

func (c *ObjectsGetCall) IfGenerationNotMatch(ifGenerationNotMatchint64) *ObjectsGetCall

IfGenerationNotMatch sets the optional parameter "ifGenerationNotMatch":Makes the operation conditional on whether the object's current generationdoes not match the given value. If no live object exists, the preconditionfails. Setting to 0 makes the operation succeed only if there is a liveversion of the object.

func (*ObjectsGetCall)IfMetagenerationMatch

func (c *ObjectsGetCall) IfMetagenerationMatch(ifMetagenerationMatchint64) *ObjectsGetCall

IfMetagenerationMatch sets the optional parameter "ifMetagenerationMatch":Makes the operation conditional on whether the object's currentmetageneration matches the given value.

func (*ObjectsGetCall)IfMetagenerationNotMatch

func (c *ObjectsGetCall) IfMetagenerationNotMatch(ifMetagenerationNotMatchint64) *ObjectsGetCall

IfMetagenerationNotMatch sets the optional parameter"ifMetagenerationNotMatch": Makes the operation conditional on whether theobject's current metageneration does not match the given value.

func (*ObjectsGetCall)IfNoneMatch

func (c *ObjectsGetCall) IfNoneMatch(entityTagstring) *ObjectsGetCall

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 (*ObjectsGetCall)Projection

func (c *ObjectsGetCall) Projection(projectionstring) *ObjectsGetCall

Projection sets the optional parameter "projection": Set of properties toreturn. Defaults to noAcl.

Possible values:

"full" - Include all properties."noAcl" - Omit the owner, acl property.

func (*ObjectsGetCall)RestoreTokenadded inv0.199.0

func (c *ObjectsGetCall) RestoreToken(restoreTokenstring) *ObjectsGetCall

RestoreToken sets the optional parameter "restoreToken": Restore token usedto differentiate soft-deleted objects with the same name and generation.Only applicable for hierarchical namespace buckets and if softDeleted is setto true. This parameter is optional, and is only required in the rare casewhen there are multiple soft-deleted objects with the same name andgeneration.

func (*ObjectsGetCall)SoftDeletedadded inv0.141.0

func (c *ObjectsGetCall) SoftDeleted(softDeletedbool) *ObjectsGetCall

SoftDeleted sets the optional parameter "softDeleted": If true, onlysoft-deleted object versions will be listed. The default is false. For moreinformation, see Soft Delete(https://cloud.google.com/storage/docs/soft-delete).

func (*ObjectsGetCall)UserProject

func (c *ObjectsGetCall) UserProject(userProjectstring) *ObjectsGetCall

UserProject sets the optional parameter "userProject": The project to bebilled for this request. Required for Requester Pays buckets.

typeObjectsGetIamPolicyCall

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

func (*ObjectsGetIamPolicyCall)Context

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

func (*ObjectsGetIamPolicyCall)Do

Do executes the "storage.objects.getIamPolicy" call.Any non-2xx status code is an error. Response headers are in either*Policy.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 (*ObjectsGetIamPolicyCall)Fields

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

func (*ObjectsGetIamPolicyCall)Generation

func (c *ObjectsGetIamPolicyCall) Generation(generationint64) *ObjectsGetIamPolicyCall

Generation sets the optional parameter "generation": If present, selects aspecific revision of this object (as opposed to the latest version, thedefault).

func (*ObjectsGetIamPolicyCall)Header

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

func (*ObjectsGetIamPolicyCall)IfNoneMatch

func (c *ObjectsGetIamPolicyCall) IfNoneMatch(entityTagstring) *ObjectsGetIamPolicyCall

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 (*ObjectsGetIamPolicyCall)UserProject

func (c *ObjectsGetIamPolicyCall) UserProject(userProjectstring) *ObjectsGetIamPolicyCall

UserProject sets the optional parameter "userProject": The project to bebilled for this request. Required for Requester Pays buckets.

typeObjectsInsertCall

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

func (*ObjectsInsertCall)ContentEncoding

func (c *ObjectsInsertCall) ContentEncoding(contentEncodingstring) *ObjectsInsertCall

ContentEncoding sets the optional parameter "contentEncoding": If set, setsthe contentEncoding property of the final object to this value. Setting thisparameter is equivalent to setting the contentEncoding metadata property.This can be useful when uploading an object with uploadType=media toindicate the encoding of the content being uploaded.

func (*ObjectsInsertCall)Context

Context sets the context to be used in this call's Do method.This context will supersede any context previously provided to theResumableMedia method.

func (*ObjectsInsertCall)Do

Do executes the "storage.objects.insert" call.Any non-2xx status code is an error. Response headers are in either*Object.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 (*ObjectsInsertCall)Fields

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

func (*ObjectsInsertCall)Header

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

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

func (*ObjectsInsertCall)IfGenerationMatch

func (c *ObjectsInsertCall) IfGenerationMatch(ifGenerationMatchint64) *ObjectsInsertCall

IfGenerationMatch sets the optional parameter "ifGenerationMatch": Makes theoperation conditional on whether the object's current generation matches thegiven value. Setting to 0 makes the operation succeed only if there are nolive versions of the object.

func (*ObjectsInsertCall)IfGenerationNotMatch

func (c *ObjectsInsertCall) IfGenerationNotMatch(ifGenerationNotMatchint64) *ObjectsInsertCall

IfGenerationNotMatch sets the optional parameter "ifGenerationNotMatch":Makes the operation conditional on whether the object's current generationdoes not match the given value. If no live object exists, the preconditionfails. Setting to 0 makes the operation succeed only if there is a liveversion of the object.

func (*ObjectsInsertCall)IfMetagenerationMatch

func (c *ObjectsInsertCall) IfMetagenerationMatch(ifMetagenerationMatchint64) *ObjectsInsertCall

IfMetagenerationMatch sets the optional parameter "ifMetagenerationMatch":Makes the operation conditional on whether the object's currentmetageneration matches the given value.

func (*ObjectsInsertCall)IfMetagenerationNotMatch

func (c *ObjectsInsertCall) IfMetagenerationNotMatch(ifMetagenerationNotMatchint64) *ObjectsInsertCall

IfMetagenerationNotMatch sets the optional parameter"ifMetagenerationNotMatch": Makes the operation conditional on whether theobject's current metageneration does not match the given value.

func (*ObjectsInsertCall)KmsKeyName

func (c *ObjectsInsertCall) KmsKeyName(kmsKeyNamestring) *ObjectsInsertCall

KmsKeyName sets the optional parameter "kmsKeyName": Resource name of theCloud KMS key, of the formprojects/my-project/locations/global/keyRings/my-kr/cryptoKeys/my-key, thatwill be used to encrypt the object. Overrides the object metadata'skms_key_name value, if any.

func (*ObjectsInsertCall)Media

Media specifies the media to upload in one or more chunks. The chunk sizemay be controlled by supplying a MediaOption generated bygoogleapi.ChunkSize. The chunk size defaults togoogleapi.DefaultUploadChunkSize.The Content-Type header used in the uploadrequest will be determined by sniffing the contents of r, unless aMediaOption generated by googleapi.ContentType is supplied.At most one of Media and ResumableMedia may be set.

func (*ObjectsInsertCall)Name

Name sets the optional parameter "name": Name of the object. Required whenthe object metadata is not otherwise provided. Overrides the objectmetadata's name value, if any. For information about how to URL encodeobject names to be path safe, see Encoding URI Path Parts(https://cloud.google.com/storage/docs/request-endpoints#encoding).

func (*ObjectsInsertCall)PredefinedAcl

func (c *ObjectsInsertCall) PredefinedAcl(predefinedAclstring) *ObjectsInsertCall

PredefinedAcl sets the optional parameter "predefinedAcl": Apply apredefined set of access controls to this object.

Possible values:

"authenticatedRead" - Object owner gets OWNER access, and

allAuthenticatedUsers get READER access.

"bucketOwnerFullControl" - Object owner gets OWNER access, and project

team owners get OWNER access.

"bucketOwnerRead" - Object owner gets OWNER access, and project team

owners get READER access.

"private" - Object owner gets OWNER access."projectPrivate" - Object owner gets OWNER access, and project team

members get access according to their roles.

"publicRead" - Object owner gets OWNER access, and allUsers get READER

access.

func (*ObjectsInsertCall)ProgressUpdater

ProgressUpdater provides a callback function that will be called after everychunk. It should be a low-latency function in order to not slow down theupload operation. This should only be called when using ResumableMedia (asopposed to Media).

func (*ObjectsInsertCall)Projection

func (c *ObjectsInsertCall) Projection(projectionstring) *ObjectsInsertCall

Projection sets the optional parameter "projection": Set of properties toreturn. Defaults to noAcl, unless the object resource specifies the aclproperty, when it defaults to full.

Possible values:

"full" - Include all properties."noAcl" - Omit the owner, acl property.

func (*ObjectsInsertCall)ResumableMediadeprecated

func (c *ObjectsInsertCall) ResumableMedia(ctxcontext.Context, rio.ReaderAt, sizeint64, mediaTypestring) *ObjectsInsertCall

ResumableMedia specifies the media to upload in chunks and can be canceledwith ctx.

Deprecated: use Media instead.

At most one of Media and ResumableMedia may be set. mediaType identifies theMIME media type of the upload, such as "image/png". If mediaType is "", itwill be auto-detected. The provided ctx will supersede any contextpreviously provided to the Context method.

func (*ObjectsInsertCall)UserProject

func (c *ObjectsInsertCall) UserProject(userProjectstring) *ObjectsInsertCall

UserProject sets the optional parameter "userProject": The project to bebilled for this request. Required for Requester Pays buckets.

func (*ObjectsInsertCall)WithRetryadded inv0.63.0

func (c *ObjectsInsertCall) WithRetry(bo *gax.Backoff, errorFunc func(errerror)bool) *ObjectsInsertCall

WithRetry causes the library to retry the initial request of the upload(forresumable uploads) or the entire upload (for multipart uploads) ifatransient error occurs. This is contingent on ChunkSize being > 0 (sothatthe input data may be buffered). The backoff argument will be usedtodetermine exponential backoff timing, and the errorFunc is used todeterminewhich errors are considered retryable. By default, exponetialbackoff will beapplied using gax defaults, and the following errors areretried:

- HTTP responses with codes 408, 429, 502, 503, and 504.

- Transient network errors such as connection reset andio.ErrUnexpectedEOF.

- Errors which are considered transient using the Temporary() interface.

- Wrapped versions of these errors.

typeObjectsListCall

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

func (*ObjectsListCall)Context

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

func (*ObjectsListCall)Delimiter

func (c *ObjectsListCall) Delimiter(delimiterstring) *ObjectsListCall

Delimiter sets the optional parameter "delimiter": Returns results in adirectory-like mode. items will contain only objects whose names, aside fromthe prefix, do not contain delimiter. Objects whose names, aside from theprefix, contain delimiter will have their name, truncated after thedelimiter, returned in prefixes. Duplicate prefixes are omitted.

func (*ObjectsListCall)Do

Do executes the "storage.objects.list" call.Any non-2xx status code is an error. Response headers are in either*Objects.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 (*ObjectsListCall)EndOffsetadded inv0.21.0

func (c *ObjectsListCall) EndOffset(endOffsetstring) *ObjectsListCall

EndOffset sets the optional parameter "endOffset": Filter results to objectswhose names are lexicographically before endOffset. If startOffset is alsoset, the objects listed will have names between startOffset (inclusive) andendOffset (exclusive).

func (*ObjectsListCall)Fields

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

func (*ObjectsListCall)Filteradded inv0.241.0

func (c *ObjectsListCall) Filter(filterstring) *ObjectsListCall

Filter sets the optional parameter "filter": Filter the returned objects.Currently only supported for the contexts field. If delimiter is set, thereturned prefixes are exempt from this filter.

func (*ObjectsListCall)Header

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

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

func (*ObjectsListCall)IfNoneMatch

func (c *ObjectsListCall) IfNoneMatch(entityTagstring) *ObjectsListCall

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 (*ObjectsListCall)IncludeFoldersAsPrefixesadded inv0.148.0

func (c *ObjectsListCall) IncludeFoldersAsPrefixes(includeFoldersAsPrefixesbool) *ObjectsListCall

IncludeFoldersAsPrefixes sets the optional parameter"includeFoldersAsPrefixes": Only applicable if delimiter is set to '/'. Iftrue, will also include folders and managed folders (besides objects) in thereturned prefixes.

func (*ObjectsListCall)IncludeTrailingDelimiter

func (c *ObjectsListCall) IncludeTrailingDelimiter(includeTrailingDelimiterbool) *ObjectsListCall

IncludeTrailingDelimiter sets the optional parameter"includeTrailingDelimiter": If true, objects that end in exactly oneinstance of delimiter will have their metadata included in items in additionto prefixes.

func (*ObjectsListCall)MatchGlobadded inv0.112.0

func (c *ObjectsListCall) MatchGlob(matchGlobstring) *ObjectsListCall

MatchGlob sets the optional parameter "matchGlob": Filter results to objectsand prefixes that match this glob pattern.

func (*ObjectsListCall)MaxResults

func (c *ObjectsListCall) MaxResults(maxResultsint64) *ObjectsListCall

MaxResults sets the optional parameter "maxResults": Maximum number of itemsplus prefixes to return in a single page of responses. As duplicate prefixesare omitted, fewer total results may be returned than requested. The servicewill use this parameter or 1,000 items, whichever is smaller.

func (*ObjectsListCall)PageToken

func (c *ObjectsListCall) PageToken(pageTokenstring) *ObjectsListCall

PageToken sets the optional parameter "pageToken": A previously-returnedpage token representing part of the larger set of results to view.

func (*ObjectsListCall)Pages

func (c *ObjectsListCall) Pages(ctxcontext.Context, f func(*Objects)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 (*ObjectsListCall)Prefix

func (c *ObjectsListCall) Prefix(prefixstring) *ObjectsListCall

Prefix sets the optional parameter "prefix": Filter results to objects whosenames begin with this prefix.

func (*ObjectsListCall)Projection

func (c *ObjectsListCall) Projection(projectionstring) *ObjectsListCall

Projection sets the optional parameter "projection": Set of properties toreturn. Defaults to noAcl.

Possible values:

"full" - Include all properties."noAcl" - Omit the owner, acl property.

func (*ObjectsListCall)SoftDeletedadded inv0.141.0

func (c *ObjectsListCall) SoftDeleted(softDeletedbool) *ObjectsListCall

SoftDeleted sets the optional parameter "softDeleted": If true, onlysoft-deleted object versions will be listed. The default is false. For moreinformation, see Soft Delete(https://cloud.google.com/storage/docs/soft-delete).

func (*ObjectsListCall)StartOffsetadded inv0.21.0

func (c *ObjectsListCall) StartOffset(startOffsetstring) *ObjectsListCall

StartOffset sets the optional parameter "startOffset": Filter results toobjects whose names are lexicographically equal to or after startOffset. IfendOffset is also set, the objects listed will have names betweenstartOffset (inclusive) and endOffset (exclusive).

func (*ObjectsListCall)UserProject

func (c *ObjectsListCall) UserProject(userProjectstring) *ObjectsListCall

UserProject sets the optional parameter "userProject": The project to bebilled for this request. Required for Requester Pays buckets.

func (*ObjectsListCall)Versions

func (c *ObjectsListCall) Versions(versionsbool) *ObjectsListCall

Versions sets the optional parameter "versions": If true, lists all versionsof an object as distinct results. The default is false. For moreinformation, see Object Versioning(https://cloud.google.com/storage/docs/object-versioning).

typeObjectsMoveCalladded inv0.212.0

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

func (*ObjectsMoveCall)Contextadded inv0.212.0

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

func (*ObjectsMoveCall)Doadded inv0.212.0

Do executes the "storage.objects.move" call.Any non-2xx status code is an error. Response headers are in either*Object.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 (*ObjectsMoveCall)Fieldsadded inv0.212.0

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

func (*ObjectsMoveCall)Headeradded inv0.212.0

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

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

func (*ObjectsMoveCall)IfGenerationMatchadded inv0.212.0

func (c *ObjectsMoveCall) IfGenerationMatch(ifGenerationMatchint64) *ObjectsMoveCall

IfGenerationMatch sets the optional parameter "ifGenerationMatch": Makes theoperation conditional on whether the destination object's current generationmatches the given value. Setting to 0 makes the operation succeed only ifthere are no live versions of the object. `ifGenerationMatch` and`ifGenerationNotMatch` conditions are mutually exclusive: it's an error forboth of them to be set in the request.

func (*ObjectsMoveCall)IfGenerationNotMatchadded inv0.212.0

func (c *ObjectsMoveCall) IfGenerationNotMatch(ifGenerationNotMatchint64) *ObjectsMoveCall

IfGenerationNotMatch sets the optional parameter "ifGenerationNotMatch":Makes the operation conditional on whether the destination object's currentgeneration does not match the given value. If no live object exists, theprecondition fails. Setting to 0 makes the operation succeed only if thereis a live version of the object.`ifGenerationMatch` and`ifGenerationNotMatch` conditions are mutually exclusive: it's an error forboth of them to be set in the request.

func (*ObjectsMoveCall)IfMetagenerationMatchadded inv0.212.0

func (c *ObjectsMoveCall) IfMetagenerationMatch(ifMetagenerationMatchint64) *ObjectsMoveCall

IfMetagenerationMatch sets the optional parameter "ifMetagenerationMatch":Makes the operation conditional on whether the destination object's currentmetageneration matches the given value. `ifMetagenerationMatch` and`ifMetagenerationNotMatch` conditions are mutually exclusive: it's an errorfor both of them to be set in the request.

func (*ObjectsMoveCall)IfMetagenerationNotMatchadded inv0.212.0

func (c *ObjectsMoveCall) IfMetagenerationNotMatch(ifMetagenerationNotMatchint64) *ObjectsMoveCall

IfMetagenerationNotMatch sets the optional parameter"ifMetagenerationNotMatch": Makes the operation conditional on whether thedestination object's current metageneration does not match the given value.`ifMetagenerationMatch` and `ifMetagenerationNotMatch` conditions aremutually exclusive: it's an error for both of them to be set in the request.

func (*ObjectsMoveCall)IfSourceGenerationMatchadded inv0.212.0

func (c *ObjectsMoveCall) IfSourceGenerationMatch(ifSourceGenerationMatchint64) *ObjectsMoveCall

IfSourceGenerationMatch sets the optional parameter"ifSourceGenerationMatch": Makes the operation conditional on whether thesource object's current generation matches the given value.`ifSourceGenerationMatch` and `ifSourceGenerationNotMatch` conditions aremutually exclusive: it's an error for both of them to be set in the request.

func (*ObjectsMoveCall)IfSourceGenerationNotMatchadded inv0.212.0

func (c *ObjectsMoveCall) IfSourceGenerationNotMatch(ifSourceGenerationNotMatchint64) *ObjectsMoveCall

IfSourceGenerationNotMatch sets the optional parameter"ifSourceGenerationNotMatch": Makes the operation conditional on whether thesource object's current generation does not match the given value.`ifSourceGenerationMatch` and `ifSourceGenerationNotMatch` conditions aremutually exclusive: it's an error for both of them to be set in the request.

func (*ObjectsMoveCall)IfSourceMetagenerationMatchadded inv0.212.0

func (c *ObjectsMoveCall) IfSourceMetagenerationMatch(ifSourceMetagenerationMatchint64) *ObjectsMoveCall

IfSourceMetagenerationMatch sets the optional parameter"ifSourceMetagenerationMatch": Makes the operation conditional on whetherthe source object's current metageneration matches the given value.`ifSourceMetagenerationMatch` and `ifSourceMetagenerationNotMatch`conditions are mutually exclusive: it's an error for both of them to be setin the request.

func (*ObjectsMoveCall)IfSourceMetagenerationNotMatchadded inv0.212.0

func (c *ObjectsMoveCall) IfSourceMetagenerationNotMatch(ifSourceMetagenerationNotMatchint64) *ObjectsMoveCall

IfSourceMetagenerationNotMatch sets the optional parameter"ifSourceMetagenerationNotMatch": Makes the operation conditional on whetherthe source object's current metageneration does not match the given value.`ifSourceMetagenerationMatch` and `ifSourceMetagenerationNotMatch`conditions are mutually exclusive: it's an error for both of them to be setin the request.

func (*ObjectsMoveCall)Projectionadded inv0.232.0

func (c *ObjectsMoveCall) Projection(projectionstring) *ObjectsMoveCall

Projection sets the optional parameter "projection": Set of properties toreturn. Defaults to noAcl.

Possible values:

"full" - Include all properties."noAcl" - Omit the owner, acl property.

func (*ObjectsMoveCall)UserProjectadded inv0.212.0

func (c *ObjectsMoveCall) UserProject(userProjectstring) *ObjectsMoveCall

UserProject sets the optional parameter "userProject": The project to bebilled for this request. Required for Requester Pays buckets.

typeObjectsPatchCall

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

func (*ObjectsPatchCall)Context

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

func (*ObjectsPatchCall)Do

Do executes the "storage.objects.patch" call.Any non-2xx status code is an error. Response headers are in either*Object.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 (*ObjectsPatchCall)Fields

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

func (*ObjectsPatchCall)Generation

func (c *ObjectsPatchCall) Generation(generationint64) *ObjectsPatchCall

Generation sets the optional parameter "generation": If present, selects aspecific revision of this object (as opposed to the latest version, thedefault).

func (*ObjectsPatchCall)Header

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

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

func (*ObjectsPatchCall)IfGenerationMatch

func (c *ObjectsPatchCall) IfGenerationMatch(ifGenerationMatchint64) *ObjectsPatchCall

IfGenerationMatch sets the optional parameter "ifGenerationMatch": Makes theoperation conditional on whether the object's current generation matches thegiven value. Setting to 0 makes the operation succeed only if there are nolive versions of the object.

func (*ObjectsPatchCall)IfGenerationNotMatch

func (c *ObjectsPatchCall) IfGenerationNotMatch(ifGenerationNotMatchint64) *ObjectsPatchCall

IfGenerationNotMatch sets the optional parameter "ifGenerationNotMatch":Makes the operation conditional on whether the object's current generationdoes not match the given value. If no live object exists, the preconditionfails. Setting to 0 makes the operation succeed only if there is a liveversion of the object.

func (*ObjectsPatchCall)IfMetagenerationMatch

func (c *ObjectsPatchCall) IfMetagenerationMatch(ifMetagenerationMatchint64) *ObjectsPatchCall

IfMetagenerationMatch sets the optional parameter "ifMetagenerationMatch":Makes the operation conditional on whether the object's currentmetageneration matches the given value.

func (*ObjectsPatchCall)IfMetagenerationNotMatch

func (c *ObjectsPatchCall) IfMetagenerationNotMatch(ifMetagenerationNotMatchint64) *ObjectsPatchCall

IfMetagenerationNotMatch sets the optional parameter"ifMetagenerationNotMatch": Makes the operation conditional on whether theobject's current metageneration does not match the given value.

func (*ObjectsPatchCall)OverrideUnlockedRetentionadded inv0.142.0

func (c *ObjectsPatchCall) OverrideUnlockedRetention(overrideUnlockedRetentionbool) *ObjectsPatchCall

OverrideUnlockedRetention sets the optional parameter"overrideUnlockedRetention": Must be true to remove the retentionconfiguration, reduce its unlocked retention period, or change its mode fromunlocked to locked.

func (*ObjectsPatchCall)PredefinedAcl

func (c *ObjectsPatchCall) PredefinedAcl(predefinedAclstring) *ObjectsPatchCall

PredefinedAcl sets the optional parameter "predefinedAcl": Apply apredefined set of access controls to this object.

Possible values:

"authenticatedRead" - Object owner gets OWNER access, and

allAuthenticatedUsers get READER access.

"bucketOwnerFullControl" - Object owner gets OWNER access, and project

team owners get OWNER access.

"bucketOwnerRead" - Object owner gets OWNER access, and project team

owners get READER access.

"private" - Object owner gets OWNER access."projectPrivate" - Object owner gets OWNER access, and project team

members get access according to their roles.

"publicRead" - Object owner gets OWNER access, and allUsers get READER

access.

func (*ObjectsPatchCall)Projection

func (c *ObjectsPatchCall) Projection(projectionstring) *ObjectsPatchCall

Projection sets the optional parameter "projection": Set of properties toreturn. Defaults to full.

Possible values:

"full" - Include all properties."noAcl" - Omit the owner, acl property.

func (*ObjectsPatchCall)UserProject

func (c *ObjectsPatchCall) UserProject(userProjectstring) *ObjectsPatchCall

UserProject sets the optional parameter "userProject": The project to bebilled for this request, for Requester Pays buckets.

typeObjectsRestoreCalladded inv0.141.0

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

func (*ObjectsRestoreCall)Contextadded inv0.141.0

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

func (*ObjectsRestoreCall)CopySourceAcladded inv0.144.0

func (c *ObjectsRestoreCall) CopySourceAcl(copySourceAclbool) *ObjectsRestoreCall

CopySourceAcl sets the optional parameter "copySourceAcl": If true, copiesthe source object's ACL; otherwise, uses the bucket's default object ACL.The default is false.

func (*ObjectsRestoreCall)Doadded inv0.141.0

Do executes the "storage.objects.restore" call.Any non-2xx status code is an error. Response headers are in either*Object.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 (*ObjectsRestoreCall)Fieldsadded inv0.141.0

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

func (*ObjectsRestoreCall)Headeradded inv0.141.0

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

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

func (*ObjectsRestoreCall)IfGenerationMatchadded inv0.141.0

func (c *ObjectsRestoreCall) IfGenerationMatch(ifGenerationMatchint64) *ObjectsRestoreCall

IfGenerationMatch sets the optional parameter "ifGenerationMatch": Makes theoperation conditional on whether the object's one live generation matchesthe given value. Setting to 0 makes the operation succeed only if there areno live versions of the object.

func (*ObjectsRestoreCall)IfGenerationNotMatchadded inv0.141.0

func (c *ObjectsRestoreCall) IfGenerationNotMatch(ifGenerationNotMatchint64) *ObjectsRestoreCall

IfGenerationNotMatch sets the optional parameter "ifGenerationNotMatch":Makes the operation conditional on whether none of the object's livegenerations match the given value. If no live object exists, theprecondition fails. Setting to 0 makes the operation succeed only if thereis a live version of the object.

func (*ObjectsRestoreCall)IfMetagenerationMatchadded inv0.141.0

func (c *ObjectsRestoreCall) IfMetagenerationMatch(ifMetagenerationMatchint64) *ObjectsRestoreCall

IfMetagenerationMatch sets the optional parameter "ifMetagenerationMatch":Makes the operation conditional on whether the object's one livemetageneration matches the given value.

func (*ObjectsRestoreCall)IfMetagenerationNotMatchadded inv0.141.0

func (c *ObjectsRestoreCall) IfMetagenerationNotMatch(ifMetagenerationNotMatchint64) *ObjectsRestoreCall

IfMetagenerationNotMatch sets the optional parameter"ifMetagenerationNotMatch": Makes the operation conditional on whether noneof the object's live metagenerations match the given value.

func (*ObjectsRestoreCall)Projectionadded inv0.141.0

func (c *ObjectsRestoreCall) Projection(projectionstring) *ObjectsRestoreCall

Projection sets the optional parameter "projection": Set of properties toreturn. Defaults to full.

Possible values:

"full" - Include all properties."noAcl" - Omit the owner, acl property.

func (*ObjectsRestoreCall)RestoreTokenadded inv0.199.0

func (c *ObjectsRestoreCall) RestoreToken(restoreTokenstring) *ObjectsRestoreCall

RestoreToken sets the optional parameter "restoreToken": Restore token usedto differentiate sof-deleted objects with the same name and generation. Onlyapplicable for hierarchical namespace buckets. This parameter is optional,and is only required in the rare case when there are multiple soft-deletedobjects with the same name and generation.

func (*ObjectsRestoreCall)UserProjectadded inv0.141.0

func (c *ObjectsRestoreCall) UserProject(userProjectstring) *ObjectsRestoreCall

UserProject sets the optional parameter "userProject": The project to bebilled for this request. Required for Requester Pays buckets.

typeObjectsRewriteCall

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

func (*ObjectsRewriteCall)Context

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

func (*ObjectsRewriteCall)DestinationKmsKeyName

func (c *ObjectsRewriteCall) DestinationKmsKeyName(destinationKmsKeyNamestring) *ObjectsRewriteCall

DestinationKmsKeyName sets the optional parameter "destinationKmsKeyName":Resource name of the Cloud KMS key, of the formprojects/my-project/locations/global/keyRings/my-kr/cryptoKeys/my-key, thatwill be used to encrypt the object. Overrides the object metadata'skms_key_name value, if any.

func (*ObjectsRewriteCall)DestinationPredefinedAcl

func (c *ObjectsRewriteCall) DestinationPredefinedAcl(destinationPredefinedAclstring) *ObjectsRewriteCall

DestinationPredefinedAcl sets the optional parameter"destinationPredefinedAcl": Apply a predefined set of access controls to thedestination object.

Possible values:

"authenticatedRead" - Object owner gets OWNER access, and

allAuthenticatedUsers get READER access.

"bucketOwnerFullControl" - Object owner gets OWNER access, and project

team owners get OWNER access.

"bucketOwnerRead" - Object owner gets OWNER access, and project team

owners get READER access.

"private" - Object owner gets OWNER access."projectPrivate" - Object owner gets OWNER access, and project team

members get access according to their roles.

"publicRead" - Object owner gets OWNER access, and allUsers get READER

access.

func (*ObjectsRewriteCall)Do

Do executes the "storage.objects.rewrite" call.Any non-2xx status code is an error. Response headers are in either*RewriteResponse.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 (*ObjectsRewriteCall)Fields

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

func (*ObjectsRewriteCall)Header

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

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

func (*ObjectsRewriteCall)IfGenerationMatch

func (c *ObjectsRewriteCall) IfGenerationMatch(ifGenerationMatchint64) *ObjectsRewriteCall

IfGenerationMatch sets the optional parameter "ifGenerationMatch": Makes theoperation conditional on whether the object's current generation matches thegiven value. Setting to 0 makes the operation succeed only if there are nolive versions of the object.

func (*ObjectsRewriteCall)IfGenerationNotMatch

func (c *ObjectsRewriteCall) IfGenerationNotMatch(ifGenerationNotMatchint64) *ObjectsRewriteCall

IfGenerationNotMatch sets the optional parameter "ifGenerationNotMatch":Makes the operation conditional on whether the object's current generationdoes not match the given value. If no live object exists, the preconditionfails. Setting to 0 makes the operation succeed only if there is a liveversion of the object.

func (*ObjectsRewriteCall)IfMetagenerationMatch

func (c *ObjectsRewriteCall) IfMetagenerationMatch(ifMetagenerationMatchint64) *ObjectsRewriteCall

IfMetagenerationMatch sets the optional parameter "ifMetagenerationMatch":Makes the operation conditional on whether the destination object's currentmetageneration matches the given value.

func (*ObjectsRewriteCall)IfMetagenerationNotMatch

func (c *ObjectsRewriteCall) IfMetagenerationNotMatch(ifMetagenerationNotMatchint64) *ObjectsRewriteCall

IfMetagenerationNotMatch sets the optional parameter"ifMetagenerationNotMatch": Makes the operation conditional on whether thedestination object's current metageneration does not match the given value.

func (*ObjectsRewriteCall)IfSourceGenerationMatch

func (c *ObjectsRewriteCall) IfSourceGenerationMatch(ifSourceGenerationMatchint64) *ObjectsRewriteCall

IfSourceGenerationMatch sets the optional parameter"ifSourceGenerationMatch": Makes the operation conditional on whether thesource object's current generation matches the given value.

func (*ObjectsRewriteCall)IfSourceGenerationNotMatch

func (c *ObjectsRewriteCall) IfSourceGenerationNotMatch(ifSourceGenerationNotMatchint64) *ObjectsRewriteCall

IfSourceGenerationNotMatch sets the optional parameter"ifSourceGenerationNotMatch": Makes the operation conditional on whether thesource object's current generation does not match the given value.

func (*ObjectsRewriteCall)IfSourceMetagenerationMatch

func (c *ObjectsRewriteCall) IfSourceMetagenerationMatch(ifSourceMetagenerationMatchint64) *ObjectsRewriteCall

IfSourceMetagenerationMatch sets the optional parameter"ifSourceMetagenerationMatch": Makes the operation conditional on whetherthe source object's current metageneration matches the given value.

func (*ObjectsRewriteCall)IfSourceMetagenerationNotMatch

func (c *ObjectsRewriteCall) IfSourceMetagenerationNotMatch(ifSourceMetagenerationNotMatchint64) *ObjectsRewriteCall

IfSourceMetagenerationNotMatch sets the optional parameter"ifSourceMetagenerationNotMatch": Makes the operation conditional on whetherthe source object's current metageneration does not match the given value.

func (*ObjectsRewriteCall)MaxBytesRewrittenPerCall

func (c *ObjectsRewriteCall) MaxBytesRewrittenPerCall(maxBytesRewrittenPerCallint64) *ObjectsRewriteCall

MaxBytesRewrittenPerCall sets the optional parameter"maxBytesRewrittenPerCall": The maximum number of bytes that will berewritten per rewrite request. Most callers shouldn't need to specify thisparameter - it is primarily in place to support testing. If specified thevalue must be an integral multiple of 1 MiB (1048576). Also, this onlyapplies to requests where the source and destination span locations and/orstorage classes. Finally, this value must not change across rewrite callselse you'll get an error that the rewriteToken is invalid.

func (*ObjectsRewriteCall)Projection

func (c *ObjectsRewriteCall) Projection(projectionstring) *ObjectsRewriteCall

Projection sets the optional parameter "projection": Set of properties toreturn. Defaults to noAcl, unless the object resource specifies the aclproperty, when it defaults to full.

Possible values:

"full" - Include all properties."noAcl" - Omit the owner, acl property.

func (*ObjectsRewriteCall)RewriteToken

func (c *ObjectsRewriteCall) RewriteToken(rewriteTokenstring) *ObjectsRewriteCall

RewriteToken sets the optional parameter "rewriteToken": Include this field(from the previous rewrite response) on each rewrite request after the firstone, until the rewrite response 'done' flag is true. Calls that provide arewriteToken can omit all other request fields, but if included those fieldsmust match the values provided in the first rewrite request.

func (*ObjectsRewriteCall)SourceGeneration

func (c *ObjectsRewriteCall) SourceGeneration(sourceGenerationint64) *ObjectsRewriteCall

SourceGeneration sets the optional parameter "sourceGeneration": If present,selects a specific revision of the source object (as opposed to the latestversion, the default).

func (*ObjectsRewriteCall)UserProject

func (c *ObjectsRewriteCall) UserProject(userProjectstring) *ObjectsRewriteCall

UserProject sets the optional parameter "userProject": The project to bebilled for this request. Required for Requester Pays buckets.

typeObjectsService

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

funcNewObjectsService

func NewObjectsService(s *Service) *ObjectsService

func (*ObjectsService)BulkRestoreadded inv0.141.0

func (r *ObjectsService) BulkRestore(bucketstring, bulkrestoreobjectsrequest *BulkRestoreObjectsRequest) *ObjectsBulkRestoreCall

BulkRestore: Initiates a long-running bulk restore operation on thespecified bucket.

- bucket: Name of the bucket in which the object resides.

func (*ObjectsService)Compose

func (r *ObjectsService) Compose(destinationBucketstring, destinationObjectstring, composerequest *ComposeRequest) *ObjectsComposeCall

Compose: Concatenates a list of existing objects into a new object in thesame bucket.

  • destinationBucket: Name of the bucket containing the source objects. Thedestination object is stored in this bucket.
  • destinationObject: Name of the new object. For information about how toURL encode object names to be path safe, see Encoding URI Path Parts(https://cloud.google.com/storage/docs/request-endpoints#encoding).

func (*ObjectsService)Copy

func (r *ObjectsService) Copy(sourceBucketstring, sourceObjectstring, destinationBucketstring, destinationObjectstring, object *Object) *ObjectsCopyCall

Copy: Copies a source object to a destination object. Optionally overridesmetadata.

  • destinationBucket: Name of the bucket in which to store the new object.Overrides the provided object metadata's bucket value, if any.Forinformation about how to URL encode object names to be path safe, seeEncoding URI Path Parts(https://cloud.google.com/storage/docs/request-endpoints#encoding).
  • destinationObject: Name of the new object. Required when the objectmetadata is not otherwise provided. Overrides the object metadata's namevalue, if any.
  • sourceBucket: Name of the bucket in which to find the source object.
  • sourceObject: Name of the source object. For information about how to URLencode object names to be path safe, see Encoding URI Path Parts(https://cloud.google.com/storage/docs/request-endpoints#encoding).

func (*ObjectsService)Delete

func (r *ObjectsService) Delete(bucketstring, objectstring) *ObjectsDeleteCall

Delete: Deletes an object and its metadata. Deletions are permanent ifversioning is not enabled for the bucket, or if the generation parameter isused.

func (*ObjectsService)Get

func (r *ObjectsService) Get(bucketstring, objectstring) *ObjectsGetCall

Get: Retrieves an object or its metadata.

func (*ObjectsService)GetIamPolicy

func (r *ObjectsService) GetIamPolicy(bucketstring, objectstring) *ObjectsGetIamPolicyCall

GetIamPolicy: Returns an IAM policy for the specified object.

func (*ObjectsService)Insert

func (r *ObjectsService) Insert(bucketstring, object *Object) *ObjectsInsertCall

Insert: Stores a new object and metadata.

  • bucket: Name of the bucket in which to store the new object. Overrides theprovided object metadata's bucket value, if any.

func (*ObjectsService)List

func (r *ObjectsService) List(bucketstring) *ObjectsListCall

List: Retrieves a list of objects matching the criteria.

- bucket: Name of the bucket in which to look for objects.

func (*ObjectsService)Moveadded inv0.212.0

func (r *ObjectsService) Move(bucketstring, sourceObjectstring, destinationObjectstring) *ObjectsMoveCall

Move: Moves the source object to the destination object in the same bucket.

func (*ObjectsService)Patch

func (r *ObjectsService) Patch(bucketstring, objectstring, object2 *Object) *ObjectsPatchCall

Patch: Patches an object's metadata.

func (*ObjectsService)Restoreadded inv0.141.0

func (r *ObjectsService) Restore(bucketstring, objectstring, generationint64) *ObjectsRestoreCall

Restore: Restores a soft-deleted object.

func (*ObjectsService)Rewrite

func (r *ObjectsService) Rewrite(sourceBucketstring, sourceObjectstring, destinationBucketstring, destinationObjectstring, object *Object) *ObjectsRewriteCall

Rewrite: Rewrites a source object to a destination object. Optionallyoverrides metadata.

  • destinationBucket: Name of the bucket in which to store the new object.Overrides the provided object metadata's bucket value, if any.
  • destinationObject: Name of the new object. Required when the objectmetadata is not otherwise provided. Overrides the object metadata's namevalue, if any. For information about how to URL encode object names to bepath safe, see Encoding URI Path Parts(https://cloud.google.com/storage/docs/request-endpoints#encoding).
  • sourceBucket: Name of the bucket in which to find the source object.
  • sourceObject: Name of the source object. For information about how to URLencode object names to be path safe, see Encoding URI Path Parts(https://cloud.google.com/storage/docs/request-endpoints#encoding).

func (*ObjectsService)SetIamPolicy

func (r *ObjectsService) SetIamPolicy(bucketstring, objectstring, policy *Policy) *ObjectsSetIamPolicyCall

SetIamPolicy: Updates an IAM policy for the specified object.

func (*ObjectsService)TestIamPermissions

func (r *ObjectsService) TestIamPermissions(bucketstring, objectstring, permissions []string) *ObjectsTestIamPermissionsCall

TestIamPermissions: Tests a set of permissions on the given object to seewhich, if any, are held by the caller.

func (*ObjectsService)Update

func (r *ObjectsService) Update(bucketstring, objectstring, object2 *Object) *ObjectsUpdateCall

Update: Updates an object's metadata.

func (*ObjectsService)WatchAll

func (r *ObjectsService) WatchAll(bucketstring, channel *Channel) *ObjectsWatchAllCall

WatchAll: Watch for changes on all objects in a bucket.

- bucket: Name of the bucket in which to look for objects.

typeObjectsSetIamPolicyCall

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

func (*ObjectsSetIamPolicyCall)Context

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

func (*ObjectsSetIamPolicyCall)Do

Do executes the "storage.objects.setIamPolicy" call.Any non-2xx status code is an error. Response headers are in either*Policy.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 (*ObjectsSetIamPolicyCall)Fields

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

func (*ObjectsSetIamPolicyCall)Generation

func (c *ObjectsSetIamPolicyCall) Generation(generationint64) *ObjectsSetIamPolicyCall

Generation sets the optional parameter "generation": If present, selects aspecific revision of this object (as opposed to the latest version, thedefault).

func (*ObjectsSetIamPolicyCall)Header

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

func (*ObjectsSetIamPolicyCall)UserProject

func (c *ObjectsSetIamPolicyCall) UserProject(userProjectstring) *ObjectsSetIamPolicyCall

UserProject sets the optional parameter "userProject": The project to bebilled for this request. Required for Requester Pays buckets.

typeObjectsTestIamPermissionsCall

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

func (*ObjectsTestIamPermissionsCall)Context

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

func (*ObjectsTestIamPermissionsCall)Do

Do executes the "storage.objects.testIamPermissions" call.Any non-2xx status code is an error. Response headers are in either*TestIamPermissionsResponse.ServerResponse.Header or (if a response wasreturned at all) in error.(*googleapi.Error).Header. Usegoogleapi.IsNotModified to check whether the returned error was becausehttp.StatusNotModified was returned.

func (*ObjectsTestIamPermissionsCall)Fields

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

func (*ObjectsTestIamPermissionsCall)Generation

Generation sets the optional parameter "generation": If present, selects aspecific revision of this object (as opposed to the latest version, thedefault).

func (*ObjectsTestIamPermissionsCall)Header

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

func (*ObjectsTestIamPermissionsCall)IfNoneMatch

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 (*ObjectsTestIamPermissionsCall)UserProject

UserProject sets the optional parameter "userProject": The project to bebilled for this request. Required for Requester Pays buckets.

typeObjectsUpdateCall

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

func (*ObjectsUpdateCall)Context

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

func (*ObjectsUpdateCall)Do

Do executes the "storage.objects.update" call.Any non-2xx status code is an error. Response headers are in either*Object.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 (*ObjectsUpdateCall)Fields

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

func (*ObjectsUpdateCall)Generation

func (c *ObjectsUpdateCall) Generation(generationint64) *ObjectsUpdateCall

Generation sets the optional parameter "generation": If present, selects aspecific revision of this object (as opposed to the latest version, thedefault).

func (*ObjectsUpdateCall)Header

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

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

func (*ObjectsUpdateCall)IfGenerationMatch

func (c *ObjectsUpdateCall) IfGenerationMatch(ifGenerationMatchint64) *ObjectsUpdateCall

IfGenerationMatch sets the optional parameter "ifGenerationMatch": Makes theoperation conditional on whether the object's current generation matches thegiven value. Setting to 0 makes the operation succeed only if there are nolive versions of the object.

func (*ObjectsUpdateCall)IfGenerationNotMatch

func (c *ObjectsUpdateCall) IfGenerationNotMatch(ifGenerationNotMatchint64) *ObjectsUpdateCall

IfGenerationNotMatch sets the optional parameter "ifGenerationNotMatch":Makes the operation conditional on whether the object's current generationdoes not match the given value. If no live object exists, the preconditionfails. Setting to 0 makes the operation succeed only if there is a liveversion of the object.

func (*ObjectsUpdateCall)IfMetagenerationMatch

func (c *ObjectsUpdateCall) IfMetagenerationMatch(ifMetagenerationMatchint64) *ObjectsUpdateCall

IfMetagenerationMatch sets the optional parameter "ifMetagenerationMatch":Makes the operation conditional on whether the object's currentmetageneration matches the given value.

func (*ObjectsUpdateCall)IfMetagenerationNotMatch

func (c *ObjectsUpdateCall) IfMetagenerationNotMatch(ifMetagenerationNotMatchint64) *ObjectsUpdateCall

IfMetagenerationNotMatch sets the optional parameter"ifMetagenerationNotMatch": Makes the operation conditional on whether theobject's current metageneration does not match the given value.

func (*ObjectsUpdateCall)OverrideUnlockedRetentionadded inv0.142.0

func (c *ObjectsUpdateCall) OverrideUnlockedRetention(overrideUnlockedRetentionbool) *ObjectsUpdateCall

OverrideUnlockedRetention sets the optional parameter"overrideUnlockedRetention": Must be true to remove the retentionconfiguration, reduce its unlocked retention period, or change its mode fromunlocked to locked.

func (*ObjectsUpdateCall)PredefinedAcl

func (c *ObjectsUpdateCall) PredefinedAcl(predefinedAclstring) *ObjectsUpdateCall

PredefinedAcl sets the optional parameter "predefinedAcl": Apply apredefined set of access controls to this object.

Possible values:

"authenticatedRead" - Object owner gets OWNER access, and

allAuthenticatedUsers get READER access.

"bucketOwnerFullControl" - Object owner gets OWNER access, and project

team owners get OWNER access.

"bucketOwnerRead" - Object owner gets OWNER access, and project team

owners get READER access.

"private" - Object owner gets OWNER access."projectPrivate" - Object owner gets OWNER access, and project team

members get access according to their roles.

"publicRead" - Object owner gets OWNER access, and allUsers get READER

access.

func (*ObjectsUpdateCall)Projection

func (c *ObjectsUpdateCall) Projection(projectionstring) *ObjectsUpdateCall

Projection sets the optional parameter "projection": Set of properties toreturn. Defaults to full.

Possible values:

"full" - Include all properties."noAcl" - Omit the owner, acl property.

func (*ObjectsUpdateCall)UserProject

func (c *ObjectsUpdateCall) UserProject(userProjectstring) *ObjectsUpdateCall

UserProject sets the optional parameter "userProject": The project to bebilled for this request. Required for Requester Pays buckets.

typeObjectsWatchAllCall

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

func (*ObjectsWatchAllCall)Context

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

func (*ObjectsWatchAllCall)Delimiter

func (c *ObjectsWatchAllCall) Delimiter(delimiterstring) *ObjectsWatchAllCall

Delimiter sets the optional parameter "delimiter": Returns results in adirectory-like mode. items will contain only objects whose names, aside fromthe prefix, do not contain delimiter. Objects whose names, aside from theprefix, contain delimiter will have their name, truncated after thedelimiter, returned in prefixes. Duplicate prefixes are omitted.

func (*ObjectsWatchAllCall)Do

Do executes the "storage.objects.watchAll" call.Any non-2xx status code is an error. Response headers are in either*Channel.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 (*ObjectsWatchAllCall)EndOffsetadded inv0.21.0

func (c *ObjectsWatchAllCall) EndOffset(endOffsetstring) *ObjectsWatchAllCall

EndOffset sets the optional parameter "endOffset": Filter results to objectswhose names are lexicographically before endOffset. If startOffset is alsoset, the objects listed will have names between startOffset (inclusive) andendOffset (exclusive).

func (*ObjectsWatchAllCall)Fields

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

func (*ObjectsWatchAllCall)Header

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

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

func (*ObjectsWatchAllCall)IncludeTrailingDelimiter

func (c *ObjectsWatchAllCall) IncludeTrailingDelimiter(includeTrailingDelimiterbool) *ObjectsWatchAllCall

IncludeTrailingDelimiter sets the optional parameter"includeTrailingDelimiter": If true, objects that end in exactly oneinstance of delimiter will have their metadata included in items in additionto prefixes.

func (*ObjectsWatchAllCall)MaxResults

func (c *ObjectsWatchAllCall) MaxResults(maxResultsint64) *ObjectsWatchAllCall

MaxResults sets the optional parameter "maxResults": Maximum number of itemsplus prefixes to return in a single page of responses. As duplicate prefixesare omitted, fewer total results may be returned than requested. The servicewill use this parameter or 1,000 items, whichever is smaller.

func (*ObjectsWatchAllCall)PageToken

func (c *ObjectsWatchAllCall) PageToken(pageTokenstring) *ObjectsWatchAllCall

PageToken sets the optional parameter "pageToken": A previously-returnedpage token representing part of the larger set of results to view.

func (*ObjectsWatchAllCall)Prefix

Prefix sets the optional parameter "prefix": Filter results to objects whosenames begin with this prefix.

func (*ObjectsWatchAllCall)Projection

func (c *ObjectsWatchAllCall) Projection(projectionstring) *ObjectsWatchAllCall

Projection sets the optional parameter "projection": Set of properties toreturn. Defaults to noAcl.

Possible values:

"full" - Include all properties."noAcl" - Omit the owner, acl property.

func (*ObjectsWatchAllCall)StartOffsetadded inv0.21.0

func (c *ObjectsWatchAllCall) StartOffset(startOffsetstring) *ObjectsWatchAllCall

StartOffset sets the optional parameter "startOffset": Filter results toobjects whose names are lexicographically equal to or after startOffset. IfendOffset is also set, the objects listed will have names betweenstartOffset (inclusive) and endOffset (exclusive).

func (*ObjectsWatchAllCall)UserProject

func (c *ObjectsWatchAllCall) UserProject(userProjectstring) *ObjectsWatchAllCall

UserProject sets the optional parameter "userProject": The project to bebilled for this request. Required for Requester Pays buckets.

func (*ObjectsWatchAllCall)Versions

func (c *ObjectsWatchAllCall) Versions(versionsbool) *ObjectsWatchAllCall

Versions sets the optional parameter "versions": If true, lists all versionsof an object as distinct results. The default is false. For moreinformation, see Object Versioning(https://cloud.google.com/storage/docs/object-versioning).

typeOperationsAdvanceRelocateBucketCalladded inv0.201.0

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

func (*OperationsAdvanceRelocateBucketCall)Contextadded inv0.201.0

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

func (*OperationsAdvanceRelocateBucketCall)Doadded inv0.201.0

Do executes the "storage.buckets.operations.advanceRelocateBucket" call.

func (*OperationsAdvanceRelocateBucketCall)Fieldsadded inv0.201.0

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

func (*OperationsAdvanceRelocateBucketCall)Headeradded inv0.201.0

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

typeOperationsCancelCalladded inv0.141.0

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

func (*OperationsCancelCall)Contextadded inv0.141.0

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

func (*OperationsCancelCall)Doadded inv0.141.0

Do executes the "storage.buckets.operations.cancel" call.

func (*OperationsCancelCall)Fieldsadded inv0.141.0

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

func (*OperationsCancelCall)Headeradded inv0.141.0

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

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

typeOperationsGetCalladded inv0.141.0

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

func (*OperationsGetCall)Contextadded inv0.141.0

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

func (*OperationsGetCall)Doadded inv0.141.0

Do executes the "storage.buckets.operations.get" call.Any non-2xx status code is an error. Response headers are in either*GoogleLongrunningOperation.ServerResponse.Header or (if a response wasreturned at all) in error.(*googleapi.Error).Header. Usegoogleapi.IsNotModified to check whether the returned error was becausehttp.StatusNotModified was returned.

func (*OperationsGetCall)Fieldsadded inv0.141.0

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

func (*OperationsGetCall)Headeradded inv0.141.0

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

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

func (*OperationsGetCall)IfNoneMatchadded inv0.141.0

func (c *OperationsGetCall) IfNoneMatch(entityTagstring) *OperationsGetCall

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.

typeOperationsListCalladded inv0.141.0

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

func (*OperationsListCall)Contextadded inv0.141.0

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

func (*OperationsListCall)Doadded inv0.141.0

Do executes the "storage.buckets.operations.list" call.Any non-2xx status code is an error. Response headers are in either*GoogleLongrunningListOperationsResponse.ServerResponse.Header or (if aresponse was returned at all) in error.(*googleapi.Error).Header. Usegoogleapi.IsNotModified to check whether the returned error was becausehttp.StatusNotModified was returned.

func (*OperationsListCall)Fieldsadded inv0.141.0

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

func (*OperationsListCall)Filteradded inv0.141.0

Filter sets the optional parameter "filter": A filter to narrow down resultsto a preferred subset. The filtering language is documented in more detailin AIP-160 (https://google.aip.dev/160).

func (*OperationsListCall)Headeradded inv0.141.0

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

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

func (*OperationsListCall)IfNoneMatchadded inv0.141.0

func (c *OperationsListCall) IfNoneMatch(entityTagstring) *OperationsListCall

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 (*OperationsListCall)PageSizeadded inv0.141.0

func (c *OperationsListCall) PageSize(pageSizeint64) *OperationsListCall

PageSize sets the optional parameter "pageSize": Maximum number of items toreturn in a single page of responses. Fewer total results may be returnedthan requested. The service uses this parameter or 100 items, whichever issmaller.

func (*OperationsListCall)PageTokenadded inv0.141.0

func (c *OperationsListCall) PageToken(pageTokenstring) *OperationsListCall

PageToken sets the optional parameter "pageToken": A previously-returnedpage token representing part of the larger set of results to view.

func (*OperationsListCall)Pagesadded inv0.141.0

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.

typeOperationsServiceadded inv0.141.0

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

funcNewOperationsServiceadded inv0.141.0

func NewOperationsService(s *Service) *OperationsService

func (*OperationsService)AdvanceRelocateBucketadded inv0.201.0

func (r *OperationsService) AdvanceRelocateBucket(bucketstring, operationIdstring, advancerelocatebucketoperationrequest *AdvanceRelocateBucketOperationRequest) *OperationsAdvanceRelocateBucketCall

AdvanceRelocateBucket: Starts asynchronous advancement of the relocatebucket operation in the case of required write downtime, to allow it to lockthe bucket at the source location, and proceed with the bucket locationswap. The server makes a best effort to advance the relocate bucketoperation, but success is not guaranteed.

- bucket: Name of the bucket to advance the relocate for.- operationId: ID of the operation resource.

func (*OperationsService)Canceladded inv0.141.0

func (r *OperationsService) Cancel(bucketstring, operationIdstring) *OperationsCancelCall

Cancel: Starts asynchronous cancellation on a long-running operation. Theserver makes a best effort to cancel the operation, but success is notguaranteed.

- bucket: The parent bucket of the operation resource.- operationId: The ID of the operation resource.

func (*OperationsService)Getadded inv0.141.0

func (r *OperationsService) Get(bucketstring, operationIdstring) *OperationsGetCall

Get: Gets the latest state of a long-running operation.

- bucket: The parent bucket of the operation resource.- operationId: The ID of the operation resource.

func (*OperationsService)Listadded inv0.141.0

List: Lists operations that match the specified filter in the request.

- bucket: Name of the bucket in which to look for operations.

typePolicy

type Policy struct {// Bindings: An association between a role, which comes with a set of// permissions, and members who may assume that role.Bindings []*PolicyBindings `json:"bindings,omitempty"`// Etag: HTTP 1.1  Entity tag for the policy.Etagstring `json:"etag,omitempty"`// Kind: The kind of item this is. For policies, this is always storage#policy.// This field is ignored on input.Kindstring `json:"kind,omitempty"`// ResourceId: The ID of the resource to which this policy belongs. Will be of// the form projects/_/buckets/bucket for buckets,// projects/_/buckets/bucket/objects/object for objects, and// projects/_/buckets/bucket/managedFolders/managedFolder. A specific// generation may be specified by appending #generationNumber to the end of the// object name, e.g. projects/_/buckets/my-bucket/objects/data.txt#17. The// current generation can be denoted with #0. This field is ignored on input.ResourceIdstring `json:"resourceId,omitempty"`// Version: The IAM policy format version.Versionint64 `json:"version,omitempty"`// ServerResponse contains the HTTP response code and headers from the server.googleapi.ServerResponse `json:"-"`// ForceSendFields is a list of field names (e.g. "Bindings") 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. "Bindings") 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:"-"`}

Policy: A bucket/object/managedFolder IAM policy.

func (Policy)MarshalJSON

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

typePolicyBindings

type PolicyBindings struct {// Condition: The condition that is associated with this binding. NOTE: an// unsatisfied condition will not allow user access via current binding.// Different bindings, including their conditions, are examined independently.Condition *Expr `json:"condition,omitempty"`// Members: A collection of identifiers for members who may assume the provided// role. Recognized identifiers are as follows:// - allUsers - A special identifier that represents anyone on the internet;// with or without a Google account.// - allAuthenticatedUsers - A special identifier that represents anyone who is// authenticated with a Google account or a service account.// - user:emailid - An email address that represents a specific account. For// example, user:alice@gmail.com or user:joe@example.com.// - serviceAccount:emailid - An email address that represents a service// account. For example,// serviceAccount:my-other-app@appspot.gserviceaccount.com .// - group:emailid - An email address that represents a Google group. For// example, group:admins@example.com.// - domain:domain - A Google Apps domain name that represents all the users of// that domain. For example, domain:google.com or domain:example.com.// - projectOwner:projectid - Owners of the given project. For example,// projectOwner:my-example-project// - projectEditor:projectid - Editors of the given project. For example,// projectEditor:my-example-project// - projectViewer:projectid - Viewers of the given project. For example,// projectViewer:my-example-projectMembers []string `json:"members,omitempty"`// Role: The role to which members belong. Two types of roles are supported:// new IAM roles, which grant permissions that do not map directly to those// provided by ACLs, and legacy IAM roles, which do map directly to ACL// permissions. All roles are of the format roles/storage.specificRole.// The new IAM roles are:// - roles/storage.admin - Full control of Google Cloud Storage resources.// - roles/storage.objectViewer - Read-Only access to Google Cloud Storage// objects.// - roles/storage.objectCreator - Access to create objects in Google Cloud// Storage.// - roles/storage.objectAdmin - Full control of Google Cloud Storage objects.//  The legacy IAM roles are:// - roles/storage.legacyObjectReader - Read-only access to objects without// listing. Equivalent to an ACL entry on an object with the READER role.// - roles/storage.legacyObjectOwner - Read/write access to existing objects// without listing. Equivalent to an ACL entry on an object with the OWNER// role.// - roles/storage.legacyBucketReader - Read access to buckets with object// listing. Equivalent to an ACL entry on a bucket with the READER role.// - roles/storage.legacyBucketWriter - Read access to buckets with object// listing/creation/deletion. Equivalent to an ACL entry on a bucket with the// WRITER role.// - roles/storage.legacyBucketOwner - Read and write access to existing// buckets with object listing/creation/deletion. Equivalent to an ACL entry on// a bucket with the OWNER role.Rolestring `json:"role,omitempty"`// ForceSendFields is a list of field names (e.g. "Condition") 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. "Condition") 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 (PolicyBindings)MarshalJSON

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

typeProjectsHmacKeysCreateCalladded inv0.4.0

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

func (*ProjectsHmacKeysCreateCall)Contextadded inv0.4.0

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

func (*ProjectsHmacKeysCreateCall)Doadded inv0.4.0

Do executes the "storage.projects.hmacKeys.create" call.Any non-2xx status code is an error. Response headers are in either*HmacKey.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 (*ProjectsHmacKeysCreateCall)Fieldsadded inv0.4.0

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

func (*ProjectsHmacKeysCreateCall)Headeradded inv0.4.0

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

func (*ProjectsHmacKeysCreateCall)UserProjectadded inv0.5.0

UserProject sets the optional parameter "userProject": The project to bebilled for this request.

typeProjectsHmacKeysDeleteCalladded inv0.4.0

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

func (*ProjectsHmacKeysDeleteCall)Contextadded inv0.4.0

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

func (*ProjectsHmacKeysDeleteCall)Doadded inv0.4.0

Do executes the "storage.projects.hmacKeys.delete" call.

func (*ProjectsHmacKeysDeleteCall)Fieldsadded inv0.4.0

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

func (*ProjectsHmacKeysDeleteCall)Headeradded inv0.4.0

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

func (*ProjectsHmacKeysDeleteCall)UserProjectadded inv0.5.0

UserProject sets the optional parameter "userProject": The project to bebilled for this request.

typeProjectsHmacKeysGetCalladded inv0.4.0

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

func (*ProjectsHmacKeysGetCall)Contextadded inv0.4.0

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

func (*ProjectsHmacKeysGetCall)Doadded inv0.4.0

Do executes the "storage.projects.hmacKeys.get" call.Any non-2xx status code is an error. Response headers are in either*HmacKeyMetadata.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 (*ProjectsHmacKeysGetCall)Fieldsadded inv0.4.0

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

func (*ProjectsHmacKeysGetCall)Headeradded inv0.4.0

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

func (*ProjectsHmacKeysGetCall)IfNoneMatchadded inv0.4.0

func (c *ProjectsHmacKeysGetCall) IfNoneMatch(entityTagstring) *ProjectsHmacKeysGetCall

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 (*ProjectsHmacKeysGetCall)UserProjectadded inv0.5.0

func (c *ProjectsHmacKeysGetCall) UserProject(userProjectstring) *ProjectsHmacKeysGetCall

UserProject sets the optional parameter "userProject": The project to bebilled for this request.

typeProjectsHmacKeysListCalladded inv0.4.0

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

func (*ProjectsHmacKeysListCall)Contextadded inv0.4.0

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

func (*ProjectsHmacKeysListCall)Doadded inv0.4.0

Do executes the "storage.projects.hmacKeys.list" call.Any non-2xx status code is an error. Response headers are in either*HmacKeysMetadata.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 (*ProjectsHmacKeysListCall)Fieldsadded inv0.4.0

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

func (*ProjectsHmacKeysListCall)Headeradded inv0.4.0

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

func (*ProjectsHmacKeysListCall)IfNoneMatchadded inv0.4.0

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 (*ProjectsHmacKeysListCall)MaxResultsadded inv0.4.0

MaxResults sets the optional parameter "maxResults": Maximum number of itemsto return in a single page of responses. The service uses this parameter or250 items, whichever is smaller. The max number of items per page will alsobe limited by the number of distinct service accounts in the response. Ifthe number of service accounts in a single response is too high, the pagewill truncated and a next page token will be returned.

func (*ProjectsHmacKeysListCall)PageTokenadded inv0.4.0

PageToken sets the optional parameter "pageToken": A previously-returnedpage token representing part of the larger set of results to view.

func (*ProjectsHmacKeysListCall)Pagesadded inv0.4.0

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 (*ProjectsHmacKeysListCall)ServiceAccountEmailadded inv0.4.0

func (c *ProjectsHmacKeysListCall) ServiceAccountEmail(serviceAccountEmailstring) *ProjectsHmacKeysListCall

ServiceAccountEmail sets the optional parameter "serviceAccountEmail": Ifpresent, only keys for the given service account are returned.

func (*ProjectsHmacKeysListCall)ShowDeletedKeysadded inv0.4.0

func (c *ProjectsHmacKeysListCall) ShowDeletedKeys(showDeletedKeysbool) *ProjectsHmacKeysListCall

ShowDeletedKeys sets the optional parameter "showDeletedKeys": Whether ornot to show keys in the DELETED state.

func (*ProjectsHmacKeysListCall)UserProjectadded inv0.5.0

func (c *ProjectsHmacKeysListCall) UserProject(userProjectstring) *ProjectsHmacKeysListCall

UserProject sets the optional parameter "userProject": The project to bebilled for this request.

typeProjectsHmacKeysServiceadded inv0.4.0

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

funcNewProjectsHmacKeysServiceadded inv0.4.0

func NewProjectsHmacKeysService(s *Service) *ProjectsHmacKeysService

func (*ProjectsHmacKeysService)Createadded inv0.4.0

func (r *ProjectsHmacKeysService) Create(projectIdstring, serviceAccountEmailstring) *ProjectsHmacKeysCreateCall

Create: Creates a new HMAC key for the specified service account.

- projectId: Project ID owning the service account.- serviceAccountEmail: Email address of the service account.

func (*ProjectsHmacKeysService)Deleteadded inv0.4.0

Delete: Deletes an HMAC key.

- accessId: Name of the HMAC key to be deleted.- projectId: Project ID owning the requested key.

func (*ProjectsHmacKeysService)Getadded inv0.4.0

Get: Retrieves an HMAC key's metadata

- accessId: Name of the HMAC key.- projectId: Project ID owning the service account of the requested key.

func (*ProjectsHmacKeysService)Listadded inv0.4.0

List: Retrieves a list of HMAC keys matching the criteria.

- projectId: Name of the project in which to look for HMAC keys.

func (*ProjectsHmacKeysService)Updateadded inv0.4.0

func (r *ProjectsHmacKeysService) Update(projectIdstring, accessIdstring, hmackeymetadata *HmacKeyMetadata) *ProjectsHmacKeysUpdateCall

Update: Updates the state of an HMAC key. See the HMAC Key resourcedescriptor(https://cloud.google.com/storage/docs/json_api/v1/projects/hmacKeys/update#request-body)for valid states.

- accessId: Name of the HMAC key being updated.- projectId: Project ID owning the service account of the updated key.

typeProjectsHmacKeysUpdateCalladded inv0.4.0

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

func (*ProjectsHmacKeysUpdateCall)Contextadded inv0.4.0

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

func (*ProjectsHmacKeysUpdateCall)Doadded inv0.4.0

Do executes the "storage.projects.hmacKeys.update" call.Any non-2xx status code is an error. Response headers are in either*HmacKeyMetadata.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 (*ProjectsHmacKeysUpdateCall)Fieldsadded inv0.4.0

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

func (*ProjectsHmacKeysUpdateCall)Headeradded inv0.4.0

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

func (*ProjectsHmacKeysUpdateCall)UserProjectadded inv0.5.0

UserProject sets the optional parameter "userProject": The project to bebilled for this request.

typeProjectsService

type ProjectsService struct {HmacKeys *ProjectsHmacKeysServiceServiceAccount *ProjectsServiceAccountService// contains filtered or unexported fields}

funcNewProjectsService

func NewProjectsService(s *Service) *ProjectsService

typeProjectsServiceAccountGetCall

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

func (*ProjectsServiceAccountGetCall)Context

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

func (*ProjectsServiceAccountGetCall)Do

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

func (*ProjectsServiceAccountGetCall)Fields

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

func (*ProjectsServiceAccountGetCall)Header

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

func (*ProjectsServiceAccountGetCall)IfNoneMatch

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 (*ProjectsServiceAccountGetCall)UserProject

UserProject sets the optional parameter "userProject": The project to bebilled for this request.

typeProjectsServiceAccountService

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

funcNewProjectsServiceAccountService

func NewProjectsServiceAccountService(s *Service) *ProjectsServiceAccountService

func (*ProjectsServiceAccountService)Get

Get: Get the email address of this project's Google Cloud Storage serviceaccount.

- projectId: Project ID.

typeRelocateBucketRequestadded inv0.200.0

type RelocateBucketRequest struct {// DestinationCustomPlacementConfig: The bucket's new custom placement// configuration if relocating to a Custom Dual Region.DestinationCustomPlacementConfig *RelocateBucketRequestDestinationCustomPlacementConfig `json:"destinationCustomPlacementConfig,omitempty"`// DestinationLocation: The new location the bucket will be relocated to.DestinationLocationstring `json:"destinationLocation,omitempty"`// ValidateOnly: If true, validate the operation, but do not actually relocate// the bucket.ValidateOnlybool `json:"validateOnly,omitempty"`// ForceSendFields is a list of field names (e.g.// "DestinationCustomPlacementConfig") 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.// "DestinationCustomPlacementConfig") to include in API requests with the JSON// null value. By default, fields with empty values are omitted from API// requests. Seehttps://pkg.go.dev/google.golang.org/api#hdr-NullFields for// more details.NullFields []string `json:"-"`}

RelocateBucketRequest: A Relocate Bucket request.

func (RelocateBucketRequest)MarshalJSONadded inv0.200.0

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

typeRelocateBucketRequestDestinationCustomPlacementConfigadded inv0.200.0

type RelocateBucketRequestDestinationCustomPlacementConfig struct {// DataLocations: The list of regional locations in which data is placed.DataLocations []string `json:"dataLocations,omitempty"`// ForceSendFields is a list of field names (e.g. "DataLocations") 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. "DataLocations") 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:"-"`}

RelocateBucketRequestDestinationCustomPlacementConfig: The bucket's newcustom placement configuration if relocating to a Custom Dual Region.

func (RelocateBucketRequestDestinationCustomPlacementConfig)MarshalJSONadded inv0.200.0

typeRewriteResponse

type RewriteResponse struct {// Done: true if the copy is finished; otherwise, false if the copy is in// progress. This property is always present in the response.Donebool `json:"done,omitempty"`// Kind: The kind of item this is.Kindstring `json:"kind,omitempty"`// ObjectSize: The total size of the object being copied in bytes. This// property is always present in the response.ObjectSizeint64 `json:"objectSize,omitempty,string"`// Resource: A resource containing the metadata for the copied-to object. This// property is present in the response only when copying completes.Resource *Object `json:"resource,omitempty"`// RewriteToken: A token to use in subsequent requests to continue copying// data. This token is present in the response only when there is more data to// copy.RewriteTokenstring `json:"rewriteToken,omitempty"`// TotalBytesRewritten: The total bytes written so far, which can be used to// provide a waiting user with a progress indicator. This property is always// present in the response.TotalBytesRewrittenint64 `json:"totalBytesRewritten,omitempty,string"`// 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:"-"`}

RewriteResponse: A rewrite response.

func (RewriteResponse)MarshalJSON

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

typeService

type Service struct {BasePathstring// API endpoint base URLUserAgentstring// optional additional User-Agent fragmentAnywhereCaches *AnywhereCachesServiceBucketAccessControls *BucketAccessControlsServiceBuckets *BucketsServiceChannels *ChannelsServiceDefaultObjectAccessControls *DefaultObjectAccessControlsServiceFolders *FoldersServiceManagedFolders *ManagedFoldersServiceNotifications *NotificationsServiceObjectAccessControls *ObjectAccessControlsServiceObjects *ObjectsServiceOperations *OperationsServiceProjects *ProjectsService// contains filtered or unexported fields}

funcNewdeprecated

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

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

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

funcNewServiceadded inv0.3.0

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

NewService creates a new Service.

typeServiceAccount

type ServiceAccount struct {// EmailAddress: The ID of the notification.EmailAddressstring `json:"email_address,omitempty"`// Kind: The kind of item this is. For notifications, this is always// storage#notification.Kindstring `json:"kind,omitempty"`// ServerResponse contains the HTTP response code and headers from the server.googleapi.ServerResponse `json:"-"`// ForceSendFields is a list of field names (e.g. "EmailAddress") 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. "EmailAddress") 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:"-"`}

ServiceAccount: A subscription to receive Google PubSub notifications.

func (ServiceAccount)MarshalJSON

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

typeTestIamPermissionsResponse

type TestIamPermissionsResponse struct {// Kind: The kind of item this is.Kindstring `json:"kind,omitempty"`// Permissions: The permissions held by the caller. Permissions are always of// the format storage.resource.capability, where resource is one of buckets,// objects, or managedFolders. The supported permissions are as follows:// - storage.buckets.delete - Delete bucket.// - storage.buckets.get - Read bucket metadata.// - storage.buckets.getIamPolicy - Read bucket IAM policy.// - storage.buckets.create - Create bucket.// - storage.buckets.list - List buckets.// - storage.buckets.setIamPolicy - Update bucket IAM policy.// - storage.buckets.update - Update bucket metadata.// - storage.objects.delete - Delete object.// - storage.objects.get - Read object data and metadata.// - storage.objects.getIamPolicy - Read object IAM policy.// - storage.objects.create - Create object.// - storage.objects.list - List objects.// - storage.objects.setIamPolicy - Update object IAM policy.// - storage.objects.update - Update object metadata.// - storage.managedFolders.delete - Delete managed folder.// - storage.managedFolders.get - Read managed folder metadata.// - storage.managedFolders.getIamPolicy - Read managed folder IAM policy.// - storage.managedFolders.create - Create managed folder.// - storage.managedFolders.list - List managed folders.// - storage.managedFolders.setIamPolicy - Update managed folder IAM policy.Permissions []string `json:"permissions,omitempty"`// ServerResponse contains the HTTP response code and headers from the server.googleapi.ServerResponse `json:"-"`// ForceSendFields is a list of field names (e.g. "Kind") 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. "Kind") 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:"-"`}

TestIamPermissionsResponse: Astorage.(buckets|objects|managedFolders).testIamPermissions response.

func (TestIamPermissionsResponse)MarshalJSON

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

Source Files

View all Source files

Jump to

Keyboard shortcuts

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

[8]ページ先頭

©2009-2025 Movatter.jp