Package Methods (1.7.4)

Summary of entries of Methods for ids.

google.cloud.ids_v1.services.ids.IDSAsyncClient

IDSAsyncClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.ids_v1.services.ids.transports.base.IDSTransport, typing.Callable[[...], google.cloud.ids_v1.services.ids.transports.base.IDSTransport]]] = '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 ids async client.

See more: google.cloud.ids_v1.services.ids.IDSAsyncClient

google.cloud.ids_v1.services.ids.IDSAsyncClient.common_billing_account_path

common_billing_account_path(billing_account: str) -> str

Returns a fully-qualified billing_account string.

See more: google.cloud.ids_v1.services.ids.IDSAsyncClient.common_billing_account_path

google.cloud.ids_v1.services.ids.IDSAsyncClient.common_folder_path

common_folder_path(folder: str) -> str

Returns a fully-qualified folder string.

See more: google.cloud.ids_v1.services.ids.IDSAsyncClient.common_folder_path

google.cloud.ids_v1.services.ids.IDSAsyncClient.common_location_path

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

Returns a fully-qualified location string.

See more: google.cloud.ids_v1.services.ids.IDSAsyncClient.common_location_path

google.cloud.ids_v1.services.ids.IDSAsyncClient.common_organization_path

common_organization_path(organization: str) -> str

Returns a fully-qualified organization string.

See more: google.cloud.ids_v1.services.ids.IDSAsyncClient.common_organization_path

google.cloud.ids_v1.services.ids.IDSAsyncClient.common_project_path

common_project_path(project: str) -> str

Returns a fully-qualified project string.

See more: google.cloud.ids_v1.services.ids.IDSAsyncClient.common_project_path

google.cloud.ids_v1.services.ids.IDSAsyncClient.create_endpoint

create_endpoint(
    request: typing.Optional[
        typing.Union[google.cloud.ids_v1.types.ids.CreateEndpointRequest, dict]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    endpoint: typing.Optional[google.cloud.ids_v1.types.ids.Endpoint] = None,
    endpoint_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, str]] = ()
) -> google.api_core.operation_async.AsyncOperation

Creates a new Endpoint in a given project and location.

See more: google.cloud.ids_v1.services.ids.IDSAsyncClient.create_endpoint

google.cloud.ids_v1.services.ids.IDSAsyncClient.delete_endpoint

delete_endpoint(
    request: typing.Optional[
        typing.Union[google.cloud.ids_v1.types.ids.DeleteEndpointRequest, 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.api_core.operation_async.AsyncOperation

Deletes a single Endpoint.

See more: google.cloud.ids_v1.services.ids.IDSAsyncClient.delete_endpoint

google.cloud.ids_v1.services.ids.IDSAsyncClient.endpoint_path

endpoint_path(project: str, location: str, endpoint: str) -> str

Returns a fully-qualified endpoint string.

See more: google.cloud.ids_v1.services.ids.IDSAsyncClient.endpoint_path

google.cloud.ids_v1.services.ids.IDSAsyncClient.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.ids_v1.services.ids.IDSAsyncClient.from_service_account_file

google.cloud.ids_v1.services.ids.IDSAsyncClient.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.ids_v1.services.ids.IDSAsyncClient.from_service_account_info

google.cloud.ids_v1.services.ids.IDSAsyncClient.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.ids_v1.services.ids.IDSAsyncClient.from_service_account_json

google.cloud.ids_v1.services.ids.IDSAsyncClient.get_endpoint

get_endpoint(
    request: typing.Optional[
        typing.Union[google.cloud.ids_v1.types.ids.GetEndpointRequest, 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.ids_v1.types.ids.Endpoint

Gets details of a single Endpoint.

See more: google.cloud.ids_v1.services.ids.IDSAsyncClient.get_endpoint

google.cloud.ids_v1.services.ids.IDSAsyncClient.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.ids_v1.services.ids.IDSAsyncClient.get_mtls_endpoint_and_cert_source

google.cloud.ids_v1.services.ids.IDSAsyncClient.get_transport_class

get_transport_class() -> (
    typing.Type[google.cloud.ids_v1.services.ids.transports.base.IDSTransport]
)

Returns an appropriate transport class.

See more: google.cloud.ids_v1.services.ids.IDSAsyncClient.get_transport_class

google.cloud.ids_v1.services.ids.IDSAsyncClient.list_endpoints

list_endpoints(
    request: typing.Optional[
        typing.Union[google.cloud.ids_v1.types.ids.ListEndpointsRequest, 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.ids_v1.services.ids.pagers.ListEndpointsAsyncPager

Lists Endpoints in a given project and location.

See more: google.cloud.ids_v1.services.ids.IDSAsyncClient.list_endpoints

google.cloud.ids_v1.services.ids.IDSAsyncClient.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.ids_v1.services.ids.IDSAsyncClient.parse_common_billing_account_path

google.cloud.ids_v1.services.ids.IDSAsyncClient.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.ids_v1.services.ids.IDSAsyncClient.parse_common_folder_path

google.cloud.ids_v1.services.ids.IDSAsyncClient.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.ids_v1.services.ids.IDSAsyncClient.parse_common_location_path

google.cloud.ids_v1.services.ids.IDSAsyncClient.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.ids_v1.services.ids.IDSAsyncClient.parse_common_organization_path

google.cloud.ids_v1.services.ids.IDSAsyncClient.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.ids_v1.services.ids.IDSAsyncClient.parse_common_project_path

google.cloud.ids_v1.services.ids.IDSAsyncClient.parse_endpoint_path

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

Parses a endpoint path into its component segments.

See more: google.cloud.ids_v1.services.ids.IDSAsyncClient.parse_endpoint_path

google.cloud.ids_v1.services.ids.IDSClient

IDSClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.ids_v1.services.ids.transports.base.IDSTransport, typing.Callable[[...], google.cloud.ids_v1.services.ids.transports.base.IDSTransport]]] = 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 ids client.

See more: google.cloud.ids_v1.services.ids.IDSClient

google.cloud.ids_v1.services.ids.IDSClient.__exit__

__exit__(type, value, traceback)

Releases underlying transport's resources.

See more: google.cloud.ids_v1.services.ids.IDSClient.exit

google.cloud.ids_v1.services.ids.IDSClient.common_billing_account_path

common_billing_account_path(billing_account: str) -> str

Returns a fully-qualified billing_account string.

See more: google.cloud.ids_v1.services.ids.IDSClient.common_billing_account_path

google.cloud.ids_v1.services.ids.IDSClient.common_folder_path

common_folder_path(folder: str) -> str

Returns a fully-qualified folder string.

See more: google.cloud.ids_v1.services.ids.IDSClient.common_folder_path

google.cloud.ids_v1.services.ids.IDSClient.common_location_path

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

Returns a fully-qualified location string.

See more: google.cloud.ids_v1.services.ids.IDSClient.common_location_path

google.cloud.ids_v1.services.ids.IDSClient.common_organization_path

common_organization_path(organization: str) -> str

Returns a fully-qualified organization string.

See more: google.cloud.ids_v1.services.ids.IDSClient.common_organization_path

google.cloud.ids_v1.services.ids.IDSClient.common_project_path

common_project_path(project: str) -> str

Returns a fully-qualified project string.

See more: google.cloud.ids_v1.services.ids.IDSClient.common_project_path

google.cloud.ids_v1.services.ids.IDSClient.create_endpoint

create_endpoint(
    request: typing.Optional[
        typing.Union[google.cloud.ids_v1.types.ids.CreateEndpointRequest, dict]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    endpoint: typing.Optional[google.cloud.ids_v1.types.ids.Endpoint] = None,
    endpoint_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, str]] = ()
) -> google.api_core.operation.Operation

Creates a new Endpoint in a given project and location.

See more: google.cloud.ids_v1.services.ids.IDSClient.create_endpoint

google.cloud.ids_v1.services.ids.IDSClient.delete_endpoint

delete_endpoint(
    request: typing.Optional[
        typing.Union[google.cloud.ids_v1.types.ids.DeleteEndpointRequest, 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.api_core.operation.Operation

Deletes a single Endpoint.

See more: google.cloud.ids_v1.services.ids.IDSClient.delete_endpoint

google.cloud.ids_v1.services.ids.IDSClient.endpoint_path

endpoint_path(project: str, location: str, endpoint: str) -> str

Returns a fully-qualified endpoint string.

See more: google.cloud.ids_v1.services.ids.IDSClient.endpoint_path

google.cloud.ids_v1.services.ids.IDSClient.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.ids_v1.services.ids.IDSClient.from_service_account_file

google.cloud.ids_v1.services.ids.IDSClient.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.ids_v1.services.ids.IDSClient.from_service_account_info

google.cloud.ids_v1.services.ids.IDSClient.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.ids_v1.services.ids.IDSClient.from_service_account_json

google.cloud.ids_v1.services.ids.IDSClient.get_endpoint

get_endpoint(
    request: typing.Optional[
        typing.Union[google.cloud.ids_v1.types.ids.GetEndpointRequest, 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.ids_v1.types.ids.Endpoint

Gets details of a single Endpoint.

See more: google.cloud.ids_v1.services.ids.IDSClient.get_endpoint

google.cloud.ids_v1.services.ids.IDSClient.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.ids_v1.services.ids.IDSClient.get_mtls_endpoint_and_cert_source

google.cloud.ids_v1.services.ids.IDSClient.list_endpoints

list_endpoints(
    request: typing.Optional[
        typing.Union[google.cloud.ids_v1.types.ids.ListEndpointsRequest, 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.ids_v1.services.ids.pagers.ListEndpointsPager

Lists Endpoints in a given project and location.

See more: google.cloud.ids_v1.services.ids.IDSClient.list_endpoints

google.cloud.ids_v1.services.ids.IDSClient.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.ids_v1.services.ids.IDSClient.parse_common_billing_account_path

google.cloud.ids_v1.services.ids.IDSClient.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.ids_v1.services.ids.IDSClient.parse_common_folder_path

google.cloud.ids_v1.services.ids.IDSClient.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.ids_v1.services.ids.IDSClient.parse_common_location_path

google.cloud.ids_v1.services.ids.IDSClient.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.ids_v1.services.ids.IDSClient.parse_common_organization_path

google.cloud.ids_v1.services.ids.IDSClient.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.ids_v1.services.ids.IDSClient.parse_common_project_path

google.cloud.ids_v1.services.ids.IDSClient.parse_endpoint_path

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

Parses a endpoint path into its component segments.

See more: google.cloud.ids_v1.services.ids.IDSClient.parse_endpoint_path

google.cloud.ids_v1.services.ids.pagers.ListEndpointsAsyncPager

ListEndpointsAsyncPager(
    method: typing.Callable[
        [...], typing.Awaitable[google.cloud.ids_v1.types.ids.ListEndpointsResponse]
    ],
    request: google.cloud.ids_v1.types.ids.ListEndpointsRequest,
    response: google.cloud.ids_v1.types.ids.ListEndpointsResponse,
    *,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
)

Instantiates the pager.

See more: google.cloud.ids_v1.services.ids.pagers.ListEndpointsAsyncPager

google.cloud.ids_v1.services.ids.pagers.ListEndpointsPager

ListEndpointsPager(
    method: typing.Callable[[...], google.cloud.ids_v1.types.ids.ListEndpointsResponse],
    request: google.cloud.ids_v1.types.ids.ListEndpointsRequest,
    response: google.cloud.ids_v1.types.ids.ListEndpointsResponse,
    *,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
)

Instantiate the pager.

See more: google.cloud.ids_v1.services.ids.pagers.ListEndpointsPager