Documentation
¶
Overview ¶
Package vault provides access to the Google Vault API.
For product documentation, see: https://developers.google.com/vault
Creating a client ¶
Usage example:
import "google.golang.org/api/vault/v1" ... ctx := context.Background() vaultService, err := vault.NewService(ctx)
In this example, Google Application Default Credentials are used for authentication.
For information on how to create and obtain Application Default Credentials, see https://developers.google.com/identity/protocols/application-default-credentials.
Other authentication options ¶
By default, all available scopes (see "Constants") are used to authenticate. To restrict scopes, use option.WithScopes:
vaultService, err := vault.NewService(ctx, option.WithScopes(vault.EdiscoveryReadonlyScope))
To use an API key for authentication (note: some APIs do not support API keys), use option.WithAPIKey:
vaultService, err := vault.NewService(ctx, option.WithAPIKey("AIza..."))
To use an OAuth token (e.g., a user token obtained via a three-legged OAuth flow), use option.WithTokenSource:
config := &oauth2.Config{...} // ... token, err := config.Exchange(ctx, ...) vaultService, err := vault.NewService(ctx, option.WithTokenSource(config.TokenSource(ctx, token)))
See https://godoc.org/google.golang.org/api/option/ for details on options.
Index ¶
- Constants
- type AccountCount
- type AccountCountError
- type AccountInfo
- type AddHeldAccountResult
- type AddHeldAccountsRequest
- type AddHeldAccountsResponse
- type AddMatterPermissionsRequest
- type CancelOperationRequest
- type CloseMatterRequest
- type CloseMatterResponse
- type CloudStorageFile
- type CloudStorageSink
- type CorpusQuery
- type CountArtifactsMetadata
- type CountArtifactsRequest
- type CountArtifactsResponse
- type DriveExportOptions
- type DriveOptions
- type Empty
- type Export
- type ExportOptions
- type ExportStats
- type GroupsCountResult
- type GroupsExportOptions
- type HangoutsChatExportOptions
- type HangoutsChatInfo
- type HangoutsChatOptions
- type HeldAccount
- type HeldDriveQuery
- type HeldGroupsQuery
- type HeldHangoutsChatQuery
- type HeldMailQuery
- type HeldOrgUnit
- type HeldVoiceQuery
- type Hold
- type ListExportsResponse
- type ListHeldAccountsResponse
- type ListHoldsResponse
- type ListMattersResponse
- type ListOperationsResponse
- type ListSavedQueriesResponse
- type MailCountResult
- type MailExportOptions
- type MailOptions
- type Matter
- type MatterPermission
- type MattersAddPermissionsCall
- func (c *MattersAddPermissionsCall) Context(ctx context.Context) *MattersAddPermissionsCall
- func (c *MattersAddPermissionsCall) Do(opts ...googleapi.CallOption) (*MatterPermission, error)
- func (c *MattersAddPermissionsCall) Fields(s ...googleapi.Field) *MattersAddPermissionsCall
- func (c *MattersAddPermissionsCall) Header() http.Header
- type MattersCloseCall
- type MattersCountCall
- type MattersCreateCall
- type MattersDeleteCall
- type MattersExportsCreateCall
- func (c *MattersExportsCreateCall) Context(ctx context.Context) *MattersExportsCreateCall
- func (c *MattersExportsCreateCall) Do(opts ...googleapi.CallOption) (*Export, error)
- func (c *MattersExportsCreateCall) Fields(s ...googleapi.Field) *MattersExportsCreateCall
- func (c *MattersExportsCreateCall) Header() http.Header
- type MattersExportsDeleteCall
- func (c *MattersExportsDeleteCall) Context(ctx context.Context) *MattersExportsDeleteCall
- func (c *MattersExportsDeleteCall) Do(opts ...googleapi.CallOption) (*Empty, error)
- func (c *MattersExportsDeleteCall) Fields(s ...googleapi.Field) *MattersExportsDeleteCall
- func (c *MattersExportsDeleteCall) Header() http.Header
- type MattersExportsGetCall
- func (c *MattersExportsGetCall) Context(ctx context.Context) *MattersExportsGetCall
- func (c *MattersExportsGetCall) Do(opts ...googleapi.CallOption) (*Export, error)
- func (c *MattersExportsGetCall) Fields(s ...googleapi.Field) *MattersExportsGetCall
- func (c *MattersExportsGetCall) Header() http.Header
- func (c *MattersExportsGetCall) IfNoneMatch(entityTag string) *MattersExportsGetCall
- type MattersExportsListCall
- func (c *MattersExportsListCall) Context(ctx context.Context) *MattersExportsListCall
- func (c *MattersExportsListCall) Do(opts ...googleapi.CallOption) (*ListExportsResponse, error)
- func (c *MattersExportsListCall) Fields(s ...googleapi.Field) *MattersExportsListCall
- func (c *MattersExportsListCall) Header() http.Header
- func (c *MattersExportsListCall) IfNoneMatch(entityTag string) *MattersExportsListCall
- func (c *MattersExportsListCall) PageSize(pageSize int64) *MattersExportsListCall
- func (c *MattersExportsListCall) PageToken(pageToken string) *MattersExportsListCall
- func (c *MattersExportsListCall) Pages(ctx context.Context, f func(*ListExportsResponse) error) error
- type MattersExportsService
- func (r *MattersExportsService) Create(matterId string, export *Export) *MattersExportsCreateCall
- func (r *MattersExportsService) Delete(matterId string, exportId string) *MattersExportsDeleteCall
- func (r *MattersExportsService) Get(matterId string, exportId string) *MattersExportsGetCall
- func (r *MattersExportsService) List(matterId string) *MattersExportsListCall
- type MattersGetCall
- func (c *MattersGetCall) Context(ctx context.Context) *MattersGetCall
- func (c *MattersGetCall) Do(opts ...googleapi.CallOption) (*Matter, error)
- func (c *MattersGetCall) Fields(s ...googleapi.Field) *MattersGetCall
- func (c *MattersGetCall) Header() http.Header
- func (c *MattersGetCall) IfNoneMatch(entityTag string) *MattersGetCall
- func (c *MattersGetCall) View(view string) *MattersGetCall
- type MattersHoldsAccountsCreateCall
- func (c *MattersHoldsAccountsCreateCall) Context(ctx context.Context) *MattersHoldsAccountsCreateCall
- func (c *MattersHoldsAccountsCreateCall) Do(opts ...googleapi.CallOption) (*HeldAccount, error)
- func (c *MattersHoldsAccountsCreateCall) Fields(s ...googleapi.Field) *MattersHoldsAccountsCreateCall
- func (c *MattersHoldsAccountsCreateCall) Header() http.Header
- type MattersHoldsAccountsDeleteCall
- func (c *MattersHoldsAccountsDeleteCall) Context(ctx context.Context) *MattersHoldsAccountsDeleteCall
- func (c *MattersHoldsAccountsDeleteCall) Do(opts ...googleapi.CallOption) (*Empty, error)
- func (c *MattersHoldsAccountsDeleteCall) Fields(s ...googleapi.Field) *MattersHoldsAccountsDeleteCall
- func (c *MattersHoldsAccountsDeleteCall) Header() http.Header
- type MattersHoldsAccountsListCall
- func (c *MattersHoldsAccountsListCall) Context(ctx context.Context) *MattersHoldsAccountsListCall
- func (c *MattersHoldsAccountsListCall) Do(opts ...googleapi.CallOption) (*ListHeldAccountsResponse, error)
- func (c *MattersHoldsAccountsListCall) Fields(s ...googleapi.Field) *MattersHoldsAccountsListCall
- func (c *MattersHoldsAccountsListCall) Header() http.Header
- func (c *MattersHoldsAccountsListCall) IfNoneMatch(entityTag string) *MattersHoldsAccountsListCall
- type MattersHoldsAccountsService
- func (r *MattersHoldsAccountsService) Create(matterId string, holdId string, heldaccount *HeldAccount) *MattersHoldsAccountsCreateCall
- func (r *MattersHoldsAccountsService) Delete(matterId string, holdId string, accountId string) *MattersHoldsAccountsDeleteCall
- func (r *MattersHoldsAccountsService) List(matterId string, holdId string) *MattersHoldsAccountsListCall
- type MattersHoldsAddHeldAccountsCall
- func (c *MattersHoldsAddHeldAccountsCall) Context(ctx context.Context) *MattersHoldsAddHeldAccountsCall
- func (c *MattersHoldsAddHeldAccountsCall) Do(opts ...googleapi.CallOption) (*AddHeldAccountsResponse, error)
- func (c *MattersHoldsAddHeldAccountsCall) Fields(s ...googleapi.Field) *MattersHoldsAddHeldAccountsCall
- func (c *MattersHoldsAddHeldAccountsCall) Header() http.Header
- type MattersHoldsCreateCall
- func (c *MattersHoldsCreateCall) Context(ctx context.Context) *MattersHoldsCreateCall
- func (c *MattersHoldsCreateCall) Do(opts ...googleapi.CallOption) (*Hold, error)
- func (c *MattersHoldsCreateCall) Fields(s ...googleapi.Field) *MattersHoldsCreateCall
- func (c *MattersHoldsCreateCall) Header() http.Header
- type MattersHoldsDeleteCall
- func (c *MattersHoldsDeleteCall) Context(ctx context.Context) *MattersHoldsDeleteCall
- func (c *MattersHoldsDeleteCall) Do(opts ...googleapi.CallOption) (*Empty, error)
- func (c *MattersHoldsDeleteCall) Fields(s ...googleapi.Field) *MattersHoldsDeleteCall
- func (c *MattersHoldsDeleteCall) Header() http.Header
- type MattersHoldsGetCall
- func (c *MattersHoldsGetCall) Context(ctx context.Context) *MattersHoldsGetCall
- func (c *MattersHoldsGetCall) Do(opts ...googleapi.CallOption) (*Hold, error)
- func (c *MattersHoldsGetCall) Fields(s ...googleapi.Field) *MattersHoldsGetCall
- func (c *MattersHoldsGetCall) Header() http.Header
- func (c *MattersHoldsGetCall) IfNoneMatch(entityTag string) *MattersHoldsGetCall
- func (c *MattersHoldsGetCall) View(view string) *MattersHoldsGetCall
- type MattersHoldsListCall
- func (c *MattersHoldsListCall) Context(ctx context.Context) *MattersHoldsListCall
- func (c *MattersHoldsListCall) Do(opts ...googleapi.CallOption) (*ListHoldsResponse, error)
- func (c *MattersHoldsListCall) Fields(s ...googleapi.Field) *MattersHoldsListCall
- func (c *MattersHoldsListCall) Header() http.Header
- func (c *MattersHoldsListCall) IfNoneMatch(entityTag string) *MattersHoldsListCall
- func (c *MattersHoldsListCall) PageSize(pageSize int64) *MattersHoldsListCall
- func (c *MattersHoldsListCall) PageToken(pageToken string) *MattersHoldsListCall
- func (c *MattersHoldsListCall) Pages(ctx context.Context, f func(*ListHoldsResponse) error) error
- func (c *MattersHoldsListCall) View(view string) *MattersHoldsListCall
- type MattersHoldsRemoveHeldAccountsCall
- func (c *MattersHoldsRemoveHeldAccountsCall) Context(ctx context.Context) *MattersHoldsRemoveHeldAccountsCall
- func (c *MattersHoldsRemoveHeldAccountsCall) Do(opts ...googleapi.CallOption) (*RemoveHeldAccountsResponse, error)
- func (c *MattersHoldsRemoveHeldAccountsCall) Fields(s ...googleapi.Field) *MattersHoldsRemoveHeldAccountsCall
- func (c *MattersHoldsRemoveHeldAccountsCall) Header() http.Header
- type MattersHoldsService
- func (r *MattersHoldsService) AddHeldAccounts(matterId string, holdId string, addheldaccountsrequest *AddHeldAccountsRequest) *MattersHoldsAddHeldAccountsCall
- func (r *MattersHoldsService) Create(matterId string, hold *Hold) *MattersHoldsCreateCall
- func (r *MattersHoldsService) Delete(matterId string, holdId string) *MattersHoldsDeleteCall
- func (r *MattersHoldsService) Get(matterId string, holdId string) *MattersHoldsGetCall
- func (r *MattersHoldsService) List(matterId string) *MattersHoldsListCall
- func (r *MattersHoldsService) RemoveHeldAccounts(matterId string, holdId string, ...) *MattersHoldsRemoveHeldAccountsCall
- func (r *MattersHoldsService) Update(matterId string, holdId string, hold *Hold) *MattersHoldsUpdateCall
- type MattersHoldsUpdateCall
- func (c *MattersHoldsUpdateCall) Context(ctx context.Context) *MattersHoldsUpdateCall
- func (c *MattersHoldsUpdateCall) Do(opts ...googleapi.CallOption) (*Hold, error)
- func (c *MattersHoldsUpdateCall) Fields(s ...googleapi.Field) *MattersHoldsUpdateCall
- func (c *MattersHoldsUpdateCall) Header() http.Header
- type MattersListCall
- func (c *MattersListCall) Context(ctx context.Context) *MattersListCall
- func (c *MattersListCall) Do(opts ...googleapi.CallOption) (*ListMattersResponse, error)
- func (c *MattersListCall) Fields(s ...googleapi.Field) *MattersListCall
- func (c *MattersListCall) Header() http.Header
- func (c *MattersListCall) IfNoneMatch(entityTag string) *MattersListCall
- func (c *MattersListCall) PageSize(pageSize int64) *MattersListCall
- func (c *MattersListCall) PageToken(pageToken string) *MattersListCall
- func (c *MattersListCall) Pages(ctx context.Context, f func(*ListMattersResponse) error) error
- func (c *MattersListCall) State(state string) *MattersListCall
- func (c *MattersListCall) View(view string) *MattersListCall
- type MattersRemovePermissionsCall
- func (c *MattersRemovePermissionsCall) Context(ctx context.Context) *MattersRemovePermissionsCall
- func (c *MattersRemovePermissionsCall) Do(opts ...googleapi.CallOption) (*Empty, error)
- func (c *MattersRemovePermissionsCall) Fields(s ...googleapi.Field) *MattersRemovePermissionsCall
- func (c *MattersRemovePermissionsCall) Header() http.Header
- type MattersReopenCall
- type MattersSavedQueriesCreateCall
- func (c *MattersSavedQueriesCreateCall) Context(ctx context.Context) *MattersSavedQueriesCreateCall
- func (c *MattersSavedQueriesCreateCall) Do(opts ...googleapi.CallOption) (*SavedQuery, error)
- func (c *MattersSavedQueriesCreateCall) Fields(s ...googleapi.Field) *MattersSavedQueriesCreateCall
- func (c *MattersSavedQueriesCreateCall) Header() http.Header
- type MattersSavedQueriesDeleteCall
- func (c *MattersSavedQueriesDeleteCall) Context(ctx context.Context) *MattersSavedQueriesDeleteCall
- func (c *MattersSavedQueriesDeleteCall) Do(opts ...googleapi.CallOption) (*Empty, error)
- func (c *MattersSavedQueriesDeleteCall) Fields(s ...googleapi.Field) *MattersSavedQueriesDeleteCall
- func (c *MattersSavedQueriesDeleteCall) Header() http.Header
- type MattersSavedQueriesGetCall
- func (c *MattersSavedQueriesGetCall) Context(ctx context.Context) *MattersSavedQueriesGetCall
- func (c *MattersSavedQueriesGetCall) Do(opts ...googleapi.CallOption) (*SavedQuery, error)
- func (c *MattersSavedQueriesGetCall) Fields(s ...googleapi.Field) *MattersSavedQueriesGetCall
- func (c *MattersSavedQueriesGetCall) Header() http.Header
- func (c *MattersSavedQueriesGetCall) IfNoneMatch(entityTag string) *MattersSavedQueriesGetCall
- type MattersSavedQueriesListCall
- func (c *MattersSavedQueriesListCall) Context(ctx context.Context) *MattersSavedQueriesListCall
- func (c *MattersSavedQueriesListCall) Do(opts ...googleapi.CallOption) (*ListSavedQueriesResponse, error)
- func (c *MattersSavedQueriesListCall) Fields(s ...googleapi.Field) *MattersSavedQueriesListCall
- func (c *MattersSavedQueriesListCall) Header() http.Header
- func (c *MattersSavedQueriesListCall) IfNoneMatch(entityTag string) *MattersSavedQueriesListCall
- func (c *MattersSavedQueriesListCall) PageSize(pageSize int64) *MattersSavedQueriesListCall
- func (c *MattersSavedQueriesListCall) PageToken(pageToken string) *MattersSavedQueriesListCall
- func (c *MattersSavedQueriesListCall) Pages(ctx context.Context, f func(*ListSavedQueriesResponse) error) error
- type MattersSavedQueriesService
- func (r *MattersSavedQueriesService) Create(matterId string, savedquery *SavedQuery) *MattersSavedQueriesCreateCall
- func (r *MattersSavedQueriesService) Delete(matterId string, savedQueryId string) *MattersSavedQueriesDeleteCall
- func (r *MattersSavedQueriesService) Get(matterId string, savedQueryId string) *MattersSavedQueriesGetCall
- func (r *MattersSavedQueriesService) List(matterId string) *MattersSavedQueriesListCall
- type MattersService
- func (r *MattersService) AddPermissions(matterId string, addmatterpermissionsrequest *AddMatterPermissionsRequest) *MattersAddPermissionsCall
- func (r *MattersService) Close(matterId string, closematterrequest *CloseMatterRequest) *MattersCloseCall
- func (r *MattersService) Count(matterId string, countartifactsrequest *CountArtifactsRequest) *MattersCountCall
- func (r *MattersService) Create(matter *Matter) *MattersCreateCall
- func (r *MattersService) Delete(matterId string) *MattersDeleteCall
- func (r *MattersService) Get(matterId string) *MattersGetCall
- func (r *MattersService) List() *MattersListCall
- func (r *MattersService) RemovePermissions(matterId string, ...) *MattersRemovePermissionsCall
- func (r *MattersService) Reopen(matterId string, reopenmatterrequest *ReopenMatterRequest) *MattersReopenCall
- func (r *MattersService) Undelete(matterId string, undeletematterrequest *UndeleteMatterRequest) *MattersUndeleteCall
- func (r *MattersService) Update(matterId string, matter *Matter) *MattersUpdateCall
- type MattersUndeleteCall
- type MattersUpdateCall
- type Operation
- type OperationsCancelCall
- type OperationsDeleteCall
- type OperationsGetCall
- func (c *OperationsGetCall) Context(ctx context.Context) *OperationsGetCall
- func (c *OperationsGetCall) Do(opts ...googleapi.CallOption) (*Operation, error)
- func (c *OperationsGetCall) Fields(s ...googleapi.Field) *OperationsGetCall
- func (c *OperationsGetCall) Header() http.Header
- func (c *OperationsGetCall) IfNoneMatch(entityTag string) *OperationsGetCall
- type OperationsListCall
- func (c *OperationsListCall) Context(ctx context.Context) *OperationsListCall
- func (c *OperationsListCall) Do(opts ...googleapi.CallOption) (*ListOperationsResponse, error)
- func (c *OperationsListCall) Fields(s ...googleapi.Field) *OperationsListCall
- func (c *OperationsListCall) Filter(filter string) *OperationsListCall
- func (c *OperationsListCall) Header() http.Header
- func (c *OperationsListCall) IfNoneMatch(entityTag string) *OperationsListCall
- func (c *OperationsListCall) PageSize(pageSize int64) *OperationsListCall
- func (c *OperationsListCall) PageToken(pageToken string) *OperationsListCall
- func (c *OperationsListCall) Pages(ctx context.Context, f func(*ListOperationsResponse) error) error
- type OperationsService
- func (r *OperationsService) Cancel(name string, canceloperationrequest *CancelOperationRequest) *OperationsCancelCall
- func (r *OperationsService) Delete(name string) *OperationsDeleteCall
- func (r *OperationsService) Get(name string) *OperationsGetCall
- func (r *OperationsService) List(name string) *OperationsListCall
- type OrgUnitInfo
- type Query
- type RemoveHeldAccountsRequest
- type RemoveHeldAccountsResponse
- type RemoveMatterPermissionsRequest
- type ReopenMatterRequest
- type ReopenMatterResponse
- type SavedQuery
- type Service
- type SharedDriveInfo
- type Status
- type TeamDriveInfo
- type UndeleteMatterRequest
- type UserInfo
- type VoiceExportOptions
- type VoiceOptions
Constants ¶
const ( // Manage your eDiscovery data EdiscoveryScope = "https://www.googleapis.com/auth/ediscovery" // View your eDiscovery data EdiscoveryReadonlyScope = "https://www.googleapis.com/auth/ediscovery.readonly" )
OAuth2 scopes used by this API.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type AccountCount ¶ added in v0.34.0
type AccountCount struct { // Account: Account owner. Account *UserInfo `json:"account,omitempty"` // Count: The number of results (messages or files) found for this // account. Count int64 `json:"count,omitempty,string"` // ForceSendFields is a list of field names (e.g. "Account") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "Account") to include in // API requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
AccountCount: The results count for each account.
func (*AccountCount) MarshalJSON ¶ added in v0.34.0
func (s *AccountCount) MarshalJSON() ([]byte, error)
type AccountCountError ¶ added in v0.34.0
type AccountCountError struct { // Account: Account owner. Account *UserInfo `json:"account,omitempty"` // ErrorType: Account query error. // // Possible values: // "ERROR_TYPE_UNSPECIFIED" - Default. // "WILDCARD_TOO_BROAD" - Permanent - prefix terms expanded to too // many query terms. // "TOO_MANY_TERMS" - Permanent - query contains too many terms. // "LOCATION_UNAVAILABLE" - Transient - data in transit between // storage replicas, temporarily unavailable. // "UNKNOWN" - Unrecognized error. // "DEADLINE_EXCEEDED" - Deadline exceeded when querying the account. ErrorType string `json:"errorType,omitempty"` // ForceSendFields is a list of field names (e.g. "Account") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "Account") to include in // API requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
AccountCountError: An error that occurred when querying a specific account
func (*AccountCountError) MarshalJSON ¶ added in v0.34.0
func (s *AccountCountError) MarshalJSON() ([]byte, error)
type AccountInfo ¶
type AccountInfo struct { // Emails: A set of accounts to search. Emails []string `json:"emails,omitempty"` // ForceSendFields is a list of field names (e.g. "Emails") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "Emails") to include in API // requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
AccountInfo: The accounts to search
func (*AccountInfo) MarshalJSON ¶
func (s *AccountInfo) MarshalJSON() ([]byte, error)
type AddHeldAccountResult ¶
type AddHeldAccountResult struct { // Account: Returned when the account was successfully created. Account *HeldAccount `json:"account,omitempty"` // Status: Reports the request status. If it failed, returns an error // message. Status *Status `json:"status,omitempty"` // ForceSendFields is a list of field names (e.g. "Account") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "Account") to include in // API requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
AddHeldAccountResult: The status of each account creation, and the **HeldAccount**, if successful.
func (*AddHeldAccountResult) MarshalJSON ¶
func (s *AddHeldAccountResult) MarshalJSON() ([]byte, error)
type AddHeldAccountsRequest ¶
type AddHeldAccountsRequest struct { // AccountIds: A comma-separated list of the account IDs of the accounts // to add to the hold. Specify either **emails** or **account_ids**, but // not both. AccountIds []string `json:"accountIds,omitempty"` // Emails: A comma-separated list of the emails of the accounts to add // to the hold. Specify either **emails** or **account_ids**, but not // both. Emails []string `json:"emails,omitempty"` // ForceSendFields is a list of field names (e.g. "AccountIds") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "AccountIds") to include in // API requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
AddHeldAccountsRequest: Add a list of accounts to a hold.
func (*AddHeldAccountsRequest) MarshalJSON ¶
func (s *AddHeldAccountsRequest) MarshalJSON() ([]byte, error)
type AddHeldAccountsResponse ¶
type AddHeldAccountsResponse struct { // Responses: The list of responses, in the same order as the batch // request. Responses []*AddHeldAccountResult `json:"responses,omitempty"` // ServerResponse contains the HTTP response code and headers from the // server. googleapi.ServerResponse `json:"-"` // ForceSendFields is a list of field names (e.g. "Responses") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "Responses") to include in // API requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
AddHeldAccountsResponse: Response for batch create held accounts.
func (*AddHeldAccountsResponse) MarshalJSON ¶
func (s *AddHeldAccountsResponse) MarshalJSON() ([]byte, error)
type AddMatterPermissionsRequest ¶
type AddMatterPermissionsRequest struct { // CcMe: Only relevant if **sendEmails** is **true**. To CC the // requestor in the email message, set to **true**. To not CC requestor, // set to **false**. CcMe bool `json:"ccMe,omitempty"` // MatterPermission: The account and its role to add. MatterPermission *MatterPermission `json:"matterPermission,omitempty"` // SendEmails: To send a notification email to the added account, set to // **true**. To not send a notification email, set to **false**. SendEmails bool `json:"sendEmails,omitempty"` // ForceSendFields is a list of field names (e.g. "CcMe") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "CcMe") to include in API // requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
AddMatterPermissionsRequest: Add an account with the permission specified. The role cannot be owner. If an account already has a role in the matter, the existing role is overwritten.
func (*AddMatterPermissionsRequest) MarshalJSON ¶
func (s *AddMatterPermissionsRequest) MarshalJSON() ([]byte, error)
type CancelOperationRequest ¶ added in v0.34.0
type CancelOperationRequest struct { }
CancelOperationRequest: The request message for Operations.CancelOperation.
type CloseMatterRequest ¶
type CloseMatterRequest struct { }
CloseMatterRequest: Close a matter by ID.
type CloseMatterResponse ¶
type CloseMatterResponse struct { // Matter: The updated matter, with state **CLOSED**. Matter *Matter `json:"matter,omitempty"` // ServerResponse contains the HTTP response code and headers from the // server. googleapi.ServerResponse `json:"-"` // ForceSendFields is a list of field names (e.g. "Matter") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "Matter") to include in API // requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
CloseMatterResponse: Response to a CloseMatterRequest.
func (*CloseMatterResponse) MarshalJSON ¶
func (s *CloseMatterResponse) MarshalJSON() ([]byte, error)
type CloudStorageFile ¶
type CloudStorageFile struct { // BucketName: The name of the Cloud Storage bucket for the export file. // You can use this value in the Cloud Storage JSON or XML APIs // (https://cloud.google.com/storage/docs/apis), but not to list the // bucket contents. Instead, you can get individual export files // (https://cloud.google.com/storage/docs/json_api/v1/objects/get) by // object name. BucketName string `json:"bucketName,omitempty"` // Md5Hash: The md5 hash of the file. Md5Hash string `json:"md5Hash,omitempty"` // ObjectName: The name of the Cloud Storage object for the export file. // You can use this value in the Cloud Storage JSON or XML APIs // (https://cloud.google.com/storage/docs/apis). ObjectName string `json:"objectName,omitempty"` // Size: The export file size. Size int64 `json:"size,omitempty,string"` // ForceSendFields is a list of field names (e.g. "BucketName") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "BucketName") to include in // API requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
CloudStorageFile: The export file in Cloud Storage
func (*CloudStorageFile) MarshalJSON ¶
func (s *CloudStorageFile) MarshalJSON() ([]byte, error)
type CloudStorageSink ¶
type CloudStorageSink struct { // Files: Output only. The exported files in Cloud Storage. Files []*CloudStorageFile `json:"files,omitempty"` // ForceSendFields is a list of field names (e.g. "Files") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "Files") to include in API // requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
CloudStorageSink: Export sink for Cloud Storage files.
func (*CloudStorageSink) MarshalJSON ¶
func (s *CloudStorageSink) MarshalJSON() ([]byte, error)
type CorpusQuery ¶
type CorpusQuery struct { // DriveQuery: Service-specific options for Drive holds. If set, // **CorpusType** must be **DRIVE**. DriveQuery *HeldDriveQuery `json:"driveQuery,omitempty"` // GroupsQuery: Service-specific options for Groups holds. If set, // **CorpusType** must be **GROUPS**. GroupsQuery *HeldGroupsQuery `json:"groupsQuery,omitempty"` // HangoutsChatQuery: Service-specific options for Chat holds. If set, // **CorpusType** must be **HANGOUTS_CHAT**. HangoutsChatQuery *HeldHangoutsChatQuery `json:"hangoutsChatQuery,omitempty"` // MailQuery: Service-specific options for Gmail holds. If set, // **CorpusType** must be **MAIL**. MailQuery *HeldMailQuery `json:"mailQuery,omitempty"` // VoiceQuery: Service-specific options for Voice holds. If set, // **CorpusType** must be **VOICE**. VoiceQuery *HeldVoiceQuery `json:"voiceQuery,omitempty"` // ForceSendFields is a list of field names (e.g. "DriveQuery") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "DriveQuery") to include in // API requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
CorpusQuery: Service-specific options for holds.
func (*CorpusQuery) MarshalJSON ¶
func (s *CorpusQuery) MarshalJSON() ([]byte, error)
type CountArtifactsMetadata ¶ added in v0.34.0
type CountArtifactsMetadata struct { // EndTime: End time of count operation. Available when operation is // done. EndTime string `json:"endTime,omitempty"` // MatterId: The matter ID of the associated matter. MatterId string `json:"matterId,omitempty"` // Query: The search query from the request. Query *Query `json:"query,omitempty"` // StartTime: Creation time of count operation. StartTime string `json:"startTime,omitempty"` // ForceSendFields is a list of field names (e.g. "EndTime") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "EndTime") to include in // API requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
CountArtifactsMetadata: Long running operation metadata for CountArtifacts.
func (*CountArtifactsMetadata) MarshalJSON ¶ added in v0.34.0
func (s *CountArtifactsMetadata) MarshalJSON() ([]byte, error)
type CountArtifactsRequest ¶ added in v0.34.0
type CountArtifactsRequest struct { // Query: The search query. Query *Query `json:"query,omitempty"` // View: Sets the granularity of the count results. // // Possible values: // "COUNT_RESULT_VIEW_UNSPECIFIED" - Default. Same as **TOTAL_COUNT**. // "TOTAL_COUNT" - Response includes counts of the total accounts, // queried accounts, matching accounts, non-queryable accounts, and // queried account errors. // "ALL" - Response includes the same details as **TOTAL_COUNT**, plus // additional account breakdown. View string `json:"view,omitempty"` // ForceSendFields is a list of field names (e.g. "Query") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "Query") to include in API // requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
CountArtifactsRequest: Count artifacts request.
func (*CountArtifactsRequest) MarshalJSON ¶ added in v0.34.0
func (s *CountArtifactsRequest) MarshalJSON() ([]byte, error)
type CountArtifactsResponse ¶ added in v0.34.0
type CountArtifactsResponse struct { // GroupsCountResult: Count metrics for Groups. GroupsCountResult *GroupsCountResult `json:"groupsCountResult,omitempty"` // MailCountResult: Count metrics for Gmail and classic Hangouts. MailCountResult *MailCountResult `json:"mailCountResult,omitempty"` // TotalCount: Total count of messages. TotalCount int64 `json:"totalCount,omitempty,string"` // ForceSendFields is a list of field names (e.g. "GroupsCountResult") // to unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "GroupsCountResult") to // include in API requests with the JSON null value. By default, fields // with empty values are omitted from API requests. However, any field // with an empty value appearing in NullFields will be sent to the // server as null. It is an error if a field in this list has a // non-empty value. This may be used to include null fields in Patch // requests. NullFields []string `json:"-"` }
CountArtifactsResponse: Definition of the response for method CountArtifacts.
func (*CountArtifactsResponse) MarshalJSON ¶ added in v0.34.0
func (s *CountArtifactsResponse) MarshalJSON() ([]byte, error)
type DriveExportOptions ¶
type DriveExportOptions struct { // IncludeAccessInfo: To include access level information for users with // indirect access // (https://support.google.com/vault/answer/6099459#metadata) to files, // set to **true**. IncludeAccessInfo bool `json:"includeAccessInfo,omitempty"` // ForceSendFields is a list of field names (e.g. "IncludeAccessInfo") // to unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "IncludeAccessInfo") to // include in API requests with the JSON null value. By default, fields // with empty values are omitted from API requests. However, any field // with an empty value appearing in NullFields will be sent to the // server as null. It is an error if a field in this list has a // non-empty value. This may be used to include null fields in Patch // requests. NullFields []string `json:"-"` }
DriveExportOptions: Options for Drive exports.
func (*DriveExportOptions) MarshalJSON ¶
func (s *DriveExportOptions) MarshalJSON() ([]byte, error)
type DriveOptions ¶
type DriveOptions struct { bool `json:"includeSharedDrives,omitempty"` // IncludeTeamDrives: Set to true to include Team Drive. IncludeTeamDrives bool `json:"includeTeamDrives,omitempty"` // VersionDate: Search the current version of the Drive file, but export // the contents of the last version saved before 12:00 AM UTC on the // specified date. Enter the date in UTC. VersionDate string `json:"versionDate,omitempty"` // ForceSendFields is a list of field names (e.g. "IncludeSharedDrives") // to unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "IncludeSharedDrives") to // include in API requests with the JSON null value. By default, fields // with empty values are omitted from API requests. However, any field // with an empty value appearing in NullFields will be sent to the // server as null. It is an error if a field in this list has a // non-empty value. This may be used to include null fields in Patch // requests. NullFields []string `json:"-"` }IncludeSharedDrives
DriveOptions: Additional options for Drive search
func (*DriveOptions) MarshalJSON ¶
func (s *DriveOptions) MarshalJSON() ([]byte, error)
type Empty ¶
type Empty struct { // ServerResponse contains the HTTP response code and headers from the // server. googleapi.ServerResponse `json:"-"` }
Empty: 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 `{}`.
type Export ¶
type Export struct { // CloudStorageSink: Output only. The sink for export files in Cloud // Storage. CloudStorageSink *CloudStorageSink `json:"cloudStorageSink,omitempty"` // CreateTime: Output only. The time when the export was created. CreateTime string `json:"createTime,omitempty"` // ExportOptions: Additional export options. ExportOptions *ExportOptions `json:"exportOptions,omitempty"` // Id: Output only. The generated export ID. Id string `json:"id,omitempty"` // MatterId: Output only. The matter ID. MatterId string `json:"matterId,omitempty"` // Name: The export name. Name string `json:"name,omitempty"` // Query: The query parameters used to create the export. Query *Query `json:"query,omitempty"` // Requester: Output only. The requester of the export. Requester *UserInfo `json:"requester,omitempty"` // Stats: Output only. Details about the export progress and size. Stats *ExportStats `json:"stats,omitempty"` // Status: Output only. The status of the export. // // Possible values: // "EXPORT_STATUS_UNSPECIFIED" - The status is unspecified. // "COMPLETED" - The export completed. // "FAILED" - The export failed. // "IN_PROGRESS" - The export is in progress. Status string `json:"status,omitempty"` // ServerResponse contains the HTTP response code and headers from the // server. googleapi.ServerResponse `json:"-"` // ForceSendFields is a list of field names (e.g. "CloudStorageSink") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "CloudStorageSink") to // include in API requests with the JSON null value. By default, fields // with empty values are omitted from API requests. However, any field // with an empty value appearing in NullFields will be sent to the // server as null. It is an error if a field in this list has a // non-empty value. This may be used to include null fields in Patch // requests. NullFields []string `json:"-"` }
Export: An export. To work with Vault resources, the account must have the required Vault privileges (https://support.google.com/vault/answer/2799699) and access to the matter. To access a matter, the account must have created the matter, have the matter shared with them, or have the **View All Matters** privilege.
func (*Export) MarshalJSON ¶
type ExportOptions ¶
type ExportOptions struct { // DriveOptions: Options for Drive exports. DriveOptions *DriveExportOptions `json:"driveOptions,omitempty"` // GroupsOptions: Options for Groups exports. GroupsOptions *GroupsExportOptions `json:"groupsOptions,omitempty"` // HangoutsChatOptions: Options for Chat exports. HangoutsChatOptions *HangoutsChatExportOptions `json:"hangoutsChatOptions,omitempty"` // MailOptions: Options for Gmail exports. MailOptions *MailExportOptions `json:"mailOptions,omitempty"` // Region: The requested data region for the export. // // Possible values: // "EXPORT_REGION_UNSPECIFIED" - The region is unspecified. Defaults // to ANY. // "ANY" - Any region. // "US" - United States region. // "EUROPE" - Europe region. Region string `json:"region,omitempty"` // VoiceOptions: Options for Voice exports. VoiceOptions *VoiceExportOptions `json:"voiceOptions,omitempty"` // ForceSendFields is a list of field names (e.g. "DriveOptions") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "DriveOptions") to include // in API requests with the JSON null value. By default, fields with // empty values are omitted from API requests. However, any field with // an empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
ExportOptions: Additional options for exports
func (*ExportOptions) MarshalJSON ¶
func (s *ExportOptions) MarshalJSON() ([]byte, error)
type ExportStats ¶
type ExportStats struct { // ExportedArtifactCount: The number of messages or files already // processed for export. ExportedArtifactCount int64 `json:"exportedArtifactCount,omitempty,string"` // SizeInBytes: The size of export in bytes. SizeInBytes int64 `json:"sizeInBytes,omitempty,string"` // TotalArtifactCount: The number of messages or files to be exported. TotalArtifactCount int64 `json:"totalArtifactCount,omitempty,string"` // ForceSendFields is a list of field names (e.g. // "ExportedArtifactCount") to unconditionally include in API requests. // By default, fields with empty or default values are omitted from API // requests. However, any non-pointer, non-interface field appearing in // ForceSendFields will be sent to the server regardless of whether the // field is empty or not. This may be used to include empty fields in // Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "ExportedArtifactCount") to // include in API requests with the JSON null value. By default, fields // with empty values are omitted from API requests. However, any field // with an empty value appearing in NullFields will be sent to the // server as null. It is an error if a field in this list has a // non-empty value. This may be used to include null fields in Patch // requests. NullFields []string `json:"-"` }
ExportStats: Progress information for an export.
func (*ExportStats) MarshalJSON ¶
func (s *ExportStats) MarshalJSON() ([]byte, error)
type GroupsCountResult ¶ added in v0.34.0
type GroupsCountResult struct { // AccountCountErrors: Error occurred when querying these accounts. AccountCountErrors []*AccountCountError `json:"accountCountErrors,omitempty"` // AccountCounts: Subtotal count per matching account that have more // than zero messages. AccountCounts []*AccountCount `json:"accountCounts,omitempty"` // MatchingAccountsCount: Total number of accounts that can be queried // and have more than zero messages. MatchingAccountsCount int64 `json:"matchingAccountsCount,omitempty,string"` // NonQueryableAccounts: When **DataScope** is **HELD_DATA**, these // accounts in the request are not queried because they are not on hold. // For other data scope, this field is not set. NonQueryableAccounts []string `json:"nonQueryableAccounts,omitempty"` // QueriedAccountsCount: Total number of accounts involved in this count // operation. QueriedAccountsCount int64 `json:"queriedAccountsCount,omitempty,string"` // ForceSendFields is a list of field names (e.g. "AccountCountErrors") // to unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "AccountCountErrors") to // include in API requests with the JSON null value. By default, fields // with empty values are omitted from API requests. However, any field // with an empty value appearing in NullFields will be sent to the // server as null. It is an error if a field in this list has a // non-empty value. This may be used to include null fields in Patch // requests. NullFields []string `json:"-"` }
GroupsCountResult: Groups specific count metrics.
func (*GroupsCountResult) MarshalJSON ¶ added in v0.34.0
func (s *GroupsCountResult) MarshalJSON() ([]byte, error)
type GroupsExportOptions ¶
type GroupsExportOptions struct { // ExportFormat: The file format for exported messages. // // Possible values: // "EXPORT_FORMAT_UNSPECIFIED" - No export format specified. // "MBOX" - Export as MBOX. // "PST" - Export as PST. ExportFormat string `json:"exportFormat,omitempty"` // ForceSendFields is a list of field names (e.g. "ExportFormat") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "ExportFormat") to include // in API requests with the JSON null value. By default, fields with // empty values are omitted from API requests. However, any field with // an empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
GroupsExportOptions: Options for Groups exports.
func (*GroupsExportOptions) MarshalJSON ¶
func (s *GroupsExportOptions) MarshalJSON() ([]byte, error)
type HangoutsChatExportOptions ¶
type HangoutsChatExportOptions struct { // ExportFormat: The file format for exported messages. // // Possible values: // "EXPORT_FORMAT_UNSPECIFIED" - No export format specified. // "MBOX" - Export as MBOX. // "PST" - Export as PST. ExportFormat string `json:"exportFormat,omitempty"` // ForceSendFields is a list of field names (e.g. "ExportFormat") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "ExportFormat") to include // in API requests with the JSON null value. By default, fields with // empty values are omitted from API requests. However, any field with // an empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
HangoutsChatExportOptions: Options for Chat exports.
func (*HangoutsChatExportOptions) MarshalJSON ¶
func (s *HangoutsChatExportOptions) MarshalJSON() ([]byte, error)
type HangoutsChatInfo ¶
type HangoutsChatInfo struct { // RoomId: A list of Chat spaces IDs, as provided by the Chat API // (https://developers.google.com/hangouts/chat). RoomId []string `json:"roomId,omitempty"` // ForceSendFields is a list of field names (e.g. "RoomId") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "RoomId") to include in API // requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
HangoutsChatInfo: The Chat spaces to search
func (*HangoutsChatInfo) MarshalJSON ¶
func (s *HangoutsChatInfo) MarshalJSON() ([]byte, error)
type HangoutsChatOptions ¶
type HangoutsChatOptions struct { // IncludeRooms: For searches by account or organizational unit, set to // **true** to include rooms. IncludeRooms bool `json:"includeRooms,omitempty"` // ForceSendFields is a list of field names (e.g. "IncludeRooms") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "IncludeRooms") to include // in API requests with the JSON null value. By default, fields with // empty values are omitted from API requests. However, any field with // an empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
HangoutsChatOptions: Additional options for Google Chat search
func (*HangoutsChatOptions) MarshalJSON ¶
func (s *HangoutsChatOptions) MarshalJSON() ([]byte, error)
type HeldAccount ¶
type HeldAccount struct { // AccountId: The account ID, as provided by the Admin SDK // (https://developers.google.com/admin-sdk/). AccountId string `json:"accountId,omitempty"` // Email: The primary email address of the account. If used as an input, // this takes precedence over **accountId**. Email string `json:"email,omitempty"` // FirstName: Output only. The first name of the account holder. FirstName string `json:"firstName,omitempty"` // HoldTime: Output only. When the account was put on hold. HoldTime string `json:"holdTime,omitempty"` // LastName: Output only. The last name of the account holder. LastName string `json:"lastName,omitempty"` // ServerResponse contains the HTTP response code and headers from the // server. googleapi.ServerResponse `json:"-"` // ForceSendFields is a list of field names (e.g. "AccountId") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "AccountId") to include in // API requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
HeldAccount: An account covered by a hold. This structure is immutable. It can be an individual account or a Google Group, depending on the service. To work with Vault resources, the account must have the [required Vault privileges] (https://support.google.com/vault/answer/2799699) and access to the matter. To access a matter, the account must have created the matter, have the matter shared with them, or have the **View All Matters** privilege.
func (*HeldAccount) MarshalJSON ¶
func (s *HeldAccount) MarshalJSON() ([]byte, error)
type HeldDriveQuery ¶
type HeldDriveQuery struct { // hold, set to **true**. IncludeSharedDriveFiles bool `json:"includeSharedDriveFiles,omitempty"` // IncludeTeamDriveFiles: To include files in Team Drives in the hold, // set to **true**. IncludeTeamDriveFiles bool `json:"includeTeamDriveFiles,omitempty"` // ForceSendFields is a list of field names (e.g. // "IncludeSharedDriveFiles") to unconditionally include in API // requests. By default, fields with empty or default values are omitted // from API requests. However, any non-pointer, non-interface field // appearing in ForceSendFields will be sent to the server regardless of // whether the field is empty or not. This may be used to include empty // fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "IncludeSharedDriveFiles") // to include in API requests with the JSON null value. By default, // fields with empty values are omitted from API requests. However, any // field with an empty value appearing in NullFields will be sent to the // server as null. It is an error if a field in this list has a // non-empty value. This may be used to include null fields in Patch // requests. NullFields []string `json:"-"` }
HeldDriveQuery: Options for Drive holds.
func (*HeldDriveQuery) MarshalJSON ¶
func (s *HeldDriveQuery) MarshalJSON() ([]byte, error)
type HeldGroupsQuery ¶
type HeldGroupsQuery struct { // EndTime: The end time for the query. Specify in GMT. The value is // rounded to 12 AM on the specified date. EndTime string `json:"endTime,omitempty"` // StartTime: The start time for the query. Specify in GMT. The value is // rounded to 12 AM on the specified date. StartTime string `json:"startTime,omitempty"` // Terms: The search operators // (https://support.google.com/vault/answer/2474474) used to refine the // messages covered by the hold. Terms string `json:"terms,omitempty"` // ForceSendFields is a list of field names (e.g. "EndTime") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "EndTime") to include in // API requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
HeldGroupsQuery: Query options for group holds.
func (*HeldGroupsQuery) MarshalJSON ¶
func (s *HeldGroupsQuery) MarshalJSON() ([]byte, error)
type HeldHangoutsChatQuery ¶
type HeldHangoutsChatQuery struct { // IncludeRooms: To include messages in Chat spaces the user was a // member of, set to **true**. IncludeRooms bool `json:"includeRooms,omitempty"` // ForceSendFields is a list of field names (e.g. "IncludeRooms") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "IncludeRooms") to include // in API requests with the JSON null value. By default, fields with // empty values are omitted from API requests. However, any field with // an empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
HeldHangoutsChatQuery: Options for Chat holds.
func (*HeldHangoutsChatQuery) MarshalJSON ¶
func (s *HeldHangoutsChatQuery) MarshalJSON() ([]byte, error)
type HeldMailQuery ¶
type HeldMailQuery struct { // EndTime: The end time for the query. Specify in GMT. The value is // rounded to 12 AM on the specified date. EndTime string `json:"endTime,omitempty"` // StartTime: The start time for the query. Specify in GMT. The value is // rounded to 12 AM on the specified date. StartTime string `json:"startTime,omitempty"` // Terms: The search operators // (https://support.google.com/vault/answer/2474474) used to refine the // messages covered by the hold. Terms string `json:"terms,omitempty"` // ForceSendFields is a list of field names (e.g. "EndTime") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "EndTime") to include in // API requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
HeldMailQuery: Query options for Gmail holds.
func (*HeldMailQuery) MarshalJSON ¶
func (s *HeldMailQuery) MarshalJSON() ([]byte, error)
type HeldOrgUnit ¶
type HeldOrgUnit struct { // HoldTime: When the organizational unit was put on hold. This property // is immutable. HoldTime string `json:"holdTime,omitempty"` // OrgUnitId: The organizational unit's immutable ID as provided by the // Admin SDK (https://developers.google.com/admin-sdk/). OrgUnitId string `json:"orgUnitId,omitempty"` // ForceSendFields is a list of field names (e.g. "HoldTime") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "HoldTime") to include in // API requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
HeldOrgUnit: The organizational unit covered by a hold. This structure is immutable.
func (*HeldOrgUnit) MarshalJSON ¶
func (s *HeldOrgUnit) MarshalJSON() ([]byte, error)
type HeldVoiceQuery ¶ added in v0.36.0
type HeldVoiceQuery struct { // CoveredData: A list of data types covered by the hold. Should be // non-empty. Order does not matter and duplicates are ignored. // // Possible values: // "COVERED_DATA_UNSPECIFIED" - Covered data unspecified. // "TEXT_MESSAGES" - Voice text messages. // "VOICEMAILS" - Voicemails and their transcripts. // "CALL_LOGS" - Call logs. CoveredData []string `json:"coveredData,omitempty"` // ForceSendFields is a list of field names (e.g. "CoveredData") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "CoveredData") to include // in API requests with the JSON null value. By default, fields with // empty values are omitted from API requests. However, any field with // an empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
HeldVoiceQuery: Options for Voice holds.
func (*HeldVoiceQuery) MarshalJSON ¶ added in v0.36.0
func (s *HeldVoiceQuery) MarshalJSON() ([]byte, error)
type Hold ¶
type Hold struct { // Accounts: If set, the hold applies to the specified accounts and // **orgUnit** must be empty. Accounts []*HeldAccount `json:"accounts,omitempty"` // Corpus: The service to be searched. // // Possible values: // "CORPUS_TYPE_UNSPECIFIED" - No service specified. // "DRIVE" - Drive, including Meet and Sites. // "MAIL" - For search, Gmail and classic Hangouts. For holds, Gmail // only. // "GROUPS" - Groups. // "HANGOUTS_CHAT" - For search, Google Chat only. For holds, Google // Chat and classic Hangouts. // "VOICE" - Google Voice. Corpus string `json:"corpus,omitempty"` // HoldId: The unique immutable ID of the hold. Assigned during // creation. HoldId string `json:"holdId,omitempty"` // Name: The name of the hold. Name string `json:"name,omitempty"` // OrgUnit: If set, the hold applies to all members of the // organizational unit and **accounts** must be empty. This property is // mutable. For Groups holds, set **accounts**. OrgUnit *HeldOrgUnit `json:"orgUnit,omitempty"` // Query: Service-specific options. If set, **CorpusQuery** must match // **CorpusType**. Query *CorpusQuery `json:"query,omitempty"` // UpdateTime: The last time this hold was modified. UpdateTime string `json:"updateTime,omitempty"` // ServerResponse contains the HTTP response code and headers from the // server. googleapi.ServerResponse `json:"-"` // ForceSendFields is a list of field names (e.g. "Accounts") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "Accounts") to include in // API requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
Hold: A hold. A hold prevents the specified Google Workspace service from purging data for specific accounts or all members of an organizational unit. To work with Vault resources, the account must have the [required Vault privileges] (https://support.google.com/vault/answer/2799699) and access to the matter. To access a matter, the account must have created the matter, have the matter shared with them, or have the **View All Matters** privilege.
func (*Hold) MarshalJSON ¶
type ListExportsResponse ¶
type ListExportsResponse struct { // Exports: The list of exports. Exports []*Export `json:"exports,omitempty"` // NextPageToken: Page token to retrieve the next page of results in the // list. NextPageToken string `json:"nextPageToken,omitempty"` // ServerResponse contains the HTTP response code and headers from the // server. googleapi.ServerResponse `json:"-"` // ForceSendFields is a list of field names (e.g. "Exports") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "Exports") to include in // API requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
ListExportsResponse: The exports for a matter.
func (*ListExportsResponse) MarshalJSON ¶
func (s *ListExportsResponse) MarshalJSON() ([]byte, error)
type ListHeldAccountsResponse ¶
type ListHeldAccountsResponse struct { // Accounts: The held accounts on a hold. Accounts []*HeldAccount `json:"accounts,omitempty"` // ServerResponse contains the HTTP response code and headers from the // server. googleapi.ServerResponse `json:"-"` // ForceSendFields is a list of field names (e.g. "Accounts") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "Accounts") to include in // API requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
ListHeldAccountsResponse: Returns a list of the accounts covered by a hold.
func (*ListHeldAccountsResponse) MarshalJSON ¶
func (s *ListHeldAccountsResponse) MarshalJSON() ([]byte, error)
type ListHoldsResponse ¶
type ListHoldsResponse struct { // Holds: The list of holds. Holds []*Hold `json:"holds,omitempty"` // NextPageToken: Page token to retrieve the next page of results in the // list. If this is empty, then there are no more holds to list. NextPageToken string `json:"nextPageToken,omitempty"` // ServerResponse contains the HTTP response code and headers from the // server. googleapi.ServerResponse `json:"-"` // ForceSendFields is a list of field names (e.g. "Holds") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "Holds") to include in API // requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
ListHoldsResponse: The holds for a matter.
func (*ListHoldsResponse) MarshalJSON ¶
func (s *ListHoldsResponse) MarshalJSON() ([]byte, error)
type ListMattersResponse ¶
type ListMattersResponse struct { // Matters: List of matters. Matters []*Matter `json:"matters,omitempty"` // NextPageToken: Page token to retrieve the next page of results in the // list. NextPageToken string `json:"nextPageToken,omitempty"` // ServerResponse contains the HTTP response code and headers from the // server. googleapi.ServerResponse `json:"-"` // ForceSendFields is a list of field names (e.g. "Matters") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "Matters") to include in // API requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
ListMattersResponse: Provides the list of matters.
func (*ListMattersResponse) MarshalJSON ¶
func (s *ListMattersResponse) MarshalJSON() ([]byte, error)
type ListOperationsResponse ¶ added in v0.34.0
type ListOperationsResponse struct { // NextPageToken: The standard List next-page token. NextPageToken string `json:"nextPageToken,omitempty"` // Operations: A list of operations that matches the specified filter in // the request. Operations []*Operation `json:"operations,omitempty"` // ServerResponse contains the HTTP response code and headers from the // server. googleapi.ServerResponse `json:"-"` // ForceSendFields is a list of field names (e.g. "NextPageToken") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "NextPageToken") to include // in API requests with the JSON null value. By default, fields with // empty values are omitted from API requests. However, any field with // an empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
ListOperationsResponse: The response message for Operations.ListOperations.
func (*ListOperationsResponse) MarshalJSON ¶ added in v0.34.0
func (s *ListOperationsResponse) MarshalJSON() ([]byte, error)
type ListSavedQueriesResponse ¶
type ListSavedQueriesResponse struct { // NextPageToken: Page token to retrieve the next page of results in the // list. If this is empty, then there are no more saved queries to list. NextPageToken string `json:"nextPageToken,omitempty"` // SavedQueries: List of saved queries. SavedQueries []*SavedQuery `json:"savedQueries,omitempty"` // ServerResponse contains the HTTP response code and headers from the // server. googleapi.ServerResponse `json:"-"` // ForceSendFields is a list of field names (e.g. "NextPageToken") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "NextPageToken") to include // in API requests with the JSON null value. By default, fields with // empty values are omitted from API requests. However, any field with // an empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
ListSavedQueriesResponse: Definition of the response for method ListSaveQuery.
func (*ListSavedQueriesResponse) MarshalJSON ¶
func (s *ListSavedQueriesResponse) MarshalJSON() ([]byte, error)
type MailCountResult ¶ added in v0.34.0
type MailCountResult struct { // AccountCountErrors: Errors occurred when querying these accounts. AccountCountErrors []*AccountCountError `json:"accountCountErrors,omitempty"` // AccountCounts: Subtotal count per matching account that have more // than zero messages. AccountCounts []*AccountCount `json:"accountCounts,omitempty"` // MatchingAccountsCount: Total number of accounts that can be queried // and have more than zero messages. MatchingAccountsCount int64 `json:"matchingAccountsCount,omitempty,string"` // NonQueryableAccounts: When **DataScope** is **HELD_DATA** and when // account emails are passed in explicitly, the list of accounts in the // request that are not queried because they are not on hold in the // matter. For other data scopes, this field is not set. NonQueryableAccounts []string `json:"nonQueryableAccounts,omitempty"` // QueriedAccountsCount: Total number of accounts involved in this count // operation. QueriedAccountsCount int64 `json:"queriedAccountsCount,omitempty,string"` // ForceSendFields is a list of field names (e.g. "AccountCountErrors") // to unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "AccountCountErrors") to // include in API requests with the JSON null value. By default, fields // with empty values are omitted from API requests. However, any field // with an empty value appearing in NullFields will be sent to the // server as null. It is an error if a field in this list has a // non-empty value. This may be used to include null fields in Patch // requests. NullFields []string `json:"-"` }
MailCountResult: Gmail and classic Hangouts-specific count metrics.
func (*MailCountResult) MarshalJSON ¶ added in v0.34.0
func (s *MailCountResult) MarshalJSON() ([]byte, error)
type MailExportOptions ¶
type MailExportOptions struct { // ExportFormat: The file format for exported messages. // // Possible values: // "EXPORT_FORMAT_UNSPECIFIED" - No export format specified. // "MBOX" - Export as MBOX. // "PST" - Export as PST. ExportFormat string `json:"exportFormat,omitempty"` // ShowConfidentialModeContent: To export confidential mode content, set // to **true**. ShowConfidentialModeContent bool `json:"showConfidentialModeContent,omitempty"` // ForceSendFields is a list of field names (e.g. "ExportFormat") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "ExportFormat") to include // in API requests with the JSON null value. By default, fields with // empty values are omitted from API requests. However, any field with // an empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
MailExportOptions: Options for Gmail exports.
func (*MailExportOptions) MarshalJSON ¶
func (s *MailExportOptions) MarshalJSON() ([]byte, error)
type MailOptions ¶
type MailOptions struct { // ExcludeDrafts: Set to **true** to exclude drafts. ExcludeDrafts bool `json:"excludeDrafts,omitempty"` // ForceSendFields is a list of field names (e.g. "ExcludeDrafts") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "ExcludeDrafts") to include // in API requests with the JSON null value. By default, fields with // empty values are omitted from API requests. However, any field with // an empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
MailOptions: Additional options for Gmail search
func (*MailOptions) MarshalJSON ¶
func (s *MailOptions) MarshalJSON() ([]byte, error)
type Matter ¶
type Matter struct { // Description: An optional description for the matter. Description string `json:"description,omitempty"` // MatterId: The matter ID, which is generated by the server. Leave // blank when creating a matter. MatterId string `json:"matterId,omitempty"` // MatterPermissions: Lists the users and their permission for the // matter. Currently there is no programmer defined limit on the number // of permissions a matter can have. MatterPermissions []*MatterPermission `json:"matterPermissions,omitempty"` // Name: The name of the matter. Name string `json:"name,omitempty"` // State: The state of the matter. // // Possible values: // "STATE_UNSPECIFIED" - The matter has no specified state. // "OPEN" - The matter is open. // "CLOSED" - The matter is closed. // "DELETED" - The matter is deleted. State string `json:"state,omitempty"` // ServerResponse contains the HTTP response code and headers from the // server. googleapi.ServerResponse `json:"-"` // ForceSendFields is a list of field names (e.g. "Description") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "Description") to include // in API requests with the JSON null value. By default, fields with // empty values are omitted from API requests. However, any field with // an empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
Matter: Represents a matter. To work with Vault resources, the account must have the [required Vault privileges] (https://support.google.com/vault/answer/2799699) and access to the matter. To access a matter, the account must have created the matter, have the matter shared with them, or have the **View All Matters** privilege.
func (*Matter) MarshalJSON ¶
type MatterPermission ¶
type MatterPermission struct { // AccountId: The account ID, as provided by the Admin SDK // (https://developers.google.com/admin-sdk/). AccountId string `json:"accountId,omitempty"` // Role: The user's role for the matter. // // Possible values: // "ROLE_UNSPECIFIED" - No role assigned. // "COLLABORATOR" - A collaborator on the matter. // "OWNER" - The owner of the matter. Role string `json:"role,omitempty"` // ServerResponse contains the HTTP response code and headers from the // server. googleapi.ServerResponse `json:"-"` // ForceSendFields is a list of field names (e.g. "AccountId") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "AccountId") to include in // API requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
MatterPermission: Users can be matter owners or collaborators. Each matter has only one owner. All others users who can access the matter are collaborators. When an account is purged, its corresponding MatterPermission resources cease to exist.
func (*MatterPermission) MarshalJSON ¶
func (s *MatterPermission) MarshalJSON() ([]byte, error)
type MattersAddPermissionsCall ¶
type MattersAddPermissionsCall struct {
// contains filtered or unexported fields
}
func (*MattersAddPermissionsCall) Context ¶
func (c *MattersAddPermissionsCall) Context(ctx context.Context) *MattersAddPermissionsCall
Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.
func (*MattersAddPermissionsCall) Do ¶
func (c *MattersAddPermissionsCall) Do(opts ...googleapi.CallOption) (*MatterPermission, error)
Do executes the "vault.matters.addPermissions" call. Exactly one of *MatterPermission or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *MatterPermission.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (*MattersAddPermissionsCall) Fields ¶
func (c *MattersAddPermissionsCall) Fields(s ...googleapi.Field) *MattersAddPermissionsCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
func (*MattersAddPermissionsCall) Header ¶
func (c *MattersAddPermissionsCall) Header() http.Header
Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.
type MattersCloseCall ¶
type MattersCloseCall struct {
// contains filtered or unexported fields
}
func (*MattersCloseCall) Context ¶
func (c *MattersCloseCall) Context(ctx context.Context) *MattersCloseCall
Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.
func (*MattersCloseCall) Do ¶
func (c *MattersCloseCall) Do(opts ...googleapi.CallOption) (*CloseMatterResponse, error)
Do executes the "vault.matters.close" call. Exactly one of *CloseMatterResponse or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *CloseMatterResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (*MattersCloseCall) Fields ¶
func (c *MattersCloseCall) Fields(s ...googleapi.Field) *MattersCloseCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
func (*MattersCloseCall) Header ¶
func (c *MattersCloseCall) Header() http.Header
Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.
type MattersCountCall ¶ added in v0.34.0
type MattersCountCall struct {
// contains filtered or unexported fields
}
func (*MattersCountCall) Context ¶ added in v0.34.0
func (c *MattersCountCall) Context(ctx context.Context) *MattersCountCall
Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.
func (*MattersCountCall) Do ¶ added in v0.34.0
func (c *MattersCountCall) Do(opts ...googleapi.CallOption) (*Operation, error)
Do executes the "vault.matters.count" call. Exactly one of *Operation or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Operation.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (*MattersCountCall) Fields ¶ added in v0.34.0
func (c *MattersCountCall) Fields(s ...googleapi.Field) *MattersCountCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
func (*MattersCountCall) Header ¶ added in v0.34.0
func (c *MattersCountCall) Header() http.Header
Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.
type MattersCreateCall ¶
type MattersCreateCall struct {
// contains filtered or unexported fields
}
func (*MattersCreateCall) Context ¶
func (c *MattersCreateCall) Context(ctx context.Context) *MattersCreateCall
Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.
func (*MattersCreateCall) Do ¶
func (c *MattersCreateCall) Do(opts ...googleapi.CallOption) (*Matter, error)
Do executes the "vault.matters.create" call. Exactly one of *Matter or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Matter.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (*MattersCreateCall) Fields ¶
func (c *MattersCreateCall) Fields(s ...googleapi.Field) *MattersCreateCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
func (*MattersCreateCall) Header ¶
func (c *MattersCreateCall) Header() http.Header
Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.
type MattersDeleteCall ¶
type MattersDeleteCall struct {
// contains filtered or unexported fields
}
func (*MattersDeleteCall) Context ¶
func (c *MattersDeleteCall) Context(ctx context.Context) *MattersDeleteCall
Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.
func (*MattersDeleteCall) Do ¶
func (c *MattersDeleteCall) Do(opts ...googleapi.CallOption) (*Matter, error)
Do executes the "vault.matters.delete" call. Exactly one of *Matter or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Matter.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (*MattersDeleteCall) Fields ¶
func (c *MattersDeleteCall) Fields(s ...googleapi.Field) *MattersDeleteCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
func (*MattersDeleteCall) Header ¶
func (c *MattersDeleteCall) Header() http.Header
Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.
type MattersExportsCreateCall ¶
type MattersExportsCreateCall struct {
// contains filtered or unexported fields
}
func (*MattersExportsCreateCall) Context ¶
func (c *MattersExportsCreateCall) Context(ctx context.Context) *MattersExportsCreateCall
Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.
func (*MattersExportsCreateCall) Do ¶
func (c *MattersExportsCreateCall) Do(opts ...googleapi.CallOption) (*Export, error)
Do executes the "vault.matters.exports.create" call. Exactly one of *Export or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Export.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (*MattersExportsCreateCall) Fields ¶
func (c *MattersExportsCreateCall) Fields(s ...googleapi.Field) *MattersExportsCreateCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
func (*MattersExportsCreateCall) Header ¶
func (c *MattersExportsCreateCall) Header() http.Header
Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.
type MattersExportsDeleteCall ¶
type MattersExportsDeleteCall struct {
// contains filtered or unexported fields
}
func (*MattersExportsDeleteCall) Context ¶
func (c *MattersExportsDeleteCall) Context(ctx context.Context) *MattersExportsDeleteCall
Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.
func (*MattersExportsDeleteCall) Do ¶
func (c *MattersExportsDeleteCall) Do(opts ...googleapi.CallOption) (*Empty, error)
Do executes the "vault.matters.exports.delete" call. Exactly one of *Empty or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Empty.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (*MattersExportsDeleteCall) Fields ¶
func (c *MattersExportsDeleteCall) Fields(s ...googleapi.Field) *MattersExportsDeleteCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
func (*MattersExportsDeleteCall) Header ¶
func (c *MattersExportsDeleteCall) Header() http.Header
Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.
type MattersExportsGetCall ¶
type MattersExportsGetCall struct {
// contains filtered or unexported fields
}
func (*MattersExportsGetCall) Context ¶
func (c *MattersExportsGetCall) Context(ctx context.Context) *MattersExportsGetCall
Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.
func (*MattersExportsGetCall) Do ¶
func (c *MattersExportsGetCall) Do(opts ...googleapi.CallOption) (*Export, error)
Do executes the "vault.matters.exports.get" call. Exactly one of *Export or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Export.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (*MattersExportsGetCall) Fields ¶
func (c *MattersExportsGetCall) Fields(s ...googleapi.Field) *MattersExportsGetCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
func (*MattersExportsGetCall) Header ¶
func (c *MattersExportsGetCall) Header() http.Header
Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.
func (*MattersExportsGetCall) IfNoneMatch ¶
func (c *MattersExportsGetCall) IfNoneMatch(entityTag string) *MattersExportsGetCall
IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.
type MattersExportsListCall ¶
type MattersExportsListCall struct {
// contains filtered or unexported fields
}
func (*MattersExportsListCall) Context ¶
func (c *MattersExportsListCall) Context(ctx context.Context) *MattersExportsListCall
Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.
func (*MattersExportsListCall) Do ¶
func (c *MattersExportsListCall) Do(opts ...googleapi.CallOption) (*ListExportsResponse, error)
Do executes the "vault.matters.exports.list" call. Exactly one of *ListExportsResponse or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *ListExportsResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (*MattersExportsListCall) Fields ¶
func (c *MattersExportsListCall) Fields(s ...googleapi.Field) *MattersExportsListCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
func (*MattersExportsListCall) Header ¶
func (c *MattersExportsListCall) Header() http.Header
Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.
func (*MattersExportsListCall) IfNoneMatch ¶
func (c *MattersExportsListCall) IfNoneMatch(entityTag string) *MattersExportsListCall
IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.
func (*MattersExportsListCall) PageSize ¶
func (c *MattersExportsListCall) PageSize(pageSize int64) *MattersExportsListCall
PageSize sets the optional parameter "pageSize": The number of exports to return in the response.
func (*MattersExportsListCall) PageToken ¶
func (c *MattersExportsListCall) PageToken(pageToken string) *MattersExportsListCall
PageToken sets the optional parameter "pageToken": The pagination token as returned in the response.
func (*MattersExportsListCall) Pages ¶
func (c *MattersExportsListCall) Pages(ctx context.Context, f func(*ListExportsResponse) error) error
Pages invokes f for each page of results. A non-nil error returned from f will halt the iteration. The provided context supersedes any context provided to the Context method.
type MattersExportsService ¶
type MattersExportsService struct {
// contains filtered or unexported fields
}
func NewMattersExportsService ¶
func NewMattersExportsService(s *Service) *MattersExportsService
func (*MattersExportsService) Create ¶
func (r *MattersExportsService) Create(matterId string, export *Export) *MattersExportsCreateCall
Create: Creates an export.
- matterId: The matter ID.
func (*MattersExportsService) Delete ¶
func (r *MattersExportsService) Delete(matterId string, exportId string) *MattersExportsDeleteCall
Delete: Deletes an export.
- exportId: The export ID. - matterId: The matter ID.
func (*MattersExportsService) Get ¶
func (r *MattersExportsService) Get(matterId string, exportId string) *MattersExportsGetCall
Get: Gets an export.
- exportId: The export ID. - matterId: The matter ID.
func (*MattersExportsService) List ¶
func (r *MattersExportsService) List(matterId string) *MattersExportsListCall
List: Lists details about the exports in the specified matter.
- matterId: The matter ID.
type MattersGetCall ¶
type MattersGetCall struct {
// contains filtered or unexported fields
}
func (*MattersGetCall) Context ¶
func (c *MattersGetCall) Context(ctx context.Context) *MattersGetCall
Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.
func (*MattersGetCall) Do ¶
func (c *MattersGetCall) Do(opts ...googleapi.CallOption) (*Matter, error)
Do executes the "vault.matters.get" call. Exactly one of *Matter or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Matter.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (*MattersGetCall) Fields ¶
func (c *MattersGetCall) Fields(s ...googleapi.Field) *MattersGetCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
func (*MattersGetCall) Header ¶
func (c *MattersGetCall) Header() http.Header
Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.
func (*MattersGetCall) IfNoneMatch ¶
func (c *MattersGetCall) IfNoneMatch(entityTag string) *MattersGetCall
IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.
func (*MattersGetCall) View ¶
func (c *MattersGetCall) View(view string) *MattersGetCall
View sets the optional parameter "view": Specifies how much information about the matter to return in the response.
Possible values:
"VIEW_UNSPECIFIED" - The amount of detail is unspecified. Same as
**BASIC**.
"BASIC" - Returns the matter ID, name, description, and state.
Default choice.
"FULL" - Returns the basic details and a list of matter owners and
collaborators (see [MatterPermissions](https://developers.google.com/vault/reference/rest /v1/matters#matterpermission)).
type MattersHoldsAccountsCreateCall ¶
type MattersHoldsAccountsCreateCall struct {
// contains filtered or unexported fields
}
func (*MattersHoldsAccountsCreateCall) Context ¶
func (c *MattersHoldsAccountsCreateCall) Context(ctx context.Context) *MattersHoldsAccountsCreateCall
Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.
func (*MattersHoldsAccountsCreateCall) Do ¶
func (c *MattersHoldsAccountsCreateCall) Do(opts ...googleapi.CallOption) (*HeldAccount, error)
Do executes the "vault.matters.holds.accounts.create" call. Exactly one of *HeldAccount or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *HeldAccount.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (*MattersHoldsAccountsCreateCall) Fields ¶
func (c *MattersHoldsAccountsCreateCall) Fields(s ...googleapi.Field) *MattersHoldsAccountsCreateCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
func (*MattersHoldsAccountsCreateCall) Header ¶
func (c *MattersHoldsAccountsCreateCall) Header() http.Header
Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.
type MattersHoldsAccountsDeleteCall ¶
type MattersHoldsAccountsDeleteCall struct {
// contains filtered or unexported fields
}
func (*MattersHoldsAccountsDeleteCall) Context ¶
func (c *MattersHoldsAccountsDeleteCall) Context(ctx context.Context) *MattersHoldsAccountsDeleteCall
Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.
func (*MattersHoldsAccountsDeleteCall) Do ¶
func (c *MattersHoldsAccountsDeleteCall) Do(opts ...googleapi.CallOption) (*Empty, error)
Do executes the "vault.matters.holds.accounts.delete" call. Exactly one of *Empty or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Empty.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (*MattersHoldsAccountsDeleteCall) Fields ¶
func (c *MattersHoldsAccountsDeleteCall) Fields(s ...googleapi.Field) *MattersHoldsAccountsDeleteCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
func (*MattersHoldsAccountsDeleteCall) Header ¶
func (c *MattersHoldsAccountsDeleteCall) Header() http.Header
Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.
type MattersHoldsAccountsListCall ¶
type MattersHoldsAccountsListCall struct {
// contains filtered or unexported fields
}
func (*MattersHoldsAccountsListCall) Context ¶
func (c *MattersHoldsAccountsListCall) Context(ctx context.Context) *MattersHoldsAccountsListCall
Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.
func (*MattersHoldsAccountsListCall) Do ¶
func (c *MattersHoldsAccountsListCall) Do(opts ...googleapi.CallOption) (*ListHeldAccountsResponse, error)
Do executes the "vault.matters.holds.accounts.list" call. Exactly one of *ListHeldAccountsResponse or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *ListHeldAccountsResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (*MattersHoldsAccountsListCall) Fields ¶
func (c *MattersHoldsAccountsListCall) Fields(s ...googleapi.Field) *MattersHoldsAccountsListCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
func (*MattersHoldsAccountsListCall) Header ¶
func (c *MattersHoldsAccountsListCall) Header() http.Header
Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.
func (*MattersHoldsAccountsListCall) IfNoneMatch ¶
func (c *MattersHoldsAccountsListCall) IfNoneMatch(entityTag string) *MattersHoldsAccountsListCall
IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.
type MattersHoldsAccountsService ¶
type MattersHoldsAccountsService struct {
// contains filtered or unexported fields
}
func NewMattersHoldsAccountsService ¶
func NewMattersHoldsAccountsService(s *Service) *MattersHoldsAccountsService
func (*MattersHoldsAccountsService) Create ¶
func (r *MattersHoldsAccountsService) Create(matterId string, holdId string, heldaccount *HeldAccount) *MattersHoldsAccountsCreateCall
Create: Adds an account to a hold. Accounts can be added only to a hold that does not have an organizational unit set. If you try to add an account to an organizational unit-based hold, an error is returned.
- holdId: The hold ID. - matterId: The matter ID.
func (*MattersHoldsAccountsService) Delete ¶
func (r *MattersHoldsAccountsService) Delete(matterId string, holdId string, accountId string) *MattersHoldsAccountsDeleteCall
Delete: Removes an account from a hold.
- accountId: The ID of the account to remove from the hold. - holdId: The hold ID. - matterId: The matter ID.
func (*MattersHoldsAccountsService) List ¶
func (r *MattersHoldsAccountsService) List(matterId string, holdId string) *MattersHoldsAccountsListCall
List: Lists the accounts covered by a hold. This can list only individually-specified accounts covered by the hold. If the hold covers an organizational unit, use the Admin SDK (https://developers.google.com/admin-sdk/). to list the members of the organizational unit on hold.
- holdId: The hold ID. - matterId: The matter ID.
type MattersHoldsAddHeldAccountsCall ¶
type MattersHoldsAddHeldAccountsCall struct {
// contains filtered or unexported fields
}
func (*MattersHoldsAddHeldAccountsCall) Context ¶
func (c *MattersHoldsAddHeldAccountsCall) Context(ctx context.Context) *MattersHoldsAddHeldAccountsCall
Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.
func (*MattersHoldsAddHeldAccountsCall) Do ¶
func (c *MattersHoldsAddHeldAccountsCall) Do(opts ...googleapi.CallOption) (*AddHeldAccountsResponse, error)
Do executes the "vault.matters.holds.addHeldAccounts" call. Exactly one of *AddHeldAccountsResponse or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *AddHeldAccountsResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (*MattersHoldsAddHeldAccountsCall) Fields ¶
func (c *MattersHoldsAddHeldAccountsCall) Fields(s ...googleapi.Field) *MattersHoldsAddHeldAccountsCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
func (*MattersHoldsAddHeldAccountsCall) Header ¶
func (c *MattersHoldsAddHeldAccountsCall) Header() http.Header
Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.
type MattersHoldsCreateCall ¶
type MattersHoldsCreateCall struct {
// contains filtered or unexported fields
}
func (*MattersHoldsCreateCall) Context ¶
func (c *MattersHoldsCreateCall) Context(ctx context.Context) *MattersHoldsCreateCall
Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.
func (*MattersHoldsCreateCall) Do ¶
func (c *MattersHoldsCreateCall) Do(opts ...googleapi.CallOption) (*Hold, error)
Do executes the "vault.matters.holds.create" call. Exactly one of *Hold or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Hold.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (*MattersHoldsCreateCall) Fields ¶
func (c *MattersHoldsCreateCall) Fields(s ...googleapi.Field) *MattersHoldsCreateCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
func (*MattersHoldsCreateCall) Header ¶
func (c *MattersHoldsCreateCall) Header() http.Header
Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.
type MattersHoldsDeleteCall ¶
type MattersHoldsDeleteCall struct {
// contains filtered or unexported fields
}
func (*MattersHoldsDeleteCall) Context ¶
func (c *MattersHoldsDeleteCall) Context(ctx context.Context) *MattersHoldsDeleteCall
Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.
func (*MattersHoldsDeleteCall) Do ¶
func (c *MattersHoldsDeleteCall) Do(opts ...googleapi.CallOption) (*Empty, error)
Do executes the "vault.matters.holds.delete" call. Exactly one of *Empty or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Empty.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (*MattersHoldsDeleteCall) Fields ¶
func (c *MattersHoldsDeleteCall) Fields(s ...googleapi.Field) *MattersHoldsDeleteCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
func (*MattersHoldsDeleteCall) Header ¶
func (c *MattersHoldsDeleteCall) Header() http.Header
Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.
type MattersHoldsGetCall ¶
type MattersHoldsGetCall struct {
// contains filtered or unexported fields
}
func (*MattersHoldsGetCall) Context ¶
func (c *MattersHoldsGetCall) Context(ctx context.Context) *MattersHoldsGetCall
Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.
func (*MattersHoldsGetCall) Do ¶
func (c *MattersHoldsGetCall) Do(opts ...googleapi.CallOption) (*Hold, error)
Do executes the "vault.matters.holds.get" call. Exactly one of *Hold or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Hold.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (*MattersHoldsGetCall) Fields ¶
func (c *MattersHoldsGetCall) Fields(s ...googleapi.Field) *MattersHoldsGetCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
func (*MattersHoldsGetCall) Header ¶
func (c *MattersHoldsGetCall) Header() http.Header
Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.
func (*MattersHoldsGetCall) IfNoneMatch ¶
func (c *MattersHoldsGetCall) IfNoneMatch(entityTag string) *MattersHoldsGetCall
IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.
func (*MattersHoldsGetCall) View ¶
func (c *MattersHoldsGetCall) View(view string) *MattersHoldsGetCall
View sets the optional parameter "view": The amount of detail to return for a hold.
Possible values:
"HOLD_VIEW_UNSPECIFIED" - Not specified. Defaults to **FULL_HOLD**. "BASIC_HOLD" - Returns the hold ID, name, update time, service, and
query.
"FULL_HOLD" - Returns all details of **BASIC_HOLD** and the
entities the hold applies to, such as accounts or organizational unit.
type MattersHoldsListCall ¶
type MattersHoldsListCall struct {
// contains filtered or unexported fields
}
func (*MattersHoldsListCall) Context ¶
func (c *MattersHoldsListCall) Context(ctx context.Context) *MattersHoldsListCall
Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.
func (*MattersHoldsListCall) Do ¶
func (c *MattersHoldsListCall) Do(opts ...googleapi.CallOption) (*ListHoldsResponse, error)
Do executes the "vault.matters.holds.list" call. Exactly one of *ListHoldsResponse or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *ListHoldsResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (*MattersHoldsListCall) Fields ¶
func (c *MattersHoldsListCall) Fields(s ...googleapi.Field) *MattersHoldsListCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
func (*MattersHoldsListCall) Header ¶
func (c *MattersHoldsListCall) Header() http.Header
Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.
func (*MattersHoldsListCall) IfNoneMatch ¶
func (c *MattersHoldsListCall) IfNoneMatch(entityTag string) *MattersHoldsListCall
IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.
func (*MattersHoldsListCall) PageSize ¶
func (c *MattersHoldsListCall) PageSize(pageSize int64) *MattersHoldsListCall
PageSize sets the optional parameter "pageSize": The number of holds to return in the response, between 0 and 100 inclusive. Leaving this empty, or as 0, is the same as **page_size** = 100.
func (*MattersHoldsListCall) PageToken ¶
func (c *MattersHoldsListCall) PageToken(pageToken string) *MattersHoldsListCall
PageToken sets the optional parameter "pageToken": The pagination token as returned in the response. An empty token means start from the beginning.
func (*MattersHoldsListCall) Pages ¶
func (c *MattersHoldsListCall) Pages(ctx context.Context, f func(*ListHoldsResponse) error) error
Pages invokes f for each page of results. A non-nil error returned from f will halt the iteration. The provided context supersedes any context provided to the Context method.
func (*MattersHoldsListCall) View ¶
func (c *MattersHoldsListCall) View(view string) *MattersHoldsListCall
View sets the optional parameter "view": The amount of detail to return for a hold.
Possible values:
"HOLD_VIEW_UNSPECIFIED" - Not specified. Defaults to **FULL_HOLD**. "BASIC_HOLD" - Returns the hold ID, name, update time, service, and
query.
"FULL_HOLD" - Returns all details of **BASIC_HOLD** and the
entities the hold applies to, such as accounts or organizational unit.
type MattersHoldsRemoveHeldAccountsCall ¶
type MattersHoldsRemoveHeldAccountsCall struct {
// contains filtered or unexported fields
}
func (*MattersHoldsRemoveHeldAccountsCall) Context ¶
func (c *MattersHoldsRemoveHeldAccountsCall) Context(ctx context.Context) *MattersHoldsRemoveHeldAccountsCall
Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.
func (*MattersHoldsRemoveHeldAccountsCall) Do ¶
func (c *MattersHoldsRemoveHeldAccountsCall) Do(opts ...googleapi.CallOption) (*RemoveHeldAccountsResponse, error)
Do executes the "vault.matters.holds.removeHeldAccounts" call. Exactly one of *RemoveHeldAccountsResponse or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *RemoveHeldAccountsResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (*MattersHoldsRemoveHeldAccountsCall) Fields ¶
func (c *MattersHoldsRemoveHeldAccountsCall) Fields(s ...googleapi.Field) *MattersHoldsRemoveHeldAccountsCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
func (*MattersHoldsRemoveHeldAccountsCall) Header ¶
func (c *MattersHoldsRemoveHeldAccountsCall) Header() http.Header
Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.
type MattersHoldsService ¶
type MattersHoldsService struct { Accounts *MattersHoldsAccountsService // contains filtered or unexported fields }
func NewMattersHoldsService ¶
func NewMattersHoldsService(s *Service) *MattersHoldsService
func (*MattersHoldsService) AddHeldAccounts ¶
func (r *MattersHoldsService) AddHeldAccounts(matterId string, holdId string, addheldaccountsrequest *AddHeldAccountsRequest) *MattersHoldsAddHeldAccountsCall
AddHeldAccounts: Adds accounts to a hold. Returns a list of accounts that have been successfully added. Accounts can be added only to an existing account-based hold.
- holdId: The hold ID. - matterId: The matter ID.
func (*MattersHoldsService) Create ¶
func (r *MattersHoldsService) Create(matterId string, hold *Hold) *MattersHoldsCreateCall
Create: Creates a hold in the specified matter.
- matterId: The matter ID.
func (*MattersHoldsService) Delete ¶
func (r *MattersHoldsService) Delete(matterId string, holdId string) *MattersHoldsDeleteCall
Delete: Removes the specified hold and releases the accounts or organizational unit covered by the hold. If the data is not preserved by another hold or retention rule, it might be purged.
- holdId: The hold ID. - matterId: The matter ID.
func (*MattersHoldsService) Get ¶
func (r *MattersHoldsService) Get(matterId string, holdId string) *MattersHoldsGetCall
Get: Gets the specified hold.
- holdId: The hold ID. - matterId: The matter ID.
func (*MattersHoldsService) List ¶
func (r *MattersHoldsService) List(matterId string) *MattersHoldsListCall
List: Lists the holds in a matter.
- matterId: The matter ID.
func (*MattersHoldsService) RemoveHeldAccounts ¶
func (r *MattersHoldsService) RemoveHeldAccounts(matterId string, holdId string, removeheldaccountsrequest *RemoveHeldAccountsRequest) *MattersHoldsRemoveHeldAccountsCall
RemoveHeldAccounts: Removes the specified accounts from a hold. Returns a list of statuses in the same order as the request.
- holdId: The hold ID. - matterId: The matter ID.
func (*MattersHoldsService) Update ¶
func (r *MattersHoldsService) Update(matterId string, holdId string, hold *Hold) *MattersHoldsUpdateCall
Update: Updates the scope (organizational unit or accounts) and query parameters of a hold. You cannot add accounts to a hold that covers an organizational unit, nor can you add organizational units to a hold that covers individual accounts. If you try, the unsupported values are ignored.
- holdId: The ID of the hold. - matterId: The matter ID.
type MattersHoldsUpdateCall ¶
type MattersHoldsUpdateCall struct {
// contains filtered or unexported fields
}
func (*MattersHoldsUpdateCall) Context ¶
func (c *MattersHoldsUpdateCall) Context(ctx context.Context) *MattersHoldsUpdateCall
Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.
func (*MattersHoldsUpdateCall) Do ¶
func (c *MattersHoldsUpdateCall) Do(opts ...googleapi.CallOption) (*Hold, error)
Do executes the "vault.matters.holds.update" call. Exactly one of *Hold or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Hold.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (*MattersHoldsUpdateCall) Fields ¶
func (c *MattersHoldsUpdateCall) Fields(s ...googleapi.Field) *MattersHoldsUpdateCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
func (*MattersHoldsUpdateCall) Header ¶
func (c *MattersHoldsUpdateCall) Header() http.Header
Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.
type MattersListCall ¶
type MattersListCall struct {
// contains filtered or unexported fields
}
func (*MattersListCall) Context ¶
func (c *MattersListCall) Context(ctx context.Context) *MattersListCall
Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.
func (*MattersListCall) Do ¶
func (c *MattersListCall) Do(opts ...googleapi.CallOption) (*ListMattersResponse, error)
Do executes the "vault.matters.list" call. Exactly one of *ListMattersResponse or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *ListMattersResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (*MattersListCall) Fields ¶
func (c *MattersListCall) Fields(s ...googleapi.Field) *MattersListCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
func (*MattersListCall) Header ¶
func (c *MattersListCall) Header() http.Header
Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.
func (*MattersListCall) IfNoneMatch ¶
func (c *MattersListCall) IfNoneMatch(entityTag string) *MattersListCall
IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.
func (*MattersListCall) PageSize ¶
func (c *MattersListCall) PageSize(pageSize int64) *MattersListCall
PageSize sets the optional parameter "pageSize": The number of matters to return in the response. Default and maximum are 100.
func (*MattersListCall) PageToken ¶
func (c *MattersListCall) PageToken(pageToken string) *MattersListCall
PageToken sets the optional parameter "pageToken": The pagination token as returned in the response.
func (*MattersListCall) Pages ¶
func (c *MattersListCall) Pages(ctx context.Context, f func(*ListMattersResponse) error) error
Pages invokes f for each page of results. A non-nil error returned from f will halt the iteration. The provided context supersedes any context provided to the Context method.
func (*MattersListCall) State ¶
func (c *MattersListCall) State(state string) *MattersListCall
State sets the optional parameter "state": If set, lists only matters with the specified state. The default lists matters of all states.
Possible values:
"STATE_UNSPECIFIED" - The matter has no specified state. "OPEN" - The matter is open. "CLOSED" - The matter is closed. "DELETED" - The matter is deleted.
func (*MattersListCall) View ¶
func (c *MattersListCall) View(view string) *MattersListCall
View sets the optional parameter "view": Specifies how much information about the matter to return in response.
Possible values:
"VIEW_UNSPECIFIED" - The amount of detail is unspecified. Same as
**BASIC**.
"BASIC" - Returns the matter ID, name, description, and state.
Default choice.
"FULL" - Returns the basic details and a list of matter owners and
collaborators (see [MatterPermissions](https://developers.google.com/vault/reference/rest /v1/matters#matterpermission)).
type MattersRemovePermissionsCall ¶
type MattersRemovePermissionsCall struct {
// contains filtered or unexported fields
}
func (*MattersRemovePermissionsCall) Context ¶
func (c *MattersRemovePermissionsCall) Context(ctx context.Context) *MattersRemovePermissionsCall
Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.
func (*MattersRemovePermissionsCall) Do ¶
func (c *MattersRemovePermissionsCall) Do(opts ...googleapi.CallOption) (*Empty, error)
Do executes the "vault.matters.removePermissions" call. Exactly one of *Empty or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Empty.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (*MattersRemovePermissionsCall) Fields ¶
func (c *MattersRemovePermissionsCall) Fields(s ...googleapi.Field) *MattersRemovePermissionsCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
func (*MattersRemovePermissionsCall) Header ¶
func (c *MattersRemovePermissionsCall) Header() http.Header
Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.
type MattersReopenCall ¶
type MattersReopenCall struct {
// contains filtered or unexported fields
}
func (*MattersReopenCall) Context ¶
func (c *MattersReopenCall) Context(ctx context.Context) *MattersReopenCall
Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.
func (*MattersReopenCall) Do ¶
func (c *MattersReopenCall) Do(opts ...googleapi.CallOption) (*ReopenMatterResponse, error)
Do executes the "vault.matters.reopen" call. Exactly one of *ReopenMatterResponse or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *ReopenMatterResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (*MattersReopenCall) Fields ¶
func (c *MattersReopenCall) Fields(s ...googleapi.Field) *MattersReopenCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
func (*MattersReopenCall) Header ¶
func (c *MattersReopenCall) Header() http.Header
Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.
type MattersSavedQueriesCreateCall ¶
type MattersSavedQueriesCreateCall struct {
// contains filtered or unexported fields
}
func (*MattersSavedQueriesCreateCall) Context ¶
func (c *MattersSavedQueriesCreateCall) Context(ctx context.Context) *MattersSavedQueriesCreateCall
Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.
func (*MattersSavedQueriesCreateCall) Do ¶
func (c *MattersSavedQueriesCreateCall) Do(opts ...googleapi.CallOption) (*SavedQuery, error)
Do executes the "vault.matters.savedQueries.create" call. Exactly one of *SavedQuery or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *SavedQuery.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (*MattersSavedQueriesCreateCall) Fields ¶
func (c *MattersSavedQueriesCreateCall) Fields(s ...googleapi.Field) *MattersSavedQueriesCreateCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
func (*MattersSavedQueriesCreateCall) Header ¶
func (c *MattersSavedQueriesCreateCall) Header() http.Header
Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.
type MattersSavedQueriesDeleteCall ¶
type MattersSavedQueriesDeleteCall struct {
// contains filtered or unexported fields
}
func (*MattersSavedQueriesDeleteCall) Context ¶
func (c *MattersSavedQueriesDeleteCall) Context(ctx context.Context) *MattersSavedQueriesDeleteCall
Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.
func (*MattersSavedQueriesDeleteCall) Do ¶
func (c *MattersSavedQueriesDeleteCall) Do(opts ...googleapi.CallOption) (*Empty, error)
Do executes the "vault.matters.savedQueries.delete" call. Exactly one of *Empty or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Empty.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (*MattersSavedQueriesDeleteCall) Fields ¶
func (c *MattersSavedQueriesDeleteCall) Fields(s ...googleapi.Field) *MattersSavedQueriesDeleteCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
func (*MattersSavedQueriesDeleteCall) Header ¶
func (c *MattersSavedQueriesDeleteCall) Header() http.Header
Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.
type MattersSavedQueriesGetCall ¶
type MattersSavedQueriesGetCall struct {
// contains filtered or unexported fields
}
func (*MattersSavedQueriesGetCall) Context ¶
func (c *MattersSavedQueriesGetCall) Context(ctx context.Context) *MattersSavedQueriesGetCall
Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.
func (*MattersSavedQueriesGetCall) Do ¶
func (c *MattersSavedQueriesGetCall) Do(opts ...googleapi.CallOption) (*SavedQuery, error)
Do executes the "vault.matters.savedQueries.get" call. Exactly one of *SavedQuery or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *SavedQuery.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (*MattersSavedQueriesGetCall) Fields ¶
func (c *MattersSavedQueriesGetCall) Fields(s ...googleapi.Field) *MattersSavedQueriesGetCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
func (*MattersSavedQueriesGetCall) Header ¶
func (c *MattersSavedQueriesGetCall) Header() http.Header
Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.
func (*MattersSavedQueriesGetCall) IfNoneMatch ¶
func (c *MattersSavedQueriesGetCall) IfNoneMatch(entityTag string) *MattersSavedQueriesGetCall
IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.
type MattersSavedQueriesListCall ¶
type MattersSavedQueriesListCall struct {
// contains filtered or unexported fields
}
func (*MattersSavedQueriesListCall) Context ¶
func (c *MattersSavedQueriesListCall) Context(ctx context.Context) *MattersSavedQueriesListCall
Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.
func (*MattersSavedQueriesListCall) Do ¶
func (c *MattersSavedQueriesListCall) Do(opts ...googleapi.CallOption) (*ListSavedQueriesResponse, error)
Do executes the "vault.matters.savedQueries.list" call. Exactly one of *ListSavedQueriesResponse or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *ListSavedQueriesResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (*MattersSavedQueriesListCall) Fields ¶
func (c *MattersSavedQueriesListCall) Fields(s ...googleapi.Field) *MattersSavedQueriesListCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
func (*MattersSavedQueriesListCall) Header ¶
func (c *MattersSavedQueriesListCall) Header() http.Header
Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.
func (*MattersSavedQueriesListCall) IfNoneMatch ¶
func (c *MattersSavedQueriesListCall) IfNoneMatch(entityTag string) *MattersSavedQueriesListCall
IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.
func (*MattersSavedQueriesListCall) PageSize ¶
func (c *MattersSavedQueriesListCall) PageSize(pageSize int64) *MattersSavedQueriesListCall
PageSize sets the optional parameter "pageSize": The maximum number of saved queries to return.
func (*MattersSavedQueriesListCall) PageToken ¶
func (c *MattersSavedQueriesListCall) PageToken(pageToken string) *MattersSavedQueriesListCall
PageToken sets the optional parameter "pageToken": The pagination token as returned in the previous response. An empty token means start from the beginning.
func (*MattersSavedQueriesListCall) Pages ¶
func (c *MattersSavedQueriesListCall) Pages(ctx context.Context, f func(*ListSavedQueriesResponse) error) error
Pages invokes f for each page of results. A non-nil error returned from f will halt the iteration. The provided context supersedes any context provided to the Context method.
type MattersSavedQueriesService ¶
type MattersSavedQueriesService struct {
// contains filtered or unexported fields
}
func NewMattersSavedQueriesService ¶
func NewMattersSavedQueriesService(s *Service) *MattersSavedQueriesService
func (*MattersSavedQueriesService) Create ¶
func (r *MattersSavedQueriesService) Create(matterId string, savedquery *SavedQuery) *MattersSavedQueriesCreateCall
Create: Creates a saved query.
- matterId: The ID of the matter to create the saved query in.
func (*MattersSavedQueriesService) Delete ¶
func (r *MattersSavedQueriesService) Delete(matterId string, savedQueryId string) *MattersSavedQueriesDeleteCall
Delete: Deletes the specified saved query.
- matterId: The ID of the matter to delete the saved query from. - savedQueryId: ID of the saved query to delete.
func (*MattersSavedQueriesService) Get ¶
func (r *MattersSavedQueriesService) Get(matterId string, savedQueryId string) *MattersSavedQueriesGetCall
Get: Retrieves the specified saved query.
- matterId: The ID of the matter to get the saved query from. - savedQueryId: ID of the saved query to retrieve.
func (*MattersSavedQueriesService) List ¶
func (r *MattersSavedQueriesService) List(matterId string) *MattersSavedQueriesListCall
List: Lists the saved queries in a matter.
- matterId: The ID of the matter to get the saved queries for.
type MattersService ¶
type MattersService struct { Exports *MattersExportsService Holds *MattersHoldsService SavedQueries *MattersSavedQueriesService // contains filtered or unexported fields }
func NewMattersService ¶
func NewMattersService(s *Service) *MattersService
func (*MattersService) AddPermissions ¶
func (r *MattersService) AddPermissions(matterId string, addmatterpermissionsrequest *AddMatterPermissionsRequest) *MattersAddPermissionsCall
AddPermissions: Adds an account as a matter collaborator.
- matterId: The matter ID.
func (*MattersService) Close ¶
func (r *MattersService) Close(matterId string, closematterrequest *CloseMatterRequest) *MattersCloseCall
Close: Closes the specified matter. Returns the matter with updated state.
- matterId: The matter ID.
func (*MattersService) Count ¶ added in v0.34.0
func (r *MattersService) Count(matterId string, countartifactsrequest *CountArtifactsRequest) *MattersCountCall
Count: Counts the accounts processed by the specified query.
- matterId: The matter ID.
func (*MattersService) Create ¶
func (r *MattersService) Create(matter *Matter) *MattersCreateCall
Create: Creates a matter with the given name and description. The initial state is open, and the owner is the method caller. Returns the created matter with default view.
func (*MattersService) Delete ¶
func (r *MattersService) Delete(matterId string) *MattersDeleteCall
Delete: Deletes the specified matter. Returns the matter with updated state.
- matterId: The matter ID.
func (*MattersService) Get ¶
func (r *MattersService) Get(matterId string) *MattersGetCall
Get: Gets the specified matter.
- matterId: The matter ID.
func (*MattersService) List ¶
func (r *MattersService) List() *MattersListCall
List: Lists matters the requestor has access to.
func (*MattersService) RemovePermissions ¶
func (r *MattersService) RemovePermissions(matterId string, removematterpermissionsrequest *RemoveMatterPermissionsRequest) *MattersRemovePermissionsCall
RemovePermissions: Removes an account as a matter collaborator.
- matterId: The matter ID.
func (*MattersService) Reopen ¶
func (r *MattersService) Reopen(matterId string, reopenmatterrequest *ReopenMatterRequest) *MattersReopenCall
Reopen: Reopens the specified matter. Returns the matter with updated state.
- matterId: The matter ID.
func (*MattersService) Undelete ¶
func (r *MattersService) Undelete(matterId string, undeletematterrequest *UndeleteMatterRequest) *MattersUndeleteCall
Undelete: Undeletes the specified matter. Returns the matter with updated state.
- matterId: The matter ID.
func (*MattersService) Update ¶
func (r *MattersService) Update(matterId string, matter *Matter) *MattersUpdateCall
Update: Updates the specified matter. This updates only the name and description of the matter, identified by matter ID. Changes to any other fields are ignored. Returns the default view of the matter.
- matterId: The matter ID.
type MattersUndeleteCall ¶
type MattersUndeleteCall struct {
// contains filtered or unexported fields
}
func (*MattersUndeleteCall) Context ¶
func (c *MattersUndeleteCall) Context(ctx context.Context) *MattersUndeleteCall
Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.
func (*MattersUndeleteCall) Do ¶
func (c *MattersUndeleteCall) Do(opts ...googleapi.CallOption) (*Matter, error)
Do executes the "vault.matters.undelete" call. Exactly one of *Matter or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Matter.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (*MattersUndeleteCall) Fields ¶
func (c *MattersUndeleteCall) Fields(s ...googleapi.Field) *MattersUndeleteCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
func (*MattersUndeleteCall) Header ¶
func (c *MattersUndeleteCall) Header() http.Header
Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.
type MattersUpdateCall ¶
type MattersUpdateCall struct {
// contains filtered or unexported fields
}
func (*MattersUpdateCall) Context ¶
func (c *MattersUpdateCall) Context(ctx context.Context) *MattersUpdateCall
Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.
func (*MattersUpdateCall) Do ¶
func (c *MattersUpdateCall) Do(opts ...googleapi.CallOption) (*Matter, error)
Do executes the "vault.matters.update" call. Exactly one of *Matter or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Matter.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (*MattersUpdateCall) Fields ¶
func (c *MattersUpdateCall) Fields(s ...googleapi.Field) *MattersUpdateCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
func (*MattersUpdateCall) Header ¶
func (c *MattersUpdateCall) Header() http.Header
Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.
type Operation ¶ added in v0.34.0
type Operation struct { // Done: If the value is `false`, it means the operation is still in // progress. If `true`, the operation is completed, and either `error` // or `response` is available. Done bool `json:"done,omitempty"` // Error: The error result of the operation in case of failure or // cancellation. Error *Status `json:"error,omitempty"` // Metadata: Service-specific metadata associated with the operation. It // typically contains progress information and common metadata such as // create time. Some services might not provide such metadata. Any // method that returns a long-running operation should document the // metadata type, if any. Metadata googleapi.RawMessage `json:"metadata,omitempty"` // Name: The server-assigned name, which is only unique within the same // service that originally returns it. If you use the default HTTP // mapping, the `name` should be a resource name ending with // `operations/{unique_id}`. Name string `json:"name,omitempty"` // Response: The normal response of the operation in case of success. If // the original method returns no data on success, such as `Delete`, the // response is `google.protobuf.Empty`. If the original method is // standard `Get`/`Create`/`Update`, the response should be the // resource. For other methods, the response should have the type // `XxxResponse`, where `Xxx` is the original method name. For example, // if the original method name is `TakeSnapshot()`, the inferred // response type is `TakeSnapshotResponse`. Response googleapi.RawMessage `json:"response,omitempty"` // ServerResponse contains the HTTP response code and headers from the // server. googleapi.ServerResponse `json:"-"` // ForceSendFields is a list of field names (e.g. "Done") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "Done") to include in API // requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
Operation: This resource represents a long-running operation that is the result of a network API call.
func (*Operation) MarshalJSON ¶ added in v0.34.0
type OperationsCancelCall ¶ added in v0.34.0
type OperationsCancelCall struct {
// contains filtered or unexported fields
}
func (*OperationsCancelCall) Context ¶ added in v0.34.0
func (c *OperationsCancelCall) Context(ctx context.Context) *OperationsCancelCall
Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.
func (*OperationsCancelCall) Do ¶ added in v0.34.0
func (c *OperationsCancelCall) Do(opts ...googleapi.CallOption) (*Empty, error)
Do executes the "vault.operations.cancel" call. Exactly one of *Empty or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Empty.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (*OperationsCancelCall) Fields ¶ added in v0.34.0
func (c *OperationsCancelCall) Fields(s ...googleapi.Field) *OperationsCancelCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
func (*OperationsCancelCall) Header ¶ added in v0.34.0
func (c *OperationsCancelCall) Header() http.Header
Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.
type OperationsDeleteCall ¶ added in v0.11.0
type OperationsDeleteCall struct {
// contains filtered or unexported fields
}
func (*OperationsDeleteCall) Context ¶ added in v0.11.0
func (c *OperationsDeleteCall) Context(ctx context.Context) *OperationsDeleteCall
Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.
func (*OperationsDeleteCall) Do ¶ added in v0.11.0
func (c *OperationsDeleteCall) Do(opts ...googleapi.CallOption) (*Empty, error)
Do executes the "vault.operations.delete" call. Exactly one of *Empty or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Empty.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (*OperationsDeleteCall) Fields ¶ added in v0.11.0
func (c *OperationsDeleteCall) Fields(s ...googleapi.Field) *OperationsDeleteCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
func (*OperationsDeleteCall) Header ¶ added in v0.11.0
func (c *OperationsDeleteCall) Header() http.Header
Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.
type OperationsGetCall ¶ added in v0.34.0
type OperationsGetCall struct {
// contains filtered or unexported fields
}
func (*OperationsGetCall) Context ¶ added in v0.34.0
func (c *OperationsGetCall) Context(ctx context.Context) *OperationsGetCall
Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.
func (*OperationsGetCall) Do ¶ added in v0.34.0
func (c *OperationsGetCall) Do(opts ...googleapi.CallOption) (*Operation, error)
Do executes the "vault.operations.get" call. Exactly one of *Operation or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Operation.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (*OperationsGetCall) Fields ¶ added in v0.34.0
func (c *OperationsGetCall) Fields(s ...googleapi.Field) *OperationsGetCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
func (*OperationsGetCall) Header ¶ added in v0.34.0
func (c *OperationsGetCall) Header() http.Header
Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.
func (*OperationsGetCall) IfNoneMatch ¶ added in v0.34.0
func (c *OperationsGetCall) IfNoneMatch(entityTag string) *OperationsGetCall
IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.
type OperationsListCall ¶ added in v0.34.0
type OperationsListCall struct {
// contains filtered or unexported fields
}
func (*OperationsListCall) Context ¶ added in v0.34.0
func (c *OperationsListCall) Context(ctx context.Context) *OperationsListCall
Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.
func (*OperationsListCall) Do ¶ added in v0.34.0
func (c *OperationsListCall) Do(opts ...googleapi.CallOption) (*ListOperationsResponse, error)
Do executes the "vault.operations.list" call. Exactly one of *ListOperationsResponse or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *ListOperationsResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (*OperationsListCall) Fields ¶ added in v0.34.0
func (c *OperationsListCall) Fields(s ...googleapi.Field) *OperationsListCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
func (*OperationsListCall) Filter ¶ added in v0.34.0
func (c *OperationsListCall) Filter(filter string) *OperationsListCall
Filter sets the optional parameter "filter": The standard list filter.
func (*OperationsListCall) Header ¶ added in v0.34.0
func (c *OperationsListCall) Header() http.Header
Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.
func (*OperationsListCall) IfNoneMatch ¶ added in v0.34.0
func (c *OperationsListCall) IfNoneMatch(entityTag string) *OperationsListCall
IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.
func (*OperationsListCall) PageSize ¶ added in v0.34.0
func (c *OperationsListCall) PageSize(pageSize int64) *OperationsListCall
PageSize sets the optional parameter "pageSize": The standard list page size.
func (*OperationsListCall) PageToken ¶ added in v0.34.0
func (c *OperationsListCall) PageToken(pageToken string) *OperationsListCall
PageToken sets the optional parameter "pageToken": The standard list page token.
func (*OperationsListCall) Pages ¶ added in v0.34.0
func (c *OperationsListCall) Pages(ctx context.Context, f func(*ListOperationsResponse) error) error
Pages invokes f for each page of results. A non-nil error returned from f will halt the iteration. The provided context supersedes any context provided to the Context method.
type OperationsService ¶ added in v0.11.0
type OperationsService struct {
// contains filtered or unexported fields
}
func NewOperationsService ¶ added in v0.11.0
func NewOperationsService(s *Service) *OperationsService
func (*OperationsService) Cancel ¶ added in v0.34.0
func (r *OperationsService) Cancel(name string, canceloperationrequest *CancelOperationRequest) *OperationsCancelCall
Cancel: Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.
- name: The name of the operation resource to be cancelled.
func (*OperationsService) Delete ¶ added in v0.11.0
func (r *OperationsService) Delete(name string) *OperationsDeleteCall
Delete: Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.
- name: The name of the operation resource to be deleted.
func (*OperationsService) Get ¶ added in v0.34.0
func (r *OperationsService) Get(name string) *OperationsGetCall
Get: Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.
- name: The name of the operation resource.
func (*OperationsService) List ¶ added in v0.34.0
func (r *OperationsService) List(name string) *OperationsListCall
List: Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. NOTE: the `name` binding allows API services to override the binding to use different resource name schemes, such as `users/*/operations`. To override the binding, API services can add a binding such as "/v1/{name=users/*}/operations" to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must ensure the name binding is the parent resource, without the operations collection id.
- name: The name of the operation's parent resource.
type OrgUnitInfo ¶
type OrgUnitInfo struct { // OrgUnitId: The name of the organizational unit to search, as provided // by the Admin SDK Directory API // (https://developers.google.com/admin-sdk/directory/). OrgUnitId string `json:"orgUnitId,omitempty"` // ForceSendFields is a list of field names (e.g. "OrgUnitId") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "OrgUnitId") to include in // API requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
OrgUnitInfo: The organizational unit to search
func (*OrgUnitInfo) MarshalJSON ¶
func (s *OrgUnitInfo) MarshalJSON() ([]byte, error)
type Query ¶
type Query struct { // AccountInfo: Required when **SearchMethod** is **ACCOUNT**. AccountInfo *AccountInfo `json:"accountInfo,omitempty"` // Corpus: The Google Workspace service to search. // // Possible values: // "CORPUS_TYPE_UNSPECIFIED" - No service specified. // "DRIVE" - Drive, including Meet and Sites. // "MAIL" - For search, Gmail and classic Hangouts. For holds, Gmail // only. // "GROUPS" - Groups. // "HANGOUTS_CHAT" - For search, Google Chat only. For holds, Google // Chat and classic Hangouts. // "VOICE" - Google Voice. Corpus string `json:"corpus,omitempty"` // DataScope: The data source to search. // // Possible values: // "DATA_SCOPE_UNSPECIFIED" - No data source specified. // "ALL_DATA" - All available data. // "HELD_DATA" - Only data on hold. // "UNPROCESSED_DATA" - Only data not yet processed by Vault. (Gmail // and Groups only) DataScope string `json:"dataScope,omitempty"` // DriveOptions: Set Drive search-specific options. DriveOptions *DriveOptions `json:"driveOptions,omitempty"` // EndTime: The end time for the search query. Specify in GMT. The value // is rounded to 12 AM on the specified date. EndTime string `json:"endTime,omitempty"` // HangoutsChatInfo: Required when **SearchMethod** is **ROOM**. // (read-only) HangoutsChatInfo *HangoutsChatInfo `json:"hangoutsChatInfo,omitempty"` // HangoutsChatOptions: Set Chat search-specific options. (read-only) HangoutsChatOptions *HangoutsChatOptions `json:"hangoutsChatOptions,omitempty"` // MailOptions: Set Gmail search-specific options. MailOptions *MailOptions `json:"mailOptions,omitempty"` // Method: The entity to search. This field replaces **searchMethod** to // support shared drives. When **searchMethod** is **TEAM_DRIVE**, the // response of this field is **SHARED_DRIVE**. // // Possible values: // "SEARCH_METHOD_UNSPECIFIED" - A search method must be specified or // else it is rejected. // "ACCOUNT" - Search the data of the accounts specified in // [AccountInfo](https://developers.google.com/vault/reference/rest/v1/Qu // ery#accountinfo). // "ORG_UNIT" - Search the data of all accounts in the organizational // unit specified in // [OrgUnitInfo](https://developers.google.com/vault/reference/rest/v1/Qu // ery#orgunitinfo). // "TEAM_DRIVE" - Search the data in the Team Drive specified in // **team_drive_info**. // "ENTIRE_ORG" - Search the data of all accounts in the organization. // Supported only for Gmail. When specified, you don't need to specify // **AccountInfo** or **OrgUnitInfo**. // "ROOM" - Search messages in the Chat spaces specified in // [HangoutsChatInfo](https://developers.google.com/vault/reference/rest/ // v1/Query#hangoutschatinfo). // "SHARED_DRIVE" - Search the files in the shared drives specified in // [SharedDriveInfo](https://developers.google.com/vault/reference/rest/v // 1/Query#shareddriveinfo). Method string `json:"method,omitempty"` // OrgUnitInfo: Required when **SearchMethod** is **ORG_UNIT**. OrgUnitInfo *OrgUnitInfo `json:"orgUnitInfo,omitempty"` // SearchMethod: The search method to use. // // Possible values: // "SEARCH_METHOD_UNSPECIFIED" - A search method must be specified or // else it is rejected. // "ACCOUNT" - Search the data of the accounts specified in // [AccountInfo](https://developers.google.com/vault/reference/rest/v1/Qu // ery#accountinfo). // "ORG_UNIT" - Search the data of all accounts in the organizational // unit specified in // [OrgUnitInfo](https://developers.google.com/vault/reference/rest/v1/Qu // ery#orgunitinfo). // "TEAM_DRIVE" - Search the data in the Team Drive specified in // **team_drive_info**. // "ENTIRE_ORG" - Search the data of all accounts in the organization. // Supported only for Gmail. When specified, you don't need to specify // **AccountInfo** or **OrgUnitInfo**. // "ROOM" - Search messages in the Chat spaces specified in // [HangoutsChatInfo](https://developers.google.com/vault/reference/rest/ // v1/Query#hangoutschatinfo). // "SHARED_DRIVE" - Search the files in the shared drives specified in // [SharedDriveInfo](https://developers.google.com/vault/reference/rest/v // 1/Query#shareddriveinfo). SearchMethod string `json:"searchMethod,omitempty"` SharedDriveInfo *SharedDriveInfo `json:"sharedDriveInfo,omitempty"` // StartTime: The start time for the search query. Specify in GMT. The // value is rounded to 12 AM on the specified date. StartTime string `json:"startTime,omitempty"` // TeamDriveInfo: Required when **SearchMethod** is **TEAM_DRIVE**. TeamDriveInfo *TeamDriveInfo `json:"teamDriveInfo,omitempty"` // Terms: Service-specific search operators // (https://support.google.com/vault/answer/2474474) to filter search // results. Terms string `json:"terms,omitempty"` // TimeZone: The time zone name. It should be an IANA TZ name, such as // "America/Los_Angeles". For a list of time zone names, see Time Zone // (https://en.wikipedia.org/wiki/List_of_tz_database_time_zones). For // more information about how Vault uses time zones, see the Vault help // center (https://support.google.com/vault/answer/6092995#time). TimeZone string `json:"timeZone,omitempty"` // VoiceOptions: Set Voice search-specific options. VoiceOptions *VoiceOptions `json:"voiceOptions,omitempty"` // ForceSendFields is a list of field names (e.g. "AccountInfo") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "AccountInfo") to include // in API requests with the JSON null value. By default, fields with // empty values are omitted from API requests. However, any field with // an empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
Query: The query definition used for search and export.
func (*Query) MarshalJSON ¶
type RemoveHeldAccountsRequest ¶
type RemoveHeldAccountsRequest struct { // AccountIds: The account IDs of the accounts to remove from the hold. AccountIds []string `json:"accountIds,omitempty"` // ForceSendFields is a list of field names (e.g. "AccountIds") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "AccountIds") to include in // API requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
RemoveHeldAccountsRequest: Remove a list of accounts from a hold.
func (*RemoveHeldAccountsRequest) MarshalJSON ¶
func (s *RemoveHeldAccountsRequest) MarshalJSON() ([]byte, error)
type RemoveHeldAccountsResponse ¶
type RemoveHeldAccountsResponse struct { // Statuses: A list of statuses for the deleted accounts. Results have // the same order as the request. Statuses []*Status `json:"statuses,omitempty"` // ServerResponse contains the HTTP response code and headers from the // server. googleapi.ServerResponse `json:"-"` // ForceSendFields is a list of field names (e.g. "Statuses") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "Statuses") to include in // API requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
RemoveHeldAccountsResponse: Response for batch delete held accounts.
func (*RemoveHeldAccountsResponse) MarshalJSON ¶
func (s *RemoveHeldAccountsResponse) MarshalJSON() ([]byte, error)
type RemoveMatterPermissionsRequest ¶
type RemoveMatterPermissionsRequest struct { // AccountId: The account ID. AccountId string `json:"accountId,omitempty"` // ForceSendFields is a list of field names (e.g. "AccountId") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "AccountId") to include in // API requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
RemoveMatterPermissionsRequest: Remove an account as a matter collaborator.
func (*RemoveMatterPermissionsRequest) MarshalJSON ¶
func (s *RemoveMatterPermissionsRequest) MarshalJSON() ([]byte, error)
type ReopenMatterRequest ¶
type ReopenMatterRequest struct { }
ReopenMatterRequest: Reopen a matter by ID.
type ReopenMatterResponse ¶
type ReopenMatterResponse struct { // Matter: The updated matter, with state **OPEN**. Matter *Matter `json:"matter,omitempty"` // ServerResponse contains the HTTP response code and headers from the // server. googleapi.ServerResponse `json:"-"` // ForceSendFields is a list of field names (e.g. "Matter") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "Matter") to include in API // requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
ReopenMatterResponse: Response to a ReopenMatterRequest.
func (*ReopenMatterResponse) MarshalJSON ¶
func (s *ReopenMatterResponse) MarshalJSON() ([]byte, error)
type SavedQuery ¶
type SavedQuery struct { // CreateTime: Output only. The server-generated timestamp when the // saved query was created. CreateTime string `json:"createTime,omitempty"` // DisplayName: The name of the saved query. DisplayName string `json:"displayName,omitempty"` // MatterId: Output only. The matter ID of the matter the saved query is // saved in. The server does not use this field during create and always // uses matter ID in the URL. MatterId string `json:"matterId,omitempty"` // Query: The search parameters of the saved query. Query *Query `json:"query,omitempty"` // SavedQueryId: A unique identifier for the saved query. SavedQueryId string `json:"savedQueryId,omitempty"` // ServerResponse contains the HTTP response code and headers from the // server. googleapi.ServerResponse `json:"-"` // ForceSendFields is a list of field names (e.g. "CreateTime") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "CreateTime") to include in // API requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
SavedQuery: The definition of a saved query. To work with Vault resources, the account must have the required Vault privileges (https://support.google.com/vault/answer/2799699) and access to the matter. To access a matter, the account must have created the matter, have the matter shared with them, or have the **View All Matters** privilege.
func (*SavedQuery) MarshalJSON ¶
func (s *SavedQuery) MarshalJSON() ([]byte, error)
type Service ¶
type Service struct { BasePath string // API endpoint base URL UserAgent string // optional additional User-Agent fragment Matters *MattersService Operations *OperationsService // contains filtered or unexported fields }
func New
deprecated
New creates a new Service. It uses the provided http.Client for requests.
Deprecated: please use NewService instead. To provide a custom HTTP client, use option.WithHTTPClient. If you are using google.golang.org/api/googleapis/transport.APIKey, use option.WithAPIKey with NewService instead.
func NewService ¶ added in v0.3.0
NewService creates a new Service.
type SharedDriveInfo ¶ added in v0.7.0
type SharedDriveInfo struct { // API (https://developers.google.com/drive). SharedDriveIds []string `json:"sharedDriveIds,omitempty"` // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // include in API requests with the JSON null value. By default, fields // with empty values are omitted from API requests. However, any field // with an empty value appearing in NullFields will be sent to the // server as null. It is an error if a field in this list has a // non-empty value. This may be used to include null fields in Patch // requests. NullFields []string `json:"-"` }
SharedDriveInfo: The shared drives to search
func (*SharedDriveInfo) MarshalJSON ¶ added in v0.7.0
func (s *SharedDriveInfo) MarshalJSON() ([]byte, error)
type Status ¶
type Status struct { // Code: The status code, which should be an enum value of // google.rpc.Code. Code int64 `json:"code,omitempty"` // Details: A list of messages that carry the error details. There is a // common set of message types for APIs to use. Details []googleapi.RawMessage `json:"details,omitempty"` // Message: A developer-facing error message, which should be in // English. Any user-facing error message should be localized and sent // in the google.rpc.Status.details field, or localized by the client. Message string `json:"message,omitempty"` // ForceSendFields is a list of field names (e.g. "Code") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "Code") to include in API // requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
Status: The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC (https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the API Design Guide (https://cloud.google.com/apis/design/errors).
func (*Status) MarshalJSON ¶
type TeamDriveInfo ¶
type TeamDriveInfo struct { // TeamDriveIds: List of Team Drive IDs, as provided by the Drive API // (https://developers.google.com/drive). TeamDriveIds []string `json:"teamDriveIds,omitempty"` // ForceSendFields is a list of field names (e.g. "TeamDriveIds") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "TeamDriveIds") to include // in API requests with the JSON null value. By default, fields with // empty values are omitted from API requests. However, any field with // an empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
TeamDriveInfo: Team Drives to search
func (*TeamDriveInfo) MarshalJSON ¶
func (s *TeamDriveInfo) MarshalJSON() ([]byte, error)
type UndeleteMatterRequest ¶
type UndeleteMatterRequest struct { }
UndeleteMatterRequest: Undelete a matter by ID.
type UserInfo ¶
type UserInfo struct { // DisplayName: The displayed name of the user. DisplayName string `json:"displayName,omitempty"` // Email: The email address of the user. Email string `json:"email,omitempty"` // ForceSendFields is a list of field names (e.g. "DisplayName") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "DisplayName") to include // in API requests with the JSON null value. By default, fields with // empty values are omitted from API requests. However, any field with // an empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
UserInfo: User's information.
func (*UserInfo) MarshalJSON ¶
type VoiceExportOptions ¶ added in v0.36.0
type VoiceExportOptions struct { // ExportFormat: The file format for exported text messages. // // Possible values: // "EXPORT_FORMAT_UNSPECIFIED" - No export format specified. // "MBOX" - Export as MBOX. // "PST" - Export as PST. ExportFormat string `json:"exportFormat,omitempty"` // ForceSendFields is a list of field names (e.g. "ExportFormat") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "ExportFormat") to include // in API requests with the JSON null value. By default, fields with // empty values are omitted from API requests. However, any field with // an empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
VoiceExportOptions: The options for Voice exports.
func (*VoiceExportOptions) MarshalJSON ¶ added in v0.36.0
func (s *VoiceExportOptions) MarshalJSON() ([]byte, error)
type VoiceOptions ¶ added in v0.36.0
type VoiceOptions struct { // CoveredData: Datatypes to search // // Possible values: // "COVERED_DATA_UNSPECIFIED" - Covered data unspecified. // "TEXT_MESSAGES" - Voice text messages. // "VOICEMAILS" - Voicemails and their transcripts. // "CALL_LOGS" - Call logs. CoveredData []string `json:"coveredData,omitempty"` // ForceSendFields is a list of field names (e.g. "CoveredData") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "CoveredData") to include // in API requests with the JSON null value. By default, fields with // empty values are omitted from API requests. However, any field with // an empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
VoiceOptions: Additional options for Voice search
func (*VoiceOptions) MarshalJSON ¶ added in v0.36.0
func (s *VoiceOptions) MarshalJSON() ([]byte, error)