Enum value maps for ServiceConstants_Values.
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,
}
)
var File_google_storage_v2_storage_proto protoreflect.FileDescriptor
func RegisterStorageServer(s *grpc.Server, srv StorageServer)
A 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.
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 iamConfig.uniformBucketLevelAccess 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 iamConfig.uniformBucketLevelAccess 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 `protobuf:"varint,14,opt,name=default_event_based_hold,json=defaultEventBasedHold,proto3" json:"default_event_based_hold,omitempty"`
// User-provided labels, in key/value pairs.
Labels map[string]string `protobuf:"bytes,15,rep,name=labels,proto3" json:"labels,omitempty" protobuf_key:"bytes,1,opt,name=key,proto3" protobuf_val:"bytes,2,opt,name=value,proto3"`
// 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 Custom
// Dual Region.
CustomPlacementConfig *Bucket_CustomPlacementConfig `protobuf:"bytes,26,opt,name=custom_placement_config,json=customPlacementConfig,proto3" json:"custom_placement_config,omitempty"`
// 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
}
func (*Bucket) Descriptor() ([]byte, []int)
Deprecated: Use Bucket.ProtoReflect.Descriptor instead.
func (x *Bucket) GetAcl() []*BucketAccessControl
func (x *Bucket) GetAutoclass() *Bucket_Autoclass
func (x *Bucket) GetBilling() *Bucket_Billing
func (x *Bucket) GetBucketId() string
func (x *Bucket) GetCors() []*Bucket_Cors
func (x *Bucket) GetCreateTime() *timestamppb.Timestamp
func (x *Bucket) GetCustomPlacementConfig() *Bucket_CustomPlacementConfig
func (x *Bucket) GetDefaultEventBasedHold() bool
func (x *Bucket) GetDefaultObjectAcl() []*ObjectAccessControl
func (x *Bucket) GetEncryption() *Bucket_Encryption
func (x *Bucket) GetEtag() string
func (x *Bucket) GetIamConfig() *Bucket_IamConfig
func (x *Bucket) GetLabels() map[string]string
func (x *Bucket) GetLifecycle() *Bucket_Lifecycle
func (x *Bucket) GetLocation() string
func (x *Bucket) GetLocationType() string
func (x *Bucket) GetLogging() *Bucket_Logging
func (x *Bucket) GetMetageneration() int64
func (x *Bucket) GetName() string
func (x *Bucket) GetOwner() *Owner
func (x *Bucket) GetProject() string
func (x *Bucket) GetRetentionPolicy() *Bucket_RetentionPolicy
func (x *Bucket) GetRpo() string
func (x *Bucket) GetSatisfiesPzs() bool
func (x *Bucket) GetStorageClass() string
func (x *Bucket) GetUpdateTime() *timestamppb.Timestamp
func (x *Bucket) GetVersioning() *Bucket_Versioning
func (x *Bucket) GetWebsite() *Bucket_Website
func (*Bucket) ProtoMessage()
func (x *Bucket) ProtoReflect() protoreflect.Message
func (x *Bucket) Reset()
func (x *Bucket) String() string
An access-control entry.
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-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`
Entity string `protobuf:"bytes,3,opt,name=entity,proto3" json:"entity,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
}
func (*BucketAccessControl) Descriptor() ([]byte, []int)
Deprecated: Use BucketAccessControl.ProtoReflect.Descriptor instead.
func (x *BucketAccessControl) GetDomain() string
func (x *BucketAccessControl) GetEmail() string
func (x *BucketAccessControl) GetEntity() string
func (x *BucketAccessControl) GetEntityId() string
func (x *BucketAccessControl) GetEtag() string
func (x *BucketAccessControl) GetId() string
func (x *BucketAccessControl) GetProjectTeam() *ProjectTeam
func (x *BucketAccessControl) GetRole() string
func (*BucketAccessControl) ProtoMessage()
func (x *BucketAccessControl) ProtoReflect() protoreflect.Message
func (x *BucketAccessControl) Reset()
func (x *BucketAccessControl) String() string
Configuration for a bucket's Autoclass feature.
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
}
func (*Bucket_Autoclass) Descriptor() ([]byte, []int)
Deprecated: Use Bucket_Autoclass.ProtoReflect.Descriptor instead.
func (x *Bucket_Autoclass) GetEnabled() bool
func (x *Bucket_Autoclass) GetToggleTime() *timestamppb.Timestamp
func (*Bucket_Autoclass) ProtoMessage()
func (x *Bucket_Autoclass) ProtoReflect() protoreflect.Message
func (x *Bucket_Autoclass) Reset()
func (x *Bucket_Autoclass) String() string
Billing properties of a bucket.
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
}
func (*Bucket_Billing) Descriptor() ([]byte, []int)
Deprecated: Use Bucket_Billing.ProtoReflect.Descriptor instead.
func (x *Bucket_Billing) GetRequesterPays() bool
func (*Bucket_Billing) ProtoMessage()
func (x *Bucket_Billing) ProtoReflect() protoreflect.Message
func (x *Bucket_Billing) Reset()
func (x *Bucket_Billing) String() string
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.
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
}
func (*Bucket_Cors) Descriptor() ([]byte, []int)
Deprecated: Use Bucket_Cors.ProtoReflect.Descriptor instead.
func (x *Bucket_Cors) GetMaxAgeSeconds() int32
func (x *Bucket_Cors) GetMethod() []string
func (x *Bucket_Cors) GetOrigin() []string
func (x *Bucket_Cors) GetResponseHeader() []string
func (*Bucket_Cors) ProtoMessage()
func (x *Bucket_Cors) ProtoReflect() protoreflect.Message
func (x *Bucket_Cors) Reset()
func (x *Bucket_Cors) String() string
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].
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
}
func (*Bucket_CustomPlacementConfig) Descriptor() ([]byte, []int)
Deprecated: Use Bucket_CustomPlacementConfig.ProtoReflect.Descriptor instead.
func (x *Bucket_CustomPlacementConfig) GetDataLocations() []string
func (*Bucket_CustomPlacementConfig) ProtoMessage()
func (x *Bucket_CustomPlacementConfig) ProtoReflect() protoreflect.Message
func (x *Bucket_CustomPlacementConfig) Reset()
func (x *Bucket_CustomPlacementConfig) String() string
Encryption properties of a bucket.
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
}
func (*Bucket_Encryption) Descriptor() ([]byte, []int)
Deprecated: Use Bucket_Encryption.ProtoReflect.Descriptor instead.
func (x *Bucket_Encryption) GetDefaultKmsKey() string
func (*Bucket_Encryption) ProtoMessage()
func (x *Bucket_Encryption) ProtoReflect() protoreflect.Message
func (x *Bucket_Encryption) Reset()
func (x *Bucket_Encryption) String() string
Bucket restriction options.
type Bucket_IamConfig struct {
// Bucket restriction options currently enforced on the bucket.
UniformBucketLevelAccess *Bucket_IamConfig_UniformBucketLevelAccess `protobuf:"bytes,1,opt,name=uniform_bucket_level_access,json=uniformBucketLevelAccess,proto3" json:"uniform_bucket_level_access,omitempty"`
// Whether IAM will enforce public access prevention. Valid values are
// "enforced" or "inherited".
PublicAccessPrevention string `protobuf:"bytes,3,opt,name=public_access_prevention,json=publicAccessPrevention,proto3" json:"public_access_prevention,omitempty"`
// contains filtered or unexported fields
}
func (*Bucket_IamConfig) Descriptor() ([]byte, []int)
Deprecated: Use Bucket_IamConfig.ProtoReflect.Descriptor instead.
func (x *Bucket_IamConfig) GetPublicAccessPrevention() string
func (x *Bucket_IamConfig) GetUniformBucketLevelAccess() *Bucket_IamConfig_UniformBucketLevelAccess
func (*Bucket_IamConfig) ProtoMessage()
func (x *Bucket_IamConfig) ProtoReflect() protoreflect.Message
func (x *Bucket_IamConfig) Reset()
func (x *Bucket_IamConfig) String() string
Settings for Uniform Bucket level access. See https://cloud.google.com/storage/docs/uniform-bucket-level-access.
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
// `iamConfig.uniformBucketLevelAccess.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
}
func (*Bucket_IamConfig_UniformBucketLevelAccess) Descriptor() ([]byte, []int)
Deprecated: Use Bucket_IamConfig_UniformBucketLevelAccess.ProtoReflect.Descriptor instead.
func (x *Bucket_IamConfig_UniformBucketLevelAccess) GetEnabled() bool
func (x *Bucket_IamConfig_UniformBucketLevelAccess) GetLockTime() *timestamppb.Timestamp
func (*Bucket_IamConfig_UniformBucketLevelAccess) ProtoMessage()
func (x *Bucket_IamConfig_UniformBucketLevelAccess) ProtoReflect() protoreflect.Message
func (x *Bucket_IamConfig_UniformBucketLevelAccess) Reset()
func (x *Bucket_IamConfig_UniformBucketLevelAccess) String() string
Lifecycle properties of a bucket. For more information, see https://cloud.google.com/storage/docs/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
}
func (*Bucket_Lifecycle) Descriptor() ([]byte, []int)
Deprecated: Use Bucket_Lifecycle.ProtoReflect.Descriptor instead.
func (x *Bucket_Lifecycle) GetRule() []*Bucket_Lifecycle_Rule
func (*Bucket_Lifecycle) ProtoMessage()
func (x *Bucket_Lifecycle) ProtoReflect() protoreflect.Message
func (x *Bucket_Lifecycle) Reset()
func (x *Bucket_Lifecycle) String() string
A lifecycle Rule, combining an action to take on an object and a condition which will trigger that action.
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
}
func (*Bucket_Lifecycle_Rule) Descriptor() ([]byte, []int)
Deprecated: Use Bucket_Lifecycle_Rule.ProtoReflect.Descriptor instead.
func (x *Bucket_Lifecycle_Rule) GetAction() *Bucket_Lifecycle_Rule_Action
func (x *Bucket_Lifecycle_Rule) GetCondition() *Bucket_Lifecycle_Rule_Condition
func (*Bucket_Lifecycle_Rule) ProtoMessage()
func (x *Bucket_Lifecycle_Rule) ProtoReflect() protoreflect.Message
func (x *Bucket_Lifecycle_Rule) Reset()
func (x *Bucket_Lifecycle_Rule) String() string
An action to take on an object.
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
}
func (*Bucket_Lifecycle_Rule_Action) Descriptor() ([]byte, []int)
Deprecated: Use Bucket_Lifecycle_Rule_Action.ProtoReflect.Descriptor instead.
func (x *Bucket_Lifecycle_Rule_Action) GetStorageClass() string
func (x *Bucket_Lifecycle_Rule_Action) GetType() string
func (*Bucket_Lifecycle_Rule_Action) ProtoMessage()
func (x *Bucket_Lifecycle_Rule_Action) ProtoReflect() protoreflect.Message
func (x *Bucket_Lifecycle_Rule_Action) Reset()
func (x *Bucket_Lifecycle_Rule_Action) String() string
A condition of an object which triggers some action.
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 `protobuf:"varint,7,opt,name=days_since_custom_time,json=daysSinceCustomTime,proto3,oneof" json:"days_since_custom_time,omitempty"`
// 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 `protobuf:"varint,9,opt,name=days_since_noncurrent_time,json=daysSinceNoncurrentTime,proto3,oneof" json:"days_since_noncurrent_time,omitempty"`
// 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
}
func (*Bucket_Lifecycle_Rule_Condition) Descriptor() ([]byte, []int)
Deprecated: Use Bucket_Lifecycle_Rule_Condition.ProtoReflect.Descriptor instead.
func (x *Bucket_Lifecycle_Rule_Condition) GetAgeDays() int32
func (x *Bucket_Lifecycle_Rule_Condition) GetCreatedBefore() *date.Date
func (x *Bucket_Lifecycle_Rule_Condition) GetCustomTimeBefore() *date.Date
func (x *Bucket_Lifecycle_Rule_Condition) GetDaysSinceCustomTime() int32
func (x *Bucket_Lifecycle_Rule_Condition) GetDaysSinceNoncurrentTime() int32
func (x *Bucket_Lifecycle_Rule_Condition) GetIsLive() bool
func (x *Bucket_Lifecycle_Rule_Condition) GetMatchesPrefix() []string
func (x *Bucket_Lifecycle_Rule_Condition) GetMatchesStorageClass() []string
func (x *Bucket_Lifecycle_Rule_Condition) GetMatchesSuffix() []string
func (x *Bucket_Lifecycle_Rule_Condition) GetNoncurrentTimeBefore() *date.Date
func (x *Bucket_Lifecycle_Rule_Condition) GetNumNewerVersions() int32
func (*Bucket_Lifecycle_Rule_Condition) ProtoMessage()
func (x *Bucket_Lifecycle_Rule_Condition) ProtoReflect() protoreflect.Message
func (x *Bucket_Lifecycle_Rule_Condition) Reset()
func (x *Bucket_Lifecycle_Rule_Condition) String() string
Logging-related properties of a bucket.
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
}
func (*Bucket_Logging) Descriptor() ([]byte, []int)
Deprecated: Use Bucket_Logging.ProtoReflect.Descriptor instead.
func (x *Bucket_Logging) GetLogBucket() string
func (x *Bucket_Logging) GetLogObjectPrefix() string
func (*Bucket_Logging) ProtoMessage()
func (x *Bucket_Logging) ProtoReflect() protoreflect.Message
func (x *Bucket_Logging) Reset()
func (x *Bucket_Logging) String() string
Retention policy properties of a bucket.
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" json:"retention_period,omitempty"`
// contains filtered or unexported fields
}
func (*Bucket_RetentionPolicy) Descriptor() ([]byte, []int)
Deprecated: Use Bucket_RetentionPolicy.ProtoReflect.Descriptor instead.
func (x *Bucket_RetentionPolicy) GetEffectiveTime() *timestamppb.Timestamp
func (x *Bucket_RetentionPolicy) GetIsLocked() bool
func (x *Bucket_RetentionPolicy) GetRetentionPeriod() int64
func (*Bucket_RetentionPolicy) ProtoMessage()
func (x *Bucket_RetentionPolicy) ProtoReflect() protoreflect.Message
func (x *Bucket_RetentionPolicy) Reset()
func (x *Bucket_RetentionPolicy) String() string
Properties of a bucket related to versioning. For more on Cloud Storage versioning, see https://cloud.google.com/storage/docs/object-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
}
func (*Bucket_Versioning) Descriptor() ([]byte, []int)
Deprecated: Use Bucket_Versioning.ProtoReflect.Descriptor instead.
func (x *Bucket_Versioning) GetEnabled() bool
func (*Bucket_Versioning) ProtoMessage()
func (x *Bucket_Versioning) ProtoReflect() protoreflect.Message
func (x *Bucket_Versioning) Reset()
func (x *Bucket_Versioning) String() string
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.
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
}
func (*Bucket_Website) Descriptor() ([]byte, []int)
Deprecated: Use Bucket_Website.ProtoReflect.Descriptor instead.
func (x *Bucket_Website) GetMainPageSuffix() string
func (x *Bucket_Website) GetNotFoundPage() string
func (*Bucket_Website) ProtoMessage()
func (x *Bucket_Website) ProtoReflect() protoreflect.Message
func (x *Bucket_Website) Reset()
func (x *Bucket_Website) String() string
Message used to convey content being read or written, along with an optional checksum.
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
}
func (*ChecksummedData) Descriptor() ([]byte, []int)
Deprecated: Use ChecksummedData.ProtoReflect.Descriptor instead.
func (x *ChecksummedData) GetContent() []byte
func (x *ChecksummedData) GetCrc32C() uint32
func (*ChecksummedData) ProtoMessage()
func (x *ChecksummedData) ProtoReflect() protoreflect.Message
func (x *ChecksummedData) Reset()
func (x *ChecksummedData) String() string
Parameters that can be passed to any object request.
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 `protobuf:"bytes,5,opt,name=encryption_key_sha256_bytes,json=encryptionKeySha256Bytes,proto3" json:"encryption_key_sha256_bytes,omitempty"`
// contains filtered or unexported fields
}
func (*CommonObjectRequestParams) Descriptor() ([]byte, []int)
Deprecated: Use CommonObjectRequestParams.ProtoReflect.Descriptor instead.
func (x *CommonObjectRequestParams) GetEncryptionAlgorithm() string
func (x *CommonObjectRequestParams) GetEncryptionKeyBytes() []byte
func (x *CommonObjectRequestParams) GetEncryptionKeySha256Bytes() []byte
func (*CommonObjectRequestParams) ProtoMessage()
func (x *CommonObjectRequestParams) ProtoReflect() protoreflect.Message
func (x *CommonObjectRequestParams) Reset()
func (x *CommonObjectRequestParams) String() string
Request message for ComposeObject.
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 `protobuf:"bytes,9,opt,name=destination_predefined_acl,json=destinationPredefinedAcl,proto3" json:"destination_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,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 `protobuf:"varint,5,opt,name=if_metageneration_match,json=ifMetagenerationMatch,proto3,oneof" json:"if_metageneration_match,omitempty"`
// 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 `protobuf:"bytes,7,opt,name=common_object_request_params,json=commonObjectRequestParams,proto3" json:"common_object_request_params,omitempty"`
// contains filtered or unexported fields
}
func (*ComposeObjectRequest) Descriptor() ([]byte, []int)
Deprecated: Use ComposeObjectRequest.ProtoReflect.Descriptor instead.
func (x *ComposeObjectRequest) GetCommonObjectRequestParams() *CommonObjectRequestParams
func (x *ComposeObjectRequest) GetDestination() *Object
func (x *ComposeObjectRequest) GetDestinationPredefinedAcl() string
func (x *ComposeObjectRequest) GetIfGenerationMatch() int64
func (x *ComposeObjectRequest) GetIfMetagenerationMatch() int64
func (x *ComposeObjectRequest) GetKmsKey() string
func (x *ComposeObjectRequest) GetSourceObjects() []*ComposeObjectRequest_SourceObject
func (*ComposeObjectRequest) ProtoMessage()
func (x *ComposeObjectRequest) ProtoReflect() protoreflect.Message
func (x *ComposeObjectRequest) Reset()
func (x *ComposeObjectRequest) String() string
Description of a source object for a composition request.
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
}
func (*ComposeObjectRequest_SourceObject) Descriptor() ([]byte, []int)
Deprecated: Use ComposeObjectRequest_SourceObject.ProtoReflect.Descriptor instead.
func (x *ComposeObjectRequest_SourceObject) GetGeneration() int64
func (x *ComposeObjectRequest_SourceObject) GetName() string
func (x *ComposeObjectRequest_SourceObject) GetObjectPreconditions() *ComposeObjectRequest_SourceObject_ObjectPreconditions
func (*ComposeObjectRequest_SourceObject) ProtoMessage()
func (x *ComposeObjectRequest_SourceObject) ProtoReflect() protoreflect.Message
func (x *ComposeObjectRequest_SourceObject) Reset()
func (x *ComposeObjectRequest_SourceObject) String() string
Preconditions for a source object of a composition request.
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
}
func (*ComposeObjectRequest_SourceObject_ObjectPreconditions) Descriptor() ([]byte, []int)
Deprecated: Use ComposeObjectRequest_SourceObject_ObjectPreconditions.ProtoReflect.Descriptor instead.
func (x *ComposeObjectRequest_SourceObject_ObjectPreconditions) GetIfGenerationMatch() int64
func (*ComposeObjectRequest_SourceObject_ObjectPreconditions) ProtoMessage()
func (x *ComposeObjectRequest_SourceObject_ObjectPreconditions) ProtoReflect() protoreflect.Message
func (x *ComposeObjectRequest_SourceObject_ObjectPreconditions) Reset()
func (x *ComposeObjectRequest_SourceObject_ObjectPreconditions) String() string
Specifies a requested range of bytes to download.
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
}
func (*ContentRange) Descriptor() ([]byte, []int)
Deprecated: Use ContentRange.ProtoReflect.Descriptor instead.
func (x *ContentRange) GetCompleteLength() int64
func (x *ContentRange) GetEnd() int64
func (x *ContentRange) GetStart() int64
func (*ContentRange) ProtoMessage()
func (x *ContentRange) ProtoReflect() protoreflect.Message
func (x *ContentRange) Reset()
func (x *ContentRange) String() string
Request message for CreateBucket.
type CreateBucketRequest struct {
// Required. The project to which this bucket will belong.
Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
// Required. 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 `protobuf:"bytes,7,opt,name=predefined_default_object_acl,json=predefinedDefaultObjectAcl,proto3" json:"predefined_default_object_acl,omitempty"`
// contains filtered or unexported fields
}
func (*CreateBucketRequest) Descriptor() ([]byte, []int)
Deprecated: Use CreateBucketRequest.ProtoReflect.Descriptor instead.
func (x *CreateBucketRequest) GetBucket() *Bucket
func (x *CreateBucketRequest) GetBucketId() string
func (x *CreateBucketRequest) GetParent() string
func (x *CreateBucketRequest) GetPredefinedAcl() string
func (x *CreateBucketRequest) GetPredefinedDefaultObjectAcl() string
func (*CreateBucketRequest) ProtoMessage()
func (x *CreateBucketRequest) ProtoReflect() protoreflect.Message
func (x *CreateBucketRequest) Reset()
func (x *CreateBucketRequest) String() string
Request message for CreateHmacKey.
type CreateHmacKeyRequest struct {
// Required. The project that the HMAC-owning service account lives in.
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
}
func (*CreateHmacKeyRequest) Descriptor() ([]byte, []int)
Deprecated: Use CreateHmacKeyRequest.ProtoReflect.Descriptor instead.
func (x *CreateHmacKeyRequest) GetProject() string
func (x *CreateHmacKeyRequest) GetServiceAccountEmail() string
func (*CreateHmacKeyRequest) ProtoMessage()
func (x *CreateHmacKeyRequest) ProtoReflect() protoreflect.Message
func (x *CreateHmacKeyRequest) Reset()
func (x *CreateHmacKeyRequest) String() string
Create hmac response. The only time the secret for an HMAC will be returned.
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
}
func (*CreateHmacKeyResponse) Descriptor() ([]byte, []int)
Deprecated: Use CreateHmacKeyResponse.ProtoReflect.Descriptor instead.
func (x *CreateHmacKeyResponse) GetMetadata() *HmacKeyMetadata
func (x *CreateHmacKeyResponse) GetSecretKeyBytes() []byte
func (*CreateHmacKeyResponse) ProtoMessage()
func (x *CreateHmacKeyResponse) ProtoReflect() protoreflect.Message
func (x *CreateHmacKeyResponse) Reset()
func (x *CreateHmacKeyResponse) String() string
Request message for CreateNotification.
type CreateNotificationRequest struct {
// Required. The bucket to which this notification belongs.
Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
// Required. Properties of the notification to be inserted.
Notification *Notification `protobuf:"bytes,2,opt,name=notification,proto3" json:"notification,omitempty"`
// contains filtered or unexported fields
}
func (*CreateNotificationRequest) Descriptor() ([]byte, []int)
Deprecated: Use CreateNotificationRequest.ProtoReflect.Descriptor instead.
func (x *CreateNotificationRequest) GetNotification() *Notification
func (x *CreateNotificationRequest) GetParent() string
func (*CreateNotificationRequest) ProtoMessage()
func (x *CreateNotificationRequest) ProtoReflect() protoreflect.Message
func (x *CreateNotificationRequest) Reset()
func (x *CreateNotificationRequest) String() string
Describes the Customer-Supplied Encryption Key mechanism used to store an Object's data at rest.
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
}
func (*CustomerEncryption) Descriptor() ([]byte, []int)
Deprecated: Use CustomerEncryption.ProtoReflect.Descriptor instead.
func (x *CustomerEncryption) GetEncryptionAlgorithm() string
func (x *CustomerEncryption) GetKeySha256Bytes() []byte
func (*CustomerEncryption) ProtoMessage()
func (x *CustomerEncryption) ProtoReflect() protoreflect.Message
func (x *CustomerEncryption) Reset()
func (x *CustomerEncryption) String() string
Request message for DeleteBucket.
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 `protobuf:"varint,2,opt,name=if_metageneration_match,json=ifMetagenerationMatch,proto3,oneof" json:"if_metageneration_match,omitempty"`
// If set, only deletes the bucket if its metageneration does not match this
// value.
IfMetagenerationNotMatch *int64 `protobuf:"varint,3,opt,name=if_metageneration_not_match,json=ifMetagenerationNotMatch,proto3,oneof" json:"if_metageneration_not_match,omitempty"`
// contains filtered or unexported fields
}
func (*DeleteBucketRequest) Descriptor() ([]byte, []int)
Deprecated: Use DeleteBucketRequest.ProtoReflect.Descriptor instead.
func (x *DeleteBucketRequest) GetIfMetagenerationMatch() int64
func (x *DeleteBucketRequest) GetIfMetagenerationNotMatch() int64
func (x *DeleteBucketRequest) GetName() string
func (*DeleteBucketRequest) ProtoMessage()
func (x *DeleteBucketRequest) ProtoReflect() protoreflect.Message
func (x *DeleteBucketRequest) Reset()
func (x *DeleteBucketRequest) String() string
Request object to delete a given HMAC key.
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 id the HMAC key lies in.
Project string `protobuf:"bytes,2,opt,name=project,proto3" json:"project,omitempty"`
// contains filtered or unexported fields
}
func (*DeleteHmacKeyRequest) Descriptor() ([]byte, []int)
Deprecated: Use DeleteHmacKeyRequest.ProtoReflect.Descriptor instead.
func (x *DeleteHmacKeyRequest) GetAccessId() string
func (x *DeleteHmacKeyRequest) GetProject() string
func (*DeleteHmacKeyRequest) ProtoMessage()
func (x *DeleteHmacKeyRequest) ProtoReflect() protoreflect.Message
func (x *DeleteHmacKeyRequest) Reset()
func (x *DeleteHmacKeyRequest) String() string
Request message for DeleteNotification.
type DeleteNotificationRequest struct {
// Required. The parent bucket of the notification.
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// contains filtered or unexported fields
}
func (*DeleteNotificationRequest) Descriptor() ([]byte, []int)
Deprecated: Use DeleteNotificationRequest.ProtoReflect.Descriptor instead.
func (x *DeleteNotificationRequest) GetName() string
func (*DeleteNotificationRequest) ProtoMessage()
func (x *DeleteNotificationRequest) ProtoReflect() protoreflect.Message
func (x *DeleteNotificationRequest) Reset()
func (x *DeleteNotificationRequest) String() string
Message for deleting an object. Either `bucket` and `object` *or* `upload_id` **must** be set (but not both).
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 object to delete (when not using a resumable write).
Object string `protobuf:"bytes,2,opt,name=object,proto3" json:"object,omitempty"`
// The resumable upload_id of the object to delete (when deleting an
// in-progress resumable write). This should be copied from the `upload_id`
// field of `StartResumableWriteResponse`.
UploadId string `protobuf:"bytes,3,opt,name=upload_id,json=uploadId,proto3" json:"upload_id,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 `protobuf:"varint,6,opt,name=if_generation_not_match,json=ifGenerationNotMatch,proto3,oneof" json:"if_generation_not_match,omitempty"`
// Makes the operation conditional on whether the object's current
// metageneration matches the given value.
IfMetagenerationMatch *int64 `protobuf:"varint,7,opt,name=if_metageneration_match,json=ifMetagenerationMatch,proto3,oneof" json:"if_metageneration_match,omitempty"`
// Makes the operation conditional on whether the object's current
// metageneration does not match the given value.
IfMetagenerationNotMatch *int64 `protobuf:"varint,8,opt,name=if_metageneration_not_match,json=ifMetagenerationNotMatch,proto3,oneof" json:"if_metageneration_not_match,omitempty"`
// A set of parameters common to Storage API requests concerning an object.
CommonObjectRequestParams *CommonObjectRequestParams `protobuf:"bytes,10,opt,name=common_object_request_params,json=commonObjectRequestParams,proto3" json:"common_object_request_params,omitempty"`
// contains filtered or unexported fields
}
func (*DeleteObjectRequest) Descriptor() ([]byte, []int)
Deprecated: Use DeleteObjectRequest.ProtoReflect.Descriptor instead.
func (x *DeleteObjectRequest) GetBucket() string
func (x *DeleteObjectRequest) GetCommonObjectRequestParams() *CommonObjectRequestParams
func (x *DeleteObjectRequest) GetGeneration() int64
func (x *DeleteObjectRequest) GetIfGenerationMatch() int64
func (x *DeleteObjectRequest) GetIfGenerationNotMatch() int64
func (x *DeleteObjectRequest) GetIfMetagenerationMatch() int64
func (x *DeleteObjectRequest) GetIfMetagenerationNotMatch() int64
func (x *DeleteObjectRequest) GetObject() string
func (x *DeleteObjectRequest) GetUploadId() string
func (*DeleteObjectRequest) ProtoMessage()
func (x *DeleteObjectRequest) ProtoReflect() protoreflect.Message
func (x *DeleteObjectRequest) Reset()
func (x *DeleteObjectRequest) String() string
Request message for GetBucket.
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 `protobuf:"varint,2,opt,name=if_metageneration_match,json=ifMetagenerationMatch,proto3,oneof" json:"if_metageneration_match,omitempty"`
// If set, and if the bucket's current metageneration matches the specified
// value, the request will return an error.
IfMetagenerationNotMatch *int64 `protobuf:"varint,3,opt,name=if_metageneration_not_match,json=ifMetagenerationNotMatch,proto3,oneof" json:"if_metageneration_not_match,omitempty"`
// 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
}
func (*GetBucketRequest) Descriptor() ([]byte, []int)
Deprecated: Use GetBucketRequest.ProtoReflect.Descriptor instead.
func (x *GetBucketRequest) GetIfMetagenerationMatch() int64
func (x *GetBucketRequest) GetIfMetagenerationNotMatch() int64
func (x *GetBucketRequest) GetName() string
func (x *GetBucketRequest) GetReadMask() *fieldmaskpb.FieldMask
func (*GetBucketRequest) ProtoMessage()
func (x *GetBucketRequest) ProtoReflect() protoreflect.Message
func (x *GetBucketRequest) Reset()
func (x *GetBucketRequest) String() string
Request object to get metadata on a given HMAC key.
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 id the HMAC key lies in.
Project string `protobuf:"bytes,2,opt,name=project,proto3" json:"project,omitempty"`
// contains filtered or unexported fields
}
func (*GetHmacKeyRequest) Descriptor() ([]byte, []int)
Deprecated: Use GetHmacKeyRequest.ProtoReflect.Descriptor instead.
func (x *GetHmacKeyRequest) GetAccessId() string
func (x *GetHmacKeyRequest) GetProject() string
func (*GetHmacKeyRequest) ProtoMessage()
func (x *GetHmacKeyRequest) ProtoReflect() protoreflect.Message
func (x *GetHmacKeyRequest) Reset()
func (x *GetHmacKeyRequest) String() string
Request message for GetNotification.
type GetNotificationRequest struct {
// Required. The parent bucket of the notification.
// Format:
// `projects/{project}/buckets/{bucket}/notificationConfigs/{notification}`
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// contains filtered or unexported fields
}
func (*GetNotificationRequest) Descriptor() ([]byte, []int)
Deprecated: Use GetNotificationRequest.ProtoReflect.Descriptor instead.
func (x *GetNotificationRequest) GetName() string
func (*GetNotificationRequest) ProtoMessage()
func (x *GetNotificationRequest) ProtoReflect() protoreflect.Message
func (x *GetNotificationRequest) Reset()
func (x *GetNotificationRequest) String() string
Request message for GetObject.
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 `protobuf:"varint,5,opt,name=if_generation_not_match,json=ifGenerationNotMatch,proto3,oneof" json:"if_generation_not_match,omitempty"`
// Makes the operation conditional on whether the object's current
// metageneration matches the given value.
IfMetagenerationMatch *int64 `protobuf:"varint,6,opt,name=if_metageneration_match,json=ifMetagenerationMatch,proto3,oneof" json:"if_metageneration_match,omitempty"`
// Makes the operation conditional on whether the object's current
// metageneration does not match the given value.
IfMetagenerationNotMatch *int64 `protobuf:"varint,7,opt,name=if_metageneration_not_match,json=ifMetagenerationNotMatch,proto3,oneof" json:"if_metageneration_not_match,omitempty"`
// A set of parameters common to Storage API requests concerning an object.
CommonObjectRequestParams *CommonObjectRequestParams `protobuf:"bytes,8,opt,name=common_object_request_params,json=commonObjectRequestParams,proto3" json:"common_object_request_params,omitempty"`
// 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
}
func (*GetObjectRequest) Descriptor() ([]byte, []int)
Deprecated: Use GetObjectRequest.ProtoReflect.Descriptor instead.
func (x *GetObjectRequest) GetBucket() string
func (x *GetObjectRequest) GetCommonObjectRequestParams() *CommonObjectRequestParams
func (x *GetObjectRequest) GetGeneration() int64
func (x *GetObjectRequest) GetIfGenerationMatch() int64
func (x *GetObjectRequest) GetIfGenerationNotMatch() int64
func (x *GetObjectRequest) GetIfMetagenerationMatch() int64
func (x *GetObjectRequest) GetIfMetagenerationNotMatch() int64
func (x *GetObjectRequest) GetObject() string
func (x *GetObjectRequest) GetReadMask() *fieldmaskpb.FieldMask
func (*GetObjectRequest) ProtoMessage()
func (x *GetObjectRequest) ProtoReflect() protoreflect.Message
func (x *GetObjectRequest) Reset()
func (x *GetObjectRequest) String() string
Request message for GetServiceAccount.
type GetServiceAccountRequest struct {
// Required. Project ID.
Project string `protobuf:"bytes,1,opt,name=project,proto3" json:"project,omitempty"`
// contains filtered or unexported fields
}
func (*GetServiceAccountRequest) Descriptor() ([]byte, []int)
Deprecated: Use GetServiceAccountRequest.ProtoReflect.Descriptor instead.
func (x *GetServiceAccountRequest) GetProject() string
func (*GetServiceAccountRequest) ProtoMessage()
func (x *GetServiceAccountRequest) ProtoReflect() protoreflect.Message
func (x *GetServiceAccountRequest) Reset()
func (x *GetServiceAccountRequest) String() string
Hmac Key Metadata, which includes all information other than the secret.
type HmacKeyMetadata struct {
// Resource name ID of the key in the format <projectId>/<accessId>.
Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
// Globally unique id for keys.
AccessId string `protobuf:"bytes,2,opt,name=access_id,json=accessId,proto3" json:"access_id,omitempty"`
// The project ID that the hmac key is contained in.
Project string `protobuf:"bytes,3,opt,name=project,proto3" json:"project,omitempty"`
// 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.
State string `protobuf:"bytes,5,opt,name=state,proto3" json:"state,omitempty"`
// The creation time of the HMAC key.
CreateTime *timestamppb.Timestamp `protobuf:"bytes,6,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"`
// 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
}
func (*HmacKeyMetadata) Descriptor() ([]byte, []int)
Deprecated: Use HmacKeyMetadata.ProtoReflect.Descriptor instead.
func (x *HmacKeyMetadata) GetAccessId() string
func (x *HmacKeyMetadata) GetCreateTime() *timestamppb.Timestamp
func (x *HmacKeyMetadata) GetEtag() string
func (x *HmacKeyMetadata) GetId() string
func (x *HmacKeyMetadata) GetProject() string
func (x *HmacKeyMetadata) GetServiceAccountEmail() string
func (x *HmacKeyMetadata) GetState() string
func (x *HmacKeyMetadata) GetUpdateTime() *timestamppb.Timestamp
func (*HmacKeyMetadata) ProtoMessage()
func (x *HmacKeyMetadata) ProtoReflect() protoreflect.Message
func (x *HmacKeyMetadata) Reset()
func (x *HmacKeyMetadata) String() string
Request message for ListBuckets.
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
}
func (*ListBucketsRequest) Descriptor() ([]byte, []int)
Deprecated: Use ListBucketsRequest.ProtoReflect.Descriptor instead.
func (x *ListBucketsRequest) GetPageSize() int32
func (x *ListBucketsRequest) GetPageToken() string
func (x *ListBucketsRequest) GetParent() string
func (x *ListBucketsRequest) GetPrefix() string
func (x *ListBucketsRequest) GetReadMask() *fieldmaskpb.FieldMask
func (*ListBucketsRequest) ProtoMessage()
func (x *ListBucketsRequest) ProtoReflect() protoreflect.Message
func (x *ListBucketsRequest) Reset()
func (x *ListBucketsRequest) String() string
The result of a call to Buckets.ListBuckets
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
}
func (*ListBucketsResponse) Descriptor() ([]byte, []int)
Deprecated: Use ListBucketsResponse.ProtoReflect.Descriptor instead.
func (x *ListBucketsResponse) GetBuckets() []*Bucket
func (x *ListBucketsResponse) GetNextPageToken() string
func (*ListBucketsResponse) ProtoMessage()
func (x *ListBucketsResponse) ProtoReflect() protoreflect.Message
func (x *ListBucketsResponse) Reset()
func (x *ListBucketsResponse) String() string
Request to fetch a list of HMAC keys under a given project.
type ListHmacKeysRequest struct {
// Required. The project id to list HMAC keys for.
Project string `protobuf:"bytes,1,opt,name=project,proto3" json:"project,omitempty"`
// Optional. The maximum number of keys to return.
PageSize int32 `protobuf:"varint,2,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"`
// Optional. 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"`
// Optional. 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"`
// Optional. 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
}
func (*ListHmacKeysRequest) Descriptor() ([]byte, []int)
Deprecated: Use ListHmacKeysRequest.ProtoReflect.Descriptor instead.
func (x *ListHmacKeysRequest) GetPageSize() int32
func (x *ListHmacKeysRequest) GetPageToken() string
func (x *ListHmacKeysRequest) GetProject() string
func (x *ListHmacKeysRequest) GetServiceAccountEmail() string
func (x *ListHmacKeysRequest) GetShowDeletedKeys() bool
func (*ListHmacKeysRequest) ProtoMessage()
func (x *ListHmacKeysRequest) ProtoReflect() protoreflect.Message
func (x *ListHmacKeysRequest) Reset()
func (x *ListHmacKeysRequest) String() string
Hmac key list response with next page information.
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
}
func (*ListHmacKeysResponse) Descriptor() ([]byte, []int)
Deprecated: Use ListHmacKeysResponse.ProtoReflect.Descriptor instead.
func (x *ListHmacKeysResponse) GetHmacKeys() []*HmacKeyMetadata
func (x *ListHmacKeysResponse) GetNextPageToken() string
func (*ListHmacKeysResponse) ProtoMessage()
func (x *ListHmacKeysResponse) ProtoReflect() protoreflect.Message
func (x *ListHmacKeysResponse) Reset()
func (x *ListHmacKeysResponse) String() string
Request message for ListNotifications.
type ListNotificationsRequest 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 notifications 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 `ListNotifications` call.
// Provide this to retrieve the subsequent page.
//
// When paginating, all other parameters provided to `ListNotifications` 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
}
func (*ListNotificationsRequest) Descriptor() ([]byte, []int)
Deprecated: Use ListNotificationsRequest.ProtoReflect.Descriptor instead.
func (x *ListNotificationsRequest) GetPageSize() int32
func (x *ListNotificationsRequest) GetPageToken() string
func (x *ListNotificationsRequest) GetParent() string
func (*ListNotificationsRequest) ProtoMessage()
func (x *ListNotificationsRequest) ProtoReflect() protoreflect.Message
func (x *ListNotificationsRequest) Reset()
func (x *ListNotificationsRequest) String() string
The result of a call to Notifications.ListNotifications
type ListNotificationsResponse struct {
// The list of items.
Notifications []*Notification `protobuf:"bytes,1,rep,name=notifications,proto3" json:"notifications,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
}
func (*ListNotificationsResponse) Descriptor() ([]byte, []int)
Deprecated: Use ListNotificationsResponse.ProtoReflect.Descriptor instead.
func (x *ListNotificationsResponse) GetNextPageToken() string
func (x *ListNotificationsResponse) GetNotifications() []*Notification
func (*ListNotificationsResponse) ProtoMessage()
func (x *ListNotificationsResponse) ProtoReflect() protoreflect.Message
func (x *ListNotificationsResponse) Reset()
func (x *ListNotificationsResponse) String() string
Request message for ListObjects.
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 `protobuf:"varint,5,opt,name=include_trailing_delimiter,json=includeTrailingDelimiter,proto3" json:"include_trailing_delimiter,omitempty"`
// 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"`
// 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"`
// 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
}
func (*ListObjectsRequest) Descriptor() ([]byte, []int)
Deprecated: Use ListObjectsRequest.ProtoReflect.Descriptor instead.
func (x *ListObjectsRequest) GetDelimiter() string
func (x *ListObjectsRequest) GetIncludeTrailingDelimiter() bool
func (x *ListObjectsRequest) GetLexicographicEnd() string
func (x *ListObjectsRequest) GetLexicographicStart() string
func (x *ListObjectsRequest) GetPageSize() int32
func (x *ListObjectsRequest) GetPageToken() string
func (x *ListObjectsRequest) GetParent() string
func (x *ListObjectsRequest) GetPrefix() string
func (x *ListObjectsRequest) GetReadMask() *fieldmaskpb.FieldMask
func (x *ListObjectsRequest) GetVersions() bool
func (*ListObjectsRequest) ProtoMessage()
func (x *ListObjectsRequest) ProtoReflect() protoreflect.Message
func (x *ListObjectsRequest) Reset()
func (x *ListObjectsRequest) String() string
The result of a call to Objects.ListObjects
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
}
func (*ListObjectsResponse) Descriptor() ([]byte, []int)
Deprecated: Use ListObjectsResponse.ProtoReflect.Descriptor instead.
func (x *ListObjectsResponse) GetNextPageToken() string
func (x *ListObjectsResponse) GetObjects() []*Object
func (x *ListObjectsResponse) GetPrefixes() []string
func (*ListObjectsResponse) ProtoMessage()
func (x *ListObjectsResponse) ProtoReflect() protoreflect.Message
func (x *ListObjectsResponse) Reset()
func (x *ListObjectsResponse) String() string
Request message for LockBucketRetentionPolicyRequest.
type LockBucketRetentionPolicyRequest struct {
// Required. Name of a bucket.
Bucket string `protobuf:"bytes,1,opt,name=bucket,proto3" json:"bucket,omitempty"`
// Makes the operation conditional on whether bucket's current metageneration
// matches the given value. Must be positive.
IfMetagenerationMatch int64 `protobuf:"varint,2,opt,name=if_metageneration_match,json=ifMetagenerationMatch,proto3" json:"if_metageneration_match,omitempty"`
// contains filtered or unexported fields
}
func (*LockBucketRetentionPolicyRequest) Descriptor() ([]byte, []int)
Deprecated: Use LockBucketRetentionPolicyRequest.ProtoReflect.Descriptor instead.
func (x *LockBucketRetentionPolicyRequest) GetBucket() string
func (x *LockBucketRetentionPolicyRequest) GetIfMetagenerationMatch() int64
func (*LockBucketRetentionPolicyRequest) ProtoMessage()
func (x *LockBucketRetentionPolicyRequest) ProtoReflect() protoreflect.Message
func (x *LockBucketRetentionPolicyRequest) Reset()
func (x *LockBucketRetentionPolicyRequest) String() string
A directive to publish Pub/Sub notifications upon changes to a bucket.
type Notification struct {
// Required. The resource name of this notification.
// Format:
// `projects/{project}/buckets/{bucket}/notificationConfigs/{notification}`
// 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 Notification.
// If included in the metadata of GetNotificationRequest, the operation will
// only be performed if the etag matches that of the Notification.
Etag string `protobuf:"bytes,7,opt,name=etag,proto3" json:"etag,omitempty"`
// Optional. 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"`
// Optional. An optional list of additional attributes to attach to each Pub/Sub
// message published for this notification subscription.
CustomAttributes map[string]string `protobuf:"bytes,4,rep,name=custom_attributes,json=customAttributes,proto3" json:"custom_attributes,omitempty" protobuf_key:"bytes,1,opt,name=key,proto3" protobuf_val:"bytes,2,opt,name=value,proto3"`
// Optional. If present, only apply this notification config 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
}
func (*Notification) Descriptor() ([]byte, []int)
Deprecated: Use Notification.ProtoReflect.Descriptor instead.
func (x *Notification) GetCustomAttributes() map[string]string
func (x *Notification) GetEtag() string
func (x *Notification) GetEventTypes() []string
func (x *Notification) GetName() string
func (x *Notification) GetObjectNamePrefix() string
func (x *Notification) GetPayloadFormat() string
func (x *Notification) GetTopic() string
func (*Notification) ProtoMessage()
func (x *Notification) ProtoReflect() protoreflect.Message
func (x *Notification) Reset()
func (x *Notification) String() string
An 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/naming-objects).
// 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 iamConfig.uniformBucketLevelAccess 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.
Checksums *ObjectChecksums `protobuf:"bytes,16,opt,name=checksums,proto3" json:"checksums,omitempty"`
// Output only. The modification time of the object metadata.
// 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 `protobuf:"bytes,19,opt,name=update_storage_class_time,json=updateStorageClassTime,proto3" json:"update_storage_class_time,omitempty"`
// 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 `protobuf:"bytes,22,rep,name=metadata,proto3" json:"metadata,omitempty" protobuf_key:"bytes,1,opt,name=key,proto3" protobuf_val:"bytes,2,opt,name=value,proto3"`
// 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
}
func (*Object) Descriptor() ([]byte, []int)
Deprecated: Use Object.ProtoReflect.Descriptor instead.
func (x *Object) GetAcl() []*ObjectAccessControl
func (x *Object) GetBucket() string
func (x *Object) GetCacheControl() string
func (x *Object) GetChecksums() *ObjectChecksums
func (x *Object) GetComponentCount() int32
func (x *Object) GetContentDisposition() string
func (x *Object) GetContentEncoding() string
func (x *Object) GetContentLanguage() string
func (x *Object) GetContentType() string
func (x *Object) GetCreateTime() *timestamppb.Timestamp
func (x *Object) GetCustomTime() *timestamppb.Timestamp
func (x *Object) GetCustomerEncryption() *CustomerEncryption
func (x *Object) GetDeleteTime() *timestamppb.Timestamp
func (x *Object) GetEtag() string
func (x *Object) GetEventBasedHold() bool
func (x *Object) GetGeneration() int64
func (x *Object) GetKmsKey() string
func (x *Object) GetMetadata() map[string]string
func (x *Object) GetMetageneration() int64
func (x *Object) GetName() string
func (x *Object) GetOwner() *Owner
func (x *Object) GetRetentionExpireTime() *timestamppb.Timestamp
func (x *Object) GetSize() int64
func (x *Object) GetStorageClass() string
func (x *Object) GetTemporaryHold() bool
func (x *Object) GetUpdateStorageClassTime() *timestamppb.Timestamp
func (x *Object) GetUpdateTime() *timestamppb.Timestamp
func (*Object) ProtoMessage()
func (x *Object) ProtoReflect() protoreflect.Message
func (x *Object) Reset()
func (x *Object) String() string
An access-control entry.
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-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`.
Entity string `protobuf:"bytes,3,opt,name=entity,proto3" json:"entity,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
}
func (*ObjectAccessControl) Descriptor() ([]byte, []int)
Deprecated: Use ObjectAccessControl.ProtoReflect.Descriptor instead.
func (x *ObjectAccessControl) GetDomain() string
func (x *ObjectAccessControl) GetEmail() string
func (x *ObjectAccessControl) GetEntity() string
func (x *ObjectAccessControl) GetEntityId() string
func (x *ObjectAccessControl) GetEtag() string
func (x *ObjectAccessControl) GetId() string
func (x *ObjectAccessControl) GetProjectTeam() *ProjectTeam
func (x *ObjectAccessControl) GetRole() string
func (*ObjectAccessControl) ProtoMessage()
func (x *ObjectAccessControl) ProtoReflect() protoreflect.Message
func (x *ObjectAccessControl) Reset()
func (x *ObjectAccessControl) String() string
Message used for storing full (not subrange) object checksums.
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
}
func (*ObjectChecksums) Descriptor() ([]byte, []int)
Deprecated: Use ObjectChecksums.ProtoReflect.Descriptor instead.
func (x *ObjectChecksums) GetCrc32C() uint32
func (x *ObjectChecksums) GetMd5Hash() []byte
func (*ObjectChecksums) ProtoMessage()
func (x *ObjectChecksums) ProtoReflect() protoreflect.Message
func (x *ObjectChecksums) Reset()
func (x *ObjectChecksums) String() string
The owner of a specific resource.
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
}
func (*Owner) Descriptor() ([]byte, []int)
Deprecated: Use Owner.ProtoReflect.Descriptor instead.
func (x *Owner) GetEntity() string
func (x *Owner) GetEntityId() string
func (*Owner) ProtoMessage()
func (x *Owner) ProtoReflect() protoreflect.Message
func (x *Owner) Reset()
func (x *Owner) String() string
Represents the Viewers, Editors, or Owners of a given project.
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
}
func (*ProjectTeam) Descriptor() ([]byte, []int)
Deprecated: Use ProjectTeam.ProtoReflect.Descriptor instead.
func (x *ProjectTeam) GetProjectNumber() string
func (x *ProjectTeam) GetTeam() string
func (*ProjectTeam) ProtoMessage()
func (x *ProjectTeam) ProtoReflect() protoreflect.Message
func (x *ProjectTeam) Reset()
func (x *ProjectTeam) String() string
Request object for `QueryWriteStatus`.
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 `protobuf:"bytes,2,opt,name=common_object_request_params,json=commonObjectRequestParams,proto3" json:"common_object_request_params,omitempty"`
// contains filtered or unexported fields
}
func (*QueryWriteStatusRequest) Descriptor() ([]byte, []int)
Deprecated: Use QueryWriteStatusRequest.ProtoReflect.Descriptor instead.
func (x *QueryWriteStatusRequest) GetCommonObjectRequestParams() *CommonObjectRequestParams
func (x *QueryWriteStatusRequest) GetUploadId() string
func (*QueryWriteStatusRequest) ProtoMessage()
func (x *QueryWriteStatusRequest) ProtoReflect() protoreflect.Message
func (x *QueryWriteStatusRequest) Reset()
func (x *QueryWriteStatusRequest) String() string
Response object for `QueryWriteStatus`.
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
}
func (*QueryWriteStatusResponse) Descriptor() ([]byte, []int)
Deprecated: Use QueryWriteStatusResponse.ProtoReflect.Descriptor instead.
func (x *QueryWriteStatusResponse) GetPersistedSize() int64
func (x *QueryWriteStatusResponse) GetResource() *Object
func (m *QueryWriteStatusResponse) GetWriteStatus() isQueryWriteStatusResponse_WriteStatus
func (*QueryWriteStatusResponse) ProtoMessage()
func (x *QueryWriteStatusResponse) ProtoReflect() protoreflect.Message
func (x *QueryWriteStatusResponse) Reset()
func (x *QueryWriteStatusResponse) String() string
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 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"`
}
Request message for ReadObject.
type ReadObjectRequest struct {
// The name of the bucket containing the object to read.
Bucket string `protobuf:"bytes,1,opt,name=bucket,proto3" json:"bucket,omitempty"`
// 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 `protobuf:"varint,7,opt,name=if_generation_not_match,json=ifGenerationNotMatch,proto3,oneof" json:"if_generation_not_match,omitempty"`
// Makes the operation conditional on whether the object's current
// metageneration matches the given value.
IfMetagenerationMatch *int64 `protobuf:"varint,8,opt,name=if_metageneration_match,json=ifMetagenerationMatch,proto3,oneof" json:"if_metageneration_match,omitempty"`
// Makes the operation conditional on whether the object's current
// metageneration does not match the given value.
IfMetagenerationNotMatch *int64 `protobuf:"varint,9,opt,name=if_metageneration_not_match,json=ifMetagenerationNotMatch,proto3,oneof" json:"if_metageneration_not_match,omitempty"`
// A set of parameters common to Storage API requests concerning an object.
CommonObjectRequestParams *CommonObjectRequestParams `protobuf:"bytes,10,opt,name=common_object_request_params,json=commonObjectRequestParams,proto3" json:"common_object_request_params,omitempty"`
// 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
}
func (*ReadObjectRequest) Descriptor() ([]byte, []int)
Deprecated: Use ReadObjectRequest.ProtoReflect.Descriptor instead.
func (x *ReadObjectRequest) GetBucket() string
func (x *ReadObjectRequest) GetCommonObjectRequestParams() *CommonObjectRequestParams
func (x *ReadObjectRequest) GetGeneration() int64
func (x *ReadObjectRequest) GetIfGenerationMatch() int64
func (x *ReadObjectRequest) GetIfGenerationNotMatch() int64
func (x *ReadObjectRequest) GetIfMetagenerationMatch() int64
func (x *ReadObjectRequest) GetIfMetagenerationNotMatch() int64
func (x *ReadObjectRequest) GetObject() string
func (x *ReadObjectRequest) GetReadLimit() int64
func (x *ReadObjectRequest) GetReadMask() *fieldmaskpb.FieldMask
func (x *ReadObjectRequest) GetReadOffset() int64
func (*ReadObjectRequest) ProtoMessage()
func (x *ReadObjectRequest) ProtoReflect() protoreflect.Message
func (x *ReadObjectRequest) Reset()
func (x *ReadObjectRequest) String() string
Response message for ReadObject.
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
}
func (*ReadObjectResponse) Descriptor() ([]byte, []int)
Deprecated: Use ReadObjectResponse.ProtoReflect.Descriptor instead.
func (x *ReadObjectResponse) GetChecksummedData() *ChecksummedData
func (x *ReadObjectResponse) GetContentRange() *ContentRange
func (x *ReadObjectResponse) GetMetadata() *Object
func (x *ReadObjectResponse) GetObjectChecksums() *ObjectChecksums
func (*ReadObjectResponse) ProtoMessage()
func (x *ReadObjectResponse) ProtoReflect() protoreflect.Message
func (x *ReadObjectResponse) Reset()
func (x *ReadObjectResponse) String() string
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.
type RewriteObjectRequest struct {
// Immutable. The name of the destination object. Nearly any sequence of unicode
// characters is valid. See
// [Guidelines](https://cloud.google.com/storage/docs/naming-objects).
// 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"`
// Immutable. The name of the bucket containing The name of 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 `protobuf:"bytes,28,opt,name=destination_predefined_acl,json=destinationPredefinedAcl,proto3" json:"destination_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,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 `protobuf:"varint,8,opt,name=if_generation_not_match,json=ifGenerationNotMatch,proto3,oneof" json:"if_generation_not_match,omitempty"`
// Makes the operation conditional on whether the destination object's current
// metageneration matches the given value.
IfMetagenerationMatch *int64 `protobuf:"varint,9,opt,name=if_metageneration_match,json=ifMetagenerationMatch,proto3,oneof" json:"if_metageneration_match,omitempty"`
// Makes the operation conditional on whether the destination object's current
// metageneration does not match the given value.
IfMetagenerationNotMatch *int64 `protobuf:"varint,10,opt,name=if_metageneration_not_match,json=ifMetagenerationNotMatch,proto3,oneof" json:"if_metageneration_not_match,omitempty"`
// Makes the operation conditional on whether the source object's live
// generation matches the given value.
IfSourceGenerationMatch *int64 `protobuf:"varint,11,opt,name=if_source_generation_match,json=ifSourceGenerationMatch,proto3,oneof" json:"if_source_generation_match,omitempty"`
// Makes the operation conditional on whether the source object's live
// generation does not match the given value.
IfSourceGenerationNotMatch *int64 `protobuf:"varint,12,opt,name=if_source_generation_not_match,json=ifSourceGenerationNotMatch,proto3,oneof" json:"if_source_generation_not_match,omitempty"`
// Makes the operation conditional on whether the source object's current
// metageneration matches the given value.
IfSourceMetagenerationMatch *int64 `protobuf:"varint,13,opt,name=if_source_metageneration_match,json=ifSourceMetagenerationMatch,proto3,oneof" json:"if_source_metageneration_match,omitempty"`
// Makes the operation conditional on whether the source object's current
// metageneration does not match the given value.
IfSourceMetagenerationNotMatch *int64 `protobuf:"varint,14,opt,name=if_source_metageneration_not_match,json=ifSourceMetagenerationNotMatch,proto3,oneof" json:"if_source_metageneration_not_match,omitempty"`
// 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 `protobuf:"varint,15,opt,name=max_bytes_rewritten_per_call,json=maxBytesRewrittenPerCall,proto3" json:"max_bytes_rewritten_per_call,omitempty"`
// 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 `protobuf:"bytes,16,opt,name=copy_source_encryption_algorithm,json=copySourceEncryptionAlgorithm,proto3" json:"copy_source_encryption_algorithm,omitempty"`
// 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 `protobuf:"bytes,21,opt,name=copy_source_encryption_key_bytes,json=copySourceEncryptionKeyBytes,proto3" json:"copy_source_encryption_key_bytes,omitempty"`
// 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 `protobuf:"bytes,22,opt,name=copy_source_encryption_key_sha256_bytes,json=copySourceEncryptionKeySha256Bytes,proto3" json:"copy_source_encryption_key_sha256_bytes,omitempty"`
// A set of parameters common to Storage API requests concerning an object.
CommonObjectRequestParams *CommonObjectRequestParams `protobuf:"bytes,19,opt,name=common_object_request_params,json=commonObjectRequestParams,proto3" json:"common_object_request_params,omitempty"`
// contains filtered or unexported fields
}
func (*RewriteObjectRequest) Descriptor() ([]byte, []int)
Deprecated: Use RewriteObjectRequest.ProtoReflect.Descriptor instead.
func (x *RewriteObjectRequest) GetCommonObjectRequestParams() *CommonObjectRequestParams
func (x *RewriteObjectRequest) GetCopySourceEncryptionAlgorithm() string
func (x *RewriteObjectRequest) GetCopySourceEncryptionKeyBytes() []byte
func (x *RewriteObjectRequest) GetCopySourceEncryptionKeySha256Bytes() []byte
func (x *RewriteObjectRequest) GetDestination() *Object
func (x *RewriteObjectRequest) GetDestinationBucket() string
func (x *RewriteObjectRequest) GetDestinationKmsKey() string
func (x *RewriteObjectRequest) GetDestinationName() string
func (x *RewriteObjectRequest) GetDestinationPredefinedAcl() string
func (x *RewriteObjectRequest) GetIfGenerationMatch() int64
func (x *RewriteObjectRequest) GetIfGenerationNotMatch() int64
func (x *RewriteObjectRequest) GetIfMetagenerationMatch() int64
func (x *RewriteObjectRequest) GetIfMetagenerationNotMatch() int64
func (x *RewriteObjectRequest) GetIfSourceGenerationMatch() int64
func (x *RewriteObjectRequest) GetIfSourceGenerationNotMatch() int64
func (x *RewriteObjectRequest) GetIfSourceMetagenerationMatch() int64
func (x *RewriteObjectRequest) GetIfSourceMetagenerationNotMatch() int64
func (x *RewriteObjectRequest) GetMaxBytesRewrittenPerCall() int64
func (x *RewriteObjectRequest) GetRewriteToken() string
func (x *RewriteObjectRequest) GetSourceBucket() string
func (x *RewriteObjectRequest) GetSourceGeneration() int64
func (x *RewriteObjectRequest) GetSourceObject() string
func (*RewriteObjectRequest) ProtoMessage()
func (x *RewriteObjectRequest) ProtoReflect() protoreflect.Message
func (x *RewriteObjectRequest) Reset()
func (x *RewriteObjectRequest) String() string
A rewrite response.
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
}
func (*RewriteResponse) Descriptor() ([]byte, []int)
Deprecated: Use RewriteResponse.ProtoReflect.Descriptor instead.
func (x *RewriteResponse) GetDone() bool
func (x *RewriteResponse) GetObjectSize() int64
func (x *RewriteResponse) GetResource() *Object
func (x *RewriteResponse) GetRewriteToken() string
func (x *RewriteResponse) GetTotalBytesRewritten() int64
func (*RewriteResponse) ProtoMessage()
func (x *RewriteResponse) ProtoReflect() protoreflect.Message
func (x *RewriteResponse) Reset()
func (x *RewriteResponse) String() string
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.
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
}
func (*ServiceAccount) Descriptor() ([]byte, []int)
Deprecated: Use ServiceAccount.ProtoReflect.Descriptor instead.
func (x *ServiceAccount) GetEmailAddress() string
func (*ServiceAccount) ProtoMessage()
func (x *ServiceAccount) ProtoReflect() protoreflect.Message
func (x *ServiceAccount) Reset()
func (x *ServiceAccount) String() string
Shared constants.
type ServiceConstants struct {
// contains filtered or unexported fields
}
func (*ServiceConstants) Descriptor() ([]byte, []int)
Deprecated: Use ServiceConstants.ProtoReflect.Descriptor instead.
func (*ServiceConstants) ProtoMessage()
func (x *ServiceConstants) ProtoReflect() protoreflect.Message
func (x *ServiceConstants) Reset()
func (x *ServiceConstants) String() string
A collection of constant values meaningful to the Storage API.
type ServiceConstants_Values int32
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() protoreflect.EnumDescriptor
func (x ServiceConstants_Values) Enum() *ServiceConstants_Values
func (ServiceConstants_Values) EnumDescriptor() ([]byte, []int)
Deprecated: Use ServiceConstants_Values.Descriptor instead.
func (x ServiceConstants_Values) Number() protoreflect.EnumNumber
func (x ServiceConstants_Values) String() string
func (ServiceConstants_Values) Type() protoreflect.EnumType
Request message StartResumableWrite.
type StartResumableWriteRequest struct {
// 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 `protobuf:"bytes,3,opt,name=common_object_request_params,json=commonObjectRequestParams,proto3" json:"common_object_request_params,omitempty"`
// contains filtered or unexported fields
}
func (*StartResumableWriteRequest) Descriptor() ([]byte, []int)
Deprecated: Use StartResumableWriteRequest.ProtoReflect.Descriptor instead.
func (x *StartResumableWriteRequest) GetCommonObjectRequestParams() *CommonObjectRequestParams
func (x *StartResumableWriteRequest) GetWriteObjectSpec() *WriteObjectSpec
func (*StartResumableWriteRequest) ProtoMessage()
func (x *StartResumableWriteRequest) ProtoReflect() protoreflect.Message
func (x *StartResumableWriteRequest) Reset()
func (x *StartResumableWriteRequest) String() string
Response object for `StartResumableWrite`.
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
}
func (*StartResumableWriteResponse) Descriptor() ([]byte, []int)
Deprecated: Use StartResumableWriteResponse.ProtoReflect.Descriptor instead.
func (x *StartResumableWriteResponse) GetUploadId() string
func (*StartResumableWriteResponse) ProtoMessage()
func (x *StartResumableWriteResponse) ProtoReflect() protoreflect.Message
func (x *StartResumableWriteResponse) Reset()
func (x *StartResumableWriteResponse) String() string
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.
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.
GetIamPolicy(ctx context.Context, in *v1.GetIamPolicyRequest, opts ...grpc.CallOption) (*v1.Policy, error)
// Updates an IAM policy for the specified bucket.
SetIamPolicy(ctx context.Context, in *v1.SetIamPolicyRequest, opts ...grpc.CallOption) (*v1.Policy, error)
// Tests a set of permissions on the given bucket to see which, if
// any, are held by the caller.
TestIamPermissions(ctx context.Context, in *v1.TestIamPermissionsRequest, opts ...grpc.CallOption) (*v1.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 notification subscription.
DeleteNotification(ctx context.Context, in *DeleteNotificationRequest, opts ...grpc.CallOption) (*emptypb.Empty, error)
// View a notification config.
GetNotification(ctx context.Context, in *GetNotificationRequest, opts ...grpc.CallOption) (*Notification, error)
// Creates a notification subscription for a given bucket.
// These notifications, when triggered, publish messages to the specified
// Pub/Sub topics.
// See https://cloud.google.com/storage/docs/pubsub-notifications.
CreateNotification(ctx context.Context, in *CreateNotificationRequest, opts ...grpc.CallOption) (*Notification, error)
// Retrieves a list of notification subscriptions for a given bucket.
ListNotifications(ctx context.Context, in *ListNotificationsRequest, opts ...grpc.CallOption) (*ListNotificationsResponse, 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)
// 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. 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)
}
func NewStorageClient(cc grpc.ClientConnInterface) StorageClient
StorageServer is the server API for Storage service.
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.
GetIamPolicy(context.Context, *v1.GetIamPolicyRequest) (*v1.Policy, error)
// Updates an IAM policy for the specified bucket.
SetIamPolicy(context.Context, *v1.SetIamPolicyRequest) (*v1.Policy, error)
// Tests a set of permissions on the given bucket to see which, if
// any, are held by the caller.
TestIamPermissions(context.Context, *v1.TestIamPermissionsRequest) (*v1.TestIamPermissionsResponse, error)
// Updates a bucket. Equivalent to JSON API's storage.buckets.patch method.
UpdateBucket(context.Context, *UpdateBucketRequest) (*Bucket, error)
// Permanently deletes a notification subscription.
DeleteNotification(context.Context, *DeleteNotificationRequest) (*emptypb.Empty, error)
// View a notification config.
GetNotification(context.Context, *GetNotificationRequest) (*Notification, error)
// Creates a notification subscription for a given bucket.
// These notifications, when triggered, publish messages to the specified
// Pub/Sub topics.
// See https://cloud.google.com/storage/docs/pubsub-notifications.
CreateNotification(context.Context, *CreateNotificationRequest) (*Notification, error)
// Retrieves a list of notification subscriptions for a given bucket.
ListNotifications(context.Context, *ListNotificationsRequest) (*ListNotificationsResponse, 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)
// 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. 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)
}
type Storage_ReadObjectClient interface {
Recv() (*ReadObjectResponse, error)
grpc.ClientStream
}
type Storage_ReadObjectServer interface {
Send(*ReadObjectResponse) error
grpc.ServerStream
}
type Storage_WriteObjectClient interface {
Send(*WriteObjectRequest) error
CloseAndRecv() (*WriteObjectResponse, error)
grpc.ClientStream
}
type Storage_WriteObjectServer interface {
SendAndClose(*WriteObjectResponse) error
Recv() (*WriteObjectRequest, error)
grpc.ServerStream
}
UnimplementedStorageServer can be embedded to have forward compatible implementations.
type UnimplementedStorageServer struct {
}
func (*UnimplementedStorageServer) ComposeObject(context.Context, *ComposeObjectRequest) (*Object, error)
func (*UnimplementedStorageServer) CreateBucket(context.Context, *CreateBucketRequest) (*Bucket, error)
func (*UnimplementedStorageServer) CreateHmacKey(context.Context, *CreateHmacKeyRequest) (*CreateHmacKeyResponse, error)
func (*UnimplementedStorageServer) CreateNotification(context.Context, *CreateNotificationRequest) (*Notification, error)
func (*UnimplementedStorageServer) DeleteBucket(context.Context, *DeleteBucketRequest) (*emptypb.Empty, error)
func (*UnimplementedStorageServer) DeleteHmacKey(context.Context, *DeleteHmacKeyRequest) (*emptypb.Empty, error)
func (*UnimplementedStorageServer) DeleteNotification(context.Context, *DeleteNotificationRequest) (*emptypb.Empty, error)
func (*UnimplementedStorageServer) DeleteObject(context.Context, *DeleteObjectRequest) (*emptypb.Empty, error)
func (*UnimplementedStorageServer) GetBucket(context.Context, *GetBucketRequest) (*Bucket, error)
func (*UnimplementedStorageServer) GetHmacKey(context.Context, *GetHmacKeyRequest) (*HmacKeyMetadata, error)
func (*UnimplementedStorageServer) GetIamPolicy(context.Context, *v1.GetIamPolicyRequest) (*v1.Policy, error)
func (*UnimplementedStorageServer) GetNotification(context.Context, *GetNotificationRequest) (*Notification, error)
func (*UnimplementedStorageServer) GetObject(context.Context, *GetObjectRequest) (*Object, error)
func (*UnimplementedStorageServer) GetServiceAccount(context.Context, *GetServiceAccountRequest) (*ServiceAccount, error)
func (*UnimplementedStorageServer) ListBuckets(context.Context, *ListBucketsRequest) (*ListBucketsResponse, error)
func (*UnimplementedStorageServer) ListHmacKeys(context.Context, *ListHmacKeysRequest) (*ListHmacKeysResponse, error)
func (*UnimplementedStorageServer) ListNotifications(context.Context, *ListNotificationsRequest) (*ListNotificationsResponse, error)
func (*UnimplementedStorageServer) ListObjects(context.Context, *ListObjectsRequest) (*ListObjectsResponse, error)
func (*UnimplementedStorageServer) LockBucketRetentionPolicy(context.Context, *LockBucketRetentionPolicyRequest) (*Bucket, error)
func (*UnimplementedStorageServer) QueryWriteStatus(context.Context, *QueryWriteStatusRequest) (*QueryWriteStatusResponse, error)
func (*UnimplementedStorageServer) ReadObject(*ReadObjectRequest, Storage_ReadObjectServer) error
func (*UnimplementedStorageServer) RewriteObject(context.Context, *RewriteObjectRequest) (*RewriteResponse, error)
func (*UnimplementedStorageServer) SetIamPolicy(context.Context, *v1.SetIamPolicyRequest) (*v1.Policy, error)
func (*UnimplementedStorageServer) StartResumableWrite(context.Context, *StartResumableWriteRequest) (*StartResumableWriteResponse, error)
func (*UnimplementedStorageServer) TestIamPermissions(context.Context, *v1.TestIamPermissionsRequest) (*v1.TestIamPermissionsResponse, error)
func (*UnimplementedStorageServer) UpdateBucket(context.Context, *UpdateBucketRequest) (*Bucket, error)
func (*UnimplementedStorageServer) UpdateHmacKey(context.Context, *UpdateHmacKeyRequest) (*HmacKeyMetadata, error)
func (*UnimplementedStorageServer) UpdateObject(context.Context, *UpdateObjectRequest) (*Object, error)
func (*UnimplementedStorageServer) WriteObject(Storage_WriteObjectServer) error
Request for UpdateBucket method.
type UpdateBucketRequest struct {
// 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 `protobuf:"varint,2,opt,name=if_metageneration_match,json=ifMetagenerationMatch,proto3,oneof" json:"if_metageneration_match,omitempty"`
// If set, will only modify the bucket if its metageneration does not match
// this value.
IfMetagenerationNotMatch *int64 `protobuf:"varint,3,opt,name=if_metageneration_not_match,json=ifMetagenerationNotMatch,proto3,oneof" json:"if_metageneration_not_match,omitempty"`
// 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 `protobuf:"bytes,9,opt,name=predefined_default_object_acl,json=predefinedDefaultObjectAcl,proto3" json:"predefined_default_object_acl,omitempty"`
// 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
}
func (*UpdateBucketRequest) Descriptor() ([]byte, []int)
Deprecated: Use UpdateBucketRequest.ProtoReflect.Descriptor instead.
func (x *UpdateBucketRequest) GetBucket() *Bucket
func (x *UpdateBucketRequest) GetIfMetagenerationMatch() int64
func (x *UpdateBucketRequest) GetIfMetagenerationNotMatch() int64
func (x *UpdateBucketRequest) GetPredefinedAcl() string
func (x *UpdateBucketRequest) GetPredefinedDefaultObjectAcl() string
func (x *UpdateBucketRequest) GetUpdateMask() *fieldmaskpb.FieldMask
func (*UpdateBucketRequest) ProtoMessage()
func (x *UpdateBucketRequest) ProtoReflect() protoreflect.Message
func (x *UpdateBucketRequest) Reset()
func (x *UpdateBucketRequest) String() string
Request object to update an HMAC key state.
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.
UpdateMask *fieldmaskpb.FieldMask `protobuf:"bytes,3,opt,name=update_mask,json=updateMask,proto3" json:"update_mask,omitempty"`
// contains filtered or unexported fields
}
func (*UpdateHmacKeyRequest) Descriptor() ([]byte, []int)
Deprecated: Use UpdateHmacKeyRequest.ProtoReflect.Descriptor instead.
func (x *UpdateHmacKeyRequest) GetHmacKey() *HmacKeyMetadata
func (x *UpdateHmacKeyRequest) GetUpdateMask() *fieldmaskpb.FieldMask
func (*UpdateHmacKeyRequest) ProtoMessage()
func (x *UpdateHmacKeyRequest) ProtoReflect() protoreflect.Message
func (x *UpdateHmacKeyRequest) Reset()
func (x *UpdateHmacKeyRequest) String() string
Request message for UpdateObject.
type UpdateObjectRequest struct {
// 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 `protobuf:"varint,3,opt,name=if_generation_not_match,json=ifGenerationNotMatch,proto3,oneof" json:"if_generation_not_match,omitempty"`
// Makes the operation conditional on whether the object's current
// metageneration matches the given value.
IfMetagenerationMatch *int64 `protobuf:"varint,4,opt,name=if_metageneration_match,json=ifMetagenerationMatch,proto3,oneof" json:"if_metageneration_match,omitempty"`
// Makes the operation conditional on whether the object's current
// metageneration does not match the given value.
IfMetagenerationNotMatch *int64 `protobuf:"varint,5,opt,name=if_metageneration_not_match,json=ifMetagenerationNotMatch,proto3,oneof" json:"if_metageneration_not_match,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,10,opt,name=predefined_acl,json=predefinedAcl,proto3" json:"predefined_acl,omitempty"`
// 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 `protobuf:"bytes,8,opt,name=common_object_request_params,json=commonObjectRequestParams,proto3" json:"common_object_request_params,omitempty"`
// contains filtered or unexported fields
}
func (*UpdateObjectRequest) Descriptor() ([]byte, []int)
Deprecated: Use UpdateObjectRequest.ProtoReflect.Descriptor instead.
func (x *UpdateObjectRequest) GetCommonObjectRequestParams() *CommonObjectRequestParams
func (x *UpdateObjectRequest) GetIfGenerationMatch() int64
func (x *UpdateObjectRequest) GetIfGenerationNotMatch() int64
func (x *UpdateObjectRequest) GetIfMetagenerationMatch() int64
func (x *UpdateObjectRequest) GetIfMetagenerationNotMatch() int64
func (x *UpdateObjectRequest) GetObject() *Object
func (x *UpdateObjectRequest) GetPredefinedAcl() string
func (x *UpdateObjectRequest) GetUpdateMask() *fieldmaskpb.FieldMask
func (*UpdateObjectRequest) ProtoMessage()
func (x *UpdateObjectRequest) ProtoReflect() protoreflect.Message
func (x *UpdateObjectRequest) Reset()
func (x *UpdateObjectRequest) String() string
Request message for WriteObject.
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 `protobuf:"bytes,8,opt,name=common_object_request_params,json=commonObjectRequestParams,proto3" json:"common_object_request_params,omitempty"`
// contains filtered or unexported fields
}
func (*WriteObjectRequest) Descriptor() ([]byte, []int)
Deprecated: Use WriteObjectRequest.ProtoReflect.Descriptor instead.
func (x *WriteObjectRequest) GetChecksummedData() *ChecksummedData
func (x *WriteObjectRequest) GetCommonObjectRequestParams() *CommonObjectRequestParams
func (m *WriteObjectRequest) GetData() isWriteObjectRequest_Data
func (x *WriteObjectRequest) GetFinishWrite() bool
func (m *WriteObjectRequest) GetFirstMessage() isWriteObjectRequest_FirstMessage
func (x *WriteObjectRequest) GetObjectChecksums() *ObjectChecksums
func (x *WriteObjectRequest) GetUploadId() string
func (x *WriteObjectRequest) GetWriteObjectSpec() *WriteObjectSpec
func (x *WriteObjectRequest) GetWriteOffset() int64
func (*WriteObjectRequest) ProtoMessage()
func (x *WriteObjectRequest) ProtoReflect() protoreflect.Message
func (x *WriteObjectRequest) Reset()
func (x *WriteObjectRequest) String() string
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 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 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"`
}
Response message for WriteObject.
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
}
func (*WriteObjectResponse) Descriptor() ([]byte, []int)
Deprecated: Use WriteObjectResponse.ProtoReflect.Descriptor instead.
func (x *WriteObjectResponse) GetPersistedSize() int64
func (x *WriteObjectResponse) GetResource() *Object
func (m *WriteObjectResponse) GetWriteStatus() isWriteObjectResponse_WriteStatus
func (*WriteObjectResponse) ProtoMessage()
func (x *WriteObjectResponse) ProtoReflect() protoreflect.Message
func (x *WriteObjectResponse) Reset()
func (x *WriteObjectResponse) String() string
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 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"`
}
Describes an attempt to insert an object, possibly over multiple requests.
type WriteObjectSpec struct {
// 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 `protobuf:"varint,4,opt,name=if_generation_not_match,json=ifGenerationNotMatch,proto3,oneof" json:"if_generation_not_match,omitempty"`
// Makes the operation conditional on whether the object's current
// metageneration matches the given value.
IfMetagenerationMatch *int64 `protobuf:"varint,5,opt,name=if_metageneration_match,json=ifMetagenerationMatch,proto3,oneof" json:"if_metageneration_match,omitempty"`
// Makes the operation conditional on whether the object's current
// metageneration does not match the given value.
IfMetagenerationNotMatch *int64 `protobuf:"varint,6,opt,name=if_metageneration_not_match,json=ifMetagenerationNotMatch,proto3,oneof" json:"if_metageneration_not_match,omitempty"`
// contains filtered or unexported fields
}
func (*WriteObjectSpec) Descriptor() ([]byte, []int)
Deprecated: Use WriteObjectSpec.ProtoReflect.Descriptor instead.
func (x *WriteObjectSpec) GetIfGenerationMatch() int64
func (x *WriteObjectSpec) GetIfGenerationNotMatch() int64
func (x *WriteObjectSpec) GetIfMetagenerationMatch() int64
func (x *WriteObjectSpec) GetIfMetagenerationNotMatch() int64
func (x *WriteObjectSpec) GetPredefinedAcl() string
func (x *WriteObjectSpec) GetResource() *Object
func (*WriteObjectSpec) ProtoMessage()
func (x *WriteObjectSpec) ProtoReflect() protoreflect.Message
func (x *WriteObjectSpec) Reset()
func (x *WriteObjectSpec) String() string