Movatterモバイル変換


[0]ホーム

URL:


vault

package
v0.257.0Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Dec 2, 2025 License:BSD-3-ClauseImports:18Imported by:4

Details

Repository

github.com/googleapis/google-api-go-client

Links

Documentation

Overview

Package vault provides access to the Google Vault API.

For product documentation, see:https://developers.google.com/workspace/vault

Library status

These client libraries are officially supported by Google. However, thislibrary is considered complete and is in maintenance mode. This meansthat we will address critical bugs and security issues but will not addany new features.

When possible, we recommend using our newer[Cloud Client Libraries for Go](https://pkg.go.dev/cloud.google.com/go)that are still actively being worked and iterated on.

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 forauthentication. For information on how to create and obtain ApplicationDefault Credentials, seehttps://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, usegoogle.golang.org/api/option.WithScopes:

vaultService, err := vault.NewService(ctx, option.WithScopes(vault.EdiscoveryReadonlyScope))

To use an API key for authentication (note: some APIs do not support APIkeys), usegoogle.golang.org/api/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 OAuthflow, usegoogle.golang.org/api/option.WithTokenSource:

config := &oauth2.Config{...}// ...token, err := config.Exchange(ctx, ...)vaultService, err := vault.NewService(ctx, option.WithTokenSource(config.TokenSource(ctx, token)))

Seegoogle.golang.org/api/option.ClientOption for details on options.

Index

Constants

View Source
const (// Manage your eDiscovery dataEdiscoveryScope = "https://www.googleapis.com/auth/ediscovery"// View your eDiscovery dataEdiscoveryReadonlyScope = "https://www.googleapis.com/auth/ediscovery.readonly")

OAuth2 scopes used by this API.

Variables

This section is empty.

Functions

This section is empty.

Types

typeAccountCountadded inv0.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.Countint64 `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. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.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. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

AccountCount: The results count for each account.

func (AccountCount)MarshalJSONadded inv0.34.0

func (sAccountCount) MarshalJSON() ([]byte,error)

typeAccountCountErroradded inv0.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.ErrorTypestring `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. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.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. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

AccountCountError: An error that occurred when querying a specific account

func (AccountCountError)MarshalJSONadded inv0.34.0

func (sAccountCountError) MarshalJSON() ([]byte,error)

typeAccountInfo

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. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.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. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

AccountInfo: The accounts to search

func (AccountInfo)MarshalJSON

func (sAccountInfo) MarshalJSON() ([]byte,error)

typeAddHeldAccountResult

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. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.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. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

AddHeldAccountResult: The status of each account creation, and the**HeldAccount**, if successful.

func (AddHeldAccountResult)MarshalJSON

func (sAddHeldAccountResult) MarshalJSON() ([]byte,error)

typeAddHeldAccountsRequest

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. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.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. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

AddHeldAccountsRequest: Add a list of accounts to a hold.

func (AddHeldAccountsRequest)MarshalJSON

func (sAddHeldAccountsRequest) MarshalJSON() ([]byte,error)

typeAddHeldAccountsResponse

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. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.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. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

AddHeldAccountsResponse: Response for batch create held accounts.

func (AddHeldAccountsResponse)MarshalJSON

func (sAddHeldAccountsResponse) MarshalJSON() ([]byte,error)

typeAddMatterPermissionsRequest

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**.CcMebool `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**.SendEmailsbool `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. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.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. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.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 (sAddMatterPermissionsRequest) MarshalJSON() ([]byte,error)

typeCalendarExportOptionsadded inv0.155.0

type CalendarExportOptions struct {// ExportFormat: The file format for exported text messages.//// Possible values://   "EXPORT_FORMAT_UNSPECIFIED" - No export format specified.//   "MBOX" - Export as MBOX. Only available for Gmail, Groups, Hangouts and// Voice.//   "PST" - Export as PST. Only available for Gmail, Groups, Hangouts, Voice// and Calendar.//   "ICS" - Export as ICS. Only available for Calendar.//   "XML" - Export as XML. Only available for Gemini.ExportFormatstring `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. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.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. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

CalendarExportOptions: The options for Calendar exports.

func (CalendarExportOptions)MarshalJSONadded inv0.155.0

func (sCalendarExportOptions) MarshalJSON() ([]byte,error)

typeCalendarOptionsadded inv0.155.0

type CalendarOptions struct {// LocationQuery: Matches only those events whose location contains all of the// words in the given set. If the string contains quoted phrases, this method// only matches those events whose location contain the exact phrase. Entries// in the set are considered in "and". Word splitting example: ["New Zealand"]// vs ["New","Zealand"] "New Zealand": matched by both "New and better// Zealand": only matched by the laterLocationQuery []string `json:"locationQuery,omitempty"`// MinusWords: Matches only those events that do not contain any of the words// in the given set in title, description, location, or attendees. Entries in// the set are considered in "or".MinusWords []string `json:"minusWords,omitempty"`// PeopleQuery: Matches only those events whose attendees contain all of the// words in the given set. Entries in the set are considered in "and".PeopleQuery []string `json:"peopleQuery,omitempty"`// ResponseStatuses: Matches only events for which the custodian gave one of// these responses. If the set is empty or contains// ATTENDEE_RESPONSE_UNSPECIFIED there will be no filtering on responses.//// Possible values://   "ATTENDEE_RESPONSE_UNSPECIFIED" - Attendee response unspecified. If this// is set no filtering on responses will be done, all other attendee responses// that are part of the query options are ignored.//   "ATTENDEE_RESPONSE_NEEDS_ACTION" - The participant has been invited but// has not responded yet.//   "ATTENDEE_RESPONSE_ACCEPTED" - The participant plans to attend.//   "ATTENDEE_RESPONSE_DECLINED" - The participant does not plan to attend.//   "ATTENDEE_RESPONSE_TENTATIVE" - The participant expects to possibly// attend.ResponseStatuses []string `json:"responseStatuses,omitempty"`// VersionDate: Search the current version of the Calendar event, but export// the contents of the last version saved before 12:00 AM UTC on the specified// date. Enter the date in UTC.VersionDatestring `json:"versionDate,omitempty"`// ForceSendFields is a list of field names (e.g. "LocationQuery") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "LocationQuery") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

CalendarOptions: Additional options for Calendar search

func (CalendarOptions)MarshalJSONadded inv0.155.0

func (sCalendarOptions) MarshalJSON() ([]byte,error)

typeCancelOperationRequestadded inv0.34.0

type CancelOperationRequest struct {}

CancelOperationRequest: The request message for Operations.CancelOperation.

typeCloseMatterRequest

type CloseMatterRequest struct {}

CloseMatterRequest: Close a matter by ID.

typeCloseMatterResponse

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. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.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. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

CloseMatterResponse: Response to a CloseMatterRequest.

func (CloseMatterResponse)MarshalJSON

func (sCloseMatterResponse) MarshalJSON() ([]byte,error)

typeCloudStorageFile

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 API// (https://cloud.google.com/storage/docs/json_api) or XML API// (https://cloud.google.com/storage/docs/xml-api), 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.BucketNamestring `json:"bucketName,omitempty"`// Md5Hash: The md5 hash of the file.Md5Hashstring `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 API// (https://cloud.google.com/storage/docs/json_api) or XML API// (https://cloud.google.com/storage/docs/xml-api).ObjectNamestring `json:"objectName,omitempty"`// Size: The export file size.Sizeint64 `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. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.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. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

CloudStorageFile: The export file in Cloud Storage

func (CloudStorageFile)MarshalJSON

func (sCloudStorageFile) MarshalJSON() ([]byte,error)

typeCloudStorageSink

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. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.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. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

CloudStorageSink: Export sink for Cloud Storage files.

func (CloudStorageSink)MarshalJSON

func (sCloudStorageSink) MarshalJSON() ([]byte,error)

typeCorpusQuery

type CorpusQuery struct {// CalendarQuery: Service-specific options for Calendar holds. If set,// **CorpusType** must be **CALENDAR**.CalendarQuery *HeldCalendarQuery `json:"calendarQuery,omitempty"`// 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. "CalendarQuery") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "CalendarQuery") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

CorpusQuery: Service-specific options for holds.

func (CorpusQuery)MarshalJSON

func (sCorpusQuery) MarshalJSON() ([]byte,error)

typeCountArtifactsMetadataadded inv0.34.0

type CountArtifactsMetadata struct {// EndTime: End time of count operation. Available when operation is done.EndTimestring `json:"endTime,omitempty"`// MatterId: The matter ID of the associated matter.MatterIdstring `json:"matterId,omitempty"`// Query: The search query from the request.Query *Query `json:"query,omitempty"`// StartTime: Creation time of count operation.StartTimestring `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. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.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. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

CountArtifactsMetadata: Long running operation metadata for CountArtifacts.

func (CountArtifactsMetadata)MarshalJSONadded inv0.34.0

func (sCountArtifactsMetadata) MarshalJSON() ([]byte,error)

typeCountArtifactsRequestadded inv0.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.Viewstring `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. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.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. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

CountArtifactsRequest: Count artifacts request.

func (CountArtifactsRequest)MarshalJSONadded inv0.34.0

func (sCountArtifactsRequest) MarshalJSON() ([]byte,error)

typeCountArtifactsResponseadded inv0.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.TotalCountint64 `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. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.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. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

CountArtifactsResponse: Definition of the response for methodCountArtifacts.

func (CountArtifactsResponse)MarshalJSONadded inv0.34.0

func (sCountArtifactsResponse) MarshalJSON() ([]byte,error)

typeDriveDocumentIdsadded inv0.223.0

type DriveDocumentIds struct {// Ids: Required. A list of Drive document IDs.Ids []string `json:"ids,omitempty"`// ForceSendFields is a list of field names (e.g. "Ids") to unconditionally// include in API requests. By default, fields with empty or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Ids") to include in API requests// with the JSON null value. By default, fields with empty values are omitted// from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

DriveDocumentIds: Specify Drive documents by document ID.

func (DriveDocumentIds)MarshalJSONadded inv0.223.0

func (sDriveDocumentIds) MarshalJSON() ([]byte,error)

typeDriveDocumentInfoadded inv0.223.0

type DriveDocumentInfo struct {// DocumentIds: Specify Drive documents by document ID.DocumentIds *DriveDocumentIds `json:"documentIds,omitempty"`// ForceSendFields is a list of field names (e.g. "DocumentIds") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "DocumentIds") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

DriveDocumentInfo: The Drive documents to search.

func (DriveDocumentInfo)MarshalJSONadded inv0.223.0

func (sDriveDocumentInfo) MarshalJSON() ([]byte,error)

typeDriveExportOptions

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**.IncludeAccessInfobool `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. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.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. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

DriveExportOptions: Options for Drive exports.

func (DriveExportOptions)MarshalJSON

func (sDriveExportOptions) MarshalJSON() ([]byte,error)

typeDriveOptions

type DriveOptions struct {// ClientSideEncryptedOption: Set whether the results include only content// encrypted with Google Workspace Client-side encryption// (https://support.google.com/a?p=cse_ov) content, only unencrypted content,// or both. Defaults to both. Currently supported for Drive.//// Possible values://   "CLIENT_SIDE_ENCRYPTED_OPTION_UNSPECIFIED" - Encryption status// unspecified. Results include both client-side encrypted and non-encrypted// content.//   "CLIENT_SIDE_ENCRYPTED_OPTION_ANY" - Include both client-side encrypted// and unencrypted content in results.//   "CLIENT_SIDE_ENCRYPTED_OPTION_ENCRYPTED" - Include client-side encrypted// content only.//   "CLIENT_SIDE_ENCRYPTED_OPTION_UNENCRYPTED" - Include unencrypted content// only.ClientSideEncryptedOptionstring `json:"clientSideEncryptedOption,omitempty"`// IncludeSharedDrives: Set to **true** to include shared drives.IncludeSharedDrivesbool `json:"includeSharedDrives,omitempty"`// IncludeTeamDrives: Set to true to include Team Drive.IncludeTeamDrivesbool `json:"includeTeamDrives,omitempty"`// SharedDrivesOption: Optional. Options to include or exclude documents in// shared drives. We recommend using this field over include_shared_drives.// This field overrides include_shared_drives and include_team_drives when set.//// Possible values://   "SHARED_DRIVES_OPTION_UNSPECIFIED" - No shared drive option specified.//   "NOT_INCLUDED" - If a resource is in a shared drive, it isn't included in// the search.//   "INCLUDED_IF_ACCOUNT_IS_NOT_A_MEMBER" - Shared drive resources are only// included in instances where the account is a collaborator on a resource but// they are not a member of the shared drive. This maps to the *"Included only// if documents shared directly (not due to shared drive membership)"* option// in the Vault UI. (Previously "include_shared_drives" off)//   "INCLUDED" - Resources in shared drives are included in the search.// (Previously "include_shared_drives" on)SharedDrivesOptionstring `json:"sharedDrivesOption,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.VersionDatestring `json:"versionDate,omitempty"`// ForceSendFields is a list of field names (e.g. "ClientSideEncryptedOption")// to unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "ClientSideEncryptedOption") to// include in API requests with the JSON null value. By default, fields with// empty values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

DriveOptions: Additional options for Drive search.

func (DriveOptions)MarshalJSON

func (sDriveOptions) MarshalJSON() ([]byte,error)

typeEmpty

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 definingduplicated empty messages in your APIs. A typical example is to use it asthe request or the response type of an API method. For instance: service Foo{ rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }

typeExport

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.CreateTimestring `json:"createTime,omitempty"`// ExportOptions: Additional export options.ExportOptions *ExportOptions `json:"exportOptions,omitempty"`// Id: Output only. The generated export ID.Idstring `json:"id,omitempty"`// MatterId: Output only. The matter ID.MatterIdstring `json:"matterId,omitempty"`// Name: The export name. Don't use special characters (~!$'(),;@:/?) in the// name, they can prevent you from downloading exports.Namestring `json:"name,omitempty"`// ParentExportId: Output only. Identifies the parent export that spawned this// child export. This is only set on child exports.ParentExportIdstring `json:"parentExportId,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.Statusstring `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. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.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. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

Export: An export. To work with Vault resources, the account must have therequired Vault privileges (https://support.google.com/vault/answer/2799699)and access to the matter. To access a matter, the account must have createdthe matter, have the matter shared with them, or have the **View AllMatters** privilege.

func (Export)MarshalJSON

func (sExport) MarshalJSON() ([]byte,error)

typeExportOptions

type ExportOptions struct {// CalendarOptions: Option available for Calendar export.CalendarOptions *CalendarExportOptions `json:"calendarOptions,omitempty"`// DriveOptions: Options for Drive exports.DriveOptions *DriveExportOptions `json:"driveOptions,omitempty"`// GeminiOptions: Option available for Gemini export.GeminiOptions *GeminiExportOptions `json:"geminiOptions,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.Regionstring `json:"region,omitempty"`// VoiceOptions: Options for Voice exports.VoiceOptions *VoiceExportOptions `json:"voiceOptions,omitempty"`// ForceSendFields is a list of field names (e.g. "CalendarOptions") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "CalendarOptions") to include in// API requests with the JSON null value. By default, fields with empty values// are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

ExportOptions: Additional options for exports

func (ExportOptions)MarshalJSON

func (sExportOptions) MarshalJSON() ([]byte,error)

typeExportStats

type ExportStats struct {// ExportedArtifactCount: The number of messages or files already processed for// export.ExportedArtifactCountint64 `json:"exportedArtifactCount,omitempty,string"`// SizeInBytes: The size of export in bytes.SizeInBytesint64 `json:"sizeInBytes,omitempty,string"`// TotalArtifactCount: The number of messages or files to be exported.TotalArtifactCountint64 `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. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.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. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

ExportStats: Progress information for an export.

func (ExportStats)MarshalJSON

func (sExportStats) MarshalJSON() ([]byte,error)

typeGeminiExportOptionsadded inv0.221.0

type GeminiExportOptions struct {// ExportFormat: The file format for exported messages.//// Possible values://   "EXPORT_FORMAT_UNSPECIFIED" - No export format specified.//   "MBOX" - Export as MBOX. Only available for Gmail, Groups, Hangouts and// Voice.//   "PST" - Export as PST. Only available for Gmail, Groups, Hangouts, Voice// and Calendar.//   "ICS" - Export as ICS. Only available for Calendar.//   "XML" - Export as XML. Only available for Gemini.ExportFormatstring `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. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.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. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GeminiExportOptions: The options for Gemini exports.

func (GeminiExportOptions)MarshalJSONadded inv0.221.0

func (sGeminiExportOptions) MarshalJSON() ([]byte,error)

typeGeminiOptionsadded inv0.221.0

type GeminiOptions struct {}

GeminiOptions: Additional options for Gemini search

typeGroupsCountResultadded inv0.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.MatchingAccountsCountint64 `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.QueriedAccountsCountint64 `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. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.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. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GroupsCountResult: Groups specific count metrics.

func (GroupsCountResult)MarshalJSONadded inv0.34.0

func (sGroupsCountResult) MarshalJSON() ([]byte,error)

typeGroupsExportOptions

type GroupsExportOptions struct {// ExportFormat: The file format for exported messages.//// Possible values://   "EXPORT_FORMAT_UNSPECIFIED" - No export format specified.//   "MBOX" - Export as MBOX. Only available for Gmail, Groups, Hangouts and// Voice.//   "PST" - Export as PST. Only available for Gmail, Groups, Hangouts, Voice// and Calendar.//   "ICS" - Export as ICS. Only available for Calendar.//   "XML" - Export as XML. Only available for Gemini.ExportFormatstring `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. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.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. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GroupsExportOptions: Options for Groups exports.

func (GroupsExportOptions)MarshalJSON

func (sGroupsExportOptions) MarshalJSON() ([]byte,error)

typeHangoutsChatExportOptions

type HangoutsChatExportOptions struct {// ExportFormat: The file format for exported messages.//// Possible values://   "EXPORT_FORMAT_UNSPECIFIED" - No export format specified.//   "MBOX" - Export as MBOX. Only available for Gmail, Groups, Hangouts and// Voice.//   "PST" - Export as PST. Only available for Gmail, Groups, Hangouts, Voice// and Calendar.//   "ICS" - Export as ICS. Only available for Calendar.//   "XML" - Export as XML. Only available for Gemini.ExportFormatstring `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. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.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. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

HangoutsChatExportOptions: Options for Chat exports.

func (HangoutsChatExportOptions)MarshalJSON

func (sHangoutsChatExportOptions) MarshalJSON() ([]byte,error)

typeHangoutsChatInfo

type HangoutsChatInfo struct {// RoomId: A list of Chat spaces IDs, as provided by the Chat API// (https://developers.google.com/workspace/chat). There is a limit of// exporting from 500 Chat spaces per request.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. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.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. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

HangoutsChatInfo: The Chat spaces to search

func (HangoutsChatInfo)MarshalJSON

func (sHangoutsChatInfo) MarshalJSON() ([]byte,error)

typeHangoutsChatOptions

type HangoutsChatOptions struct {// IncludeRooms: For searches by account or organizational unit, set to// **true** to include rooms.IncludeRoomsbool `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. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.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. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

HangoutsChatOptions: Additional options for Google Chat search

func (HangoutsChatOptions)MarshalJSON

func (sHangoutsChatOptions) MarshalJSON() ([]byte,error)

typeHeldAccount

type HeldAccount struct {// AccountId: The account ID, as provided by the Admin SDK// (https://developers.google.com/admin-sdk/).AccountIdstring `json:"accountId,omitempty"`// Email: The primary email address of the account. If used as an input, this// takes precedence over **accountId**.Emailstring `json:"email,omitempty"`// FirstName: Output only. The first name of the account holder.FirstNamestring `json:"firstName,omitempty"`// HoldTime: Output only. When the account was put on hold.HoldTimestring `json:"holdTime,omitempty"`// LastName: Output only. The last name of the account holder.LastNamestring `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. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.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. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

HeldAccount: An account covered by a hold. This structure is immutable. Itcan be an individual account or a Google Group, depending on the service. Towork with Vault resources, the account must have the [required Vaultprivileges] (https://support.google.com/vault/answer/2799699) and access tothe 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 (sHeldAccount) MarshalJSON() ([]byte,error)

typeHeldCalendarQueryadded inv0.185.0

type HeldCalendarQuery struct {}

HeldCalendarQuery: Options for Calendar holds.

typeHeldDriveQuery

type HeldDriveQuery struct {// IncludeSharedDriveFiles: To include files in shared drives in the hold, set// to **true**.IncludeSharedDriveFilesbool `json:"includeSharedDriveFiles,omitempty"`// IncludeTeamDriveFiles: To include files in Team Drives in the hold, set to// **true**.IncludeTeamDriveFilesbool `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. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.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. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

HeldDriveQuery: Options for Drive holds.

func (HeldDriveQuery)MarshalJSON

func (sHeldDriveQuery) MarshalJSON() ([]byte,error)

typeHeldGroupsQuery

type HeldGroupsQuery struct {// EndTime: The end time for the query. Specify in GMT. The value is rounded to// 12 AM on the specified date.EndTimestring `json:"endTime,omitempty"`// StartTime: The start time for the query. Specify in GMT. The value is// rounded to 12 AM on the specified date.StartTimestring `json:"startTime,omitempty"`// Terms: The search operators// (https://support.google.com/vault/answer/2474474) used to refine the// messages covered by the hold.Termsstring `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. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.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. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

HeldGroupsQuery: Query options for group holds.

func (HeldGroupsQuery)MarshalJSON

func (sHeldGroupsQuery) MarshalJSON() ([]byte,error)

typeHeldHangoutsChatQuery

type HeldHangoutsChatQuery struct {// IncludeRooms: To include messages in Chat spaces the user was a member of,// set to **true**.IncludeRoomsbool `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. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.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. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

HeldHangoutsChatQuery: Options for Chat holds.

func (HeldHangoutsChatQuery)MarshalJSON

func (sHeldHangoutsChatQuery) MarshalJSON() ([]byte,error)

typeHeldMailQuery

type HeldMailQuery struct {// EndTime: The end time for the query. Specify in GMT. The value is rounded to// 12 AM on the specified date.EndTimestring `json:"endTime,omitempty"`// StartTime: The start time for the query. Specify in GMT. The value is// rounded to 12 AM on the specified date.StartTimestring `json:"startTime,omitempty"`// Terms: The search operators// (https://support.google.com/vault/answer/2474474) used to refine the// messages covered by the hold.Termsstring `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. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.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. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

HeldMailQuery: Query options for Gmail holds.

func (HeldMailQuery)MarshalJSON

func (sHeldMailQuery) MarshalJSON() ([]byte,error)

typeHeldOrgUnit

type HeldOrgUnit struct {// HoldTime: When the organizational unit was put on hold. This property is// immutable.HoldTimestring `json:"holdTime,omitempty"`// OrgUnitId: The organizational unit's immutable ID as provided by the Admin// SDK (https://developers.google.com/admin-sdk/).OrgUnitIdstring `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. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.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. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

HeldOrgUnit: The organizational unit covered by a hold. This structure isimmutable.

func (HeldOrgUnit)MarshalJSON

func (sHeldOrgUnit) MarshalJSON() ([]byte,error)

typeHeldVoiceQueryadded inv0.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. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.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. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

HeldVoiceQuery: Options for Voice holds.

func (HeldVoiceQuery)MarshalJSONadded inv0.36.0

func (sHeldVoiceQuery) MarshalJSON() ([]byte,error)

typeHold

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 export, Google Chat only. For holds, Google Chat and// classic Hangouts.//   "VOICE" - Google Voice.//   "CALENDAR" - Calendar.//   "GEMINI" - Gemini.Corpusstring `json:"corpus,omitempty"`// HoldId: The unique immutable ID of the hold. Assigned during creation.HoldIdstring `json:"holdId,omitempty"`// Name: The name of the hold.Namestring `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.UpdateTimestring `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. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.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. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

Hold: A hold. A hold prevents the specified Google Workspace service frompurging data for specific accounts or all members of an organizational unit.To work with Vault resources, the account must have the [required Vaultprivileges] (https://support.google.com/vault/answer/2799699) and access tothe 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

func (sHold) MarshalJSON() ([]byte,error)

typeListExportsResponse

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.NextPageTokenstring `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. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.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. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

ListExportsResponse: The exports for a matter.

func (ListExportsResponse)MarshalJSON

func (sListExportsResponse) MarshalJSON() ([]byte,error)

typeListHeldAccountsResponse

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. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.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. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

ListHeldAccountsResponse: Returns a list of the accounts covered by a hold.

func (ListHeldAccountsResponse)MarshalJSON

func (sListHeldAccountsResponse) MarshalJSON() ([]byte,error)

typeListHoldsResponse

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.NextPageTokenstring `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. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.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. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

ListHoldsResponse: The holds for a matter.

func (ListHoldsResponse)MarshalJSON

func (sListHoldsResponse) MarshalJSON() ([]byte,error)

typeListMattersResponse

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.NextPageTokenstring `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. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.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. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

ListMattersResponse: Provides the list of matters.

func (ListMattersResponse)MarshalJSON

func (sListMattersResponse) MarshalJSON() ([]byte,error)

typeListOperationsResponseadded inv0.34.0

type ListOperationsResponse struct {// NextPageToken: The standard List next-page token.NextPageTokenstring `json:"nextPageToken,omitempty"`// Operations: A list of operations that matches the specified filter in the// request.Operations []*Operation `json:"operations,omitempty"`// Unreachable: Unordered list. Unreachable resources. Populated when the// request sets `ListOperationsRequest.return_partial_success` and reads across// collections e.g. when attempting to list all resources across all supported// locations.Unreachable []string `json:"unreachable,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. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.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. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

ListOperationsResponse: The response message for Operations.ListOperations.

func (ListOperationsResponse)MarshalJSONadded inv0.34.0

func (sListOperationsResponse) MarshalJSON() ([]byte,error)

typeListSavedQueriesResponse

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.NextPageTokenstring `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. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.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. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

ListSavedQueriesResponse: Definition of the response for methodListSaveQuery.

func (ListSavedQueriesResponse)MarshalJSON

func (sListSavedQueriesResponse) MarshalJSON() ([]byte,error)

typeMailCountResultadded inv0.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.MatchingAccountsCountint64 `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.QueriedAccountsCountint64 `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. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.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. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

MailCountResult: Gmail and classic Hangouts-specific count metrics.

func (MailCountResult)MarshalJSONadded inv0.34.0

func (sMailCountResult) MarshalJSON() ([]byte,error)

typeMailExportOptions

type MailExportOptions struct {// ExportFormat: The file format for exported messages.//// Possible values://   "EXPORT_FORMAT_UNSPECIFIED" - No export format specified.//   "MBOX" - Export as MBOX. Only available for Gmail, Groups, Hangouts and// Voice.//   "PST" - Export as PST. Only available for Gmail, Groups, Hangouts, Voice// and Calendar.//   "ICS" - Export as ICS. Only available for Calendar.//   "XML" - Export as XML. Only available for Gemini.ExportFormatstring `json:"exportFormat,omitempty"`// ExportLinkedDriveFiles: Optional. To enable exporting linked Drive files,// set to **true**.ExportLinkedDriveFilesbool `json:"exportLinkedDriveFiles,omitempty"`// ShowConfidentialModeContent: To export confidential mode content, set to// **true**.ShowConfidentialModeContentbool `json:"showConfidentialModeContent,omitempty"`// UseNewExport: To use the new export system, set to **true**.UseNewExportbool `json:"useNewExport,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. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.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. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

MailExportOptions: Options for Gmail exports.

func (MailExportOptions)MarshalJSON

func (sMailExportOptions) MarshalJSON() ([]byte,error)

typeMailOptions

type MailOptions struct {// ClientSideEncryptedOption: Specifies whether the results should include// encrypted content, unencrypted content, or both. Defaults to including both.//// Possible values://   "CLIENT_SIDE_ENCRYPTED_OPTION_UNSPECIFIED" - Encryption status// unspecified. Results include both client-side encrypted and non-encrypted// content.//   "CLIENT_SIDE_ENCRYPTED_OPTION_ANY" - Include both client-side encrypted// and unencrypted content in results.//   "CLIENT_SIDE_ENCRYPTED_OPTION_ENCRYPTED" - Include client-side encrypted// content only.//   "CLIENT_SIDE_ENCRYPTED_OPTION_UNENCRYPTED" - Include unencrypted content// only.ClientSideEncryptedOptionstring `json:"clientSideEncryptedOption,omitempty"`// ExcludeDrafts: Set to **true** to exclude drafts.ExcludeDraftsbool `json:"excludeDrafts,omitempty"`// ForceSendFields is a list of field names (e.g. "ClientSideEncryptedOption")// to unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "ClientSideEncryptedOption") to// include in API requests with the JSON null value. By default, fields with// empty values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

MailOptions: Additional options for Gmail search

func (MailOptions)MarshalJSON

func (sMailOptions) MarshalJSON() ([]byte,error)

typeMatter

type Matter struct {// Description: An optional description for the matter.Descriptionstring `json:"description,omitempty"`// MatterId: The matter ID, which is generated by the server. Leave blank when// creating a matter.MatterIdstring `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"`// MatterRegion: Optional. The requested data region for the matter.//// Possible values://   "MATTER_REGION_UNSPECIFIED" - The region is unspecified. Defaults to ANY.//   "ANY" - Any region.//   "US" - United States region.//   "EUROPE" - Europe region.MatterRegionstring `json:"matterRegion,omitempty"`// Name: The name of the matter.Namestring `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.Statestring `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. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.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. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

Matter: Represents a matter. To work with Vault resources, the account musthave 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 thematter shared with them, or have the **View All Matters** privilege.

func (Matter)MarshalJSON

func (sMatter) MarshalJSON() ([]byte,error)

typeMatterPermission

type MatterPermission struct {// AccountId: The account ID, as provided by the Admin SDK// (https://developers.google.com/admin-sdk/).AccountIdstring `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.Rolestring `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. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.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. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

MatterPermission: Users can be matter owners or collaborators. Each matterhas only one owner. All others users who can access the matter arecollaborators. When an account is purged, its corresponding MatterPermissionresources cease to exist.

func (MatterPermission)MarshalJSON

func (sMatterPermission) MarshalJSON() ([]byte,error)

typeMattersAddPermissionsCall

type MattersAddPermissionsCall struct {// contains filtered or unexported fields}

func (*MattersAddPermissionsCall)Context

Context sets the context to be used in this call's Do method.

func (*MattersAddPermissionsCall)Do

Do executes the "vault.matters.addPermissions" call.Any non-2xx status code is an error. Response headers are in either*MatterPermission.ServerResponse.Header or (if a response was returned atall) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified tocheck whether the returned error was because http.StatusNotModified wasreturned.

func (*MattersAddPermissionsCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*MattersAddPermissionsCall)Header

Header returns a http.Header that can be modified by the caller to addheaders to the request.

typeMattersCloseCall

type MattersCloseCall struct {// contains filtered or unexported fields}

func (*MattersCloseCall)Context

Context sets the context to be used in this call's Do method.

func (*MattersCloseCall)Do

Do executes the "vault.matters.close" call.Any non-2xx status code is an error. Response headers are in either*CloseMatterResponse.ServerResponse.Header or (if a response was returned atall) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified tocheck whether the returned error was because http.StatusNotModified wasreturned.

func (*MattersCloseCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*MattersCloseCall)Header

func (c *MattersCloseCall) Header()http.Header

Header returns a http.Header that can be modified by the caller to addheaders to the request.

typeMattersCountCalladded inv0.34.0

type MattersCountCall struct {// contains filtered or unexported fields}

func (*MattersCountCall)Contextadded inv0.34.0

Context sets the context to be used in this call's Do method.

func (*MattersCountCall)Doadded inv0.34.0

Do executes the "vault.matters.count" call.Any non-2xx status code is an error. Response headers are in either*Operation.ServerResponse.Header or (if a response was returned at all) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.

func (*MattersCountCall)Fieldsadded inv0.34.0

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*MattersCountCall)Headeradded inv0.34.0

func (c *MattersCountCall) Header()http.Header

Header returns a http.Header that can be modified by the caller to addheaders to the request.

typeMattersCreateCall

type MattersCreateCall struct {// contains filtered or unexported fields}

func (*MattersCreateCall)Context

Context sets the context to be used in this call's Do method.

func (*MattersCreateCall)Do

Do executes the "vault.matters.create" call.Any non-2xx status code is an error. Response headers are in either*Matter.ServerResponse.Header or (if a response was returned at all) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.

func (*MattersCreateCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*MattersCreateCall)Header

func (c *MattersCreateCall) Header()http.Header

Header returns a http.Header that can be modified by the caller to addheaders to the request.

typeMattersDeleteCall

type MattersDeleteCall struct {// contains filtered or unexported fields}

func (*MattersDeleteCall)Context

Context sets the context to be used in this call's Do method.

func (*MattersDeleteCall)Do

Do executes the "vault.matters.delete" call.Any non-2xx status code is an error. Response headers are in either*Matter.ServerResponse.Header or (if a response was returned at all) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.

func (*MattersDeleteCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*MattersDeleteCall)Header

func (c *MattersDeleteCall) Header()http.Header

Header returns a http.Header that can be modified by the caller to addheaders to the request.

typeMattersExportsCreateCall

type MattersExportsCreateCall struct {// contains filtered or unexported fields}

func (*MattersExportsCreateCall)Context

Context sets the context to be used in this call's Do method.

func (*MattersExportsCreateCall)Do

Do executes the "vault.matters.exports.create" call.Any non-2xx status code is an error. Response headers are in either*Export.ServerResponse.Header or (if a response was returned at all) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.

func (*MattersExportsCreateCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*MattersExportsCreateCall)Header

Header returns a http.Header that can be modified by the caller to addheaders to the request.

typeMattersExportsDeleteCall

type MattersExportsDeleteCall struct {// contains filtered or unexported fields}

func (*MattersExportsDeleteCall)Context

Context sets the context to be used in this call's Do method.

func (*MattersExportsDeleteCall)Do

Do executes the "vault.matters.exports.delete" call.Any non-2xx status code is an error. Response headers are in either*Empty.ServerResponse.Header or (if a response was returned at all) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.

func (*MattersExportsDeleteCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*MattersExportsDeleteCall)Header

Header returns a http.Header that can be modified by the caller to addheaders to the request.

typeMattersExportsGetCall

type MattersExportsGetCall struct {// contains filtered or unexported fields}

func (*MattersExportsGetCall)Context

Context sets the context to be used in this call's Do method.

func (*MattersExportsGetCall)Do

Do executes the "vault.matters.exports.get" call.Any non-2xx status code is an error. Response headers are in either*Export.ServerResponse.Header or (if a response was returned at all) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.

func (*MattersExportsGetCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*MattersExportsGetCall)Header

Header returns a http.Header that can be modified by the caller to addheaders to the request.

func (*MattersExportsGetCall)IfNoneMatch

func (c *MattersExportsGetCall) IfNoneMatch(entityTagstring) *MattersExportsGetCall

IfNoneMatch sets an optional parameter which makes the operation fail if theobject's ETag matches the given value. This is useful for getting updatesonly after the object has changed since the last request.

typeMattersExportsListCall

type MattersExportsListCall struct {// contains filtered or unexported fields}

func (*MattersExportsListCall)Context

Context sets the context to be used in this call's Do method.

func (*MattersExportsListCall)Do

Do executes the "vault.matters.exports.list" call.Any non-2xx status code is an error. Response headers are in either*ListExportsResponse.ServerResponse.Header or (if a response was returned atall) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified tocheck whether the returned error was because http.StatusNotModified wasreturned.

func (*MattersExportsListCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*MattersExportsListCall)Header

Header returns a http.Header that can be modified by the caller to addheaders to the request.

func (*MattersExportsListCall)IfNoneMatch

func (c *MattersExportsListCall) IfNoneMatch(entityTagstring) *MattersExportsListCall

IfNoneMatch sets an optional parameter which makes the operation fail if theobject's ETag matches the given value. This is useful for getting updatesonly after the object has changed since the last request.

func (*MattersExportsListCall)PageSize

PageSize sets the optional parameter "pageSize": The number of exports toreturn in the response.

func (*MattersExportsListCall)PageToken

PageToken sets the optional parameter "pageToken": The pagination token asreturned in the response.

func (*MattersExportsListCall)Pages

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.

typeMattersExportsService

type MattersExportsService struct {// contains filtered or unexported fields}

funcNewMattersExportsService

func NewMattersExportsService(s *Service) *MattersExportsService

func (*MattersExportsService)Create

func (r *MattersExportsService) Create(matterIdstring, export *Export) *MattersExportsCreateCall

Create: Creates an export.

- matterId: The matter ID.

func (*MattersExportsService)Delete

func (r *MattersExportsService) Delete(matterIdstring, exportIdstring) *MattersExportsDeleteCall

Delete: Deletes an export.

- exportId: The export ID.- matterId: The matter ID.

func (*MattersExportsService)Get

func (r *MattersExportsService) Get(matterIdstring, exportIdstring) *MattersExportsGetCall

Get: Gets an export.

- exportId: The export ID.- matterId: The matter ID.

func (*MattersExportsService)List

List: Lists details about the exports in the specified matter.

- matterId: The matter ID.

typeMattersGetCall

type MattersGetCall struct {// contains filtered or unexported fields}

func (*MattersGetCall)Context

Context sets the context to be used in this call's Do method.

func (*MattersGetCall)Do

Do executes the "vault.matters.get" call.Any non-2xx status code is an error. Response headers are in either*Matter.ServerResponse.Header or (if a response was returned at all) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.

func (*MattersGetCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*MattersGetCall)Header

func (c *MattersGetCall) Header()http.Header

Header returns a http.Header that can be modified by the caller to addheaders to the request.

func (*MattersGetCall)IfNoneMatch

func (c *MattersGetCall) IfNoneMatch(entityTagstring) *MattersGetCall

IfNoneMatch sets an optional parameter which makes the operation fail if theobject's ETag matches the given value. This is useful for getting updatesonly after the object has changed since the last request.

func (*MattersGetCall)View

func (c *MattersGetCall) View(viewstring) *MattersGetCall

View sets the optional parameter "view": Specifies how much informationabout 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/workspace/vault/reference/rest/v1/matters#matterpermission)).

typeMattersHoldsAccountsCreateCall

type MattersHoldsAccountsCreateCall struct {// contains filtered or unexported fields}

func (*MattersHoldsAccountsCreateCall)Context

Context sets the context to be used in this call's Do method.

func (*MattersHoldsAccountsCreateCall)Do

Do executes the "vault.matters.holds.accounts.create" call.Any non-2xx status code is an error. Response headers are in either*HeldAccount.ServerResponse.Header or (if a response was returned at all) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.

func (*MattersHoldsAccountsCreateCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*MattersHoldsAccountsCreateCall)Header

Header returns a http.Header that can be modified by the caller to addheaders to the request.

typeMattersHoldsAccountsDeleteCall

type MattersHoldsAccountsDeleteCall struct {// contains filtered or unexported fields}

func (*MattersHoldsAccountsDeleteCall)Context

Context sets the context to be used in this call's Do method.

func (*MattersHoldsAccountsDeleteCall)Do

Do executes the "vault.matters.holds.accounts.delete" call.Any non-2xx status code is an error. Response headers are in either*Empty.ServerResponse.Header or (if a response was returned at all) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.

func (*MattersHoldsAccountsDeleteCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*MattersHoldsAccountsDeleteCall)Header

Header returns a http.Header that can be modified by the caller to addheaders to the request.

typeMattersHoldsAccountsListCall

type MattersHoldsAccountsListCall struct {// contains filtered or unexported fields}

func (*MattersHoldsAccountsListCall)Context

Context sets the context to be used in this call's Do method.

func (*MattersHoldsAccountsListCall)Do

Do executes the "vault.matters.holds.accounts.list" call.Any non-2xx status code is an error. Response headers are in either*ListHeldAccountsResponse.ServerResponse.Header or (if a response wasreturned at all) in error.(*googleapi.Error).Header. Usegoogleapi.IsNotModified to check whether the returned error was becausehttp.StatusNotModified was returned.

func (*MattersHoldsAccountsListCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*MattersHoldsAccountsListCall)Header

Header returns a http.Header that can be modified by the caller to addheaders to the request.

func (*MattersHoldsAccountsListCall)IfNoneMatch

IfNoneMatch sets an optional parameter which makes the operation fail if theobject's ETag matches the given value. This is useful for getting updatesonly after the object has changed since the last request.

typeMattersHoldsAccountsService

type MattersHoldsAccountsService struct {// contains filtered or unexported fields}

funcNewMattersHoldsAccountsService

func NewMattersHoldsAccountsService(s *Service) *MattersHoldsAccountsService

func (*MattersHoldsAccountsService)Create

Create: Adds an account to a hold. Accounts can be added only to a hold thatdoes not have an organizational unit set. If you try to add an account to anorganizational unit-based hold, an error is returned.

- holdId: The hold ID.- matterId: The matter ID.

func (*MattersHoldsAccountsService)Delete

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

List: Lists the accounts covered by a hold. This can list onlyindividually-specified accounts covered by the hold. If the hold covers anorganizational unit, use the Admin SDK(https://developers.google.com/admin-sdk/). to list the members of theorganizational unit on hold.

- holdId: The hold ID.- matterId: The matter ID.

typeMattersHoldsAddHeldAccountsCall

type MattersHoldsAddHeldAccountsCall struct {// contains filtered or unexported fields}

func (*MattersHoldsAddHeldAccountsCall)Context

Context sets the context to be used in this call's Do method.

func (*MattersHoldsAddHeldAccountsCall)Do

Do executes the "vault.matters.holds.addHeldAccounts" call.Any non-2xx status code is an error. Response headers are in either*AddHeldAccountsResponse.ServerResponse.Header or (if a response wasreturned at all) in error.(*googleapi.Error).Header. Usegoogleapi.IsNotModified to check whether the returned error was becausehttp.StatusNotModified was returned.

func (*MattersHoldsAddHeldAccountsCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*MattersHoldsAddHeldAccountsCall)Header

Header returns a http.Header that can be modified by the caller to addheaders to the request.

typeMattersHoldsCreateCall

type MattersHoldsCreateCall struct {// contains filtered or unexported fields}

func (*MattersHoldsCreateCall)Context

Context sets the context to be used in this call's Do method.

func (*MattersHoldsCreateCall)Do

Do executes the "vault.matters.holds.create" call.Any non-2xx status code is an error. Response headers are in either*Hold.ServerResponse.Header or (if a response was returned at all) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.

func (*MattersHoldsCreateCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*MattersHoldsCreateCall)Header

Header returns a http.Header that can be modified by the caller to addheaders to the request.

typeMattersHoldsDeleteCall

type MattersHoldsDeleteCall struct {// contains filtered or unexported fields}

func (*MattersHoldsDeleteCall)Context

Context sets the context to be used in this call's Do method.

func (*MattersHoldsDeleteCall)Do

Do executes the "vault.matters.holds.delete" call.Any non-2xx status code is an error. Response headers are in either*Empty.ServerResponse.Header or (if a response was returned at all) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.

func (*MattersHoldsDeleteCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*MattersHoldsDeleteCall)Header

Header returns a http.Header that can be modified by the caller to addheaders to the request.

typeMattersHoldsGetCall

type MattersHoldsGetCall struct {// contains filtered or unexported fields}

func (*MattersHoldsGetCall)Context

Context sets the context to be used in this call's Do method.

func (*MattersHoldsGetCall)Do

Do executes the "vault.matters.holds.get" call.Any non-2xx status code is an error. Response headers are in either*Hold.ServerResponse.Header or (if a response was returned at all) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.

func (*MattersHoldsGetCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*MattersHoldsGetCall)Header

func (c *MattersHoldsGetCall) Header()http.Header

Header returns a http.Header that can be modified by the caller to addheaders to the request.

func (*MattersHoldsGetCall)IfNoneMatch

func (c *MattersHoldsGetCall) IfNoneMatch(entityTagstring) *MattersHoldsGetCall

IfNoneMatch sets an optional parameter which makes the operation fail if theobject's ETag matches the given value. This is useful for getting updatesonly after the object has changed since the last request.

func (*MattersHoldsGetCall)View

View sets the optional parameter "view": The amount of detail to return fora 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.

typeMattersHoldsListCall

type MattersHoldsListCall struct {// contains filtered or unexported fields}

func (*MattersHoldsListCall)Context

Context sets the context to be used in this call's Do method.

func (*MattersHoldsListCall)Do

Do executes the "vault.matters.holds.list" call.Any non-2xx status code is an error. Response headers are in either*ListHoldsResponse.ServerResponse.Header or (if a response was returned atall) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified tocheck whether the returned error was because http.StatusNotModified wasreturned.

func (*MattersHoldsListCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*MattersHoldsListCall)Header

func (c *MattersHoldsListCall) Header()http.Header

Header returns a http.Header that can be modified by the caller to addheaders to the request.

func (*MattersHoldsListCall)IfNoneMatch

func (c *MattersHoldsListCall) IfNoneMatch(entityTagstring) *MattersHoldsListCall

IfNoneMatch sets an optional parameter which makes the operation fail if theobject's ETag matches the given value. This is useful for getting updatesonly after the object has changed since the last request.

func (*MattersHoldsListCall)PageSize

func (c *MattersHoldsListCall) PageSize(pageSizeint64) *MattersHoldsListCall

PageSize sets the optional parameter "pageSize": The number of holds toreturn in the response, between 0 and 100 inclusive. Leaving this empty, oras 0, is the same as **page_size** = 100.

func (*MattersHoldsListCall)PageToken

func (c *MattersHoldsListCall) PageToken(pageTokenstring) *MattersHoldsListCall

PageToken sets the optional parameter "pageToken": The pagination token asreturned in the response. An empty token means start from the beginning.

func (*MattersHoldsListCall)Pages

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

View sets the optional parameter "view": The amount of detail to return fora 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.

typeMattersHoldsRemoveHeldAccountsCall

type MattersHoldsRemoveHeldAccountsCall struct {// contains filtered or unexported fields}

func (*MattersHoldsRemoveHeldAccountsCall)Context

Context sets the context to be used in this call's Do method.

func (*MattersHoldsRemoveHeldAccountsCall)Do

Do executes the "vault.matters.holds.removeHeldAccounts" call.Any non-2xx status code is an error. Response headers are in either*RemoveHeldAccountsResponse.ServerResponse.Header or (if a response wasreturned at all) in error.(*googleapi.Error).Header. Usegoogleapi.IsNotModified to check whether the returned error was becausehttp.StatusNotModified was returned.

func (*MattersHoldsRemoveHeldAccountsCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*MattersHoldsRemoveHeldAccountsCall)Header

Header returns a http.Header that can be modified by the caller to addheaders to the request.

typeMattersHoldsService

type MattersHoldsService struct {Accounts *MattersHoldsAccountsService// contains filtered or unexported fields}

funcNewMattersHoldsService

func NewMattersHoldsService(s *Service) *MattersHoldsService

func (*MattersHoldsService)AddHeldAccounts

func (r *MattersHoldsService) AddHeldAccounts(matterIdstring, holdIdstring, addheldaccountsrequest *AddHeldAccountsRequest) *MattersHoldsAddHeldAccountsCall

AddHeldAccounts: Adds accounts to a hold. Returns a list of accounts thathave been successfully added. Accounts can be added only to an existingaccount-based hold.

- holdId: The hold ID.- matterId: The matter ID.

func (*MattersHoldsService)Create

func (r *MattersHoldsService) Create(matterIdstring, hold *Hold) *MattersHoldsCreateCall

Create: Creates a hold in the specified matter.

- matterId: The matter ID.

func (*MattersHoldsService)Delete

func (r *MattersHoldsService) Delete(matterIdstring, holdIdstring) *MattersHoldsDeleteCall

Delete: Removes the specified hold and releases the accounts ororganizational unit covered by the hold. If the data is not preserved byanother hold or retention rule, it might be purged.

- holdId: The hold ID.- matterId: The matter ID.

func (*MattersHoldsService)Get

func (r *MattersHoldsService) Get(matterIdstring, holdIdstring) *MattersHoldsGetCall

Get: Gets the specified hold.

- holdId: The hold ID.- matterId: The matter ID.

func (*MattersHoldsService)List

List: Lists the holds in a matter.

- matterId: The matter ID.

func (*MattersHoldsService)RemoveHeldAccounts

func (r *MattersHoldsService) RemoveHeldAccounts(matterIdstring, holdIdstring, removeheldaccountsrequest *RemoveHeldAccountsRequest) *MattersHoldsRemoveHeldAccountsCall

RemoveHeldAccounts: Removes the specified accounts from a hold. Returns alist of statuses in the same order as the request.

- holdId: The hold ID.- matterId: The matter ID.

func (*MattersHoldsService)Update

func (r *MattersHoldsService) Update(matterIdstring, holdIdstring, hold *Hold) *MattersHoldsUpdateCall

Update: Updates the scope (organizational unit or accounts) and queryparameters of a hold. You cannot add accounts to a hold that covers anorganizational unit, nor can you add organizational units to a hold thatcovers individual accounts. If you try, the unsupported values are ignored.

- holdId: The ID of the hold.- matterId: The matter ID.

typeMattersHoldsUpdateCall

type MattersHoldsUpdateCall struct {// contains filtered or unexported fields}

func (*MattersHoldsUpdateCall)Context

Context sets the context to be used in this call's Do method.

func (*MattersHoldsUpdateCall)Do

Do executes the "vault.matters.holds.update" call.Any non-2xx status code is an error. Response headers are in either*Hold.ServerResponse.Header or (if a response was returned at all) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.

func (*MattersHoldsUpdateCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*MattersHoldsUpdateCall)Header

Header returns a http.Header that can be modified by the caller to addheaders to the request.

typeMattersListCall

type MattersListCall struct {// contains filtered or unexported fields}

func (*MattersListCall)Context

Context sets the context to be used in this call's Do method.

func (*MattersListCall)Do

Do executes the "vault.matters.list" call.Any non-2xx status code is an error. Response headers are in either*ListMattersResponse.ServerResponse.Header or (if a response was returned atall) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified tocheck whether the returned error was because http.StatusNotModified wasreturned.

func (*MattersListCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*MattersListCall)Header

func (c *MattersListCall) Header()http.Header

Header returns a http.Header that can be modified by the caller to addheaders to the request.

func (*MattersListCall)IfNoneMatch

func (c *MattersListCall) IfNoneMatch(entityTagstring) *MattersListCall

IfNoneMatch sets an optional parameter which makes the operation fail if theobject's ETag matches the given value. This is useful for getting updatesonly after the object has changed since the last request.

func (*MattersListCall)PageSize

func (c *MattersListCall) PageSize(pageSizeint64) *MattersListCall

PageSize sets the optional parameter "pageSize": The number of matters toreturn in the response. Default and maximum are 100.

func (*MattersListCall)PageToken

func (c *MattersListCall) PageToken(pageTokenstring) *MattersListCall

PageToken sets the optional parameter "pageToken": The pagination token asreturned in the response.

func (*MattersListCall)Pages

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(statestring) *MattersListCall

State sets the optional parameter "state": If set, lists only matters withthe 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

View sets the optional parameter "view": Specifies how much informationabout 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/workspace/vault/reference/rest/v1/matters#matterpermission)).

typeMattersRemovePermissionsCall

type MattersRemovePermissionsCall struct {// contains filtered or unexported fields}

func (*MattersRemovePermissionsCall)Context

Context sets the context to be used in this call's Do method.

func (*MattersRemovePermissionsCall)Do

Do executes the "vault.matters.removePermissions" call.Any non-2xx status code is an error. Response headers are in either*Empty.ServerResponse.Header or (if a response was returned at all) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.

func (*MattersRemovePermissionsCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*MattersRemovePermissionsCall)Header

Header returns a http.Header that can be modified by the caller to addheaders to the request.

typeMattersReopenCall

type MattersReopenCall struct {// contains filtered or unexported fields}

func (*MattersReopenCall)Context

Context sets the context to be used in this call's Do method.

func (*MattersReopenCall)Do

Do executes the "vault.matters.reopen" call.Any non-2xx status code is an error. Response headers are in either*ReopenMatterResponse.ServerResponse.Header or (if a response was returnedat all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified tocheck whether the returned error was because http.StatusNotModified wasreturned.

func (*MattersReopenCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*MattersReopenCall)Header

func (c *MattersReopenCall) Header()http.Header

Header returns a http.Header that can be modified by the caller to addheaders to the request.

typeMattersSavedQueriesCreateCall

type MattersSavedQueriesCreateCall struct {// contains filtered or unexported fields}

func (*MattersSavedQueriesCreateCall)Context

Context sets the context to be used in this call's Do method.

func (*MattersSavedQueriesCreateCall)Do

Do executes the "vault.matters.savedQueries.create" call.Any non-2xx status code is an error. Response headers are in either*SavedQuery.ServerResponse.Header or (if a response was returned at all) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.

func (*MattersSavedQueriesCreateCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*MattersSavedQueriesCreateCall)Header

Header returns a http.Header that can be modified by the caller to addheaders to the request.

typeMattersSavedQueriesDeleteCall

type MattersSavedQueriesDeleteCall struct {// contains filtered or unexported fields}

func (*MattersSavedQueriesDeleteCall)Context

Context sets the context to be used in this call's Do method.

func (*MattersSavedQueriesDeleteCall)Do

Do executes the "vault.matters.savedQueries.delete" call.Any non-2xx status code is an error. Response headers are in either*Empty.ServerResponse.Header or (if a response was returned at all) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.

func (*MattersSavedQueriesDeleteCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*MattersSavedQueriesDeleteCall)Header

Header returns a http.Header that can be modified by the caller to addheaders to the request.

typeMattersSavedQueriesGetCall

type MattersSavedQueriesGetCall struct {// contains filtered or unexported fields}

func (*MattersSavedQueriesGetCall)Context

Context sets the context to be used in this call's Do method.

func (*MattersSavedQueriesGetCall)Do

Do executes the "vault.matters.savedQueries.get" call.Any non-2xx status code is an error. Response headers are in either*SavedQuery.ServerResponse.Header or (if a response was returned at all) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.

func (*MattersSavedQueriesGetCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*MattersSavedQueriesGetCall)Header

Header returns a http.Header that can be modified by the caller to addheaders to the request.

func (*MattersSavedQueriesGetCall)IfNoneMatch

IfNoneMatch sets an optional parameter which makes the operation fail if theobject's ETag matches the given value. This is useful for getting updatesonly after the object has changed since the last request.

typeMattersSavedQueriesListCall

type MattersSavedQueriesListCall struct {// contains filtered or unexported fields}

func (*MattersSavedQueriesListCall)Context

Context sets the context to be used in this call's Do method.

func (*MattersSavedQueriesListCall)Do

Do executes the "vault.matters.savedQueries.list" call.Any non-2xx status code is an error. Response headers are in either*ListSavedQueriesResponse.ServerResponse.Header or (if a response wasreturned at all) in error.(*googleapi.Error).Header. Usegoogleapi.IsNotModified to check whether the returned error was becausehttp.StatusNotModified was returned.

func (*MattersSavedQueriesListCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*MattersSavedQueriesListCall)Header

Header returns a http.Header that can be modified by the caller to addheaders to the request.

func (*MattersSavedQueriesListCall)IfNoneMatch

IfNoneMatch sets an optional parameter which makes the operation fail if theobject's ETag matches the given value. This is useful for getting updatesonly after the object has changed since the last request.

func (*MattersSavedQueriesListCall)PageSize

PageSize sets the optional parameter "pageSize": The maximum number of savedqueries to return.

func (*MattersSavedQueriesListCall)PageToken

PageToken sets the optional parameter "pageToken": The pagination token asreturned in the previous response. An empty token means start from thebeginning.

func (*MattersSavedQueriesListCall)Pages

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.

typeMattersSavedQueriesService

type MattersSavedQueriesService struct {// contains filtered or unexported fields}

funcNewMattersSavedQueriesService

func NewMattersSavedQueriesService(s *Service) *MattersSavedQueriesService

func (*MattersSavedQueriesService)Create

Create: Creates a saved query.

- matterId: The ID of the matter to create the saved query in.

func (*MattersSavedQueriesService)Delete

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

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

List: Lists the saved queries in a matter.

- matterId: The ID of the matter to get the saved queries for.

typeMattersService

type MattersService struct {Exports *MattersExportsServiceHolds *MattersHoldsServiceSavedQueries *MattersSavedQueriesService// contains filtered or unexported fields}

funcNewMattersService

func NewMattersService(s *Service) *MattersService

func (*MattersService)AddPermissions

func (r *MattersService) AddPermissions(matterIdstring, addmatterpermissionsrequest *AddMatterPermissionsRequest) *MattersAddPermissionsCall

AddPermissions: Adds an account as a matter collaborator.

- matterId: The matter ID.

func (*MattersService)Close

func (r *MattersService) Close(matterIdstring, closematterrequest *CloseMatterRequest) *MattersCloseCall

Close: Closes the specified matter. Returns the matter with updated state.

- matterId: The matter ID.

func (*MattersService)Countadded inv0.34.0

func (r *MattersService) Count(matterIdstring, 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 initialstate is open, and the owner is the method caller. Returns the createdmatter with default view.

func (*MattersService)Delete

func (r *MattersService) Delete(matterIdstring) *MattersDeleteCall

Delete: Deletes the specified matter. Returns the matter with updated state.

- matterId: The matter ID.

func (*MattersService)Get

func (r *MattersService) Get(matterIdstring) *MattersGetCall

Get: Gets the specified matter.

- matterId: The matter ID.

func (*MattersService)List

List: Lists matters the requestor has access to.

func (*MattersService)RemovePermissions

func (r *MattersService) RemovePermissions(matterIdstring, removematterpermissionsrequest *RemoveMatterPermissionsRequest) *MattersRemovePermissionsCall

RemovePermissions: Removes an account as a matter collaborator.

- matterId: The matter ID.

func (*MattersService)Reopen

func (r *MattersService) Reopen(matterIdstring, 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(matterIdstring, undeletematterrequest *UndeleteMatterRequest) *MattersUndeleteCall

Undelete: Undeletes the specified matter. Returns the matter with updatedstate.

- matterId: The matter ID.

func (*MattersService)Update

func (r *MattersService) Update(matterIdstring, matter *Matter) *MattersUpdateCall

Update: Updates the specified matter. This updates only the name anddescription of the matter, identified by matter ID. Changes to any otherfields are ignored. Returns the default view of the matter.

- matterId: The matter ID.

typeMattersUndeleteCall

type MattersUndeleteCall struct {// contains filtered or unexported fields}

func (*MattersUndeleteCall)Context

Context sets the context to be used in this call's Do method.

func (*MattersUndeleteCall)Do

Do executes the "vault.matters.undelete" call.Any non-2xx status code is an error. Response headers are in either*Matter.ServerResponse.Header or (if a response was returned at all) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.

func (*MattersUndeleteCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*MattersUndeleteCall)Header

func (c *MattersUndeleteCall) Header()http.Header

Header returns a http.Header that can be modified by the caller to addheaders to the request.

typeMattersUpdateCall

type MattersUpdateCall struct {// contains filtered or unexported fields}

func (*MattersUpdateCall)Context

Context sets the context to be used in this call's Do method.

func (*MattersUpdateCall)Do

Do executes the "vault.matters.update" call.Any non-2xx status code is an error. Response headers are in either*Matter.ServerResponse.Header or (if a response was returned at all) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.

func (*MattersUpdateCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*MattersUpdateCall)Header

func (c *MattersUpdateCall) Header()http.Header

Header returns a http.Header that can be modified by the caller to addheaders to the request.

typeOperationadded inv0.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.Donebool `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.Metadatagoogleapi.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}`.Namestring `json:"name,omitempty"`// Response: The normal, successful response of the operation. 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`.Responsegoogleapi.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. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.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. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

Operation: This resource represents a long-running operation that is theresult of a network API call.

func (Operation)MarshalJSONadded inv0.34.0

func (sOperation) MarshalJSON() ([]byte,error)

typeOperationsCancelCalladded inv0.34.0

type OperationsCancelCall struct {// contains filtered or unexported fields}

func (*OperationsCancelCall)Contextadded inv0.34.0

Context sets the context to be used in this call's Do method.

func (*OperationsCancelCall)Doadded inv0.34.0

Do executes the "vault.operations.cancel" call.Any non-2xx status code is an error. Response headers are in either*Empty.ServerResponse.Header or (if a response was returned at all) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.

func (*OperationsCancelCall)Fieldsadded inv0.34.0

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*OperationsCancelCall)Headeradded inv0.34.0

func (c *OperationsCancelCall) Header()http.Header

Header returns a http.Header that can be modified by the caller to addheaders to the request.

typeOperationsDeleteCalladded inv0.11.0

type OperationsDeleteCall struct {// contains filtered or unexported fields}

func (*OperationsDeleteCall)Contextadded inv0.11.0

Context sets the context to be used in this call's Do method.

func (*OperationsDeleteCall)Doadded inv0.11.0

Do executes the "vault.operations.delete" call.Any non-2xx status code is an error. Response headers are in either*Empty.ServerResponse.Header or (if a response was returned at all) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.

func (*OperationsDeleteCall)Fieldsadded inv0.11.0

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*OperationsDeleteCall)Headeradded inv0.11.0

func (c *OperationsDeleteCall) Header()http.Header

Header returns a http.Header that can be modified by the caller to addheaders to the request.

typeOperationsGetCalladded inv0.34.0

type OperationsGetCall struct {// contains filtered or unexported fields}

func (*OperationsGetCall)Contextadded inv0.34.0

Context sets the context to be used in this call's Do method.

func (*OperationsGetCall)Doadded inv0.34.0

Do executes the "vault.operations.get" call.Any non-2xx status code is an error. Response headers are in either*Operation.ServerResponse.Header or (if a response was returned at all) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.

func (*OperationsGetCall)Fieldsadded inv0.34.0

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*OperationsGetCall)Headeradded inv0.34.0

func (c *OperationsGetCall) Header()http.Header

Header returns a http.Header that can be modified by the caller to addheaders to the request.

func (*OperationsGetCall)IfNoneMatchadded inv0.34.0

func (c *OperationsGetCall) IfNoneMatch(entityTagstring) *OperationsGetCall

IfNoneMatch sets an optional parameter which makes the operation fail if theobject's ETag matches the given value. This is useful for getting updatesonly after the object has changed since the last request.

typeOperationsListCalladded inv0.34.0

type OperationsListCall struct {// contains filtered or unexported fields}

func (*OperationsListCall)Contextadded inv0.34.0

Context sets the context to be used in this call's Do method.

func (*OperationsListCall)Doadded inv0.34.0

Do executes the "vault.operations.list" call.Any non-2xx status code is an error. Response headers are in either*ListOperationsResponse.ServerResponse.Header or (if a response was returnedat all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified tocheck whether the returned error was because http.StatusNotModified wasreturned.

func (*OperationsListCall)Fieldsadded inv0.34.0

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*OperationsListCall)Filteradded inv0.34.0

Filter sets the optional parameter "filter": The standard list filter.

func (*OperationsListCall)Headeradded inv0.34.0

func (c *OperationsListCall) Header()http.Header

Header returns a http.Header that can be modified by the caller to addheaders to the request.

func (*OperationsListCall)IfNoneMatchadded inv0.34.0

func (c *OperationsListCall) IfNoneMatch(entityTagstring) *OperationsListCall

IfNoneMatch sets an optional parameter which makes the operation fail if theobject's ETag matches the given value. This is useful for getting updatesonly after the object has changed since the last request.

func (*OperationsListCall)PageSizeadded inv0.34.0

func (c *OperationsListCall) PageSize(pageSizeint64) *OperationsListCall

PageSize sets the optional parameter "pageSize": The standard list pagesize.

func (*OperationsListCall)PageTokenadded inv0.34.0

func (c *OperationsListCall) PageToken(pageTokenstring) *OperationsListCall

PageToken sets the optional parameter "pageToken": The standard list pagetoken.

func (*OperationsListCall)Pagesadded inv0.34.0

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 (*OperationsListCall)ReturnPartialSuccessadded inv0.253.0

func (c *OperationsListCall) ReturnPartialSuccess(returnPartialSuccessbool) *OperationsListCall

ReturnPartialSuccess sets the optional parameter "returnPartialSuccess":When set to `true`, operations that are reachable are returned as normal,and those that are unreachable are returned in the[ListOperationsResponse.unreachable] field. This can only be `true` whenreading across collections e.g. when `parent` is set to"projects/example/locations/-". This field is not by default supported andwill result in an `UNIMPLEMENTED` error if set unless explicitly documentedotherwise in service or product specific documentation.

typeOperationsServiceadded inv0.11.0

type OperationsService struct {// contains filtered or unexported fields}

funcNewOperationsServiceadded inv0.11.0

func NewOperationsService(s *Service) *OperationsService

func (*OperationsService)Canceladded inv0.34.0

func (r *OperationsService) Cancel(namestring, canceloperationrequest *CancelOperationRequest) *OperationsCancelCall

Cancel: Starts asynchronous cancellation on a long-running operation. Theserver makes a best effort to cancel the operation, but success is notguaranteed. If the server doesn't support this method, it returns`google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation orother methods to check whether the cancellation succeeded or whether theoperation completed despite cancellation. On successful cancellation, theoperation is not deleted; instead, it becomes an operation with anOperation.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)Deleteadded inv0.11.0

Delete: Deletes a long-running operation. This method indicates that theclient is no longer interested in the operation result. It does not cancelthe 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)Getadded inv0.34.0

Get: Gets the latest state of a long-running operation. Clients can use thismethod to poll the operation result at intervals as recommended by the APIservice.

- name: The name of the operation resource.

func (*OperationsService)Listadded inv0.34.0

List: Lists operations that match the specified filter in the request. Ifthe server doesn't support this method, it returns `UNIMPLEMENTED`.

- name: The name of the operation's parent resource.

typeOrgUnitInfo

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/).OrgUnitIdstring `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. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.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. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

OrgUnitInfo: The organizational unit to search

func (OrgUnitInfo)MarshalJSON

func (sOrgUnitInfo) MarshalJSON() ([]byte,error)

typeQuery

type Query struct {// AccountInfo: Required when **SearchMethod** is **ACCOUNT**.AccountInfo *AccountInfo `json:"accountInfo,omitempty"`// CalendarOptions: Set Calendar search-specific options.CalendarOptions *CalendarOptions `json:"calendarOptions,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 export, Google Chat only. For holds, Google Chat and// classic Hangouts.//   "VOICE" - Google Voice.//   "CALENDAR" - Calendar.//   "GEMINI" - Gemini.Corpusstring `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)DataScopestring `json:"dataScope,omitempty"`// DriveDocumentInfo: Required when **SearchMethod** is **DRIVE_DOCUMENT**.DriveDocumentInfo *DriveDocumentInfo `json:"driveDocumentInfo,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.EndTimestring `json:"endTime,omitempty"`// GeminiOptions: Set Gemini search-specific options.GeminiOptions *GeminiOptions `json:"geminiOptions,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/workspace/vault/reference/rest/v1// /Query#accountinfo).//   "ORG_UNIT" - Search the data of all accounts in the organizational unit// specified in// [OrgUnitInfo](https://developers.google.com/workspace/vault/reference/rest/v1// /Query#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/workspace/vault/reference/re// st/v1/Query#hangoutschatinfo).//   "SITES_URL" - Search for sites by the published site URLs specified in// [SitesUrlInfo](https://developers.google.com/workspace/vault/reference/rest/v// 1/Query#sitesurlinfo).//   "SHARED_DRIVE" - Search the files in the shared drives specified in// [SharedDriveInfo](https://developers.google.com/workspace/vault/reference/res// t/v1/Query#shareddriveinfo).//   "DRIVE_DOCUMENT" - Retrieve the documents specified in DriveDocumentInfo.Methodstring `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/workspace/vault/reference/rest/v1// /Query#accountinfo).//   "ORG_UNIT" - Search the data of all accounts in the organizational unit// specified in// [OrgUnitInfo](https://developers.google.com/workspace/vault/reference/rest/v1// /Query#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/workspace/vault/reference/re// st/v1/Query#hangoutschatinfo).//   "SITES_URL" - Search for sites by the published site URLs specified in// [SitesUrlInfo](https://developers.google.com/workspace/vault/reference/rest/v// 1/Query#sitesurlinfo).//   "SHARED_DRIVE" - Search the files in the shared drives specified in// [SharedDriveInfo](https://developers.google.com/workspace/vault/reference/res// t/v1/Query#shareddriveinfo).//   "DRIVE_DOCUMENT" - Retrieve the documents specified in DriveDocumentInfo.SearchMethodstring `json:"searchMethod,omitempty"`// SharedDriveInfo: Required when **SearchMethod** is **SHARED_DRIVE**.SharedDriveInfo *SharedDriveInfo `json:"sharedDriveInfo,omitempty"`// SitesUrlInfo: Required when **SearchMethod** is **SITES_URL**.SitesUrlInfo *SitesUrlInfo `json:"sitesUrlInfo,omitempty"`// StartTime: The start time for the search query. Specify in GMT. The value is// rounded to 12 AM on the specified date.StartTimestring `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.Termsstring `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).TimeZonestring `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. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.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. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

Query: The query definition used for search and export.

func (Query)MarshalJSON

func (sQuery) MarshalJSON() ([]byte,error)

typeRemoveHeldAccountsRequest

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. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.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. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

RemoveHeldAccountsRequest: Remove a list of accounts from a hold.

func (RemoveHeldAccountsRequest)MarshalJSON

func (sRemoveHeldAccountsRequest) MarshalJSON() ([]byte,error)

typeRemoveHeldAccountsResponse

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. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.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. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

RemoveHeldAccountsResponse: Response for batch delete held accounts.

func (RemoveHeldAccountsResponse)MarshalJSON

func (sRemoveHeldAccountsResponse) MarshalJSON() ([]byte,error)

typeRemoveMatterPermissionsRequest

type RemoveMatterPermissionsRequest struct {// AccountId: The account ID.AccountIdstring `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. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.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. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

RemoveMatterPermissionsRequest: Remove an account as a matter collaborator.

func (RemoveMatterPermissionsRequest)MarshalJSON

func (sRemoveMatterPermissionsRequest) MarshalJSON() ([]byte,error)

typeReopenMatterRequest

type ReopenMatterRequest struct {}

ReopenMatterRequest: Reopen a matter by ID.

typeReopenMatterResponse

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. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.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. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

ReopenMatterResponse: Response to a ReopenMatterRequest.

func (ReopenMatterResponse)MarshalJSON

func (sReopenMatterResponse) MarshalJSON() ([]byte,error)

typeSavedQuery

type SavedQuery struct {// CreateTime: Output only. The server-generated timestamp when the saved query// was created.CreateTimestring `json:"createTime,omitempty"`// DisplayName: The name of the saved query.DisplayNamestring `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.MatterIdstring `json:"matterId,omitempty"`// Query: The search parameters of the saved query.Query *Query `json:"query,omitempty"`// SavedQueryId: A unique identifier for the saved query.SavedQueryIdstring `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. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.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. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.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 thematter shared with them, or have the **View All Matters** privilege.

func (SavedQuery)MarshalJSON

func (sSavedQuery) MarshalJSON() ([]byte,error)

typeService

type Service struct {BasePathstring// API endpoint base URLUserAgentstring// optional additional User-Agent fragmentMatters *MattersServiceOperations *OperationsService// contains filtered or unexported fields}

funcNewdeprecated

func New(client *http.Client) (*Service,error)

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.

funcNewServiceadded inv0.3.0

func NewService(ctxcontext.Context, opts ...option.ClientOption) (*Service,error)

NewService creates a new Service.

typeSharedDriveInfoadded inv0.7.0

type SharedDriveInfo struct {// SharedDriveIds: A list of shared drive IDs, as provided by the Drive API// (https://developers.google.com/drive).SharedDriveIds []string `json:"sharedDriveIds,omitempty"`// ForceSendFields is a list of field names (e.g. "SharedDriveIds") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "SharedDriveIds") to include in// API requests with the JSON null value. By default, fields with empty values// are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

SharedDriveInfo: The shared drives to search

func (SharedDriveInfo)MarshalJSONadded inv0.7.0

func (sSharedDriveInfo) MarshalJSON() ([]byte,error)

typeSitesUrlInfoadded inv0.78.0

type SitesUrlInfo struct {// Urls: A list of published site URLs.Urls []string `json:"urls,omitempty"`// ForceSendFields is a list of field names (e.g. "Urls") to unconditionally// include in API requests. By default, fields with empty or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Urls") to include in API requests// with the JSON null value. By default, fields with empty values are omitted// from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

SitesUrlInfo: The published site URLs of new Google Sites to search

func (SitesUrlInfo)MarshalJSONadded inv0.78.0

func (sSitesUrlInfo) MarshalJSON() ([]byte,error)

typeStatus

type Status struct {// Code: The status code, which should be an enum value of google.rpc.Code.Codeint64 `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.Messagestring `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. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.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. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

Status: The `Status` type defines a logical error model that is suitable fordifferent programming environments, including REST APIs and RPC APIs. It isused by gRPC (https://github.com/grpc). Each `Status` message contains threepieces of data: error code, error message, and error details. You can findout more about this error model and how to work with it in the API DesignGuide (https://cloud.google.com/apis/design/errors).

func (Status)MarshalJSON

func (sStatus) MarshalJSON() ([]byte,error)

typeTeamDriveInfo

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. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.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. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

TeamDriveInfo: Team Drives to search

func (TeamDriveInfo)MarshalJSON

func (sTeamDriveInfo) MarshalJSON() ([]byte,error)

typeUndeleteMatterRequest

type UndeleteMatterRequest struct {}

UndeleteMatterRequest: Undelete a matter by ID.

typeUserInfo

type UserInfo struct {// DisplayName: The displayed name of the user.DisplayNamestring `json:"displayName,omitempty"`// Email: The email address of the user.Emailstring `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. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.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. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

UserInfo: User's information.

func (UserInfo)MarshalJSON

func (sUserInfo) MarshalJSON() ([]byte,error)

typeVoiceExportOptionsadded inv0.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. Only available for Gmail, Groups, Hangouts and// Voice.//   "PST" - Export as PST. Only available for Gmail, Groups, Hangouts, Voice// and Calendar.//   "ICS" - Export as ICS. Only available for Calendar.//   "XML" - Export as XML. Only available for Gemini.ExportFormatstring `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. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.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. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

VoiceExportOptions: The options for Voice exports.

func (VoiceExportOptions)MarshalJSONadded inv0.36.0

func (sVoiceExportOptions) MarshalJSON() ([]byte,error)

typeVoiceOptionsadded inv0.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. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.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. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

VoiceOptions: Additional options for Voice search

func (VoiceOptions)MarshalJSONadded inv0.36.0

func (sVoiceOptions) MarshalJSON() ([]byte,error)

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f orF : Jump to
y orY : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic.Learn more.

[8]ページ先頭

©2009-2025 Movatter.jp