Package Methods (0.1.0)

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) -> str

google.cloud.locationfinder_v1.services.cloud_location_finder.CloudLocationFinderAsyncClient.common_billing_account_path

common_billing_account_path(billing_account: str) -> str

google.cloud.locationfinder_v1.services.cloud_location_finder.CloudLocationFinderAsyncClient.common_folder_path

common_folder_path(folder: str) -> str

google.cloud.locationfinder_v1.services.cloud_location_finder.CloudLocationFinderAsyncClient.common_location_path

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

google.cloud.locationfinder_v1.services.cloud_location_finder.CloudLocationFinderAsyncClient.common_organization_path

common_organization_path(organization: str) -> str

google.cloud.locationfinder_v1.services.cloud_location_finder.CloudLocationFinderAsyncClient.common_project_path

common_project_path(project: str) -> str

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.

See more: google.cloud.locationfinder_v1.services.cloud_location_finder.CloudLocationFinderAsyncClient.from_service_account_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.

See more: google.cloud.locationfinder_v1.services.cloud_location_finder.CloudLocationFinderAsyncClient.from_service_account_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.

See more: google.cloud.locationfinder_v1.services.cloud_location_finder.CloudLocationFinderAsyncClient.from_service_account_json

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.CloudLocation

Retrieves a resource containing information about a cloud location.

See more: google.cloud.locationfinder_v1.services.cloud_location_finder.CloudLocationFinderAsyncClient.get_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.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,
)

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
]

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
)

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.ListLocationsResponse

Lists information about the supported locations for this service.

See more: google.cloud.locationfinder_v1.services.cloud_location_finder.CloudLocationFinderAsyncClient.list_locations

google.cloud.locationfinder_v1.services.cloud_location_finder.CloudLocationFinderAsyncClient.parse_cloud_location_path

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

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]

google.cloud.locationfinder_v1.services.cloud_location_finder.CloudLocationFinderAsyncClient.parse_common_folder_path

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

google.cloud.locationfinder_v1.services.cloud_location_finder.CloudLocationFinderAsyncClient.parse_common_location_path

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

google.cloud.locationfinder_v1.services.cloud_location_finder.CloudLocationFinderAsyncClient.parse_common_organization_path

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

google.cloud.locationfinder_v1.services.cloud_location_finder.CloudLocationFinderAsyncClient.parse_common_project_path

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

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
)

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)

google.cloud.locationfinder_v1.services.cloud_location_finder.CloudLocationFinderClient.cloud_location_path

cloud_location_path(project: str, location: str, cloud_location: str) -> str

google.cloud.locationfinder_v1.services.cloud_location_finder.CloudLocationFinderClient.common_billing_account_path

common_billing_account_path(billing_account: str) -> str

google.cloud.locationfinder_v1.services.cloud_location_finder.CloudLocationFinderClient.common_folder_path

common_folder_path(folder: str) -> str

google.cloud.locationfinder_v1.services.cloud_location_finder.CloudLocationFinderClient.common_location_path

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

google.cloud.locationfinder_v1.services.cloud_location_finder.CloudLocationFinderClient.common_organization_path

common_organization_path(organization: str) -> str

google.cloud.locationfinder_v1.services.cloud_location_finder.CloudLocationFinderClient.common_project_path

common_project_path(project: str) -> str

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.

See more: google.cloud.locationfinder_v1.services.cloud_location_finder.CloudLocationFinderClient.from_service_account_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.

See more: google.cloud.locationfinder_v1.services.cloud_location_finder.CloudLocationFinderClient.from_service_account_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.

See more: google.cloud.locationfinder_v1.services.cloud_location_finder.CloudLocationFinderClient.from_service_account_json

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.CloudLocation

Retrieves a resource containing information about a cloud location.

See more: google.cloud.locationfinder_v1.services.cloud_location_finder.CloudLocationFinderClient.get_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.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,
)

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
)

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.ListLocationsResponse

Lists information about the supported locations for this service.

See more: google.cloud.locationfinder_v1.services.cloud_location_finder.CloudLocationFinderClient.list_locations

google.cloud.locationfinder_v1.services.cloud_location_finder.CloudLocationFinderClient.parse_cloud_location_path

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

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]

google.cloud.locationfinder_v1.services.cloud_location_finder.CloudLocationFinderClient.parse_common_folder_path

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

google.cloud.locationfinder_v1.services.cloud_location_finder.CloudLocationFinderClient.parse_common_location_path

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

google.cloud.locationfinder_v1.services.cloud_location_finder.CloudLocationFinderClient.parse_common_organization_path

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

google.cloud.locationfinder_v1.services.cloud_location_finder.CloudLocationFinderClient.parse_common_project_path

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

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
)

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]]] = ()
)

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]]] = ()
)

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]]] = ()
)

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]]] = ()
)