# G Suite Vault API . matters . exports

## Instance Methods

Creates an Export.

Deletes an Export.

Gets an Export.

Lists Exports.

Retrieves the next page of results.

### Method Details

`create(matterId, body=None, x__xgafv=None)`

    Creates an Export.

    Args:
      matterId: string, The matter ID. (required)
      body: object, The request body.
        The object takes the form of:

    { # An export
      "exportOptions": { # Export advanced options # Advanced options of the export.
        "groupsOptions": { # The options for groups export. # Option available for groups export.
          "exportFormat": "A String", # The export format for groups export.
        },
        "hangoutsChatOptions": { # The options for hangouts chat export. # Option available for hangouts chat export.
          "exportFormat": "A String", # The export format for hangouts chat export.
        },
        "driveOptions": { # The options for Drive export. # Option available for Drive export.
          "includeAccessInfo": True or False, # Set to true to include access level information for users
              # with <a
              # href="https://support.google.com/vault/answer/6099459#metadata">indirect
              # access</a> to files.
        },
        "mailOptions": { # The options for mail export. # Option available for mail export.
          "exportFormat": "A String", # The export file format.
          "showConfidentialModeContent": True or False, # Set to true to export confidential mode content.
        },
        "region": "A String", # The requested export location.
      },
      "stats": { # Stats of an export. # Output only. Export statistics.
        "sizeInBytes": "A String", # The size of export in bytes.
        "exportedArtifactCount": "A String", # The number of documents already processed by the export.
        "totalArtifactCount": "A String", # The number of documents to be exported.
      },
      "requester": { # User's information. # Output only. The requester of the export.
        "displayName": "A String", # The displayed name of the user.
        "email": "A String", # The email address of the user.
      },
      "name": "A String", # The export name.
      "matterId": "A String", # Output only. The matter ID.
      "id": "A String", # Output only. The generated export ID.
      "cloudStorageSink": { # Export sink for cloud storage files. # Output only. Export sink for cloud storage files.
        "files": [ # Output only. The exported files on cloud storage.
          { # An export file on cloud storage
            "objectName": "A String", # The cloud storage object name of this export file.
                # Can be used in cloud storage JSON/XML API.
            "size": "A String", # The size of the export file.
            "md5Hash": "A String", # The md5 hash of the file.
            "bucketName": "A String", # The cloud storage bucket name of this export file.
                # Can be used in cloud storage JSON/XML API, but not to list the bucket
                # contents. Instead, you can <a
                # href="https://cloud.google.com/storage/docs/json_api/v1/objects/get">
                # get individual export files</a> by object name.
          },
        ],
      },
      "createTime": "A String", # Output only. The time when the export was created.
      "status": "A String", # Output only. The export status.
      "query": { # A query definition relevant for search & export. # The search query being exported.
        "accountInfo": { # Accounts to search # When 'ACCOUNT' is chosen as search method,
            # account_info needs to be specified.
          "emails": [ # A set of accounts to search.
            "A String",
          ],
        },
        "hangoutsChatInfo": { # Accounts to search # When 'ROOM' is chosen as search method, hangout_chats_info needs to be
            # specified. (read-only)
          "roomId": [ # A set of rooms to search.
            "A String",
          ],
        },
        "teamDriveInfo": { # Team Drives to search # When 'TEAM_DRIVE' is chosen as search method, team_drive_info needs to be
            # specified.
          "teamDriveIds": [ # List of Team Drive IDs, as provided by <a
              # href="https://developers.google.com/drive">Drive API</a>.
            "A String",
          ],
        },
        "dataScope": "A String", # The data source to search from.
        "endTime": "A String", # The end time range for the search query. These timestamps are in GMT and
            # rounded down to the start of the given date.
        "searchMethod": "A String", # The search method to use.
        "driveOptions": { # Drive search advanced options # For Drive search, specify more options in this field.
          "includeTeamDrives": True or False, # Set to true to include Team Drive.
          "includeSharedDrives": True or False, # Set to true to include shared drive.
          "versionDate": "A String", # Search the versions of the Drive file
              # as of the reference date. These timestamps are in GMT and
              # rounded down to the given date.
        },
        "orgUnitInfo": { # Org Unit to search # When 'ORG_UNIT' is chosen as as search method, org_unit_info needs
            # to be specified.
          "orgUnitId": "A String", # Org unit to search, as provided by the
              # <a href="https://developers.google.com/admin-sdk/directory/">Admin SDK
              # Directory API</a>.
        },
        "startTime": "A String", # The start time range for the search query. These timestamps are in GMT and
            # rounded down to the start of the given date.
        "terms": "A String", # The corpus-specific
            # <a href="https://support.google.com/vault/answer/2474474">search
            # operators</a> used to generate search results.
        "hangoutsChatOptions": { # Hangouts chat search advanced options # For hangouts chat search, specify more options in this field. (read-only)
          "includeRooms": True or False, # Set to true to include rooms.
        },
        "sharedDriveInfo": { # Shared drives to search # When 'SHARED_DRIVE' is chosen as search method, shared_drive_info needs
            # to be specified.
          "sharedDriveIds": [ # List of Shared drive IDs, as provided by <a
              # href="https://developers.google.com/drive">Drive API</a>.
            "A String",
          ],
        },
        "mailOptions": { # Mail search advanced options # For mail search, specify more options in this field.
          "excludeDrafts": True or False, # Set to true to exclude drafts.
        },
        "timeZone": "A String", # The time zone name.
            # It should be an IANA TZ name, such as "America/Los_Angeles".
            # For more information, see
            # <a href="https://en.wikipedia.org/wiki/List_of_tz_database_time_zones">Time
            # Zone</a>.
        "corpus": "A String", # The corpus to search.
        "method": "A String", # The search method to use. This field is similar to the search_method field
            # but is introduced to support shared drives. It supports all
            # search method types. In case the search_method is TEAM_DRIVE the response
            # of this field will be SHARED_DRIVE only.
      },
    }

      x__xgafv: string, V1 error format.
        Allowed values
          1 - v1 error format
          2 - v2 error format

    Returns:
      An object of the form:

        { # An export
        "exportOptions": { # Export advanced options # Advanced options of the export.
          "groupsOptions": { # The options for groups export. # Option available for groups export.
            "exportFormat": "A String", # The export format for groups export.
          },
          "hangoutsChatOptions": { # The options for hangouts chat export. # Option available for hangouts chat export.
            "exportFormat": "A String", # The export format for hangouts chat export.
          },
          "driveOptions": { # The options for Drive export. # Option available for Drive export.
            "includeAccessInfo": True or False, # Set to true to include access level information for users
                # with <a
                # href="https://support.google.com/vault/answer/6099459#metadata">indirect
                # access</a> to files.
          },
          "mailOptions": { # The options for mail export. # Option available for mail export.
            "exportFormat": "A String", # The export file format.
            "showConfidentialModeContent": True or False, # Set to true to export confidential mode content.
          },
          "region": "A String", # The requested export location.
        },
        "stats": { # Stats of an export. # Output only. Export statistics.
          "sizeInBytes": "A String", # The size of export in bytes.
          "exportedArtifactCount": "A String", # The number of documents already processed by the export.
          "totalArtifactCount": "A String", # The number of documents to be exported.
        },
        "requester": { # User's information. # Output only. The requester of the export.
          "displayName": "A String", # The displayed name of the user.
          "email": "A String", # The email address of the user.
        },
        "name": "A String", # The export name.
        "matterId": "A String", # Output only. The matter ID.
        "id": "A String", # Output only. The generated export ID.
        "cloudStorageSink": { # Export sink for cloud storage files. # Output only. Export sink for cloud storage files.
          "files": [ # Output only. The exported files on cloud storage.
            { # An export file on cloud storage
              "objectName": "A String", # The cloud storage object name of this export file.
                  # Can be used in cloud storage JSON/XML API.
              "size": "A String", # The size of the export file.
              "md5Hash": "A String", # The md5 hash of the file.
              "bucketName": "A String", # The cloud storage bucket name of this export file.
                  # Can be used in cloud storage JSON/XML API, but not to list the bucket
                  # contents. Instead, you can <a
                  # href="https://cloud.google.com/storage/docs/json_api/v1/objects/get">
                  # get individual export files</a> by object name.
            },
          ],
        },
        "createTime": "A String", # Output only. The time when the export was created.
        "status": "A String", # Output only. The export status.
        "query": { # A query definition relevant for search & export. # The search query being exported.
          "accountInfo": { # Accounts to search # When 'ACCOUNT' is chosen as search method,
              # account_info needs to be specified.
            "emails": [ # A set of accounts to search.
              "A String",
            ],
          },
          "hangoutsChatInfo": { # Accounts to search # When 'ROOM' is chosen as search method, hangout_chats_info needs to be
              # specified. (read-only)
            "roomId": [ # A set of rooms to search.
              "A String",
            ],
          },
          "teamDriveInfo": { # Team Drives to search # When 'TEAM_DRIVE' is chosen as search method, team_drive_info needs to be
              # specified.
            "teamDriveIds": [ # List of Team Drive IDs, as provided by <a
                # href="https://developers.google.com/drive">Drive API</a>.
              "A String",
            ],
          },
          "dataScope": "A String", # The data source to search from.
          "endTime": "A String", # The end time range for the search query. These timestamps are in GMT and
              # rounded down to the start of the given date.
          "searchMethod": "A String", # The search method to use.
          "driveOptions": { # Drive search advanced options # For Drive search, specify more options in this field.
            "includeTeamDrives": True or False, # Set to true to include Team Drive.
            "includeSharedDrives": True or False, # Set to true to include shared drive.
            "versionDate": "A String", # Search the versions of the Drive file
                # as of the reference date. These timestamps are in GMT and
                # rounded down to the given date.
          },
          "orgUnitInfo": { # Org Unit to search # When 'ORG_UNIT' is chosen as as search method, org_unit_info needs
              # to be specified.
            "orgUnitId": "A String", # Org unit to search, as provided by the
                # <a href="https://developers.google.com/admin-sdk/directory/">Admin SDK
                # Directory API</a>.
          },
          "startTime": "A String", # The start time range for the search query. These timestamps are in GMT and
              # rounded down to the start of the given date.
          "terms": "A String", # The corpus-specific
              # <a href="https://support.google.com/vault/answer/2474474">search
              # operators</a> used to generate search results.
          "hangoutsChatOptions": { # Hangouts chat search advanced options # For hangouts chat search, specify more options in this field. (read-only)
            "includeRooms": True or False, # Set to true to include rooms.
          },
          "sharedDriveInfo": { # Shared drives to search # When 'SHARED_DRIVE' is chosen as search method, shared_drive_info needs
              # to be specified.
            "sharedDriveIds": [ # List of Shared drive IDs, as provided by <a
                # href="https://developers.google.com/drive">Drive API</a>.
              "A String",
            ],
          },
          "mailOptions": { # Mail search advanced options # For mail search, specify more options in this field.
            "excludeDrafts": True or False, # Set to true to exclude drafts.
          },
          "timeZone": "A String", # The time zone name.
              # It should be an IANA TZ name, such as "America/Los_Angeles".
              # For more information, see
              # <a href="https://en.wikipedia.org/wiki/List_of_tz_database_time_zones">Time
              # Zone</a>.
          "corpus": "A String", # The corpus to search.
          "method": "A String", # The search method to use. This field is similar to the search_method field
              # but is introduced to support shared drives. It supports all
              # search method types. In case the search_method is TEAM_DRIVE the response
              # of this field will be SHARED_DRIVE only.
        },
      }

`delete(matterId, exportId, x__xgafv=None)`

    Deletes an Export.

    Args:
      matterId: string, The matter ID. (required)
      exportId: string, The export ID. (required)
      x__xgafv: string, V1 error format.
        Allowed values
          1 - v1 error format
          2 - v2 error format

    Returns:
      An object of the form:

        { # A generic empty message that you can re-use to avoid defining duplicated
          # empty messages in your APIs. A typical example is to use it as the request
          # or the response type of an API method. For instance:
          #
          #     service Foo {
          #       rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);
          #     }
          #
          # The JSON representation for `Empty` is empty JSON object `{}`.
      }

`get(matterId, exportId, x__xgafv=None)`

    Gets an Export.

    Args:
      matterId: string, The matter ID. (required)
      exportId: string, The export ID. (required)
      x__xgafv: string, V1 error format.
        Allowed values
          1 - v1 error format
          2 - v2 error format

    Returns:
      An object of the form:

        { # An export
        "exportOptions": { # Export advanced options # Advanced options of the export.
          "groupsOptions": { # The options for groups export. # Option available for groups export.
            "exportFormat": "A String", # The export format for groups export.
          },
          "hangoutsChatOptions": { # The options for hangouts chat export. # Option available for hangouts chat export.
            "exportFormat": "A String", # The export format for hangouts chat export.
          },
          "driveOptions": { # The options for Drive export. # Option available for Drive export.
            "includeAccessInfo": True or False, # Set to true to include access level information for users
                # with <a
                # href="https://support.google.com/vault/answer/6099459#metadata">indirect
                # access</a> to files.
          },
          "mailOptions": { # The options for mail export. # Option available for mail export.
            "exportFormat": "A String", # The export file format.
            "showConfidentialModeContent": True or False, # Set to true to export confidential mode content.
          },
          "region": "A String", # The requested export location.
        },
        "stats": { # Stats of an export. # Output only. Export statistics.
          "sizeInBytes": "A String", # The size of export in bytes.
          "exportedArtifactCount": "A String", # The number of documents already processed by the export.
          "totalArtifactCount": "A String", # The number of documents to be exported.
        },
        "requester": { # User's information. # Output only. The requester of the export.
          "displayName": "A String", # The displayed name of the user.
          "email": "A String", # The email address of the user.
        },
        "name": "A String", # The export name.
        "matterId": "A String", # Output only. The matter ID.
        "id": "A String", # Output only. The generated export ID.
        "cloudStorageSink": { # Export sink for cloud storage files. # Output only. Export sink for cloud storage files.
          "files": [ # Output only. The exported files on cloud storage.
            { # An export file on cloud storage
              "objectName": "A String", # The cloud storage object name of this export file.
                  # Can be used in cloud storage JSON/XML API.
              "size": "A String", # The size of the export file.
              "md5Hash": "A String", # The md5 hash of the file.
              "bucketName": "A String", # The cloud storage bucket name of this export file.
                  # Can be used in cloud storage JSON/XML API, but not to list the bucket
                  # contents. Instead, you can <a
                  # href="https://cloud.google.com/storage/docs/json_api/v1/objects/get">
                  # get individual export files</a> by object name.
            },
          ],
        },
        "createTime": "A String", # Output only. The time when the export was created.
        "status": "A String", # Output only. The export status.
        "query": { # A query definition relevant for search & export. # The search query being exported.
          "accountInfo": { # Accounts to search # When 'ACCOUNT' is chosen as search method,
              # account_info needs to be specified.
            "emails": [ # A set of accounts to search.
              "A String",
            ],
          },
          "hangoutsChatInfo": { # Accounts to search # When 'ROOM' is chosen as search method, hangout_chats_info needs to be
              # specified. (read-only)
            "roomId": [ # A set of rooms to search.
              "A String",
            ],
          },
          "teamDriveInfo": { # Team Drives to search # When 'TEAM_DRIVE' is chosen as search method, team_drive_info needs to be
              # specified.
            "teamDriveIds": [ # List of Team Drive IDs, as provided by <a
                # href="https://developers.google.com/drive">Drive API</a>.
              "A String",
            ],
          },
          "dataScope": "A String", # The data source to search from.
          "endTime": "A String", # The end time range for the search query. These timestamps are in GMT and
              # rounded down to the start of the given date.
          "searchMethod": "A String", # The search method to use.
          "driveOptions": { # Drive search advanced options # For Drive search, specify more options in this field.
            "includeTeamDrives": True or False, # Set to true to include Team Drive.
            "includeSharedDrives": True or False, # Set to true to include shared drive.
            "versionDate": "A String", # Search the versions of the Drive file
                # as of the reference date. These timestamps are in GMT and
                # rounded down to the given date.
          },
          "orgUnitInfo": { # Org Unit to search # When 'ORG_UNIT' is chosen as as search method, org_unit_info needs
              # to be specified.
            "orgUnitId": "A String", # Org unit to search, as provided by the
                # <a href="https://developers.google.com/admin-sdk/directory/">Admin SDK
                # Directory API</a>.
          },
          "startTime": "A String", # The start time range for the search query. These timestamps are in GMT and
              # rounded down to the start of the given date.
          "terms": "A String", # The corpus-specific
              # <a href="https://support.google.com/vault/answer/2474474">search
              # operators</a> used to generate search results.
          "hangoutsChatOptions": { # Hangouts chat search advanced options # For hangouts chat search, specify more options in this field. (read-only)
            "includeRooms": True or False, # Set to true to include rooms.
          },
          "sharedDriveInfo": { # Shared drives to search # When 'SHARED_DRIVE' is chosen as search method, shared_drive_info needs
              # to be specified.
            "sharedDriveIds": [ # List of Shared drive IDs, as provided by <a
                # href="https://developers.google.com/drive">Drive API</a>.
              "A String",
            ],
          },
          "mailOptions": { # Mail search advanced options # For mail search, specify more options in this field.
            "excludeDrafts": True or False, # Set to true to exclude drafts.
          },
          "timeZone": "A String", # The time zone name.
              # It should be an IANA TZ name, such as "America/Los_Angeles".
              # For more information, see
              # <a href="https://en.wikipedia.org/wiki/List_of_tz_database_time_zones">Time
              # Zone</a>.
          "corpus": "A String", # The corpus to search.
          "method": "A String", # The search method to use. This field is similar to the search_method field
              # but is introduced to support shared drives. It supports all
              # search method types. In case the search_method is TEAM_DRIVE the response
              # of this field will be SHARED_DRIVE only.
        },
      }

`list(matterId, pageSize=None, pageToken=None, x__xgafv=None)`

    Lists Exports.

    Args:
      matterId: string, The matter ID. (required)
      pageSize: integer, The number of exports to return in the response.
      pageToken: string, The pagination token as returned in the response.
      x__xgafv: string, V1 error format.
        Allowed values
          1 - v1 error format
          2 - v2 error format

    Returns:
      An object of the form:

        { # The holds for a matter.
        "exports": [ # The list of exports.
          { # An export
            "exportOptions": { # Export advanced options # Advanced options of the export.
              "groupsOptions": { # The options for groups export. # Option available for groups export.
                "exportFormat": "A String", # The export format for groups export.
              },
              "hangoutsChatOptions": { # The options for hangouts chat export. # Option available for hangouts chat export.
                "exportFormat": "A String", # The export format for hangouts chat export.
              },
              "driveOptions": { # The options for Drive export. # Option available for Drive export.
                "includeAccessInfo": True or False, # Set to true to include access level information for users
                    # with <a
                    # href="https://support.google.com/vault/answer/6099459#metadata">indirect
                    # access</a> to files.
              },
              "mailOptions": { # The options for mail export. # Option available for mail export.
                "exportFormat": "A String", # The export file format.
                "showConfidentialModeContent": True or False, # Set to true to export confidential mode content.
              },
              "region": "A String", # The requested export location.
            },
            "stats": { # Stats of an export. # Output only. Export statistics.
              "sizeInBytes": "A String", # The size of export in bytes.
              "exportedArtifactCount": "A String", # The number of documents already processed by the export.
              "totalArtifactCount": "A String", # The number of documents to be exported.
            },
            "requester": { # User's information. # Output only. The requester of the export.
              "displayName": "A String", # The displayed name of the user.
              "email": "A String", # The email address of the user.
            },
            "name": "A String", # The export name.
            "matterId": "A String", # Output only. The matter ID.
            "id": "A String", # Output only. The generated export ID.
            "cloudStorageSink": { # Export sink for cloud storage files. # Output only. Export sink for cloud storage files.
              "files": [ # Output only. The exported files on cloud storage.
                { # An export file on cloud storage
                  "objectName": "A String", # The cloud storage object name of this export file.
                      # Can be used in cloud storage JSON/XML API.
                  "size": "A String", # The size of the export file.
                  "md5Hash": "A String", # The md5 hash of the file.
                  "bucketName": "A String", # The cloud storage bucket name of this export file.
                      # Can be used in cloud storage JSON/XML API, but not to list the bucket
                      # contents. Instead, you can <a
                      # href="https://cloud.google.com/storage/docs/json_api/v1/objects/get">
                      # get individual export files</a> by object name.
                },
              ],
            },
            "createTime": "A String", # Output only. The time when the export was created.
            "status": "A String", # Output only. The export status.
            "query": { # A query definition relevant for search & export. # The search query being exported.
              "accountInfo": { # Accounts to search # When 'ACCOUNT' is chosen as search method,
                  # account_info needs to be specified.
                "emails": [ # A set of accounts to search.
                  "A String",
                ],
              },
              "hangoutsChatInfo": { # Accounts to search # When 'ROOM' is chosen as search method, hangout_chats_info needs to be
                  # specified. (read-only)
                "roomId": [ # A set of rooms to search.
                  "A String",
                ],
              },
              "teamDriveInfo": { # Team Drives to search # When 'TEAM_DRIVE' is chosen as search method, team_drive_info needs to be
                  # specified.
                "teamDriveIds": [ # List of Team Drive IDs, as provided by <a
                    # href="https://developers.google.com/drive">Drive API</a>.
                  "A String",
                ],
              },
              "dataScope": "A String", # The data source to search from.
              "endTime": "A String", # The end time range for the search query. These timestamps are in GMT and
                  # rounded down to the start of the given date.
              "searchMethod": "A String", # The search method to use.
              "driveOptions": { # Drive search advanced options # For Drive search, specify more options in this field.
                "includeTeamDrives": True or False, # Set to true to include Team Drive.
                "includeSharedDrives": True or False, # Set to true to include shared drive.
                "versionDate": "A String", # Search the versions of the Drive file
                    # as of the reference date. These timestamps are in GMT and
                    # rounded down to the given date.
              },
              "orgUnitInfo": { # Org Unit to search # When 'ORG_UNIT' is chosen as as search method, org_unit_info needs
                  # to be specified.
                "orgUnitId": "A String", # Org unit to search, as provided by the
                    # <a href="https://developers.google.com/admin-sdk/directory/">Admin SDK
                    # Directory API</a>.
              },
              "startTime": "A String", # The start time range for the search query. These timestamps are in GMT and
                  # rounded down to the start of the given date.
              "terms": "A String", # The corpus-specific
                  # <a href="https://support.google.com/vault/answer/2474474">search
                  # operators</a> used to generate search results.
              "hangoutsChatOptions": { # Hangouts chat search advanced options # For hangouts chat search, specify more options in this field. (read-only)
                "includeRooms": True or False, # Set to true to include rooms.
              },
              "sharedDriveInfo": { # Shared drives to search # When 'SHARED_DRIVE' is chosen as search method, shared_drive_info needs
                  # to be specified.
                "sharedDriveIds": [ # List of Shared drive IDs, as provided by <a
                    # href="https://developers.google.com/drive">Drive API</a>.
                  "A String",
                ],
              },
              "mailOptions": { # Mail search advanced options # For mail search, specify more options in this field.
                "excludeDrafts": True or False, # Set to true to exclude drafts.
              },
              "timeZone": "A String", # The time zone name.
                  # It should be an IANA TZ name, such as "America/Los_Angeles".
                  # For more information, see
                  # <a href="https://en.wikipedia.org/wiki/List_of_tz_database_time_zones">Time
                  # Zone</a>.
              "corpus": "A String", # The corpus to search.
              "method": "A String", # The search method to use. This field is similar to the search_method field
                  # but is introduced to support shared drives. It supports all
                  # search method types. In case the search_method is TEAM_DRIVE the response
                  # of this field will be SHARED_DRIVE only.
            },
          },
        ],
        "nextPageToken": "A String", # Page token to retrieve the next page of results in the list.
      }

`list_next(previous_request, previous_response)`

    Retrieves the next page of results.

    Args:
      previous_request: The request for the previous page. (required)
      previous_response: The response from the request for the previous page. (required)

    Returns:
      A request object that you can call 'execute()' on to request the next
      page. Returns None if there are no more items in the collection.