cloudera.services.ssb_job_info module – Retrieve information about SSB jobs

Note

This module is part of the cloudera.services collection (version 1.0.0).

It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install git+https://github.com/cloudera-labs/cloudera.services.git.

To use it in a playbook, specify: cloudera.services.ssb_job_info.

New in cloudera.services 1.0.0

Synopsis

  • Retrieve information about one or more Cloudera SQL Stream Builder (SSB) jobs.

  • The module can list all jobs in a project or filter by job ID, name, or state.

  • The module supports check_mode.

Parameters

Parameter

Comments

client_cert

path

The path to a client certificate for authenticating to the API endpoint.

client_key

path

The path to a client key for authenticating to the API endpoint.

debug

aliases: debug_endpoints

boolean

A flag to enable debug logging of the module’s execution.

Choices:

  • false ← (default)

  • true

force

boolean

A flag to force a refresh of the API request, ignoring any cached results.

Choices:

  • false ← (default)

  • true

force_basic_auth

boolean

A flag to force basic authentication for API requests.

Choices:

  • false ← (default)

  • true

http_agent

aliases: user_agent

string

The User-Agent string to send with API requests.

Default: "cloudera-services-module"

job_id

integer

The unique identifier of a specific job to retrieve.

When specified, only this job will be returned.

This parameter is mutually exclusive with name and state.

name

string

The name of the job to filter by.

When specified, only jobs matching this name will be returned.

This parameter is mutually exclusive with job_id.

page_size

aliases: default_page_size

integer

The number of items to return per page in a paginated API response.

Default: 100

project_id

string / required

The unique identifier of the project containing the jobs.

This parameter is required as jobs are scoped to projects.

state

string

Filter jobs by their current state.

When specified, only jobs in this state will be returned.

This parameter is mutually exclusive with job_id.

Choices:

  • "INITIALIZING"

  • "CREATED"

  • "RUNNING"

  • "FAILING"

  • "FAILED"

  • "CANCELLING"

  • "CANCELED"

  • "FINISHED"

  • "RESTARTING"

  • "SUSPENDED"

  • "RECONCILING"

timeout

aliases: timeout_seconds

integer

The timeout in seconds for any API requests.

Default: 60

url

aliases: endpoint, endpoint_url

string / required

The base URL of the API endpoint, including the port if necessary.

url_password

string

The password for authenticating to the API endpoint.

url_username

string

The username for authenticating to the API endpoint.

use_gssapi

boolean

A flag to enable or disable GSSAPI authentication for API requests.

Choices:

  • false ← (default)

  • true

use_proxy

boolean

A flag to enable or disable the use of a proxy for API requests.

Choices:

  • false

  • true ← (default)

validate_certs

boolean

A flag to enable or disable SSL certificate validation for API requests.

Choices:

  • false

  • true ← (default)

Examples

- name: List all jobs in a project
  cloudera.services.ssb_job_info:
    project_id: "12345"
  register: all_jobs

- name: Get information about a specific job by ID
  cloudera.services.ssb_job_info:
    project_id: "12345"
    job_id: 67890
  register: specific_job

- name: List all running jobs in a project
  cloudera.services.ssb_job_info:
    project_id: "12345"
    state: RUNNING
  register: running_jobs

- name: Get jobs by name
  cloudera.services.ssb_job_info:
    project_id: "12345"
    name: "my-streaming-job"
  register: jobs_by_name

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key

Description

jobs

list / elements=dictionary

List of SSB jobs matching the specified criteria.

Returned: always

autoscaler_config

dictionary

Autoscaler configuration for this job.

Returned: when available

checkpoint_config

dictionary

Checkpoint configuration for this job.

Returned: when available

cluster_id

string

The ID of the cluster running this job.

Returned: when available

created_at

string

Timestamp when the job was created.

Returned: when available

end_time

integer

Timestamp when the job ended (epoch milliseconds).

Returned: when available

string

The Flink job ID associated with this SSB job.

Returned: when available

jm_url

string

The URL to the Flink JobManager for this job.

Returned: when available

job_id

integer

The unique identifier of the job.

Returned: when available

kubernetes_config

dictionary

Kubernetes configuration for this job.

Returned: when available

mv_config

dictionary

Materialized view configuration for this job.

Returned: when available

mv_endpoints

list / elements=dictionary

List of materialized view API endpoints for this job.

Returned: when available

name

string

The name of the job.

Returned: always

project_id

string

The ID of the project containing this job.

Returned: when available

sample_id

string

The sample ID for this job.

Returned: when available

savepoint_id

integer

The ID of the savepoint associated with this job.

Returned: when available

sql

string

The SQL query executed by this job.

Returned: always

start_time

integer

Timestamp when the job was started (epoch milliseconds).

Returned: when available

state

string

The current state of the job.

Returned: when available

user_id

string

The ID of the user who created the job.

Returned: when available

username

string

The username of the user who created the job.

Returned: when available

sdk_out

string

Returns the captured CDP SDK log.

Returned: when supported

sdk_out_lines

list / elements=string

Returns a list of each line of the captured CDP SDK log.

Returned: when supported

Authors

  • Webster Mudge (@wmudge)