"create-group-cursor"
*********************


Description
===========

Creates a group-cursor.

The top level --endpoint parameter must be supplied for this
operation.


Usage
=====

   oci streaming stream cursor create-group-cursor [OPTIONS]


Required Parameters
===================

--group-name [text]

Name of the consumer group.

--stream-id [text]

The OCID of the stream.

--type [text]

The type of the cursor. This value is only used when the group is
created.

Accepted values are:

   AT_TIME, LATEST, TRIM_HORIZON


Optional Parameters
===================

--commit-on-get [boolean]

When using consumer-groups, the default commit-on-get behaviour can be
overriden by setting this value to false. If disabled, a consumer must
manually commit their cursors.

--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

--instance-name [text]

A unique identifier for the instance joining the consumer group. If an
instanceName is not provided, a UUID will be generated and used.

--time [datetime]

The time to consume from if type is AT_TIME.

The following datetime formats are supported:


UTC with milliseconds
---------------------

   Format: YYYY-MM-DDTHH:mm:ss.sssTZD
   Example: 2017-09-15T20:30:00.123Z


UTC without milliseconds
------------------------

   Format: YYYY-MM-DDTHH:mm:ssTZD
   Example: 2017-09-15T20:30:00Z


UTC with minute precision
-------------------------

   Format: YYYY-MM-DDTHH:mmTZD
   Example: 2017-09-15T20:30Z


Timezone with milliseconds
--------------------------

   Format: YYYY-MM-DDTHH:mm:ssTZD
   Example: 2017-09-15T12:30:00.456-08:00, 2017-09-15T12:30:00.456-0800


Timezone without milliseconds
-----------------------------

   Format: YYYY-MM-DDTHH:mm:ssTZD
   Example: 2017-09-15T12:30:00-08:00, 2017-09-15T12:30:00-0800


Timezone with minute precision
------------------------------

   Format: YYYY-MM-DDTHH:mmTZD
   Example: 2017-09-15T12:30-08:00, 2017-09-15T12:30-0800


Short date and time
-------------------

The timezone for this date and time will be taken as UTC (Needs to be
surrounded by single or double quotes)

   Format: 'YYYY-MM-DD HH:mm' or "YYYY-MM-DD HH:mm"
   Example: '2017-09-15 17:25'


Date Only
---------

This date will be taken as midnight UTC of that day

   Format: YYYY-MM-DD
   Example: 2017-09-15


Epoch seconds
-------------

   Example: 1412195400

--timeout-in-ms [integer]

The amount of a consumer instance inactivity time, before partition
reservations are released.


Global Parameters
=================

Use "oci --help" for help on global parameters.

"--auth", "--cert-bundle", "--cli-rc-file", "--config-file", "--
debug", "--defaults-file", "--endpoint", "--generate-full-command-
json-input", "--generate-param-json-input", "--help", "--no-retry", "
--opc-client-request-id", "--opc-request-id", "--output", "--profile",
"--query", "--raw-output", "--region", "--request-id", "--version",
"-?", "-d", "-h", "-v"
