Summary of entries of Methods for google-cloud-workloadidentity.
google.cloud.workloadidentity_v1.services.workload_identity.WorkloadIdentityAsyncClient
WorkloadIdentityAsyncClient(
*,
credentials: typing.Optional[google.auth.credentials.Credentials] = None,
transport: typing.Optional[
typing.Union[
str,
google.cloud.workloadidentity_v1.services.workload_identity.transports.base.WorkloadIdentityTransport,
typing.Callable[
[...],
google.cloud.workloadidentity_v1.services.workload_identity.transports.base.WorkloadIdentityTransport,
],
]
] = "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 workload identity async client.
See more: google.cloud.workloadidentity_v1.services.workload_identity.WorkloadIdentityAsyncClient
google.cloud.workloadidentity_v1.services.workload_identity.WorkloadIdentityAsyncClient.cancel_operation
cancel_operation(
request: typing.Optional[
typing.Union[google.longrunning.operations_pb2.CancelOperationRequest, 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]]] = ()
) -> NoneStarts asynchronous cancellation on a long-running operation.
google.cloud.workloadidentity_v1.services.workload_identity.WorkloadIdentityAsyncClient.common_billing_account_path
common_billing_account_path(billing_account: str) -> strReturns a fully-qualified billing_account string.
google.cloud.workloadidentity_v1.services.workload_identity.WorkloadIdentityAsyncClient.common_folder_path
common_folder_path(folder: str) -> strReturns a fully-qualified folder string.
google.cloud.workloadidentity_v1.services.workload_identity.WorkloadIdentityAsyncClient.common_location_path
common_location_path(project: str, location: str) -> strReturns a fully-qualified location string.
google.cloud.workloadidentity_v1.services.workload_identity.WorkloadIdentityAsyncClient.common_organization_path
common_organization_path(organization: str) -> strReturns a fully-qualified organization string.
google.cloud.workloadidentity_v1.services.workload_identity.WorkloadIdentityAsyncClient.common_project_path
common_project_path(project: str) -> strReturns a fully-qualified project string.
google.cloud.workloadidentity_v1.services.workload_identity.WorkloadIdentityAsyncClient.delete_operation
delete_operation(
request: typing.Optional[
typing.Union[google.longrunning.operations_pb2.DeleteOperationRequest, 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]]] = ()
) -> NoneDeletes a long-running operation.
google.cloud.workloadidentity_v1.services.workload_identity.WorkloadIdentityAsyncClient.from_service_account_file
from_service_account_file(filename: str, *args, **kwargs)Creates an instance of this client using the provided credentials file.
google.cloud.workloadidentity_v1.services.workload_identity.WorkloadIdentityAsyncClient.from_service_account_info
from_service_account_info(info: dict, *args, **kwargs)Creates an instance of this client using the provided credentials info.
google.cloud.workloadidentity_v1.services.workload_identity.WorkloadIdentityAsyncClient.from_service_account_json
from_service_account_json(filename: str, *args, **kwargs)Creates an instance of this client using the provided credentials file.
google.cloud.workloadidentity_v1.services.workload_identity.WorkloadIdentityAsyncClient.generate_service_agents
generate_service_agents(
request: typing.Optional[
typing.Union[
google.cloud.workloadidentity_v1.types.service.GenerateServiceAgentsRequest,
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, typing.Union[str, bytes]]] = ()
) -> google.api_core.operation_async.AsyncOperationCreates all service agents for a given resource, location and service producer.
google.cloud.workloadidentity_v1.services.workload_identity.WorkloadIdentityAsyncClient.get_location
get_location(
request: typing.Optional[
typing.Union[google.cloud.location.locations_pb2.GetLocationRequest, 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.location.locations_pb2.LocationGets information about a location.
See more: google.cloud.workloadidentity_v1.services.workload_identity.WorkloadIdentityAsyncClient.get_location
google.cloud.workloadidentity_v1.services.workload_identity.WorkloadIdentityAsyncClient.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.
google.cloud.workloadidentity_v1.services.workload_identity.WorkloadIdentityAsyncClient.get_operation
get_operation(
request: typing.Optional[
typing.Union[google.longrunning.operations_pb2.GetOperationRequest, 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.longrunning.operations_pb2.OperationGets the latest state of a long-running operation.
google.cloud.workloadidentity_v1.services.workload_identity.WorkloadIdentityAsyncClient.get_transport_class
get_transport_class(
label: typing.Optional[str] = None,
) -> typing.Type[
google.cloud.workloadidentity_v1.services.workload_identity.transports.base.WorkloadIdentityTransport
]Returns an appropriate transport class.
google.cloud.workloadidentity_v1.services.workload_identity.WorkloadIdentityAsyncClient.list_locations
list_locations(
request: typing.Optional[
typing.Union[google.cloud.location.locations_pb2.ListLocationsRequest, 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.location.locations_pb2.ListLocationsResponseLists information about the supported locations for this service.
google.cloud.workloadidentity_v1.services.workload_identity.WorkloadIdentityAsyncClient.list_operations
list_operations(
request: typing.Optional[
typing.Union[google.longrunning.operations_pb2.ListOperationsRequest, 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.longrunning.operations_pb2.ListOperationsResponseLists operations that match the specified filter in the request.
google.cloud.workloadidentity_v1.services.workload_identity.WorkloadIdentityAsyncClient.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.
google.cloud.workloadidentity_v1.services.workload_identity.WorkloadIdentityAsyncClient.parse_common_folder_path
parse_common_folder_path(path: str) -> typing.Dict[str, str]Parse a folder path into its component segments.
google.cloud.workloadidentity_v1.services.workload_identity.WorkloadIdentityAsyncClient.parse_common_location_path
parse_common_location_path(path: str) -> typing.Dict[str, str]Parse a location path into its component segments.
google.cloud.workloadidentity_v1.services.workload_identity.WorkloadIdentityAsyncClient.parse_common_organization_path
parse_common_organization_path(path: str) -> typing.Dict[str, str]Parse a organization path into its component segments.
google.cloud.workloadidentity_v1.services.workload_identity.WorkloadIdentityAsyncClient.parse_common_project_path
parse_common_project_path(path: str) -> typing.Dict[str, str]Parse a project path into its component segments.
google.cloud.workloadidentity_v1.services.workload_identity.WorkloadIdentityAsyncClient.parse_service_agent_path
parse_service_agent_path(path: str) -> typing.Dict[str, str]Parses a service_agent path into its component segments.
google.cloud.workloadidentity_v1.services.workload_identity.WorkloadIdentityAsyncClient.parse_service_producer_path
parse_service_producer_path(path: str) -> typing.Dict[str, str]Parses a service_producer path into its component segments.
google.cloud.workloadidentity_v1.services.workload_identity.WorkloadIdentityAsyncClient.service_agent_path
service_agent_path(
project: str, location: str, service_producer: str, service_agent: str
) -> strReturns a fully-qualified service_agent string.
google.cloud.workloadidentity_v1.services.workload_identity.WorkloadIdentityAsyncClient.service_producer_path
service_producer_path(project: str, location: str, service_producer: str) -> strReturns a fully-qualified service_producer string.
google.cloud.workloadidentity_v1.services.workload_identity.WorkloadIdentityClient
WorkloadIdentityClient(
*,
credentials: typing.Optional[google.auth.credentials.Credentials] = None,
transport: typing.Optional[
typing.Union[
str,
google.cloud.workloadidentity_v1.services.workload_identity.transports.base.WorkloadIdentityTransport,
typing.Callable[
[...],
google.cloud.workloadidentity_v1.services.workload_identity.transports.base.WorkloadIdentityTransport,
],
]
] = 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 workload identity client.
See more: google.cloud.workloadidentity_v1.services.workload_identity.WorkloadIdentityClient
google.cloud.workloadidentity_v1.services.workload_identity.WorkloadIdentityClient.__exit__
__exit__(type, value, traceback)Releases underlying transport's resources.
See more: google.cloud.workloadidentity_v1.services.workload_identity.WorkloadIdentityClient.exit
google.cloud.workloadidentity_v1.services.workload_identity.WorkloadIdentityClient.cancel_operation
cancel_operation(
request: typing.Optional[
typing.Union[google.longrunning.operations_pb2.CancelOperationRequest, 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]]] = ()
) -> NoneStarts asynchronous cancellation on a long-running operation.
See more: google.cloud.workloadidentity_v1.services.workload_identity.WorkloadIdentityClient.cancel_operation
google.cloud.workloadidentity_v1.services.workload_identity.WorkloadIdentityClient.common_billing_account_path
common_billing_account_path(billing_account: str) -> strReturns a fully-qualified billing_account string.
google.cloud.workloadidentity_v1.services.workload_identity.WorkloadIdentityClient.common_folder_path
common_folder_path(folder: str) -> strReturns a fully-qualified folder string.
google.cloud.workloadidentity_v1.services.workload_identity.WorkloadIdentityClient.common_location_path
common_location_path(project: str, location: str) -> strReturns a fully-qualified location string.
google.cloud.workloadidentity_v1.services.workload_identity.WorkloadIdentityClient.common_organization_path
common_organization_path(organization: str) -> strReturns a fully-qualified organization string.
google.cloud.workloadidentity_v1.services.workload_identity.WorkloadIdentityClient.common_project_path
common_project_path(project: str) -> strReturns a fully-qualified project string.
google.cloud.workloadidentity_v1.services.workload_identity.WorkloadIdentityClient.delete_operation
delete_operation(
request: typing.Optional[
typing.Union[google.longrunning.operations_pb2.DeleteOperationRequest, 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]]] = ()
) -> NoneDeletes a long-running operation.
See more: google.cloud.workloadidentity_v1.services.workload_identity.WorkloadIdentityClient.delete_operation
google.cloud.workloadidentity_v1.services.workload_identity.WorkloadIdentityClient.from_service_account_file
from_service_account_file(filename: str, *args, **kwargs)Creates an instance of this client using the provided credentials file.
google.cloud.workloadidentity_v1.services.workload_identity.WorkloadIdentityClient.from_service_account_info
from_service_account_info(info: dict, *args, **kwargs)Creates an instance of this client using the provided credentials info.
google.cloud.workloadidentity_v1.services.workload_identity.WorkloadIdentityClient.from_service_account_json
from_service_account_json(filename: str, *args, **kwargs)Creates an instance of this client using the provided credentials file.
google.cloud.workloadidentity_v1.services.workload_identity.WorkloadIdentityClient.generate_service_agents
generate_service_agents(
request: typing.Optional[
typing.Union[
google.cloud.workloadidentity_v1.types.service.GenerateServiceAgentsRequest,
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, typing.Union[str, bytes]]] = ()
) -> google.api_core.operation.OperationCreates all service agents for a given resource, location and service producer.
google.cloud.workloadidentity_v1.services.workload_identity.WorkloadIdentityClient.get_location
get_location(
request: typing.Optional[
typing.Union[google.cloud.location.locations_pb2.GetLocationRequest, 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.location.locations_pb2.LocationGets information about a location.
See more: google.cloud.workloadidentity_v1.services.workload_identity.WorkloadIdentityClient.get_location
google.cloud.workloadidentity_v1.services.workload_identity.WorkloadIdentityClient.get_mtls_endpoint_and_cert_source
get_mtls_endpoint_and_cert_source(
client_options: typing.Optional[
google.api_core.client_options.ClientOptions
] = None,
)Deprecated.
google.cloud.workloadidentity_v1.services.workload_identity.WorkloadIdentityClient.get_operation
get_operation(
request: typing.Optional[
typing.Union[google.longrunning.operations_pb2.GetOperationRequest, 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.longrunning.operations_pb2.OperationGets the latest state of a long-running operation.
See more: google.cloud.workloadidentity_v1.services.workload_identity.WorkloadIdentityClient.get_operation
google.cloud.workloadidentity_v1.services.workload_identity.WorkloadIdentityClient.list_locations
list_locations(
request: typing.Optional[
typing.Union[google.cloud.location.locations_pb2.ListLocationsRequest, 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.location.locations_pb2.ListLocationsResponseLists information about the supported locations for this service.
See more: google.cloud.workloadidentity_v1.services.workload_identity.WorkloadIdentityClient.list_locations
google.cloud.workloadidentity_v1.services.workload_identity.WorkloadIdentityClient.list_operations
list_operations(
request: typing.Optional[
typing.Union[google.longrunning.operations_pb2.ListOperationsRequest, 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.longrunning.operations_pb2.ListOperationsResponseLists operations that match the specified filter in the request.
See more: google.cloud.workloadidentity_v1.services.workload_identity.WorkloadIdentityClient.list_operations
google.cloud.workloadidentity_v1.services.workload_identity.WorkloadIdentityClient.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.
google.cloud.workloadidentity_v1.services.workload_identity.WorkloadIdentityClient.parse_common_folder_path
parse_common_folder_path(path: str) -> typing.Dict[str, str]Parse a folder path into its component segments.
google.cloud.workloadidentity_v1.services.workload_identity.WorkloadIdentityClient.parse_common_location_path
parse_common_location_path(path: str) -> typing.Dict[str, str]Parse a location path into its component segments.
google.cloud.workloadidentity_v1.services.workload_identity.WorkloadIdentityClient.parse_common_organization_path
parse_common_organization_path(path: str) -> typing.Dict[str, str]Parse a organization path into its component segments.
google.cloud.workloadidentity_v1.services.workload_identity.WorkloadIdentityClient.parse_common_project_path
parse_common_project_path(path: str) -> typing.Dict[str, str]Parse a project path into its component segments.
google.cloud.workloadidentity_v1.services.workload_identity.WorkloadIdentityClient.parse_service_agent_path
parse_service_agent_path(path: str) -> typing.Dict[str, str]Parses a service_agent path into its component segments.
google.cloud.workloadidentity_v1.services.workload_identity.WorkloadIdentityClient.parse_service_producer_path
parse_service_producer_path(path: str) -> typing.Dict[str, str]Parses a service_producer path into its component segments.
google.cloud.workloadidentity_v1.services.workload_identity.WorkloadIdentityClient.service_agent_path
service_agent_path(
project: str, location: str, service_producer: str, service_agent: str
) -> strReturns a fully-qualified service_agent string.
google.cloud.workloadidentity_v1.services.workload_identity.WorkloadIdentityClient.service_producer_path
service_producer_path(project: str, location: str, service_producer: str) -> strReturns a fully-qualified service_producer string.