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,
}
)
Enum value maps for Bucket_IamConfiguration_PublicAccessPrevention.
var (
Bucket_IamConfiguration_PublicAccessPrevention_name = map[int32]string{
0: "PUBLIC_ACCESS_PREVENTION_UNSPECIFIED",
1: "ENFORCED",
2: "INHERITED",
}
Bucket_IamConfiguration_PublicAccessPrevention_value = map[string]int32{
"PUBLIC_ACCESS_PREVENTION_UNSPECIFIED": 0,
"ENFORCED": 1,
"INHERITED": 2,
}
)
Enum value maps for CommonEnums_Projection.
var (
CommonEnums_Projection_name = map[int32]string{
0: "PROJECTION_UNSPECIFIED",
1: "NO_ACL",
2: "FULL",
}
CommonEnums_Projection_value = map[string]int32{
"PROJECTION_UNSPECIFIED": 0,
"NO_ACL": 1,
"FULL": 2,
}
)
Enum value maps for CommonEnums_PredefinedBucketAcl.
var (
CommonEnums_PredefinedBucketAcl_name = map[int32]string{
0: "PREDEFINED_BUCKET_ACL_UNSPECIFIED",
1: "BUCKET_ACL_AUTHENTICATED_READ",
2: "BUCKET_ACL_PRIVATE",
3: "BUCKET_ACL_PROJECT_PRIVATE",
4: "BUCKET_ACL_PUBLIC_READ",
5: "BUCKET_ACL_PUBLIC_READ_WRITE",
}
CommonEnums_PredefinedBucketAcl_value = map[string]int32{
"PREDEFINED_BUCKET_ACL_UNSPECIFIED": 0,
"BUCKET_ACL_AUTHENTICATED_READ": 1,
"BUCKET_ACL_PRIVATE": 2,
"BUCKET_ACL_PROJECT_PRIVATE": 3,
"BUCKET_ACL_PUBLIC_READ": 4,
"BUCKET_ACL_PUBLIC_READ_WRITE": 5,
}
)
Enum value maps for CommonEnums_PredefinedObjectAcl.
var (
CommonEnums_PredefinedObjectAcl_name = map[int32]string{
0: "PREDEFINED_OBJECT_ACL_UNSPECIFIED",
1: "OBJECT_ACL_AUTHENTICATED_READ",
2: "OBJECT_ACL_BUCKET_OWNER_FULL_CONTROL",
3: "OBJECT_ACL_BUCKET_OWNER_READ",
4: "OBJECT_ACL_PRIVATE",
5: "OBJECT_ACL_PROJECT_PRIVATE",
6: "OBJECT_ACL_PUBLIC_READ",
}
CommonEnums_PredefinedObjectAcl_value = map[string]int32{
"PREDEFINED_OBJECT_ACL_UNSPECIFIED": 0,
"OBJECT_ACL_AUTHENTICATED_READ": 1,
"OBJECT_ACL_BUCKET_OWNER_FULL_CONTROL": 2,
"OBJECT_ACL_BUCKET_OWNER_READ": 3,
"OBJECT_ACL_PRIVATE": 4,
"OBJECT_ACL_PROJECT_PRIVATE": 5,
"OBJECT_ACL_PUBLIC_READ": 6,
}
)
var File_google_storage_v1_storage_proto protoreflect.FileDescriptor
var File_google_storage_v1_storage_resources_proto protoreflect.FileDescriptor
func RegisterStorageServer(s *grpc.Server, srv StorageServer)
A bucket.
type Bucket struct {
// Access controls on the bucket.
Acl []*BucketAccessControl `protobuf:"bytes,1,rep,name=acl,proto3" json:"acl,omitempty"`
// Default access controls to apply to new objects when no ACL is provided.
DefaultObjectAcl []*ObjectAccessControl `protobuf:"bytes,2,rep,name=default_object_acl,json=defaultObjectAcl,proto3" json:"default_object_acl,omitempty"`
// The bucket's lifecycle configuration. See
// [https://developers.google.com/storage/docs/lifecycle]Lifecycle Management]
// for more information.
Lifecycle *Bucket_Lifecycle `protobuf:"bytes,3,opt,name=lifecycle,proto3" json:"lifecycle,omitempty"`
// The creation time of the bucket in
// [https://tools.ietf.org/html/rfc3339][RFC 3339] format.
// Attempting to set or update this field will result in a
// [FieldViolation][google.rpc.BadRequest.FieldViolation].
TimeCreated *timestamppb.Timestamp `protobuf:"bytes,4,opt,name=time_created,json=timeCreated,proto3" json:"time_created,omitempty"`
// The ID of the bucket. For buckets, the `id` and `name` properties are the
// same.
// Attempting to update this field after the bucket is created will result in
// a [FieldViolation][google.rpc.BadRequest.FieldViolation].
Id string `protobuf:"bytes,5,opt,name=id,proto3" json:"id,omitempty"`
// The name of the bucket.
// Attempting to update this field after the bucket is created will result in
// an error.
Name string `protobuf:"bytes,6,opt,name=name,proto3" json:"name,omitempty"`
// The project number of the project the bucket belongs to.
// Attempting to set or update this field will result in a
// [FieldViolation][google.rpc.BadRequest.FieldViolation].
ProjectNumber int64 `protobuf:"varint,7,opt,name=project_number,json=projectNumber,proto3" json:"project_number,omitempty"`
// 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,8,opt,name=metageneration,proto3" json:"metageneration,omitempty"`
// The bucket's [https://www.w3.org/TR/cors/][Cross-Origin Resource Sharing]
// (CORS) configuration.
Cors []*Bucket_Cors `protobuf:"bytes,9,rep,name=cors,proto3" json:"cors,omitempty"`
// 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,10,opt,name=location,proto3" json:"location,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,11,opt,name=storage_class,json=storageClass,proto3" json:"storage_class,omitempty"`
// HTTP 1.1 [https://tools.ietf.org/html/rfc7232#section-2.3"]Entity tag]
// for the bucket.
// Attempting to set or update this field will result in a
// [FieldViolation][google.rpc.BadRequest.FieldViolation].
Etag string `protobuf:"bytes,12,opt,name=etag,proto3" json:"etag,omitempty"`
// The modification time of the bucket.
// Attempting to set or update this field will result in a
// [FieldViolation][google.rpc.BadRequest.FieldViolation].
Updated *timestamppb.Timestamp `protobuf:"bytes,13,opt,name=updated,proto3" json:"updated,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 configuration, 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 configuration.
Versioning *Bucket_Versioning `protobuf:"bytes,17,opt,name=versioning,proto3" json:"versioning,omitempty"`
// The bucket's logging configuration, which defines the destination bucket
// and optional name prefix for the current bucket's logs.
Logging *Bucket_Logging `protobuf:"bytes,18,opt,name=logging,proto3" json:"logging,omitempty"`
// 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 configuration for a bucket.
Encryption *Bucket_Encryption `protobuf:"bytes,20,opt,name=encryption,proto3" json:"encryption,omitempty"`
// The bucket's billing configuration.
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 location type of the bucket (region, dual-region, multi-region, etc).
LocationType string `protobuf:"bytes,23,opt,name=location_type,json=locationType,proto3" json:"location_type,omitempty"`
// The bucket's IAM configuration.
IamConfiguration *Bucket_IamConfiguration `protobuf:"bytes,24,opt,name=iam_configuration,json=iamConfiguration,proto3" json:"iam_configuration,omitempty"`
// The zone or zones from which the bucket is intended to use zonal quota.
// Requests for data from outside the specified affinities are still allowed
// but won't be able to use zonal quota. The values are case-insensitive.
// Attempting to update this field after bucket is created will result in an
// error.
//
// Deprecated: Do not use.
ZoneAffinity []string `protobuf:"bytes,25,rep,name=zone_affinity,json=zoneAffinity,proto3" json:"zone_affinity,omitempty"`
// Reserved for future use.
SatisfiesPzs bool `protobuf:"varint,26,opt,name=satisfies_pzs,json=satisfiesPzs,proto3" json:"satisfies_pzs,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) GetCors() []*Bucket_Cors
func (x *Bucket) GetDefaultEventBasedHold() bool
func (x *Bucket) GetDefaultObjectAcl() []*ObjectAccessControl
func (x *Bucket) GetEncryption() *Bucket_Encryption
func (x *Bucket) GetEtag() string
func (x *Bucket) GetIamConfiguration() *Bucket_IamConfiguration
func (x *Bucket) GetId() string
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) GetProjectNumber() int64
func (x *Bucket) GetRetentionPolicy() *Bucket_RetentionPolicy
func (x *Bucket) GetSatisfiesPzs() bool
func (x *Bucket) GetStorageClass() string
func (x *Bucket) GetTimeCreated() *timestamppb.Timestamp
func (x *Bucket) GetUpdated() *timestamppb.Timestamp
func (x *Bucket) GetVersioning() *Bucket_Versioning
func (x *Bucket) GetWebsite() *Bucket_Website
func (x *Bucket) GetZoneAffinity() []string
Deprecated: Do not use.
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"`
// HTTP 1.1 ["https://tools.ietf.org/html/rfc7232#section-2.3][Entity tag]
// for the access-control entry.
Etag string `protobuf:"bytes,2,opt,name=etag,proto3" json:"etag,omitempty"`
// The ID of the access-control entry.
Id string `protobuf:"bytes,3,opt,name=id,proto3" json:"id,omitempty"`
// The name of the bucket.
Bucket string `protobuf:"bytes,4,opt,name=bucket,proto3" json:"bucket,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,6,opt,name=entity,proto3" json:"entity,omitempty"`
// The ID for the entity, if any.
EntityId string `protobuf:"bytes,7,opt,name=entity_id,json=entityId,proto3" json:"entity_id,omitempty"`
// The email address associated with the entity, if any.
Email string `protobuf:"bytes,8,opt,name=email,proto3" json:"email,omitempty"`
// The domain associated with the entity, if any.
Domain string `protobuf:"bytes,9,opt,name=domain,proto3" json:"domain,omitempty"`
// The project team associated with the entity, if any.
ProjectTeam *ProjectTeam `protobuf:"bytes,10,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) GetBucket() string
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"`
// Latest instant at which the `enabled` bit was flipped.
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 GCS 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
Encryption properties of a bucket.
type Bucket_Encryption struct {
// A Cloud KMS key that will be used to encrypt objects inserted into this
// bucket, if no encryption method is specified.
DefaultKmsKeyName string `protobuf:"bytes,1,opt,name=default_kms_key_name,json=defaultKmsKeyName,proto3" json:"default_kms_key_name,omitempty"`
// contains filtered or unexported fields
}
func (*Bucket_Encryption) Descriptor() ([]byte, []int)
Deprecated: Use Bucket_Encryption.ProtoReflect.Descriptor instead.
func (x *Bucket_Encryption) GetDefaultKmsKeyName() 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 currently enforced on the bucket.
type Bucket_IamConfiguration struct {
UniformBucketLevelAccess *Bucket_IamConfiguration_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.
PublicAccessPrevention Bucket_IamConfiguration_PublicAccessPrevention `protobuf:"varint,2,opt,name=public_access_prevention,json=publicAccessPrevention,proto3,enum=google.storage.v1.Bucket_IamConfiguration_PublicAccessPrevention" json:"public_access_prevention,omitempty"`
// contains filtered or unexported fields
}
func (*Bucket_IamConfiguration) Descriptor() ([]byte, []int)
Deprecated: Use Bucket_IamConfiguration.ProtoReflect.Descriptor instead.
func (x *Bucket_IamConfiguration) GetPublicAccessPrevention() Bucket_IamConfiguration_PublicAccessPrevention
func (x *Bucket_IamConfiguration) GetUniformBucketLevelAccess() *Bucket_IamConfiguration_UniformBucketLevelAccess
func (*Bucket_IamConfiguration) ProtoMessage()
func (x *Bucket_IamConfiguration) ProtoReflect() protoreflect.Message
func (x *Bucket_IamConfiguration) Reset()
func (x *Bucket_IamConfiguration) String() string
Public Access Prevention configuration values.
type Bucket_IamConfiguration_PublicAccessPrevention int32
const (
// No specified PublicAccessPrevention.
Bucket_IamConfiguration_PUBLIC_ACCESS_PREVENTION_UNSPECIFIED Bucket_IamConfiguration_PublicAccessPrevention = 0
// Prevents access from being granted to public members 'allUsers' and
// 'allAuthenticatedUsers'. Prevents attempts to grant new access to
// public members.
Bucket_IamConfiguration_ENFORCED Bucket_IamConfiguration_PublicAccessPrevention = 1
// This setting is inherited from Org Policy. Does not prevent access from
// being granted to public members 'allUsers' or 'allAuthenticatedUsers'.
Bucket_IamConfiguration_INHERITED Bucket_IamConfiguration_PublicAccessPrevention = 2
)
func (Bucket_IamConfiguration_PublicAccessPrevention) Descriptor() protoreflect.EnumDescriptor
func (x Bucket_IamConfiguration_PublicAccessPrevention) Enum() *Bucket_IamConfiguration_PublicAccessPrevention
func (Bucket_IamConfiguration_PublicAccessPrevention) EnumDescriptor() ([]byte, []int)
Deprecated: Use Bucket_IamConfiguration_PublicAccessPrevention.Descriptor instead.
func (x Bucket_IamConfiguration_PublicAccessPrevention) Number() protoreflect.EnumNumber
func (x Bucket_IamConfiguration_PublicAccessPrevention) String() string
func (Bucket_IamConfiguration_PublicAccessPrevention) Type() protoreflect.EnumType
type Bucket_IamConfiguration_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
// <code>iamConfiguration.uniformBucketLevelAccess.enabled</code> from
// true to false in [https://tools.ietf.org/html/rfc3339][RFC 3339]. After
// the deadline is passed the field is immutable.
LockedTime *timestamppb.Timestamp `protobuf:"bytes,2,opt,name=locked_time,json=lockedTime,proto3" json:"locked_time,omitempty"`
// contains filtered or unexported fields
}
func (*Bucket_IamConfiguration_UniformBucketLevelAccess) Descriptor() ([]byte, []int)
Deprecated: Use Bucket_IamConfiguration_UniformBucketLevelAccess.ProtoReflect.Descriptor instead.
func (x *Bucket_IamConfiguration_UniformBucketLevelAccess) GetEnabled() bool
func (x *Bucket_IamConfiguration_UniformBucketLevelAccess) GetLockedTime() *timestamppb.Timestamp
func (*Bucket_IamConfiguration_UniformBucketLevelAccess) ProtoMessage()
func (x *Bucket_IamConfiguration_UniformBucketLevelAccess) ProtoReflect() protoreflect.Message
func (x *Bucket_IamConfiguration_UniformBucketLevelAccess) Reset()
func (x *Bucket_IamConfiguration_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.
Age int32 `protobuf:"varint,1,opt,name=age,proto3" json:"age,omitempty"`
// A date in [RFC 3339][1] format with only the date part (for
// instance, "2013-01-15"). This condition is satisfied when an
// object is created before midnight of the specified date in UTC.
// [1]: https://tools.ietf.org/html/rfc3339
CreatedBefore *timestamppb.Timestamp `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 *wrapperspb.BoolValue `protobuf:"bytes,3,opt,name=is_live,json=isLive,proto3" 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" 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"`
// A regular expression that satisfies the RE2 syntax. This condition is
// satisfied when the name of the object matches the RE2 pattern. Note:
// This feature is currently in the "Early Access" launch stage and is
// only available to an allowlisted set of users; that means that this
// feature may be changed in backward-incompatible ways and that it is
// not guaranteed to be released.
MatchesPattern string `protobuf:"bytes,6,opt,name=matches_pattern,json=matchesPattern,proto3" json:"matches_pattern,omitempty"`
// Number of days that has elapsed since the custom timestamp set on an
// object.
DaysSinceCustomTime int32 `protobuf:"varint,7,opt,name=days_since_custom_time,json=daysSinceCustomTime,proto3" json:"days_since_custom_time,omitempty"`
// An object matches this condition if the custom timestamp set on the
// object is before this timestamp.
CustomTimeBefore *timestamppb.Timestamp `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" 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 timestamp.
NoncurrentTimeBefore *timestamppb.Timestamp `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) GetAge() int32
func (x *Bucket_Lifecycle_Rule_Condition) GetCreatedBefore() *timestamppb.Timestamp
func (x *Bucket_Lifecycle_Rule_Condition) GetCustomTimeBefore() *timestamppb.Timestamp
func (x *Bucket_Lifecycle_Rule_Condition) GetDaysSinceCustomTime() int32
func (x *Bucket_Lifecycle_Rule_Condition) GetDaysSinceNoncurrentTime() int32
func (x *Bucket_Lifecycle_Rule_Condition) GetIsLive() *wrapperspb.BoolValue
func (x *Bucket_Lifecycle_Rule_Condition) GetMatchesPattern() string
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() *timestamppb.Timestamp
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.
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. This value is in
// [https://tools.ietf.org/html/rfc3339][RFC 3339] format.
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 GCS 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 GCS, 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
An notification channel used to watch for resource changes.
type Channel struct {
// A UUID or similar unique string that identifies this channel.
Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
// An opaque ID that identifies the resource being watched on this channel.
// Stable across different API versions.
ResourceId string `protobuf:"bytes,2,opt,name=resource_id,json=resourceId,proto3" json:"resource_id,omitempty"`
// A version-specific identifier for the watched resource.
ResourceUri string `protobuf:"bytes,3,opt,name=resource_uri,json=resourceUri,proto3" json:"resource_uri,omitempty"`
// An arbitrary string delivered to the target address with each notification
// delivered over this channel. Optional.
Token string `protobuf:"bytes,4,opt,name=token,proto3" json:"token,omitempty"`
// Date and time of notification channel expiration. Optional.
Expiration *timestamppb.Timestamp `protobuf:"bytes,5,opt,name=expiration,proto3" json:"expiration,omitempty"`
// The type of delivery mechanism used for this channel.
Type string `protobuf:"bytes,6,opt,name=type,proto3" json:"type,omitempty"`
// The address where notifications are delivered for this channel.
Address string `protobuf:"bytes,7,opt,name=address,proto3" json:"address,omitempty"`
// Additional parameters controlling delivery channel behavior. Optional.
Params map[string]string `protobuf:"bytes,8,rep,name=params,proto3" json:"params,omitempty" protobuf_key:"bytes,1,opt,name=key,proto3" protobuf_val:"bytes,2,opt,name=value,proto3"`
// A Boolean value to indicate whether payload is wanted. Optional.
Payload bool `protobuf:"varint,9,opt,name=payload,proto3" json:"payload,omitempty"`
// contains filtered or unexported fields
}
func (*Channel) Descriptor() ([]byte, []int)
Deprecated: Use Channel.ProtoReflect.Descriptor instead.
func (x *Channel) GetAddress() string
func (x *Channel) GetExpiration() *timestamppb.Timestamp
func (x *Channel) GetId() string
func (x *Channel) GetParams() map[string]string
func (x *Channel) GetPayload() bool
func (x *Channel) GetResourceId() string
func (x *Channel) GetResourceUri() string
func (x *Channel) GetToken() string
func (x *Channel) GetType() string
func (*Channel) ProtoMessage()
func (x *Channel) ProtoReflect() protoreflect.Message
func (x *Channel) Reset()
func (x *Channel) String() string
Message used to convey content being read or written, along with its checksum.
type ChecksummedData struct {
// The data.
Content []byte `protobuf:"bytes,1,opt,name=content,proto3" json:"content,omitempty"`
// CRC32C digest of the contents.
Crc32C *wrapperspb.UInt32Value `protobuf:"bytes,2,opt,name=crc32c,proto3" 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() *wrapperspb.UInt32Value
func (*ChecksummedData) ProtoMessage()
func (x *ChecksummedData) ProtoReflect() protoreflect.Message
func (x *ChecksummedData) Reset()
func (x *ChecksummedData) String() string
A collection of enums used in multiple places throughout the API.
type CommonEnums struct {
// contains filtered or unexported fields
}
func (*CommonEnums) Descriptor() ([]byte, []int)
Deprecated: Use CommonEnums.ProtoReflect.Descriptor instead.
func (*CommonEnums) ProtoMessage()
func (x *CommonEnums) ProtoReflect() protoreflect.Message
func (x *CommonEnums) Reset()
func (x *CommonEnums) String() string
Predefined or "canned" aliases for sets of specific bucket ACL entries.
type CommonEnums_PredefinedBucketAcl int32
const (
// No predefined ACL.
CommonEnums_PREDEFINED_BUCKET_ACL_UNSPECIFIED CommonEnums_PredefinedBucketAcl = 0
// Project team owners get `OWNER` access, and
// `allAuthenticatedUsers` get `READER` access.
CommonEnums_BUCKET_ACL_AUTHENTICATED_READ CommonEnums_PredefinedBucketAcl = 1
// Project team owners get `OWNER` access.
CommonEnums_BUCKET_ACL_PRIVATE CommonEnums_PredefinedBucketAcl = 2
// Project team members get access according to their roles.
CommonEnums_BUCKET_ACL_PROJECT_PRIVATE CommonEnums_PredefinedBucketAcl = 3
// Project team owners get `OWNER` access, and
// `allUsers` get `READER` access.
CommonEnums_BUCKET_ACL_PUBLIC_READ CommonEnums_PredefinedBucketAcl = 4
// Project team owners get `OWNER` access, and
// `allUsers` get `WRITER` access.
CommonEnums_BUCKET_ACL_PUBLIC_READ_WRITE CommonEnums_PredefinedBucketAcl = 5
)
func (CommonEnums_PredefinedBucketAcl) Descriptor() protoreflect.EnumDescriptor
func (x CommonEnums_PredefinedBucketAcl) Enum() *CommonEnums_PredefinedBucketAcl
func (CommonEnums_PredefinedBucketAcl) EnumDescriptor() ([]byte, []int)
Deprecated: Use CommonEnums_PredefinedBucketAcl.Descriptor instead.
func (x CommonEnums_PredefinedBucketAcl) Number() protoreflect.EnumNumber
func (x CommonEnums_PredefinedBucketAcl) String() string
func (CommonEnums_PredefinedBucketAcl) Type() protoreflect.EnumType
Predefined or "canned" aliases for sets of specific object ACL entries.
type CommonEnums_PredefinedObjectAcl int32
const (
// No predefined ACL.
CommonEnums_PREDEFINED_OBJECT_ACL_UNSPECIFIED CommonEnums_PredefinedObjectAcl = 0
// Object owner gets `OWNER` access, and
// `allAuthenticatedUsers` get `READER` access.
CommonEnums_OBJECT_ACL_AUTHENTICATED_READ CommonEnums_PredefinedObjectAcl = 1
// Object owner gets `OWNER` access, and project team owners get
// `OWNER` access.
CommonEnums_OBJECT_ACL_BUCKET_OWNER_FULL_CONTROL CommonEnums_PredefinedObjectAcl = 2
// Object owner gets `OWNER` access, and project team owners get
// `READER` access.
CommonEnums_OBJECT_ACL_BUCKET_OWNER_READ CommonEnums_PredefinedObjectAcl = 3
// Object owner gets `OWNER` access.
CommonEnums_OBJECT_ACL_PRIVATE CommonEnums_PredefinedObjectAcl = 4
// Object owner gets `OWNER` access, and project team members get
// access according to their roles.
CommonEnums_OBJECT_ACL_PROJECT_PRIVATE CommonEnums_PredefinedObjectAcl = 5
// Object owner gets `OWNER` access, and `allUsers`
// get `READER` access.
CommonEnums_OBJECT_ACL_PUBLIC_READ CommonEnums_PredefinedObjectAcl = 6
)
func (CommonEnums_PredefinedObjectAcl) Descriptor() protoreflect.EnumDescriptor
func (x CommonEnums_PredefinedObjectAcl) Enum() *CommonEnums_PredefinedObjectAcl
func (CommonEnums_PredefinedObjectAcl) EnumDescriptor() ([]byte, []int)
Deprecated: Use CommonEnums_PredefinedObjectAcl.Descriptor instead.
func (x CommonEnums_PredefinedObjectAcl) Number() protoreflect.EnumNumber
func (x CommonEnums_PredefinedObjectAcl) String() string
func (CommonEnums_PredefinedObjectAcl) Type() protoreflect.EnumType
A set of properties to return in a response.
type CommonEnums_Projection int32
const (
// No specified projection.
CommonEnums_PROJECTION_UNSPECIFIED CommonEnums_Projection = 0
// Omit `owner`, `acl`, and `defaultObjectAcl` properties.
CommonEnums_NO_ACL CommonEnums_Projection = 1
// Include all properties.
CommonEnums_FULL CommonEnums_Projection = 2
)
func (CommonEnums_Projection) Descriptor() protoreflect.EnumDescriptor
func (x CommonEnums_Projection) Enum() *CommonEnums_Projection
func (CommonEnums_Projection) EnumDescriptor() ([]byte, []int)
Deprecated: Use CommonEnums_Projection.Descriptor instead.
func (x CommonEnums_Projection) Number() protoreflect.EnumNumber
func (x CommonEnums_Projection) String() string
func (CommonEnums_Projection) Type() protoreflect.EnumType
Parameters that can be passed to any object request.
type CommonObjectRequestParams struct {
// Encryption algorithm used with 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 Customer-Supplied Encryption Keys feature.
EncryptionKey string `protobuf:"bytes,2,opt,name=encryption_key,json=encryptionKey,proto3" json:"encryption_key,omitempty"`
// SHA256 hash of encryption key used with Customer-Supplied Encryption Keys
// feature.
EncryptionKeySha256 string `protobuf:"bytes,3,opt,name=encryption_key_sha256,json=encryptionKeySha256,proto3" json:"encryption_key_sha256,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) GetEncryptionKey() string
func (x *CommonObjectRequestParams) GetEncryptionKeySha256() string
func (*CommonObjectRequestParams) ProtoMessage()
func (x *CommonObjectRequestParams) ProtoReflect() protoreflect.Message
func (x *CommonObjectRequestParams) Reset()
func (x *CommonObjectRequestParams) String() string
Parameters that can be passed to any request.
type CommonRequestParams struct {
// Required. Required when using buckets with Requestor Pays feature enabled.
UserProject string `protobuf:"bytes,1,opt,name=user_project,json=userProject,proto3" json:"user_project,omitempty"`
// Lets you enforce per-user quotas from a server-side application even in
// cases when the user's IP address is unknown. This can occur, for example,
// with applications that run cron jobs on App Engine on a user's behalf.
// You can choose any arbitrary string that uniquely identifies a user, but it
// is limited to 40 characters.
QuotaUser string `protobuf:"bytes,2,opt,name=quota_user,json=quotaUser,proto3" json:"quota_user,omitempty"`
// Subset of fields to include in the response.
Fields *fieldmaskpb.FieldMask `protobuf:"bytes,4,opt,name=fields,proto3" json:"fields,omitempty"`
// contains filtered or unexported fields
}
func (*CommonRequestParams) Descriptor() ([]byte, []int)
Deprecated: Use CommonRequestParams.ProtoReflect.Descriptor instead.
func (x *CommonRequestParams) GetFields() *fieldmaskpb.FieldMask
func (x *CommonRequestParams) GetQuotaUser() string
func (x *CommonRequestParams) GetUserProject() string
func (*CommonRequestParams) ProtoMessage()
func (x *CommonRequestParams) ProtoReflect() protoreflect.Message
func (x *CommonRequestParams) Reset()
func (x *CommonRequestParams) String() string
Request message for ComposeObject.
type ComposeObjectRequest struct {
// Required. Name of the bucket containing the source objects. The destination object is
// stored in this bucket.
DestinationBucket string `protobuf:"bytes,1,opt,name=destination_bucket,json=destinationBucket,proto3" json:"destination_bucket,omitempty"`
// Required. Name of the new object.
DestinationObject string `protobuf:"bytes,2,opt,name=destination_object,json=destinationObject,proto3" json:"destination_object,omitempty"`
// Apply a predefined set of access controls to the destination object.
DestinationPredefinedAcl CommonEnums_PredefinedObjectAcl `protobuf:"varint,3,opt,name=destination_predefined_acl,json=destinationPredefinedAcl,proto3,enum=google.storage.v1.CommonEnums_PredefinedObjectAcl" json:"destination_predefined_acl,omitempty"`
// Properties of the resulting object.
Destination *Object `protobuf:"bytes,11,opt,name=destination,proto3" json:"destination,omitempty"`
// The list of source objects that will be concatenated into a single object.
SourceObjects []*ComposeObjectRequest_SourceObjects `protobuf:"bytes,12,rep,name=source_objects,json=sourceObjects,proto3" json:"source_objects,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 *wrapperspb.Int64Value `protobuf:"bytes,4,opt,name=if_generation_match,json=ifGenerationMatch,proto3" json:"if_generation_match,omitempty"`
// Makes the operation conditional on whether the object's current
// metageneration matches the given value.
IfMetagenerationMatch *wrapperspb.Int64Value `protobuf:"bytes,5,opt,name=if_metageneration_match,json=ifMetagenerationMatch,proto3" 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.
KmsKeyName string `protobuf:"bytes,6,opt,name=kms_key_name,json=kmsKeyName,proto3" json:"kms_key_name,omitempty"`
// A set of parameters common to Storage API requests concerning an object.
CommonObjectRequestParams *CommonObjectRequestParams `protobuf:"bytes,9,opt,name=common_object_request_params,json=commonObjectRequestParams,proto3" json:"common_object_request_params,omitempty"`
// A set of parameters common to all Storage API requests.
CommonRequestParams *CommonRequestParams `protobuf:"bytes,10,opt,name=common_request_params,json=commonRequestParams,proto3" json:"common_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) GetCommonRequestParams() *CommonRequestParams
func (x *ComposeObjectRequest) GetDestination() *Object
func (x *ComposeObjectRequest) GetDestinationBucket() string
func (x *ComposeObjectRequest) GetDestinationObject() string
func (x *ComposeObjectRequest) GetDestinationPredefinedAcl() CommonEnums_PredefinedObjectAcl
func (x *ComposeObjectRequest) GetIfGenerationMatch() *wrapperspb.Int64Value
func (x *ComposeObjectRequest) GetIfMetagenerationMatch() *wrapperspb.Int64Value
func (x *ComposeObjectRequest) GetKmsKeyName() string
func (x *ComposeObjectRequest) GetSourceObjects() []*ComposeObjectRequest_SourceObjects
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_SourceObjects struct {
// 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_SourceObjects_ObjectPreconditions `protobuf:"bytes,3,opt,name=object_preconditions,json=objectPreconditions,proto3" json:"object_preconditions,omitempty"`
// contains filtered or unexported fields
}
func (*ComposeObjectRequest_SourceObjects) Descriptor() ([]byte, []int)
Deprecated: Use ComposeObjectRequest_SourceObjects.ProtoReflect.Descriptor instead.
func (x *ComposeObjectRequest_SourceObjects) GetGeneration() int64
func (x *ComposeObjectRequest_SourceObjects) GetName() string
func (x *ComposeObjectRequest_SourceObjects) GetObjectPreconditions() *ComposeObjectRequest_SourceObjects_ObjectPreconditions
func (*ComposeObjectRequest_SourceObjects) ProtoMessage()
func (x *ComposeObjectRequest_SourceObjects) ProtoReflect() protoreflect.Message
func (x *ComposeObjectRequest_SourceObjects) Reset()
func (x *ComposeObjectRequest_SourceObjects) String() string
Preconditions for a source object of a composition request.
type ComposeObjectRequest_SourceObjects_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 *wrapperspb.Int64Value `protobuf:"bytes,1,opt,name=if_generation_match,json=ifGenerationMatch,proto3" json:"if_generation_match,omitempty"`
// contains filtered or unexported fields
}
func (*ComposeObjectRequest_SourceObjects_ObjectPreconditions) Descriptor() ([]byte, []int)
Deprecated: Use ComposeObjectRequest_SourceObjects_ObjectPreconditions.ProtoReflect.Descriptor instead.
func (x *ComposeObjectRequest_SourceObjects_ObjectPreconditions) GetIfGenerationMatch() *wrapperspb.Int64Value
func (*ComposeObjectRequest_SourceObjects_ObjectPreconditions) ProtoMessage()
func (x *ComposeObjectRequest_SourceObjects_ObjectPreconditions) ProtoReflect() protoreflect.Message
func (x *ComposeObjectRequest_SourceObjects_ObjectPreconditions) Reset()
func (x *ComposeObjectRequest_SourceObjects_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 CopyObject.
type CopyObjectRequest struct {
// Required. Name of the bucket in which to store the new object. Overrides the provided
// object
// metadata's `bucket` value, if any.
DestinationBucket string `protobuf:"bytes,1,opt,name=destination_bucket,json=destinationBucket,proto3" json:"destination_bucket,omitempty"`
// Required. Name of the new object.
// Required when the object metadata is not otherwise provided. Overrides the
// object metadata's `name` value, if any.
DestinationObject string `protobuf:"bytes,2,opt,name=destination_object,json=destinationObject,proto3" json:"destination_object,omitempty"`
// Apply a predefined set of access controls to the destination object.
DestinationPredefinedAcl CommonEnums_PredefinedObjectAcl `protobuf:"varint,3,opt,name=destination_predefined_acl,json=destinationPredefinedAcl,proto3,enum=google.storage.v1.CommonEnums_PredefinedObjectAcl" json:"destination_predefined_acl,omitempty"`
// Makes the operation conditional on whether the destination object's current
// generation matches the given value. Setting to 0 makes the operation
// succeed only if there are no live versions of the object.
IfGenerationMatch *wrapperspb.Int64Value `protobuf:"bytes,4,opt,name=if_generation_match,json=ifGenerationMatch,proto3" json:"if_generation_match,omitempty"`
// Makes the operation conditional on whether the destination object's current
// generation does not match the given value. If no live object exists, the
// precondition fails. Setting to 0 makes the operation succeed only if there
// is a live version of the object.
IfGenerationNotMatch *wrapperspb.Int64Value `protobuf:"bytes,5,opt,name=if_generation_not_match,json=ifGenerationNotMatch,proto3" json:"if_generation_not_match,omitempty"`
// Makes the operation conditional on whether the destination object's current
// metageneration matches the given value.
IfMetagenerationMatch *wrapperspb.Int64Value `protobuf:"bytes,6,opt,name=if_metageneration_match,json=ifMetagenerationMatch,proto3" json:"if_metageneration_match,omitempty"`
// Makes the operation conditional on whether the destination object's current
// metageneration does not match the given value.
IfMetagenerationNotMatch *wrapperspb.Int64Value `protobuf:"bytes,7,opt,name=if_metageneration_not_match,json=ifMetagenerationNotMatch,proto3" json:"if_metageneration_not_match,omitempty"`
// Makes the operation conditional on whether the source object's current
// generation matches the given value.
IfSourceGenerationMatch *wrapperspb.Int64Value `protobuf:"bytes,8,opt,name=if_source_generation_match,json=ifSourceGenerationMatch,proto3" json:"if_source_generation_match,omitempty"`
// Makes the operation conditional on whether the source object's current
// generation does not match the given value.
IfSourceGenerationNotMatch *wrapperspb.Int64Value `protobuf:"bytes,9,opt,name=if_source_generation_not_match,json=ifSourceGenerationNotMatch,proto3" json:"if_source_generation_not_match,omitempty"`
// Makes the operation conditional on whether the source object's current
// metageneration matches the given value.
IfSourceMetagenerationMatch *wrapperspb.Int64Value `protobuf:"bytes,10,opt,name=if_source_metageneration_match,json=ifSourceMetagenerationMatch,proto3" 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 *wrapperspb.Int64Value `protobuf:"bytes,11,opt,name=if_source_metageneration_not_match,json=ifSourceMetagenerationNotMatch,proto3" json:"if_source_metageneration_not_match,omitempty"`
// Set of properties to return. Defaults to `NO_ACL`, unless the
// object resource specifies the `acl` property, when it defaults
// to `full`.
Projection CommonEnums_Projection `protobuf:"varint,12,opt,name=projection,proto3,enum=google.storage.v1.CommonEnums_Projection" json:"projection,omitempty"`
// Required. Name of the bucket in which to find the source object.
SourceBucket string `protobuf:"bytes,13,opt,name=source_bucket,json=sourceBucket,proto3" json:"source_bucket,omitempty"`
// Required. Name of the source object.
SourceObject string `protobuf:"bytes,14,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,15,opt,name=source_generation,json=sourceGeneration,proto3" json:"source_generation,omitempty"`
// Properties of the resulting object. If not set, duplicate properties of
// source object.
Destination *Object `protobuf:"bytes,17,opt,name=destination,proto3" json:"destination,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.
DestinationKmsKeyName string `protobuf:"bytes,20,opt,name=destination_kms_key_name,json=destinationKmsKeyName,proto3" json:"destination_kms_key_name,omitempty"`
// A set of parameters common to Storage API requests concerning an object.
CommonObjectRequestParams *CommonObjectRequestParams `protobuf:"bytes,18,opt,name=common_object_request_params,json=commonObjectRequestParams,proto3" json:"common_object_request_params,omitempty"`
// A set of parameters common to all Storage API requests.
CommonRequestParams *CommonRequestParams `protobuf:"bytes,19,opt,name=common_request_params,json=commonRequestParams,proto3" json:"common_request_params,omitempty"`
// contains filtered or unexported fields
}
func (*CopyObjectRequest) Descriptor() ([]byte, []int)
Deprecated: Use CopyObjectRequest.ProtoReflect.Descriptor instead.
func (x *CopyObjectRequest) GetCommonObjectRequestParams() *CommonObjectRequestParams
func (x *CopyObjectRequest) GetCommonRequestParams() *CommonRequestParams
func (x *CopyObjectRequest) GetDestination() *Object
func (x *CopyObjectRequest) GetDestinationBucket() string
func (x *CopyObjectRequest) GetDestinationKmsKeyName() string
func (x *CopyObjectRequest) GetDestinationObject() string
func (x *CopyObjectRequest) GetDestinationPredefinedAcl() CommonEnums_PredefinedObjectAcl
func (x *CopyObjectRequest) GetIfGenerationMatch() *wrapperspb.Int64Value
func (x *CopyObjectRequest) GetIfGenerationNotMatch() *wrapperspb.Int64Value
func (x *CopyObjectRequest) GetIfMetagenerationMatch() *wrapperspb.Int64Value
func (x *CopyObjectRequest) GetIfMetagenerationNotMatch() *wrapperspb.Int64Value
func (x *CopyObjectRequest) GetIfSourceGenerationMatch() *wrapperspb.Int64Value
func (x *CopyObjectRequest) GetIfSourceGenerationNotMatch() *wrapperspb.Int64Value
func (x *CopyObjectRequest) GetIfSourceMetagenerationMatch() *wrapperspb.Int64Value
func (x *CopyObjectRequest) GetIfSourceMetagenerationNotMatch() *wrapperspb.Int64Value
func (x *CopyObjectRequest) GetProjection() CommonEnums_Projection
func (x *CopyObjectRequest) GetSourceBucket() string
func (x *CopyObjectRequest) GetSourceGeneration() int64
func (x *CopyObjectRequest) GetSourceObject() string
func (*CopyObjectRequest) ProtoMessage()
func (x *CopyObjectRequest) ProtoReflect() protoreflect.Message
func (x *CopyObjectRequest) Reset()
func (x *CopyObjectRequest) String() string
type CreateHmacKeyRequest struct {
// Required. The project that the HMAC-owning service account lives in.
ProjectId string `protobuf:"bytes,1,opt,name=project_id,json=projectId,proto3" json:"project_id,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"`
// A set of parameters common to all Storage API requests.
CommonRequestParams *CommonRequestParams `protobuf:"bytes,3,opt,name=common_request_params,json=commonRequestParams,proto3" json:"common_request_params,omitempty"`
// contains filtered or unexported fields
}
func (*CreateHmacKeyRequest) Descriptor() ([]byte, []int)
Deprecated: Use CreateHmacKeyRequest.ProtoReflect.Descriptor instead.
func (x *CreateHmacKeyRequest) GetCommonRequestParams() *CommonRequestParams
func (x *CreateHmacKeyRequest) GetProjectId() 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.
Secret string `protobuf:"bytes,2,opt,name=secret,proto3" json:"secret,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) GetSecret() string
func (*CreateHmacKeyResponse) ProtoMessage()
func (x *CreateHmacKeyResponse) ProtoReflect() protoreflect.Message
func (x *CreateHmacKeyResponse) Reset()
func (x *CreateHmacKeyResponse) String() string
Request message for DeleteBucketAccessControl.
type DeleteBucketAccessControlRequest struct {
// Required. Name of a bucket.
Bucket string `protobuf:"bytes,1,opt,name=bucket,proto3" json:"bucket,omitempty"`
// Required. The entity holding the permission. Can be one of:
// * `user-`*userId*
// * `user-`*emailAddress*
// * `group-`*groupId*
// * `group-`*emailAddress*
// * `allUsers`
// * `allAuthenticatedUsers`
Entity string `protobuf:"bytes,2,opt,name=entity,proto3" json:"entity,omitempty"`
// A set of parameters common to all Storage API requests.
CommonRequestParams *CommonRequestParams `protobuf:"bytes,4,opt,name=common_request_params,json=commonRequestParams,proto3" json:"common_request_params,omitempty"`
// contains filtered or unexported fields
}
func (*DeleteBucketAccessControlRequest) Descriptor() ([]byte, []int)
Deprecated: Use DeleteBucketAccessControlRequest.ProtoReflect.Descriptor instead.
func (x *DeleteBucketAccessControlRequest) GetBucket() string
func (x *DeleteBucketAccessControlRequest) GetCommonRequestParams() *CommonRequestParams
func (x *DeleteBucketAccessControlRequest) GetEntity() string
func (*DeleteBucketAccessControlRequest) ProtoMessage()
func (x *DeleteBucketAccessControlRequest) ProtoReflect() protoreflect.Message
func (x *DeleteBucketAccessControlRequest) Reset()
func (x *DeleteBucketAccessControlRequest) String() string
Request message for DeleteBucket.
type DeleteBucketRequest struct {
// Required. Name of a bucket.
Bucket string `protobuf:"bytes,1,opt,name=bucket,proto3" json:"bucket,omitempty"`
// If set, only deletes the bucket if its metageneration matches this value.
IfMetagenerationMatch *wrapperspb.Int64Value `protobuf:"bytes,2,opt,name=if_metageneration_match,json=ifMetagenerationMatch,proto3" json:"if_metageneration_match,omitempty"`
// If set, only deletes the bucket if its metageneration does not match this
// value.
IfMetagenerationNotMatch *wrapperspb.Int64Value `protobuf:"bytes,3,opt,name=if_metageneration_not_match,json=ifMetagenerationNotMatch,proto3" json:"if_metageneration_not_match,omitempty"`
// A set of parameters common to all Storage API requests.
CommonRequestParams *CommonRequestParams `protobuf:"bytes,5,opt,name=common_request_params,json=commonRequestParams,proto3" json:"common_request_params,omitempty"`
// contains filtered or unexported fields
}
func (*DeleteBucketRequest) Descriptor() ([]byte, []int)
Deprecated: Use DeleteBucketRequest.ProtoReflect.Descriptor instead.
func (x *DeleteBucketRequest) GetBucket() string
func (x *DeleteBucketRequest) GetCommonRequestParams() *CommonRequestParams
func (x *DeleteBucketRequest) GetIfMetagenerationMatch() *wrapperspb.Int64Value
func (x *DeleteBucketRequest) GetIfMetagenerationNotMatch() *wrapperspb.Int64Value
func (*DeleteBucketRequest) ProtoMessage()
func (x *DeleteBucketRequest) ProtoReflect() protoreflect.Message
func (x *DeleteBucketRequest) Reset()
func (x *DeleteBucketRequest) String() string
Request message for DeleteDefaultObjectAccessControl.
type DeleteDefaultObjectAccessControlRequest struct {
// Required. Name of a bucket.
Bucket string `protobuf:"bytes,1,opt,name=bucket,proto3" json:"bucket,omitempty"`
// Required. The entity holding the permission. Can be one of:
// * `user-`*userId*
// * `user-`*emailAddress*
// * `group-`*groupId*
// * `group-`*emailAddress*
// * `allUsers`
// * `allAuthenticatedUsers`
Entity string `protobuf:"bytes,2,opt,name=entity,proto3" json:"entity,omitempty"`
// A set of parameters common to all Storage API requests.
CommonRequestParams *CommonRequestParams `protobuf:"bytes,4,opt,name=common_request_params,json=commonRequestParams,proto3" json:"common_request_params,omitempty"`
// contains filtered or unexported fields
}
func (*DeleteDefaultObjectAccessControlRequest) Descriptor() ([]byte, []int)
Deprecated: Use DeleteDefaultObjectAccessControlRequest.ProtoReflect.Descriptor instead.
func (x *DeleteDefaultObjectAccessControlRequest) GetBucket() string
func (x *DeleteDefaultObjectAccessControlRequest) GetCommonRequestParams() *CommonRequestParams
func (x *DeleteDefaultObjectAccessControlRequest) GetEntity() string
func (*DeleteDefaultObjectAccessControlRequest) ProtoMessage()
func (x *DeleteDefaultObjectAccessControlRequest) ProtoReflect() protoreflect.Message
func (x *DeleteDefaultObjectAccessControlRequest) Reset()
func (x *DeleteDefaultObjectAccessControlRequest) 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.
ProjectId string `protobuf:"bytes,2,opt,name=project_id,json=projectId,proto3" json:"project_id,omitempty"`
// A set of parameters common to all Storage API requests.
CommonRequestParams *CommonRequestParams `protobuf:"bytes,3,opt,name=common_request_params,json=commonRequestParams,proto3" json:"common_request_params,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) GetCommonRequestParams() *CommonRequestParams
func (x *DeleteHmacKeyRequest) GetProjectId() 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.
Bucket string `protobuf:"bytes,1,opt,name=bucket,proto3" json:"bucket,omitempty"`
// Required. ID of the notification to delete.
Notification string `protobuf:"bytes,2,opt,name=notification,proto3" json:"notification,omitempty"`
// A set of parameters common to all Storage API requests.
CommonRequestParams *CommonRequestParams `protobuf:"bytes,4,opt,name=common_request_params,json=commonRequestParams,proto3" json:"common_request_params,omitempty"`
// contains filtered or unexported fields
}
func (*DeleteNotificationRequest) Descriptor() ([]byte, []int)
Deprecated: Use DeleteNotificationRequest.ProtoReflect.Descriptor instead.
func (x *DeleteNotificationRequest) GetBucket() string
func (x *DeleteNotificationRequest) GetCommonRequestParams() *CommonRequestParams
func (x *DeleteNotificationRequest) GetNotification() string
func (*DeleteNotificationRequest) ProtoMessage()
func (x *DeleteNotificationRequest) ProtoReflect() protoreflect.Message
func (x *DeleteNotificationRequest) Reset()
func (x *DeleteNotificationRequest) String() string
Request message for DeleteObjectAccessControl.
type DeleteObjectAccessControlRequest struct {
// Required. Name of a bucket.
Bucket string `protobuf:"bytes,1,opt,name=bucket,proto3" json:"bucket,omitempty"`
// Required. The entity holding the permission. Can be one of:
// * `user-`*userId*
// * `user-`*emailAddress*
// * `group-`*groupId*
// * `group-`*emailAddress*
// * `allUsers`
// * `allAuthenticatedUsers`
Entity string `protobuf:"bytes,2,opt,name=entity,proto3" json:"entity,omitempty"`
// Required. Name of the object.
Object string `protobuf:"bytes,3,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,4,opt,name=generation,proto3" json:"generation,omitempty"`
// A set of parameters common to all Storage API requests.
CommonRequestParams *CommonRequestParams `protobuf:"bytes,6,opt,name=common_request_params,json=commonRequestParams,proto3" json:"common_request_params,omitempty"`
// contains filtered or unexported fields
}
func (*DeleteObjectAccessControlRequest) Descriptor() ([]byte, []int)
Deprecated: Use DeleteObjectAccessControlRequest.ProtoReflect.Descriptor instead.
func (x *DeleteObjectAccessControlRequest) GetBucket() string
func (x *DeleteObjectAccessControlRequest) GetCommonRequestParams() *CommonRequestParams
func (x *DeleteObjectAccessControlRequest) GetEntity() string
func (x *DeleteObjectAccessControlRequest) GetGeneration() int64
func (x *DeleteObjectAccessControlRequest) GetObject() string
func (*DeleteObjectAccessControlRequest) ProtoMessage()
func (x *DeleteObjectAccessControlRequest) ProtoReflect() protoreflect.Message
func (x *DeleteObjectAccessControlRequest) Reset()
func (x *DeleteObjectAccessControlRequest) 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 using a
// 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 *wrapperspb.Int64Value `protobuf:"bytes,5,opt,name=if_generation_match,json=ifGenerationMatch,proto3" json:"if_generation_match,omitempty"`
// Makes the operation conditional on whether the object's current generation
// does not match the given value. If no live object exists, the precondition
// fails. Setting to 0 makes the operation succeed only if there is a live
// version of the object.
IfGenerationNotMatch *wrapperspb.Int64Value `protobuf:"bytes,6,opt,name=if_generation_not_match,json=ifGenerationNotMatch,proto3" json:"if_generation_not_match,omitempty"`
// Makes the operation conditional on whether the object's current
// metageneration matches the given value.
IfMetagenerationMatch *wrapperspb.Int64Value `protobuf:"bytes,7,opt,name=if_metageneration_match,json=ifMetagenerationMatch,proto3" json:"if_metageneration_match,omitempty"`
// Makes the operation conditional on whether the object's current
// metageneration does not match the given value.
IfMetagenerationNotMatch *wrapperspb.Int64Value `protobuf:"bytes,8,opt,name=if_metageneration_not_match,json=ifMetagenerationNotMatch,proto3" 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"`
// A set of parameters common to all Storage API requests.
CommonRequestParams *CommonRequestParams `protobuf:"bytes,11,opt,name=common_request_params,json=commonRequestParams,proto3" json:"common_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) GetCommonRequestParams() *CommonRequestParams
func (x *DeleteObjectRequest) GetGeneration() int64
func (x *DeleteObjectRequest) GetIfGenerationMatch() *wrapperspb.Int64Value
func (x *DeleteObjectRequest) GetIfGenerationNotMatch() *wrapperspb.Int64Value
func (x *DeleteObjectRequest) GetIfMetagenerationMatch() *wrapperspb.Int64Value
func (x *DeleteObjectRequest) GetIfMetagenerationNotMatch() *wrapperspb.Int64Value
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 GetBucketAccessControl.
type GetBucketAccessControlRequest struct {
// Required. Name of a bucket.
Bucket string `protobuf:"bytes,1,opt,name=bucket,proto3" json:"bucket,omitempty"`
// Required. The entity holding the permission. Can be one of:
// * `user-`*userId*
// * `user-`*emailAddress*
// * `group-`*groupId*
// * `group-`*emailAddress*
// * `allUsers`
// * `allAuthenticatedUsers`
Entity string `protobuf:"bytes,2,opt,name=entity,proto3" json:"entity,omitempty"`
// A set of parameters common to all Storage API requests.
CommonRequestParams *CommonRequestParams `protobuf:"bytes,4,opt,name=common_request_params,json=commonRequestParams,proto3" json:"common_request_params,omitempty"`
// contains filtered or unexported fields
}
func (*GetBucketAccessControlRequest) Descriptor() ([]byte, []int)
Deprecated: Use GetBucketAccessControlRequest.ProtoReflect.Descriptor instead.
func (x *GetBucketAccessControlRequest) GetBucket() string
func (x *GetBucketAccessControlRequest) GetCommonRequestParams() *CommonRequestParams
func (x *GetBucketAccessControlRequest) GetEntity() string
func (*GetBucketAccessControlRequest) ProtoMessage()
func (x *GetBucketAccessControlRequest) ProtoReflect() protoreflect.Message
func (x *GetBucketAccessControlRequest) Reset()
func (x *GetBucketAccessControlRequest) String() string
Request message for GetBucket.
type GetBucketRequest struct {
// Required. Name of a bucket.
Bucket string `protobuf:"bytes,1,opt,name=bucket,proto3" json:"bucket,omitempty"`
// Makes the return of the bucket metadata conditional on whether the bucket's
// current metageneration matches the given value.
IfMetagenerationMatch *wrapperspb.Int64Value `protobuf:"bytes,2,opt,name=if_metageneration_match,json=ifMetagenerationMatch,proto3" json:"if_metageneration_match,omitempty"`
// Makes the return of the bucket metadata conditional on whether the bucket's
// current metageneration does not match the given value.
IfMetagenerationNotMatch *wrapperspb.Int64Value `protobuf:"bytes,3,opt,name=if_metageneration_not_match,json=ifMetagenerationNotMatch,proto3" json:"if_metageneration_not_match,omitempty"`
// Set of properties to return. Defaults to `NO_ACL`.
Projection CommonEnums_Projection `protobuf:"varint,4,opt,name=projection,proto3,enum=google.storage.v1.CommonEnums_Projection" json:"projection,omitempty"`
// A set of parameters common to all Storage API requests.
CommonRequestParams *CommonRequestParams `protobuf:"bytes,6,opt,name=common_request_params,json=commonRequestParams,proto3" json:"common_request_params,omitempty"`
// contains filtered or unexported fields
}
func (*GetBucketRequest) Descriptor() ([]byte, []int)
Deprecated: Use GetBucketRequest.ProtoReflect.Descriptor instead.
func (x *GetBucketRequest) GetBucket() string
func (x *GetBucketRequest) GetCommonRequestParams() *CommonRequestParams
func (x *GetBucketRequest) GetIfMetagenerationMatch() *wrapperspb.Int64Value
func (x *GetBucketRequest) GetIfMetagenerationNotMatch() *wrapperspb.Int64Value
func (x *GetBucketRequest) GetProjection() CommonEnums_Projection
func (*GetBucketRequest) ProtoMessage()
func (x *GetBucketRequest) ProtoReflect() protoreflect.Message
func (x *GetBucketRequest) Reset()
func (x *GetBucketRequest) String() string
Request message for GetDefaultObjectAccessControl.
type GetDefaultObjectAccessControlRequest struct {
// Required. Name of a bucket.
Bucket string `protobuf:"bytes,1,opt,name=bucket,proto3" json:"bucket,omitempty"`
// Required. The entity holding the permission. Can be one of:
// * `user-`*userId*
// * `user-`*emailAddress*
// * `group-`*groupId*
// * `group-`*emailAddress*
// * `allUsers`
// * `allAuthenticatedUsers`
Entity string `protobuf:"bytes,2,opt,name=entity,proto3" json:"entity,omitempty"`
// A set of parameters common to all Storage API requests.
CommonRequestParams *CommonRequestParams `protobuf:"bytes,4,opt,name=common_request_params,json=commonRequestParams,proto3" json:"common_request_params,omitempty"`
// contains filtered or unexported fields
}
func (*GetDefaultObjectAccessControlRequest) Descriptor() ([]byte, []int)
Deprecated: Use GetDefaultObjectAccessControlRequest.ProtoReflect.Descriptor instead.
func (x *GetDefaultObjectAccessControlRequest) GetBucket() string
func (x *GetDefaultObjectAccessControlRequest) GetCommonRequestParams() *CommonRequestParams
func (x *GetDefaultObjectAccessControlRequest) GetEntity() string
func (*GetDefaultObjectAccessControlRequest) ProtoMessage()
func (x *GetDefaultObjectAccessControlRequest) ProtoReflect() protoreflect.Message
func (x *GetDefaultObjectAccessControlRequest) Reset()
func (x *GetDefaultObjectAccessControlRequest) 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.
ProjectId string `protobuf:"bytes,2,opt,name=project_id,json=projectId,proto3" json:"project_id,omitempty"`
// A set of parameters common to all Storage API requests.
CommonRequestParams *CommonRequestParams `protobuf:"bytes,3,opt,name=common_request_params,json=commonRequestParams,proto3" json:"common_request_params,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) GetCommonRequestParams() *CommonRequestParams
func (x *GetHmacKeyRequest) GetProjectId() string
func (*GetHmacKeyRequest) ProtoMessage()
func (x *GetHmacKeyRequest) ProtoReflect() protoreflect.Message
func (x *GetHmacKeyRequest) Reset()
func (x *GetHmacKeyRequest) String() string
A wrapper around the IAM get policy request to support our common_request_params.
type GetIamPolicyRequest struct {
// The request sent to IAM.
IamRequest *v1.GetIamPolicyRequest `protobuf:"bytes,1,opt,name=iam_request,json=iamRequest,proto3" json:"iam_request,omitempty"`
// A set of parameters common to all Storage API requests.
CommonRequestParams *CommonRequestParams `protobuf:"bytes,2,opt,name=common_request_params,json=commonRequestParams,proto3" json:"common_request_params,omitempty"`
// contains filtered or unexported fields
}
func (*GetIamPolicyRequest) Descriptor() ([]byte, []int)
Deprecated: Use GetIamPolicyRequest.ProtoReflect.Descriptor instead.
func (x *GetIamPolicyRequest) GetCommonRequestParams() *CommonRequestParams
func (x *GetIamPolicyRequest) GetIamRequest() *v1.GetIamPolicyRequest
func (*GetIamPolicyRequest) ProtoMessage()
func (x *GetIamPolicyRequest) ProtoReflect() protoreflect.Message
func (x *GetIamPolicyRequest) Reset()
func (x *GetIamPolicyRequest) String() string
Request message for GetNotification.
type GetNotificationRequest struct {
// Required. The parent bucket of the notification.
Bucket string `protobuf:"bytes,1,opt,name=bucket,proto3" json:"bucket,omitempty"`
// Required. Notification ID.
// Required.
Notification string `protobuf:"bytes,2,opt,name=notification,proto3" json:"notification,omitempty"`
// A set of parameters common to all Storage API requests.
CommonRequestParams *CommonRequestParams `protobuf:"bytes,4,opt,name=common_request_params,json=commonRequestParams,proto3" json:"common_request_params,omitempty"`
// contains filtered or unexported fields
}
func (*GetNotificationRequest) Descriptor() ([]byte, []int)
Deprecated: Use GetNotificationRequest.ProtoReflect.Descriptor instead.
func (x *GetNotificationRequest) GetBucket() string
func (x *GetNotificationRequest) GetCommonRequestParams() *CommonRequestParams
func (x *GetNotificationRequest) GetNotification() string
func (*GetNotificationRequest) ProtoMessage()
func (x *GetNotificationRequest) ProtoReflect() protoreflect.Message
func (x *GetNotificationRequest) Reset()
func (x *GetNotificationRequest) String() string
Request message for GetObjectAccessControl.
type GetObjectAccessControlRequest struct {
// Required. Name of a bucket.
Bucket string `protobuf:"bytes,1,opt,name=bucket,proto3" json:"bucket,omitempty"`
// Required. The entity holding the permission. Can be one of:
// * `user-`*userId*
// * `user-`*emailAddress*
// * `group-`*groupId*
// * `group-`*emailAddress*
// * `allUsers`
// * `allAuthenticatedUsers`
Entity string `protobuf:"bytes,2,opt,name=entity,proto3" json:"entity,omitempty"`
// Required. Name of the object.
Object string `protobuf:"bytes,3,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,4,opt,name=generation,proto3" json:"generation,omitempty"`
// A set of parameters common to all Storage API requests.
CommonRequestParams *CommonRequestParams `protobuf:"bytes,6,opt,name=common_request_params,json=commonRequestParams,proto3" json:"common_request_params,omitempty"`
// contains filtered or unexported fields
}
func (*GetObjectAccessControlRequest) Descriptor() ([]byte, []int)
Deprecated: Use GetObjectAccessControlRequest.ProtoReflect.Descriptor instead.
func (x *GetObjectAccessControlRequest) GetBucket() string
func (x *GetObjectAccessControlRequest) GetCommonRequestParams() *CommonRequestParams
func (x *GetObjectAccessControlRequest) GetEntity() string
func (x *GetObjectAccessControlRequest) GetGeneration() int64
func (x *GetObjectAccessControlRequest) GetObject() string
func (*GetObjectAccessControlRequest) ProtoMessage()
func (x *GetObjectAccessControlRequest) ProtoReflect() protoreflect.Message
func (x *GetObjectAccessControlRequest) Reset()
func (x *GetObjectAccessControlRequest) String() string
Request message for GetObjectMedia.
type GetObjectMediaRequest 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 GetObjectMediaRequest with `read_offset` = -5 and
// `read_limit` = 3 would return bytes 10 through 12 of the object. Requesting
// a negative offset whose magnitude is larger than the size of the object
// will result in an error.
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 *wrapperspb.Int64Value `protobuf:"bytes,6,opt,name=if_generation_match,json=ifGenerationMatch,proto3" json:"if_generation_match,omitempty"`
// Makes the operation conditional on whether the object's current generation
// does not match the given value. If no live object exists, the precondition
// fails. Setting to 0 makes the operation succeed only if there is a live
// version of the object.
IfGenerationNotMatch *wrapperspb.Int64Value `protobuf:"bytes,7,opt,name=if_generation_not_match,json=ifGenerationNotMatch,proto3" json:"if_generation_not_match,omitempty"`
// Makes the operation conditional on whether the object's current
// metageneration matches the given value.
IfMetagenerationMatch *wrapperspb.Int64Value `protobuf:"bytes,8,opt,name=if_metageneration_match,json=ifMetagenerationMatch,proto3" json:"if_metageneration_match,omitempty"`
// Makes the operation conditional on whether the object's current
// metageneration does not match the given value.
IfMetagenerationNotMatch *wrapperspb.Int64Value `protobuf:"bytes,9,opt,name=if_metageneration_not_match,json=ifMetagenerationNotMatch,proto3" json:"if_metageneration_not_match,omitempty"`
// A set of parameters common to Storage API requests concerning an object.
CommonObjectRequestParams *CommonObjectRequestParams `protobuf:"bytes,11,opt,name=common_object_request_params,json=commonObjectRequestParams,proto3" json:"common_object_request_params,omitempty"`
// A set of parameters common to all Storage API requests.
CommonRequestParams *CommonRequestParams `protobuf:"bytes,12,opt,name=common_request_params,json=commonRequestParams,proto3" json:"common_request_params,omitempty"`
// contains filtered or unexported fields
}
func (*GetObjectMediaRequest) Descriptor() ([]byte, []int)
Deprecated: Use GetObjectMediaRequest.ProtoReflect.Descriptor instead.
func (x *GetObjectMediaRequest) GetBucket() string
func (x *GetObjectMediaRequest) GetCommonObjectRequestParams() *CommonObjectRequestParams
func (x *GetObjectMediaRequest) GetCommonRequestParams() *CommonRequestParams
func (x *GetObjectMediaRequest) GetGeneration() int64
func (x *GetObjectMediaRequest) GetIfGenerationMatch() *wrapperspb.Int64Value
func (x *GetObjectMediaRequest) GetIfGenerationNotMatch() *wrapperspb.Int64Value
func (x *GetObjectMediaRequest) GetIfMetagenerationMatch() *wrapperspb.Int64Value
func (x *GetObjectMediaRequest) GetIfMetagenerationNotMatch() *wrapperspb.Int64Value
func (x *GetObjectMediaRequest) GetObject() string
func (x *GetObjectMediaRequest) GetReadLimit() int64
func (x *GetObjectMediaRequest) GetReadOffset() int64
func (*GetObjectMediaRequest) ProtoMessage()
func (x *GetObjectMediaRequest) ProtoReflect() protoreflect.Message
func (x *GetObjectMediaRequest) Reset()
func (x *GetObjectMediaRequest) String() string
Response message for GetObject.
type GetObjectMediaResponse 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
// GetObjectMediaRequest, ContentRange will be populated on the first
// GetObjectMediaResponse 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 (*GetObjectMediaResponse) Descriptor() ([]byte, []int)
Deprecated: Use GetObjectMediaResponse.ProtoReflect.Descriptor instead.
func (x *GetObjectMediaResponse) GetChecksummedData() *ChecksummedData
func (x *GetObjectMediaResponse) GetContentRange() *ContentRange
func (x *GetObjectMediaResponse) GetMetadata() *Object
func (x *GetObjectMediaResponse) GetObjectChecksums() *ObjectChecksums
func (*GetObjectMediaResponse) ProtoMessage()
func (x *GetObjectMediaResponse) ProtoReflect() protoreflect.Message
func (x *GetObjectMediaResponse) Reset()
func (x *GetObjectMediaResponse) 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 *wrapperspb.Int64Value `protobuf:"bytes,4,opt,name=if_generation_match,json=ifGenerationMatch,proto3" json:"if_generation_match,omitempty"`
// Makes the operation conditional on whether the object's current generation
// does not match the given value. If no live object exists, the precondition
// fails. Setting to 0 makes the operation succeed only if there is a live
// version of the object.
IfGenerationNotMatch *wrapperspb.Int64Value `protobuf:"bytes,5,opt,name=if_generation_not_match,json=ifGenerationNotMatch,proto3" json:"if_generation_not_match,omitempty"`
// Makes the operation conditional on whether the object's current
// metageneration matches the given value.
IfMetagenerationMatch *wrapperspb.Int64Value `protobuf:"bytes,6,opt,name=if_metageneration_match,json=ifMetagenerationMatch,proto3" json:"if_metageneration_match,omitempty"`
// Makes the operation conditional on whether the object's current
// metageneration does not match the given value.
IfMetagenerationNotMatch *wrapperspb.Int64Value `protobuf:"bytes,7,opt,name=if_metageneration_not_match,json=ifMetagenerationNotMatch,proto3" json:"if_metageneration_not_match,omitempty"`
// Set of properties to return. Defaults to `NO_ACL`.
Projection CommonEnums_Projection `protobuf:"varint,8,opt,name=projection,proto3,enum=google.storage.v1.CommonEnums_Projection" json:"projection,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"`
// A set of parameters common to all Storage API requests.
CommonRequestParams *CommonRequestParams `protobuf:"bytes,11,opt,name=common_request_params,json=commonRequestParams,proto3" json:"common_request_params,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) GetCommonRequestParams() *CommonRequestParams
func (x *GetObjectRequest) GetGeneration() int64
func (x *GetObjectRequest) GetIfGenerationMatch() *wrapperspb.Int64Value
func (x *GetObjectRequest) GetIfGenerationNotMatch() *wrapperspb.Int64Value
func (x *GetObjectRequest) GetIfMetagenerationMatch() *wrapperspb.Int64Value
func (x *GetObjectRequest) GetIfMetagenerationNotMatch() *wrapperspb.Int64Value
func (x *GetObjectRequest) GetObject() string
func (x *GetObjectRequest) GetProjection() CommonEnums_Projection
func (*GetObjectRequest) ProtoMessage()
func (x *GetObjectRequest) ProtoReflect() protoreflect.Message
func (x *GetObjectRequest) Reset()
func (x *GetObjectRequest) String() string
Request message for GetProjectServiceAccount.
type GetProjectServiceAccountRequest struct {
// Required. Project ID.
ProjectId string `protobuf:"bytes,1,opt,name=project_id,json=projectId,proto3" json:"project_id,omitempty"`
// A set of parameters common to all Storage API requests.
CommonRequestParams *CommonRequestParams `protobuf:"bytes,3,opt,name=common_request_params,json=commonRequestParams,proto3" json:"common_request_params,omitempty"`
// contains filtered or unexported fields
}
func (*GetProjectServiceAccountRequest) Descriptor() ([]byte, []int)
Deprecated: Use GetProjectServiceAccountRequest.ProtoReflect.Descriptor instead.
func (x *GetProjectServiceAccountRequest) GetCommonRequestParams() *CommonRequestParams
func (x *GetProjectServiceAccountRequest) GetProjectId() string
func (*GetProjectServiceAccountRequest) ProtoMessage()
func (x *GetProjectServiceAccountRequest) ProtoReflect() protoreflect.Message
func (x *GetProjectServiceAccountRequest) Reset()
func (x *GetProjectServiceAccountRequest) 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.
ProjectId string `protobuf:"bytes,3,opt,name=project_id,json=projectId,proto3" json:"project_id,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 in RFC 3339 format.
TimeCreated *timestamppb.Timestamp `protobuf:"bytes,6,opt,name=time_created,json=timeCreated,proto3" json:"time_created,omitempty"`
// The last modification time of the HMAC key metadata in RFC 3339 format.
Updated *timestamppb.Timestamp `protobuf:"bytes,7,opt,name=updated,proto3" json:"updated,omitempty"`
// Tag updated with each key update.
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) GetEtag() string
func (x *HmacKeyMetadata) GetId() string
func (x *HmacKeyMetadata) GetProjectId() string
func (x *HmacKeyMetadata) GetServiceAccountEmail() string
func (x *HmacKeyMetadata) GetState() string
func (x *HmacKeyMetadata) GetTimeCreated() *timestamppb.Timestamp
func (x *HmacKeyMetadata) GetUpdated() *timestamppb.Timestamp
func (*HmacKeyMetadata) ProtoMessage()
func (x *HmacKeyMetadata) ProtoReflect() protoreflect.Message
func (x *HmacKeyMetadata) Reset()
func (x *HmacKeyMetadata) String() string
Request message for InsertBucketAccessControl.
type InsertBucketAccessControlRequest struct {
// Required. Name of a bucket.
Bucket string `protobuf:"bytes,1,opt,name=bucket,proto3" json:"bucket,omitempty"`
// Properties of the new bucket access control being inserted.
BucketAccessControl *BucketAccessControl `protobuf:"bytes,3,opt,name=bucket_access_control,json=bucketAccessControl,proto3" json:"bucket_access_control,omitempty"`
// A set of parameters common to all Storage API requests.
CommonRequestParams *CommonRequestParams `protobuf:"bytes,4,opt,name=common_request_params,json=commonRequestParams,proto3" json:"common_request_params,omitempty"`
// contains filtered or unexported fields
}
func (*InsertBucketAccessControlRequest) Descriptor() ([]byte, []int)
Deprecated: Use InsertBucketAccessControlRequest.ProtoReflect.Descriptor instead.
func (x *InsertBucketAccessControlRequest) GetBucket() string
func (x *InsertBucketAccessControlRequest) GetBucketAccessControl() *BucketAccessControl
func (x *InsertBucketAccessControlRequest) GetCommonRequestParams() *CommonRequestParams
func (*InsertBucketAccessControlRequest) ProtoMessage()
func (x *InsertBucketAccessControlRequest) ProtoReflect() protoreflect.Message
func (x *InsertBucketAccessControlRequest) Reset()
func (x *InsertBucketAccessControlRequest) String() string
Request message for InsertBucket.
type InsertBucketRequest struct {
// Apply a predefined set of access controls to this bucket.
PredefinedAcl CommonEnums_PredefinedBucketAcl `protobuf:"varint,1,opt,name=predefined_acl,json=predefinedAcl,proto3,enum=google.storage.v1.CommonEnums_PredefinedBucketAcl" json:"predefined_acl,omitempty"`
// Apply a predefined set of default object access controls to this bucket.
PredefinedDefaultObjectAcl CommonEnums_PredefinedObjectAcl `protobuf:"varint,2,opt,name=predefined_default_object_acl,json=predefinedDefaultObjectAcl,proto3,enum=google.storage.v1.CommonEnums_PredefinedObjectAcl" json:"predefined_default_object_acl,omitempty"`
// Required. A valid API project identifier.
Project string `protobuf:"bytes,3,opt,name=project,proto3" json:"project,omitempty"`
// Set of properties to return. Defaults to `NO_ACL`, unless the
// bucket resource specifies `acl` or `defaultObjectAcl`
// properties, when it defaults to `FULL`.
Projection CommonEnums_Projection `protobuf:"varint,4,opt,name=projection,proto3,enum=google.storage.v1.CommonEnums_Projection" json:"projection,omitempty"`
// Properties of the new bucket being inserted, including its name.
Bucket *Bucket `protobuf:"bytes,6,opt,name=bucket,proto3" json:"bucket,omitempty"`
// A set of parameters common to all Storage API requests.
CommonRequestParams *CommonRequestParams `protobuf:"bytes,7,opt,name=common_request_params,json=commonRequestParams,proto3" json:"common_request_params,omitempty"`
// contains filtered or unexported fields
}
func (*InsertBucketRequest) Descriptor() ([]byte, []int)
Deprecated: Use InsertBucketRequest.ProtoReflect.Descriptor instead.
func (x *InsertBucketRequest) GetBucket() *Bucket
func (x *InsertBucketRequest) GetCommonRequestParams() *CommonRequestParams
func (x *InsertBucketRequest) GetPredefinedAcl() CommonEnums_PredefinedBucketAcl
func (x *InsertBucketRequest) GetPredefinedDefaultObjectAcl() CommonEnums_PredefinedObjectAcl
func (x *InsertBucketRequest) GetProject() string
func (x *InsertBucketRequest) GetProjection() CommonEnums_Projection
func (*InsertBucketRequest) ProtoMessage()
func (x *InsertBucketRequest) ProtoReflect() protoreflect.Message
func (x *InsertBucketRequest) Reset()
func (x *InsertBucketRequest) String() string
Request message for InsertDefaultObjectAccessControl.
type InsertDefaultObjectAccessControlRequest struct {
// Required. Name of a bucket.
Bucket string `protobuf:"bytes,1,opt,name=bucket,proto3" json:"bucket,omitempty"`
// Properties of the object access control being inserted.
ObjectAccessControl *ObjectAccessControl `protobuf:"bytes,3,opt,name=object_access_control,json=objectAccessControl,proto3" json:"object_access_control,omitempty"`
// A set of parameters common to all Storage API requests.
CommonRequestParams *CommonRequestParams `protobuf:"bytes,4,opt,name=common_request_params,json=commonRequestParams,proto3" json:"common_request_params,omitempty"`
// contains filtered or unexported fields
}
func (*InsertDefaultObjectAccessControlRequest) Descriptor() ([]byte, []int)
Deprecated: Use InsertDefaultObjectAccessControlRequest.ProtoReflect.Descriptor instead.
func (x *InsertDefaultObjectAccessControlRequest) GetBucket() string
func (x *InsertDefaultObjectAccessControlRequest) GetCommonRequestParams() *CommonRequestParams
func (x *InsertDefaultObjectAccessControlRequest) GetObjectAccessControl() *ObjectAccessControl
func (*InsertDefaultObjectAccessControlRequest) ProtoMessage()
func (x *InsertDefaultObjectAccessControlRequest) ProtoReflect() protoreflect.Message
func (x *InsertDefaultObjectAccessControlRequest) Reset()
func (x *InsertDefaultObjectAccessControlRequest) String() string
Request message for InsertNotification.
type InsertNotificationRequest struct {
// Required. The parent bucket of the notification.
Bucket string `protobuf:"bytes,1,opt,name=bucket,proto3" json:"bucket,omitempty"`
// Properties of the notification to be inserted.
Notification *Notification `protobuf:"bytes,3,opt,name=notification,proto3" json:"notification,omitempty"`
// A set of parameters common to all Storage API requests.
CommonRequestParams *CommonRequestParams `protobuf:"bytes,4,opt,name=common_request_params,json=commonRequestParams,proto3" json:"common_request_params,omitempty"`
// contains filtered or unexported fields
}
func (*InsertNotificationRequest) Descriptor() ([]byte, []int)
Deprecated: Use InsertNotificationRequest.ProtoReflect.Descriptor instead.
func (x *InsertNotificationRequest) GetBucket() string
func (x *InsertNotificationRequest) GetCommonRequestParams() *CommonRequestParams
func (x *InsertNotificationRequest) GetNotification() *Notification
func (*InsertNotificationRequest) ProtoMessage()
func (x *InsertNotificationRequest) ProtoReflect() protoreflect.Message
func (x *InsertNotificationRequest) Reset()
func (x *InsertNotificationRequest) String() string
Request message for InsertObjectAccessControl.
type InsertObjectAccessControlRequest struct {
// Required. Name of a bucket.
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"`
// Properties of the object access control to be inserted.
ObjectAccessControl *ObjectAccessControl `protobuf:"bytes,5,opt,name=object_access_control,json=objectAccessControl,proto3" json:"object_access_control,omitempty"`
// A set of parameters common to all Storage API requests.
CommonRequestParams *CommonRequestParams `protobuf:"bytes,6,opt,name=common_request_params,json=commonRequestParams,proto3" json:"common_request_params,omitempty"`
// contains filtered or unexported fields
}
func (*InsertObjectAccessControlRequest) Descriptor() ([]byte, []int)
Deprecated: Use InsertObjectAccessControlRequest.ProtoReflect.Descriptor instead.
func (x *InsertObjectAccessControlRequest) GetBucket() string
func (x *InsertObjectAccessControlRequest) GetCommonRequestParams() *CommonRequestParams
func (x *InsertObjectAccessControlRequest) GetGeneration() int64
func (x *InsertObjectAccessControlRequest) GetObject() string
func (x *InsertObjectAccessControlRequest) GetObjectAccessControl() *ObjectAccessControl
func (*InsertObjectAccessControlRequest) ProtoMessage()
func (x *InsertObjectAccessControlRequest) ProtoReflect() protoreflect.Message
func (x *InsertObjectAccessControlRequest) Reset()
func (x *InsertObjectAccessControlRequest) String() string
Message for writing an object.
type InsertObjectRequest struct {
// The first message of each stream should set one of the following.
//
// Types that are assignable to FirstMessage:
// *InsertObjectRequest_UploadId
// *InsertObjectRequest_InsertObjectSpec
FirstMessage isInsertObjectRequest_FirstMessage `protobuf_oneof:"first_message"`
// Required. The offset from the beginning of the object at which the data should be
// written.
//
// In the first `InsertObjectRequest` of a `InsertObject()` action, it
// indicates the initial offset for the `Insert()` call. The value **must** be
// equal to the `committed_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:
// *InsertObjectRequest_ChecksummedData
// *InsertObjectRequest_Reference
Data isInsertObjectRequest_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
// `InsertObjectRequest`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"`
// A set of parameters common to all Storage API requests.
CommonRequestParams *CommonRequestParams `protobuf:"bytes,9,opt,name=common_request_params,json=commonRequestParams,proto3" json:"common_request_params,omitempty"`
// contains filtered or unexported fields
}
func (*InsertObjectRequest) Descriptor() ([]byte, []int)
Deprecated: Use InsertObjectRequest.ProtoReflect.Descriptor instead.
func (x *InsertObjectRequest) GetChecksummedData() *ChecksummedData
func (x *InsertObjectRequest) GetCommonObjectRequestParams() *CommonObjectRequestParams
func (x *InsertObjectRequest) GetCommonRequestParams() *CommonRequestParams
func (m *InsertObjectRequest) GetData() isInsertObjectRequest_Data
func (x *InsertObjectRequest) GetFinishWrite() bool
func (m *InsertObjectRequest) GetFirstMessage() isInsertObjectRequest_FirstMessage
func (x *InsertObjectRequest) GetInsertObjectSpec() *InsertObjectSpec
func (x *InsertObjectRequest) GetObjectChecksums() *ObjectChecksums
func (x *InsertObjectRequest) GetReference() *GetObjectMediaRequest
func (x *InsertObjectRequest) GetUploadId() string
func (x *InsertObjectRequest) GetWriteOffset() int64
func (*InsertObjectRequest) ProtoMessage()
func (x *InsertObjectRequest) ProtoReflect() protoreflect.Message
func (x *InsertObjectRequest) Reset()
func (x *InsertObjectRequest) String() string
type InsertObjectRequest_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 InsertObjectRequest_InsertObjectSpec struct {
// For non-resumable uploads. Describes the overall upload, including the
// destination bucket and object name, preconditions, etc.
InsertObjectSpec *InsertObjectSpec `protobuf:"bytes,2,opt,name=insert_object_spec,json=insertObjectSpec,proto3,oneof"`
}
type InsertObjectRequest_Reference struct {
// A reference to an existing object. This can be used to support
// several use cases:
// - Writing a sequence of data buffers supports the basic use case of
// uploading a complete object, chunk by chunk.
// - Writing a sequence of references to existing objects allows an
// object to be composed from a collection of objects, which can be
// used to support parallel object writes.
// - Writing a single reference with a given offset and size can be used
// to create an object from a slice of an existing object.
// - Writing an object referencing a object slice (created as noted
// above) followed by a data buffer followed by another object
// slice can be used to support delta upload functionality.
Reference *GetObjectMediaRequest `protobuf:"bytes,5,opt,name=reference,proto3,oneof"`
}
type InsertObjectRequest_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"`
}
Describes an attempt to insert an object, possibly over multiple requests.
type InsertObjectSpec 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.
PredefinedAcl CommonEnums_PredefinedObjectAcl `protobuf:"varint,2,opt,name=predefined_acl,json=predefinedAcl,proto3,enum=google.storage.v1.CommonEnums_PredefinedObjectAcl" 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 *wrapperspb.Int64Value `protobuf:"bytes,3,opt,name=if_generation_match,json=ifGenerationMatch,proto3" json:"if_generation_match,omitempty"`
// Makes the operation conditional on whether the object's current
// generation does not match the given value. If no live object exists, the
// precondition fails. Setting to 0 makes the operation succeed only if
// there is a live version of the object.
IfGenerationNotMatch *wrapperspb.Int64Value `protobuf:"bytes,4,opt,name=if_generation_not_match,json=ifGenerationNotMatch,proto3" json:"if_generation_not_match,omitempty"`
// Makes the operation conditional on whether the object's current
// metageneration matches the given value.
IfMetagenerationMatch *wrapperspb.Int64Value `protobuf:"bytes,5,opt,name=if_metageneration_match,json=ifMetagenerationMatch,proto3" json:"if_metageneration_match,omitempty"`
// Makes the operation conditional on whether the object's current
// metageneration does not match the given value.
IfMetagenerationNotMatch *wrapperspb.Int64Value `protobuf:"bytes,6,opt,name=if_metageneration_not_match,json=ifMetagenerationNotMatch,proto3" json:"if_metageneration_not_match,omitempty"`
// Set of properties to return. Defaults to `NO_ACL`, unless the
// object resource specifies the `acl` property, when it defaults
// to `full`.
Projection CommonEnums_Projection `protobuf:"varint,7,opt,name=projection,proto3,enum=google.storage.v1.CommonEnums_Projection" json:"projection,omitempty"`
// contains filtered or unexported fields
}
func (*InsertObjectSpec) Descriptor() ([]byte, []int)
Deprecated: Use InsertObjectSpec.ProtoReflect.Descriptor instead.
func (x *InsertObjectSpec) GetIfGenerationMatch() *wrapperspb.Int64Value
func (x *InsertObjectSpec) GetIfGenerationNotMatch() *wrapperspb.Int64Value
func (x *InsertObjectSpec) GetIfMetagenerationMatch() *wrapperspb.Int64Value
func (x *InsertObjectSpec) GetIfMetagenerationNotMatch() *wrapperspb.Int64Value
func (x *InsertObjectSpec) GetPredefinedAcl() CommonEnums_PredefinedObjectAcl
func (x *InsertObjectSpec) GetProjection() CommonEnums_Projection
func (x *InsertObjectSpec) GetResource() *Object
func (*InsertObjectSpec) ProtoMessage()
func (x *InsertObjectSpec) ProtoReflect() protoreflect.Message
func (x *InsertObjectSpec) Reset()
func (x *InsertObjectSpec) String() string
Request message for ListBucketAccessControl.
type ListBucketAccessControlsRequest struct {
// Required. Name of a bucket.
Bucket string `protobuf:"bytes,1,opt,name=bucket,proto3" json:"bucket,omitempty"`
// A set of parameters common to all Storage API requests.
CommonRequestParams *CommonRequestParams `protobuf:"bytes,3,opt,name=common_request_params,json=commonRequestParams,proto3" json:"common_request_params,omitempty"`
// contains filtered or unexported fields
}
func (*ListBucketAccessControlsRequest) Descriptor() ([]byte, []int)
Deprecated: Use ListBucketAccessControlsRequest.ProtoReflect.Descriptor instead.
func (x *ListBucketAccessControlsRequest) GetBucket() string
func (x *ListBucketAccessControlsRequest) GetCommonRequestParams() *CommonRequestParams
func (*ListBucketAccessControlsRequest) ProtoMessage()
func (x *ListBucketAccessControlsRequest) ProtoReflect() protoreflect.Message
func (x *ListBucketAccessControlsRequest) Reset()
func (x *ListBucketAccessControlsRequest) String() string
The response to a call to BucketAccessControls.ListBucketAccessControls.
type ListBucketAccessControlsResponse struct {
// The list of items.
Items []*BucketAccessControl `protobuf:"bytes,1,rep,name=items,proto3" json:"items,omitempty"`
// contains filtered or unexported fields
}
func (*ListBucketAccessControlsResponse) Descriptor() ([]byte, []int)
Deprecated: Use ListBucketAccessControlsResponse.ProtoReflect.Descriptor instead.
func (x *ListBucketAccessControlsResponse) GetItems() []*BucketAccessControl
func (*ListBucketAccessControlsResponse) ProtoMessage()
func (x *ListBucketAccessControlsResponse) ProtoReflect() protoreflect.Message
func (x *ListBucketAccessControlsResponse) Reset()
func (x *ListBucketAccessControlsResponse) String() string
Request message for ListBuckets.
type ListBucketsRequest struct {
// Maximum number of buckets to return in a single response. The service will
// use this parameter or 1,000 items, whichever is smaller.
MaxResults int32 `protobuf:"varint,1,opt,name=max_results,json=maxResults,proto3" json:"max_results,omitempty"`
// A previously-returned page token representing part of the larger set of
// results to view.
PageToken string `protobuf:"bytes,2,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,3,opt,name=prefix,proto3" json:"prefix,omitempty"`
// Required. A valid API project identifier.
Project string `protobuf:"bytes,4,opt,name=project,proto3" json:"project,omitempty"`
// Set of properties to return. Defaults to `NO_ACL`.
Projection CommonEnums_Projection `protobuf:"varint,5,opt,name=projection,proto3,enum=google.storage.v1.CommonEnums_Projection" json:"projection,omitempty"`
// A set of parameters common to all Storage API requests.
CommonRequestParams *CommonRequestParams `protobuf:"bytes,7,opt,name=common_request_params,json=commonRequestParams,proto3" json:"common_request_params,omitempty"`
// contains filtered or unexported fields
}
func (*ListBucketsRequest) Descriptor() ([]byte, []int)
Deprecated: Use ListBucketsRequest.ProtoReflect.Descriptor instead.
func (x *ListBucketsRequest) GetCommonRequestParams() *CommonRequestParams
func (x *ListBucketsRequest) GetMaxResults() int32
func (x *ListBucketsRequest) GetPageToken() string
func (x *ListBucketsRequest) GetPrefix() string
func (x *ListBucketsRequest) GetProject() string
func (x *ListBucketsRequest) GetProjection() CommonEnums_Projection
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.
Items []*Bucket `protobuf:"bytes,1,rep,name=items,proto3" json:"items,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) GetItems() []*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 message for ListChannels.
type ListChannelsRequest struct {
// Required. Name of a bucket.
Bucket string `protobuf:"bytes,1,opt,name=bucket,proto3" json:"bucket,omitempty"`
// A set of parameters common to all Storage API requests.
CommonRequestParams *CommonRequestParams `protobuf:"bytes,3,opt,name=common_request_params,json=commonRequestParams,proto3" json:"common_request_params,omitempty"`
// contains filtered or unexported fields
}
func (*ListChannelsRequest) Descriptor() ([]byte, []int)
Deprecated: Use ListChannelsRequest.ProtoReflect.Descriptor instead.
func (x *ListChannelsRequest) GetBucket() string
func (x *ListChannelsRequest) GetCommonRequestParams() *CommonRequestParams
func (*ListChannelsRequest) ProtoMessage()
func (x *ListChannelsRequest) ProtoReflect() protoreflect.Message
func (x *ListChannelsRequest) Reset()
func (x *ListChannelsRequest) String() string
The result of a call to Channels.ListChannels
type ListChannelsResponse struct {
// The list of notification channels for a bucket.
Items []*ListChannelsResponse_Items `protobuf:"bytes,1,rep,name=items,proto3" json:"items,omitempty"`
// contains filtered or unexported fields
}
func (*ListChannelsResponse) Descriptor() ([]byte, []int)
Deprecated: Use ListChannelsResponse.ProtoReflect.Descriptor instead.
func (x *ListChannelsResponse) GetItems() []*ListChannelsResponse_Items
func (*ListChannelsResponse) ProtoMessage()
func (x *ListChannelsResponse) ProtoReflect() protoreflect.Message
func (x *ListChannelsResponse) Reset()
func (x *ListChannelsResponse) String() string
type ListChannelsResponse_Items struct {
// User-specified name for a channel. Needed to unsubscribe.
ChannelId string `protobuf:"bytes,1,opt,name=channel_id,json=channelId,proto3" json:"channel_id,omitempty"`
// Opaque value generated by GCS representing a bucket. Needed to
// unsubscribe.
ResourceId string `protobuf:"bytes,2,opt,name=resource_id,json=resourceId,proto3" json:"resource_id,omitempty"`
// Url used to identify where notifications are sent to.
PushUrl string `protobuf:"bytes,3,opt,name=push_url,json=pushUrl,proto3" json:"push_url,omitempty"`
// Email address of the subscriber.
SubscriberEmail string `protobuf:"bytes,4,opt,name=subscriber_email,json=subscriberEmail,proto3" json:"subscriber_email,omitempty"`
// Time when the channel was created.
CreationTime *timestamppb.Timestamp `protobuf:"bytes,5,opt,name=creation_time,json=creationTime,proto3" json:"creation_time,omitempty"`
// contains filtered or unexported fields
}
func (*ListChannelsResponse_Items) Descriptor() ([]byte, []int)
Deprecated: Use ListChannelsResponse_Items.ProtoReflect.Descriptor instead.
func (x *ListChannelsResponse_Items) GetChannelId() string
func (x *ListChannelsResponse_Items) GetCreationTime() *timestamppb.Timestamp
func (x *ListChannelsResponse_Items) GetPushUrl() string
func (x *ListChannelsResponse_Items) GetResourceId() string
func (x *ListChannelsResponse_Items) GetSubscriberEmail() string
func (*ListChannelsResponse_Items) ProtoMessage()
func (x *ListChannelsResponse_Items) ProtoReflect() protoreflect.Message
func (x *ListChannelsResponse_Items) Reset()
func (x *ListChannelsResponse_Items) String() string
Request message for ListDefaultObjectAccessControls.
type ListDefaultObjectAccessControlsRequest struct {
// Required. Name of a bucket.
Bucket string `protobuf:"bytes,1,opt,name=bucket,proto3" json:"bucket,omitempty"`
// If present, only return default ACL listing if the bucket's current
// metageneration matches this value.
IfMetagenerationMatch *wrapperspb.Int64Value `protobuf:"bytes,2,opt,name=if_metageneration_match,json=ifMetagenerationMatch,proto3" json:"if_metageneration_match,omitempty"`
// If present, only return default ACL listing if the bucket's current
// metageneration does not match the given value.
IfMetagenerationNotMatch *wrapperspb.Int64Value `protobuf:"bytes,3,opt,name=if_metageneration_not_match,json=ifMetagenerationNotMatch,proto3" json:"if_metageneration_not_match,omitempty"`
// A set of parameters common to all Storage API requests.
CommonRequestParams *CommonRequestParams `protobuf:"bytes,5,opt,name=common_request_params,json=commonRequestParams,proto3" json:"common_request_params,omitempty"`
// contains filtered or unexported fields
}
func (*ListDefaultObjectAccessControlsRequest) Descriptor() ([]byte, []int)
Deprecated: Use ListDefaultObjectAccessControlsRequest.ProtoReflect.Descriptor instead.
func (x *ListDefaultObjectAccessControlsRequest) GetBucket() string
func (x *ListDefaultObjectAccessControlsRequest) GetCommonRequestParams() *CommonRequestParams
func (x *ListDefaultObjectAccessControlsRequest) GetIfMetagenerationMatch() *wrapperspb.Int64Value
func (x *ListDefaultObjectAccessControlsRequest) GetIfMetagenerationNotMatch() *wrapperspb.Int64Value
func (*ListDefaultObjectAccessControlsRequest) ProtoMessage()
func (x *ListDefaultObjectAccessControlsRequest) ProtoReflect() protoreflect.Message
func (x *ListDefaultObjectAccessControlsRequest) Reset()
func (x *ListDefaultObjectAccessControlsRequest) 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.
ProjectId string `protobuf:"bytes,1,opt,name=project_id,json=projectId,proto3" json:"project_id,omitempty"`
// An optional filter to only return HMAC keys for one service account.
ServiceAccountEmail string `protobuf:"bytes,2,opt,name=service_account_email,json=serviceAccountEmail,proto3" json:"service_account_email,omitempty"`
// An optional bool to return deleted keys that have not been wiped out yet.
ShowDeletedKeys bool `protobuf:"varint,3,opt,name=show_deleted_keys,json=showDeletedKeys,proto3" json:"show_deleted_keys,omitempty"`
// The maximum number of keys to return.
MaxResults int32 `protobuf:"varint,4,opt,name=max_results,json=maxResults,proto3" json:"max_results,omitempty"`
// A previously returned token from ListHmacKeysResponse to get the next page.
PageToken string `protobuf:"bytes,5,opt,name=page_token,json=pageToken,proto3" json:"page_token,omitempty"`
// A set of parameters common to all Storage API requests.
CommonRequestParams *CommonRequestParams `protobuf:"bytes,6,opt,name=common_request_params,json=commonRequestParams,proto3" json:"common_request_params,omitempty"`
// contains filtered or unexported fields
}
func (*ListHmacKeysRequest) Descriptor() ([]byte, []int)
Deprecated: Use ListHmacKeysRequest.ProtoReflect.Descriptor instead.
func (x *ListHmacKeysRequest) GetCommonRequestParams() *CommonRequestParams
func (x *ListHmacKeysRequest) GetMaxResults() int32
func (x *ListHmacKeysRequest) GetPageToken() string
func (x *ListHmacKeysRequest) GetProjectId() 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 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,1,opt,name=next_page_token,json=nextPageToken,proto3" json:"next_page_token,omitempty"`
// The list of items.
Items []*HmacKeyMetadata `protobuf:"bytes,2,rep,name=items,proto3" json:"items,omitempty"`
// contains filtered or unexported fields
}
func (*ListHmacKeysResponse) Descriptor() ([]byte, []int)
Deprecated: Use ListHmacKeysResponse.ProtoReflect.Descriptor instead.
func (x *ListHmacKeysResponse) GetItems() []*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.
Bucket string `protobuf:"bytes,1,opt,name=bucket,proto3" json:"bucket,omitempty"`
// A set of parameters common to all Storage API requests.
CommonRequestParams *CommonRequestParams `protobuf:"bytes,3,opt,name=common_request_params,json=commonRequestParams,proto3" json:"common_request_params,omitempty"`
// contains filtered or unexported fields
}
func (*ListNotificationsRequest) Descriptor() ([]byte, []int)
Deprecated: Use ListNotificationsRequest.ProtoReflect.Descriptor instead.
func (x *ListNotificationsRequest) GetBucket() string
func (x *ListNotificationsRequest) GetCommonRequestParams() *CommonRequestParams
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.
Items []*Notification `protobuf:"bytes,1,rep,name=items,proto3" json:"items,omitempty"`
// contains filtered or unexported fields
}
func (*ListNotificationsResponse) Descriptor() ([]byte, []int)
Deprecated: Use ListNotificationsResponse.ProtoReflect.Descriptor instead.
func (x *ListNotificationsResponse) GetItems() []*Notification
func (*ListNotificationsResponse) ProtoMessage()
func (x *ListNotificationsResponse) ProtoReflect() protoreflect.Message
func (x *ListNotificationsResponse) Reset()
func (x *ListNotificationsResponse) String() string
Request message for ListObjectAccessControls.
type ListObjectAccessControlsRequest struct {
// Required. Name of a bucket.
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"`
// A set of parameters common to all Storage API requests.
CommonRequestParams *CommonRequestParams `protobuf:"bytes,5,opt,name=common_request_params,json=commonRequestParams,proto3" json:"common_request_params,omitempty"`
// contains filtered or unexported fields
}
func (*ListObjectAccessControlsRequest) Descriptor() ([]byte, []int)
Deprecated: Use ListObjectAccessControlsRequest.ProtoReflect.Descriptor instead.
func (x *ListObjectAccessControlsRequest) GetBucket() string
func (x *ListObjectAccessControlsRequest) GetCommonRequestParams() *CommonRequestParams
func (x *ListObjectAccessControlsRequest) GetGeneration() int64
func (x *ListObjectAccessControlsRequest) GetObject() string
func (*ListObjectAccessControlsRequest) ProtoMessage()
func (x *ListObjectAccessControlsRequest) ProtoReflect() protoreflect.Message
func (x *ListObjectAccessControlsRequest) Reset()
func (x *ListObjectAccessControlsRequest) String() string
The result of a call to ObjectAccessControls.ListObjectAccessControls.
type ListObjectAccessControlsResponse struct {
// The list of items.
Items []*ObjectAccessControl `protobuf:"bytes,1,rep,name=items,proto3" json:"items,omitempty"`
// contains filtered or unexported fields
}
func (*ListObjectAccessControlsResponse) Descriptor() ([]byte, []int)
Deprecated: Use ListObjectAccessControlsResponse.ProtoReflect.Descriptor instead.
func (x *ListObjectAccessControlsResponse) GetItems() []*ObjectAccessControl
func (*ListObjectAccessControlsResponse) ProtoMessage()
func (x *ListObjectAccessControlsResponse) ProtoReflect() protoreflect.Message
func (x *ListObjectAccessControlsResponse) Reset()
func (x *ListObjectAccessControlsResponse) String() string
Request message for ListObjects.
type ListObjectsRequest struct {
// Required. Name of the bucket in which to look for objects.
Bucket string `protobuf:"bytes,1,opt,name=bucket,proto3" json:"bucket,omitempty"`
// 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,2,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,3,opt,name=include_trailing_delimiter,json=includeTrailingDelimiter,proto3" json:"include_trailing_delimiter,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.
MaxResults int32 `protobuf:"varint,4,opt,name=max_results,json=maxResults,proto3" json:"max_results,omitempty"`
// A previously-returned page token representing part of the larger set of
// results to view.
PageToken string `protobuf:"bytes,5,opt,name=page_token,json=pageToken,proto3" json:"page_token,omitempty"`
// Filter results to objects whose names begin with this prefix.
Prefix string `protobuf:"bytes,6,opt,name=prefix,proto3" json:"prefix,omitempty"`
// Set of properties to return. Defaults to `NO_ACL`.
Projection CommonEnums_Projection `protobuf:"varint,7,opt,name=projection,proto3,enum=google.storage.v1.CommonEnums_Projection" json:"projection,omitempty"`
// If `true`, lists all versions of an object as distinct results.
// The default is `false`. For more information, see
// [Object
// Versioning](https://cloud.google.com/storage/docs/object-versioning).
Versions bool `protobuf:"varint,9,opt,name=versions,proto3" json:"versions,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,11,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,12,opt,name=lexicographic_end,json=lexicographicEnd,proto3" json:"lexicographic_end,omitempty"`
// A set of parameters common to all Storage API requests.
CommonRequestParams *CommonRequestParams `protobuf:"bytes,10,opt,name=common_request_params,json=commonRequestParams,proto3" json:"common_request_params,omitempty"`
// contains filtered or unexported fields
}
func (*ListObjectsRequest) Descriptor() ([]byte, []int)
Deprecated: Use ListObjectsRequest.ProtoReflect.Descriptor instead.
func (x *ListObjectsRequest) GetBucket() string
func (x *ListObjectsRequest) GetCommonRequestParams() *CommonRequestParams
func (x *ListObjectsRequest) GetDelimiter() string
func (x *ListObjectsRequest) GetIncludeTrailingDelimiter() bool
func (x *ListObjectsRequest) GetLexicographicEnd() string
func (x *ListObjectsRequest) GetLexicographicStart() string
func (x *ListObjectsRequest) GetMaxResults() int32
func (x *ListObjectsRequest) GetPageToken() string
func (x *ListObjectsRequest) GetPrefix() string
func (x *ListObjectsRequest) GetProjection() CommonEnums_Projection
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 prefixes of objects matching-but-not-listed up to and including
// the requested delimiter.
Prefixes []string `protobuf:"bytes,1,rep,name=prefixes,proto3" json:"prefixes,omitempty"`
// The list of items.
Items []*Object `protobuf:"bytes,2,rep,name=items,proto3" json:"items,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) GetItems() []*Object
func (x *ListObjectsResponse) GetNextPageToken() string
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 LockRetentionPolicy.
type LockRetentionPolicyRequest 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"`
// A set of parameters common to all Storage API requests.
CommonRequestParams *CommonRequestParams `protobuf:"bytes,4,opt,name=common_request_params,json=commonRequestParams,proto3" json:"common_request_params,omitempty"`
// contains filtered or unexported fields
}
func (*LockRetentionPolicyRequest) Descriptor() ([]byte, []int)
Deprecated: Use LockRetentionPolicyRequest.ProtoReflect.Descriptor instead.
func (x *LockRetentionPolicyRequest) GetBucket() string
func (x *LockRetentionPolicyRequest) GetCommonRequestParams() *CommonRequestParams
func (x *LockRetentionPolicyRequest) GetIfMetagenerationMatch() int64
func (*LockRetentionPolicyRequest) ProtoMessage()
func (x *LockRetentionPolicyRequest) ProtoReflect() protoreflect.Message
func (x *LockRetentionPolicyRequest) Reset()
func (x *LockRetentionPolicyRequest) String() string
A subscription to receive Google PubSub notifications.
type Notification struct {
// The Cloud PubSub topic to which this subscription publishes. Formatted as:
// '//pubsub.googleapis.com/projects/{project-identifier}/topics/{my-topic}'
Topic string `protobuf:"bytes,1,opt,name=topic,proto3" json:"topic,omitempty"`
// If present, only send notifications about listed event types. If empty,
// sent notifications for all event types.
EventTypes []string `protobuf:"bytes,2,rep,name=event_types,json=eventTypes,proto3" json:"event_types,omitempty"`
// An optional list of additional attributes to attach to each Cloud PubSub
// message published for this notification subscription.
CustomAttributes map[string]string `protobuf:"bytes,3,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"`
// HTTP 1.1 [https://tools.ietf.org/html/rfc7232#section-2.3][Entity tag]
// for this subscription notification.
Etag string `protobuf:"bytes,4,opt,name=etag,proto3" json:"etag,omitempty"`
// If present, only apply this notification configuration 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"`
// The desired content of the Payload.
PayloadFormat string `protobuf:"bytes,6,opt,name=payload_format,json=payloadFormat,proto3" json:"payload_format,omitempty"`
// The ID of the notification.
Id string `protobuf:"bytes,7,opt,name=id,proto3" json:"id,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) GetId() 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 {
// 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,1,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,2,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,3,opt,name=cache_control,json=cacheControl,proto3" json:"cache_control,omitempty"`
// Access controls on the object.
Acl []*ObjectAccessControl `protobuf:"bytes,4,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,5,opt,name=content_language,json=contentLanguage,proto3" json:"content_language,omitempty"`
// The version of the metadata for this object at this generation. Used for
// preconditions and for detecting changes in metadata. A metageneration
// number is only meaningful in the context of a particular generation of a
// particular object.
// Attempting to set or update this field will result in a
// [FieldViolation][google.rpc.BadRequest.FieldViolation].
Metageneration int64 `protobuf:"varint,6,opt,name=metageneration,proto3" json:"metageneration,omitempty"`
// 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].
TimeDeleted *timestamppb.Timestamp `protobuf:"bytes,7,opt,name=time_deleted,json=timeDeleted,proto3" json:"time_deleted,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,8,opt,name=content_type,json=contentType,proto3" json:"content_type,omitempty"`
// 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,9,opt,name=size,proto3" json:"size,omitempty"`
// The creation time of the object.
// Attempting to set or update this field will result in a
// [FieldViolation][google.rpc.BadRequest.FieldViolation].
TimeCreated *timestamppb.Timestamp `protobuf:"bytes,10,opt,name=time_created,json=timeCreated,proto3" json:"time_created,omitempty"`
// CRC32c checksum. For more information about using the CRC32c
// checksum, see
// [https://cloud.google.com/storage/docs/hashes-etags#json-api][Hashes and
// ETags: Best Practices]. This is a server determined value and should not be
// supplied by the user when sending an Object. The server will ignore any
// value provided. Users should instead use the object_checksums field on the
// InsertObjectRequest when uploading an object.
Crc32C *wrapperspb.UInt32Value `protobuf:"bytes,11,opt,name=crc32c,proto3" json:"crc32c,omitempty"`
// 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,12,opt,name=component_count,json=componentCount,proto3" json:"component_count,omitempty"`
// MD5 hash of the data; encoded using base64 as per
// [https://tools.ietf.org/html/rfc4648#section-4][RFC 4648 §4]. For more
// information about using the MD5 hash, see
// [https://cloud.google.com/storage/docs/hashes-etags#json-api][Hashes and
// ETags: Best Practices]. This is a server determined value and should not be
// supplied by the user when sending an Object. The server will ignore any
// value provided. Users should instead use the object_checksums field on the
// InsertObjectRequest when uploading an object.
Md5Hash string `protobuf:"bytes,13,opt,name=md5_hash,json=md5Hash,proto3" json:"md5_hash,omitempty"`
// HTTP 1.1 Entity tag for the object. See
// [https://tools.ietf.org/html/rfc7232#section-2.3][RFC 7232 §2.3].
// Attempting to set or update this field will result in a
// [FieldViolation][google.rpc.BadRequest.FieldViolation].
Etag string `protobuf:"bytes,14,opt,name=etag,proto3" json:"etag,omitempty"`
// The modification time of the object metadata.
// Attempting to set or update this field will result in a
// [FieldViolation][google.rpc.BadRequest.FieldViolation].
Updated *timestamppb.Timestamp `protobuf:"bytes,15,opt,name=updated,proto3" json:"updated,omitempty"`
// Storage class of the object.
StorageClass string `protobuf:"bytes,16,opt,name=storage_class,json=storageClass,proto3" json:"storage_class,omitempty"`
// Cloud KMS Key used to encrypt this object, if the object is encrypted by
// such a key.
KmsKeyName string `protobuf:"bytes,17,opt,name=kms_key_name,json=kmsKeyName,proto3" json:"kms_key_name,omitempty"`
// 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].
TimeStorageClassUpdated *timestamppb.Timestamp `protobuf:"bytes,18,opt,name=time_storage_class_updated,json=timeStorageClassUpdated,proto3" json:"time_storage_class_updated,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,19,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. This value is in
// [https://tools.ietf.org/html/rfc3339][RFC 3339] format.
// Note 1: This field is not provided for objects with an active event-based
// hold, since retention expiration is unknown until the hold is removed.
// Note 2: This value can be provided even when temporary hold is set (so that
// the user can reason about policy without having to first unset the
// temporary hold).
RetentionExpirationTime *timestamppb.Timestamp `protobuf:"bytes,20,opt,name=retention_expiration_time,json=retentionExpirationTime,proto3" json:"retention_expiration_time,omitempty"`
// User-provided metadata, in key/value pairs.
Metadata map[string]string `protobuf:"bytes,21,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. Event-based hold is a way to
// retain objects until an event occurs, which is signified by the
// hold's release (i.e. this value is set to false). After being released (set
// to false), such objects will be subject to bucket-level retention (if any).
// One sample use case of this flag is for banks to hold loan documents for at
// least 3 years after loan is paid in full. Here, bucket-level retention is 3
// years and the event is the loan being paid in full. In this example, these
// objects will be held intact for any number of years until the event has
// occurred (event-based hold on the object is released) and then 3 more years
// after that. That means retention duration of the objects begins from the
// moment event-based hold transitioned from true to false.
EventBasedHold *wrapperspb.BoolValue `protobuf:"bytes,29,opt,name=event_based_hold,json=eventBasedHold,proto3" json:"event_based_hold,omitempty"`
// The name of the object.
// Attempting to update this field after the object is created will result in
// an error.
Name string `protobuf:"bytes,23,opt,name=name,proto3" json:"name,omitempty"`
// The ID of the object, including the bucket name, object name, and
// generation number.
// Attempting to update this field after the object is created will result in
// an error.
Id string `protobuf:"bytes,24,opt,name=id,proto3" json:"id,omitempty"`
// The name of the bucket containing this object.
// Attempting to update this field after the object is created will result in
// an error.
Bucket string `protobuf:"bytes,25,opt,name=bucket,proto3" json:"bucket,omitempty"`
// 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,26,opt,name=generation,proto3" json:"generation,omitempty"`
// 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,27,opt,name=owner,proto3" json:"owner,omitempty"`
// Metadata of customer-supplied encryption key, if the object is encrypted by
// such a key.
CustomerEncryption *Object_CustomerEncryption `protobuf:"bytes,28,opt,name=customer_encryption,json=customerEncryption,proto3" json:"customer_encryption,omitempty"`
// A user-specified timestamp set on an object.
CustomTime *timestamppb.Timestamp `protobuf:"bytes,30,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) 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) GetCrc32C() *wrapperspb.UInt32Value
func (x *Object) GetCustomTime() *timestamppb.Timestamp
func (x *Object) GetCustomerEncryption() *Object_CustomerEncryption
func (x *Object) GetEtag() string
func (x *Object) GetEventBasedHold() *wrapperspb.BoolValue
func (x *Object) GetGeneration() int64
func (x *Object) GetId() string
func (x *Object) GetKmsKeyName() string
func (x *Object) GetMd5Hash() 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) GetRetentionExpirationTime() *timestamppb.Timestamp
func (x *Object) GetSize() int64
func (x *Object) GetStorageClass() string
func (x *Object) GetTemporaryHold() bool
func (x *Object) GetTimeCreated() *timestamppb.Timestamp
func (x *Object) GetTimeDeleted() *timestamppb.Timestamp
func (x *Object) GetTimeStorageClassUpdated() *timestamppb.Timestamp
func (x *Object) GetUpdated() *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"`
// HTTP 1.1 Entity tag for the access-control entry.
// See [https://tools.ietf.org/html/rfc7232#section-2.3][RFC 7232 §2.3].
Etag string `protobuf:"bytes,2,opt,name=etag,proto3" json:"etag,omitempty"`
// The ID of the access-control entry.
Id string `protobuf:"bytes,3,opt,name=id,proto3" json:"id,omitempty"`
// The name of the bucket.
Bucket string `protobuf:"bytes,4,opt,name=bucket,proto3" json:"bucket,omitempty"`
// The name of the object, if applied to an object.
Object string `protobuf:"bytes,5,opt,name=object,proto3" json:"object,omitempty"`
// The content generation of the object, if applied to an object.
Generation int64 `protobuf:"varint,6,opt,name=generation,proto3" json:"generation,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,7,opt,name=entity,proto3" json:"entity,omitempty"`
// The ID for the entity, if any.
EntityId string `protobuf:"bytes,8,opt,name=entity_id,json=entityId,proto3" json:"entity_id,omitempty"`
// The email address associated with the entity, if any.
Email string `protobuf:"bytes,9,opt,name=email,proto3" json:"email,omitempty"`
// The domain associated with the entity, if any.
Domain string `protobuf:"bytes,10,opt,name=domain,proto3" json:"domain,omitempty"`
// The project team associated with the entity, if any.
ProjectTeam *ProjectTeam `protobuf:"bytes,11,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) GetBucket() string
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) GetGeneration() int64
func (x *ObjectAccessControl) GetId() string
func (x *ObjectAccessControl) GetObject() 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 GCS service for
// all written objects, and validated by the GCS service against
// client-supplied values if present in an InsertObjectRequest.
Crc32C *wrapperspb.UInt32Value `protobuf:"bytes,1,opt,name=crc32c,proto3" json:"crc32c,omitempty"`
// Hex-encoded MD5 hash of the object data (hexdigest). Whether/how this
// checksum is provided and validated is service-dependent.
Md5Hash string `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() *wrapperspb.UInt32Value
func (x *ObjectChecksums) GetMd5Hash() string
func (*ObjectChecksums) ProtoMessage()
func (x *ObjectChecksums) ProtoReflect() protoreflect.Message
func (x *ObjectChecksums) Reset()
func (x *ObjectChecksums) String() string
Describes the customer-specified mechanism used to store the data at rest.
type Object_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.
KeySha256 string `protobuf:"bytes,2,opt,name=key_sha256,json=keySha256,proto3" json:"key_sha256,omitempty"`
// contains filtered or unexported fields
}
func (*Object_CustomerEncryption) Descriptor() ([]byte, []int)
Deprecated: Use Object_CustomerEncryption.ProtoReflect.Descriptor instead.
func (x *Object_CustomerEncryption) GetEncryptionAlgorithm() string
func (x *Object_CustomerEncryption) GetKeySha256() string
func (*Object_CustomerEncryption) ProtoMessage()
func (x *Object_CustomerEncryption) ProtoReflect() protoreflect.Message
func (x *Object_CustomerEncryption) Reset()
func (x *Object_CustomerEncryption) 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
Request for PatchBucketAccessControl.
type PatchBucketAccessControlRequest struct {
// Required. Name of a bucket.
Bucket string `protobuf:"bytes,1,opt,name=bucket,proto3" json:"bucket,omitempty"`
// Required. The entity holding the permission. Can be one of:
// * `user-`*userId*
// * `user-`*emailAddress*
// * `group-`*groupId*
// * `group-`*emailAddress*
// * `allUsers`
// * `allAuthenticatedUsers`
Entity string `protobuf:"bytes,2,opt,name=entity,proto3" json:"entity,omitempty"`
// The BucketAccessControl for updating.
BucketAccessControl *BucketAccessControl `protobuf:"bytes,4,opt,name=bucket_access_control,json=bucketAccessControl,proto3" json:"bucket_access_control,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 `*`.
//
//
// 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,5,opt,name=update_mask,json=updateMask,proto3" json:"update_mask,omitempty"`
// A set of parameters common to all Storage API requests.
CommonRequestParams *CommonRequestParams `protobuf:"bytes,6,opt,name=common_request_params,json=commonRequestParams,proto3" json:"common_request_params,omitempty"`
// contains filtered or unexported fields
}
func (*PatchBucketAccessControlRequest) Descriptor() ([]byte, []int)
Deprecated: Use PatchBucketAccessControlRequest.ProtoReflect.Descriptor instead.
func (x *PatchBucketAccessControlRequest) GetBucket() string
func (x *PatchBucketAccessControlRequest) GetBucketAccessControl() *BucketAccessControl
func (x *PatchBucketAccessControlRequest) GetCommonRequestParams() *CommonRequestParams
func (x *PatchBucketAccessControlRequest) GetEntity() string
func (x *PatchBucketAccessControlRequest) GetUpdateMask() *fieldmaskpb.FieldMask
func (*PatchBucketAccessControlRequest) ProtoMessage()
func (x *PatchBucketAccessControlRequest) ProtoReflect() protoreflect.Message
func (x *PatchBucketAccessControlRequest) Reset()
func (x *PatchBucketAccessControlRequest) String() string
Request for PatchBucket method.
type PatchBucketRequest struct {
// Required. Name of a bucket.
Bucket string `protobuf:"bytes,1,opt,name=bucket,proto3" json:"bucket,omitempty"`
// Makes the return of the bucket metadata conditional on whether the bucket's
// current metageneration matches the given value.
IfMetagenerationMatch *wrapperspb.Int64Value `protobuf:"bytes,2,opt,name=if_metageneration_match,json=ifMetagenerationMatch,proto3" json:"if_metageneration_match,omitempty"`
// Makes the return of the bucket metadata conditional on whether the bucket's
// current metageneration does not match the given value.
IfMetagenerationNotMatch *wrapperspb.Int64Value `protobuf:"bytes,3,opt,name=if_metageneration_not_match,json=ifMetagenerationNotMatch,proto3" json:"if_metageneration_not_match,omitempty"`
// Apply a predefined set of access controls to this bucket.
PredefinedAcl CommonEnums_PredefinedBucketAcl `protobuf:"varint,4,opt,name=predefined_acl,json=predefinedAcl,proto3,enum=google.storage.v1.CommonEnums_PredefinedBucketAcl" json:"predefined_acl,omitempty"`
// Apply a predefined set of default object access controls to this bucket.
PredefinedDefaultObjectAcl CommonEnums_PredefinedObjectAcl `protobuf:"varint,5,opt,name=predefined_default_object_acl,json=predefinedDefaultObjectAcl,proto3,enum=google.storage.v1.CommonEnums_PredefinedObjectAcl" json:"predefined_default_object_acl,omitempty"`
// Set of properties to return. Defaults to `FULL`.
Projection CommonEnums_Projection `protobuf:"varint,6,opt,name=projection,proto3,enum=google.storage.v1.CommonEnums_Projection" json:"projection,omitempty"`
// The Bucket metadata for updating.
Metadata *Bucket `protobuf:"bytes,8,opt,name=metadata,proto3" json:"metadata,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,9,opt,name=update_mask,json=updateMask,proto3" json:"update_mask,omitempty"`
// A set of parameters common to all Storage API requests.
CommonRequestParams *CommonRequestParams `protobuf:"bytes,10,opt,name=common_request_params,json=commonRequestParams,proto3" json:"common_request_params,omitempty"`
// contains filtered or unexported fields
}
func (*PatchBucketRequest) Descriptor() ([]byte, []int)
Deprecated: Use PatchBucketRequest.ProtoReflect.Descriptor instead.
func (x *PatchBucketRequest) GetBucket() string
func (x *PatchBucketRequest) GetCommonRequestParams() *CommonRequestParams
func (x *PatchBucketRequest) GetIfMetagenerationMatch() *wrapperspb.Int64Value
func (x *PatchBucketRequest) GetIfMetagenerationNotMatch() *wrapperspb.Int64Value
func (x *PatchBucketRequest) GetMetadata() *Bucket
func (x *PatchBucketRequest) GetPredefinedAcl() CommonEnums_PredefinedBucketAcl
func (x *PatchBucketRequest) GetPredefinedDefaultObjectAcl() CommonEnums_PredefinedObjectAcl
func (x *PatchBucketRequest) GetProjection() CommonEnums_Projection
func (x *PatchBucketRequest) GetUpdateMask() *fieldmaskpb.FieldMask
func (*PatchBucketRequest) ProtoMessage()
func (x *PatchBucketRequest) ProtoReflect() protoreflect.Message
func (x *PatchBucketRequest) Reset()
func (x *PatchBucketRequest) String() string
Request message for PatchDefaultObjectAccessControl.
type PatchDefaultObjectAccessControlRequest struct {
// Required. Name of a bucket.
Bucket string `protobuf:"bytes,1,opt,name=bucket,proto3" json:"bucket,omitempty"`
// Required. The entity holding the permission. Can be one of:
// * `user-`*userId*
// * `user-`*emailAddress*
// * `group-`*groupId*
// * `group-`*emailAddress*
// * `allUsers`
// * `allAuthenticatedUsers`
Entity string `protobuf:"bytes,2,opt,name=entity,proto3" json:"entity,omitempty"`
// The ObjectAccessControl for updating.
ObjectAccessControl *ObjectAccessControl `protobuf:"bytes,4,opt,name=object_access_control,json=objectAccessControl,proto3" json:"object_access_control,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,5,opt,name=update_mask,json=updateMask,proto3" json:"update_mask,omitempty"`
// A set of parameters common to all Storage API requests.
CommonRequestParams *CommonRequestParams `protobuf:"bytes,6,opt,name=common_request_params,json=commonRequestParams,proto3" json:"common_request_params,omitempty"`
// contains filtered or unexported fields
}
func (*PatchDefaultObjectAccessControlRequest) Descriptor() ([]byte, []int)
Deprecated: Use PatchDefaultObjectAccessControlRequest.ProtoReflect.Descriptor instead.
func (x *PatchDefaultObjectAccessControlRequest) GetBucket() string
func (x *PatchDefaultObjectAccessControlRequest) GetCommonRequestParams() *CommonRequestParams
func (x *PatchDefaultObjectAccessControlRequest) GetEntity() string
func (x *PatchDefaultObjectAccessControlRequest) GetObjectAccessControl() *ObjectAccessControl
func (x *PatchDefaultObjectAccessControlRequest) GetUpdateMask() *fieldmaskpb.FieldMask
func (*PatchDefaultObjectAccessControlRequest) ProtoMessage()
func (x *PatchDefaultObjectAccessControlRequest) ProtoReflect() protoreflect.Message
func (x *PatchDefaultObjectAccessControlRequest) Reset()
func (x *PatchDefaultObjectAccessControlRequest) String() string
Request message for PatchObjectAccessControl.
type PatchObjectAccessControlRequest struct {
// Required. Name of a bucket.
Bucket string `protobuf:"bytes,1,opt,name=bucket,proto3" json:"bucket,omitempty"`
// Required. The entity holding the permission. Can be one of:
// * `user-`*userId*
// * `user-`*emailAddress*
// * `group-`*groupId*
// * `group-`*emailAddress*
// * `allUsers`
// * `allAuthenticatedUsers`
Entity string `protobuf:"bytes,2,opt,name=entity,proto3" json:"entity,omitempty"`
// Required. Name of the object.
// Required.
Object string `protobuf:"bytes,3,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,4,opt,name=generation,proto3" json:"generation,omitempty"`
// The ObjectAccessControl for updating.
ObjectAccessControl *ObjectAccessControl `protobuf:"bytes,5,opt,name=object_access_control,json=objectAccessControl,proto3" json:"object_access_control,omitempty"`
// A set of parameters common to all Storage API requests.
CommonRequestParams *CommonRequestParams `protobuf:"bytes,6,opt,name=common_request_params,json=commonRequestParams,proto3" json:"common_request_params,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"`
// contains filtered or unexported fields
}
func (*PatchObjectAccessControlRequest) Descriptor() ([]byte, []int)
Deprecated: Use PatchObjectAccessControlRequest.ProtoReflect.Descriptor instead.
func (x *PatchObjectAccessControlRequest) GetBucket() string
func (x *PatchObjectAccessControlRequest) GetCommonRequestParams() *CommonRequestParams
func (x *PatchObjectAccessControlRequest) GetEntity() string
func (x *PatchObjectAccessControlRequest) GetGeneration() int64
func (x *PatchObjectAccessControlRequest) GetObject() string
func (x *PatchObjectAccessControlRequest) GetObjectAccessControl() *ObjectAccessControl
func (x *PatchObjectAccessControlRequest) GetUpdateMask() *fieldmaskpb.FieldMask
func (*PatchObjectAccessControlRequest) ProtoMessage()
func (x *PatchObjectAccessControlRequest) ProtoReflect() protoreflect.Message
func (x *PatchObjectAccessControlRequest) Reset()
func (x *PatchObjectAccessControlRequest) String() string
Request message for PatchObject.
type PatchObjectRequest 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 *wrapperspb.Int64Value `protobuf:"bytes,4,opt,name=if_generation_match,json=ifGenerationMatch,proto3" json:"if_generation_match,omitempty"`
// Makes the operation conditional on whether the object's current generation
// does not match the given value. If no live object exists, the precondition
// fails. Setting to 0 makes the operation succeed only if there is a live
// version of the object.
IfGenerationNotMatch *wrapperspb.Int64Value `protobuf:"bytes,5,opt,name=if_generation_not_match,json=ifGenerationNotMatch,proto3" json:"if_generation_not_match,omitempty"`
// Makes the operation conditional on whether the object's current
// metageneration matches the given value.
IfMetagenerationMatch *wrapperspb.Int64Value `protobuf:"bytes,6,opt,name=if_metageneration_match,json=ifMetagenerationMatch,proto3" json:"if_metageneration_match,omitempty"`
// Makes the operation conditional on whether the object's current
// metageneration does not match the given value.
IfMetagenerationNotMatch *wrapperspb.Int64Value `protobuf:"bytes,7,opt,name=if_metageneration_not_match,json=ifMetagenerationNotMatch,proto3" json:"if_metageneration_not_match,omitempty"`
// Apply a predefined set of access controls to this object.
PredefinedAcl CommonEnums_PredefinedObjectAcl `protobuf:"varint,8,opt,name=predefined_acl,json=predefinedAcl,proto3,enum=google.storage.v1.CommonEnums_PredefinedObjectAcl" json:"predefined_acl,omitempty"`
// Set of properties to return. Defaults to `FULL`.
Projection CommonEnums_Projection `protobuf:"varint,9,opt,name=projection,proto3,enum=google.storage.v1.CommonEnums_Projection" json:"projection,omitempty"`
// The Object metadata for updating.
Metadata *Object `protobuf:"bytes,11,opt,name=metadata,proto3" json:"metadata,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,12,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,13,opt,name=common_object_request_params,json=commonObjectRequestParams,proto3" json:"common_object_request_params,omitempty"`
// A set of parameters common to all Storage API requests.
CommonRequestParams *CommonRequestParams `protobuf:"bytes,14,opt,name=common_request_params,json=commonRequestParams,proto3" json:"common_request_params,omitempty"`
// contains filtered or unexported fields
}
func (*PatchObjectRequest) Descriptor() ([]byte, []int)
Deprecated: Use PatchObjectRequest.ProtoReflect.Descriptor instead.
func (x *PatchObjectRequest) GetBucket() string
func (x *PatchObjectRequest) GetCommonObjectRequestParams() *CommonObjectRequestParams
func (x *PatchObjectRequest) GetCommonRequestParams() *CommonRequestParams
func (x *PatchObjectRequest) GetGeneration() int64
func (x *PatchObjectRequest) GetIfGenerationMatch() *wrapperspb.Int64Value
func (x *PatchObjectRequest) GetIfGenerationNotMatch() *wrapperspb.Int64Value
func (x *PatchObjectRequest) GetIfMetagenerationMatch() *wrapperspb.Int64Value
func (x *PatchObjectRequest) GetIfMetagenerationNotMatch() *wrapperspb.Int64Value
func (x *PatchObjectRequest) GetMetadata() *Object
func (x *PatchObjectRequest) GetObject() string
func (x *PatchObjectRequest) GetPredefinedAcl() CommonEnums_PredefinedObjectAcl
func (x *PatchObjectRequest) GetProjection() CommonEnums_Projection
func (x *PatchObjectRequest) GetUpdateMask() *fieldmaskpb.FieldMask
func (*PatchObjectRequest) ProtoMessage()
func (x *PatchObjectRequest) ProtoReflect() protoreflect.Message
func (x *PatchObjectRequest) Reset()
func (x *PatchObjectRequest) 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"`
// A set of parameters common to all Storage API requests.
CommonRequestParams *CommonRequestParams `protobuf:"bytes,3,opt,name=common_request_params,json=commonRequestParams,proto3" json:"common_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) GetCommonRequestParams() *CommonRequestParams
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 number of bytes that have been processed for the given object.
CommittedSize int64 `protobuf:"varint,1,opt,name=committed_size,json=committedSize,proto3" json:"committed_size,omitempty"`
// `complete` is `true` only if the client has sent a `InsertObjectRequest`
// with `finish_write` set to true, and the server has processed that request.
Complete bool `protobuf:"varint,2,opt,name=complete,proto3" json:"complete,omitempty"`
// The metadata for the uploaded object. Only set if `complete` is `true`.
Resource *Object `protobuf:"bytes,3,opt,name=resource,proto3" json:"resource,omitempty"`
// contains filtered or unexported fields
}
func (*QueryWriteStatusResponse) Descriptor() ([]byte, []int)
Deprecated: Use QueryWriteStatusResponse.ProtoReflect.Descriptor instead.
func (x *QueryWriteStatusResponse) GetCommittedSize() int64
func (x *QueryWriteStatusResponse) GetComplete() bool
func (x *QueryWriteStatusResponse) GetResource() *Object
func (*QueryWriteStatusResponse) ProtoMessage()
func (x *QueryWriteStatusResponse) ProtoReflect() protoreflect.Message
func (x *QueryWriteStatusResponse) Reset()
func (x *QueryWriteStatusResponse) String() string
Request message for RewriteObject.
type RewriteObjectRequest struct {
// Required. Name of the bucket in which to store the new object. Overrides the provided
// object metadata's `bucket` value, if any.
DestinationBucket string `protobuf:"bytes,1,opt,name=destination_bucket,json=destinationBucket,proto3" json:"destination_bucket,omitempty"`
// Required. Name of the new object.
// Required when the object metadata is not otherwise provided. Overrides the
// object metadata's `name` value, if any.
DestinationObject string `protobuf:"bytes,2,opt,name=destination_object,json=destinationObject,proto3" json:"destination_object,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.
DestinationKmsKeyName string `protobuf:"bytes,3,opt,name=destination_kms_key_name,json=destinationKmsKeyName,proto3" json:"destination_kms_key_name,omitempty"`
// Apply a predefined set of access controls to the destination object.
DestinationPredefinedAcl CommonEnums_PredefinedObjectAcl `protobuf:"varint,4,opt,name=destination_predefined_acl,json=destinationPredefinedAcl,proto3,enum=google.storage.v1.CommonEnums_PredefinedObjectAcl" 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 *wrapperspb.Int64Value `protobuf:"bytes,5,opt,name=if_generation_match,json=ifGenerationMatch,proto3" json:"if_generation_match,omitempty"`
// Makes the operation conditional on whether the object's current generation
// does not match the given value. If no live object exists, the precondition
// fails. Setting to 0 makes the operation succeed only if there is a live
// version of the object.
IfGenerationNotMatch *wrapperspb.Int64Value `protobuf:"bytes,6,opt,name=if_generation_not_match,json=ifGenerationNotMatch,proto3" json:"if_generation_not_match,omitempty"`
// Makes the operation conditional on whether the destination object's current
// metageneration matches the given value.
IfMetagenerationMatch *wrapperspb.Int64Value `protobuf:"bytes,7,opt,name=if_metageneration_match,json=ifMetagenerationMatch,proto3" json:"if_metageneration_match,omitempty"`
// Makes the operation conditional on whether the destination object's current
// metageneration does not match the given value.
IfMetagenerationNotMatch *wrapperspb.Int64Value `protobuf:"bytes,8,opt,name=if_metageneration_not_match,json=ifMetagenerationNotMatch,proto3" json:"if_metageneration_not_match,omitempty"`
// Makes the operation conditional on whether the source object's current
// generation matches the given value.
IfSourceGenerationMatch *wrapperspb.Int64Value `protobuf:"bytes,9,opt,name=if_source_generation_match,json=ifSourceGenerationMatch,proto3" json:"if_source_generation_match,omitempty"`
// Makes the operation conditional on whether the source object's current
// generation does not match the given value.
IfSourceGenerationNotMatch *wrapperspb.Int64Value `protobuf:"bytes,10,opt,name=if_source_generation_not_match,json=ifSourceGenerationNotMatch,proto3" json:"if_source_generation_not_match,omitempty"`
// Makes the operation conditional on whether the source object's current
// metageneration matches the given value.
IfSourceMetagenerationMatch *wrapperspb.Int64Value `protobuf:"bytes,11,opt,name=if_source_metageneration_match,json=ifSourceMetagenerationMatch,proto3" 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 *wrapperspb.Int64Value `protobuf:"bytes,12,opt,name=if_source_metageneration_not_match,json=ifSourceMetagenerationNotMatch,proto3" 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,13,opt,name=max_bytes_rewritten_per_call,json=maxBytesRewrittenPerCall,proto3" json:"max_bytes_rewritten_per_call,omitempty"`
// Set of properties to return. Defaults to `NO_ACL`, unless the
// object resource specifies the `acl` property, when it defaults
// to `full`.
Projection CommonEnums_Projection `protobuf:"varint,14,opt,name=projection,proto3,enum=google.storage.v1.CommonEnums_Projection" json:"projection,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,15,opt,name=rewrite_token,json=rewriteToken,proto3" json:"rewrite_token,omitempty"`
// Required. Name of the bucket in which to find the source object.
SourceBucket string `protobuf:"bytes,16,opt,name=source_bucket,json=sourceBucket,proto3" json:"source_bucket,omitempty"`
// Required. Name of the source object.
SourceObject string `protobuf:"bytes,17,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,18,opt,name=source_generation,json=sourceGeneration,proto3" json:"source_generation,omitempty"`
// Properties of the destination, post-rewrite object.
Object *Object `protobuf:"bytes,20,opt,name=object,proto3" json:"object,omitempty"`
// The algorithm used to encrypt the source object, if any.
CopySourceEncryptionAlgorithm string `protobuf:"bytes,21,opt,name=copy_source_encryption_algorithm,json=copySourceEncryptionAlgorithm,proto3" json:"copy_source_encryption_algorithm,omitempty"`
// The encryption key used to encrypt the source object, if any.
CopySourceEncryptionKey string `protobuf:"bytes,22,opt,name=copy_source_encryption_key,json=copySourceEncryptionKey,proto3" json:"copy_source_encryption_key,omitempty"`
// The SHA-256 hash of the key used to encrypt the source object, if any.
CopySourceEncryptionKeySha256 string `protobuf:"bytes,23,opt,name=copy_source_encryption_key_sha256,json=copySourceEncryptionKeySha256,proto3" json:"copy_source_encryption_key_sha256,omitempty"`
// A set of parameters common to Storage API requests concerning an object.
CommonObjectRequestParams *CommonObjectRequestParams `protobuf:"bytes,24,opt,name=common_object_request_params,json=commonObjectRequestParams,proto3" json:"common_object_request_params,omitempty"`
// A set of parameters common to all Storage API requests.
CommonRequestParams *CommonRequestParams `protobuf:"bytes,25,opt,name=common_request_params,json=commonRequestParams,proto3" json:"common_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) GetCommonRequestParams() *CommonRequestParams
func (x *RewriteObjectRequest) GetCopySourceEncryptionAlgorithm() string
func (x *RewriteObjectRequest) GetCopySourceEncryptionKey() string
func (x *RewriteObjectRequest) GetCopySourceEncryptionKeySha256() string
func (x *RewriteObjectRequest) GetDestinationBucket() string
func (x *RewriteObjectRequest) GetDestinationKmsKeyName() string
func (x *RewriteObjectRequest) GetDestinationObject() string
func (x *RewriteObjectRequest) GetDestinationPredefinedAcl() CommonEnums_PredefinedObjectAcl
func (x *RewriteObjectRequest) GetIfGenerationMatch() *wrapperspb.Int64Value
func (x *RewriteObjectRequest) GetIfGenerationNotMatch() *wrapperspb.Int64Value
func (x *RewriteObjectRequest) GetIfMetagenerationMatch() *wrapperspb.Int64Value
func (x *RewriteObjectRequest) GetIfMetagenerationNotMatch() *wrapperspb.Int64Value
func (x *RewriteObjectRequest) GetIfSourceGenerationMatch() *wrapperspb.Int64Value
func (x *RewriteObjectRequest) GetIfSourceGenerationNotMatch() *wrapperspb.Int64Value
func (x *RewriteObjectRequest) GetIfSourceMetagenerationMatch() *wrapperspb.Int64Value
func (x *RewriteObjectRequest) GetIfSourceMetagenerationNotMatch() *wrapperspb.Int64Value
func (x *RewriteObjectRequest) GetMaxBytesRewrittenPerCall() int64
func (x *RewriteObjectRequest) GetObject() *Object
func (x *RewriteObjectRequest) GetProjection() CommonEnums_Projection
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 subscription to receive Google PubSub notifications.
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 InsertObjectRequest.
// 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 NotificationConfigurations 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 NotificationConfig.
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
A wrapper around the IAM set policy request to support our common_request_params.
type SetIamPolicyRequest struct {
// The request sent to IAM.
IamRequest *v1.SetIamPolicyRequest `protobuf:"bytes,1,opt,name=iam_request,json=iamRequest,proto3" json:"iam_request,omitempty"`
// A set of parameters common to all Storage API requests.
CommonRequestParams *CommonRequestParams `protobuf:"bytes,2,opt,name=common_request_params,json=commonRequestParams,proto3" json:"common_request_params,omitempty"`
// contains filtered or unexported fields
}
func (*SetIamPolicyRequest) Descriptor() ([]byte, []int)
Deprecated: Use SetIamPolicyRequest.ProtoReflect.Descriptor instead.
func (x *SetIamPolicyRequest) GetCommonRequestParams() *CommonRequestParams
func (x *SetIamPolicyRequest) GetIamRequest() *v1.SetIamPolicyRequest
func (*SetIamPolicyRequest) ProtoMessage()
func (x *SetIamPolicyRequest) ProtoReflect() protoreflect.Message
func (x *SetIamPolicyRequest) Reset()
func (x *SetIamPolicyRequest) String() string
Request message StartResumableWrite.
type StartResumableWriteRequest struct {
// The destination bucket, object, and metadata, as well as any preconditions.
InsertObjectSpec *InsertObjectSpec `protobuf:"bytes,1,opt,name=insert_object_spec,json=insertObjectSpec,proto3" json:"insert_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"`
// A set of parameters common to all Storage API requests.
CommonRequestParams *CommonRequestParams `protobuf:"bytes,4,opt,name=common_request_params,json=commonRequestParams,proto3" json:"common_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) GetCommonRequestParams() *CommonRequestParams
func (x *StartResumableWriteRequest) GetInsertObjectSpec() *InsertObjectSpec
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 `InsertObjectRequest.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
Request message for StopChannel.
type StopChannelRequest struct {
// The channel to be stopped.
Channel *Channel `protobuf:"bytes,1,opt,name=channel,proto3" json:"channel,omitempty"`
// A set of parameters common to all Storage API requests.
CommonRequestParams *CommonRequestParams `protobuf:"bytes,2,opt,name=common_request_params,json=commonRequestParams,proto3" json:"common_request_params,omitempty"`
// contains filtered or unexported fields
}
func (*StopChannelRequest) Descriptor() ([]byte, []int)
Deprecated: Use StopChannelRequest.ProtoReflect.Descriptor instead.
func (x *StopChannelRequest) GetChannel() *Channel
func (x *StopChannelRequest) GetCommonRequestParams() *CommonRequestParams
func (*StopChannelRequest) ProtoMessage()
func (x *StopChannelRequest) ProtoReflect() protoreflect.Message
func (x *StopChannelRequest) Reset()
func (x *StopChannelRequest) 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 the ACL entry for the specified entity on the specified
// bucket.
DeleteBucketAccessControl(ctx context.Context, in *DeleteBucketAccessControlRequest, opts ...grpc.CallOption) (*emptypb.Empty, error)
// Returns the ACL entry for the specified entity on the specified bucket.
GetBucketAccessControl(ctx context.Context, in *GetBucketAccessControlRequest, opts ...grpc.CallOption) (*BucketAccessControl, error)
// Creates a new ACL entry on the specified bucket.
InsertBucketAccessControl(ctx context.Context, in *InsertBucketAccessControlRequest, opts ...grpc.CallOption) (*BucketAccessControl, error)
// Retrieves ACL entries on the specified bucket.
ListBucketAccessControls(ctx context.Context, in *ListBucketAccessControlsRequest, opts ...grpc.CallOption) (*ListBucketAccessControlsResponse, error)
// Updates an ACL entry on the specified bucket. Equivalent to
// PatchBucketAccessControl, but all unspecified fields will be
// reset to their default values.
UpdateBucketAccessControl(ctx context.Context, in *UpdateBucketAccessControlRequest, opts ...grpc.CallOption) (*BucketAccessControl, error)
// Updates an ACL entry on the specified bucket.
PatchBucketAccessControl(ctx context.Context, in *PatchBucketAccessControlRequest, opts ...grpc.CallOption) (*BucketAccessControl, error)
// 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.
InsertBucket(ctx context.Context, in *InsertBucketRequest, opts ...grpc.CallOption) (*Bucket, error)
// List active object change notification channels for this bucket.
ListChannels(ctx context.Context, in *ListChannelsRequest, opts ...grpc.CallOption) (*ListChannelsResponse, 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 *LockRetentionPolicyRequest, opts ...grpc.CallOption) (*Bucket, error)
// Gets the IAM policy for the specified bucket.
GetBucketIamPolicy(ctx context.Context, in *GetIamPolicyRequest, opts ...grpc.CallOption) (*v1.Policy, error)
// Updates an IAM policy for the specified bucket.
SetBucketIamPolicy(ctx context.Context, in *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.
TestBucketIamPermissions(ctx context.Context, in *TestIamPermissionsRequest, opts ...grpc.CallOption) (*v1.TestIamPermissionsResponse, error)
// Updates a bucket. Changes to the bucket will be readable immediately after
// writing, but configuration changes may take time to propagate.
PatchBucket(ctx context.Context, in *PatchBucketRequest, opts ...grpc.CallOption) (*Bucket, error)
// Updates a bucket. Equivalent to PatchBucket, but always replaces all
// mutatable fields of the bucket with new values, reverting all
// unspecified fields to their default values.
// Like PatchBucket, Changes to the bucket will be readable immediately after
// writing, but configuration changes may take time to propagate.
UpdateBucket(ctx context.Context, in *UpdateBucketRequest, opts ...grpc.CallOption) (*Bucket, error)
// Halts "Object Change Notification" push messagages.
// See https://cloud.google.com/storage/docs/object-change-notification
// Note: this is not related to the newer "Notifications" resource, which
// are stopped using DeleteNotification.
StopChannel(ctx context.Context, in *StopChannelRequest, opts ...grpc.CallOption) (*emptypb.Empty, error)
// Permanently deletes the default object ACL entry for the specified entity
// on the specified bucket.
DeleteDefaultObjectAccessControl(ctx context.Context, in *DeleteDefaultObjectAccessControlRequest, opts ...grpc.CallOption) (*emptypb.Empty, error)
// Returns the default object ACL entry for the specified entity on the
// specified bucket.
GetDefaultObjectAccessControl(ctx context.Context, in *GetDefaultObjectAccessControlRequest, opts ...grpc.CallOption) (*ObjectAccessControl, error)
// Creates a new default object ACL entry on the specified bucket.
InsertDefaultObjectAccessControl(ctx context.Context, in *InsertDefaultObjectAccessControlRequest, opts ...grpc.CallOption) (*ObjectAccessControl, error)
// Retrieves default object ACL entries on the specified bucket.
ListDefaultObjectAccessControls(ctx context.Context, in *ListDefaultObjectAccessControlsRequest, opts ...grpc.CallOption) (*ListObjectAccessControlsResponse, error)
// Updates a default object ACL entry on the specified bucket.
PatchDefaultObjectAccessControl(ctx context.Context, in *PatchDefaultObjectAccessControlRequest, opts ...grpc.CallOption) (*ObjectAccessControl, error)
// Updates a default object ACL entry on the specified bucket. Equivalent to
// PatchDefaultObjectAccessControl, but modifies all unspecified fields to
// their default values.
UpdateDefaultObjectAccessControl(ctx context.Context, in *UpdateDefaultObjectAccessControlRequest, opts ...grpc.CallOption) (*ObjectAccessControl, error)
// Permanently deletes a notification subscription.
// Note: Older, "Object Change Notification" push subscriptions should be
// deleted using StopChannel instead.
DeleteNotification(ctx context.Context, in *DeleteNotificationRequest, opts ...grpc.CallOption) (*emptypb.Empty, error)
// View a notification configuration.
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
// Cloud Pub/Sub topics.
// See https://cloud.google.com/storage/docs/pubsub-notifications.
InsertNotification(ctx context.Context, in *InsertNotificationRequest, 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)
// Permanently deletes the ACL entry for the specified entity on the specified
// object.
DeleteObjectAccessControl(ctx context.Context, in *DeleteObjectAccessControlRequest, opts ...grpc.CallOption) (*emptypb.Empty, error)
// Returns the ACL entry for the specified entity on the specified object.
GetObjectAccessControl(ctx context.Context, in *GetObjectAccessControlRequest, opts ...grpc.CallOption) (*ObjectAccessControl, error)
// Creates a new ACL entry on the specified object.
InsertObjectAccessControl(ctx context.Context, in *InsertObjectAccessControlRequest, opts ...grpc.CallOption) (*ObjectAccessControl, error)
// Retrieves ACL entries on the specified object.
ListObjectAccessControls(ctx context.Context, in *ListObjectAccessControlsRequest, opts ...grpc.CallOption) (*ListObjectAccessControlsResponse, error)
// Patches an ACL entry on the specified object. Patch is similar to update,
// but only applies or appends the specified fields in the
// object_access_control object. Other fields are unaffected.
PatchObjectAccessControl(ctx context.Context, in *PatchObjectAccessControlRequest, opts ...grpc.CallOption) (*ObjectAccessControl, error)
// Updates an ACL entry on the specified object.
UpdateObjectAccessControl(ctx context.Context, in *UpdateObjectAccessControlRequest, opts ...grpc.CallOption) (*ObjectAccessControl, 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)
// Copies a source object to a destination object. Optionally overrides
// metadata.
CopyObject(ctx context.Context, in *CopyObjectRequest, 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.
GetObjectMedia(ctx context.Context, in *GetObjectMediaRequest, opts ...grpc.CallOption) (Storage_GetObjectMediaClient, 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
// `InsertObjectSpec` 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()` and provide that method an `InsertObjectSpec.`
// They should then attach the returned `upload_id` to the first message of
// each following call to `Insert`. If there is an error or the connection is
// broken during the resumable `Insert()`, the client should check the status
// of the `Insert()` by calling `QueryWriteStatus()` and continue writing from
// the returned `committed_size`. This may be less than the amount of data the
// client previously sent.
//
// The service will not view the object as complete until the client has
// sent an `Insert` 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
// `Object` it receives to determine how much data the service was
// able to commit and whether the service views the object as complete.
InsertObject(ctx context.Context, opts ...grpc.CallOption) (Storage_InsertObjectClient, 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 `committed_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 `committed_size` values will be
// non-decreasing.
QueryWriteStatus(ctx context.Context, in *QueryWriteStatusRequest, opts ...grpc.CallOption) (*QueryWriteStatusResponse, error)
// Updates an object's metadata.
PatchObject(ctx context.Context, in *PatchObjectRequest, opts ...grpc.CallOption) (*Object, error)
// Updates an object's metadata. Equivalent to PatchObject, but always
// replaces all mutatable fields of the bucket with new values, reverting all
// unspecified fields to their default values.
UpdateObject(ctx context.Context, in *UpdateObjectRequest, opts ...grpc.CallOption) (*Object, error)
// Watch for changes on all objects in a bucket.
WatchAllObjects(ctx context.Context, in *WatchAllObjectsRequest, opts ...grpc.CallOption) (*Channel, error)
// Retrieves the name of a project's Google Cloud Storage service account.
GetServiceAccount(ctx context.Context, in *GetProjectServiceAccountRequest, 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 the ACL entry for the specified entity on the specified
// bucket.
DeleteBucketAccessControl(context.Context, *DeleteBucketAccessControlRequest) (*emptypb.Empty, error)
// Returns the ACL entry for the specified entity on the specified bucket.
GetBucketAccessControl(context.Context, *GetBucketAccessControlRequest) (*BucketAccessControl, error)
// Creates a new ACL entry on the specified bucket.
InsertBucketAccessControl(context.Context, *InsertBucketAccessControlRequest) (*BucketAccessControl, error)
// Retrieves ACL entries on the specified bucket.
ListBucketAccessControls(context.Context, *ListBucketAccessControlsRequest) (*ListBucketAccessControlsResponse, error)
// Updates an ACL entry on the specified bucket. Equivalent to
// PatchBucketAccessControl, but all unspecified fields will be
// reset to their default values.
UpdateBucketAccessControl(context.Context, *UpdateBucketAccessControlRequest) (*BucketAccessControl, error)
// Updates an ACL entry on the specified bucket.
PatchBucketAccessControl(context.Context, *PatchBucketAccessControlRequest) (*BucketAccessControl, error)
// 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.
InsertBucket(context.Context, *InsertBucketRequest) (*Bucket, error)
// List active object change notification channels for this bucket.
ListChannels(context.Context, *ListChannelsRequest) (*ListChannelsResponse, 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, *LockRetentionPolicyRequest) (*Bucket, error)
// Gets the IAM policy for the specified bucket.
GetBucketIamPolicy(context.Context, *GetIamPolicyRequest) (*v1.Policy, error)
// Updates an IAM policy for the specified bucket.
SetBucketIamPolicy(context.Context, *SetIamPolicyRequest) (*v1.Policy, error)
// Tests a set of permissions on the given bucket to see which, if
// any, are held by the caller.
TestBucketIamPermissions(context.Context, *TestIamPermissionsRequest) (*v1.TestIamPermissionsResponse, error)
// Updates a bucket. Changes to the bucket will be readable immediately after
// writing, but configuration changes may take time to propagate.
PatchBucket(context.Context, *PatchBucketRequest) (*Bucket, error)
// Updates a bucket. Equivalent to PatchBucket, but always replaces all
// mutatable fields of the bucket with new values, reverting all
// unspecified fields to their default values.
// Like PatchBucket, Changes to the bucket will be readable immediately after
// writing, but configuration changes may take time to propagate.
UpdateBucket(context.Context, *UpdateBucketRequest) (*Bucket, error)
// Halts "Object Change Notification" push messagages.
// See https://cloud.google.com/storage/docs/object-change-notification
// Note: this is not related to the newer "Notifications" resource, which
// are stopped using DeleteNotification.
StopChannel(context.Context, *StopChannelRequest) (*emptypb.Empty, error)
// Permanently deletes the default object ACL entry for the specified entity
// on the specified bucket.
DeleteDefaultObjectAccessControl(context.Context, *DeleteDefaultObjectAccessControlRequest) (*emptypb.Empty, error)
// Returns the default object ACL entry for the specified entity on the
// specified bucket.
GetDefaultObjectAccessControl(context.Context, *GetDefaultObjectAccessControlRequest) (*ObjectAccessControl, error)
// Creates a new default object ACL entry on the specified bucket.
InsertDefaultObjectAccessControl(context.Context, *InsertDefaultObjectAccessControlRequest) (*ObjectAccessControl, error)
// Retrieves default object ACL entries on the specified bucket.
ListDefaultObjectAccessControls(context.Context, *ListDefaultObjectAccessControlsRequest) (*ListObjectAccessControlsResponse, error)
// Updates a default object ACL entry on the specified bucket.
PatchDefaultObjectAccessControl(context.Context, *PatchDefaultObjectAccessControlRequest) (*ObjectAccessControl, error)
// Updates a default object ACL entry on the specified bucket. Equivalent to
// PatchDefaultObjectAccessControl, but modifies all unspecified fields to
// their default values.
UpdateDefaultObjectAccessControl(context.Context, *UpdateDefaultObjectAccessControlRequest) (*ObjectAccessControl, error)
// Permanently deletes a notification subscription.
// Note: Older, "Object Change Notification" push subscriptions should be
// deleted using StopChannel instead.
DeleteNotification(context.Context, *DeleteNotificationRequest) (*emptypb.Empty, error)
// View a notification configuration.
GetNotification(context.Context, *GetNotificationRequest) (*Notification, error)
// Creates a notification subscription for a given bucket.
// These notifications, when triggered, publish messages to the specified
// Cloud Pub/Sub topics.
// See https://cloud.google.com/storage/docs/pubsub-notifications.
InsertNotification(context.Context, *InsertNotificationRequest) (*Notification, error)
// Retrieves a list of notification subscriptions for a given bucket.
ListNotifications(context.Context, *ListNotificationsRequest) (*ListNotificationsResponse, error)
// Permanently deletes the ACL entry for the specified entity on the specified
// object.
DeleteObjectAccessControl(context.Context, *DeleteObjectAccessControlRequest) (*emptypb.Empty, error)
// Returns the ACL entry for the specified entity on the specified object.
GetObjectAccessControl(context.Context, *GetObjectAccessControlRequest) (*ObjectAccessControl, error)
// Creates a new ACL entry on the specified object.
InsertObjectAccessControl(context.Context, *InsertObjectAccessControlRequest) (*ObjectAccessControl, error)
// Retrieves ACL entries on the specified object.
ListObjectAccessControls(context.Context, *ListObjectAccessControlsRequest) (*ListObjectAccessControlsResponse, error)
// Patches an ACL entry on the specified object. Patch is similar to update,
// but only applies or appends the specified fields in the
// object_access_control object. Other fields are unaffected.
PatchObjectAccessControl(context.Context, *PatchObjectAccessControlRequest) (*ObjectAccessControl, error)
// Updates an ACL entry on the specified object.
UpdateObjectAccessControl(context.Context, *UpdateObjectAccessControlRequest) (*ObjectAccessControl, error)
// Concatenates a list of existing objects into a new object in the same
// bucket.
ComposeObject(context.Context, *ComposeObjectRequest) (*Object, error)
// Copies a source object to a destination object. Optionally overrides
// metadata.
CopyObject(context.Context, *CopyObjectRequest) (*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.
GetObjectMedia(*GetObjectMediaRequest, Storage_GetObjectMediaServer) 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
// `InsertObjectSpec` 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()` and provide that method an `InsertObjectSpec.`
// They should then attach the returned `upload_id` to the first message of
// each following call to `Insert`. If there is an error or the connection is
// broken during the resumable `Insert()`, the client should check the status
// of the `Insert()` by calling `QueryWriteStatus()` and continue writing from
// the returned `committed_size`. This may be less than the amount of data the
// client previously sent.
//
// The service will not view the object as complete until the client has
// sent an `Insert` 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
// `Object` it receives to determine how much data the service was
// able to commit and whether the service views the object as complete.
InsertObject(Storage_InsertObjectServer) 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 `committed_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 `committed_size` values will be
// non-decreasing.
QueryWriteStatus(context.Context, *QueryWriteStatusRequest) (*QueryWriteStatusResponse, error)
// Updates an object's metadata.
PatchObject(context.Context, *PatchObjectRequest) (*Object, error)
// Updates an object's metadata. Equivalent to PatchObject, but always
// replaces all mutatable fields of the bucket with new values, reverting all
// unspecified fields to their default values.
UpdateObject(context.Context, *UpdateObjectRequest) (*Object, error)
// Watch for changes on all objects in a bucket.
WatchAllObjects(context.Context, *WatchAllObjectsRequest) (*Channel, error)
// Retrieves the name of a project's Google Cloud Storage service account.
GetServiceAccount(context.Context, *GetProjectServiceAccountRequest) (*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_GetObjectMediaClient interface {
Recv() (*GetObjectMediaResponse, error)
grpc.ClientStream
}
type Storage_GetObjectMediaServer interface {
Send(*GetObjectMediaResponse) error
grpc.ServerStream
}
type Storage_InsertObjectClient interface {
Send(*InsertObjectRequest) error
CloseAndRecv() (*Object, error)
grpc.ClientStream
}
type Storage_InsertObjectServer interface {
SendAndClose(*Object) error
Recv() (*InsertObjectRequest, error)
grpc.ServerStream
}
A wrapper around the IAM test iam permissions request to support our common_request_params.
type TestIamPermissionsRequest struct {
// The request sent to IAM.
IamRequest *v1.TestIamPermissionsRequest `protobuf:"bytes,1,opt,name=iam_request,json=iamRequest,proto3" json:"iam_request,omitempty"`
// A set of parameters common to all Storage API requests.
CommonRequestParams *CommonRequestParams `protobuf:"bytes,2,opt,name=common_request_params,json=commonRequestParams,proto3" json:"common_request_params,omitempty"`
// contains filtered or unexported fields
}
func (*TestIamPermissionsRequest) Descriptor() ([]byte, []int)
Deprecated: Use TestIamPermissionsRequest.ProtoReflect.Descriptor instead.
func (x *TestIamPermissionsRequest) GetCommonRequestParams() *CommonRequestParams
func (x *TestIamPermissionsRequest) GetIamRequest() *v1.TestIamPermissionsRequest
func (*TestIamPermissionsRequest) ProtoMessage()
func (x *TestIamPermissionsRequest) ProtoReflect() protoreflect.Message
func (x *TestIamPermissionsRequest) Reset()
func (x *TestIamPermissionsRequest) String() string
UnimplementedStorageServer can be embedded to have forward compatible implementations.
type UnimplementedStorageServer struct {
}
func (*UnimplementedStorageServer) ComposeObject(context.Context, *ComposeObjectRequest) (*Object, error)
func (*UnimplementedStorageServer) CopyObject(context.Context, *CopyObjectRequest) (*Object, error)
func (*UnimplementedStorageServer) CreateHmacKey(context.Context, *CreateHmacKeyRequest) (*CreateHmacKeyResponse, error)
func (*UnimplementedStorageServer) DeleteBucket(context.Context, *DeleteBucketRequest) (*emptypb.Empty, error)
func (*UnimplementedStorageServer) DeleteBucketAccessControl(context.Context, *DeleteBucketAccessControlRequest) (*emptypb.Empty, error)
func (*UnimplementedStorageServer) DeleteDefaultObjectAccessControl(context.Context, *DeleteDefaultObjectAccessControlRequest) (*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) DeleteObjectAccessControl(context.Context, *DeleteObjectAccessControlRequest) (*emptypb.Empty, error)
func (*UnimplementedStorageServer) GetBucket(context.Context, *GetBucketRequest) (*Bucket, error)
func (*UnimplementedStorageServer) GetBucketAccessControl(context.Context, *GetBucketAccessControlRequest) (*BucketAccessControl, error)
func (*UnimplementedStorageServer) GetBucketIamPolicy(context.Context, *GetIamPolicyRequest) (*v1.Policy, error)
func (*UnimplementedStorageServer) GetDefaultObjectAccessControl(context.Context, *GetDefaultObjectAccessControlRequest) (*ObjectAccessControl, error)
func (*UnimplementedStorageServer) GetHmacKey(context.Context, *GetHmacKeyRequest) (*HmacKeyMetadata, error)
func (*UnimplementedStorageServer) GetNotification(context.Context, *GetNotificationRequest) (*Notification, error)
func (*UnimplementedStorageServer) GetObject(context.Context, *GetObjectRequest) (*Object, error)
func (*UnimplementedStorageServer) GetObjectAccessControl(context.Context, *GetObjectAccessControlRequest) (*ObjectAccessControl, error)
func (*UnimplementedStorageServer) GetObjectMedia(*GetObjectMediaRequest, Storage_GetObjectMediaServer) error
func (*UnimplementedStorageServer) GetServiceAccount(context.Context, *GetProjectServiceAccountRequest) (*ServiceAccount, error)
func (*UnimplementedStorageServer) InsertBucket(context.Context, *InsertBucketRequest) (*Bucket, error)
func (*UnimplementedStorageServer) InsertBucketAccessControl(context.Context, *InsertBucketAccessControlRequest) (*BucketAccessControl, error)
func (*UnimplementedStorageServer) InsertDefaultObjectAccessControl(context.Context, *InsertDefaultObjectAccessControlRequest) (*ObjectAccessControl, error)
func (*UnimplementedStorageServer) InsertNotification(context.Context, *InsertNotificationRequest) (*Notification, error)
func (*UnimplementedStorageServer) InsertObject(Storage_InsertObjectServer) error
func (*UnimplementedStorageServer) InsertObjectAccessControl(context.Context, *InsertObjectAccessControlRequest) (*ObjectAccessControl, error)
func (*UnimplementedStorageServer) ListBucketAccessControls(context.Context, *ListBucketAccessControlsRequest) (*ListBucketAccessControlsResponse, error)
func (*UnimplementedStorageServer) ListBuckets(context.Context, *ListBucketsRequest) (*ListBucketsResponse, error)
func (*UnimplementedStorageServer) ListChannels(context.Context, *ListChannelsRequest) (*ListChannelsResponse, error)
func (*UnimplementedStorageServer) ListDefaultObjectAccessControls(context.Context, *ListDefaultObjectAccessControlsRequest) (*ListObjectAccessControlsResponse, error)
func (*UnimplementedStorageServer) ListHmacKeys(context.Context, *ListHmacKeysRequest) (*ListHmacKeysResponse, error)
func (*UnimplementedStorageServer) ListNotifications(context.Context, *ListNotificationsRequest) (*ListNotificationsResponse, error)
func (*UnimplementedStorageServer) ListObjectAccessControls(context.Context, *ListObjectAccessControlsRequest) (*ListObjectAccessControlsResponse, error)
func (*UnimplementedStorageServer) ListObjects(context.Context, *ListObjectsRequest) (*ListObjectsResponse, error)
func (*UnimplementedStorageServer) LockBucketRetentionPolicy(context.Context, *LockRetentionPolicyRequest) (*Bucket, error)
func (*UnimplementedStorageServer) PatchBucket(context.Context, *PatchBucketRequest) (*Bucket, error)
func (*UnimplementedStorageServer) PatchBucketAccessControl(context.Context, *PatchBucketAccessControlRequest) (*BucketAccessControl, error)
func (*UnimplementedStorageServer) PatchDefaultObjectAccessControl(context.Context, *PatchDefaultObjectAccessControlRequest) (*ObjectAccessControl, error)
func (*UnimplementedStorageServer) PatchObject(context.Context, *PatchObjectRequest) (*Object, error)
func (*UnimplementedStorageServer) PatchObjectAccessControl(context.Context, *PatchObjectAccessControlRequest) (*ObjectAccessControl, error)
func (*UnimplementedStorageServer) QueryWriteStatus(context.Context, *QueryWriteStatusRequest) (*QueryWriteStatusResponse, error)
func (*UnimplementedStorageServer) RewriteObject(context.Context, *RewriteObjectRequest) (*RewriteResponse, error)
func (*UnimplementedStorageServer) SetBucketIamPolicy(context.Context, *SetIamPolicyRequest) (*v1.Policy, error)
func (*UnimplementedStorageServer) StartResumableWrite(context.Context, *StartResumableWriteRequest) (*StartResumableWriteResponse, error)
func (*UnimplementedStorageServer) StopChannel(context.Context, *StopChannelRequest) (*emptypb.Empty, error)
func (*UnimplementedStorageServer) TestBucketIamPermissions(context.Context, *TestIamPermissionsRequest) (*v1.TestIamPermissionsResponse, error)
func (*UnimplementedStorageServer) UpdateBucket(context.Context, *UpdateBucketRequest) (*Bucket, error)
func (*UnimplementedStorageServer) UpdateBucketAccessControl(context.Context, *UpdateBucketAccessControlRequest) (*BucketAccessControl, error)
func (*UnimplementedStorageServer) UpdateDefaultObjectAccessControl(context.Context, *UpdateDefaultObjectAccessControlRequest) (*ObjectAccessControl, error)
func (*UnimplementedStorageServer) UpdateHmacKey(context.Context, *UpdateHmacKeyRequest) (*HmacKeyMetadata, error)
func (*UnimplementedStorageServer) UpdateObject(context.Context, *UpdateObjectRequest) (*Object, error)
func (*UnimplementedStorageServer) UpdateObjectAccessControl(context.Context, *UpdateObjectAccessControlRequest) (*ObjectAccessControl, error)
func (*UnimplementedStorageServer) WatchAllObjects(context.Context, *WatchAllObjectsRequest) (*Channel, error)
Request for UpdateBucketAccessControl.
type UpdateBucketAccessControlRequest struct {
// Required. Name of a bucket.
Bucket string `protobuf:"bytes,1,opt,name=bucket,proto3" json:"bucket,omitempty"`
// Required. The entity holding the permission. Can be one of:
// * `user-`*userId*
// * `user-`*emailAddress*
// * `group-`*groupId*
// * `group-`*emailAddress*
// * `allUsers`
// * `allAuthenticatedUsers`
Entity string `protobuf:"bytes,2,opt,name=entity,proto3" json:"entity,omitempty"`
// The BucketAccessControl for updating.
BucketAccessControl *BucketAccessControl `protobuf:"bytes,4,opt,name=bucket_access_control,json=bucketAccessControl,proto3" json:"bucket_access_control,omitempty"`
// A set of parameters common to all Storage API requests.
CommonRequestParams *CommonRequestParams `protobuf:"bytes,5,opt,name=common_request_params,json=commonRequestParams,proto3" json:"common_request_params,omitempty"`
// contains filtered or unexported fields
}
func (*UpdateBucketAccessControlRequest) Descriptor() ([]byte, []int)
Deprecated: Use UpdateBucketAccessControlRequest.ProtoReflect.Descriptor instead.
func (x *UpdateBucketAccessControlRequest) GetBucket() string
func (x *UpdateBucketAccessControlRequest) GetBucketAccessControl() *BucketAccessControl
func (x *UpdateBucketAccessControlRequest) GetCommonRequestParams() *CommonRequestParams
func (x *UpdateBucketAccessControlRequest) GetEntity() string
func (*UpdateBucketAccessControlRequest) ProtoMessage()
func (x *UpdateBucketAccessControlRequest) ProtoReflect() protoreflect.Message
func (x *UpdateBucketAccessControlRequest) Reset()
func (x *UpdateBucketAccessControlRequest) String() string
Request for UpdateBucket method.
type UpdateBucketRequest struct {
// Required. Name of a bucket.
Bucket string `protobuf:"bytes,1,opt,name=bucket,proto3" json:"bucket,omitempty"`
// Makes the return of the bucket metadata conditional on whether the bucket's
// current metageneration matches the given value.
IfMetagenerationMatch *wrapperspb.Int64Value `protobuf:"bytes,2,opt,name=if_metageneration_match,json=ifMetagenerationMatch,proto3" json:"if_metageneration_match,omitempty"`
// Makes the return of the bucket metadata conditional on whether the bucket's
// current metageneration does not match the given value.
IfMetagenerationNotMatch *wrapperspb.Int64Value `protobuf:"bytes,3,opt,name=if_metageneration_not_match,json=ifMetagenerationNotMatch,proto3" json:"if_metageneration_not_match,omitempty"`
// Apply a predefined set of access controls to this bucket.
PredefinedAcl CommonEnums_PredefinedBucketAcl `protobuf:"varint,4,opt,name=predefined_acl,json=predefinedAcl,proto3,enum=google.storage.v1.CommonEnums_PredefinedBucketAcl" json:"predefined_acl,omitempty"`
// Apply a predefined set of default object access controls to this bucket.
PredefinedDefaultObjectAcl CommonEnums_PredefinedObjectAcl `protobuf:"varint,5,opt,name=predefined_default_object_acl,json=predefinedDefaultObjectAcl,proto3,enum=google.storage.v1.CommonEnums_PredefinedObjectAcl" json:"predefined_default_object_acl,omitempty"`
// Set of properties to return. Defaults to `FULL`.
Projection CommonEnums_Projection `protobuf:"varint,6,opt,name=projection,proto3,enum=google.storage.v1.CommonEnums_Projection" json:"projection,omitempty"`
// The Bucket metadata for updating.
Metadata *Bucket `protobuf:"bytes,8,opt,name=metadata,proto3" json:"metadata,omitempty"`
// A set of parameters common to all Storage API requests.
CommonRequestParams *CommonRequestParams `protobuf:"bytes,9,opt,name=common_request_params,json=commonRequestParams,proto3" json:"common_request_params,omitempty"`
// contains filtered or unexported fields
}
func (*UpdateBucketRequest) Descriptor() ([]byte, []int)
Deprecated: Use UpdateBucketRequest.ProtoReflect.Descriptor instead.
func (x *UpdateBucketRequest) GetBucket() string
func (x *UpdateBucketRequest) GetCommonRequestParams() *CommonRequestParams
func (x *UpdateBucketRequest) GetIfMetagenerationMatch() *wrapperspb.Int64Value
func (x *UpdateBucketRequest) GetIfMetagenerationNotMatch() *wrapperspb.Int64Value
func (x *UpdateBucketRequest) GetMetadata() *Bucket
func (x *UpdateBucketRequest) GetPredefinedAcl() CommonEnums_PredefinedBucketAcl
func (x *UpdateBucketRequest) GetPredefinedDefaultObjectAcl() CommonEnums_PredefinedObjectAcl
func (x *UpdateBucketRequest) GetProjection() CommonEnums_Projection
func (*UpdateBucketRequest) ProtoMessage()
func (x *UpdateBucketRequest) ProtoReflect() protoreflect.Message
func (x *UpdateBucketRequest) Reset()
func (x *UpdateBucketRequest) String() string
Request message for UpdateDefaultObjectAccessControl.
type UpdateDefaultObjectAccessControlRequest struct {
// Required. Name of a bucket.
Bucket string `protobuf:"bytes,1,opt,name=bucket,proto3" json:"bucket,omitempty"`
// Required. The entity holding the permission. Can be one of:
// * `user-`*userId*
// * `user-`*emailAddress*
// * `group-`*groupId*
// * `group-`*emailAddress*
// * `allUsers`
// * `allAuthenticatedUsers`
Entity string `protobuf:"bytes,2,opt,name=entity,proto3" json:"entity,omitempty"`
// The ObjectAccessControl for updating.
ObjectAccessControl *ObjectAccessControl `protobuf:"bytes,4,opt,name=object_access_control,json=objectAccessControl,proto3" json:"object_access_control,omitempty"`
// A set of parameters common to all Storage API requests.
CommonRequestParams *CommonRequestParams `protobuf:"bytes,5,opt,name=common_request_params,json=commonRequestParams,proto3" json:"common_request_params,omitempty"`
// contains filtered or unexported fields
}
func (*UpdateDefaultObjectAccessControlRequest) Descriptor() ([]byte, []int)
Deprecated: Use UpdateDefaultObjectAccessControlRequest.ProtoReflect.Descriptor instead.
func (x *UpdateDefaultObjectAccessControlRequest) GetBucket() string
func (x *UpdateDefaultObjectAccessControlRequest) GetCommonRequestParams() *CommonRequestParams
func (x *UpdateDefaultObjectAccessControlRequest) GetEntity() string
func (x *UpdateDefaultObjectAccessControlRequest) GetObjectAccessControl() *ObjectAccessControl
func (*UpdateDefaultObjectAccessControlRequest) ProtoMessage()
func (x *UpdateDefaultObjectAccessControlRequest) ProtoReflect() protoreflect.Message
func (x *UpdateDefaultObjectAccessControlRequest) Reset()
func (x *UpdateDefaultObjectAccessControlRequest) String() string
Request object to update an HMAC key state.
type UpdateHmacKeyRequest struct {
// Required. The id of the HMAC key.
AccessId string `protobuf:"bytes,1,opt,name=access_id,json=accessId,proto3" json:"access_id,omitempty"`
// Required. The project id the HMAC's service account lies in.
ProjectId string `protobuf:"bytes,2,opt,name=project_id,json=projectId,proto3" json:"project_id,omitempty"`
// Required. The service account owner of the HMAC key.
Metadata *HmacKeyMetadata `protobuf:"bytes,3,opt,name=metadata,proto3" json:"metadata,omitempty"`
// A set of parameters common to all Storage API requests.
CommonRequestParams *CommonRequestParams `protobuf:"bytes,5,opt,name=common_request_params,json=commonRequestParams,proto3" json:"common_request_params,omitempty"`
// contains filtered or unexported fields
}
func (*UpdateHmacKeyRequest) Descriptor() ([]byte, []int)
Deprecated: Use UpdateHmacKeyRequest.ProtoReflect.Descriptor instead.
func (x *UpdateHmacKeyRequest) GetAccessId() string
func (x *UpdateHmacKeyRequest) GetCommonRequestParams() *CommonRequestParams
func (x *UpdateHmacKeyRequest) GetMetadata() *HmacKeyMetadata
func (x *UpdateHmacKeyRequest) GetProjectId() string
func (*UpdateHmacKeyRequest) ProtoMessage()
func (x *UpdateHmacKeyRequest) ProtoReflect() protoreflect.Message
func (x *UpdateHmacKeyRequest) Reset()
func (x *UpdateHmacKeyRequest) String() string
Request message for UpdateObjectAccessControl.
type UpdateObjectAccessControlRequest struct {
// Required. Name of a bucket.
Bucket string `protobuf:"bytes,1,opt,name=bucket,proto3" json:"bucket,omitempty"`
// Required. The entity holding the permission. Can be one of:
// * `user-`*userId*
// * `user-`*emailAddress*
// * `group-`*groupId*
// * `group-`*emailAddress*
// * `allUsers`
// * `allAuthenticatedUsers`
Entity string `protobuf:"bytes,2,opt,name=entity,proto3" json:"entity,omitempty"`
// Required. Name of the object.
// Required.
Object string `protobuf:"bytes,3,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,4,opt,name=generation,proto3" json:"generation,omitempty"`
// The ObjectAccessControl for updating.
ObjectAccessControl *ObjectAccessControl `protobuf:"bytes,6,opt,name=object_access_control,json=objectAccessControl,proto3" json:"object_access_control,omitempty"`
// A set of parameters common to all Storage API requests.
CommonRequestParams *CommonRequestParams `protobuf:"bytes,7,opt,name=common_request_params,json=commonRequestParams,proto3" json:"common_request_params,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,8,opt,name=update_mask,json=updateMask,proto3" json:"update_mask,omitempty"`
// contains filtered or unexported fields
}
func (*UpdateObjectAccessControlRequest) Descriptor() ([]byte, []int)
Deprecated: Use UpdateObjectAccessControlRequest.ProtoReflect.Descriptor instead.
func (x *UpdateObjectAccessControlRequest) GetBucket() string
func (x *UpdateObjectAccessControlRequest) GetCommonRequestParams() *CommonRequestParams
func (x *UpdateObjectAccessControlRequest) GetEntity() string
func (x *UpdateObjectAccessControlRequest) GetGeneration() int64
func (x *UpdateObjectAccessControlRequest) GetObject() string
func (x *UpdateObjectAccessControlRequest) GetObjectAccessControl() *ObjectAccessControl
func (x *UpdateObjectAccessControlRequest) GetUpdateMask() *fieldmaskpb.FieldMask
func (*UpdateObjectAccessControlRequest) ProtoMessage()
func (x *UpdateObjectAccessControlRequest) ProtoReflect() protoreflect.Message
func (x *UpdateObjectAccessControlRequest) Reset()
func (x *UpdateObjectAccessControlRequest) String() string
Request message for UpdateObject.
type UpdateObjectRequest 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 *wrapperspb.Int64Value `protobuf:"bytes,4,opt,name=if_generation_match,json=ifGenerationMatch,proto3" json:"if_generation_match,omitempty"`
// Makes the operation conditional on whether the object's current generation
// does not match the given value. If no live object exists, the precondition
// fails. Setting to 0 makes the operation succeed only if there is a live
// version of the object.
IfGenerationNotMatch *wrapperspb.Int64Value `protobuf:"bytes,5,opt,name=if_generation_not_match,json=ifGenerationNotMatch,proto3" json:"if_generation_not_match,omitempty"`
// Makes the operation conditional on whether the object's current
// metageneration matches the given value.
IfMetagenerationMatch *wrapperspb.Int64Value `protobuf:"bytes,6,opt,name=if_metageneration_match,json=ifMetagenerationMatch,proto3" json:"if_metageneration_match,omitempty"`
// Makes the operation conditional on whether the object's current
// metageneration does not match the given value.
IfMetagenerationNotMatch *wrapperspb.Int64Value `protobuf:"bytes,7,opt,name=if_metageneration_not_match,json=ifMetagenerationNotMatch,proto3" json:"if_metageneration_not_match,omitempty"`
// Apply a predefined set of access controls to this object.
PredefinedAcl CommonEnums_PredefinedObjectAcl `protobuf:"varint,8,opt,name=predefined_acl,json=predefinedAcl,proto3,enum=google.storage.v1.CommonEnums_PredefinedObjectAcl" json:"predefined_acl,omitempty"`
// Set of properties to return. Defaults to `FULL`.
Projection CommonEnums_Projection `protobuf:"varint,9,opt,name=projection,proto3,enum=google.storage.v1.CommonEnums_Projection" json:"projection,omitempty"`
// The Object metadata for updating.
Metadata *Object `protobuf:"bytes,11,opt,name=metadata,proto3" json:"metadata,omitempty"`
// A set of parameters common to Storage API requests concerning an object.
CommonObjectRequestParams *CommonObjectRequestParams `protobuf:"bytes,12,opt,name=common_object_request_params,json=commonObjectRequestParams,proto3" json:"common_object_request_params,omitempty"`
// A set of parameters common to all Storage API requests.
CommonRequestParams *CommonRequestParams `protobuf:"bytes,13,opt,name=common_request_params,json=commonRequestParams,proto3" json:"common_request_params,omitempty"`
// contains filtered or unexported fields
}
func (*UpdateObjectRequest) Descriptor() ([]byte, []int)
Deprecated: Use UpdateObjectRequest.ProtoReflect.Descriptor instead.
func (x *UpdateObjectRequest) GetBucket() string
func (x *UpdateObjectRequest) GetCommonObjectRequestParams() *CommonObjectRequestParams
func (x *UpdateObjectRequest) GetCommonRequestParams() *CommonRequestParams
func (x *UpdateObjectRequest) GetGeneration() int64
func (x *UpdateObjectRequest) GetIfGenerationMatch() *wrapperspb.Int64Value
func (x *UpdateObjectRequest) GetIfGenerationNotMatch() *wrapperspb.Int64Value
func (x *UpdateObjectRequest) GetIfMetagenerationMatch() *wrapperspb.Int64Value
func (x *UpdateObjectRequest) GetIfMetagenerationNotMatch() *wrapperspb.Int64Value
func (x *UpdateObjectRequest) GetMetadata() *Object
func (x *UpdateObjectRequest) GetObject() string
func (x *UpdateObjectRequest) GetPredefinedAcl() CommonEnums_PredefinedObjectAcl
func (x *UpdateObjectRequest) GetProjection() CommonEnums_Projection
func (*UpdateObjectRequest) ProtoMessage()
func (x *UpdateObjectRequest) ProtoReflect() protoreflect.Message
func (x *UpdateObjectRequest) Reset()
func (x *UpdateObjectRequest) String() string
Request message for WatchAllObjects.
type WatchAllObjectsRequest struct {
// Name of the bucket in which to look for objects.
Bucket string `protobuf:"bytes,1,opt,name=bucket,proto3" json:"bucket,omitempty"`
// If `true`, lists all versions of an object as distinct results.
// The default is `false`. For more information, see
// [Object
// Versioning](https://cloud.google.com/storage/docs/object-versioning).
Versions bool `protobuf:"varint,2,opt,name=versions,proto3" json:"versions,omitempty"`
// 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,3,opt,name=delimiter,proto3" json:"delimiter,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.
MaxResults int32 `protobuf:"varint,4,opt,name=max_results,json=maxResults,proto3" json:"max_results,omitempty"`
// Filter results to objects whose names begin with this prefix.
Prefix string `protobuf:"bytes,5,opt,name=prefix,proto3" json:"prefix,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,6,opt,name=include_trailing_delimiter,json=includeTrailingDelimiter,proto3" json:"include_trailing_delimiter,omitempty"`
// A previously-returned page token representing part of the larger set of
// results to view.
PageToken string `protobuf:"bytes,7,opt,name=page_token,json=pageToken,proto3" json:"page_token,omitempty"`
// Set of properties to return. Defaults to `NO_ACL`.
Projection CommonEnums_Projection `protobuf:"varint,8,opt,name=projection,proto3,enum=google.storage.v1.CommonEnums_Projection" json:"projection,omitempty"`
// Properties of the channel to be inserted.
Channel *Channel `protobuf:"bytes,10,opt,name=channel,proto3" json:"channel,omitempty"`
// A set of parameters common to all Storage API requests.
CommonRequestParams *CommonRequestParams `protobuf:"bytes,11,opt,name=common_request_params,json=commonRequestParams,proto3" json:"common_request_params,omitempty"`
// contains filtered or unexported fields
}
func (*WatchAllObjectsRequest) Descriptor() ([]byte, []int)
Deprecated: Use WatchAllObjectsRequest.ProtoReflect.Descriptor instead.
func (x *WatchAllObjectsRequest) GetBucket() string
func (x *WatchAllObjectsRequest) GetChannel() *Channel
func (x *WatchAllObjectsRequest) GetCommonRequestParams() *CommonRequestParams
func (x *WatchAllObjectsRequest) GetDelimiter() string
func (x *WatchAllObjectsRequest) GetIncludeTrailingDelimiter() bool
func (x *WatchAllObjectsRequest) GetMaxResults() int32
func (x *WatchAllObjectsRequest) GetPageToken() string
func (x *WatchAllObjectsRequest) GetPrefix() string
func (x *WatchAllObjectsRequest) GetProjection() CommonEnums_Projection
func (x *WatchAllObjectsRequest) GetVersions() bool
func (*WatchAllObjectsRequest) ProtoMessage()
func (x *WatchAllObjectsRequest) ProtoReflect() protoreflect.Message
func (x *WatchAllObjectsRequest) Reset()
func (x *WatchAllObjectsRequest) String() string