"description":"Page token to retrieve the next page of results in the list.",
"type":"string"
}
},
"id":"ListMattersResponse"
},
"HeldMailQuery":{
"description":"Query options for mail holds.",
"type":"object",
"properties":{
"endTime":{
"format":"google-datetime",
"description":"The end date range for the search query. These timestamps are in GMT and\nrounded down to the start of the given date.",
"type":"string"
},
"startTime":{
"format":"google-datetime",
"description":"The start date range for the search query. These timestamps are in GMT and\nrounded down to the start of the given date.",
"type":"string"
},
"terms":{
"description":"The search terms for the hold.",
"type":"string"
}
},
"id":"HeldMailQuery"
},
"CloseMatterResponse":{
"description":"Response to a CloseMatterRequest.",
"type":"object",
"properties":{
"matter":{
"$ref":"Matter",
"description":"The updated matter, with state CLOSED."
}
},
"id":"CloseMatterResponse"
},
"HeldGroupsQuery":{
"description":"Query options for group holds.",
"type":"object",
"properties":{
"endTime":{
"format":"google-datetime",
"description":"The end date range for the search query. These timestamps are in GMT and\nrounded down to the start of the given date.",
"type":"string"
},
"startTime":{
"format":"google-datetime",
"description":"The start date range for the search query. These timestamps are in GMT and\nrounded down to the start of the given date.",
"type":"string"
},
"terms":{
"type":"string",
"description":"The search terms for the hold."
}
},
"id":"HeldGroupsQuery"
},
"HeldDriveQuery":{
"description":"Query options for drive holds.",
"type":"object",
"properties":{
"includeTeamDriveFiles":{
"description":"If true, include files in Team Drives in the hold.",
"type":"boolean"
}
},
"id":"HeldDriveQuery"
},
"HeldOrgUnit":{
"description":"A organizational unit being held in a particular hold.\nThis structure is immutable.",
"type":"object",
"properties":{
"orgUnitId":{
"description":"The org unit's immutable ID as provided by the admin SDK.",
"type":"string"
},
"holdTime":{
"format":"google-datetime",
"description":"When the org unit was put on hold. This property is immutable.",
"type":"string"
}
},
"id":"HeldOrgUnit"
},
"AddMatterPermissionsRequest":{
"description":"Add an account with the permission specified. The role cannot be owner.\nIf an account already has a role in the matter, it will be\noverwritten.",
"type":"object",
"properties":{
"sendEmails":{
"description":"True to send notification email to the added account.\nFalse to not send notification email.",
"type":"boolean"
},
"matterPermission":{
"$ref":"MatterPermission",
"description":"The MatterPermission to add."
},
"ccMe":{
"description":"Only relevant if send_emails is true.\nTrue to CC requestor in the email message.\nFalse to not CC requestor.",
"type":"boolean"
}
},
"id":"AddMatterPermissionsRequest"
},
"Matter":{
"id":"Matter",
"description":"Represents a matter.",
"type":"object",
"properties":{
"description":{
"description":"The description of the matter.",
"type":"string"
},
"matterId":{
"description":"The matter ID which is generated by the server.\nShould be blank when creating a new matter.",
"type":"string"
},
"state":{
"enumDescriptions":[
"The matter has no specified state.",
"This matter is open.",
"This matter is closed.",
"This matter is deleted."
],
"enum":[
"STATE_UNSPECIFIED",
"OPEN",
"CLOSED",
"DELETED"
],
"description":"The state of the matter.",
"type":"string"
},
"matterPermissions":{
"description":"List of users and access to the matter. Currently there is no programmer\ndefined limit on the number of permissions a matter can have.",
"items":{
"$ref":"MatterPermission"
},
"type":"array"
},
"name":{
"description":"The name of the matter.",
"type":"string"
}
}
},
"HeldAccount":{
"id":"HeldAccount",
"description":"An account being held in a particular hold. This structure is immutable.\nThis can be either a single user or a google group, depending on the corpus.",
"type":"object",
"properties":{
"accountId":{
"description":"The account's ID as provided by the\n\u003ca href=\"https://developers.google.com/admin-sdk/\"\u003eAdmin SDK\u003c/a\u003e.",
"type":"string"
},
"holdTime":{
"format":"google-datetime",
"description":"When the account was put on hold.",
"type":"string"
}
}
},
"ReopenMatterResponse":{
"description":"Response to a ReopenMatterRequest.",
"type":"object",
"properties":{
"matter":{
"$ref":"Matter",
"description":"The updated matter, with state OPEN."
}
},
"id":"ReopenMatterResponse"
},
"CorpusQuery":{
"description":"Corpus specific queries.",
"type":"object",
"properties":{
"groupsQuery":{
"description":"Details pertaining to Groups holds. If set, corpus must be Groups.",
"$ref":"HeldGroupsQuery"
},
"mailQuery":{
"description":"Details pertaining to mail holds. If set, corpus must be mail.",
"$ref":"HeldMailQuery"
},
"driveQuery":{
"$ref":"HeldDriveQuery",
"description":"Details pertaining to Drive holds. If set, corpus must be Drive."
}
},
"id":"CorpusQuery"
},
"Hold":{
"description":"Represents a hold within Vault. A hold restricts purging of\nartifacts based on the combination of the query and accounts restrictions.\nA hold can be configured to either apply to an explicitly configured set\nof accounts, or can be applied to all members of an organizational unit.",
"type":"object",
"properties":{
"name":{
"description":"The name of the hold.",
"type":"string"
},
"holdId":{
"description":"The unique immutable ID of the hold. Assigned during creation.",
"type":"string"
},
"accounts":{
"description":"If set, the hold applies to the enumerated accounts and org_unit must be\nempty.",
"items":{
"$ref":"HeldAccount"
},
"type":"array"
},
"orgUnit":{
"description":"If set, the hold applies to all members of the organizational unit and\naccounts must be empty. This property is mutable. For groups holds,\nset the accounts field.",
"$ref":"HeldOrgUnit"
},
"query":{
"$ref":"CorpusQuery",
"description":"The corpus-specific query. If set, the corpusQuery must match corpus\ntype."
},
"corpus":{
"description":"The corpus to be searched.",
"type":"string",
"enumDescriptions":[
"No corpus specified.",
"Drive.",
"Mail.",
"Groups."
],
"enum":[
"CORPUS_TYPE_UNSPECIFIED",
"DRIVE",
"MAIL",
"GROUPS"
]
},
"updateTime":{
"format":"google-datetime",
"description":"The last time this hold was modified.",
"type":"string"
}
},
"id":"Hold"
},
"ListHoldsResponse":{
"description":"The holds for a matter.",
"type":"object",
"properties":{
"nextPageToken":{
"description":"Page token to retrieve the next page of results in the list.\nIf this is empty, then there are no more holds to list.",
"type":"string"
},
"holds":{
"items":{
"$ref":"Hold"
},
"type":"array",
"description":"The list of holds."
}
},
"id":"ListHoldsResponse"
},
"ListHeldAccountsResponse":{
"properties":{
"accounts":{
"description":"The held accounts on a hold.",
"items":{
"$ref":"HeldAccount"
},
"type":"array"
}
},
"id":"ListHeldAccountsResponse",
"description":"Returns a list of held accounts for a hold.",
"type":"object"
},
"UndeleteMatterRequest":{
"type":"object",
"properties":{},
"id":"UndeleteMatterRequest",
"description":"Undelete a matter by ID."
},
"Empty":{
"description":"A generic empty message that you can re-use to avoid defining duplicated\nempty messages in your APIs. A typical example is to use it as the request\nor the response type of an API method. For instance:\n\n service Foo {\n rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);\n }\n\nThe JSON representation for `Empty` is empty JSON object `{}`.",
"type":"object",
"properties":{},
"id":"Empty"
},
"ReopenMatterRequest":{
"id":"ReopenMatterRequest",
"description":"Reopen a matter by ID.",
"type":"object",
"properties":{}
},
"CloseMatterRequest":{
"description":"Close a matter by ID.",
"type":"object",
"properties":{},
"id":"CloseMatterRequest"
},
"RemoveMatterPermissionsRequest":{
"description":"Remove an account as a matter collaborator.",
"type":"object",
"properties":{
"accountId":{
"description":"The account ID.",
"type":"string"
}
},
"id":"RemoveMatterPermissionsRequest"
},
"MatterPermission":{
"type":"object",
"properties":{
"accountId":{
"description":"The account id, as provided by \u003ca href=\"https://developers.google.com/admin-sdk/\"\u003eAdmin SDK\u003c/a\u003e.",
"type":"string"
},
"role":{
"enumDescriptions":[
"No role assigned.",
"A collaborator to the matter.",
"The owner of the matter."
],
"enum":[
"ROLE_UNSPECIFIED",
"COLLABORATOR",
"OWNER"
],
"description":"The user's role in this matter.",
"type":"string"
}
},
"id":"MatterPermission",
"description":"Currently each matter only has one owner, and all others are collaborators.\nWhen an account is purged, its corresponding MatterPermission resources\ncease to exist."
"description":"Updates the specified matter.\nThis updates only the name and description of the matter, identified by\nmatter id. Changes to any other fields are ignored.\nReturns the default view of the matter.",
"description":"The number of holds to return in the response, between 0 and 100 inclusive.\nLeaving this empty, or as 0, is the same as page_size = 100.",
"description":"Updates the OU and/or query parameters of a hold. You cannot add accounts\nto a hold that covers an OU, nor can you add OUs to a hold that covers\nindividual accounts. Accounts listed in the hold will be ignored.",
"description":"Lists HeldAccounts for a hold. This will only list individually specified\nheld accounts. If the hold is on an OU, then use\n\u003ca href=\"https://developers.google.com/admin-sdk/\"\u003eAdmin SDK\u003c/a\u003e\nto enumerate its members.",
"description":"Adds a HeldAccount to a hold. Accounts can only be added to a hold that\nhas no held_org_unit set. Attempting to add an account to an OU-based\nhold will result in an error.",
"description":"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.",
"description":"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.",
