Files
c/kubernetes/docs/RbacAuthorizationV1beta1API.md
Ahmed Yarub Hani Al Nuaimi d91f3852fd Regenerate specs
2021-09-05 12:12:19 -03:00

104 KiB

RbacAuthorizationV1beta1API

All URIs are relative to http://localhost

Method HTTP request Description
RbacAuthorizationV1beta1API_createClusterRole POST /apis/rbac.authorization.k8s.io/v1beta1/clusterroles
RbacAuthorizationV1beta1API_createClusterRoleBinding POST /apis/rbac.authorization.k8s.io/v1beta1/clusterrolebindings
RbacAuthorizationV1beta1API_createNamespacedRole POST /apis/rbac.authorization.k8s.io/v1beta1/namespaces/{namespace}/roles
RbacAuthorizationV1beta1API_createNamespacedRoleBinding POST /apis/rbac.authorization.k8s.io/v1beta1/namespaces/{namespace}/rolebindings
RbacAuthorizationV1beta1API_deleteClusterRole DELETE /apis/rbac.authorization.k8s.io/v1beta1/clusterroles/{name}
RbacAuthorizationV1beta1API_deleteClusterRoleBinding DELETE /apis/rbac.authorization.k8s.io/v1beta1/clusterrolebindings/{name}
RbacAuthorizationV1beta1API_deleteCollectionClusterRole DELETE /apis/rbac.authorization.k8s.io/v1beta1/clusterroles
RbacAuthorizationV1beta1API_deleteCollectionClusterRoleBinding DELETE /apis/rbac.authorization.k8s.io/v1beta1/clusterrolebindings
RbacAuthorizationV1beta1API_deleteCollectionNamespacedRole DELETE /apis/rbac.authorization.k8s.io/v1beta1/namespaces/{namespace}/roles
RbacAuthorizationV1beta1API_deleteCollectionNamespacedRoleBinding DELETE /apis/rbac.authorization.k8s.io/v1beta1/namespaces/{namespace}/rolebindings
RbacAuthorizationV1beta1API_deleteNamespacedRole DELETE /apis/rbac.authorization.k8s.io/v1beta1/namespaces/{namespace}/roles/{name}
RbacAuthorizationV1beta1API_deleteNamespacedRoleBinding DELETE /apis/rbac.authorization.k8s.io/v1beta1/namespaces/{namespace}/rolebindings/{name}
RbacAuthorizationV1beta1API_getAPIResources GET /apis/rbac.authorization.k8s.io/v1beta1/
RbacAuthorizationV1beta1API_listClusterRole GET /apis/rbac.authorization.k8s.io/v1beta1/clusterroles
RbacAuthorizationV1beta1API_listClusterRoleBinding GET /apis/rbac.authorization.k8s.io/v1beta1/clusterrolebindings
RbacAuthorizationV1beta1API_listNamespacedRole GET /apis/rbac.authorization.k8s.io/v1beta1/namespaces/{namespace}/roles
RbacAuthorizationV1beta1API_listNamespacedRoleBinding GET /apis/rbac.authorization.k8s.io/v1beta1/namespaces/{namespace}/rolebindings
RbacAuthorizationV1beta1API_listRoleBindingForAllNamespaces GET /apis/rbac.authorization.k8s.io/v1beta1/rolebindings
RbacAuthorizationV1beta1API_listRoleForAllNamespaces GET /apis/rbac.authorization.k8s.io/v1beta1/roles
RbacAuthorizationV1beta1API_patchClusterRole PATCH /apis/rbac.authorization.k8s.io/v1beta1/clusterroles/{name}
RbacAuthorizationV1beta1API_patchClusterRoleBinding PATCH /apis/rbac.authorization.k8s.io/v1beta1/clusterrolebindings/{name}
RbacAuthorizationV1beta1API_patchNamespacedRole PATCH /apis/rbac.authorization.k8s.io/v1beta1/namespaces/{namespace}/roles/{name}
RbacAuthorizationV1beta1API_patchNamespacedRoleBinding PATCH /apis/rbac.authorization.k8s.io/v1beta1/namespaces/{namespace}/rolebindings/{name}
RbacAuthorizationV1beta1API_readClusterRole GET /apis/rbac.authorization.k8s.io/v1beta1/clusterroles/{name}
RbacAuthorizationV1beta1API_readClusterRoleBinding GET /apis/rbac.authorization.k8s.io/v1beta1/clusterrolebindings/{name}
RbacAuthorizationV1beta1API_readNamespacedRole GET /apis/rbac.authorization.k8s.io/v1beta1/namespaces/{namespace}/roles/{name}
RbacAuthorizationV1beta1API_readNamespacedRoleBinding GET /apis/rbac.authorization.k8s.io/v1beta1/namespaces/{namespace}/rolebindings/{name}
RbacAuthorizationV1beta1API_replaceClusterRole PUT /apis/rbac.authorization.k8s.io/v1beta1/clusterroles/{name}
RbacAuthorizationV1beta1API_replaceClusterRoleBinding PUT /apis/rbac.authorization.k8s.io/v1beta1/clusterrolebindings/{name}
RbacAuthorizationV1beta1API_replaceNamespacedRole PUT /apis/rbac.authorization.k8s.io/v1beta1/namespaces/{namespace}/roles/{name}
RbacAuthorizationV1beta1API_replaceNamespacedRoleBinding PUT /apis/rbac.authorization.k8s.io/v1beta1/namespaces/{namespace}/rolebindings/{name}

RbacAuthorizationV1beta1API_createClusterRole

// create a ClusterRole
//
v1beta1_cluster_role_t* RbacAuthorizationV1beta1API_createClusterRole(apiClient_t *apiClient, v1beta1_cluster_role_t * body, char * pretty, char * dryRun, char * fieldManager);

Parameters

Name Type Description Notes
apiClient apiClient_t * context containing the client configuration
body v1beta1_cluster_role_t *
pretty char * If 'true', then the output is pretty printed. [optional]
dryRun char * 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 [optional]
fieldManager char * fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. [optional]

Return type

v1beta1_cluster_role_t *

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]

RbacAuthorizationV1beta1API_createClusterRoleBinding

// create a ClusterRoleBinding
//
v1beta1_cluster_role_binding_t* RbacAuthorizationV1beta1API_createClusterRoleBinding(apiClient_t *apiClient, v1beta1_cluster_role_binding_t * body, char * pretty, char * dryRun, char * fieldManager);

Parameters

Name Type Description Notes
apiClient apiClient_t * context containing the client configuration
body v1beta1_cluster_role_binding_t *
pretty char * If 'true', then the output is pretty printed. [optional]
dryRun char * 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 [optional]
fieldManager char * fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. [optional]

Return type

v1beta1_cluster_role_binding_t *

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]

RbacAuthorizationV1beta1API_createNamespacedRole

// create a Role
//
v1beta1_role_t* RbacAuthorizationV1beta1API_createNamespacedRole(apiClient_t *apiClient, char * _namespace, v1beta1_role_t * body, char * pretty, char * dryRun, char * fieldManager);

Parameters

Name Type Description Notes
apiClient apiClient_t * context containing the client configuration
_namespace char * object name and auth scope, such as for teams and projects
body v1beta1_role_t *
pretty char * If 'true', then the output is pretty printed. [optional]
dryRun char * 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 [optional]
fieldManager char * fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. [optional]

Return type

v1beta1_role_t *

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]

RbacAuthorizationV1beta1API_createNamespacedRoleBinding

// create a RoleBinding
//
v1beta1_role_binding_t* RbacAuthorizationV1beta1API_createNamespacedRoleBinding(apiClient_t *apiClient, char * _namespace, v1beta1_role_binding_t * body, char * pretty, char * dryRun, char * fieldManager);

Parameters

Name Type Description Notes
apiClient apiClient_t * context containing the client configuration
_namespace char * object name and auth scope, such as for teams and projects
body v1beta1_role_binding_t *
pretty char * If 'true', then the output is pretty printed. [optional]
dryRun char * 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 [optional]
fieldManager char * fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. [optional]

Return type

v1beta1_role_binding_t *

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]

RbacAuthorizationV1beta1API_deleteClusterRole

// delete a ClusterRole
//
v1_status_t* RbacAuthorizationV1beta1API_deleteClusterRole(apiClient_t *apiClient, char * name, char * pretty, char * dryRun, int gracePeriodSeconds, int orphanDependents, char * propagationPolicy, v1_delete_options_t * body);

Parameters

Name Type Description Notes
apiClient apiClient_t * context containing the client configuration
name char * name of the ClusterRole
pretty char * If 'true', then the output is pretty printed. [optional]
dryRun char * 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 [optional]
gracePeriodSeconds int 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. [optional]
orphanDependents int 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. [optional]
propagationPolicy char * 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. [optional]
body v1_delete_options_t * [optional]

Return type

v1_status_t *

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]

RbacAuthorizationV1beta1API_deleteClusterRoleBinding

// delete a ClusterRoleBinding
//
v1_status_t* RbacAuthorizationV1beta1API_deleteClusterRoleBinding(apiClient_t *apiClient, char * name, char * pretty, char * dryRun, int gracePeriodSeconds, int orphanDependents, char * propagationPolicy, v1_delete_options_t * body);

Parameters

Name Type Description Notes
apiClient apiClient_t * context containing the client configuration
name char * name of the ClusterRoleBinding
pretty char * If 'true', then the output is pretty printed. [optional]
dryRun char * 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 [optional]
gracePeriodSeconds int 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. [optional]
orphanDependents int 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. [optional]
propagationPolicy char * 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. [optional]
body v1_delete_options_t * [optional]

Return type

v1_status_t *

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]

RbacAuthorizationV1beta1API_deleteCollectionClusterRole

// delete collection of ClusterRole
//
v1_status_t* RbacAuthorizationV1beta1API_deleteCollectionClusterRole(apiClient_t *apiClient, char * pretty, char * _continue, char * dryRun, char * fieldSelector, int gracePeriodSeconds, char * labelSelector, int limit, int orphanDependents, char * propagationPolicy, char * resourceVersion, int timeoutSeconds, v1_delete_options_t * body);

Parameters

Name Type Description Notes
apiClient apiClient_t * context containing the client configuration
pretty char * If 'true', then the output is pretty printed. [optional]
_continue char * 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. [optional]
dryRun char * 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 [optional]
fieldSelector char * A selector to restrict the list of returned objects by their fields. Defaults to everything. [optional]
gracePeriodSeconds int 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. [optional]
labelSelector char * A selector to restrict the list of returned objects by their labels. Defaults to everything. [optional]
limit int 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. [optional]
orphanDependents int 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. [optional]
propagationPolicy char * 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. [optional]
resourceVersion char * 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. [optional]
timeoutSeconds int Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. [optional]
body v1_delete_options_t * [optional]

Return type

v1_status_t *

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]

RbacAuthorizationV1beta1API_deleteCollectionClusterRoleBinding

// delete collection of ClusterRoleBinding
//
v1_status_t* RbacAuthorizationV1beta1API_deleteCollectionClusterRoleBinding(apiClient_t *apiClient, char * pretty, char * _continue, char * dryRun, char * fieldSelector, int gracePeriodSeconds, char * labelSelector, int limit, int orphanDependents, char * propagationPolicy, char * resourceVersion, int timeoutSeconds, v1_delete_options_t * body);

Parameters

Name Type Description Notes
apiClient apiClient_t * context containing the client configuration
pretty char * If 'true', then the output is pretty printed. [optional]
_continue char * 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. [optional]
dryRun char * 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 [optional]
fieldSelector char * A selector to restrict the list of returned objects by their fields. Defaults to everything. [optional]
gracePeriodSeconds int 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. [optional]
labelSelector char * A selector to restrict the list of returned objects by their labels. Defaults to everything. [optional]
limit int 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. [optional]
orphanDependents int 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. [optional]
propagationPolicy char * 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. [optional]
resourceVersion char * 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. [optional]
timeoutSeconds int Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. [optional]
body v1_delete_options_t * [optional]

Return type

v1_status_t *

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]

RbacAuthorizationV1beta1API_deleteCollectionNamespacedRole

// delete collection of Role
//
v1_status_t* RbacAuthorizationV1beta1API_deleteCollectionNamespacedRole(apiClient_t *apiClient, char * _namespace, char * pretty, char * _continue, char * dryRun, char * fieldSelector, int gracePeriodSeconds, char * labelSelector, int limit, int orphanDependents, char * propagationPolicy, char * resourceVersion, int timeoutSeconds, v1_delete_options_t * body);

Parameters

Name Type Description Notes
apiClient apiClient_t * context containing the client configuration
_namespace char * object name and auth scope, such as for teams and projects
pretty char * If 'true', then the output is pretty printed. [optional]
_continue char * 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. [optional]
dryRun char * 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 [optional]
fieldSelector char * A selector to restrict the list of returned objects by their fields. Defaults to everything. [optional]
gracePeriodSeconds int 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. [optional]
labelSelector char * A selector to restrict the list of returned objects by their labels. Defaults to everything. [optional]
limit int 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. [optional]
orphanDependents int 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. [optional]
propagationPolicy char * 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. [optional]
resourceVersion char * 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. [optional]
timeoutSeconds int Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. [optional]
body v1_delete_options_t * [optional]

Return type

v1_status_t *

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]

RbacAuthorizationV1beta1API_deleteCollectionNamespacedRoleBinding

// delete collection of RoleBinding
//
v1_status_t* RbacAuthorizationV1beta1API_deleteCollectionNamespacedRoleBinding(apiClient_t *apiClient, char * _namespace, char * pretty, char * _continue, char * dryRun, char * fieldSelector, int gracePeriodSeconds, char * labelSelector, int limit, int orphanDependents, char * propagationPolicy, char * resourceVersion, int timeoutSeconds, v1_delete_options_t * body);

Parameters

Name Type Description Notes
apiClient apiClient_t * context containing the client configuration
_namespace char * object name and auth scope, such as for teams and projects
pretty char * If 'true', then the output is pretty printed. [optional]
_continue char * 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. [optional]
dryRun char * 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 [optional]
fieldSelector char * A selector to restrict the list of returned objects by their fields. Defaults to everything. [optional]
gracePeriodSeconds int 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. [optional]
labelSelector char * A selector to restrict the list of returned objects by their labels. Defaults to everything. [optional]
limit int 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. [optional]
orphanDependents int 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. [optional]
propagationPolicy char * 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. [optional]
resourceVersion char * 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. [optional]
timeoutSeconds int Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. [optional]
body v1_delete_options_t * [optional]

Return type

v1_status_t *

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]

RbacAuthorizationV1beta1API_deleteNamespacedRole

// delete a Role
//
v1_status_t* RbacAuthorizationV1beta1API_deleteNamespacedRole(apiClient_t *apiClient, char * name, char * _namespace, char * pretty, char * dryRun, int gracePeriodSeconds, int orphanDependents, char * propagationPolicy, v1_delete_options_t * body);

Parameters

Name Type Description Notes
apiClient apiClient_t * context containing the client configuration
name char * name of the Role
_namespace char * object name and auth scope, such as for teams and projects
pretty char * If 'true', then the output is pretty printed. [optional]
dryRun char * 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 [optional]
gracePeriodSeconds int 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. [optional]
orphanDependents int 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. [optional]
propagationPolicy char * 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. [optional]
body v1_delete_options_t * [optional]

Return type

v1_status_t *

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]

RbacAuthorizationV1beta1API_deleteNamespacedRoleBinding

// delete a RoleBinding
//
v1_status_t* RbacAuthorizationV1beta1API_deleteNamespacedRoleBinding(apiClient_t *apiClient, char * name, char * _namespace, char * pretty, char * dryRun, int gracePeriodSeconds, int orphanDependents, char * propagationPolicy, v1_delete_options_t * body);

Parameters

Name Type Description Notes
apiClient apiClient_t * context containing the client configuration
name char * name of the RoleBinding
_namespace char * object name and auth scope, such as for teams and projects
pretty char * If 'true', then the output is pretty printed. [optional]
dryRun char * 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 [optional]
gracePeriodSeconds int 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. [optional]
orphanDependents int 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. [optional]
propagationPolicy char * 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. [optional]
body v1_delete_options_t * [optional]

Return type

v1_status_t *

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]

RbacAuthorizationV1beta1API_getAPIResources

// get available resources
//
v1_api_resource_list_t* RbacAuthorizationV1beta1API_getAPIResources(apiClient_t *apiClient);

Parameters

Name Type Description Notes
apiClient apiClient_t * context containing the client configuration

Return type

v1_api_resource_list_t *

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]

RbacAuthorizationV1beta1API_listClusterRole

// list or watch objects of kind ClusterRole
//
v1beta1_cluster_role_list_t* RbacAuthorizationV1beta1API_listClusterRole(apiClient_t *apiClient, char * pretty, int allowWatchBookmarks, char * _continue, char * fieldSelector, char * labelSelector, int limit, char * resourceVersion, int timeoutSeconds, int watch);

Parameters

Name Type Description Notes
apiClient apiClient_t * context containing the client configuration
pretty char * If 'true', then the output is pretty printed. [optional]
allowWatchBookmarks int allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. [optional]
_continue char * 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. [optional]
fieldSelector char * A selector to restrict the list of returned objects by their fields. Defaults to everything. [optional]
labelSelector char * A selector to restrict the list of returned objects by their labels. Defaults to everything. [optional]
limit int 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. [optional]
resourceVersion char * 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. [optional]
timeoutSeconds int Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. [optional]
watch int Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. [optional]

Return type

v1beta1_cluster_role_list_t *

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]

RbacAuthorizationV1beta1API_listClusterRoleBinding

// list or watch objects of kind ClusterRoleBinding
//
v1beta1_cluster_role_binding_list_t* RbacAuthorizationV1beta1API_listClusterRoleBinding(apiClient_t *apiClient, char * pretty, int allowWatchBookmarks, char * _continue, char * fieldSelector, char * labelSelector, int limit, char * resourceVersion, int timeoutSeconds, int watch);

Parameters

Name Type Description Notes
apiClient apiClient_t * context containing the client configuration
pretty char * If 'true', then the output is pretty printed. [optional]
allowWatchBookmarks int allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. [optional]
_continue char * 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. [optional]
fieldSelector char * A selector to restrict the list of returned objects by their fields. Defaults to everything. [optional]
labelSelector char * A selector to restrict the list of returned objects by their labels. Defaults to everything. [optional]
limit int 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. [optional]
resourceVersion char * 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. [optional]
timeoutSeconds int Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. [optional]
watch int Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. [optional]

Return type

v1beta1_cluster_role_binding_list_t *

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]

RbacAuthorizationV1beta1API_listNamespacedRole

// list or watch objects of kind Role
//
v1beta1_role_list_t* RbacAuthorizationV1beta1API_listNamespacedRole(apiClient_t *apiClient, char * _namespace, char * pretty, int allowWatchBookmarks, char * _continue, char * fieldSelector, char * labelSelector, int limit, char * resourceVersion, int timeoutSeconds, int watch);

Parameters

Name Type Description Notes
apiClient apiClient_t * context containing the client configuration
_namespace char * object name and auth scope, such as for teams and projects
pretty char * If 'true', then the output is pretty printed. [optional]
allowWatchBookmarks int allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. [optional]
_continue char * 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. [optional]
fieldSelector char * A selector to restrict the list of returned objects by their fields. Defaults to everything. [optional]
labelSelector char * A selector to restrict the list of returned objects by their labels. Defaults to everything. [optional]
limit int 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. [optional]
resourceVersion char * 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. [optional]
timeoutSeconds int Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. [optional]
watch int Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. [optional]

Return type

v1beta1_role_list_t *

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]

RbacAuthorizationV1beta1API_listNamespacedRoleBinding

// list or watch objects of kind RoleBinding
//
v1beta1_role_binding_list_t* RbacAuthorizationV1beta1API_listNamespacedRoleBinding(apiClient_t *apiClient, char * _namespace, char * pretty, int allowWatchBookmarks, char * _continue, char * fieldSelector, char * labelSelector, int limit, char * resourceVersion, int timeoutSeconds, int watch);

Parameters

Name Type Description Notes
apiClient apiClient_t * context containing the client configuration
_namespace char * object name and auth scope, such as for teams and projects
pretty char * If 'true', then the output is pretty printed. [optional]
allowWatchBookmarks int allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. [optional]
_continue char * 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. [optional]
fieldSelector char * A selector to restrict the list of returned objects by their fields. Defaults to everything. [optional]
labelSelector char * A selector to restrict the list of returned objects by their labels. Defaults to everything. [optional]
limit int 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. [optional]
resourceVersion char * 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. [optional]
timeoutSeconds int Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. [optional]
watch int Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. [optional]

Return type

v1beta1_role_binding_list_t *

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]

RbacAuthorizationV1beta1API_listRoleBindingForAllNamespaces

// list or watch objects of kind RoleBinding
//
v1beta1_role_binding_list_t* RbacAuthorizationV1beta1API_listRoleBindingForAllNamespaces(apiClient_t *apiClient, int allowWatchBookmarks, char * _continue, char * fieldSelector, char * labelSelector, int limit, char * pretty, char * resourceVersion, int timeoutSeconds, int watch);

Parameters

Name Type Description Notes
apiClient apiClient_t * context containing the client configuration
allowWatchBookmarks int allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. [optional]
_continue char * 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. [optional]
fieldSelector char * A selector to restrict the list of returned objects by their fields. Defaults to everything. [optional]
labelSelector char * A selector to restrict the list of returned objects by their labels. Defaults to everything. [optional]
limit int 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. [optional]
pretty char * If 'true', then the output is pretty printed. [optional]
resourceVersion char * 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. [optional]
timeoutSeconds int Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. [optional]
watch int Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. [optional]

Return type

v1beta1_role_binding_list_t *

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]

RbacAuthorizationV1beta1API_listRoleForAllNamespaces

// list or watch objects of kind Role
//
v1beta1_role_list_t* RbacAuthorizationV1beta1API_listRoleForAllNamespaces(apiClient_t *apiClient, int allowWatchBookmarks, char * _continue, char * fieldSelector, char * labelSelector, int limit, char * pretty, char * resourceVersion, int timeoutSeconds, int watch);

Parameters

Name Type Description Notes
apiClient apiClient_t * context containing the client configuration
allowWatchBookmarks int allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. [optional]
_continue char * 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. [optional]
fieldSelector char * A selector to restrict the list of returned objects by their fields. Defaults to everything. [optional]
labelSelector char * A selector to restrict the list of returned objects by their labels. Defaults to everything. [optional]
limit int 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. [optional]
pretty char * If 'true', then the output is pretty printed. [optional]
resourceVersion char * 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. [optional]
timeoutSeconds int Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. [optional]
watch int Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. [optional]

Return type

v1beta1_role_list_t *

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]

RbacAuthorizationV1beta1API_patchClusterRole

// partially update the specified ClusterRole
//
v1beta1_cluster_role_t* RbacAuthorizationV1beta1API_patchClusterRole(apiClient_t *apiClient, char * name, object_t * body, char * pretty, char * dryRun, char * fieldManager, int force);

Parameters

Name Type Description Notes
apiClient apiClient_t * context containing the client configuration
name char * name of the ClusterRole
body object_t *
pretty char * If 'true', then the output is pretty printed. [optional]
dryRun char * 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 [optional]
fieldManager char * fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). [optional]
force int Force is going to "force" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. [optional]

Return type

v1beta1_cluster_role_t *

Authorization

BearerToken

HTTP request headers

  • Content-Type: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml
  • Accept: application/json, application/yaml, application/vnd.kubernetes.protobuf

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

RbacAuthorizationV1beta1API_patchClusterRoleBinding

// partially update the specified ClusterRoleBinding
//
v1beta1_cluster_role_binding_t* RbacAuthorizationV1beta1API_patchClusterRoleBinding(apiClient_t *apiClient, char * name, object_t * body, char * pretty, char * dryRun, char * fieldManager, int force);

Parameters

Name Type Description Notes
apiClient apiClient_t * context containing the client configuration
name char * name of the ClusterRoleBinding
body object_t *
pretty char * If 'true', then the output is pretty printed. [optional]
dryRun char * 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 [optional]
fieldManager char * fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). [optional]
force int Force is going to "force" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. [optional]

Return type

v1beta1_cluster_role_binding_t *

Authorization

BearerToken

HTTP request headers

  • Content-Type: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml
  • Accept: application/json, application/yaml, application/vnd.kubernetes.protobuf

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

RbacAuthorizationV1beta1API_patchNamespacedRole

// partially update the specified Role
//
v1beta1_role_t* RbacAuthorizationV1beta1API_patchNamespacedRole(apiClient_t *apiClient, char * name, char * _namespace, object_t * body, char * pretty, char * dryRun, char * fieldManager, int force);

Parameters

Name Type Description Notes
apiClient apiClient_t * context containing the client configuration
name char * name of the Role
_namespace char * object name and auth scope, such as for teams and projects
body object_t *
pretty char * If 'true', then the output is pretty printed. [optional]
dryRun char * 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 [optional]
fieldManager char * fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). [optional]
force int Force is going to "force" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. [optional]

Return type

v1beta1_role_t *

Authorization

BearerToken

HTTP request headers

  • Content-Type: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml
  • Accept: application/json, application/yaml, application/vnd.kubernetes.protobuf

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

RbacAuthorizationV1beta1API_patchNamespacedRoleBinding

// partially update the specified RoleBinding
//
v1beta1_role_binding_t* RbacAuthorizationV1beta1API_patchNamespacedRoleBinding(apiClient_t *apiClient, char * name, char * _namespace, object_t * body, char * pretty, char * dryRun, char * fieldManager, int force);

Parameters

Name Type Description Notes
apiClient apiClient_t * context containing the client configuration
name char * name of the RoleBinding
_namespace char * object name and auth scope, such as for teams and projects
body object_t *
pretty char * If 'true', then the output is pretty printed. [optional]
dryRun char * 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 [optional]
fieldManager char * fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). [optional]
force int Force is going to "force" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. [optional]

Return type

v1beta1_role_binding_t *

Authorization

BearerToken

HTTP request headers

  • Content-Type: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml
  • Accept: application/json, application/yaml, application/vnd.kubernetes.protobuf

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

RbacAuthorizationV1beta1API_readClusterRole

// read the specified ClusterRole
//
v1beta1_cluster_role_t* RbacAuthorizationV1beta1API_readClusterRole(apiClient_t *apiClient, char * name, char * pretty);

Parameters

Name Type Description Notes
apiClient apiClient_t * context containing the client configuration
name char * name of the ClusterRole
pretty char * If 'true', then the output is pretty printed. [optional]

Return type

v1beta1_cluster_role_t *

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]

RbacAuthorizationV1beta1API_readClusterRoleBinding

// read the specified ClusterRoleBinding
//
v1beta1_cluster_role_binding_t* RbacAuthorizationV1beta1API_readClusterRoleBinding(apiClient_t *apiClient, char * name, char * pretty);

Parameters

Name Type Description Notes
apiClient apiClient_t * context containing the client configuration
name char * name of the ClusterRoleBinding
pretty char * If 'true', then the output is pretty printed. [optional]

Return type

v1beta1_cluster_role_binding_t *

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]

RbacAuthorizationV1beta1API_readNamespacedRole

// read the specified Role
//
v1beta1_role_t* RbacAuthorizationV1beta1API_readNamespacedRole(apiClient_t *apiClient, char * name, char * _namespace, char * pretty);

Parameters

Name Type Description Notes
apiClient apiClient_t * context containing the client configuration
name char * name of the Role
_namespace char * object name and auth scope, such as for teams and projects
pretty char * If 'true', then the output is pretty printed. [optional]

Return type

v1beta1_role_t *

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]

RbacAuthorizationV1beta1API_readNamespacedRoleBinding

// read the specified RoleBinding
//
v1beta1_role_binding_t* RbacAuthorizationV1beta1API_readNamespacedRoleBinding(apiClient_t *apiClient, char * name, char * _namespace, char * pretty);

Parameters

Name Type Description Notes
apiClient apiClient_t * context containing the client configuration
name char * name of the RoleBinding
_namespace char * object name and auth scope, such as for teams and projects
pretty char * If 'true', then the output is pretty printed. [optional]

Return type

v1beta1_role_binding_t *

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]

RbacAuthorizationV1beta1API_replaceClusterRole

// replace the specified ClusterRole
//
v1beta1_cluster_role_t* RbacAuthorizationV1beta1API_replaceClusterRole(apiClient_t *apiClient, char * name, v1beta1_cluster_role_t * body, char * pretty, char * dryRun, char * fieldManager);

Parameters

Name Type Description Notes
apiClient apiClient_t * context containing the client configuration
name char * name of the ClusterRole
body v1beta1_cluster_role_t *
pretty char * If 'true', then the output is pretty printed. [optional]
dryRun char * 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 [optional]
fieldManager char * fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. [optional]

Return type

v1beta1_cluster_role_t *

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]

RbacAuthorizationV1beta1API_replaceClusterRoleBinding

// replace the specified ClusterRoleBinding
//
v1beta1_cluster_role_binding_t* RbacAuthorizationV1beta1API_replaceClusterRoleBinding(apiClient_t *apiClient, char * name, v1beta1_cluster_role_binding_t * body, char * pretty, char * dryRun, char * fieldManager);

Parameters

Name Type Description Notes
apiClient apiClient_t * context containing the client configuration
name char * name of the ClusterRoleBinding
body v1beta1_cluster_role_binding_t *
pretty char * If 'true', then the output is pretty printed. [optional]
dryRun char * 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 [optional]
fieldManager char * fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. [optional]

Return type

v1beta1_cluster_role_binding_t *

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]

RbacAuthorizationV1beta1API_replaceNamespacedRole

// replace the specified Role
//
v1beta1_role_t* RbacAuthorizationV1beta1API_replaceNamespacedRole(apiClient_t *apiClient, char * name, char * _namespace, v1beta1_role_t * body, char * pretty, char * dryRun, char * fieldManager);

Parameters

Name Type Description Notes
apiClient apiClient_t * context containing the client configuration
name char * name of the Role
_namespace char * object name and auth scope, such as for teams and projects
body v1beta1_role_t *
pretty char * If 'true', then the output is pretty printed. [optional]
dryRun char * 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 [optional]
fieldManager char * fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. [optional]

Return type

v1beta1_role_t *

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]

RbacAuthorizationV1beta1API_replaceNamespacedRoleBinding

// replace the specified RoleBinding
//
v1beta1_role_binding_t* RbacAuthorizationV1beta1API_replaceNamespacedRoleBinding(apiClient_t *apiClient, char * name, char * _namespace, v1beta1_role_binding_t * body, char * pretty, char * dryRun, char * fieldManager);

Parameters

Name Type Description Notes
apiClient apiClient_t * context containing the client configuration
name char * name of the RoleBinding
_namespace char * object name and auth scope, such as for teams and projects
body v1beta1_role_binding_t *
pretty char * If 'true', then the output is pretty printed. [optional]
dryRun char * 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 [optional]
fieldManager char * fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. [optional]

Return type

v1beta1_role_binding_t *

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]