oracle.oci.oci_data_labeling_service_dataplane_record – Manage a Record resource 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.

New in version 2.9.0: of oracle.oci

Synopsis

  • This module allows the user to create, update and delete a Record resource in Oracle Cloud Infrastructure

  • For state=present, creates a record.

Requirements

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

Parameters

Parameter Choices/Defaults Comments
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 OCID of the compartment for the record. This is tied to the dataset. It is not changeable on the record itself.
Required for create using state=present.
Required for update when environment variable OCI_USE_NAME_AS_IDENTIFIER is set.
Required for delete when environment variable OCI_USE_NAME_AS_IDENTIFIER is set.
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
The OCID of the dataset to associate the record with.
Required for create using state=present.
Required for update when environment variable OCI_USE_NAME_AS_IDENTIFIER is set.
Required for delete when environment variable OCI_USE_NAME_AS_IDENTIFIER is set.
defined_tags
dictionary
The defined tags for this resource. Each key is predefined and scoped to a namespace. For example: `{"foo-namespace": {"bar-key": "value"}}`
This parameter is updatable.
force_create
boolean
    Choices:
  • no ←
  • yes
Whether to attempt non-idempotent creation of a resource. By default, create resource is an idempotent operation, and doesn't create the resource if it already exists. Setting this option to true, forcefully creates a copy of the resource, even if it already exists.This option is mutually exclusive with key_by.
freeform_tags
dictionary
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"}`
This parameter is updatable.
key_by
list / elements=string
The list of attributes of this resource which should be used to uniquely identify an instance of the resource. By default, all the attributes of a resource are used to uniquely identify a resource.
name
string
The name is automatically assigned by the service. It is unique and immutable.
Required for create using state=present.
Required for update, delete when environment variable OCI_USE_NAME_AS_IDENTIFIER is set.
record_id
string
The OCID of the record annotated.
Required for update using state=present when environment variable OCI_USE_NAME_AS_IDENTIFIER is not set.
Required for delete using state=absent when environment variable OCI_USE_NAME_AS_IDENTIFIER is not set.

aliases: id
record_metadata
dictionary
This parameter is updatable.
depth
integer
Depth of the image record.
Applicable when record_type is 'IMAGE_METADATA'
height
integer
Height of the image record.
Applicable when record_type is 'IMAGE_METADATA'
record_type
string / required
    Choices:
  • DOCUMENT_METADATA
  • IMAGE_METADATA
  • TEXT_METADATA
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.
width
integer
Width of the image record.
Applicable when record_type is 'IMAGE_METADATA'
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.
source_details
dictionary
Required for create using state=present.
length
float
The length from offset into the file containing the content.
offset
float
The offset into the file containing the content.
relative_path
string / required
The path relative to the prefix specified in the dataset source details (file name).
source_type
string / required
    Choices:
  • OBJECT_STORAGE
The type of data source. OBJECT_STORAGE - The source details for an object storage bucket.
state
string
    Choices:
  • present ←
  • absent
The state of the Record.
Use state=present to create or update a Record.
Use state=absent to delete a Record.
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
wait
boolean
    Choices:
  • no
  • yes ←
Whether to wait for create or delete operation to complete.
wait_timeout
integer
Time, in seconds, to wait when wait=yes. Defaults to 1200 for most of the services but some services might have a longer wait timeout.

Examples

- name: Create record
  oci_data_labeling_service_dataplane_record:
    # required
    name: name_example
    dataset_id: "ocid1.dataset.oc1..xxxxxxEXAMPLExxxxxx"
    compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
    source_details:
      # required
      source_type: OBJECT_STORAGE
      relative_path: relative_path_example

      # optional
      offset: 3.4
      length: 3.4

    # optional
    freeform_tags: {'Department': 'Finance'}
    defined_tags: {'Operations': {'CostCenter': 'US'}}
    record_metadata:
      # required
      record_type: DOCUMENT_METADATA

- name: Update record
  oci_data_labeling_service_dataplane_record:
    # required
    record_id: "ocid1.record.oc1..xxxxxxEXAMPLExxxxxx"

    # optional
    freeform_tags: {'Department': 'Finance'}
    defined_tags: {'Operations': {'CostCenter': 'US'}}
    record_metadata:
      # required
      record_type: DOCUMENT_METADATA

- name: Update record using name (when environment variable OCI_USE_NAME_AS_IDENTIFIER is set)
  oci_data_labeling_service_dataplane_record:
    # required
    name: name_example
    dataset_id: "ocid1.dataset.oc1..xxxxxxEXAMPLExxxxxx"
    compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"

    # optional
    freeform_tags: {'Department': 'Finance'}
    defined_tags: {'Operations': {'CostCenter': 'US'}}
    record_metadata:
      # required
      record_type: DOCUMENT_METADATA

- name: Delete record
  oci_data_labeling_service_dataplane_record:
    # required
    record_id: "ocid1.record.oc1..xxxxxxEXAMPLExxxxxx"
    state: absent

- name: Delete record using name (when environment variable OCI_USE_NAME_AS_IDENTIFIER is set)
  oci_data_labeling_service_dataplane_record:
    # required
    name: name_example
    dataset_id: "ocid1.dataset.oc1..xxxxxxEXAMPLExxxxxx"
    compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
    state: absent

Return Values

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

Key Returned Description
record
complex
on success
Details of the Record resource acted upon by the current operation

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.

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

   
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

   
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)