Package Methods (0.1.0)

Summary of entries of Methods for google-cloud-agentidentitycredentials.

google.cloud.agentidentitycredentials_v1.services.auth_provider_credentials_service.AuthProviderCredentialsServiceAsyncClient

AuthProviderCredentialsServiceAsyncClient(
    *,
    credentials: typing.Optional[google.auth.credentials.Credentials] = None,
    transport: typing.Optional[
        typing.Union[
            str,
            google.cloud.agentidentitycredentials_v1.services.auth_provider_credentials_service.transports.base.AuthProviderCredentialsServiceTransport,
            typing.Callable[
                [...],
                google.cloud.agentidentitycredentials_v1.services.auth_provider_credentials_service.transports.base.AuthProviderCredentialsServiceTransport,
            ],
        ]
    ] = "grpc_asyncio",
    client_options: typing.Optional[
        google.api_core.client_options.ClientOptions
    ] = None,
    client_info: google.api_core.gapic_v1.client_info.ClientInfo = google.api_core.gapic_v1.client_info.ClientInfo
)

Instantiates the auth provider credentials service async client.

See more: google.cloud.agentidentitycredentials_v1.services.auth_provider_credentials_service.AuthProviderCredentialsServiceAsyncClient

google.cloud.agentidentitycredentials_v1.services.auth_provider_credentials_service.AuthProviderCredentialsServiceAsyncClient.auth_provider_path

auth_provider_path(project: str, location: str, auth_provider: str) -> str

Returns a fully-qualified auth_provider string.

See more: google.cloud.agentidentitycredentials_v1.services.auth_provider_credentials_service.AuthProviderCredentialsServiceAsyncClient.auth_provider_path

google.cloud.agentidentitycredentials_v1.services.auth_provider_credentials_service.AuthProviderCredentialsServiceAsyncClient.common_billing_account_path

common_billing_account_path(billing_account: str) -> str

Returns a fully-qualified billing_account string.

See more: google.cloud.agentidentitycredentials_v1.services.auth_provider_credentials_service.AuthProviderCredentialsServiceAsyncClient.common_billing_account_path

google.cloud.agentidentitycredentials_v1.services.auth_provider_credentials_service.AuthProviderCredentialsServiceAsyncClient.common_folder_path

common_folder_path(folder: str) -> str

Returns a fully-qualified folder string.

See more: google.cloud.agentidentitycredentials_v1.services.auth_provider_credentials_service.AuthProviderCredentialsServiceAsyncClient.common_folder_path

google.cloud.agentidentitycredentials_v1.services.auth_provider_credentials_service.AuthProviderCredentialsServiceAsyncClient.common_location_path

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

Returns a fully-qualified location string.

See more: google.cloud.agentidentitycredentials_v1.services.auth_provider_credentials_service.AuthProviderCredentialsServiceAsyncClient.common_location_path

google.cloud.agentidentitycredentials_v1.services.auth_provider_credentials_service.AuthProviderCredentialsServiceAsyncClient.common_organization_path

common_organization_path(organization: str) -> str

Returns a fully-qualified organization string.

See more: google.cloud.agentidentitycredentials_v1.services.auth_provider_credentials_service.AuthProviderCredentialsServiceAsyncClient.common_organization_path

google.cloud.agentidentitycredentials_v1.services.auth_provider_credentials_service.AuthProviderCredentialsServiceAsyncClient.common_project_path

common_project_path(project: str) -> str

Returns a fully-qualified project string.

See more: google.cloud.agentidentitycredentials_v1.services.auth_provider_credentials_service.AuthProviderCredentialsServiceAsyncClient.common_project_path

google.cloud.agentidentitycredentials_v1.services.auth_provider_credentials_service.AuthProviderCredentialsServiceAsyncClient.finalize_credentials

finalize_credentials(
    request: typing.Optional[
        typing.Union[
            google.cloud.agentidentitycredentials_v1.types.auth_provider_credentials_service.FinalizeCredentialsRequest,
            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, typing.Union[str, bytes]]] = ()
) -> (
    google.cloud.agentidentitycredentials_v1.types.auth_provider_credentials_service.FinalizeCredentialsResponse
)

Finalizes the credentials after a successful consent flow.

See more: google.cloud.agentidentitycredentials_v1.services.auth_provider_credentials_service.AuthProviderCredentialsServiceAsyncClient.finalize_credentials

google.cloud.agentidentitycredentials_v1.services.auth_provider_credentials_service.AuthProviderCredentialsServiceAsyncClient.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.agentidentitycredentials_v1.services.auth_provider_credentials_service.AuthProviderCredentialsServiceAsyncClient.from_service_account_file

google.cloud.agentidentitycredentials_v1.services.auth_provider_credentials_service.AuthProviderCredentialsServiceAsyncClient.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.agentidentitycredentials_v1.services.auth_provider_credentials_service.AuthProviderCredentialsServiceAsyncClient.from_service_account_info

google.cloud.agentidentitycredentials_v1.services.auth_provider_credentials_service.AuthProviderCredentialsServiceAsyncClient.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.agentidentitycredentials_v1.services.auth_provider_credentials_service.AuthProviderCredentialsServiceAsyncClient.from_service_account_json

google.cloud.agentidentitycredentials_v1.services.auth_provider_credentials_service.AuthProviderCredentialsServiceAsyncClient.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.agentidentitycredentials_v1.services.auth_provider_credentials_service.AuthProviderCredentialsServiceAsyncClient.get_mtls_endpoint_and_cert_source

google.cloud.agentidentitycredentials_v1.services.auth_provider_credentials_service.AuthProviderCredentialsServiceAsyncClient.get_transport_class

get_transport_class(
    label: typing.Optional[str] = None,
) -> typing.Type[
    google.cloud.agentidentitycredentials_v1.services.auth_provider_credentials_service.transports.base.AuthProviderCredentialsServiceTransport
]

Returns an appropriate transport class.

See more: google.cloud.agentidentitycredentials_v1.services.auth_provider_credentials_service.AuthProviderCredentialsServiceAsyncClient.get_transport_class

google.cloud.agentidentitycredentials_v1.services.auth_provider_credentials_service.AuthProviderCredentialsServiceAsyncClient.parse_auth_provider_path

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

Parses a auth_provider path into its component segments.

See more: google.cloud.agentidentitycredentials_v1.services.auth_provider_credentials_service.AuthProviderCredentialsServiceAsyncClient.parse_auth_provider_path

google.cloud.agentidentitycredentials_v1.services.auth_provider_credentials_service.AuthProviderCredentialsServiceAsyncClient.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.agentidentitycredentials_v1.services.auth_provider_credentials_service.AuthProviderCredentialsServiceAsyncClient.parse_common_billing_account_path

google.cloud.agentidentitycredentials_v1.services.auth_provider_credentials_service.AuthProviderCredentialsServiceAsyncClient.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.agentidentitycredentials_v1.services.auth_provider_credentials_service.AuthProviderCredentialsServiceAsyncClient.parse_common_folder_path

google.cloud.agentidentitycredentials_v1.services.auth_provider_credentials_service.AuthProviderCredentialsServiceAsyncClient.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.agentidentitycredentials_v1.services.auth_provider_credentials_service.AuthProviderCredentialsServiceAsyncClient.parse_common_location_path

google.cloud.agentidentitycredentials_v1.services.auth_provider_credentials_service.AuthProviderCredentialsServiceAsyncClient.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.agentidentitycredentials_v1.services.auth_provider_credentials_service.AuthProviderCredentialsServiceAsyncClient.parse_common_organization_path

google.cloud.agentidentitycredentials_v1.services.auth_provider_credentials_service.AuthProviderCredentialsServiceAsyncClient.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.agentidentitycredentials_v1.services.auth_provider_credentials_service.AuthProviderCredentialsServiceAsyncClient.parse_common_project_path

google.cloud.agentidentitycredentials_v1.services.auth_provider_credentials_service.AuthProviderCredentialsServiceAsyncClient.retrieve_credentials

retrieve_credentials(
    request: typing.Optional[
        typing.Union[
            google.cloud.agentidentitycredentials_v1.types.auth_provider_credentials_service.RetrieveCredentialsRequest,
            dict,
        ]
    ] = None,
    *,
    auth_provider: typing.Optional[str] = None,
    user_id: 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, typing.Union[str, bytes]]] = ()
) -> (
    google.cloud.agentidentitycredentials_v1.types.auth_provider_credentials_service.RetrieveCredentialsResponse
)

Retrieves authorization credentials for an authprovider, or indicates what action needs to be taken to obtain credentials.

See more: google.cloud.agentidentitycredentials_v1.services.auth_provider_credentials_service.AuthProviderCredentialsServiceAsyncClient.retrieve_credentials

google.cloud.agentidentitycredentials_v1.services.auth_provider_credentials_service.AuthProviderCredentialsServiceClient

AuthProviderCredentialsServiceClient(
    *,
    credentials: typing.Optional[google.auth.credentials.Credentials] = None,
    transport: typing.Optional[
        typing.Union[
            str,
            google.cloud.agentidentitycredentials_v1.services.auth_provider_credentials_service.transports.base.AuthProviderCredentialsServiceTransport,
            typing.Callable[
                [...],
                google.cloud.agentidentitycredentials_v1.services.auth_provider_credentials_service.transports.base.AuthProviderCredentialsServiceTransport,
            ],
        ]
    ] = 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 = google.api_core.gapic_v1.client_info.ClientInfo
)

Instantiates the auth provider credentials service client.

See more: google.cloud.agentidentitycredentials_v1.services.auth_provider_credentials_service.AuthProviderCredentialsServiceClient

google.cloud.agentidentitycredentials_v1.services.auth_provider_credentials_service.AuthProviderCredentialsServiceClient.__exit__

__exit__(type, value, traceback)

Releases underlying transport's resources.

See more: google.cloud.agentidentitycredentials_v1.services.auth_provider_credentials_service.AuthProviderCredentialsServiceClient.exit

google.cloud.agentidentitycredentials_v1.services.auth_provider_credentials_service.AuthProviderCredentialsServiceClient.auth_provider_path

auth_provider_path(project: str, location: str, auth_provider: str) -> str

Returns a fully-qualified auth_provider string.

See more: google.cloud.agentidentitycredentials_v1.services.auth_provider_credentials_service.AuthProviderCredentialsServiceClient.auth_provider_path

google.cloud.agentidentitycredentials_v1.services.auth_provider_credentials_service.AuthProviderCredentialsServiceClient.common_billing_account_path

common_billing_account_path(billing_account: str) -> str

Returns a fully-qualified billing_account string.

See more: google.cloud.agentidentitycredentials_v1.services.auth_provider_credentials_service.AuthProviderCredentialsServiceClient.common_billing_account_path

google.cloud.agentidentitycredentials_v1.services.auth_provider_credentials_service.AuthProviderCredentialsServiceClient.common_folder_path

common_folder_path(folder: str) -> str

Returns a fully-qualified folder string.

See more: google.cloud.agentidentitycredentials_v1.services.auth_provider_credentials_service.AuthProviderCredentialsServiceClient.common_folder_path

google.cloud.agentidentitycredentials_v1.services.auth_provider_credentials_service.AuthProviderCredentialsServiceClient.common_location_path

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

Returns a fully-qualified location string.

See more: google.cloud.agentidentitycredentials_v1.services.auth_provider_credentials_service.AuthProviderCredentialsServiceClient.common_location_path

google.cloud.agentidentitycredentials_v1.services.auth_provider_credentials_service.AuthProviderCredentialsServiceClient.common_organization_path

common_organization_path(organization: str) -> str

Returns a fully-qualified organization string.

See more: google.cloud.agentidentitycredentials_v1.services.auth_provider_credentials_service.AuthProviderCredentialsServiceClient.common_organization_path

google.cloud.agentidentitycredentials_v1.services.auth_provider_credentials_service.AuthProviderCredentialsServiceClient.common_project_path

common_project_path(project: str) -> str

Returns a fully-qualified project string.

See more: google.cloud.agentidentitycredentials_v1.services.auth_provider_credentials_service.AuthProviderCredentialsServiceClient.common_project_path

google.cloud.agentidentitycredentials_v1.services.auth_provider_credentials_service.AuthProviderCredentialsServiceClient.finalize_credentials

finalize_credentials(
    request: typing.Optional[
        typing.Union[
            google.cloud.agentidentitycredentials_v1.types.auth_provider_credentials_service.FinalizeCredentialsRequest,
            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, typing.Union[str, bytes]]] = ()
) -> (
    google.cloud.agentidentitycredentials_v1.types.auth_provider_credentials_service.FinalizeCredentialsResponse
)

Finalizes the credentials after a successful consent flow.

See more: google.cloud.agentidentitycredentials_v1.services.auth_provider_credentials_service.AuthProviderCredentialsServiceClient.finalize_credentials

google.cloud.agentidentitycredentials_v1.services.auth_provider_credentials_service.AuthProviderCredentialsServiceClient.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.agentidentitycredentials_v1.services.auth_provider_credentials_service.AuthProviderCredentialsServiceClient.from_service_account_file

google.cloud.agentidentitycredentials_v1.services.auth_provider_credentials_service.AuthProviderCredentialsServiceClient.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.agentidentitycredentials_v1.services.auth_provider_credentials_service.AuthProviderCredentialsServiceClient.from_service_account_info

google.cloud.agentidentitycredentials_v1.services.auth_provider_credentials_service.AuthProviderCredentialsServiceClient.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.agentidentitycredentials_v1.services.auth_provider_credentials_service.AuthProviderCredentialsServiceClient.from_service_account_json

google.cloud.agentidentitycredentials_v1.services.auth_provider_credentials_service.AuthProviderCredentialsServiceClient.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.agentidentitycredentials_v1.services.auth_provider_credentials_service.AuthProviderCredentialsServiceClient.get_mtls_endpoint_and_cert_source

google.cloud.agentidentitycredentials_v1.services.auth_provider_credentials_service.AuthProviderCredentialsServiceClient.parse_auth_provider_path

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

Parses a auth_provider path into its component segments.

See more: google.cloud.agentidentitycredentials_v1.services.auth_provider_credentials_service.AuthProviderCredentialsServiceClient.parse_auth_provider_path

google.cloud.agentidentitycredentials_v1.services.auth_provider_credentials_service.AuthProviderCredentialsServiceClient.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.agentidentitycredentials_v1.services.auth_provider_credentials_service.AuthProviderCredentialsServiceClient.parse_common_billing_account_path

google.cloud.agentidentitycredentials_v1.services.auth_provider_credentials_service.AuthProviderCredentialsServiceClient.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.agentidentitycredentials_v1.services.auth_provider_credentials_service.AuthProviderCredentialsServiceClient.parse_common_folder_path

google.cloud.agentidentitycredentials_v1.services.auth_provider_credentials_service.AuthProviderCredentialsServiceClient.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.agentidentitycredentials_v1.services.auth_provider_credentials_service.AuthProviderCredentialsServiceClient.parse_common_location_path

google.cloud.agentidentitycredentials_v1.services.auth_provider_credentials_service.AuthProviderCredentialsServiceClient.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.agentidentitycredentials_v1.services.auth_provider_credentials_service.AuthProviderCredentialsServiceClient.parse_common_organization_path

google.cloud.agentidentitycredentials_v1.services.auth_provider_credentials_service.AuthProviderCredentialsServiceClient.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.agentidentitycredentials_v1.services.auth_provider_credentials_service.AuthProviderCredentialsServiceClient.parse_common_project_path

google.cloud.agentidentitycredentials_v1.services.auth_provider_credentials_service.AuthProviderCredentialsServiceClient.retrieve_credentials

retrieve_credentials(
    request: typing.Optional[
        typing.Union[
            google.cloud.agentidentitycredentials_v1.types.auth_provider_credentials_service.RetrieveCredentialsRequest,
            dict,
        ]
    ] = None,
    *,
    auth_provider: typing.Optional[str] = None,
    user_id: 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, typing.Union[str, bytes]]] = ()
) -> (
    google.cloud.agentidentitycredentials_v1.types.auth_provider_credentials_service.RetrieveCredentialsResponse
)

Retrieves authorization credentials for an authprovider, or indicates what action needs to be taken to obtain credentials.

See more: google.cloud.agentidentitycredentials_v1.services.auth_provider_credentials_service.AuthProviderCredentialsServiceClient.retrieve_credentials