Skip to content

Latest commit

 

History

History
1634 lines (1024 loc) · 104 KB

AppsV1beta1Api.md

File metadata and controls

1634 lines (1024 loc) · 104 KB

\AppsV1beta1Api

All URIs are relative to http://localhost

Method HTTP request Description
CreateNamespacedControllerRevision Post /apis/apps/v1beta1/namespaces/{namespace}/controllerrevisions
CreateNamespacedDeployment Post /apis/apps/v1beta1/namespaces/{namespace}/deployments
CreateNamespacedDeploymentRollback Post /apis/apps/v1beta1/namespaces/{namespace}/deployments/{name}/rollback
CreateNamespacedStatefulSet Post /apis/apps/v1beta1/namespaces/{namespace}/statefulsets
DeleteCollectionNamespacedControllerRevision Delete /apis/apps/v1beta1/namespaces/{namespace}/controllerrevisions
DeleteCollectionNamespacedDeployment Delete /apis/apps/v1beta1/namespaces/{namespace}/deployments
DeleteCollectionNamespacedStatefulSet Delete /apis/apps/v1beta1/namespaces/{namespace}/statefulsets
DeleteNamespacedControllerRevision Delete /apis/apps/v1beta1/namespaces/{namespace}/controllerrevisions/{name}
DeleteNamespacedDeployment Delete /apis/apps/v1beta1/namespaces/{namespace}/deployments/{name}
DeleteNamespacedStatefulSet Delete /apis/apps/v1beta1/namespaces/{namespace}/statefulsets/{name}
GetAPIResources Get /apis/apps/v1beta1/
ListControllerRevisionForAllNamespaces Get /apis/apps/v1beta1/controllerrevisions
ListDeploymentForAllNamespaces Get /apis/apps/v1beta1/deployments
ListNamespacedControllerRevision Get /apis/apps/v1beta1/namespaces/{namespace}/controllerrevisions
ListNamespacedDeployment Get /apis/apps/v1beta1/namespaces/{namespace}/deployments
ListNamespacedStatefulSet Get /apis/apps/v1beta1/namespaces/{namespace}/statefulsets
ListStatefulSetForAllNamespaces Get /apis/apps/v1beta1/statefulsets
PatchNamespacedControllerRevision Patch /apis/apps/v1beta1/namespaces/{namespace}/controllerrevisions/{name}
PatchNamespacedDeployment Patch /apis/apps/v1beta1/namespaces/{namespace}/deployments/{name}
PatchNamespacedDeploymentScale Patch /apis/apps/v1beta1/namespaces/{namespace}/deployments/{name}/scale
PatchNamespacedDeploymentStatus Patch /apis/apps/v1beta1/namespaces/{namespace}/deployments/{name}/status
PatchNamespacedStatefulSet Patch /apis/apps/v1beta1/namespaces/{namespace}/statefulsets/{name}
PatchNamespacedStatefulSetScale Patch /apis/apps/v1beta1/namespaces/{namespace}/statefulsets/{name}/scale
PatchNamespacedStatefulSetStatus Patch /apis/apps/v1beta1/namespaces/{namespace}/statefulsets/{name}/status
ReadNamespacedControllerRevision Get /apis/apps/v1beta1/namespaces/{namespace}/controllerrevisions/{name}
ReadNamespacedDeployment Get /apis/apps/v1beta1/namespaces/{namespace}/deployments/{name}
ReadNamespacedDeploymentScale Get /apis/apps/v1beta1/namespaces/{namespace}/deployments/{name}/scale
ReadNamespacedDeploymentStatus Get /apis/apps/v1beta1/namespaces/{namespace}/deployments/{name}/status
ReadNamespacedStatefulSet Get /apis/apps/v1beta1/namespaces/{namespace}/statefulsets/{name}
ReadNamespacedStatefulSetScale Get /apis/apps/v1beta1/namespaces/{namespace}/statefulsets/{name}/scale
ReadNamespacedStatefulSetStatus Get /apis/apps/v1beta1/namespaces/{namespace}/statefulsets/{name}/status
ReplaceNamespacedControllerRevision Put /apis/apps/v1beta1/namespaces/{namespace}/controllerrevisions/{name}
ReplaceNamespacedDeployment Put /apis/apps/v1beta1/namespaces/{namespace}/deployments/{name}
ReplaceNamespacedDeploymentScale Put /apis/apps/v1beta1/namespaces/{namespace}/deployments/{name}/scale
ReplaceNamespacedDeploymentStatus Put /apis/apps/v1beta1/namespaces/{namespace}/deployments/{name}/status
ReplaceNamespacedStatefulSet Put /apis/apps/v1beta1/namespaces/{namespace}/statefulsets/{name}
ReplaceNamespacedStatefulSetScale Put /apis/apps/v1beta1/namespaces/{namespace}/statefulsets/{name}/scale
ReplaceNamespacedStatefulSetStatus Put /apis/apps/v1beta1/namespaces/{namespace}/statefulsets/{name}/status

CreateNamespacedControllerRevision

V1beta1ControllerRevision CreateNamespacedControllerRevision(ctx, namespace, body, optional)

create a ControllerRevision

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
namespace string object name and auth scope, such as for teams and projects
body V1beta1ControllerRevision
optional *CreateNamespacedControllerRevisionOpts optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a CreateNamespacedControllerRevisionOpts struct

Name Type Description Notes

includeUninitialized | optional.Bool| If true, partially initialized resources are included in the response. | pretty | optional.String| If 'true', then the output is pretty printed. | dryRun | optional.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 |

Return type

V1beta1ControllerRevision

Authorization

BearerToken

HTTP request headers

  • 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]

CreateNamespacedDeployment

AppsV1beta1Deployment CreateNamespacedDeployment(ctx, namespace, body, optional)

create a Deployment

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
namespace string object name and auth scope, such as for teams and projects
body AppsV1beta1Deployment
optional *CreateNamespacedDeploymentOpts optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a CreateNamespacedDeploymentOpts struct

Name Type Description Notes

includeUninitialized | optional.Bool| If true, partially initialized resources are included in the response. | pretty | optional.String| If 'true', then the output is pretty printed. | dryRun | optional.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 |

Return type

AppsV1beta1Deployment

Authorization

BearerToken

HTTP request headers

  • 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]

CreateNamespacedDeploymentRollback

V1Status CreateNamespacedDeploymentRollback(ctx, name, namespace, body, optional)

create rollback of a Deployment

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
name string name of the DeploymentRollback
namespace string object name and auth scope, such as for teams and projects
body AppsV1beta1DeploymentRollback
optional *CreateNamespacedDeploymentRollbackOpts optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a CreateNamespacedDeploymentRollbackOpts struct

Name Type Description Notes

dryRun | optional.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 | includeUninitialized | optional.Bool| If IncludeUninitialized is specified, the object may be returned without completing initialization. | pretty | optional.String| If 'true', then the output is pretty printed. |

Return type

V1Status

Authorization

BearerToken

HTTP request headers

  • 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]

CreateNamespacedStatefulSet

V1beta1StatefulSet CreateNamespacedStatefulSet(ctx, namespace, body, optional)

create a StatefulSet

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
namespace string object name and auth scope, such as for teams and projects
body V1beta1StatefulSet
optional *CreateNamespacedStatefulSetOpts optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a CreateNamespacedStatefulSetOpts struct

Name Type Description Notes

includeUninitialized | optional.Bool| If true, partially initialized resources are included in the response. | pretty | optional.String| If 'true', then the output is pretty printed. | dryRun | optional.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 |

Return type

V1beta1StatefulSet

Authorization

BearerToken

HTTP request headers

  • 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]

DeleteCollectionNamespacedControllerRevision

V1Status DeleteCollectionNamespacedControllerRevision(ctx, namespace, optional)

delete collection of ControllerRevision

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
namespace string object name and auth scope, such as for teams and projects
optional *DeleteCollectionNamespacedControllerRevisionOpts optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a DeleteCollectionNamespacedControllerRevisionOpts struct

Name Type Description Notes

includeUninitialized | optional.Bool| If true, partially initialized resources are included in the response. | pretty | optional.String| If 'true', then the output is pretty printed. | continue_ | optional.String| The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | 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. | limit | optional.Int32| limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | 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. Specify resourceVersion. |

Return type

V1Status

Authorization

BearerToken

HTTP request headers

  • 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]

DeleteCollectionNamespacedDeployment

V1Status DeleteCollectionNamespacedDeployment(ctx, namespace, optional)

delete collection of Deployment

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
namespace string object name and auth scope, such as for teams and projects
optional *DeleteCollectionNamespacedDeploymentOpts optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a DeleteCollectionNamespacedDeploymentOpts struct

Name Type Description Notes

includeUninitialized | optional.Bool| If true, partially initialized resources are included in the response. | pretty | optional.String| If 'true', then the output is pretty printed. | continue_ | optional.String| The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | 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. | limit | optional.Int32| limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | 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. Specify resourceVersion. |

Return type

V1Status

Authorization

BearerToken

HTTP request headers

  • 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]

DeleteCollectionNamespacedStatefulSet

V1Status DeleteCollectionNamespacedStatefulSet(ctx, namespace, optional)

delete collection of StatefulSet

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
namespace string object name and auth scope, such as for teams and projects
optional *DeleteCollectionNamespacedStatefulSetOpts optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a DeleteCollectionNamespacedStatefulSetOpts struct

Name Type Description Notes

includeUninitialized | optional.Bool| If true, partially initialized resources are included in the response. | pretty | optional.String| If 'true', then the output is pretty printed. | continue_ | optional.String| The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | 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. | limit | optional.Int32| limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | 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. Specify resourceVersion. |

Return type

V1Status

Authorization

BearerToken

HTTP request headers

  • 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]

DeleteNamespacedControllerRevision

V1Status DeleteNamespacedControllerRevision(ctx, name, namespace, optional)

delete a ControllerRevision

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
name string name of the ControllerRevision
namespace string object name and auth scope, such as for teams and projects
optional *DeleteNamespacedControllerRevisionOpts optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a DeleteNamespacedControllerRevisionOpts struct

Name Type Description Notes

pretty | optional.String| If 'true', then the output is pretty printed. | dryRun | optional.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 | 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. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground. | body | optional.Interface of V1DeleteOptions| |

Return type

V1Status

Authorization

BearerToken

HTTP request headers

  • 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]

DeleteNamespacedDeployment

V1Status DeleteNamespacedDeployment(ctx, name, namespace, optional)

delete a Deployment

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
name string name of the Deployment
namespace string object name and auth scope, such as for teams and projects
optional *DeleteNamespacedDeploymentOpts optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a DeleteNamespacedDeploymentOpts struct

Name Type Description Notes

pretty | optional.String| If 'true', then the output is pretty printed. | dryRun | optional.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 | 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. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground. | body | optional.Interface of V1DeleteOptions| |

Return type

V1Status

Authorization

BearerToken

HTTP request headers

  • 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]

DeleteNamespacedStatefulSet

V1Status DeleteNamespacedStatefulSet(ctx, name, namespace, optional)

delete a StatefulSet

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
name string name of the StatefulSet
namespace string object name and auth scope, such as for teams and projects
optional *DeleteNamespacedStatefulSetOpts optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a DeleteNamespacedStatefulSetOpts struct

Name Type Description Notes

pretty | optional.String| If 'true', then the output is pretty printed. | dryRun | optional.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 | 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. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground. | body | optional.Interface of V1DeleteOptions| |

Return type

V1Status

Authorization

BearerToken

HTTP request headers

  • 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]

GetAPIResources

V1ApiResourceList GetAPIResources(ctx, )

get available resources

Required Parameters

This endpoint does not need any parameter.

Return type

V1ApiResourceList

Authorization

BearerToken

HTTP request headers

  • 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]

ListControllerRevisionForAllNamespaces

V1beta1ControllerRevisionList ListControllerRevisionForAllNamespaces(ctx, optional)

list or watch objects of kind ControllerRevision

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
optional *ListControllerRevisionForAllNamespacesOpts optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a ListControllerRevisionForAllNamespacesOpts struct

Name Type Description Notes
continue_ optional.String The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelector optional.String A selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitialized optional.Bool If true, partially initialized resources are included in the response.
labelSelector optional.String A selector to restrict the list of returned objects by their labels. Defaults to everything.
limit optional.Int32 limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
pretty optional.String If 'true', then the output is pretty printed.
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. Specify resourceVersion.

Return type

V1beta1ControllerRevisionList

Authorization

BearerToken

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch

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

ListDeploymentForAllNamespaces

AppsV1beta1DeploymentList ListDeploymentForAllNamespaces(ctx, optional)

list or watch objects of kind Deployment

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
optional *ListDeploymentForAllNamespacesOpts optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a ListDeploymentForAllNamespacesOpts struct

Name Type Description Notes
continue_ optional.String The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelector optional.String A selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitialized optional.Bool If true, partially initialized resources are included in the response.
labelSelector optional.String A selector to restrict the list of returned objects by their labels. Defaults to everything.
limit optional.Int32 limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
pretty optional.String If 'true', then the output is pretty printed.
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. Specify resourceVersion.

Return type

AppsV1beta1DeploymentList

Authorization

BearerToken

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch

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

ListNamespacedControllerRevision

V1beta1ControllerRevisionList ListNamespacedControllerRevision(ctx, namespace, optional)

list or watch objects of kind ControllerRevision

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
namespace string object name and auth scope, such as for teams and projects
optional *ListNamespacedControllerRevisionOpts optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a ListNamespacedControllerRevisionOpts struct

Name Type Description Notes

includeUninitialized | optional.Bool| If true, partially initialized resources are included in the response. | pretty | optional.String| If 'true', then the output is pretty printed. | continue_ | optional.String| The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | 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. | limit | optional.Int32| limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | 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. Specify resourceVersion. |

Return type

V1beta1ControllerRevisionList

Authorization

BearerToken

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch

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

ListNamespacedDeployment

AppsV1beta1DeploymentList ListNamespacedDeployment(ctx, namespace, optional)

list or watch objects of kind Deployment

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
namespace string object name and auth scope, such as for teams and projects
optional *ListNamespacedDeploymentOpts optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a ListNamespacedDeploymentOpts struct

Name Type Description Notes

includeUninitialized | optional.Bool| If true, partially initialized resources are included in the response. | pretty | optional.String| If 'true', then the output is pretty printed. | continue_ | optional.String| The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | 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. | limit | optional.Int32| limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | 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. Specify resourceVersion. |

Return type

AppsV1beta1DeploymentList

Authorization

BearerToken

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch

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

ListNamespacedStatefulSet

V1beta1StatefulSetList ListNamespacedStatefulSet(ctx, namespace, optional)

list or watch objects of kind StatefulSet

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
namespace string object name and auth scope, such as for teams and projects
optional *ListNamespacedStatefulSetOpts optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a ListNamespacedStatefulSetOpts struct

Name Type Description Notes

includeUninitialized | optional.Bool| If true, partially initialized resources are included in the response. | pretty | optional.String| If 'true', then the output is pretty printed. | continue_ | optional.String| The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | 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. | limit | optional.Int32| limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | 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. Specify resourceVersion. |

Return type

V1beta1StatefulSetList

Authorization

BearerToken

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch

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

ListStatefulSetForAllNamespaces

V1beta1StatefulSetList ListStatefulSetForAllNamespaces(ctx, optional)

list or watch objects of kind StatefulSet

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
optional *ListStatefulSetForAllNamespacesOpts optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a ListStatefulSetForAllNamespacesOpts struct

Name Type Description Notes
continue_ optional.String The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelector optional.String A selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitialized optional.Bool If true, partially initialized resources are included in the response.
labelSelector optional.String A selector to restrict the list of returned objects by their labels. Defaults to everything.
limit optional.Int32 limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
pretty optional.String If 'true', then the output is pretty printed.
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. Specify resourceVersion.

Return type

V1beta1StatefulSetList

Authorization

BearerToken

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch

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

PatchNamespacedControllerRevision

V1beta1ControllerRevision PatchNamespacedControllerRevision(ctx, name, namespace, body, optional)

partially update the specified ControllerRevision

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
name string name of the ControllerRevision
namespace string object name and auth scope, such as for teams and projects
body UNKNOWN_BASE_TYPE
optional *PatchNamespacedControllerRevisionOpts optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a PatchNamespacedControllerRevisionOpts struct

Name Type Description Notes

pretty | optional.String| If 'true', then the output is pretty printed. | dryRun | optional.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 |

Return type

V1beta1ControllerRevision

Authorization

BearerToken

HTTP request headers

  • Content-Type: application/json-patch+json, application/merge-patch+json, application/strategic-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]

PatchNamespacedDeployment

AppsV1beta1Deployment PatchNamespacedDeployment(ctx, name, namespace, body, optional)

partially update the specified Deployment

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
name string name of the Deployment
namespace string object name and auth scope, such as for teams and projects
body UNKNOWN_BASE_TYPE
optional *PatchNamespacedDeploymentOpts optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a PatchNamespacedDeploymentOpts struct

Name Type Description Notes

pretty | optional.String| If 'true', then the output is pretty printed. | dryRun | optional.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 |

Return type

AppsV1beta1Deployment

Authorization

BearerToken

HTTP request headers

  • Content-Type: application/json-patch+json, application/merge-patch+json, application/strategic-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]

PatchNamespacedDeploymentScale

AppsV1beta1Scale PatchNamespacedDeploymentScale(ctx, name, namespace, body, optional)

partially update scale of the specified Deployment

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
name string name of the Scale
namespace string object name and auth scope, such as for teams and projects
body UNKNOWN_BASE_TYPE
optional *PatchNamespacedDeploymentScaleOpts optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a PatchNamespacedDeploymentScaleOpts struct

Name Type Description Notes

pretty | optional.String| If 'true', then the output is pretty printed. | dryRun | optional.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 |

Return type

AppsV1beta1Scale

Authorization

BearerToken

HTTP request headers

  • Content-Type: application/json-patch+json, application/merge-patch+json, application/strategic-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]

PatchNamespacedDeploymentStatus

AppsV1beta1Deployment PatchNamespacedDeploymentStatus(ctx, name, namespace, body, optional)

partially update status of the specified Deployment

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
name string name of the Deployment
namespace string object name and auth scope, such as for teams and projects
body UNKNOWN_BASE_TYPE
optional *PatchNamespacedDeploymentStatusOpts optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a PatchNamespacedDeploymentStatusOpts struct

Name Type Description Notes

pretty | optional.String| If 'true', then the output is pretty printed. | dryRun | optional.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 |

Return type

AppsV1beta1Deployment

Authorization

BearerToken

HTTP request headers

  • Content-Type: application/json-patch+json, application/merge-patch+json, application/strategic-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]

PatchNamespacedStatefulSet

V1beta1StatefulSet PatchNamespacedStatefulSet(ctx, name, namespace, body, optional)

partially update the specified StatefulSet

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
name string name of the StatefulSet
namespace string object name and auth scope, such as for teams and projects
body UNKNOWN_BASE_TYPE
optional *PatchNamespacedStatefulSetOpts optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a PatchNamespacedStatefulSetOpts struct

Name Type Description Notes

pretty | optional.String| If 'true', then the output is pretty printed. | dryRun | optional.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 |

Return type

V1beta1StatefulSet

Authorization

BearerToken

HTTP request headers

  • Content-Type: application/json-patch+json, application/merge-patch+json, application/strategic-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]

PatchNamespacedStatefulSetScale

AppsV1beta1Scale PatchNamespacedStatefulSetScale(ctx, name, namespace, body, optional)

partially update scale of the specified StatefulSet

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
name string name of the Scale
namespace string object name and auth scope, such as for teams and projects
body UNKNOWN_BASE_TYPE
optional *PatchNamespacedStatefulSetScaleOpts optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a PatchNamespacedStatefulSetScaleOpts struct

Name Type Description Notes

pretty | optional.String| If 'true', then the output is pretty printed. | dryRun | optional.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 |

Return type

AppsV1beta1Scale

Authorization

BearerToken

HTTP request headers

  • Content-Type: application/json-patch+json, application/merge-patch+json, application/strategic-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]

PatchNamespacedStatefulSetStatus

V1beta1StatefulSet PatchNamespacedStatefulSetStatus(ctx, name, namespace, body, optional)

partially update status of the specified StatefulSet

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
name string name of the StatefulSet
namespace string object name and auth scope, such as for teams and projects
body UNKNOWN_BASE_TYPE
optional *PatchNamespacedStatefulSetStatusOpts optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a PatchNamespacedStatefulSetStatusOpts struct

Name Type Description Notes

pretty | optional.String| If 'true', then the output is pretty printed. | dryRun | optional.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 |

Return type

V1beta1StatefulSet

Authorization

BearerToken

HTTP request headers

  • Content-Type: application/json-patch+json, application/merge-patch+json, application/strategic-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]

ReadNamespacedControllerRevision

V1beta1ControllerRevision ReadNamespacedControllerRevision(ctx, name, namespace, optional)

read the specified ControllerRevision

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
name string name of the ControllerRevision
namespace string object name and auth scope, such as for teams and projects
optional *ReadNamespacedControllerRevisionOpts optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a ReadNamespacedControllerRevisionOpts struct

Name Type Description Notes

pretty | optional.String| If 'true', then the output is pretty printed. | exact | optional.Bool| Should the export be exact. Exact export maintains cluster-specific fields like 'Namespace'. | export | optional.Bool| Should this value be exported. Export strips fields that a user can not specify. |

Return type

V1beta1ControllerRevision

Authorization

BearerToken

HTTP request headers

  • 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]

ReadNamespacedDeployment

AppsV1beta1Deployment ReadNamespacedDeployment(ctx, name, namespace, optional)

read the specified Deployment

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
name string name of the Deployment
namespace string object name and auth scope, such as for teams and projects
optional *ReadNamespacedDeploymentOpts optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a ReadNamespacedDeploymentOpts struct

Name Type Description Notes

pretty | optional.String| If 'true', then the output is pretty printed. | exact | optional.Bool| Should the export be exact. Exact export maintains cluster-specific fields like 'Namespace'. | export | optional.Bool| Should this value be exported. Export strips fields that a user can not specify. |

Return type

AppsV1beta1Deployment

Authorization

BearerToken

HTTP request headers

  • 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]

ReadNamespacedDeploymentScale

AppsV1beta1Scale ReadNamespacedDeploymentScale(ctx, name, namespace, optional)

read scale of the specified Deployment

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
name string name of the Scale
namespace string object name and auth scope, such as for teams and projects
optional *ReadNamespacedDeploymentScaleOpts optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a ReadNamespacedDeploymentScaleOpts struct

Name Type Description Notes

pretty | optional.String| If 'true', then the output is pretty printed. |

Return type

AppsV1beta1Scale

Authorization

BearerToken

HTTP request headers

  • 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]

ReadNamespacedDeploymentStatus

AppsV1beta1Deployment ReadNamespacedDeploymentStatus(ctx, name, namespace, optional)

read status of the specified Deployment

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
name string name of the Deployment
namespace string object name and auth scope, such as for teams and projects
optional *ReadNamespacedDeploymentStatusOpts optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a ReadNamespacedDeploymentStatusOpts struct

Name Type Description Notes

pretty | optional.String| If 'true', then the output is pretty printed. |

Return type

AppsV1beta1Deployment

Authorization

BearerToken

HTTP request headers

  • 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]

ReadNamespacedStatefulSet

V1beta1StatefulSet ReadNamespacedStatefulSet(ctx, name, namespace, optional)

read the specified StatefulSet

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
name string name of the StatefulSet
namespace string object name and auth scope, such as for teams and projects
optional *ReadNamespacedStatefulSetOpts optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a ReadNamespacedStatefulSetOpts struct

Name Type Description Notes

pretty | optional.String| If 'true', then the output is pretty printed. | exact | optional.Bool| Should the export be exact. Exact export maintains cluster-specific fields like 'Namespace'. | export | optional.Bool| Should this value be exported. Export strips fields that a user can not specify. |

Return type

V1beta1StatefulSet

Authorization

BearerToken

HTTP request headers

  • 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]

ReadNamespacedStatefulSetScale

AppsV1beta1Scale ReadNamespacedStatefulSetScale(ctx, name, namespace, optional)

read scale of the specified StatefulSet

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
name string name of the Scale
namespace string object name and auth scope, such as for teams and projects
optional *ReadNamespacedStatefulSetScaleOpts optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a ReadNamespacedStatefulSetScaleOpts struct

Name Type Description Notes

pretty | optional.String| If 'true', then the output is pretty printed. |

Return type

AppsV1beta1Scale

Authorization

BearerToken

HTTP request headers

  • 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]

ReadNamespacedStatefulSetStatus

V1beta1StatefulSet ReadNamespacedStatefulSetStatus(ctx, name, namespace, optional)

read status of the specified StatefulSet

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
name string name of the StatefulSet
namespace string object name and auth scope, such as for teams and projects
optional *ReadNamespacedStatefulSetStatusOpts optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a ReadNamespacedStatefulSetStatusOpts struct

Name Type Description Notes

pretty | optional.String| If 'true', then the output is pretty printed. |

Return type

V1beta1StatefulSet

Authorization

BearerToken

HTTP request headers

  • 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]

ReplaceNamespacedControllerRevision

V1beta1ControllerRevision ReplaceNamespacedControllerRevision(ctx, name, namespace, body, optional)

replace the specified ControllerRevision

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
name string name of the ControllerRevision
namespace string object name and auth scope, such as for teams and projects
body V1beta1ControllerRevision
optional *ReplaceNamespacedControllerRevisionOpts optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a ReplaceNamespacedControllerRevisionOpts struct

Name Type Description Notes

pretty | optional.String| If 'true', then the output is pretty printed. | dryRun | optional.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 |

Return type

V1beta1ControllerRevision

Authorization

BearerToken

HTTP request headers

  • 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]

ReplaceNamespacedDeployment

AppsV1beta1Deployment ReplaceNamespacedDeployment(ctx, name, namespace, body, optional)

replace the specified Deployment

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
name string name of the Deployment
namespace string object name and auth scope, such as for teams and projects
body AppsV1beta1Deployment
optional *ReplaceNamespacedDeploymentOpts optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a ReplaceNamespacedDeploymentOpts struct

Name Type Description Notes

pretty | optional.String| If 'true', then the output is pretty printed. | dryRun | optional.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 |

Return type

AppsV1beta1Deployment

Authorization

BearerToken

HTTP request headers

  • 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]

ReplaceNamespacedDeploymentScale

AppsV1beta1Scale ReplaceNamespacedDeploymentScale(ctx, name, namespace, body, optional)

replace scale of the specified Deployment

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
name string name of the Scale
namespace string object name and auth scope, such as for teams and projects
body AppsV1beta1Scale
optional *ReplaceNamespacedDeploymentScaleOpts optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a ReplaceNamespacedDeploymentScaleOpts struct

Name Type Description Notes

pretty | optional.String| If 'true', then the output is pretty printed. | dryRun | optional.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 |

Return type

AppsV1beta1Scale

Authorization

BearerToken

HTTP request headers

  • 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]

ReplaceNamespacedDeploymentStatus

AppsV1beta1Deployment ReplaceNamespacedDeploymentStatus(ctx, name, namespace, body, optional)

replace status of the specified Deployment

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
name string name of the Deployment
namespace string object name and auth scope, such as for teams and projects
body AppsV1beta1Deployment
optional *ReplaceNamespacedDeploymentStatusOpts optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a ReplaceNamespacedDeploymentStatusOpts struct

Name Type Description Notes

pretty | optional.String| If 'true', then the output is pretty printed. | dryRun | optional.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 |

Return type

AppsV1beta1Deployment

Authorization

BearerToken

HTTP request headers

  • 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]

ReplaceNamespacedStatefulSet

V1beta1StatefulSet ReplaceNamespacedStatefulSet(ctx, name, namespace, body, optional)

replace the specified StatefulSet

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
name string name of the StatefulSet
namespace string object name and auth scope, such as for teams and projects
body V1beta1StatefulSet
optional *ReplaceNamespacedStatefulSetOpts optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a ReplaceNamespacedStatefulSetOpts struct

Name Type Description Notes

pretty | optional.String| If 'true', then the output is pretty printed. | dryRun | optional.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 |

Return type

V1beta1StatefulSet

Authorization

BearerToken

HTTP request headers

  • 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]

ReplaceNamespacedStatefulSetScale

AppsV1beta1Scale ReplaceNamespacedStatefulSetScale(ctx, name, namespace, body, optional)

replace scale of the specified StatefulSet

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
name string name of the Scale
namespace string object name and auth scope, such as for teams and projects
body AppsV1beta1Scale
optional *ReplaceNamespacedStatefulSetScaleOpts optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a ReplaceNamespacedStatefulSetScaleOpts struct

Name Type Description Notes

pretty | optional.String| If 'true', then the output is pretty printed. | dryRun | optional.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 |

Return type

AppsV1beta1Scale

Authorization

BearerToken

HTTP request headers

  • 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]

ReplaceNamespacedStatefulSetStatus

V1beta1StatefulSet ReplaceNamespacedStatefulSetStatus(ctx, name, namespace, body, optional)

replace status of the specified StatefulSet

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
name string name of the StatefulSet
namespace string object name and auth scope, such as for teams and projects
body V1beta1StatefulSet
optional *ReplaceNamespacedStatefulSetStatusOpts optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a ReplaceNamespacedStatefulSetStatusOpts struct

Name Type Description Notes

pretty | optional.String| If 'true', then the output is pretty printed. | dryRun | optional.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 |

Return type

V1beta1StatefulSet

Authorization

BearerToken

HTTP request headers

  • 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]