Skip to content

Latest commit

 

History

History
1313 lines (836 loc) · 93.3 KB

RbacAuthorizationV1beta1Api.md

File metadata and controls

1313 lines (836 loc) · 93.3 KB

\RbacAuthorizationV1beta1Api

All URIs are relative to http://localhost

Method HTTP request Description
CreateClusterRole Post /apis/rbac.authorization.k8s.io/v1beta1/clusterroles
CreateClusterRoleBinding Post /apis/rbac.authorization.k8s.io/v1beta1/clusterrolebindings
CreateNamespacedRole Post /apis/rbac.authorization.k8s.io/v1beta1/namespaces/{namespace}/roles
CreateNamespacedRoleBinding Post /apis/rbac.authorization.k8s.io/v1beta1/namespaces/{namespace}/rolebindings
DeleteClusterRole Delete /apis/rbac.authorization.k8s.io/v1beta1/clusterroles/{name}
DeleteClusterRoleBinding Delete /apis/rbac.authorization.k8s.io/v1beta1/clusterrolebindings/{name}
DeleteCollectionClusterRole Delete /apis/rbac.authorization.k8s.io/v1beta1/clusterroles
DeleteCollectionClusterRoleBinding Delete /apis/rbac.authorization.k8s.io/v1beta1/clusterrolebindings
DeleteCollectionNamespacedRole Delete /apis/rbac.authorization.k8s.io/v1beta1/namespaces/{namespace}/roles
DeleteCollectionNamespacedRoleBinding Delete /apis/rbac.authorization.k8s.io/v1beta1/namespaces/{namespace}/rolebindings
DeleteNamespacedRole Delete /apis/rbac.authorization.k8s.io/v1beta1/namespaces/{namespace}/roles/{name}
DeleteNamespacedRoleBinding Delete /apis/rbac.authorization.k8s.io/v1beta1/namespaces/{namespace}/rolebindings/{name}
GetAPIResources Get /apis/rbac.authorization.k8s.io/v1beta1/
ListClusterRole Get /apis/rbac.authorization.k8s.io/v1beta1/clusterroles
ListClusterRoleBinding Get /apis/rbac.authorization.k8s.io/v1beta1/clusterrolebindings
ListNamespacedRole Get /apis/rbac.authorization.k8s.io/v1beta1/namespaces/{namespace}/roles
ListNamespacedRoleBinding Get /apis/rbac.authorization.k8s.io/v1beta1/namespaces/{namespace}/rolebindings
ListRoleBindingForAllNamespaces Get /apis/rbac.authorization.k8s.io/v1beta1/rolebindings
ListRoleForAllNamespaces Get /apis/rbac.authorization.k8s.io/v1beta1/roles
PatchClusterRole Patch /apis/rbac.authorization.k8s.io/v1beta1/clusterroles/{name}
PatchClusterRoleBinding Patch /apis/rbac.authorization.k8s.io/v1beta1/clusterrolebindings/{name}
PatchNamespacedRole Patch /apis/rbac.authorization.k8s.io/v1beta1/namespaces/{namespace}/roles/{name}
PatchNamespacedRoleBinding Patch /apis/rbac.authorization.k8s.io/v1beta1/namespaces/{namespace}/rolebindings/{name}
ReadClusterRole Get /apis/rbac.authorization.k8s.io/v1beta1/clusterroles/{name}
ReadClusterRoleBinding Get /apis/rbac.authorization.k8s.io/v1beta1/clusterrolebindings/{name}
ReadNamespacedRole Get /apis/rbac.authorization.k8s.io/v1beta1/namespaces/{namespace}/roles/{name}
ReadNamespacedRoleBinding Get /apis/rbac.authorization.k8s.io/v1beta1/namespaces/{namespace}/rolebindings/{name}
ReplaceClusterRole Put /apis/rbac.authorization.k8s.io/v1beta1/clusterroles/{name}
ReplaceClusterRoleBinding Put /apis/rbac.authorization.k8s.io/v1beta1/clusterrolebindings/{name}
ReplaceNamespacedRole Put /apis/rbac.authorization.k8s.io/v1beta1/namespaces/{namespace}/roles/{name}
ReplaceNamespacedRoleBinding Put /apis/rbac.authorization.k8s.io/v1beta1/namespaces/{namespace}/rolebindings/{name}

CreateClusterRole

V1beta1ClusterRole CreateClusterRole(ctx, body, optional)

create a ClusterRole

Required Parameters

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

Optional Parameters

Optional parameters are passed through a pointer to a CreateClusterRoleOpts 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

V1beta1ClusterRole

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]

CreateClusterRoleBinding

V1beta1ClusterRoleBinding CreateClusterRoleBinding(ctx, body, optional)

create a ClusterRoleBinding

Required Parameters

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

Optional Parameters

Optional parameters are passed through a pointer to a CreateClusterRoleBindingOpts 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

V1beta1ClusterRoleBinding

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]

CreateNamespacedRole

V1beta1Role CreateNamespacedRole(ctx, namespace, body, optional)

create a Role

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 V1beta1Role
optional *CreateNamespacedRoleOpts optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a CreateNamespacedRoleOpts 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

V1beta1Role

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]

CreateNamespacedRoleBinding

V1beta1RoleBinding CreateNamespacedRoleBinding(ctx, namespace, body, optional)

create a RoleBinding

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 V1beta1RoleBinding
optional *CreateNamespacedRoleBindingOpts optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a CreateNamespacedRoleBindingOpts 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

V1beta1RoleBinding

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]

DeleteClusterRole

V1Status DeleteClusterRole(ctx, name, optional)

delete a ClusterRole

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
name string name of the ClusterRole
optional *DeleteClusterRoleOpts optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a DeleteClusterRoleOpts 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]

DeleteClusterRoleBinding

V1Status DeleteClusterRoleBinding(ctx, name, optional)

delete a ClusterRoleBinding

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
name string name of the ClusterRoleBinding
optional *DeleteClusterRoleBindingOpts optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a DeleteClusterRoleBindingOpts 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]

DeleteCollectionClusterRole

V1Status DeleteCollectionClusterRole(ctx, optional)

delete collection of ClusterRole

Required Parameters

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

Optional Parameters

Optional parameters are passed through a pointer to a DeleteCollectionClusterRoleOpts 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]

DeleteCollectionClusterRoleBinding

V1Status DeleteCollectionClusterRoleBinding(ctx, optional)

delete collection of ClusterRoleBinding

Required Parameters

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

Optional Parameters

Optional parameters are passed through a pointer to a DeleteCollectionClusterRoleBindingOpts 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]

DeleteCollectionNamespacedRole

V1Status DeleteCollectionNamespacedRole(ctx, namespace, optional)

delete collection of Role

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 *DeleteCollectionNamespacedRoleOpts optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a DeleteCollectionNamespacedRoleOpts 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]

DeleteCollectionNamespacedRoleBinding

V1Status DeleteCollectionNamespacedRoleBinding(ctx, namespace, optional)

delete collection of RoleBinding

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 *DeleteCollectionNamespacedRoleBindingOpts optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a DeleteCollectionNamespacedRoleBindingOpts 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]

DeleteNamespacedRole

V1Status DeleteNamespacedRole(ctx, name, namespace, optional)

delete a Role

Required Parameters

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

Optional Parameters

Optional parameters are passed through a pointer to a DeleteNamespacedRoleOpts 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]

DeleteNamespacedRoleBinding

V1Status DeleteNamespacedRoleBinding(ctx, name, namespace, optional)

delete a RoleBinding

Required Parameters

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

Optional Parameters

Optional parameters are passed through a pointer to a DeleteNamespacedRoleBindingOpts 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]

ListClusterRole

V1beta1ClusterRoleList ListClusterRole(ctx, optional)

list or watch objects of kind ClusterRole

Required Parameters

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

Optional Parameters

Optional parameters are passed through a pointer to a ListClusterRoleOpts 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

V1beta1ClusterRoleList

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]

ListClusterRoleBinding

V1beta1ClusterRoleBindingList ListClusterRoleBinding(ctx, optional)

list or watch objects of kind ClusterRoleBinding

Required Parameters

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

Optional Parameters

Optional parameters are passed through a pointer to a ListClusterRoleBindingOpts 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

V1beta1ClusterRoleBindingList

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]

ListNamespacedRole

V1beta1RoleList ListNamespacedRole(ctx, namespace, optional)

list or watch objects of kind Role

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 *ListNamespacedRoleOpts optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a ListNamespacedRoleOpts 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

V1beta1RoleList

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]

ListNamespacedRoleBinding

V1beta1RoleBindingList ListNamespacedRoleBinding(ctx, namespace, optional)

list or watch objects of kind RoleBinding

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 *ListNamespacedRoleBindingOpts optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a ListNamespacedRoleBindingOpts 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

V1beta1RoleBindingList

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]

ListRoleBindingForAllNamespaces

V1beta1RoleBindingList ListRoleBindingForAllNamespaces(ctx, optional)

list or watch objects of kind RoleBinding

Required Parameters

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

Optional Parameters

Optional parameters are passed through a pointer to a ListRoleBindingForAllNamespacesOpts 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

V1beta1RoleBindingList

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]

ListRoleForAllNamespaces

V1beta1RoleList ListRoleForAllNamespaces(ctx, optional)

list or watch objects of kind Role

Required Parameters

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

Optional Parameters

Optional parameters are passed through a pointer to a ListRoleForAllNamespacesOpts 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

V1beta1RoleList

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]

PatchClusterRole

V1beta1ClusterRole PatchClusterRole(ctx, name, body, optional)

partially update the specified ClusterRole

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
name string name of the ClusterRole
body UNKNOWN_BASE_TYPE
optional *PatchClusterRoleOpts optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a PatchClusterRoleOpts 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

V1beta1ClusterRole

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]

PatchClusterRoleBinding

V1beta1ClusterRoleBinding PatchClusterRoleBinding(ctx, name, body, optional)

partially update the specified ClusterRoleBinding

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
name string name of the ClusterRoleBinding
body UNKNOWN_BASE_TYPE
optional *PatchClusterRoleBindingOpts optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a PatchClusterRoleBindingOpts 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

V1beta1ClusterRoleBinding

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]

PatchNamespacedRole

V1beta1Role PatchNamespacedRole(ctx, name, namespace, body, optional)

partially update the specified Role

Required Parameters

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

Optional Parameters

Optional parameters are passed through a pointer to a PatchNamespacedRoleOpts 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

V1beta1Role

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]

PatchNamespacedRoleBinding

V1beta1RoleBinding PatchNamespacedRoleBinding(ctx, name, namespace, body, optional)

partially update the specified RoleBinding

Required Parameters

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

Optional Parameters

Optional parameters are passed through a pointer to a PatchNamespacedRoleBindingOpts 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

V1beta1RoleBinding

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]

ReadClusterRole

V1beta1ClusterRole ReadClusterRole(ctx, name, optional)

read the specified ClusterRole

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
name string name of the ClusterRole
optional *ReadClusterRoleOpts optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a ReadClusterRoleOpts struct

Name Type Description Notes

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

Return type

V1beta1ClusterRole

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]

ReadClusterRoleBinding

V1beta1ClusterRoleBinding ReadClusterRoleBinding(ctx, name, optional)

read the specified ClusterRoleBinding

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
name string name of the ClusterRoleBinding
optional *ReadClusterRoleBindingOpts optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a ReadClusterRoleBindingOpts struct

Name Type Description Notes

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

Return type

V1beta1ClusterRoleBinding

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]

ReadNamespacedRole

V1beta1Role ReadNamespacedRole(ctx, name, namespace, optional)

read the specified Role

Required Parameters

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

Optional Parameters

Optional parameters are passed through a pointer to a ReadNamespacedRoleOpts struct

Name Type Description Notes

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

Return type

V1beta1Role

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]

ReadNamespacedRoleBinding

V1beta1RoleBinding ReadNamespacedRoleBinding(ctx, name, namespace, optional)

read the specified RoleBinding

Required Parameters

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

Optional Parameters

Optional parameters are passed through a pointer to a ReadNamespacedRoleBindingOpts struct

Name Type Description Notes

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

Return type

V1beta1RoleBinding

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]

ReplaceClusterRole

V1beta1ClusterRole ReplaceClusterRole(ctx, name, body, optional)

replace the specified ClusterRole

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
name string name of the ClusterRole
body V1beta1ClusterRole
optional *ReplaceClusterRoleOpts optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a ReplaceClusterRoleOpts 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

V1beta1ClusterRole

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]

ReplaceClusterRoleBinding

V1beta1ClusterRoleBinding ReplaceClusterRoleBinding(ctx, name, body, optional)

replace the specified ClusterRoleBinding

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
name string name of the ClusterRoleBinding
body V1beta1ClusterRoleBinding
optional *ReplaceClusterRoleBindingOpts optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a ReplaceClusterRoleBindingOpts 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

V1beta1ClusterRoleBinding

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]

ReplaceNamespacedRole

V1beta1Role ReplaceNamespacedRole(ctx, name, namespace, body, optional)

replace the specified Role

Required Parameters

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

Optional Parameters

Optional parameters are passed through a pointer to a ReplaceNamespacedRoleOpts 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

V1beta1Role

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]

ReplaceNamespacedRoleBinding

V1beta1RoleBinding ReplaceNamespacedRoleBinding(ctx, name, namespace, body, optional)

replace the specified RoleBinding

Required Parameters

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

Optional Parameters

Optional parameters are passed through a pointer to a ReplaceNamespacedRoleBindingOpts 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

V1beta1RoleBinding

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]