pub struct Role {
pub api_version: Option<String>,
pub kind: Option<String>,
pub metadata: Option<ObjectMeta>,
pub rules: Vec<PolicyRule>,
}
Expand description
Role is a namespaced, logical grouping of PolicyRules that can be referenced as a unit by a RoleBinding.
Fields§
§api_version: Option<String>
APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources
kind: Option<String>
Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds
metadata: Option<ObjectMeta>
Standard object’s metadata.
rules: Vec<PolicyRule>
Rules holds all the PolicyRules for this Role
Implementations§
source§impl Role
impl Role
create a Role
Use CreateRbacAuthorizationV1NamespacedRoleResponse
to parse the HTTP response.
Arguments
-
namespace
object name and auth scope, such as for teams and projects
-
body
-
dry_run
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
-
include_uninitialized
If true, partially initialized resources are included in the response.
-
pretty
If ‘true’, then the output is pretty printed.
source§impl Role
impl Role
delete collection of Role
Use DeleteRbacAuthorizationV1CollectionNamespacedRoleResponse
to parse the HTTP response.
Arguments
-
namespace
object name and auth scope, such as for teams and projects
-
continue_
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.
-
field_selector
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
include_uninitialized
If true, partially initialized resources are included in the response.
-
label_selector
A selector to restrict the list of returned objects by their labels. Defaults to everything.
-
limit
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
If ‘true’, then the output is pretty printed.
-
resource_version
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.
-
timeout_seconds
Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
-
watch
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
source§impl Role
impl Role
delete a Role
Use DeleteRbacAuthorizationV1NamespacedRoleResponse
to parse the HTTP response.
Arguments
-
name
name of the Role
-
namespace
object name and auth scope, such as for teams and projects
-
body
-
dry_run
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
-
grace_period_seconds
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.
-
orphan_dependents
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.
-
pretty
If ‘true’, then the output is pretty printed.
-
propagation_policy
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.
source§impl Role
impl Role
list or watch objects of kind Role
Use ListRbacAuthorizationV1NamespacedRoleResponse
to parse the HTTP response.
Arguments
-
namespace
object name and auth scope, such as for teams and projects
-
continue_
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.
-
field_selector
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
include_uninitialized
If true, partially initialized resources are included in the response.
-
label_selector
A selector to restrict the list of returned objects by their labels. Defaults to everything.
-
limit
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
If ‘true’, then the output is pretty printed.
-
resource_version
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.
-
timeout_seconds
Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
-
watch
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
source§impl Role
impl Role
list or watch objects of kind Role
Use ListRbacAuthorizationV1RoleForAllNamespacesResponse
to parse the HTTP response.
Arguments
-
continue_
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.
-
field_selector
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
include_uninitialized
If true, partially initialized resources are included in the response.
-
label_selector
A selector to restrict the list of returned objects by their labels. Defaults to everything.
-
limit
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
If ‘true’, then the output is pretty printed.
-
resource_version
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.
-
timeout_seconds
Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
-
watch
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
source§impl Role
impl Role
partially update the specified Role
Use PatchRbacAuthorizationV1NamespacedRoleResponse
to parse the HTTP response.
Arguments
-
name
name of the Role
-
namespace
object name and auth scope, such as for teams and projects
-
body
-
dry_run
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
-
pretty
If ‘true’, then the output is pretty printed.
source§impl Role
impl Role
read the specified Role
Use ReadRbacAuthorizationV1NamespacedRoleResponse
to parse the HTTP response.
Arguments
-
name
name of the Role
-
namespace
object name and auth scope, such as for teams and projects
-
pretty
If ‘true’, then the output is pretty printed.
source§impl Role
impl Role
replace the specified Role
Use ReplaceRbacAuthorizationV1NamespacedRoleResponse
to parse the HTTP response.
Arguments
-
name
name of the Role
-
namespace
object name and auth scope, such as for teams and projects
-
body
-
dry_run
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
-
pretty
If ‘true’, then the output is pretty printed.
source§impl Role
impl Role
watch changes to an object of kind Role. deprecated: use the ‘watch’ parameter with a list operation instead, filtered to a single item with the ‘fieldSelector’ parameter.
Use WatchRbacAuthorizationV1NamespacedRoleResponse
to parse the HTTP response.
Arguments
-
name
name of the Role
-
namespace
object name and auth scope, such as for teams and projects
-
continue_
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.
-
field_selector
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
include_uninitialized
If true, partially initialized resources are included in the response.
-
label_selector
A selector to restrict the list of returned objects by their labels. Defaults to everything.
-
limit
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
If ‘true’, then the output is pretty printed.
-
resource_version
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.
-
timeout_seconds
Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
-
watch
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
source§impl Role
impl Role
watch individual changes to a list of Role. deprecated: use the ‘watch’ parameter with a list operation instead.
Use WatchRbacAuthorizationV1NamespacedRoleListResponse
to parse the HTTP response.
Arguments
-
namespace
object name and auth scope, such as for teams and projects
-
continue_
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.
-
field_selector
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
include_uninitialized
If true, partially initialized resources are included in the response.
-
label_selector
A selector to restrict the list of returned objects by their labels. Defaults to everything.
-
limit
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
If ‘true’, then the output is pretty printed.
-
resource_version
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.
-
timeout_seconds
Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
-
watch
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
source§impl Role
impl Role
watch individual changes to a list of Role. deprecated: use the ‘watch’ parameter with a list operation instead.
Use WatchRbacAuthorizationV1RoleListForAllNamespacesResponse
to parse the HTTP response.
Arguments
-
continue_
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.
-
field_selector
A selector to restrict the list of returned objects by their fields. Defaults to everything.
-
include_uninitialized
If true, partially initialized resources are included in the response.
-
label_selector
A selector to restrict the list of returned objects by their labels. Defaults to everything.
-
limit
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
If ‘true’, then the output is pretty printed.
-
resource_version
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.
-
timeout_seconds
Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
-
watch
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.