1. Documentation
×

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

Description

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

Type

object

Required

  • sourceKind

Specification

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

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’s metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

sourceKind

object

Kind of the data source this populator supports

.sourceKind

Description

Kind of the data source this populator supports

Type

object

Required

  • group

  • kind

Property Type Description

group

string

kind

string

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

Table 1. HTTP responses
HTTP code Reponse body

200 - OK

Status schema

401 - Unauthorized

Empty
HTTP method

GET

Description

list objects of kind VolumePopulator

Table 2. HTTP responses
HTTP code Reponse body

200 - OK

VolumePopulatorList schema

401 - Unauthorized

Empty
HTTP method

POST

Description

create a VolumePopulator

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

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 4. Body parameters
Parameter Type Description

body

VolumePopulator schema
Table 5. HTTP responses
HTTP code Reponse body

200 - OK

VolumePopulator schema

201 - Created

VolumePopulator schema

202 - Accepted

VolumePopulator schema

401 - Unauthorized

Empty

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

Table 6. Global path parameters
Parameter Type Description

name

string

name of the VolumePopulator
HTTP method

DELETE

Description

delete a VolumePopulator

Table 7. 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 8. HTTP responses
HTTP code Reponse body

200 - OK

Status schema

202 - Accepted

Status schema

401 - Unauthorized

Empty
HTTP method

GET

Description

read the specified VolumePopulator

Table 9. HTTP responses
HTTP code Reponse body

200 - OK

VolumePopulator schema

401 - Unauthorized

Empty
HTTP method

PATCH

Description

partially update the specified VolumePopulator

Table 10. 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 11. HTTP responses
HTTP code Reponse body

200 - OK

VolumePopulator schema

401 - Unauthorized

Empty
HTTP method

PUT

Description

replace the specified VolumePopulator

Table 12. 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 13. Body parameters
Parameter Type Description

body

VolumePopulator schema
Table 14. HTTP responses
HTTP code Reponse body

200 - OK

VolumePopulator schema

201 - Created

VolumePopulator schema

401 - Unauthorized

Empty