oracle.oci.oci_oda_translator_facts – Fetches details about one or multiple Translator resources in Oracle Cloud Infrastructure¶
Note
This plugin is part of the oracle.oci collection (version 5.2.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_oda_translator_facts
.
New in version 2.9.0: of oracle.oci
Synopsis¶
Fetches details about one or multiple Translator resources in Oracle Cloud Infrastructure
Returns a page of Translators that belong to the specified Digital Assistant instance.
If the opc-next-page header appears in the response, then there are more items to retrieve. To get the next page in the subsequent GET request, include the header’s value as the page query parameter.
If translator_id is specified, the details of a single Translator will be returned.
Requirements¶
The below requirements are needed on the host that executes this module.
python >= 3.6
Python SDK for Oracle Cloud Infrastructure https://oracle-cloud-infrastructure-python-sdk.readthedocs.io
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
|
|
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
|
|
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.
|
|
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 . |
|
lifecycle_state
string
|
|
List only the resources that are in this lifecycle state.
|
name
string
|
List only Translators with this name. Translator names are unique and may not change.
Example: `MyTranslator`
|
|
oda_instance_id
string
/ required
|
Unique Digital Assistant instance identifier.
|
|
realm_specific_endpoint_template_enabled
boolean
|
|
Enable/Disable realm specific endpoint template for service client. By Default, realm specific endpoint template is disabled. If not set, then the value of the OCI_REALM_SPECIFIC_SERVICE_ENDPOINT_TEMPLATE_ENABLED variable, if any, is used.
|
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
|
|
Sort on this field. You can specify one sort order only. The default sort field is `timeCreated`.
The default sort order for `timeCreated` and `timeUpdated` is descending. For all other sort fields the default sort order is ascending.
|
sort_order
string
|
|
Sort the results in this order, use either `ASC` (ascending) or `DESC` (descending).
|
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 |
|
translator_id
string
|
Unique Translator identifier.
Required to get a specific translator.
aliases: id |
|
type
string
|
|
List only Translators of this type.
|
Notes¶
Note
For OCI python sdk configuration, please refer to https://oracle-cloud-infrastructure-python-sdk.readthedocs.io/en/latest/configuration.html
Examples¶
- name: Get a specific translator
oci_oda_translator_facts:
# required
translator_id: "ocid1.translator.oc1..xxxxxxEXAMPLExxxxxx"
oda_instance_id: "ocid1.odainstance.oc1..xxxxxxEXAMPLExxxxxx"
- name: List translators
oci_oda_translator_facts:
# required
oda_instance_id: "ocid1.odainstance.oc1..xxxxxxEXAMPLExxxxxx"
# optional
type: GOOGLE
name: name_example
lifecycle_state: CREATING
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 | |
---|---|---|---|
translators
complex
|
on success |
List of Translator resources
Sample:
[{'base_url': 'base_url_example', 'defined_tags': {'Operations': {'CostCenter': 'US'}}, 'freeform_tags': {'Department': 'Finance'}, 'id': 'ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx', 'lifecycle_state': 'CREATING', 'name': 'name_example', 'properties': {}, 'time_created': '2013-10-20T19:20:30+01:00', 'time_updated': '2013-10-20T19:20:30+01:00', 'type': 'GOOGLE'}]
|
|
base_url
string
|
on success |
The base URL for invoking the Translation Service.
Returned for get operation
Sample:
base_url_example
|
|
defined_tags
dictionary
|
on success |
Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: `{"foo-namespace": {"bar-key": "value"}}`
Sample:
{'Operations': {'CostCenter': 'US'}}
|
|
freeform_tags
dictionary
|
on success |
Simple key-value pair that is applied without any predefined name, type, or scope. Example: `{"bar-key": "value"}`
Sample:
{'Department': 'Finance'}
|
|
id
string
|
on success |
Unique immutable identifier that was assigned when the Translator was created.
Sample:
ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx
|
|
lifecycle_state
string
|
on success |
The Translator's current state.
Sample:
CREATING
|
|
name
string
|
on success |
The descriptive name for this Translator.
Sample:
name_example
|
|
properties
dictionary
|
on success |
Properties used when invoking the translation service. Each property is a simple key-value pair.
Returned for get operation
|
|
time_created
string
|
on success |
When the resource was created. A date-time string as described in RFC 3339, section 14.29.
Sample:
2013-10-20T19:20:30+01:00
|
|
time_updated
string
|
on success |
When the resource was last updated. A date-time string as described in RFC 3339, section 14.29.
Sample:
2013-10-20T19:20:30+01:00
|
|
type
string
|
on success |
The Translation Service to use for this Translator.
Sample:
GOOGLE
|
Authors¶
Oracle (@oracle)