Summary of entries of Classes for resourcesettings.
Classes
ResourceSettingsServiceAsyncClient
An interface to interact with resource settings and setting values throughout the resource hierarchy.
Services may surface a number of settings for users to control how their resources behave. Values of settings applied on a given Cloud resource are evaluated hierarchically and inherited by all descendants of that resource.
For all requests, returns a google.rpc.Status
with
google.rpc.Code.PERMISSION_DENIED
if the IAM check fails or the
parent
resource is not in a Cloud Organization. For all
requests, returns a google.rpc.Status
with
google.rpc.Code.INVALID_ARGUMENT
if the request is malformed.
(== deprecation_description Resource Settings is deprecated. As of
November 7, 2023, no organizations will be onboarded for any of the
enabled settings, and the service will be shut down on October 1,
- ==)
ResourceSettingsServiceClient
An interface to interact with resource settings and setting values throughout the resource hierarchy.
Services may surface a number of settings for users to control how their resources behave. Values of settings applied on a given Cloud resource are evaluated hierarchically and inherited by all descendants of that resource.
For all requests, returns a google.rpc.Status
with
google.rpc.Code.PERMISSION_DENIED
if the IAM check fails or the
parent
resource is not in a Cloud Organization. For all
requests, returns a google.rpc.Status
with
google.rpc.Code.INVALID_ARGUMENT
if the request is malformed.
(== deprecation_description Resource Settings is deprecated. As of
November 7, 2023, no organizations will be onboarded for any of the
enabled settings, and the service will be shut down on October 1,
- ==)
ListSettingsAsyncPager
A pager for iterating through list_settings
requests.
This class thinly wraps an initial
ListSettingsResponse object, and
provides an __aiter__
method to iterate through its
settings
field.
If there are more pages, the __aiter__
method will make additional
ListSettings
requests and continue to iterate
through the settings
field on the
corresponding responses.
All the usual ListSettingsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.
ListSettingsPager
A pager for iterating through list_settings
requests.
This class thinly wraps an initial
ListSettingsResponse object, and
provides an __iter__
method to iterate through its
settings
field.
If there are more pages, the __iter__
method will make additional
ListSettings
requests and continue to iterate
through the settings
field on the
corresponding responses.
All the usual ListSettingsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.
GetSettingRequest
The request for GetSetting.
ListSettingsRequest
The request for ListSettings.
ListSettingsResponse
The response from ListSettings.
Setting
The schema for settings.
SettingMetadata
Metadata about a setting which is not editable by the end user.
DataType
The data type for setting values of this setting. See Value for more details on the available data types.
SettingView
View options for Settings.
UpdateSettingRequest
The request for UpdateSetting.
Value
The data in a setting value.
This message has oneof
_ fields (mutually exclusive fields).
For each oneof, at most one member field can be set at the same time.
Setting any member of the oneof automatically clears all other
members.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
EnumValue
A enum value that can hold any enum type setting values. Each enum type is represented by a number, this representation is stored in the definitions.
StringSet
A string set value that can hold a set of strings. The maximum length of each string is 200 characters and there can be a maximum of 50 strings in the string set.
Modules
pagers
API documentation for resourcesettings_v1.services.resource_settings_service.pagers
module.