\CustomObjectsApi

All URIs are relative to https://localhost

Method	HTTP request	Description
CreateClusterCustomObject	Post /apis/{group}/{version}/{plural}
CreateNamespacedCustomObject	Post /apis/{group}/{version}/namespaces/{namespace}/{plural}
DeleteClusterCustomObject	Delete /apis/{group}/{version}/{plural}/{name}
DeleteNamespacedCustomObject	Delete /apis/{group}/{version}/namespaces/{namespace}/{plural}/{name}
GetClusterCustomObject	Get /apis/{group}/{version}/{plural}/{name}
GetNamespacedCustomObject	Get /apis/{group}/{version}/namespaces/{namespace}/{plural}/{name}
ListClusterCustomObject	Get /apis/{group}/{version}/{plural}
ListNamespacedCustomObject	Get /apis/{group}/{version}/namespaces/{namespace}/{plural}
PatchClusterCustomObject	Patch /apis/{group}/{version}/{plural}/{name}
PatchNamespacedCustomObject	Patch /apis/{group}/{version}/namespaces/{namespace}/{plural}/{name}
ReplaceClusterCustomObject	Put /apis/{group}/{version}/{plural}/{name}
ReplaceNamespacedCustomObject	Put /apis/{group}/{version}/namespaces/{namespace}/{plural}/{name}

CreateClusterCustomObject

interface{} CreateClusterCustomObject(ctx, group, version, plural, body, optional)

Creates a cluster scoped Custom object

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for logging, tracing, authentication, etc.
group	string	The custom resource's group name
version	string	The custom resource's version
plural	string	The custom resource's plural name. For TPRs this would be lowercase plural kind.
body	interface{}	The JSON schema of the Resource to create.
optional	map[string]interface{}	optional parameters	nil if no parameters

Optional Parameters

Optional parameters are passed through a map[string]interface{}.

Name	Type	Description
group	string	The custom resource's group name
version	string	The custom resource's version
plural	string	The custom resource's plural name. For TPRs this would be lowercase plural kind.
body	interface{}	The JSON schema of the Resource to create.
pretty	string	If 'true', then the output is pretty printed.

Return type

interface{}

Authorization

BearerToken

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

CreateNamespacedCustomObject

interface{} CreateNamespacedCustomObject(ctx, group, version, namespace, plural, body, optional)

Creates a namespace scoped Custom object

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for logging, tracing, authentication, etc.
group	string	The custom resource's group name
version	string	The custom resource's version
namespace	string	The custom resource's namespace
plural	string	The custom resource's plural name. For TPRs this would be lowercase plural kind.
body	interface{}	The JSON schema of the Resource to create.
optional	map[string]interface{}	optional parameters	nil if no parameters

Optional Parameters

Optional parameters are passed through a map[string]interface{}.

Name	Type	Description
group	string	The custom resource's group name
version	string	The custom resource's version
namespace	string	The custom resource's namespace
plural	string	The custom resource's plural name. For TPRs this would be lowercase plural kind.
body	interface{}	The JSON schema of the Resource to create.
pretty	string	If 'true', then the output is pretty printed.

Return type

interface{}

Authorization

BearerToken

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

DeleteClusterCustomObject

interface{} DeleteClusterCustomObject(ctx, group, version, plural, name, body, optional)

Deletes the specified cluster scoped custom object

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for logging, tracing, authentication, etc.
group	string	the custom resource's group
version	string	the custom resource's version
plural	string	the custom object's plural name. For TPRs this would be lowercase plural kind.
name	string	the custom object's name
body	V1DeleteOptions
optional	map[string]interface{}	optional parameters	nil if no parameters

Optional Parameters

Optional parameters are passed through a map[string]interface{}.

Name	Type	Description
group	string	the custom resource's group
version	string	the custom resource's version
plural	string	the custom object's plural name. For TPRs this would be lowercase plural kind.
name	string	the custom object's name
body	V1DeleteOptions
gracePeriodSeconds	int32	The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.
orphanDependents	bool	Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
propagationPolicy	string	Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy.

Return type

interface{}

Authorization

BearerToken

HTTP request headers

Content-Type: /
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

DeleteNamespacedCustomObject

interface{} DeleteNamespacedCustomObject(ctx, group, version, namespace, plural, name, body, optional)

Deletes the specified namespace scoped custom object

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for logging, tracing, authentication, etc.
group	string	the custom resource's group
version	string	the custom resource's version
namespace	string	The custom resource's namespace
plural	string	the custom resource's plural name. For TPRs this would be lowercase plural kind.
name	string	the custom object's name
body	V1DeleteOptions
optional	map[string]interface{}	optional parameters	nil if no parameters

Optional Parameters

Optional parameters are passed through a map[string]interface{}.

Name	Type	Description
group	string	the custom resource's group
version	string	the custom resource's version
namespace	string	The custom resource's namespace
plural	string	the custom resource's plural name. For TPRs this would be lowercase plural kind.
name	string	the custom object's name
body	V1DeleteOptions
gracePeriodSeconds	int32	The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.
orphanDependents	bool	Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
propagationPolicy	string	Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy.

Return type

interface{}

Authorization

BearerToken

HTTP request headers

Content-Type: /
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetClusterCustomObject

interface{} GetClusterCustomObject(ctx, group, version, plural, name)

Returns a cluster scoped custom object

Required Parameters

Name	Type	Description
ctx	context.Context	context for logging, tracing, authentication, etc.
group	string	the custom resource's group
version	string	the custom resource's version
plural	string	the custom object's plural name. For TPRs this would be lowercase plural kind.
name	string	the custom object's name

Return type

interface{}

Authorization

BearerToken

HTTP request headers

Content-Type: /
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetNamespacedCustomObject

interface{} GetNamespacedCustomObject(ctx, group, version, namespace, plural, name)

Returns a namespace scoped custom object

Required Parameters

Name	Type	Description
ctx	context.Context	context for logging, tracing, authentication, etc.
group	string	the custom resource's group
version	string	the custom resource's version
namespace	string	The custom resource's namespace
plural	string	the custom resource's plural name. For TPRs this would be lowercase plural kind.
name	string	the custom object's name

Return type

interface{}

Authorization

BearerToken

HTTP request headers

Content-Type: /
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ListClusterCustomObject

interface{} ListClusterCustomObject(ctx, group, version, plural, optional)

list or watch cluster scoped custom objects

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for logging, tracing, authentication, etc.
group	string	The custom resource's group name
version	string	The custom resource's version
plural	string	The custom resource's plural name. For TPRs this would be lowercase plural kind.
optional	map[string]interface{}	optional parameters	nil if no parameters

Optional Parameters

Optional parameters are passed through a map[string]interface{}.

Name	Type	Description
group	string	The custom resource's group name
version	string	The custom resource's version
plural	string	The custom resource's plural name. For TPRs this would be lowercase plural kind.
pretty	string	If 'true', then the output is pretty printed.
labelSelector	string	A selector to restrict the list of returned objects by their labels. Defaults to everything.
resourceVersion	string	When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
watch	bool	Watch for changes to the described resources and return them as a stream of add, update, and remove notifications.

Return type

interface{}

Authorization

BearerToken

HTTP request headers

Content-Type: /
Accept: application/json, application/json;stream=watch

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ListNamespacedCustomObject

interface{} ListNamespacedCustomObject(ctx, group, version, namespace, plural, optional)

list or watch namespace scoped custom objects

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for logging, tracing, authentication, etc.
group	string	The custom resource's group name
version	string	The custom resource's version
namespace	string	The custom resource's namespace
plural	string	The custom resource's plural name. For TPRs this would be lowercase plural kind.
optional	map[string]interface{}	optional parameters	nil if no parameters

Optional Parameters

Optional parameters are passed through a map[string]interface{}.

Name	Type	Description
group	string	The custom resource's group name
version	string	The custom resource's version
namespace	string	The custom resource's namespace
plural	string	The custom resource's plural name. For TPRs this would be lowercase plural kind.
pretty	string	If 'true', then the output is pretty printed.
labelSelector	string	A selector to restrict the list of returned objects by their labels. Defaults to everything.
resourceVersion	string	When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
watch	bool	Watch for changes to the described resources and return them as a stream of add, update, and remove notifications.

Return type

interface{}

Authorization

BearerToken

HTTP request headers

Content-Type: /
Accept: application/json, application/json;stream=watch

[Back to top] [Back to API list] [Back to Model list] [Back to README]

PatchClusterCustomObject

interface{} PatchClusterCustomObject(ctx, group, version, plural, name, body)

patch the specified cluster scoped custom object

Required Parameters

Name	Type	Description
ctx	context.Context	context for logging, tracing, authentication, etc.
group	string	the custom resource's group
version	string	the custom resource's version
plural	string	the custom object's plural name. For TPRs this would be lowercase plural kind.
name	string	the custom object's name
body	interface{}	The JSON schema of the Resource to patch.

Return type

interface{}

Authorization

BearerToken

HTTP request headers

Content-Type: application/merge-patch+json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

PatchNamespacedCustomObject

interface{} PatchNamespacedCustomObject(ctx, group, version, namespace, plural, name, body)

patch the specified namespace scoped custom object

Required Parameters

Name	Type	Description
ctx	context.Context	context for logging, tracing, authentication, etc.
group	string	the custom resource's group
version	string	the custom resource's version
namespace	string	The custom resource's namespace
plural	string	the custom resource's plural name. For TPRs this would be lowercase plural kind.
name	string	the custom object's name
body	interface{}	The JSON schema of the Resource to patch.

Return type

interface{}

Authorization

BearerToken

HTTP request headers

Content-Type: application/merge-patch+json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ReplaceClusterCustomObject

interface{} ReplaceClusterCustomObject(ctx, group, version, plural, name, body)

replace the specified cluster scoped custom object

Required Parameters

Name	Type	Description
ctx	context.Context	context for logging, tracing, authentication, etc.
group	string	the custom resource's group
version	string	the custom resource's version
plural	string	the custom object's plural name. For TPRs this would be lowercase plural kind.
name	string	the custom object's name
body	interface{}	The JSON schema of the Resource to replace.

Return type

interface{}

Authorization

BearerToken

HTTP request headers

Content-Type: /
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ReplaceNamespacedCustomObject

interface{} ReplaceNamespacedCustomObject(ctx, group, version, namespace, plural, name, body)

replace the specified namespace scoped custom object

Required Parameters

Name	Type	Description
ctx	context.Context	context for logging, tracing, authentication, etc.
group	string	the custom resource's group
version	string	the custom resource's version
namespace	string	The custom resource's namespace
plural	string	the custom resource's plural name. For TPRs this would be lowercase plural kind.
name	string	the custom object's name
body	interface{}	The JSON schema of the Resource to replace.

Return type

interface{}

Authorization

BearerToken

HTTP request headers

Content-Type: /
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Files

CustomObjectsApi.md

Latest commit

History

CustomObjectsApi.md

File metadata and controls

\CustomObjectsApi

CreateClusterCustomObject

Required Parameters

Optional Parameters

Return type

Authorization

HTTP request headers

CreateNamespacedCustomObject

Required Parameters

Optional Parameters

Return type

Authorization

HTTP request headers

DeleteClusterCustomObject

Required Parameters

Optional Parameters

Return type

Authorization

HTTP request headers

DeleteNamespacedCustomObject

Required Parameters

Optional Parameters

Return type

Authorization

HTTP request headers

GetClusterCustomObject

Required Parameters

Return type

Authorization

HTTP request headers

GetNamespacedCustomObject

Required Parameters

Return type

Authorization

HTTP request headers

ListClusterCustomObject

Required Parameters

Optional Parameters

Return type

Authorization

HTTP request headers

ListNamespacedCustomObject

Required Parameters

Optional Parameters

Return type

Authorization

HTTP request headers

PatchClusterCustomObject

Required Parameters

Return type

Authorization

HTTP request headers

PatchNamespacedCustomObject

Required Parameters

Return type

Authorization

HTTP request headers

ReplaceClusterCustomObject

Required Parameters

Return type

Authorization

HTTP request headers

ReplaceNamespacedCustomObject

Required Parameters

Return type

Authorization

HTTP request headers