apex-document-generator-details

Description

Update the APEX Document Generator property set.

Usage

oci dbtools-runtime property-set update apex-document-generator-details [OPTIONS]

Required Parameters

--connection-id [text]

The OCID of a Database Tools connection.

--property-set-key [text]

The name of the property set

Accepted values are:

APEX, APEX_DOCUMENT_GENERATOR, APEX_FA_INTEGRATION, ORACLE_DATABASE_EXTERNAL_AUTHENTICATION

Optional Parameters

--autonomous-database-resource-principal-status [text]

The status of the Autonomous Database Serverless Resource Principal (OCI$RESOURCE_PRINCIPAL)

--credential-key [text]

The name of the credential used by APEX to manage Object Storage Buckets and Objects as well as invoke the Document Generator function.

--from-json [text]

Provide input to this command as a JSON document from a file using the file://path-to/file syntax.

The --generate-full-command-json-input option can be used to generate a sample json file to be used with this command option. The key names are pre-populated and match the command option names (converted to camelCase format, e.g. compartment-id –> compartmentId), while the values of the keys need to be populated by the user before using the sample file as an input to this command. For any command option that accepts multiple values, the value of the key can be a JSON array.

Options can still be provided on the command line. If an option exists in both the JSON document and the command line then the command line specified value will be used.

For examples on usage of this option, please see our “using CLI with advanced JSON options” link: https://docs.cloud.oracle.com/iaas/Content/API/SDKDocs/cliusing.htm#AdvancedJSONOptions

--function-id [text]

The OCID of the Document Generator function

--if-match [text]

If-Match is most often used with state-changing methods (e.g., POST, PUT, DELETE) to prevent accidental overwrites when multiple user agentss might be acting in parallel on the same resource (i.e., to prevent the “lost update” problem). In general, it can be used with any method that involves the selection or modification of a representation to abort the request if the selected representation’s current entity tag is not a member within the If-Match field value. When specified on an action-specific subresource, the ETag value of the resource on which the action is requested should be provided.

--invoke-endpoint [text]

The base endpoint URL to use to invoke the Document Generator function

--object-storage-bucket-compartment-id [text]

The OCID of the compartment containing the Object Storage Buckets managed by APEX

--object-storage-endpoint [text]

Object Storage Endpoint

--object-storage-namespace [text]

The Object Storage Namespace containing the Object Storage Buckets managed by APEX

--print-server-type [text]

The print server type

Example using required parameter

Copy the following CLI commands into a file named example.sh. Run the command by typing “bash example.sh” and replacing the example parameters with your own.

Please note this sample will only work in the POSIX-compliant bash-like shell. You need to set up the OCI configuration and appropriate security policies before trying the examples.

    export connection_id=<substitute-value-of-connection_id> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/dbtools-runtime/property-set/update/apex-document-generator-details.html#cmdoption-connection-id
    export property_set_key=<substitute-value-of-property_set_key> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/dbtools-runtime/property-set/update/apex-document-generator-details.html#cmdoption-property-set-key

    oci dbtools-runtime property-set update apex-document-generator-details --connection-id $connection_id --property-set-key $property_set_key