Package Methods (0.1.0)
Stay organized with collections
Save and categorize content based on your preferences.
Summary of entries of Methods for google-cloud-locationfinder.
google.cloud.locationfinder_v1.services.cloud_location_finder.CloudLocationFinderAsyncClient
CloudLocationFinderAsyncClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.locationfinder_v1.services.cloud_location_finder.transports.base.CloudLocationFinderTransport, typing.Callable[[...], google.cloud.locationfinder_v1.services.cloud_location_finder.transports.base.CloudLocationFinderTransport]]] = '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 cloud location finder async client.
See more: google.cloud.locationfinder_v1.services.cloud_location_finder.CloudLocationFinderAsyncClient
google.cloud.locationfinder_v1.services.cloud_location_finder.CloudLocationFinderAsyncClient.cloud_location_path
cloud_location_path(project: str, location: str, cloud_location: str) -> strReturns a fully-qualified cloud_location string.
google.cloud.locationfinder_v1.services.cloud_location_finder.CloudLocationFinderAsyncClient.common_billing_account_path
common_billing_account_path(billing_account: str) -> strReturns a fully-qualified billing_account string.
google.cloud.locationfinder_v1.services.cloud_location_finder.CloudLocationFinderAsyncClient.common_folder_path
common_folder_path(folder: str) -> strReturns a fully-qualified folder string.
google.cloud.locationfinder_v1.services.cloud_location_finder.CloudLocationFinderAsyncClient.common_location_path
common_location_path(project: str, location: str) -> strReturns a fully-qualified location string.
google.cloud.locationfinder_v1.services.cloud_location_finder.CloudLocationFinderAsyncClient.common_organization_path
common_organization_path(organization: str) -> strReturns a fully-qualified organization string.
google.cloud.locationfinder_v1.services.cloud_location_finder.CloudLocationFinderAsyncClient.common_project_path
common_project_path(project: str) -> strReturns a fully-qualified project string.
google.cloud.locationfinder_v1.services.cloud_location_finder.CloudLocationFinderAsyncClient.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.locationfinder_v1.services.cloud_location_finder.CloudLocationFinderAsyncClient.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.locationfinder_v1.services.cloud_location_finder.CloudLocationFinderAsyncClient.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.locationfinder_v1.services.cloud_location_finder.CloudLocationFinderAsyncClient.get_cloud_location
get_cloud_location(
request: typing.Optional[
typing.Union[
google.cloud.locationfinder_v1.types.cloud_location.GetCloudLocationRequest,
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, typing.Union[str, bytes]]] = ()
) -> google.cloud.locationfinder_v1.types.cloud_location.CloudLocationRetrieves a resource containing information about a cloud location.
google.cloud.locationfinder_v1.services.cloud_location_finder.CloudLocationFinderAsyncClient.get_location
get_location(
request: typing.Optional[
google.cloud.location.locations_pb2.GetLocationRequest
] = 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.
google.cloud.locationfinder_v1.services.cloud_location_finder.CloudLocationFinderAsyncClient.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.locationfinder_v1.services.cloud_location_finder.CloudLocationFinderAsyncClient.get_transport_class
get_transport_class(
label: typing.Optional[str] = None,
) -> typing.Type[
google.cloud.locationfinder_v1.services.cloud_location_finder.transports.base.CloudLocationFinderTransport
]Returns an appropriate transport class.
google.cloud.locationfinder_v1.services.cloud_location_finder.CloudLocationFinderAsyncClient.list_cloud_locations
list_cloud_locations(
request: typing.Optional[
typing.Union[
google.cloud.locationfinder_v1.types.cloud_location.ListCloudLocationsRequest,
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.cloud.locationfinder_v1.services.cloud_location_finder.pagers.ListCloudLocationsAsyncPager
)Lists cloud locations under a given project and location.
google.cloud.locationfinder_v1.services.cloud_location_finder.CloudLocationFinderAsyncClient.list_locations
list_locations(
request: typing.Optional[
google.cloud.location.locations_pb2.ListLocationsRequest
] = 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.locationfinder_v1.services.cloud_location_finder.CloudLocationFinderAsyncClient.parse_cloud_location_path
parse_cloud_location_path(path: str) -> typing.Dict[str, str]Parses a cloud_location path into its component segments.
google.cloud.locationfinder_v1.services.cloud_location_finder.CloudLocationFinderAsyncClient.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.locationfinder_v1.services.cloud_location_finder.CloudLocationFinderAsyncClient.parse_common_folder_path
parse_common_folder_path(path: str) -> typing.Dict[str, str]Parse a folder path into its component segments.
google.cloud.locationfinder_v1.services.cloud_location_finder.CloudLocationFinderAsyncClient.parse_common_location_path
parse_common_location_path(path: str) -> typing.Dict[str, str]Parse a location path into its component segments.
google.cloud.locationfinder_v1.services.cloud_location_finder.CloudLocationFinderAsyncClient.parse_common_organization_path
parse_common_organization_path(path: str) -> typing.Dict[str, str]Parse a organization path into its component segments.
google.cloud.locationfinder_v1.services.cloud_location_finder.CloudLocationFinderAsyncClient.parse_common_project_path
parse_common_project_path(path: str) -> typing.Dict[str, str]Parse a project path into its component segments.
google.cloud.locationfinder_v1.services.cloud_location_finder.CloudLocationFinderAsyncClient.search_cloud_locations
search_cloud_locations(
request: typing.Optional[
typing.Union[
google.cloud.locationfinder_v1.types.cloud_location.SearchCloudLocationsRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
source_cloud_location: typing.Optional[str] = None,
query: 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.locationfinder_v1.services.cloud_location_finder.pagers.SearchCloudLocationsAsyncPager
)Searches for cloud locations from a given source location.
google.cloud.locationfinder_v1.services.cloud_location_finder.CloudLocationFinderClient
CloudLocationFinderClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.locationfinder_v1.services.cloud_location_finder.transports.base.CloudLocationFinderTransport, typing.Callable[[...], google.cloud.locationfinder_v1.services.cloud_location_finder.transports.base.CloudLocationFinderTransport]]] = 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 cloud location finder client.
See more: google.cloud.locationfinder_v1.services.cloud_location_finder.CloudLocationFinderClient
google.cloud.locationfinder_v1.services.cloud_location_finder.CloudLocationFinderClient.__exit__
__exit__(type, value, traceback)Releases underlying transport's resources.
See more: google.cloud.locationfinder_v1.services.cloud_location_finder.CloudLocationFinderClient.exit
google.cloud.locationfinder_v1.services.cloud_location_finder.CloudLocationFinderClient.cloud_location_path
cloud_location_path(project: str, location: str, cloud_location: str) -> strReturns a fully-qualified cloud_location string.
google.cloud.locationfinder_v1.services.cloud_location_finder.CloudLocationFinderClient.common_billing_account_path
common_billing_account_path(billing_account: str) -> strReturns a fully-qualified billing_account string.
google.cloud.locationfinder_v1.services.cloud_location_finder.CloudLocationFinderClient.common_folder_path
common_folder_path(folder: str) -> strReturns a fully-qualified folder string.
google.cloud.locationfinder_v1.services.cloud_location_finder.CloudLocationFinderClient.common_location_path
common_location_path(project: str, location: str) -> strReturns a fully-qualified location string.
google.cloud.locationfinder_v1.services.cloud_location_finder.CloudLocationFinderClient.common_organization_path
common_organization_path(organization: str) -> strReturns a fully-qualified organization string.
google.cloud.locationfinder_v1.services.cloud_location_finder.CloudLocationFinderClient.common_project_path
common_project_path(project: str) -> strReturns a fully-qualified project string.
google.cloud.locationfinder_v1.services.cloud_location_finder.CloudLocationFinderClient.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.locationfinder_v1.services.cloud_location_finder.CloudLocationFinderClient.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.locationfinder_v1.services.cloud_location_finder.CloudLocationFinderClient.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.locationfinder_v1.services.cloud_location_finder.CloudLocationFinderClient.get_cloud_location
get_cloud_location(
request: typing.Optional[
typing.Union[
google.cloud.locationfinder_v1.types.cloud_location.GetCloudLocationRequest,
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, typing.Union[str, bytes]]] = ()
) -> google.cloud.locationfinder_v1.types.cloud_location.CloudLocationRetrieves a resource containing information about a cloud location.
google.cloud.locationfinder_v1.services.cloud_location_finder.CloudLocationFinderClient.get_location
get_location(
request: typing.Optional[
google.cloud.location.locations_pb2.GetLocationRequest
] = 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.locationfinder_v1.services.cloud_location_finder.CloudLocationFinderClient.get_location
google.cloud.locationfinder_v1.services.cloud_location_finder.CloudLocationFinderClient.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.locationfinder_v1.services.cloud_location_finder.CloudLocationFinderClient.list_cloud_locations
list_cloud_locations(
request: typing.Optional[
typing.Union[
google.cloud.locationfinder_v1.types.cloud_location.ListCloudLocationsRequest,
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.cloud.locationfinder_v1.services.cloud_location_finder.pagers.ListCloudLocationsPager
)Lists cloud locations under a given project and location.
google.cloud.locationfinder_v1.services.cloud_location_finder.CloudLocationFinderClient.list_locations
list_locations(
request: typing.Optional[
google.cloud.location.locations_pb2.ListLocationsRequest
] = 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.
google.cloud.locationfinder_v1.services.cloud_location_finder.CloudLocationFinderClient.parse_cloud_location_path
parse_cloud_location_path(path: str) -> typing.Dict[str, str]Parses a cloud_location path into its component segments.
google.cloud.locationfinder_v1.services.cloud_location_finder.CloudLocationFinderClient.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.locationfinder_v1.services.cloud_location_finder.CloudLocationFinderClient.parse_common_folder_path
parse_common_folder_path(path: str) -> typing.Dict[str, str]Parse a folder path into its component segments.
google.cloud.locationfinder_v1.services.cloud_location_finder.CloudLocationFinderClient.parse_common_location_path
parse_common_location_path(path: str) -> typing.Dict[str, str]Parse a location path into its component segments.
google.cloud.locationfinder_v1.services.cloud_location_finder.CloudLocationFinderClient.parse_common_organization_path
parse_common_organization_path(path: str) -> typing.Dict[str, str]Parse a organization path into its component segments.
google.cloud.locationfinder_v1.services.cloud_location_finder.CloudLocationFinderClient.parse_common_project_path
parse_common_project_path(path: str) -> typing.Dict[str, str]Parse a project path into its component segments.
google.cloud.locationfinder_v1.services.cloud_location_finder.CloudLocationFinderClient.search_cloud_locations
search_cloud_locations(
request: typing.Optional[
typing.Union[
google.cloud.locationfinder_v1.types.cloud_location.SearchCloudLocationsRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
source_cloud_location: typing.Optional[str] = None,
query: 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.locationfinder_v1.services.cloud_location_finder.pagers.SearchCloudLocationsPager
)Searches for cloud locations from a given source location.
google.cloud.locationfinder_v1.services.cloud_location_finder.pagers.ListCloudLocationsAsyncPager
ListCloudLocationsAsyncPager(
method: typing.Callable[
[...],
typing.Awaitable[
google.cloud.locationfinder_v1.types.cloud_location.ListCloudLocationsResponse
],
],
request: google.cloud.locationfinder_v1.types.cloud_location.ListCloudLocationsRequest,
response: google.cloud.locationfinder_v1.types.cloud_location.ListCloudLocationsResponse,
*,
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]]] = ()
)Instantiates the pager.
See more: google.cloud.locationfinder_v1.services.cloud_location_finder.pagers.ListCloudLocationsAsyncPager
google.cloud.locationfinder_v1.services.cloud_location_finder.pagers.ListCloudLocationsPager
ListCloudLocationsPager(
method: typing.Callable[
[...],
google.cloud.locationfinder_v1.types.cloud_location.ListCloudLocationsResponse,
],
request: google.cloud.locationfinder_v1.types.cloud_location.ListCloudLocationsRequest,
response: google.cloud.locationfinder_v1.types.cloud_location.ListCloudLocationsResponse,
*,
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]]] = ()
)Instantiate the pager.
See more: google.cloud.locationfinder_v1.services.cloud_location_finder.pagers.ListCloudLocationsPager
google.cloud.locationfinder_v1.services.cloud_location_finder.pagers.SearchCloudLocationsAsyncPager
SearchCloudLocationsAsyncPager(
method: typing.Callable[
[...],
typing.Awaitable[
google.cloud.locationfinder_v1.types.cloud_location.SearchCloudLocationsResponse
],
],
request: google.cloud.locationfinder_v1.types.cloud_location.SearchCloudLocationsRequest,
response: google.cloud.locationfinder_v1.types.cloud_location.SearchCloudLocationsResponse,
*,
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]]] = ()
)Instantiates the pager.
See more: google.cloud.locationfinder_v1.services.cloud_location_finder.pagers.SearchCloudLocationsAsyncPager
google.cloud.locationfinder_v1.services.cloud_location_finder.pagers.SearchCloudLocationsPager
SearchCloudLocationsPager(
method: typing.Callable[
[...],
google.cloud.locationfinder_v1.types.cloud_location.SearchCloudLocationsResponse,
],
request: google.cloud.locationfinder_v1.types.cloud_location.SearchCloudLocationsRequest,
response: google.cloud.locationfinder_v1.types.cloud_location.SearchCloudLocationsResponse,
*,
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]]] = ()
)Instantiate the pager.
See more: google.cloud.locationfinder_v1.services.cloud_location_finder.pagers.SearchCloudLocationsPager