ResourceClaimTemplate v1alpha2

    apiVersion: resource.k8s.io/v1alpha2

    import "k8s.io/api/resource/v1alpha2"

    ResourceClaimTemplate is used to produce ResourceClaim objects.

    • apiVersion: resource.k8s.io/v1alpha2

    • metadata ()

      Standard object metadata

    • spec (ResourceClaimTemplateSpec), required

      Describes the ResourceClaim that is to be generated.

      This field is immutable. A ResourceClaim will get created by the control plane for a Pod when needed and then not get updated anymore.

    ResourceClaimTemplateSpec contains the metadata and fields for a ResourceClaim.

    • spec (ResourceClaimSpec), required

      Spec for the ResourceClaim. The entire content is copied unchanged into the ResourceClaim that gets created from this template. The same fields as in a ResourceClaim are also valid here.

    • metadata ()

      ObjectMeta may contain labels and annotations that will be copied into the PVC when creating it. No other fields are allowed and will be rejected during validation.

    ResourceClaimTemplateList is a collection of claim templates.

    • apiVersion: resource.k8s.io/v1alpha2

    • kind: ResourceClaimTemplateList

    • metadata ()

      Standard list metadata

    • items ([]ResourceClaimTemplate), required

      Items is the list of resource claim templates.

    HTTP Request

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

    Parameters

    • name (in path): string, required

      name of the ResourceClaimTemplate

    • namespace (in path): string, required

    • pretty (in query): string

      pretty

    Response

    200 (ResourceClaimTemplate): OK

    401: Unauthorized

    list list or watch objects of kind ResourceClaimTemplate

    HTTP Request

    GET /apis/resource.k8s.io/v1alpha2/namespaces/{namespace}/resourceclaimtemplates

    Parameters

    • namespace (in path): string, required

      namespace

    • allowWatchBookmarks (in query): boolean

    • continue (in query): string

      continue

    • fieldSelector (in query): string

    • labelSelector (in query): string

      labelSelector

    • limit (in query): integer

    • pretty (in query): string

      pretty

    • resourceVersion (in query): string

    • resourceVersionMatch (in query): string

      resourceVersionMatch

    • sendInitialEvents (in query): boolean

    • timeoutSeconds (in query): integer

      timeoutSeconds

    • watch (in query): boolean

    Response

    200 (): OK

    401: Unauthorized

    HTTP Request

    GET /apis/resource.k8s.io/v1alpha2/resourceclaimtemplates

    Parameters

    • allowWatchBookmarks (in query): boolean

    • continue (in query): string

    • fieldSelector (in query): string

      fieldSelector

    • labelSelector (in query): string

    • limit (in query): integer

      limit

    • pretty (in query): string

    • resourceVersion (in query): string

      resourceVersion

    • resourceVersionMatch (in query): string

    • sendInitialEvents (in query): boolean

      sendInitialEvents

    • timeoutSeconds (in query): integer

    • watch (in query): boolean

      watch

    Response

    200 (ResourceClaimTemplateList): OK

    401: Unauthorized

    create create a ResourceClaimTemplate

    HTTP Request

    POST /apis/resource.k8s.io/v1alpha2/namespaces/{namespace}/resourceclaimtemplates

    Parameters

    • namespace (in path): string, required

      namespace

    • body: , required

    • dryRun (in query): string

      dryRun

    • fieldValidation (in query): string

    • pretty (in query): string

      pretty

    Response

    200 (ResourceClaimTemplate): OK

    201 (): Created

    202 (ResourceClaimTemplate): Accepted

    401: Unauthorized

    HTTP Request

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

    Parameters

    • name (in path): string, required

      name of the ResourceClaimTemplate

    • namespace (in path): string, required

      namespace

    • body: , required

    • dryRun (in query): string

      dryRun

    • fieldManager (in query): string

    • fieldValidation (in query): string

      fieldValidation

    • pretty (in query): string

    Response

    200 (): OK

    201 (ResourceClaimTemplate): Created

    401: Unauthorized

    patch partially update the specified ResourceClaimTemplate

    HTTP Request

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

    Parameters

    • name (in path): string, required

      name of the ResourceClaimTemplate

    • namespace (in path): string, required

      namespace

    • dryRun (in query): string

    • fieldManager (in query): string

      fieldManager

    • fieldValidation (in query): string

    • force (in query): boolean

      force

    • pretty (in query): string

    Response

    200 (): OK

    201 (ResourceClaimTemplate): Created

    401: Unauthorized

    HTTP Request

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

    Parameters

    • name (in path): string, required

      name of the ResourceClaimTemplate

    • namespace (in path): string, required

      namespace

    • body:

    • dryRun (in query): string

      dryRun

    • gracePeriodSeconds (in query): integer

    • pretty (in query): string

      pretty

    • propagationPolicy (in query): string

    Response

    200 (): OK

    202 (ResourceClaimTemplate): Accepted

    401: Unauthorized

    deletecollection delete collection of ResourceClaimTemplate

    HTTP Request

    DELETE /apis/resource.k8s.io/v1alpha2/namespaces/{namespace}/resourceclaimtemplates

    Parameters

    • namespace (in path): string, required

      namespace

    • body:

    • continue (in query): string

      continue

    • dryRun (in query): string

    • fieldSelector (in query): string

      fieldSelector

    • gracePeriodSeconds (in query): integer

    • labelSelector (in query): string

      labelSelector

    • limit (in query): integer

    • pretty (in query): string

      pretty

    • propagationPolicy (in query): string

    • resourceVersion (in query): string

      resourceVersion

    • resourceVersionMatch (in query): string

    • sendInitialEvents (in query): boolean

      sendInitialEvents

    Response

    200 (Status): OK

    401: Unauthorized