Skip to content

storage.v1alpha3.bucket

"A Bucket is a managed resource that represents a Google Cloud Storage bucket."

Index

Fields

fn new

new(name)

new returns an instance of Bucket

obj metadata

"ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create."

fn metadata.withAnnotations

withAnnotations(annotations)

"Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations"

fn metadata.withAnnotationsMixin

withAnnotationsMixin(annotations)

"Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations"

Note: This function appends passed data to existing values

fn metadata.withClusterName

withClusterName(clusterName)

"The name of the cluster which the object belongs to. This is used to distinguish resources with same name and namespace in different clusters. This field is not set anywhere right now and apiserver is going to ignore it if set in create or update request."

fn metadata.withCreationTimestamp

withCreationTimestamp(creationTimestamp)

"Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers."

fn metadata.withDeletionGracePeriodSeconds

withDeletionGracePeriodSeconds(deletionGracePeriodSeconds)

"Number of seconds allowed for this object to gracefully terminate before it will be removed from the system. Only set when deletionTimestamp is also set. May only be shortened. Read-only."

fn metadata.withDeletionTimestamp

withDeletionTimestamp(deletionTimestamp)

"Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers."

fn metadata.withFinalizers

withFinalizers(finalizers)

"Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list."

fn metadata.withFinalizersMixin

withFinalizersMixin(finalizers)

"Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list."

Note: This function appends passed data to existing values

fn metadata.withGenerateName

withGenerateName(generateName)

"GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. The provided value has the same validation rules as the Name field, and may be truncated by the length of the suffix required to make the value unique on the server.\n\nIf this field is specified and the generated name exists, the server will NOT return a 409 - instead, it will either return 201 Created or 500 with Reason ServerTimeout indicating a unique name could not be found in the time allotted, and the client should retry (optionally after the time indicated in the Retry-After header).\n\nApplied only if Name is not specified. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency"

fn metadata.withGeneration

withGeneration(generation)

"A sequence number representing a specific generation of the desired state. Populated by the system. Read-only."

fn metadata.withLabels

withLabels(labels)

"Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels"

fn metadata.withLabelsMixin

withLabelsMixin(labels)

"Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels"

Note: This function appends passed data to existing values

fn metadata.withName

withName(name)

"Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/identifiers#names"

fn metadata.withNamespace

withNamespace(namespace)

"Namespace defines the space within which each name must be unique. An empty namespace is equivalent to the \"default\" namespace, but \"default\" is the canonical representation. Not all objects are required to be scoped to a namespace - the value of this field for those objects will be empty.\n\nMust be a DNS_LABEL. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/namespaces"

fn metadata.withOwnerReferences

withOwnerReferences(ownerReferences)

"List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller."

fn metadata.withOwnerReferencesMixin

withOwnerReferencesMixin(ownerReferences)

"List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller."

Note: This function appends passed data to existing values

fn metadata.withResourceVersion

withResourceVersion(resourceVersion)

"An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources.\n\nPopulated by the system. Read-only. Value must be treated as opaque by clients and . More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency"

withSelfLink(selfLink)

"SelfLink is a URL representing this object. Populated by the system. Read-only.\n\nDEPRECATED Kubernetes will stop propagating this field in 1.20 release and the field is planned to be removed in 1.21 release."

fn metadata.withUid

withUid(uid)

"UID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations.\n\nPopulated by the system. Read-only. More info: http://kubernetes.io/docs/user-guide/identifiers#uids"

obj spec

"A BucketSpec defines the desired state of a Bucket."

fn spec.withAcl

withAcl(acl)

"ACL is the list of access control rules on the bucket."

fn spec.withAclMixin

withAclMixin(acl)

"ACL is the list of access control rules on the bucket."

Note: This function appends passed data to existing values

fn spec.withCors

withCors(cors)

"The bucket's Cross-Origin Resource Sharing (CORS) configuration."

fn spec.withCorsMixin

withCorsMixin(cors)

"The bucket's Cross-Origin Resource Sharing (CORS) configuration."

Note: This function appends passed data to existing values

fn spec.withDefaultEventBasedHold

withDefaultEventBasedHold(defaultEventBasedHold)

"DefaultEventBasedHold is the default value for event-based hold on newly created objects in this bucket. It defaults to false."

fn spec.withDefaultObjectAcl

withDefaultObjectAcl(defaultObjectAcl)

"DefaultObjectACL is the list of access controls to apply to new objects when no object ACL is provided."

fn spec.withDefaultObjectAclMixin

withDefaultObjectAclMixin(defaultObjectAcl)

"DefaultObjectACL is the list of access controls to apply to new objects when no object ACL is provided."

Note: This function appends passed data to existing values

fn spec.withDeletionPolicy

withDeletionPolicy(deletionPolicy)

"DeletionPolicy specifies what will happen to the underlying external when this managed resource is deleted - either \"Delete\" or \"Orphan\" the external resource."

fn spec.withLabels

withLabels(labels)

"Labels are the bucket's labels."

fn spec.withLabelsMixin

withLabelsMixin(labels)

"Labels are the bucket's labels."

Note: This function appends passed data to existing values

fn spec.withLocation

withLocation(location)

"Location is the location of the bucket. It defaults to \"US\"."

fn spec.withPredefinedAcl

withPredefinedAcl(predefinedAcl)

"If not empty, applies a predefined set of access controls. It should be set only when creating a bucket. It is always empty for BucketAttrs returned from the service. See https://cloud.google.com/storage/docs/json_api/v1/buckets/insert for valid values."

fn spec.withPredefinedDefaultObjectAcl

withPredefinedDefaultObjectAcl(predefinedDefaultObjectAcl)

"If not empty, applies a predefined set of default object access controls. It should be set only when creating a bucket. It is always empty for BucketAttrs returned from the service. See https://cloud.google.com/storage/docs/json_api/v1/buckets/insert for valid values."

fn spec.withRequesterPays

withRequesterPays(requesterPays)

"RequesterPays reports whether the bucket is a Requester Pays bucket. Clients performing operations on Requester Pays buckets must provide a user project (see BucketHandle.UserProject), which will be billed for the operations."

fn spec.withStorageClass

withStorageClass(storageClass)

"StorageClass is the default storage class of the bucket. This defines how objects in the bucket are stored and determines the SLA and the cost of storage. Typical values are \"MULTI_REGIONAL\", \"REGIONAL\", \"NEARLINE\", \"COLDLINE\", \"STANDARD\" and \"DURABLE_REDUCED_AVAILABILITY\". Defaults to \"STANDARD\", which is equivalent to \"MULTI_REGIONAL\" or \"REGIONAL\" depending on the bucket's location settings."

fn spec.withVersioningEnabled

withVersioningEnabled(versioningEnabled)

"VersioningEnabled reports whether this bucket has versioning enabled."

obj spec.acl

"ACL is the list of access control rules on the bucket."

fn spec.acl.withDomain

withDomain(domain)

"The domain associated with the entity, if any."

fn spec.acl.withEmail

withEmail(email)

"The email address associated with the entity, if any."

fn spec.acl.withEntity

withEntity(entity)

"Entity refers to a user or group. They are sometimes referred to as grantees. It could be in the form of: \"user-\", \"user-\", \"group-\", \"group-\", \"domain-\" and \"project-team-\". \n Or one of the predefined constants: AllUsers, AllAuthenticatedUsers."

fn spec.acl.withEntityId

withEntityId(entityId)

"EntityID is the ID for the entity, if any."

fn spec.acl.withRole

withRole(role)

"Role is the access permission for the entity. Valid values are \"OWNER\", \"READER\" and \"WRITER\

obj spec.acl.projectTeam

"ProjectTeam that is associated with the entity, if any."

fn spec.acl.projectTeam.withProjectNumber

withProjectNumber(projectNumber)

"ProjectNumber is the number of the project."

fn spec.acl.projectTeam.withTeam

withTeam(team)

"The team. Acceptable values are: \"editors\", \"owners\" or \"viewers\

obj spec.bucketPolicyOnly

"BucketPolicyOnly configures access checks to use only bucket-level IAM policies."

fn spec.bucketPolicyOnly.withEnabled

withEnabled(enabled)

"Enabled specifies whether access checks use only bucket-level IAM policies. Enabled may be disabled until the locked time."

fn spec.bucketPolicyOnly.withLockedTime

withLockedTime(lockedTime)

"LockedTime specifies the deadline for changing Enabled from true to false."

obj spec.cors

"The bucket's Cross-Origin Resource Sharing (CORS) configuration."

fn spec.cors.withMaxAge

withMaxAge(maxAge)

"MaxAge is the value to return in the Access-Control-Max-Age header used in preflight responses."

fn spec.cors.withMethods

withMethods(methods)

"Methods is 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\"."

fn spec.cors.withMethodsMixin

withMethodsMixin(methods)

"Methods is 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\"."

Note: This function appends passed data to existing values

fn spec.cors.withOrigins

withOrigins(origins)

"Origins is the list of Origins eligible to receive CORS response headers. Note: \"*\" is permitted in the list of origins, and means \"any Origin\"."

fn spec.cors.withOriginsMixin

withOriginsMixin(origins)

"Origins is the list of Origins eligible to receive CORS response headers. Note: \"*\" is permitted in the list of origins, and means \"any Origin\"."

Note: This function appends passed data to existing values

fn spec.cors.withResponseHeaders

withResponseHeaders(responseHeaders)

"ResponseHeaders is the list of HTTP headers other than the simple response headers to give permission for the user-agent to share across domains."

fn spec.cors.withResponseHeadersMixin

withResponseHeadersMixin(responseHeaders)

"ResponseHeaders is the list of HTTP headers other than the simple response headers to give permission for the user-agent to share across domains."

Note: This function appends passed data to existing values

obj spec.defaultObjectAcl

"DefaultObjectACL is the list of access controls to apply to new objects when no object ACL is provided."

fn spec.defaultObjectAcl.withDomain

withDomain(domain)

"The domain associated with the entity, if any."

fn spec.defaultObjectAcl.withEmail

withEmail(email)

"The email address associated with the entity, if any."

fn spec.defaultObjectAcl.withEntity

withEntity(entity)

"Entity refers to a user or group. They are sometimes referred to as grantees. It could be in the form of: \"user-\", \"user-\", \"group-\", \"group-\", \"domain-\" and \"project-team-\". \n Or one of the predefined constants: AllUsers, AllAuthenticatedUsers."

fn spec.defaultObjectAcl.withEntityId

withEntityId(entityId)

"EntityID is the ID for the entity, if any."

fn spec.defaultObjectAcl.withRole

withRole(role)

"Role is the access permission for the entity. Valid values are \"OWNER\", \"READER\" and \"WRITER\

obj spec.defaultObjectAcl.projectTeam

"ProjectTeam that is associated with the entity, if any."

fn spec.defaultObjectAcl.projectTeam.withProjectNumber

withProjectNumber(projectNumber)

"ProjectNumber is the number of the project."

fn spec.defaultObjectAcl.projectTeam.withTeam

withTeam(team)

"The team. Acceptable values are: \"editors\", \"owners\" or \"viewers\

obj spec.encryption

"The encryption configuration used by default for newly inserted objects."

fn spec.encryption.withDefaultKmsKeyName

withDefaultKmsKeyName(defaultKmsKeyName)

"A Cloud KMS key name, in the form projects/P/locations/L/keyRings/R/cryptoKeys/K, that will be used to encrypt objects inserted into this bucket, if no encryption method is specified. The key's location must be the same as the bucket's."

obj spec.lifecycle

"Lifecycle is the lifecycle configuration for objects in the bucket."

fn spec.lifecycle.withRules

withRules(rules)

fn spec.lifecycle.withRulesMixin

withRulesMixin(rules)

Note: This function appends passed data to existing values

obj spec.lifecycle.rules

obj spec.lifecycle.rules.action

"Action is the action to take when all of the associated conditions are met."

fn spec.lifecycle.rules.action.withStorageClass

withStorageClass(storageClass)

"StorageClass is the storage class to set on matching objects if the Action is \"SetStorageClass\"."

fn spec.lifecycle.rules.action.withType

withType(type)

"Type is the type of action to take on matching objects. \n Acceptable values are \"Delete\" to delete matching objects and \"SetStorageClass\" to set the storage class defined in StorageClass on matching objects."

obj spec.lifecycle.rules.condition

"Condition is the set of conditions that must be met for the associated action to be taken."

fn spec.lifecycle.rules.condition.withAgeInDays

withAgeInDays(ageInDays)

"AgeInDays is the age of the object in days."

fn spec.lifecycle.rules.condition.withCreatedBefore

withCreatedBefore(createdBefore)

"CreatedBefore is the time the object was created. \n This condition is satisfied when an object is created before midnight of the specified date in UTC."

fn spec.lifecycle.rules.condition.withLiveness

withLiveness(liveness)

"Liveness specifies the object's liveness. Relevant only for versioned objects"

fn spec.lifecycle.rules.condition.withMatchesStorageClasses

withMatchesStorageClasses(matchesStorageClasses)

"MatchesStorageClasses is the condition matching the object's storage class. \n Values include \"MULTI_REGIONAL\", \"REGIONAL\", \"NEARLINE\", \"COLDLINE\", \"STANDARD\", and \"DURABLE_REDUCED_AVAILABILITY\"."

fn spec.lifecycle.rules.condition.withMatchesStorageClassesMixin

withMatchesStorageClassesMixin(matchesStorageClasses)

"MatchesStorageClasses is the condition matching the object's storage class. \n Values include \"MULTI_REGIONAL\", \"REGIONAL\", \"NEARLINE\", \"COLDLINE\", \"STANDARD\", and \"DURABLE_REDUCED_AVAILABILITY\"."

Note: This function appends passed data to existing values

fn spec.lifecycle.rules.condition.withNumNewerVersions

withNumNewerVersions(numNewerVersions)

"NumNewerVersions is the condition matching objects with a number of newer versions. \n 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."

obj spec.logging

"The logging configuration."

fn spec.logging.withLogBucket

withLogBucket(logBucket)

"The destination bucket where the current bucket's logs should be placed."

fn spec.logging.withLogObjectPrefix

withLogObjectPrefix(logObjectPrefix)

"A prefix for log object names."

obj spec.providerConfigRef

"ProviderConfigReference specifies how the provider that will be used to create, observe, update, and delete this managed resource should be configured."

fn spec.providerConfigRef.withName

withName(name)

"Name of the referenced object."

obj spec.providerConfigRef.policy

"Policies for referencing."

fn spec.providerConfigRef.policy.withResolution

withResolution(resolution)

"Resolution specifies whether resolution of this reference is required. The default is 'Required', which means the reconcile will fail if the reference cannot be resolved. 'Optional' means this reference will be a no-op if it cannot be resolved."

fn spec.providerConfigRef.policy.withResolve

withResolve(resolve)

"Resolve specifies when this reference should be resolved. The default is 'IfNotPresent', which will attempt to resolve the reference only when the corresponding field is not present. Use 'Always' to resolve the reference on every reconcile."

obj spec.providerRef

"ProviderReference specifies the provider that will be used to create, observe, update, and delete this managed resource. Deprecated: Please use ProviderConfigReference, i.e. providerConfigRef"

fn spec.providerRef.withName

withName(name)

"Name of the referenced object."

obj spec.providerRef.policy

"Policies for referencing."

fn spec.providerRef.policy.withResolution

withResolution(resolution)

"Resolution specifies whether resolution of this reference is required. The default is 'Required', which means the reconcile will fail if the reference cannot be resolved. 'Optional' means this reference will be a no-op if it cannot be resolved."

fn spec.providerRef.policy.withResolve

withResolve(resolve)

"Resolve specifies when this reference should be resolved. The default is 'IfNotPresent', which will attempt to resolve the reference only when the corresponding field is not present. Use 'Always' to resolve the reference on every reconcile."

obj spec.publishConnectionDetailsTo

"PublishConnectionDetailsTo specifies the connection secret config which contains a name, metadata and a reference to secret store config to which any connection details for this managed resource should be written. Connection details frequently include the endpoint, username, and password required to connect to the managed resource."

fn spec.publishConnectionDetailsTo.withName

withName(name)

"Name is the name of the connection secret."

obj spec.publishConnectionDetailsTo.configRef

"SecretStoreConfigRef specifies which secret store config should be used for this ConnectionSecret."

fn spec.publishConnectionDetailsTo.configRef.withName

withName(name)

"Name of the referenced object."

obj spec.publishConnectionDetailsTo.configRef.policy

"Policies for referencing."

fn spec.publishConnectionDetailsTo.configRef.policy.withResolution

withResolution(resolution)

"Resolution specifies whether resolution of this reference is required. The default is 'Required', which means the reconcile will fail if the reference cannot be resolved. 'Optional' means this reference will be a no-op if it cannot be resolved."

fn spec.publishConnectionDetailsTo.configRef.policy.withResolve

withResolve(resolve)

"Resolve specifies when this reference should be resolved. The default is 'IfNotPresent', which will attempt to resolve the reference only when the corresponding field is not present. Use 'Always' to resolve the reference on every reconcile."

obj spec.publishConnectionDetailsTo.metadata

"Metadata is the metadata for connection secret."

fn spec.publishConnectionDetailsTo.metadata.withAnnotations

withAnnotations(annotations)

"Annotations are the annotations to be added to connection secret. - For Kubernetes secrets, this will be used as \"metadata.annotations\". - It is up to Secret Store implementation for others store types."

fn spec.publishConnectionDetailsTo.metadata.withAnnotationsMixin

withAnnotationsMixin(annotations)

"Annotations are the annotations to be added to connection secret. - For Kubernetes secrets, this will be used as \"metadata.annotations\". - It is up to Secret Store implementation for others store types."

Note: This function appends passed data to existing values

fn spec.publishConnectionDetailsTo.metadata.withLabels

withLabels(labels)

"Labels are the labels/tags to be added to connection secret. - For Kubernetes secrets, this will be used as \"metadata.labels\". - It is up to Secret Store implementation for others store types."

fn spec.publishConnectionDetailsTo.metadata.withLabelsMixin

withLabelsMixin(labels)

"Labels are the labels/tags to be added to connection secret. - For Kubernetes secrets, this will be used as \"metadata.labels\". - It is up to Secret Store implementation for others store types."

Note: This function appends passed data to existing values

fn spec.publishConnectionDetailsTo.metadata.withType

withType(type)

"Type is the SecretType for the connection secret. - Only valid for Kubernetes Secret Stores."

obj spec.retentionPolicy

"Retention policy enforces a minimum retention time for all objects contained in the bucket. A RetentionPolicy of nil implies the bucket has no minimum data retention. \n This feature is in private alpha release. It is not currently available to most customers. It might be changed in backwards-incompatible ways and is not subject to any SLA or deprecation policy."

fn spec.retentionPolicy.withRetentionPeriodSeconds

withRetentionPeriodSeconds(retentionPeriodSeconds)

"RetentionPeriod specifies the duration value 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."

obj spec.website

"The website configuration."

fn spec.website.withMainPageSuffix

withMainPageSuffix(mainPageSuffix)

"If the requested object path is missing, the service will ensure the path has a trailing '/', append this suffix, and attempt to retrieve the resulting object. This allows the creation of index.html objects to represent directory pages."

fn spec.website.withNotFoundPage

withNotFoundPage(notFoundPage)

"If the requested object path is missing, and any mainPageSuffix object is missing, if applicable, the service will return the named object from this bucket as the content for a 404 Not Found result."

obj spec.writeConnectionSecretToRef

"WriteConnectionSecretToReference specifies the namespace and name of a Secret to which any connection details for this managed resource should be written. Connection details frequently include the endpoint, username, and password required to connect to the managed resource. This field is planned to be replaced in a future release in favor of PublishConnectionDetailsTo. Currently, both could be set independently and connection details would be published to both without affecting each other."

fn spec.writeConnectionSecretToRef.withName

withName(name)

"Name of the secret."

fn spec.writeConnectionSecretToRef.withNamespace

withNamespace(namespace)

"Namespace of the secret."