Creates a hold in the specified matter.

Scopes

You will need authorization for the https://www.googleapis.com/auth/ediscovery scope to make a valid call.

If unset, the scope for this method defaults to https://www.googleapis.com/auth/ediscovery. You can set the scope for this method like this: vault1 --scope <scope> matters holds-create ...

Required Scalar Argument

• <matter-id> (string)
  • The matter ID.

Required Request Value

The request value is a data-structure with various fields. Each field may be a simple scalar or another data-structure. In the latter case it is advised to set the field-cursor to the data-structure's field to specify values more concisely.

For example, a structure like this:

Hold:
  corpus: string
  hold-id: string
  name: string
  org-unit:
    hold-time: string
    org-unit-id: string
  query:
    drive-query:
      include-shared-drive-files: boolean
      include-team-drive-files: boolean
    groups-query:
      end-time: string
      start-time: string
      terms: string
    hangouts-chat-query:
      include-rooms: boolean
    mail-query:
      end-time: string
      start-time: string
      terms: string
    voice-query:
      covered-data: [string]
  update-time: string

can be set completely with the following arguments which are assumed to be executed in the given order. Note how the cursor position is adjusted to the respective structures, allowing simple field names to be used most of the time.

• -r . corpus=lorem
  • The service to be searched.
• hold-id=est
  • The unique immutable ID of the hold. Assigned during creation.
• name=sed
  • The name of the hold.
• org-unit hold-time=diam
  • When the organizational unit was put on hold. This property is immutable.

• org-unit-id=dolores

  • The organizational unit's immutable ID as provided by the Admin SDK.

• ..query.drive-query include-shared-drive-files=true

  • To include files in shared drives in the hold, set to true.

• include-team-drive-files=true

  • To include files in Team Drives in the hold, set to true.

• ..groups-query end-time=sed

  • The end time for the query. Specify in GMT. The value is rounded to 12 AM on the specified date.
• start-time=no
  • The start time for the query. Specify in GMT. The value is rounded to 12 AM on the specified date.

• terms=et

  • The search operators used to refine the messages covered by the hold.

• ..hangouts-chat-query include-rooms=false

  • To include messages in Chat spaces the user was a member of, set to true.

• ..mail-query end-time=sed

  • The end time for the query. Specify in GMT. The value is rounded to 12 AM on the specified date.
• start-time=no
  • The start time for the query. Specify in GMT. The value is rounded to 12 AM on the specified date.

• terms=nonumy

  • The search operators used to refine the messages covered by the hold.

• ..voice-query covered-data=at

  • A list of data types covered by the hold. Should be non-empty. Order does not matter and duplicates are ignored.
  • Each invocation of this argument appends the given value to the array.

• ... update-time=sadipscing

  • The last time this hold was modified.

About Cursors

The cursor position is key to comfortably set complex nested structures. The following rules apply:

• The cursor position is always set relative to the current one, unless the field name starts with the . character. Fields can be nested such as in -r f.s.o .
• The cursor position is set relative to the top-level structure if it starts with ., e.g. -r .s.s
• You can also set nested fields without setting the cursor explicitly. For example, to set a value relative to the current cursor position, you would specify -r struct.sub_struct=bar.
• You can move the cursor one level up by using ... Each additional . moves it up one additional level. E.g. ... would go three levels up.

Optional Output Flags

The method's return value a JSON encoded structure, which will be written to standard output by default.

• -o out
  • out specifies the destination to which to write the server's result to. It will be a JSON-encoded structure. The destination may be - to indicate standard output, or a filepath that is to contain the received bytes. If unset, it defaults to standard output.

Optional General Properties

The following properties can configure any call, and are not specific to this method.

• -p $-xgafv=string

  • V1 error format.

• -p access-token=string

  • OAuth access token.

• -p alt=string

  • Data format for response.

• -p callback=string

  • JSONP

• -p fields=string

  • Selector specifying which fields to include in a partial response.

• -p key=string

  • API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

• -p oauth-token=string

  • OAuth 2.0 token for the current user.

• -p pretty-print=boolean

  • Returns response with indentations and line breaks.

• -p quota-user=string

  • Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

• -p upload-type=string

  • Legacy upload protocol for media (e.g. "media", "multipart").

• -p upload-protocol=string

  • Upload protocol for media (e.g. "raw", "multipart").