Search

Chapter 2. BrokerTemplateInstance [template.openshift.io/v1]

download PDF
Description

BrokerTemplateInstance holds the service broker-related state associated with a TemplateInstance. BrokerTemplateInstance is part of an experimental API.

Compatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).

Type
object
Required
  • spec

2.1. Specification

PropertyTypeDescription

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

metadata is the standard object’s metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

spec

object

BrokerTemplateInstanceSpec describes the state of a BrokerTemplateInstance.

2.1.1. .spec

Description
BrokerTemplateInstanceSpec describes the state of a BrokerTemplateInstance.
Type
object
Required
  • templateInstance
  • secret
PropertyTypeDescription

bindingIDs

array (string)

bindingids is a list of 'binding_id’s provided during successive bind calls to the template service broker.

secret

ObjectReference

secret is a reference to a Secret object residing in a namespace, containing the necessary template parameters.

templateInstance

ObjectReference

templateinstance is a reference to a TemplateInstance object residing in a namespace.

2.2. API endpoints

The following API endpoints are available:

  • /apis/template.openshift.io/v1/brokertemplateinstances

    • DELETE: delete collection of BrokerTemplateInstance
    • GET: list or watch objects of kind BrokerTemplateInstance
    • POST: create a BrokerTemplateInstance
  • /apis/template.openshift.io/v1/watch/brokertemplateinstances

    • GET: watch individual changes to a list of BrokerTemplateInstance. deprecated: use the 'watch' parameter with a list operation instead.
  • /apis/template.openshift.io/v1/brokertemplateinstances/{name}

    • DELETE: delete a BrokerTemplateInstance
    • GET: read the specified BrokerTemplateInstance
    • PATCH: partially update the specified BrokerTemplateInstance
    • PUT: replace the specified BrokerTemplateInstance
  • /apis/template.openshift.io/v1/watch/brokertemplateinstances/{name}

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

2.2.1. /apis/template.openshift.io/v1/brokertemplateinstances

HTTP method
DELETE
Description
delete collection of BrokerTemplateInstance
Table 2.1. Query parameters
ParameterTypeDescription

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 2.2. HTTP responses
HTTP codeReponse body

200 - OK

Status schema

401 - Unauthorized

Empty

HTTP method
GET
Description
list or watch objects of kind BrokerTemplateInstance
Table 2.3. HTTP responses
HTTP codeReponse body

200 - OK

BrokerTemplateInstanceList schema

401 - Unauthorized

Empty

HTTP method
POST
Description
create a BrokerTemplateInstance
Table 2.4. Query parameters
ParameterTypeDescription

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 2.5. Body parameters
ParameterTypeDescription

body

BrokerTemplateInstance schema

 
Table 2.6. HTTP responses
HTTP codeReponse body

200 - OK

BrokerTemplateInstance schema

201 - Created

BrokerTemplateInstance schema

202 - Accepted

BrokerTemplateInstance schema

401 - Unauthorized

Empty

2.2.2. /apis/template.openshift.io/v1/watch/brokertemplateinstances

HTTP method
GET
Description
watch individual changes to a list of BrokerTemplateInstance. deprecated: use the 'watch' parameter with a list operation instead.
Table 2.7. HTTP responses
HTTP codeReponse body

200 - OK

WatchEvent schema

401 - Unauthorized

Empty

2.2.3. /apis/template.openshift.io/v1/brokertemplateinstances/{name}

Table 2.8. Global path parameters
ParameterTypeDescription

name

string

name of the BrokerTemplateInstance

HTTP method
DELETE
Description
delete a BrokerTemplateInstance
Table 2.9. Query parameters
ParameterTypeDescription

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 2.10. HTTP responses
HTTP codeReponse body

200 - OK

Status schema

202 - Accepted

Status schema

401 - Unauthorized

Empty

HTTP method
GET
Description
read the specified BrokerTemplateInstance
Table 2.11. HTTP responses
HTTP codeReponse body

200 - OK

BrokerTemplateInstance schema

401 - Unauthorized

Empty

HTTP method
PATCH
Description
partially update the specified BrokerTemplateInstance
Table 2.12. Query parameters
ParameterTypeDescription

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 2.13. HTTP responses
HTTP codeReponse body

200 - OK

BrokerTemplateInstance schema

201 - Created

BrokerTemplateInstance schema

401 - Unauthorized

Empty

HTTP method
PUT
Description
replace the specified BrokerTemplateInstance
Table 2.14. Query parameters
ParameterTypeDescription

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 2.15. Body parameters
ParameterTypeDescription

body

BrokerTemplateInstance schema

 
Table 2.16. HTTP responses
HTTP codeReponse body

200 - OK

BrokerTemplateInstance schema

201 - Created

BrokerTemplateInstance schema

401 - Unauthorized

Empty

2.2.4. /apis/template.openshift.io/v1/watch/brokertemplateinstances/{name}

Table 2.17. Global path parameters
ParameterTypeDescription

name

string

name of the BrokerTemplateInstance

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

200 - OK

WatchEvent schema

401 - Unauthorized

Empty

Red Hat logoGithubRedditYoutubeTwitter

Learn

Try, buy, & sell

Communities

About Red Hat Documentation

We help Red Hat users innovate and achieve their goals with our products and services with content they can trust.

Making open source more inclusive

Red Hat is committed to replacing problematic language in our code, documentation, and web properties. For more details, see the Red Hat Blog.

About Red Hat

We deliver hardened solutions that make it easier for enterprises to work across platforms and environments, from the core datacenter to the network edge.

© 2024 Red Hat, Inc.