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

oci_cli/help_text_producer/data_files/text/cmdref/{anomaly-detection/data-asset → kafka/cluster-config}/update.txt

@@ -17,21 +17,21 @@
 Description
 ===========
 
-Updates the DataAsset
+Updates a KafkaClusterConfig.
 
 
 Usage
 =====
 
-   oci anomaly-detection data-asset update [OPTIONS]
+   oci kafka cluster-config update [OPTIONS]
 
 
 Required Parameters
 ===================
 
---data-asset-id [text]
+--kafka-cluster-config-id [text]
 
-The OCID of the Data Asset.
+The OCID of the KafkaClusterConfig.
 
 
 Optional Parameters
@@ -40,23 +40,25 @@ 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.
+namespace. For more information, see Resource Tags.
+
+Example:
+
+   {"Operations": {"CostCenter": "42"}}
+
+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]
-
-DataAsset description
-
 --display-name [text]
 
-DataAsset Identifier
+A user-friendly name. Does not have to be unique, and it’s changeable.
+Avoid entering confidential information.
 
 --force
 
@@ -64,11 +66,17 @@ Perform update without prompting for confirmation.
 
 --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.
+Free-form tags for this resource. Each tag is a simple key-value pair
+with no predefined name, type, or namespace. For more information, see
+Resource Tags.
+
+Example:
+
+   {"Department": "Finance"}
+
+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
@@ -105,6 +113,17 @@ 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.
 
+--latest-config [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.
+
 --max-wait-seconds [integer]
 
 The maximum time to wait for the resource to reach the lifecycle state
@@ -123,7 +142,7 @@ is returned.
 
 Accepted values are:
 
-   ACTIVE, DELETED
+   ACTIVE, CREATING, DELETED, UPDATING
 
 --wait-interval-seconds [integer]
 
@@ -150,11 +169,6 @@ 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 data-asset create --generate-param-json-input data-source-details > data-source-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.
@@ -163,10 +177,6 @@ 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)
-
-       data_asset_id=$(oci anomaly-detection data-asset create --compartment-id $compartment_id --data-source-details file://data-source-details.json --project-id $project_id --query data.id --raw-output)
+       export kafka_cluster_config_id=<substitute-value-of-kafka_cluster_config_id> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/kafka/cluster-config/update.html#cmdoption-kafka-cluster-config-id
 
-       oci anomaly-detection data-asset update --data-asset-id $data_asset_id
+       oci kafka cluster-config update --kafka-cluster-config-id $kafka_cluster_config_id

oci_cli/help_text_producer/data_files/text/cmdref/{anomaly-detection/work-request/cancel.txt → kafka/cluster-config-version/delete.txt}

@@ -1,4 +1,4 @@
-"cancel"
+"delete"
 ********
 
 * Description
@@ -17,21 +17,25 @@
 Description
 ===========
 
-Cancel work request with the given ID.
+Deletes a KafkaClusterConfig version.
 
 
 Usage
 =====
 
-   oci anomaly-detection work-request cancel [OPTIONS]
+   oci kafka cluster-config-version delete [OPTIONS]
 
 
 Required Parameters
 ===================
 
---work-request-id [text]
+--kafka-cluster-config-id [text]
 
-The ID of the asynchronous request.
+The OCID of the KafkaClusterConfig.
+
+--version-number [integer]
+
+The versionNumber of the KafkaClusterConfig.
 
 
 Optional Parameters
@@ -98,6 +102,7 @@ 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 work_request_id=<substitute-value-of-work_request_id> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/anomaly-detection/work-request/cancel.html#cmdoption-work-request-id
+       export kafka_cluster_config_id=<substitute-value-of-kafka_cluster_config_id> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/kafka/cluster-config-version/delete.html#cmdoption-kafka-cluster-config-id
+       export version_number=<substitute-value-of-version_number> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/kafka/cluster-config-version/delete.html#cmdoption-version-number
 
-       oci anomaly-detection work-request cancel --work-request-id $work_request_id
+       oci kafka cluster-config-version delete --kafka-cluster-config-id $kafka_cluster_config_id --version-number $version_number

oci_cli/help_text_producer/data_files/text/cmdref/{anomaly-detection/project → kafka/cluster-config-version}/get.txt

@@ -17,21 +17,25 @@
 Description
 ===========
 
-Gets a Project by identifier
+Gets information about a KafkaClusterConfig version.
 
 
 Usage
 =====
 
-   oci anomaly-detection project get [OPTIONS]
+   oci kafka cluster-config-version get [OPTIONS]
 
 
 Required Parameters
 ===================
 
---project-id [text]
+--kafka-cluster-config-id [text]
 
-The OCID of the Project.
+The OCID of the KafkaClusterConfig.
+
+--version-number [integer]
+
+The versionNumber of the KafkaClusterConfig.
 
 
 Optional Parameters
@@ -86,8 +90,7 @@ 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)
+       export kafka_cluster_config_id=<substitute-value-of-kafka_cluster_config_id> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/kafka/cluster-config-version/get.html#cmdoption-kafka-cluster-config-id
+       export version_number=<substitute-value-of-version_number> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/kafka/cluster-config-version/get.html#cmdoption-version-number
 
-       oci anomaly-detection project get --project-id $project_id
+       oci kafka cluster-config-version get --kafka-cluster-config-id $kafka_cluster_config_id --version-number $version_number

oci_cli/help_text_producer/data_files/text/cmdref/{dts/export → kafka/cluster-config-version}/list.txt

@@ -17,21 +17,21 @@
 Description
 ===========
 
-Lists Appliance Export Jobs in a given compartment
+Gets a list of KafkaClusterConfig Versions.
 
 
 Usage
 =====
 
-   oci dts export list [OPTIONS]
+   oci kafka cluster-config-version list [OPTIONS]
 
 
 Required Parameters
 ===================
 
---compartment-id, -c [text]
+--kafka-cluster-config-id [text]
 
-compartment id
+The OCID of the KafkaClusterConfig.
 
 
 Optional Parameters
@@ -42,10 +42,6 @@ Optional Parameters
 Fetches all pages of results. If you provide this option, then you
 cannot provide the "--limit" option.
 
---display-name [text]
-
-filtering by displayName
-
 --from-json [text]
 
 Provide input to this command as a JSON document from a file using the
@@ -68,27 +64,15 @@ 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]
-
-filtering by lifecycleState
-
-Accepted values are:
-
-   ACTIVE, CANCELLED, CREATING, DELETED, FAILED, INPROGRESS, SUCCEEDED
-
 --limit [integer]
 
 For list pagination. The maximum number of results per page, or items
 to return in a paginated “List” call. For important details about how
 pagination works, see List Pagination.
 
-Example:
-
-   50
-
 --page [text]
 
-For list pagination. The value of the *opc-next-page* response header
+For list pagination. The value of the opc-next-page response header
 from the previous “List” call. For important details about how
 pagination works, see List Pagination.
 
@@ -97,6 +81,24 @@ pagination works, see List Pagination.
 When fetching results, the number of results to fetch per call. Only
 valid when used with "--all" or "--limit", and ignored otherwise.
 
+--sort-by [text]
+
+The field to sort by. You can provide only one sort order. Default
+order for *versionNumber* is descending.
+
+Accepted values are:
+
+   versionNumber
+
+--sort-order [text]
+
+The sort order to use, either ascending (*ASC*) or descending
+(*DESC*).
+
+Accepted values are:
+
+   ASC, DESC
+
 
 Global Parameters
 =================
@@ -124,6 +126,6 @@ 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/dts/export/list.html#cmdoption-compartment-id
+       export kafka_cluster_config_id=<substitute-value-of-kafka_cluster_config_id> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/kafka/cluster-config-version/list.html#cmdoption-kafka-cluster-config-id
 
-       oci dts export list --compartment-id $compartment_id
+       oci kafka cluster-config-version list --kafka-cluster-config-id $kafka_cluster_config_id

oci_cli/help_text_producer/data_files/text/cmdref/kafka/cluster-config-version.txt

@@ -0,0 +1,18 @@
+cluster-config-version
+**********************
+
+
+Description
+===========
+
+A shared configuration object used by 0 or more kafka clusters.
+
+
+Available Commands
+==================
+
+* delete
+
+* get
+
+* list

oci_cli/help_text_producer/data_files/text/cmdref/kafka/cluster-config.txt

@@ -0,0 +1,29 @@
+cluster-config
+**************
+
+
+Description
+===========
+
+A shared configuration object used by 0 or more kafka clusters.
+
+To use any of the API operations, you must be authorized in an IAM
+policy. If you’re not authorized, talk to an administrator. If you’re
+an administrator who needs to write policies to give users access, see
+Getting Started with Policies.
+
+
+Available Commands
+==================
+
+* change-compartment
+
+* create
+
+* delete
+
+* get
+
+* list
+
+* update

oci_cli/help_text_producer/data_files/text/cmdref/kafka/cluster.txt

@@ -0,0 +1,33 @@
+cluster
+*******
+
+
+Description
+===========
+
+A KafkaCluster is a description of a KafkaCluster.
+
+To use any of the API operations, you must be authorized in an IAM
+policy. If you’re not authorized, talk to an administrator. If you’re
+an administrator who needs to write policies to give users access, see
+Getting Started with Policies.
+
+
+Available Commands
+==================
+
+* change-compartment
+
+* create
+
+* delete
+
+* disable-superuser
+
+* enable-superuser
+
+* get
+
+* list
+
+* update

oci_cli/help_text_producer/data_files/text/cmdref/{service-mesh → kafka}/work-request/cancel.txt

@@ -17,13 +17,13 @@
 Description
 ===========
 
-Cancels the work request with the given ID.
+Cancels a work request.
 
 
 Usage
 =====
 
-   oci service-mesh work-request cancel [OPTIONS]
+   oci kafka work-request cancel [OPTIONS]
 
 
 Required Parameters
@@ -31,7 +31,7 @@ Required Parameters
 
 --work-request-id [text]
 
-The ID of the asynchronous request.
+The OCID of the asynchronous work request.
 
 
 Optional Parameters
@@ -98,6 +98,6 @@ 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 work_request_id=<substitute-value-of-work_request_id> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/service-mesh/work-request/cancel.html#cmdoption-work-request-id
+       export work_request_id=<substitute-value-of-work_request_id> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/kafka/work-request/cancel.html#cmdoption-work-request-id
 
-       oci service-mesh work-request cancel --work-request-id $work_request_id
+       oci kafka work-request cancel --work-request-id $work_request_id

oci_cli/help_text_producer/data_files/text/cmdref/{service-mesh → kafka}/work-request/get.txt

@@ -17,13 +17,13 @@
 Description
 ===========
 
-Gets the status of the work request with the given ID.
+Gets the details of a work request.
 
 
 Usage
 =====
 
-   oci service-mesh work-request get [OPTIONS]
+   oci kafka work-request get [OPTIONS]
 
 
 Required Parameters
@@ -31,7 +31,7 @@ Required Parameters
 
 --work-request-id [text]
 
-The ID of the asynchronous request.
+The OCID of the asynchronous work request.
 
 
 Optional Parameters
@@ -86,6 +86,6 @@ 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 work_request_id=<substitute-value-of-work_request_id> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/service-mesh/work-request/get.html#cmdoption-work-request-id
+       export work_request_id=<substitute-value-of-work_request_id> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/kafka/work-request/get.html#cmdoption-work-request-id
 
-       oci service-mesh work-request get --work-request-id $work_request_id
+       oci kafka work-request get --work-request-id $work_request_id

oci_cli/help_text_producer/data_files/text/cmdref/{service-mesh → kafka}/work-request/list.txt

@@ -5,8 +5,6 @@
 
 * Usage
 
-* Required Parameters
-
 * Optional Parameters
 
 * Global Parameters
@@ -23,15 +21,7 @@ Lists the work requests in a compartment.
 Usage
 =====
 
-   oci service-mesh work-request list [OPTIONS]
-
-
-Required Parameters
-===================
-
---compartment-id, -c [text]
-
-The ID of the compartment in which to list resources.
+   oci kafka work-request list [OPTIONS]
 
 
 Optional Parameters
@@ -42,6 +32,10 @@ Optional Parameters
 Fetches all pages of results. If you provide this option, then you
 cannot provide the "--limit" option.
 
+--compartment-id, -c [text]
+
+The OCID of the compartment in which to list resources.
+
 --from-json [text]
 
 Provide input to this command as a JSON document from a file using the
@@ -66,22 +60,15 @@ nt/API/SDKDocs/cliusing.htm#AdvancedJSONOptions
 
 --limit [integer]
 
-The maximum number of items to return.
-
---operation-status [text]
-
-A filter to return only resources that match the operation status
-given.
-
-Accepted values are:
-
-   ACCEPTED, CANCELED, CANCELING, FAILED, IN_PROGRESS, NEEDS_ATTENTION, SUCCEEDED, WAITING
+For list pagination. The maximum number of results per page, or items
+to return in a paginated “List” call. For important details about how
+pagination works, see List Pagination.
 
 --page [text]
 
-A token representing the position at which to start retrieving
-results. This must come from the *opc-next-page* header field of a
-previous response.
+For list pagination. The value of the opc-next-page response header
+from the previous “List” call. For important details about how
+pagination works, see List Pagination.
 
 --page-size [integer]
 
@@ -90,12 +77,12 @@ valid when used with "--all" or "--limit", and ignored otherwise.
 
 --resource-id [text]
 
-A filter to return work requests that match the given resourceId.
+The OCID of the resource affected by the work request.
 
 --sort-by [text]
 
 The field to sort by. Only one sort order may be provided. Default
-order for timeAccepted is descending.
+order for *timeAccepted* is descending.
 
 Accepted values are:
 
@@ -103,15 +90,25 @@ Accepted values are:
 
 --sort-order [text]
 
-The sort order to use, either ‘ASC’ or ‘DESC’.
+The sort order to use, either ascending (*ASC*) or descending
+(*DESC*).
 
 Accepted values are:
 
    ASC, DESC
 
+--status [text]
+
+A filter to return only the resources that match the given lifecycle
+state.
+
+Accepted values are:
+
+   ACCEPTED, CANCELED, CANCELING, FAILED, IN_PROGRESS, NEEDS_ATTENTION, SUCCEEDED, WAITING
+
 --work-request-id [text]
 
-The ID of the asynchronous work request.
+The OCID of the asynchronous work request.
 
 
 Global Parameters
@@ -140,6 +137,4 @@ 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/service-mesh/work-request/list.html#cmdoption-compartment-id
-
-       oci service-mesh work-request list --compartment-id $compartment_id
+       oci kafka work-request list

oci_cli/help_text_producer/data_files/text/cmdref/{service-mesh/work-request/list-work-request-errors.txt → kafka/work-request-error/list.txt}

@@ -1,5 +1,5 @@
-"list-work-request-errors"
-**************************
+"list"
+******
 
 * Description
 
@@ -17,13 +17,13 @@
 Description
 ===========
 
-Return a (paginated) list of errors for a given work request.
+Lists the errors for a work request.
 
 
 Usage
 =====
 
-   oci service-mesh work-request list-work-request-errors [OPTIONS]
+   oci kafka work-request-error list [OPTIONS]
 
 
 Required Parameters
@@ -31,7 +31,7 @@ Required Parameters
 
 --work-request-id [text]
 
-The ID of the asynchronous request.
+The OCID of the asynchronous work request.
 
 
 Optional Parameters
@@ -66,13 +66,15 @@ nt/API/SDKDocs/cliusing.htm#AdvancedJSONOptions
 
 --limit [integer]
 
-The maximum number of items to return.
+For list pagination. The maximum number of results per page, or items
+to return in a paginated “List” call. For important details about how
+pagination works, see List Pagination.
 
 --page [text]
 
-A token representing the position at which to start retrieving
-results. This must come from the *opc-next-page* header field of a
-previous response.
+For list pagination. The value of the opc-next-page response header
+from the previous “List” call. For important details about how
+pagination works, see List Pagination.
 
 --page-size [integer]
 
@@ -82,7 +84,7 @@ valid when used with "--all" or "--limit", and ignored otherwise.
 --sort-by [text]
 
 The field to sort by. Only one sort order may be provided. Default
-order for timestamp is descending.
+order for *timestamp* is descending.
 
 Accepted values are:
 
@@ -90,7 +92,8 @@ Accepted values are:
 
 --sort-order [text]
 
-The sort order to use, either ‘ASC’ or ‘DESC’.
+The sort order to use, either ascending (*ASC*) or descending
+(*DESC*).
 
 Accepted values are:
 
@@ -123,6 +126,6 @@ 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 work_request_id=<substitute-value-of-work_request_id> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/service-mesh/work-request/list-work-request-errors.html#cmdoption-work-request-id
+       export work_request_id=<substitute-value-of-work_request_id> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/kafka/work-request-error/list.html#cmdoption-work-request-id
 
-       oci service-mesh work-request list-work-request-errors --work-request-id $work_request_id
+       oci kafka work-request-error list --work-request-id $work_request_id

oci_cli/help_text_producer/data_files/text/cmdref/{anomaly-detection → kafka}/work-request-error.txt

@@ -5,7 +5,8 @@ work-request-error
 Description
 ===========
 
-An error encountered while executing a work request.
+An error encountered while performing an operation that is tracked by
+a work request.
 
 
 Available Commands