ResourceClaimParameters [resource.k8s.io/v1alpha2] - Schedule and quota APIs | API reference

Specification
API endpoints

Description: ResourceClaimParameters defines resource requests for a ResourceClaim in an in-tree format understood by Kubernetes.
Type: object

Specification

Property Type Description

Property	Type	Description
`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
`driverRequests`	`array`	DriverRequests describes all resources that are needed for the allocated claim. A single claim may use resources coming from different drivers. For each driver, this array has at most one entry which then may have one or more per-driver requests. May be empty, in which case the claim can always be allocated.
`driverRequests[]`	`object`	DriverRequests describes all resources that are needed from one particular driver.
`generatedFrom`	`object`	ResourceClaimParametersReference contains enough information to let you locate the parameters for a ResourceClaim. The object must be in the same namespace as the ResourceClaim.
`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
`metadata`	`ObjectMeta`	Standard object metadata
`shareable`	`boolean`	Shareable indicates whether the allocated claim is meant to be shareable by multiple consumers at the same time.

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

driverRequests

array

DriverRequests describes all resources that are needed for the allocated claim. A single claim may use resources coming from different drivers. For each driver, this array has at most one entry which then may have one or more per-driver requests.

May be empty, in which case the claim can always be allocated.

driverRequests[]

object

DriverRequests describes all resources that are needed from one particular driver.

generatedFrom

object

ResourceClaimParametersReference contains enough information to let you locate the parameters for a ResourceClaim. The object must be in the same namespace as the ResourceClaim.

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

metadata

ObjectMeta

Standard object metadata

shareable

boolean

Shareable indicates whether the allocated claim is meant to be shareable by multiple consumers at the same time.

.driverRequests

Description: DriverRequests describes all resources that are needed for the allocated claim. A single claim may use resources coming from different drivers. For each driver, this array has at most one entry which then may have one or more per-driver requests.

May be empty, in which case the claim can always be allocated.
Type: array

.driverRequests[]

Description: DriverRequests describes all resources that are needed from one particular driver.
Type: object

Property Type Description

Property	Type	Description
`driverName`	`string`	DriverName is the name used by the DRA driver kubelet plugin.
`requests`	`array`	Requests describes all resources that are needed from the driver.
`requests[]`	`object`	ResourceRequest is a request for resources from one particular driver.
`vendorParameters`	`RawExtension`	VendorParameters are arbitrary setup parameters for all requests of the claim. They are ignored while allocating the claim.

driverName

string

DriverName is the name used by the DRA driver kubelet plugin.

requests

array

Requests describes all resources that are needed from the driver.

requests[]

object

ResourceRequest is a request for resources from one particular driver.

vendorParameters

RawExtension

VendorParameters are arbitrary setup parameters for all requests of the claim. They are ignored while allocating the claim.

.driverRequests[].requests

Description: Requests describes all resources that are needed from the driver.
Type: array

.driverRequests[].requests[]

Description: ResourceRequest is a request for resources from one particular driver.
Type: object

Property Type Description

Property	Type	Description
`namedResources`	`object`	NamedResourcesRequest is used in ResourceRequestModel.
`vendorParameters`	`RawExtension`	VendorParameters are arbitrary setup parameters for the requested resource. They are ignored while allocating a claim.

namedResources

object

NamedResourcesRequest is used in ResourceRequestModel.

vendorParameters

RawExtension

VendorParameters are arbitrary setup parameters for the requested resource. They are ignored while allocating a claim.

.driverRequests[].requests[].namedResources

Description

NamedResourcesRequest is used in ResourceRequestModel.

Type

object

Required

selector

Property Type Description

Property	Type	Description
`selector`	`string`	Selector is a CEL expression which must evaluate to true if a resource instance is suitable. The language is as defined in https://kubernetes.io/docs/reference/using-api/cel/ In addition, for each type NamedResourcesin AttributeValue there is a map that resolves to the corresponding value of the instance under evaluation. For example: attributes.quantity["a"].isGreaterThan(quantity("0")) && attributes.stringslice["b"].isSorted()

selector

string

Selector is a CEL expression which must evaluate to true if a resource instance is suitable. The language is as defined in https://kubernetes.io/docs/reference/using-api/cel/

In addition, for each type NamedResourcesin AttributeValue there is a map that resolves to the corresponding value of the instance under evaluation. For example:

attributes.quantity["a"].isGreaterThan(quantity("0")) && attributes.stringslice["b"].isSorted()

.generatedFrom

Description

ResourceClaimParametersReference contains enough information to let you locate the parameters for a ResourceClaim. The object must be in the same namespace as the ResourceClaim.

Type

object

Required

kind
name

Property Type Description

Property	Type	Description
`apiGroup`	`string`	APIGroup is the group for the resource being referenced. It is empty for the core API. This matches the group in the APIVersion that is used when creating the resources.
`kind`	`string`	Kind is the type of resource being referenced. This is the same value as in the parameter object’s metadata, for example "ConfigMap".
`name`	`string`	Name is the name of resource being referenced.

apiGroup

string

APIGroup is the group for the resource being referenced. It is empty for the core API. This matches the group in the APIVersion that is used when creating the resources.

kind

string

Kind is the type of resource being referenced. This is the same value as in the parameter object’s metadata, for example "ConfigMap".

name

string

Name is the name of resource being referenced.

API endpoints

The following API endpoints are available:

/apis/resource.k8s.io/v1alpha2/resourceclaimparameters
- GET: list or watch objects of kind ResourceClaimParameters
/apis/resource.k8s.io/v1alpha2/watch/resourceclaimparameters
- GET: watch individual changes to a list of ResourceClaimParameters. deprecated: use the 'watch' parameter with a list operation instead.
/apis/resource.k8s.io/v1alpha2/namespaces/{namespace}/resourceclaimparameters
- DELETE: delete collection of ResourceClaimParameters
- GET: list or watch objects of kind ResourceClaimParameters
- POST: create ResourceClaimParameters
/apis/resource.k8s.io/v1alpha2/watch/namespaces/{namespace}/resourceclaimparameters
- GET: watch individual changes to a list of ResourceClaimParameters. deprecated: use the 'watch' parameter with a list operation instead.
/apis/resource.k8s.io/v1alpha2/namespaces/{namespace}/resourceclaimparameters/{name}
- DELETE: delete ResourceClaimParameters
- GET: read the specified ResourceClaimParameters
- PATCH: partially update the specified ResourceClaimParameters
- PUT: replace the specified ResourceClaimParameters
/apis/resource.k8s.io/v1alpha2/watch/namespaces/{namespace}/resourceclaimparameters/{name}
- GET: watch changes to an object of kind ResourceClaimParameters. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.

/apis/resource.k8s.io/v1alpha2/resourceclaimparameters

HTTP method: GET
Description: list or watch objects of kind ResourceClaimParameters

Table 1. HTTP responses
HTTP code	Reponse body
200 - OK	`ResourceClaimParametersList` schema
401 - Unauthorized	Empty

/apis/resource.k8s.io/v1alpha2/watch/resourceclaimparameters

HTTP method: GET
Description: watch individual changes to a list of ResourceClaimParameters. deprecated: use the 'watch' parameter with a list operation instead.

Table 2. HTTP responses
HTTP code	Reponse body
200 - OK	`WatchEvent` schema
401 - Unauthorized	Empty

/apis/resource.k8s.io/v1alpha2/namespaces/{namespace}/resourceclaimparameters

HTTP method: DELETE
Description: delete collection of ResourceClaimParameters

Table 3. Query parameters
Parameter	Type	Description
`dryRun`	`string`	When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

Table 4. HTTP responses
HTTP code	Reponse body
200 - OK	`Status` schema
401 - Unauthorized	Empty

HTTP method: GET
Description: list or watch objects of kind ResourceClaimParameters

Table 5. HTTP responses
HTTP code	Reponse body
200 - OK	`ResourceClaimParametersList` schema
401 - Unauthorized	Empty

HTTP method: POST
Description: create ResourceClaimParameters

Table 6. Query parameters
Parameter	Type	Description
`dryRun`	`string`	When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldValidation`	`string`	fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.

Table 7. Body parameters
Parameter	Type	Description
`body`	`ResourceClaimParameters` schema

Table 8. HTTP responses
HTTP code	Reponse body
200 - OK	`ResourceClaimParameters` schema
201 - Created	`ResourceClaimParameters` schema
202 - Accepted	`ResourceClaimParameters` schema
401 - Unauthorized	Empty

/apis/resource.k8s.io/v1alpha2/watch/namespaces/{namespace}/resourceclaimparameters

HTTP method: GET
Description: watch individual changes to a list of ResourceClaimParameters. deprecated: use the 'watch' parameter with a list operation instead.

Table 9. HTTP responses
HTTP code	Reponse body
200 - OK	`WatchEvent` schema
401 - Unauthorized	Empty

/apis/resource.k8s.io/v1alpha2/namespaces/{namespace}/resourceclaimparameters/{name}

Table 10. Global path parameters
Parameter	Type	Description
`name`	`string`	name of the ResourceClaimParameters

HTTP method: DELETE
Description: delete ResourceClaimParameters

Table 11. Query parameters
Parameter	Type	Description
`dryRun`	`string`	When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

Table 12. HTTP responses
HTTP code	Reponse body
200 - OK	`ResourceClaimParameters` schema
202 - Accepted	`ResourceClaimParameters` schema
401 - Unauthorized	Empty

HTTP method: GET
Description: read the specified ResourceClaimParameters

Table 13. HTTP responses
HTTP code	Reponse body
200 - OK	`ResourceClaimParameters` schema
401 - Unauthorized	Empty

HTTP method: PATCH
Description: partially update the specified ResourceClaimParameters

Table 14. Query parameters
Parameter	Type	Description
`dryRun`	`string`	When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldValidation`	`string`	fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.

Table 15. HTTP responses
HTTP code	Reponse body
200 - OK	`ResourceClaimParameters` schema
201 - Created	`ResourceClaimParameters` schema
401 - Unauthorized	Empty

HTTP method: PUT
Description: replace the specified ResourceClaimParameters

Table 16. Query parameters
Parameter	Type	Description
`dryRun`	`string`	When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldValidation`	`string`	fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.

Table 17. Body parameters
Parameter	Type	Description
`body`	`ResourceClaimParameters` schema

Table 18. HTTP responses
HTTP code	Reponse body
200 - OK	`ResourceClaimParameters` schema
201 - Created	`ResourceClaimParameters` schema
401 - Unauthorized	Empty

/apis/resource.k8s.io/v1alpha2/watch/namespaces/{namespace}/resourceclaimparameters/{name}

Table 19. Global path parameters
Parameter	Type	Description
`name`	`string`	name of the ResourceClaimParameters

HTTP method: GET
Description: watch changes to an object of kind ResourceClaimParameters. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.

Table 20. HTTP responses
HTTP code	Reponse body
200 - OK	`WatchEvent` schema
401 - Unauthorized	Empty