Batch

import { Batch } from "https://googleapis.deno.dev/v1/batch:v1.ts";

An API to manage the running of Batch resources on Google Cloud Platform.

class Batch {

constructor(client?: CredentialsClient, baseUrl?: string);

async projectsLocationsGet(name: string): Promise<Location>;

async projectsLocationsJobsCancel(name: string, req: CancelJobRequest): Promise<Operation>;

async projectsLocationsJobsCreate(

parent: string,

req: Job,

opts?: ProjectsLocationsJobsCreateOptions,

): Promise<Job>;

async projectsLocationsJobsDelete(name: string, opts?: ProjectsLocationsJobsDeleteOptions): Promise<Operation>;

async projectsLocationsJobsGet(name: string): Promise<Job>;

async projectsLocationsJobsList(parent: string, opts?: ProjectsLocationsJobsListOptions): Promise<ListJobsResponse>;

async projectsLocationsJobsTaskGroupsTasksGet(name: string): Promise<Task>;

async projectsLocationsJobsTaskGroupsTasksList(parent: string, opts?: ProjectsLocationsJobsTaskGroupsTasksListOptions): Promise<ListTasksResponse>;

async projectsLocationsList(name: string, opts?: ProjectsLocationsListOptions): Promise<ListLocationsResponse>;

async projectsLocationsOperationsCancel(name: string, req: CancelOperationRequest): Promise<Empty>;

async projectsLocationsOperationsDelete(name: string): Promise<Empty>;

async projectsLocationsOperationsGet(name: string): Promise<Operation>;

async projectsLocationsOperationsList(name: string, opts?: ProjectsLocationsOperationsListOptions): Promise<ListOperationsResponse>;

async projectsLocationsStateReport(parent: string, req: ReportAgentStateRequest): Promise<ReportAgentStateResponse>;

}

§Constructors

new Batch(client?: CredentialsClient, baseUrl?: string)

[src]

§Methods

projectsLocationsGet(name: string): Promise<Location>

[src]

Gets information about a location.

@param name

Resource name for the location.

projectsLocationsJobsCancel(name: string, req: CancelJobRequest): Promise<Operation>

[src]

Cancel a Job.

@param name

Required. Job name.

projectsLocationsJobsCreate(parent: string, req: Job, opts?: ProjectsLocationsJobsCreateOptions): Promise<Job>

[src]

Create a Job.

@param parent

Required. The parent resource name where the Job will be created. Pattern: "projects/{project}/locations/{location}"

projectsLocationsJobsDelete(name: string, opts?: ProjectsLocationsJobsDeleteOptions): Promise<Operation>

[src]

Delete a Job.

@param name

Job name.

projectsLocationsJobsGet(name: string): Promise<Job>

[src]

Get a Job specified by its resource name.

@param name

Required. Job name.

projectsLocationsJobsList(parent: string, opts?: ProjectsLocationsJobsListOptions): Promise<ListJobsResponse>

[src]

List all Jobs for a project within a region.

@param parent

Parent path.

projectsLocationsJobsTaskGroupsTasksGet(name: string): Promise<Task>

[src]

Return a single Task.

@param name

Required. Task name.

projectsLocationsJobsTaskGroupsTasksList(parent: string, opts?: ProjectsLocationsJobsTaskGroupsTasksListOptions): Promise<ListTasksResponse>

[src]

List Tasks associated with a job.

@param parent

Required. Name of a TaskGroup from which Tasks are being requested. Pattern: "projects/{project}/locations/{location}/jobs/{job}/taskGroups/{task_group}"

projectsLocationsList(name: string, opts?: ProjectsLocationsListOptions): Promise<ListLocationsResponse>

[src]

Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the [ListLocationsRequest.name] field: * Global locations: If name is empty, the method lists the public locations available to all projects. * Project-specific locations: If name follows the format projects/{project}, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the name field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version.

@param name

The resource that owns the locations collection, if applicable.

projectsLocationsOperationsCancel(name: string, req: CancelOperationRequest): Promise<Empty>

[src]

Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to Code.CANCELLED.

@param name

The name of the operation resource to be cancelled.

projectsLocationsOperationsDelete(name: string): Promise<Empty>

[src]

Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED.

@param name

The name of the operation resource to be deleted.

projectsLocationsOperationsGet(name: string): Promise<Operation>

[src]

Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

@param name

The name of the operation resource.

projectsLocationsOperationsList(name: string, opts?: ProjectsLocationsOperationsListOptions): Promise<ListOperationsResponse>

[src]

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED.

@param name

The name of the operation's parent resource.

projectsLocationsStateReport(parent: string, req: ReportAgentStateRequest): Promise<ReportAgentStateResponse>

[src]

Report agent's state, e.g. agent status and tasks information

@param parent

Required. Format: projects/{project}/locations/{location} {project} should be a project number.