update-message

Description

Updates the visibility of the message represented by the receipt. You must use the messages endpoint to update messages. The messages endpoint may be different for different queues. Use ``GetQueue` <https://docs.cloud.oracle.com/api/#/en/queue/latest/Queue/GetQueue/>`__ to find the queue’s messagesEndpoint.

Usage

oci queue messages update-message [OPTIONS]

Required Parameters

--message-receipt [text]

The receipt of the message retrieved from a GetMessages call.

--queue-id [text]

The unique queue identifier.

--visibility-in-seconds [integer]

The new visibility of the message relative to the current time (as-per the clock of the server receiving the request).

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/Content/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 compartment_id=<substitute-value-of-compartment_id> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/queue/queue-admin/queue/create.html#cmdoption-compartment-id
    export display_name=<substitute-value-of-display_name> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/queue/queue-admin/queue/create.html#cmdoption-display-name
    export message_receipt=<substitute-value-of-message_receipt> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/queue/messages/update-message.html#cmdoption-message-receipt
    export visibility_in_seconds=<substitute-value-of-visibility_in_seconds> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/queue/messages/update-message.html#cmdoption-visibility-in-seconds

    queue_id=$(oci queue queue-admin queue create --compartment-id $compartment_id --display-name $display_name --query data.id --raw-output)

    oci queue messages update-message --message-receipt $message_receipt --queue-id $queue_id --visibility-in-seconds $visibility_in_seconds