cloudera.services.ssb_udf_info module – Retrieve information about SSB project User Defined Functions (UDFs)

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

New in cloudera.services 1.0.0

Synopsis

  • Retrieve information about one or more Cloudera SSB project User Defined Functions (UDFs).

  • The module can list all UDFs in a project or filter by name or id.

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

id

aliases: udf_id

integer

The unique identifier of the UDF to retrieve.

This parameter is mutually exclusive with name.

name

string

The name of the UDF to retrieve.

This parameter is mutually exclusive with 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 UDF(s).

Required for all operations.

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 SSB UDFs in a project
  cloudera.services.ssb_udf_info:
    project_id: "12345"
  register: all_udfs

- name: Get information about a specific UDF by name
  cloudera.services.ssb_udf_info:
    project_id: "12345"
    name: "my_custom_function"
  register: udf_by_name

- name: Get information about a specific UDF by id
  cloudera.services.ssb_udf_info:
    project_id: "12345"
    id: 789
  register: udf_by_id

Return Values

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

Key

Description

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

udfs

list / elements=dictionary

List of SSB project User Defined Functions.

Returned: always

code

string

The source code of the UDF.

Returned: when available

created_at

string

Timestamp when the UDF was created.

Returned: when available

description

string

The description of the UDF.

Returned: when available

file_name

string

The file name associated with the UDF.

Returned: when available

id

integer

The unique identifier of the UDF.

Returned: when available

input_types

list / elements=string

List of input parameter types for the UDF.

Returned: when available

jar_file

dictionary

Information about the JAR file for Java UDFs.

Returned: when available

java_class_name

string

The Java class name for Java UDFs.

Returned: when available

language

string

The language of the UDF (JAVASCRIPT or PYTHON).

Returned: when available

name

string

The name of the UDF.

Returned: always

output_type

string

The output type of the UDF.

Returned: always

project_id

string

The project identifier this UDF belongs to.

Returned: always

updated_at

string

Timestamp when the UDF was last updated.

Returned: when available

Authors

  • Webster Mudge (@wmudge)