vault

package
v0.46.0 Latest Latest
Warning

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

Go to latest
Published: May 3, 2021 License: BSD-3-Clause Imports: 15 Imported by: 2

Documentation

Overview

Package vault provides access to the G Suite Vault API.

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

Creating a client

Usage example:

import "google.golang.org/api/vault/v1"
...
ctx := context.Background()
vaultService, err := vault.NewService(ctx)

In this example, Google Application Default Credentials are used for authentication.

For information on how to create and obtain Application Default Credentials, see https://developers.google.com/identity/protocols/application-default-credentials.

Other authentication options

By default, all available scopes (see "Constants") are used to authenticate. To restrict scopes, use option.WithScopes:

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

To use an API key for authentication (note: some APIs do not support API keys), use option.WithAPIKey:

vaultService, err := vault.NewService(ctx, option.WithAPIKey("AIza..."))

To use an OAuth token (e.g., a user token obtained via a three-legged OAuth flow), use option.WithTokenSource:

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

See https://godoc.org/google.golang.org/api/option/ for details on options.

Index

Constants

View Source
const (
	// Manage your eDiscovery data
	EdiscoveryScope = "https://www.googleapis.com/auth/ediscovery"

	// View your eDiscovery data
	EdiscoveryReadonlyScope = "https://www.googleapis.com/auth/ediscovery.readonly"
)

OAuth2 scopes used by this API.

Variables

This section is empty.

Functions

This section is empty.

Types

type AccountCount added in v0.34.0

type AccountCount struct {
	// Account: Account owner.
	Account *UserInfo `json:"account,omitempty"`

	// Count: The number of artifacts found for this account.
	Count int64 `json:"count,omitempty,string"`

	// ForceSendFields is a list of field names (e.g. "Account") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "Account") to include in
	// API requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

AccountCount: Count number for each account.

func (*AccountCount) MarshalJSON added in v0.34.0

func (s *AccountCount) MarshalJSON() ([]byte, error)

type AccountCountError added in v0.34.0

type AccountCountError struct {
	// Account: Account owner.
	Account *UserInfo `json:"account,omitempty"`

	// ErrorType: Account query error.
	//
	// Possible values:
	//   "ERROR_TYPE_UNSPECIFIED" - Default.
	//   "WILDCARD_TOO_BROAD" - Permanent - prefix terms expanded to too
	// many query terms.
	//   "TOO_MANY_TERMS" - Permanent - query contains too many terms.
	//   "LOCATION_UNAVAILABLE" - Transient - data in transit between
	// storage replicas, temporarily unavailable.
	//   "UNKNOWN" - Unrecognized error.
	//   "DEADLINE_EXCEEDED" - Deadline exceeded when querying the account.
	ErrorType string `json:"errorType,omitempty"`

	// ForceSendFields is a list of field names (e.g. "Account") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "Account") to include in
	// API requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

AccountCountError: An error that occurred when querying a specific account

func (*AccountCountError) MarshalJSON added in v0.34.0

func (s *AccountCountError) MarshalJSON() ([]byte, error)

type AccountInfo

type AccountInfo struct {
	// Emails: A set of accounts to search.
	Emails []string `json:"emails,omitempty"`

	// ForceSendFields is a list of field names (e.g. "Emails") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "Emails") to include in API
	// requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

AccountInfo: Accounts to search

func (*AccountInfo) MarshalJSON

func (s *AccountInfo) MarshalJSON() ([]byte, error)

type AddHeldAccountResult

type AddHeldAccountResult struct {
	// Account: If present, this account was successfully created.
	Account *HeldAccount `json:"account,omitempty"`

	// Status: This represents the success status. If failed, check 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 values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "Account") to include in
	// API requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

AddHeldAccountResult: A status detailing the status of each account creation, and the HeldAccount, if successful.

func (*AddHeldAccountResult) MarshalJSON

func (s *AddHeldAccountResult) MarshalJSON() ([]byte, error)

type AddHeldAccountsRequest

type AddHeldAccountsRequest struct {
	// AccountIds: Account IDs to identify which accounts to add. Only
	// account_ids or only emails should be specified, but not both.
	AccountIds []string `json:"accountIds,omitempty"`

	// Emails: Emails to identify which accounts to add. Only emails or only
	// account_ids should be specified, 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 values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "AccountIds") to include in
	// API requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

AddHeldAccountsRequest: Add a list of accounts to a hold.

func (*AddHeldAccountsRequest) MarshalJSON

func (s *AddHeldAccountsRequest) MarshalJSON() ([]byte, error)

type AddHeldAccountsResponse

type AddHeldAccountsResponse struct {
	// Responses: The list of responses, in the same order as the batch
	// request.
	Responses []*AddHeldAccountResult `json:"responses,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the
	// server.
	googleapi.ServerResponse `json:"-"`

	// ForceSendFields is a list of field names (e.g. "Responses") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "Responses") to include in
	// API requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

AddHeldAccountsResponse: Response for batch create held accounts.

func (*AddHeldAccountsResponse) MarshalJSON

func (s *AddHeldAccountsResponse) MarshalJSON() ([]byte, error)

type AddMatterPermissionsRequest

type AddMatterPermissionsRequest struct {
	// CcMe: Only relevant if send_emails is true. True to CC requestor in
	// the email message. False to not CC requestor.
	CcMe bool `json:"ccMe,omitempty"`

	// MatterPermission: The MatterPermission to add.
	MatterPermission *MatterPermission `json:"matterPermission,omitempty"`

	// SendEmails: True to send notification email to the added account.
	// False to not send notification email.
	SendEmails bool `json:"sendEmails,omitempty"`

	// ForceSendFields is a list of field names (e.g. "CcMe") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "CcMe") to include in API
	// requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

AddMatterPermissionsRequest: Add an account with the permission specified. The role cannot be owner. If an account already has a role in the matter, it will be overwritten.

func (*AddMatterPermissionsRequest) MarshalJSON

func (s *AddMatterPermissionsRequest) MarshalJSON() ([]byte, error)

type CancelOperationRequest added in v0.34.0

type CancelOperationRequest struct {
}

CancelOperationRequest: The request message for Operations.CancelOperation.

type CloseMatterRequest

type CloseMatterRequest struct {
}

CloseMatterRequest: Close a matter by ID.

type CloseMatterResponse

type CloseMatterResponse struct {
	// Matter: The updated matter, with state CLOSED.
	Matter *Matter `json:"matter,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the
	// server.
	googleapi.ServerResponse `json:"-"`

	// ForceSendFields is a list of field names (e.g. "Matter") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "Matter") to include in API
	// requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

CloseMatterResponse: Response to a CloseMatterRequest.

func (*CloseMatterResponse) MarshalJSON

func (s *CloseMatterResponse) MarshalJSON() ([]byte, error)

type CloudStorageFile

type CloudStorageFile struct {
	// BucketName: The cloud storage bucket name of this export file. Can be
	// used in cloud storage JSON/XML API, but not to list the bucket
	// contents. Instead, you can get individual export files by object
	// name.
	BucketName string `json:"bucketName,omitempty"`

	// Md5Hash: The md5 hash of the file.
	Md5Hash string `json:"md5Hash,omitempty"`

	// ObjectName: The cloud storage object name of this export file. Can be
	// used in cloud storage JSON/XML API.
	ObjectName string `json:"objectName,omitempty"`

	// Size: The size of the export file.
	Size int64 `json:"size,omitempty,string"`

	// ForceSendFields is a list of field names (e.g. "BucketName") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "BucketName") to include in
	// API requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

CloudStorageFile: An export file on cloud storage

func (*CloudStorageFile) MarshalJSON

func (s *CloudStorageFile) MarshalJSON() ([]byte, error)

type CloudStorageSink

type CloudStorageSink struct {
	// Files: Output only. The exported files on 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 values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "Files") to include in API
	// requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

CloudStorageSink: Export sink for cloud storage files.

func (*CloudStorageSink) MarshalJSON

func (s *CloudStorageSink) MarshalJSON() ([]byte, error)

type CorpusQuery

type CorpusQuery struct {
	// DriveQuery: Details pertaining to Drive holds. If set, corpus must be
	// Drive.
	DriveQuery *HeldDriveQuery `json:"driveQuery,omitempty"`

	// GroupsQuery: Details pertaining to Groups holds. If set, corpus must
	// be Groups.
	GroupsQuery *HeldGroupsQuery `json:"groupsQuery,omitempty"`

	// HangoutsChatQuery: Details pertaining to Hangouts Chat holds. If set,
	// corpus must be Hangouts Chat.
	HangoutsChatQuery *HeldHangoutsChatQuery `json:"hangoutsChatQuery,omitempty"`

	// MailQuery: Details pertaining to mail holds. If set, corpus must be
	// mail.
	MailQuery *HeldMailQuery `json:"mailQuery,omitempty"`

	// VoiceQuery: Details pertaining to Voice holds. If set, corpus must be
	// Voice.
	VoiceQuery *HeldVoiceQuery `json:"voiceQuery,omitempty"`

	// ForceSendFields is a list of field names (e.g. "DriveQuery") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "DriveQuery") to include in
	// API requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

CorpusQuery: Corpus specific queries.

func (*CorpusQuery) MarshalJSON

func (s *CorpusQuery) MarshalJSON() ([]byte, error)

type CountArtifactsMetadata added in v0.34.0

type CountArtifactsMetadata struct {
	// EndTime: End time of count operation. Available when operation is
	// done.
	EndTime string `json:"endTime,omitempty"`

	// MatterId: The matter ID of the associated matter.
	MatterId string `json:"matterId,omitempty"`

	// Query: The search query from the request.
	Query *Query `json:"query,omitempty"`

	// StartTime: Creation time of count operation.
	StartTime string `json:"startTime,omitempty"`

	// ForceSendFields is a list of field names (e.g. "EndTime") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "EndTime") to include in
	// API requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

CountArtifactsMetadata: Long running operation metadata for CountArtifacts.

func (*CountArtifactsMetadata) MarshalJSON added in v0.34.0

func (s *CountArtifactsMetadata) MarshalJSON() ([]byte, error)

type CountArtifactsRequest added in v0.34.0

type CountArtifactsRequest struct {
	// Query: The search query.
	Query *Query `json:"query,omitempty"`

	// View: Specifies the granularity of the count result returned in
	// response.
	//
	// Possible values:
	//   "COUNT_RESULT_VIEW_UNSPECIFIED" - Default. It works the same as
	// TOTAL_COUNT.
	//   "TOTAL_COUNT" - Response includes: total count, queried accounts
	// count, matching accounts count, non-queryable accounts, queried
	// account errors.
	//   "ALL" - Response includes additional breakdown of account count.
	View string `json:"view,omitempty"`

	// ForceSendFields is a list of field names (e.g. "Query") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "Query") to include in API
	// requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

CountArtifactsRequest: Count artifacts request.

func (*CountArtifactsRequest) MarshalJSON added in v0.34.0

func (s *CountArtifactsRequest) MarshalJSON() ([]byte, error)

type CountArtifactsResponse added in v0.34.0

type CountArtifactsResponse struct {
	// GroupsCountResult: Count metrics of Groups.
	GroupsCountResult *GroupsCountResult `json:"groupsCountResult,omitempty"`

	// MailCountResult: Count metrics of Mail.
	MailCountResult *MailCountResult `json:"mailCountResult,omitempty"`

	// TotalCount: Total count of artifacts. For mail and groups, artifacts
	// refers to messages.
	TotalCount int64 `json:"totalCount,omitempty,string"`

	// ForceSendFields is a list of field names (e.g. "GroupsCountResult")
	// to unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "GroupsCountResult") to
	// include in API requests with the JSON null value. By default, fields
	// with empty values are omitted from API requests. However, any field
	// with an empty value appearing in NullFields will be sent to the
	// server as null. It is an error if a field in this list has a
	// non-empty value. This may be used to include null fields in Patch
	// requests.
	NullFields []string `json:"-"`
}

CountArtifactsResponse: Definition of the response for method CountArtifacts.

func (*CountArtifactsResponse) MarshalJSON added in v0.34.0

func (s *CountArtifactsResponse) MarshalJSON() ([]byte, error)

type DriveExportOptions

type DriveExportOptions struct {
	// IncludeAccessInfo: Set to true to include access level information
	// for users with indirect access to files.
	IncludeAccessInfo bool `json:"includeAccessInfo,omitempty"`

	// ForceSendFields is a list of field names (e.g. "IncludeAccessInfo")
	// to unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "IncludeAccessInfo") to
	// include in API requests with the JSON null value. By default, fields
	// with empty values are omitted from API requests. However, any field
	// with an empty value appearing in NullFields will be sent to the
	// server as null. It is an error if a field in this list has a
	// non-empty value. This may be used to include null fields in Patch
	// requests.
	NullFields []string `json:"-"`
}

DriveExportOptions: The options for Drive export.

func (*DriveExportOptions) MarshalJSON

func (s *DriveExportOptions) MarshalJSON() ([]byte, error)

type DriveOptions

type DriveOptions struct {
	// IncludeSharedDrives: Set to true to include shared drive.
	IncludeSharedDrives bool `json:"includeSharedDrives,omitempty"`

	// IncludeTeamDrives: Set to true to include Team Drive.
	IncludeTeamDrives bool `json:"includeTeamDrives,omitempty"`

	// VersionDate: Search the versions of the Drive file as of the
	// reference date. These timestamps are in GMT and rounded down to the
	// given date.
	VersionDate string `json:"versionDate,omitempty"`

	// ForceSendFields is a list of field names (e.g. "IncludeSharedDrives")
	// to unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "IncludeSharedDrives") to
	// include in API requests with the JSON null value. By default, fields
	// with empty values are omitted from API requests. However, any field
	// with an empty value appearing in NullFields will be sent to the
	// server as null. It is an error if a field in this list has a
	// non-empty value. This may be used to include null fields in Patch
	// requests.
	NullFields []string `json:"-"`
}

DriveOptions: Drive search advanced options

func (*DriveOptions) MarshalJSON

func (s *DriveOptions) MarshalJSON() ([]byte, error)

type Empty

type Empty struct {
	// ServerResponse contains the HTTP response code and headers from the
	// server.
	googleapi.ServerResponse `json:"-"`
}

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

type Export

type Export struct {
	// CloudStorageSink: Output only. Export sink for cloud storage files.
	CloudStorageSink *CloudStorageSink `json:"cloudStorageSink,omitempty"`

	// CreateTime: Output only. The time when the export was created.
	CreateTime string `json:"createTime,omitempty"`

	// ExportOptions: Advanced options of the export.
	ExportOptions *ExportOptions `json:"exportOptions,omitempty"`

	// Id: Output only. The generated export ID.
	Id string `json:"id,omitempty"`

	// MatterId: Output only. The matter ID.
	MatterId string `json:"matterId,omitempty"`

	// Name: The export name.
	Name string `json:"name,omitempty"`

	// Query: The search query being exported.
	Query *Query `json:"query,omitempty"`

	// Requester: Output only. The requester of the export.
	Requester *UserInfo `json:"requester,omitempty"`

	// Stats: Output only. Export statistics.
	Stats *ExportStats `json:"stats,omitempty"`

	// Status: Output only. The export status.
	//
	// Possible values:
	//   "EXPORT_STATUS_UNSPECIFIED" - The status is unspecified.
	//   "COMPLETED" - The export completed.
	//   "FAILED" - The export failed.
	//   "IN_PROGRESS" - The export is still being executed.
	Status string `json:"status,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the
	// server.
	googleapi.ServerResponse `json:"-"`

	// ForceSendFields is a list of field names (e.g. "CloudStorageSink") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "CloudStorageSink") to
	// include in API requests with the JSON null value. By default, fields
	// with empty values are omitted from API requests. However, any field
	// with an empty value appearing in NullFields will be sent to the
	// server as null. It is an error if a field in this list has a
	// non-empty value. This may be used to include null fields in Patch
	// requests.
	NullFields []string `json:"-"`
}

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

func (*Export) MarshalJSON

func (s *Export) MarshalJSON() ([]byte, error)

type ExportOptions

type ExportOptions struct {
	// DriveOptions: Option available for Drive export.
	DriveOptions *DriveExportOptions `json:"driveOptions,omitempty"`

	// GroupsOptions: Option available for groups export.
	GroupsOptions *GroupsExportOptions `json:"groupsOptions,omitempty"`

	// HangoutsChatOptions: Option available for hangouts chat export.
	HangoutsChatOptions *HangoutsChatExportOptions `json:"hangoutsChatOptions,omitempty"`

	// MailOptions: Option available for mail export.
	MailOptions *MailExportOptions `json:"mailOptions,omitempty"`

	// Region: The requested export location.
	//
	// Possible values:
	//   "EXPORT_REGION_UNSPECIFIED" - The region is unspecified. Will be
	// treated the same as ANY.
	//   "ANY" - Any region.
	//   "US" - US region.
	//   "EUROPE" - Europe region.
	Region string `json:"region,omitempty"`

	// VoiceOptions: Option available for voice export.
	VoiceOptions *VoiceExportOptions `json:"voiceOptions,omitempty"`

	// ForceSendFields is a list of field names (e.g. "DriveOptions") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "DriveOptions") to include
	// in API requests with the JSON null value. By default, fields with
	// empty values are omitted from API requests. However, any field with
	// an empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

ExportOptions: Export advanced options

func (*ExportOptions) MarshalJSON

func (s *ExportOptions) MarshalJSON() ([]byte, error)

type ExportStats

type ExportStats struct {
	// ExportedArtifactCount: The number of documents already processed by
	// the export.
	ExportedArtifactCount int64 `json:"exportedArtifactCount,omitempty,string"`

	// SizeInBytes: The size of export in bytes.
	SizeInBytes int64 `json:"sizeInBytes,omitempty,string"`

	// TotalArtifactCount: The number of documents to be exported.
	TotalArtifactCount int64 `json:"totalArtifactCount,omitempty,string"`

	// ForceSendFields is a list of field names (e.g.
	// "ExportedArtifactCount") to unconditionally include in API requests.
	// By default, fields with empty values are omitted from API requests.
	// However, any non-pointer, non-interface field appearing in
	// ForceSendFields will be sent to the server regardless of whether the
	// field is empty or not. This may be used to include empty fields in
	// Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "ExportedArtifactCount") to
	// include in API requests with the JSON null value. By default, fields
	// with empty values are omitted from API requests. However, any field
	// with an empty value appearing in NullFields will be sent to the
	// server as null. It is an error if a field in this list has a
	// non-empty value. This may be used to include null fields in Patch
	// requests.
	NullFields []string `json:"-"`
}

ExportStats: Stats of an export.

func (*ExportStats) MarshalJSON

func (s *ExportStats) MarshalJSON() ([]byte, error)

type GroupsCountResult added in v0.34.0

type GroupsCountResult struct {
	// AccountCountErrors: Error occurred when querying these accounts.
	AccountCountErrors []*AccountCountError `json:"accountCountErrors,omitempty"`

	// AccountCounts: Subtotal count per matching account that have more
	// than zero messages.
	AccountCounts []*AccountCount `json:"accountCounts,omitempty"`

	// MatchingAccountsCount: Total number of accounts that can be queried
	// and have more than zero messages.
	MatchingAccountsCount int64 `json:"matchingAccountsCount,omitempty,string"`

	// NonQueryableAccounts: When data scope is HELD_DATA in the request
	// Query, these accounts in the request are not queried because they are
	// not on hold. For other data scope, this field is not set.
	NonQueryableAccounts []string `json:"nonQueryableAccounts,omitempty"`

	// QueriedAccountsCount: Total number of accounts involved in this count
	// operation.
	QueriedAccountsCount int64 `json:"queriedAccountsCount,omitempty,string"`

	// ForceSendFields is a list of field names (e.g. "AccountCountErrors")
	// to unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "AccountCountErrors") to
	// include in API requests with the JSON null value. By default, fields
	// with empty values are omitted from API requests. However, any field
	// with an empty value appearing in NullFields will be sent to the
	// server as null. It is an error if a field in this list has a
	// non-empty value. This may be used to include null fields in Patch
	// requests.
	NullFields []string `json:"-"`
}

GroupsCountResult: Groups specific count metrics.

func (*GroupsCountResult) MarshalJSON added in v0.34.0

func (s *GroupsCountResult) MarshalJSON() ([]byte, error)

type GroupsExportOptions

type GroupsExportOptions struct {
	// ExportFormat: The export format for groups export.
	//
	// Possible values:
	//   "EXPORT_FORMAT_UNSPECIFIED" - No export format specified.
	//   "MBOX" - MBOX as export format.
	//   "PST" - PST as export format
	ExportFormat string `json:"exportFormat,omitempty"`

	// ForceSendFields is a list of field names (e.g. "ExportFormat") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "ExportFormat") to include
	// in API requests with the JSON null value. By default, fields with
	// empty values are omitted from API requests. However, any field with
	// an empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

GroupsExportOptions: The options for groups export.

func (*GroupsExportOptions) MarshalJSON

func (s *GroupsExportOptions) MarshalJSON() ([]byte, error)

type HangoutsChatExportOptions

type HangoutsChatExportOptions struct {
	// ExportFormat: The export format for hangouts chat export.
	//
	// Possible values:
	//   "EXPORT_FORMAT_UNSPECIFIED" - No export format specified.
	//   "MBOX" - MBOX as export format.
	//   "PST" - PST as export format
	ExportFormat string `json:"exportFormat,omitempty"`

	// ForceSendFields is a list of field names (e.g. "ExportFormat") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "ExportFormat") to include
	// in API requests with the JSON null value. By default, fields with
	// empty values are omitted from API requests. However, any field with
	// an empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

HangoutsChatExportOptions: The options for hangouts chat export.

func (*HangoutsChatExportOptions) MarshalJSON

func (s *HangoutsChatExportOptions) MarshalJSON() ([]byte, error)

type HangoutsChatInfo

type HangoutsChatInfo struct {
	// RoomId: A set of rooms to search.
	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 values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "RoomId") to include in API
	// requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

HangoutsChatInfo: Accounts to search

func (*HangoutsChatInfo) MarshalJSON

func (s *HangoutsChatInfo) MarshalJSON() ([]byte, error)

type HangoutsChatOptions

type HangoutsChatOptions struct {
	// IncludeRooms: Set to true to include rooms.
	IncludeRooms bool `json:"includeRooms,omitempty"`

	// ForceSendFields is a list of field names (e.g. "IncludeRooms") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "IncludeRooms") to include
	// in API requests with the JSON null value. By default, fields with
	// empty values are omitted from API requests. However, any field with
	// an empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

HangoutsChatOptions: Hangouts chat search advanced options

func (*HangoutsChatOptions) MarshalJSON

func (s *HangoutsChatOptions) MarshalJSON() ([]byte, error)

type HeldAccount

type HeldAccount struct {
	// AccountId: The account's ID as provided by the Admin SDK.
	AccountId string `json:"accountId,omitempty"`

	// Email: The primary email address of the account. If used as an input,
	// this takes precedence over account ID.
	Email string `json:"email,omitempty"`

	// FirstName: Output only. The first name of the account holder.
	FirstName string `json:"firstName,omitempty"`

	// HoldTime: Output only. When the account was put on hold.
	HoldTime string `json:"holdTime,omitempty"`

	// LastName: Output only. The last name of the account holder.
	LastName string `json:"lastName,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the
	// server.
	googleapi.ServerResponse `json:"-"`

	// ForceSendFields is a list of field names (e.g. "AccountId") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "AccountId") to include in
	// API requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

HeldAccount: An account being held in a particular hold. This structure is immutable. This can be either a single user or a google group, depending on the corpus. To work with Vault resources, the account must have the [required Vault privileges] (https://support.google.com/vault/answer/2799699) and access to the matter. To access a matter, the account must have created the matter, have the matter shared with them, or have the **View All Matters** privilege.

func (*HeldAccount) MarshalJSON

func (s *HeldAccount) MarshalJSON() ([]byte, error)

type HeldDriveQuery

type HeldDriveQuery struct {
	// IncludeSharedDriveFiles: If true, include files in shared drives in
	// the hold.
	IncludeSharedDriveFiles bool `json:"includeSharedDriveFiles,omitempty"`

	// IncludeTeamDriveFiles: If true, include files in Team Drives in the
	// hold.
	IncludeTeamDriveFiles bool `json:"includeTeamDriveFiles,omitempty"`

	// ForceSendFields is a list of field names (e.g.
	// "IncludeSharedDriveFiles") to unconditionally include in API
	// requests. By default, fields with empty values are omitted from API
	// requests. However, any non-pointer, non-interface field appearing in
	// ForceSendFields will be sent to the server regardless of whether the
	// field is empty or not. This may be used to include empty fields in
	// Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "IncludeSharedDriveFiles")
	// to include in API requests with the JSON null value. By default,
	// fields with empty values are omitted from API requests. However, any
	// field with an empty value appearing in NullFields will be sent to the
	// server as null. It is an error if a field in this list has a
	// non-empty value. This may be used to include null fields in Patch
	// requests.
	NullFields []string `json:"-"`
}

HeldDriveQuery: Query options for Drive holds.

func (*HeldDriveQuery) MarshalJSON

func (s *HeldDriveQuery) MarshalJSON() ([]byte, error)

type HeldGroupsQuery

type HeldGroupsQuery struct {
	// EndTime: The end time range for the search query. These timestamps
	// are in GMT and rounded down to the start of the given date.
	EndTime string `json:"endTime,omitempty"`

	// StartTime: The start time range for the search query. These
	// timestamps are in GMT and rounded down to the start of the given
	// date.
	StartTime string `json:"startTime,omitempty"`

	// Terms: The search terms for the hold.
	Terms string `json:"terms,omitempty"`

	// ForceSendFields is a list of field names (e.g. "EndTime") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "EndTime") to include in
	// API requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

HeldGroupsQuery: Query options for group holds.

func (*HeldGroupsQuery) MarshalJSON

func (s *HeldGroupsQuery) MarshalJSON() ([]byte, error)

type HeldHangoutsChatQuery

type HeldHangoutsChatQuery struct {
	// IncludeRooms: If true, include rooms the user has participated in.
	IncludeRooms bool `json:"includeRooms,omitempty"`

	// ForceSendFields is a list of field names (e.g. "IncludeRooms") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "IncludeRooms") to include
	// in API requests with the JSON null value. By default, fields with
	// empty values are omitted from API requests. However, any field with
	// an empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

HeldHangoutsChatQuery: Query options for hangouts chat holds.

func (*HeldHangoutsChatQuery) MarshalJSON

func (s *HeldHangoutsChatQuery) MarshalJSON() ([]byte, error)

type HeldMailQuery

type HeldMailQuery struct {
	// EndTime: The end time range for the search query. These timestamps
	// are in GMT and rounded down to the start of the given date.
	EndTime string `json:"endTime,omitempty"`

	// StartTime: The start time range for the search query. These
	// timestamps are in GMT and rounded down to the start of the given
	// date.
	StartTime string `json:"startTime,omitempty"`

	// Terms: The search terms for the hold.
	Terms string `json:"terms,omitempty"`

	// ForceSendFields is a list of field names (e.g. "EndTime") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "EndTime") to include in
	// API requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

HeldMailQuery: Query options for mail holds.

func (*HeldMailQuery) MarshalJSON

func (s *HeldMailQuery) MarshalJSON() ([]byte, error)

type HeldOrgUnit

type HeldOrgUnit struct {
	// HoldTime: When the org unit was put on hold. This property is
	// immutable.
	HoldTime string `json:"holdTime,omitempty"`

	// OrgUnitId: The org unit's immutable ID as provided by the Admin SDK.
	OrgUnitId string `json:"orgUnitId,omitempty"`

	// ForceSendFields is a list of field names (e.g. "HoldTime") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "HoldTime") to include in
	// API requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

HeldOrgUnit: A organizational unit being held in a particular hold. This structure is immutable.

func (*HeldOrgUnit) MarshalJSON

func (s *HeldOrgUnit) MarshalJSON() ([]byte, error)

type HeldVoiceQuery added in v0.36.0

type HeldVoiceQuery struct {
	// CoveredData: Data covered by this rule. Should be non-empty. Order
	// does not matter and duplicates will be ignored.
	//
	// Possible values:
	//   "COVERED_DATA_UNSPECIFIED" - Covered data unspecified.
	//   "TEXT_MESSAGES" - Voice text message will be covered.
	//   "VOICEMAILS" - Voicemail will be covered.
	//   "CALL_LOGS" - Call logs will be covered.
	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 values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "CoveredData") to include
	// in API requests with the JSON null value. By default, fields with
	// empty values are omitted from API requests. However, any field with
	// an empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

HeldVoiceQuery: Query options for Voice holds.

func (*HeldVoiceQuery) MarshalJSON added in v0.36.0

func (s *HeldVoiceQuery) MarshalJSON() ([]byte, error)

type Hold

type Hold struct {
	// Accounts: If set, the hold applies to the enumerated accounts and
	// org_unit must be empty.
	Accounts []*HeldAccount `json:"accounts,omitempty"`

	// Corpus: The corpus to be searched.
	//
	// Possible values:
	//   "CORPUS_TYPE_UNSPECIFIED" - No corpus specified.
	//   "DRIVE" - Drive.
	//   "MAIL" - Mail.
	//   "GROUPS" - Groups.
	//   "HANGOUTS_CHAT" - Hangouts Chat.
	//   "VOICE" - Google Voice.
	Corpus string `json:"corpus,omitempty"`

	// HoldId: The unique immutable ID of the hold. Assigned during
	// creation.
	HoldId string `json:"holdId,omitempty"`

	// Name: The name of the hold.
	Name string `json:"name,omitempty"`

	// OrgUnit: If set, the hold applies to all members of the
	// organizational unit and accounts must be empty. This property is
	// mutable. For groups holds, set the accounts field.
	OrgUnit *HeldOrgUnit `json:"orgUnit,omitempty"`

	// Query: The corpus-specific query. If set, the corpusQuery must match
	// corpus type.
	Query *CorpusQuery `json:"query,omitempty"`

	// UpdateTime: The last time this hold was modified.
	UpdateTime string `json:"updateTime,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the
	// server.
	googleapi.ServerResponse `json:"-"`

	// ForceSendFields is a list of field names (e.g. "Accounts") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "Accounts") to include in
	// API requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

Hold: Represents a hold within Vault. A hold restricts purging of artifacts based on the combination of the query and accounts restrictions. A hold can be configured to either apply to an explicitly configured set of accounts, or can be applied to all members of an organizational unit. To work with Vault resources, the account must have the [required Vault privileges] (https://support.google.com/vault/answer/2799699) and access to the matter. To access a matter, the account must have created the matter, have the matter shared with them, or have the **View All Matters** privilege.

func (*Hold) MarshalJSON

func (s *Hold) MarshalJSON() ([]byte, error)

type ListExportsResponse

type ListExportsResponse struct {
	// Exports: The list of exports.
	Exports []*Export `json:"exports,omitempty"`

	// NextPageToken: Page token to retrieve the next page of results in the
	// list.
	NextPageToken string `json:"nextPageToken,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the
	// server.
	googleapi.ServerResponse `json:"-"`

	// ForceSendFields is a list of field names (e.g. "Exports") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "Exports") to include in
	// API requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

ListExportsResponse: The holds for a matter.

func (*ListExportsResponse) MarshalJSON

func (s *ListExportsResponse) MarshalJSON() ([]byte, error)

type ListHeldAccountsResponse

type ListHeldAccountsResponse struct {
	// Accounts: The held accounts on a hold.
	Accounts []*HeldAccount `json:"accounts,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the
	// server.
	googleapi.ServerResponse `json:"-"`

	// ForceSendFields is a list of field names (e.g. "Accounts") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "Accounts") to include in
	// API requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

ListHeldAccountsResponse: Returns a list of held accounts for a hold.

func (*ListHeldAccountsResponse) MarshalJSON

func (s *ListHeldAccountsResponse) MarshalJSON() ([]byte, error)

type ListHoldsResponse

type ListHoldsResponse struct {
	// Holds: The list of holds.
	Holds []*Hold `json:"holds,omitempty"`

	// NextPageToken: Page token to retrieve the next page of results in the
	// list. If this is empty, then there are no more holds to list.
	NextPageToken string `json:"nextPageToken,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the
	// server.
	googleapi.ServerResponse `json:"-"`

	// ForceSendFields is a list of field names (e.g. "Holds") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "Holds") to include in API
	// requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

ListHoldsResponse: The holds for a matter.

func (*ListHoldsResponse) MarshalJSON

func (s *ListHoldsResponse) MarshalJSON() ([]byte, error)

type ListMattersResponse

type ListMattersResponse struct {
	// Matters: List of matters.
	Matters []*Matter `json:"matters,omitempty"`

	// NextPageToken: Page token to retrieve the next page of results in the
	// list.
	NextPageToken string `json:"nextPageToken,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the
	// server.
	googleapi.ServerResponse `json:"-"`

	// ForceSendFields is a list of field names (e.g. "Matters") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "Matters") to include in
	// API requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

ListMattersResponse: Provides the list of matters.

func (*ListMattersResponse) MarshalJSON

func (s *ListMattersResponse) MarshalJSON() ([]byte, error)

type ListOperationsResponse added in v0.34.0

type ListOperationsResponse struct {
	// NextPageToken: The standard List next-page token.
	NextPageToken string `json:"nextPageToken,omitempty"`

	// Operations: A list of operations that matches the specified filter in
	// the request.
	Operations []*Operation `json:"operations,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the
	// server.
	googleapi.ServerResponse `json:"-"`

	// ForceSendFields is a list of field names (e.g. "NextPageToken") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "NextPageToken") to include
	// in API requests with the JSON null value. By default, fields with
	// empty values are omitted from API requests. However, any field with
	// an empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

ListOperationsResponse: The response message for Operations.ListOperations.

func (*ListOperationsResponse) MarshalJSON added in v0.34.0

func (s *ListOperationsResponse) MarshalJSON() ([]byte, error)

type ListSavedQueriesResponse

type ListSavedQueriesResponse struct {
	// NextPageToken: Page token to retrieve the next page of results in the
	// list. If this is empty, then there are no more saved queries to list.
	NextPageToken string `json:"nextPageToken,omitempty"`

	// SavedQueries: List of output 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 values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "NextPageToken") to include
	// in API requests with the JSON null value. By default, fields with
	// empty values are omitted from API requests. However, any field with
	// an empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

ListSavedQueriesResponse: Definition of the response for method ListSaveQuery.

func (*ListSavedQueriesResponse) MarshalJSON

func (s *ListSavedQueriesResponse) MarshalJSON() ([]byte, error)

type MailCountResult added in v0.34.0

type MailCountResult struct {
	// AccountCountErrors: Error occurred when querying these accounts.
	AccountCountErrors []*AccountCountError `json:"accountCountErrors,omitempty"`

	// AccountCounts: Subtotal count per matching account that have more
	// than zero messages.
	AccountCounts []*AccountCount `json:"accountCounts,omitempty"`

	// MatchingAccountsCount: Total number of accounts that can be queried
	// and have more than zero messages.
	MatchingAccountsCount int64 `json:"matchingAccountsCount,omitempty,string"`

	// NonQueryableAccounts: When data scope is HELD_DATA in the request
	// Query, these accounts in the request are not queried because they are
	// not on hold. For other data scope, this field is not set.
	NonQueryableAccounts []string `json:"nonQueryableAccounts,omitempty"`

	// QueriedAccountsCount: Total number of accounts involved in this count
	// operation.
	QueriedAccountsCount int64 `json:"queriedAccountsCount,omitempty,string"`

	// ForceSendFields is a list of field names (e.g. "AccountCountErrors")
	// to unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "AccountCountErrors") to
	// include in API requests with the JSON null value. By default, fields
	// with empty values are omitted from API requests. However, any field
	// with an empty value appearing in NullFields will be sent to the
	// server as null. It is an error if a field in this list has a
	// non-empty value. This may be used to include null fields in Patch
	// requests.
	NullFields []string `json:"-"`
}

MailCountResult: Mail specific count metrics.

func (*MailCountResult) MarshalJSON added in v0.34.0

func (s *MailCountResult) MarshalJSON() ([]byte, error)

type MailExportOptions

type MailExportOptions struct {
	// ExportFormat: The export file format.
	//
	// Possible values:
	//   "EXPORT_FORMAT_UNSPECIFIED" - No export format specified.
	//   "MBOX" - MBOX as export format.
	//   "PST" - PST as export format
	ExportFormat string `json:"exportFormat,omitempty"`

	// ShowConfidentialModeContent: Set to true to export confidential mode
	// content.
	ShowConfidentialModeContent bool `json:"showConfidentialModeContent,omitempty"`

	// ForceSendFields is a list of field names (e.g. "ExportFormat") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "ExportFormat") to include
	// in API requests with the JSON null value. By default, fields with
	// empty values are omitted from API requests. However, any field with
	// an empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

MailExportOptions: The options for mail export.

func (*MailExportOptions) MarshalJSON

func (s *MailExportOptions) MarshalJSON() ([]byte, error)

type MailOptions

type MailOptions struct {
	// ExcludeDrafts: Set to true to exclude drafts.
	ExcludeDrafts bool `json:"excludeDrafts,omitempty"`

	// ForceSendFields is a list of field names (e.g. "ExcludeDrafts") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "ExcludeDrafts") to include
	// in API requests with the JSON null value. By default, fields with
	// empty values are omitted from API requests. However, any field with
	// an empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

MailOptions: Mail search advanced options

func (*MailOptions) MarshalJSON

func (s *MailOptions) MarshalJSON() ([]byte, error)

type Matter

type Matter struct {
	// Description: The description of the matter.
	Description string `json:"description,omitempty"`

	// MatterId: The matter ID which is generated by the server. Should be
	// blank when creating a new matter.
	MatterId string `json:"matterId,omitempty"`

	// MatterPermissions: List of users and access to the matter. Currently
	// there is no programmer defined limit on the number of permissions a
	// matter can have.
	MatterPermissions []*MatterPermission `json:"matterPermissions,omitempty"`

	// Name: The name of the matter.
	Name string `json:"name,omitempty"`

	// State: The state of the matter.
	//
	// Possible values:
	//   "STATE_UNSPECIFIED" - The matter has no specified state.
	//   "OPEN" - This matter is open.
	//   "CLOSED" - This matter is closed.
	//   "DELETED" - This matter is deleted.
	State string `json:"state,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the
	// server.
	googleapi.ServerResponse `json:"-"`

	// ForceSendFields is a list of field names (e.g. "Description") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "Description") to include
	// in API requests with the JSON null value. By default, fields with
	// empty values are omitted from API requests. However, any field with
	// an empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

Matter: Represents a matter. To work with Vault resources, the account must have the [required Vault privileges] (https://support.google.com/vault/answer/2799699) and access to the matter. To access a matter, the account must have created the matter, have the matter shared with them, or have the **View All Matters** privilege.

func (*Matter) MarshalJSON

func (s *Matter) MarshalJSON() ([]byte, error)

type MatterPermission

type MatterPermission struct {
	// AccountId: The account ID, as provided by Admin SDK.
	AccountId string `json:"accountId,omitempty"`

	// Role: The user's role in this matter.
	//
	// Possible values:
	//   "ROLE_UNSPECIFIED" - No role assigned.
	//   "COLLABORATOR" - A collaborator to the matter.
	//   "OWNER" - The owner of the matter.
	Role string `json:"role,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the
	// server.
	googleapi.ServerResponse `json:"-"`

	// ForceSendFields is a list of field names (e.g. "AccountId") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "AccountId") to include in
	// API requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

MatterPermission: Currently each matter only has one owner, and all others are collaborators. When an account is purged, its corresponding MatterPermission resources cease to exist.

func (*MatterPermission) MarshalJSON

func (s *MatterPermission) MarshalJSON() ([]byte, error)

type MattersAddPermissionsCall

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

func (*MattersAddPermissionsCall) Context

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*MattersAddPermissionsCall) Do

Do executes the "vault.matters.addPermissions" call. Exactly one of *MatterPermission or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *MatterPermission.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*MattersAddPermissionsCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*MattersAddPermissionsCall) Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

type MattersCloseCall

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

func (*MattersCloseCall) Context

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*MattersCloseCall) Do

Do executes the "vault.matters.close" call. Exactly one of *CloseMatterResponse or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *CloseMatterResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*MattersCloseCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*MattersCloseCall) Header

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

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

type MattersCountCall added in v0.34.0

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

func (*MattersCountCall) Context added in v0.34.0

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*MattersCountCall) Do added in v0.34.0

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

func (*MattersCountCall) Fields added in v0.34.0

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*MattersCountCall) Header added in v0.34.0

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

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

type MattersCreateCall

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

func (*MattersCreateCall) Context

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*MattersCreateCall) Do

func (c *MattersCreateCall) Do(opts ...googleapi.CallOption) (*Matter, error)

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

func (*MattersCreateCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*MattersCreateCall) Header

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

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

type MattersDeleteCall

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

func (*MattersDeleteCall) Context

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*MattersDeleteCall) Do

func (c *MattersDeleteCall) Do(opts ...googleapi.CallOption) (*Matter, error)

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

func (*MattersDeleteCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*MattersDeleteCall) Header

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

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

type MattersExportsCreateCall

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

func (*MattersExportsCreateCall) Context

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*MattersExportsCreateCall) Do

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

func (*MattersExportsCreateCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*MattersExportsCreateCall) Header

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

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

type MattersExportsDeleteCall

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

func (*MattersExportsDeleteCall) Context

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*MattersExportsDeleteCall) Do

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

func (*MattersExportsDeleteCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*MattersExportsDeleteCall) Header

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

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

type MattersExportsGetCall

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

func (*MattersExportsGetCall) Context

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*MattersExportsGetCall) Do

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

func (*MattersExportsGetCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*MattersExportsGetCall) Header

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

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

func (*MattersExportsGetCall) IfNoneMatch

func (c *MattersExportsGetCall) IfNoneMatch(entityTag string) *MattersExportsGetCall

IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

type MattersExportsListCall

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

func (*MattersExportsListCall) Context

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*MattersExportsListCall) Do

Do executes the "vault.matters.exports.list" call. Exactly one of *ListExportsResponse or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *ListExportsResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*MattersExportsListCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*MattersExportsListCall) Header

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

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

func (*MattersExportsListCall) IfNoneMatch

func (c *MattersExportsListCall) IfNoneMatch(entityTag string) *MattersExportsListCall

IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

func (*MattersExportsListCall) PageSize

func (c *MattersExportsListCall) PageSize(pageSize int64) *MattersExportsListCall

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

func (*MattersExportsListCall) PageToken

func (c *MattersExportsListCall) PageToken(pageToken string) *MattersExportsListCall

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

func (*MattersExportsListCall) Pages

Pages invokes f for each page of results. A non-nil error returned from f will halt the iteration. The provided context supersedes any context provided to the Context method.

type MattersExportsService

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

func NewMattersExportsService

func NewMattersExportsService(s *Service) *MattersExportsService

func (*MattersExportsService) Create

func (r *MattersExportsService) Create(matterId string, export *Export) *MattersExportsCreateCall

Create: Creates an Export.

- matterId: The matter ID.

func (*MattersExportsService) Delete

func (r *MattersExportsService) Delete(matterId string, exportId string) *MattersExportsDeleteCall

Delete: Deletes an Export.

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

func (*MattersExportsService) Get

func (r *MattersExportsService) Get(matterId string, exportId string) *MattersExportsGetCall

Get: Gets an Export.

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

func (*MattersExportsService) List

List: Lists Exports.

- matterId: The matter ID.

type MattersGetCall

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

func (*MattersGetCall) Context

func (c *MattersGetCall) Context(ctx context.Context) *MattersGetCall

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*MattersGetCall) Do

func (c *MattersGetCall) Do(opts ...googleapi.CallOption) (*Matter, error)

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

func (*MattersGetCall) Fields

func (c *MattersGetCall) Fields(s ...googleapi.Field) *MattersGetCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*MattersGetCall) Header

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

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

func (*MattersGetCall) IfNoneMatch

func (c *MattersGetCall) IfNoneMatch(entityTag string) *MattersGetCall

IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

func (*MattersGetCall) View

func (c *MattersGetCall) View(view string) *MattersGetCall

View sets the optional parameter "view": Specifies which parts of the Matter to return in the response.

Possible values:

"VIEW_UNSPECIFIED" - There is no specified view.
"BASIC" - Response includes the matter_id, name, description, and

state. Default choice.

"FULL" - Full representation of matter is returned. Everything

above and including MatterPermissions list.

type MattersHoldsAccountsCreateCall

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

func (*MattersHoldsAccountsCreateCall) Context

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*MattersHoldsAccountsCreateCall) Do

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

func (*MattersHoldsAccountsCreateCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*MattersHoldsAccountsCreateCall) Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

type MattersHoldsAccountsDeleteCall

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

func (*MattersHoldsAccountsDeleteCall) Context

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*MattersHoldsAccountsDeleteCall) Do

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

func (*MattersHoldsAccountsDeleteCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*MattersHoldsAccountsDeleteCall) Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

type MattersHoldsAccountsListCall

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

func (*MattersHoldsAccountsListCall) Context

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*MattersHoldsAccountsListCall) Do

Do executes the "vault.matters.holds.accounts.list" call. Exactly one of *ListHeldAccountsResponse or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *ListHeldAccountsResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*MattersHoldsAccountsListCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*MattersHoldsAccountsListCall) Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

func (*MattersHoldsAccountsListCall) IfNoneMatch

IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

type MattersHoldsAccountsService

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

func NewMattersHoldsAccountsService

func NewMattersHoldsAccountsService(s *Service) *MattersHoldsAccountsService

func (*MattersHoldsAccountsService) Create

func (r *MattersHoldsAccountsService) Create(matterId string, holdId string, heldaccount *HeldAccount) *MattersHoldsAccountsCreateCall

Create: Adds a HeldAccount to a hold. Accounts can only be added to a hold that has no held_org_unit set. Attempting to add an account to an OU-based hold will result in an error.

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

func (*MattersHoldsAccountsService) Delete

func (r *MattersHoldsAccountsService) Delete(matterId string, holdId string, accountId string) *MattersHoldsAccountsDeleteCall

Delete: Removes a HeldAccount from a hold. If this request leaves the hold with no held accounts, the hold will not apply to any accounts.

- accountId: The ID of the account to remove from the hold. - holdId: The hold ID. - matterId: The matter ID.

func (*MattersHoldsAccountsService) List

List: Lists HeldAccounts for a hold. This will only list individually specified held accounts. If the hold is on an OU, then use Admin SDK to enumerate its members.

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

type MattersHoldsAddHeldAccountsCall

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

func (*MattersHoldsAddHeldAccountsCall) Context

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*MattersHoldsAddHeldAccountsCall) Do

Do executes the "vault.matters.holds.addHeldAccounts" call. Exactly one of *AddHeldAccountsResponse or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *AddHeldAccountsResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*MattersHoldsAddHeldAccountsCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*MattersHoldsAddHeldAccountsCall) Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

type MattersHoldsCreateCall

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

func (*MattersHoldsCreateCall) Context

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*MattersHoldsCreateCall) Do

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

func (*MattersHoldsCreateCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*MattersHoldsCreateCall) Header

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

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

type MattersHoldsDeleteCall

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

func (*MattersHoldsDeleteCall) Context

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*MattersHoldsDeleteCall) Do

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

func (*MattersHoldsDeleteCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*MattersHoldsDeleteCall) Header

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

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

type MattersHoldsGetCall

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

func (*MattersHoldsGetCall) Context

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*MattersHoldsGetCall) Do

func (c *MattersHoldsGetCall) Do(opts ...googleapi.CallOption) (*Hold, error)

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

func (*MattersHoldsGetCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*MattersHoldsGetCall) Header

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

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

func (*MattersHoldsGetCall) IfNoneMatch

func (c *MattersHoldsGetCall) IfNoneMatch(entityTag string) *MattersHoldsGetCall

IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

func (*MattersHoldsGetCall) View

View sets the optional parameter "view": Specifies which parts of the Hold to return.

Possible values:

"HOLD_VIEW_UNSPECIFIED" - There is no specified view. Defaults to

FULL_HOLD.

"BASIC_HOLD" - Response includes the id, name, update time, corpus,

and query.

"FULL_HOLD" - Full representation of a Hold. Response includes all

fields of 'BASIC' and the entities the Hold applies to, such as accounts, or OU.

type MattersHoldsListCall

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

func (*MattersHoldsListCall) Context

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*MattersHoldsListCall) Do

Do executes the "vault.matters.holds.list" call. Exactly one of *ListHoldsResponse or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *ListHoldsResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*MattersHoldsListCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*MattersHoldsListCall) Header

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

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

func (*MattersHoldsListCall) IfNoneMatch

func (c *MattersHoldsListCall) IfNoneMatch(entityTag string) *MattersHoldsListCall

IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

func (*MattersHoldsListCall) PageSize

func (c *MattersHoldsListCall) PageSize(pageSize int64) *MattersHoldsListCall

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

func (*MattersHoldsListCall) PageToken

func (c *MattersHoldsListCall) PageToken(pageToken string) *MattersHoldsListCall

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

func (*MattersHoldsListCall) Pages

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": Specifies which parts of the Hold to return.

Possible values:

"HOLD_VIEW_UNSPECIFIED" - There is no specified view. Defaults to

FULL_HOLD.

"BASIC_HOLD" - Response includes the id, name, update time, corpus,

and query.

"FULL_HOLD" - Full representation of a Hold. Response includes all

fields of 'BASIC' and the entities the Hold applies to, such as accounts, or OU.

type MattersHoldsRemoveHeldAccountsCall

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

func (*MattersHoldsRemoveHeldAccountsCall) Context

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*MattersHoldsRemoveHeldAccountsCall) Do

Do executes the "vault.matters.holds.removeHeldAccounts" call. Exactly one of *RemoveHeldAccountsResponse or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *RemoveHeldAccountsResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*MattersHoldsRemoveHeldAccountsCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*MattersHoldsRemoveHeldAccountsCall) Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

type MattersHoldsService

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

func NewMattersHoldsService

func NewMattersHoldsService(s *Service) *MattersHoldsService

func (*MattersHoldsService) AddHeldAccounts

func (r *MattersHoldsService) AddHeldAccounts(matterId string, holdId string, addheldaccountsrequest *AddHeldAccountsRequest) *MattersHoldsAddHeldAccountsCall

AddHeldAccounts: Adds HeldAccounts to a hold. Returns a list of accounts that have been successfully added. Accounts can only be added to an existing account-based hold.

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

func (*MattersHoldsService) Create

func (r *MattersHoldsService) Create(matterId string, hold *Hold) *MattersHoldsCreateCall

Create: Creates a hold in the given matter.

- matterId: The matter ID.

func (*MattersHoldsService) Delete

func (r *MattersHoldsService) Delete(matterId string, holdId string) *MattersHoldsDeleteCall

Delete: Removes a hold by ID. This will release any HeldAccounts on this Hold.

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

func (*MattersHoldsService) Get

func (r *MattersHoldsService) Get(matterId string, holdId string) *MattersHoldsGetCall

Get: Gets a hold by ID.

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

func (*MattersHoldsService) List

func (r *MattersHoldsService) List(matterId string) *MattersHoldsListCall

List: Lists holds within a matter. An empty page token in ListHoldsResponse denotes no more holds to list.

- matterId: The matter ID.

func (*MattersHoldsService) RemoveHeldAccounts

func (r *MattersHoldsService) RemoveHeldAccounts(matterId string, holdId string, removeheldaccountsrequest *RemoveHeldAccountsRequest) *MattersHoldsRemoveHeldAccountsCall

RemoveHeldAccounts: Removes HeldAccounts from a hold. Returns a list of statuses in the same order as the request. If this request leaves the hold with no held accounts, the hold will not apply to any accounts.

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

func (*MattersHoldsService) Update

func (r *MattersHoldsService) Update(matterId string, holdId string, hold *Hold) *MattersHoldsUpdateCall

Update: Updates the OU and/or query parameters of a hold. You cannot add accounts to a hold that covers an OU, nor can you add OUs to a hold that covers individual accounts. Accounts listed in the hold will be ignored.

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

type MattersHoldsUpdateCall

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

func (*MattersHoldsUpdateCall) Context

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*MattersHoldsUpdateCall) Do

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

func (*MattersHoldsUpdateCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*MattersHoldsUpdateCall) Header

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

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

type MattersListCall

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

func (*MattersListCall) Context

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*MattersListCall) Do

Do executes the "vault.matters.list" call. Exactly one of *ListMattersResponse or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *ListMattersResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*MattersListCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*MattersListCall) Header

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

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

func (*MattersListCall) IfNoneMatch

func (c *MattersListCall) IfNoneMatch(entityTag string) *MattersListCall

IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

func (*MattersListCall) PageSize

func (c *MattersListCall) PageSize(pageSize int64) *MattersListCall

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

func (*MattersListCall) PageToken

func (c *MattersListCall) PageToken(pageToken string) *MattersListCall

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

func (*MattersListCall) Pages

Pages invokes f for each page of results. A non-nil error returned from f will halt the iteration. The provided context supersedes any context provided to the Context method.

func (*MattersListCall) State

func (c *MattersListCall) State(state string) *MattersListCall

State sets the optional parameter "state": If set, list only matters with that specific state. The default is listing matters of all states.

Possible values:

"STATE_UNSPECIFIED" - The matter has no specified state.
"OPEN" - This matter is open.
"CLOSED" - This matter is closed.
"DELETED" - This matter is deleted.

func (*MattersListCall) View

func (c *MattersListCall) View(view string) *MattersListCall

View sets the optional parameter "view": Specifies which parts of the matter to return in response.

Possible values:

"VIEW_UNSPECIFIED" - There is no specified view.
"BASIC" - Response includes the matter_id, name, description, and

state. Default choice.

"FULL" - Full representation of matter is returned. Everything

above and including MatterPermissions list.

type MattersRemovePermissionsCall

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

func (*MattersRemovePermissionsCall) Context

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*MattersRemovePermissionsCall) Do

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

func (*MattersRemovePermissionsCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*MattersRemovePermissionsCall) Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

type MattersReopenCall

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

func (*MattersReopenCall) Context

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*MattersReopenCall) Do

Do executes the "vault.matters.reopen" call. Exactly one of *ReopenMatterResponse or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *ReopenMatterResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*MattersReopenCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*MattersReopenCall) Header

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

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

type MattersSavedQueriesCreateCall

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

func (*MattersSavedQueriesCreateCall) Context

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*MattersSavedQueriesCreateCall) Do

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

func (*MattersSavedQueriesCreateCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*MattersSavedQueriesCreateCall) Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

type MattersSavedQueriesDeleteCall

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

func (*MattersSavedQueriesDeleteCall) Context

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*MattersSavedQueriesDeleteCall) Do

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

func (*MattersSavedQueriesDeleteCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*MattersSavedQueriesDeleteCall) Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

type MattersSavedQueriesGetCall

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

func (*MattersSavedQueriesGetCall) Context

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*MattersSavedQueriesGetCall) Do

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

func (*MattersSavedQueriesGetCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*MattersSavedQueriesGetCall) Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

func (*MattersSavedQueriesGetCall) IfNoneMatch

IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

type MattersSavedQueriesListCall

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

func (*MattersSavedQueriesListCall) Context

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*MattersSavedQueriesListCall) Do

Do executes the "vault.matters.savedQueries.list" call. Exactly one of *ListSavedQueriesResponse or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *ListSavedQueriesResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*MattersSavedQueriesListCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*MattersSavedQueriesListCall) Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

func (*MattersSavedQueriesListCall) IfNoneMatch

IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

func (*MattersSavedQueriesListCall) PageSize

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

func (*MattersSavedQueriesListCall) PageToken

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

func (*MattersSavedQueriesListCall) Pages

Pages invokes f for each page of results. A non-nil error returned from f will halt the iteration. The provided context supersedes any context provided to the Context method.

type MattersSavedQueriesService

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

func NewMattersSavedQueriesService

func NewMattersSavedQueriesService(s *Service) *MattersSavedQueriesService

func (*MattersSavedQueriesService) Create

Create: Creates a saved query.

  • matterId: The matter ID of the parent matter for which the saved query is to be created.

func (*MattersSavedQueriesService) Delete

func (r *MattersSavedQueriesService) Delete(matterId string, savedQueryId string) *MattersSavedQueriesDeleteCall

Delete: Deletes a saved query by Id.

  • matterId: The matter ID of the parent matter for which the saved query is to be deleted.
  • savedQueryId: ID of the saved query to be deleted.

func (*MattersSavedQueriesService) Get

func (r *MattersSavedQueriesService) Get(matterId string, savedQueryId string) *MattersSavedQueriesGetCall

Get: Retrieves a saved query by Id.

  • matterId: The matter ID of the parent matter for which the saved query is to be retrieved.
  • savedQueryId: ID of the saved query to be retrieved.

func (*MattersSavedQueriesService) List

List: Lists saved queries within a matter. An empty page token in ListSavedQueriesResponse denotes no more saved queries to list.

  • matterId: The matter ID of the parent matter for which the saved queries are to be retrieved.

type MattersService

type MattersService struct {
	Exports *MattersExportsService

	Holds *MattersHoldsService

	SavedQueries *MattersSavedQueriesService
	// contains filtered or unexported fields
}

func NewMattersService

func NewMattersService(s *Service) *MattersService

func (*MattersService) AddPermissions

func (r *MattersService) AddPermissions(matterId string, addmatterpermissionsrequest *AddMatterPermissionsRequest) *MattersAddPermissionsCall

AddPermissions: Adds an account as a matter collaborator.

- matterId: The matter ID.

func (*MattersService) Close

func (r *MattersService) Close(matterId string, closematterrequest *CloseMatterRequest) *MattersCloseCall

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

- matterId: The matter ID.

func (*MattersService) Count added in v0.34.0

func (r *MattersService) Count(matterId string, countartifactsrequest *CountArtifactsRequest) *MattersCountCall

Count: Counts the artifacts within the context of a matter and returns a detailed breakdown of metrics.

- matterId: The matter ID.

func (*MattersService) Create

func (r *MattersService) Create(matter *Matter) *MattersCreateCall

Create: Creates a new matter with the given name and description. The initial state is open, and the owner is the method caller. Returns the created matter with default view.

func (*MattersService) Delete

func (r *MattersService) Delete(matterId string) *MattersDeleteCall

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

- matterId: The matter ID.

func (*MattersService) Get

func (r *MattersService) Get(matterId string) *MattersGetCall

Get: Gets the specified matter.

- matterId: The matter ID.

func (*MattersService) List

func (r *MattersService) List() *MattersListCall

List: Lists matters the user has access to.

func (*MattersService) RemovePermissions

func (r *MattersService) RemovePermissions(matterId string, removematterpermissionsrequest *RemoveMatterPermissionsRequest) *MattersRemovePermissionsCall

RemovePermissions: Removes an account as a matter collaborator.

- matterId: The matter ID.

func (*MattersService) Reopen

func (r *MattersService) Reopen(matterId string, reopenmatterrequest *ReopenMatterRequest) *MattersReopenCall

Reopen: Reopens the specified matter. Returns matter with updated state.

- matterId: The matter ID.

func (*MattersService) Undelete

func (r *MattersService) Undelete(matterId string, undeletematterrequest *UndeleteMatterRequest) *MattersUndeleteCall

Undelete: Undeletes the specified matter. Returns matter with updated state.

- matterId: The matter ID.

func (*MattersService) Update

func (r *MattersService) Update(matterId string, matter *Matter) *MattersUpdateCall

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

- matterId: The matter ID.

type MattersUndeleteCall

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

func (*MattersUndeleteCall) Context

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*MattersUndeleteCall) Do

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

func (*MattersUndeleteCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*MattersUndeleteCall) Header

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

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

type MattersUpdateCall

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

func (*MattersUpdateCall) Context

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*MattersUpdateCall) Do

func (c *MattersUpdateCall) Do(opts ...googleapi.CallOption) (*Matter, error)

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

func (*MattersUpdateCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*MattersUpdateCall) Header

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

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

type Operation added in v0.34.0

type Operation struct {
	// Done: If the value is `false`, it means the operation is still in
	// progress. If `true`, the operation is completed, and either `error`
	// or `response` is available.
	Done bool `json:"done,omitempty"`

	// Error: The error result of the operation in case of failure or
	// cancellation.
	Error *Status `json:"error,omitempty"`

	// Metadata: Service-specific metadata associated with the operation. It
	// typically contains progress information and common metadata such as
	// create time. Some services might not provide such metadata. Any
	// method that returns a long-running operation should document the
	// metadata type, if any.
	Metadata googleapi.RawMessage `json:"metadata,omitempty"`

	// Name: The server-assigned name, which is only unique within the same
	// service that originally returns it. If you use the default HTTP
	// mapping, the `name` should be a resource name ending with
	// `operations/{unique_id}`.
	Name string `json:"name,omitempty"`

	// Response: The normal response of the operation in case of success. If
	// the original method returns no data on success, such as `Delete`, the
	// response is `google.protobuf.Empty`. If the original method is
	// standard `Get`/`Create`/`Update`, the response should be the
	// resource. For other methods, the response should have the type
	// `XxxResponse`, where `Xxx` is the original method name. For example,
	// if the original method name is `TakeSnapshot()`, the inferred
	// response type is `TakeSnapshotResponse`.
	Response googleapi.RawMessage `json:"response,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the
	// server.
	googleapi.ServerResponse `json:"-"`

	// ForceSendFields is a list of field names (e.g. "Done") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "Done") to include in API
	// requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

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

func (*Operation) MarshalJSON added in v0.34.0

func (s *Operation) MarshalJSON() ([]byte, error)

type OperationsCancelCall added in v0.34.0

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

func (*OperationsCancelCall) Context added in v0.34.0

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*OperationsCancelCall) Do added in v0.34.0

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

func (*OperationsCancelCall) Fields added in v0.34.0

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*OperationsCancelCall) Header added in v0.34.0

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

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

type OperationsDeleteCall added in v0.11.0

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

func (*OperationsDeleteCall) Context added in v0.11.0

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*OperationsDeleteCall) Do added in v0.11.0

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

func (*OperationsDeleteCall) Fields added in v0.11.0

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*OperationsDeleteCall) Header added in v0.11.0

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

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

type OperationsGetCall added in v0.34.0

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

func (*OperationsGetCall) Context added in v0.34.0

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*OperationsGetCall) Do added in v0.34.0

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

func (*OperationsGetCall) Fields added in v0.34.0

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*OperationsGetCall) Header added in v0.34.0

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

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

func (*OperationsGetCall) IfNoneMatch added in v0.34.0

func (c *OperationsGetCall) IfNoneMatch(entityTag string) *OperationsGetCall

IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

type OperationsListCall added in v0.34.0

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

func (*OperationsListCall) Context added in v0.34.0

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*OperationsListCall) Do added in v0.34.0

Do executes the "vault.operations.list" call. Exactly one of *ListOperationsResponse or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *ListOperationsResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*OperationsListCall) Fields added in v0.34.0

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*OperationsListCall) Filter added in v0.34.0

func (c *OperationsListCall) Filter(filter string) *OperationsListCall

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

func (*OperationsListCall) Header added in v0.34.0

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

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

func (*OperationsListCall) IfNoneMatch added in v0.34.0

func (c *OperationsListCall) IfNoneMatch(entityTag string) *OperationsListCall

IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

func (*OperationsListCall) PageSize added in v0.34.0

func (c *OperationsListCall) PageSize(pageSize int64) *OperationsListCall

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

func (*OperationsListCall) PageToken added in v0.34.0

func (c *OperationsListCall) PageToken(pageToken string) *OperationsListCall

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

func (*OperationsListCall) Pages added in v0.34.0

Pages invokes f for each page of results. A non-nil error returned from f will halt the iteration. The provided context supersedes any context provided to the Context method.

type OperationsService added in v0.11.0

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

func NewOperationsService added in v0.11.0

func NewOperationsService(s *Service) *OperationsService

func (*OperationsService) Cancel added in v0.34.0

func (r *OperationsService) Cancel(name string, canceloperationrequest *CancelOperationRequest) *OperationsCancelCall

Cancel: Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.

- name: The name of the operation resource to be cancelled.

func (*OperationsService) Delete added in v0.11.0

Delete: Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.

- name: The name of the operation resource to be deleted.

func (*OperationsService) Get added in v0.34.0

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

- name: The name of the operation resource.

func (*OperationsService) List added in v0.34.0

List: Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. NOTE: the `name` binding allows API services to override the binding to use different resource name schemes, such as `users/*/operations`. To override the binding, API services can add a binding such as "/v1/{name=users/*}/operations" to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must ensure the name binding is the parent resource, without the operations collection id.

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

type OrgUnitInfo

type OrgUnitInfo struct {
	// OrgUnitId: Org unit to search, as provided by the Admin SDK Directory
	// API.
	OrgUnitId string `json:"orgUnitId,omitempty"`

	// ForceSendFields is a list of field names (e.g. "OrgUnitId") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "OrgUnitId") to include in
	// API requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

OrgUnitInfo: Org Unit to search

func (*OrgUnitInfo) MarshalJSON

func (s *OrgUnitInfo) MarshalJSON() ([]byte, error)

type Query

type Query struct {
	// AccountInfo: When 'ACCOUNT' is chosen as search method, account_info
	// needs to be specified.
	AccountInfo *AccountInfo `json:"accountInfo,omitempty"`

	// Corpus: The corpus to search.
	//
	// Possible values:
	//   "CORPUS_TYPE_UNSPECIFIED" - No corpus specified.
	//   "DRIVE" - Drive.
	//   "MAIL" - Mail.
	//   "GROUPS" - Groups.
	//   "HANGOUTS_CHAT" - Hangouts Chat.
	//   "VOICE" - Google Voice.
	Corpus string `json:"corpus,omitempty"`

	// DataScope: The data source to search from.
	//
	// Possible values:
	//   "DATA_SCOPE_UNSPECIFIED" - No data scope specified.
	//   "ALL_DATA" - All available data.
	//   "HELD_DATA" - Data on hold.
	//   "UNPROCESSED_DATA" - Data not processed.
	DataScope string `json:"dataScope,omitempty"`

	// DriveOptions: For Drive search, specify more options in this field.
	DriveOptions *DriveOptions `json:"driveOptions,omitempty"`

	// EndTime: The end time range for the search query. These timestamps
	// are in GMT and rounded down to the start of the given date.
	EndTime string `json:"endTime,omitempty"`

	// HangoutsChatInfo: When 'ROOM' is chosen as search method,
	// hangout_chats_info needs to be specified. (read-only)
	HangoutsChatInfo *HangoutsChatInfo `json:"hangoutsChatInfo,omitempty"`

	// HangoutsChatOptions: For hangouts chat search, specify more options
	// in this field. (read-only)
	HangoutsChatOptions *HangoutsChatOptions `json:"hangoutsChatOptions,omitempty"`

	// MailOptions: For mail search, specify more options in this field.
	MailOptions *MailOptions `json:"mailOptions,omitempty"`

	// Method: The search method to use. This field is similar to the
	// search_method field but is introduced to support shared drives. It
	// supports all search method types. In case the search_method is
	// TEAM_DRIVE the response of this field will be SHARED_DRIVE only.
	//
	// Possible values:
	//   "SEARCH_METHOD_UNSPECIFIED" - A search method must be specified. If
	// a request does not specify a search method, it will be rejected.
	//   "ACCOUNT" - Will search all accounts provided in account_info.
	//   "ORG_UNIT" - Will search all accounts in the OU specified in
	// org_unit_info.
	//   "TEAM_DRIVE" - Will search for all accounts in the Team Drive
	// specified in team_drive_info.
	//   "ENTIRE_ORG" - Will search for all accounts in the organization. No
	// need to set account_info or org_unit_info. Not all CORPUS_TYPE
	// support this scope. Supported by MAIL.
	//   "ROOM" - Will search in the Room specified in hangout_chats_info.
	// (read-only)
	//   "SHARED_DRIVE" - Will search for all accounts in the shared drive
	// specified in shared_drive_info.
	Method string `json:"method,omitempty"`

	// OrgUnitInfo: When 'ORG_UNIT' is chosen as as search method,
	// org_unit_info needs to be specified.
	OrgUnitInfo *OrgUnitInfo `json:"orgUnitInfo,omitempty"`

	// SearchMethod: The search method to use.
	//
	// Possible values:
	//   "SEARCH_METHOD_UNSPECIFIED" - A search method must be specified. If
	// a request does not specify a search method, it will be rejected.
	//   "ACCOUNT" - Will search all accounts provided in account_info.
	//   "ORG_UNIT" - Will search all accounts in the OU specified in
	// org_unit_info.
	//   "TEAM_DRIVE" - Will search for all accounts in the Team Drive
	// specified in team_drive_info.
	//   "ENTIRE_ORG" - Will search for all accounts in the organization. No
	// need to set account_info or org_unit_info. Not all CORPUS_TYPE
	// support this scope. Supported by MAIL.
	//   "ROOM" - Will search in the Room specified in hangout_chats_info.
	// (read-only)
	//   "SHARED_DRIVE" - Will search for all accounts in the shared drive
	// specified in shared_drive_info.
	SearchMethod string `json:"searchMethod,omitempty"`

	// SharedDriveInfo: When 'SHARED_DRIVE' is chosen as search method,
	// shared_drive_info needs to be specified.
	SharedDriveInfo *SharedDriveInfo `json:"sharedDriveInfo,omitempty"`

	// StartTime: The start time range for the search query. These
	// timestamps are in GMT and rounded down to the start of the given
	// date.
	StartTime string `json:"startTime,omitempty"`

	// TeamDriveInfo: When 'TEAM_DRIVE' is chosen as search method,
	// team_drive_info needs to be specified.
	TeamDriveInfo *TeamDriveInfo `json:"teamDriveInfo,omitempty"`

	// Terms: The corpus-specific search operators used to generate search
	// results.
	Terms string `json:"terms,omitempty"`

	// TimeZone: The time zone name. It should be an IANA TZ name, such as
	// "America/Los_Angeles". For more information, see Time Zone.
	TimeZone string `json:"timeZone,omitempty"`

	// VoiceOptions: For voice search, specify more options in this field.
	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 values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "AccountInfo") to include
	// in API requests with the JSON null value. By default, fields with
	// empty values are omitted from API requests. However, any field with
	// an empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

Query: A query definition relevant for search & export.

func (*Query) MarshalJSON

func (s *Query) MarshalJSON() ([]byte, error)

type RemoveHeldAccountsRequest

type RemoveHeldAccountsRequest struct {
	// AccountIds: Account IDs to identify HeldAccounts to remove.
	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 values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "AccountIds") to include in
	// API requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

RemoveHeldAccountsRequest: Remove a list of accounts from a hold.

func (*RemoveHeldAccountsRequest) MarshalJSON

func (s *RemoveHeldAccountsRequest) MarshalJSON() ([]byte, error)

type RemoveHeldAccountsResponse

type RemoveHeldAccountsResponse struct {
	// Statuses: A list of statuses for 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 values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "Statuses") to include in
	// API requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

RemoveHeldAccountsResponse: Response for batch delete held accounts.

func (*RemoveHeldAccountsResponse) MarshalJSON

func (s *RemoveHeldAccountsResponse) MarshalJSON() ([]byte, error)

type RemoveMatterPermissionsRequest

type RemoveMatterPermissionsRequest struct {
	// AccountId: The account ID.
	AccountId string `json:"accountId,omitempty"`

	// ForceSendFields is a list of field names (e.g. "AccountId") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "AccountId") to include in
	// API requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

RemoveMatterPermissionsRequest: Remove an account as a matter collaborator.

func (*RemoveMatterPermissionsRequest) MarshalJSON

func (s *RemoveMatterPermissionsRequest) MarshalJSON() ([]byte, error)

type ReopenMatterRequest

type ReopenMatterRequest struct {
}

ReopenMatterRequest: Reopen a matter by ID.

type ReopenMatterResponse

type ReopenMatterResponse struct {
	// Matter: The updated matter, with state OPEN.
	Matter *Matter `json:"matter,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the
	// server.
	googleapi.ServerResponse `json:"-"`

	// ForceSendFields is a list of field names (e.g. "Matter") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "Matter") to include in API
	// requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

ReopenMatterResponse: Response to a ReopenMatterRequest.

func (*ReopenMatterResponse) MarshalJSON

func (s *ReopenMatterResponse) MarshalJSON() ([]byte, error)

type SavedQuery

type SavedQuery struct {
	// CreateTime: Output only. The server generated timestamp at which
	// saved query was created.
	CreateTime string `json:"createTime,omitempty"`

	// DisplayName: Name of the saved query.
	DisplayName string `json:"displayName,omitempty"`

	// MatterId: Output only. The matter ID of the associated matter. The
	// server does not look at this field during create and always uses
	// matter id in the URL.
	MatterId string `json:"matterId,omitempty"`

	// Query: The underlying Query object which contains all the information
	// of the saved query.
	Query *Query `json:"query,omitempty"`

	// SavedQueryId: A unique identifier for the saved query.
	SavedQueryId string `json:"savedQueryId,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the
	// server.
	googleapi.ServerResponse `json:"-"`

	// ForceSendFields is a list of field names (e.g. "CreateTime") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "CreateTime") to include in
	// API requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

SavedQuery: Definition of the saved query. To work with Vault resources, the account must have the [required Vault privileges] (https://support.google.com/vault/answer/2799699) and access to the matter. To access a matter, the account must have created the matter, have the matter shared with them, or have the **View All Matters** privilege.

func (*SavedQuery) MarshalJSON

func (s *SavedQuery) MarshalJSON() ([]byte, error)

type Service

type Service struct {
	BasePath  string // API endpoint base URL
	UserAgent string // optional additional User-Agent fragment

	Matters *MattersService

	Operations *OperationsService
	// contains filtered or unexported fields
}

func New deprecated

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.

func NewService added in v0.3.0

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

NewService creates a new Service.

type SharedDriveInfo added in v0.7.0

type SharedDriveInfo struct {
	// SharedDriveIds: List of Shared drive IDs, as provided by Drive API.
	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 values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "SharedDriveIds") to
	// include in API requests with the JSON null value. By default, fields
	// with empty values are omitted from API requests. However, any field
	// with an empty value appearing in NullFields will be sent to the
	// server as null. It is an error if a field in this list has a
	// non-empty value. This may be used to include null fields in Patch
	// requests.
	NullFields []string `json:"-"`
}

SharedDriveInfo: Shared drives to search

func (*SharedDriveInfo) MarshalJSON added in v0.7.0

func (s *SharedDriveInfo) MarshalJSON() ([]byte, error)

type Status

type Status struct {
	// Code: The status code, which should be an enum value of
	// google.rpc.Code.
	Code int64 `json:"code,omitempty"`

	// Details: A list of messages that carry the error details. There is a
	// common set of message types for APIs to use.
	Details []googleapi.RawMessage `json:"details,omitempty"`

	// Message: A developer-facing error message, which should be in
	// English. Any user-facing error message should be localized and sent
	// in the google.rpc.Status.details field, or localized by the client.
	Message string `json:"message,omitempty"`

	// ForceSendFields is a list of field names (e.g. "Code") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "Code") to include in API
	// requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

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

func (*Status) MarshalJSON

func (s *Status) MarshalJSON() ([]byte, error)

type TeamDriveInfo

type TeamDriveInfo struct {
	// TeamDriveIds: List of Team Drive IDs, as provided by Drive API.
	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 values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "TeamDriveIds") to include
	// in API requests with the JSON null value. By default, fields with
	// empty values are omitted from API requests. However, any field with
	// an empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

TeamDriveInfo: Team Drives to search

func (*TeamDriveInfo) MarshalJSON

func (s *TeamDriveInfo) MarshalJSON() ([]byte, error)

type UndeleteMatterRequest

type UndeleteMatterRequest struct {
}

UndeleteMatterRequest: Undelete a matter by ID.

type UserInfo

type UserInfo struct {
	// DisplayName: The displayed name of the user.
	DisplayName string `json:"displayName,omitempty"`

	// Email: The email address of the user.
	Email string `json:"email,omitempty"`

	// ForceSendFields is a list of field names (e.g. "DisplayName") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "DisplayName") to include
	// in API requests with the JSON null value. By default, fields with
	// empty values are omitted from API requests. However, any field with
	// an empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

UserInfo: User's information.

func (*UserInfo) MarshalJSON

func (s *UserInfo) MarshalJSON() ([]byte, error)

type VoiceExportOptions added in v0.36.0

type VoiceExportOptions struct {
	// ExportFormat: The export format for voice export.
	//
	// Possible values:
	//   "EXPORT_FORMAT_UNSPECIFIED" - No export format specified.
	//   "MBOX" - MBOX as export format.
	//   "PST" - PST as export format
	ExportFormat string `json:"exportFormat,omitempty"`

	// ForceSendFields is a list of field names (e.g. "ExportFormat") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "ExportFormat") to include
	// in API requests with the JSON null value. By default, fields with
	// empty values are omitted from API requests. However, any field with
	// an empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

VoiceExportOptions: The options for voice export.

func (*VoiceExportOptions) MarshalJSON added in v0.36.0

func (s *VoiceExportOptions) MarshalJSON() ([]byte, error)

type VoiceOptions added in v0.36.0

type VoiceOptions struct {
	// CoveredData: Datatypes to search
	//
	// Possible values:
	//   "COVERED_DATA_UNSPECIFIED" - Covered data unspecified.
	//   "TEXT_MESSAGES" - Voice text message will be covered.
	//   "VOICEMAILS" - Voicemail will be covered.
	//   "CALL_LOGS" - Call logs will be covered.
	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 values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "CoveredData") to include
	// in API requests with the JSON null value. By default, fields with
	// empty values are omitted from API requests. However, any field with
	// an empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

VoiceOptions: Voice search options

func (*VoiceOptions) MarshalJSON added in v0.36.0

func (s *VoiceOptions) MarshalJSON() ([]byte, error)

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL