Package Methods (1.10.0)

Summary of entries of Methods for resourcesettings.

google.cloud.resourcesettings_v1.services.resource_settings_service.ResourceSettingsServiceAsyncClient

ResourceSettingsServiceAsyncClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.resourcesettings_v1.services.resource_settings_service.transports.base.ResourceSettingsServiceTransport, typing.Callable[[...], google.cloud.resourcesettings_v1.services.resource_settings_service.transports.base.ResourceSettingsServiceTransport]]] = 'grpc_asyncio', client_options: typing.Optional[google.api_core.client_options.ClientOptions] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo =

Instantiates the resource settings service async client.

See more: google.cloud.resourcesettings_v1.services.resource_settings_service.ResourceSettingsServiceAsyncClient

google.cloud.resourcesettings_v1.services.resource_settings_service.ResourceSettingsServiceAsyncClient.common_billing_account_path

common_billing_account_path(billing_account: str) -> str

Returns a fully-qualified billing_account string.

See more: google.cloud.resourcesettings_v1.services.resource_settings_service.ResourceSettingsServiceAsyncClient.common_billing_account_path

google.cloud.resourcesettings_v1.services.resource_settings_service.ResourceSettingsServiceAsyncClient.common_folder_path

common_folder_path(folder: str) -> str

Returns a fully-qualified folder string.

See more: google.cloud.resourcesettings_v1.services.resource_settings_service.ResourceSettingsServiceAsyncClient.common_folder_path

google.cloud.resourcesettings_v1.services.resource_settings_service.ResourceSettingsServiceAsyncClient.common_location_path

common_location_path(project: str, location: str) -> str

Returns a fully-qualified location string.

See more: google.cloud.resourcesettings_v1.services.resource_settings_service.ResourceSettingsServiceAsyncClient.common_location_path

google.cloud.resourcesettings_v1.services.resource_settings_service.ResourceSettingsServiceAsyncClient.common_organization_path

common_organization_path(organization: str) -> str

Returns a fully-qualified organization string.

See more: google.cloud.resourcesettings_v1.services.resource_settings_service.ResourceSettingsServiceAsyncClient.common_organization_path

google.cloud.resourcesettings_v1.services.resource_settings_service.ResourceSettingsServiceAsyncClient.common_project_path

common_project_path(project: str) -> str

Returns a fully-qualified project string.

See more: google.cloud.resourcesettings_v1.services.resource_settings_service.ResourceSettingsServiceAsyncClient.common_project_path

google.cloud.resourcesettings_v1.services.resource_settings_service.ResourceSettingsServiceAsyncClient.from_service_account_file

from_service_account_file(filename: str, *args, **kwargs)

Creates an instance of this client using the provided credentials file.

See more: google.cloud.resourcesettings_v1.services.resource_settings_service.ResourceSettingsServiceAsyncClient.from_service_account_file

google.cloud.resourcesettings_v1.services.resource_settings_service.ResourceSettingsServiceAsyncClient.from_service_account_info

from_service_account_info(info: dict, *args, **kwargs)

Creates an instance of this client using the provided credentials info.

See more: google.cloud.resourcesettings_v1.services.resource_settings_service.ResourceSettingsServiceAsyncClient.from_service_account_info

google.cloud.resourcesettings_v1.services.resource_settings_service.ResourceSettingsServiceAsyncClient.from_service_account_json

from_service_account_json(filename: str, *args, **kwargs)

Creates an instance of this client using the provided credentials file.

See more: google.cloud.resourcesettings_v1.services.resource_settings_service.ResourceSettingsServiceAsyncClient.from_service_account_json

google.cloud.resourcesettings_v1.services.resource_settings_service.ResourceSettingsServiceAsyncClient.get_mtls_endpoint_and_cert_source

get_mtls_endpoint_and_cert_source(
    client_options: typing.Optional[
        google.api_core.client_options.ClientOptions
    ] = None,
)

Return the API endpoint and client cert source for mutual TLS.

See more: google.cloud.resourcesettings_v1.services.resource_settings_service.ResourceSettingsServiceAsyncClient.get_mtls_endpoint_and_cert_source

google.cloud.resourcesettings_v1.services.resource_settings_service.ResourceSettingsServiceAsyncClient.get_setting

get_setting(
    request: typing.Optional[
        typing.Union[
            google.cloud.resourcesettings_v1.types.resource_settings.GetSettingRequest,
            dict,
        ]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.resourcesettings_v1.types.resource_settings.Setting

Gets a setting.

See more: google.cloud.resourcesettings_v1.services.resource_settings_service.ResourceSettingsServiceAsyncClient.get_setting

google.cloud.resourcesettings_v1.services.resource_settings_service.ResourceSettingsServiceAsyncClient.get_transport_class

get_transport_class(
    label: typing.Optional[str] = None,
) -> typing.Type[
    google.cloud.resourcesettings_v1.services.resource_settings_service.transports.base.ResourceSettingsServiceTransport
]

Returns an appropriate transport class.

See more: google.cloud.resourcesettings_v1.services.resource_settings_service.ResourceSettingsServiceAsyncClient.get_transport_class

google.cloud.resourcesettings_v1.services.resource_settings_service.ResourceSettingsServiceAsyncClient.list_settings

list_settings(
    request: typing.Optional[
        typing.Union[
            google.cloud.resourcesettings_v1.types.resource_settings.ListSettingsRequest,
            dict,
        ]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
    google.cloud.resourcesettings_v1.services.resource_settings_service.pagers.ListSettingsAsyncPager
)

Lists all the settings that are available on the Cloud resource parent.

See more: google.cloud.resourcesettings_v1.services.resource_settings_service.ResourceSettingsServiceAsyncClient.list_settings

google.cloud.resourcesettings_v1.services.resource_settings_service.ResourceSettingsServiceAsyncClient.parse_common_billing_account_path

parse_common_billing_account_path(path: str) -> typing.Dict[str, str]

Parse a billing_account path into its component segments.

See more: google.cloud.resourcesettings_v1.services.resource_settings_service.ResourceSettingsServiceAsyncClient.parse_common_billing_account_path

google.cloud.resourcesettings_v1.services.resource_settings_service.ResourceSettingsServiceAsyncClient.parse_common_folder_path

parse_common_folder_path(path: str) -> typing.Dict[str, str]

Parse a folder path into its component segments.

See more: google.cloud.resourcesettings_v1.services.resource_settings_service.ResourceSettingsServiceAsyncClient.parse_common_folder_path

google.cloud.resourcesettings_v1.services.resource_settings_service.ResourceSettingsServiceAsyncClient.parse_common_location_path

parse_common_location_path(path: str) -> typing.Dict[str, str]

Parse a location path into its component segments.

See more: google.cloud.resourcesettings_v1.services.resource_settings_service.ResourceSettingsServiceAsyncClient.parse_common_location_path

google.cloud.resourcesettings_v1.services.resource_settings_service.ResourceSettingsServiceAsyncClient.parse_common_organization_path

parse_common_organization_path(path: str) -> typing.Dict[str, str]

Parse a organization path into its component segments.

See more: google.cloud.resourcesettings_v1.services.resource_settings_service.ResourceSettingsServiceAsyncClient.parse_common_organization_path

google.cloud.resourcesettings_v1.services.resource_settings_service.ResourceSettingsServiceAsyncClient.parse_common_project_path

parse_common_project_path(path: str) -> typing.Dict[str, str]

Parse a project path into its component segments.

See more: google.cloud.resourcesettings_v1.services.resource_settings_service.ResourceSettingsServiceAsyncClient.parse_common_project_path

google.cloud.resourcesettings_v1.services.resource_settings_service.ResourceSettingsServiceAsyncClient.parse_setting_path

parse_setting_path(path: str) -> typing.Dict[str, str]

Parses a setting path into its component segments.

See more: google.cloud.resourcesettings_v1.services.resource_settings_service.ResourceSettingsServiceAsyncClient.parse_setting_path

google.cloud.resourcesettings_v1.services.resource_settings_service.ResourceSettingsServiceAsyncClient.setting_path

setting_path(project_number: str, setting_name: str) -> str

Returns a fully-qualified setting string.

See more: google.cloud.resourcesettings_v1.services.resource_settings_service.ResourceSettingsServiceAsyncClient.setting_path

google.cloud.resourcesettings_v1.services.resource_settings_service.ResourceSettingsServiceAsyncClient.update_setting

update_setting(
    request: typing.Optional[
        typing.Union[
            google.cloud.resourcesettings_v1.types.resource_settings.UpdateSettingRequest,
            dict,
        ]
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.resourcesettings_v1.types.resource_settings.Setting

Updates a setting.

See more: google.cloud.resourcesettings_v1.services.resource_settings_service.ResourceSettingsServiceAsyncClient.update_setting

google.cloud.resourcesettings_v1.services.resource_settings_service.ResourceSettingsServiceClient

ResourceSettingsServiceClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.resourcesettings_v1.services.resource_settings_service.transports.base.ResourceSettingsServiceTransport, typing.Callable[[...], google.cloud.resourcesettings_v1.services.resource_settings_service.transports.base.ResourceSettingsServiceTransport]]] = None, client_options: typing.Optional[typing.Union[google.api_core.client_options.ClientOptions, dict]] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo =

Instantiates the resource settings service client.

See more: google.cloud.resourcesettings_v1.services.resource_settings_service.ResourceSettingsServiceClient

google.cloud.resourcesettings_v1.services.resource_settings_service.ResourceSettingsServiceClient.__exit__

__exit__(type, value, traceback)

Releases underlying transport's resources.

See more: google.cloud.resourcesettings_v1.services.resource_settings_service.ResourceSettingsServiceClient.exit

google.cloud.resourcesettings_v1.services.resource_settings_service.ResourceSettingsServiceClient.common_billing_account_path

common_billing_account_path(billing_account: str) -> str

Returns a fully-qualified billing_account string.

See more: google.cloud.resourcesettings_v1.services.resource_settings_service.ResourceSettingsServiceClient.common_billing_account_path

google.cloud.resourcesettings_v1.services.resource_settings_service.ResourceSettingsServiceClient.common_folder_path

common_folder_path(folder: str) -> str

Returns a fully-qualified folder string.

See more: google.cloud.resourcesettings_v1.services.resource_settings_service.ResourceSettingsServiceClient.common_folder_path

google.cloud.resourcesettings_v1.services.resource_settings_service.ResourceSettingsServiceClient.common_location_path

common_location_path(project: str, location: str) -> str

Returns a fully-qualified location string.

See more: google.cloud.resourcesettings_v1.services.resource_settings_service.ResourceSettingsServiceClient.common_location_path

google.cloud.resourcesettings_v1.services.resource_settings_service.ResourceSettingsServiceClient.common_organization_path

common_organization_path(organization: str) -> str

Returns a fully-qualified organization string.

See more: google.cloud.resourcesettings_v1.services.resource_settings_service.ResourceSettingsServiceClient.common_organization_path

google.cloud.resourcesettings_v1.services.resource_settings_service.ResourceSettingsServiceClient.common_project_path

common_project_path(project: str) -> str

Returns a fully-qualified project string.

See more: google.cloud.resourcesettings_v1.services.resource_settings_service.ResourceSettingsServiceClient.common_project_path

google.cloud.resourcesettings_v1.services.resource_settings_service.ResourceSettingsServiceClient.from_service_account_file

from_service_account_file(filename: str, *args, **kwargs)

Creates an instance of this client using the provided credentials file.

See more: google.cloud.resourcesettings_v1.services.resource_settings_service.ResourceSettingsServiceClient.from_service_account_file

google.cloud.resourcesettings_v1.services.resource_settings_service.ResourceSettingsServiceClient.from_service_account_info

from_service_account_info(info: dict, *args, **kwargs)

Creates an instance of this client using the provided credentials info.

See more: google.cloud.resourcesettings_v1.services.resource_settings_service.ResourceSettingsServiceClient.from_service_account_info

google.cloud.resourcesettings_v1.services.resource_settings_service.ResourceSettingsServiceClient.from_service_account_json

from_service_account_json(filename: str, *args, **kwargs)

Creates an instance of this client using the provided credentials file.

See more: google.cloud.resourcesettings_v1.services.resource_settings_service.ResourceSettingsServiceClient.from_service_account_json

google.cloud.resourcesettings_v1.services.resource_settings_service.ResourceSettingsServiceClient.get_mtls_endpoint_and_cert_source

get_mtls_endpoint_and_cert_source(
    client_options: typing.Optional[
        google.api_core.client_options.ClientOptions
    ] = None,
)

Deprecated.

See more: google.cloud.resourcesettings_v1.services.resource_settings_service.ResourceSettingsServiceClient.get_mtls_endpoint_and_cert_source

google.cloud.resourcesettings_v1.services.resource_settings_service.ResourceSettingsServiceClient.get_setting

get_setting(
    request: typing.Optional[
        typing.Union[
            google.cloud.resourcesettings_v1.types.resource_settings.GetSettingRequest,
            dict,
        ]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.resourcesettings_v1.types.resource_settings.Setting

Gets a setting.

See more: google.cloud.resourcesettings_v1.services.resource_settings_service.ResourceSettingsServiceClient.get_setting

google.cloud.resourcesettings_v1.services.resource_settings_service.ResourceSettingsServiceClient.list_settings

list_settings(
    request: typing.Optional[
        typing.Union[
            google.cloud.resourcesettings_v1.types.resource_settings.ListSettingsRequest,
            dict,
        ]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
    google.cloud.resourcesettings_v1.services.resource_settings_service.pagers.ListSettingsPager
)

Lists all the settings that are available on the Cloud resource parent.

See more: google.cloud.resourcesettings_v1.services.resource_settings_service.ResourceSettingsServiceClient.list_settings

google.cloud.resourcesettings_v1.services.resource_settings_service.ResourceSettingsServiceClient.parse_common_billing_account_path

parse_common_billing_account_path(path: str) -> typing.Dict[str, str]

Parse a billing_account path into its component segments.

See more: google.cloud.resourcesettings_v1.services.resource_settings_service.ResourceSettingsServiceClient.parse_common_billing_account_path

google.cloud.resourcesettings_v1.services.resource_settings_service.ResourceSettingsServiceClient.parse_common_folder_path

parse_common_folder_path(path: str) -> typing.Dict[str, str]

Parse a folder path into its component segments.

See more: google.cloud.resourcesettings_v1.services.resource_settings_service.ResourceSettingsServiceClient.parse_common_folder_path

google.cloud.resourcesettings_v1.services.resource_settings_service.ResourceSettingsServiceClient.parse_common_location_path

parse_common_location_path(path: str) -> typing.Dict[str, str]

Parse a location path into its component segments.

See more: google.cloud.resourcesettings_v1.services.resource_settings_service.ResourceSettingsServiceClient.parse_common_location_path

google.cloud.resourcesettings_v1.services.resource_settings_service.ResourceSettingsServiceClient.parse_common_organization_path

parse_common_organization_path(path: str) -> typing.Dict[str, str]

Parse a organization path into its component segments.

See more: google.cloud.resourcesettings_v1.services.resource_settings_service.ResourceSettingsServiceClient.parse_common_organization_path

google.cloud.resourcesettings_v1.services.resource_settings_service.ResourceSettingsServiceClient.parse_common_project_path

parse_common_project_path(path: str) -> typing.Dict[str, str]

Parse a project path into its component segments.

See more: google.cloud.resourcesettings_v1.services.resource_settings_service.ResourceSettingsServiceClient.parse_common_project_path

google.cloud.resourcesettings_v1.services.resource_settings_service.ResourceSettingsServiceClient.parse_setting_path

parse_setting_path(path: str) -> typing.Dict[str, str]

Parses a setting path into its component segments.

See more: google.cloud.resourcesettings_v1.services.resource_settings_service.ResourceSettingsServiceClient.parse_setting_path

google.cloud.resourcesettings_v1.services.resource_settings_service.ResourceSettingsServiceClient.setting_path

setting_path(project_number: str, setting_name: str) -> str

Returns a fully-qualified setting string.

See more: google.cloud.resourcesettings_v1.services.resource_settings_service.ResourceSettingsServiceClient.setting_path

google.cloud.resourcesettings_v1.services.resource_settings_service.ResourceSettingsServiceClient.update_setting

update_setting(
    request: typing.Optional[
        typing.Union[
            google.cloud.resourcesettings_v1.types.resource_settings.UpdateSettingRequest,
            dict,
        ]
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.resourcesettings_v1.types.resource_settings.Setting

Updates a setting.

See more: google.cloud.resourcesettings_v1.services.resource_settings_service.ResourceSettingsServiceClient.update_setting

google.cloud.resourcesettings_v1.services.resource_settings_service.pagers.ListSettingsAsyncPager

ListSettingsAsyncPager(
    method: typing.Callable[
        [...],
        typing.Awaitable[
            google.cloud.resourcesettings_v1.types.resource_settings.ListSettingsResponse
        ],
    ],
    request: google.cloud.resourcesettings_v1.types.resource_settings.ListSettingsRequest,
    response: google.cloud.resourcesettings_v1.types.resource_settings.ListSettingsResponse,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
)

Instantiates the pager.

See more: google.cloud.resourcesettings_v1.services.resource_settings_service.pagers.ListSettingsAsyncPager

google.cloud.resourcesettings_v1.services.resource_settings_service.pagers.ListSettingsPager

ListSettingsPager(
    method: typing.Callable[
        [...],
        google.cloud.resourcesettings_v1.types.resource_settings.ListSettingsResponse,
    ],
    request: google.cloud.resourcesettings_v1.types.resource_settings.ListSettingsRequest,
    response: google.cloud.resourcesettings_v1.types.resource_settings.ListSettingsResponse,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
)

Instantiate the pager.

See more: google.cloud.resourcesettings_v1.services.resource_settings_service.pagers.ListSettingsPager