Package Methods (0.1.0)

Summary of entries of Methods for google-cloud-storagebatchoperations.

google.cloud.storagebatchoperations_v1.services.storage_batch_operations.StorageBatchOperationsAsyncClient

StorageBatchOperationsAsyncClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.storagebatchoperations_v1.services.storage_batch_operations.transports.base.StorageBatchOperationsTransport, typing.Callable[[...], google.cloud.storagebatchoperations_v1.services.storage_batch_operations.transports.base.StorageBatchOperationsTransport]]] = '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 storage batch operations async client.

See more: google.cloud.storagebatchoperations_v1.services.storage_batch_operations.StorageBatchOperationsAsyncClient

google.cloud.storagebatchoperations_v1.services.storage_batch_operations.StorageBatchOperationsAsyncClient.cancel_job

cancel_job(
    request: typing.Optional[
        typing.Union[
            google.cloud.storagebatchoperations_v1.types.storage_batch_operations.CancelJobRequest,
            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.storagebatchoperations_v1.types.storage_batch_operations.CancelJobResponse
)

Cancels a batch job.

See more: google.cloud.storagebatchoperations_v1.services.storage_batch_operations.StorageBatchOperationsAsyncClient.cancel_job

google.cloud.storagebatchoperations_v1.services.storage_batch_operations.StorageBatchOperationsAsyncClient.cancel_operation

cancel_operation(
    request: typing.Optional[
        google.longrunning.operations_pb2.CancelOperationRequest
    ] = 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]]] = ()
) -> None

Starts asynchronous cancellation on a long-running operation.

See more: google.cloud.storagebatchoperations_v1.services.storage_batch_operations.StorageBatchOperationsAsyncClient.cancel_operation

google.cloud.storagebatchoperations_v1.services.storage_batch_operations.StorageBatchOperationsAsyncClient.common_billing_account_path

common_billing_account_path(billing_account: str) -> str

Returns a fully-qualified billing_account string.

See more: google.cloud.storagebatchoperations_v1.services.storage_batch_operations.StorageBatchOperationsAsyncClient.common_billing_account_path

google.cloud.storagebatchoperations_v1.services.storage_batch_operations.StorageBatchOperationsAsyncClient.common_folder_path

common_folder_path(folder: str) -> str

Returns a fully-qualified folder string.

See more: google.cloud.storagebatchoperations_v1.services.storage_batch_operations.StorageBatchOperationsAsyncClient.common_folder_path

google.cloud.storagebatchoperations_v1.services.storage_batch_operations.StorageBatchOperationsAsyncClient.common_location_path

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

Returns a fully-qualified location string.

See more: google.cloud.storagebatchoperations_v1.services.storage_batch_operations.StorageBatchOperationsAsyncClient.common_location_path

google.cloud.storagebatchoperations_v1.services.storage_batch_operations.StorageBatchOperationsAsyncClient.common_organization_path

common_organization_path(organization: str) -> str

Returns a fully-qualified organization string.

See more: google.cloud.storagebatchoperations_v1.services.storage_batch_operations.StorageBatchOperationsAsyncClient.common_organization_path

google.cloud.storagebatchoperations_v1.services.storage_batch_operations.StorageBatchOperationsAsyncClient.common_project_path

common_project_path(project: str) -> str

Returns a fully-qualified project string.

See more: google.cloud.storagebatchoperations_v1.services.storage_batch_operations.StorageBatchOperationsAsyncClient.common_project_path

google.cloud.storagebatchoperations_v1.services.storage_batch_operations.StorageBatchOperationsAsyncClient.create_job

create_job(
    request: typing.Optional[
        typing.Union[
            google.cloud.storagebatchoperations_v1.types.storage_batch_operations.CreateJobRequest,
            dict,
        ]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    job: typing.Optional[
        google.cloud.storagebatchoperations_v1.types.storage_batch_operations_types.Job
    ] = None,
    job_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, typing.Union[str, bytes]]] = ()
) -> google.api_core.operation_async.AsyncOperation

Creates a batch job.

See more: google.cloud.storagebatchoperations_v1.services.storage_batch_operations.StorageBatchOperationsAsyncClient.create_job

google.cloud.storagebatchoperations_v1.services.storage_batch_operations.StorageBatchOperationsAsyncClient.crypto_key_path

crypto_key_path(project: str, location: str, key_ring: str, crypto_key: str) -> str

Returns a fully-qualified crypto_key string.

See more: google.cloud.storagebatchoperations_v1.services.storage_batch_operations.StorageBatchOperationsAsyncClient.crypto_key_path

google.cloud.storagebatchoperations_v1.services.storage_batch_operations.StorageBatchOperationsAsyncClient.delete_job

delete_job(
    request: typing.Optional[
        typing.Union[
            google.cloud.storagebatchoperations_v1.types.storage_batch_operations.DeleteJobRequest,
            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]]] = ()
) -> None

Deletes a batch job.

See more: google.cloud.storagebatchoperations_v1.services.storage_batch_operations.StorageBatchOperationsAsyncClient.delete_job

google.cloud.storagebatchoperations_v1.services.storage_batch_operations.StorageBatchOperationsAsyncClient.delete_operation

delete_operation(
    request: typing.Optional[
        google.longrunning.operations_pb2.DeleteOperationRequest
    ] = 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]]] = ()
) -> None

Deletes a long-running operation.

See more: google.cloud.storagebatchoperations_v1.services.storage_batch_operations.StorageBatchOperationsAsyncClient.delete_operation

google.cloud.storagebatchoperations_v1.services.storage_batch_operations.StorageBatchOperationsAsyncClient.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.storagebatchoperations_v1.services.storage_batch_operations.StorageBatchOperationsAsyncClient.from_service_account_file

google.cloud.storagebatchoperations_v1.services.storage_batch_operations.StorageBatchOperationsAsyncClient.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.storagebatchoperations_v1.services.storage_batch_operations.StorageBatchOperationsAsyncClient.from_service_account_info

google.cloud.storagebatchoperations_v1.services.storage_batch_operations.StorageBatchOperationsAsyncClient.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.storagebatchoperations_v1.services.storage_batch_operations.StorageBatchOperationsAsyncClient.from_service_account_json

google.cloud.storagebatchoperations_v1.services.storage_batch_operations.StorageBatchOperationsAsyncClient.get_job

get_job(
    request: typing.Optional[
        typing.Union[
            google.cloud.storagebatchoperations_v1.types.storage_batch_operations.GetJobRequest,
            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.storagebatchoperations_v1.types.storage_batch_operations_types.Job

Gets a batch job.

See more: google.cloud.storagebatchoperations_v1.services.storage_batch_operations.StorageBatchOperationsAsyncClient.get_job

google.cloud.storagebatchoperations_v1.services.storage_batch_operations.StorageBatchOperationsAsyncClient.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

Gets information about a location.

See more: google.cloud.storagebatchoperations_v1.services.storage_batch_operations.StorageBatchOperationsAsyncClient.get_location

google.cloud.storagebatchoperations_v1.services.storage_batch_operations.StorageBatchOperationsAsyncClient.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.storagebatchoperations_v1.services.storage_batch_operations.StorageBatchOperationsAsyncClient.get_mtls_endpoint_and_cert_source

google.cloud.storagebatchoperations_v1.services.storage_batch_operations.StorageBatchOperationsAsyncClient.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, typing.Union[str, bytes]]] = ()
) -> google.longrunning.operations_pb2.Operation

Gets the latest state of a long-running operation.

See more: google.cloud.storagebatchoperations_v1.services.storage_batch_operations.StorageBatchOperationsAsyncClient.get_operation

google.cloud.storagebatchoperations_v1.services.storage_batch_operations.StorageBatchOperationsAsyncClient.get_transport_class

get_transport_class(
    label: typing.Optional[str] = None,
) -> typing.Type[
    google.cloud.storagebatchoperations_v1.services.storage_batch_operations.transports.base.StorageBatchOperationsTransport
]

Returns an appropriate transport class.

See more: google.cloud.storagebatchoperations_v1.services.storage_batch_operations.StorageBatchOperationsAsyncClient.get_transport_class

google.cloud.storagebatchoperations_v1.services.storage_batch_operations.StorageBatchOperationsAsyncClient.job_path

job_path(project: str, location: str, job: str) -> str

Returns a fully-qualified job string.

See more: google.cloud.storagebatchoperations_v1.services.storage_batch_operations.StorageBatchOperationsAsyncClient.job_path

google.cloud.storagebatchoperations_v1.services.storage_batch_operations.StorageBatchOperationsAsyncClient.list_jobs

list_jobs(
    request: typing.Optional[
        typing.Union[
            google.cloud.storagebatchoperations_v1.types.storage_batch_operations.ListJobsRequest,
            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.storagebatchoperations_v1.services.storage_batch_operations.pagers.ListJobsAsyncPager
)

Lists Jobs in a given project and location.

See more: google.cloud.storagebatchoperations_v1.services.storage_batch_operations.StorageBatchOperationsAsyncClient.list_jobs

google.cloud.storagebatchoperations_v1.services.storage_batch_operations.StorageBatchOperationsAsyncClient.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.storagebatchoperations_v1.services.storage_batch_operations.StorageBatchOperationsAsyncClient.list_locations

google.cloud.storagebatchoperations_v1.services.storage_batch_operations.StorageBatchOperationsAsyncClient.list_operations

list_operations(
    request: typing.Optional[
        google.longrunning.operations_pb2.ListOperationsRequest
    ] = 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.ListOperationsResponse

Lists operations that match the specified filter in the request.

See more: google.cloud.storagebatchoperations_v1.services.storage_batch_operations.StorageBatchOperationsAsyncClient.list_operations

google.cloud.storagebatchoperations_v1.services.storage_batch_operations.StorageBatchOperationsAsyncClient.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.storagebatchoperations_v1.services.storage_batch_operations.StorageBatchOperationsAsyncClient.parse_common_billing_account_path

google.cloud.storagebatchoperations_v1.services.storage_batch_operations.StorageBatchOperationsAsyncClient.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.storagebatchoperations_v1.services.storage_batch_operations.StorageBatchOperationsAsyncClient.parse_common_folder_path

google.cloud.storagebatchoperations_v1.services.storage_batch_operations.StorageBatchOperationsAsyncClient.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.storagebatchoperations_v1.services.storage_batch_operations.StorageBatchOperationsAsyncClient.parse_common_location_path

google.cloud.storagebatchoperations_v1.services.storage_batch_operations.StorageBatchOperationsAsyncClient.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.storagebatchoperations_v1.services.storage_batch_operations.StorageBatchOperationsAsyncClient.parse_common_organization_path

google.cloud.storagebatchoperations_v1.services.storage_batch_operations.StorageBatchOperationsAsyncClient.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.storagebatchoperations_v1.services.storage_batch_operations.StorageBatchOperationsAsyncClient.parse_common_project_path

google.cloud.storagebatchoperations_v1.services.storage_batch_operations.StorageBatchOperationsAsyncClient.parse_crypto_key_path

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

Parses a crypto_key path into its component segments.

See more: google.cloud.storagebatchoperations_v1.services.storage_batch_operations.StorageBatchOperationsAsyncClient.parse_crypto_key_path

google.cloud.storagebatchoperations_v1.services.storage_batch_operations.StorageBatchOperationsAsyncClient.parse_job_path

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

Parses a job path into its component segments.

See more: google.cloud.storagebatchoperations_v1.services.storage_batch_operations.StorageBatchOperationsAsyncClient.parse_job_path

google.cloud.storagebatchoperations_v1.services.storage_batch_operations.StorageBatchOperationsClient

StorageBatchOperationsClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.storagebatchoperations_v1.services.storage_batch_operations.transports.base.StorageBatchOperationsTransport, typing.Callable[[...], google.cloud.storagebatchoperations_v1.services.storage_batch_operations.transports.base.StorageBatchOperationsTransport]]] = 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 storage batch operations client.

See more: google.cloud.storagebatchoperations_v1.services.storage_batch_operations.StorageBatchOperationsClient

google.cloud.storagebatchoperations_v1.services.storage_batch_operations.StorageBatchOperationsClient.__exit__

__exit__(type, value, traceback)

Releases underlying transport's resources.

See more: google.cloud.storagebatchoperations_v1.services.storage_batch_operations.StorageBatchOperationsClient.exit

google.cloud.storagebatchoperations_v1.services.storage_batch_operations.StorageBatchOperationsClient.cancel_job

cancel_job(
    request: typing.Optional[
        typing.Union[
            google.cloud.storagebatchoperations_v1.types.storage_batch_operations.CancelJobRequest,
            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.storagebatchoperations_v1.types.storage_batch_operations.CancelJobResponse
)

Cancels a batch job.

See more: google.cloud.storagebatchoperations_v1.services.storage_batch_operations.StorageBatchOperationsClient.cancel_job

google.cloud.storagebatchoperations_v1.services.storage_batch_operations.StorageBatchOperationsClient.cancel_operation

cancel_operation(
    request: typing.Optional[
        google.longrunning.operations_pb2.CancelOperationRequest
    ] = 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]]] = ()
) -> None

Starts asynchronous cancellation on a long-running operation.

See more: google.cloud.storagebatchoperations_v1.services.storage_batch_operations.StorageBatchOperationsClient.cancel_operation

google.cloud.storagebatchoperations_v1.services.storage_batch_operations.StorageBatchOperationsClient.common_billing_account_path

common_billing_account_path(billing_account: str) -> str

Returns a fully-qualified billing_account string.

See more: google.cloud.storagebatchoperations_v1.services.storage_batch_operations.StorageBatchOperationsClient.common_billing_account_path

google.cloud.storagebatchoperations_v1.services.storage_batch_operations.StorageBatchOperationsClient.common_folder_path

common_folder_path(folder: str) -> str

Returns a fully-qualified folder string.

See more: google.cloud.storagebatchoperations_v1.services.storage_batch_operations.StorageBatchOperationsClient.common_folder_path

google.cloud.storagebatchoperations_v1.services.storage_batch_operations.StorageBatchOperationsClient.common_location_path

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

Returns a fully-qualified location string.

See more: google.cloud.storagebatchoperations_v1.services.storage_batch_operations.StorageBatchOperationsClient.common_location_path

google.cloud.storagebatchoperations_v1.services.storage_batch_operations.StorageBatchOperationsClient.common_organization_path

common_organization_path(organization: str) -> str

Returns a fully-qualified organization string.

See more: google.cloud.storagebatchoperations_v1.services.storage_batch_operations.StorageBatchOperationsClient.common_organization_path

google.cloud.storagebatchoperations_v1.services.storage_batch_operations.StorageBatchOperationsClient.common_project_path

common_project_path(project: str) -> str

Returns a fully-qualified project string.

See more: google.cloud.storagebatchoperations_v1.services.storage_batch_operations.StorageBatchOperationsClient.common_project_path

google.cloud.storagebatchoperations_v1.services.storage_batch_operations.StorageBatchOperationsClient.create_job

create_job(
    request: typing.Optional[
        typing.Union[
            google.cloud.storagebatchoperations_v1.types.storage_batch_operations.CreateJobRequest,
            dict,
        ]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    job: typing.Optional[
        google.cloud.storagebatchoperations_v1.types.storage_batch_operations_types.Job
    ] = None,
    job_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, typing.Union[str, bytes]]] = ()
) -> google.api_core.operation.Operation

Creates a batch job.

See more: google.cloud.storagebatchoperations_v1.services.storage_batch_operations.StorageBatchOperationsClient.create_job

google.cloud.storagebatchoperations_v1.services.storage_batch_operations.StorageBatchOperationsClient.crypto_key_path

crypto_key_path(project: str, location: str, key_ring: str, crypto_key: str) -> str

Returns a fully-qualified crypto_key string.

See more: google.cloud.storagebatchoperations_v1.services.storage_batch_operations.StorageBatchOperationsClient.crypto_key_path

google.cloud.storagebatchoperations_v1.services.storage_batch_operations.StorageBatchOperationsClient.delete_job

delete_job(
    request: typing.Optional[
        typing.Union[
            google.cloud.storagebatchoperations_v1.types.storage_batch_operations.DeleteJobRequest,
            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]]] = ()
) -> None

Deletes a batch job.

See more: google.cloud.storagebatchoperations_v1.services.storage_batch_operations.StorageBatchOperationsClient.delete_job

google.cloud.storagebatchoperations_v1.services.storage_batch_operations.StorageBatchOperationsClient.delete_operation

delete_operation(
    request: typing.Optional[
        google.longrunning.operations_pb2.DeleteOperationRequest
    ] = 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]]] = ()
) -> None

Deletes a long-running operation.

See more: google.cloud.storagebatchoperations_v1.services.storage_batch_operations.StorageBatchOperationsClient.delete_operation

google.cloud.storagebatchoperations_v1.services.storage_batch_operations.StorageBatchOperationsClient.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.storagebatchoperations_v1.services.storage_batch_operations.StorageBatchOperationsClient.from_service_account_file

google.cloud.storagebatchoperations_v1.services.storage_batch_operations.StorageBatchOperationsClient.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.storagebatchoperations_v1.services.storage_batch_operations.StorageBatchOperationsClient.from_service_account_info

google.cloud.storagebatchoperations_v1.services.storage_batch_operations.StorageBatchOperationsClient.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.storagebatchoperations_v1.services.storage_batch_operations.StorageBatchOperationsClient.from_service_account_json

google.cloud.storagebatchoperations_v1.services.storage_batch_operations.StorageBatchOperationsClient.get_job

get_job(
    request: typing.Optional[
        typing.Union[
            google.cloud.storagebatchoperations_v1.types.storage_batch_operations.GetJobRequest,
            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.storagebatchoperations_v1.types.storage_batch_operations_types.Job

Gets a batch job.

See more: google.cloud.storagebatchoperations_v1.services.storage_batch_operations.StorageBatchOperationsClient.get_job

google.cloud.storagebatchoperations_v1.services.storage_batch_operations.StorageBatchOperationsClient.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

Gets information about a location.

See more: google.cloud.storagebatchoperations_v1.services.storage_batch_operations.StorageBatchOperationsClient.get_location

google.cloud.storagebatchoperations_v1.services.storage_batch_operations.StorageBatchOperationsClient.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.storagebatchoperations_v1.services.storage_batch_operations.StorageBatchOperationsClient.get_mtls_endpoint_and_cert_source

google.cloud.storagebatchoperations_v1.services.storage_batch_operations.StorageBatchOperationsClient.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, typing.Union[str, bytes]]] = ()
) -> google.longrunning.operations_pb2.Operation

Gets the latest state of a long-running operation.

See more: google.cloud.storagebatchoperations_v1.services.storage_batch_operations.StorageBatchOperationsClient.get_operation

google.cloud.storagebatchoperations_v1.services.storage_batch_operations.StorageBatchOperationsClient.job_path

job_path(project: str, location: str, job: str) -> str

Returns a fully-qualified job string.

See more: google.cloud.storagebatchoperations_v1.services.storage_batch_operations.StorageBatchOperationsClient.job_path

google.cloud.storagebatchoperations_v1.services.storage_batch_operations.StorageBatchOperationsClient.list_jobs

list_jobs(
    request: typing.Optional[
        typing.Union[
            google.cloud.storagebatchoperations_v1.types.storage_batch_operations.ListJobsRequest,
            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.storagebatchoperations_v1.services.storage_batch_operations.pagers.ListJobsPager
)

Lists Jobs in a given project and location.

See more: google.cloud.storagebatchoperations_v1.services.storage_batch_operations.StorageBatchOperationsClient.list_jobs

google.cloud.storagebatchoperations_v1.services.storage_batch_operations.StorageBatchOperationsClient.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.storagebatchoperations_v1.services.storage_batch_operations.StorageBatchOperationsClient.list_locations

google.cloud.storagebatchoperations_v1.services.storage_batch_operations.StorageBatchOperationsClient.list_operations

list_operations(
    request: typing.Optional[
        google.longrunning.operations_pb2.ListOperationsRequest
    ] = 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.ListOperationsResponse

Lists operations that match the specified filter in the request.

See more: google.cloud.storagebatchoperations_v1.services.storage_batch_operations.StorageBatchOperationsClient.list_operations

google.cloud.storagebatchoperations_v1.services.storage_batch_operations.StorageBatchOperationsClient.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.storagebatchoperations_v1.services.storage_batch_operations.StorageBatchOperationsClient.parse_common_billing_account_path

google.cloud.storagebatchoperations_v1.services.storage_batch_operations.StorageBatchOperationsClient.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.storagebatchoperations_v1.services.storage_batch_operations.StorageBatchOperationsClient.parse_common_folder_path

google.cloud.storagebatchoperations_v1.services.storage_batch_operations.StorageBatchOperationsClient.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.storagebatchoperations_v1.services.storage_batch_operations.StorageBatchOperationsClient.parse_common_location_path

google.cloud.storagebatchoperations_v1.services.storage_batch_operations.StorageBatchOperationsClient.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.storagebatchoperations_v1.services.storage_batch_operations.StorageBatchOperationsClient.parse_common_organization_path

google.cloud.storagebatchoperations_v1.services.storage_batch_operations.StorageBatchOperationsClient.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.storagebatchoperations_v1.services.storage_batch_operations.StorageBatchOperationsClient.parse_common_project_path

google.cloud.storagebatchoperations_v1.services.storage_batch_operations.StorageBatchOperationsClient.parse_crypto_key_path

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

Parses a crypto_key path into its component segments.

See more: google.cloud.storagebatchoperations_v1.services.storage_batch_operations.StorageBatchOperationsClient.parse_crypto_key_path

google.cloud.storagebatchoperations_v1.services.storage_batch_operations.StorageBatchOperationsClient.parse_job_path

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

Parses a job path into its component segments.

See more: google.cloud.storagebatchoperations_v1.services.storage_batch_operations.StorageBatchOperationsClient.parse_job_path

google.cloud.storagebatchoperations_v1.services.storage_batch_operations.pagers.ListJobsAsyncPager

ListJobsAsyncPager(
    method: typing.Callable[
        [...],
        typing.Awaitable[
            google.cloud.storagebatchoperations_v1.types.storage_batch_operations.ListJobsResponse
        ],
    ],
    request: google.cloud.storagebatchoperations_v1.types.storage_batch_operations.ListJobsRequest,
    response: google.cloud.storagebatchoperations_v1.types.storage_batch_operations.ListJobsResponse,
    *,
    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.storagebatchoperations_v1.services.storage_batch_operations.pagers.ListJobsAsyncPager

google.cloud.storagebatchoperations_v1.services.storage_batch_operations.pagers.ListJobsPager

ListJobsPager(
    method: typing.Callable[
        [...],
        google.cloud.storagebatchoperations_v1.types.storage_batch_operations.ListJobsResponse,
    ],
    request: google.cloud.storagebatchoperations_v1.types.storage_batch_operations.ListJobsRequest,
    response: google.cloud.storagebatchoperations_v1.types.storage_batch_operations.ListJobsResponse,
    *,
    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.storagebatchoperations_v1.services.storage_batch_operations.pagers.ListJobsPager