PropertySetApexDocumentGenerator¶
- class oci.database_tools_runtime.models.PropertySetApexDocumentGenerator(**kwargs)¶
Bases:
PropertySetContains the details of an APEX Document Generator property set
Attributes:
A constant which can be used with the autonomous_database_resource_principal_status property of a PropertySetApexDocumentGenerator.
A constant which can be used with the autonomous_database_resource_principal_status property of a PropertySetApexDocumentGenerator.
A constant which can be used with the key property of a PropertySet.
A constant which can be used with the key property of a PropertySet.
A constant which can be used with the key property of a PropertySet.
A constant which can be used with the key property of a PropertySet.
A constant which can be used with the print_server_type property of a PropertySetApexDocumentGenerator.
A constant which can be used with the print_server_type property of a PropertySetApexDocumentGenerator.
A constant which can be used with the print_server_type property of a PropertySetApexDocumentGenerator.
A constant which can be used with the print_server_type property of a PropertySetApexDocumentGenerator.
A constant which can be used with the print_server_type property of a PropertySetApexDocumentGenerator.
A constant which can be used with the print_server_type property of a PropertySetApexDocumentGenerator.
Gets the autonomous_database_resource_principal_status of this PropertySetApexDocumentGenerator.
Gets the credential_key of this PropertySetApexDocumentGenerator.
Gets the function_id of this PropertySetApexDocumentGenerator.
Gets the invoke_endpoint of this PropertySetApexDocumentGenerator.
[Required] Gets the is_mutable of this PropertySet.
[Required] Gets the key of this PropertySet.
Gets the object_storage_bucket_compartment_id of this PropertySetApexDocumentGenerator.
Gets the object_storage_endpoint of this PropertySetApexDocumentGenerator.
Gets the object_storage_namespace of this PropertySetApexDocumentGenerator.
Gets the print_server_type of this PropertySetApexDocumentGenerator.
Methods:
__init__(**kwargs)Initializes a new PropertySetApexDocumentGenerator object with values from keyword arguments.
get_subtype(object_dictionary)Given the hash representation of a subtype of this class, use the info in the hash to return the class of the subtype.
- AUTONOMOUS_DATABASE_RESOURCE_PRINCIPAL_STATUS_DISABLED = 'DISABLED'¶
A constant which can be used with the autonomous_database_resource_principal_status property of a PropertySetApexDocumentGenerator. This constant has a value of “DISABLED”
- AUTONOMOUS_DATABASE_RESOURCE_PRINCIPAL_STATUS_ENABLED = 'ENABLED'¶
A constant which can be used with the autonomous_database_resource_principal_status property of a PropertySetApexDocumentGenerator. This constant has a value of “ENABLED”
- KEY_APEX = 'APEX'¶
A constant which can be used with the key property of a PropertySet. This constant has a value of “APEX”
- KEY_APEX_DOCUMENT_GENERATOR = 'APEX_DOCUMENT_GENERATOR'¶
A constant which can be used with the key property of a PropertySet. This constant has a value of “APEX_DOCUMENT_GENERATOR”
- KEY_APEX_FA_INTEGRATION = 'APEX_FA_INTEGRATION'¶
A constant which can be used with the key property of a PropertySet. This constant has a value of “APEX_FA_INTEGRATION”
- KEY_ORACLE_DATABASE_EXTERNAL_AUTHENTICATION = 'ORACLE_DATABASE_EXTERNAL_AUTHENTICATION'¶
A constant which can be used with the key property of a PropertySet. This constant has a value of “ORACLE_DATABASE_EXTERNAL_AUTHENTICATION”
- PRINT_SERVER_TYPE_ADVANCED = 'ADVANCED'¶
A constant which can be used with the print_server_type property of a PropertySetApexDocumentGenerator. This constant has a value of “ADVANCED”
- PRINT_SERVER_TYPE_AOP = 'AOP'¶
A constant which can be used with the print_server_type property of a PropertySetApexDocumentGenerator. This constant has a value of “AOP”
- PRINT_SERVER_TYPE_DOCUMENT_GENERATOR = 'DOCUMENT_GENERATOR'¶
A constant which can be used with the print_server_type property of a PropertySetApexDocumentGenerator. This constant has a value of “DOCUMENT_GENERATOR”
- PRINT_SERVER_TYPE_NONE = 'NONE'¶
A constant which can be used with the print_server_type property of a PropertySetApexDocumentGenerator. This constant has a value of “NONE”
- PRINT_SERVER_TYPE_OTHER = 'OTHER'¶
A constant which can be used with the print_server_type property of a PropertySetApexDocumentGenerator. This constant has a value of “OTHER”
- PRINT_SERVER_TYPE_STANDARD = 'STANDARD'¶
A constant which can be used with the print_server_type property of a PropertySetApexDocumentGenerator. This constant has a value of “STANDARD”
- __init__(**kwargs)¶
Initializes a new PropertySetApexDocumentGenerator object with values from keyword arguments. The default value of the
keyattribute of this class isAPEX_DOCUMENT_GENERATORand it should not be changed. The following keyword arguments are supported (corresponding to the getters/setters of this class):- Parameters
key (str) – The value to assign to the key property of this PropertySetApexDocumentGenerator. Allowed values for this property are: “APEX_DOCUMENT_GENERATOR”, “APEX”, “APEX_FA_INTEGRATION”, “ORACLE_DATABASE_EXTERNAL_AUTHENTICATION”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
is_mutable (bool) – The value to assign to the is_mutable property of this PropertySetApexDocumentGenerator.
print_server_type (str) – The value to assign to the print_server_type property of this PropertySetApexDocumentGenerator. Allowed values for this property are: “DOCUMENT_GENERATOR”, “NONE”, “STANDARD”, “ADVANCED”, “AOP”, “OTHER”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
credential_key (str) – The value to assign to the credential_key property of this PropertySetApexDocumentGenerator.
autonomous_database_resource_principal_status (str) – The value to assign to the autonomous_database_resource_principal_status property of this PropertySetApexDocumentGenerator. Allowed values for this property are: “ENABLED”, “DISABLED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
object_storage_namespace (str) – The value to assign to the object_storage_namespace property of this PropertySetApexDocumentGenerator.
object_storage_bucket_compartment_id (str) – The value to assign to the object_storage_bucket_compartment_id property of this PropertySetApexDocumentGenerator.
object_storage_endpoint (str) – The value to assign to the object_storage_endpoint property of this PropertySetApexDocumentGenerator.
function_id (str) – The value to assign to the function_id property of this PropertySetApexDocumentGenerator.
invoke_endpoint (str) – The value to assign to the invoke_endpoint property of this PropertySetApexDocumentGenerator.
- property autonomous_database_resource_principal_status¶
Gets the autonomous_database_resource_principal_status of this PropertySetApexDocumentGenerator. The status of the Autonomous Database Serverless Resource Principal (OCI$RESOURCE_PRINCIPAL)
Allowed values for this property are: “ENABLED”, “DISABLED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
- Returns
The autonomous_database_resource_principal_status of this PropertySetApexDocumentGenerator.
- Return type
str
- property credential_key¶
Gets the credential_key of this PropertySetApexDocumentGenerator. The name of the credential used by APEX to manage Object Storage Buckets and Objects as well as invoke the Document Generator function
- Returns
The credential_key of this PropertySetApexDocumentGenerator.
- Return type
str
- property function_id¶
Gets the function_id of this PropertySetApexDocumentGenerator. The OCID of the Document Generator function
- Returns
The function_id of this PropertySetApexDocumentGenerator.
- Return type
str
- static get_subtype(object_dictionary)¶
Given the hash representation of a subtype of this class, use the info in the hash to return the class of the subtype.
- property invoke_endpoint¶
Gets the invoke_endpoint of this PropertySetApexDocumentGenerator. The base endpoint URL to use to invoke the Document Generator function
- Returns
The invoke_endpoint of this PropertySetApexDocumentGenerator.
- Return type
str
- property is_mutable¶
[Required] Gets the is_mutable of this PropertySet. Indicates whether the property set is mutable or not
- Returns
The is_mutable of this PropertySet.
- Return type
bool
- property key¶
[Required] Gets the key of this PropertySet. The name of the property set
Allowed values for this property are: “APEX_DOCUMENT_GENERATOR”, “APEX”, “APEX_FA_INTEGRATION”, “ORACLE_DATABASE_EXTERNAL_AUTHENTICATION”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
- Returns
The key of this PropertySet.
- Return type
str
- property object_storage_bucket_compartment_id¶
Gets the object_storage_bucket_compartment_id of this PropertySetApexDocumentGenerator. The OCID of the compartment containing the Object Storage Buckets managed by APEX
- Returns
The object_storage_bucket_compartment_id of this PropertySetApexDocumentGenerator.
- Return type
str
- property object_storage_endpoint¶
Gets the object_storage_endpoint of this PropertySetApexDocumentGenerator. Object Storage Endpoint
- Returns
The object_storage_endpoint of this PropertySetApexDocumentGenerator.
- Return type
str
- property object_storage_namespace¶
Gets the object_storage_namespace of this PropertySetApexDocumentGenerator. The Object Storage Namespace containing the Object Storage Buckets managed by APEX
- Returns
The object_storage_namespace of this PropertySetApexDocumentGenerator.
- Return type
str
- property print_server_type¶
Gets the print_server_type of this PropertySetApexDocumentGenerator. The print server type
Allowed values for this property are: “DOCUMENT_GENERATOR”, “NONE”, “STANDARD”, “ADVANCED”, “AOP”, “OTHER”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
- Returns
The print_server_type of this PropertySetApexDocumentGenerator.
- Return type
str