oracle.oci.oci_data_labeling_service_dataplane_record_facts – Fetches details about one or multiple Record resources in Oracle Cloud Infrastructure

Note

This plugin is part of the oracle.oci collection (version 4.10.0).

You might already have this collection installed if you are using the ansible package. 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 oracle.oci.

To use it in a playbook, specify: oracle.oci.oci_data_labeling_service_dataplane_record_facts.

New in version 2.9.0: of oracle.oci

Synopsis

  • Fetches details about one or multiple Record resources in Oracle Cloud Infrastructure

  • The list of records in the specified compartment.

  • If record_id is specified, the details of a single Record will be returned.

Requirements

The below requirements are needed on the host that executes this module.

Parameters

Parameter Choices/Defaults Comments
annotation_labels_contains
list / elements=string
Lets the user filter records based on the related annotations.
api_user
string
The OCID of the user, on whose behalf, OCI APIs are invoked. If not set, then the value of the OCI_USER_ID environment variable, if any, is used. This option is required if the user is not specified through a configuration file (See config_file_location). To get the user's OCID, please refer https://docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/apisigningkey.htm.
api_user_fingerprint
string
Fingerprint for the key pair being used. If not set, then the value of the OCI_USER_FINGERPRINT environment variable, if any, is used. This option is required if the key fingerprint is not specified through a configuration file (See config_file_location). To get the key pair's fingerprint value please refer https://docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/apisigningkey.htm.
api_user_key_file
string
Full path and filename of the private key (in PEM format). If not set, then the value of the OCI_USER_KEY_FILE variable, if any, is used. This option is required if the private key is not specified through a configuration file (See config_file_location). If the key is encrypted with a pass-phrase, the api_user_key_pass_phrase option must also be provided.
api_user_key_pass_phrase
string
Passphrase used by the key referenced in api_user_key_file, if it is encrypted. If not set, then the value of the OCI_USER_KEY_PASS_PHRASE variable, if any, is used. This option is required if the key passphrase is not specified through a configuration file (See config_file_location).
auth_purpose
string
    Choices:
  • service_principal
The auth purpose which can be used in conjunction with 'auth_type=instance_principal'. The default auth_purpose for instance_principal is None.
auth_type
string
    Choices:
  • api_key ←
  • instance_principal
  • instance_obo_user
  • resource_principal
The type of authentication to use for making API requests. By default auth_type="api_key" based authentication is performed and the API key (see api_user_key_file) in your config file will be used. If this 'auth_type' module option is not specified, the value of the OCI_ANSIBLE_AUTH_TYPE, if any, is used. Use auth_type="instance_principal" to use instance principal based authentication when running ansible playbooks within an OCI compute instance.
cert_bundle
string
The full path to a CA certificate bundle to be used for SSL verification. This will override the default CA certificate bundle. If not set, then the value of the OCI_ANSIBLE_CERT_BUNDLE variable, if any, is used.
compartment_id
string
The ID of the compartment in which to list resources.
Required to list multiple records.
config_file_location
string
Path to configuration file. If not set then the value of the OCI_CONFIG_FILE environment variable, if any, is used. Otherwise, defaults to ~/.oci/config.
config_profile_name
string
The profile to load from the config file referenced by config_file_location. If not set, then the value of the OCI_CONFIG_PROFILE environment variable, if any, is used. Otherwise, defaults to the "DEFAULT" profile in config_file_location.
dataset_id
string
Filter the results by the OCID of the dataset.
Required to list multiple records.
is_labeled
boolean
    Choices:
  • no
  • yes
Whether the record has been labeled and has associated annotations.
lifecycle_state
string
    Choices:
  • ACTIVE
  • INACTIVE
  • DELETED
A filter to return only resources whose lifecycleState matches the given lifecycleState.
name
string
The name of the record.
record_id
string
The OCID of the record annotated.
Required to get a specific record.

aliases: id
region
string
The Oracle Cloud Infrastructure region to use for all OCI API requests. If not set, then the value of the OCI_REGION variable, if any, is used. This option is required if the region is not specified through a configuration file (See config_file_location). Please refer to https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/regions.htm for more information on OCI regions.
sort_by
string
    Choices:
  • timeCreated
  • name
The field to sort by. Only one sort order may be provided. The default order for timeCreated is descending. The default order for name is ascending. If no value is specified, timeCreated is used by default.
sort_order
string
    Choices:
  • ASC
  • DESC
The sort order to use, either 'asc' or 'desc'.
tenancy
string
OCID of your tenancy. If not set, then the value of the OCI_TENANCY variable, if any, is used. This option is required if the tenancy OCID is not specified through a configuration file (See config_file_location). To get the tenancy OCID, please refer https://docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/apisigningkey.htm

Examples

- name: Get a specific record
  oci_data_labeling_service_dataplane_record_facts:
    # required
    record_id: "ocid1.record.oc1..xxxxxxEXAMPLExxxxxx"

- name: List records
  oci_data_labeling_service_dataplane_record_facts:
    # required
    compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
    dataset_id: "ocid1.dataset.oc1..xxxxxxEXAMPLExxxxxx"

    # optional
    lifecycle_state: ACTIVE
    name: name_example
    is_labeled: true
    annotation_labels_contains: [ "annotation_labels_contains_example" ]
    sort_order: ASC
    sort_by: timeCreated

Return Values

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

Key Returned Description
records
complex
on success
List of Record resources

Sample:
[{'compartment_id': 'ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx', 'dataset_id': 'ocid1.dataset.oc1..xxxxxxEXAMPLExxxxxx', 'defined_tags': {'Operations': {'CostCenter': 'US'}}, 'freeform_tags': {'Department': 'Finance'}, 'id': 'ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx', 'is_labeled': True, 'lifecycle_state': 'ACTIVE', 'lifetime_logical_clock': 56, 'name': 'name_example', 'record_metadata': {'depth': 56, 'height': 56, 'record_type': 'IMAGE_METADATA', 'width': 56}, 'source_details': {'length': 10, 'offset': 10, 'path': 'path_example', 'relative_path': 'relative_path_example', 'source_type': 'OBJECT_STORAGE'}, 'time_created': '2013-10-20T19:20:30+01:00', 'time_updated': '2013-10-20T19:20:30+01:00'}]
 
compartment_id
string
on success
The OCID of the compartment for the task.

Sample:
ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx
 
dataset_id
string
on success
The OCID of the dataset to associate the record with.

Sample:
ocid1.dataset.oc1..xxxxxxEXAMPLExxxxxx
 
defined_tags
dictionary
on success
The defined tags for this resource. Each key is predefined and scoped to a namespace. For example: `{"foo-namespace": {"bar-key": "value"}}`

Sample:
{'Operations': {'CostCenter': 'US'}}
 
freeform_tags
dictionary
on success
A simple key-value pair that is applied without any predefined name, type, or scope. It exists for cross-compatibility only. For example: `{"bar-key": "value"}`

Sample:
{'Department': 'Finance'}
 
id
string
on success
The OCID of the record.

Sample:
ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx
 
is_labeled
boolean
on success
Whether or not the record has been labeled and has associated annotations.

Sample:
True
 
lifecycle_state
string
on success
The lifecycle state of the record. ACTIVE - The record is active and ready for labeling. INACTIVE - The record has been marked as inactive and should not be used for labeling. DELETED - The record has been deleted and is no longer available for labeling.

Sample:
ACTIVE
 
lifetime_logical_clock
integer
on success
An integer value used in achieving concurrency control, this field will be used to generate eTags.
Returned for get operation

Sample:
56
 
name
string
on success
The name is created by the user. It is unique and immutable.

Sample:
name_example
 
record_metadata
complex
on success
Returned for get operation

   
depth
integer
on success
Depth of the image record.

Sample:
56
   
height
integer
on success
Height of the image record.

Sample:
56
   
record_type
string
on success
The record type based on dataset format details. IMAGE_METADATA - Collection of metadata related to image record. TEXT_METADATA - Collection of metadata related to text record. DOCUMENT_METADATA - Collection of metadata related to document record.

Sample:
IMAGE_METADATA
   
width
integer
on success
Width of the image record.

Sample:
56
 
source_details
complex
on success
Returned for get operation

   
length
float
on success
The length from the offset into the file containing the content.

Sample:
10
   
offset
float
on success
The offset into the file containing the content.

Sample:
10
   
path
string
on success
The full path of the file this record belongs to.

Sample:
path_example
   
relative_path
string
on success
The path relative to the prefix specified in the dataset source details (file name).

Sample:
relative_path_example
   
source_type
string
on success
The type of data source. OBJECT_STORAGE - The source details for an object storage bucket.

Sample:
OBJECT_STORAGE
 
time_created
string
on success
The date and time the resource was created, in the timestamp format defined by RFC3339.

Sample:
2013-10-20T19:20:30+01:00
 
time_updated
string
on success
The date and time the resource was updated, in the timestamp format defined by RFC3339.

Sample:
2013-10-20T19:20:30+01:00


Authors

  • Oracle (@oracle)