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

oci_cli/help_text_producer/data_files/text/cmdref/db/pluggable-database/get-snapshot.txt

@@ -0,0 +1,92 @@
+"get-snapshot"
+**************
+
+* Description
+
+* Usage
+
+* Required Parameters
+
+* Optional Parameters
+
+* Global Parameters
+
+* Example using required parameter
+
+
+Description
+===========
+
+Gets information about the specified Exadata Pluggable Database
+Snapshot in the specified compartment.
+
+
+Usage
+=====
+
+   oci db pluggable-database get-snapshot [OPTIONS]
+
+
+Required Parameters
+===================
+
+--pdb-snapshot-id [text]
+
+The Exadata Pluggable Database Snapshot OCID.
+
+
+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 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 pdb_snapshot_id=<substitute-value-of-pdb_snapshot_id> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/db/pluggable-database/get-snapshot.html#cmdoption-pdb-snapshot-id
+
+       oci db pluggable-database get-snapshot --pdb-snapshot-id $pdb_snapshot_id

oci_cli/help_text_producer/data_files/text/cmdref/db/pluggable-database/list-snapshots.txt

@@ -0,0 +1,145 @@
+"list-snapshots"
+****************
+
+* Description
+
+* Usage
+
+* Optional Parameters
+
+* Global Parameters
+
+* Example using required parameter
+
+
+Description
+===========
+
+Gets a list of the Exadata Pluggable Database Snapshots in the
+specified compartment.
+
+
+Usage
+=====
+
+   oci db pluggable-database list-snapshots [OPTIONS]
+
+
+Optional Parameters
+===================
+
+--all
+
+Fetches all pages of results. If you provide this option, then you
+cannot provide the "--limit" option.
+
+--cluster-id [text]
+
+A filter to return only Exadata Database Node Snapshots that match the
+given VM cluster.
+
+--compartment-id, -c [text]
+
+The compartment OCID.
+
+--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]
+
+A filter to return only Exadata Pluggable Database Snapshots that
+match the given lifecycle state exactly.
+
+Accepted values are:
+
+   AVAILABLE, CREATING, FAILED, TERMINATED, TERMINATING
+
+--limit [integer]
+
+The maximum number of items to return per page.
+
+--name [text]
+
+A filter to return only resources that match the entire name given.
+The match is not case sensitive.
+
+--page [text]
+
+The pagination token to continue listing from.
+
+--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.
+
+--pluggable-database-id [text]
+
+A filter to return only Exadata Pluggable Database Snapshots that
+match the given database OCID.
+
+--sort-by [text]
+
+The field to sort by. You can provide one sort order (*sortOrder*).
+Default order for TIMECREATED is descending. Default order for NAME is
+ascending. The NAME sort order is case sensitive.
+
+Accepted values are:
+
+   NAME, TIMECREATED
+
+--sort-order [text]
+
+The sort order to use, either ascending (*ASC*) or descending
+(*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.
+
+       oci db pluggable-database list-snapshots

oci_cli/help_text_producer/data_files/text/cmdref/db/pluggable-database.txt

@@ -28,16 +28,24 @@ Available Commands
 
 * create-remote-clone
 
+* create-snapshot
+
 * delete
 
+* delete-snapshot
+
 * disable-pluggable-database-management
 
 * enable-pluggable-database-management
 
 * get
 
+* get-snapshot
+
 * list
 
+* list-snapshots
+
 * local-clone
 
 * modify-pluggable-database-management

oci_cli/help_text_producer/data_files/text/cmdref/db.txt

@@ -908,16 +908,24 @@ Available Commands
 
   * create-remote-clone
 
+  * create-snapshot
+
   * delete
 
+  * delete-snapshot
+
   * disable-pluggable-database-management
 
   * enable-pluggable-database-management
 
   * get
 
+  * get-snapshot
+
   * list
 
+  * list-snapshots
+
   * local-clone
 
   * modify-pluggable-database-management

oci_cli/help_text_producer/data_files/text/cmdref/devops/protected-branch/create-or-update.txt

@@ -31,7 +31,7 @@ Required Parameters
 
 --branch-name [text]
 
-Name of a branch to protect.
+The branchName can either be exact branch name or branch pattern.
 
 --repository-id [text]
 

oci_cli/help_text_producer/data_files/text/cmdref/devops/protected-branch/delete.txt

@@ -31,7 +31,7 @@ Required Parameters
 
 --branch-name [text]
 
-Name of a protected branch.
+The branchName can either be exact branch name or branch pattern.
 
 --repository-id [text]
 

oci_cli/help_text_producer/data_files/text/cmdref/devops/pull-request/reopen-pull-request-comment.txt

@@ -0,0 +1,119 @@
+"reopen-pull-request-comment"
+*****************************
+
+* Description
+
+* Usage
+
+* Required Parameters
+
+* Optional Parameters
+
+* Global Parameters
+
+* Example using required parameter
+
+
+Description
+===========
+
+Reopen a PullRequest Comment
+
+
+Usage
+=====
+
+   oci devops pull-request reopen-pull-request-comment [OPTIONS]
+
+
+Required Parameters
+===================
+
+--comment-id [text]
+
+unique PullRequest Comment identifier
+
+--pull-request-id [text]
+
+unique PullRequest 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
+
+--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 devops project create --generate-param-json-input notification-config > notification-config.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/devops/project/create.html#cmdoption-compartment-id
+       export name=<substitute-value-of-name> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/devops/project/create.html#cmdoption-name
+       export repository_type=<substitute-value-of-repository_type> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/devops/repository/create.html#cmdoption-repository-type
+       export display_name=<substitute-value-of-display_name> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/devops/pull-request/create.html#cmdoption-display-name
+       export source_branch=<substitute-value-of-source_branch> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/devops/pull-request/create.html#cmdoption-source-branch
+       export comment_id=<substitute-value-of-comment_id> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/devops/pull-request/reopen-pull-request-comment.html#cmdoption-comment-id
+
+       project_id=$(oci devops project create --compartment-id $compartment_id --name $name --notification-config file://notification-config.json --query data.id --raw-output)
+
+       repository_id=$(oci devops repository create --name $name --project-id $project_id --repository-type $repository_type --query data.id --raw-output)
+
+       pull_request_id=$(oci devops pull-request create --display-name $display_name --repository-id $repository_id --source-branch $source_branch --query data.id --raw-output)
+
+       oci devops pull-request reopen-pull-request-comment --comment-id $comment_id --pull-request-id $pull_request_id

oci_cli/help_text_producer/data_files/text/cmdref/devops/pull-request/resolve-pull-request-comment.txt

@@ -0,0 +1,119 @@
+"resolve-pull-request-comment"
+******************************
+
+* Description
+
+* Usage
+
+* Required Parameters
+
+* Optional Parameters
+
+* Global Parameters
+
+* Example using required parameter
+
+
+Description
+===========
+
+Resolve a PullRequest Comment
+
+
+Usage
+=====
+
+   oci devops pull-request resolve-pull-request-comment [OPTIONS]
+
+
+Required Parameters
+===================
+
+--comment-id [text]
+
+unique PullRequest Comment identifier
+
+--pull-request-id [text]
+
+unique PullRequest 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
+
+--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 devops project create --generate-param-json-input notification-config > notification-config.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/devops/project/create.html#cmdoption-compartment-id
+       export name=<substitute-value-of-name> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/devops/project/create.html#cmdoption-name
+       export repository_type=<substitute-value-of-repository_type> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/devops/repository/create.html#cmdoption-repository-type
+       export display_name=<substitute-value-of-display_name> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/devops/pull-request/create.html#cmdoption-display-name
+       export source_branch=<substitute-value-of-source_branch> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/devops/pull-request/create.html#cmdoption-source-branch
+       export comment_id=<substitute-value-of-comment_id> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/devops/pull-request/resolve-pull-request-comment.html#cmdoption-comment-id
+
+       project_id=$(oci devops project create --compartment-id $compartment_id --name $name --notification-config file://notification-config.json --query data.id --raw-output)
+
+       repository_id=$(oci devops repository create --name $name --project-id $project_id --repository-type $repository_type --query data.id --raw-output)
+
+       pull_request_id=$(oci devops pull-request create --display-name $display_name --repository-id $repository_id --source-branch $source_branch --query data.id --raw-output)
+
+       oci devops pull-request resolve-pull-request-comment --comment-id $comment_id --pull-request-id $pull_request_id

oci_cli/help_text_producer/data_files/text/cmdref/devops/pull-request.txt

@@ -50,6 +50,10 @@ Available Commands
 
 * reopen
 
+* reopen-pull-request-comment
+
+* resolve-pull-request-comment
+
 * review
 
 * unsubscribe

oci_cli/help_text_producer/data_files/text/cmdref/devops.txt

@@ -350,6 +350,10 @@ Available Commands
 
   * reopen
 
+  * reopen-pull-request-comment
+
+  * resolve-pull-request-comment
+
   * review
 
   * unsubscribe

oci_cli/help_text_producer/data_files/text/cmdref/generative-ai-inference/chat-result/chat-cohere-chat-request.txt

@@ -144,7 +144,9 @@ a small buffer.
 --chat-request-max-tokens [integer]
 
 The maximum number of output tokens that the model will generate for
-the response.
+the response. The token count of your prompt plus maxTokens must not
+exceed the model’s context length. For on-demand inferencing, the
+response length is capped at 4,000 tokens for each run.
 
 --chat-request-preamble-override [text]