All URIs are relative to http://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} | |
GetClusterCustomObjectScale | Get /apis/{group}/{version}/{plural}/{name}/scale | |
GetClusterCustomObjectStatus | Get /apis/{group}/{version}/{plural}/{name}/status | |
GetNamespacedCustomObject | Get /apis/{group}/{version}/namespaces/{namespace}/{plural}/{name} | |
GetNamespacedCustomObjectScale | Get /apis/{group}/{version}/namespaces/{namespace}/{plural}/{name}/scale | |
GetNamespacedCustomObjectStatus | Get /apis/{group}/{version}/namespaces/{namespace}/{plural}/{name}/status | |
ListClusterCustomObject | Get /apis/{group}/{version}/{plural} | |
ListNamespacedCustomObject | Get /apis/{group}/{version}/namespaces/{namespace}/{plural} | |
PatchClusterCustomObject | Patch /apis/{group}/{version}/{plural}/{name} | |
PatchClusterCustomObjectScale | Patch /apis/{group}/{version}/{plural}/{name}/scale | |
PatchClusterCustomObjectStatus | Patch /apis/{group}/{version}/{plural}/{name}/status | |
PatchNamespacedCustomObject | Patch /apis/{group}/{version}/namespaces/{namespace}/{plural}/{name} | |
PatchNamespacedCustomObjectScale | Patch /apis/{group}/{version}/namespaces/{namespace}/{plural}/{name}/scale | |
PatchNamespacedCustomObjectStatus | Patch /apis/{group}/{version}/namespaces/{namespace}/{plural}/{name}/status | |
ReplaceClusterCustomObject | Put /apis/{group}/{version}/{plural}/{name} | |
ReplaceClusterCustomObjectScale | Put /apis/{group}/{version}/{plural}/{name}/scale | |
ReplaceClusterCustomObjectStatus | Put /apis/{group}/{version}/{plural}/{name}/status | |
ReplaceNamespacedCustomObject | Put /apis/{group}/{version}/namespaces/{namespace}/{plural}/{name} | |
ReplaceNamespacedCustomObjectScale | Put /apis/{group}/{version}/namespaces/{namespace}/{plural}/{name}/scale | |
ReplaceNamespacedCustomObjectStatus | Put /apis/{group}/{version}/namespaces/{namespace}/{plural}/{name}/status |
map[string]interface{} CreateClusterCustomObject(ctx, group, version, plural, body, optional)
Creates a cluster scoped Custom object
Name | Type | Description | Notes |
---|---|---|---|
ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, 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 | UNKNOWN_BASE_TYPE | The JSON schema of the Resource to create. | |
optional | *CreateClusterCustomObjectOpts | optional parameters | nil if no parameters |
Optional parameters are passed through a pointer to a CreateClusterCustomObjectOpts struct
Name | Type | Description | Notes |
---|
pretty | optional.String| If 'true', then the output is pretty printed. |
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
map[string]interface{} CreateNamespacedCustomObject(ctx, group, version, namespace, plural, body, optional)
Creates a namespace scoped Custom object
Name | Type | Description | Notes |
---|---|---|---|
ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, 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 | UNKNOWN_BASE_TYPE | The JSON schema of the Resource to create. | |
optional | *CreateNamespacedCustomObjectOpts | optional parameters | nil if no parameters |
Optional parameters are passed through a pointer to a CreateNamespacedCustomObjectOpts struct
Name | Type | Description | Notes |
---|
pretty | optional.String| If 'true', then the output is pretty printed. |
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
map[string]interface{} DeleteClusterCustomObject(ctx, group, version, plural, name, body, optional)
Deletes the specified cluster scoped custom object
Name | Type | Description | Notes |
---|---|---|---|
ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, 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 | *DeleteClusterCustomObjectOpts | optional parameters | nil if no parameters |
Optional parameters are passed through a pointer to a DeleteClusterCustomObjectOpts struct
Name | Type | Description | Notes |
---|
gracePeriodSeconds | optional.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 | optional.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 | optional.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. |
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
map[string]interface{} DeleteNamespacedCustomObject(ctx, group, version, namespace, plural, name, body, optional)
Deletes the specified namespace scoped custom object
Name | Type | Description | Notes |
---|---|---|---|
ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, 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 | *DeleteNamespacedCustomObjectOpts | optional parameters | nil if no parameters |
Optional parameters are passed through a pointer to a DeleteNamespacedCustomObjectOpts struct
Name | Type | Description | Notes |
---|
gracePeriodSeconds | optional.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 | optional.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 | optional.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. |
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
map[string]interface{} GetClusterCustomObject(ctx, group, version, plural, name)
Returns a cluster scoped custom object
Name | Type | Description | Notes |
---|---|---|---|
ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, 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 |
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
map[string]interface{} GetClusterCustomObjectScale(ctx, group, version, plural, name)
read scale of the specified custom object
Name | Type | Description | Notes |
---|---|---|---|
ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
group | string | the custom resource's group | |
version | string | the custom resource's version | |
plural | string | the custom resource's plural name. For TPRs this would be lowercase plural kind. | |
name | string | the custom object's name |
- Content-Type: Not defined
- Accept: application/json, application/yaml, application/vnd.kubernetes.protobuf
[Back to top] [Back to API list] [Back to Model list] [Back to README]
map[string]interface{} GetClusterCustomObjectStatus(ctx, group, version, plural, name)
read status of the specified cluster scoped custom object
Name | Type | Description | Notes |
---|---|---|---|
ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
group | string | the custom resource's group | |
version | string | the custom resource's version | |
plural | string | the custom resource's plural name. For TPRs this would be lowercase plural kind. | |
name | string | the custom object's name |
- Content-Type: Not defined
- Accept: application/json, application/yaml, application/vnd.kubernetes.protobuf
[Back to top] [Back to API list] [Back to Model list] [Back to README]
map[string]interface{} GetNamespacedCustomObject(ctx, group, version, namespace, plural, name)
Returns a namespace scoped custom object
Name | Type | Description | Notes |
---|---|---|---|
ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, 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 |
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
map[string]interface{} GetNamespacedCustomObjectScale(ctx, group, version, namespace, plural, name)
read scale of the specified namespace scoped custom object
Name | Type | Description | Notes |
---|---|---|---|
ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, 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 |
- Content-Type: Not defined
- Accept: application/json, application/yaml, application/vnd.kubernetes.protobuf
[Back to top] [Back to API list] [Back to Model list] [Back to README]
map[string]interface{} GetNamespacedCustomObjectStatus(ctx, group, version, namespace, plural, name)
read status of the specified namespace scoped custom object
Name | Type | Description | Notes |
---|---|---|---|
ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, 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 |
- Content-Type: Not defined
- Accept: application/json, application/yaml, application/vnd.kubernetes.protobuf
[Back to top] [Back to API list] [Back to Model list] [Back to README]
map[string]interface{} ListClusterCustomObject(ctx, group, version, plural, optional)
list or watch cluster scoped custom objects
Name | Type | Description | Notes |
---|---|---|---|
ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, 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 | *ListClusterCustomObjectOpts | optional parameters | nil if no parameters |
Optional parameters are passed through a pointer to a ListClusterCustomObjectOpts struct
Name | Type | Description | Notes |
---|
pretty | optional.String| If 'true', then the output is pretty printed. | fieldSelector | optional.String| A selector to restrict the list of returned objects by their fields. Defaults to everything. | labelSelector | optional.String| A selector to restrict the list of returned objects by their labels. Defaults to everything. | resourceVersion | optional.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. | timeoutSeconds | optional.Int32| Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | watch | optional.Bool| Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. |
- Content-Type: Not defined
- Accept: application/json, application/json;stream=watch
[Back to top] [Back to API list] [Back to Model list] [Back to README]
map[string]interface{} ListNamespacedCustomObject(ctx, group, version, namespace, plural, optional)
list or watch namespace scoped custom objects
Name | Type | Description | Notes |
---|---|---|---|
ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, 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 | *ListNamespacedCustomObjectOpts | optional parameters | nil if no parameters |
Optional parameters are passed through a pointer to a ListNamespacedCustomObjectOpts struct
Name | Type | Description | Notes |
---|
pretty | optional.String| If 'true', then the output is pretty printed. | fieldSelector | optional.String| A selector to restrict the list of returned objects by their fields. Defaults to everything. | labelSelector | optional.String| A selector to restrict the list of returned objects by their labels. Defaults to everything. | resourceVersion | optional.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. | timeoutSeconds | optional.Int32| Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | watch | optional.Bool| Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. |
- Content-Type: Not defined
- Accept: application/json, application/json;stream=watch
[Back to top] [Back to API list] [Back to Model list] [Back to README]
map[string]interface{} PatchClusterCustomObject(ctx, group, version, plural, name, body)
patch the specified cluster scoped custom object
Name | Type | Description | Notes |
---|---|---|---|
ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, 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 | UNKNOWN_BASE_TYPE | The JSON schema of the Resource to patch. |
- Content-Type: application/merge-patch+json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
map[string]interface{} PatchClusterCustomObjectScale(ctx, group, version, plural, name, body)
partially update scale of the specified cluster scoped custom object
Name | Type | Description | Notes |
---|---|---|---|
ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
group | string | the custom resource's group | |
version | string | the custom resource's version | |
plural | string | the custom resource's plural name. For TPRs this would be lowercase plural kind. | |
name | string | the custom object's name | |
body | UNKNOWN_BASE_TYPE |
- Content-Type: application/merge-patch+json
- Accept: application/json, application/yaml, application/vnd.kubernetes.protobuf
[Back to top] [Back to API list] [Back to Model list] [Back to README]
map[string]interface{} PatchClusterCustomObjectStatus(ctx, group, version, plural, name, body)
partially update status of the specified cluster scoped custom object
Name | Type | Description | Notes |
---|---|---|---|
ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
group | string | the custom resource's group | |
version | string | the custom resource's version | |
plural | string | the custom resource's plural name. For TPRs this would be lowercase plural kind. | |
name | string | the custom object's name | |
body | UNKNOWN_BASE_TYPE |
- Content-Type: application/merge-patch+json
- Accept: application/json, application/yaml, application/vnd.kubernetes.protobuf
[Back to top] [Back to API list] [Back to Model list] [Back to README]
map[string]interface{} PatchNamespacedCustomObject(ctx, group, version, namespace, plural, name, body)
patch the specified namespace scoped custom object
Name | Type | Description | Notes |
---|---|---|---|
ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, 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 | UNKNOWN_BASE_TYPE | The JSON schema of the Resource to patch. |
- Content-Type: application/merge-patch+json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
map[string]interface{} PatchNamespacedCustomObjectScale(ctx, group, version, namespace, plural, name, body)
partially update scale of the specified namespace scoped custom object
Name | Type | Description | Notes |
---|---|---|---|
ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, 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 | UNKNOWN_BASE_TYPE |
- Content-Type: application/merge-patch+json
- Accept: application/json, application/yaml, application/vnd.kubernetes.protobuf
[Back to top] [Back to API list] [Back to Model list] [Back to README]
map[string]interface{} PatchNamespacedCustomObjectStatus(ctx, group, version, namespace, plural, name, body)
partially update status of the specified namespace scoped custom object
Name | Type | Description | Notes |
---|---|---|---|
ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, 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 | UNKNOWN_BASE_TYPE |
- Content-Type: application/merge-patch+json
- Accept: application/json, application/yaml, application/vnd.kubernetes.protobuf
[Back to top] [Back to API list] [Back to Model list] [Back to README]
map[string]interface{} ReplaceClusterCustomObject(ctx, group, version, plural, name, body)
replace the specified cluster scoped custom object
Name | Type | Description | Notes |
---|---|---|---|
ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, 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 | UNKNOWN_BASE_TYPE | The JSON schema of the Resource to replace. |
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
map[string]interface{} ReplaceClusterCustomObjectScale(ctx, group, version, plural, name, body)
replace scale of the specified cluster scoped custom object
Name | Type | Description | Notes |
---|---|---|---|
ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
group | string | the custom resource's group | |
version | string | the custom resource's version | |
plural | string | the custom resource's plural name. For TPRs this would be lowercase plural kind. | |
name | string | the custom object's name | |
body | UNKNOWN_BASE_TYPE |
- Content-Type: Not defined
- Accept: application/json, application/yaml, application/vnd.kubernetes.protobuf
[Back to top] [Back to API list] [Back to Model list] [Back to README]
map[string]interface{} ReplaceClusterCustomObjectStatus(ctx, group, version, plural, name, body)
replace status of the cluster scoped specified custom object
Name | Type | Description | Notes |
---|---|---|---|
ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
group | string | the custom resource's group | |
version | string | the custom resource's version | |
plural | string | the custom resource's plural name. For TPRs this would be lowercase plural kind. | |
name | string | the custom object's name | |
body | UNKNOWN_BASE_TYPE |
- Content-Type: Not defined
- Accept: application/json, application/yaml, application/vnd.kubernetes.protobuf
[Back to top] [Back to API list] [Back to Model list] [Back to README]
map[string]interface{} ReplaceNamespacedCustomObject(ctx, group, version, namespace, plural, name, body)
replace the specified namespace scoped custom object
Name | Type | Description | Notes |
---|---|---|---|
ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, 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 | UNKNOWN_BASE_TYPE | The JSON schema of the Resource to replace. |
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
map[string]interface{} ReplaceNamespacedCustomObjectScale(ctx, group, version, namespace, plural, name, body)
replace scale of the specified namespace scoped custom object
Name | Type | Description | Notes |
---|---|---|---|
ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, 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 | UNKNOWN_BASE_TYPE |
- Content-Type: Not defined
- Accept: application/json, application/yaml, application/vnd.kubernetes.protobuf
[Back to top] [Back to API list] [Back to Model list] [Back to README]
map[string]interface{} ReplaceNamespacedCustomObjectStatus(ctx, group, version, namespace, plural, name, body)
replace status of the specified namespace scoped custom object
Name | Type | Description | Notes |
---|---|---|---|
ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, 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 | UNKNOWN_BASE_TYPE |
- Content-Type: Not defined
- Accept: application/json, application/yaml, application/vnd.kubernetes.protobuf
[Back to top] [Back to API list] [Back to Model list] [Back to README]