Class API

constructor

• new API(client): Jobs.v1alpha1.API

• Parameters

  • client: Client

  Returns Jobs.v1alpha1.API

Static ReadonlyLOCALITIES

createJobDefinition

• createJobDefinition(request): Promise<JobDefinition>

• Create a new job definition in a specified Project.

  Parameters

  • request: Readonly<Jobs.v1alpha1.CreateJobDefinitionRequest>

    The request CreateJobDefinitionRequest

  Returns Promise<JobDefinition>

  A Promise of JobDefinition

createJobDefinitionSecrets

• createJobDefinitionSecrets(request): Promise<CreateJobDefinitionSecretsResponse>

• Create a secret reference within a job definition.

  Parameters

  • request: Readonly<CreateJobDefinitionSecretsRequest>

    The request CreateJobDefinitionSecretsRequest

  Returns Promise<CreateJobDefinitionSecretsResponse>

  A Promise of CreateJobDefinitionSecretsResponse

deleteJobDefinition

• deleteJobDefinition(request): Promise<void>

• Delete an exsisting job definition by its unique identifier.

  Parameters

  • request: Readonly<DeleteJobDefinitionRequest>

    The request DeleteJobDefinitionRequest

  Returns Promise<void>

deleteJobDefinitionSecret

• deleteJobDefinitionSecret(request): Promise<void>

• Delete a secret reference within a job definition.

  Parameters

  • request: Readonly<DeleteJobDefinitionSecretRequest>

    The request DeleteJobDefinitionSecretRequest

  Returns Promise<void>

getJobDefinition

• getJobDefinition(request): Promise<JobDefinition>

• Get a job definition by its unique identifier.

  Parameters

  • request: Readonly<GetJobDefinitionRequest>

    The request GetJobDefinitionRequest

  Returns Promise<JobDefinition>

  A Promise of JobDefinition

getJobDefinitionSecret

• getJobDefinitionSecret(request): Promise<Jobs.v1alpha1.Secret>

• Get a secret references within a job definition.

  Parameters

  • request: Readonly<GetJobDefinitionSecretRequest>

    The request GetJobDefinitionSecretRequest

  Returns Promise<Jobs.v1alpha1.Secret>

  A Promise of Secret

getJobRun

• getJobRun(request): Promise<JobRun>

• Get a job run by its unique identifier.

  Parameters

  • request: Readonly<GetJobRunRequest>

    The request GetJobRunRequest

  Returns Promise<JobRun>

  A Promise of JobRun

getJobsLimits

• getJobsLimits(request?): Promise<JobsLimits>

• Get jobs limits for the console.

  Parameters

  • request: Readonly<GetJobsLimitsRequest> = {}

    The request GetJobsLimitsRequest

  Returns Promise<JobsLimits>

  A Promise of JobsLimits

listJobDefinitionSecrets

• listJobDefinitionSecrets(request): Promise<ListJobDefinitionSecretsResponse>

• List secrets references within a job definition.

  Parameters

  • request: Readonly<ListJobDefinitionSecretsRequest>

    The request ListJobDefinitionSecretsRequest

  Returns Promise<ListJobDefinitionSecretsResponse>

  A Promise of ListJobDefinitionSecretsResponse

listJobDefinitions

• listJobDefinitions(request?): Promise<ListJobDefinitionsResponse> & {
      [asyncIterator]: (() => AsyncGenerator<JobDefinition[], void, void>);
      all: (() => Promise<JobDefinition[]>);
  }

• List all your job definitions with filters.

  Parameters

  • request: Readonly<Jobs.v1alpha1.ListJobDefinitionsRequest> = {}

    The request ListJobDefinitionsRequest

  Returns Promise<ListJobDefinitionsResponse> & {
      [asyncIterator]: (() => AsyncGenerator<JobDefinition[], void, void>);
      all: (() => Promise<JobDefinition[]>);
  }

  A Promise of ListJobDefinitionsResponse

listJobRuns

• listJobRuns(request?): Promise<ListJobRunsResponse> & {
      [asyncIterator]: (() => AsyncGenerator<JobRun[], void, void>);
      all: (() => Promise<JobRun[]>);
  }

• List all job runs with filters.

  Parameters

  • request: Readonly<Jobs.v1alpha1.ListJobRunsRequest> = {}

    The request ListJobRunsRequest

  Returns Promise<ListJobRunsResponse> & {
      [asyncIterator]: (() => AsyncGenerator<JobRun[], void, void>);
      all: (() => Promise<JobRun[]>);
  }

  A Promise of ListJobRunsResponse

listJobsResources

• listJobsResources(request?): Promise<ListJobsResourcesResponse>

• List jobs resources for the console.

  Parameters

  • request: Readonly<ListJobsResourcesRequest> = {}

    The request ListJobsResourcesRequest

  Returns Promise<ListJobsResourcesResponse>

  A Promise of ListJobsResourcesResponse

startJobDefinition

• startJobDefinition(request): Promise<StartJobDefinitionResponse>

• Run an existing job definition by its unique identifier. This will create a new job run.

  Parameters

  • request: Readonly<Jobs.v1alpha1.StartJobDefinitionRequest>

    The request StartJobDefinitionRequest

  Returns Promise<StartJobDefinitionResponse>

  A Promise of StartJobDefinitionResponse

stopJobRun

• stopJobRun(request): Promise<JobRun>

• Stop a job run by its unique identifier.

  Parameters

  • request: Readonly<StopJobRunRequest>

    The request StopJobRunRequest

  Returns Promise<JobRun>

  A Promise of JobRun

updateJobDefinition

• updateJobDefinition(request): Promise<JobDefinition>

• Update an existing job definition associated with the specified unique identifier.

  Parameters

  • request: Readonly<Jobs.v1alpha1.UpdateJobDefinitionRequest>

    The request UpdateJobDefinitionRequest

  Returns Promise<JobDefinition>

  A Promise of JobDefinition

updateJobDefinitionSecret

• updateJobDefinitionSecret(request): Promise<Jobs.v1alpha1.Secret>

• Update a secret reference within a job definition.

  Parameters

  • request: Readonly<Jobs.v1alpha1.UpdateJobDefinitionSecretRequest>

    The request UpdateJobDefinitionSecretRequest

  Returns Promise<Jobs.v1alpha1.Secret>

  A Promise of Secret