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-collection/list-detect-anomaly-jobs.txt

@@ -1,155 +0,0 @@
-"list-detect-anomaly-jobs"
-**************************
-
-* Description
-
-* Usage
-
-* Required Parameters
-
-* Optional Parameters
-
-* Global Parameters
-
-* Example using required parameter
-
-
-Description
-===========
-
-Returns a list of all the Anomaly Detection jobs in the specified
-compartment.
-
-
-Usage
-=====
-
-   oci anomaly-detection detect-anomaly-job-collection list-detect-anomaly-jobs [OPTIONS]
-
-
-Required Parameters
-===================
-
---compartment-id, -c [text]
-
-The ID of the compartment in which to list resources.
-
-
-Optional Parameters
-===================
-
---all
-
-Fetches all pages of results. If you provide this option, then you
-cannot provide the "--limit" option.
-
---detect-anomaly-job-id [text]
-
-Unique Async Job identifier
-
---display-name [text]
-
-A filter to return only resources that match the entire display name
-given.
-
---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
-
---lifecycle-state [text]
-
-<b>Filter</b> results by the specified lifecycle state. Must be a
-valid state for the resource type.
-
-Accepted values are:
-
-   ACCEPTED, CANCELED, FAILED, IN_PROGRESS, PARTIALLY_SUCCEEDED, SUCCEEDED
-
---limit [integer]
-
-The maximum number of items to return.
-
---model-id [text]
-
-The ID of the trained model for which to list the resources.
-
---page [text]
-
-The page token representing the page at which to start retrieving
-results. This is usually retrieved from a previous list call.
-
---page-size [integer]
-
-When fetching results, the number of results to fetch per call. Only
-valid when used with "--all" or "--limit", and ignored otherwise.
-
---project-id [text]
-
-The ID of the project for which to list the objects.
-
---sort-by [text]
-
-The field to sort by. Only one sort order may be provided. Default
-order for timeCreated is descending. Default order for displayName is
-ascending. If no value is specified timeCreated is default.
-
-Accepted values are:
-
-   displayName, timeCreated
-
---sort-order [text]
-
-The sort order to use, either ‘asc’ or ‘desc’.
-
-Accepted values are:
-
-   ASC, DESC
-
-
-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 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/detect-anomaly-job-collection/list-detect-anomaly-jobs.html#cmdoption-compartment-id
-
-       oci anomaly-detection detect-anomaly-job-collection list-detect-anomaly-jobs --compartment-id $compartment_id

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

@@ -1,15 +0,0 @@
-detect-anomaly-job-collection
-*****************************
-
-
-Description
-===========
-
-A collection of anomaly jobs. Each item is a DetectAnomalyJob summary
-object.
-
-
-Available Commands
-==================
-
-* list-detect-anomaly-jobs

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

@@ -1,31 +0,0 @@
-detect-anomaly-job
-******************
-
-
-Description
-===========
-
-Anomaly Job contains information for asynchronous detection of
-anomalies.
-
-
-Available Commands
-==================
-
-* change-compartment
-
-* create
-
-* create-detect-anomaly-job-embedded-input-details
-
-* create-detect-anomaly-job-inline-input-details
-
-* create-detect-anomaly-job-object-list-input-details
-
-* create-detect-anomaly-job-object-store-output-details
-
-* delete
-
-* get
-
-* update

oci_cli/help_text_producer/data_files/text/cmdref/anomaly-detection/model/change-compartment.txt

@@ -1,113 +0,0 @@
-"change-compartment"
-********************
-
-* Description
-
-* Usage
-
-* Required Parameters
-
-* Optional Parameters
-
-* Global Parameters
-
-* Example using required parameter
-
-
-Description
-===========
-
-Moves a Model resource from one compartment to another. When provided,
-If-Match is checked against ETag values of the resource.
-
-
-Usage
-=====
-
-   oci anomaly-detection model change-compartment [OPTIONS]
-
-
-Required Parameters
-===================
-
---compartment-id, -c [text]
-
-The OCID of the compartment into which the resource should be moved.
-
---model-id [text]
-
-The OCID of the Model.
-
-
-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
-
---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.
-
-
-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
-
-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 model change-compartment --compartment-id $compartment_id --model-id $model_id

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

@@ -1,174 +0,0 @@
-"create"
-********
-
-* Description
-
-* Usage
-
-* Required Parameters
-
-* Optional Parameters
-
-* Global Parameters
-
-* Example using required parameter
-
-
-Description
-===========
-
-Creates a new Model.
-
-
-Usage
-=====
-
-   oci anomaly-detection model create [OPTIONS]
-
-
-Required Parameters
-===================
-
---compartment-id, -c [text]
-
-The OCID for the ai model’s compartment.
-
---model-training-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.
-
---project-id [text]
-
-The OCID of the project to associate with the model.
-
-
-Optional Parameters
-===================
-
---defined-tags [complex type]
-
-Defined tags for this resource. Each key is predefined and scoped to a
-namespace. Example: *{“foo-namespace”: {“bar-key”: “value”}}* 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.
-
---description [text]
-
-A short description of the ai model.
-
---display-name [text]
-
-A user-friendly display name for the resource. It does not have to be
-unique and can be modified. Avoid entering confidential information.
-
---freeform-tags [complex type]
-
-Simple key-value pair that is applied without any predefined name,
-type or scope. Exists for cross-compatibility only. Example: *{“bar-
-key”: “value”}* 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.
-
---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 work request to reach the state
-defined by "--wait-for-state". Defaults to 1200 seconds.
-
---wait-for-state [text]
-
-This operation asynchronously creates, modifies or deletes a resource
-and uses a work request to track the progress of the operation.
-Specify this option to perform the action and then wait until the work
-request reaches a certain 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, CANCELING, FAILED, IN_PROGRESS, SUCCEEDED, WAITING
-
---wait-interval-seconds [integer]
-
-Check every "--wait-interval-seconds" to see whether the work request
-has reached the 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
-
-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)
-
-       oci anomaly-detection model create --compartment-id $compartment_id --model-training-details file://model-training-details.json --project-id $project_id

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

@@ -1,140 +0,0 @@
-"delete"
-********
-
-* Description
-
-* Usage
-
-* Required Parameters
-
-* Optional Parameters
-
-* Global Parameters
-
-* Example using required parameter
-
-
-Description
-===========
-
-Deletes an ai model resource by identifier. This operation fails with
-a 409 error unless all associated resources are in a DELETED state.
-You must delete all associated resources before deleting a project.
-
-
-Usage
-=====
-
-   oci anomaly-detection model delete [OPTIONS]
-
-
-Required Parameters
-===================
-
---model-id [text]
-
-The OCID of the Model.
-
-
-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 work request to reach the state
-defined by "--wait-for-state". Defaults to 1200 seconds.
-
---wait-for-state [text]
-
-This operation asynchronously creates, modifies or deletes a resource
-and uses a work request to track the progress of the operation.
-Specify this option to perform the action and then wait until the work
-request reaches a certain 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, CANCELING, FAILED, IN_PROGRESS, SUCCEEDED, WAITING
-
---wait-interval-seconds [integer]
-
-Check every "--wait-interval-seconds" to see whether the work request
-has reached the 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
-
-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 model delete --model-id $model_id