API Reference
Packages
objectstorage.k8s.io/v1alpha2
Package v1alpha2 contains API Schema definitions for the objectstorage v1alpha2 API group.
Resource Types
- Bucket
- BucketAccess
- BucketAccessClass
- BucketAccessClassList
- BucketAccessList
- BucketClaim
- BucketClaimList
- BucketClass
- BucketClassList
- BucketList
Bucket
Bucket is the Schema for the buckets API
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
apiVersion string | objectstorage.k8s.io/v1alpha2 | ||
kind string | Bucket | ||
kind string | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds | ||
apiVersion string | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources | ||
metadata ObjectMeta | Refer to Kubernetes API documentation for fields of metadata. | ||
spec BucketSpec | spec defines the desired state of Bucket | ||
status BucketStatus | status defines the observed state of Bucket |
BucketAccess
BucketAccess is the Schema for the bucketaccesses API
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
apiVersion string | objectstorage.k8s.io/v1alpha2 | ||
kind string | BucketAccess | ||
kind string | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds | ||
apiVersion string | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources | ||
metadata ObjectMeta | Refer to Kubernetes API documentation for fields of metadata. | ||
spec BucketAccessSpec | spec defines the desired state of BucketAccess | ||
status BucketAccessStatus | status defines the observed state of BucketAccess |
BucketAccessClass
BucketAccessClass is the Schema for the bucketaccessclasses API
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
apiVersion string | objectstorage.k8s.io/v1alpha2 | ||
kind string | BucketAccessClass | ||
kind string | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds | ||
apiVersion string | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources | ||
metadata ObjectMeta | Refer to Kubernetes API documentation for fields of metadata. | ||
spec BucketAccessClassSpec | spec defines the desired state of BucketAccessClass | ||
status BucketAccessClassStatus | status defines the observed state of BucketAccessClass |
BucketAccessClassList
BucketAccessClassList contains a list of BucketAccessClass
| Field | Description | Default | Validation |
|---|---|---|---|
apiVersion string | objectstorage.k8s.io/v1alpha2 | ||
kind string | BucketAccessClassList | ||
kind string | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds | ||
apiVersion string | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources | ||
metadata ListMeta | Refer to Kubernetes API documentation for fields of metadata. | ||
items BucketAccessClass array |
BucketAccessClassSpec
BucketAccessClassSpec defines the desired state of BucketAccessClass
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
foo string | foo is an example field of BucketAccessClass. Edit bucketaccessclass_types.go to remove/update |
BucketAccessClassStatus
BucketAccessClassStatus defines the observed state of BucketAccessClass.
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
conditions Condition array | conditions represent the current state of the BucketAccessClass resource. Each condition has a unique type and reflects the status of a specific aspect of the resource. Standard condition types include: - "Available": the resource is fully functional - "Progressing": the resource is being created or updated - "Degraded": the resource failed to reach or maintain its desired state The status of each condition is one of True, False, or Unknown. |
BucketAccessList
BucketAccessList contains a list of BucketAccess
| Field | Description | Default | Validation |
|---|---|---|---|
apiVersion string | objectstorage.k8s.io/v1alpha2 | ||
kind string | BucketAccessList | ||
kind string | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds | ||
apiVersion string | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources | ||
metadata ListMeta | Refer to Kubernetes API documentation for fields of metadata. | ||
items BucketAccess array |
BucketAccessSpec
BucketAccessSpec defines the desired state of BucketAccess
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
foo string | foo is an example field of BucketAccess. Edit bucketaccess_types.go to remove/update |
BucketAccessStatus
BucketAccessStatus defines the observed state of BucketAccess.
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
conditions Condition array | conditions represent the current state of the BucketAccess resource. Each condition has a unique type and reflects the status of a specific aspect of the resource. Standard condition types include: - "Available": the resource is fully functional - "Progressing": the resource is being created or updated - "Degraded": the resource failed to reach or maintain its desired state The status of each condition is one of True, False, or Unknown. |
BucketClaim
BucketClaim is the Schema for the bucketclaims API
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
apiVersion string | objectstorage.k8s.io/v1alpha2 | ||
kind string | BucketClaim | ||
kind string | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds | ||
apiVersion string | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources | ||
metadata ObjectMeta | Refer to Kubernetes API documentation for fields of metadata. | ||
spec BucketClaimSpec | spec defines the desired state of BucketClaim | ||
status BucketClaimStatus | status defines the observed state of BucketClaim |
BucketClaimList
BucketClaimList contains a list of BucketClaim
| Field | Description | Default | Validation |
|---|---|---|---|
apiVersion string | objectstorage.k8s.io/v1alpha2 | ||
kind string | BucketClaimList | ||
kind string | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds | ||
apiVersion string | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources | ||
metadata ListMeta | Refer to Kubernetes API documentation for fields of metadata. | ||
items BucketClaim array |
BucketClaimSpec
BucketClaimSpec defines the desired state of BucketClaim
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
foo string | foo is an example field of BucketClaim. Edit bucketclaim_types.go to remove/update |
BucketClaimStatus
BucketClaimStatus defines the observed state of BucketClaim.
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
conditions Condition array | conditions represent the current state of the BucketClaim resource. Each condition has a unique type and reflects the status of a specific aspect of the resource. Standard condition types include: - "Available": the resource is fully functional - "Progressing": the resource is being created or updated - "Degraded": the resource failed to reach or maintain its desired state The status of each condition is one of True, False, or Unknown. |
BucketClass
BucketClass is the Schema for the bucketclasses API
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
apiVersion string | objectstorage.k8s.io/v1alpha2 | ||
kind string | BucketClass | ||
kind string | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds | ||
apiVersion string | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources | ||
metadata ObjectMeta | Refer to Kubernetes API documentation for fields of metadata. | ||
spec BucketClassSpec | spec defines the desired state of BucketClass | ||
status BucketClassStatus | status defines the observed state of BucketClass |
BucketClassList
BucketClassList contains a list of BucketClass
| Field | Description | Default | Validation |
|---|---|---|---|
apiVersion string | objectstorage.k8s.io/v1alpha2 | ||
kind string | BucketClassList | ||
kind string | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds | ||
apiVersion string | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources | ||
metadata ListMeta | Refer to Kubernetes API documentation for fields of metadata. | ||
items BucketClass array |
BucketClassSpec
BucketClassSpec defines the desired state of BucketClass
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
foo string | foo is an example field of BucketClass. Edit bucketclass_types.go to remove/update |
BucketClassStatus
BucketClassStatus defines the observed state of BucketClass.
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
conditions Condition array | conditions represent the current state of the BucketClass resource. Each condition has a unique type and reflects the status of a specific aspect of the resource. Standard condition types include: - "Available": the resource is fully functional - "Progressing": the resource is being created or updated - "Degraded": the resource failed to reach or maintain its desired state The status of each condition is one of True, False, or Unknown. |
BucketList
BucketList contains a list of Bucket
| Field | Description | Default | Validation |
|---|---|---|---|
apiVersion string | objectstorage.k8s.io/v1alpha2 | ||
kind string | BucketList | ||
kind string | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds | ||
apiVersion string | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources | ||
metadata ListMeta | Refer to Kubernetes API documentation for fields of metadata. | ||
items Bucket array |
BucketSpec
BucketSpec defines the desired state of Bucket
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
foo string | foo is an example field of Bucket. Edit bucket_types.go to remove/update |
BucketStatus
BucketStatus defines the observed state of Bucket.
Appears in: