Summary of entries of Methods for batch.
google.cloud.batch_v1.services.batch_service.BatchServiceAsyncClient
BatchServiceAsyncClient
(
*
,
credentials
:
typing
.
Optional
[
google
.
auth
.
credentials
.
Credentials
]
=
None
,
transport
:
typing
.
Optional
[
typing
.
Union
[
str
,
google
.
cloud
.
batch_v1
.
services
.
batch_service
.
transports
.
base
.
BatchServiceTransport
,
typing
.
Callable
[[
...
],
google
.
cloud
.
batch_v1
.
services
.
batch_service
.
transports
.
base
.
BatchServiceTransport
]]]
=
'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 batch service async client.
See more: google.cloud.batch_v1.services.batch_service.BatchServiceAsyncClient
google.cloud.batch_v1.services.batch_service.BatchServiceAsyncClient.cancel_job
cancel_job
(
request
:
typing
.
Optional
[
typing
.
Union
[
google
.
cloud
.
batch_v1
.
types
.
batch
.
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
.
api_core
.
operation_async
.
AsyncOperation
Cancel a Job.
See more: google.cloud.batch_v1.services.batch_service.BatchServiceAsyncClient.cancel_job
google.cloud.batch_v1.services.batch_service.BatchServiceAsyncClient.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.batch_v1.services.batch_service.BatchServiceAsyncClient.cancel_operation
google.cloud.batch_v1.services.batch_service.BatchServiceAsyncClient.common_billing_account_path
common_billing_account_path
(
billing_account
:
str
)
-
> str
Returns a fully-qualified billing_account string.
See more: google.cloud.batch_v1.services.batch_service.BatchServiceAsyncClient.common_billing_account_path
google.cloud.batch_v1.services.batch_service.BatchServiceAsyncClient.common_folder_path
common_folder_path
(
folder
:
str
)
-
> str
Returns a fully-qualified folder string.
See more: google.cloud.batch_v1.services.batch_service.BatchServiceAsyncClient.common_folder_path
google.cloud.batch_v1.services.batch_service.BatchServiceAsyncClient.common_location_path
common_location_path
(
project
:
str
,
location
:
str
)
-
> str
Returns a fully-qualified location string.
See more: google.cloud.batch_v1.services.batch_service.BatchServiceAsyncClient.common_location_path
google.cloud.batch_v1.services.batch_service.BatchServiceAsyncClient.common_organization_path
common_organization_path
(
organization
:
str
)
-
> str
Returns a fully-qualified organization string.
See more: google.cloud.batch_v1.services.batch_service.BatchServiceAsyncClient.common_organization_path
google.cloud.batch_v1.services.batch_service.BatchServiceAsyncClient.common_project_path
common_project_path
(
project
:
str
)
-
> str
Returns a fully-qualified project string.
See more: google.cloud.batch_v1.services.batch_service.BatchServiceAsyncClient.common_project_path
google.cloud.batch_v1.services.batch_service.BatchServiceAsyncClient.create_job
create_job
(
request
:
typing
.
Optional
[
typing
.
Union
[
google
.
cloud
.
batch_v1
.
types
.
batch
.
CreateJobRequest
,
dict
]
]
=
None
,
*
,
parent
:
typing
.
Optional
[
str
]
=
None
,
job
:
typing
.
Optional
[
google
.
cloud
.
batch_v1
.
types
.
job
.
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
.
cloud
.
batch_v1
.
types
.
job
.
Job
Create a Job.
See more: google.cloud.batch_v1.services.batch_service.BatchServiceAsyncClient.create_job
google.cloud.batch_v1.services.batch_service.BatchServiceAsyncClient.delete_job
delete_job
(
request
:
typing
.
Optional
[
typing
.
Union
[
google
.
cloud
.
batch_v1
.
types
.
batch
.
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
]]]
=
()
)
-
> google
.
api_core
.
operation_async
.
AsyncOperation
Delete a Job.
See more: google.cloud.batch_v1.services.batch_service.BatchServiceAsyncClient.delete_job
google.cloud.batch_v1.services.batch_service.BatchServiceAsyncClient.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.batch_v1.services.batch_service.BatchServiceAsyncClient.delete_operation
google.cloud.batch_v1.services.batch_service.BatchServiceAsyncClient.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.batch_v1.services.batch_service.BatchServiceAsyncClient.from_service_account_file
google.cloud.batch_v1.services.batch_service.BatchServiceAsyncClient.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.batch_v1.services.batch_service.BatchServiceAsyncClient.from_service_account_info
google.cloud.batch_v1.services.batch_service.BatchServiceAsyncClient.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.batch_v1.services.batch_service.BatchServiceAsyncClient.from_service_account_json
google.cloud.batch_v1.services.batch_service.BatchServiceAsyncClient.get_job
get_job
(
request
:
typing
.
Optional
[
typing
.
Union
[
google
.
cloud
.
batch_v1
.
types
.
batch
.
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
.
batch_v1
.
types
.
job
.
Job
Get a Job specified by its resource name.
See more: google.cloud.batch_v1.services.batch_service.BatchServiceAsyncClient.get_job
google.cloud.batch_v1.services.batch_service.BatchServiceAsyncClient.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.batch_v1.services.batch_service.BatchServiceAsyncClient.get_location
google.cloud.batch_v1.services.batch_service.BatchServiceAsyncClient.get_mtls_endpoint_and_cert_source
get_mtls_endpoint_and_cert_source
(
client_options
:
typing
.
Optional
[
google
.
api_core
.
client_options
.
ClientOptions
]
=
None
,
)
Return the API endpoint and client cert source for mutual TLS.
google.cloud.batch_v1.services.batch_service.BatchServiceAsyncClient.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.batch_v1.services.batch_service.BatchServiceAsyncClient.get_operation
google.cloud.batch_v1.services.batch_service.BatchServiceAsyncClient.get_task
get_task
(
request
:
typing
.
Optional
[
typing
.
Union
[
google
.
cloud
.
batch_v1
.
types
.
batch
.
GetTaskRequest
,
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
.
batch_v1
.
types
.
task
.
Task
Return a single Task.
See more: google.cloud.batch_v1.services.batch_service.BatchServiceAsyncClient.get_task
google.cloud.batch_v1.services.batch_service.BatchServiceAsyncClient.get_transport_class
get_transport_class
(
label
:
typing
.
Optional
[
str
]
=
None
,
)
-
> typing
.
Type
[
google
.
cloud
.
batch_v1
.
services
.
batch_service
.
transports
.
base
.
BatchServiceTransport
]
Returns an appropriate transport class.
See more: google.cloud.batch_v1.services.batch_service.BatchServiceAsyncClient.get_transport_class
google.cloud.batch_v1.services.batch_service.BatchServiceAsyncClient.job_path
job_path
(
project
:
str
,
location
:
str
,
job
:
str
)
-
> str
Returns a fully-qualified job string.
See more: google.cloud.batch_v1.services.batch_service.BatchServiceAsyncClient.job_path
google.cloud.batch_v1.services.batch_service.BatchServiceAsyncClient.list_jobs
list_jobs
(
request
:
typing
.
Optional
[
typing
.
Union
[
google
.
cloud
.
batch_v1
.
types
.
batch
.
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
.
batch_v1
.
services
.
batch_service
.
pagers
.
ListJobsAsyncPager
List all Jobs for a project within a region.
See more: google.cloud.batch_v1.services.batch_service.BatchServiceAsyncClient.list_jobs
google.cloud.batch_v1.services.batch_service.BatchServiceAsyncClient.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.batch_v1.services.batch_service.BatchServiceAsyncClient.list_locations
google.cloud.batch_v1.services.batch_service.BatchServiceAsyncClient.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.batch_v1.services.batch_service.BatchServiceAsyncClient.list_operations
google.cloud.batch_v1.services.batch_service.BatchServiceAsyncClient.list_tasks
list_tasks
(
request
:
typing
.
Optional
[
typing
.
Union
[
google
.
cloud
.
batch_v1
.
types
.
batch
.
ListTasksRequest
,
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
.
batch_v1
.
services
.
batch_service
.
pagers
.
ListTasksAsyncPager
List Tasks associated with a job.
See more: google.cloud.batch_v1.services.batch_service.BatchServiceAsyncClient.list_tasks
google.cloud.batch_v1.services.batch_service.BatchServiceAsyncClient.parse_common_billing_account_path
parse_common_billing_account_path
(
path
:
str
)
-
> typing
.
Dict
[
str
,
str
]
Parse a billing_account path into its component segments.
google.cloud.batch_v1.services.batch_service.BatchServiceAsyncClient.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.batch_v1.services.batch_service.BatchServiceAsyncClient.parse_common_folder_path
google.cloud.batch_v1.services.batch_service.BatchServiceAsyncClient.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.batch_v1.services.batch_service.BatchServiceAsyncClient.parse_common_location_path
google.cloud.batch_v1.services.batch_service.BatchServiceAsyncClient.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.batch_v1.services.batch_service.BatchServiceAsyncClient.parse_common_organization_path
google.cloud.batch_v1.services.batch_service.BatchServiceAsyncClient.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.batch_v1.services.batch_service.BatchServiceAsyncClient.parse_common_project_path
google.cloud.batch_v1.services.batch_service.BatchServiceAsyncClient.parse_job_path
parse_job_path
(
path
:
str
)
-
> typing
.
Dict
[
str
,
str
]
Parses a job path into its component segments.
See more: google.cloud.batch_v1.services.batch_service.BatchServiceAsyncClient.parse_job_path
google.cloud.batch_v1.services.batch_service.BatchServiceAsyncClient.parse_task_group_path
parse_task_group_path
(
path
:
str
)
-
> typing
.
Dict
[
str
,
str
]
Parses a task_group path into its component segments.
See more: google.cloud.batch_v1.services.batch_service.BatchServiceAsyncClient.parse_task_group_path
google.cloud.batch_v1.services.batch_service.BatchServiceAsyncClient.parse_task_path
parse_task_path
(
path
:
str
)
-
> typing
.
Dict
[
str
,
str
]
Parses a task path into its component segments.
See more: google.cloud.batch_v1.services.batch_service.BatchServiceAsyncClient.parse_task_path
google.cloud.batch_v1.services.batch_service.BatchServiceAsyncClient.task_group_path
task_group_path
(
project
:
str
,
location
:
str
,
job
:
str
,
task_group
:
str
)
-
> str
Returns a fully-qualified task_group string.
See more: google.cloud.batch_v1.services.batch_service.BatchServiceAsyncClient.task_group_path
google.cloud.batch_v1.services.batch_service.BatchServiceAsyncClient.task_path
task_path
(
project
:
str
,
location
:
str
,
job
:
str
,
task_group
:
str
,
task
:
str
)
-
> str
Returns a fully-qualified task string.
See more: google.cloud.batch_v1.services.batch_service.BatchServiceAsyncClient.task_path
google.cloud.batch_v1.services.batch_service.BatchServiceClient
BatchServiceClient
(
*
,
credentials
:
typing
.
Optional
[
google
.
auth
.
credentials
.
Credentials
]
=
None
,
transport
:
typing
.
Optional
[
typing
.
Union
[
str
,
google
.
cloud
.
batch_v1
.
services
.
batch_service
.
transports
.
base
.
BatchServiceTransport
,
typing
.
Callable
[[
...
],
google
.
cloud
.
batch_v1
.
services
.
batch_service
.
transports
.
base
.
BatchServiceTransport
]]]
=
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 batch service client.
See more: google.cloud.batch_v1.services.batch_service.BatchServiceClient
google.cloud.batch_v1.services.batch_service.BatchServiceClient.__exit__
__exit__
(
type
,
value
,
traceback
)
Releases underlying transport's resources.
See more: google.cloud.batch_v1.services.batch_service.BatchServiceClient. exit
google.cloud.batch_v1.services.batch_service.BatchServiceClient.cancel_job
cancel_job
(
request
:
typing
.
Optional
[
typing
.
Union
[
google
.
cloud
.
batch_v1
.
types
.
batch
.
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
.
api_core
.
operation
.
Operation
Cancel a Job.
See more: google.cloud.batch_v1.services.batch_service.BatchServiceClient.cancel_job
google.cloud.batch_v1.services.batch_service.BatchServiceClient.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.batch_v1.services.batch_service.BatchServiceClient.cancel_operation
google.cloud.batch_v1.services.batch_service.BatchServiceClient.common_billing_account_path
common_billing_account_path
(
billing_account
:
str
)
-
> str
Returns a fully-qualified billing_account string.
See more: google.cloud.batch_v1.services.batch_service.BatchServiceClient.common_billing_account_path
google.cloud.batch_v1.services.batch_service.BatchServiceClient.common_folder_path
common_folder_path
(
folder
:
str
)
-
> str
Returns a fully-qualified folder string.
See more: google.cloud.batch_v1.services.batch_service.BatchServiceClient.common_folder_path
google.cloud.batch_v1.services.batch_service.BatchServiceClient.common_location_path
common_location_path
(
project
:
str
,
location
:
str
)
-
> str
Returns a fully-qualified location string.
See more: google.cloud.batch_v1.services.batch_service.BatchServiceClient.common_location_path
google.cloud.batch_v1.services.batch_service.BatchServiceClient.common_organization_path
common_organization_path
(
organization
:
str
)
-
> str
Returns a fully-qualified organization string.
See more: google.cloud.batch_v1.services.batch_service.BatchServiceClient.common_organization_path
google.cloud.batch_v1.services.batch_service.BatchServiceClient.common_project_path
common_project_path
(
project
:
str
)
-
> str
Returns a fully-qualified project string.
See more: google.cloud.batch_v1.services.batch_service.BatchServiceClient.common_project_path
google.cloud.batch_v1.services.batch_service.BatchServiceClient.create_job
create_job
(
request
:
typing
.
Optional
[
typing
.
Union
[
google
.
cloud
.
batch_v1
.
types
.
batch
.
CreateJobRequest
,
dict
]
]
=
None
,
*
,
parent
:
typing
.
Optional
[
str
]
=
None
,
job
:
typing
.
Optional
[
google
.
cloud
.
batch_v1
.
types
.
job
.
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
.
cloud
.
batch_v1
.
types
.
job
.
Job
Create a Job.
See more: google.cloud.batch_v1.services.batch_service.BatchServiceClient.create_job
google.cloud.batch_v1.services.batch_service.BatchServiceClient.delete_job
delete_job
(
request
:
typing
.
Optional
[
typing
.
Union
[
google
.
cloud
.
batch_v1
.
types
.
batch
.
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
]]]
=
()
)
-
> google
.
api_core
.
operation
.
Operation
Delete a Job.
See more: google.cloud.batch_v1.services.batch_service.BatchServiceClient.delete_job
google.cloud.batch_v1.services.batch_service.BatchServiceClient.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.batch_v1.services.batch_service.BatchServiceClient.delete_operation
google.cloud.batch_v1.services.batch_service.BatchServiceClient.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.batch_v1.services.batch_service.BatchServiceClient.from_service_account_file
google.cloud.batch_v1.services.batch_service.BatchServiceClient.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.batch_v1.services.batch_service.BatchServiceClient.from_service_account_info
google.cloud.batch_v1.services.batch_service.BatchServiceClient.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.batch_v1.services.batch_service.BatchServiceClient.from_service_account_json
google.cloud.batch_v1.services.batch_service.BatchServiceClient.get_job
get_job
(
request
:
typing
.
Optional
[
typing
.
Union
[
google
.
cloud
.
batch_v1
.
types
.
batch
.
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
.
batch_v1
.
types
.
job
.
Job
Get a Job specified by its resource name.
See more: google.cloud.batch_v1.services.batch_service.BatchServiceClient.get_job
google.cloud.batch_v1.services.batch_service.BatchServiceClient.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.batch_v1.services.batch_service.BatchServiceClient.get_location
google.cloud.batch_v1.services.batch_service.BatchServiceClient.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.batch_v1.services.batch_service.BatchServiceClient.get_mtls_endpoint_and_cert_source
google.cloud.batch_v1.services.batch_service.BatchServiceClient.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.batch_v1.services.batch_service.BatchServiceClient.get_operation
google.cloud.batch_v1.services.batch_service.BatchServiceClient.get_task
get_task
(
request
:
typing
.
Optional
[
typing
.
Union
[
google
.
cloud
.
batch_v1
.
types
.
batch
.
GetTaskRequest
,
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
.
batch_v1
.
types
.
task
.
Task
Return a single Task.
See more: google.cloud.batch_v1.services.batch_service.BatchServiceClient.get_task
google.cloud.batch_v1.services.batch_service.BatchServiceClient.job_path
job_path
(
project
:
str
,
location
:
str
,
job
:
str
)
-
> str
Returns a fully-qualified job string.
See more: google.cloud.batch_v1.services.batch_service.BatchServiceClient.job_path
google.cloud.batch_v1.services.batch_service.BatchServiceClient.list_jobs
list_jobs
(
request
:
typing
.
Optional
[
typing
.
Union
[
google
.
cloud
.
batch_v1
.
types
.
batch
.
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
.
batch_v1
.
services
.
batch_service
.
pagers
.
ListJobsPager
List all Jobs for a project within a region.
See more: google.cloud.batch_v1.services.batch_service.BatchServiceClient.list_jobs
google.cloud.batch_v1.services.batch_service.BatchServiceClient.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.batch_v1.services.batch_service.BatchServiceClient.list_locations
google.cloud.batch_v1.services.batch_service.BatchServiceClient.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.batch_v1.services.batch_service.BatchServiceClient.list_operations
google.cloud.batch_v1.services.batch_service.BatchServiceClient.list_tasks
list_tasks
(
request
:
typing
.
Optional
[
typing
.
Union
[
google
.
cloud
.
batch_v1
.
types
.
batch
.
ListTasksRequest
,
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
.
batch_v1
.
services
.
batch_service
.
pagers
.
ListTasksPager
List Tasks associated with a job.
See more: google.cloud.batch_v1.services.batch_service.BatchServiceClient.list_tasks
google.cloud.batch_v1.services.batch_service.BatchServiceClient.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.batch_v1.services.batch_service.BatchServiceClient.parse_common_billing_account_path
google.cloud.batch_v1.services.batch_service.BatchServiceClient.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.batch_v1.services.batch_service.BatchServiceClient.parse_common_folder_path
google.cloud.batch_v1.services.batch_service.BatchServiceClient.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.batch_v1.services.batch_service.BatchServiceClient.parse_common_location_path
google.cloud.batch_v1.services.batch_service.BatchServiceClient.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.batch_v1.services.batch_service.BatchServiceClient.parse_common_organization_path
google.cloud.batch_v1.services.batch_service.BatchServiceClient.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.batch_v1.services.batch_service.BatchServiceClient.parse_common_project_path
google.cloud.batch_v1.services.batch_service.BatchServiceClient.parse_job_path
parse_job_path
(
path
:
str
)
-
> typing
.
Dict
[
str
,
str
]
Parses a job path into its component segments.
See more: google.cloud.batch_v1.services.batch_service.BatchServiceClient.parse_job_path
google.cloud.batch_v1.services.batch_service.BatchServiceClient.parse_task_group_path
parse_task_group_path
(
path
:
str
)
-
> typing
.
Dict
[
str
,
str
]
Parses a task_group path into its component segments.
See more: google.cloud.batch_v1.services.batch_service.BatchServiceClient.parse_task_group_path
google.cloud.batch_v1.services.batch_service.BatchServiceClient.parse_task_path
parse_task_path
(
path
:
str
)
-
> typing
.
Dict
[
str
,
str
]
Parses a task path into its component segments.
See more: google.cloud.batch_v1.services.batch_service.BatchServiceClient.parse_task_path
google.cloud.batch_v1.services.batch_service.BatchServiceClient.task_group_path
task_group_path
(
project
:
str
,
location
:
str
,
job
:
str
,
task_group
:
str
)
-
> str
Returns a fully-qualified task_group string.
See more: google.cloud.batch_v1.services.batch_service.BatchServiceClient.task_group_path
google.cloud.batch_v1.services.batch_service.BatchServiceClient.task_path
task_path
(
project
:
str
,
location
:
str
,
job
:
str
,
task_group
:
str
,
task
:
str
)
-
> str
Returns a fully-qualified task string.
See more: google.cloud.batch_v1.services.batch_service.BatchServiceClient.task_path
google.cloud.batch_v1.services.batch_service.pagers.ListJobsAsyncPager
ListJobsAsyncPager
(
method
:
typing
.
Callable
[
[
...
],
typing
.
Awaitable
[
google
.
cloud
.
batch_v1
.
types
.
batch
.
ListJobsResponse
]
],
request
:
google
.
cloud
.
batch_v1
.
types
.
batch
.
ListJobsRequest
,
response
:
google
.
cloud
.
batch_v1
.
types
.
batch
.
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.batch_v1.services.batch_service.pagers.ListJobsAsyncPager
google.cloud.batch_v1.services.batch_service.pagers.ListJobsPager
ListJobsPager
(
method
:
typing
.
Callable
[[
...
],
google
.
cloud
.
batch_v1
.
types
.
batch
.
ListJobsResponse
],
request
:
google
.
cloud
.
batch_v1
.
types
.
batch
.
ListJobsRequest
,
response
:
google
.
cloud
.
batch_v1
.
types
.
batch
.
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.batch_v1.services.batch_service.pagers.ListJobsPager
google.cloud.batch_v1.services.batch_service.pagers.ListTasksAsyncPager
ListTasksAsyncPager
(
method
:
typing
.
Callable
[
[
...
],
typing
.
Awaitable
[
google
.
cloud
.
batch_v1
.
types
.
batch
.
ListTasksResponse
]
],
request
:
google
.
cloud
.
batch_v1
.
types
.
batch
.
ListTasksRequest
,
response
:
google
.
cloud
.
batch_v1
.
types
.
batch
.
ListTasksResponse
,
*
,
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.batch_v1.services.batch_service.pagers.ListTasksAsyncPager
google.cloud.batch_v1.services.batch_service.pagers.ListTasksPager
ListTasksPager
(
method
:
typing
.
Callable
[[
...
],
google
.
cloud
.
batch_v1
.
types
.
batch
.
ListTasksResponse
],
request
:
google
.
cloud
.
batch_v1
.
types
.
batch
.
ListTasksRequest
,
response
:
google
.
cloud
.
batch_v1
.
types
.
batch
.
ListTasksResponse
,
*
,
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.batch_v1.services.batch_service.pagers.ListTasksPager
google.cloud.batch_v1alpha.services.batch_service.BatchServiceAsyncClient
BatchServiceAsyncClient
(
*
,
credentials
:
typing
.
Optional
[
google
.
auth
.
credentials
.
Credentials
]
=
None
,
transport
:
typing
.
Optional
[
typing
.
Union
[
str
,
google
.
cloud
.
batch_v1alpha
.
services
.
batch_service
.
transports
.
base
.
BatchServiceTransport
,
typing
.
Callable
[[
...
],
google
.
cloud
.
batch_v1alpha
.
services
.
batch_service
.
transports
.
base
.
BatchServiceTransport
]]]
=
'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 batch service async client.
See more: google.cloud.batch_v1alpha.services.batch_service.BatchServiceAsyncClient
google.cloud.batch_v1alpha.services.batch_service.BatchServiceAsyncClient.cancel_job
cancel_job
(
request
:
typing
.
Optional
[
typing
.
Union
[
google
.
cloud
.
batch_v1alpha
.
types
.
batch
.
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
.
api_core
.
operation_async
.
AsyncOperation
Cancel a Job.
See more: google.cloud.batch_v1alpha.services.batch_service.BatchServiceAsyncClient.cancel_job
google.cloud.batch_v1alpha.services.batch_service.BatchServiceAsyncClient.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.batch_v1alpha.services.batch_service.BatchServiceAsyncClient.cancel_operation
google.cloud.batch_v1alpha.services.batch_service.BatchServiceAsyncClient.common_billing_account_path
common_billing_account_path
(
billing_account
:
str
)
-
> str
Returns a fully-qualified billing_account string.
google.cloud.batch_v1alpha.services.batch_service.BatchServiceAsyncClient.common_folder_path
common_folder_path
(
folder
:
str
)
-
> str
Returns a fully-qualified folder string.
See more: google.cloud.batch_v1alpha.services.batch_service.BatchServiceAsyncClient.common_folder_path
google.cloud.batch_v1alpha.services.batch_service.BatchServiceAsyncClient.common_location_path
common_location_path
(
project
:
str
,
location
:
str
)
-
> str
Returns a fully-qualified location string.
See more: google.cloud.batch_v1alpha.services.batch_service.BatchServiceAsyncClient.common_location_path
google.cloud.batch_v1alpha.services.batch_service.BatchServiceAsyncClient.common_organization_path
common_organization_path
(
organization
:
str
)
-
> str
Returns a fully-qualified organization string.
See more: google.cloud.batch_v1alpha.services.batch_service.BatchServiceAsyncClient.common_organization_path
google.cloud.batch_v1alpha.services.batch_service.BatchServiceAsyncClient.common_project_path
common_project_path
(
project
:
str
)
-
> str
Returns a fully-qualified project string.
See more: google.cloud.batch_v1alpha.services.batch_service.BatchServiceAsyncClient.common_project_path
google.cloud.batch_v1alpha.services.batch_service.BatchServiceAsyncClient.create_job
create_job
(
request
:
typing
.
Optional
[
typing
.
Union
[
google
.
cloud
.
batch_v1alpha
.
types
.
batch
.
CreateJobRequest
,
dict
]
]
=
None
,
*
,
parent
:
typing
.
Optional
[
str
]
=
None
,
job
:
typing
.
Optional
[
google
.
cloud
.
batch_v1alpha
.
types
.
job
.
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
.
cloud
.
batch_v1alpha
.
types
.
job
.
Job
Create a Job.
See more: google.cloud.batch_v1alpha.services.batch_service.BatchServiceAsyncClient.create_job
google.cloud.batch_v1alpha.services.batch_service.BatchServiceAsyncClient.create_resource_allowance
create_resource_allowance
(
request
:
typing
.
Optional
[
typing
.
Union
[
google
.
cloud
.
batch_v1alpha
.
types
.
batch
.
CreateResourceAllowanceRequest
,
dict
]
]
=
None
,
*
,
parent
:
typing
.
Optional
[
str
]
=
None
,
resource_allowance
:
typing
.
Optional
[
google
.
cloud
.
batch_v1alpha
.
types
.
resource_allowance
.
ResourceAllowance
]
=
None
,
resource_allowance_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
.
cloud
.
batch_v1alpha
.
types
.
resource_allowance
.
ResourceAllowance
Create a Resource Allowance.
See more: google.cloud.batch_v1alpha.services.batch_service.BatchServiceAsyncClient.create_resource_allowance
google.cloud.batch_v1alpha.services.batch_service.BatchServiceAsyncClient.delete_job
delete_job
(
request
:
typing
.
Optional
[
typing
.
Union
[
google
.
cloud
.
batch_v1alpha
.
types
.
batch
.
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
]]]
=
()
)
-
> google
.
api_core
.
operation_async
.
AsyncOperation
Delete a Job.
See more: google.cloud.batch_v1alpha.services.batch_service.BatchServiceAsyncClient.delete_job
google.cloud.batch_v1alpha.services.batch_service.BatchServiceAsyncClient.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.batch_v1alpha.services.batch_service.BatchServiceAsyncClient.delete_operation
google.cloud.batch_v1alpha.services.batch_service.BatchServiceAsyncClient.delete_resource_allowance
delete_resource_allowance
(
request
:
typing
.
Optional
[
typing
.
Union
[
google
.
cloud
.
batch_v1alpha
.
types
.
batch
.
DeleteResourceAllowanceRequest
,
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
.
api_core
.
operation_async
.
AsyncOperation
Delete a ResourceAllowance.
See more: google.cloud.batch_v1alpha.services.batch_service.BatchServiceAsyncClient.delete_resource_allowance
google.cloud.batch_v1alpha.services.batch_service.BatchServiceAsyncClient.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.batch_v1alpha.services.batch_service.BatchServiceAsyncClient.from_service_account_file
google.cloud.batch_v1alpha.services.batch_service.BatchServiceAsyncClient.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.batch_v1alpha.services.batch_service.BatchServiceAsyncClient.from_service_account_info
google.cloud.batch_v1alpha.services.batch_service.BatchServiceAsyncClient.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.batch_v1alpha.services.batch_service.BatchServiceAsyncClient.from_service_account_json
google.cloud.batch_v1alpha.services.batch_service.BatchServiceAsyncClient.get_job
get_job
(
request
:
typing
.
Optional
[
typing
.
Union
[
google
.
cloud
.
batch_v1alpha
.
types
.
batch
.
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
.
batch_v1alpha
.
types
.
job
.
Job
Get a Job specified by its resource name.
See more: google.cloud.batch_v1alpha.services.batch_service.BatchServiceAsyncClient.get_job
google.cloud.batch_v1alpha.services.batch_service.BatchServiceAsyncClient.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.batch_v1alpha.services.batch_service.BatchServiceAsyncClient.get_location
google.cloud.batch_v1alpha.services.batch_service.BatchServiceAsyncClient.get_mtls_endpoint_and_cert_source
get_mtls_endpoint_and_cert_source
(
client_options
:
typing
.
Optional
[
google
.
api_core
.
client_options
.
ClientOptions
]
=
None
,
)
Return the API endpoint and client cert source for mutual TLS.
google.cloud.batch_v1alpha.services.batch_service.BatchServiceAsyncClient.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.batch_v1alpha.services.batch_service.BatchServiceAsyncClient.get_operation
google.cloud.batch_v1alpha.services.batch_service.BatchServiceAsyncClient.get_resource_allowance
get_resource_allowance
(
request
:
typing
.
Optional
[
typing
.
Union
[
google
.
cloud
.
batch_v1alpha
.
types
.
batch
.
GetResourceAllowanceRequest
,
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
.
batch_v1alpha
.
types
.
resource_allowance
.
ResourceAllowance
Get a ResourceAllowance specified by its resource name.
See more: google.cloud.batch_v1alpha.services.batch_service.BatchServiceAsyncClient.get_resource_allowance
google.cloud.batch_v1alpha.services.batch_service.BatchServiceAsyncClient.get_task
get_task
(
request
:
typing
.
Optional
[
typing
.
Union
[
google
.
cloud
.
batch_v1alpha
.
types
.
batch
.
GetTaskRequest
,
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
.
batch_v1alpha
.
types
.
task
.
Task
Return a single Task.
See more: google.cloud.batch_v1alpha.services.batch_service.BatchServiceAsyncClient.get_task
google.cloud.batch_v1alpha.services.batch_service.BatchServiceAsyncClient.get_transport_class
get_transport_class
(
label
:
typing
.
Optional
[
str
]
=
None
,
)
-
> typing
.
Type
[
google
.
cloud
.
batch_v1alpha
.
services
.
batch_service
.
transports
.
base
.
BatchServiceTransport
]
Returns an appropriate transport class.
See more: google.cloud.batch_v1alpha.services.batch_service.BatchServiceAsyncClient.get_transport_class
google.cloud.batch_v1alpha.services.batch_service.BatchServiceAsyncClient.job_path
job_path
(
project
:
str
,
location
:
str
,
job
:
str
)
-
> str
Returns a fully-qualified job string.
See more: google.cloud.batch_v1alpha.services.batch_service.BatchServiceAsyncClient.job_path
google.cloud.batch_v1alpha.services.batch_service.BatchServiceAsyncClient.list_jobs
list_jobs
(
request
:
typing
.
Optional
[
typing
.
Union
[
google
.
cloud
.
batch_v1alpha
.
types
.
batch
.
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
.
batch_v1alpha
.
services
.
batch_service
.
pagers
.
ListJobsAsyncPager
List all Jobs for a project within a region.
See more: google.cloud.batch_v1alpha.services.batch_service.BatchServiceAsyncClient.list_jobs
google.cloud.batch_v1alpha.services.batch_service.BatchServiceAsyncClient.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.batch_v1alpha.services.batch_service.BatchServiceAsyncClient.list_locations
google.cloud.batch_v1alpha.services.batch_service.BatchServiceAsyncClient.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.batch_v1alpha.services.batch_service.BatchServiceAsyncClient.list_operations
google.cloud.batch_v1alpha.services.batch_service.BatchServiceAsyncClient.list_resource_allowances
list_resource_allowances
(
request
:
typing
.
Optional
[
typing
.
Union
[
google
.
cloud
.
batch_v1alpha
.
types
.
batch
.
ListResourceAllowancesRequest
,
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
.
batch_v1alpha
.
services
.
batch_service
.
pagers
.
ListResourceAllowancesAsyncPager
)
List all ResourceAllowances for a project within a region.
See more: google.cloud.batch_v1alpha.services.batch_service.BatchServiceAsyncClient.list_resource_allowances
google.cloud.batch_v1alpha.services.batch_service.BatchServiceAsyncClient.list_tasks
list_tasks
(
request
:
typing
.
Optional
[
typing
.
Union
[
google
.
cloud
.
batch_v1alpha
.
types
.
batch
.
ListTasksRequest
,
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
.
batch_v1alpha
.
services
.
batch_service
.
pagers
.
ListTasksAsyncPager
List Tasks associated with a job.
See more: google.cloud.batch_v1alpha.services.batch_service.BatchServiceAsyncClient.list_tasks
google.cloud.batch_v1alpha.services.batch_service.BatchServiceAsyncClient.parse_common_billing_account_path
parse_common_billing_account_path
(
path
:
str
)
-
> typing
.
Dict
[
str
,
str
]
Parse a billing_account path into its component segments.
google.cloud.batch_v1alpha.services.batch_service.BatchServiceAsyncClient.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.batch_v1alpha.services.batch_service.BatchServiceAsyncClient.parse_common_folder_path
google.cloud.batch_v1alpha.services.batch_service.BatchServiceAsyncClient.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.batch_v1alpha.services.batch_service.BatchServiceAsyncClient.parse_common_location_path
google.cloud.batch_v1alpha.services.batch_service.BatchServiceAsyncClient.parse_common_organization_path
parse_common_organization_path
(
path
:
str
)
-
> typing
.
Dict
[
str
,
str
]
Parse a organization path into its component segments.
google.cloud.batch_v1alpha.services.batch_service.BatchServiceAsyncClient.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.batch_v1alpha.services.batch_service.BatchServiceAsyncClient.parse_common_project_path
google.cloud.batch_v1alpha.services.batch_service.BatchServiceAsyncClient.parse_job_path
parse_job_path
(
path
:
str
)
-
> typing
.
Dict
[
str
,
str
]
Parses a job path into its component segments.
See more: google.cloud.batch_v1alpha.services.batch_service.BatchServiceAsyncClient.parse_job_path
google.cloud.batch_v1alpha.services.batch_service.BatchServiceAsyncClient.parse_resource_allowance_path
parse_resource_allowance_path
(
path
:
str
)
-
> typing
.
Dict
[
str
,
str
]
Parses a resource_allowance path into its component segments.
google.cloud.batch_v1alpha.services.batch_service.BatchServiceAsyncClient.parse_task_group_path
parse_task_group_path
(
path
:
str
)
-
> typing
.
Dict
[
str
,
str
]
Parses a task_group path into its component segments.
See more: google.cloud.batch_v1alpha.services.batch_service.BatchServiceAsyncClient.parse_task_group_path
google.cloud.batch_v1alpha.services.batch_service.BatchServiceAsyncClient.parse_task_path
parse_task_path
(
path
:
str
)
-
> typing
.
Dict
[
str
,
str
]
Parses a task path into its component segments.
See more: google.cloud.batch_v1alpha.services.batch_service.BatchServiceAsyncClient.parse_task_path
google.cloud.batch_v1alpha.services.batch_service.BatchServiceAsyncClient.resource_allowance_path
resource_allowance_path
(
project
:
str
,
location
:
str
,
resource_allowance
:
str
)
-
> str
Returns a fully-qualified resource_allowance string.
See more: google.cloud.batch_v1alpha.services.batch_service.BatchServiceAsyncClient.resource_allowance_path
google.cloud.batch_v1alpha.services.batch_service.BatchServiceAsyncClient.task_group_path
task_group_path
(
project
:
str
,
location
:
str
,
job
:
str
,
task_group
:
str
)
-
> str
Returns a fully-qualified task_group string.
See more: google.cloud.batch_v1alpha.services.batch_service.BatchServiceAsyncClient.task_group_path
google.cloud.batch_v1alpha.services.batch_service.BatchServiceAsyncClient.task_path
task_path
(
project
:
str
,
location
:
str
,
job
:
str
,
task_group
:
str
,
task
:
str
)
-
> str
Returns a fully-qualified task string.
See more: google.cloud.batch_v1alpha.services.batch_service.BatchServiceAsyncClient.task_path
google.cloud.batch_v1alpha.services.batch_service.BatchServiceAsyncClient.update_job
update_job
(
request
:
typing
.
Optional
[
typing
.
Union
[
google
.
cloud
.
batch_v1alpha
.
types
.
batch
.
UpdateJobRequest
,
dict
]
]
=
None
,
*
,
job
:
typing
.
Optional
[
google
.
cloud
.
batch_v1alpha
.
types
.
job
.
Job
]
=
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
,
typing
.
Union
[
str
,
bytes
]]]
=
()
)
-
> google
.
cloud
.
batch_v1alpha
.
types
.
job
.
Job
Update a Job.
See more: google.cloud.batch_v1alpha.services.batch_service.BatchServiceAsyncClient.update_job
google.cloud.batch_v1alpha.services.batch_service.BatchServiceAsyncClient.update_resource_allowance
update_resource_allowance
(
request
:
typing
.
Optional
[
typing
.
Union
[
google
.
cloud
.
batch_v1alpha
.
types
.
batch
.
UpdateResourceAllowanceRequest
,
dict
]
]
=
None
,
*
,
resource_allowance
:
typing
.
Optional
[
google
.
cloud
.
batch_v1alpha
.
types
.
resource_allowance
.
ResourceAllowance
]
=
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
,
typing
.
Union
[
str
,
bytes
]]]
=
()
)
-
> google
.
cloud
.
batch_v1alpha
.
types
.
resource_allowance
.
ResourceAllowance
Update a Resource Allowance.
See more: google.cloud.batch_v1alpha.services.batch_service.BatchServiceAsyncClient.update_resource_allowance
google.cloud.batch_v1alpha.services.batch_service.BatchServiceClient
BatchServiceClient
(
*
,
credentials
:
typing
.
Optional
[
google
.
auth
.
credentials
.
Credentials
]
=
None
,
transport
:
typing
.
Optional
[
typing
.
Union
[
str
,
google
.
cloud
.
batch_v1alpha
.
services
.
batch_service
.
transports
.
base
.
BatchServiceTransport
,
typing
.
Callable
[[
...
],
google
.
cloud
.
batch_v1alpha
.
services
.
batch_service
.
transports
.
base
.
BatchServiceTransport
]]]
=
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 batch service client.
See more: google.cloud.batch_v1alpha.services.batch_service.BatchServiceClient
google.cloud.batch_v1alpha.services.batch_service.BatchServiceClient.__exit__
__exit__
(
type
,
value
,
traceback
)
Releases underlying transport's resources.
See more: google.cloud.batch_v1alpha.services.batch_service.BatchServiceClient. exit
google.cloud.batch_v1alpha.services.batch_service.BatchServiceClient.cancel_job
cancel_job
(
request
:
typing
.
Optional
[
typing
.
Union
[
google
.
cloud
.
batch_v1alpha
.
types
.
batch
.
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
.
api_core
.
operation
.
Operation
Cancel a Job.
See more: google.cloud.batch_v1alpha.services.batch_service.BatchServiceClient.cancel_job
google.cloud.batch_v1alpha.services.batch_service.BatchServiceClient.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.batch_v1alpha.services.batch_service.BatchServiceClient.cancel_operation
google.cloud.batch_v1alpha.services.batch_service.BatchServiceClient.common_billing_account_path
common_billing_account_path
(
billing_account
:
str
)
-
> str
Returns a fully-qualified billing_account string.
See more: google.cloud.batch_v1alpha.services.batch_service.BatchServiceClient.common_billing_account_path
google.cloud.batch_v1alpha.services.batch_service.BatchServiceClient.common_folder_path
common_folder_path
(
folder
:
str
)
-
> str
Returns a fully-qualified folder string.
See more: google.cloud.batch_v1alpha.services.batch_service.BatchServiceClient.common_folder_path
google.cloud.batch_v1alpha.services.batch_service.BatchServiceClient.common_location_path
common_location_path
(
project
:
str
,
location
:
str
)
-
> str
Returns a fully-qualified location string.
See more: google.cloud.batch_v1alpha.services.batch_service.BatchServiceClient.common_location_path
google.cloud.batch_v1alpha.services.batch_service.BatchServiceClient.common_organization_path
common_organization_path
(
organization
:
str
)
-
> str
Returns a fully-qualified organization string.
See more: google.cloud.batch_v1alpha.services.batch_service.BatchServiceClient.common_organization_path
google.cloud.batch_v1alpha.services.batch_service.BatchServiceClient.common_project_path
common_project_path
(
project
:
str
)
-
> str
Returns a fully-qualified project string.
See more: google.cloud.batch_v1alpha.services.batch_service.BatchServiceClient.common_project_path
google.cloud.batch_v1alpha.services.batch_service.BatchServiceClient.create_job
create_job
(
request
:
typing
.
Optional
[
typing
.
Union
[
google
.
cloud
.
batch_v1alpha
.
types
.
batch
.
CreateJobRequest
,
dict
]
]
=
None
,
*
,
parent
:
typing
.
Optional
[
str
]
=
None
,
job
:
typing
.
Optional
[
google
.
cloud
.
batch_v1alpha
.
types
.
job
.
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
.
cloud
.
batch_v1alpha
.
types
.
job
.
Job
Create a Job.
See more: google.cloud.batch_v1alpha.services.batch_service.BatchServiceClient.create_job
google.cloud.batch_v1alpha.services.batch_service.BatchServiceClient.create_resource_allowance
create_resource_allowance
(
request
:
typing
.
Optional
[
typing
.
Union
[
google
.
cloud
.
batch_v1alpha
.
types
.
batch
.
CreateResourceAllowanceRequest
,
dict
]
]
=
None
,
*
,
parent
:
typing
.
Optional
[
str
]
=
None
,
resource_allowance
:
typing
.
Optional
[
google
.
cloud
.
batch_v1alpha
.
types
.
resource_allowance
.
ResourceAllowance
]
=
None
,
resource_allowance_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
.
cloud
.
batch_v1alpha
.
types
.
resource_allowance
.
ResourceAllowance
Create a Resource Allowance.
See more: google.cloud.batch_v1alpha.services.batch_service.BatchServiceClient.create_resource_allowance
google.cloud.batch_v1alpha.services.batch_service.BatchServiceClient.delete_job
delete_job
(
request
:
typing
.
Optional
[
typing
.
Union
[
google
.
cloud
.
batch_v1alpha
.
types
.
batch
.
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
]]]
=
()
)
-
> google
.
api_core
.
operation
.
Operation
Delete a Job.
See more: google.cloud.batch_v1alpha.services.batch_service.BatchServiceClient.delete_job
google.cloud.batch_v1alpha.services.batch_service.BatchServiceClient.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.batch_v1alpha.services.batch_service.BatchServiceClient.delete_operation
google.cloud.batch_v1alpha.services.batch_service.BatchServiceClient.delete_resource_allowance
delete_resource_allowance
(
request
:
typing
.
Optional
[
typing
.
Union
[
google
.
cloud
.
batch_v1alpha
.
types
.
batch
.
DeleteResourceAllowanceRequest
,
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
.
api_core
.
operation
.
Operation
Delete a ResourceAllowance.
See more: google.cloud.batch_v1alpha.services.batch_service.BatchServiceClient.delete_resource_allowance
google.cloud.batch_v1alpha.services.batch_service.BatchServiceClient.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.batch_v1alpha.services.batch_service.BatchServiceClient.from_service_account_file
google.cloud.batch_v1alpha.services.batch_service.BatchServiceClient.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.batch_v1alpha.services.batch_service.BatchServiceClient.from_service_account_info
google.cloud.batch_v1alpha.services.batch_service.BatchServiceClient.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.batch_v1alpha.services.batch_service.BatchServiceClient.from_service_account_json
google.cloud.batch_v1alpha.services.batch_service.BatchServiceClient.get_job
get_job
(
request
:
typing
.
Optional
[
typing
.
Union
[
google
.
cloud
.
batch_v1alpha
.
types
.
batch
.
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
.
batch_v1alpha
.
types
.
job
.
Job
Get a Job specified by its resource name.
See more: google.cloud.batch_v1alpha.services.batch_service.BatchServiceClient.get_job
google.cloud.batch_v1alpha.services.batch_service.BatchServiceClient.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.batch_v1alpha.services.batch_service.BatchServiceClient.get_location
google.cloud.batch_v1alpha.services.batch_service.BatchServiceClient.get_mtls_endpoint_and_cert_source
get_mtls_endpoint_and_cert_source
(
client_options
:
typing
.
Optional
[
google
.
api_core
.
client_options
.
ClientOptions
]
=
None
,
)
Deprecated.
google.cloud.batch_v1alpha.services.batch_service.BatchServiceClient.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.batch_v1alpha.services.batch_service.BatchServiceClient.get_operation
google.cloud.batch_v1alpha.services.batch_service.BatchServiceClient.get_resource_allowance
get_resource_allowance
(
request
:
typing
.
Optional
[
typing
.
Union
[
google
.
cloud
.
batch_v1alpha
.
types
.
batch
.
GetResourceAllowanceRequest
,
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
.
batch_v1alpha
.
types
.
resource_allowance
.
ResourceAllowance
Get a ResourceAllowance specified by its resource name.
See more: google.cloud.batch_v1alpha.services.batch_service.BatchServiceClient.get_resource_allowance
google.cloud.batch_v1alpha.services.batch_service.BatchServiceClient.get_task
get_task
(
request
:
typing
.
Optional
[
typing
.
Union
[
google
.
cloud
.
batch_v1alpha
.
types
.
batch
.
GetTaskRequest
,
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
.
batch_v1alpha
.
types
.
task
.
Task
Return a single Task.
See more: google.cloud.batch_v1alpha.services.batch_service.BatchServiceClient.get_task
google.cloud.batch_v1alpha.services.batch_service.BatchServiceClient.job_path
job_path
(
project
:
str
,
location
:
str
,
job
:
str
)
-
> str
Returns a fully-qualified job string.
See more: google.cloud.batch_v1alpha.services.batch_service.BatchServiceClient.job_path
google.cloud.batch_v1alpha.services.batch_service.BatchServiceClient.list_jobs
list_jobs
(
request
:
typing
.
Optional
[
typing
.
Union
[
google
.
cloud
.
batch_v1alpha
.
types
.
batch
.
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
.
batch_v1alpha
.
services
.
batch_service
.
pagers
.
ListJobsPager
List all Jobs for a project within a region.
See more: google.cloud.batch_v1alpha.services.batch_service.BatchServiceClient.list_jobs
google.cloud.batch_v1alpha.services.batch_service.BatchServiceClient.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.batch_v1alpha.services.batch_service.BatchServiceClient.list_locations
google.cloud.batch_v1alpha.services.batch_service.BatchServiceClient.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.batch_v1alpha.services.batch_service.BatchServiceClient.list_operations
google.cloud.batch_v1alpha.services.batch_service.BatchServiceClient.list_resource_allowances
list_resource_allowances
(
request
:
typing
.
Optional
[
typing
.
Union
[
google
.
cloud
.
batch_v1alpha
.
types
.
batch
.
ListResourceAllowancesRequest
,
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
.
batch_v1alpha
.
services
.
batch_service
.
pagers
.
ListResourceAllowancesPager
)
List all ResourceAllowances for a project within a region.
See more: google.cloud.batch_v1alpha.services.batch_service.BatchServiceClient.list_resource_allowances
google.cloud.batch_v1alpha.services.batch_service.BatchServiceClient.list_tasks
list_tasks
(
request
:
typing
.
Optional
[
typing
.
Union
[
google
.
cloud
.
batch_v1alpha
.
types
.
batch
.
ListTasksRequest
,
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
.
batch_v1alpha
.
services
.
batch_service
.
pagers
.
ListTasksPager
List Tasks associated with a job.
See more: google.cloud.batch_v1alpha.services.batch_service.BatchServiceClient.list_tasks
google.cloud.batch_v1alpha.services.batch_service.BatchServiceClient.parse_common_billing_account_path
parse_common_billing_account_path
(
path
:
str
)
-
> typing
.
Dict
[
str
,
str
]
Parse a billing_account path into its component segments.
google.cloud.batch_v1alpha.services.batch_service.BatchServiceClient.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.batch_v1alpha.services.batch_service.BatchServiceClient.parse_common_folder_path
google.cloud.batch_v1alpha.services.batch_service.BatchServiceClient.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.batch_v1alpha.services.batch_service.BatchServiceClient.parse_common_location_path
google.cloud.batch_v1alpha.services.batch_service.BatchServiceClient.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.batch_v1alpha.services.batch_service.BatchServiceClient.parse_common_organization_path
google.cloud.batch_v1alpha.services.batch_service.BatchServiceClient.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.batch_v1alpha.services.batch_service.BatchServiceClient.parse_common_project_path
google.cloud.batch_v1alpha.services.batch_service.BatchServiceClient.parse_job_path
parse_job_path
(
path
:
str
)
-
> typing
.
Dict
[
str
,
str
]
Parses a job path into its component segments.
See more: google.cloud.batch_v1alpha.services.batch_service.BatchServiceClient.parse_job_path
google.cloud.batch_v1alpha.services.batch_service.BatchServiceClient.parse_resource_allowance_path
parse_resource_allowance_path
(
path
:
str
)
-
> typing
.
Dict
[
str
,
str
]
Parses a resource_allowance path into its component segments.
See more: google.cloud.batch_v1alpha.services.batch_service.BatchServiceClient.parse_resource_allowance_path
google.cloud.batch_v1alpha.services.batch_service.BatchServiceClient.parse_task_group_path
parse_task_group_path
(
path
:
str
)
-
> typing
.
Dict
[
str
,
str
]
Parses a task_group path into its component segments.
See more: google.cloud.batch_v1alpha.services.batch_service.BatchServiceClient.parse_task_group_path
google.cloud.batch_v1alpha.services.batch_service.BatchServiceClient.parse_task_path
parse_task_path
(
path
:
str
)
-
> typing
.
Dict
[
str
,
str
]
Parses a task path into its component segments.
See more: google.cloud.batch_v1alpha.services.batch_service.BatchServiceClient.parse_task_path
google.cloud.batch_v1alpha.services.batch_service.BatchServiceClient.resource_allowance_path
resource_allowance_path
(
project
:
str
,
location
:
str
,
resource_allowance
:
str
)
-
> str
Returns a fully-qualified resource_allowance string.
See more: google.cloud.batch_v1alpha.services.batch_service.BatchServiceClient.resource_allowance_path
google.cloud.batch_v1alpha.services.batch_service.BatchServiceClient.task_group_path
task_group_path
(
project
:
str
,
location
:
str
,
job
:
str
,
task_group
:
str
)
-
> str
Returns a fully-qualified task_group string.
See more: google.cloud.batch_v1alpha.services.batch_service.BatchServiceClient.task_group_path
google.cloud.batch_v1alpha.services.batch_service.BatchServiceClient.task_path
task_path
(
project
:
str
,
location
:
str
,
job
:
str
,
task_group
:
str
,
task
:
str
)
-
> str
Returns a fully-qualified task string.
See more: google.cloud.batch_v1alpha.services.batch_service.BatchServiceClient.task_path
google.cloud.batch_v1alpha.services.batch_service.BatchServiceClient.update_job
update_job
(
request
:
typing
.
Optional
[
typing
.
Union
[
google
.
cloud
.
batch_v1alpha
.
types
.
batch
.
UpdateJobRequest
,
dict
]
]
=
None
,
*
,
job
:
typing
.
Optional
[
google
.
cloud
.
batch_v1alpha
.
types
.
job
.
Job
]
=
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
,
typing
.
Union
[
str
,
bytes
]]]
=
()
)
-
> google
.
cloud
.
batch_v1alpha
.
types
.
job
.
Job
Update a Job.
See more: google.cloud.batch_v1alpha.services.batch_service.BatchServiceClient.update_job
google.cloud.batch_v1alpha.services.batch_service.BatchServiceClient.update_resource_allowance
update_resource_allowance
(
request
:
typing
.
Optional
[
typing
.
Union
[
google
.
cloud
.
batch_v1alpha
.
types
.
batch
.
UpdateResourceAllowanceRequest
,
dict
]
]
=
None
,
*
,
resource_allowance
:
typing
.
Optional
[
google
.
cloud
.
batch_v1alpha
.
types
.
resource_allowance
.
ResourceAllowance
]
=
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
,
typing
.
Union
[
str
,
bytes
]]]
=
()
)
-
> google
.
cloud
.
batch_v1alpha
.
types
.
resource_allowance
.
ResourceAllowance
Update a Resource Allowance.
See more: google.cloud.batch_v1alpha.services.batch_service.BatchServiceClient.update_resource_allowance
google.cloud.batch_v1alpha.services.batch_service.pagers.ListJobsAsyncPager
ListJobsAsyncPager
(
method
:
typing
.
Callable
[
[
...
],
typing
.
Awaitable
[
google
.
cloud
.
batch_v1alpha
.
types
.
batch
.
ListJobsResponse
]
],
request
:
google
.
cloud
.
batch_v1alpha
.
types
.
batch
.
ListJobsRequest
,
response
:
google
.
cloud
.
batch_v1alpha
.
types
.
batch
.
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.batch_v1alpha.services.batch_service.pagers.ListJobsAsyncPager
google.cloud.batch_v1alpha.services.batch_service.pagers.ListJobsPager
ListJobsPager
(
method
:
typing
.
Callable
[
[
...
],
google
.
cloud
.
batch_v1alpha
.
types
.
batch
.
ListJobsResponse
],
request
:
google
.
cloud
.
batch_v1alpha
.
types
.
batch
.
ListJobsRequest
,
response
:
google
.
cloud
.
batch_v1alpha
.
types
.
batch
.
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.batch_v1alpha.services.batch_service.pagers.ListJobsPager
google.cloud.batch_v1alpha.services.batch_service.pagers.ListResourceAllowancesAsyncPager
ListResourceAllowancesAsyncPager
(
method
:
typing
.
Callable
[
[
...
],
typing
.
Awaitable
[
google
.
cloud
.
batch_v1alpha
.
types
.
batch
.
ListResourceAllowancesResponse
],
],
request
:
google
.
cloud
.
batch_v1alpha
.
types
.
batch
.
ListResourceAllowancesRequest
,
response
:
google
.
cloud
.
batch_v1alpha
.
types
.
batch
.
ListResourceAllowancesResponse
,
*
,
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.batch_v1alpha.services.batch_service.pagers.ListResourceAllowancesAsyncPager
google.cloud.batch_v1alpha.services.batch_service.pagers.ListResourceAllowancesPager
ListResourceAllowancesPager
(
method
:
typing
.
Callable
[
[
...
],
google
.
cloud
.
batch_v1alpha
.
types
.
batch
.
ListResourceAllowancesResponse
],
request
:
google
.
cloud
.
batch_v1alpha
.
types
.
batch
.
ListResourceAllowancesRequest
,
response
:
google
.
cloud
.
batch_v1alpha
.
types
.
batch
.
ListResourceAllowancesResponse
,
*
,
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.batch_v1alpha.services.batch_service.pagers.ListResourceAllowancesPager
google.cloud.batch_v1alpha.services.batch_service.pagers.ListTasksAsyncPager
ListTasksAsyncPager
(
method
:
typing
.
Callable
[
[
...
],
typing
.
Awaitable
[
google
.
cloud
.
batch_v1alpha
.
types
.
batch
.
ListTasksResponse
],
],
request
:
google
.
cloud
.
batch_v1alpha
.
types
.
batch
.
ListTasksRequest
,
response
:
google
.
cloud
.
batch_v1alpha
.
types
.
batch
.
ListTasksResponse
,
*
,
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.batch_v1alpha.services.batch_service.pagers.ListTasksAsyncPager
google.cloud.batch_v1alpha.services.batch_service.pagers.ListTasksPager
ListTasksPager
(
method
:
typing
.
Callable
[
[
...
],
google
.
cloud
.
batch_v1alpha
.
types
.
batch
.
ListTasksResponse
],
request
:
google
.
cloud
.
batch_v1alpha
.
types
.
batch
.
ListTasksRequest
,
response
:
google
.
cloud
.
batch_v1alpha
.
types
.
batch
.
ListTasksResponse
,
*
,
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.batch_v1alpha.services.batch_service.pagers.ListTasksPager