VolumePopulator [populator.storage.k8s.io/v1beta1]
Esc
Start typing to search...
On this page

VolumePopulator [populator.storage.k8s.io/v1beta1]

Description

VolumePopulator represents the registration for a volume populator. VolumePopulators are cluster scoped.

Type
`object`
Required
  • sourceKind

Specification

PropertyTypeDescription
apiVersionstringAPIVersion 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
kindstringKind 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
metadataObjectMetaStandard object’s metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
sourceKindobjectKind of the data source this populator supports

.sourceKind

Description

Kind of the data source this populator supports

Type
`object`
Required
  • group
  • kind
PropertyTypeDescription
groupstring
kindstring

API endpoints

The following API endpoints are available:

  • /apis/populator.storage.k8s.io/v1beta1/volumepopulators
    • DELETE: delete collection of VolumePopulator
    • GET: list objects of kind VolumePopulator
    • POST: create a VolumePopulator
  • /apis/populator.storage.k8s.io/v1beta1/volumepopulators/{name}
    • DELETE: delete a VolumePopulator
    • GET: read the specified VolumePopulator
    • PATCH: partially update the specified VolumePopulator
    • PUT: replace the specified VolumePopulator

/apis/populator.storage.k8s.io/v1beta1/volumepopulators

HTTP method
`DELETE`
Description
delete collection of VolumePopulator

HTTP responses

HTTP codeReponse body
200 - OKStatus schema
401 - UnauthorizedEmpty
HTTP method
`GET`
Description
list objects of kind VolumePopulator

HTTP responses

HTTP codeReponse body
200 - OKVolumePopulatorList schema
401 - UnauthorizedEmpty
HTTP method
`POST`
Description
create a VolumePopulator

Query parameters

ParameterTypeDescription
dryRunstringWhen 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
fieldValidationstringfieldValidation 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.

Body parameters

ParameterTypeDescription
bodyVolumePopulator schema

HTTP responses

HTTP codeReponse body
200 - OKVolumePopulator schema
201 - CreatedVolumePopulator schema
202 - AcceptedVolumePopulator schema
401 - UnauthorizedEmpty

/apis/populator.storage.k8s.io/v1beta1/volumepopulators/{name}

Global path parameters

ParameterTypeDescription
namestringname of the VolumePopulator
HTTP method
`DELETE`
Description
delete a VolumePopulator

Query parameters

ParameterTypeDescription
dryRunstringWhen 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

HTTP responses

HTTP codeReponse body
200 - OKStatus schema
202 - AcceptedStatus schema
401 - UnauthorizedEmpty
HTTP method
`GET`
Description
read the specified VolumePopulator

HTTP responses

HTTP codeReponse body
200 - OKVolumePopulator schema
401 - UnauthorizedEmpty
HTTP method
`PATCH`
Description
partially update the specified VolumePopulator

Query parameters

ParameterTypeDescription
dryRunstringWhen 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
fieldValidationstringfieldValidation 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.

HTTP responses

HTTP codeReponse body
200 - OKVolumePopulator schema
401 - UnauthorizedEmpty
HTTP method
`PUT`
Description
replace the specified VolumePopulator

Query parameters

ParameterTypeDescription
dryRunstringWhen 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
fieldValidationstringfieldValidation 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.

Body parameters

ParameterTypeDescription
bodyVolumePopulator schema

HTTP responses

HTTP codeReponse body
200 - OKVolumePopulator schema
201 - CreatedVolumePopulator schema
401 - UnauthorizedEmpty