BMCEventSubscription [metal3.io/v1alpha1]
Description
BMCEventSubscription is the Schema for the fast eventing API
Type
object
Specification
Property | Type | Description |
---|---|---|
|
| 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 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 |
| Standard object’s metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata | |
|
| |
|
|
.spec
Description
Type
object
Property | Type | Description |
---|---|---|
|
| Arbitrary user-provided context for the event |
|
| A webhook URL to send events to |
|
| A reference to a BareMetalHost |
|
| A secret containing HTTP headers which should be passed along to the Destination when making a request |
.spec.httpHeadersRef
Description
A secret containing HTTP headers which should be passed along to the Destination when making a request
Type
object
Property | Type | Description |
---|---|---|
|
| name is unique within a namespace to reference a secret resource. |
|
| namespace defines the space within which the secret name must be unique. |
.status
Description
Type
object
Property | Type | Description |
---|---|---|
|
| |
|
|
API endpoints
The following API endpoints are available:
/apis/metal3.io/v1alpha1/bmceventsubscriptions
GET
: list objects of kind BMCEventSubscription
/apis/metal3.io/v1alpha1/namespaces/{namespace}/bmceventsubscriptions
DELETE
: delete collection of BMCEventSubscriptionGET
: list objects of kind BMCEventSubscriptionPOST
: create a BMCEventSubscription
/apis/metal3.io/v1alpha1/namespaces/{namespace}/bmceventsubscriptions/{name}
DELETE
: delete a BMCEventSubscriptionGET
: read the specified BMCEventSubscriptionPATCH
: partially update the specified BMCEventSubscriptionPUT
: replace the specified BMCEventSubscription
/apis/metal3.io/v1alpha1/namespaces/{namespace}/bmceventsubscriptions/{name}/status
GET
: read status of the specified BMCEventSubscriptionPATCH
: partially update status of the specified BMCEventSubscriptionPUT
: replace status of the specified BMCEventSubscription
/apis/metal3.io/v1alpha1/bmceventsubscriptions
HTTP method
GET
Description
list objects of kind BMCEventSubscription
HTTP code | Reponse body |
---|---|
200 - OK | BMCEventSubscriptionList schema |
401 - Unauthorized | Empty |
/apis/metal3.io/v1alpha1/namespaces/{namespace}/bmceventsubscriptions
HTTP method
DELETE
Description
delete collection of BMCEventSubscription
HTTP code | Reponse body |
---|---|
200 - OK | Status schema |
401 - Unauthorized | Empty |
HTTP method
GET
Description
list objects of kind BMCEventSubscription
HTTP code | Reponse body |
---|---|
200 - OK | BMCEventSubscriptionList schema |
401 - Unauthorized | Empty |
HTTP method
POST
Description
create a BMCEventSubscription
Parameter | Type | Description |
---|---|---|
|
| 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 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. |
Parameter | Type | Description |
---|---|---|
| BMCEventSubscription schema |
HTTP code | Reponse body |
---|---|
200 - OK | BMCEventSubscription schema |
201 - Created | BMCEventSubscription schema |
202 - Accepted | BMCEventSubscription schema |
401 - Unauthorized | Empty |
/apis/metal3.io/v1alpha1/namespaces/{namespace}/bmceventsubscriptions/{name}
Parameter | Type | Description |
---|---|---|
|
| name of the BMCEventSubscription |
HTTP method
DELETE
Description
delete a BMCEventSubscription
Parameter | Type | Description |
---|---|---|
|
| 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 |
HTTP code | Reponse body |
---|---|
200 - OK | Status schema |
202 - Accepted | Status schema |
401 - Unauthorized | Empty |
HTTP method
GET
Description
read the specified BMCEventSubscription
HTTP code | Reponse body |
---|---|
200 - OK | BMCEventSubscription schema |
401 - Unauthorized | Empty |
HTTP method
PATCH
Description
partially update the specified BMCEventSubscription
Parameter | Type | Description |
---|---|---|
|
| 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 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 code | Reponse body |
---|---|
200 - OK | BMCEventSubscription schema |
401 - Unauthorized | Empty |
HTTP method
PUT
Description
replace the specified BMCEventSubscription
Parameter | Type | Description |
---|---|---|
|
| 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 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. |
Parameter | Type | Description |
---|---|---|
| BMCEventSubscription schema |
HTTP code | Reponse body |
---|---|
200 - OK | BMCEventSubscription schema |
201 - Created | BMCEventSubscription schema |
401 - Unauthorized | Empty |
/apis/metal3.io/v1alpha1/namespaces/{namespace}/bmceventsubscriptions/{name}/status
Parameter | Type | Description |
---|---|---|
|
| name of the BMCEventSubscription |
HTTP method
GET
Description
read status of the specified BMCEventSubscription
HTTP code | Reponse body |
---|---|
200 - OK | BMCEventSubscription schema |
401 - Unauthorized | Empty |
HTTP method
PATCH
Description
partially update status of the specified BMCEventSubscription
Parameter | Type | Description |
---|---|---|
|
| 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 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 code | Reponse body |
---|---|
200 - OK | BMCEventSubscription schema |
401 - Unauthorized | Empty |
HTTP method
PUT
Description
replace status of the specified BMCEventSubscription
Parameter | Type | Description |
---|---|---|
|
| 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 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. |
Parameter | Type | Description |
---|---|---|
| BMCEventSubscription schema |
HTTP code | Reponse body |
---|---|
200 - OK | BMCEventSubscription schema |
201 - Created | BMCEventSubscription schema |
401 - Unauthorized | Empty |