oci-cli 3.64.1__py3-none-any.whl → 3.65.0__py3-none-any.whl

oci_cli/help_text_producer/data_files/text/cmdref/anomaly-detection/detect-anomaly-job/create.txt

@@ -1,173 +0,0 @@
-"create"
-********
-
-* Description
-
-* Usage
-
-* Required Parameters
-
-* Optional Parameters
-
-* Global Parameters
-
-* Example using required parameter
-
-
-Description
-===========
-
-Creates a job to perform anomaly detection.
-
-
-Usage
-=====
-
-   oci anomaly-detection detect-anomaly-job create [OPTIONS]
-
-
-Required Parameters
-===================
-
---compartment-id, -c [text]
-
-The OCID of the compartment that starts the job.
-
---input-details [complex type]
-
-This is a complex type whose value must be valid JSON. The value can
-be provided as a string on the command line or passed in as a file
-using the file://path/to/file syntax.
-
-The "--generate-param-json-input" option can be used to generate an
-example of the JSON which must be provided. We recommend storing this
-example in a file, modifying it as needed and then passing it back in
-via the file:// syntax.
-
---model-id [text]
-
-The OCID of the trained model.
-
---output-details [complex type]
-
-This is a complex type whose value must be valid JSON. The value can
-be provided as a string on the command line or passed in as a file
-using the file://path/to/file syntax.
-
-The "--generate-param-json-input" option can be used to generate an
-example of the JSON which must be provided. We recommend storing this
-example in a file, modifying it as needed and then passing it back in
-via the file:// syntax.
-
-
-Optional Parameters
-===================
-
---are-all-estimates-required [boolean]
-
-Flag to enable the service to return estimates for all data points
-rather than just the anomalous data points.
-
---description [text]
-
-A short description of the detect anomaly job.
-
---display-name [text]
-
-Detect anomaly job display name.
-
---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/Conte
-nt/API/SDKDocs/cliusing.htm#AdvancedJSONOptions
-
---max-wait-seconds [integer]
-
-The maximum time to wait for the resource to reach the lifecycle state
-defined by "--wait-for-state". Defaults to 1200 seconds.
-
---sensitivity [float]
-
-The value that customer can adjust to control the sensitivity of
-anomaly detection
-
---wait-for-state [text]
-
-This operation creates, modifies or deletes a resource that has a
-defined lifecycle state. Specify this option to perform the action and
-then wait until the resource reaches a given lifecycle state. Multiple
-states can be specified, returning on the first state. For example, "
---wait-for-state" SUCCEEDED "--wait-for-state" FAILED would return on
-whichever lifecycle state is reached first. If timeout is reached, a
-return code of 2 is returned. For any other error, a return code of 1
-is returned.
-
-Accepted values are:
-
-   ACCEPTED, CANCELED, FAILED, IN_PROGRESS, PARTIALLY_SUCCEEDED, SUCCEEDED
-
---wait-interval-seconds [integer]
-
-Check every "--wait-interval-seconds" to see whether the resource has
-reached the lifecycle state defined by "--wait-for-state". Defaults to
-30 seconds.
-
-
-Global Parameters
-=================
-
-Use "oci --help" for help on global parameters.
-
-"--auth-purpose", "--auth", "--cert-bundle", "--cli-auto-prompt", "--
-cli-rc-file", "--config-file", "--connection-timeout", "--debug", "--
-defaults-file", "--endpoint", "--generate-full-command-json-input", "
---generate-param-json-input", "--help", "--latest-version", "--max-
-retries", "--no-retry", "--opc-client-request-id", "--opc-request-id",
-"--output", "--profile", "--proxy", "--query", "--raw-output", "--
-read-timeout", "--realm-specific-endpoint", "--region", "--release-
-info", "--request-id", "--version", "-?", "-d", "-h", "-i", "-v"
-
-
-Example using required parameter
-================================
-
-Copy and paste the following example into a JSON file, replacing the
-example parameters with your own.
-
-       oci anomaly-detection model create --generate-param-json-input model-training-details > model-training-details.json
-
-       oci anomaly-detection detect-anomaly-job create --generate-param-json-input input-details > input-details.json
-       oci anomaly-detection detect-anomaly-job create --generate-param-json-input output-details > output-details.json
-
-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 compartment_id=<substitute-value-of-compartment_id> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/anomaly-detection/project/create.html#cmdoption-compartment-id
-
-       project_id=$(oci anomaly-detection project create --compartment-id $compartment_id --query data.id --raw-output)
-
-       model_id=$(oci anomaly-detection model create --compartment-id $compartment_id --model-training-details file://model-training-details.json --project-id $project_id --query data.id --raw-output)
-
-       oci anomaly-detection detect-anomaly-job create --compartment-id $compartment_id --input-details file://input-details.json --model-id $model_id --output-details file://output-details.json

oci_cli/help_text_producer/data_files/text/cmdref/anomaly-detection/detect-anomaly-job/delete.txt

@@ -1,143 +0,0 @@
-"delete"
-********
-
-* Description
-
-* Usage
-
-* Required Parameters
-
-* Optional Parameters
-
-* Global Parameters
-
-* Example using required parameter
-
-
-Description
-===========
-
-Deletes an accepted, but not started detect anomaly asynchronous job.
-
-
-Usage
-=====
-
-   oci anomaly-detection detect-anomaly-job delete [OPTIONS]
-
-
-Required Parameters
-===================
-
---detect-anomaly-job-id [text]
-
-Unique asynchronous job identifier.
-
-
-Optional Parameters
-===================
-
---force
-
-Perform deletion without prompting for confirmation.
-
---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/Conte
-nt/API/SDKDocs/cliusing.htm#AdvancedJSONOptions
-
---if-match [text]
-
-For optimistic concurrency control. In the PUT or DELETE call for a
-resource, set the *if-match* parameter to the value of the etag from a
-previous GET or POST response for that resource. The resource will be
-updated or deleted only if the etag you provide matches the resource’s
-current etag value.
-
---max-wait-seconds [integer]
-
-The maximum time to wait for the resource to reach the lifecycle state
-defined by "--wait-for-state". Defaults to 1200 seconds.
-
---wait-for-state [text]
-
-This operation creates, modifies or deletes a resource that has a
-defined lifecycle state. Specify this option to perform the action and
-then wait until the resource reaches a given lifecycle state. Multiple
-states can be specified, returning on the first state. For example, "
---wait-for-state" SUCCEEDED "--wait-for-state" FAILED would return on
-whichever lifecycle state is reached first. If timeout is reached, a
-return code of 2 is returned. For any other error, a return code of 1
-is returned.
-
-Accepted values are:
-
-   ACCEPTED, CANCELED, FAILED, IN_PROGRESS, PARTIALLY_SUCCEEDED, SUCCEEDED
-
---wait-interval-seconds [integer]
-
-Check every "--wait-interval-seconds" to see whether the resource has
-reached the lifecycle state defined by "--wait-for-state". Defaults to
-30 seconds.
-
-
-Global Parameters
-=================
-
-Use "oci --help" for help on global parameters.
-
-"--auth-purpose", "--auth", "--cert-bundle", "--cli-auto-prompt", "--
-cli-rc-file", "--config-file", "--connection-timeout", "--debug", "--
-defaults-file", "--endpoint", "--generate-full-command-json-input", "
---generate-param-json-input", "--help", "--latest-version", "--max-
-retries", "--no-retry", "--opc-client-request-id", "--opc-request-id",
-"--output", "--profile", "--proxy", "--query", "--raw-output", "--
-read-timeout", "--realm-specific-endpoint", "--region", "--release-
-info", "--request-id", "--version", "-?", "-d", "-h", "-i", "-v"
-
-
-Example using required parameter
-================================
-
-Copy and paste the following example into a JSON file, replacing the
-example parameters with your own.
-
-       oci anomaly-detection model create --generate-param-json-input model-training-details > model-training-details.json
-
-       oci anomaly-detection detect-anomaly-job create --generate-param-json-input input-details > input-details.json
-       oci anomaly-detection detect-anomaly-job create --generate-param-json-input output-details > output-details.json
-
-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 compartment_id=<substitute-value-of-compartment_id> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/anomaly-detection/project/create.html#cmdoption-compartment-id
-
-       project_id=$(oci anomaly-detection project create --compartment-id $compartment_id --query data.id --raw-output)
-
-       model_id=$(oci anomaly-detection model create --compartment-id $compartment_id --model-training-details file://model-training-details.json --project-id $project_id --query data.id --raw-output)
-
-       detect_anomaly_job_id=$(oci anomaly-detection detect-anomaly-job create --compartment-id $compartment_id --input-details file://input-details.json --model-id $model_id --output-details file://output-details.json --query data.id --raw-output)
-
-       oci anomaly-detection detect-anomaly-job delete --detect-anomaly-job-id $detect_anomaly_job_id

oci_cli/help_text_producer/data_files/text/cmdref/anomaly-detection/detect-anomaly-job/get.txt

@@ -1,105 +0,0 @@
-"get"
-*****
-
-* Description
-
-* Usage
-
-* Required Parameters
-
-* Optional Parameters
-
-* Global Parameters
-
-* Example using required parameter
-
-
-Description
-===========
-
-Gets a detect anomaly asynchronous job by identifier.
-
-
-Usage
-=====
-
-   oci anomaly-detection detect-anomaly-job get [OPTIONS]
-
-
-Required Parameters
-===================
-
---detect-anomaly-job-id [text]
-
-Unique asynchronous job identifier.
-
-
-Optional Parameters
-===================
-
---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/Conte
-nt/API/SDKDocs/cliusing.htm#AdvancedJSONOptions
-
-
-Global Parameters
-=================
-
-Use "oci --help" for help on global parameters.
-
-"--auth-purpose", "--auth", "--cert-bundle", "--cli-auto-prompt", "--
-cli-rc-file", "--config-file", "--connection-timeout", "--debug", "--
-defaults-file", "--endpoint", "--generate-full-command-json-input", "
---generate-param-json-input", "--help", "--latest-version", "--max-
-retries", "--no-retry", "--opc-client-request-id", "--opc-request-id",
-"--output", "--profile", "--proxy", "--query", "--raw-output", "--
-read-timeout", "--realm-specific-endpoint", "--region", "--release-
-info", "--request-id", "--version", "-?", "-d", "-h", "-i", "-v"
-
-
-Example using required parameter
-================================
-
-Copy and paste the following example into a JSON file, replacing the
-example parameters with your own.
-
-       oci anomaly-detection model create --generate-param-json-input model-training-details > model-training-details.json
-
-       oci anomaly-detection detect-anomaly-job create --generate-param-json-input input-details > input-details.json
-       oci anomaly-detection detect-anomaly-job create --generate-param-json-input output-details > output-details.json
-
-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 compartment_id=<substitute-value-of-compartment_id> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/anomaly-detection/project/create.html#cmdoption-compartment-id
-
-       project_id=$(oci anomaly-detection project create --compartment-id $compartment_id --query data.id --raw-output)
-
-       model_id=$(oci anomaly-detection model create --compartment-id $compartment_id --model-training-details file://model-training-details.json --project-id $project_id --query data.id --raw-output)
-
-       detect_anomaly_job_id=$(oci anomaly-detection detect-anomaly-job create --compartment-id $compartment_id --input-details file://input-details.json --model-id $model_id --output-details file://output-details.json --query data.id --raw-output)
-
-       oci anomaly-detection detect-anomaly-job get --detect-anomaly-job-id $detect_anomaly_job_id

oci_cli/help_text_producer/data_files/text/cmdref/anomaly-detection/detect-anomaly-job/update.txt

@@ -1,147 +0,0 @@
-"update"
-********
-
-* Description
-
-* Usage
-
-* Required Parameters
-
-* Optional Parameters
-
-* Global Parameters
-
-* Example using required parameter
-
-
-Description
-===========
-
-Updates the detect anomaly asynchronous job by identifier.
-
-
-Usage
-=====
-
-   oci anomaly-detection detect-anomaly-job update [OPTIONS]
-
-
-Required Parameters
-===================
-
---detect-anomaly-job-id [text]
-
-Unique asynchronous job identifier.
-
-
-Optional Parameters
-===================
-
---description [text]
-
-A short description of the detect anomaly job.
-
---display-name [text]
-
-Detect anomaly job display name.
-
---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/Conte
-nt/API/SDKDocs/cliusing.htm#AdvancedJSONOptions
-
---if-match [text]
-
-For optimistic concurrency control. In the PUT or DELETE call for a
-resource, set the *if-match* parameter to the value of the etag from a
-previous GET or POST response for that resource. The resource will be
-updated or deleted only if the etag you provide matches the resource’s
-current etag value.
-
---max-wait-seconds [integer]
-
-The maximum time to wait for the resource to reach the lifecycle state
-defined by "--wait-for-state". Defaults to 1200 seconds.
-
---wait-for-state [text]
-
-This operation creates, modifies or deletes a resource that has a
-defined lifecycle state. Specify this option to perform the action and
-then wait until the resource reaches a given lifecycle state. Multiple
-states can be specified, returning on the first state. For example, "
---wait-for-state" SUCCEEDED "--wait-for-state" FAILED would return on
-whichever lifecycle state is reached first. If timeout is reached, a
-return code of 2 is returned. For any other error, a return code of 1
-is returned.
-
-Accepted values are:
-
-   ACCEPTED, CANCELED, FAILED, IN_PROGRESS, PARTIALLY_SUCCEEDED, SUCCEEDED
-
---wait-interval-seconds [integer]
-
-Check every "--wait-interval-seconds" to see whether the resource has
-reached the lifecycle state defined by "--wait-for-state". Defaults to
-30 seconds.
-
-
-Global Parameters
-=================
-
-Use "oci --help" for help on global parameters.
-
-"--auth-purpose", "--auth", "--cert-bundle", "--cli-auto-prompt", "--
-cli-rc-file", "--config-file", "--connection-timeout", "--debug", "--
-defaults-file", "--endpoint", "--generate-full-command-json-input", "
---generate-param-json-input", "--help", "--latest-version", "--max-
-retries", "--no-retry", "--opc-client-request-id", "--opc-request-id",
-"--output", "--profile", "--proxy", "--query", "--raw-output", "--
-read-timeout", "--realm-specific-endpoint", "--region", "--release-
-info", "--request-id", "--version", "-?", "-d", "-h", "-i", "-v"
-
-
-Example using required parameter
-================================
-
-Copy and paste the following example into a JSON file, replacing the
-example parameters with your own.
-
-       oci anomaly-detection model create --generate-param-json-input model-training-details > model-training-details.json
-
-       oci anomaly-detection detect-anomaly-job create --generate-param-json-input input-details > input-details.json
-       oci anomaly-detection detect-anomaly-job create --generate-param-json-input output-details > output-details.json
-
-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 compartment_id=<substitute-value-of-compartment_id> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/anomaly-detection/project/create.html#cmdoption-compartment-id
-
-       project_id=$(oci anomaly-detection project create --compartment-id $compartment_id --query data.id --raw-output)
-
-       model_id=$(oci anomaly-detection model create --compartment-id $compartment_id --model-training-details file://model-training-details.json --project-id $project_id --query data.id --raw-output)
-
-       detect_anomaly_job_id=$(oci anomaly-detection detect-anomaly-job create --compartment-id $compartment_id --input-details file://input-details.json --model-id $model_id --output-details file://output-details.json --query data.id --raw-output)
-
-       oci anomaly-detection detect-anomaly-job update --detect-anomaly-job-id $detect_anomaly_job_id