Class JobService

constructor

• new JobService(sdk: SDKInterface): JobService

  Parameters

  • sdk: SDKInterface

  Returns JobService

$type

cancel

• cancel(
      request: CancelJobRequest,
  ): Request<CancelJobRequest, Operation<GetOperationRequest>>

  Cancel a job.

  Parameters

  • request: CancelJobRequest

  Returns Request<CancelJobRequest, Operation<GetOperationRequest>>

• cancel(
      request: CancelJobRequest,
      metadata: Metadata,
  ): Request<CancelJobRequest, Operation<GetOperationRequest>>

  Parameters

  • request: CancelJobRequest
  • metadata: Metadata

  Returns Request<CancelJobRequest, Operation<GetOperationRequest>>

• cancel(
      request: CancelJobRequest,
      metadata: Metadata,
      options: Partial<CallOptions> & RetryOptions,
  ): Request<CancelJobRequest, Operation<GetOperationRequest>>

  Parameters

  • request: CancelJobRequest
  • metadata: Metadata
  • options: Partial<CallOptions> & RetryOptions

  Returns Request<CancelJobRequest, Operation<GetOperationRequest>>

• cancel(
      request: CancelJobRequest,
  ): Request<CancelJobRequest, Operation<GetOperationRequest>>

  Cancel a job.

  Parameters

  • request: CancelJobRequest

  Returns Request<CancelJobRequest, Operation<GetOperationRequest>>

• cancel(
      request: CancelJobRequest,
      metadata: Metadata,
  ): Request<CancelJobRequest, Operation<GetOperationRequest>>

  Cancel a job.

  Parameters

  • request: CancelJobRequest
  • metadata: Metadata

  Returns Request<CancelJobRequest, Operation<GetOperationRequest>>

• cancel(
      request: CancelJobRequest,
      metadata: Metadata,
      options: Partial<CallOptions> & RetryOptions,
  ): Request<CancelJobRequest, Operation<GetOperationRequest>>

  Cancel a job.

  Parameters

  • request: CancelJobRequest
  • metadata: Metadata
  • options: Partial<CallOptions> & RetryOptions

  Returns Request<CancelJobRequest, Operation<GetOperationRequest>>

create

• create(
      request: CreateJobRequest,
  ): Request<CreateJobRequest, Operation<GetOperationRequest>>

  Creates a job.

  Parameters

  • request: CreateJobRequest

  Returns Request<CreateJobRequest, Operation<GetOperationRequest>>

• create(
      request: CreateJobRequest,
      metadata: Metadata,
  ): Request<CreateJobRequest, Operation<GetOperationRequest>>

  Parameters

  • request: CreateJobRequest
  • metadata: Metadata

  Returns Request<CreateJobRequest, Operation<GetOperationRequest>>

• create(
      request: CreateJobRequest,
      metadata: Metadata,
      options: Partial<CallOptions> & RetryOptions,
  ): Request<CreateJobRequest, Operation<GetOperationRequest>>

  Parameters

  • request: CreateJobRequest
  • metadata: Metadata
  • options: Partial<CallOptions> & RetryOptions

  Returns Request<CreateJobRequest, Operation<GetOperationRequest>>

• create(
      request: CreateJobRequest,
  ): Request<CreateJobRequest, Operation<GetOperationRequest>>

  Creates a job.

  Parameters

  • request: CreateJobRequest

  Returns Request<CreateJobRequest, Operation<GetOperationRequest>>

• create(
      request: CreateJobRequest,
      metadata: Metadata,
  ): Request<CreateJobRequest, Operation<GetOperationRequest>>

  Creates a job.

  Parameters

  • request: CreateJobRequest
  • metadata: Metadata

  Returns Request<CreateJobRequest, Operation<GetOperationRequest>>

• create(
      request: CreateJobRequest,
      metadata: Metadata,
      options: Partial<CallOptions> & RetryOptions,
  ): Request<CreateJobRequest, Operation<GetOperationRequest>>

  Creates a job.

  Parameters

  • request: CreateJobRequest
  • metadata: Metadata
  • options: Partial<CallOptions> & RetryOptions

  Returns Request<CreateJobRequest, Operation<GetOperationRequest>>

delete

• delete(
      request: DeleteRequest,
  ): Request<DeleteRequest, Operation<GetOperationRequest>>

  Delete a job.

  Parameters

  • request: DeleteRequest

  Returns Request<DeleteRequest, Operation<GetOperationRequest>>

• delete(
      request: DeleteRequest,
      metadata: Metadata,
  ): Request<DeleteRequest, Operation<GetOperationRequest>>

  Parameters

  • request: DeleteRequest
  • metadata: Metadata

  Returns Request<DeleteRequest, Operation<GetOperationRequest>>

• delete(
      request: DeleteRequest,
      metadata: Metadata,
      options: Partial<CallOptions> & RetryOptions,
  ): Request<DeleteRequest, Operation<GetOperationRequest>>

  Parameters

  • request: DeleteRequest
  • metadata: Metadata
  • options: Partial<CallOptions> & RetryOptions

  Returns Request<DeleteRequest, Operation<GetOperationRequest>>

• delete(
      request: DeleteRequest,
  ): Request<DeleteRequest, Operation<GetOperationRequest>>

  Delete a job.

  Parameters

  • request: DeleteRequest

  Returns Request<DeleteRequest, Operation<GetOperationRequest>>

• delete(
      request: DeleteRequest,
      metadata: Metadata,
  ): Request<DeleteRequest, Operation<GetOperationRequest>>

  Delete a job.

  Parameters

  • request: DeleteRequest
  • metadata: Metadata

  Returns Request<DeleteRequest, Operation<GetOperationRequest>>

• delete(
      request: DeleteRequest,
      metadata: Metadata,
      options: Partial<CallOptions> & RetryOptions,
  ): Request<DeleteRequest, Operation<GetOperationRequest>>

  Delete a job.

  Parameters

  • request: DeleteRequest
  • metadata: Metadata
  • options: Partial<CallOptions> & RetryOptions

  Returns Request<DeleteRequest, Operation<GetOperationRequest>>

get

• get(request: GetRequest): Request<GetRequest, Job>

  Returns the specified job.

  Parameters

  • request: GetRequest

  Returns Request<GetRequest, Job>

• get(request: GetRequest, metadata: Metadata): Request<GetRequest, Job>

  Parameters

  • request: GetRequest
  • metadata: Metadata

  Returns Request<GetRequest, Job>

• get(
      request: GetRequest,
      metadata: Metadata,
      options: Partial<CallOptions> & RetryOptions,
  ): Request<GetRequest, Job>

  Parameters

  • request: GetRequest
  • metadata: Metadata
  • options: Partial<CallOptions> & RetryOptions

  Returns Request<GetRequest, Job>

• get(request: GetRequest): Request<GetRequest, Job>

  Returns the specified job.

  Parameters

  • request: GetRequest

  Returns Request<GetRequest, Job>

• get(request: GetRequest, metadata: Metadata): Request<GetRequest, Job>

  Returns the specified job.

  Parameters

  • request: GetRequest
  • metadata: Metadata

  Returns Request<GetRequest, Job>

• get(
      request: GetRequest,
      metadata: Metadata,
      options: Partial<CallOptions> & RetryOptions,
  ): Request<GetRequest, Job>

  Returns the specified job.

  Parameters

  • request: GetRequest
  • metadata: Metadata
  • options: Partial<CallOptions> & RetryOptions

  Returns Request<GetRequest, Job>

getOperationService

• getOperationService(): OperationService

  Returns OperationService

list

• list(request: ListRequest): Request<ListRequest, ListJobsResponse>

  Retrieves a list of jobs.

  Parameters

  • request: ListRequest

  Returns Request<ListRequest, ListJobsResponse>

• list(
      request: ListRequest,
      metadata: Metadata,
  ): Request<ListRequest, ListJobsResponse>

  Parameters

  • request: ListRequest
  • metadata: Metadata

  Returns Request<ListRequest, ListJobsResponse>

• list(
      request: ListRequest,
      metadata: Metadata,
      options: Partial<CallOptions> & RetryOptions,
  ): Request<ListRequest, ListJobsResponse>

  Parameters

  • request: ListRequest
  • metadata: Metadata
  • options: Partial<CallOptions> & RetryOptions

  Returns Request<ListRequest, ListJobsResponse>

• list(request: ListRequest): Request<ListRequest, ListJobsResponse>

  Retrieves a list of jobs.

  Parameters

  • request: ListRequest

  Returns Request<ListRequest, ListJobsResponse>

• list(
      request: ListRequest,
      metadata: Metadata,
  ): Request<ListRequest, ListJobsResponse>

  Retrieves a list of jobs.

  Parameters

  • request: ListRequest
  • metadata: Metadata

  Returns Request<ListRequest, ListJobsResponse>

• list(
      request: ListRequest,
      metadata: Metadata,
      options: Partial<CallOptions> & RetryOptions,
  ): Request<ListRequest, ListJobsResponse>

  Retrieves a list of jobs.

  Parameters

  • request: ListRequest
  • metadata: Metadata
  • options: Partial<CallOptions> & RetryOptions

  Returns Request<ListRequest, ListJobsResponse>