## object.gdc.goog/v1

Contains API schema definitions for the Object Storage `v1` API group.

### Bucket

Defines the schema for the Buckets API.

*Appears in:*
- [BucketList](https://docs.cloud.google.com/distributed-cloud/hosted/docs/latest/gdcag/apis/service/storage/v1/object-v1.md.txt#bucketlist)

| Field | Description |
|---|---|
| `apiVersion` *string* | `object.gdc.goog/v1` |
| `kind` *string* | `Bucket` |
| `metadata` *[ObjectMeta](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#objectmeta-v1-meta)* | Refer to Kubernetes API documentation for fields of `metadata`. |
| `spec` *[BucketSpec](https://docs.cloud.google.com/distributed-cloud/hosted/docs/latest/gdcag/apis/service/storage/v1/object-v1.md.txt#bucketspec)* |   |
| `status` *[BucketStatus](https://docs.cloud.google.com/distributed-cloud/hosted/docs/latest/gdcag/apis/service/storage/v1/object-v1.md.txt#bucketstatus)* |   |

### BucketInfo

Defines the schema for the BucketInfo API.

*Appears in:*
- [BucketInfoList](https://docs.cloud.google.com/distributed-cloud/hosted/docs/latest/gdcag/apis/service/storage/v1/object-v1.md.txt#bucketinfolist)

| Field | Description |
|---|---|
| `apiVersion` *string* | `object.gdc.goog/v1` |
| `kind` *string* | `BucketInfo` |
| `metadata` *[ObjectMeta](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#objectmeta-v1-meta)* | Refer to Kubernetes API documentation for fields of `metadata`. |
| `spec` *[BucketInfoSpec](https://docs.cloud.google.com/distributed-cloud/hosted/docs/latest/gdcag/apis/service/storage/v1/object-v1.md.txt#bucketinfospec)* |   |
| `status` *[BucketInfoStatus](https://docs.cloud.google.com/distributed-cloud/hosted/docs/latest/gdcag/apis/service/storage/v1/object-v1.md.txt#bucketinfostatus)* |   |

### BucketInfoList

Contains a list of BucketInfos.

| Field | Description |
|---|---|
| `apiVersion` *string* | `object.gdc.goog/v1` |
| `kind` *string* | `BucketInfoList` |
| `metadata` *[ListMeta](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#listmeta-v1-meta)* | Refer to Kubernetes API documentation for fields of `metadata`. |
| `items` *[BucketInfo](https://docs.cloud.google.com/distributed-cloud/hosted/docs/latest/gdcag/apis/service/storage/v1/object-v1.md.txt#bucketinfo) array* |   |

### BucketInfoSpec

BucketInfoSpec defines the desired state of the BucketInfo Resource.

*Appears in:*
- [BucketInfo](https://docs.cloud.google.com/distributed-cloud/hosted/docs/latest/gdcag/apis/service/storage/v1/object-v1.md.txt#bucketinfo)

| Field | Description |
|---|---|
| `description` *string* | The description of bucket contents. |
| `storageClass` *ObjectStorageClass* | Defines how frequently data needs to be accessed. The available options include `Standard` and `Nearline`. `Standard` is appropriate for hot data that is accessed frequently, such as websites, streaming videos, and mobile apps. It is used for data that can be stored for at least 30 days. `Nearline` is appropriate for data that can be stored for at least 60 days, including data backup and long-tail multimedia content. |
| `bucketPolicy` *[GlobalBucketPolicy](https://docs.cloud.google.com/distributed-cloud/hosted/docs/latest/gdcag/apis/service/storage/v1/object-v1.md.txt#globalbucketpolicy)* | Defines policies of the bucket resource. If unspecified, default policies are applied. |
| `location` *string* | Defines the physical place where object data in the bucket resides. If unspecified, defaults to the location in which the bucket is being created. |
| `bucketName` *string* | The non-namespaced name of the provisioned bucket. This is used to refer to the bucket when using local tools and libraries. |
| `zonalEndpoints` *string array* | Zonal DNS endpoints at which the bucket is reachable. Use these endpoints if customized failover is required. |
| `globalEndpoint` *string* | Global endpoint which will dynamically route traffic to any zone which contains data for this bucket. Use this endpoint if automatic failover is required. |
| `region` *string* | The region where the bucket is stored. |
| `encryption` *[EncryptionStatus](https://docs.cloud.google.com/distributed-cloud/hosted/docs/latest/gdcag/apis/service/storage/v1/object-v1.md.txt#encryptionstatus)* | The status of the encryption on the bucket. |
| `allowDegradedWrites` *boolean* | Only used for synchronous buckets. Determines if S3 operations should revert to asynchronous replication due to one of the replication zones being unavailable. This prevents synchronous buckets from becoming read-only in the event that one of the replication zones is down. If empty, defaults to false. |

### BucketInfoStatus

Defines the observed state of the BucketInfo.

*Appears in:*
- [BucketInfo](https://docs.cloud.google.com/distributed-cloud/hosted/docs/latest/gdcag/apis/service/storage/v1/object-v1.md.txt#bucketinfo)

| Field | Description |
|---|---|
| `conditions` *[Condition](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#condition-v1-meta) array* |   |

### BucketList

Contains a list of Buckets.

| Field | Description |
|---|---|
| `apiVersion` *string* | `object.gdc.goog/v1` |
| `kind` *string* | `BucketList` |
| `metadata` *[ListMeta](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#listmeta-v1-meta)* | Refer to Kubernetes API documentation for fields of `metadata`. |
| `items` *[Bucket](https://docs.cloud.google.com/distributed-cloud/hosted/docs/latest/gdcag/apis/service/storage/v1/object-v1.md.txt#bucket) array* |   |

### BucketPolicy

Defines policies of the Bucket.

*Appears in:*
- [BucketSpec](https://docs.cloud.google.com/distributed-cloud/hosted/docs/latest/gdcag/apis/service/storage/v1/object-v1.md.txt#bucketspec)

| Field | Description |
|---|---|
| `lockingPolicy` *[LockingPolicy](https://docs.cloud.google.com/distributed-cloud/hosted/docs/latest/gdcag/apis/service/storage/v1/object-v1.md.txt#lockingpolicy)* | Policy for object locking. When set, object versioning is enabled and all objects stored in the bucket will be subject to this policy. A locked object cannot be deleted until the lock expires. Can only be enabled when creating the bucket and cannot be disabled afterwards. When not enabled, object locking and versioning are disabled and cannot be enabled. |
| `corsPolicy` *[CorsPolicy](https://docs.cloud.google.com/distributed-cloud/hosted/docs/latest/gdcag/apis/service/storage/v1/object-v1.md.txt#corspolicy)* | Policy for custom CORS policy user set on the bucket. CorsPolicy has to be enabled when additional CORS policy is needed on the buckets. Otherwise, the bucket will only have the default UI console CORS policy. CorsPolicy can always be added or modified later after the bucket is created. |
| `lifecyclePolicy` *[LifecyclePolicy](https://docs.cloud.google.com/distributed-cloud/hosted/docs/latest/gdcag/apis/service/storage/v1/object-v1.md.txt#lifecyclepolicy)* | Policy for custom lifecycle policy user set on the bucket. LifecyclePolicy can always be added, modified, removed later after the bucket is created. |

### BucketSpec

BucketSpec defines the desired state of the Bucket Resource.

*Appears in:*
- [Bucket](https://docs.cloud.google.com/distributed-cloud/hosted/docs/latest/gdcag/apis/service/storage/v1/object-v1.md.txt#bucket)

| Field | Description |
|---|---|
| `description` *string* | Description of bucket contents. |
| `storageClass` *ObjectStorageClass* | Defines how frequently data needs to be accessed. The available options include `Standard` and `Nearline`. `Standard` is appropriate for hot data that is accessed frequently, such as websites, streaming videos, and mobile apps. It is used for data that can be stored for at least 30 days. `Nearline` is appropriate for data that can be stored for at least 60 days, including data backup and long-tail multimedia content. |
| `bucketPolicy` *[BucketPolicy](https://docs.cloud.google.com/distributed-cloud/hosted/docs/latest/gdcag/apis/service/storage/v1/object-v1.md.txt#bucketpolicy)* | Defines policies of the bucket resource. If unspecified, default policies are applied. |
| `location` *string* | Defines the physical place where object data in the bucket resides. If unspecified, defaults to the location in which the bucket is being created. |

### BucketStatus

Defines the observed state of the Bucket.

*Appears in:*
- [Bucket](https://docs.cloud.google.com/distributed-cloud/hosted/docs/latest/gdcag/apis/service/storage/v1/object-v1.md.txt#bucket)

| Field | Description |
|---|---|
| `fullyQualifiedName` *string* | The name of the provisioned bucket. This name is used to refer to the bucket when using external tools and libraries. |
| `conditions` *[Condition](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#condition-v1-meta) array* | Specifies the status of the bucket. Supported conditions include `BucketReady`. If BucketReady is `True`, it indicates the bucket has been provisioned and is ready for use. |
| `endpoint` *string* | The DNS endpoint at which the bucket is reachable. |
| `region` *string* | The region where the bucket is stored. |
| `encryption` *[EncryptionStatus](https://docs.cloud.google.com/distributed-cloud/hosted/docs/latest/gdcag/apis/service/storage/v1/object-v1.md.txt#encryptionstatus)* | The status of the encryption on the bucket. |
| `errorStatus` *ErrorStatus* | ErrorStatus holds the most recent errors with the observed times included. |

### CorsPolicy

Defines the strategy for setting up custom CORS policy on the bucket.

*Appears in:*
- [BucketPolicy](https://docs.cloud.google.com/distributed-cloud/hosted/docs/latest/gdcag/apis/service/storage/v1/object-v1.md.txt#bucketpolicy)
- [GlobalBucketPolicy](https://docs.cloud.google.com/distributed-cloud/hosted/docs/latest/gdcag/apis/service/storage/v1/object-v1.md.txt#globalbucketpolicy)

| Field | Description |
|---|---|
| `enableCorsPolicy` *boolean* | Defines whether the user wants the custom policy to take effect on the bucket. If yes, the custom policy defined in CorsDetail will be read. Otherwise, CorsDetail would not be used even if it has custom policy set up. |
| `corsDetail` *[CorsRule](https://docs.cloud.google.com/distributed-cloud/hosted/docs/latest/gdcag/apis/service/storage/v1/object-v1.md.txt#corsrule) array* | Detail of the custom CORS policy being set. |

### CorsRule

Defines the information related with CORS rule.

*Appears in:*
- [CorsPolicy](https://docs.cloud.google.com/distributed-cloud/hosted/docs/latest/gdcag/apis/service/storage/v1/object-v1.md.txt#corspolicy)

| Field | Description |
|---|---|
| `allowedHeaders` *string array* | Headers that are specified in the Access-Control-Request-Headers header. |
| `allowedMethods` *string array* | HTTP methods that are permitted to be executed by an allowed origin. |
| `allowedOrigins` *string array* | Origins that can access the bucket. |
| `exposeHeaders` *string array* | Headers in the response that can be accessed. |
| `id` *string* | Unique identifier for the rule. The value can not be longer than 255 characters. |

### EncryptionStatus

EncryptionStatus defines the status of the encryption on the bucket.

*Appears in:*
- [BucketInfoSpec](https://docs.cloud.google.com/distributed-cloud/hosted/docs/latest/gdcag/apis/service/storage/v1/object-v1.md.txt#bucketinfospec)
- [BucketStatus](https://docs.cloud.google.com/distributed-cloud/hosted/docs/latest/gdcag/apis/service/storage/v1/object-v1.md.txt#bucketstatus)

| Field | Description |
|---|---|
| `type` *EncryptionType* | Defines the type of encryption to be used for the bucket. Available options are: - CMEK - Customer Managed Encryption Key which creates a KMS backed key rooted in the HSM which the customer is billed for. The customer can access these keys and manage them through KMS. |
| `keyRef` *[ObjectReference](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#objectreference-v1-core)* | KeyRef references the key which is used as the default key to encrypt objects in the bucket. |

### GlobalBucketPolicy

Defines policies of the Bucket.

*Appears in:*
- [BucketInfoSpec](https://docs.cloud.google.com/distributed-cloud/hosted/docs/latest/gdcag/apis/service/storage/v1/object-v1.md.txt#bucketinfospec)

| Field | Description |
|---|---|
| `lockingPolicy` *[LockingPolicy](https://docs.cloud.google.com/distributed-cloud/hosted/docs/latest/gdcag/apis/service/storage/v1/object-v1.md.txt#lockingpolicy)* | Policy for object locking. When set, object versioning is enabled and all objects stored in the bucket will be subject to this policy. A locked object cannot be deleted until the lock expires. Can only be enabled when creating the bucket and cannot be disabled afterwards. |
| `corsPolicy` *[CorsPolicy](https://docs.cloud.google.com/distributed-cloud/hosted/docs/latest/gdcag/apis/service/storage/v1/object-v1.md.txt#corspolicy)* | Policy for custom CORS policy user set on the bucket. CorsPolicy has to be enabled when additional CORS policy is needed on the buckets. Otherwise, the bucket will only have the default UI console CORS policy. CorsPolicy can always be added or modified later after the bucket is created. |
| `lifecyclePolicy` *[LifecyclePolicy](https://docs.cloud.google.com/distributed-cloud/hosted/docs/latest/gdcag/apis/service/storage/v1/object-v1.md.txt#lifecyclepolicy)* | Policy for custom lifecycle policy user set on the bucket. LifecyclePolicy can always be added, modified, removed later after the bucket is created. |

### LifecycleExpiration

*Appears in:*
- [LifecycleRule](https://docs.cloud.google.com/distributed-cloud/hosted/docs/latest/gdcag/apis/service/storage/v1/object-v1.md.txt#lifecyclerule)

| Field | Description |
|---|---|
| `date` *[Time](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#time-v1-meta)* | Specific date when the objects should be deleted. |
| `days` *integer* | Number of days this object is subject to the rule. |

### LifecycleNoncurrentExpiration

*Appears in:*
- [LifecycleRule](https://docs.cloud.google.com/distributed-cloud/hosted/docs/latest/gdcag/apis/service/storage/v1/object-v1.md.txt#lifecyclerule)

| Field | Description |
|---|---|
| `noncurrentDays` *integer* | Number of days an object is noncurrent before lifecycle rules takes the action. |

### LifecyclePolicy

*Appears in:*
- [BucketPolicy](https://docs.cloud.google.com/distributed-cloud/hosted/docs/latest/gdcag/apis/service/storage/v1/object-v1.md.txt#bucketpolicy)
- [GlobalBucketPolicy](https://docs.cloud.google.com/distributed-cloud/hosted/docs/latest/gdcag/apis/service/storage/v1/object-v1.md.txt#globalbucketpolicy)

| Field | Description |
|---|---|
| `enable` *boolean* | Defines whether the user wants to enable custom lifecycle policy on the bucket. |
| `lifecycleRules` *[LifecycleRule](https://docs.cloud.google.com/distributed-cloud/hosted/docs/latest/gdcag/apis/service/storage/v1/object-v1.md.txt#lifecyclerule) array* | Consists of one or more lifecycle configuration rules that can take expiration action on objects in the bucket. |

### LifecycleRule

*Appears in:*
- [LifecyclePolicy](https://docs.cloud.google.com/distributed-cloud/hosted/docs/latest/gdcag/apis/service/storage/v1/object-v1.md.txt#lifecyclepolicy)

| Field | Description |
|---|---|
| `id` *string* | Unique identifier for the rule. The value cannot be longer than 255 characters. |
| `status` *[LifecycleRuleStatus](https://docs.cloud.google.com/distributed-cloud/hosted/docs/latest/gdcag/apis/service/storage/v1/object-v1.md.txt#lifecyclerulestatus)* | Status of the lifecycle rule. Indicate whether this rule takes action. The status can always be changed, and only Enabled rule would take effect. |
| `expiration` *[LifecycleExpiration](https://docs.cloud.google.com/distributed-cloud/hosted/docs/latest/gdcag/apis/service/storage/v1/object-v1.md.txt#lifecycleexpiration)* | Expiration behavior for objects in current version. Either Expiration or NoncurrentExpiration, or both should be provided. Rule without expiration behavior would be ignored. |
| `noncurrentExpiration` *[LifecycleNoncurrentExpiration](https://docs.cloud.google.com/distributed-cloud/hosted/docs/latest/gdcag/apis/service/storage/v1/object-v1.md.txt#lifecyclenoncurrentexpiration)* | Expiration behavior for objects noncurrent. |
| `filter` *[LifecycleRuleFilter](https://docs.cloud.google.com/distributed-cloud/hosted/docs/latest/gdcag/apis/service/storage/v1/object-v1.md.txt#lifecyclerulefilter)* | Filter for the rule. Empty filer means the rule apply to all objects in the bucket. |

### LifecycleRuleFilter

Defines the filter that can be set on lifecycle rule.

*Appears in:*
- [LifecycleRule](https://docs.cloud.google.com/distributed-cloud/hosted/docs/latest/gdcag/apis/service/storage/v1/object-v1.md.txt#lifecyclerule)

| Field | Description |
|---|---|
| `prefixFilter` *string* | Match objects with provided prefix. Empty string of prefix means apply to all objects in the bucket. |
| `tagFilters` *[Tag](https://docs.cloud.google.com/distributed-cloud/hosted/docs/latest/gdcag/apis/service/storage/v1/object-v1.md.txt#tag) array* | Match objects with provided tags. The tag on object must match both the key and value exactly. |

### LifecycleRuleStatus

*Underlying type:* `string`

*Appears in:*
- [LifecycleRule](https://docs.cloud.google.com/distributed-cloud/hosted/docs/latest/gdcag/apis/service/storage/v1/object-v1.md.txt#lifecyclerule)

### LockingPolicy

Defines the strategy for locking the objects of the Bucket.

*Appears in:*
- [BucketPolicy](https://docs.cloud.google.com/distributed-cloud/hosted/docs/latest/gdcag/apis/service/storage/v1/object-v1.md.txt#bucketpolicy)
- [GlobalBucketPolicy](https://docs.cloud.google.com/distributed-cloud/hosted/docs/latest/gdcag/apis/service/storage/v1/object-v1.md.txt#globalbucketpolicy)

| Field | Description |
|---|---|
| `defaultObjectRetentionDays` *integer* | Specifies the minimum number of days that each version of every object will be retained. An object cannot be deleted during the retention period. If a bucket contains any object, it cannot be deleted either. When unspecified, no default object retention period is set. Can be modified after creation, however the change will only take effect for new objects and versions. Existing objects and versions will still use the previous value. |

### S3CredentialRotationRequest

S3CredentialRotationRequest is the Schema for the S3CredentialRotationRequests API

*Appears in:*
- [S3CredentialRotationRequestList](https://docs.cloud.google.com/distributed-cloud/hosted/docs/latest/gdcag/apis/service/storage/v1/object-v1.md.txt#s3credentialrotationrequestlist)

| Field | Description |
|---|---|
| `apiVersion` *string* | `object.gdc.goog/v1` |
| `kind` *string* | `S3CredentialRotationRequest` |
| `metadata` *[ObjectMeta](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#objectmeta-v1-meta)* | Refer to Kubernetes API documentation for fields of `metadata`. |
| `spec` *[S3CredentialRotationRequestSpec](https://docs.cloud.google.com/distributed-cloud/hosted/docs/latest/gdcag/apis/service/storage/v1/object-v1.md.txt#s3credentialrotationrequestspec)* |   |
| `status` *[S3CredentialRotationRequestStatus](https://docs.cloud.google.com/distributed-cloud/hosted/docs/latest/gdcag/apis/service/storage/v1/object-v1.md.txt#s3credentialrotationrequeststatus)* |   |

### S3CredentialRotationRequestList

S3CredentialRotationRequestList contains a list of S3CredentialRotationRequest

| Field | Description |
|---|---|
| `apiVersion` *string* | `object.gdc.goog/v1` |
| `kind` *string* | `S3CredentialRotationRequestList` |
| `metadata` *[ListMeta](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#listmeta-v1-meta)* | Refer to Kubernetes API documentation for fields of `metadata`. |
| `items` *[S3CredentialRotationRequest](https://docs.cloud.google.com/distributed-cloud/hosted/docs/latest/gdcag/apis/service/storage/v1/object-v1.md.txt#s3credentialrotationrequest) array* |   |

### S3CredentialRotationRequestSpec

S3CredentialRotationRequestSpec defines the desired state of a S3CredentialRotationRequest.
This spec is used to initiate the rotation of S3 credentials stored in a Kubernetes Secret.

*Appears in:*
- [S3CredentialRotationRequest](https://docs.cloud.google.com/distributed-cloud/hosted/docs/latest/gdcag/apis/service/storage/v1/object-v1.md.txt#s3credentialrotationrequest)

| Field | Description |
|---|---|
| `secretName` *string* | SecretName is the name of the Kubernetes Secret containing the S3 credentials that need to be rotated. The Secret must exist in the same namespace as this S3CredentialRotationRequest. |
| `expirationDelay` *[Duration](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#duration-v1-meta)* | ExpirationDelay specifies the duration for which the old, rotated S3 key will remain valid after the new key has been created. This allows for a graceful transition period for clients and applications to switch to the new credentials. If not specified, this value is defaulted by a defaulting webhook to 72 hours. A value of "0s" indicates that the old key should be revoked immediately after the new key is activated. The format is a duration string that is parsable by Go's time.ParseDuration function. For example, "72h", "90m", "30s". Note that units such as "d" for days are not supported. See https://pkg.go.dev/time#ParseDuration for more details on the format. |
| `requestTTL` *[Duration](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#duration-v1-meta)* | RequestTTL defines the time-to-live (TTL) for this S3CredentialRotationRequest object itself. The TTL timer begins after the credential rotation is complete (i.e., when the `RotationCompleted` status condition becomes `True`). After this duration, the request object will be automatically garbage collected by the system. This mechanism preserves the request as an audit record for a configurable period. If not specified, this value is defaulted by a defaulting webhook to 90 days. The format is a duration string that is parsable by Go's time.ParseDuration function. For example, "2160h" (for 90 days), "72h", "30m". Note that units such as "d" for days are not supported. See https://pkg.go.dev/time#ParseDuration for more details on the format. |

### S3CredentialRotationRequestStatus

S3CredentialRotationRequestStatus defines the observed state of a S3CredentialRotationRequest.
It provides feedback on the progress and outcome of the credential rotation process.

*Appears in:*
- [S3CredentialRotationRequest](https://docs.cloud.google.com/distributed-cloud/hosted/docs/latest/gdcag/apis/service/storage/v1/object-v1.md.txt#s3credentialrotationrequest)

| Field | Description |
|---|---|
| `conditions` *[Condition](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#condition-v1-meta) array* | Conditions represents the latest available observations of the rotation request's state. It provides a detailed breakdown of the rotation process, including its current phase and any errors that may have occurred. |
| `oldKeyRevocationTimestamp` *[Time](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#time-v1-meta)* | OldKeyRevocationTimestamp is the timestamp when the old, rotated S3 key is scheduled to be permanently revoked from the backend storage system. This time is calculated by adding the ExpirationDelay to the LastTransitionTime of the RotationCompleted condition. |

### Tag

Defines the tags on object that can be used by lifecycle filter.

*Appears in:*
- [LifecycleRuleFilter](https://docs.cloud.google.com/distributed-cloud/hosted/docs/latest/gdcag/apis/service/storage/v1/object-v1.md.txt#lifecyclerulefilter)

| Field | Description |
|---|---|
| `key` *string* |   |
| `value` *string* |   |