OAuth2 scopes used by this API.
const (
// View and manage your data across Google Cloud Platform services
CloudPlatformScope = "https://www.googleapis.com/auth/cloud-platform"
// View your data across Google Cloud Platform services
CloudPlatformReadOnlyScope = "https://www.googleapis.com/auth/cloud-platform.read-only"
// Manage your data and permissions in Google Cloud Storage
DevstorageFullControlScope = "https://www.googleapis.com/auth/devstorage.full_control"
// View your data in Google Cloud Storage
DevstorageReadOnlyScope = "https://www.googleapis.com/auth/devstorage.read_only"
// Manage your data in Google Cloud Storage
DevstorageReadWriteScope = "https://www.googleapis.com/auth/devstorage.read_write"
)
AnywhereCache: An Anywhere Cache instance.
type AnywhereCache struct {
// AdmissionPolicy: The cache-level entry admission policy.
AdmissionPolicy string `json:"admissionPolicy,omitempty"`
// AnywhereCacheId: The ID of the Anywhere cache instance.
AnywhereCacheId string `json:"anywhereCacheId,omitempty"`
// Bucket: The name of the bucket containing this cache instance.
Bucket string `json:"bucket,omitempty"`
// CreateTime: The creation time of the cache instance in RFC 3339 format.
CreateTime string `json:"createTime,omitempty"`
// Id: The ID of the resource, including the project number, bucket name and
// anywhere cache ID.
Id string `json:"id,omitempty"`
// Kind: The kind of item this is. For Anywhere Cache, this is always
// storage#anywhereCache.
Kind string `json:"kind,omitempty"`
// PendingUpdate: True if the cache instance has an active Update long-running
// operation.
PendingUpdate bool `json:"pendingUpdate,omitempty"`
// SelfLink: The link to this cache instance.
SelfLink string `json:"selfLink,omitempty"`
// State: The current state of the cache instance.
State string `json:"state,omitempty"`
// Ttl: The TTL of all cache entries in whole seconds. e.g., "7200s".
Ttl string `json:"ttl,omitempty"`
// UpdateTime: The modification time of the cache instance metadata in RFC 3339
// format.
UpdateTime string `json:"updateTime,omitempty"`
// Zone: The zone in which the cache instance is running. For example,
// us-central1-a.
Zone string `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:"-"`
}
func (s *AnywhereCache) MarshalJSON() ([]byte, error)
AnywhereCaches: A list of Anywhere Caches.
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.
Kind string `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.
NextPageToken string `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:"-"`
}
func (s *AnywhereCaches) MarshalJSON() ([]byte, error)
type AnywhereCachesDisableCall struct {
// contains filtered or unexported fields
}
func (c *AnywhereCachesDisableCall) Context(ctx context.Context) *AnywhereCachesDisableCall
Context sets the context to be used in this call's Do method.
func (c *AnywhereCachesDisableCall) Do(opts ...googleapi.CallOption) (*AnywhereCache, error)
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 check whether the returned error was because http.StatusNotModified was returned.
func (c *AnywhereCachesDisableCall) Fields(s ...googleapi.Field) *AnywhereCachesDisableCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.
func (c *AnywhereCachesDisableCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
type AnywhereCachesGetCall struct {
// contains filtered or unexported fields
}
func (c *AnywhereCachesGetCall) Context(ctx context.Context) *AnywhereCachesGetCall
Context sets the context to be used in this call's Do method.
func (c *AnywhereCachesGetCall) Do(opts ...googleapi.CallOption) (*AnywhereCache, error)
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 check whether the returned error was because http.StatusNotModified was returned.
func (c *AnywhereCachesGetCall) Fields(s ...googleapi.Field) *AnywhereCachesGetCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.
func (c *AnywhereCachesGetCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
func (c *AnywhereCachesGetCall) IfNoneMatch(entityTag string) *AnywhereCachesGetCall
IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.
type AnywhereCachesInsertCall struct {
// contains filtered or unexported fields
}
func (c *AnywhereCachesInsertCall) Context(ctx context.Context) *AnywhereCachesInsertCall
Context sets the context to be used in this call's Do method.
func (c *AnywhereCachesInsertCall) Do(opts ...googleapi.CallOption) (*GoogleLongrunningOperation, error)
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 was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (c *AnywhereCachesInsertCall) Fields(s ...googleapi.Field) *AnywhereCachesInsertCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.
func (c *AnywhereCachesInsertCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
type AnywhereCachesListCall struct {
// contains filtered or unexported fields
}
func (c *AnywhereCachesListCall) Context(ctx context.Context) *AnywhereCachesListCall
Context sets the context to be used in this call's Do method.
func (c *AnywhereCachesListCall) Do(opts ...googleapi.CallOption) (*AnywhereCaches, error)
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 check whether the returned error was because http.StatusNotModified was returned.
func (c *AnywhereCachesListCall) Fields(s ...googleapi.Field) *AnywhereCachesListCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.
func (c *AnywhereCachesListCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
func (c *AnywhereCachesListCall) IfNoneMatch(entityTag string) *AnywhereCachesListCall
IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.
func (c *AnywhereCachesListCall) PageSize(pageSize int64) *AnywhereCachesListCall
PageSize sets the optional parameter "pageSize": Maximum number of items to return in a single page of responses. Maximum 1000.
func (c *AnywhereCachesListCall) PageToken(pageToken string) *AnywhereCachesListCall
PageToken sets the optional parameter "pageToken": A previously-returned page token representing part of the larger set of results to view.
func (c *AnywhereCachesListCall) Pages(ctx context.Context, f func(*AnywhereCaches) error) error
Pages invokes f for each page of results. A non-nil error returned from f will halt the iteration. The provided context supersedes any context provided to the Context method.
type AnywhereCachesPauseCall struct {
// contains filtered or unexported fields
}
func (c *AnywhereCachesPauseCall) Context(ctx context.Context) *AnywhereCachesPauseCall
Context sets the context to be used in this call's Do method.
func (c *AnywhereCachesPauseCall) Do(opts ...googleapi.CallOption) (*AnywhereCache, error)
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 check whether the returned error was because http.StatusNotModified was returned.
func (c *AnywhereCachesPauseCall) Fields(s ...googleapi.Field) *AnywhereCachesPauseCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.
func (c *AnywhereCachesPauseCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
type AnywhereCachesResumeCall struct {
// contains filtered or unexported fields
}
func (c *AnywhereCachesResumeCall) Context(ctx context.Context) *AnywhereCachesResumeCall
Context sets the context to be used in this call's Do method.
func (c *AnywhereCachesResumeCall) Do(opts ...googleapi.CallOption) (*AnywhereCache, error)
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 check whether the returned error was because http.StatusNotModified was returned.
func (c *AnywhereCachesResumeCall) Fields(s ...googleapi.Field) *AnywhereCachesResumeCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.
func (c *AnywhereCachesResumeCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
type AnywhereCachesService struct {
// contains filtered or unexported fields
}
func NewAnywhereCachesService(s *Service) *AnywhereCachesService
func (r *AnywhereCachesService) Disable(bucket string, anywhereCacheId string) *AnywhereCachesDisableCall
Disable: Disables an Anywhere Cache instance.
- anywhereCacheId: The ID of requested Anywhere Cache instance. - bucket: Name of the parent bucket.
func (r *AnywhereCachesService) Get(bucket string, anywhereCacheId string) *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 (r *AnywhereCachesService) Insert(bucket string, anywherecache *AnywhereCache) *AnywhereCachesInsertCall
Insert: Creates an Anywhere Cache instance.
- bucket: Name of the parent bucket.
func (r *AnywhereCachesService) List(bucket string) *AnywhereCachesListCall
List: Returns a list of Anywhere Cache instances of the bucket matching the criteria.
- bucket: Name of the parent bucket.
func (r *AnywhereCachesService) Pause(bucket string, anywhereCacheId string) *AnywhereCachesPauseCall
Pause: Pauses an Anywhere Cache instance.
- anywhereCacheId: The ID of requested Anywhere Cache instance. - bucket: Name of the parent bucket.
func (r *AnywhereCachesService) Resume(bucket string, anywhereCacheId string) *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 (r *AnywhereCachesService) Update(bucket string, anywhereCacheId string, anywherecache *AnywhereCache) *AnywhereCachesUpdateCall
Update: Updates the config(ttl and admissionPolicy) of an Anywhere Cache instance.
- anywhereCacheId: The ID of requested Anywhere Cache instance. - bucket: Name of the parent bucket.
type AnywhereCachesUpdateCall struct {
// contains filtered or unexported fields
}
func (c *AnywhereCachesUpdateCall) Context(ctx context.Context) *AnywhereCachesUpdateCall
Context sets the context to be used in this call's Do method.
func (c *AnywhereCachesUpdateCall) Do(opts ...googleapi.CallOption) (*GoogleLongrunningOperation, error)
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 was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (c *AnywhereCachesUpdateCall) Fields(s ...googleapi.Field) *AnywhereCachesUpdateCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.
func (c *AnywhereCachesUpdateCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
Bucket: A bucket.
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.
DefaultEventBasedHold bool `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.
Etag string `json:"etag,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.
Id string `json:"id,omitempty"`
// Kind: The kind of item this is. For buckets, this is always storage#bucket.
Kind string `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
// 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 for the authoritative list.
Location string `json:"location,omitempty"`
// LocationType: The type of the bucket location.
LocationType string `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.
Metageneration int64 `json:"metageneration,omitempty,string"`
// Name: The name of the bucket.
Name string `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.
ProjectNumber uint64 `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.
Rpo string `json:"rpo,omitempty"`
// SatisfiesPZS: Reserved for future use.
SatisfiesPZS bool `json:"satisfiesPZS,omitempty"`
// SelfLink: The URI of this bucket.
SelfLink string `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"`
// 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.
StorageClass string `json:"storageClass,omitempty"`
// TimeCreated: The creation time of the bucket in RFC 3339 format.
TimeCreated string `json:"timeCreated,omitempty"`
// Updated: The modification time of the bucket in RFC 3339 format.
Updated string `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 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:"-"`
}
func (s *Bucket) MarshalJSON() ([]byte, error)
BucketAccessControl: An access-control entry.
type BucketAccessControl struct {
// Bucket: The name of the bucket.
Bucket string `json:"bucket,omitempty"`
// Domain: The domain associated with the entity, if any.
Domain string `json:"domain,omitempty"`
// Email: The email address associated with the entity, if any.
Email string `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.
Entity string `json:"entity,omitempty"`
// EntityId: The ID for the entity, if any.
EntityId string `json:"entityId,omitempty"`
// Etag: HTTP 1.1 Entity tag for the access-control entry.
Etag string `json:"etag,omitempty"`
// Id: The ID of the access-control entry.
Id string `json:"id,omitempty"`
// Kind: The kind of item this is. For bucket access control entries, this is
// always storage#bucketAccessControl.
Kind string `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.
Role string `json:"role,omitempty"`
// SelfLink: The link to this access-control entry.
SelfLink string `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:"-"`
}
func (s *BucketAccessControl) MarshalJSON() ([]byte, error)
BucketAccessControlProjectTeam: The project team associated with the entity, if any.
type BucketAccessControlProjectTeam struct {
// ProjectNumber: The project number.
ProjectNumber string `json:"projectNumber,omitempty"`
// Team: The team.
Team string `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:"-"`
}
func (s *BucketAccessControlProjectTeam) MarshalJSON() ([]byte, error)
BucketAccessControls: An access-control list.
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.
Kind string `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:"-"`
}
func (s *BucketAccessControls) MarshalJSON() ([]byte, error)
type BucketAccessControlsDeleteCall struct {
// contains filtered or unexported fields
}
func (c *BucketAccessControlsDeleteCall) Context(ctx context.Context) *BucketAccessControlsDeleteCall
Context sets the context to be used in this call's Do method.
func (c *BucketAccessControlsDeleteCall) Do(opts ...googleapi.CallOption) error
Do executes the "storage.bucketAccessControls.delete" call.
func (c *BucketAccessControlsDeleteCall) Fields(s ...googleapi.Field) *BucketAccessControlsDeleteCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.
func (c *BucketAccessControlsDeleteCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
func (c *BucketAccessControlsDeleteCall) UserProject(userProject string) *BucketAccessControlsDeleteCall
UserProject sets the optional parameter "userProject": The project to be billed for this request. Required for Requester Pays buckets.
type BucketAccessControlsGetCall struct {
// contains filtered or unexported fields
}
func (c *BucketAccessControlsGetCall) Context(ctx context.Context) *BucketAccessControlsGetCall
Context sets the context to be used in this call's Do method.
func (c *BucketAccessControlsGetCall) Do(opts ...googleapi.CallOption) (*BucketAccessControl, error)
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 at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (c *BucketAccessControlsGetCall) Fields(s ...googleapi.Field) *BucketAccessControlsGetCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.
func (c *BucketAccessControlsGetCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
func (c *BucketAccessControlsGetCall) IfNoneMatch(entityTag string) *BucketAccessControlsGetCall
IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.
func (c *BucketAccessControlsGetCall) UserProject(userProject string) *BucketAccessControlsGetCall
UserProject sets the optional parameter "userProject": The project to be billed for this request. Required for Requester Pays buckets.
type BucketAccessControlsInsertCall struct {
// contains filtered or unexported fields
}
func (c *BucketAccessControlsInsertCall) Context(ctx context.Context) *BucketAccessControlsInsertCall
Context sets the context to be used in this call's Do method.
func (c *BucketAccessControlsInsertCall) Do(opts ...googleapi.CallOption) (*BucketAccessControl, error)
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 at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (c *BucketAccessControlsInsertCall) Fields(s ...googleapi.Field) *BucketAccessControlsInsertCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.
func (c *BucketAccessControlsInsertCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
func (c *BucketAccessControlsInsertCall) UserProject(userProject string) *BucketAccessControlsInsertCall
UserProject sets the optional parameter "userProject": The project to be billed for this request. Required for Requester Pays buckets.
type BucketAccessControlsListCall struct {
// contains filtered or unexported fields
}
func (c *BucketAccessControlsListCall) Context(ctx context.Context) *BucketAccessControlsListCall
Context sets the context to be used in this call's Do method.
func (c *BucketAccessControlsListCall) Do(opts ...googleapi.CallOption) (*BucketAccessControls, error)
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 returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (c *BucketAccessControlsListCall) Fields(s ...googleapi.Field) *BucketAccessControlsListCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.
func (c *BucketAccessControlsListCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
func (c *BucketAccessControlsListCall) IfNoneMatch(entityTag string) *BucketAccessControlsListCall
IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.
func (c *BucketAccessControlsListCall) UserProject(userProject string) *BucketAccessControlsListCall
UserProject sets the optional parameter "userProject": The project to be billed for this request. Required for Requester Pays buckets.
type BucketAccessControlsPatchCall struct {
// contains filtered or unexported fields
}
func (c *BucketAccessControlsPatchCall) Context(ctx context.Context) *BucketAccessControlsPatchCall
Context sets the context to be used in this call's Do method.
func (c *BucketAccessControlsPatchCall) Do(opts ...googleapi.CallOption) (*BucketAccessControl, error)
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 at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (c *BucketAccessControlsPatchCall) Fields(s ...googleapi.Field) *BucketAccessControlsPatchCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.
func (c *BucketAccessControlsPatchCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
func (c *BucketAccessControlsPatchCall) UserProject(userProject string) *BucketAccessControlsPatchCall
UserProject sets the optional parameter "userProject": The project to be billed for this request. Required for Requester Pays buckets.
type BucketAccessControlsService struct {
// contains filtered or unexported fields
}
func NewBucketAccessControlsService(s *Service) *BucketAccessControlsService
func (r *BucketAccessControlsService) Delete(bucket string, entity string) *BucketAccessControlsDeleteCall
Delete: Permanently deletes the ACL entry for the specified entity on the specified bucket.
func (r *BucketAccessControlsService) Get(bucket string, entity string) *BucketAccessControlsGetCall
Get: Returns the ACL entry for the specified entity on the specified bucket.
func (r *BucketAccessControlsService) Insert(bucket string, bucketaccesscontrol *BucketAccessControl) *BucketAccessControlsInsertCall
Insert: Creates a new ACL entry on the specified bucket.
- bucket: Name of a bucket.
func (r *BucketAccessControlsService) List(bucket string) *BucketAccessControlsListCall
List: Retrieves ACL entries on the specified bucket.
- bucket: Name of a bucket.
func (r *BucketAccessControlsService) Patch(bucket string, entity string, bucketaccesscontrol *BucketAccessControl) *BucketAccessControlsPatchCall
Patch: Patches an ACL entry on the specified bucket.
func (r *BucketAccessControlsService) Update(bucket string, entity string, bucketaccesscontrol *BucketAccessControl) *BucketAccessControlsUpdateCall
Update: Updates an ACL entry on the specified bucket.
type BucketAccessControlsUpdateCall struct {
// contains filtered or unexported fields
}
func (c *BucketAccessControlsUpdateCall) Context(ctx context.Context) *BucketAccessControlsUpdateCall
Context sets the context to be used in this call's Do method.
func (c *BucketAccessControlsUpdateCall) Do(opts ...googleapi.CallOption) (*BucketAccessControl, error)
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 at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (c *BucketAccessControlsUpdateCall) Fields(s ...googleapi.Field) *BucketAccessControlsUpdateCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.
func (c *BucketAccessControlsUpdateCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
func (c *BucketAccessControlsUpdateCall) UserProject(userProject string) *BucketAccessControlsUpdateCall
UserProject sets the optional parameter "userProject": The project to be billed for this request. Required for Requester Pays buckets.
BucketAutoclass: The bucket's Autoclass configuration.
type BucketAutoclass struct {
// Enabled: Whether or not Autoclass is enabled on this bucket
Enabled bool `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.
TerminalStorageClass string `json:"terminalStorageClass,omitempty"`
// TerminalStorageClassUpdateTime: A date and time in RFC 3339 format
// representing the time of the most recent update to "terminalStorageClass".
TerminalStorageClassUpdateTime string `json:"terminalStorageClassUpdateTime,omitempty"`
// ToggleTime: A date and time in RFC 3339 format representing the instant at
// which "enabled" was last toggled.
ToggleTime string `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:"-"`
}
func (s *BucketAutoclass) MarshalJSON() ([]byte, error)
BucketBilling: The bucket's billing configuration.
type BucketBilling struct {
// RequesterPays: When set to true, Requester Pays is enabled for this bucket.
RequesterPays bool `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:"-"`
}
func (s *BucketBilling) MarshalJSON() ([]byte, error)
type BucketCors struct {
// MaxAgeSeconds: The value, in seconds, to return in the
// Access-Control-Max-Age header used in preflight responses.
MaxAgeSeconds int64 `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 (s *BucketCors) MarshalJSON() ([]byte, error)
BucketCustomPlacementConfig: The bucket's custom placement configuration for Custom Dual Regions.
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:"-"`
}
func (s *BucketCustomPlacementConfig) MarshalJSON() ([]byte, error)
BucketEncryption: Encryption configuration for a bucket.
type BucketEncryption struct {
// DefaultKmsKeyName: A Cloud KMS key that will be used to encrypt objects
// inserted into this bucket, if no encryption method is specified.
DefaultKmsKeyName string `json:"defaultKmsKeyName,omitempty"`
// ForceSendFields is a list of field names (e.g. "DefaultKmsKeyName") 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. "DefaultKmsKeyName") 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 (s *BucketEncryption) MarshalJSON() ([]byte, error)
BucketHierarchicalNamespace: The bucket's hierarchical namespace configuration.
type BucketHierarchicalNamespace struct {
// Enabled: When set to true, hierarchical namespace is enabled for this
// bucket.
Enabled bool `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:"-"`
}
func (s *BucketHierarchicalNamespace) MarshalJSON() ([]byte, error)
BucketIamConfiguration: The bucket's IAM configuration.
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.
PublicAccessPrevention string `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:"-"`
}
func (s *BucketIamConfiguration) MarshalJSON() ([]byte, error)
BucketIamConfigurationBucketPolicyOnly: 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.
type BucketIamConfigurationBucketPolicyOnly struct {
// Enabled: If set, access is controlled only by bucket-level or above IAM
// policies.
Enabled bool `json:"enabled,omitempty"`
// LockedTime: The deadline for changing
// iamConfiguration.bucketPolicyOnly.enabled from true to false in RFC 3339
// format. iamConfiguration.bucketPolicyOnly.enabled may be changed from true
// to false until the locked time, after which the field is immutable.
LockedTime string `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:"-"`
}
func (s *BucketIamConfigurationBucketPolicyOnly) MarshalJSON() ([]byte, error)
BucketIamConfigurationUniformBucketLevelAccess: The bucket's uniform bucket-level access configuration.
type BucketIamConfigurationUniformBucketLevelAccess struct {
// Enabled: If set, access is controlled only by bucket-level or above IAM
// policies.
Enabled bool `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.
LockedTime string `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:"-"`
}
func (s *BucketIamConfigurationUniformBucketLevelAccess) MarshalJSON() ([]byte, error)
BucketLifecycle: The bucket's lifecycle configuration. See lifecycle management for more information.
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:"-"`
}
func (s *BucketLifecycle) MarshalJSON() ([]byte, error)
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 (s *BucketLifecycleRule) MarshalJSON() ([]byte, error)
BucketLifecycleRuleAction: The action to take.
type BucketLifecycleRuleAction struct {
// StorageClass: Target storage class. Required iff the type of the action is
// SetStorageClass.
StorageClass string `json:"storageClass,omitempty"`
// Type: Type of the action. Currently, only Delete, SetStorageClass, and
// AbortIncompleteMultipartUpload are supported.
Type string `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:"-"`
}
func (s *BucketLifecycleRuleAction) MarshalJSON() ([]byte, error)
BucketLifecycleRuleCondition: The condition(s) under which the action will be taken.
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 in RFC 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.
CreatedBefore string `json:"createdBefore,omitempty"`
// CustomTimeBefore: A date in RFC 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.
CustomTimeBefore string `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.
DaysSinceCustomTime int64 `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.
DaysSinceNoncurrentTime int64 `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.
MatchesPattern string `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 in RFC 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.
NoncurrentTimeBefore string `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.
NumNewerVersions int64 `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:"-"`
}
func (s *BucketLifecycleRuleCondition) MarshalJSON() ([]byte, error)
BucketLogging: The bucket's logging configuration, which defines the destination bucket and optional name prefix for the current bucket's logs.
type BucketLogging struct {
// LogBucket: The destination bucket where the current bucket's logs should be
// placed.
LogBucket string `json:"logBucket,omitempty"`
// LogObjectPrefix: A prefix for log object names.
LogObjectPrefix string `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:"-"`
}
func (s *BucketLogging) MarshalJSON() ([]byte, error)
BucketObjectRetention: The bucket's object retention config.
type BucketObjectRetention struct {
// Mode: The bucket's object retention mode. Can be Enabled.
Mode string `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:"-"`
}
func (s *BucketObjectRetention) MarshalJSON() ([]byte, error)
BucketOwner: The owner of the bucket. This is always the project team's owner group.
type BucketOwner struct {
// Entity: The entity, in the form project-owner-projectId.
Entity string `json:"entity,omitempty"`
// EntityId: The ID for the entity.
EntityId string `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:"-"`
}
func (s *BucketOwner) MarshalJSON() ([]byte, error)
BucketRetentionPolicy: 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.
type BucketRetentionPolicy struct {
// EffectiveTime: Server-determined value that indicates the time from which
// policy was enforced and effective. This value is in RFC 3339 format.
EffectiveTime string `json:"effectiveTime,omitempty"`
// IsLocked: Once locked, an object retention policy cannot be modified.
IsLocked bool `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.
RetentionPeriod int64 `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:"-"`
}
func (s *BucketRetentionPolicy) MarshalJSON() ([]byte, error)
BucketSoftDeletePolicy: The bucket's soft delete policy, which defines the period of time that soft-deleted objects will be retained, and cannot be permanently deleted.
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.
EffectiveTime string `json:"effectiveTime,omitempty"`
// RetentionDurationSeconds: The duration in seconds that soft-deleted objects
// in the bucket will be retained and cannot be permanently deleted.
RetentionDurationSeconds int64 `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:"-"`
}
func (s *BucketSoftDeletePolicy) MarshalJSON() ([]byte, error)
BucketVersioning: The bucket's versioning configuration.
type BucketVersioning struct {
// Enabled: While set to true, versioning is fully enabled for this bucket.
Enabled bool `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:"-"`
}
func (s *BucketVersioning) MarshalJSON() ([]byte, error)
BucketWebsite: The bucket's website configuration, controlling how the service behaves when accessing bucket contents as a web site. See the Static Website Examples for more information.
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.
MainPageSuffix string `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.
NotFoundPage string `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:"-"`
}
func (s *BucketWebsite) MarshalJSON() ([]byte, error)
Buckets: A list of buckets.
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.
Kind string `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.
NextPageToken string `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:"-"`
}
func (s *Buckets) MarshalJSON() ([]byte, error)
type BucketsDeleteCall struct {
// contains filtered or unexported fields
}
func (c *BucketsDeleteCall) Context(ctx context.Context) *BucketsDeleteCall
Context sets the context to be used in this call's Do method.
func (c *BucketsDeleteCall) Do(opts ...googleapi.CallOption) error
Do executes the "storage.buckets.delete" call.
func (c *BucketsDeleteCall) Fields(s ...googleapi.Field) *BucketsDeleteCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.
func (c *BucketsDeleteCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
func (c *BucketsDeleteCall) IfMetagenerationMatch(ifMetagenerationMatch int64) *BucketsDeleteCall
IfMetagenerationMatch sets the optional parameter "ifMetagenerationMatch": If set, only deletes the bucket if its metageneration matches this value.
func (c *BucketsDeleteCall) IfMetagenerationNotMatch(ifMetagenerationNotMatch int64) *BucketsDeleteCall
IfMetagenerationNotMatch sets the optional parameter "ifMetagenerationNotMatch": If set, only deletes the bucket if its metageneration does not match this value.
func (c *BucketsDeleteCall) UserProject(userProject string) *BucketsDeleteCall
UserProject sets the optional parameter "userProject": The project to be billed for this request. Required for Requester Pays buckets.
type BucketsGetCall struct {
// contains filtered or unexported fields
}
func (c *BucketsGetCall) Context(ctx context.Context) *BucketsGetCall
Context sets the context to be used in this call's Do method.
func (c *BucketsGetCall) Do(opts ...googleapi.CallOption) (*Bucket, error)
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) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (c *BucketsGetCall) Fields(s ...googleapi.Field) *BucketsGetCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.
func (c *BucketsGetCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
func (c *BucketsGetCall) IfMetagenerationMatch(ifMetagenerationMatch int64) *BucketsGetCall
IfMetagenerationMatch sets the optional parameter "ifMetagenerationMatch": Makes the return of the bucket metadata conditional on whether the bucket's current metageneration matches the given value.
func (c *BucketsGetCall) IfMetagenerationNotMatch(ifMetagenerationNotMatch int64) *BucketsGetCall
IfMetagenerationNotMatch sets the optional parameter "ifMetagenerationNotMatch": Makes the return of the bucket metadata conditional on whether the bucket's current metageneration does not match the given value.
func (c *BucketsGetCall) IfNoneMatch(entityTag string) *BucketsGetCall
IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.
func (c *BucketsGetCall) Projection(projection string) *BucketsGetCall
Projection sets the optional parameter "projection": Set of properties to return. Defaults to noAcl.
Possible values:
"full" - Include all properties. "noAcl" - Omit owner, acl and defaultObjectAcl properties.
func (c *BucketsGetCall) UserProject(userProject string) *BucketsGetCall
UserProject sets the optional parameter "userProject": The project to be billed for this request. Required for Requester Pays buckets.
type BucketsGetIamPolicyCall struct {
// contains filtered or unexported fields
}
func (c *BucketsGetIamPolicyCall) Context(ctx context.Context) *BucketsGetIamPolicyCall
Context sets the context to be used in this call's Do method.
func (c *BucketsGetIamPolicyCall) Do(opts ...googleapi.CallOption) (*Policy, error)
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) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (c *BucketsGetIamPolicyCall) Fields(s ...googleapi.Field) *BucketsGetIamPolicyCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.
func (c *BucketsGetIamPolicyCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
func (c *BucketsGetIamPolicyCall) IfNoneMatch(entityTag string) *BucketsGetIamPolicyCall
IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.
func (c *BucketsGetIamPolicyCall) OptionsRequestedPolicyVersion(optionsRequestedPolicyVersion int64) *BucketsGetIamPolicyCall
OptionsRequestedPolicyVersion sets the optional parameter "optionsRequestedPolicyVersion": The IAM policy format version to be returned. If the optionsRequestedPolicyVersion is for an older version that doesn't support part of the requested IAM policy, the request fails.
func (c *BucketsGetIamPolicyCall) UserProject(userProject string) *BucketsGetIamPolicyCall
UserProject sets the optional parameter "userProject": The project to be billed for this request. Required for Requester Pays buckets.
type BucketsInsertCall struct {
// contains filtered or unexported fields
}
func (c *BucketsInsertCall) Context(ctx context.Context) *BucketsInsertCall
Context sets the context to be used in this call's Do method.
func (c *BucketsInsertCall) Do(opts ...googleapi.CallOption) (*Bucket, error)
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) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (c *BucketsInsertCall) EnableObjectRetention(enableObjectRetention bool) *BucketsInsertCall
EnableObjectRetention sets the optional parameter "enableObjectRetention": When set to true, object retention is enabled for this bucket.
func (c *BucketsInsertCall) Fields(s ...googleapi.Field) *BucketsInsertCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.
func (c *BucketsInsertCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
func (c *BucketsInsertCall) PredefinedAcl(predefinedAcl string) *BucketsInsertCall
PredefinedAcl sets the optional parameter "predefinedAcl": Apply a predefined 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 (c *BucketsInsertCall) PredefinedDefaultObjectAcl(predefinedDefaultObjectAcl string) *BucketsInsertCall
PredefinedDefaultObjectAcl sets the optional parameter "predefinedDefaultObjectAcl": Apply a predefined set of default object access 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 (c *BucketsInsertCall) Projection(projection string) *BucketsInsertCall
Projection sets the optional parameter "projection": Set of properties to return. Defaults to noAcl, unless the bucket resource specifies acl or defaultObjectAcl properties, when it defaults to full.
Possible values:
"full" - Include all properties. "noAcl" - Omit owner, acl and defaultObjectAcl properties.
func (c *BucketsInsertCall) UserProject(userProject string) *BucketsInsertCall
UserProject sets the optional parameter "userProject": The project to be billed for this request.
type BucketsListCall struct {
// contains filtered or unexported fields
}
func (c *BucketsListCall) Context(ctx context.Context) *BucketsListCall
Context sets the context to be used in this call's Do method.
func (c *BucketsListCall) Do(opts ...googleapi.CallOption) (*Buckets, error)
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) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (c *BucketsListCall) Fields(s ...googleapi.Field) *BucketsListCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.
func (c *BucketsListCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
func (c *BucketsListCall) IfNoneMatch(entityTag string) *BucketsListCall
IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.
func (c *BucketsListCall) MaxResults(maxResults int64) *BucketsListCall
MaxResults sets the optional parameter "maxResults": Maximum number of buckets to return in a single response. The service will use this parameter or 1,000 items, whichever is smaller.
func (c *BucketsListCall) PageToken(pageToken string) *BucketsListCall
PageToken sets the optional parameter "pageToken": A previously-returned page token representing part of the larger set of results to view.
func (c *BucketsListCall) Pages(ctx context.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 (c *BucketsListCall) Prefix(prefix string) *BucketsListCall
Prefix sets the optional parameter "prefix": Filter results to buckets whose names begin with this prefix.
func (c *BucketsListCall) Projection(projection string) *BucketsListCall
Projection sets the optional parameter "projection": Set of properties to return. Defaults to noAcl.
Possible values:
"full" - Include all properties. "noAcl" - Omit owner, acl and defaultObjectAcl properties.
func (c *BucketsListCall) UserProject(userProject string) *BucketsListCall
UserProject sets the optional parameter "userProject": The project to be billed for this request.
type BucketsLockRetentionPolicyCall struct {
// contains filtered or unexported fields
}
func (c *BucketsLockRetentionPolicyCall) Context(ctx context.Context) *BucketsLockRetentionPolicyCall
Context sets the context to be used in this call's Do method.
func (c *BucketsLockRetentionPolicyCall) Do(opts ...googleapi.CallOption) (*Bucket, error)
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) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (c *BucketsLockRetentionPolicyCall) Fields(s ...googleapi.Field) *BucketsLockRetentionPolicyCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.
func (c *BucketsLockRetentionPolicyCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
func (c *BucketsLockRetentionPolicyCall) UserProject(userProject string) *BucketsLockRetentionPolicyCall
UserProject sets the optional parameter "userProject": The project to be billed for this request. Required for Requester Pays buckets.
type BucketsPatchCall struct {
// contains filtered or unexported fields
}
func (c *BucketsPatchCall) Context(ctx context.Context) *BucketsPatchCall
Context sets the context to be used in this call's Do method.
func (c *BucketsPatchCall) Do(opts ...googleapi.CallOption) (*Bucket, error)
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) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (c *BucketsPatchCall) Fields(s ...googleapi.Field) *BucketsPatchCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.
func (c *BucketsPatchCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
func (c *BucketsPatchCall) IfMetagenerationMatch(ifMetagenerationMatch int64) *BucketsPatchCall
IfMetagenerationMatch sets the optional parameter "ifMetagenerationMatch": Makes the return of the bucket metadata conditional on whether the bucket's current metageneration matches the given value.
func (c *BucketsPatchCall) IfMetagenerationNotMatch(ifMetagenerationNotMatch int64) *BucketsPatchCall
IfMetagenerationNotMatch sets the optional parameter "ifMetagenerationNotMatch": Makes the return of the bucket metadata conditional on whether the bucket's current metageneration does not match the given value.
func (c *BucketsPatchCall) PredefinedAcl(predefinedAcl string) *BucketsPatchCall
PredefinedAcl sets the optional parameter "predefinedAcl": Apply a predefined 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 (c *BucketsPatchCall) PredefinedDefaultObjectAcl(predefinedDefaultObjectAcl string) *BucketsPatchCall
PredefinedDefaultObjectAcl sets the optional parameter "predefinedDefaultObjectAcl": Apply a predefined set of default object access 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 (c *BucketsPatchCall) Projection(projection string) *BucketsPatchCall
Projection sets the optional parameter "projection": Set of properties to return. Defaults to full.
Possible values:
"full" - Include all properties. "noAcl" - Omit owner, acl and defaultObjectAcl properties.
func (c *BucketsPatchCall) UserProject(userProject string) *BucketsPatchCall
UserProject sets the optional parameter "userProject": The project to be billed for this request. Required for Requester Pays buckets.
type BucketsService struct {
// contains filtered or unexported fields
}
func NewBucketsService(s *Service) *BucketsService
func (r *BucketsService) Delete(bucket string) *BucketsDeleteCall
Delete: Permanently deletes an empty bucket.
- bucket: Name of a bucket.
func (r *BucketsService) Get(bucket string) *BucketsGetCall
Get: Returns metadata for the specified bucket.
- bucket: Name of a bucket.
func (r *BucketsService) GetIamPolicy(bucket string) *BucketsGetIamPolicyCall
GetIamPolicy: Returns an IAM policy for the specified bucket.
- bucket: Name of a bucket.
func (r *BucketsService) Insert(projectid string, bucket *Bucket) *BucketsInsertCall
Insert: Creates a new bucket.
- project: A valid API project identifier.
func (r *BucketsService) List(projectid string) *BucketsListCall
List: Retrieves a list of buckets for a given project.
- project: A valid API project identifier.
func (r *BucketsService) LockRetentionPolicy(bucket string, ifMetagenerationMatch int64) *BucketsLockRetentionPolicyCall
LockRetentionPolicy: Locks retention policy on a bucket.
func (r *BucketsService) Patch(bucket string, bucket2 *Bucket) *BucketsPatchCall
Patch: Patches a bucket. Changes to the bucket will be readable immediately after writing, but configuration changes may take time to propagate.
- bucket: Name of a bucket.
func (r *BucketsService) SetIamPolicy(bucket string, policy *Policy) *BucketsSetIamPolicyCall
SetIamPolicy: Updates an IAM policy for the specified bucket.
- bucket: Name of a bucket.
func (r *BucketsService) TestIamPermissions(bucket string, permissions []string) *BucketsTestIamPermissionsCall
TestIamPermissions: Tests a set of permissions on the given bucket to see which, if any, are held by the caller.
- bucket: Name of a bucket. - permissions: Permissions to test.
func (r *BucketsService) Update(bucket string, bucket2 *Bucket) *BucketsUpdateCall
Update: Updates a bucket. Changes to the bucket will be readable immediately after writing, but configuration changes may take time to propagate.
- bucket: Name of a bucket.
type BucketsSetIamPolicyCall struct {
// contains filtered or unexported fields
}
func (c *BucketsSetIamPolicyCall) Context(ctx context.Context) *BucketsSetIamPolicyCall
Context sets the context to be used in this call's Do method.
func (c *BucketsSetIamPolicyCall) Do(opts ...googleapi.CallOption) (*Policy, error)
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) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (c *BucketsSetIamPolicyCall) Fields(s ...googleapi.Field) *BucketsSetIamPolicyCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.
func (c *BucketsSetIamPolicyCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
func (c *BucketsSetIamPolicyCall) UserProject(userProject string) *BucketsSetIamPolicyCall
UserProject sets the optional parameter "userProject": The project to be billed for this request. Required for Requester Pays buckets.
type BucketsTestIamPermissionsCall struct {
// contains filtered or unexported fields
}
func (c *BucketsTestIamPermissionsCall) Context(ctx context.Context) *BucketsTestIamPermissionsCall
Context sets the context to be used in this call's Do method.
func (c *BucketsTestIamPermissionsCall) Do(opts ...googleapi.CallOption) (*TestIamPermissionsResponse, error)
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 was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (c *BucketsTestIamPermissionsCall) Fields(s ...googleapi.Field) *BucketsTestIamPermissionsCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.
func (c *BucketsTestIamPermissionsCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
func (c *BucketsTestIamPermissionsCall) IfNoneMatch(entityTag string) *BucketsTestIamPermissionsCall
IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.
func (c *BucketsTestIamPermissionsCall) UserProject(userProject string) *BucketsTestIamPermissionsCall
UserProject sets the optional parameter "userProject": The project to be billed for this request. Required for Requester Pays buckets.
type BucketsUpdateCall struct {
// contains filtered or unexported fields
}
func (c *BucketsUpdateCall) Context(ctx context.Context) *BucketsUpdateCall
Context sets the context to be used in this call's Do method.
func (c *BucketsUpdateCall) Do(opts ...googleapi.CallOption) (*Bucket, error)
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) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (c *BucketsUpdateCall) Fields(s ...googleapi.Field) *BucketsUpdateCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.
func (c *BucketsUpdateCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
func (c *BucketsUpdateCall) IfMetagenerationMatch(ifMetagenerationMatch int64) *BucketsUpdateCall
IfMetagenerationMatch sets the optional parameter "ifMetagenerationMatch": Makes the return of the bucket metadata conditional on whether the bucket's current metageneration matches the given value.
func (c *BucketsUpdateCall) IfMetagenerationNotMatch(ifMetagenerationNotMatch int64) *BucketsUpdateCall
IfMetagenerationNotMatch sets the optional parameter "ifMetagenerationNotMatch": Makes the return of the bucket metadata conditional on whether the bucket's current metageneration does not match the given value.
func (c *BucketsUpdateCall) PredefinedAcl(predefinedAcl string) *BucketsUpdateCall
PredefinedAcl sets the optional parameter "predefinedAcl": Apply a predefined 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 (c *BucketsUpdateCall) PredefinedDefaultObjectAcl(predefinedDefaultObjectAcl string) *BucketsUpdateCall
PredefinedDefaultObjectAcl sets the optional parameter "predefinedDefaultObjectAcl": Apply a predefined set of default object access 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 (c *BucketsUpdateCall) Projection(projection string) *BucketsUpdateCall
Projection sets the optional parameter "projection": Set of properties to return. Defaults to full.
Possible values:
"full" - Include all properties. "noAcl" - Omit owner, acl and defaultObjectAcl properties.
func (c *BucketsUpdateCall) UserProject(userProject string) *BucketsUpdateCall
UserProject sets the optional parameter "userProject": The project to be billed for this request. Required for Requester Pays buckets.
BulkRestoreObjectsRequest: A bulk restore objects request.
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.
AllowOverwrite bool `json:"allowOverwrite,omitempty"`
// CopySourceAcl: If true, copies the source object's ACL; otherwise, uses the
// bucket's default object ACL. The default is false.
CopySourceAcl bool `json:"copySourceAcl,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.
SoftDeletedAfterTime string `json:"softDeletedAfterTime,omitempty"`
// SoftDeletedBeforeTime: Restores only the objects that were soft-deleted
// before this time.
SoftDeletedBeforeTime string `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:"-"`
}
func (s *BulkRestoreObjectsRequest) MarshalJSON() ([]byte, error)
Channel: An notification channel used to watch for resource changes.
type Channel struct {
// Address: The address where notifications are delivered for this channel.
Address string `json:"address,omitempty"`
// Expiration: Date and time of notification channel expiration, expressed as a
// Unix timestamp, in milliseconds. Optional.
Expiration int64 `json:"expiration,omitempty,string"`
// Id: A UUID or similar unique string that identifies this channel.
Id string `json:"id,omitempty"`
// Kind: Identifies this as a notification channel used to watch for changes to
// a resource, which is "api#channel".
Kind string `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.
Payload bool `json:"payload,omitempty"`
// ResourceId: An opaque ID that identifies the resource being watched on this
// channel. Stable across different API versions.
ResourceId string `json:"resourceId,omitempty"`
// ResourceUri: A version-specific identifier for the watched resource.
ResourceUri string `json:"resourceUri,omitempty"`
// Token: An arbitrary string delivered to the target address with each
// notification delivered over this channel. Optional.
Token string `json:"token,omitempty"`
// Type: The type of delivery mechanism used for this channel.
Type string `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:"-"`
}
func (s *Channel) MarshalJSON() ([]byte, error)
type ChannelsService struct {
// contains filtered or unexported fields
}
func NewChannelsService(s *Service) *ChannelsService
func (r *ChannelsService) Stop(channel *Channel) *ChannelsStopCall
Stop: Stop watching resources through this channel
type ChannelsStopCall struct {
// contains filtered or unexported fields
}
func (c *ChannelsStopCall) Context(ctx context.Context) *ChannelsStopCall
Context sets the context to be used in this call's Do method.
func (c *ChannelsStopCall) Do(opts ...googleapi.CallOption) error
Do executes the "storage.channels.stop" call.
func (c *ChannelsStopCall) Fields(s ...googleapi.Field) *ChannelsStopCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.
func (c *ChannelsStopCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
ComposeRequest: A Compose request.
type ComposeRequest struct {
// Destination: Properties of the resulting object.
Destination *Object `json:"destination,omitempty"`
// Kind: The kind of item this is.
Kind string `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:"-"`
}
func (s *ComposeRequest) MarshalJSON() ([]byte, error)
type ComposeRequestSourceObjects struct {
// Generation: The generation of this object to use as the source.
Generation int64 `json:"generation,omitempty,string"`
// Name: The source object's name. All source objects must reside in the same
// bucket.
Name string `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 (s *ComposeRequestSourceObjects) MarshalJSON() ([]byte, error)
ComposeRequestSourceObjectsObjectPreconditions: Conditions that must be met for this operation to execute.
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.
IfGenerationMatch int64 `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:"-"`
}
func (s *ComposeRequestSourceObjectsObjectPreconditions) MarshalJSON() ([]byte, error)
type DefaultObjectAccessControlsDeleteCall struct {
// contains filtered or unexported fields
}
func (c *DefaultObjectAccessControlsDeleteCall) Context(ctx context.Context) *DefaultObjectAccessControlsDeleteCall
Context sets the context to be used in this call's Do method.
func (c *DefaultObjectAccessControlsDeleteCall) Do(opts ...googleapi.CallOption) error
Do executes the "storage.defaultObjectAccessControls.delete" call.
func (c *DefaultObjectAccessControlsDeleteCall) Fields(s ...googleapi.Field) *DefaultObjectAccessControlsDeleteCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.
func (c *DefaultObjectAccessControlsDeleteCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
func (c *DefaultObjectAccessControlsDeleteCall) UserProject(userProject string) *DefaultObjectAccessControlsDeleteCall
UserProject sets the optional parameter "userProject": The project to be billed for this request. Required for Requester Pays buckets.
type DefaultObjectAccessControlsGetCall struct {
// contains filtered or unexported fields
}
func (c *DefaultObjectAccessControlsGetCall) Context(ctx context.Context) *DefaultObjectAccessControlsGetCall
Context sets the context to be used in this call's Do method.
func (c *DefaultObjectAccessControlsGetCall) Do(opts ...googleapi.CallOption) (*ObjectAccessControl, error)
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 at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (c *DefaultObjectAccessControlsGetCall) Fields(s ...googleapi.Field) *DefaultObjectAccessControlsGetCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.
func (c *DefaultObjectAccessControlsGetCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
func (c *DefaultObjectAccessControlsGetCall) IfNoneMatch(entityTag string) *DefaultObjectAccessControlsGetCall
IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.
func (c *DefaultObjectAccessControlsGetCall) UserProject(userProject string) *DefaultObjectAccessControlsGetCall
UserProject sets the optional parameter "userProject": The project to be billed for this request. Required for Requester Pays buckets.
type DefaultObjectAccessControlsInsertCall struct {
// contains filtered or unexported fields
}
func (c *DefaultObjectAccessControlsInsertCall) Context(ctx context.Context) *DefaultObjectAccessControlsInsertCall
Context sets the context to be used in this call's Do method.
func (c *DefaultObjectAccessControlsInsertCall) Do(opts ...googleapi.CallOption) (*ObjectAccessControl, error)
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 at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (c *DefaultObjectAccessControlsInsertCall) Fields(s ...googleapi.Field) *DefaultObjectAccessControlsInsertCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.
func (c *DefaultObjectAccessControlsInsertCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
func (c *DefaultObjectAccessControlsInsertCall) UserProject(userProject string) *DefaultObjectAccessControlsInsertCall
UserProject sets the optional parameter "userProject": The project to be billed for this request. Required for Requester Pays buckets.
type DefaultObjectAccessControlsListCall struct {
// contains filtered or unexported fields
}
func (c *DefaultObjectAccessControlsListCall) Context(ctx context.Context) *DefaultObjectAccessControlsListCall
Context sets the context to be used in this call's Do method.
func (c *DefaultObjectAccessControlsListCall) Do(opts ...googleapi.CallOption) (*ObjectAccessControls, error)
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 returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (c *DefaultObjectAccessControlsListCall) Fields(s ...googleapi.Field) *DefaultObjectAccessControlsListCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.
func (c *DefaultObjectAccessControlsListCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
func (c *DefaultObjectAccessControlsListCall) IfMetagenerationMatch(ifMetagenerationMatch int64) *DefaultObjectAccessControlsListCall
IfMetagenerationMatch sets the optional parameter "ifMetagenerationMatch": If present, only return default ACL listing if the bucket's current metageneration matches this value.
func (c *DefaultObjectAccessControlsListCall) IfMetagenerationNotMatch(ifMetagenerationNotMatch int64) *DefaultObjectAccessControlsListCall
IfMetagenerationNotMatch sets the optional parameter "ifMetagenerationNotMatch": If present, only return default ACL listing if the bucket's current metageneration does not match the given value.
func (c *DefaultObjectAccessControlsListCall) IfNoneMatch(entityTag string) *DefaultObjectAccessControlsListCall
IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.
func (c *DefaultObjectAccessControlsListCall) UserProject(userProject string) *DefaultObjectAccessControlsListCall
UserProject sets the optional parameter "userProject": The project to be billed for this request. Required for Requester Pays buckets.
type DefaultObjectAccessControlsPatchCall struct {
// contains filtered or unexported fields
}
func (c *DefaultObjectAccessControlsPatchCall) Context(ctx context.Context) *DefaultObjectAccessControlsPatchCall
Context sets the context to be used in this call's Do method.
func (c *DefaultObjectAccessControlsPatchCall) Do(opts ...googleapi.CallOption) (*ObjectAccessControl, error)
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 at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (c *DefaultObjectAccessControlsPatchCall) Fields(s ...googleapi.Field) *DefaultObjectAccessControlsPatchCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.
func (c *DefaultObjectAccessControlsPatchCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
func (c *DefaultObjectAccessControlsPatchCall) UserProject(userProject string) *DefaultObjectAccessControlsPatchCall
UserProject sets the optional parameter "userProject": The project to be billed for this request. Required for Requester Pays buckets.
type DefaultObjectAccessControlsService struct {
// contains filtered or unexported fields
}
func NewDefaultObjectAccessControlsService(s *Service) *DefaultObjectAccessControlsService
func (r *DefaultObjectAccessControlsService) Delete(bucket string, entity string) *DefaultObjectAccessControlsDeleteCall
Delete: Permanently deletes the default object ACL entry for the specified entity on the specified bucket.
func (r *DefaultObjectAccessControlsService) Get(bucket string, entity string) *DefaultObjectAccessControlsGetCall
Get: Returns the default object ACL entry for the specified entity on the specified bucket.
func (r *DefaultObjectAccessControlsService) Insert(bucket string, objectaccesscontrol *ObjectAccessControl) *DefaultObjectAccessControlsInsertCall
Insert: Creates a new default object ACL entry on the specified bucket.
- bucket: Name of a bucket.
func (r *DefaultObjectAccessControlsService) List(bucket string) *DefaultObjectAccessControlsListCall
List: Retrieves default object ACL entries on the specified bucket.
- bucket: Name of a bucket.
func (r *DefaultObjectAccessControlsService) Patch(bucket string, entity string, objectaccesscontrol *ObjectAccessControl) *DefaultObjectAccessControlsPatchCall
Patch: Patches a default object ACL entry on the specified bucket.
func (r *DefaultObjectAccessControlsService) Update(bucket string, entity string, objectaccesscontrol *ObjectAccessControl) *DefaultObjectAccessControlsUpdateCall
Update: Updates a default object ACL entry on the specified bucket.
type DefaultObjectAccessControlsUpdateCall struct {
// contains filtered or unexported fields
}
func (c *DefaultObjectAccessControlsUpdateCall) Context(ctx context.Context) *DefaultObjectAccessControlsUpdateCall
Context sets the context to be used in this call's Do method.
func (c *DefaultObjectAccessControlsUpdateCall) Do(opts ...googleapi.CallOption) (*ObjectAccessControl, error)
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 at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (c *DefaultObjectAccessControlsUpdateCall) Fields(s ...googleapi.Field) *DefaultObjectAccessControlsUpdateCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.
func (c *DefaultObjectAccessControlsUpdateCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
func (c *DefaultObjectAccessControlsUpdateCall) UserProject(userProject string) *DefaultObjectAccessControlsUpdateCall
UserProject sets the optional parameter "userProject": The project to be billed for this request. Required for Requester Pays buckets.
Expr: Represents an expression text. Example: title: "User account presence" description: "Determines whether the request has a user account" expression: "size(request.user) > 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.
Description string `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.
Expression string `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.
Location string `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.
Title string `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:"-"`
}
func (s *Expr) MarshalJSON() ([]byte, error)
Folder: A folder. Only available in buckets with hierarchical namespace enabled.
type Folder struct {
// Bucket: The name of the bucket containing this folder.
Bucket string `json:"bucket,omitempty"`
// CreateTime: The creation time of the folder in RFC 3339 format.
CreateTime string `json:"createTime,omitempty"`
// Id: The ID of the folder, including the bucket name, folder name.
Id string `json:"id,omitempty"`
// Kind: The kind of item this is. For folders, this is always storage#folder.
Kind string `json:"kind,omitempty"`
// Metageneration: The version of the metadata for this folder. Used for
// preconditions and for detecting changes in metadata.
Metageneration int64 `json:"metageneration,omitempty,string"`
// Name: The name of the folder. Required if not specified by URL parameter.
Name string `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.
SelfLink string `json:"selfLink,omitempty"`
// UpdateTime: The modification time of the folder metadata in RFC 3339 format.
UpdateTime string `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:"-"`
}
func (s *Folder) MarshalJSON() ([]byte, error)
FolderPendingRenameInfo: Only present if the folder is part of an ongoing rename folder operation. Contains information which can be used to query the operation status.
type FolderPendingRenameInfo struct {
// OperationId: The ID of the rename folder operation.
OperationId string `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:"-"`
}
func (s *FolderPendingRenameInfo) MarshalJSON() ([]byte, error)
Folders: A list of folders.
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.
Kind string `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.
NextPageToken string `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:"-"`
}
func (s *Folders) MarshalJSON() ([]byte, error)
type FoldersDeleteCall struct {
// contains filtered or unexported fields
}
func (c *FoldersDeleteCall) Context(ctx context.Context) *FoldersDeleteCall
Context sets the context to be used in this call's Do method.
func (c *FoldersDeleteCall) Do(opts ...googleapi.CallOption) error
Do executes the "storage.folders.delete" call.
func (c *FoldersDeleteCall) Fields(s ...googleapi.Field) *FoldersDeleteCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.
func (c *FoldersDeleteCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
func (c *FoldersDeleteCall) IfMetagenerationMatch(ifMetagenerationMatch int64) *FoldersDeleteCall
IfMetagenerationMatch sets the optional parameter "ifMetagenerationMatch": If set, only deletes the folder if its metageneration matches this value.
func (c *FoldersDeleteCall) IfMetagenerationNotMatch(ifMetagenerationNotMatch int64) *FoldersDeleteCall
IfMetagenerationNotMatch sets the optional parameter "ifMetagenerationNotMatch": If set, only deletes the folder if its metageneration does not match this value.
type FoldersGetCall struct {
// contains filtered or unexported fields
}
func (c *FoldersGetCall) Context(ctx context.Context) *FoldersGetCall
Context sets the context to be used in this call's Do method.
func (c *FoldersGetCall) Do(opts ...googleapi.CallOption) (*Folder, error)
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) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (c *FoldersGetCall) Fields(s ...googleapi.Field) *FoldersGetCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.
func (c *FoldersGetCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
func (c *FoldersGetCall) IfMetagenerationMatch(ifMetagenerationMatch int64) *FoldersGetCall
IfMetagenerationMatch sets the optional parameter "ifMetagenerationMatch": Makes the return of the folder metadata conditional on whether the folder's current metageneration matches the given value.
func (c *FoldersGetCall) IfMetagenerationNotMatch(ifMetagenerationNotMatch int64) *FoldersGetCall
IfMetagenerationNotMatch sets the optional parameter "ifMetagenerationNotMatch": Makes the return of the folder metadata conditional on whether the folder's current metageneration does not match the given value.
func (c *FoldersGetCall) IfNoneMatch(entityTag string) *FoldersGetCall
IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.
type FoldersInsertCall struct {
// contains filtered or unexported fields
}
func (c *FoldersInsertCall) Context(ctx context.Context) *FoldersInsertCall
Context sets the context to be used in this call's Do method.
func (c *FoldersInsertCall) Do(opts ...googleapi.CallOption) (*Folder, error)
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) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (c *FoldersInsertCall) Fields(s ...googleapi.Field) *FoldersInsertCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.
func (c *FoldersInsertCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
func (c *FoldersInsertCall) Recursive(recursive bool) *FoldersInsertCall
Recursive sets the optional parameter "recursive": If true, any parent folder which doesn’t exist will be created automatically.
type FoldersListCall struct {
// contains filtered or unexported fields
}
func (c *FoldersListCall) Context(ctx context.Context) *FoldersListCall
Context sets the context to be used in this call's Do method.
func (c *FoldersListCall) Delimiter(delimiter string) *FoldersListCall
Delimiter sets the optional parameter "delimiter": Returns results in a directory-like mode. The only supported value is '/'. If set, items will only contain folders that either exactly match the prefix, or are one level below the prefix.
func (c *FoldersListCall) Do(opts ...googleapi.CallOption) (*Folders, error)
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) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (c *FoldersListCall) EndOffset(endOffset string) *FoldersListCall
EndOffset sets the optional parameter "endOffset": Filter results to folders whose names are lexicographically before endOffset. If startOffset is also set, the folders listed will have names between startOffset (inclusive) and endOffset (exclusive).
func (c *FoldersListCall) Fields(s ...googleapi.Field) *FoldersListCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.
func (c *FoldersListCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
func (c *FoldersListCall) IfNoneMatch(entityTag string) *FoldersListCall
IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.
func (c *FoldersListCall) PageSize(pageSize int64) *FoldersListCall
PageSize sets the optional parameter "pageSize": Maximum number of items to return in a single page of responses.
func (c *FoldersListCall) PageToken(pageToken string) *FoldersListCall
PageToken sets the optional parameter "pageToken": A previously-returned page token representing part of the larger set of results to view.
func (c *FoldersListCall) Pages(ctx context.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 (c *FoldersListCall) Prefix(prefix string) *FoldersListCall
Prefix sets the optional parameter "prefix": Filter results to folders whose paths begin with this prefix. If set, the value must either be an empty string or end with a '/'.
func (c *FoldersListCall) StartOffset(startOffset string) *FoldersListCall
StartOffset sets the optional parameter "startOffset": Filter results to folders whose names are lexicographically equal to or after startOffset. If endOffset is also set, the folders listed will have names between startOffset (inclusive) and endOffset (exclusive).
type FoldersRenameCall struct {
// contains filtered or unexported fields
}
func (c *FoldersRenameCall) Context(ctx context.Context) *FoldersRenameCall
Context sets the context to be used in this call's Do method.
func (c *FoldersRenameCall) Do(opts ...googleapi.CallOption) (*GoogleLongrunningOperation, error)
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 was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (c *FoldersRenameCall) Fields(s ...googleapi.Field) *FoldersRenameCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.
func (c *FoldersRenameCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
func (c *FoldersRenameCall) IfSourceMetagenerationMatch(ifSourceMetagenerationMatch int64) *FoldersRenameCall
IfSourceMetagenerationMatch sets the optional parameter "ifSourceMetagenerationMatch": Makes the operation conditional on whether the source object's current metageneration matches the given value.
func (c *FoldersRenameCall) IfSourceMetagenerationNotMatch(ifSourceMetagenerationNotMatch int64) *FoldersRenameCall
IfSourceMetagenerationNotMatch sets the optional parameter "ifSourceMetagenerationNotMatch": Makes the operation conditional on whether the source object's current metageneration does not match the given value.
type FoldersService struct {
// contains filtered or unexported fields
}
func NewFoldersService(s *Service) *FoldersService
func (r *FoldersService) Delete(bucket string, folder string) *FoldersDeleteCall
Delete: Permanently deletes a folder. Only applicable to buckets with hierarchical namespace enabled.
- bucket: Name of the bucket in which the folder resides. - folder: Name of a folder.
func (r *FoldersService) Get(bucket string, folder string) *FoldersGetCall
Get: Returns metadata for the specified folder. Only applicable to buckets with hierarchical namespace enabled.
- bucket: Name of the bucket in which the folder resides. - folder: Name of a folder.
func (r *FoldersService) Insert(bucket string, folder *Folder) *FoldersInsertCall
Insert: Creates a new folder. Only applicable to buckets with hierarchical namespace enabled.
- bucket: Name of the bucket in which the folder resides.
func (r *FoldersService) List(bucket string) *FoldersListCall
List: Retrieves a list of folders matching the criteria. Only applicable to buckets with hierarchical namespace enabled.
- bucket: Name of the bucket in which to look for folders.
func (r *FoldersService) Rename(bucket string, sourceFolder string, destinationFolder string) *FoldersRenameCall
Rename: Renames a source folder to a destination folder. Only applicable to buckets 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.
GoogleLongrunningListOperationsResponse: The response message for storage.buckets.operations.list.
type GoogleLongrunningListOperationsResponse struct {
// 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.
NextPageToken string `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. "NextPageToken") to
// unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "NextPageToken") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *GoogleLongrunningListOperationsResponse) MarshalJSON() ([]byte, error)
GoogleLongrunningOperation: This resource represents a long-running operation that is the result of a network API call.
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.
Done bool `json:"done,omitempty"`
// Error: The error result of the operation in case of failure or cancellation.
Error *GoogleRpcStatus `json:"error,omitempty"`
// Metadata: Service-specific metadata associated with the operation. It
// typically contains progress information and common metadata such as create
// time. Some services might not provide such metadata. Any method that returns
// a long-running operation should document the metadata type, if any.
Metadata googleapi.RawMessage `json:"metadata,omitempty"`
// Name: The server-assigned name, which is only unique within the same service
// that originally returns it. If you use the default HTTP mapping, the "name"
// should be a resource name ending with "operations/{operationId}".
Name string `json:"name,omitempty"`
// Response: The normal response of the operation in case of success. If the
// original method returns no data on success, such as "Delete", the response
// is google.protobuf.Empty. If the original method is standard
// Get/Create/Update, the response should be the resource. For other methods,
// the response should have the type "XxxResponse", where "Xxx" is the original
// method name. For example, if the original method name is "TakeSnapshot()",
// the inferred response type is "TakeSnapshotResponse".
Response googleapi.RawMessage `json:"response,omitempty"`
// ServerResponse contains the HTTP response code and headers from the server.
googleapi.ServerResponse `json:"-"`
// ForceSendFields is a list of field names (e.g. "Done") to unconditionally
// include in API requests. By default, fields with empty or default values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "Done") to include in API requests
// with the JSON null value. By default, fields with empty values are omitted
// from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *GoogleLongrunningOperation) MarshalJSON() ([]byte, error)
GoogleRpcStatus: The "Status" type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC (https://github.com/grpc). Each "Status" message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the API Design Guide (https://cloud.google.com/apis/design/errors).
type GoogleRpcStatus struct {
// Code: The status code, which should be an enum value of google.rpc.Code.
Code int64 `json:"code,omitempty"`
// Details: A list of messages that carry the error details. There is a common
// set of message types for APIs to use.
Details []googleapi.RawMessage `json:"details,omitempty"`
// Message: A developer-facing error message, which should be in English.
Message string `json:"message,omitempty"`
// ForceSendFields is a list of field names (e.g. "Code") to unconditionally
// include in API requests. By default, fields with empty or default values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "Code") to include in API requests
// with the JSON null value. By default, fields with empty values are omitted
// from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *GoogleRpcStatus) MarshalJSON() ([]byte, error)
HmacKey: JSON template to produce a JSON-style HMAC Key resource for Create responses.
type HmacKey struct {
// Kind: The kind of item this is. For HMAC keys, this is always
// storage#hmacKey.
Kind string `json:"kind,omitempty"`
// Metadata: Key metadata.
Metadata *HmacKeyMetadata `json:"metadata,omitempty"`
// Secret: HMAC secret key material.
Secret string `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:"-"`
}
func (s *HmacKey) MarshalJSON() ([]byte, error)
HmacKeyMetadata: JSON template to produce a JSON-style HMAC Key metadata resource.
type HmacKeyMetadata struct {
// AccessId: The ID of the HMAC Key.
AccessId string `json:"accessId,omitempty"`
// Etag: HTTP 1.1 Entity tag for the HMAC key.
Etag string `json:"etag,omitempty"`
// Id: The ID of the HMAC key, including the Project ID and the Access ID.
Id string `json:"id,omitempty"`
// Kind: The kind of item this is. For HMAC Key metadata, this is always
// storage#hmacKeyMetadata.
Kind string `json:"kind,omitempty"`
// ProjectId: Project ID owning the service account to which the key
// authenticates.
ProjectId string `json:"projectId,omitempty"`
// SelfLink: The link to this resource.
SelfLink string `json:"selfLink,omitempty"`
// ServiceAccountEmail: The email address of the key's associated service
// account.
ServiceAccountEmail string `json:"serviceAccountEmail,omitempty"`
// State: The state of the key. Can be one of ACTIVE, INACTIVE, or DELETED.
State string `json:"state,omitempty"`
// TimeCreated: The creation time of the HMAC key in RFC 3339 format.
TimeCreated string `json:"timeCreated,omitempty"`
// Updated: The last modification time of the HMAC key metadata in RFC 3339
// format.
Updated string `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:"-"`
}
func (s *HmacKeyMetadata) MarshalJSON() ([]byte, error)
HmacKeysMetadata: A list of hmacKeys.
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.
Kind string `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.
NextPageToken string `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:"-"`
}
func (s *HmacKeysMetadata) MarshalJSON() ([]byte, error)
ManagedFolder: A managed folder.
type ManagedFolder struct {
// Bucket: The name of the bucket containing this managed folder.
Bucket string `json:"bucket,omitempty"`
// CreateTime: The creation time of the managed folder in RFC 3339 format.
CreateTime string `json:"createTime,omitempty"`
// Id: The ID of the managed folder, including the bucket name and managed
// folder name.
Id string `json:"id,omitempty"`
// Kind: The kind of item this is. For managed folders, this is always
// storage#managedFolder.
Kind string `json:"kind,omitempty"`
// Metageneration: The version of the metadata for this managed folder. Used
// for preconditions and for detecting changes in metadata.
Metageneration int64 `json:"metageneration,omitempty,string"`
// Name: The name of the managed folder. Required if not specified by URL
// parameter.
Name string `json:"name,omitempty"`
// SelfLink: The link to this managed folder.
SelfLink string `json:"selfLink,omitempty"`
// UpdateTime: The last update time of the managed folder metadata in RFC 3339
// format.
UpdateTime string `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:"-"`
}
func (s *ManagedFolder) MarshalJSON() ([]byte, error)
ManagedFolders: A list of managed folders.
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.
Kind string `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.
NextPageToken string `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:"-"`
}
func (s *ManagedFolders) MarshalJSON() ([]byte, error)
type ManagedFoldersDeleteCall struct {
// contains filtered or unexported fields
}
func (c *ManagedFoldersDeleteCall) AllowNonEmpty(allowNonEmpty bool) *ManagedFoldersDeleteCall
AllowNonEmpty sets the optional parameter "allowNonEmpty": Allows the deletion of a managed folder even if it is not empty. A managed folder is empty if there are no objects or managed folders that it applies to. Callers must have storage.managedFolders.setIamPolicy permission.
func (c *ManagedFoldersDeleteCall) Context(ctx context.Context) *ManagedFoldersDeleteCall
Context sets the context to be used in this call's Do method.
func (c *ManagedFoldersDeleteCall) Do(opts ...googleapi.CallOption) error
Do executes the "storage.managedFolders.delete" call.
func (c *ManagedFoldersDeleteCall) Fields(s ...googleapi.Field) *ManagedFoldersDeleteCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.
func (c *ManagedFoldersDeleteCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
func (c *ManagedFoldersDeleteCall) IfMetagenerationMatch(ifMetagenerationMatch int64) *ManagedFoldersDeleteCall
IfMetagenerationMatch sets the optional parameter "ifMetagenerationMatch": If set, only deletes the managed folder if its metageneration matches this value.
func (c *ManagedFoldersDeleteCall) IfMetagenerationNotMatch(ifMetagenerationNotMatch int64) *ManagedFoldersDeleteCall
IfMetagenerationNotMatch sets the optional parameter "ifMetagenerationNotMatch": If set, only deletes the managed folder if its metageneration does not match this value.
type ManagedFoldersGetCall struct {
// contains filtered or unexported fields
}
func (c *ManagedFoldersGetCall) Context(ctx context.Context) *ManagedFoldersGetCall
Context sets the context to be used in this call's Do method.
func (c *ManagedFoldersGetCall) Do(opts ...googleapi.CallOption) (*ManagedFolder, error)
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 check whether the returned error was because http.StatusNotModified was returned.
func (c *ManagedFoldersGetCall) Fields(s ...googleapi.Field) *ManagedFoldersGetCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.
func (c *ManagedFoldersGetCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
func (c *ManagedFoldersGetCall) IfMetagenerationMatch(ifMetagenerationMatch int64) *ManagedFoldersGetCall
IfMetagenerationMatch sets the optional parameter "ifMetagenerationMatch": Makes the return of the managed folder metadata conditional on whether the managed folder's current metageneration matches the given value.
func (c *ManagedFoldersGetCall) IfMetagenerationNotMatch(ifMetagenerationNotMatch int64) *ManagedFoldersGetCall
IfMetagenerationNotMatch sets the optional parameter "ifMetagenerationNotMatch": Makes the return of the managed folder metadata conditional on whether the managed folder's current metageneration does not match the given value.
func (c *ManagedFoldersGetCall) IfNoneMatch(entityTag string) *ManagedFoldersGetCall
IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.
type ManagedFoldersGetIamPolicyCall struct {
// contains filtered or unexported fields
}
func (c *ManagedFoldersGetIamPolicyCall) Context(ctx context.Context) *ManagedFoldersGetIamPolicyCall
Context sets the context to be used in this call's Do method.
func (c *ManagedFoldersGetIamPolicyCall) Do(opts ...googleapi.CallOption) (*Policy, error)
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) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (c *ManagedFoldersGetIamPolicyCall) Fields(s ...googleapi.Field) *ManagedFoldersGetIamPolicyCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.
func (c *ManagedFoldersGetIamPolicyCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
func (c *ManagedFoldersGetIamPolicyCall) IfNoneMatch(entityTag string) *ManagedFoldersGetIamPolicyCall
IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.
func (c *ManagedFoldersGetIamPolicyCall) OptionsRequestedPolicyVersion(optionsRequestedPolicyVersion int64) *ManagedFoldersGetIamPolicyCall
OptionsRequestedPolicyVersion sets the optional parameter "optionsRequestedPolicyVersion": The IAM policy format version to be returned. If the optionsRequestedPolicyVersion is for an older version that doesn't support part of the requested IAM policy, the request fails.
func (c *ManagedFoldersGetIamPolicyCall) UserProject(userProject string) *ManagedFoldersGetIamPolicyCall
UserProject sets the optional parameter "userProject": The project to be billed for this request. Required for Requester Pays buckets.
type ManagedFoldersInsertCall struct {
// contains filtered or unexported fields
}
func (c *ManagedFoldersInsertCall) Context(ctx context.Context) *ManagedFoldersInsertCall
Context sets the context to be used in this call's Do method.
func (c *ManagedFoldersInsertCall) Do(opts ...googleapi.CallOption) (*ManagedFolder, error)
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 check whether the returned error was because http.StatusNotModified was returned.
func (c *ManagedFoldersInsertCall) Fields(s ...googleapi.Field) *ManagedFoldersInsertCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.
func (c *ManagedFoldersInsertCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
type ManagedFoldersListCall struct {
// contains filtered or unexported fields
}
func (c *ManagedFoldersListCall) Context(ctx context.Context) *ManagedFoldersListCall
Context sets the context to be used in this call's Do method.
func (c *ManagedFoldersListCall) Do(opts ...googleapi.CallOption) (*ManagedFolders, error)
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 check whether the returned error was because http.StatusNotModified was returned.
func (c *ManagedFoldersListCall) Fields(s ...googleapi.Field) *ManagedFoldersListCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.
func (c *ManagedFoldersListCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
func (c *ManagedFoldersListCall) IfNoneMatch(entityTag string) *ManagedFoldersListCall
IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.
func (c *ManagedFoldersListCall) PageSize(pageSize int64) *ManagedFoldersListCall
PageSize sets the optional parameter "pageSize": Maximum number of items to return in a single page of responses.
func (c *ManagedFoldersListCall) PageToken(pageToken string) *ManagedFoldersListCall
PageToken sets the optional parameter "pageToken": A previously-returned page token representing part of the larger set of results to view.
func (c *ManagedFoldersListCall) Pages(ctx context.Context, f func(*ManagedFolders) 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 (c *ManagedFoldersListCall) Prefix(prefix string) *ManagedFoldersListCall
Prefix sets the optional parameter "prefix": The managed folder name/path prefix to filter the output list of results.
type ManagedFoldersService struct {
// contains filtered or unexported fields
}
func NewManagedFoldersService(s *Service) *ManagedFoldersService
func (r *ManagedFoldersService) Delete(bucket string, managedFolder string) *ManagedFoldersDeleteCall
Delete: Permanently deletes a managed folder.
- bucket: Name of the bucket containing the managed folder. - managedFolder: The managed folder name/path.
func (r *ManagedFoldersService) Get(bucket string, managedFolder string) *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 (r *ManagedFoldersService) GetIamPolicy(bucket string, managedFolder string) *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 (r *ManagedFoldersService) Insert(bucket string, managedfolder *ManagedFolder) *ManagedFoldersInsertCall
Insert: Creates a new managed folder.
- bucket: Name of the bucket containing the managed folder.
func (r *ManagedFoldersService) List(bucket string) *ManagedFoldersListCall
List: Lists managed folders in the given bucket.
- bucket: Name of the bucket containing the managed folder.
func (r *ManagedFoldersService) SetIamPolicy(bucket string, managedFolder string, 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 (r *ManagedFoldersService) TestIamPermissions(bucket string, managedFolder string, permissions []string) *ManagedFoldersTestIamPermissionsCall
TestIamPermissions: Tests a set of permissions on the given managed folder to 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.
type ManagedFoldersSetIamPolicyCall struct {
// contains filtered or unexported fields
}
func (c *ManagedFoldersSetIamPolicyCall) Context(ctx context.Context) *ManagedFoldersSetIamPolicyCall
Context sets the context to be used in this call's Do method.
func (c *ManagedFoldersSetIamPolicyCall) Do(opts ...googleapi.CallOption) (*Policy, error)
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) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (c *ManagedFoldersSetIamPolicyCall) Fields(s ...googleapi.Field) *ManagedFoldersSetIamPolicyCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.
func (c *ManagedFoldersSetIamPolicyCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
func (c *ManagedFoldersSetIamPolicyCall) UserProject(userProject string) *ManagedFoldersSetIamPolicyCall
UserProject sets the optional parameter "userProject": The project to be billed for this request. Required for Requester Pays buckets.
type ManagedFoldersTestIamPermissionsCall struct {
// contains filtered or unexported fields
}
func (c *ManagedFoldersTestIamPermissionsCall) Context(ctx context.Context) *ManagedFoldersTestIamPermissionsCall
Context sets the context to be used in this call's Do method.
func (c *ManagedFoldersTestIamPermissionsCall) Do(opts ...googleapi.CallOption) (*TestIamPermissionsResponse, error)
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 was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (c *ManagedFoldersTestIamPermissionsCall) Fields(s ...googleapi.Field) *ManagedFoldersTestIamPermissionsCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.
func (c *ManagedFoldersTestIamPermissionsCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
func (c *ManagedFoldersTestIamPermissionsCall) IfNoneMatch(entityTag string) *ManagedFoldersTestIamPermissionsCall
IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.
func (c *ManagedFoldersTestIamPermissionsCall) UserProject(userProject string) *ManagedFoldersTestIamPermissionsCall
UserProject sets the optional parameter "userProject": The project to be billed for this request. Required for Requester Pays buckets.
Notification: A subscription to receive Google PubSub notifications.
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.
Etag string `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.
Id string `json:"id,omitempty"`
// Kind: The kind of item this is. For notifications, this is always
// storage#notification.
Kind string `json:"kind,omitempty"`
// ObjectNamePrefix: If present, only apply this notification configuration to
// object names that begin with this prefix.
ObjectNamePrefix string `json:"object_name_prefix,omitempty"`
// PayloadFormat: The desired content of the Payload.
PayloadFormat string `json:"payload_format,omitempty"`
// SelfLink: The canonical URL of this notification.
SelfLink string `json:"selfLink,omitempty"`
// Topic: The Cloud PubSub topic to which this subscription publishes.
// Formatted as:
// '//pubsub.googleapis.com/projects/{project-identifier}/topics/{my-topic}'
Topic string `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:"-"`
}
func (s *Notification) MarshalJSON() ([]byte, error)
Notifications: A list of notification subscriptions.
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.
Kind string `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:"-"`
}
func (s *Notifications) MarshalJSON() ([]byte, error)
type NotificationsDeleteCall struct {
// contains filtered or unexported fields
}
func (c *NotificationsDeleteCall) Context(ctx context.Context) *NotificationsDeleteCall
Context sets the context to be used in this call's Do method.
func (c *NotificationsDeleteCall) Do(opts ...googleapi.CallOption) error
Do executes the "storage.notifications.delete" call.
func (c *NotificationsDeleteCall) Fields(s ...googleapi.Field) *NotificationsDeleteCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.
func (c *NotificationsDeleteCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
func (c *NotificationsDeleteCall) UserProject(userProject string) *NotificationsDeleteCall
UserProject sets the optional parameter "userProject": The project to be billed for this request. Required for Requester Pays buckets.
type NotificationsGetCall struct {
// contains filtered or unexported fields
}
func (c *NotificationsGetCall) Context(ctx context.Context) *NotificationsGetCall
Context sets the context to be used in this call's Do method.
func (c *NotificationsGetCall) Do(opts ...googleapi.CallOption) (*Notification, error)
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 check whether the returned error was because http.StatusNotModified was returned.
func (c *NotificationsGetCall) Fields(s ...googleapi.Field) *NotificationsGetCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.
func (c *NotificationsGetCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
func (c *NotificationsGetCall) IfNoneMatch(entityTag string) *NotificationsGetCall
IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.
func (c *NotificationsGetCall) UserProject(userProject string) *NotificationsGetCall
UserProject sets the optional parameter "userProject": The project to be billed for this request. Required for Requester Pays buckets.
type NotificationsInsertCall struct {
// contains filtered or unexported fields
}
func (c *NotificationsInsertCall) Context(ctx context.Context) *NotificationsInsertCall
Context sets the context to be used in this call's Do method.
func (c *NotificationsInsertCall) Do(opts ...googleapi.CallOption) (*Notification, error)
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 check whether the returned error was because http.StatusNotModified was returned.
func (c *NotificationsInsertCall) Fields(s ...googleapi.Field) *NotificationsInsertCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.
func (c *NotificationsInsertCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
func (c *NotificationsInsertCall) UserProject(userProject string) *NotificationsInsertCall
UserProject sets the optional parameter "userProject": The project to be billed for this request. Required for Requester Pays buckets.
type NotificationsListCall struct {
// contains filtered or unexported fields
}
func (c *NotificationsListCall) Context(ctx context.Context) *NotificationsListCall
Context sets the context to be used in this call's Do method.
func (c *NotificationsListCall) Do(opts ...googleapi.CallOption) (*Notifications, error)
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 check whether the returned error was because http.StatusNotModified was returned.
func (c *NotificationsListCall) Fields(s ...googleapi.Field) *NotificationsListCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.
func (c *NotificationsListCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
func (c *NotificationsListCall) IfNoneMatch(entityTag string) *NotificationsListCall
IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.
func (c *NotificationsListCall) UserProject(userProject string) *NotificationsListCall
UserProject sets the optional parameter "userProject": The project to be billed for this request. Required for Requester Pays buckets.
type NotificationsService struct {
// contains filtered or unexported fields
}
func NewNotificationsService(s *Service) *NotificationsService
func (r *NotificationsService) Delete(bucket string, notification string) *NotificationsDeleteCall
Delete: Permanently deletes a notification subscription.
- bucket: The parent bucket of the notification. - notification: ID of the notification to delete.
func (r *NotificationsService) Get(bucket string, notification string) *NotificationsGetCall
Get: View a notification configuration.
- bucket: The parent bucket of the notification. - notification: Notification ID.
func (r *NotificationsService) Insert(bucket string, notification *Notification) *NotificationsInsertCall
Insert: Creates a notification subscription for a given bucket.
- bucket: The parent bucket of the notification.
func (r *NotificationsService) List(bucket string) *NotificationsListCall
List: Retrieves a list of notification subscriptions for a given bucket.
- bucket: Name of a Google Cloud Storage bucket.
Object: An object.
type Object struct {
// Acl: Access controls on the object.
Acl []*ObjectAccessControl `json:"acl,omitempty"`
// Bucket: The name of the bucket containing this object.
Bucket string `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.
CacheControl string `json:"cacheControl,omitempty"`
// ComponentCount: Number of underlying components that make up this object.
// Components are accumulated by compose operations.
ComponentCount int64 `json:"componentCount,omitempty"`
// ContentDisposition: Content-Disposition of the object data.
ContentDisposition string `json:"contentDisposition,omitempty"`
// ContentEncoding: Content-Encoding of the object data.
ContentEncoding string `json:"contentEncoding,omitempty"`
// ContentLanguage: Content-Language of the object data.
ContentLanguage string `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.
ContentType string `json:"contentType,omitempty"`
// Crc32c: CRC32c checksum, as described in RFC 4960, Appendix B; encoded using
// base64 in big-endian byte order. For more information about using the CRC32c
// checksum, see Hashes and ETags: Best Practices.
Crc32c string `json:"crc32c,omitempty"`
// CustomTime: A timestamp in RFC 3339 format specified by the user for an
// object.
CustomTime string `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.
Etag string `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.
EventBasedHold bool `json:"eventBasedHold,omitempty"`
// Generation: The content generation of this object. Used for object
// versioning.
Generation int64 `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.
HardDeleteTime string `json:"hardDeleteTime,omitempty"`
// Id: The ID of the object, including the bucket name, object name, and
// generation number.
Id string `json:"id,omitempty"`
// Kind: The kind of item this is. For objects, this is always storage#object.
Kind string `json:"kind,omitempty"`
// KmsKeyName: Not currently supported. Specifying the parameter causes the
// request to fail with status code 400 - Bad Request.
KmsKeyName string `json:"kmsKeyName,omitempty"`
// Md5Hash: MD5 hash of the data; encoded using base64. For more information
// about using the MD5 hash, see Hashes and ETags: Best Practices.
Md5Hash string `json:"md5Hash,omitempty"`
// MediaLink: Media download link.
MediaLink string `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.
Metageneration int64 `json:"metageneration,omitempty,string"`
// Name: The name of the object. Required if not specified by URL parameter.
Name string `json:"name,omitempty"`
// Owner: The owner of the object. This will always be the uploader of the
// object.
Owner *ObjectOwner `json:"owner,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).
RetentionExpirationTime string `json:"retentionExpirationTime,omitempty"`
// SelfLink: The link to this object.
SelfLink string `json:"selfLink,omitempty"`
// Size: Content-Length of the data in bytes.
Size uint64 `json:"size,omitempty,string"`
// SoftDeleteTime: The time at which the object became soft-deleted in RFC 3339
// format.
SoftDeleteTime string `json:"softDeleteTime,omitempty"`
// StorageClass: Storage class of the object.
StorageClass string `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.
TemporaryHold bool `json:"temporaryHold,omitempty"`
// TimeCreated: The creation time of the object in RFC 3339 format.
TimeCreated string `json:"timeCreated,omitempty"`
// TimeDeleted: The time at which the object became noncurrent in RFC 3339
// format. Will be returned if and only if this version of the object has been
// deleted.
TimeDeleted string `json:"timeDeleted,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.
TimeStorageClassUpdated string `json:"timeStorageClassUpdated,omitempty"`
// Updated: The modification time of the object metadata in RFC 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.
Updated string `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:"-"`
}
func (s *Object) MarshalJSON() ([]byte, error)
ObjectAccessControl: An access-control entry.
type ObjectAccessControl struct {
// Bucket: The name of the bucket.
Bucket string `json:"bucket,omitempty"`
// Domain: The domain associated with the entity, if any.
Domain string `json:"domain,omitempty"`
// Email: The email address associated with the entity, if any.
Email string `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.
Entity string `json:"entity,omitempty"`
// EntityId: The ID for the entity, if any.
EntityId string `json:"entityId,omitempty"`
// Etag: HTTP 1.1 Entity tag for the access-control entry.
Etag string `json:"etag,omitempty"`
// Generation: The content generation of the object, if applied to an object.
Generation int64 `json:"generation,omitempty,string"`
// Id: The ID of the access-control entry.
Id string `json:"id,omitempty"`
// Kind: The kind of item this is. For object access control entries, this is
// always storage#objectAccessControl.
Kind string `json:"kind,omitempty"`
// Object: The name of the object, if applied to an object.
Object string `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.
Role string `json:"role,omitempty"`
// SelfLink: The link to this access-control entry.
SelfLink string `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:"-"`
}
func (s *ObjectAccessControl) MarshalJSON() ([]byte, error)
ObjectAccessControlProjectTeam: The project team associated with the entity, if any.
type ObjectAccessControlProjectTeam struct {
// ProjectNumber: The project number.
ProjectNumber string `json:"projectNumber,omitempty"`
// Team: The team.
Team string `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:"-"`
}
func (s *ObjectAccessControlProjectTeam) MarshalJSON() ([]byte, error)
ObjectAccessControls: An access-control list.
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.
Kind string `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:"-"`
}
func (s *ObjectAccessControls) MarshalJSON() ([]byte, error)
type ObjectAccessControlsDeleteCall struct {
// contains filtered or unexported fields
}
func (c *ObjectAccessControlsDeleteCall) Context(ctx context.Context) *ObjectAccessControlsDeleteCall
Context sets the context to be used in this call's Do method.
func (c *ObjectAccessControlsDeleteCall) Do(opts ...googleapi.CallOption) error
Do executes the "storage.objectAccessControls.delete" call.
func (c *ObjectAccessControlsDeleteCall) Fields(s ...googleapi.Field) *ObjectAccessControlsDeleteCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.
func (c *ObjectAccessControlsDeleteCall) Generation(generation int64) *ObjectAccessControlsDeleteCall
Generation sets the optional parameter "generation": If present, selects a specific revision of this object (as opposed to the latest version, the default).
func (c *ObjectAccessControlsDeleteCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
func (c *ObjectAccessControlsDeleteCall) UserProject(userProject string) *ObjectAccessControlsDeleteCall
UserProject sets the optional parameter "userProject": The project to be billed for this request. Required for Requester Pays buckets.
type ObjectAccessControlsGetCall struct {
// contains filtered or unexported fields
}
func (c *ObjectAccessControlsGetCall) Context(ctx context.Context) *ObjectAccessControlsGetCall
Context sets the context to be used in this call's Do method.
func (c *ObjectAccessControlsGetCall) Do(opts ...googleapi.CallOption) (*ObjectAccessControl, error)
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 at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (c *ObjectAccessControlsGetCall) Fields(s ...googleapi.Field) *ObjectAccessControlsGetCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.
func (c *ObjectAccessControlsGetCall) Generation(generation int64) *ObjectAccessControlsGetCall
Generation sets the optional parameter "generation": If present, selects a specific revision of this object (as opposed to the latest version, the default).
func (c *ObjectAccessControlsGetCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
func (c *ObjectAccessControlsGetCall) IfNoneMatch(entityTag string) *ObjectAccessControlsGetCall
IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.
func (c *ObjectAccessControlsGetCall) UserProject(userProject string) *ObjectAccessControlsGetCall
UserProject sets the optional parameter "userProject": The project to be billed for this request. Required for Requester Pays buckets.
type ObjectAccessControlsInsertCall struct {
// contains filtered or unexported fields
}
func (c *ObjectAccessControlsInsertCall) Context(ctx context.Context) *ObjectAccessControlsInsertCall
Context sets the context to be used in this call's Do method.
func (c *ObjectAccessControlsInsertCall) Do(opts ...googleapi.CallOption) (*ObjectAccessControl, error)
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 at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (c *ObjectAccessControlsInsertCall) Fields(s ...googleapi.Field) *ObjectAccessControlsInsertCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.
func (c *ObjectAccessControlsInsertCall) Generation(generation int64) *ObjectAccessControlsInsertCall
Generation sets the optional parameter "generation": If present, selects a specific revision of this object (as opposed to the latest version, the default).
func (c *ObjectAccessControlsInsertCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
func (c *ObjectAccessControlsInsertCall) UserProject(userProject string) *ObjectAccessControlsInsertCall
UserProject sets the optional parameter "userProject": The project to be billed for this request. Required for Requester Pays buckets.
type ObjectAccessControlsListCall struct {
// contains filtered or unexported fields
}
func (c *ObjectAccessControlsListCall) Context(ctx context.Context) *ObjectAccessControlsListCall
Context sets the context to be used in this call's Do method.
func (c *ObjectAccessControlsListCall) Do(opts ...googleapi.CallOption) (*ObjectAccessControls, error)
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 returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (c *ObjectAccessControlsListCall) Fields(s ...googleapi.Field) *ObjectAccessControlsListCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.
func (c *ObjectAccessControlsListCall) Generation(generation int64) *ObjectAccessControlsListCall
Generation sets the optional parameter "generation": If present, selects a specific revision of this object (as opposed to the latest version, the default).
func (c *ObjectAccessControlsListCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
func (c *ObjectAccessControlsListCall) IfNoneMatch(entityTag string) *ObjectAccessControlsListCall
IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.
func (c *ObjectAccessControlsListCall) UserProject(userProject string) *ObjectAccessControlsListCall
UserProject sets the optional parameter "userProject": The project to be billed for this request. Required for Requester Pays buckets.
type ObjectAccessControlsPatchCall struct {
// contains filtered or unexported fields
}
func (c *ObjectAccessControlsPatchCall) Context(ctx context.Context) *ObjectAccessControlsPatchCall
Context sets the context to be used in this call's Do method.
func (c *ObjectAccessControlsPatchCall) Do(opts ...googleapi.CallOption) (*ObjectAccessControl, error)
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 at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (c *ObjectAccessControlsPatchCall) Fields(s ...googleapi.Field) *ObjectAccessControlsPatchCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.
func (c *ObjectAccessControlsPatchCall) Generation(generation int64) *ObjectAccessControlsPatchCall
Generation sets the optional parameter "generation": If present, selects a specific revision of this object (as opposed to the latest version, the default).
func (c *ObjectAccessControlsPatchCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
func (c *ObjectAccessControlsPatchCall) UserProject(userProject string) *ObjectAccessControlsPatchCall
UserProject sets the optional parameter "userProject": The project to be billed for this request. Required for Requester Pays buckets.
type ObjectAccessControlsService struct {
// contains filtered or unexported fields
}
func NewObjectAccessControlsService(s *Service) *ObjectAccessControlsService
func (r *ObjectAccessControlsService) Delete(bucket string, object string, entity string) *ObjectAccessControlsDeleteCall
Delete: Permanently deletes the ACL entry for the specified entity on the specified object.
func (r *ObjectAccessControlsService) Get(bucket string, object string, entity string) *ObjectAccessControlsGetCall
Get: Returns the ACL entry for the specified entity on the specified object.
func (r *ObjectAccessControlsService) Insert(bucket string, object string, objectaccesscontrol *ObjectAccessControl) *ObjectAccessControlsInsertCall
Insert: Creates a new ACL entry on the specified object.
func (r *ObjectAccessControlsService) List(bucket string, object string) *ObjectAccessControlsListCall
List: Retrieves ACL entries on the specified object.
func (r *ObjectAccessControlsService) Patch(bucket string, object string, entity string, objectaccesscontrol *ObjectAccessControl) *ObjectAccessControlsPatchCall
Patch: Patches an ACL entry on the specified object.
func (r *ObjectAccessControlsService) Update(bucket string, object string, entity string, objectaccesscontrol *ObjectAccessControl) *ObjectAccessControlsUpdateCall
Update: Updates an ACL entry on the specified object.
type ObjectAccessControlsUpdateCall struct {
// contains filtered or unexported fields
}
func (c *ObjectAccessControlsUpdateCall) Context(ctx context.Context) *ObjectAccessControlsUpdateCall
Context sets the context to be used in this call's Do method.
func (c *ObjectAccessControlsUpdateCall) Do(opts ...googleapi.CallOption) (*ObjectAccessControl, error)
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 at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (c *ObjectAccessControlsUpdateCall) Fields(s ...googleapi.Field) *ObjectAccessControlsUpdateCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.
func (c *ObjectAccessControlsUpdateCall) Generation(generation int64) *ObjectAccessControlsUpdateCall
Generation sets the optional parameter "generation": If present, selects a specific revision of this object (as opposed to the latest version, the default).
func (c *ObjectAccessControlsUpdateCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
func (c *ObjectAccessControlsUpdateCall) UserProject(userProject string) *ObjectAccessControlsUpdateCall
UserProject sets the optional parameter "userProject": The project to be billed for this request. Required for Requester Pays buckets.
ObjectCustomerEncryption: Metadata of customer-supplied encryption key, if the object is encrypted by such a key.
type ObjectCustomerEncryption struct {
// EncryptionAlgorithm: The encryption algorithm.
EncryptionAlgorithm string `json:"encryptionAlgorithm,omitempty"`
// KeySha256: SHA256 hash value of the encryption key.
KeySha256 string `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:"-"`
}
func (s *ObjectCustomerEncryption) MarshalJSON() ([]byte, error)
ObjectOwner: The owner of the object. This will always be the uploader of the object.
type ObjectOwner struct {
// Entity: The entity, in the form user-userId.
Entity string `json:"entity,omitempty"`
// EntityId: The ID for the entity.
EntityId string `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:"-"`
}
func (s *ObjectOwner) MarshalJSON() ([]byte, error)
ObjectRetention: A collection of object level retention parameters.
type ObjectRetention struct {
// Mode: The bucket's object retention mode, can only be Unlocked or Locked.
Mode string `json:"mode,omitempty"`
// RetainUntilTime: A time in RFC 3339 format until which object retention
// protects this object.
RetainUntilTime string `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:"-"`
}
func (s *ObjectRetention) MarshalJSON() ([]byte, error)
Objects: A list of objects.
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.
Kind string `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.
NextPageToken string `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:"-"`
}
func (s *Objects) MarshalJSON() ([]byte, error)
type ObjectsBulkRestoreCall struct {
// contains filtered or unexported fields
}
func (c *ObjectsBulkRestoreCall) Context(ctx context.Context) *ObjectsBulkRestoreCall
Context sets the context to be used in this call's Do method.
func (c *ObjectsBulkRestoreCall) Do(opts ...googleapi.CallOption) (*GoogleLongrunningOperation, error)
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 was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (c *ObjectsBulkRestoreCall) Fields(s ...googleapi.Field) *ObjectsBulkRestoreCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.
func (c *ObjectsBulkRestoreCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
type ObjectsComposeCall struct {
// contains filtered or unexported fields
}
func (c *ObjectsComposeCall) Context(ctx context.Context) *ObjectsComposeCall
Context sets the context to be used in this call's Do method.
func (c *ObjectsComposeCall) DestinationPredefinedAcl(destinationPredefinedAcl string) *ObjectsComposeCall
DestinationPredefinedAcl sets the optional parameter "destinationPredefinedAcl": Apply a predefined set of access controls to the destination 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 (c *ObjectsComposeCall) Do(opts ...googleapi.CallOption) (*Object, error)
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) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (c *ObjectsComposeCall) Fields(s ...googleapi.Field) *ObjectsComposeCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.
func (c *ObjectsComposeCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
func (c *ObjectsComposeCall) IfGenerationMatch(ifGenerationMatch int64) *ObjectsComposeCall
IfGenerationMatch sets the optional parameter "ifGenerationMatch": Makes the operation conditional on whether the object's current generation matches the given value. Setting to 0 makes the operation succeed only if there are no live versions of the object.
func (c *ObjectsComposeCall) IfMetagenerationMatch(ifMetagenerationMatch int64) *ObjectsComposeCall
IfMetagenerationMatch sets the optional parameter "ifMetagenerationMatch": Makes the operation conditional on whether the object's current metageneration matches the given value.
func (c *ObjectsComposeCall) KmsKeyName(kmsKeyName string) *ObjectsComposeCall
KmsKeyName sets the optional parameter "kmsKeyName": Resource name of the Cloud KMS key, of the form projects/my-project/locations/global/keyRings/my-kr/cryptoKeys/my-key, that will be used to encrypt the object. Overrides the object metadata's kms_key_name value, if any.
func (c *ObjectsComposeCall) UserProject(userProject string) *ObjectsComposeCall
UserProject sets the optional parameter "userProject": The project to be billed for this request. Required for Requester Pays buckets.
type ObjectsCopyCall struct {
// contains filtered or unexported fields
}
func (c *ObjectsCopyCall) Context(ctx context.Context) *ObjectsCopyCall
Context sets the context to be used in this call's Do method.
func (c *ObjectsCopyCall) DestinationKmsKeyName(destinationKmsKeyName string) *ObjectsCopyCall
DestinationKmsKeyName sets the optional parameter "destinationKmsKeyName": Resource name of the Cloud KMS key, of the form projects/my-project/locations/global/keyRings/my-kr/cryptoKeys/my-key, that will be used to encrypt the object. Overrides the object metadata's kms_key_name value, if any.
func (c *ObjectsCopyCall) DestinationPredefinedAcl(destinationPredefinedAcl string) *ObjectsCopyCall
DestinationPredefinedAcl sets the optional parameter "destinationPredefinedAcl": Apply a predefined set of access controls to the destination 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 (c *ObjectsCopyCall) Do(opts ...googleapi.CallOption) (*Object, error)
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) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (c *ObjectsCopyCall) Fields(s ...googleapi.Field) *ObjectsCopyCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.
func (c *ObjectsCopyCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
func (c *ObjectsCopyCall) IfGenerationMatch(ifGenerationMatch int64) *ObjectsCopyCall
IfGenerationMatch sets the optional parameter "ifGenerationMatch": Makes the operation conditional on whether the destination object's current generation matches the given value. Setting to 0 makes the operation succeed only if there are no live versions of the object.
func (c *ObjectsCopyCall) IfGenerationNotMatch(ifGenerationNotMatch int64) *ObjectsCopyCall
IfGenerationNotMatch sets the optional parameter "ifGenerationNotMatch": Makes the operation conditional on whether the destination object's current generation does not match the given value. If no live object exists, the precondition fails. Setting to 0 makes the operation succeed only if there is a live version of the object.
func (c *ObjectsCopyCall) IfMetagenerationMatch(ifMetagenerationMatch int64) *ObjectsCopyCall
IfMetagenerationMatch sets the optional parameter "ifMetagenerationMatch": Makes the operation conditional on whether the destination object's current metageneration matches the given value.
func (c *ObjectsCopyCall) IfMetagenerationNotMatch(ifMetagenerationNotMatch int64) *ObjectsCopyCall
IfMetagenerationNotMatch sets the optional parameter "ifMetagenerationNotMatch": Makes the operation conditional on whether the destination object's current metageneration does not match the given value.
func (c *ObjectsCopyCall) IfSourceGenerationMatch(ifSourceGenerationMatch int64) *ObjectsCopyCall
IfSourceGenerationMatch sets the optional parameter "ifSourceGenerationMatch": Makes the operation conditional on whether the source object's current generation matches the given value.
func (c *ObjectsCopyCall) IfSourceGenerationNotMatch(ifSourceGenerationNotMatch int64) *ObjectsCopyCall
IfSourceGenerationNotMatch sets the optional parameter "ifSourceGenerationNotMatch": Makes the operation conditional on whether the source object's current generation does not match the given value.
func (c *ObjectsCopyCall) IfSourceMetagenerationMatch(ifSourceMetagenerationMatch int64) *ObjectsCopyCall
IfSourceMetagenerationMatch sets the optional parameter "ifSourceMetagenerationMatch": Makes the operation conditional on whether the source object's current metageneration matches the given value.
func (c *ObjectsCopyCall) IfSourceMetagenerationNotMatch(ifSourceMetagenerationNotMatch int64) *ObjectsCopyCall
IfSourceMetagenerationNotMatch sets the optional parameter "ifSourceMetagenerationNotMatch": Makes the operation conditional on whether the source object's current metageneration does not match the given value.
func (c *ObjectsCopyCall) Projection(projection string) *ObjectsCopyCall
Projection sets the optional parameter "projection": Set of properties to return. Defaults to noAcl, unless the object resource specifies the acl property, when it defaults to full.
Possible values:
"full" - Include all properties. "noAcl" - Omit the owner, acl property.
func (c *ObjectsCopyCall) SourceGeneration(sourceGeneration int64) *ObjectsCopyCall
SourceGeneration sets the optional parameter "sourceGeneration": If present, selects a specific revision of the source object (as opposed to the latest version, the default).
func (c *ObjectsCopyCall) UserProject(userProject string) *ObjectsCopyCall
UserProject sets the optional parameter "userProject": The project to be billed for this request. Required for Requester Pays buckets.
type ObjectsDeleteCall struct {
// contains filtered or unexported fields
}
func (c *ObjectsDeleteCall) Context(ctx context.Context) *ObjectsDeleteCall
Context sets the context to be used in this call's Do method.
func (c *ObjectsDeleteCall) Do(opts ...googleapi.CallOption) error
Do executes the "storage.objects.delete" call.
func (c *ObjectsDeleteCall) Fields(s ...googleapi.Field) *ObjectsDeleteCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.
func (c *ObjectsDeleteCall) Generation(generation int64) *ObjectsDeleteCall
Generation sets the optional parameter "generation": If present, permanently deletes a specific revision of this object (as opposed to the latest version, the default).
func (c *ObjectsDeleteCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
func (c *ObjectsDeleteCall) IfGenerationMatch(ifGenerationMatch int64) *ObjectsDeleteCall
IfGenerationMatch sets the optional parameter "ifGenerationMatch": Makes the operation conditional on whether the object's current generation matches the given value. Setting to 0 makes the operation succeed only if there are no live versions of the object.
func (c *ObjectsDeleteCall) IfGenerationNotMatch(ifGenerationNotMatch int64) *ObjectsDeleteCall
IfGenerationNotMatch sets the optional parameter "ifGenerationNotMatch": Makes the operation conditional on whether the object's current generation does not match the given value. If no live object exists, the precondition fails. Setting to 0 makes the operation succeed only if there is a live version of the object.
func (c *ObjectsDeleteCall) IfMetagenerationMatch(ifMetagenerationMatch int64) *ObjectsDeleteCall
IfMetagenerationMatch sets the optional parameter "ifMetagenerationMatch": Makes the operation conditional on whether the object's current metageneration matches the given value.
func (c *ObjectsDeleteCall) IfMetagenerationNotMatch(ifMetagenerationNotMatch int64) *ObjectsDeleteCall
IfMetagenerationNotMatch sets the optional parameter "ifMetagenerationNotMatch": Makes the operation conditional on whether the object's current metageneration does not match the given value.
func (c *ObjectsDeleteCall) UserProject(userProject string) *ObjectsDeleteCall
UserProject sets the optional parameter "userProject": The project to be billed for this request. Required for Requester Pays buckets.
type ObjectsGetCall struct {
// contains filtered or unexported fields
}
func (c *ObjectsGetCall) Context(ctx context.Context) *ObjectsGetCall
Context sets the context to be used in this call's Do and Download methods.
func (c *ObjectsGetCall) Do(opts ...googleapi.CallOption) (*Object, error)
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) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (c *ObjectsGetCall) Download(opts ...googleapi.CallOption) (*http.Response, error)
Download fetches the API endpoint's "media" value, instead of the normal API response value. If the returned error is nil, the Response is guaranteed to have a 2xx status code. Callers must close the Response.Body as usual.
func (c *ObjectsGetCall) Fields(s ...googleapi.Field) *ObjectsGetCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.
func (c *ObjectsGetCall) Generation(generation int64) *ObjectsGetCall
Generation sets the optional parameter "generation": If present, selects a specific revision of this object (as opposed to the latest version, the default).
func (c *ObjectsGetCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
func (c *ObjectsGetCall) IfGenerationMatch(ifGenerationMatch int64) *ObjectsGetCall
IfGenerationMatch sets the optional parameter "ifGenerationMatch": Makes the operation conditional on whether the object's current generation matches the given value. Setting to 0 makes the operation succeed only if there are no live versions of the object.
func (c *ObjectsGetCall) IfGenerationNotMatch(ifGenerationNotMatch int64) *ObjectsGetCall
IfGenerationNotMatch sets the optional parameter "ifGenerationNotMatch": Makes the operation conditional on whether the object's current generation does not match the given value. If no live object exists, the precondition fails. Setting to 0 makes the operation succeed only if there is a live version of the object.
func (c *ObjectsGetCall) IfMetagenerationMatch(ifMetagenerationMatch int64) *ObjectsGetCall
IfMetagenerationMatch sets the optional parameter "ifMetagenerationMatch": Makes the operation conditional on whether the object's current metageneration matches the given value.
func (c *ObjectsGetCall) IfMetagenerationNotMatch(ifMetagenerationNotMatch int64) *ObjectsGetCall
IfMetagenerationNotMatch sets the optional parameter "ifMetagenerationNotMatch": Makes the operation conditional on whether the object's current metageneration does not match the given value.
func (c *ObjectsGetCall) IfNoneMatch(entityTag string) *ObjectsGetCall
IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.
func (c *ObjectsGetCall) Projection(projection string) *ObjectsGetCall
Projection sets the optional parameter "projection": Set of properties to return. Defaults to noAcl.
Possible values:
"full" - Include all properties. "noAcl" - Omit the owner, acl property.
func (c *ObjectsGetCall) SoftDeleted(softDeleted bool) *ObjectsGetCall
SoftDeleted sets the optional parameter "softDeleted": If true, only soft-deleted object versions will be listed. The default is false. For more information, see Soft Delete.
func (c *ObjectsGetCall) UserProject(userProject string) *ObjectsGetCall
UserProject sets the optional parameter "userProject": The project to be billed for this request. Required for Requester Pays buckets.
type ObjectsGetIamPolicyCall struct {
// contains filtered or unexported fields
}
func (c *ObjectsGetIamPolicyCall) Context(ctx context.Context) *ObjectsGetIamPolicyCall
Context sets the context to be used in this call's Do method.
func (c *ObjectsGetIamPolicyCall) Do(opts ...googleapi.CallOption) (*Policy, error)
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) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (c *ObjectsGetIamPolicyCall) Fields(s ...googleapi.Field) *ObjectsGetIamPolicyCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.
func (c *ObjectsGetIamPolicyCall) Generation(generation int64) *ObjectsGetIamPolicyCall
Generation sets the optional parameter "generation": If present, selects a specific revision of this object (as opposed to the latest version, the default).
func (c *ObjectsGetIamPolicyCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
func (c *ObjectsGetIamPolicyCall) IfNoneMatch(entityTag string) *ObjectsGetIamPolicyCall
IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.
func (c *ObjectsGetIamPolicyCall) UserProject(userProject string) *ObjectsGetIamPolicyCall
UserProject sets the optional parameter "userProject": The project to be billed for this request. Required for Requester Pays buckets.
type ObjectsInsertCall struct {
// contains filtered or unexported fields
}
func (c *ObjectsInsertCall) ContentEncoding(contentEncoding string) *ObjectsInsertCall
ContentEncoding sets the optional parameter "contentEncoding": If set, sets the contentEncoding property of the final object to this value. Setting this parameter is equivalent to setting the contentEncoding metadata property. This can be useful when uploading an object with uploadType=media to indicate the encoding of the content being uploaded.
func (c *ObjectsInsertCall) Context(ctx context.Context) *ObjectsInsertCall
Context sets the context to be used in this call's Do method. This context will supersede any context previously provided to the ResumableMedia method.
func (c *ObjectsInsertCall) Do(opts ...googleapi.CallOption) (*Object, error)
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) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (c *ObjectsInsertCall) Fields(s ...googleapi.Field) *ObjectsInsertCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.
func (c *ObjectsInsertCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
func (c *ObjectsInsertCall) IfGenerationMatch(ifGenerationMatch int64) *ObjectsInsertCall
IfGenerationMatch sets the optional parameter "ifGenerationMatch": Makes the operation conditional on whether the object's current generation matches the given value. Setting to 0 makes the operation succeed only if there are no live versions of the object.
func (c *ObjectsInsertCall) IfGenerationNotMatch(ifGenerationNotMatch int64) *ObjectsInsertCall
IfGenerationNotMatch sets the optional parameter "ifGenerationNotMatch": Makes the operation conditional on whether the object's current generation does not match the given value. If no live object exists, the precondition fails. Setting to 0 makes the operation succeed only if there is a live version of the object.
func (c *ObjectsInsertCall) IfMetagenerationMatch(ifMetagenerationMatch int64) *ObjectsInsertCall
IfMetagenerationMatch sets the optional parameter "ifMetagenerationMatch": Makes the operation conditional on whether the object's current metageneration matches the given value.
func (c *ObjectsInsertCall) IfMetagenerationNotMatch(ifMetagenerationNotMatch int64) *ObjectsInsertCall
IfMetagenerationNotMatch sets the optional parameter "ifMetagenerationNotMatch": Makes the operation conditional on whether the object's current metageneration does not match the given value.
func (c *ObjectsInsertCall) KmsKeyName(kmsKeyName string) *ObjectsInsertCall
KmsKeyName sets the optional parameter "kmsKeyName": Resource name of the Cloud KMS key, of the form projects/my-project/locations/global/keyRings/my-kr/cryptoKeys/my-key, that will be used to encrypt the object. Overrides the object metadata's kms_key_name value, if any.
func (c *ObjectsInsertCall) Media(r io.Reader, options ...googleapi.MediaOption) *ObjectsInsertCall
Media specifies the media to upload in one or more chunks. The chunk size may be controlled by supplying a MediaOption generated by googleapi.ChunkSize. The chunk size defaults to googleapi.DefaultUploadChunkSize.The Content-Type header used in the upload request will be determined by sniffing the contents of r, unless a MediaOption generated by googleapi.ContentType is supplied. At most one of Media and ResumableMedia may be set.
func (c *ObjectsInsertCall) Name(name string) *ObjectsInsertCall
Name sets the optional parameter "name": Name of the object. Required when the object metadata is not otherwise provided. Overrides the object metadata's name value, if any. For information about how to URL encode object names to be path safe, see Encoding URI Path Parts (https://cloud.google.com/storage/docs/request-endpoints#encoding).
func (c *ObjectsInsertCall) PredefinedAcl(predefinedAcl string) *ObjectsInsertCall
PredefinedAcl sets the optional parameter "predefinedAcl": Apply a predefined 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 (c *ObjectsInsertCall) ProgressUpdater(pu googleapi.ProgressUpdater) *ObjectsInsertCall
ProgressUpdater provides a callback function that will be called after every chunk. It should be a low-latency function in order to not slow down the upload operation. This should only be called when using ResumableMedia (as opposed to Media).
func (c *ObjectsInsertCall) Projection(projection string) *ObjectsInsertCall
Projection sets the optional parameter "projection": Set of properties to return. Defaults to noAcl, unless the object resource specifies the acl property, when it defaults to full.
Possible values:
"full" - Include all properties. "noAcl" - Omit the owner, acl property.
func (c *ObjectsInsertCall) ResumableMedia(ctx context.Context, r io.ReaderAt, size int64, mediaType string) *ObjectsInsertCall
ResumableMedia specifies the media to upload in chunks and can be canceled with ctx.
Deprecated: use Media instead.
At most one of Media and ResumableMedia may be set. mediaType identifies the MIME media type of the upload, such as "image/png". If mediaType is "", it will be auto-detected. The provided ctx will supersede any context previously provided to the Context method.
func (c *ObjectsInsertCall) UserProject(userProject string) *ObjectsInsertCall
UserProject sets the optional parameter "userProject": The project to be billed for this request. Required for Requester Pays buckets.
func (c *ObjectsInsertCall) WithRetry(bo *gax.Backoff, errorFunc func(err error) bool) *ObjectsInsertCall
WithRetry causes the library to retry the initial request of the upload(for resumable uploads) or the entire upload (for multipart uploads) ifa transient error occurs. This is contingent on ChunkSize being > 0 (sothat the input data may be buffered). The backoff argument will be used todetermine exponential backoff timing, and the errorFunc is used to determinewhich errors are considered retryable. By default, exponetial backoff will beapplied using gax defaults, and the following errors are retried:
- HTTP responses with codes 408, 429, 502, 503, and 504.
- Transient network errors such as connection reset and io.ErrUnexpectedEOF.
- Errors which are considered transient using the Temporary() interface.
- Wrapped versions of these errors.
type ObjectsListCall struct {
// contains filtered or unexported fields
}
func (c *ObjectsListCall) Context(ctx context.Context) *ObjectsListCall
Context sets the context to be used in this call's Do method.
func (c *ObjectsListCall) Delimiter(delimiter string) *ObjectsListCall
Delimiter sets the optional parameter "delimiter": Returns results in a directory-like mode. items will contain only objects whose names, aside from the prefix, do not contain delimiter. Objects whose names, aside from the prefix, contain delimiter will have their name, truncated after the delimiter, returned in prefixes. Duplicate prefixes are omitted.
func (c *ObjectsListCall) Do(opts ...googleapi.CallOption) (*Objects, error)
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) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (c *ObjectsListCall) EndOffset(endOffset string) *ObjectsListCall
EndOffset sets the optional parameter "endOffset": Filter results to objects whose names are lexicographically before endOffset. If startOffset is also set, the objects listed will have names between startOffset (inclusive) and endOffset (exclusive).
func (c *ObjectsListCall) Fields(s ...googleapi.Field) *ObjectsListCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.
func (c *ObjectsListCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
func (c *ObjectsListCall) IfNoneMatch(entityTag string) *ObjectsListCall
IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.
func (c *ObjectsListCall) IncludeFoldersAsPrefixes(includeFoldersAsPrefixes bool) *ObjectsListCall
IncludeFoldersAsPrefixes sets the optional parameter "includeFoldersAsPrefixes": Only applicable if delimiter is set to '/'. If true, will also include folders and managed folders (besides objects) in the returned prefixes.
func (c *ObjectsListCall) IncludeTrailingDelimiter(includeTrailingDelimiter bool) *ObjectsListCall
IncludeTrailingDelimiter sets the optional parameter "includeTrailingDelimiter": If true, objects that end in exactly one instance of delimiter will have their metadata included in items in addition to prefixes.
func (c *ObjectsListCall) MatchGlob(matchGlob string) *ObjectsListCall
MatchGlob sets the optional parameter "matchGlob": Filter results to objects and prefixes that match this glob pattern.
func (c *ObjectsListCall) MaxResults(maxResults int64) *ObjectsListCall
MaxResults sets the optional parameter "maxResults": Maximum number of items plus prefixes to return in a single page of responses. As duplicate prefixes are omitted, fewer total results may be returned than requested. The service will use this parameter or 1,000 items, whichever is smaller.
func (c *ObjectsListCall) PageToken(pageToken string) *ObjectsListCall
PageToken sets the optional parameter "pageToken": A previously-returned page token representing part of the larger set of results to view.
func (c *ObjectsListCall) Pages(ctx context.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 (c *ObjectsListCall) Prefix(prefix string) *ObjectsListCall
Prefix sets the optional parameter "prefix": Filter results to objects whose names begin with this prefix.
func (c *ObjectsListCall) Projection(projection string) *ObjectsListCall
Projection sets the optional parameter "projection": Set of properties to return. Defaults to noAcl.
Possible values:
"full" - Include all properties. "noAcl" - Omit the owner, acl property.
func (c *ObjectsListCall) SoftDeleted(softDeleted bool) *ObjectsListCall
SoftDeleted sets the optional parameter "softDeleted": If true, only soft-deleted object versions will be listed. The default is false. For more information, see Soft Delete.
func (c *ObjectsListCall) StartOffset(startOffset string) *ObjectsListCall
StartOffset sets the optional parameter "startOffset": Filter results to objects whose names are lexicographically equal to or after startOffset. If endOffset is also set, the objects listed will have names between startOffset (inclusive) and endOffset (exclusive).
func (c *ObjectsListCall) UserProject(userProject string) *ObjectsListCall
UserProject sets the optional parameter "userProject": The project to be billed for this request. Required for Requester Pays buckets.
func (c *ObjectsListCall) Versions(versions bool) *ObjectsListCall
Versions sets the optional parameter "versions": If true, lists all versions of an object as distinct results. The default is false. For more information, see Object Versioning.
type ObjectsPatchCall struct {
// contains filtered or unexported fields
}
func (c *ObjectsPatchCall) Context(ctx context.Context) *ObjectsPatchCall
Context sets the context to be used in this call's Do method.
func (c *ObjectsPatchCall) Do(opts ...googleapi.CallOption) (*Object, error)
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) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (c *ObjectsPatchCall) Fields(s ...googleapi.Field) *ObjectsPatchCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.
func (c *ObjectsPatchCall) Generation(generation int64) *ObjectsPatchCall
Generation sets the optional parameter "generation": If present, selects a specific revision of this object (as opposed to the latest version, the default).
func (c *ObjectsPatchCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
func (c *ObjectsPatchCall) IfGenerationMatch(ifGenerationMatch int64) *ObjectsPatchCall
IfGenerationMatch sets the optional parameter "ifGenerationMatch": Makes the operation conditional on whether the object's current generation matches the given value. Setting to 0 makes the operation succeed only if there are no live versions of the object.
func (c *ObjectsPatchCall) IfGenerationNotMatch(ifGenerationNotMatch int64) *ObjectsPatchCall
IfGenerationNotMatch sets the optional parameter "ifGenerationNotMatch": Makes the operation conditional on whether the object's current generation does not match the given value. If no live object exists, the precondition fails. Setting to 0 makes the operation succeed only if there is a live version of the object.
func (c *ObjectsPatchCall) IfMetagenerationMatch(ifMetagenerationMatch int64) *ObjectsPatchCall
IfMetagenerationMatch sets the optional parameter "ifMetagenerationMatch": Makes the operation conditional on whether the object's current metageneration matches the given value.
func (c *ObjectsPatchCall) IfMetagenerationNotMatch(ifMetagenerationNotMatch int64) *ObjectsPatchCall
IfMetagenerationNotMatch sets the optional parameter "ifMetagenerationNotMatch": Makes the operation conditional on whether the object's current metageneration does not match the given value.
func (c *ObjectsPatchCall) OverrideUnlockedRetention(overrideUnlockedRetention bool) *ObjectsPatchCall
OverrideUnlockedRetention sets the optional parameter "overrideUnlockedRetention": Must be true to remove the retention configuration, reduce its unlocked retention period, or change its mode from unlocked to locked.
func (c *ObjectsPatchCall) PredefinedAcl(predefinedAcl string) *ObjectsPatchCall
PredefinedAcl sets the optional parameter "predefinedAcl": Apply a predefined 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 (c *ObjectsPatchCall) Projection(projection string) *ObjectsPatchCall
Projection sets the optional parameter "projection": Set of properties to return. Defaults to full.
Possible values:
"full" - Include all properties. "noAcl" - Omit the owner, acl property.
func (c *ObjectsPatchCall) UserProject(userProject string) *ObjectsPatchCall
UserProject sets the optional parameter "userProject": The project to be billed for this request, for Requester Pays buckets.
type ObjectsRestoreCall struct {
// contains filtered or unexported fields
}
func (c *ObjectsRestoreCall) Context(ctx context.Context) *ObjectsRestoreCall
Context sets the context to be used in this call's Do method.
func (c *ObjectsRestoreCall) CopySourceAcl(copySourceAcl bool) *ObjectsRestoreCall
CopySourceAcl sets the optional parameter "copySourceAcl": If true, copies the source object's ACL; otherwise, uses the bucket's default object ACL. The default is false.
func (c *ObjectsRestoreCall) Do(opts ...googleapi.CallOption) (*Object, error)
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) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (c *ObjectsRestoreCall) Fields(s ...googleapi.Field) *ObjectsRestoreCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.
func (c *ObjectsRestoreCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
func (c *ObjectsRestoreCall) IfGenerationMatch(ifGenerationMatch int64) *ObjectsRestoreCall
IfGenerationMatch sets the optional parameter "ifGenerationMatch": Makes the operation conditional on whether the object's one live generation matches the given value. Setting to 0 makes the operation succeed only if there are no live versions of the object.
func (c *ObjectsRestoreCall) IfGenerationNotMatch(ifGenerationNotMatch int64) *ObjectsRestoreCall
IfGenerationNotMatch sets the optional parameter "ifGenerationNotMatch": Makes the operation conditional on whether none of the object's live generations match the given value. If no live object exists, the precondition fails. Setting to 0 makes the operation succeed only if there is a live version of the object.
func (c *ObjectsRestoreCall) IfMetagenerationMatch(ifMetagenerationMatch int64) *ObjectsRestoreCall
IfMetagenerationMatch sets the optional parameter "ifMetagenerationMatch": Makes the operation conditional on whether the object's one live metageneration matches the given value.
func (c *ObjectsRestoreCall) IfMetagenerationNotMatch(ifMetagenerationNotMatch int64) *ObjectsRestoreCall
IfMetagenerationNotMatch sets the optional parameter "ifMetagenerationNotMatch": Makes the operation conditional on whether none of the object's live metagenerations match the given value.
func (c *ObjectsRestoreCall) Projection(projection string) *ObjectsRestoreCall
Projection sets the optional parameter "projection": Set of properties to return. Defaults to full.
Possible values:
"full" - Include all properties. "noAcl" - Omit the owner, acl property.
func (c *ObjectsRestoreCall) UserProject(userProject string) *ObjectsRestoreCall
UserProject sets the optional parameter "userProject": The project to be billed for this request. Required for Requester Pays buckets.
type ObjectsRewriteCall struct {
// contains filtered or unexported fields
}
func (c *ObjectsRewriteCall) Context(ctx context.Context) *ObjectsRewriteCall
Context sets the context to be used in this call's Do method.
func (c *ObjectsRewriteCall) DestinationKmsKeyName(destinationKmsKeyName string) *ObjectsRewriteCall
DestinationKmsKeyName sets the optional parameter "destinationKmsKeyName": Resource name of the Cloud KMS key, of the form projects/my-project/locations/global/keyRings/my-kr/cryptoKeys/my-key, that will be used to encrypt the object. Overrides the object metadata's kms_key_name value, if any.
func (c *ObjectsRewriteCall) DestinationPredefinedAcl(destinationPredefinedAcl string) *ObjectsRewriteCall
DestinationPredefinedAcl sets the optional parameter "destinationPredefinedAcl": Apply a predefined set of access controls to the destination 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 (c *ObjectsRewriteCall) Do(opts ...googleapi.CallOption) (*RewriteResponse, error)
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 at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (c *ObjectsRewriteCall) Fields(s ...googleapi.Field) *ObjectsRewriteCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.
func (c *ObjectsRewriteCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
func (c *ObjectsRewriteCall) IfGenerationMatch(ifGenerationMatch int64) *ObjectsRewriteCall
IfGenerationMatch sets the optional parameter "ifGenerationMatch": Makes the operation conditional on whether the object's current generation matches the given value. Setting to 0 makes the operation succeed only if there are no live versions of the object.
func (c *ObjectsRewriteCall) IfGenerationNotMatch(ifGenerationNotMatch int64) *ObjectsRewriteCall
IfGenerationNotMatch sets the optional parameter "ifGenerationNotMatch": Makes the operation conditional on whether the object's current generation does not match the given value. If no live object exists, the precondition fails. Setting to 0 makes the operation succeed only if there is a live version of the object.
func (c *ObjectsRewriteCall) IfMetagenerationMatch(ifMetagenerationMatch int64) *ObjectsRewriteCall
IfMetagenerationMatch sets the optional parameter "ifMetagenerationMatch": Makes the operation conditional on whether the destination object's current metageneration matches the given value.
func (c *ObjectsRewriteCall) IfMetagenerationNotMatch(ifMetagenerationNotMatch int64) *ObjectsRewriteCall
IfMetagenerationNotMatch sets the optional parameter "ifMetagenerationNotMatch": Makes the operation conditional on whether the destination object's current metageneration does not match the given value.
func (c *ObjectsRewriteCall) IfSourceGenerationMatch(ifSourceGenerationMatch int64) *ObjectsRewriteCall
IfSourceGenerationMatch sets the optional parameter "ifSourceGenerationMatch": Makes the operation conditional on whether the source object's current generation matches the given value.
func (c *ObjectsRewriteCall) IfSourceGenerationNotMatch(ifSourceGenerationNotMatch int64) *ObjectsRewriteCall
IfSourceGenerationNotMatch sets the optional parameter "ifSourceGenerationNotMatch": Makes the operation conditional on whether the source object's current generation does not match the given value.
func (c *ObjectsRewriteCall) IfSourceMetagenerationMatch(ifSourceMetagenerationMatch int64) *ObjectsRewriteCall
IfSourceMetagenerationMatch sets the optional parameter "ifSourceMetagenerationMatch": Makes the operation conditional on whether the source object's current metageneration matches the given value.
func (c *ObjectsRewriteCall) IfSourceMetagenerationNotMatch(ifSourceMetagenerationNotMatch int64) *ObjectsRewriteCall
IfSourceMetagenerationNotMatch sets the optional parameter "ifSourceMetagenerationNotMatch": Makes the operation conditional on whether the source object's current metageneration does not match the given value.
func (c *ObjectsRewriteCall) MaxBytesRewrittenPerCall(maxBytesRewrittenPerCall int64) *ObjectsRewriteCall
MaxBytesRewrittenPerCall sets the optional parameter "maxBytesRewrittenPerCall": The maximum number of bytes that will be rewritten per rewrite request. Most callers shouldn't need to specify this parameter - it is primarily in place to support testing. If specified the value must be an integral multiple of 1 MiB (1048576). Also, this only applies to requests where the source and destination span locations and/or storage classes. Finally, this value must not change across rewrite calls else you'll get an error that the rewriteToken is invalid.
func (c *ObjectsRewriteCall) Projection(projection string) *ObjectsRewriteCall
Projection sets the optional parameter "projection": Set of properties to return. Defaults to noAcl, unless the object resource specifies the acl property, when it defaults to full.
Possible values:
"full" - Include all properties. "noAcl" - Omit the owner, acl property.
func (c *ObjectsRewriteCall) RewriteToken(rewriteToken string) *ObjectsRewriteCall
RewriteToken sets the optional parameter "rewriteToken": Include this field (from the previous rewrite response) on each rewrite request after the first one, until the rewrite response 'done' flag is true. Calls that provide a rewriteToken can omit all other request fields, but if included those fields must match the values provided in the first rewrite request.
func (c *ObjectsRewriteCall) SourceGeneration(sourceGeneration int64) *ObjectsRewriteCall
SourceGeneration sets the optional parameter "sourceGeneration": If present, selects a specific revision of the source object (as opposed to the latest version, the default).
func (c *ObjectsRewriteCall) UserProject(userProject string) *ObjectsRewriteCall
UserProject sets the optional parameter "userProject": The project to be billed for this request. Required for Requester Pays buckets.
type ObjectsService struct {
// contains filtered or unexported fields
}
func NewObjectsService(s *Service) *ObjectsService
func (r *ObjectsService) BulkRestore(bucket string, bulkrestoreobjectsrequest *BulkRestoreObjectsRequest) *ObjectsBulkRestoreCall
BulkRestore: Initiates a long-running bulk restore operation on the specified bucket.
- bucket: Name of the bucket in which the object resides.
func (r *ObjectsService) Compose(destinationBucket string, destinationObject string, composerequest *ComposeRequest) *ObjectsComposeCall
Compose: Concatenates a list of existing objects into a new object in the same bucket.
func (r *ObjectsService) Copy(sourceBucket string, sourceObject string, destinationBucket string, destinationObject string, object *Object) *ObjectsCopyCall
Copy: Copies a source object to a destination object. Optionally overrides metadata.
func (r *ObjectsService) Delete(bucket string, object string) *ObjectsDeleteCall
Delete: Deletes an object and its metadata. Deletions are permanent if versioning is not enabled for the bucket, or if the generation parameter is used.
func (r *ObjectsService) Get(bucket string, object string) *ObjectsGetCall
Get: Retrieves an object or its metadata.
func (r *ObjectsService) GetIamPolicy(bucket string, object string) *ObjectsGetIamPolicyCall
GetIamPolicy: Returns an IAM policy for the specified object.
func (r *ObjectsService) Insert(bucket string, object *Object) *ObjectsInsertCall
Insert: Stores a new object and metadata.
func (r *ObjectsService) List(bucket string) *ObjectsListCall
List: Retrieves a list of objects matching the criteria.
- bucket: Name of the bucket in which to look for objects.
func (r *ObjectsService) Patch(bucket string, object string, object2 *Object) *ObjectsPatchCall
Patch: Patches an object's metadata.
func (r *ObjectsService) Restore(bucket string, object string, generation int64) *ObjectsRestoreCall
Restore: Restores a soft-deleted object.
func (r *ObjectsService) Rewrite(sourceBucket string, sourceObject string, destinationBucket string, destinationObject string, object *Object) *ObjectsRewriteCall
Rewrite: Rewrites a source object to a destination object. Optionally overrides metadata.
func (r *ObjectsService) SetIamPolicy(bucket string, object string, policy *Policy) *ObjectsSetIamPolicyCall
SetIamPolicy: Updates an IAM policy for the specified object.
func (r *ObjectsService) TestIamPermissions(bucket string, object string, permissions []string) *ObjectsTestIamPermissionsCall
TestIamPermissions: Tests a set of permissions on the given object to see which, if any, are held by the caller.
func (r *ObjectsService) Update(bucket string, object string, object2 *Object) *ObjectsUpdateCall
Update: Updates an object's metadata.
func (r *ObjectsService) WatchAll(bucket string, channel *Channel) *ObjectsWatchAllCall
WatchAll: Watch for changes on all objects in a bucket.
- bucket: Name of the bucket in which to look for objects.
type ObjectsSetIamPolicyCall struct {
// contains filtered or unexported fields
}
func (c *ObjectsSetIamPolicyCall) Context(ctx context.Context) *ObjectsSetIamPolicyCall
Context sets the context to be used in this call's Do method.
func (c *ObjectsSetIamPolicyCall) Do(opts ...googleapi.CallOption) (*Policy, error)
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) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (c *ObjectsSetIamPolicyCall) Fields(s ...googleapi.Field) *ObjectsSetIamPolicyCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.
func (c *ObjectsSetIamPolicyCall) Generation(generation int64) *ObjectsSetIamPolicyCall
Generation sets the optional parameter "generation": If present, selects a specific revision of this object (as opposed to the latest version, the default).
func (c *ObjectsSetIamPolicyCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
func (c *ObjectsSetIamPolicyCall) UserProject(userProject string) *ObjectsSetIamPolicyCall
UserProject sets the optional parameter "userProject": The project to be billed for this request. Required for Requester Pays buckets.
type ObjectsTestIamPermissionsCall struct {
// contains filtered or unexported fields
}
func (c *ObjectsTestIamPermissionsCall) Context(ctx context.Context) *ObjectsTestIamPermissionsCall
Context sets the context to be used in this call's Do method.
func (c *ObjectsTestIamPermissionsCall) Do(opts ...googleapi.CallOption) (*TestIamPermissionsResponse, error)
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 was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (c *ObjectsTestIamPermissionsCall) Fields(s ...googleapi.Field) *ObjectsTestIamPermissionsCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.
func (c *ObjectsTestIamPermissionsCall) Generation(generation int64) *ObjectsTestIamPermissionsCall
Generation sets the optional parameter "generation": If present, selects a specific revision of this object (as opposed to the latest version, the default).
func (c *ObjectsTestIamPermissionsCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
func (c *ObjectsTestIamPermissionsCall) IfNoneMatch(entityTag string) *ObjectsTestIamPermissionsCall
IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.
func (c *ObjectsTestIamPermissionsCall) UserProject(userProject string) *ObjectsTestIamPermissionsCall
UserProject sets the optional parameter "userProject": The project to be billed for this request. Required for Requester Pays buckets.
type ObjectsUpdateCall struct {
// contains filtered or unexported fields
}
func (c *ObjectsUpdateCall) Context(ctx context.Context) *ObjectsUpdateCall
Context sets the context to be used in this call's Do method.
func (c *ObjectsUpdateCall) Do(opts ...googleapi.CallOption) (*Object, error)
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) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (c *ObjectsUpdateCall) Fields(s ...googleapi.Field) *ObjectsUpdateCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.
func (c *ObjectsUpdateCall) Generation(generation int64) *ObjectsUpdateCall
Generation sets the optional parameter "generation": If present, selects a specific revision of this object (as opposed to the latest version, the default).
func (c *ObjectsUpdateCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
func (c *ObjectsUpdateCall) IfGenerationMatch(ifGenerationMatch int64) *ObjectsUpdateCall
IfGenerationMatch sets the optional parameter "ifGenerationMatch": Makes the operation conditional on whether the object's current generation matches the given value. Setting to 0 makes the operation succeed only if there are no live versions of the object.
func (c *ObjectsUpdateCall) IfGenerationNotMatch(ifGenerationNotMatch int64) *ObjectsUpdateCall
IfGenerationNotMatch sets the optional parameter "ifGenerationNotMatch": Makes the operation conditional on whether the object's current generation does not match the given value. If no live object exists, the precondition fails. Setting to 0 makes the operation succeed only if there is a live version of the object.
func (c *ObjectsUpdateCall) IfMetagenerationMatch(ifMetagenerationMatch int64) *ObjectsUpdateCall
IfMetagenerationMatch sets the optional parameter "ifMetagenerationMatch": Makes the operation conditional on whether the object's current metageneration matches the given value.
func (c *ObjectsUpdateCall) IfMetagenerationNotMatch(ifMetagenerationNotMatch int64) *ObjectsUpdateCall
IfMetagenerationNotMatch sets the optional parameter "ifMetagenerationNotMatch": Makes the operation conditional on whether the object's current metageneration does not match the given value.
func (c *ObjectsUpdateCall) OverrideUnlockedRetention(overrideUnlockedRetention bool) *ObjectsUpdateCall
OverrideUnlockedRetention sets the optional parameter "overrideUnlockedRetention": Must be true to remove the retention configuration, reduce its unlocked retention period, or change its mode from unlocked to locked.
func (c *ObjectsUpdateCall) PredefinedAcl(predefinedAcl string) *ObjectsUpdateCall
PredefinedAcl sets the optional parameter "predefinedAcl": Apply a predefined 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 (c *ObjectsUpdateCall) Projection(projection string) *ObjectsUpdateCall
Projection sets the optional parameter "projection": Set of properties to return. Defaults to full.
Possible values:
"full" - Include all properties. "noAcl" - Omit the owner, acl property.
func (c *ObjectsUpdateCall) UserProject(userProject string) *ObjectsUpdateCall
UserProject sets the optional parameter "userProject": The project to be billed for this request. Required for Requester Pays buckets.
type ObjectsWatchAllCall struct {
// contains filtered or unexported fields
}
func (c *ObjectsWatchAllCall) Context(ctx context.Context) *ObjectsWatchAllCall
Context sets the context to be used in this call's Do method.
func (c *ObjectsWatchAllCall) Delimiter(delimiter string) *ObjectsWatchAllCall
Delimiter sets the optional parameter "delimiter": Returns results in a directory-like mode. items will contain only objects whose names, aside from the prefix, do not contain delimiter. Objects whose names, aside from the prefix, contain delimiter will have their name, truncated after the delimiter, returned in prefixes. Duplicate prefixes are omitted.
func (c *ObjectsWatchAllCall) Do(opts ...googleapi.CallOption) (*Channel, error)
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) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (c *ObjectsWatchAllCall) EndOffset(endOffset string) *ObjectsWatchAllCall
EndOffset sets the optional parameter "endOffset": Filter results to objects whose names are lexicographically before endOffset. If startOffset is also set, the objects listed will have names between startOffset (inclusive) and endOffset (exclusive).
func (c *ObjectsWatchAllCall) Fields(s ...googleapi.Field) *ObjectsWatchAllCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.
func (c *ObjectsWatchAllCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
func (c *ObjectsWatchAllCall) IncludeTrailingDelimiter(includeTrailingDelimiter bool) *ObjectsWatchAllCall
IncludeTrailingDelimiter sets the optional parameter "includeTrailingDelimiter": If true, objects that end in exactly one instance of delimiter will have their metadata included in items in addition to prefixes.
func (c *ObjectsWatchAllCall) MaxResults(maxResults int64) *ObjectsWatchAllCall
MaxResults sets the optional parameter "maxResults": Maximum number of items plus prefixes to return in a single page of responses. As duplicate prefixes are omitted, fewer total results may be returned than requested. The service will use this parameter or 1,000 items, whichever is smaller.
func (c *ObjectsWatchAllCall) PageToken(pageToken string) *ObjectsWatchAllCall
PageToken sets the optional parameter "pageToken": A previously-returned page token representing part of the larger set of results to view.
func (c *ObjectsWatchAllCall) Prefix(prefix string) *ObjectsWatchAllCall
Prefix sets the optional parameter "prefix": Filter results to objects whose names begin with this prefix.
func (c *ObjectsWatchAllCall) Projection(projection string) *ObjectsWatchAllCall
Projection sets the optional parameter "projection": Set of properties to return. Defaults to noAcl.
Possible values:
"full" - Include all properties. "noAcl" - Omit the owner, acl property.
func (c *ObjectsWatchAllCall) StartOffset(startOffset string) *ObjectsWatchAllCall
StartOffset sets the optional parameter "startOffset": Filter results to objects whose names are lexicographically equal to or after startOffset. If endOffset is also set, the objects listed will have names between startOffset (inclusive) and endOffset (exclusive).
func (c *ObjectsWatchAllCall) UserProject(userProject string) *ObjectsWatchAllCall
UserProject sets the optional parameter "userProject": The project to be billed for this request. Required for Requester Pays buckets.
func (c *ObjectsWatchAllCall) Versions(versions bool) *ObjectsWatchAllCall
Versions sets the optional parameter "versions": If true, lists all versions of an object as distinct results. The default is false. For more information, see Object Versioning.
type OperationsCancelCall struct {
// contains filtered or unexported fields
}
func (c *OperationsCancelCall) Context(ctx context.Context) *OperationsCancelCall
Context sets the context to be used in this call's Do method.
func (c *OperationsCancelCall) Do(opts ...googleapi.CallOption) error
Do executes the "storage.buckets.operations.cancel" call.
func (c *OperationsCancelCall) Fields(s ...googleapi.Field) *OperationsCancelCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.
func (c *OperationsCancelCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
type OperationsGetCall struct {
// contains filtered or unexported fields
}
func (c *OperationsGetCall) Context(ctx context.Context) *OperationsGetCall
Context sets the context to be used in this call's Do method.
func (c *OperationsGetCall) Do(opts ...googleapi.CallOption) (*GoogleLongrunningOperation, error)
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 was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (c *OperationsGetCall) Fields(s ...googleapi.Field) *OperationsGetCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.
func (c *OperationsGetCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
func (c *OperationsGetCall) IfNoneMatch(entityTag string) *OperationsGetCall
IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.
type OperationsListCall struct {
// contains filtered or unexported fields
}
func (c *OperationsListCall) Context(ctx context.Context) *OperationsListCall
Context sets the context to be used in this call's Do method.
func (c *OperationsListCall) Do(opts ...googleapi.CallOption) (*GoogleLongrunningListOperationsResponse, error)
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 a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (c *OperationsListCall) Fields(s ...googleapi.Field) *OperationsListCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.
func (c *OperationsListCall) Filter(filter string) *OperationsListCall
Filter sets the optional parameter "filter": A filter to narrow down results to a preferred subset. The filtering language is documented in more detail in AIP-160 (https://google.aip.dev/160).
func (c *OperationsListCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
func (c *OperationsListCall) IfNoneMatch(entityTag string) *OperationsListCall
IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.
func (c *OperationsListCall) PageSize(pageSize int64) *OperationsListCall
PageSize sets the optional parameter "pageSize": Maximum number of items to return in a single page of responses. Fewer total results may be returned than requested. The service uses this parameter or 100 items, whichever is smaller.
func (c *OperationsListCall) PageToken(pageToken string) *OperationsListCall
PageToken sets the optional parameter "pageToken": A previously-returned page token representing part of the larger set of results to view.
func (c *OperationsListCall) Pages(ctx context.Context, f func(*GoogleLongrunningListOperationsResponse) error) error
Pages invokes f for each page of results. A non-nil error returned from f will halt the iteration. The provided context supersedes any context provided to the Context method.
type OperationsService struct {
// contains filtered or unexported fields
}
func NewOperationsService(s *Service) *OperationsService
func (r *OperationsService) Cancel(bucket string, operationId string) *OperationsCancelCall
Cancel: Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed.
- bucket: The parent bucket of the operation resource. - operationId: The ID of the operation resource.
func (r *OperationsService) Get(bucket string, operationId string) *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 (r *OperationsService) List(bucket string) *OperationsListCall
List: Lists operations that match the specified filter in the request.
- bucket: Name of the bucket in which to look for operations.
Policy: A bucket/object/managedFolder IAM policy.
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.
Etag string `json:"etag,omitempty"`
// Kind: The kind of item this is. For policies, this is always storage#policy.
// This field is ignored on input.
Kind string `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.
ResourceId string `json:"resourceId,omitempty"`
// Version: The IAM policy format version.
Version int64 `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:"-"`
}
func (s *Policy) MarshalJSON() ([]byte, error)
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-project
Members []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.
Role string `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 (s *PolicyBindings) MarshalJSON() ([]byte, error)
type ProjectsHmacKeysCreateCall struct {
// contains filtered or unexported fields
}
func (c *ProjectsHmacKeysCreateCall) Context(ctx context.Context) *ProjectsHmacKeysCreateCall
Context sets the context to be used in this call's Do method.
func (c *ProjectsHmacKeysCreateCall) Do(opts ...googleapi.CallOption) (*HmacKey, error)
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) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (c *ProjectsHmacKeysCreateCall) Fields(s ...googleapi.Field) *ProjectsHmacKeysCreateCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.
func (c *ProjectsHmacKeysCreateCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
func (c *ProjectsHmacKeysCreateCall) UserProject(userProject string) *ProjectsHmacKeysCreateCall
UserProject sets the optional parameter "userProject": The project to be billed for this request.
type ProjectsHmacKeysDeleteCall struct {
// contains filtered or unexported fields
}
func (c *ProjectsHmacKeysDeleteCall) Context(ctx context.Context) *ProjectsHmacKeysDeleteCall
Context sets the context to be used in this call's Do method.
func (c *ProjectsHmacKeysDeleteCall) Do(opts ...googleapi.CallOption) error
Do executes the "storage.projects.hmacKeys.delete" call.
func (c *ProjectsHmacKeysDeleteCall) Fields(s ...googleapi.Field) *ProjectsHmacKeysDeleteCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.
func (c *ProjectsHmacKeysDeleteCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
func (c *ProjectsHmacKeysDeleteCall) UserProject(userProject string) *ProjectsHmacKeysDeleteCall
UserProject sets the optional parameter "userProject": The project to be billed for this request.
type ProjectsHmacKeysGetCall struct {
// contains filtered or unexported fields
}
func (c *ProjectsHmacKeysGetCall) Context(ctx context.Context) *ProjectsHmacKeysGetCall
Context sets the context to be used in this call's Do method.
func (c *ProjectsHmacKeysGetCall) Do(opts ...googleapi.CallOption) (*HmacKeyMetadata, error)
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 at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (c *ProjectsHmacKeysGetCall) Fields(s ...googleapi.Field) *ProjectsHmacKeysGetCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.
func (c *ProjectsHmacKeysGetCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
func (c *ProjectsHmacKeysGetCall) IfNoneMatch(entityTag string) *ProjectsHmacKeysGetCall
IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.
func (c *ProjectsHmacKeysGetCall) UserProject(userProject string) *ProjectsHmacKeysGetCall
UserProject sets the optional parameter "userProject": The project to be billed for this request.
type ProjectsHmacKeysListCall struct {
// contains filtered or unexported fields
}
func (c *ProjectsHmacKeysListCall) Context(ctx context.Context) *ProjectsHmacKeysListCall
Context sets the context to be used in this call's Do method.
func (c *ProjectsHmacKeysListCall) Do(opts ...googleapi.CallOption) (*HmacKeysMetadata, error)
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 at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (c *ProjectsHmacKeysListCall) Fields(s ...googleapi.Field) *ProjectsHmacKeysListCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.
func (c *ProjectsHmacKeysListCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
func (c *ProjectsHmacKeysListCall) IfNoneMatch(entityTag string) *ProjectsHmacKeysListCall
IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.
func (c *ProjectsHmacKeysListCall) MaxResults(maxResults int64) *ProjectsHmacKeysListCall
MaxResults sets the optional parameter "maxResults": Maximum number of items to return in a single page of responses. The service uses this parameter or 250 items, whichever is smaller. The max number of items per page will also be limited by the number of distinct service accounts in the response. If the number of service accounts in a single response is too high, the page will truncated and a next page token will be returned.
func (c *ProjectsHmacKeysListCall) PageToken(pageToken string) *ProjectsHmacKeysListCall
PageToken sets the optional parameter "pageToken": A previously-returned page token representing part of the larger set of results to view.
func (c *ProjectsHmacKeysListCall) Pages(ctx context.Context, f func(*HmacKeysMetadata) 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 (c *ProjectsHmacKeysListCall) ServiceAccountEmail(serviceAccountEmail string) *ProjectsHmacKeysListCall
ServiceAccountEmail sets the optional parameter "serviceAccountEmail": If present, only keys for the given service account are returned.
func (c *ProjectsHmacKeysListCall) ShowDeletedKeys(showDeletedKeys bool) *ProjectsHmacKeysListCall
ShowDeletedKeys sets the optional parameter "showDeletedKeys": Whether or not to show keys in the DELETED state.
func (c *ProjectsHmacKeysListCall) UserProject(userProject string) *ProjectsHmacKeysListCall
UserProject sets the optional parameter "userProject": The project to be billed for this request.
type ProjectsHmacKeysService struct {
// contains filtered or unexported fields
}
func NewProjectsHmacKeysService(s *Service) *ProjectsHmacKeysService
func (r *ProjectsHmacKeysService) Create(projectId string, serviceAccountEmail string) *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 (r *ProjectsHmacKeysService) Delete(projectId string, accessId string) *ProjectsHmacKeysDeleteCall
Delete: Deletes an HMAC key.
- accessId: Name of the HMAC key to be deleted. - projectId: Project ID owning the requested key.
func (r *ProjectsHmacKeysService) Get(projectId string, accessId string) *ProjectsHmacKeysGetCall
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 (r *ProjectsHmacKeysService) List(projectId string) *ProjectsHmacKeysListCall
List: Retrieves a list of HMAC keys matching the criteria.
- projectId: Name of the project in which to look for HMAC keys.
func (r *ProjectsHmacKeysService) Update(projectId string, accessId string, hmackeymetadata *HmacKeyMetadata) *ProjectsHmacKeysUpdateCall
Update: Updates the state of an HMAC key. See the HMAC Key resource descriptor for valid states.
- accessId: Name of the HMAC key being updated. - projectId: Project ID owning the service account of the updated key.
type ProjectsHmacKeysUpdateCall struct {
// contains filtered or unexported fields
}
func (c *ProjectsHmacKeysUpdateCall) Context(ctx context.Context) *ProjectsHmacKeysUpdateCall
Context sets the context to be used in this call's Do method.
func (c *ProjectsHmacKeysUpdateCall) Do(opts ...googleapi.CallOption) (*HmacKeyMetadata, error)
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 at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (c *ProjectsHmacKeysUpdateCall) Fields(s ...googleapi.Field) *ProjectsHmacKeysUpdateCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.
func (c *ProjectsHmacKeysUpdateCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
func (c *ProjectsHmacKeysUpdateCall) UserProject(userProject string) *ProjectsHmacKeysUpdateCall
UserProject sets the optional parameter "userProject": The project to be billed for this request.
type ProjectsService struct {
HmacKeys *ProjectsHmacKeysService
ServiceAccount *ProjectsServiceAccountService
// contains filtered or unexported fields
}
func NewProjectsService(s *Service) *ProjectsService
type ProjectsServiceAccountGetCall struct {
// contains filtered or unexported fields
}
func (c *ProjectsServiceAccountGetCall) Context(ctx context.Context) *ProjectsServiceAccountGetCall
Context sets the context to be used in this call's Do method.
func (c *ProjectsServiceAccountGetCall) Do(opts ...googleapi.CallOption) (*ServiceAccount, error)
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 check whether the returned error was because http.StatusNotModified was returned.
func (c *ProjectsServiceAccountGetCall) Fields(s ...googleapi.Field) *ProjectsServiceAccountGetCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.
func (c *ProjectsServiceAccountGetCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
func (c *ProjectsServiceAccountGetCall) IfNoneMatch(entityTag string) *ProjectsServiceAccountGetCall
IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.
func (c *ProjectsServiceAccountGetCall) UserProject(userProject string) *ProjectsServiceAccountGetCall
UserProject sets the optional parameter "userProject": The project to be billed for this request.
type ProjectsServiceAccountService struct {
// contains filtered or unexported fields
}
func NewProjectsServiceAccountService(s *Service) *ProjectsServiceAccountService
func (r *ProjectsServiceAccountService) Get(projectId string) *ProjectsServiceAccountGetCall
Get: Get the email address of this project's Google Cloud Storage service account.
- projectId: Project ID.
RewriteResponse: A rewrite response.
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.
Done bool `json:"done,omitempty"`
// Kind: The kind of item this is.
Kind string `json:"kind,omitempty"`
// ObjectSize: The total size of the object being copied in bytes. This
// property is always present in the response.
ObjectSize int64 `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.
RewriteToken string `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.
TotalBytesRewritten int64 `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:"-"`
}
func (s *RewriteResponse) MarshalJSON() ([]byte, error)
type Service struct {
BasePath string // API endpoint base URL
UserAgent string // optional additional User-Agent fragment
AnywhereCaches *AnywhereCachesService
BucketAccessControls *BucketAccessControlsService
Buckets *BucketsService
Channels *ChannelsService
DefaultObjectAccessControls *DefaultObjectAccessControlsService
Folders *FoldersService
ManagedFolders *ManagedFoldersService
Notifications *NotificationsService
ObjectAccessControls *ObjectAccessControlsService
Objects *ObjectsService
Operations *OperationsService
Projects *ProjectsService
// contains filtered or unexported fields
}
func New(client *http.Client) (*Service, error)
New creates a new Service. It uses the provided http.Client for requests.
Deprecated: please use NewService instead. To provide a custom HTTP client, use option.WithHTTPClient. If you are using google.golang.org/api/googleapis/transport.APIKey, use option.WithAPIKey with NewService instead.
func NewService(ctx context.Context, opts ...option.ClientOption) (*Service, error)
NewService creates a new Service.
ServiceAccount: A subscription to receive Google PubSub notifications.
type ServiceAccount struct {
// EmailAddress: The ID of the notification.
EmailAddress string `json:"email_address,omitempty"`
// Kind: The kind of item this is. For notifications, this is always
// storage#notification.
Kind string `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:"-"`
}
func (s *ServiceAccount) MarshalJSON() ([]byte, error)
TestIamPermissionsResponse: A storage.(buckets|objects|managedFolders).testIamPermissions response.
type TestIamPermissionsResponse struct {
// Kind: The kind of item this is.
Kind string `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:"-"`
}
func (s *TestIamPermissionsResponse) MarshalJSON() ([]byte, error)