oci-cli 3.62.2__py3-none-any.whl → 3.63.1__py3-none-any.whl

oci_cli/help_text_producer/data_files/text/cmdref/api-gateway/subscriber/add-lock.txt

@@ -0,0 +1,147 @@
+"add-lock"
+**********
+
+* Description
+
+* Usage
+
+* Required Parameters
+
+* Optional Parameters
+
+* Global Parameters
+
+* Example using required parameter
+
+
+Description
+===========
+
+Adds a lock to a Subscriber resource.
+
+
+Usage
+=====
+
+   oci api-gateway subscriber add-lock [OPTIONS]
+
+
+Required Parameters
+===================
+
+--subscriber-id [text]
+
+The ocid of the subscriber.
+
+--type [text]
+
+Type of the lock.
+
+Accepted values are:
+
+   DELETE, FULL
+
+
+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.
+
+--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.
+
+--message [text]
+
+A message added by the creator of the lock. This is typically used to
+give an indication of why the resource is locked.
+
+--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:
+
+   ACTIVE, CREATING, DELETED, DELETING, FAILED, UPDATING
+
+--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 api-gateway subscriber create --generate-param-json-input clients > clients.json
+       oci api-gateway subscriber create --generate-param-json-input usage-plans > usage-plans.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/api-gateway/subscriber/create.html#cmdoption-compartment-id
+       export type=<substitute-value-of-type> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/api-gateway/subscriber/add-lock.html#cmdoption-type
+
+       subscriber_id=$(oci api-gateway subscriber create --clients file://clients.json --compartment-id $compartment_id --usage-plans file://usage-plans.json --query data.id --raw-output)
+
+       oci api-gateway subscriber add-lock --subscriber-id $subscriber_id --type $type

oci_cli/help_text_producer/data_files/text/cmdref/api-gateway/subscriber/change-compartment.txt

@@ -71,6 +71,10 @@ 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.
 
+--is-lock-override [boolean]
+
+Whether to override locks (if any exist).
+
 --max-wait-seconds [integer]
 
 The maximum time to wait for the work request to reach the state

oci_cli/help_text_producer/data_files/text/cmdref/api-gateway/subscriber/create.txt

@@ -130,6 +130,23 @@ 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
 
+--locks [complex type]
+
+Locks associated with this resource.
+
+This option is a JSON list with items of type AddResourceLockDetails.
+For documentation on AddResourceLockDetails please see our API
+reference: https://docs.cloud.oracle.com/api/#/en/subscribers/2019050
+1/datatypes/AddResourceLockDetails. 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 work request to reach the state

oci_cli/help_text_producer/data_files/text/cmdref/api-gateway/subscriber/delete.txt

@@ -71,6 +71,10 @@ 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.
 
+--is-lock-override [boolean]
+
+Whether to override locks (if any exist).
+
 --max-wait-seconds [integer]
 
 The maximum time to wait for the work request to reach the state

oci_cli/help_text_producer/data_files/text/cmdref/api-gateway/subscriber/remove-lock.txt

@@ -0,0 +1,142 @@
+"remove-lock"
+*************
+
+* Description
+
+* Usage
+
+* Required Parameters
+
+* Optional Parameters
+
+* Global Parameters
+
+* Example using required parameter
+
+
+Description
+===========
+
+Removes a lock from a Subscriber resource.
+
+
+Usage
+=====
+
+   oci api-gateway subscriber remove-lock [OPTIONS]
+
+
+Required Parameters
+===================
+
+--subscriber-id [text]
+
+The ocid of the subscriber.
+
+--type [text]
+
+Type of the lock.
+
+Accepted values are:
+
+   DELETE, FULL
+
+
+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.
+
+--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:
+
+   ACTIVE, CREATING, DELETED, DELETING, FAILED, UPDATING
+
+--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 api-gateway subscriber create --generate-param-json-input clients > clients.json
+       oci api-gateway subscriber create --generate-param-json-input usage-plans > usage-plans.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/api-gateway/subscriber/create.html#cmdoption-compartment-id
+       export type=<substitute-value-of-type> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/api-gateway/subscriber/remove-lock.html#cmdoption-type
+
+       subscriber_id=$(oci api-gateway subscriber create --clients file://clients.json --compartment-id $compartment_id --usage-plans file://usage-plans.json --query data.id --raw-output)
+
+       oci api-gateway subscriber remove-lock --subscriber-id $subscriber_id --type $type

oci_cli/help_text_producer/data_files/text/cmdref/api-gateway/subscriber/update.txt

@@ -133,6 +133,10 @@ 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.
 
+--is-lock-override [boolean]
+
+Whether to override locks (if any exist).
+
 --max-wait-seconds [integer]
 
 The maximum time to wait for the work request to reach the state

oci_cli/help_text_producer/data_files/text/cmdref/api-gateway/subscriber.txt

@@ -12,6 +12,8 @@ that they are subscribed to.
 Available Commands
 ==================
 
+* add-lock
+
 * change-compartment
 
 * create
@@ -22,4 +24,6 @@ Available Commands
 
 * list
 
+* remove-lock
+
 * update

oci_cli/help_text_producer/data_files/text/cmdref/api-gateway/usage-plan/add-lock.txt

@@ -0,0 +1,146 @@
+"add-lock"
+**********
+
+* Description
+
+* Usage
+
+* Required Parameters
+
+* Optional Parameters
+
+* Global Parameters
+
+* Example using required parameter
+
+
+Description
+===========
+
+Adds a lock to a UsagePlan resource.
+
+
+Usage
+=====
+
+   oci api-gateway usage-plan add-lock [OPTIONS]
+
+
+Required Parameters
+===================
+
+--type [text]
+
+Type of the lock.
+
+Accepted values are:
+
+   DELETE, FULL
+
+--usage-plan-id [text]
+
+The ocid of the usage plan.
+
+
+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.
+
+--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.
+
+--message [text]
+
+A message added by the creator of the lock. This is typically used to
+give an indication of why the resource is locked.
+
+--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:
+
+   ACTIVE, CREATING, DELETED, DELETING, FAILED, UPDATING
+
+--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 api-gateway usage-plan create --generate-param-json-input entitlements > entitlements.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/api-gateway/usage-plan/create.html#cmdoption-compartment-id
+       export type=<substitute-value-of-type> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/api-gateway/usage-plan/add-lock.html#cmdoption-type
+
+       usage_plan_id=$(oci api-gateway usage-plan create --compartment-id $compartment_id --entitlements file://entitlements.json --query data.id --raw-output)
+
+       oci api-gateway usage-plan add-lock --type $type --usage-plan-id $usage_plan_id

oci_cli/help_text_producer/data_files/text/cmdref/api-gateway/usage-plan/change-compartment.txt

@@ -71,6 +71,10 @@ 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.
 
+--is-lock-override [boolean]
+
+Whether to override locks (if any exist).
+
 --max-wait-seconds [integer]
 
 The maximum time to wait for the work request to reach the state

oci_cli/help_text_producer/data_files/text/cmdref/api-gateway/usage-plan/create.txt

@@ -117,6 +117,23 @@ 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
 
+--locks [complex type]
+
+Locks associated with this resource.
+
+This option is a JSON list with items of type AddResourceLockDetails.
+For documentation on AddResourceLockDetails please see our API
+reference: https://docs.cloud.oracle.com/api/#/en/usageplans/20190501
+/datatypes/AddResourceLockDetails. 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 work request to reach the state

oci_cli/help_text_producer/data_files/text/cmdref/api-gateway/usage-plan/delete.txt

@@ -71,6 +71,10 @@ 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.
 
+--is-lock-override [boolean]
+
+Whether to override locks (if any exist).
+
 --max-wait-seconds [integer]
 
 The maximum time to wait for the work request to reach the state