Package Methods (0.5.12)

Summary of entries of Methods for apikeys.

google.cloud.api_keys_v2.services.api_keys.ApiKeysAsyncClient

ApiKeysAsyncClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.api_keys_v2.services.api_keys.transports.base.ApiKeysTransport, typing.Callable[[...], google.cloud.api_keys_v2.services.api_keys.transports.base.ApiKeysTransport]]] = '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 api keys async client.

See more: google.cloud.api_keys_v2.services.api_keys.ApiKeysAsyncClient

google.cloud.api_keys_v2.services.api_keys.ApiKeysAsyncClient.common_billing_account_path

common_billing_account_path(billing_account: str) -> str

Returns a fully-qualified billing_account string.

See more: google.cloud.api_keys_v2.services.api_keys.ApiKeysAsyncClient.common_billing_account_path

google.cloud.api_keys_v2.services.api_keys.ApiKeysAsyncClient.common_folder_path

common_folder_path(folder: str) -> str

Returns a fully-qualified folder string.

See more: google.cloud.api_keys_v2.services.api_keys.ApiKeysAsyncClient.common_folder_path

google.cloud.api_keys_v2.services.api_keys.ApiKeysAsyncClient.common_location_path

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

Returns a fully-qualified location string.

See more: google.cloud.api_keys_v2.services.api_keys.ApiKeysAsyncClient.common_location_path

google.cloud.api_keys_v2.services.api_keys.ApiKeysAsyncClient.common_organization_path

common_organization_path(organization: str) -> str

Returns a fully-qualified organization string.

See more: google.cloud.api_keys_v2.services.api_keys.ApiKeysAsyncClient.common_organization_path

google.cloud.api_keys_v2.services.api_keys.ApiKeysAsyncClient.common_project_path

common_project_path(project: str) -> str

Returns a fully-qualified project string.

See more: google.cloud.api_keys_v2.services.api_keys.ApiKeysAsyncClient.common_project_path

google.cloud.api_keys_v2.services.api_keys.ApiKeysAsyncClient.create_key

create_key(
    request: typing.Optional[
        typing.Union[google.cloud.api_keys_v2.types.apikeys.CreateKeyRequest, dict]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    key: typing.Optional[google.cloud.api_keys_v2.types.resources.Key] = None,
    key_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 API key.

See more: google.cloud.api_keys_v2.services.api_keys.ApiKeysAsyncClient.create_key

google.cloud.api_keys_v2.services.api_keys.ApiKeysAsyncClient.delete_key

delete_key(
    request: typing.Optional[
        typing.Union[google.cloud.api_keys_v2.types.apikeys.DeleteKeyRequest, 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 an API key.

See more: google.cloud.api_keys_v2.services.api_keys.ApiKeysAsyncClient.delete_key

google.cloud.api_keys_v2.services.api_keys.ApiKeysAsyncClient.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.api_keys_v2.services.api_keys.ApiKeysAsyncClient.from_service_account_file

google.cloud.api_keys_v2.services.api_keys.ApiKeysAsyncClient.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.api_keys_v2.services.api_keys.ApiKeysAsyncClient.from_service_account_info

google.cloud.api_keys_v2.services.api_keys.ApiKeysAsyncClient.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.api_keys_v2.services.api_keys.ApiKeysAsyncClient.from_service_account_json

google.cloud.api_keys_v2.services.api_keys.ApiKeysAsyncClient.get_key

get_key(
    request: typing.Optional[
        typing.Union[google.cloud.api_keys_v2.types.apikeys.GetKeyRequest, 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.api_keys_v2.types.resources.Key

Gets the metadata for an API key.

See more: google.cloud.api_keys_v2.services.api_keys.ApiKeysAsyncClient.get_key

google.cloud.api_keys_v2.services.api_keys.ApiKeysAsyncClient.get_key_string

get_key_string(
    request: typing.Optional[
        typing.Union[google.cloud.api_keys_v2.types.apikeys.GetKeyStringRequest, 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.api_keys_v2.types.apikeys.GetKeyStringResponse

Get the key string for an API key.

See more: google.cloud.api_keys_v2.services.api_keys.ApiKeysAsyncClient.get_key_string

google.cloud.api_keys_v2.services.api_keys.ApiKeysAsyncClient.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.api_keys_v2.services.api_keys.ApiKeysAsyncClient.get_mtls_endpoint_and_cert_source

google.cloud.api_keys_v2.services.api_keys.ApiKeysAsyncClient.get_operation

get_operation(
    request: typing.Optional[
        google.longrunning.operations_pb2.GetOperationRequest
    ] = 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.longrunning.operations_pb2.Operation

Gets the latest state of a long-running operation.

See more: google.cloud.api_keys_v2.services.api_keys.ApiKeysAsyncClient.get_operation

google.cloud.api_keys_v2.services.api_keys.ApiKeysAsyncClient.get_transport_class

get_transport_class(
    label: typing.Optional[str] = None,
) -> typing.Type[
    google.cloud.api_keys_v2.services.api_keys.transports.base.ApiKeysTransport
]

Returns an appropriate transport class.

See more: google.cloud.api_keys_v2.services.api_keys.ApiKeysAsyncClient.get_transport_class

google.cloud.api_keys_v2.services.api_keys.ApiKeysAsyncClient.key_path

key_path(project: str, location: str, key: str) -> str

Returns a fully-qualified key string.

See more: google.cloud.api_keys_v2.services.api_keys.ApiKeysAsyncClient.key_path

google.cloud.api_keys_v2.services.api_keys.ApiKeysAsyncClient.list_keys

list_keys(
    request: typing.Optional[
        typing.Union[google.cloud.api_keys_v2.types.apikeys.ListKeysRequest, 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.api_keys_v2.services.api_keys.pagers.ListKeysAsyncPager

Lists the API keys owned by a project.

See more: google.cloud.api_keys_v2.services.api_keys.ApiKeysAsyncClient.list_keys

google.cloud.api_keys_v2.services.api_keys.ApiKeysAsyncClient.lookup_key

lookup_key(
    request: typing.Optional[
        typing.Union[google.cloud.api_keys_v2.types.apikeys.LookupKeyRequest, 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, str]] = ()
) -> google.cloud.api_keys_v2.types.apikeys.LookupKeyResponse

Find the parent project and resource name of the API key that matches the key string in the request.

See more: google.cloud.api_keys_v2.services.api_keys.ApiKeysAsyncClient.lookup_key

google.cloud.api_keys_v2.services.api_keys.ApiKeysAsyncClient.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.api_keys_v2.services.api_keys.ApiKeysAsyncClient.parse_common_billing_account_path

google.cloud.api_keys_v2.services.api_keys.ApiKeysAsyncClient.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.api_keys_v2.services.api_keys.ApiKeysAsyncClient.parse_common_folder_path

google.cloud.api_keys_v2.services.api_keys.ApiKeysAsyncClient.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.api_keys_v2.services.api_keys.ApiKeysAsyncClient.parse_common_location_path

google.cloud.api_keys_v2.services.api_keys.ApiKeysAsyncClient.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.api_keys_v2.services.api_keys.ApiKeysAsyncClient.parse_common_organization_path

google.cloud.api_keys_v2.services.api_keys.ApiKeysAsyncClient.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.api_keys_v2.services.api_keys.ApiKeysAsyncClient.parse_common_project_path

google.cloud.api_keys_v2.services.api_keys.ApiKeysAsyncClient.parse_key_path

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

Parses a key path into its component segments.

See more: google.cloud.api_keys_v2.services.api_keys.ApiKeysAsyncClient.parse_key_path

google.cloud.api_keys_v2.services.api_keys.ApiKeysAsyncClient.undelete_key

undelete_key(
    request: typing.Optional[
        typing.Union[google.cloud.api_keys_v2.types.apikeys.UndeleteKeyRequest, 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, str]] = ()
) -> google.api_core.operation_async.AsyncOperation

Undeletes an API key which was deleted within 30 days.

See more: google.cloud.api_keys_v2.services.api_keys.ApiKeysAsyncClient.undelete_key

google.cloud.api_keys_v2.services.api_keys.ApiKeysAsyncClient.update_key

update_key(
    request: typing.Optional[
        typing.Union[google.cloud.api_keys_v2.types.apikeys.UpdateKeyRequest, dict]
    ] = None,
    *,
    key: typing.Optional[google.cloud.api_keys_v2.types.resources.Key] = None,
    update_mask: typing.Optional[google.protobuf.field_mask_pb2.FieldMask] = 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

Patches the modifiable fields of an API key.

See more: google.cloud.api_keys_v2.services.api_keys.ApiKeysAsyncClient.update_key

google.cloud.api_keys_v2.services.api_keys.ApiKeysClient

ApiKeysClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.api_keys_v2.services.api_keys.transports.base.ApiKeysTransport, typing.Callable[[...], google.cloud.api_keys_v2.services.api_keys.transports.base.ApiKeysTransport]]] = 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 api keys client.

See more: google.cloud.api_keys_v2.services.api_keys.ApiKeysClient

google.cloud.api_keys_v2.services.api_keys.ApiKeysClient.__exit__

__exit__(type, value, traceback)

Releases underlying transport's resources.

See more: google.cloud.api_keys_v2.services.api_keys.ApiKeysClient.exit

google.cloud.api_keys_v2.services.api_keys.ApiKeysClient.common_billing_account_path

common_billing_account_path(billing_account: str) -> str

Returns a fully-qualified billing_account string.

See more: google.cloud.api_keys_v2.services.api_keys.ApiKeysClient.common_billing_account_path

google.cloud.api_keys_v2.services.api_keys.ApiKeysClient.common_folder_path

common_folder_path(folder: str) -> str

Returns a fully-qualified folder string.

See more: google.cloud.api_keys_v2.services.api_keys.ApiKeysClient.common_folder_path

google.cloud.api_keys_v2.services.api_keys.ApiKeysClient.common_location_path

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

Returns a fully-qualified location string.

See more: google.cloud.api_keys_v2.services.api_keys.ApiKeysClient.common_location_path

google.cloud.api_keys_v2.services.api_keys.ApiKeysClient.common_organization_path

common_organization_path(organization: str) -> str

Returns a fully-qualified organization string.

See more: google.cloud.api_keys_v2.services.api_keys.ApiKeysClient.common_organization_path

google.cloud.api_keys_v2.services.api_keys.ApiKeysClient.common_project_path

common_project_path(project: str) -> str

Returns a fully-qualified project string.

See more: google.cloud.api_keys_v2.services.api_keys.ApiKeysClient.common_project_path

google.cloud.api_keys_v2.services.api_keys.ApiKeysClient.create_key

create_key(
    request: typing.Optional[
        typing.Union[google.cloud.api_keys_v2.types.apikeys.CreateKeyRequest, dict]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    key: typing.Optional[google.cloud.api_keys_v2.types.resources.Key] = None,
    key_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 API key.

See more: google.cloud.api_keys_v2.services.api_keys.ApiKeysClient.create_key

google.cloud.api_keys_v2.services.api_keys.ApiKeysClient.delete_key

delete_key(
    request: typing.Optional[
        typing.Union[google.cloud.api_keys_v2.types.apikeys.DeleteKeyRequest, 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 an API key.

See more: google.cloud.api_keys_v2.services.api_keys.ApiKeysClient.delete_key

google.cloud.api_keys_v2.services.api_keys.ApiKeysClient.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.api_keys_v2.services.api_keys.ApiKeysClient.from_service_account_file

google.cloud.api_keys_v2.services.api_keys.ApiKeysClient.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.api_keys_v2.services.api_keys.ApiKeysClient.from_service_account_info

google.cloud.api_keys_v2.services.api_keys.ApiKeysClient.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.api_keys_v2.services.api_keys.ApiKeysClient.from_service_account_json

google.cloud.api_keys_v2.services.api_keys.ApiKeysClient.get_key

get_key(
    request: typing.Optional[
        typing.Union[google.cloud.api_keys_v2.types.apikeys.GetKeyRequest, 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.api_keys_v2.types.resources.Key

Gets the metadata for an API key.

See more: google.cloud.api_keys_v2.services.api_keys.ApiKeysClient.get_key

google.cloud.api_keys_v2.services.api_keys.ApiKeysClient.get_key_string

get_key_string(
    request: typing.Optional[
        typing.Union[google.cloud.api_keys_v2.types.apikeys.GetKeyStringRequest, 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.api_keys_v2.types.apikeys.GetKeyStringResponse

Get the key string for an API key.

See more: google.cloud.api_keys_v2.services.api_keys.ApiKeysClient.get_key_string

google.cloud.api_keys_v2.services.api_keys.ApiKeysClient.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.api_keys_v2.services.api_keys.ApiKeysClient.get_mtls_endpoint_and_cert_source

google.cloud.api_keys_v2.services.api_keys.ApiKeysClient.get_operation

get_operation(
    request: typing.Optional[
        google.longrunning.operations_pb2.GetOperationRequest
    ] = 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.longrunning.operations_pb2.Operation

Gets the latest state of a long-running operation.

See more: google.cloud.api_keys_v2.services.api_keys.ApiKeysClient.get_operation

google.cloud.api_keys_v2.services.api_keys.ApiKeysClient.key_path

key_path(project: str, location: str, key: str) -> str

Returns a fully-qualified key string.

See more: google.cloud.api_keys_v2.services.api_keys.ApiKeysClient.key_path

google.cloud.api_keys_v2.services.api_keys.ApiKeysClient.list_keys

list_keys(
    request: typing.Optional[
        typing.Union[google.cloud.api_keys_v2.types.apikeys.ListKeysRequest, 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.api_keys_v2.services.api_keys.pagers.ListKeysPager

Lists the API keys owned by a project.

See more: google.cloud.api_keys_v2.services.api_keys.ApiKeysClient.list_keys

google.cloud.api_keys_v2.services.api_keys.ApiKeysClient.lookup_key

lookup_key(
    request: typing.Optional[
        typing.Union[google.cloud.api_keys_v2.types.apikeys.LookupKeyRequest, 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, str]] = ()
) -> google.cloud.api_keys_v2.types.apikeys.LookupKeyResponse

Find the parent project and resource name of the API key that matches the key string in the request.

See more: google.cloud.api_keys_v2.services.api_keys.ApiKeysClient.lookup_key

google.cloud.api_keys_v2.services.api_keys.ApiKeysClient.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.api_keys_v2.services.api_keys.ApiKeysClient.parse_common_billing_account_path

google.cloud.api_keys_v2.services.api_keys.ApiKeysClient.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.api_keys_v2.services.api_keys.ApiKeysClient.parse_common_folder_path

google.cloud.api_keys_v2.services.api_keys.ApiKeysClient.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.api_keys_v2.services.api_keys.ApiKeysClient.parse_common_location_path

google.cloud.api_keys_v2.services.api_keys.ApiKeysClient.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.api_keys_v2.services.api_keys.ApiKeysClient.parse_common_organization_path

google.cloud.api_keys_v2.services.api_keys.ApiKeysClient.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.api_keys_v2.services.api_keys.ApiKeysClient.parse_common_project_path

google.cloud.api_keys_v2.services.api_keys.ApiKeysClient.parse_key_path

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

Parses a key path into its component segments.

See more: google.cloud.api_keys_v2.services.api_keys.ApiKeysClient.parse_key_path

google.cloud.api_keys_v2.services.api_keys.ApiKeysClient.undelete_key

undelete_key(
    request: typing.Optional[
        typing.Union[google.cloud.api_keys_v2.types.apikeys.UndeleteKeyRequest, 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, str]] = ()
) -> google.api_core.operation.Operation

Undeletes an API key which was deleted within 30 days.

See more: google.cloud.api_keys_v2.services.api_keys.ApiKeysClient.undelete_key

google.cloud.api_keys_v2.services.api_keys.ApiKeysClient.update_key

update_key(
    request: typing.Optional[
        typing.Union[google.cloud.api_keys_v2.types.apikeys.UpdateKeyRequest, dict]
    ] = None,
    *,
    key: typing.Optional[google.cloud.api_keys_v2.types.resources.Key] = None,
    update_mask: typing.Optional[google.protobuf.field_mask_pb2.FieldMask] = 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

Patches the modifiable fields of an API key.

See more: google.cloud.api_keys_v2.services.api_keys.ApiKeysClient.update_key

google.cloud.api_keys_v2.services.api_keys.pagers.ListKeysAsyncPager

ListKeysAsyncPager(
    method: typing.Callable[
        [...], typing.Awaitable[google.cloud.api_keys_v2.types.apikeys.ListKeysResponse]
    ],
    request: google.cloud.api_keys_v2.types.apikeys.ListKeysRequest,
    response: google.cloud.api_keys_v2.types.apikeys.ListKeysResponse,
    *,
    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]] = ()
)

Instantiates the pager.

See more: google.cloud.api_keys_v2.services.api_keys.pagers.ListKeysAsyncPager

google.cloud.api_keys_v2.services.api_keys.pagers.ListKeysPager

ListKeysPager(
    method: typing.Callable[
        [...], google.cloud.api_keys_v2.types.apikeys.ListKeysResponse
    ],
    request: google.cloud.api_keys_v2.types.apikeys.ListKeysRequest,
    response: google.cloud.api_keys_v2.types.apikeys.ListKeysResponse,
    *,
    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]] = ()
)

Instantiate the pager.

See more: google.cloud.api_keys_v2.services.api_keys.pagers.ListKeysPager