storage

package
v1.30.1 Latest Latest
Warning

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

 Go to latest Published: Mar 21, 2023 License: Apache-2.0 Imports: 15 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

View Source 
var (
	ServiceConstants_Values_name = map[int32]string{
		0:       "VALUES_UNSPECIFIED",
		2097152: "MAX_READ_CHUNK_BYTES",

		5242880: "MAX_OBJECT_SIZE_MB",
		1024:    "MAX_CUSTOM_METADATA_FIELD_NAME_BYTES",
		4096:    "MAX_CUSTOM_METADATA_FIELD_VALUE_BYTES",
		8192:    "MAX_CUSTOM_METADATA_TOTAL_SIZE_BYTES",
		20480:   "MAX_BUCKET_METADATA_TOTAL_SIZE_BYTES",
		100:     "MAX_NOTIFICATION_CONFIGS_PER_BUCKET",

		5:   "MAX_NOTIFICATION_CUSTOM_ATTRIBUTES",
		256: "MAX_NOTIFICATION_CUSTOM_ATTRIBUTE_KEY_LENGTH",

		64:   "MAX_LABELS_ENTRIES_COUNT",
		63:   "MAX_LABELS_KEY_VALUE_LENGTH",
		128:  "MAX_LABELS_KEY_VALUE_BYTES",
		1000: "MAX_OBJECT_IDS_PER_DELETE_OBJECTS_REQUEST",
		14:   "SPLIT_TOKEN_MAX_VALID_DAYS",
	}
	ServiceConstants_Values_value = map[string]int32{
		"VALUES_UNSPECIFIED":                             0,
		"MAX_READ_CHUNK_BYTES":                           2097152,
		"MAX_WRITE_CHUNK_BYTES":                          2097152,
		"MAX_OBJECT_SIZE_MB":                             5242880,
		"MAX_CUSTOM_METADATA_FIELD_NAME_BYTES":           1024,
		"MAX_CUSTOM_METADATA_FIELD_VALUE_BYTES":          4096,
		"MAX_CUSTOM_METADATA_TOTAL_SIZE_BYTES":           8192,
		"MAX_BUCKET_METADATA_TOTAL_SIZE_BYTES":           20480,
		"MAX_NOTIFICATION_CONFIGS_PER_BUCKET":            100,
		"MAX_LIFECYCLE_RULES_PER_BUCKET":                 100,
		"MAX_NOTIFICATION_CUSTOM_ATTRIBUTES":             5,
		"MAX_NOTIFICATION_CUSTOM_ATTRIBUTE_KEY_LENGTH":   256,
		"MAX_NOTIFICATION_CUSTOM_ATTRIBUTE_VALUE_LENGTH": 1024,
		"MAX_LABELS_ENTRIES_COUNT":                       64,
		"MAX_LABELS_KEY_VALUE_LENGTH":                    63,
		"MAX_LABELS_KEY_VALUE_BYTES":                     128,
		"MAX_OBJECT_IDS_PER_DELETE_OBJECTS_REQUEST":      1000,
		"SPLIT_TOKEN_MAX_VALID_DAYS":                     14,
	}
)

Enum value maps for ServiceConstants_Values.

View Source 
var File_google_storage_v2_storage_proto protoreflect.FileDescriptor

Functions

func RegisterStorageServer 

func RegisterStorageServer(s *grpc.Server, srv StorageServer)

Types

type Bucket 

type Bucket struct {

	// Immutable. The name of the bucket.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// Output only. The user-chosen part of the bucket name. The `{bucket}`
	// portion of the `name` field. For globally unique buckets, this is equal to
	// the "bucket name" of other Cloud Storage APIs. Example: "pub".
	BucketId string `protobuf:"bytes,2,opt,name=bucket_id,json=bucketId,proto3" json:"bucket_id,omitempty"`
	// The etag of the bucket.
	// If included in the metadata of an UpdateBucketRequest, the operation will
	// only be performed if the etag matches that of the bucket.
	Etag string `protobuf:"bytes,29,opt,name=etag,proto3" json:"etag,omitempty"`
	// Immutable. The project which owns this bucket, in the format of
	// "projects/<projectIdentifier>".
	// <projectIdentifier> can be the project ID or project number.
	Project string `protobuf:"bytes,3,opt,name=project,proto3" json:"project,omitempty"`
	// Output only. The metadata generation of this bucket.
	// Attempting to set or update this field will result in a
	// [FieldViolation][google.rpc.BadRequest.FieldViolation].
	Metageneration int64 `protobuf:"varint,4,opt,name=metageneration,proto3" json:"metageneration,omitempty"`
	// Immutable. The location of the bucket. Object data for objects in the
	// bucket resides in physical storage within this region.  Defaults to `US`.
	// See the
	// [https://developers.google.com/storage/docs/concepts-techniques#specifyinglocations"][developer's
	// guide] for the authoritative list. Attempting to update this field after
	// the bucket is created will result in an error.
	Location string `protobuf:"bytes,5,opt,name=location,proto3" json:"location,omitempty"`
	// Output only. The location type of the bucket (region, dual-region,
	// multi-region, etc).
	LocationType string `protobuf:"bytes,6,opt,name=location_type,json=locationType,proto3" json:"location_type,omitempty"`
	// 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.
	// If this value is not specified when the bucket is created, it will default
	// to `STANDARD`. For more information, see
	// https://developers.google.com/storage/docs/storage-classes.
	StorageClass string `protobuf:"bytes,7,opt,name=storage_class,json=storageClass,proto3" json:"storage_class,omitempty"`
	// The recovery point objective for cross-region replication of the bucket.
	// Applicable only for dual- and multi-region buckets. "DEFAULT" uses default
	// replication. "ASYNC_TURBO" enables turbo replication, valid for dual-region
	// buckets only. If rpo is not specified when the bucket is created, it
	// defaults to "DEFAULT". For more information, see
	// https://cloud.google.com/storage/docs/turbo-replication.
	Rpo string `protobuf:"bytes,27,opt,name=rpo,proto3" json:"rpo,omitempty"`
	// Access controls on the bucket.
	// If iam_config.uniform_bucket_level_access is enabled on this bucket,
	// requests to set, read, or modify acl is an error.
	Acl []*BucketAccessControl `protobuf:"bytes,8,rep,name=acl,proto3" json:"acl,omitempty"`
	// Default access controls to apply to new objects when no ACL is provided.
	// If iam_config.uniform_bucket_level_access is enabled on this bucket,
	// requests to set, read, or modify acl is an error.
	DefaultObjectAcl []*ObjectAccessControl `protobuf:"bytes,9,rep,name=default_object_acl,json=defaultObjectAcl,proto3" json:"default_object_acl,omitempty"`
	// The bucket's lifecycle config. See
	// [https://developers.google.com/storage/docs/lifecycle]Lifecycle Management]
	// for more information.
	Lifecycle *Bucket_Lifecycle `protobuf:"bytes,10,opt,name=lifecycle,proto3" json:"lifecycle,omitempty"`
	// Output only. The creation time of the bucket.
	// Attempting to set or update this field will result in a
	// [FieldViolation][google.rpc.BadRequest.FieldViolation].
	CreateTime *timestamppb.Timestamp `protobuf:"bytes,11,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"`
	// The bucket's [https://www.w3.org/TR/cors/][Cross-Origin Resource Sharing]
	// (CORS) config.
	Cors []*Bucket_Cors `protobuf:"bytes,12,rep,name=cors,proto3" json:"cors,omitempty"`
	// Output only. The modification time of the bucket.
	// Attempting to set or update this field will result in a
	// [FieldViolation][google.rpc.BadRequest.FieldViolation].
	UpdateTime *timestamppb.Timestamp `protobuf:"bytes,13,opt,name=update_time,json=updateTime,proto3" json:"update_time,omitempty"`
	// 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 `` /* 130-byte string literal not displayed */
	// User-provided labels, in key/value pairs.
	Labels map[string]string `` /* 154-byte string literal not displayed */
	// The bucket's website config, controlling how the service behaves
	// when accessing bucket contents as a web site. See the
	// [https://cloud.google.com/storage/docs/static-website][Static Website
	// Examples] for more information.
	Website *Bucket_Website `protobuf:"bytes,16,opt,name=website,proto3" json:"website,omitempty"`
	// The bucket's versioning config.
	Versioning *Bucket_Versioning `protobuf:"bytes,17,opt,name=versioning,proto3" json:"versioning,omitempty"`
	// The bucket's logging config, which defines the destination bucket
	// and name prefix (if any) for the current bucket's logs.
	Logging *Bucket_Logging `protobuf:"bytes,18,opt,name=logging,proto3" json:"logging,omitempty"`
	// Output only. The owner of the bucket. This is always the project team's
	// owner group.
	Owner *Owner `protobuf:"bytes,19,opt,name=owner,proto3" json:"owner,omitempty"`
	// Encryption config for a bucket.
	Encryption *Bucket_Encryption `protobuf:"bytes,20,opt,name=encryption,proto3" json:"encryption,omitempty"`
	// The bucket's billing config.
	Billing *Bucket_Billing `protobuf:"bytes,21,opt,name=billing,proto3" json:"billing,omitempty"`
	// 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 *Bucket_RetentionPolicy `protobuf:"bytes,22,opt,name=retention_policy,json=retentionPolicy,proto3" json:"retention_policy,omitempty"`
	// The bucket's IAM config.
	IamConfig *Bucket_IamConfig `protobuf:"bytes,23,opt,name=iam_config,json=iamConfig,proto3" json:"iam_config,omitempty"`
	// Reserved for future use.
	SatisfiesPzs bool `protobuf:"varint,25,opt,name=satisfies_pzs,json=satisfiesPzs,proto3" json:"satisfies_pzs,omitempty"`
	// Configuration that, if present, specifies the data placement for a
	// [https://cloud.google.com/storage/docs/use-dual-regions][Dual Region].
	CustomPlacementConfig *Bucket_CustomPlacementConfig `` /* 127-byte string literal not displayed */
	// The bucket's Autoclass configuration. If there is no configuration, the
	// Autoclass feature will be disabled and have no effect on the bucket.
	Autoclass *Bucket_Autoclass `protobuf:"bytes,28,opt,name=autoclass,proto3" json:"autoclass,omitempty"`
	// contains filtered or unexported fields
}

A bucket.

func (*Bucket) Descriptor deprecated 

func (*Bucket) Descriptor() ([]byte, []int)

Deprecated: Use Bucket.ProtoReflect.Descriptor instead.

func (*Bucket) GetAcl 

func (x *Bucket) GetAcl() []*BucketAccessControl

func (*Bucket) GetAutoclass 

func (x *Bucket) GetAutoclass() *Bucket_Autoclass

func (*Bucket) GetBilling 

func (x *Bucket) GetBilling() *Bucket_Billing

func (*Bucket) GetBucketId 

func (x *Bucket) GetBucketId() string

func (*Bucket) GetCors 

func (x *Bucket) GetCors() []*Bucket_Cors

func (*Bucket) GetCreateTime 

func (x *Bucket) GetCreateTime() *timestamppb.Timestamp

func (*Bucket) GetCustomPlacementConfig 

func (x *Bucket) GetCustomPlacementConfig() *Bucket_CustomPlacementConfig

func (*Bucket) GetDefaultEventBasedHold 

func (x *Bucket) GetDefaultEventBasedHold() bool

func (*Bucket) GetDefaultObjectAcl 

func (x *Bucket) GetDefaultObjectAcl() []*ObjectAccessControl

func (*Bucket) GetEncryption 

func (x *Bucket) GetEncryption() *Bucket_Encryption

func (*Bucket) GetEtag 

func (x *Bucket) GetEtag() string

func (*Bucket) GetIamConfig 

func (x *Bucket) GetIamConfig() *Bucket_IamConfig

func (*Bucket) GetLabels 

func (x *Bucket) GetLabels() map[string]string

func (*Bucket) GetLifecycle 

func (x *Bucket) GetLifecycle() *Bucket_Lifecycle

func (*Bucket) GetLocation 

func (x *Bucket) GetLocation() string

func (*Bucket) GetLocationType 

func (x *Bucket) GetLocationType() string

func (*Bucket) GetLogging 

func (x *Bucket) GetLogging() *Bucket_Logging

func (*Bucket) GetMetageneration 

func (x *Bucket) GetMetageneration() int64

func (*Bucket) GetName 

func (x *Bucket) GetName() string

func (*Bucket) GetOwner 

func (x *Bucket) GetOwner() *Owner

func (*Bucket) GetProject 

func (x *Bucket) GetProject() string

func (*Bucket) GetRetentionPolicy 

func (x *Bucket) GetRetentionPolicy() *Bucket_RetentionPolicy

func (*Bucket) GetRpo 

func (x *Bucket) GetRpo() string

func (*Bucket) GetSatisfiesPzs 

func (x *Bucket) GetSatisfiesPzs() bool

func (*Bucket) GetStorageClass 

func (x *Bucket) GetStorageClass() string

func (*Bucket) GetUpdateTime 

func (x *Bucket) GetUpdateTime() *timestamppb.Timestamp

func (*Bucket) GetVersioning 

func (x *Bucket) GetVersioning() *Bucket_Versioning

func (*Bucket) GetWebsite 

func (x *Bucket) GetWebsite() *Bucket_Website

func (*Bucket) ProtoMessage 

func (*Bucket) ProtoMessage()

func (*Bucket) ProtoReflect 

func (x *Bucket) ProtoReflect() protoreflect.Message

func (*Bucket) Reset 

func (x *Bucket) Reset()

func (*Bucket) String 

func (x *Bucket) String() string

type BucketAccessControl 

type BucketAccessControl struct {

	// The access permission for the entity.
	Role string `protobuf:"bytes,1,opt,name=role,proto3" json:"role,omitempty"`
	// The ID of the access-control entry.
	Id string `protobuf:"bytes,2,opt,name=id,proto3" json:"id,omitempty"`
	// The entity holding the permission, in one of the following forms:
	// * `user-{userid}`
	// * `user-{email}`
	// * `group-{groupid}`
	// * `group-{email}`
	// * `domain-{domain}`
	// * `project-{team}-{projectnumber}`
	// * `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`
	// * All members of the Google Apps for Business domain `example.com` would be
	// `domain-example.com`
	// For project entities, `project-{team}-{projectnumber}` format will be
	// returned on response.
	Entity string `protobuf:"bytes,3,opt,name=entity,proto3" json:"entity,omitempty"`
	// Output only. The alternative entity format, if exists. For project
	// entities, `project-{team}-{projectid}` format will be returned on response.
	EntityAlt string `protobuf:"bytes,9,opt,name=entity_alt,json=entityAlt,proto3" json:"entity_alt,omitempty"`
	// The ID for the entity, if any.
	EntityId string `protobuf:"bytes,4,opt,name=entity_id,json=entityId,proto3" json:"entity_id,omitempty"`
	// The etag of the BucketAccessControl.
	// If included in the metadata of an update or delete request message, the
	// operation operation will only be performed if the etag matches that of the
	// bucket's BucketAccessControl.
	Etag string `protobuf:"bytes,8,opt,name=etag,proto3" json:"etag,omitempty"`
	// The email address associated with the entity, if any.
	Email string `protobuf:"bytes,5,opt,name=email,proto3" json:"email,omitempty"`
	// The domain associated with the entity, if any.
	Domain string `protobuf:"bytes,6,opt,name=domain,proto3" json:"domain,omitempty"`
	// The project team associated with the entity, if any.
	ProjectTeam *ProjectTeam `protobuf:"bytes,7,opt,name=project_team,json=projectTeam,proto3" json:"project_team,omitempty"`
	// contains filtered or unexported fields
}

An access-control entry.

func (*BucketAccessControl) Descriptor deprecated 

func (*BucketAccessControl) Descriptor() ([]byte, []int)

Deprecated: Use BucketAccessControl.ProtoReflect.Descriptor instead.

func (*BucketAccessControl) GetDomain 

func (x *BucketAccessControl) GetDomain() string

func (*BucketAccessControl) GetEmail 

func (x *BucketAccessControl) GetEmail() string

func (*BucketAccessControl) GetEntity 

func (x *BucketAccessControl) GetEntity() string

func (*BucketAccessControl) GetEntityAlt added in v1.28.0 

func (x *BucketAccessControl) GetEntityAlt() string

func (*BucketAccessControl) GetEntityId 

func (x *BucketAccessControl) GetEntityId() string

func (*BucketAccessControl) GetEtag 

func (x *BucketAccessControl) GetEtag() string

func (*BucketAccessControl) GetId 

func (x *BucketAccessControl) GetId() string

func (*BucketAccessControl) GetProjectTeam 

func (x *BucketAccessControl) GetProjectTeam() *ProjectTeam

func (*BucketAccessControl) GetRole 

func (x *BucketAccessControl) GetRole() string

func (*BucketAccessControl) ProtoMessage 

func (*BucketAccessControl) ProtoMessage()

func (*BucketAccessControl) ProtoReflect 

func (x *BucketAccessControl) ProtoReflect() protoreflect.Message

func (*BucketAccessControl) Reset 

func (x *BucketAccessControl) Reset()

func (*BucketAccessControl) String 

func (x *BucketAccessControl) String() string

type Bucket_Autoclass 

type Bucket_Autoclass struct {

	// Enables Autoclass.
	Enabled bool `protobuf:"varint,1,opt,name=enabled,proto3" json:"enabled,omitempty"`
	// Output only. Latest instant at which the `enabled` field was set to true
	// after being disabled/unconfigured or set to false after being enabled. If
	// Autoclass is enabled when the bucket is created, the toggle_time is set
	// to the bucket creation time.
	ToggleTime *timestamppb.Timestamp `protobuf:"bytes,2,opt,name=toggle_time,json=toggleTime,proto3" json:"toggle_time,omitempty"`
	// contains filtered or unexported fields
}

Configuration for a bucket's Autoclass feature.

func (*Bucket_Autoclass) Descriptor deprecated 

func (*Bucket_Autoclass) Descriptor() ([]byte, []int)

Deprecated: Use Bucket_Autoclass.ProtoReflect.Descriptor instead.

func (*Bucket_Autoclass) GetEnabled 

func (x *Bucket_Autoclass) GetEnabled() bool

func (*Bucket_Autoclass) GetToggleTime 

func (x *Bucket_Autoclass) GetToggleTime() *timestamppb.Timestamp

func (*Bucket_Autoclass) ProtoMessage 

func (*Bucket_Autoclass) ProtoMessage()

func (*Bucket_Autoclass) ProtoReflect 

func (x *Bucket_Autoclass) ProtoReflect() protoreflect.Message

func (*Bucket_Autoclass) Reset 

func (x *Bucket_Autoclass) Reset()

func (*Bucket_Autoclass) String 

func (x *Bucket_Autoclass) String() string

type Bucket_Billing 

type Bucket_Billing struct {

	// When set to true, Requester Pays is enabled for this bucket.
	RequesterPays bool `protobuf:"varint,1,opt,name=requester_pays,json=requesterPays,proto3" json:"requester_pays,omitempty"`
	// contains filtered or unexported fields
}

Billing properties of a bucket.

func (*Bucket_Billing) Descriptor deprecated 

func (*Bucket_Billing) Descriptor() ([]byte, []int)

Deprecated: Use Bucket_Billing.ProtoReflect.Descriptor instead.

func (*Bucket_Billing) GetRequesterPays 

func (x *Bucket_Billing) GetRequesterPays() bool

func (*Bucket_Billing) ProtoMessage 

func (*Bucket_Billing) ProtoMessage()

func (*Bucket_Billing) ProtoReflect 

func (x *Bucket_Billing) ProtoReflect() protoreflect.Message

func (*Bucket_Billing) Reset 

func (x *Bucket_Billing) Reset()

func (*Bucket_Billing) String 

func (x *Bucket_Billing) String() string

type Bucket_Cors 

type Bucket_Cors struct {

	// The list of Origins eligible to receive CORS response headers. See
	// [https://tools.ietf.org/html/rfc6454][RFC 6454] for more on origins.
	// Note: "*" is permitted in the list of origins, and means "any Origin".
	Origin []string `protobuf:"bytes,1,rep,name=origin,proto3" json:"origin,omitempty"`
	// 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 `protobuf:"bytes,2,rep,name=method,proto3" json:"method,omitempty"`
	// The list of HTTP headers other than the
	// [https://www.w3.org/TR/cors/#simple-response-header][simple response
	// headers] to give permission for the user-agent to share across domains.
	ResponseHeader []string `protobuf:"bytes,3,rep,name=response_header,json=responseHeader,proto3" json:"response_header,omitempty"`
	// The value, in seconds, to return in the
	// [https://www.w3.org/TR/cors/#access-control-max-age-response-header][Access-Control-Max-Age
	// header] used in preflight responses.
	MaxAgeSeconds int32 `protobuf:"varint,4,opt,name=max_age_seconds,json=maxAgeSeconds,proto3" json:"max_age_seconds,omitempty"`
	// contains filtered or unexported fields
}

Cross-Origin Response sharing (CORS) properties for a bucket. For more on Cloud Storage and CORS, see https://cloud.google.com/storage/docs/cross-origin. For more on CORS in general, see https://tools.ietf.org/html/rfc6454.

func (*Bucket_Cors) Descriptor deprecated 

func (*Bucket_Cors) Descriptor() ([]byte, []int)

Deprecated: Use Bucket_Cors.ProtoReflect.Descriptor instead.

func (*Bucket_Cors) GetMaxAgeSeconds 

func (x *Bucket_Cors) GetMaxAgeSeconds() int32

func (*Bucket_Cors) GetMethod 

func (x *Bucket_Cors) GetMethod() []string

func (*Bucket_Cors) GetOrigin 

func (x *Bucket_Cors) GetOrigin() []string

func (*Bucket_Cors) GetResponseHeader 

func (x *Bucket_Cors) GetResponseHeader() []string

func (*Bucket_Cors) ProtoMessage 

func (*Bucket_Cors) ProtoMessage()

func (*Bucket_Cors) ProtoReflect 

func (x *Bucket_Cors) ProtoReflect() protoreflect.Message

func (*Bucket_Cors) Reset 

func (x *Bucket_Cors) Reset()

func (*Bucket_Cors) String 

func (x *Bucket_Cors) String() string

type Bucket_CustomPlacementConfig 

type Bucket_CustomPlacementConfig struct {

	// List of locations to use for data placement.
	DataLocations []string `protobuf:"bytes,1,rep,name=data_locations,json=dataLocations,proto3" json:"data_locations,omitempty"`
	// contains filtered or unexported fields
}

Configuration for Custom Dual Regions. It should specify precisely two eligible regions within the same Multiregion. More information on regions may be found [https://cloud.google.com/storage/docs/locations][here].

func (*Bucket_CustomPlacementConfig) Descriptor deprecated 

func (*Bucket_CustomPlacementConfig) Descriptor() ([]byte, []int)

Deprecated: Use Bucket_CustomPlacementConfig.ProtoReflect.Descriptor instead.

func (*Bucket_CustomPlacementConfig) GetDataLocations 

func (x *Bucket_CustomPlacementConfig) GetDataLocations() []string

func (*Bucket_CustomPlacementConfig) ProtoMessage 

func (*Bucket_CustomPlacementConfig) ProtoMessage()

func (*Bucket_CustomPlacementConfig) ProtoReflect 

func (x *Bucket_CustomPlacementConfig) ProtoReflect() protoreflect.Message

func (*Bucket_CustomPlacementConfig) Reset 

func (x *Bucket_CustomPlacementConfig) Reset()

func (*Bucket_CustomPlacementConfig) String 

func (x *Bucket_CustomPlacementConfig) String() string

type Bucket_Encryption 

type Bucket_Encryption struct {

	// The name of the Cloud KMS key that will be used to encrypt objects
	// inserted into this bucket, if no encryption method is specified.
	DefaultKmsKey string `protobuf:"bytes,1,opt,name=default_kms_key,json=defaultKmsKey,proto3" json:"default_kms_key,omitempty"`
	// contains filtered or unexported fields
}

Encryption properties of a bucket.

func (*Bucket_Encryption) Descriptor deprecated 

func (*Bucket_Encryption) Descriptor() ([]byte, []int)

Deprecated: Use Bucket_Encryption.ProtoReflect.Descriptor instead.

func (*Bucket_Encryption) GetDefaultKmsKey 

func (x *Bucket_Encryption) GetDefaultKmsKey() string

func (*Bucket_Encryption) ProtoMessage 

func (*Bucket_Encryption) ProtoMessage()

func (*Bucket_Encryption) ProtoReflect 

func (x *Bucket_Encryption) ProtoReflect() protoreflect.Message

func (*Bucket_Encryption) Reset 

func (x *Bucket_Encryption) Reset()

func (*Bucket_Encryption) String 

func (x *Bucket_Encryption) String() string

type Bucket_IamConfig 

type Bucket_IamConfig struct {

	// Bucket restriction options currently enforced on the bucket.
	UniformBucketLevelAccess *Bucket_IamConfig_UniformBucketLevelAccess `` /* 137-byte string literal not displayed */
	// Whether IAM will enforce public access prevention. Valid values are
	// "enforced" or "inherited".
	PublicAccessPrevention string `` /* 129-byte string literal not displayed */
	// contains filtered or unexported fields
}

Bucket restriction options.

func (*Bucket_IamConfig) Descriptor deprecated 

func (*Bucket_IamConfig) Descriptor() ([]byte, []int)

Deprecated: Use Bucket_IamConfig.ProtoReflect.Descriptor instead.

func (*Bucket_IamConfig) GetPublicAccessPrevention 

func (x *Bucket_IamConfig) GetPublicAccessPrevention() string

func (*Bucket_IamConfig) GetUniformBucketLevelAccess 

func (x *Bucket_IamConfig) GetUniformBucketLevelAccess() *Bucket_IamConfig_UniformBucketLevelAccess

func (*Bucket_IamConfig) ProtoMessage 

func (*Bucket_IamConfig) ProtoMessage()

func (*Bucket_IamConfig) ProtoReflect 

func (x *Bucket_IamConfig) ProtoReflect() protoreflect.Message

func (*Bucket_IamConfig) Reset 

func (x *Bucket_IamConfig) Reset()

func (*Bucket_IamConfig) String 

func (x *Bucket_IamConfig) String() string

type Bucket_IamConfig_UniformBucketLevelAccess 

type Bucket_IamConfig_UniformBucketLevelAccess struct {

	// If set, access checks only use bucket-level IAM policies or above.
	Enabled bool `protobuf:"varint,1,opt,name=enabled,proto3" json:"enabled,omitempty"`
	// The deadline time for changing
	// `iam_config.uniform_bucket_level_access.enabled` from `true` to
	// `false`. Mutable until the specified deadline is reached, but not
	// afterward.
	LockTime *timestamppb.Timestamp `protobuf:"bytes,2,opt,name=lock_time,json=lockTime,proto3" json:"lock_time,omitempty"`
	// contains filtered or unexported fields
}

Settings for Uniform Bucket level access. See https://cloud.google.com/storage/docs/uniform-bucket-level-access.

func (*Bucket_IamConfig_UniformBucketLevelAccess) Descriptor deprecated 

func (*Bucket_IamConfig_UniformBucketLevelAccess) Descriptor() ([]byte, []int)

Deprecated: Use Bucket_IamConfig_UniformBucketLevelAccess.ProtoReflect.Descriptor instead.

func (*Bucket_IamConfig_UniformBucketLevelAccess) GetEnabled 

func (x *Bucket_IamConfig_UniformBucketLevelAccess) GetEnabled() bool

func (*Bucket_IamConfig_UniformBucketLevelAccess) GetLockTime 

func (x *Bucket_IamConfig_UniformBucketLevelAccess) GetLockTime() *timestamppb.Timestamp

func (*Bucket_IamConfig_UniformBucketLevelAccess) ProtoMessage 

func (*Bucket_IamConfig_UniformBucketLevelAccess) ProtoMessage()

func (*Bucket_IamConfig_UniformBucketLevelAccess) ProtoReflect 

func (x *Bucket_IamConfig_UniformBucketLevelAccess) ProtoReflect() protoreflect.Message

func (*Bucket_IamConfig_UniformBucketLevelAccess) Reset 

func (x *Bucket_IamConfig_UniformBucketLevelAccess) Reset()

func (*Bucket_IamConfig_UniformBucketLevelAccess) String 

func (x *Bucket_IamConfig_UniformBucketLevelAccess) String() string

type Bucket_Lifecycle 

type Bucket_Lifecycle struct {

	// A lifecycle management rule, which is made of an action to take and the
	// condition(s) under which the action will be taken.
	Rule []*Bucket_Lifecycle_Rule `protobuf:"bytes,1,rep,name=rule,proto3" json:"rule,omitempty"`
	// contains filtered or unexported fields
}

Lifecycle properties of a bucket. For more information, see https://cloud.google.com/storage/docs/lifecycle.

func (*Bucket_Lifecycle) Descriptor deprecated 

func (*Bucket_Lifecycle) Descriptor() ([]byte, []int)

Deprecated: Use Bucket_Lifecycle.ProtoReflect.Descriptor instead.

func (*Bucket_Lifecycle) GetRule 

func (x *Bucket_Lifecycle) GetRule() []*Bucket_Lifecycle_Rule

func (*Bucket_Lifecycle) ProtoMessage 

func (*Bucket_Lifecycle) ProtoMessage()

func (*Bucket_Lifecycle) ProtoReflect 

func (x *Bucket_Lifecycle) ProtoReflect() protoreflect.Message

func (*Bucket_Lifecycle) Reset 

func (x *Bucket_Lifecycle) Reset()

func (*Bucket_Lifecycle) String 

func (x *Bucket_Lifecycle) String() string

type Bucket_Lifecycle_Rule 

type Bucket_Lifecycle_Rule struct {

	// The action to take.
	Action *Bucket_Lifecycle_Rule_Action `protobuf:"bytes,1,opt,name=action,proto3" json:"action,omitempty"`
	// The condition(s) under which the action will be taken.
	Condition *Bucket_Lifecycle_Rule_Condition `protobuf:"bytes,2,opt,name=condition,proto3" json:"condition,omitempty"`
	// contains filtered or unexported fields
}

A lifecycle Rule, combining an action to take on an object and a condition which will trigger that action.

func (*Bucket_Lifecycle_Rule) Descriptor deprecated 

func (*Bucket_Lifecycle_Rule) Descriptor() ([]byte, []int)

Deprecated: Use Bucket_Lifecycle_Rule.ProtoReflect.Descriptor instead.

func (*Bucket_Lifecycle_Rule) GetAction 

func (x *Bucket_Lifecycle_Rule) GetAction() *Bucket_Lifecycle_Rule_Action

func (*Bucket_Lifecycle_Rule) GetCondition 

func (x *Bucket_Lifecycle_Rule) GetCondition() *Bucket_Lifecycle_Rule_Condition

func (*Bucket_Lifecycle_Rule) ProtoMessage 

func (*Bucket_Lifecycle_Rule) ProtoMessage()

func (*Bucket_Lifecycle_Rule) ProtoReflect 

func (x *Bucket_Lifecycle_Rule) ProtoReflect() protoreflect.Message

func (*Bucket_Lifecycle_Rule) Reset 

func (x *Bucket_Lifecycle_Rule) Reset()

func (*Bucket_Lifecycle_Rule) String 

func (x *Bucket_Lifecycle_Rule) String() string

type Bucket_Lifecycle_Rule_Action 

type Bucket_Lifecycle_Rule_Action struct {

	// Type of the action. Currently, only `Delete`, `SetStorageClass`, and
	// `AbortIncompleteMultipartUpload` are supported.
	Type string `protobuf:"bytes,1,opt,name=type,proto3" json:"type,omitempty"`
	// Target storage class. Required iff the type of the action is
	// SetStorageClass.
	StorageClass string `protobuf:"bytes,2,opt,name=storage_class,json=storageClass,proto3" json:"storage_class,omitempty"`
	// contains filtered or unexported fields
}

An action to take on an object.

func (*Bucket_Lifecycle_Rule_Action) Descriptor deprecated 

func (*Bucket_Lifecycle_Rule_Action) Descriptor() ([]byte, []int)

Deprecated: Use Bucket_Lifecycle_Rule_Action.ProtoReflect.Descriptor instead.

func (*Bucket_Lifecycle_Rule_Action) GetStorageClass 

func (x *Bucket_Lifecycle_Rule_Action) GetStorageClass() string

func (*Bucket_Lifecycle_Rule_Action) GetType 

func (x *Bucket_Lifecycle_Rule_Action) GetType() string

func (*Bucket_Lifecycle_Rule_Action) ProtoMessage 

func (*Bucket_Lifecycle_Rule_Action) ProtoMessage()

func (*Bucket_Lifecycle_Rule_Action) ProtoReflect 

func (x *Bucket_Lifecycle_Rule_Action) ProtoReflect() protoreflect.Message

func (*Bucket_Lifecycle_Rule_Action) Reset 

func (x *Bucket_Lifecycle_Rule_Action) Reset()

func (*Bucket_Lifecycle_Rule_Action) String 

func (x *Bucket_Lifecycle_Rule_Action) String() string

type Bucket_Lifecycle_Rule_Condition 

type Bucket_Lifecycle_Rule_Condition struct {

	// Age of an object (in days). This condition is satisfied when an
	// object reaches the specified age.
	// A value of 0 indicates that all objects immediately match this
	// condition.
	AgeDays *int32 `protobuf:"varint,1,opt,name=age_days,json=ageDays,proto3,oneof" json:"age_days,omitempty"`
	// This condition is satisfied when an object is created before midnight
	// of the specified date in UTC.
	CreatedBefore *date.Date `protobuf:"bytes,2,opt,name=created_before,json=createdBefore,proto3" json:"created_before,omitempty"`
	// 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 `protobuf:"varint,3,opt,name=is_live,json=isLive,proto3,oneof" json:"is_live,omitempty"`
	// 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 *int32 `protobuf:"varint,4,opt,name=num_newer_versions,json=numNewerVersions,proto3,oneof" json:"num_newer_versions,omitempty"`
	// Objects having any of the storage classes specified by this condition
	// will be matched. Values include `MULTI_REGIONAL`, `REGIONAL`,
	// `NEARLINE`, `COLDLINE`, `STANDARD`, and
	// `DURABLE_REDUCED_AVAILABILITY`.
	MatchesStorageClass []string `protobuf:"bytes,5,rep,name=matches_storage_class,json=matchesStorageClass,proto3" json:"matches_storage_class,omitempty"`
	// Number of days that have elapsed since the custom timestamp set on an
	// object.
	// The value of the field must be a nonnegative integer.
	DaysSinceCustomTime *int32 `` /* 129-byte string literal not displayed */
	// An object matches this condition if the custom timestamp set on the
	// object is before the specified date in UTC.
	CustomTimeBefore *date.Date `protobuf:"bytes,8,opt,name=custom_time_before,json=customTimeBefore,proto3" json:"custom_time_before,omitempty"`
	// This condition is relevant only for versioned objects. An object
	// version satisfies this condition only if these many days have been
	// passed since it became noncurrent. 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 *int32 `` /* 141-byte string literal not displayed */
	// This condition is relevant only for versioned objects. An object
	// version satisfies this condition only if it became noncurrent before
	// the specified date in UTC.
	NoncurrentTimeBefore *date.Date `protobuf:"bytes,10,opt,name=noncurrent_time_before,json=noncurrentTimeBefore,proto3" json:"noncurrent_time_before,omitempty"`
	// List of object name prefixes. If any prefix exactly matches the
	// beginning of the object name, the condition evaluates to true.
	MatchesPrefix []string `protobuf:"bytes,11,rep,name=matches_prefix,json=matchesPrefix,proto3" json:"matches_prefix,omitempty"`
	// List of object name suffixes. If any suffix exactly matches the
	// end of the object name, the condition evaluates to true.
	MatchesSuffix []string `protobuf:"bytes,12,rep,name=matches_suffix,json=matchesSuffix,proto3" json:"matches_suffix,omitempty"`
	// contains filtered or unexported fields
}

A condition of an object which triggers some action.

func (*Bucket_Lifecycle_Rule_Condition) Descriptor deprecated 

func (*Bucket_Lifecycle_Rule_Condition) Descriptor() ([]byte, []int)

Deprecated: Use Bucket_Lifecycle_Rule_Condition.ProtoReflect.Descriptor instead.

func (*Bucket_Lifecycle_Rule_Condition) GetAgeDays 

func (x *Bucket_Lifecycle_Rule_Condition) GetAgeDays() int32

func (*Bucket_Lifecycle_Rule_Condition) GetCreatedBefore 

func (x *Bucket_Lifecycle_Rule_Condition) GetCreatedBefore() *date.Date

func (*Bucket_Lifecycle_Rule_Condition) GetCustomTimeBefore 

func (x *Bucket_Lifecycle_Rule_Condition) GetCustomTimeBefore() *date.Date

func (*Bucket_Lifecycle_Rule_Condition) GetDaysSinceCustomTime 

func (x *Bucket_Lifecycle_Rule_Condition) GetDaysSinceCustomTime() int32

func (*Bucket_Lifecycle_Rule_Condition) GetDaysSinceNoncurrentTime 

func (x *Bucket_Lifecycle_Rule_Condition) GetDaysSinceNoncurrentTime() int32

func (*Bucket_Lifecycle_Rule_Condition) GetIsLive 

func (x *Bucket_Lifecycle_Rule_Condition) GetIsLive() bool

func (*Bucket_Lifecycle_Rule_Condition) GetMatchesPrefix 

func (x *Bucket_Lifecycle_Rule_Condition) GetMatchesPrefix() []string

func (*Bucket_Lifecycle_Rule_Condition) GetMatchesStorageClass 

func (x *Bucket_Lifecycle_Rule_Condition) GetMatchesStorageClass() []string

func (*Bucket_Lifecycle_Rule_Condition) GetMatchesSuffix 

func (x *Bucket_Lifecycle_Rule_Condition) GetMatchesSuffix() []string

func (*Bucket_Lifecycle_Rule_Condition) GetNoncurrentTimeBefore 

func (x *Bucket_Lifecycle_Rule_Condition) GetNoncurrentTimeBefore() *date.Date

func (*Bucket_Lifecycle_Rule_Condition) GetNumNewerVersions 

func (x *Bucket_Lifecycle_Rule_Condition) GetNumNewerVersions() int32

func (*Bucket_Lifecycle_Rule_Condition) ProtoMessage 

func (*Bucket_Lifecycle_Rule_Condition) ProtoMessage()

func (*Bucket_Lifecycle_Rule_Condition) ProtoReflect 

func (x *Bucket_Lifecycle_Rule_Condition) ProtoReflect() protoreflect.Message

func (*Bucket_Lifecycle_Rule_Condition) Reset 

func (x *Bucket_Lifecycle_Rule_Condition) Reset()

func (*Bucket_Lifecycle_Rule_Condition) String 

func (x *Bucket_Lifecycle_Rule_Condition) String() string

type Bucket_Logging 

type Bucket_Logging struct {

	// The destination bucket where the current bucket's logs should be placed,
	// using path format (like `projects/123456/buckets/foo`).
	LogBucket string `protobuf:"bytes,1,opt,name=log_bucket,json=logBucket,proto3" json:"log_bucket,omitempty"`
	// A prefix for log object names.
	LogObjectPrefix string `protobuf:"bytes,2,opt,name=log_object_prefix,json=logObjectPrefix,proto3" json:"log_object_prefix,omitempty"`
	// contains filtered or unexported fields
}

Logging-related properties of a bucket.

func (*Bucket_Logging) Descriptor deprecated 

func (*Bucket_Logging) Descriptor() ([]byte, []int)

Deprecated: Use Bucket_Logging.ProtoReflect.Descriptor instead.

func (*Bucket_Logging) GetLogBucket 

func (x *Bucket_Logging) GetLogBucket() string

func (*Bucket_Logging) GetLogObjectPrefix 

func (x *Bucket_Logging) GetLogObjectPrefix() string

func (*Bucket_Logging) ProtoMessage 

func (*Bucket_Logging) ProtoMessage()

func (*Bucket_Logging) ProtoReflect 

func (x *Bucket_Logging) ProtoReflect() protoreflect.Message

func (*Bucket_Logging) Reset 

func (x *Bucket_Logging) Reset()

func (*Bucket_Logging) String 

func (x *Bucket_Logging) String() string

type Bucket_RetentionPolicy 

type Bucket_RetentionPolicy struct {

	// Server-determined value that indicates the time from which policy was
	// enforced and effective.
	EffectiveTime *timestamppb.Timestamp `protobuf:"bytes,1,opt,name=effective_time,json=effectiveTime,proto3" json:"effective_time,omitempty"`
	// Once locked, an object retention policy cannot be modified.
	IsLocked bool `protobuf:"varint,2,opt,name=is_locked,json=isLocked,proto3" json:"is_locked,omitempty"`
	// 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 `protobuf:"varint,3,opt,name=retention_period,json=retentionPeriod,proto3,oneof" json:"retention_period,omitempty"`
	// The duration 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. Any `nanos` value specified will be
	// rounded down to the nearest second.
	RetentionDuration *durationpb.Duration `protobuf:"bytes,4,opt,name=retention_duration,json=retentionDuration,proto3" json:"retention_duration,omitempty"`
	// contains filtered or unexported fields
}

Retention policy properties of a bucket.

func (*Bucket_RetentionPolicy) Descriptor deprecated 

func (*Bucket_RetentionPolicy) Descriptor() ([]byte, []int)

Deprecated: Use Bucket_RetentionPolicy.ProtoReflect.Descriptor instead.

func (*Bucket_RetentionPolicy) GetEffectiveTime 

func (x *Bucket_RetentionPolicy) GetEffectiveTime() *timestamppb.Timestamp

func (*Bucket_RetentionPolicy) GetIsLocked 

func (x *Bucket_RetentionPolicy) GetIsLocked() bool

func (*Bucket_RetentionPolicy) GetRetentionDuration added in v1.29.0 

func (x *Bucket_RetentionPolicy) GetRetentionDuration() *durationpb.Duration

func (*Bucket_RetentionPolicy) GetRetentionPeriod 

func (x *Bucket_RetentionPolicy) GetRetentionPeriod() int64

func (*Bucket_RetentionPolicy) ProtoMessage 

func (*Bucket_RetentionPolicy) ProtoMessage()

func (*Bucket_RetentionPolicy) ProtoReflect 

func (x *Bucket_RetentionPolicy) ProtoReflect() protoreflect.Message

func (*Bucket_RetentionPolicy) Reset 

func (x *Bucket_RetentionPolicy) Reset()

func (*Bucket_RetentionPolicy) String 

func (x *Bucket_RetentionPolicy) String() string

type Bucket_Versioning 

type Bucket_Versioning struct {

	// While set to true, versioning is fully enabled for this bucket.
	Enabled bool `protobuf:"varint,1,opt,name=enabled,proto3" json:"enabled,omitempty"`
	// contains filtered or unexported fields
}

Properties of a bucket related to versioning. For more on Cloud Storage versioning, see https://cloud.google.com/storage/docs/object-versioning.

func (*Bucket_Versioning) Descriptor deprecated 

func (*Bucket_Versioning) Descriptor() ([]byte, []int)

Deprecated: Use Bucket_Versioning.ProtoReflect.Descriptor instead.

func (*Bucket_Versioning) GetEnabled 

func (x *Bucket_Versioning) GetEnabled() bool

func (*Bucket_Versioning) ProtoMessage 

func (*Bucket_Versioning) ProtoMessage()

func (*Bucket_Versioning) ProtoReflect 

func (x *Bucket_Versioning) ProtoReflect() protoreflect.Message

func (*Bucket_Versioning) Reset 

func (x *Bucket_Versioning) Reset()

func (*Bucket_Versioning) String 

func (x *Bucket_Versioning) String() string

type Bucket_Website 

type Bucket_Website struct {

	// 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 `protobuf:"bytes,1,opt,name=main_page_suffix,json=mainPageSuffix,proto3" json:"main_page_suffix,omitempty"`
	// 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
	// [https://tools.ietf.org/html/rfc7231#section-6.5.4][404 Not Found]
	// result.
	NotFoundPage string `protobuf:"bytes,2,opt,name=not_found_page,json=notFoundPage,proto3" json:"not_found_page,omitempty"`
	// contains filtered or unexported fields
}

Properties of a bucket related to accessing the contents as a static website. For more on hosting a static website via Cloud Storage, see https://cloud.google.com/storage/docs/hosting-static-website.

func (*Bucket_Website) Descriptor deprecated 

func (*Bucket_Website) Descriptor() ([]byte, []int)

Deprecated: Use Bucket_Website.ProtoReflect.Descriptor instead.

func (*Bucket_Website) GetMainPageSuffix 

func (x *Bucket_Website) GetMainPageSuffix() string

func (*Bucket_Website) GetNotFoundPage 

func (x *Bucket_Website) GetNotFoundPage() string

func (*Bucket_Website) ProtoMessage 

func (*Bucket_Website) ProtoMessage()

func (*Bucket_Website) ProtoReflect 

func (x *Bucket_Website) ProtoReflect() protoreflect.Message

func (*Bucket_Website) Reset 

func (x *Bucket_Website) Reset()

func (*Bucket_Website) String 

func (x *Bucket_Website) String() string

type CancelResumableWriteRequest added in v1.25.0 

type CancelResumableWriteRequest struct {

	// Required. The upload_id of the resumable upload to cancel. This should be
	// copied from the `upload_id` field of `StartResumableWriteResponse`.
	UploadId string `protobuf:"bytes,1,opt,name=upload_id,json=uploadId,proto3" json:"upload_id,omitempty"`
	// contains filtered or unexported fields
}

Message for canceling an in-progress resumable upload. `upload_id` **must** be set.

func (*CancelResumableWriteRequest) Descriptor deprecated added in v1.25.0 

func (*CancelResumableWriteRequest) Descriptor() ([]byte, []int)

Deprecated: Use CancelResumableWriteRequest.ProtoReflect.Descriptor instead.

func (*CancelResumableWriteRequest) GetUploadId added in v1.25.0 

func (x *CancelResumableWriteRequest) GetUploadId() string

func (*CancelResumableWriteRequest) ProtoMessage added in v1.25.0 

func (*CancelResumableWriteRequest) ProtoMessage()

func (*CancelResumableWriteRequest) ProtoReflect added in v1.25.0 

func (x *CancelResumableWriteRequest) ProtoReflect() protoreflect.Message

func (*CancelResumableWriteRequest) Reset added in v1.25.0 

func (x *CancelResumableWriteRequest) Reset()

func (*CancelResumableWriteRequest) String added in v1.25.0 

func (x *CancelResumableWriteRequest) String() string

type CancelResumableWriteResponse added in v1.25.0 

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

Empty response message for canceling an in-progress resumable upload, will be extended as needed.

func (*CancelResumableWriteResponse) Descriptor deprecated added in v1.25.0 

func (*CancelResumableWriteResponse) Descriptor() ([]byte, []int)

Deprecated: Use CancelResumableWriteResponse.ProtoReflect.Descriptor instead.

func (*CancelResumableWriteResponse) ProtoMessage added in v1.25.0 

func (*CancelResumableWriteResponse) ProtoMessage()

func (*CancelResumableWriteResponse) ProtoReflect added in v1.25.0 

func (x *CancelResumableWriteResponse) ProtoReflect() protoreflect.Message

func (*CancelResumableWriteResponse) Reset added in v1.25.0 

func (x *CancelResumableWriteResponse) Reset()

func (*CancelResumableWriteResponse) String added in v1.25.0 

func (x *CancelResumableWriteResponse) String() string

type ChecksummedData 

type ChecksummedData struct {

	// The data.
	Content []byte `protobuf:"bytes,1,opt,name=content,proto3" json:"content,omitempty"`
	// If set, the CRC32C digest of the content field.
	Crc32C *uint32 `protobuf:"fixed32,2,opt,name=crc32c,proto3,oneof" json:"crc32c,omitempty"`
	// contains filtered or unexported fields
}

Message used to convey content being read or written, along with an optional checksum.

func (*ChecksummedData) Descriptor deprecated 

func (*ChecksummedData) Descriptor() ([]byte, []int)

Deprecated: Use ChecksummedData.ProtoReflect.Descriptor instead.

func (*ChecksummedData) GetContent 

func (x *ChecksummedData) GetContent() []byte

func (*ChecksummedData) GetCrc32C 

func (x *ChecksummedData) GetCrc32C() uint32

func (*ChecksummedData) ProtoMessage 

func (*ChecksummedData) ProtoMessage()

func (*ChecksummedData) ProtoReflect 

func (x *ChecksummedData) ProtoReflect() protoreflect.Message

func (*ChecksummedData) Reset 

func (x *ChecksummedData) Reset()

func (*ChecksummedData) String 

func (x *ChecksummedData) String() string

type CommonObjectRequestParams 

type CommonObjectRequestParams struct {

	// Encryption algorithm used with the Customer-Supplied Encryption Keys
	// feature.
	EncryptionAlgorithm string `protobuf:"bytes,1,opt,name=encryption_algorithm,json=encryptionAlgorithm,proto3" json:"encryption_algorithm,omitempty"`
	// Encryption key used with the Customer-Supplied Encryption Keys feature.
	// In raw bytes format (not base64-encoded).
	EncryptionKeyBytes []byte `protobuf:"bytes,4,opt,name=encryption_key_bytes,json=encryptionKeyBytes,proto3" json:"encryption_key_bytes,omitempty"`
	// SHA256 hash of encryption key used with the Customer-Supplied Encryption
	// Keys feature.
	EncryptionKeySha256Bytes []byte `` /* 137-byte string literal not displayed */
	// contains filtered or unexported fields
}

Parameters that can be passed to any object request.

func (*CommonObjectRequestParams) Descriptor deprecated 

func (*CommonObjectRequestParams) Descriptor() ([]byte, []int)

Deprecated: Use CommonObjectRequestParams.ProtoReflect.Descriptor instead.

func (*CommonObjectRequestParams) GetEncryptionAlgorithm 

func (x *CommonObjectRequestParams) GetEncryptionAlgorithm() string

func (*CommonObjectRequestParams) GetEncryptionKeyBytes 

func (x *CommonObjectRequestParams) GetEncryptionKeyBytes() []byte

func (*CommonObjectRequestParams) GetEncryptionKeySha256Bytes 

func (x *CommonObjectRequestParams) GetEncryptionKeySha256Bytes() []byte

func (*CommonObjectRequestParams) ProtoMessage 

func (*CommonObjectRequestParams) ProtoMessage()

func (*CommonObjectRequestParams) ProtoReflect 

func (x *CommonObjectRequestParams) ProtoReflect() protoreflect.Message

func (*CommonObjectRequestParams) Reset 

func (x *CommonObjectRequestParams) Reset()

func (*CommonObjectRequestParams) String 

func (x *CommonObjectRequestParams) String() string

type ComposeObjectRequest 

type ComposeObjectRequest struct {

	// Required. Properties of the resulting object.
	Destination *Object `protobuf:"bytes,1,opt,name=destination,proto3" json:"destination,omitempty"`
	// The list of source objects that will be concatenated into a single object.
	SourceObjects []*ComposeObjectRequest_SourceObject `protobuf:"bytes,2,rep,name=source_objects,json=sourceObjects,proto3" json:"source_objects,omitempty"`
	// Apply a predefined set of access controls to the destination object.
	// Valid values are "authenticatedRead", "bucketOwnerFullControl",
	// "bucketOwnerRead", "private", "projectPrivate", or "publicRead".
	DestinationPredefinedAcl string `` /* 135-byte string literal not displayed */
	// 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.
	IfGenerationMatch *int64 `protobuf:"varint,4,opt,name=if_generation_match,json=ifGenerationMatch,proto3,oneof" json:"if_generation_match,omitempty"`
	// Makes the operation conditional on whether the object's current
	// metageneration matches the given value.
	IfMetagenerationMatch *int64 `` /* 133-byte string literal not displayed */
	// Resource name of the Cloud KMS key, of the form
	// `projects/my-project/locations/my-location/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.
	KmsKey string `protobuf:"bytes,6,opt,name=kms_key,json=kmsKey,proto3" json:"kms_key,omitempty"`
	// A set of parameters common to Storage API requests concerning an object.
	CommonObjectRequestParams *CommonObjectRequestParams `` /* 140-byte string literal not displayed */
	// The checksums of the complete object. This will be validated against the
	// combined checksums of the component objects.
	ObjectChecksums *ObjectChecksums `protobuf:"bytes,10,opt,name=object_checksums,json=objectChecksums,proto3" json:"object_checksums,omitempty"`
	// contains filtered or unexported fields
}

Request message for ComposeObject.

func (*ComposeObjectRequest) Descriptor deprecated 

func (*ComposeObjectRequest) Descriptor() ([]byte, []int)

Deprecated: Use ComposeObjectRequest.ProtoReflect.Descriptor instead.

func (*ComposeObjectRequest) GetCommonObjectRequestParams 

func (x *ComposeObjectRequest) GetCommonObjectRequestParams() *CommonObjectRequestParams

func (*ComposeObjectRequest) GetDestination 

func (x *ComposeObjectRequest) GetDestination() *Object

func (*ComposeObjectRequest) GetDestinationPredefinedAcl 

func (x *ComposeObjectRequest) GetDestinationPredefinedAcl() string

func (*ComposeObjectRequest) GetIfGenerationMatch 

func (x *ComposeObjectRequest) GetIfGenerationMatch() int64

func (*ComposeObjectRequest) GetIfMetagenerationMatch 

func (x *ComposeObjectRequest) GetIfMetagenerationMatch() int64

func (*ComposeObjectRequest) GetKmsKey 

func (x *ComposeObjectRequest) GetKmsKey() string

func (*ComposeObjectRequest) GetObjectChecksums added in v1.29.0 

func (x *ComposeObjectRequest) GetObjectChecksums() *ObjectChecksums

func (*ComposeObjectRequest) GetSourceObjects 

func (x *ComposeObjectRequest) GetSourceObjects() []*ComposeObjectRequest_SourceObject

func (*ComposeObjectRequest) ProtoMessage 

func (*ComposeObjectRequest) ProtoMessage()

func (*ComposeObjectRequest) ProtoReflect 

func (x *ComposeObjectRequest) ProtoReflect() protoreflect.Message

func (*ComposeObjectRequest) Reset 

func (x *ComposeObjectRequest) Reset()

func (*ComposeObjectRequest) String 

func (x *ComposeObjectRequest) String() string

type ComposeObjectRequest_SourceObject 

type ComposeObjectRequest_SourceObject struct {

	// Required. The source object's name. All source objects must reside in the
	// same bucket.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// The generation of this object to use as the source.
	Generation int64 `protobuf:"varint,2,opt,name=generation,proto3" json:"generation,omitempty"`
	// Conditions that must be met for this operation to execute.
	ObjectPreconditions *ComposeObjectRequest_SourceObject_ObjectPreconditions `protobuf:"bytes,3,opt,name=object_preconditions,json=objectPreconditions,proto3" json:"object_preconditions,omitempty"`
	// contains filtered or unexported fields
}

Description of a source object for a composition request.

func (*ComposeObjectRequest_SourceObject) Descriptor deprecated 

func (*ComposeObjectRequest_SourceObject) Descriptor() ([]byte, []int)

Deprecated: Use ComposeObjectRequest_SourceObject.ProtoReflect.Descriptor instead.

func (*ComposeObjectRequest_SourceObject) GetGeneration 

func (x *ComposeObjectRequest_SourceObject) GetGeneration() int64

func (*ComposeObjectRequest_SourceObject) GetName 

func (x *ComposeObjectRequest_SourceObject) GetName() string

func (*ComposeObjectRequest_SourceObject) GetObjectPreconditions 

func (x *ComposeObjectRequest_SourceObject) GetObjectPreconditions() *ComposeObjectRequest_SourceObject_ObjectPreconditions

func (*ComposeObjectRequest_SourceObject) ProtoMessage 

func (*ComposeObjectRequest_SourceObject) ProtoMessage()

func (*ComposeObjectRequest_SourceObject) ProtoReflect 

func (x *ComposeObjectRequest_SourceObject) ProtoReflect() protoreflect.Message

func (*ComposeObjectRequest_SourceObject) Reset 

func (x *ComposeObjectRequest_SourceObject) Reset()

func (*ComposeObjectRequest_SourceObject) String 

func (x *ComposeObjectRequest_SourceObject) String() string

type ComposeObjectRequest_SourceObject_ObjectPreconditions 

type ComposeObjectRequest_SourceObject_ObjectPreconditions struct {

	// 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 `protobuf:"varint,1,opt,name=if_generation_match,json=ifGenerationMatch,proto3,oneof" json:"if_generation_match,omitempty"`
	// contains filtered or unexported fields
}

Preconditions for a source object of a composition request.

func (*ComposeObjectRequest_SourceObject_ObjectPreconditions) Descriptor deprecated 

func (*ComposeObjectRequest_SourceObject_ObjectPreconditions) Descriptor() ([]byte, []int)

Deprecated: Use ComposeObjectRequest_SourceObject_ObjectPreconditions.ProtoReflect.Descriptor instead.

func (*ComposeObjectRequest_SourceObject_ObjectPreconditions) GetIfGenerationMatch 

func (x *ComposeObjectRequest_SourceObject_ObjectPreconditions) GetIfGenerationMatch() int64

func (*ComposeObjectRequest_SourceObject_ObjectPreconditions) ProtoMessage 

func (*ComposeObjectRequest_SourceObject_ObjectPreconditions) ProtoMessage()

func (*ComposeObjectRequest_SourceObject_ObjectPreconditions) ProtoReflect 

func (x *ComposeObjectRequest_SourceObject_ObjectPreconditions) ProtoReflect() protoreflect.Message

func (*ComposeObjectRequest_SourceObject_ObjectPreconditions) Reset 

func (x *ComposeObjectRequest_SourceObject_ObjectPreconditions) Reset()

func (*ComposeObjectRequest_SourceObject_ObjectPreconditions) String 

func (x *ComposeObjectRequest_SourceObject_ObjectPreconditions) String() string

type ContentRange 

type ContentRange struct {

	// The starting offset of the object data.
	Start int64 `protobuf:"varint,1,opt,name=start,proto3" json:"start,omitempty"`
	// The ending offset of the object data.
	End int64 `protobuf:"varint,2,opt,name=end,proto3" json:"end,omitempty"`
	// The complete length of the object data.
	CompleteLength int64 `protobuf:"varint,3,opt,name=complete_length,json=completeLength,proto3" json:"complete_length,omitempty"`
	// contains filtered or unexported fields
}

Specifies a requested range of bytes to download.

func (*ContentRange) Descriptor deprecated 

func (*ContentRange) Descriptor() ([]byte, []int)

Deprecated: Use ContentRange.ProtoReflect.Descriptor instead.

func (*ContentRange) GetCompleteLength 

func (x *ContentRange) GetCompleteLength() int64

func (*ContentRange) GetEnd 

func (x *ContentRange) GetEnd() int64

func (*ContentRange) GetStart 

func (x *ContentRange) GetStart() int64

func (*ContentRange) ProtoMessage 

func (*ContentRange) ProtoMessage()

func (*ContentRange) ProtoReflect 

func (x *ContentRange) ProtoReflect() protoreflect.Message

func (*ContentRange) Reset 

func (x *ContentRange) Reset()

func (*ContentRange) String 

func (x *ContentRange) String() string

type CreateBucketRequest 

type CreateBucketRequest struct {

	// Required. The project to which this bucket will belong.
	Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
	// Properties of the new bucket being inserted.
	// The project and name of the bucket are specified in the parent and
	// bucket_id fields, respectively. Populating those fields in `bucket` will
	// result in an error.
	Bucket *Bucket `protobuf:"bytes,2,opt,name=bucket,proto3" json:"bucket,omitempty"`
	// Required. The ID to use for this bucket, which will become the final
	// component of the bucket's resource name. For example, the value `foo` might
	// result in a bucket with the name `projects/123456/buckets/foo`.
	BucketId string `protobuf:"bytes,3,opt,name=bucket_id,json=bucketId,proto3" json:"bucket_id,omitempty"`
	// Apply a predefined set of access controls to this bucket.
	// Valid values are "authenticatedRead", "private", "projectPrivate",
	// "publicRead", or "publicReadWrite".
	PredefinedAcl string `protobuf:"bytes,6,opt,name=predefined_acl,json=predefinedAcl,proto3" json:"predefined_acl,omitempty"`
	// Apply a predefined set of default object access controls to this bucket.
	// Valid values are "authenticatedRead", "bucketOwnerFullControl",
	// "bucketOwnerRead", "private", "projectPrivate", or "publicRead".
	PredefinedDefaultObjectAcl string `` /* 143-byte string literal not displayed */
	// contains filtered or unexported fields
}

Request message for CreateBucket.

func (*CreateBucketRequest) Descriptor deprecated 

func (*CreateBucketRequest) Descriptor() ([]byte, []int)

Deprecated: Use CreateBucketRequest.ProtoReflect.Descriptor instead.

func (*CreateBucketRequest) GetBucket 

func (x *CreateBucketRequest) GetBucket() *Bucket

func (*CreateBucketRequest) GetBucketId 

func (x *CreateBucketRequest) GetBucketId() string

func (*CreateBucketRequest) GetParent 

func (x *CreateBucketRequest) GetParent() string

func (*CreateBucketRequest) GetPredefinedAcl 

func (x *CreateBucketRequest) GetPredefinedAcl() string

func (*CreateBucketRequest) GetPredefinedDefaultObjectAcl 

func (x *CreateBucketRequest) GetPredefinedDefaultObjectAcl() string

func (*CreateBucketRequest) ProtoMessage 

func (*CreateBucketRequest) ProtoMessage()

func (*CreateBucketRequest) ProtoReflect 

func (x *CreateBucketRequest) ProtoReflect() protoreflect.Message

func (*CreateBucketRequest) Reset 

func (x *CreateBucketRequest) Reset()

func (*CreateBucketRequest) String 

func (x *CreateBucketRequest) String() string

type CreateHmacKeyRequest 

type CreateHmacKeyRequest struct {

	// Required. The project that the HMAC-owning service account lives in, in the
	// format of "projects/<projectIdentifier>". <projectIdentifier> can be the
	// project ID or project number.
	Project string `protobuf:"bytes,1,opt,name=project,proto3" json:"project,omitempty"`
	// Required. The service account to create the HMAC for.
	ServiceAccountEmail string `protobuf:"bytes,2,opt,name=service_account_email,json=serviceAccountEmail,proto3" json:"service_account_email,omitempty"`
	// contains filtered or unexported fields
}

Request message for CreateHmacKey.

func (*CreateHmacKeyRequest) Descriptor deprecated 

func (*CreateHmacKeyRequest) Descriptor() ([]byte, []int)

Deprecated: Use CreateHmacKeyRequest.ProtoReflect.Descriptor instead.

func (*CreateHmacKeyRequest) GetProject 

func (x *CreateHmacKeyRequest) GetProject() string

func (*CreateHmacKeyRequest) GetServiceAccountEmail 

func (x *CreateHmacKeyRequest) GetServiceAccountEmail() string

func (*CreateHmacKeyRequest) ProtoMessage 

func (*CreateHmacKeyRequest) ProtoMessage()

func (*CreateHmacKeyRequest) ProtoReflect 

func (x *CreateHmacKeyRequest) ProtoReflect() protoreflect.Message

func (*CreateHmacKeyRequest) Reset 

func (x *CreateHmacKeyRequest) Reset()

func (*CreateHmacKeyRequest) String 

func (x *CreateHmacKeyRequest) String() string

type CreateHmacKeyResponse 

type CreateHmacKeyResponse struct {

	// Key metadata.
	Metadata *HmacKeyMetadata `protobuf:"bytes,1,opt,name=metadata,proto3" json:"metadata,omitempty"`
	// HMAC key secret material.
	// In raw bytes format (not base64-encoded).
	SecretKeyBytes []byte `protobuf:"bytes,3,opt,name=secret_key_bytes,json=secretKeyBytes,proto3" json:"secret_key_bytes,omitempty"`
	// contains filtered or unexported fields
}

Create hmac response. The only time the secret for an HMAC will be returned.

func (*CreateHmacKeyResponse) Descriptor deprecated 

func (*CreateHmacKeyResponse) Descriptor() ([]byte, []int)

Deprecated: Use CreateHmacKeyResponse.ProtoReflect.Descriptor instead.

func (*CreateHmacKeyResponse) GetMetadata 

func (x *CreateHmacKeyResponse) GetMetadata() *HmacKeyMetadata

func (*CreateHmacKeyResponse) GetSecretKeyBytes 

func (x *CreateHmacKeyResponse) GetSecretKeyBytes() []byte

func (*CreateHmacKeyResponse) ProtoMessage 

func (*CreateHmacKeyResponse) ProtoMessage()

func (*CreateHmacKeyResponse) ProtoReflect 

func (x *CreateHmacKeyResponse) ProtoReflect() protoreflect.Message

func (*CreateHmacKeyResponse) Reset 

func (x *CreateHmacKeyResponse) Reset()

func (*CreateHmacKeyResponse) String 

func (x *CreateHmacKeyResponse) String() string

type CreateNotificationConfigRequest added in v1.30.0 

type CreateNotificationConfigRequest struct {

	// Required. The bucket to which this NotificationConfig belongs.
	Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
	// Required. Properties of the NotificationConfig to be inserted.
	NotificationConfig *NotificationConfig `protobuf:"bytes,2,opt,name=notification_config,json=notificationConfig,proto3" json:"notification_config,omitempty"`
	// contains filtered or unexported fields
}

Request message for CreateNotificationConfig.

func (*CreateNotificationConfigRequest) Descriptor deprecated added in v1.30.0 

func (*CreateNotificationConfigRequest) Descriptor() ([]byte, []int)

Deprecated: Use CreateNotificationConfigRequest.ProtoReflect.Descriptor instead.

func (*CreateNotificationConfigRequest) GetNotificationConfig added in v1.30.0 

func (x *CreateNotificationConfigRequest) GetNotificationConfig() *NotificationConfig

func (*CreateNotificationConfigRequest) GetParent added in v1.30.0 

func (x *CreateNotificationConfigRequest) GetParent() string

func (*CreateNotificationConfigRequest) ProtoMessage added in v1.30.0 

func (*CreateNotificationConfigRequest) ProtoMessage()

func (*CreateNotificationConfigRequest) ProtoReflect added in v1.30.0 

func (x *CreateNotificationConfigRequest) ProtoReflect() protoreflect.Message

func (*CreateNotificationConfigRequest) Reset added in v1.30.0 

func (x *CreateNotificationConfigRequest) Reset()

func (*CreateNotificationConfigRequest) String added in v1.30.0 

func (x *CreateNotificationConfigRequest) String() string

type CustomerEncryption 

type CustomerEncryption struct {

	// The encryption algorithm.
	EncryptionAlgorithm string `protobuf:"bytes,1,opt,name=encryption_algorithm,json=encryptionAlgorithm,proto3" json:"encryption_algorithm,omitempty"`
	// SHA256 hash value of the encryption key.
	// In raw bytes format (not base64-encoded).
	KeySha256Bytes []byte `protobuf:"bytes,3,opt,name=key_sha256_bytes,json=keySha256Bytes,proto3" json:"key_sha256_bytes,omitempty"`
	// contains filtered or unexported fields
}

Describes the Customer-Supplied Encryption Key mechanism used to store an Object's data at rest.

func (*CustomerEncryption) Descriptor deprecated 

func (*CustomerEncryption) Descriptor() ([]byte, []int)

Deprecated: Use CustomerEncryption.ProtoReflect.Descriptor instead.

func (*CustomerEncryption) GetEncryptionAlgorithm 

func (x *CustomerEncryption) GetEncryptionAlgorithm() string

func (*CustomerEncryption) GetKeySha256Bytes 

func (x *CustomerEncryption) GetKeySha256Bytes() []byte

func (*CustomerEncryption) ProtoMessage 

func (*CustomerEncryption) ProtoMessage()

func (*CustomerEncryption) ProtoReflect 

func (x *CustomerEncryption) ProtoReflect() protoreflect.Message

func (*CustomerEncryption) Reset 

func (x *CustomerEncryption) Reset()

func (*CustomerEncryption) String 

func (x *CustomerEncryption) String() string

type DeleteBucketRequest 

type DeleteBucketRequest struct {

	// Required. Name of a bucket to delete.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// If set, only deletes the bucket if its metageneration matches this value.
	IfMetagenerationMatch *int64 `` /* 133-byte string literal not displayed */
	// If set, only deletes the bucket if its metageneration does not match this
	// value.
	IfMetagenerationNotMatch *int64 `` /* 144-byte string literal not displayed */
	// contains filtered or unexported fields
}

Request message for DeleteBucket.

func (*DeleteBucketRequest) Descriptor deprecated 

func (*DeleteBucketRequest) Descriptor() ([]byte, []int)

Deprecated: Use DeleteBucketRequest.ProtoReflect.Descriptor instead.

func (*DeleteBucketRequest) GetIfMetagenerationMatch 

func (x *DeleteBucketRequest) GetIfMetagenerationMatch() int64

func (*DeleteBucketRequest) GetIfMetagenerationNotMatch 

func (x *DeleteBucketRequest) GetIfMetagenerationNotMatch() int64

func (*DeleteBucketRequest) GetName 

func (x *DeleteBucketRequest) GetName() string

func (*DeleteBucketRequest) ProtoMessage 

func (*DeleteBucketRequest) ProtoMessage()

func (*DeleteBucketRequest) ProtoReflect 

func (x *DeleteBucketRequest) ProtoReflect() protoreflect.Message

func (*DeleteBucketRequest) Reset 

func (x *DeleteBucketRequest) Reset()

func (*DeleteBucketRequest) String 

func (x *DeleteBucketRequest) String() string

type DeleteHmacKeyRequest 

type DeleteHmacKeyRequest struct {

	// Required. The identifying key for the HMAC to delete.
	AccessId string `protobuf:"bytes,1,opt,name=access_id,json=accessId,proto3" json:"access_id,omitempty"`
	// Required. The project that owns the HMAC key, in the format of
	// "projects/<projectIdentifier>".
	// <projectIdentifier> can be the project ID or project number.
	Project string `protobuf:"bytes,2,opt,name=project,proto3" json:"project,omitempty"`
	// contains filtered or unexported fields
}

Request object to delete a given HMAC key.

func (*DeleteHmacKeyRequest) Descriptor deprecated 

func (*DeleteHmacKeyRequest) Descriptor() ([]byte, []int)

Deprecated: Use DeleteHmacKeyRequest.ProtoReflect.Descriptor instead.

func (*DeleteHmacKeyRequest) GetAccessId 

func (x *DeleteHmacKeyRequest) GetAccessId() string

func (*DeleteHmacKeyRequest) GetProject 

func (x *DeleteHmacKeyRequest) GetProject() string

func (*DeleteHmacKeyRequest) ProtoMessage 

func (*DeleteHmacKeyRequest) ProtoMessage()

func (*DeleteHmacKeyRequest) ProtoReflect 

func (x *DeleteHmacKeyRequest) ProtoReflect() protoreflect.Message

func (*DeleteHmacKeyRequest) Reset 

func (x *DeleteHmacKeyRequest) Reset()

func (*DeleteHmacKeyRequest) String 

func (x *DeleteHmacKeyRequest) String() string

type DeleteNotificationConfigRequest added in v1.30.0 

type DeleteNotificationConfigRequest struct {

	// Required. The parent bucket of the NotificationConfig.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// contains filtered or unexported fields
}

Request message for DeleteNotificationConfig.

func (*DeleteNotificationConfigRequest) Descriptor deprecated added in v1.30.0 

func (*DeleteNotificationConfigRequest) Descriptor() ([]byte, []int)

Deprecated: Use DeleteNotificationConfigRequest.ProtoReflect.Descriptor instead.

func (*DeleteNotificationConfigRequest) GetName added in v1.30.0 

func (x *DeleteNotificationConfigRequest) GetName() string

func (*DeleteNotificationConfigRequest) ProtoMessage added in v1.30.0 

func (*DeleteNotificationConfigRequest) ProtoMessage()

func (*DeleteNotificationConfigRequest) ProtoReflect added in v1.30.0 

func (x *DeleteNotificationConfigRequest) ProtoReflect() protoreflect.Message

func (*DeleteNotificationConfigRequest) Reset added in v1.30.0 

func (x *DeleteNotificationConfigRequest) Reset()

func (*DeleteNotificationConfigRequest) String added in v1.30.0 

func (x *DeleteNotificationConfigRequest) String() string

type DeleteObjectRequest 

type DeleteObjectRequest struct {

	// Required. Name of the bucket in which the object resides.
	Bucket string `protobuf:"bytes,1,opt,name=bucket,proto3" json:"bucket,omitempty"`
	// Required. The name of the finalized object to delete.
	// Note: If you want to delete an unfinalized resumable upload please use
	// `CancelResumableWrite`.
	Object string `protobuf:"bytes,2,opt,name=object,proto3" json:"object,omitempty"`
	// If present, permanently deletes a specific revision of this object (as
	// opposed to the latest version, the default).
	Generation int64 `protobuf:"varint,4,opt,name=generation,proto3" json:"generation,omitempty"`
	// 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.
	IfGenerationMatch *int64 `protobuf:"varint,5,opt,name=if_generation_match,json=ifGenerationMatch,proto3,oneof" json:"if_generation_match,omitempty"`
	// Makes the operation conditional on whether the object's live 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.
	IfGenerationNotMatch *int64 `` /* 132-byte string literal not displayed */
	// Makes the operation conditional on whether the object's current
	// metageneration matches the given value.
	IfMetagenerationMatch *int64 `` /* 133-byte string literal not displayed */
	// Makes the operation conditional on whether the object's current
	// metageneration does not match the given value.
	IfMetagenerationNotMatch *int64 `` /* 144-byte string literal not displayed */
	// A set of parameters common to Storage API requests concerning an object.
	CommonObjectRequestParams *CommonObjectRequestParams `` /* 141-byte string literal not displayed */
	// contains filtered or unexported fields
}

Message for deleting an object. `bucket` and `object` **must** be set.

func (*DeleteObjectRequest) Descriptor deprecated 

func (*DeleteObjectRequest) Descriptor() ([]byte, []int)

Deprecated: Use DeleteObjectRequest.ProtoReflect.Descriptor instead.

func (*DeleteObjectRequest) GetBucket 

func (x *DeleteObjectRequest) GetBucket() string

func (*DeleteObjectRequest) GetCommonObjectRequestParams 

func (x *DeleteObjectRequest) GetCommonObjectRequestParams() *CommonObjectRequestParams

func (*DeleteObjectRequest) GetGeneration 

func (x *DeleteObjectRequest) GetGeneration() int64

func (*DeleteObjectRequest) GetIfGenerationMatch 

func (x *DeleteObjectRequest) GetIfGenerationMatch() int64

func (*DeleteObjectRequest) GetIfGenerationNotMatch 

func (x *DeleteObjectRequest) GetIfGenerationNotMatch() int64

func (*DeleteObjectRequest) GetIfMetagenerationMatch 

func (x *DeleteObjectRequest) GetIfMetagenerationMatch() int64

func (*DeleteObjectRequest) GetIfMetagenerationNotMatch 

func (x *DeleteObjectRequest) GetIfMetagenerationNotMatch() int64

func (*DeleteObjectRequest) GetObject 

func (x *DeleteObjectRequest) GetObject() string

func (*DeleteObjectRequest) ProtoMessage 

func (*DeleteObjectRequest) ProtoMessage()

func (*DeleteObjectRequest) ProtoReflect 

func (x *DeleteObjectRequest) ProtoReflect() protoreflect.Message

func (*DeleteObjectRequest) Reset 

func (x *DeleteObjectRequest) Reset()

func (*DeleteObjectRequest) String 

func (x *DeleteObjectRequest) String() string

type GetBucketRequest 

type GetBucketRequest struct {

	// Required. Name of a bucket.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// If set, and if the bucket's current metageneration does not match the
	// specified value, the request will return an error.
	IfMetagenerationMatch *int64 `` /* 133-byte string literal not displayed */
	// If set, and if the bucket's current metageneration matches the specified
	// value, the request will return an error.
	IfMetagenerationNotMatch *int64 `` /* 144-byte string literal not displayed */
	// Mask specifying which fields to read.
	// A "*" field may be used to indicate all fields.
	// If no mask is specified, will default to all fields.
	ReadMask *fieldmaskpb.FieldMask `protobuf:"bytes,5,opt,name=read_mask,json=readMask,proto3,oneof" json:"read_mask,omitempty"`
	// contains filtered or unexported fields
}

Request message for GetBucket.

func (*GetBucketRequest) Descriptor deprecated 

func (*GetBucketRequest) Descriptor() ([]byte, []int)

Deprecated: Use GetBucketRequest.ProtoReflect.Descriptor instead.

func (*GetBucketRequest) GetIfMetagenerationMatch 

func (x *GetBucketRequest) GetIfMetagenerationMatch() int64

func (*GetBucketRequest) GetIfMetagenerationNotMatch 

func (x *GetBucketRequest) GetIfMetagenerationNotMatch() int64

func (*GetBucketRequest) GetName 

func (x *GetBucketRequest) GetName() string

func (*GetBucketRequest) GetReadMask 

func (x *GetBucketRequest) GetReadMask() *fieldmaskpb.FieldMask

func (*GetBucketRequest) ProtoMessage 

func (*GetBucketRequest) ProtoMessage()

func (*GetBucketRequest) ProtoReflect 

func (x *GetBucketRequest) ProtoReflect() protoreflect.Message

func (*GetBucketRequest) Reset 

func (x *GetBucketRequest) Reset()

func (*GetBucketRequest) String 

func (x *GetBucketRequest) String() string

type GetHmacKeyRequest 

type GetHmacKeyRequest struct {

	// Required. The identifying key for the HMAC to delete.
	AccessId string `protobuf:"bytes,1,opt,name=access_id,json=accessId,proto3" json:"access_id,omitempty"`
	// Required. The project the HMAC key lies in, in the format of
	// "projects/<projectIdentifier>".
	// <projectIdentifier> can be the project ID or project number.
	Project string `protobuf:"bytes,2,opt,name=project,proto3" json:"project,omitempty"`
	// contains filtered or unexported fields
}

Request object to get metadata on a given HMAC key.

func (*GetHmacKeyRequest) Descriptor deprecated 

func (*GetHmacKeyRequest) Descriptor() ([]byte, []int)

Deprecated: Use GetHmacKeyRequest.ProtoReflect.Descriptor instead.

func (*GetHmacKeyRequest) GetAccessId 

func (x *GetHmacKeyRequest) GetAccessId() string

func (*GetHmacKeyRequest) GetProject 

func (x *GetHmacKeyRequest) GetProject() string

func (*GetHmacKeyRequest) ProtoMessage 

func (*GetHmacKeyRequest) ProtoMessage()

func (*GetHmacKeyRequest) ProtoReflect 

func (x *GetHmacKeyRequest) ProtoReflect() protoreflect.Message

func (*GetHmacKeyRequest) Reset 

func (x *GetHmacKeyRequest) Reset()

func (*GetHmacKeyRequest) String 

func (x *GetHmacKeyRequest) String() string

type GetNotificationConfigRequest added in v1.30.0 

type GetNotificationConfigRequest struct {

	// Required. The parent bucket of the NotificationConfig.
	// Format:
	// `projects/{project}/buckets/{bucket}/notificationConfigs/{notificationConfig}`
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// contains filtered or unexported fields
}

Request message for GetNotificationConfig.

func (*GetNotificationConfigRequest) Descriptor deprecated added in v1.30.0 

func (*GetNotificationConfigRequest) Descriptor() ([]byte, []int)

Deprecated: Use GetNotificationConfigRequest.ProtoReflect.Descriptor instead.

func (*GetNotificationConfigRequest) GetName added in v1.30.0 

func (x *GetNotificationConfigRequest) GetName() string

func (*GetNotificationConfigRequest) ProtoMessage added in v1.30.0 

func (*GetNotificationConfigRequest) ProtoMessage()

func (*GetNotificationConfigRequest) ProtoReflect added in v1.30.0 

func (x *GetNotificationConfigRequest) ProtoReflect() protoreflect.Message

func (*GetNotificationConfigRequest) Reset added in v1.30.0 

func (x *GetNotificationConfigRequest) Reset()

func (*GetNotificationConfigRequest) String added in v1.30.0 

func (x *GetNotificationConfigRequest) String() string

type GetObjectRequest 

type GetObjectRequest struct {

	// Required. Name of the bucket in which the object resides.
	Bucket string `protobuf:"bytes,1,opt,name=bucket,proto3" json:"bucket,omitempty"`
	// Required. Name of the object.
	Object string `protobuf:"bytes,2,opt,name=object,proto3" json:"object,omitempty"`
	// If present, selects a specific revision of this object (as opposed to the
	// latest version, the default).
	Generation int64 `protobuf:"varint,3,opt,name=generation,proto3" json:"generation,omitempty"`
	// 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.
	IfGenerationMatch *int64 `protobuf:"varint,4,opt,name=if_generation_match,json=ifGenerationMatch,proto3,oneof" json:"if_generation_match,omitempty"`
	// Makes the operation conditional on whether the object's live 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.
	IfGenerationNotMatch *int64 `` /* 132-byte string literal not displayed */
	// Makes the operation conditional on whether the object's current
	// metageneration matches the given value.
	IfMetagenerationMatch *int64 `` /* 133-byte string literal not displayed */
	// Makes the operation conditional on whether the object's current
	// metageneration does not match the given value.
	IfMetagenerationNotMatch *int64 `` /* 144-byte string literal not displayed */
	// A set of parameters common to Storage API requests concerning an object.
	CommonObjectRequestParams *CommonObjectRequestParams `` /* 140-byte string literal not displayed */
	// Mask specifying which fields to read.
	// If no mask is specified, will default to all fields except metadata.acl and
	// metadata.owner.
	// * may be used to mean "all fields".
	ReadMask *fieldmaskpb.FieldMask `protobuf:"bytes,10,opt,name=read_mask,json=readMask,proto3,oneof" json:"read_mask,omitempty"`
	// contains filtered or unexported fields
}

Request message for GetObject.

func (*GetObjectRequest) Descriptor deprecated 

func (*GetObjectRequest) Descriptor() ([]byte, []int)

Deprecated: Use GetObjectRequest.ProtoReflect.Descriptor instead.

func (*GetObjectRequest) GetBucket 

func (x *GetObjectRequest) GetBucket() string

func (*GetObjectRequest) GetCommonObjectRequestParams 

func (x *GetObjectRequest) GetCommonObjectRequestParams() *CommonObjectRequestParams

func (*GetObjectRequest) GetGeneration 

func (x *GetObjectRequest) GetGeneration() int64

func (*GetObjectRequest) GetIfGenerationMatch 

func (x *GetObjectRequest) GetIfGenerationMatch() int64

func (*GetObjectRequest) GetIfGenerationNotMatch 

func (x *GetObjectRequest) GetIfGenerationNotMatch() int64

func (*GetObjectRequest) GetIfMetagenerationMatch 

func (x *GetObjectRequest) GetIfMetagenerationMatch() int64

func (*GetObjectRequest) GetIfMetagenerationNotMatch 

func (x *GetObjectRequest) GetIfMetagenerationNotMatch() int64

func (*GetObjectRequest) GetObject 

func (x *GetObjectRequest) GetObject() string

func (*GetObjectRequest) GetReadMask 

func (x *GetObjectRequest) GetReadMask() *fieldmaskpb.FieldMask

func (*GetObjectRequest) ProtoMessage 

func (*GetObjectRequest) ProtoMessage()

func (*GetObjectRequest) ProtoReflect 

func (x *GetObjectRequest) ProtoReflect() protoreflect.Message

func (*GetObjectRequest) Reset 

func (x *GetObjectRequest) Reset()

func (*GetObjectRequest) String 

func (x *GetObjectRequest) String() string

type GetServiceAccountRequest 

type GetServiceAccountRequest struct {

	// Required. Project ID, in the format of "projects/<projectIdentifier>".
	// <projectIdentifier> can be the project ID or project number.
	Project string `protobuf:"bytes,1,opt,name=project,proto3" json:"project,omitempty"`
	// contains filtered or unexported fields
}

Request message for GetServiceAccount.

func (*GetServiceAccountRequest) Descriptor deprecated 

func (*GetServiceAccountRequest) Descriptor() ([]byte, []int)

Deprecated: Use GetServiceAccountRequest.ProtoReflect.Descriptor instead.

func (*GetServiceAccountRequest) GetProject 

func (x *GetServiceAccountRequest) GetProject() string

func (*GetServiceAccountRequest) ProtoMessage 

func (*GetServiceAccountRequest) ProtoMessage()

func (*GetServiceAccountRequest) ProtoReflect 

func (x *GetServiceAccountRequest) ProtoReflect() protoreflect.Message

func (*GetServiceAccountRequest) Reset 

func (x *GetServiceAccountRequest) Reset()

func (*GetServiceAccountRequest) String 

func (x *GetServiceAccountRequest) String() string

type HmacKeyMetadata 

type HmacKeyMetadata struct {

	// Immutable. Resource name ID of the key in the format
	// <projectIdentifier>/<accessId>.
	// <projectIdentifier> can be the project ID or project number.
	Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
	// Immutable. Globally unique id for keys.
	AccessId string `protobuf:"bytes,2,opt,name=access_id,json=accessId,proto3" json:"access_id,omitempty"`
	// Immutable. Identifies the project that owns the service account of the
	// specified HMAC key, in the format "projects/<projectIdentifier>".
	// <projectIdentifier> can be the project ID or project number.
	Project string `protobuf:"bytes,3,opt,name=project,proto3" json:"project,omitempty"`
	// Output only. Email of the service account the key authenticates as.
	ServiceAccountEmail string `protobuf:"bytes,4,opt,name=service_account_email,json=serviceAccountEmail,proto3" json:"service_account_email,omitempty"`
	// State of the key. One of ACTIVE, INACTIVE, or DELETED.
	// Writable, can be updated by UpdateHmacKey operation.
	State string `protobuf:"bytes,5,opt,name=state,proto3" json:"state,omitempty"`
	// Output only. The creation time of the HMAC key.
	CreateTime *timestamppb.Timestamp `protobuf:"bytes,6,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"`
	// Output only. The last modification time of the HMAC key metadata.
	UpdateTime *timestamppb.Timestamp `protobuf:"bytes,7,opt,name=update_time,json=updateTime,proto3" json:"update_time,omitempty"`
	// The etag of the HMAC key.
	Etag string `protobuf:"bytes,8,opt,name=etag,proto3" json:"etag,omitempty"`
	// contains filtered or unexported fields
}

Hmac Key Metadata, which includes all information other than the secret.

func (*HmacKeyMetadata) Descriptor deprecated 

func (*HmacKeyMetadata) Descriptor() ([]byte, []int)

Deprecated: Use HmacKeyMetadata.ProtoReflect.Descriptor instead.

func (*HmacKeyMetadata) GetAccessId 

func (x *HmacKeyMetadata) GetAccessId() string

func (*HmacKeyMetadata) GetCreateTime 

func (x *HmacKeyMetadata) GetCreateTime() *timestamppb.Timestamp

func (*HmacKeyMetadata) GetEtag 

func (x *HmacKeyMetadata) GetEtag() string

func (*HmacKeyMetadata) GetId 

func (x *HmacKeyMetadata) GetId() string

func (*HmacKeyMetadata) GetProject 

func (x *HmacKeyMetadata) GetProject() string

func (*HmacKeyMetadata) GetServiceAccountEmail 

func (x *HmacKeyMetadata) GetServiceAccountEmail() string

func (*HmacKeyMetadata) GetState 

func (x *HmacKeyMetadata) GetState() string

func (*HmacKeyMetadata) GetUpdateTime 

func (x *HmacKeyMetadata) GetUpdateTime() *timestamppb.Timestamp

func (*HmacKeyMetadata) ProtoMessage 

func (*HmacKeyMetadata) ProtoMessage()

func (*HmacKeyMetadata) ProtoReflect 

func (x *HmacKeyMetadata) ProtoReflect() protoreflect.Message

func (*HmacKeyMetadata) Reset 

func (x *HmacKeyMetadata) Reset()

func (*HmacKeyMetadata) String 

func (x *HmacKeyMetadata) String() string

type ListBucketsRequest 

type ListBucketsRequest struct {

	// Required. The project whose buckets we are listing.
	Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
	// Maximum number of buckets to return in a single response. The service will
	// use this parameter or 1,000 items, whichever is smaller. If "acl" is
	// present in the read_mask, the service will use this parameter of 200 items,
	// whichever is smaller.
	PageSize int32 `protobuf:"varint,2,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"`
	// A previously-returned page token representing part of the larger set of
	// results to view.
	PageToken string `protobuf:"bytes,3,opt,name=page_token,json=pageToken,proto3" json:"page_token,omitempty"`
	// Filter results to buckets whose names begin with this prefix.
	Prefix string `protobuf:"bytes,4,opt,name=prefix,proto3" json:"prefix,omitempty"`
	// Mask specifying which fields to read from each result.
	// If no mask is specified, will default to all fields except items.owner,
	// items.acl, and items.default_object_acl.
	// * may be used to mean "all fields".
	ReadMask *fieldmaskpb.FieldMask `protobuf:"bytes,5,opt,name=read_mask,json=readMask,proto3,oneof" json:"read_mask,omitempty"`
	// contains filtered or unexported fields
}

Request message for ListBuckets.

func (*ListBucketsRequest) Descriptor deprecated 

func (*ListBucketsRequest) Descriptor() ([]byte, []int)

Deprecated: Use ListBucketsRequest.ProtoReflect.Descriptor instead.

func (*ListBucketsRequest) GetPageSize 

func (x *ListBucketsRequest) GetPageSize() int32

func (*ListBucketsRequest) GetPageToken 

func (x *ListBucketsRequest) GetPageToken() string

func (*ListBucketsRequest) GetParent 

func (x *ListBucketsRequest) GetParent() string

func (*ListBucketsRequest) GetPrefix 

func (x *ListBucketsRequest) GetPrefix() string

func (*ListBucketsRequest) GetReadMask 

func (x *ListBucketsRequest) GetReadMask() *fieldmaskpb.FieldMask

func (*ListBucketsRequest) ProtoMessage 

func (*ListBucketsRequest) ProtoMessage()

func (*ListBucketsRequest) ProtoReflect 

func (x *ListBucketsRequest) ProtoReflect() protoreflect.Message

func (*ListBucketsRequest) Reset 

func (x *ListBucketsRequest) Reset()

func (*ListBucketsRequest) String 

func (x *ListBucketsRequest) String() string

type ListBucketsResponse 

type ListBucketsResponse struct {

	// The list of items.
	Buckets []*Bucket `protobuf:"bytes,1,rep,name=buckets,proto3" json:"buckets,omitempty"`
	// 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 `protobuf:"bytes,2,opt,name=next_page_token,json=nextPageToken,proto3" json:"next_page_token,omitempty"`
	// contains filtered or unexported fields
}

The result of a call to Buckets.ListBuckets

func (*ListBucketsResponse) Descriptor deprecated 

func (*ListBucketsResponse) Descriptor() ([]byte, []int)

Deprecated: Use ListBucketsResponse.ProtoReflect.Descriptor instead.

func (*ListBucketsResponse) GetBuckets 

func (x *ListBucketsResponse) GetBuckets() []*Bucket

func (*ListBucketsResponse) GetNextPageToken 

func (x *ListBucketsResponse) GetNextPageToken() string

func (*ListBucketsResponse) ProtoMessage 

func (*ListBucketsResponse) ProtoMessage()

func (*ListBucketsResponse) ProtoReflect 

func (x *ListBucketsResponse) ProtoReflect() protoreflect.Message

func (*ListBucketsResponse) Reset 

func (x *ListBucketsResponse) Reset()

func (*ListBucketsResponse) String 

func (x *ListBucketsResponse) String() string

type ListHmacKeysRequest 

type ListHmacKeysRequest struct {

	// Required. The project to list HMAC keys for, in the format of
	// "projects/<projectIdentifier>".
	// <projectIdentifier> can be the project ID or project number.
	Project string `protobuf:"bytes,1,opt,name=project,proto3" json:"project,omitempty"`
	// The maximum number of keys to return.
	PageSize int32 `protobuf:"varint,2,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"`
	// A previously returned token from ListHmacKeysResponse to get the next page.
	PageToken string `protobuf:"bytes,3,opt,name=page_token,json=pageToken,proto3" json:"page_token,omitempty"`
	// If set, filters to only return HMAC keys for specified service account.
	ServiceAccountEmail string `protobuf:"bytes,4,opt,name=service_account_email,json=serviceAccountEmail,proto3" json:"service_account_email,omitempty"`
	// If set, return deleted keys that have not yet been wiped out.
	ShowDeletedKeys bool `protobuf:"varint,5,opt,name=show_deleted_keys,json=showDeletedKeys,proto3" json:"show_deleted_keys,omitempty"`
	// contains filtered or unexported fields
}

Request to fetch a list of HMAC keys under a given project.

func (*ListHmacKeysRequest) Descriptor deprecated 

func (*ListHmacKeysRequest) Descriptor() ([]byte, []int)

Deprecated: Use ListHmacKeysRequest.ProtoReflect.Descriptor instead.

func (*ListHmacKeysRequest) GetPageSize 

func (x *ListHmacKeysRequest) GetPageSize() int32

func (*ListHmacKeysRequest) GetPageToken 

func (x *ListHmacKeysRequest) GetPageToken() string

func (*ListHmacKeysRequest) GetProject 

func (x *ListHmacKeysRequest) GetProject() string

func (*ListHmacKeysRequest) GetServiceAccountEmail 

func (x *ListHmacKeysRequest) GetServiceAccountEmail() string

func (*ListHmacKeysRequest) GetShowDeletedKeys 

func (x *ListHmacKeysRequest) GetShowDeletedKeys() bool

func (*ListHmacKeysRequest) ProtoMessage 

func (*ListHmacKeysRequest) ProtoMessage()

func (*ListHmacKeysRequest) ProtoReflect 

func (x *ListHmacKeysRequest) ProtoReflect() protoreflect.Message

func (*ListHmacKeysRequest) Reset 

func (x *ListHmacKeysRequest) Reset()

func (*ListHmacKeysRequest) String 

func (x *ListHmacKeysRequest) String() string

type ListHmacKeysResponse 

type ListHmacKeysResponse struct {

	// The list of items.
	HmacKeys []*HmacKeyMetadata `protobuf:"bytes,1,rep,name=hmac_keys,json=hmacKeys,proto3" json:"hmac_keys,omitempty"`
	// 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 `protobuf:"bytes,2,opt,name=next_page_token,json=nextPageToken,proto3" json:"next_page_token,omitempty"`
	// contains filtered or unexported fields
}

Hmac key list response with next page information.

func (*ListHmacKeysResponse) Descriptor deprecated 

func (*ListHmacKeysResponse) Descriptor() ([]byte, []int)

Deprecated: Use ListHmacKeysResponse.ProtoReflect.Descriptor instead.

func (*ListHmacKeysResponse) GetHmacKeys 

func (x *ListHmacKeysResponse) GetHmacKeys() []*HmacKeyMetadata

func (*ListHmacKeysResponse) GetNextPageToken 

func (x *ListHmacKeysResponse) GetNextPageToken() string

func (*ListHmacKeysResponse) ProtoMessage 

func (*ListHmacKeysResponse) ProtoMessage()

func (*ListHmacKeysResponse) ProtoReflect 

func (x *ListHmacKeysResponse) ProtoReflect() protoreflect.Message

func (*ListHmacKeysResponse) Reset 

func (x *ListHmacKeysResponse) Reset()

func (*ListHmacKeysResponse) String 

func (x *ListHmacKeysResponse) String() string

type ListNotificationConfigsRequest added in v1.30.0 

type ListNotificationConfigsRequest struct {

	// Required. Name of a Google Cloud Storage bucket.
	Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
	// The maximum number of NotificationConfigs to return. The service may
	// return fewer than this value. The default value is 100. Specifying a value
	// above 100 will result in a page_size of 100.
	PageSize int32 `protobuf:"varint,2,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"`
	// A page token, received from a previous `ListNotificationConfigs` call.
	// Provide this to retrieve the subsequent page.
	//
	// When paginating, all other parameters provided to `ListNotificationConfigs`
	// must match the call that provided the page token.
	PageToken string `protobuf:"bytes,3,opt,name=page_token,json=pageToken,proto3" json:"page_token,omitempty"`
	// contains filtered or unexported fields
}

Request message for ListNotifications.

func (*ListNotificationConfigsRequest) Descriptor deprecated added in v1.30.0 

func (*ListNotificationConfigsRequest) Descriptor() ([]byte, []int)

Deprecated: Use ListNotificationConfigsRequest.ProtoReflect.Descriptor instead.

func (*ListNotificationConfigsRequest) GetPageSize added in v1.30.0 

func (x *ListNotificationConfigsRequest) GetPageSize() int32

func (*ListNotificationConfigsRequest) GetPageToken added in v1.30.0 

func (x *ListNotificationConfigsRequest) GetPageToken() string

func (*ListNotificationConfigsRequest) GetParent added in v1.30.0 

func (x *ListNotificationConfigsRequest) GetParent() string

func (*ListNotificationConfigsRequest) ProtoMessage added in v1.30.0 

func (*ListNotificationConfigsRequest) ProtoMessage()

func (*ListNotificationConfigsRequest) ProtoReflect added in v1.30.0 

func (x *ListNotificationConfigsRequest) ProtoReflect() protoreflect.Message

func (*ListNotificationConfigsRequest) Reset added in v1.30.0 

func (x *ListNotificationConfigsRequest) Reset()

func (*ListNotificationConfigsRequest) String added in v1.30.0 

func (x *ListNotificationConfigsRequest) String() string

type ListNotificationConfigsResponse added in v1.30.0 

type ListNotificationConfigsResponse struct {

	// The list of items.
	NotificationConfigs []*NotificationConfig `protobuf:"bytes,1,rep,name=notification_configs,json=notificationConfigs,proto3" json:"notification_configs,omitempty"`
	// A token, which can be sent as `page_token` to retrieve the next page.
	// If this field is omitted, there are no subsequent pages.
	NextPageToken string `protobuf:"bytes,2,opt,name=next_page_token,json=nextPageToken,proto3" json:"next_page_token,omitempty"`
	// contains filtered or unexported fields
}

The result of a call to ListNotificationConfigs

func (*ListNotificationConfigsResponse) Descriptor deprecated added in v1.30.0 

func (*ListNotificationConfigsResponse) Descriptor() ([]byte, []int)

Deprecated: Use ListNotificationConfigsResponse.ProtoReflect.Descriptor instead.

func (*ListNotificationConfigsResponse) GetNextPageToken added in v1.30.0 

func (x *ListNotificationConfigsResponse) GetNextPageToken() string

func (*ListNotificationConfigsResponse) GetNotificationConfigs added in v1.30.0 

func (x *ListNotificationConfigsResponse) GetNotificationConfigs() []*NotificationConfig

func (*ListNotificationConfigsResponse) ProtoMessage added in v1.30.0 

func (*ListNotificationConfigsResponse) ProtoMessage()

func (*ListNotificationConfigsResponse) ProtoReflect added in v1.30.0 

func (x *ListNotificationConfigsResponse) ProtoReflect() protoreflect.Message

func (*ListNotificationConfigsResponse) Reset added in v1.30.0 

func (x *ListNotificationConfigsResponse) Reset()

func (*ListNotificationConfigsResponse) String added in v1.30.0 

func (x *ListNotificationConfigsResponse) String() string

type ListObjectsRequest 

type ListObjectsRequest struct {

	// Required. Name of the bucket in which to look for objects.
	Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
	// 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.
	PageSize int32 `protobuf:"varint,2,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"`
	// A previously-returned page token representing part of the larger set of
	// results to view.
	PageToken string `protobuf:"bytes,3,opt,name=page_token,json=pageToken,proto3" json:"page_token,omitempty"`
	// If set, 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.
	Delimiter string `protobuf:"bytes,4,opt,name=delimiter,proto3" json:"delimiter,omitempty"`
	// If true, objects that end in exactly one instance of `delimiter`
	// will have their metadata included in `items` in addition to
	// `prefixes`.
	IncludeTrailingDelimiter bool `` /* 136-byte string literal not displayed */
	// Filter results to objects whose names begin with this prefix.
	Prefix string `protobuf:"bytes,6,opt,name=prefix,proto3" json:"prefix,omitempty"`
	// If `true`, lists all versions of an object as distinct results.
	// For more information, see
	// [Object
	// Versioning](https://cloud.google.com/storage/docs/object-versioning).
	Versions bool `protobuf:"varint,7,opt,name=versions,proto3" json:"versions,omitempty"`
	// Mask specifying which fields to read from each result.
	// If no mask is specified, will default to all fields except items.acl and
	// items.owner.
	// * may be used to mean "all fields".
	ReadMask *fieldmaskpb.FieldMask `protobuf:"bytes,8,opt,name=read_mask,json=readMask,proto3,oneof" json:"read_mask,omitempty"`
	// Optional. Filter results to objects whose names are lexicographically equal
	// to or after lexicographic_start. If lexicographic_end is also set, the
	// objects listed have names between lexicographic_start (inclusive) and
	// lexicographic_end (exclusive).
	LexicographicStart string `protobuf:"bytes,10,opt,name=lexicographic_start,json=lexicographicStart,proto3" json:"lexicographic_start,omitempty"`
	// Optional. Filter results to objects whose names are lexicographically
	// before lexicographic_end. If lexicographic_start is also set, the objects
	// listed have names between lexicographic_start (inclusive) and
	// lexicographic_end (exclusive).
	LexicographicEnd string `protobuf:"bytes,11,opt,name=lexicographic_end,json=lexicographicEnd,proto3" json:"lexicographic_end,omitempty"`
	// contains filtered or unexported fields
}

Request message for ListObjects.

func (*ListObjectsRequest) Descriptor deprecated 

func (*ListObjectsRequest) Descriptor() ([]byte, []int)

Deprecated: Use ListObjectsRequest.ProtoReflect.Descriptor instead.

func (*ListObjectsRequest) GetDelimiter 

func (x *ListObjectsRequest) GetDelimiter() string

func (*ListObjectsRequest) GetIncludeTrailingDelimiter 

func (x *ListObjectsRequest) GetIncludeTrailingDelimiter() bool

func (*ListObjectsRequest) GetLexicographicEnd 

func (x *ListObjectsRequest) GetLexicographicEnd() string

func (*ListObjectsRequest) GetLexicographicStart 

func (x *ListObjectsRequest) GetLexicographicStart() string

func (*ListObjectsRequest) GetPageSize 

func (x *ListObjectsRequest) GetPageSize() int32

func (*ListObjectsRequest) GetPageToken 

func (x *ListObjectsRequest) GetPageToken() string

func (*ListObjectsRequest) GetParent 

func (x *ListObjectsRequest) GetParent() string

func (*ListObjectsRequest) GetPrefix 

func (x *ListObjectsRequest) GetPrefix() string

func (*ListObjectsRequest) GetReadMask 

func (x *ListObjectsRequest) GetReadMask() *fieldmaskpb.FieldMask

func (*ListObjectsRequest) GetVersions 

func (x *ListObjectsRequest) GetVersions() bool

func (*ListObjectsRequest) ProtoMessage 

func (*ListObjectsRequest) ProtoMessage()

func (*ListObjectsRequest) ProtoReflect 

func (x *ListObjectsRequest) ProtoReflect() protoreflect.Message

func (*ListObjectsRequest) Reset 

func (x *ListObjectsRequest) Reset()

func (*ListObjectsRequest) String 

func (x *ListObjectsRequest) String() string

type ListObjectsResponse 

type ListObjectsResponse struct {

	// The list of items.
	Objects []*Object `protobuf:"bytes,1,rep,name=objects,proto3" json:"objects,omitempty"`
	// The list of prefixes of objects matching-but-not-listed up to and including
	// the requested delimiter.
	Prefixes []string `protobuf:"bytes,2,rep,name=prefixes,proto3" json:"prefixes,omitempty"`
	// 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 `protobuf:"bytes,3,opt,name=next_page_token,json=nextPageToken,proto3" json:"next_page_token,omitempty"`
	// contains filtered or unexported fields
}

The result of a call to Objects.ListObjects

func (*ListObjectsResponse) Descriptor deprecated 

func (*ListObjectsResponse) Descriptor() ([]byte, []int)

Deprecated: Use ListObjectsResponse.ProtoReflect.Descriptor instead.

func (*ListObjectsResponse) GetNextPageToken 

func (x *ListObjectsResponse) GetNextPageToken() string

func (*ListObjectsResponse) GetObjects 

func (x *ListObjectsResponse) GetObjects() []*Object

func (*ListObjectsResponse) GetPrefixes 

func (x *ListObjectsResponse) GetPrefixes() []string

func (*ListObjectsResponse) ProtoMessage 

func (*ListObjectsResponse) ProtoMessage()

func (*ListObjectsResponse) ProtoReflect 

func (x *ListObjectsResponse) ProtoReflect() protoreflect.Message

func (*ListObjectsResponse) Reset 

func (x *ListObjectsResponse) Reset()

func (*ListObjectsResponse) String 

func (x *ListObjectsResponse) String() string

type LockBucketRetentionPolicyRequest 

type LockBucketRetentionPolicyRequest struct {

	// Required. Name of a bucket.
	Bucket string `protobuf:"bytes,1,opt,name=bucket,proto3" json:"bucket,omitempty"`
	// Required. Makes the operation conditional on whether bucket's current
	// metageneration matches the given value. Must be positive.
	IfMetagenerationMatch int64 `` /* 127-byte string literal not displayed */
	// contains filtered or unexported fields
}

Request message for LockBucketRetentionPolicyRequest.

func (*LockBucketRetentionPolicyRequest) Descriptor deprecated 

func (*LockBucketRetentionPolicyRequest) Descriptor() ([]byte, []int)

Deprecated: Use LockBucketRetentionPolicyRequest.ProtoReflect.Descriptor instead.

func (*LockBucketRetentionPolicyRequest) GetBucket 

func (x *LockBucketRetentionPolicyRequest) GetBucket() string

func (*LockBucketRetentionPolicyRequest) GetIfMetagenerationMatch 

func (x *LockBucketRetentionPolicyRequest) GetIfMetagenerationMatch() int64

func (*LockBucketRetentionPolicyRequest) ProtoMessage 

func (*LockBucketRetentionPolicyRequest) ProtoMessage()

func (*LockBucketRetentionPolicyRequest) ProtoReflect 

func (x *LockBucketRetentionPolicyRequest) ProtoReflect() protoreflect.Message

func (*LockBucketRetentionPolicyRequest) Reset 

func (x *LockBucketRetentionPolicyRequest) Reset()

func (*LockBucketRetentionPolicyRequest) String 

func (x *LockBucketRetentionPolicyRequest) String() string

type NotificationConfig added in v1.30.0 

type NotificationConfig struct {

	// Required. The resource name of this NotificationConfig.
	// Format:
	// `projects/{project}/buckets/{bucket}/notificationConfigs/{notificationConfig}`
	// The `{project}` portion may be `_` for globally unique buckets.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// Required. The Pub/Sub topic to which this subscription publishes. Formatted
	// as:
	// '//pubsub.googleapis.com/projects/{project-identifier}/topics/{my-topic}'
	Topic string `protobuf:"bytes,2,opt,name=topic,proto3" json:"topic,omitempty"`
	// The etag of the NotificationConfig.
	// If included in the metadata of GetNotificationConfigRequest, the operation
	// will only be performed if the etag matches that of the NotificationConfig.
	Etag string `protobuf:"bytes,7,opt,name=etag,proto3" json:"etag,omitempty"`
	// If present, only send notifications about listed event types. If
	// empty, sent notifications for all event types.
	EventTypes []string `protobuf:"bytes,3,rep,name=event_types,json=eventTypes,proto3" json:"event_types,omitempty"`
	// A list of additional attributes to attach to each Pub/Sub
	// message published for this NotificationConfig.
	CustomAttributes map[string]string `` /* 197-byte string literal not displayed */
	// If present, only apply this NotificationConfig to object names that
	// begin with this prefix.
	ObjectNamePrefix string `protobuf:"bytes,5,opt,name=object_name_prefix,json=objectNamePrefix,proto3" json:"object_name_prefix,omitempty"`
	// Required. The desired content of the Payload.
	PayloadFormat string `protobuf:"bytes,6,opt,name=payload_format,json=payloadFormat,proto3" json:"payload_format,omitempty"`
	// contains filtered or unexported fields
}

A directive to publish Pub/Sub notifications upon changes to a bucket.

func (*NotificationConfig) Descriptor deprecated added in v1.30.0 

func (*NotificationConfig) Descriptor() ([]byte, []int)

Deprecated: Use NotificationConfig.ProtoReflect.Descriptor instead.

func (*NotificationConfig) GetCustomAttributes added in v1.30.0 

func (x *NotificationConfig) GetCustomAttributes() map[string]string

func (*NotificationConfig) GetEtag added in v1.30.0 

func (x *NotificationConfig) GetEtag() string

func (*NotificationConfig) GetEventTypes added in v1.30.0 

func (x *NotificationConfig) GetEventTypes() []string

func (*NotificationConfig) GetName added in v1.30.0 

func (x *NotificationConfig) GetName() string

func (*NotificationConfig) GetObjectNamePrefix added in v1.30.0 

func (x *NotificationConfig) GetObjectNamePrefix() string

func (*NotificationConfig) GetPayloadFormat added in v1.30.0 

func (x *NotificationConfig) GetPayloadFormat() string

func (*NotificationConfig) GetTopic added in v1.30.0 

func (x *NotificationConfig) GetTopic() string

func (*NotificationConfig) ProtoMessage added in v1.30.0 

func (*NotificationConfig) ProtoMessage()

func (*NotificationConfig) ProtoReflect added in v1.30.0 

func (x *NotificationConfig) ProtoReflect() protoreflect.Message

func (*NotificationConfig) Reset added in v1.30.0 

func (x *NotificationConfig) Reset()

func (*NotificationConfig) String added in v1.30.0 

func (x *NotificationConfig) String() string

type Object 

type Object struct {

	// Immutable. The name of this object. Nearly any sequence of unicode
	// characters is valid. See
	// [Guidelines](https://cloud.google.com/storage/docs/objects#naming).
	// Example: `test.txt`
	// The `name` field by itself does not uniquely identify a Cloud Storage
	// object. A Cloud Storage object is uniquely identified by the tuple of
	// (bucket, object, generation).
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// Immutable. The name of the bucket containing this object.
	Bucket string `protobuf:"bytes,2,opt,name=bucket,proto3" json:"bucket,omitempty"`
	// The etag of the object.
	// If included in the metadata of an update or delete request message, the
	// operation will only be performed if the etag matches that of the live
	// object.
	Etag string `protobuf:"bytes,27,opt,name=etag,proto3" json:"etag,omitempty"`
	// Immutable. The content generation of this object. Used for object
	// versioning. Attempting to set or update this field will result in a
	// [FieldViolation][google.rpc.BadRequest.FieldViolation].
	Generation int64 `protobuf:"varint,3,opt,name=generation,proto3" json:"generation,omitempty"`
	// Output only. The version of the metadata for this generation of this
	// object. 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. Attempting to set or update this field
	// will result in a [FieldViolation][google.rpc.BadRequest.FieldViolation].
	Metageneration int64 `protobuf:"varint,4,opt,name=metageneration,proto3" json:"metageneration,omitempty"`
	// Storage class of the object.
	StorageClass string `protobuf:"bytes,5,opt,name=storage_class,json=storageClass,proto3" json:"storage_class,omitempty"`
	// Output only. Content-Length of the object data in bytes, matching
	// [https://tools.ietf.org/html/rfc7230#section-3.3.2][RFC 7230 §3.3.2].
	// Attempting to set or update this field will result in a
	// [FieldViolation][google.rpc.BadRequest.FieldViolation].
	Size int64 `protobuf:"varint,6,opt,name=size,proto3" json:"size,omitempty"`
	// Content-Encoding of the object data, matching
	// [https://tools.ietf.org/html/rfc7231#section-3.1.2.2][RFC 7231 §3.1.2.2]
	ContentEncoding string `protobuf:"bytes,7,opt,name=content_encoding,json=contentEncoding,proto3" json:"content_encoding,omitempty"`
	// Content-Disposition of the object data, matching
	// [https://tools.ietf.org/html/rfc6266][RFC 6266].
	ContentDisposition string `protobuf:"bytes,8,opt,name=content_disposition,json=contentDisposition,proto3" json:"content_disposition,omitempty"`
	// Cache-Control directive for the object data, matching
	// [https://tools.ietf.org/html/rfc7234#section-5.2"][RFC 7234 §5.2].
	// If omitted, and the object is accessible to all anonymous users, the
	// default will be `public, max-age=3600`.
	CacheControl string `protobuf:"bytes,9,opt,name=cache_control,json=cacheControl,proto3" json:"cache_control,omitempty"`
	// Access controls on the object.
	// If iam_config.uniform_bucket_level_access is enabled on the parent
	// bucket, requests to set, read, or modify acl is an error.
	Acl []*ObjectAccessControl `protobuf:"bytes,10,rep,name=acl,proto3" json:"acl,omitempty"`
	// Content-Language of the object data, matching
	// [https://tools.ietf.org/html/rfc7231#section-3.1.3.2][RFC 7231 §3.1.3.2].
	ContentLanguage string `protobuf:"bytes,11,opt,name=content_language,json=contentLanguage,proto3" json:"content_language,omitempty"`
	// Output only. The deletion time of the object. Will be returned if and only
	// if this version of the object has been deleted. Attempting to set or update
	// this field will result in a
	// [FieldViolation][google.rpc.BadRequest.FieldViolation].
	DeleteTime *timestamppb.Timestamp `protobuf:"bytes,12,opt,name=delete_time,json=deleteTime,proto3" json:"delete_time,omitempty"`
	// Content-Type of the object data, matching
	// [https://tools.ietf.org/html/rfc7231#section-3.1.1.5][RFC 7231 §3.1.1.5].
	// If an object is stored without a Content-Type, it is served as
	// `application/octet-stream`.
	ContentType string `protobuf:"bytes,13,opt,name=content_type,json=contentType,proto3" json:"content_type,omitempty"`
	// Output only. The creation time of the object.
	// Attempting to set or update this field will result in a
	// [FieldViolation][google.rpc.BadRequest.FieldViolation].
	CreateTime *timestamppb.Timestamp `protobuf:"bytes,14,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"`
	// Output only. Number of underlying components that make up this object.
	// Components are accumulated by compose operations. Attempting to set or
	// update this field will result in a
	// [FieldViolation][google.rpc.BadRequest.FieldViolation].
	ComponentCount int32 `protobuf:"varint,15,opt,name=component_count,json=componentCount,proto3" json:"component_count,omitempty"`
	// Output only. Hashes for the data part of this object. This field is used
	// for output only and will be silently ignored if provided in requests.
	Checksums *ObjectChecksums `protobuf:"bytes,16,opt,name=checksums,proto3" json:"checksums,omitempty"`
	// Output only. The modification time of the object metadata.
	// 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.
	// Attempting to set or update this field will result in a
	// [FieldViolation][google.rpc.BadRequest.FieldViolation].
	UpdateTime *timestamppb.Timestamp `protobuf:"bytes,17,opt,name=update_time,json=updateTime,proto3" json:"update_time,omitempty"`
	// Cloud KMS Key used to encrypt this object, if the object is encrypted by
	// such a key.
	KmsKey string `protobuf:"bytes,18,opt,name=kms_key,json=kmsKey,proto3" json:"kms_key,omitempty"`
	// Output only. The time at which the object's storage class was last changed.
	// When the object is initially created, it will be set to time_created.
	// Attempting to set or update this field will result in a
	// [FieldViolation][google.rpc.BadRequest.FieldViolation].
	UpdateStorageClassTime *timestamppb.Timestamp `` /* 132-byte string literal not displayed */
	// 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 `protobuf:"varint,20,opt,name=temporary_hold,json=temporaryHold,proto3" json:"temporary_hold,omitempty"`
	// A server-determined value that specifies the earliest time that the
	// object's retention period expires.
	// 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).
	RetentionExpireTime *timestamppb.Timestamp `protobuf:"bytes,21,opt,name=retention_expire_time,json=retentionExpireTime,proto3" json:"retention_expire_time,omitempty"`
	// User-provided metadata, in key/value pairs.
	Metadata map[string]string `` /* 158-byte string literal not displayed */
	// Whether an object is under event-based hold.
	// An event-based hold is a way to force the retention of an object until
	// after some event occurs. Once the hold is released by explicitly setting
	// this field to false, the object will become subject to any bucket-level
	// retention policy, except that the retention duration will be calculated
	// from the time the event based hold was lifted, rather than the time the
	// object was created.
	//
	// In a WriteObject request, not setting this field implies that the value
	// should be taken from the parent bucket's "default_event_based_hold" field.
	// In a response, this field will always be set to true or false.
	EventBasedHold *bool `protobuf:"varint,23,opt,name=event_based_hold,json=eventBasedHold,proto3,oneof" json:"event_based_hold,omitempty"`
	// Output only. The owner of the object. This will always be the uploader of
	// the object. Attempting to set or update this field will result in a
	// [FieldViolation][google.rpc.BadRequest.FieldViolation].
	Owner *Owner `protobuf:"bytes,24,opt,name=owner,proto3" json:"owner,omitempty"`
	// Metadata of Customer-Supplied Encryption Key, if the object is encrypted by
	// such a key.
	CustomerEncryption *CustomerEncryption `protobuf:"bytes,25,opt,name=customer_encryption,json=customerEncryption,proto3" json:"customer_encryption,omitempty"`
	// A user-specified timestamp set on an object.
	CustomTime *timestamppb.Timestamp `protobuf:"bytes,26,opt,name=custom_time,json=customTime,proto3" json:"custom_time,omitempty"`
	// contains filtered or unexported fields
}

An object.

func (*Object) Descriptor deprecated 

func (*Object) Descriptor() ([]byte, []int)

Deprecated: Use Object.ProtoReflect.Descriptor instead.

func (*Object) GetAcl 

func (x *Object) GetAcl() []*ObjectAccessControl

func (*Object) GetBucket 

func (x *Object) GetBucket() string

func (*Object) GetCacheControl 

func (x *Object) GetCacheControl() string

func (*Object) GetChecksums 

func (x *Object) GetChecksums() *ObjectChecksums

func (*Object) GetComponentCount 

func (x *Object) GetComponentCount() int32

func (*Object) GetContentDisposition 

func (x *Object) GetContentDisposition() string

func (*Object) GetContentEncoding 

func (x *Object) GetContentEncoding() string

func (*Object) GetContentLanguage 

func (x *Object) GetContentLanguage() string

func (*Object) GetContentType 

func (x *Object) GetContentType() string

func (*Object) GetCreateTime 

func (x *Object) GetCreateTime() *timestamppb.Timestamp

func (*Object) GetCustomTime 

func (x *Object) GetCustomTime() *timestamppb.Timestamp

func (*Object) GetCustomerEncryption 

func (x *Object) GetCustomerEncryption() *CustomerEncryption

func (*Object) GetDeleteTime 

func (x *Object) GetDeleteTime() *timestamppb.Timestamp

func (*Object) GetEtag 

func (x *Object) GetEtag() string

func (*Object) GetEventBasedHold 

func (x *Object) GetEventBasedHold() bool

func (*Object) GetGeneration 

func (x *Object) GetGeneration() int64

func (*Object) GetKmsKey 

func (x *Object) GetKmsKey() string

func (*Object) GetMetadata 

func (x *Object) GetMetadata() map[string]string

func (*Object) GetMetageneration 

func (x *Object) GetMetageneration() int64

func (*Object) GetName 

func (x *Object) GetName() string

func (*Object) GetOwner 

func (x *Object) GetOwner() *Owner

func (*Object) GetRetentionExpireTime 

func (x *Object) GetRetentionExpireTime() *timestamppb.Timestamp

func (*Object) GetSize 

func (x *Object) GetSize() int64

func (*Object) GetStorageClass 

func (x *Object) GetStorageClass() string

func (*Object) GetTemporaryHold 

func (x *Object) GetTemporaryHold() bool

func (*Object) GetUpdateStorageClassTime 

func (x *Object) GetUpdateStorageClassTime() *timestamppb.Timestamp

func (*Object) GetUpdateTime 

func (x *Object) GetUpdateTime() *timestamppb.Timestamp

func (*Object) ProtoMessage 

func (*Object) ProtoMessage()

func (*Object) ProtoReflect 

func (x *Object) ProtoReflect() protoreflect.Message

func (*Object) Reset 

func (x *Object) Reset()

func (*Object) String 

func (x *Object) String() string

type ObjectAccessControl 

type ObjectAccessControl struct {

	// The access permission for the entity.
	Role string `protobuf:"bytes,1,opt,name=role,proto3" json:"role,omitempty"`
	// The ID of the access-control entry.
	Id string `protobuf:"bytes,2,opt,name=id,proto3" json:"id,omitempty"`
	// The entity holding the permission, in one of the following forms:
	// * `user-{userid}`
	// * `user-{email}`
	// * `group-{groupid}`
	// * `group-{email}`
	// * `domain-{domain}`
	// * `project-{team}-{projectnumber}`
	// * `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`.
	// * All members of the Google Apps for Business domain `example.com` would be
	// `domain-example.com`.
	// For project entities, `project-{team}-{projectnumber}` format will be
	// returned on response.
	Entity string `protobuf:"bytes,3,opt,name=entity,proto3" json:"entity,omitempty"`
	// Output only. The alternative entity format, if exists. For project
	// entities, `project-{team}-{projectid}` format will be returned on response.
	EntityAlt string `protobuf:"bytes,9,opt,name=entity_alt,json=entityAlt,proto3" json:"entity_alt,omitempty"`
	// The ID for the entity, if any.
	EntityId string `protobuf:"bytes,4,opt,name=entity_id,json=entityId,proto3" json:"entity_id,omitempty"`
	// The etag of the ObjectAccessControl.
	// If included in the metadata of an update or delete request message, the
	// operation will only be performed if the etag matches that of the live
	// object's ObjectAccessControl.
	Etag string `protobuf:"bytes,8,opt,name=etag,proto3" json:"etag,omitempty"`
	// The email address associated with the entity, if any.
	Email string `protobuf:"bytes,5,opt,name=email,proto3" json:"email,omitempty"`
	// The domain associated with the entity, if any.
	Domain string `protobuf:"bytes,6,opt,name=domain,proto3" json:"domain,omitempty"`
	// The project team associated with the entity, if any.
	ProjectTeam *ProjectTeam `protobuf:"bytes,7,opt,name=project_team,json=projectTeam,proto3" json:"project_team,omitempty"`
	// contains filtered or unexported fields
}

An access-control entry.

func (*ObjectAccessControl) Descriptor deprecated 

func (*ObjectAccessControl) Descriptor() ([]byte, []int)

Deprecated: Use ObjectAccessControl.ProtoReflect.Descriptor instead.

func (*ObjectAccessControl) GetDomain 

func (x *ObjectAccessControl) GetDomain() string

func (*ObjectAccessControl) GetEmail 

func (x *ObjectAccessControl) GetEmail() string

func (*ObjectAccessControl) GetEntity 

func (x *ObjectAccessControl) GetEntity() string

func (*ObjectAccessControl) GetEntityAlt added in v1.28.0 

func (x *ObjectAccessControl) GetEntityAlt() string

func (*ObjectAccessControl) GetEntityId 

func (x *ObjectAccessControl) GetEntityId() string

func (*ObjectAccessControl) GetEtag 

func (x *ObjectAccessControl) GetEtag() string

func (*ObjectAccessControl) GetId 

func (x *ObjectAccessControl) GetId() string

func (*ObjectAccessControl) GetProjectTeam 

func (x *ObjectAccessControl) GetProjectTeam() *ProjectTeam

func (*ObjectAccessControl) GetRole 

func (x *ObjectAccessControl) GetRole() string

func (*ObjectAccessControl) ProtoMessage 

func (*ObjectAccessControl) ProtoMessage()

func (*ObjectAccessControl) ProtoReflect 

func (x *ObjectAccessControl) ProtoReflect() protoreflect.Message

func (*ObjectAccessControl) Reset 

func (x *ObjectAccessControl) Reset()

func (*ObjectAccessControl) String 

func (x *ObjectAccessControl) String() string

type ObjectChecksums 

type ObjectChecksums struct {

	// CRC32C digest of the object data. Computed by the Cloud Storage service for
	// all written objects.
	// If set in an WriteObjectRequest, service will validate that the stored
	// object matches this checksum.
	Crc32C *uint32 `protobuf:"fixed32,1,opt,name=crc32c,proto3,oneof" json:"crc32c,omitempty"`
	// 128 bit MD5 hash of the object data.
	// For more information about using the MD5 hash, see
	// [https://cloud.google.com/storage/docs/hashes-etags#json-api][Hashes and
	// ETags: Best Practices].
	// Not all objects will provide an MD5 hash. For example, composite objects
	// provide only crc32c hashes.
	// This value is equivalent to running `cat object.txt | openssl md5 -binary`
	Md5Hash []byte `protobuf:"bytes,2,opt,name=md5_hash,json=md5Hash,proto3" json:"md5_hash,omitempty"`
	// contains filtered or unexported fields
}

Message used for storing full (not subrange) object checksums.

func (*ObjectChecksums) Descriptor deprecated 

func (*ObjectChecksums) Descriptor() ([]byte, []int)

Deprecated: Use ObjectChecksums.ProtoReflect.Descriptor instead.

func (*ObjectChecksums) GetCrc32C 

func (x *ObjectChecksums) GetCrc32C() uint32

func (*ObjectChecksums) GetMd5Hash 

func (x *ObjectChecksums) GetMd5Hash() []byte

func (*ObjectChecksums) ProtoMessage 

func (*ObjectChecksums) ProtoMessage()

func (*ObjectChecksums) ProtoReflect 

func (x *ObjectChecksums) ProtoReflect() protoreflect.Message

func (*ObjectChecksums) Reset 

func (x *ObjectChecksums) Reset()

func (*ObjectChecksums) String 

func (x *ObjectChecksums) String() string

type Owner 

type Owner struct {

	// The entity, in the form `user-`*userId*.
	Entity string `protobuf:"bytes,1,opt,name=entity,proto3" json:"entity,omitempty"`
	// The ID for the entity.
	EntityId string `protobuf:"bytes,2,opt,name=entity_id,json=entityId,proto3" json:"entity_id,omitempty"`
	// contains filtered or unexported fields
}

The owner of a specific resource.

func (*Owner) Descriptor deprecated 

func (*Owner) Descriptor() ([]byte, []int)

Deprecated: Use Owner.ProtoReflect.Descriptor instead.

func (*Owner) GetEntity 

func (x *Owner) GetEntity() string

func (*Owner) GetEntityId 

func (x *Owner) GetEntityId() string

func (*Owner) ProtoMessage 

func (*Owner) ProtoMessage()

func (*Owner) ProtoReflect 

func (x *Owner) ProtoReflect() protoreflect.Message

func (*Owner) Reset 

func (x *Owner) Reset()

func (*Owner) String 

func (x *Owner) String() string

type ProjectTeam 

type ProjectTeam struct {

	// The project number.
	ProjectNumber string `protobuf:"bytes,1,opt,name=project_number,json=projectNumber,proto3" json:"project_number,omitempty"`
	// The team.
	Team string `protobuf:"bytes,2,opt,name=team,proto3" json:"team,omitempty"`
	// contains filtered or unexported fields
}

Represents the Viewers, Editors, or Owners of a given project.

func (*ProjectTeam) Descriptor deprecated 

func (*ProjectTeam) Descriptor() ([]byte, []int)

Deprecated: Use ProjectTeam.ProtoReflect.Descriptor instead.

func (*ProjectTeam) GetProjectNumber 

func (x *ProjectTeam) GetProjectNumber() string

func (*ProjectTeam) GetTeam 

func (x *ProjectTeam) GetTeam() string

func (*ProjectTeam) ProtoMessage 

func (*ProjectTeam) ProtoMessage()

func (*ProjectTeam) ProtoReflect 

func (x *ProjectTeam) ProtoReflect() protoreflect.Message

func (*ProjectTeam) Reset 

func (x *ProjectTeam) Reset()

func (*ProjectTeam) String 

func (x *ProjectTeam) String() string

type QueryWriteStatusRequest 

type QueryWriteStatusRequest struct {

	// Required. The name of the resume token for the object whose write status is
	// being requested.
	UploadId string `protobuf:"bytes,1,opt,name=upload_id,json=uploadId,proto3" json:"upload_id,omitempty"`
	// A set of parameters common to Storage API requests concerning an object.
	CommonObjectRequestParams *CommonObjectRequestParams `` /* 140-byte string literal not displayed */
	// contains filtered or unexported fields
}

Request object for `QueryWriteStatus`.

func (*QueryWriteStatusRequest) Descriptor deprecated 

func (*QueryWriteStatusRequest) Descriptor() ([]byte, []int)

Deprecated: Use QueryWriteStatusRequest.ProtoReflect.Descriptor instead.

func (*QueryWriteStatusRequest) GetCommonObjectRequestParams 

func (x *QueryWriteStatusRequest) GetCommonObjectRequestParams() *CommonObjectRequestParams

func (*QueryWriteStatusRequest) GetUploadId 

func (x *QueryWriteStatusRequest) GetUploadId() string

func (*QueryWriteStatusRequest) ProtoMessage 

func (*QueryWriteStatusRequest) ProtoMessage()

func (*QueryWriteStatusRequest) ProtoReflect 

func (x *QueryWriteStatusRequest) ProtoReflect() protoreflect.Message

func (*QueryWriteStatusRequest) Reset 

func (x *QueryWriteStatusRequest) Reset()

func (*QueryWriteStatusRequest) String 

func (x *QueryWriteStatusRequest) String() string

type QueryWriteStatusResponse 

type QueryWriteStatusResponse struct {

	// The response will set one of the following.
	//
	// Types that are assignable to WriteStatus:
	//
	//	*QueryWriteStatusResponse_PersistedSize
	//	*QueryWriteStatusResponse_Resource
	WriteStatus isQueryWriteStatusResponse_WriteStatus `protobuf_oneof:"write_status"`
	// contains filtered or unexported fields
}

Response object for `QueryWriteStatus`.

func (*QueryWriteStatusResponse) Descriptor deprecated 

func (*QueryWriteStatusResponse) Descriptor() ([]byte, []int)

Deprecated: Use QueryWriteStatusResponse.ProtoReflect.Descriptor instead.

func (*QueryWriteStatusResponse) GetPersistedSize 

func (x *QueryWriteStatusResponse) GetPersistedSize() int64

func (*QueryWriteStatusResponse) GetResource 

func (x *QueryWriteStatusResponse) GetResource() *Object

func (*QueryWriteStatusResponse) GetWriteStatus 

func (m *QueryWriteStatusResponse) GetWriteStatus() isQueryWriteStatusResponse_WriteStatus

func (*QueryWriteStatusResponse) ProtoMessage 

func (*QueryWriteStatusResponse) ProtoMessage()

func (*QueryWriteStatusResponse) ProtoReflect 

func (x *QueryWriteStatusResponse) ProtoReflect() protoreflect.Message

func (*QueryWriteStatusResponse) Reset 

func (x *QueryWriteStatusResponse) Reset()

func (*QueryWriteStatusResponse) String 

func (x *QueryWriteStatusResponse) String() string

type QueryWriteStatusResponse_PersistedSize 

type QueryWriteStatusResponse_PersistedSize struct {
	// The total number of bytes that have been processed for the given object
	// from all `WriteObject` calls. This is the correct value for the
	// 'write_offset' field to use when resuming the `WriteObject` operation.
	// Only set if the upload has not finalized.
	PersistedSize int64 `protobuf:"varint,1,opt,name=persisted_size,json=persistedSize,proto3,oneof"`
}

type QueryWriteStatusResponse_Resource 

type QueryWriteStatusResponse_Resource struct {
	// A resource containing the metadata for the uploaded object. Only set if
	// the upload has finalized.
	Resource *Object `protobuf:"bytes,2,opt,name=resource,proto3,oneof"`
}

type ReadObjectRequest 

type ReadObjectRequest struct {

	// Required. The name of the bucket containing the object to read.
	Bucket string `protobuf:"bytes,1,opt,name=bucket,proto3" json:"bucket,omitempty"`
	// Required. The name of the object to read.
	Object string `protobuf:"bytes,2,opt,name=object,proto3" json:"object,omitempty"`
	// If present, selects a specific revision of this object (as opposed
	// to the latest version, the default).
	Generation int64 `protobuf:"varint,3,opt,name=generation,proto3" json:"generation,omitempty"`
	// The offset for the first byte to return in the read, relative to the start
	// of the object.
	//
	// A negative `read_offset` value will be interpreted as the number of bytes
	// back from the end of the object to be returned. For example, if an object's
	// length is 15 bytes, a ReadObjectRequest with `read_offset` = -5 and
	// `read_limit` = 3 would return bytes 10 through 12 of the object. Requesting
	// a negative offset with magnitude larger than the size of the object will
	// return the entire object.
	ReadOffset int64 `protobuf:"varint,4,opt,name=read_offset,json=readOffset,proto3" json:"read_offset,omitempty"`
	// The maximum number of `data` bytes the server is allowed to return in the
	// sum of all `Object` messages. A `read_limit` of zero indicates that there
	// is no limit, and a negative `read_limit` will cause an error.
	//
	// If the stream returns fewer bytes than allowed by the `read_limit` and no
	// error occurred, the stream includes all data from the `read_offset` to the
	// end of the resource.
	ReadLimit int64 `protobuf:"varint,5,opt,name=read_limit,json=readLimit,proto3" json:"read_limit,omitempty"`
	// 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.
	IfGenerationMatch *int64 `protobuf:"varint,6,opt,name=if_generation_match,json=ifGenerationMatch,proto3,oneof" json:"if_generation_match,omitempty"`
	// Makes the operation conditional on whether the object's live 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.
	IfGenerationNotMatch *int64 `` /* 132-byte string literal not displayed */
	// Makes the operation conditional on whether the object's current
	// metageneration matches the given value.
	IfMetagenerationMatch *int64 `` /* 133-byte string literal not displayed */
	// Makes the operation conditional on whether the object's current
	// metageneration does not match the given value.
	IfMetagenerationNotMatch *int64 `` /* 144-byte string literal not displayed */
	// A set of parameters common to Storage API requests concerning an object.
	CommonObjectRequestParams *CommonObjectRequestParams `` /* 141-byte string literal not displayed */
	// Mask specifying which fields to read.
	// The checksummed_data field and its children will always be present.
	// If no mask is specified, will default to all fields except metadata.owner
	// and metadata.acl.
	// * may be used to mean "all fields".
	ReadMask *fieldmaskpb.FieldMask `protobuf:"bytes,12,opt,name=read_mask,json=readMask,proto3,oneof" json:"read_mask,omitempty"`
	// contains filtered or unexported fields
}

Request message for ReadObject.

func (*ReadObjectRequest) Descriptor deprecated 

func (*ReadObjectRequest) Descriptor() ([]byte, []int)

Deprecated: Use ReadObjectRequest.ProtoReflect.Descriptor instead.

func (*ReadObjectRequest) GetBucket 

func (x *ReadObjectRequest) GetBucket() string

func (*ReadObjectRequest) GetCommonObjectRequestParams 

func (x *ReadObjectRequest) GetCommonObjectRequestParams() *CommonObjectRequestParams

func (*ReadObjectRequest) GetGeneration 

func (x *ReadObjectRequest) GetGeneration() int64

func (*ReadObjectRequest) GetIfGenerationMatch 

func (x *ReadObjectRequest) GetIfGenerationMatch() int64

func (*ReadObjectRequest) GetIfGenerationNotMatch 

func (x *ReadObjectRequest) GetIfGenerationNotMatch() int64

func (*ReadObjectRequest) GetIfMetagenerationMatch 

func (x *ReadObjectRequest) GetIfMetagenerationMatch() int64

func (*ReadObjectRequest) GetIfMetagenerationNotMatch 

func (x *ReadObjectRequest) GetIfMetagenerationNotMatch() int64

func (*ReadObjectRequest) GetObject 

func (x *ReadObjectRequest) GetObject() string

func (*ReadObjectRequest) GetReadLimit 

func (x *ReadObjectRequest) GetReadLimit() int64

func (*ReadObjectRequest) GetReadMask 

func (x *ReadObjectRequest) GetReadMask() *fieldmaskpb.FieldMask

func (*ReadObjectRequest) GetReadOffset 

func (x *ReadObjectRequest) GetReadOffset() int64

func (*ReadObjectRequest) ProtoMessage 

func (*ReadObjectRequest) ProtoMessage()

func (*ReadObjectRequest) ProtoReflect 

func (x *ReadObjectRequest) ProtoReflect() protoreflect.Message

func (*ReadObjectRequest) Reset 

func (x *ReadObjectRequest) Reset()

func (*ReadObjectRequest) String 

func (x *ReadObjectRequest) String() string

type ReadObjectResponse 

type ReadObjectResponse struct {

	// A portion of the data for the object. The service **may** leave `data`
	// empty for any given `ReadResponse`. This enables the service to inform the
	// client that the request is still live while it is running an operation to
	// generate more data.
	ChecksummedData *ChecksummedData `protobuf:"bytes,1,opt,name=checksummed_data,json=checksummedData,proto3" json:"checksummed_data,omitempty"`
	// The checksums of the complete object. The client should compute one of
	// these checksums over the downloaded object and compare it against the value
	// provided here.
	ObjectChecksums *ObjectChecksums `protobuf:"bytes,2,opt,name=object_checksums,json=objectChecksums,proto3" json:"object_checksums,omitempty"`
	// If read_offset and or read_limit was specified on the
	// ReadObjectRequest, ContentRange will be populated on the first
	// ReadObjectResponse message of the read stream.
	ContentRange *ContentRange `protobuf:"bytes,3,opt,name=content_range,json=contentRange,proto3" json:"content_range,omitempty"`
	// Metadata of the object whose media is being returned.
	// Only populated in the first response in the stream.
	Metadata *Object `protobuf:"bytes,4,opt,name=metadata,proto3" json:"metadata,omitempty"`
	// contains filtered or unexported fields
}

Response message for ReadObject.

func (*ReadObjectResponse) Descriptor deprecated 

func (*ReadObjectResponse) Descriptor() ([]byte, []int)

Deprecated: Use ReadObjectResponse.ProtoReflect.Descriptor instead.

func (*ReadObjectResponse) GetChecksummedData 

func (x *ReadObjectResponse) GetChecksummedData() *ChecksummedData

func (*ReadObjectResponse) GetContentRange 

func (x *ReadObjectResponse) GetContentRange() *ContentRange

func (*ReadObjectResponse) GetMetadata 

func (x *ReadObjectResponse) GetMetadata() *Object

func (*ReadObjectResponse) GetObjectChecksums 

func (x *ReadObjectResponse) GetObjectChecksums() *ObjectChecksums

func (*ReadObjectResponse) ProtoMessage 

func (*ReadObjectResponse) ProtoMessage()

func (*ReadObjectResponse) ProtoReflect 

func (x *ReadObjectResponse) ProtoReflect() protoreflect.Message

func (*ReadObjectResponse) Reset 

func (x *ReadObjectResponse) Reset()

func (*ReadObjectResponse) String 

func (x *ReadObjectResponse) String() string

type RewriteObjectRequest 

type RewriteObjectRequest struct {

	// Required. Immutable. The name of the destination object.
	// See the
	// [Naming Guidelines](https://cloud.google.com/storage/docs/objects#naming).
	// Example: `test.txt`
	// The `name` field by itself does not uniquely identify a Cloud Storage
	// object. A Cloud Storage object is uniquely identified by the tuple of
	// (bucket, object, generation).
	DestinationName string `protobuf:"bytes,24,opt,name=destination_name,json=destinationName,proto3" json:"destination_name,omitempty"`
	// Required. Immutable. The name of the bucket containing the destination
	// object.
	DestinationBucket string `protobuf:"bytes,25,opt,name=destination_bucket,json=destinationBucket,proto3" json:"destination_bucket,omitempty"`
	// The name of the Cloud KMS key that will be used to encrypt the destination
	// object. The Cloud KMS key must be located in same location as the object.
	// If the parameter is not specified, the request uses the destination
	// bucket's default encryption key, if any, or else the Google-managed
	// encryption key.
	DestinationKmsKey string `protobuf:"bytes,27,opt,name=destination_kms_key,json=destinationKmsKey,proto3" json:"destination_kms_key,omitempty"`
	// Properties of the destination, post-rewrite object.
	// The `name`, `bucket` and `kms_key` fields must not be populated (these
	// values are specified in the `destination_name`, `destination_bucket`, and
	// `destination_kms_key` fields).
	// If `destination` is present it will be used to construct the destination
	// object's metadata; otherwise the destination object's metadata will be
	// copied from the source object.
	Destination *Object `protobuf:"bytes,1,opt,name=destination,proto3" json:"destination,omitempty"`
	// Required. Name of the bucket in which to find the source object.
	SourceBucket string `protobuf:"bytes,2,opt,name=source_bucket,json=sourceBucket,proto3" json:"source_bucket,omitempty"`
	// Required. Name of the source object.
	SourceObject string `protobuf:"bytes,3,opt,name=source_object,json=sourceObject,proto3" json:"source_object,omitempty"`
	// If present, selects a specific revision of the source object (as opposed to
	// the latest version, the default).
	SourceGeneration int64 `protobuf:"varint,4,opt,name=source_generation,json=sourceGeneration,proto3" json:"source_generation,omitempty"`
	// 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.
	RewriteToken string `protobuf:"bytes,5,opt,name=rewrite_token,json=rewriteToken,proto3" json:"rewrite_token,omitempty"`
	// Apply a predefined set of access controls to the destination object.
	// Valid values are "authenticatedRead", "bucketOwnerFullControl",
	// "bucketOwnerRead", "private", "projectPrivate", or "publicRead".
	DestinationPredefinedAcl string `` /* 136-byte string literal not displayed */
	// 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.
	IfGenerationMatch *int64 `protobuf:"varint,7,opt,name=if_generation_match,json=ifGenerationMatch,proto3,oneof" json:"if_generation_match,omitempty"`
	// Makes the operation conditional on whether the object's live 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.
	IfGenerationNotMatch *int64 `` /* 132-byte string literal not displayed */
	// Makes the operation conditional on whether the destination object's current
	// metageneration matches the given value.
	IfMetagenerationMatch *int64 `` /* 133-byte string literal not displayed */
	// Makes the operation conditional on whether the destination object's current
	// metageneration does not match the given value.
	IfMetagenerationNotMatch *int64 `` /* 145-byte string literal not displayed */
	// Makes the operation conditional on whether the source object's live
	// generation matches the given value.
	IfSourceGenerationMatch *int64 `` /* 142-byte string literal not displayed */
	// Makes the operation conditional on whether the source object's live
	// generation does not match the given value.
	IfSourceGenerationNotMatch *int64 `` /* 153-byte string literal not displayed */
	// Makes the operation conditional on whether the source object's current
	// metageneration matches the given value.
	IfSourceMetagenerationMatch *int64 `` /* 154-byte string literal not displayed */
	// Makes the operation conditional on whether the source object's current
	// metageneration does not match the given value.
	IfSourceMetagenerationNotMatch *int64 `` /* 165-byte string literal not displayed */
	// 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.
	MaxBytesRewrittenPerCall int64 `` /* 141-byte string literal not displayed */
	// The algorithm used to encrypt the source object, if any. Used if the source
	// object was encrypted with a Customer-Supplied Encryption Key.
	CopySourceEncryptionAlgorithm string `` /* 153-byte string literal not displayed */
	// The raw bytes (not base64-encoded) AES-256 encryption key used to encrypt
	// the source object, if it was encrypted with a Customer-Supplied Encryption
	// Key.
	CopySourceEncryptionKeyBytes []byte `` /* 152-byte string literal not displayed */
	// The raw bytes (not base64-encoded) SHA256 hash of the encryption key used
	// to encrypt the source object, if it was encrypted with a Customer-Supplied
	// Encryption Key.
	CopySourceEncryptionKeySha256Bytes []byte `` /* 172-byte string literal not displayed */
	// A set of parameters common to Storage API requests concerning an object.
	CommonObjectRequestParams *CommonObjectRequestParams `` /* 141-byte string literal not displayed */
	// The checksums of the complete object. This will be used to validate the
	// destination object after rewriting.
	ObjectChecksums *ObjectChecksums `protobuf:"bytes,29,opt,name=object_checksums,json=objectChecksums,proto3" json:"object_checksums,omitempty"`
	// contains filtered or unexported fields
}

Request message for RewriteObject. If the source object is encrypted using a Customer-Supplied Encryption Key the key information must be provided in the copy_source_encryption_algorithm, copy_source_encryption_key_bytes, and copy_source_encryption_key_sha256_bytes fields. If the destination object should be encrypted the keying information should be provided in the encryption_algorithm, encryption_key_bytes, and encryption_key_sha256_bytes fields of the common_object_request_params.customer_encryption field.

func (*RewriteObjectRequest) Descriptor deprecated 

func (*RewriteObjectRequest) Descriptor() ([]byte, []int)

Deprecated: Use RewriteObjectRequest.ProtoReflect.Descriptor instead.

func (*RewriteObjectRequest) GetCommonObjectRequestParams 

func (x *RewriteObjectRequest) GetCommonObjectRequestParams() *CommonObjectRequestParams

func (*RewriteObjectRequest) GetCopySourceEncryptionAlgorithm 

func (x *RewriteObjectRequest) GetCopySourceEncryptionAlgorithm() string

func (*RewriteObjectRequest) GetCopySourceEncryptionKeyBytes 

func (x *RewriteObjectRequest) GetCopySourceEncryptionKeyBytes() []byte

func (*RewriteObjectRequest) GetCopySourceEncryptionKeySha256Bytes 

func (x *RewriteObjectRequest) GetCopySourceEncryptionKeySha256Bytes() []byte

func (*RewriteObjectRequest) GetDestination 

func (x *RewriteObjectRequest) GetDestination() *Object

func (*RewriteObjectRequest) GetDestinationBucket 

func (x *RewriteObjectRequest) GetDestinationBucket() string

func (*RewriteObjectRequest) GetDestinationKmsKey 

func (x *RewriteObjectRequest) GetDestinationKmsKey() string

func (*RewriteObjectRequest) GetDestinationName 

func (x *RewriteObjectRequest) GetDestinationName() string

func (*RewriteObjectRequest) GetDestinationPredefinedAcl 

func (x *RewriteObjectRequest) GetDestinationPredefinedAcl() string

func (*RewriteObjectRequest) GetIfGenerationMatch 

func (x *RewriteObjectRequest) GetIfGenerationMatch() int64

func (*RewriteObjectRequest) GetIfGenerationNotMatch 

func (x *RewriteObjectRequest) GetIfGenerationNotMatch() int64

func (*RewriteObjectRequest) GetIfMetagenerationMatch 

func (x *RewriteObjectRequest) GetIfMetagenerationMatch() int64

func (*RewriteObjectRequest) GetIfMetagenerationNotMatch 

func (x *RewriteObjectRequest) GetIfMetagenerationNotMatch() int64

func (*RewriteObjectRequest) GetIfSourceGenerationMatch 

func (x *RewriteObjectRequest) GetIfSourceGenerationMatch() int64

func (*RewriteObjectRequest) GetIfSourceGenerationNotMatch 

func (x *RewriteObjectRequest) GetIfSourceGenerationNotMatch() int64

func (*RewriteObjectRequest) GetIfSourceMetagenerationMatch 

func (x *RewriteObjectRequest) GetIfSourceMetagenerationMatch() int64

func (*RewriteObjectRequest) GetIfSourceMetagenerationNotMatch 

func (x *RewriteObjectRequest) GetIfSourceMetagenerationNotMatch() int64

func (*RewriteObjectRequest) GetMaxBytesRewrittenPerCall 

func (x *RewriteObjectRequest) GetMaxBytesRewrittenPerCall() int64

func (*RewriteObjectRequest) GetObjectChecksums added in v1.29.0 

func (x *RewriteObjectRequest) GetObjectChecksums() *ObjectChecksums

func (*RewriteObjectRequest) GetRewriteToken 

func (x *RewriteObjectRequest) GetRewriteToken() string

func (*RewriteObjectRequest) GetSourceBucket 

func (x *RewriteObjectRequest) GetSourceBucket() string

func (*RewriteObjectRequest) GetSourceGeneration 

func (x *RewriteObjectRequest) GetSourceGeneration() int64

func (*RewriteObjectRequest) GetSourceObject 

func (x *RewriteObjectRequest) GetSourceObject() string

func (*RewriteObjectRequest) ProtoMessage 

func (*RewriteObjectRequest) ProtoMessage()

func (*RewriteObjectRequest) ProtoReflect 

func (x *RewriteObjectRequest) ProtoReflect() protoreflect.Message

func (*RewriteObjectRequest) Reset 

func (x *RewriteObjectRequest) Reset()

func (*RewriteObjectRequest) String 

func (x *RewriteObjectRequest) String() string

type RewriteResponse 

type RewriteResponse struct {

	// 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 `protobuf:"varint,1,opt,name=total_bytes_rewritten,json=totalBytesRewritten,proto3" json:"total_bytes_rewritten,omitempty"`
	// The total size of the object being copied in bytes. This property is always
	// present in the response.
	ObjectSize int64 `protobuf:"varint,2,opt,name=object_size,json=objectSize,proto3" json:"object_size,omitempty"`
	// `true` if the copy is finished; otherwise, `false` if
	// the copy is in progress. This property is always present in the response.
	Done bool `protobuf:"varint,3,opt,name=done,proto3" json:"done,omitempty"`
	// 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 `protobuf:"bytes,4,opt,name=rewrite_token,json=rewriteToken,proto3" json:"rewrite_token,omitempty"`
	// A resource containing the metadata for the copied-to object. This property
	// is present in the response only when copying completes.
	Resource *Object `protobuf:"bytes,5,opt,name=resource,proto3" json:"resource,omitempty"`
	// contains filtered or unexported fields
}

A rewrite response.

func (*RewriteResponse) Descriptor deprecated 

func (*RewriteResponse) Descriptor() ([]byte, []int)

Deprecated: Use RewriteResponse.ProtoReflect.Descriptor instead.

func (*RewriteResponse) GetDone 

func (x *RewriteResponse) GetDone() bool

func (*RewriteResponse) GetObjectSize 

func (x *RewriteResponse) GetObjectSize() int64

func (*RewriteResponse) GetResource 

func (x *RewriteResponse) GetResource() *Object

func (*RewriteResponse) GetRewriteToken 

func (x *RewriteResponse) GetRewriteToken() string

func (*RewriteResponse) GetTotalBytesRewritten 

func (x *RewriteResponse) GetTotalBytesRewritten() int64

func (*RewriteResponse) ProtoMessage 

func (*RewriteResponse) ProtoMessage()

func (*RewriteResponse) ProtoReflect 

func (x *RewriteResponse) ProtoReflect() protoreflect.Message

func (*RewriteResponse) Reset 

func (x *RewriteResponse) Reset()

func (*RewriteResponse) String 

func (x *RewriteResponse) String() string

type ServiceAccount 

type ServiceAccount struct {

	// The ID of the notification.
	EmailAddress string `protobuf:"bytes,1,opt,name=email_address,json=emailAddress,proto3" json:"email_address,omitempty"`
	// contains filtered or unexported fields
}

A service account, owned by Cloud Storage, which may be used when taking action on behalf of a given project, for example to publish Pub/Sub notifications or to retrieve security keys.

func (*ServiceAccount) Descriptor deprecated 

func (*ServiceAccount) Descriptor() ([]byte, []int)

Deprecated: Use ServiceAccount.ProtoReflect.Descriptor instead.

func (*ServiceAccount) GetEmailAddress 

func (x *ServiceAccount) GetEmailAddress() string

func (*ServiceAccount) ProtoMessage 

func (*ServiceAccount) ProtoMessage()

func (*ServiceAccount) ProtoReflect 

func (x *ServiceAccount) ProtoReflect() protoreflect.Message

func (*ServiceAccount) Reset 

func (x *ServiceAccount) Reset()

func (*ServiceAccount) String 

func (x *ServiceAccount) String() string

type ServiceConstants 

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

Shared constants.

func (*ServiceConstants) Descriptor deprecated 

func (*ServiceConstants) Descriptor() ([]byte, []int)

Deprecated: Use ServiceConstants.ProtoReflect.Descriptor instead.

func (*ServiceConstants) ProtoMessage 

func (*ServiceConstants) ProtoMessage()

func (*ServiceConstants) ProtoReflect 

func (x *ServiceConstants) ProtoReflect() protoreflect.Message

func (*ServiceConstants) Reset 

func (x *ServiceConstants) Reset()

func (*ServiceConstants) String 

func (x *ServiceConstants) String() string

type ServiceConstants_Values 

type ServiceConstants_Values int32

A collection of constant values meaningful to the Storage API. 

const (
	// Unused. Proto3 requires first enum to be 0.
	ServiceConstants_VALUES_UNSPECIFIED ServiceConstants_Values = 0
	// The maximum size chunk that can will be returned in a single
	// ReadRequest.
	// 2 MiB.
	ServiceConstants_MAX_READ_CHUNK_BYTES ServiceConstants_Values = 2097152
	// The maximum size chunk that can be sent in a single WriteObjectRequest.
	// 2 MiB.
	ServiceConstants_MAX_WRITE_CHUNK_BYTES ServiceConstants_Values = 2097152
	// The maximum size of an object in MB - whether written in a single stream
	// or composed from multiple other objects.
	// 5 TiB.
	ServiceConstants_MAX_OBJECT_SIZE_MB ServiceConstants_Values = 5242880
	// The maximum length field name that can be sent in a single
	// custom metadata field.
	// 1 KiB.
	ServiceConstants_MAX_CUSTOM_METADATA_FIELD_NAME_BYTES ServiceConstants_Values = 1024
	// The maximum length field value that can be sent in a single
	// custom_metadata field.
	// 4 KiB.
	ServiceConstants_MAX_CUSTOM_METADATA_FIELD_VALUE_BYTES ServiceConstants_Values = 4096
	// The maximum total bytes that can be populated into all field names and
	// values of the custom_metadata for one object.
	// 8 KiB.
	ServiceConstants_MAX_CUSTOM_METADATA_TOTAL_SIZE_BYTES ServiceConstants_Values = 8192
	// The maximum total bytes that can be populated into all bucket metadata
	// fields.
	// 20 KiB.
	ServiceConstants_MAX_BUCKET_METADATA_TOTAL_SIZE_BYTES ServiceConstants_Values = 20480
	// The maximum number of NotificationConfigs that can be registered
	// for a given bucket.
	ServiceConstants_MAX_NOTIFICATION_CONFIGS_PER_BUCKET ServiceConstants_Values = 100
	// The maximum number of LifecycleRules that can be registered for a given
	// bucket.
	ServiceConstants_MAX_LIFECYCLE_RULES_PER_BUCKET ServiceConstants_Values = 100
	// The maximum number of custom attributes per NotificationConfigs.
	ServiceConstants_MAX_NOTIFICATION_CUSTOM_ATTRIBUTES ServiceConstants_Values = 5
	// The maximum length of a custom attribute key included in
	// NotificationConfig.
	ServiceConstants_MAX_NOTIFICATION_CUSTOM_ATTRIBUTE_KEY_LENGTH ServiceConstants_Values = 256
	// The maximum length of a custom attribute value included in a
	// NotificationConfig.
	ServiceConstants_MAX_NOTIFICATION_CUSTOM_ATTRIBUTE_VALUE_LENGTH ServiceConstants_Values = 1024
	// The maximum number of key/value entries per bucket label.
	ServiceConstants_MAX_LABELS_ENTRIES_COUNT ServiceConstants_Values = 64
	// The maximum character length of the key or value in a bucket
	// label map.
	ServiceConstants_MAX_LABELS_KEY_VALUE_LENGTH ServiceConstants_Values = 63
	// The maximum byte size of the key or value in a bucket label
	// map.
	ServiceConstants_MAX_LABELS_KEY_VALUE_BYTES ServiceConstants_Values = 128
	// The maximum number of object IDs that can be included in a
	// DeleteObjectsRequest.
	ServiceConstants_MAX_OBJECT_IDS_PER_DELETE_OBJECTS_REQUEST ServiceConstants_Values = 1000
	// The maximum number of days for which a token returned by the
	// GetListObjectsSplitPoints RPC is valid.
	ServiceConstants_SPLIT_TOKEN_MAX_VALID_DAYS ServiceConstants_Values = 14
)

func (ServiceConstants_Values) Descriptor 

func (ServiceConstants_Values) Descriptor() protoreflect.EnumDescriptor

func (ServiceConstants_Values) Enum 

func (x ServiceConstants_Values) Enum() *ServiceConstants_Values

func (ServiceConstants_Values) EnumDescriptor deprecated 

func (ServiceConstants_Values) EnumDescriptor() ([]byte, []int)

Deprecated: Use ServiceConstants_Values.Descriptor instead.

func (ServiceConstants_Values) Number 

func (x ServiceConstants_Values) Number() protoreflect.EnumNumber

func (ServiceConstants_Values) String 

func (x ServiceConstants_Values) String() string

func (ServiceConstants_Values) Type 

func (ServiceConstants_Values) Type() protoreflect.EnumType

type StartResumableWriteRequest 

type StartResumableWriteRequest struct {

	// Required. The destination bucket, object, and metadata, as well as any
	// preconditions.
	WriteObjectSpec *WriteObjectSpec `protobuf:"bytes,1,opt,name=write_object_spec,json=writeObjectSpec,proto3" json:"write_object_spec,omitempty"`
	// A set of parameters common to Storage API requests concerning an object.
	CommonObjectRequestParams *CommonObjectRequestParams `` /* 140-byte string literal not displayed */
	// The checksums of the complete object. This will be used to validate the
	// uploaded object. For each upload, object_checksums can be provided with
	// either StartResumableWriteRequest or the WriteObjectRequest with
	// finish_write set to `true`.
	ObjectChecksums *ObjectChecksums `protobuf:"bytes,5,opt,name=object_checksums,json=objectChecksums,proto3" json:"object_checksums,omitempty"`
	// contains filtered or unexported fields
}

Request message StartResumableWrite.

func (*StartResumableWriteRequest) Descriptor deprecated 

func (*StartResumableWriteRequest) Descriptor() ([]byte, []int)

Deprecated: Use StartResumableWriteRequest.ProtoReflect.Descriptor instead.

func (*StartResumableWriteRequest) GetCommonObjectRequestParams 

func (x *StartResumableWriteRequest) GetCommonObjectRequestParams() *CommonObjectRequestParams

func (*StartResumableWriteRequest) GetObjectChecksums added in v1.29.0 

func (x *StartResumableWriteRequest) GetObjectChecksums() *ObjectChecksums

func (*StartResumableWriteRequest) GetWriteObjectSpec 

func (x *StartResumableWriteRequest) GetWriteObjectSpec() *WriteObjectSpec

func (*StartResumableWriteRequest) ProtoMessage 

func (*StartResumableWriteRequest) ProtoMessage()

func (*StartResumableWriteRequest) ProtoReflect 

func (x *StartResumableWriteRequest) ProtoReflect() protoreflect.Message

func (*StartResumableWriteRequest) Reset 

func (x *StartResumableWriteRequest) Reset()

func (*StartResumableWriteRequest) String 

func (x *StartResumableWriteRequest) String() string

type StartResumableWriteResponse 

type StartResumableWriteResponse struct {

	// The upload_id of the newly started resumable write operation. This
	// value should be copied into the `WriteObjectRequest.upload_id` field.
	UploadId string `protobuf:"bytes,1,opt,name=upload_id,json=uploadId,proto3" json:"upload_id,omitempty"`
	// contains filtered or unexported fields
}

Response object for `StartResumableWrite`.

func (*StartResumableWriteResponse) Descriptor deprecated 

func (*StartResumableWriteResponse) Descriptor() ([]byte, []int)

Deprecated: Use StartResumableWriteResponse.ProtoReflect.Descriptor instead.

func (*StartResumableWriteResponse) GetUploadId 

func (x *StartResumableWriteResponse) GetUploadId() string

func (*StartResumableWriteResponse) ProtoMessage 

func (*StartResumableWriteResponse) ProtoMessage()

func (*StartResumableWriteResponse) ProtoReflect 

func (x *StartResumableWriteResponse) ProtoReflect() protoreflect.Message

func (*StartResumableWriteResponse) Reset 

func (x *StartResumableWriteResponse) Reset()

func (*StartResumableWriteResponse) String 

func (x *StartResumableWriteResponse) String() string

type StorageClient 

type StorageClient interface {
	// Permanently deletes an empty bucket.
	DeleteBucket(ctx context.Context, in *DeleteBucketRequest, opts ...grpc.CallOption) (*emptypb.Empty, error)
	// Returns metadata for the specified bucket.
	GetBucket(ctx context.Context, in *GetBucketRequest, opts ...grpc.CallOption) (*Bucket, error)
	// Creates a new bucket.
	CreateBucket(ctx context.Context, in *CreateBucketRequest, opts ...grpc.CallOption) (*Bucket, error)
	// Retrieves a list of buckets for a given project.
	ListBuckets(ctx context.Context, in *ListBucketsRequest, opts ...grpc.CallOption) (*ListBucketsResponse, error)
	// Locks retention policy on a bucket.
	LockBucketRetentionPolicy(ctx context.Context, in *LockBucketRetentionPolicyRequest, opts ...grpc.CallOption) (*Bucket, error)
	// Gets the IAM policy for a specified bucket or object.
	// The `resource` field in the request should be
	// projects/_/buckets/<bucket_name> for a bucket or
	// projects/_/buckets/<bucket_name>/objects/<object_name> for an object.
	GetIamPolicy(ctx context.Context, in *iampb.GetIamPolicyRequest, opts ...grpc.CallOption) (*iampb.Policy, error)
	// Updates an IAM policy for the specified bucket or object.
	// The `resource` field in the request should be
	// projects/_/buckets/<bucket_name> for a bucket or
	// projects/_/buckets/<bucket_name>/objects/<object_name> for an object.
	SetIamPolicy(ctx context.Context, in *iampb.SetIamPolicyRequest, opts ...grpc.CallOption) (*iampb.Policy, error)
	// Tests a set of permissions on the given bucket or object to see which, if
	// any, are held by the caller.
	// The `resource` field in the request should be
	// projects/_/buckets/<bucket_name> for a bucket or
	// projects/_/buckets/<bucket_name>/objects/<object_name> for an object.
	TestIamPermissions(ctx context.Context, in *iampb.TestIamPermissionsRequest, opts ...grpc.CallOption) (*iampb.TestIamPermissionsResponse, error)
	// Updates a bucket. Equivalent to JSON API's storage.buckets.patch method.
	UpdateBucket(ctx context.Context, in *UpdateBucketRequest, opts ...grpc.CallOption) (*Bucket, error)
	// Permanently deletes a NotificationConfig.
	DeleteNotificationConfig(ctx context.Context, in *DeleteNotificationConfigRequest, opts ...grpc.CallOption) (*emptypb.Empty, error)
	// View a NotificationConfig.
	GetNotificationConfig(ctx context.Context, in *GetNotificationConfigRequest, opts ...grpc.CallOption) (*NotificationConfig, error)
	// Creates a NotificationConfig for a given bucket.
	// These NotificationConfigs, when triggered, publish messages to the
	// specified Pub/Sub topics. See
	// https://cloud.google.com/storage/docs/pubsub-notifications.
	CreateNotificationConfig(ctx context.Context, in *CreateNotificationConfigRequest, opts ...grpc.CallOption) (*NotificationConfig, error)
	// Retrieves a list of NotificationConfigs for a given bucket.
	ListNotificationConfigs(ctx context.Context, in *ListNotificationConfigsRequest, opts ...grpc.CallOption) (*ListNotificationConfigsResponse, error)
	// Concatenates a list of existing objects into a new object in the same
	// bucket.
	ComposeObject(ctx context.Context, in *ComposeObjectRequest, opts ...grpc.CallOption) (*Object, error)
	// Deletes an object and its metadata. Deletions are permanent if versioning
	// is not enabled for the bucket, or if the `generation` parameter is used.
	DeleteObject(ctx context.Context, in *DeleteObjectRequest, opts ...grpc.CallOption) (*emptypb.Empty, error)
	// Cancels an in-progress resumable upload.
	CancelResumableWrite(ctx context.Context, in *CancelResumableWriteRequest, opts ...grpc.CallOption) (*CancelResumableWriteResponse, error)
	// Retrieves an object's metadata.
	GetObject(ctx context.Context, in *GetObjectRequest, opts ...grpc.CallOption) (*Object, error)
	// Reads an object's data.
	ReadObject(ctx context.Context, in *ReadObjectRequest, opts ...grpc.CallOption) (Storage_ReadObjectClient, error)
	// Updates an object's metadata.
	// Equivalent to JSON API's storage.objects.patch.
	UpdateObject(ctx context.Context, in *UpdateObjectRequest, opts ...grpc.CallOption) (*Object, error)
	// Stores a new object and metadata.
	//
	// An object can be written either in a single message stream or in a
	// resumable sequence of message streams. To write using a single stream,
	// the client should include in the first message of the stream an
	// `WriteObjectSpec` describing the destination bucket, object, and any
	// preconditions. Additionally, the final message must set 'finish_write' to
	// true, or else it is an error.
	//
	// For a resumable write, the client should instead call
	// `StartResumableWrite()`, populating a `WriteObjectSpec` into that request.
	// They should then attach the returned `upload_id` to the first message of
	// each following call to `WriteObject`. If the stream is closed before
	// finishing the upload (either explicitly by the client or due to a network
	// error or an error response from the server), the client should do as
	// follows:
	//   - Check the result Status of the stream, to determine if writing can be
	//     resumed on this stream or must be restarted from scratch (by calling
	//     `StartResumableWrite()`). The resumable errors are DEADLINE_EXCEEDED,
	//     INTERNAL, and UNAVAILABLE. For each case, the client should use binary
	//     exponential backoff before retrying.  Additionally, writes can be
	//     resumed after RESOURCE_EXHAUSTED errors, but only after taking
	//     appropriate measures, which may include reducing aggregate send rate
	//     across clients and/or requesting a quota increase for your project.
	//   - If the call to `WriteObject` returns `ABORTED`, that indicates
	//     concurrent attempts to update the resumable write, caused either by
	//     multiple racing clients or by a single client where the previous
	//     request was timed out on the client side but nonetheless reached the
	//     server. In this case the client should take steps to prevent further
	//     concurrent writes (e.g., increase the timeouts, stop using more than
	//     one process to perform the upload, etc.), and then should follow the
	//     steps below for resuming the upload.
	//   - For resumable errors, the client should call `QueryWriteStatus()` and
	//     then continue writing from the returned `persisted_size`. This may be
	//     less than the amount of data the client previously sent. Note also that
	//     it is acceptable to send data starting at an offset earlier than the
	//     returned `persisted_size`; in this case, the service will skip data at
	//     offsets that were already persisted (without checking that it matches
	//     the previously written data), and write only the data starting from the
	//     persisted offset. Even though the data isn't written, it may still
	//     incur a performance cost over resuming at the correct write offset.
	//     This behavior can make client-side handling simpler in some cases.
	//
	// The service will not view the object as complete until the client has
	// sent a `WriteObjectRequest` with `finish_write` set to `true`. Sending any
	// requests on a stream after sending a request with `finish_write` set to
	// `true` will cause an error. The client **should** check the response it
	// receives to determine how much data the service was able to commit and
	// whether the service views the object as complete.
	//
	// Attempting to resume an already finalized object will result in an OK
	// status, with a WriteObjectResponse containing the finalized object's
	// metadata.
	WriteObject(ctx context.Context, opts ...grpc.CallOption) (Storage_WriteObjectClient, error)
	// Retrieves a list of objects matching the criteria.
	ListObjects(ctx context.Context, in *ListObjectsRequest, opts ...grpc.CallOption) (*ListObjectsResponse, error)
	// Rewrites a source object to a destination object. Optionally overrides
	// metadata.
	RewriteObject(ctx context.Context, in *RewriteObjectRequest, opts ...grpc.CallOption) (*RewriteResponse, error)
	// Starts a resumable write. How long the write operation remains valid, and
	// what happens when the write operation becomes invalid, are
	// service-dependent.
	StartResumableWrite(ctx context.Context, in *StartResumableWriteRequest, opts ...grpc.CallOption) (*StartResumableWriteResponse, error)
	// Determines the `persisted_size` for an object that is being written, which
	// can then be used as the `write_offset` for the next `Write()` call.
	//
	// If the object does not exist (i.e., the object has been deleted, or the
	// first `Write()` has not yet reached the service), this method returns the
	// error `NOT_FOUND`.
	//
	// The client **may** call `QueryWriteStatus()` at any time to determine how
	// much data has been processed for this object. This is useful if the
	// client is buffering data and needs to know which data can be safely
	// evicted. For any sequence of `QueryWriteStatus()` calls for a given
	// object name, the sequence of returned `persisted_size` values will be
	// non-decreasing.
	QueryWriteStatus(ctx context.Context, in *QueryWriteStatusRequest, opts ...grpc.CallOption) (*QueryWriteStatusResponse, error)
	// Retrieves the name of a project's Google Cloud Storage service account.
	GetServiceAccount(ctx context.Context, in *GetServiceAccountRequest, opts ...grpc.CallOption) (*ServiceAccount, error)
	// Creates a new HMAC key for the given service account.
	CreateHmacKey(ctx context.Context, in *CreateHmacKeyRequest, opts ...grpc.CallOption) (*CreateHmacKeyResponse, error)
	// Deletes a given HMAC key.  Key must be in an INACTIVE state.
	DeleteHmacKey(ctx context.Context, in *DeleteHmacKeyRequest, opts ...grpc.CallOption) (*emptypb.Empty, error)
	// Gets an existing HMAC key metadata for the given id.
	GetHmacKey(ctx context.Context, in *GetHmacKeyRequest, opts ...grpc.CallOption) (*HmacKeyMetadata, error)
	// Lists HMAC keys under a given project with the additional filters provided.
	ListHmacKeys(ctx context.Context, in *ListHmacKeysRequest, opts ...grpc.CallOption) (*ListHmacKeysResponse, error)
	// Updates a given HMAC key state between ACTIVE and INACTIVE.
	UpdateHmacKey(ctx context.Context, in *UpdateHmacKeyRequest, opts ...grpc.CallOption) (*HmacKeyMetadata, error)
}

StorageClient is the client API for Storage service.

For semantics around ctx use and closing/ending streaming RPCs, please refer to https://godoc.org/google.golang.org/grpc#ClientConn.NewStream.

func NewStorageClient 

func NewStorageClient(cc grpc.ClientConnInterface) StorageClient

type StorageServer 

type StorageServer interface {
	// Permanently deletes an empty bucket.
	DeleteBucket(context.Context, *DeleteBucketRequest) (*emptypb.Empty, error)
	// Returns metadata for the specified bucket.
	GetBucket(context.Context, *GetBucketRequest) (*Bucket, error)
	// Creates a new bucket.
	CreateBucket(context.Context, *CreateBucketRequest) (*Bucket, error)
	// Retrieves a list of buckets for a given project.
	ListBuckets(context.Context, *ListBucketsRequest) (*ListBucketsResponse, error)
	// Locks retention policy on a bucket.
	LockBucketRetentionPolicy(context.Context, *LockBucketRetentionPolicyRequest) (*Bucket, error)
	// Gets the IAM policy for a specified bucket or object.
	// The `resource` field in the request should be
	// projects/_/buckets/<bucket_name> for a bucket or
	// projects/_/buckets/<bucket_name>/objects/<object_name> for an object.
	GetIamPolicy(context.Context, *iampb.GetIamPolicyRequest) (*iampb.Policy, error)
	// Updates an IAM policy for the specified bucket or object.
	// The `resource` field in the request should be
	// projects/_/buckets/<bucket_name> for a bucket or
	// projects/_/buckets/<bucket_name>/objects/<object_name> for an object.
	SetIamPolicy(context.Context, *iampb.SetIamPolicyRequest) (*iampb.Policy, error)
	// Tests a set of permissions on the given bucket or object to see which, if
	// any, are held by the caller.
	// The `resource` field in the request should be
	// projects/_/buckets/<bucket_name> for a bucket or
	// projects/_/buckets/<bucket_name>/objects/<object_name> for an object.
	TestIamPermissions(context.Context, *iampb.TestIamPermissionsRequest) (*iampb.TestIamPermissionsResponse, error)
	// Updates a bucket. Equivalent to JSON API's storage.buckets.patch method.
	UpdateBucket(context.Context, *UpdateBucketRequest) (*Bucket, error)
	// Permanently deletes a NotificationConfig.
	DeleteNotificationConfig(context.Context, *DeleteNotificationConfigRequest) (*emptypb.Empty, error)
	// View a NotificationConfig.
	GetNotificationConfig(context.Context, *GetNotificationConfigRequest) (*NotificationConfig, error)
	// Creates a NotificationConfig for a given bucket.
	// These NotificationConfigs, when triggered, publish messages to the
	// specified Pub/Sub topics. See
	// https://cloud.google.com/storage/docs/pubsub-notifications.
	CreateNotificationConfig(context.Context, *CreateNotificationConfigRequest) (*NotificationConfig, error)
	// Retrieves a list of NotificationConfigs for a given bucket.
	ListNotificationConfigs(context.Context, *ListNotificationConfigsRequest) (*ListNotificationConfigsResponse, error)
	// Concatenates a list of existing objects into a new object in the same
	// bucket.
	ComposeObject(context.Context, *ComposeObjectRequest) (*Object, error)
	// Deletes an object and its metadata. Deletions are permanent if versioning
	// is not enabled for the bucket, or if the `generation` parameter is used.
	DeleteObject(context.Context, *DeleteObjectRequest) (*emptypb.Empty, error)
	// Cancels an in-progress resumable upload.
	CancelResumableWrite(context.Context, *CancelResumableWriteRequest) (*CancelResumableWriteResponse, error)
	// Retrieves an object's metadata.
	GetObject(context.Context, *GetObjectRequest) (*Object, error)
	// Reads an object's data.
	ReadObject(*ReadObjectRequest, Storage_ReadObjectServer) error
	// Updates an object's metadata.
	// Equivalent to JSON API's storage.objects.patch.
	UpdateObject(context.Context, *UpdateObjectRequest) (*Object, error)
	// Stores a new object and metadata.
	//
	// An object can be written either in a single message stream or in a
	// resumable sequence of message streams. To write using a single stream,
	// the client should include in the first message of the stream an
	// `WriteObjectSpec` describing the destination bucket, object, and any
	// preconditions. Additionally, the final message must set 'finish_write' to
	// true, or else it is an error.
	//
	// For a resumable write, the client should instead call
	// `StartResumableWrite()`, populating a `WriteObjectSpec` into that request.
	// They should then attach the returned `upload_id` to the first message of
	// each following call to `WriteObject`. If the stream is closed before
	// finishing the upload (either explicitly by the client or due to a network
	// error or an error response from the server), the client should do as
	// follows:
	//   - Check the result Status of the stream, to determine if writing can be
	//     resumed on this stream or must be restarted from scratch (by calling
	//     `StartResumableWrite()`). The resumable errors are DEADLINE_EXCEEDED,
	//     INTERNAL, and UNAVAILABLE. For each case, the client should use binary
	//     exponential backoff before retrying.  Additionally, writes can be
	//     resumed after RESOURCE_EXHAUSTED errors, but only after taking
	//     appropriate measures, which may include reducing aggregate send rate
	//     across clients and/or requesting a quota increase for your project.
	//   - If the call to `WriteObject` returns `ABORTED`, that indicates
	//     concurrent attempts to update the resumable write, caused either by
	//     multiple racing clients or by a single client where the previous
	//     request was timed out on the client side but nonetheless reached the
	//     server. In this case the client should take steps to prevent further
	//     concurrent writes (e.g., increase the timeouts, stop using more than
	//     one process to perform the upload, etc.), and then should follow the
	//     steps below for resuming the upload.
	//   - For resumable errors, the client should call `QueryWriteStatus()` and
	//     then continue writing from the returned `persisted_size`. This may be
	//     less than the amount of data the client previously sent. Note also that
	//     it is acceptable to send data starting at an offset earlier than the
	//     returned `persisted_size`; in this case, the service will skip data at
	//     offsets that were already persisted (without checking that it matches
	//     the previously written data), and write only the data starting from the
	//     persisted offset. Even though the data isn't written, it may still
	//     incur a performance cost over resuming at the correct write offset.
	//     This behavior can make client-side handling simpler in some cases.
	//
	// The service will not view the object as complete until the client has
	// sent a `WriteObjectRequest` with `finish_write` set to `true`. Sending any
	// requests on a stream after sending a request with `finish_write` set to
	// `true` will cause an error. The client **should** check the response it
	// receives to determine how much data the service was able to commit and
	// whether the service views the object as complete.
	//
	// Attempting to resume an already finalized object will result in an OK
	// status, with a WriteObjectResponse containing the finalized object's
	// metadata.
	WriteObject(Storage_WriteObjectServer) error
	// Retrieves a list of objects matching the criteria.
	ListObjects(context.Context, *ListObjectsRequest) (*ListObjectsResponse, error)
	// Rewrites a source object to a destination object. Optionally overrides
	// metadata.
	RewriteObject(context.Context, *RewriteObjectRequest) (*RewriteResponse, error)
	// Starts a resumable write. How long the write operation remains valid, and
	// what happens when the write operation becomes invalid, are
	// service-dependent.
	StartResumableWrite(context.Context, *StartResumableWriteRequest) (*StartResumableWriteResponse, error)
	// Determines the `persisted_size` for an object that is being written, which
	// can then be used as the `write_offset` for the next `Write()` call.
	//
	// If the object does not exist (i.e., the object has been deleted, or the
	// first `Write()` has not yet reached the service), this method returns the
	// error `NOT_FOUND`.
	//
	// The client **may** call `QueryWriteStatus()` at any time to determine how
	// much data has been processed for this object. This is useful if the
	// client is buffering data and needs to know which data can be safely
	// evicted. For any sequence of `QueryWriteStatus()` calls for a given
	// object name, the sequence of returned `persisted_size` values will be
	// non-decreasing.
	QueryWriteStatus(context.Context, *QueryWriteStatusRequest) (*QueryWriteStatusResponse, error)
	// Retrieves the name of a project's Google Cloud Storage service account.
	GetServiceAccount(context.Context, *GetServiceAccountRequest) (*ServiceAccount, error)
	// Creates a new HMAC key for the given service account.
	CreateHmacKey(context.Context, *CreateHmacKeyRequest) (*CreateHmacKeyResponse, error)
	// Deletes a given HMAC key.  Key must be in an INACTIVE state.
	DeleteHmacKey(context.Context, *DeleteHmacKeyRequest) (*emptypb.Empty, error)
	// Gets an existing HMAC key metadata for the given id.
	GetHmacKey(context.Context, *GetHmacKeyRequest) (*HmacKeyMetadata, error)
	// Lists HMAC keys under a given project with the additional filters provided.
	ListHmacKeys(context.Context, *ListHmacKeysRequest) (*ListHmacKeysResponse, error)
	// Updates a given HMAC key state between ACTIVE and INACTIVE.
	UpdateHmacKey(context.Context, *UpdateHmacKeyRequest) (*HmacKeyMetadata, error)
}

StorageServer is the server API for Storage service.

type Storage_ReadObjectClient 

type Storage_ReadObjectClient interface {
	Recv() (*ReadObjectResponse, error)
	grpc.ClientStream
}

type Storage_ReadObjectServer 

type Storage_ReadObjectServer interface {
	Send(*ReadObjectResponse) error
	grpc.ServerStream
}

type Storage_WriteObjectClient 

type Storage_WriteObjectClient interface {
	Send(*WriteObjectRequest) error
	CloseAndRecv() (*WriteObjectResponse, error)
	grpc.ClientStream
}

type Storage_WriteObjectServer 

type Storage_WriteObjectServer interface {
	SendAndClose(*WriteObjectResponse) error
	Recv() (*WriteObjectRequest, error)
	grpc.ServerStream
}

type UnimplementedStorageServer 

type UnimplementedStorageServer struct {
}

UnimplementedStorageServer can be embedded to have forward compatible implementations.

func (*UnimplementedStorageServer) CancelResumableWrite added in v1.25.0 

func (*UnimplementedStorageServer) CancelResumableWrite(context.Context, *CancelResumableWriteRequest) (*CancelResumableWriteResponse, error)

func (*UnimplementedStorageServer) ComposeObject 

func (*UnimplementedStorageServer) ComposeObject(context.Context, *ComposeObjectRequest) (*Object, error)

func (*UnimplementedStorageServer) CreateBucket 

func (*UnimplementedStorageServer) CreateBucket(context.Context, *CreateBucketRequest) (*Bucket, error)

func (*UnimplementedStorageServer) CreateHmacKey 

func (*UnimplementedStorageServer) CreateHmacKey(context.Context, *CreateHmacKeyRequest) (*CreateHmacKeyResponse, error)

func (*UnimplementedStorageServer) CreateNotificationConfig added in v1.30.0 

func (*UnimplementedStorageServer) CreateNotificationConfig(context.Context, *CreateNotificationConfigRequest) (*NotificationConfig, error)

func (*UnimplementedStorageServer) DeleteBucket 

func (*UnimplementedStorageServer) DeleteBucket(context.Context, *DeleteBucketRequest) (*emptypb.Empty, error)

func (*UnimplementedStorageServer) DeleteHmacKey 

func (*UnimplementedStorageServer) DeleteHmacKey(context.Context, *DeleteHmacKeyRequest) (*emptypb.Empty, error)

func (*UnimplementedStorageServer) DeleteNotificationConfig added in v1.30.0 

func (*UnimplementedStorageServer) DeleteNotificationConfig(context.Context, *DeleteNotificationConfigRequest) (*emptypb.Empty, error)

func (*UnimplementedStorageServer) DeleteObject 

func (*UnimplementedStorageServer) DeleteObject(context.Context, *DeleteObjectRequest) (*emptypb.Empty, error)

func (*UnimplementedStorageServer) GetBucket 

func (*UnimplementedStorageServer) GetBucket(context.Context, *GetBucketRequest) (*Bucket, error)

func (*UnimplementedStorageServer) GetHmacKey 

func (*UnimplementedStorageServer) GetHmacKey(context.Context, *GetHmacKeyRequest) (*HmacKeyMetadata, error)

func (*UnimplementedStorageServer) GetIamPolicy 

func (*UnimplementedStorageServer) GetIamPolicy(context.Context, *iampb.GetIamPolicyRequest) (*iampb.Policy, error)

func (*UnimplementedStorageServer) GetNotificationConfig added in v1.30.0 

func (*UnimplementedStorageServer) GetNotificationConfig(context.Context, *GetNotificationConfigRequest) (*NotificationConfig, error)

func (*UnimplementedStorageServer) GetObject 

func (*UnimplementedStorageServer) GetObject(context.Context, *GetObjectRequest) (*Object, error)

func (*UnimplementedStorageServer) GetServiceAccount 

func (*UnimplementedStorageServer) GetServiceAccount(context.Context, *GetServiceAccountRequest) (*ServiceAccount, error)

func (*UnimplementedStorageServer) ListBuckets 

func (*UnimplementedStorageServer) ListBuckets(context.Context, *ListBucketsRequest) (*ListBucketsResponse, error)

func (*UnimplementedStorageServer) ListHmacKeys 

func (*UnimplementedStorageServer) ListHmacKeys(context.Context, *ListHmacKeysRequest) (*ListHmacKeysResponse, error)

func (*UnimplementedStorageServer) ListNotificationConfigs added in v1.30.0 

func (*UnimplementedStorageServer) ListNotificationConfigs(context.Context, *ListNotificationConfigsRequest) (*ListNotificationConfigsResponse, error)

func (*UnimplementedStorageServer) ListObjects 

func (*UnimplementedStorageServer) ListObjects(context.Context, *ListObjectsRequest) (*ListObjectsResponse, error)

func (*UnimplementedStorageServer) LockBucketRetentionPolicy 

func (*UnimplementedStorageServer) LockBucketRetentionPolicy(context.Context, *LockBucketRetentionPolicyRequest) (*Bucket, error)

func (*UnimplementedStorageServer) QueryWriteStatus 

func (*UnimplementedStorageServer) QueryWriteStatus(context.Context, *QueryWriteStatusRequest) (*QueryWriteStatusResponse, error)

func (*UnimplementedStorageServer) ReadObject 

func (*UnimplementedStorageServer) ReadObject(*ReadObjectRequest, Storage_ReadObjectServer) error

func (*UnimplementedStorageServer) RewriteObject 

func (*UnimplementedStorageServer) RewriteObject(context.Context, *RewriteObjectRequest) (*RewriteResponse, error)

func (*UnimplementedStorageServer) SetIamPolicy 

func (*UnimplementedStorageServer) SetIamPolicy(context.Context, *iampb.SetIamPolicyRequest) (*iampb.Policy, error)

func (*UnimplementedStorageServer) StartResumableWrite 

func (*UnimplementedStorageServer) StartResumableWrite(context.Context, *StartResumableWriteRequest) (*StartResumableWriteResponse, error)

func (*UnimplementedStorageServer) TestIamPermissions 

func (*UnimplementedStorageServer) TestIamPermissions(context.Context, *iampb.TestIamPermissionsRequest) (*iampb.TestIamPermissionsResponse, error)

func (*UnimplementedStorageServer) UpdateBucket 

func (*UnimplementedStorageServer) UpdateBucket(context.Context, *UpdateBucketRequest) (*Bucket, error)

func (*UnimplementedStorageServer) UpdateHmacKey 

func (*UnimplementedStorageServer) UpdateHmacKey(context.Context, *UpdateHmacKeyRequest) (*HmacKeyMetadata, error)

func (*UnimplementedStorageServer) UpdateObject 

func (*UnimplementedStorageServer) UpdateObject(context.Context, *UpdateObjectRequest) (*Object, error)

func (*UnimplementedStorageServer) WriteObject 

func (*UnimplementedStorageServer) WriteObject(Storage_WriteObjectServer) error

type UpdateBucketRequest 

type UpdateBucketRequest struct {

	// Required. The bucket to update.
	// The bucket's `name` field will be used to identify the bucket.
	Bucket *Bucket `protobuf:"bytes,1,opt,name=bucket,proto3" json:"bucket,omitempty"`
	// If set, will only modify the bucket if its metageneration matches this
	// value.
	IfMetagenerationMatch *int64 `` /* 133-byte string literal not displayed */
	// If set, will only modify the bucket if its metageneration does not match
	// this value.
	IfMetagenerationNotMatch *int64 `` /* 144-byte string literal not displayed */
	// Apply a predefined set of access controls to this bucket.
	// Valid values are "authenticatedRead", "private", "projectPrivate",
	// "publicRead", or "publicReadWrite".
	PredefinedAcl string `protobuf:"bytes,8,opt,name=predefined_acl,json=predefinedAcl,proto3" json:"predefined_acl,omitempty"`
	// Apply a predefined set of default object access controls to this bucket.
	// Valid values are "authenticatedRead", "bucketOwnerFullControl",
	// "bucketOwnerRead", "private", "projectPrivate", or "publicRead".
	PredefinedDefaultObjectAcl string `` /* 143-byte string literal not displayed */
	// Required. List of fields to be updated.
	//
	// To specify ALL fields, equivalent to the JSON API's "update" function,
	// specify a single field with the value `*`. Note: not recommended. If a new
	// field is introduced at a later time, an older client updating with the `*`
	// may accidentally reset the new field's value.
	//
	// Not specifying any fields is an error.
	// Not specifying a field while setting that field to a non-default value is
	// an error.
	UpdateMask *fieldmaskpb.FieldMask `protobuf:"bytes,6,opt,name=update_mask,json=updateMask,proto3" json:"update_mask,omitempty"`
	// contains filtered or unexported fields
}

Request for UpdateBucket method.

func (*UpdateBucketRequest) Descriptor deprecated 

func (*UpdateBucketRequest) Descriptor() ([]byte, []int)

Deprecated: Use UpdateBucketRequest.ProtoReflect.Descriptor instead.

func (*UpdateBucketRequest) GetBucket 

func (x *UpdateBucketRequest) GetBucket() *Bucket

func (*UpdateBucketRequest) GetIfMetagenerationMatch 

func (x *UpdateBucketRequest) GetIfMetagenerationMatch() int64

func (*UpdateBucketRequest) GetIfMetagenerationNotMatch 

func (x *UpdateBucketRequest) GetIfMetagenerationNotMatch() int64

func (*UpdateBucketRequest) GetPredefinedAcl 

func (x *UpdateBucketRequest) GetPredefinedAcl() string

func (*UpdateBucketRequest) GetPredefinedDefaultObjectAcl 

func (x *UpdateBucketRequest) GetPredefinedDefaultObjectAcl() string

func (*UpdateBucketRequest) GetUpdateMask 

func (x *UpdateBucketRequest) GetUpdateMask() *fieldmaskpb.FieldMask

func (*UpdateBucketRequest) ProtoMessage 

func (*UpdateBucketRequest) ProtoMessage()

func (*UpdateBucketRequest) ProtoReflect 

func (x *UpdateBucketRequest) ProtoReflect() protoreflect.Message

func (*UpdateBucketRequest) Reset 

func (x *UpdateBucketRequest) Reset()

func (*UpdateBucketRequest) String 

func (x *UpdateBucketRequest) String() string

type UpdateHmacKeyRequest 

type UpdateHmacKeyRequest struct {

	// Required. The HMAC key to update.
	// If present, the hmac_key's `id` field will be used to identify the key.
	// Otherwise, the hmac_key's access_id and project fields will be used to
	// identify the key.
	HmacKey *HmacKeyMetadata `protobuf:"bytes,1,opt,name=hmac_key,json=hmacKey,proto3" json:"hmac_key,omitempty"`
	// Update mask for hmac_key.
	// Not specifying any fields will mean only the `state` field is updated to
	// the value specified in `hmac_key`.
	UpdateMask *fieldmaskpb.FieldMask `protobuf:"bytes,3,opt,name=update_mask,json=updateMask,proto3" json:"update_mask,omitempty"`
	// contains filtered or unexported fields
}

Request object to update an HMAC key state. HmacKeyMetadata.state is required and the only writable field in UpdateHmacKey operation. Specifying fields other than state will result in an error.

func (*UpdateHmacKeyRequest) Descriptor deprecated 

func (*UpdateHmacKeyRequest) Descriptor() ([]byte, []int)

Deprecated: Use UpdateHmacKeyRequest.ProtoReflect.Descriptor instead.

func (*UpdateHmacKeyRequest) GetHmacKey 

func (x *UpdateHmacKeyRequest) GetHmacKey() *HmacKeyMetadata

func (*UpdateHmacKeyRequest) GetUpdateMask 

func (x *UpdateHmacKeyRequest) GetUpdateMask() *fieldmaskpb.FieldMask

func (*UpdateHmacKeyRequest) ProtoMessage 

func (*UpdateHmacKeyRequest) ProtoMessage()

func (*UpdateHmacKeyRequest) ProtoReflect 

func (x *UpdateHmacKeyRequest) ProtoReflect() protoreflect.Message

func (*UpdateHmacKeyRequest) Reset 

func (x *UpdateHmacKeyRequest) Reset()

func (*UpdateHmacKeyRequest) String 

func (x *UpdateHmacKeyRequest) String() string

type UpdateObjectRequest 

type UpdateObjectRequest struct {

	// Required. The object to update.
	// The object's bucket and name fields are used to identify the object to
	// update. If present, the object's generation field selects a specific
	// revision of this object whose metadata should be updated. Otherwise,
	// assumes the live version of the object.
	Object *Object `protobuf:"bytes,1,opt,name=object,proto3" json:"object,omitempty"`
	// 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.
	IfGenerationMatch *int64 `protobuf:"varint,2,opt,name=if_generation_match,json=ifGenerationMatch,proto3,oneof" json:"if_generation_match,omitempty"`
	// Makes the operation conditional on whether the object's live 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.
	IfGenerationNotMatch *int64 `` /* 132-byte string literal not displayed */
	// Makes the operation conditional on whether the object's current
	// metageneration matches the given value.
	IfMetagenerationMatch *int64 `` /* 133-byte string literal not displayed */
	// Makes the operation conditional on whether the object's current
	// metageneration does not match the given value.
	IfMetagenerationNotMatch *int64 `` /* 144-byte string literal not displayed */
	// Apply a predefined set of access controls to this object.
	// Valid values are "authenticatedRead", "bucketOwnerFullControl",
	// "bucketOwnerRead", "private", "projectPrivate", or "publicRead".
	PredefinedAcl string `protobuf:"bytes,10,opt,name=predefined_acl,json=predefinedAcl,proto3" json:"predefined_acl,omitempty"`
	// Required. List of fields to be updated.
	//
	// To specify ALL fields, equivalent to the JSON API's "update" function,
	// specify a single field with the value `*`. Note: not recommended. If a new
	// field is introduced at a later time, an older client updating with the `*`
	// may accidentally reset the new field's value.
	//
	// Not specifying any fields is an error.
	// Not specifying a field while setting that field to a non-default value is
	// an error.
	UpdateMask *fieldmaskpb.FieldMask `protobuf:"bytes,7,opt,name=update_mask,json=updateMask,proto3" json:"update_mask,omitempty"`
	// A set of parameters common to Storage API requests concerning an object.
	CommonObjectRequestParams *CommonObjectRequestParams `` /* 140-byte string literal not displayed */
	// contains filtered or unexported fields
}

Request message for UpdateObject.

func (*UpdateObjectRequest) Descriptor deprecated 

func (*UpdateObjectRequest) Descriptor() ([]byte, []int)

Deprecated: Use UpdateObjectRequest.ProtoReflect.Descriptor instead.

func (*UpdateObjectRequest) GetCommonObjectRequestParams 

func (x *UpdateObjectRequest) GetCommonObjectRequestParams() *CommonObjectRequestParams

func (*UpdateObjectRequest) GetIfGenerationMatch 

func (x *UpdateObjectRequest) GetIfGenerationMatch() int64

func (*UpdateObjectRequest) GetIfGenerationNotMatch 

func (x *UpdateObjectRequest) GetIfGenerationNotMatch() int64

func (*UpdateObjectRequest) GetIfMetagenerationMatch 

func (x *UpdateObjectRequest) GetIfMetagenerationMatch() int64

func (*UpdateObjectRequest) GetIfMetagenerationNotMatch 

func (x *UpdateObjectRequest) GetIfMetagenerationNotMatch() int64

func (*UpdateObjectRequest) GetObject 

func (x *UpdateObjectRequest) GetObject() *Object

func (*UpdateObjectRequest) GetPredefinedAcl 

func (x *UpdateObjectRequest) GetPredefinedAcl() string

func (*UpdateObjectRequest) GetUpdateMask 

func (x *UpdateObjectRequest) GetUpdateMask() *fieldmaskpb.FieldMask

func (*UpdateObjectRequest) ProtoMessage 

func (*UpdateObjectRequest) ProtoMessage()

func (*UpdateObjectRequest) ProtoReflect 

func (x *UpdateObjectRequest) ProtoReflect() protoreflect.Message

func (*UpdateObjectRequest) Reset 

func (x *UpdateObjectRequest) Reset()

func (*UpdateObjectRequest) String 

func (x *UpdateObjectRequest) String() string

type WriteObjectRequest 

type WriteObjectRequest struct {

	// The first message of each stream should set one of the following.
	//
	// Types that are assignable to FirstMessage:
	//
	//	*WriteObjectRequest_UploadId
	//	*WriteObjectRequest_WriteObjectSpec
	FirstMessage isWriteObjectRequest_FirstMessage `protobuf_oneof:"first_message"`
	// Required. The offset from the beginning of the object at which the data
	// should be written.
	//
	// In the first `WriteObjectRequest` of a `WriteObject()` action, it
	// indicates the initial offset for the `Write()` call. The value **must** be
	// equal to the `persisted_size` that a call to `QueryWriteStatus()` would
	// return (0 if this is the first write to the object).
	//
	// On subsequent calls, this value **must** be no larger than the sum of the
	// first `write_offset` and the sizes of all `data` chunks sent previously on
	// this stream.
	//
	// An incorrect value will cause an error.
	WriteOffset int64 `protobuf:"varint,3,opt,name=write_offset,json=writeOffset,proto3" json:"write_offset,omitempty"`
	// A portion of the data for the object.
	//
	// Types that are assignable to Data:
	//
	//	*WriteObjectRequest_ChecksummedData
	Data isWriteObjectRequest_Data `protobuf_oneof:"data"`
	// Checksums for the complete object. If the checksums computed by the service
	// don't match the specifified checksums the call will fail. May only be
	// provided in the first or last request (either with first_message, or
	// finish_write set).
	ObjectChecksums *ObjectChecksums `protobuf:"bytes,6,opt,name=object_checksums,json=objectChecksums,proto3" json:"object_checksums,omitempty"`
	// If `true`, this indicates that the write is complete. Sending any
	// `WriteObjectRequest`s subsequent to one in which `finish_write` is `true`
	// will cause an error.
	// For a non-resumable write (where the upload_id was not set in the first
	// message), it is an error not to set this field in the final message of the
	// stream.
	FinishWrite bool `protobuf:"varint,7,opt,name=finish_write,json=finishWrite,proto3" json:"finish_write,omitempty"`
	// A set of parameters common to Storage API requests concerning an object.
	CommonObjectRequestParams *CommonObjectRequestParams `` /* 140-byte string literal not displayed */
	// contains filtered or unexported fields
}

Request message for WriteObject.

func (*WriteObjectRequest) Descriptor deprecated 

func (*WriteObjectRequest) Descriptor() ([]byte, []int)

Deprecated: Use WriteObjectRequest.ProtoReflect.Descriptor instead.

func (*WriteObjectRequest) GetChecksummedData 

func (x *WriteObjectRequest) GetChecksummedData() *ChecksummedData

func (*WriteObjectRequest) GetCommonObjectRequestParams 

func (x *WriteObjectRequest) GetCommonObjectRequestParams() *CommonObjectRequestParams

func (*WriteObjectRequest) GetData 

func (m *WriteObjectRequest) GetData() isWriteObjectRequest_Data

func (*WriteObjectRequest) GetFinishWrite 

func (x *WriteObjectRequest) GetFinishWrite() bool

func (*WriteObjectRequest) GetFirstMessage 

func (m *WriteObjectRequest) GetFirstMessage() isWriteObjectRequest_FirstMessage

func (*WriteObjectRequest) GetObjectChecksums 

func (x *WriteObjectRequest) GetObjectChecksums() *ObjectChecksums

func (*WriteObjectRequest) GetUploadId 

func (x *WriteObjectRequest) GetUploadId() string

func (*WriteObjectRequest) GetWriteObjectSpec 

func (x *WriteObjectRequest) GetWriteObjectSpec() *WriteObjectSpec

func (*WriteObjectRequest) GetWriteOffset 

func (x *WriteObjectRequest) GetWriteOffset() int64

func (*WriteObjectRequest) ProtoMessage 

func (*WriteObjectRequest) ProtoMessage()

func (*WriteObjectRequest) ProtoReflect 

func (x *WriteObjectRequest) ProtoReflect() protoreflect.Message

func (*WriteObjectRequest) Reset 

func (x *WriteObjectRequest) Reset()

func (*WriteObjectRequest) String 

func (x *WriteObjectRequest) String() string

type WriteObjectRequest_ChecksummedData 

type WriteObjectRequest_ChecksummedData struct {
	// The data to insert. If a crc32c checksum is provided that doesn't match
	// the checksum computed by the service, the request will fail.
	ChecksummedData *ChecksummedData `protobuf:"bytes,4,opt,name=checksummed_data,json=checksummedData,proto3,oneof"`
}

type WriteObjectRequest_UploadId 

type WriteObjectRequest_UploadId struct {
	// For resumable uploads. This should be the `upload_id` returned from a
	// call to `StartResumableWriteResponse`.
	UploadId string `protobuf:"bytes,1,opt,name=upload_id,json=uploadId,proto3,oneof"`
}

type WriteObjectRequest_WriteObjectSpec 

type WriteObjectRequest_WriteObjectSpec struct {
	// For non-resumable uploads. Describes the overall upload, including the
	// destination bucket and object name, preconditions, etc.
	WriteObjectSpec *WriteObjectSpec `protobuf:"bytes,2,opt,name=write_object_spec,json=writeObjectSpec,proto3,oneof"`
}

type WriteObjectResponse 

type WriteObjectResponse struct {

	// The response will set one of the following.
	//
	// Types that are assignable to WriteStatus:
	//
	//	*WriteObjectResponse_PersistedSize
	//	*WriteObjectResponse_Resource
	WriteStatus isWriteObjectResponse_WriteStatus `protobuf_oneof:"write_status"`
	// contains filtered or unexported fields
}

Response message for WriteObject.

func (*WriteObjectResponse) Descriptor deprecated 

func (*WriteObjectResponse) Descriptor() ([]byte, []int)

Deprecated: Use WriteObjectResponse.ProtoReflect.Descriptor instead.

func (*WriteObjectResponse) GetPersistedSize 

func (x *WriteObjectResponse) GetPersistedSize() int64

func (*WriteObjectResponse) GetResource 

func (x *WriteObjectResponse) GetResource() *Object

func (*WriteObjectResponse) GetWriteStatus 

func (m *WriteObjectResponse) GetWriteStatus() isWriteObjectResponse_WriteStatus

func (*WriteObjectResponse) ProtoMessage 

func (*WriteObjectResponse) ProtoMessage()

func (*WriteObjectResponse) ProtoReflect 

func (x *WriteObjectResponse) ProtoReflect() protoreflect.Message

func (*WriteObjectResponse) Reset 

func (x *WriteObjectResponse) Reset()

func (*WriteObjectResponse) String 

func (x *WriteObjectResponse) String() string

type WriteObjectResponse_PersistedSize 

type WriteObjectResponse_PersistedSize struct {
	// The total number of bytes that have been processed for the given object
	// from all `WriteObject` calls. Only set if the upload has not finalized.
	PersistedSize int64 `protobuf:"varint,1,opt,name=persisted_size,json=persistedSize,proto3,oneof"`
}

type WriteObjectResponse_Resource 

type WriteObjectResponse_Resource struct {
	// A resource containing the metadata for the uploaded object. Only set if
	// the upload has finalized.
	Resource *Object `protobuf:"bytes,2,opt,name=resource,proto3,oneof"`
}

type WriteObjectSpec 

type WriteObjectSpec struct {

	// Required. Destination object, including its name and its metadata.
	Resource *Object `protobuf:"bytes,1,opt,name=resource,proto3" json:"resource,omitempty"`
	// Apply a predefined set of access controls to this object.
	// Valid values are "authenticatedRead", "bucketOwnerFullControl",
	// "bucketOwnerRead", "private", "projectPrivate", or "publicRead".
	PredefinedAcl string `protobuf:"bytes,7,opt,name=predefined_acl,json=predefinedAcl,proto3" json:"predefined_acl,omitempty"`
	// 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.
	IfGenerationMatch *int64 `protobuf:"varint,3,opt,name=if_generation_match,json=ifGenerationMatch,proto3,oneof" json:"if_generation_match,omitempty"`
	// Makes the operation conditional on whether the object's live
	// 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.
	IfGenerationNotMatch *int64 `` /* 132-byte string literal not displayed */
	// Makes the operation conditional on whether the object's current
	// metageneration matches the given value.
	IfMetagenerationMatch *int64 `` /* 133-byte string literal not displayed */
	// Makes the operation conditional on whether the object's current
	// metageneration does not match the given value.
	IfMetagenerationNotMatch *int64 `` /* 144-byte string literal not displayed */
	// The expected final object size being uploaded.
	// If this value is set, closing the stream after writing fewer or more than
	// `object_size` bytes will result in an OUT_OF_RANGE error.
	//
	// This situation is considered a client error, and if such an error occurs
	// you must start the upload over from scratch, this time sending the correct
	// number of bytes.
	//
	// The `object_size` value is ignored for one-shot (non-resumable) writes.
	ObjectSize *int64 `protobuf:"varint,8,opt,name=object_size,json=objectSize,proto3,oneof" json:"object_size,omitempty"`
	// contains filtered or unexported fields
}

Describes an attempt to insert an object, possibly over multiple requests.

func (*WriteObjectSpec) Descriptor deprecated 

func (*WriteObjectSpec) Descriptor() ([]byte, []int)

Deprecated: Use WriteObjectSpec.ProtoReflect.Descriptor instead.

func (*WriteObjectSpec) GetIfGenerationMatch 

func (x *WriteObjectSpec) GetIfGenerationMatch() int64

func (*WriteObjectSpec) GetIfGenerationNotMatch 

func (x *WriteObjectSpec) GetIfGenerationNotMatch() int64

func (*WriteObjectSpec) GetIfMetagenerationMatch 

func (x *WriteObjectSpec) GetIfMetagenerationMatch() int64

func (*WriteObjectSpec) GetIfMetagenerationNotMatch 

func (x *WriteObjectSpec) GetIfMetagenerationNotMatch() int64

func (*WriteObjectSpec) GetObjectSize added in v1.25.0 

func (x *WriteObjectSpec) GetObjectSize() int64

func (*WriteObjectSpec) GetPredefinedAcl 

func (x *WriteObjectSpec) GetPredefinedAcl() string

func (*WriteObjectSpec) GetResource 

func (x *WriteObjectSpec) GetResource() *Object

func (*WriteObjectSpec) ProtoMessage 

func (*WriteObjectSpec) ProtoMessage()

func (*WriteObjectSpec) ProtoReflect 

func (x *WriteObjectSpec) ProtoReflect() protoreflect.Message

func (*WriteObjectSpec) Reset 

func (x *WriteObjectSpec) Reset()

func (*WriteObjectSpec) String 

func (x *WriteObjectSpec) String() string

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.