Class JobService

constructor

• new JobService(sdk: SDKInterface): JobService

  Creates a client that uses the SDK service address.

  Parameters

  • sdk: SDKInterface

  Returns JobService

$type

cancel

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

  Cancels a job.

  Parameters

  • request: CancelJobRequest

  Returns Request<CancelJobRequest, Operation<GetOperationRequest>>

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

  Cancels 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>>

  Cancels a job.

  Parameters

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

  Returns Request<CancelJobRequest, Operation<GetOperationRequest>>

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

  Cancels a job.

  Parameters

  • request: CancelJobRequest

  Returns Request<CancelJobRequest, Operation<GetOperationRequest>>

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

  Cancels 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>>

  Cancels 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>>

  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>>

• 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: DeleteJobRequest,
  ): Request<DeleteJobRequest, Operation<GetOperationRequest>>

  Deletes a job.

  Parameters

  • request: DeleteJobRequest

  Returns Request<DeleteJobRequest, Operation<GetOperationRequest>>

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

  Deletes a job.

  Parameters

  • request: DeleteJobRequest
  • metadata: Metadata

  Returns Request<DeleteJobRequest, Operation<GetOperationRequest>>

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

  Deletes a job.

  Parameters

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

  Returns Request<DeleteJobRequest, Operation<GetOperationRequest>>

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

  Deletes a job.

  Parameters

  • request: DeleteJobRequest

  Returns Request<DeleteJobRequest, Operation<GetOperationRequest>>

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

  Deletes a job.

  Parameters

  • request: DeleteJobRequest
  • metadata: Metadata

  Returns Request<DeleteJobRequest, Operation<GetOperationRequest>>

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

  Deletes a job.

  Parameters

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

  Returns Request<DeleteJobRequest, Operation<GetOperationRequest>>

filter

• filter(
      request: ListJobsRequest,
      metadata?: Metadata,
      options?: Partial<CallOptions> & RetryOptions,
  ): AsyncGenerator<Job>

  Calls the filter method.

  Parameters

  • request: ListJobsRequest
  • Optionalmetadata: Metadata
  • Optionaloptions: Partial<CallOptions> & RetryOptions

  Returns AsyncGenerator<Job>

• filter(
      request: ListJobsRequest,
      metadata?: Metadata,
      options?: Partial<CallOptions> & RetryOptions,
  ): AsyncGenerator<Job>

  Yields list items across pages, without changing the supplied request.

  Parameters

  • request: ListJobsRequest
  • Optionalmetadata: Metadata
  • Optionaloptions: Partial<CallOptions> & RetryOptions

  Returns AsyncGenerator<Job>

get

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

  Returns the specified job.

  Parameters

  • request: GetJobRequest

  Returns Request<GetJobRequest, Job>

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

  Returns the specified job.

  Parameters

  • request: GetJobRequest
  • metadata: Metadata

  Returns Request<GetJobRequest, Job>

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

  Returns the specified job.

  Parameters

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

  Returns Request<GetJobRequest, Job>

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

  Returns the specified job.

  Parameters

  • request: GetJobRequest

  Returns Request<GetJobRequest, Job>

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

  Returns the specified job.

  Parameters

  • request: GetJobRequest
  • metadata: Metadata

  Returns Request<GetJobRequest, Job>

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

  Returns the specified job.

  Parameters

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

  Returns Request<GetJobRequest, Job>

getByName

• getByName(request: GetJobByNameRequest): Request<GetJobByNameRequest, Job>

  Returns the specified job by name.

  Parameters

  • request: GetJobByNameRequest

  Returns Request<GetJobByNameRequest, Job>

• getByName(
      request: GetJobByNameRequest,
      metadata: Metadata,
  ): Request<GetJobByNameRequest, Job>

  Returns the specified job by name.

  Parameters

  • request: GetJobByNameRequest
  • metadata: Metadata

  Returns Request<GetJobByNameRequest, Job>

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

  Returns the specified job by name.

  Parameters

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

  Returns Request<GetJobByNameRequest, Job>

• getByName(request: GetJobByNameRequest): Request<GetJobByNameRequest, Job>

  Returns the specified job by name.

  Parameters

  • request: GetJobByNameRequest

  Returns Request<GetJobByNameRequest, Job>

• getByName(
      request: GetJobByNameRequest,
      metadata: Metadata,
  ): Request<GetJobByNameRequest, Job>

  Returns the specified job by name.

  Parameters

  • request: GetJobByNameRequest
  • metadata: Metadata

  Returns Request<GetJobByNameRequest, Job>

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

  Returns the specified job by name.

  Parameters

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

  Returns Request<GetJobByNameRequest, Job>

getOperationService

• getOperationService(): OperationService

  Returns the operation service for this service address.

  Returns OperationService

list

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

  Retrieves a list of jobs.

  Parameters

  • request: ListJobsRequest

  Returns Request<ListJobsRequest, ListJobsResponse>

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

  Retrieves a list of jobs.

  Parameters

  • request: ListJobsRequest
  • metadata: Metadata

  Returns Request<ListJobsRequest, ListJobsResponse>

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

  Retrieves a list of jobs.

  Parameters

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

  Returns Request<ListJobsRequest, ListJobsResponse>

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

  Retrieves a list of jobs.

  Parameters

  • request: ListJobsRequest

  Returns Request<ListJobsRequest, ListJobsResponse>

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

  Retrieves a list of jobs.

  Parameters

  • request: ListJobsRequest
  • metadata: Metadata

  Returns Request<ListJobsRequest, ListJobsResponse>

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

  Retrieves a list of jobs.

  Parameters

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

  Returns Request<ListJobsRequest, ListJobsResponse>

listOperations

• listOperations(
      request: ListOperationsRequest,
      metadata?: Metadata,
      options?: Partial<CallOptions> & RetryOptions,
  ): Request<ListOperationsRequest>

  Lists operations for this service address.

  Parameters

  • request: ListOperationsRequest
  • metadata: Metadata = ...
  • options: Partial<CallOptions> & RetryOptions = {}

  Returns Request<ListOperationsRequest>

restart

• restart(
      request: RestartJobRequest,
  ): Request<RestartJobRequest, Operation<GetOperationRequest>>

  Restarts a job.

  Parameters

  • request: RestartJobRequest

  Returns Request<RestartJobRequest, Operation<GetOperationRequest>>

• restart(
      request: RestartJobRequest,
      metadata: Metadata,
  ): Request<RestartJobRequest, Operation<GetOperationRequest>>

  Restarts a job.

  Parameters

  • request: RestartJobRequest
  • metadata: Metadata

  Returns Request<RestartJobRequest, Operation<GetOperationRequest>>

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

  Restarts a job.

  Parameters

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

  Returns Request<RestartJobRequest, Operation<GetOperationRequest>>

• restart(
      request: RestartJobRequest,
  ): Request<RestartJobRequest, Operation<GetOperationRequest>>

  Restarts a job.

  Parameters

  • request: RestartJobRequest

  Returns Request<RestartJobRequest, Operation<GetOperationRequest>>

• restart(
      request: RestartJobRequest,
      metadata: Metadata,
  ): Request<RestartJobRequest, Operation<GetOperationRequest>>

  Restarts a job.

  Parameters

  • request: RestartJobRequest
  • metadata: Metadata

  Returns Request<RestartJobRequest, Operation<GetOperationRequest>>

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

  Restarts a job.

  Parameters

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

  Returns Request<RestartJobRequest, Operation<GetOperationRequest>>