Autogenerated update (2017-08-25)

Add:
- adexperiencereport_v1
- androiddeviceprovisioning_v1
- androidmanagement_v1
- bigquerydatatransfer_v1
- cloudtrace_v2
- clouduseraccounts_vm_alpha
- consumersurveys_v2
- dlp_v2beta1
- oslogin_v1alpha
- playcustomapp_v1
- playmoviespartner_v1
- safebrowsing_v4
- spectrum_v1explorer
- speech_v1
- streetviewpublish_v1
- vault_v1
- videointelligence_v1beta1

Update:
- acceleratedmobilepageurl_v1
- adexchangebuyer2_v2beta1
- adexchangebuyer_v1_4
- adsense_v1_4
- adsensehost_v4_1
- analytics_v3
- analyticsreporting_v4
- androidenterprise_v1
- androidpublisher_v2
- appengine_v1
- appsactivity_v1
- appstate_v1
- bigquery_v2
- calendar_v3
- classroom_v1
- cloudbilling_v1
- cloudbuild_v1
- clouddebugger_v2
- clouderrorreporting_v1beta1
- cloudfunctions_v1
- cloudkms_v1
- cloudmonitoring_v2beta2
- cloudresourcemanager_v1
- compute_beta
- compute_v1
- container_v1
- content_v2
- dataflow_v1b3
- dataproc_v1
- datastore_v1
- deploymentmanager_v2
- dfareporting_v2_8
- dns_v1
- doubleclicksearch_v2
- drive_v3
- firebasedynamiclinks_v1
- firebaserules_v1
- fitness_v1
- games_configuration_v1configuration
- games_management_v1management
- games_v1
- genomics_v1
- gmail_v1
- iam_v1
- identitytoolkit_v3
- language_v1
- logging_v2
- manufacturers_v1
- ml_v1
- monitoring_v3
- oauth2_v2
- partners_v2
- people_v1
- plus_domains_v1
- plus_v1
- proximitybeacon_v1beta1
- pubsub_v1
- runtimeconfig_v1
- script_v1
- searchconsole_v1
- servicecontrol_v1
- servicemanagement_v1
- serviceuser_v1
- sheets_v4
- slides_v1
- sourcerepo_v1
- spanner_v1
- sqladmin_v1beta4
- storage_v1
- storagetransfer_v1
- toolresults_v1beta3
- vision_v1
- webmasters_v3
- youtube_analytics_v1
- youtube_partner_v1
- youtubereporting_v1
This commit is contained in:
Google APIs committed 2017-08-25 19:54:22 +00:00
1 parent ce32deabcf
commit 2dd396ce6e
315 files changed
+158012 -116092

No files matched your search

+554
View File
@@ -0,0 +1,554 @@
# Copyright 2015 Google Inc.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
require 'date'
require 'google/apis/core/base_service'
require 'google/apis/core/json_representation'
require 'google/apis/core/hashable'
require 'google/apis/errors'
module Google
module Apis
module VaultV1
# 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.
class AddMatterPermissionsRequest
include Google::Apis::Core::Hashable
# Only relevant if send_emails is true.
# True to CC requestor in the email message.
# False to not CC requestor.
# Corresponds to the JSON property `ccMe`
# @return [Boolean]
attr_accessor :cc_me
alias_method :cc_me?, :cc_me
# Currently each matter only has one owner, and all others are collaborators.
# When an account is purged, its corresponding MatterPermission resources
# cease to exist.
# Corresponds to the JSON property `matterPermission`
# @return [Google::Apis::VaultV1::MatterPermission]
attr_accessor :matter_permission
# True to send notification email to the added account.
# False to not send notification email.
# Corresponds to the JSON property `sendEmails`
# @return [Boolean]
attr_accessor :send_emails
alias_method :send_emails?, :send_emails
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@cc_me = args[:cc_me] if args.key?(:cc_me)
@matter_permission = args[:matter_permission] if args.key?(:matter_permission)
@send_emails = args[:send_emails] if args.key?(:send_emails)
end
end
# Close a matter by ID.
class CloseMatterRequest
include Google::Apis::Core::Hashable
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
end
end
# Response to a CloseMatterRequest.
class CloseMatterResponse
include Google::Apis::Core::Hashable
# Represents a matter.
# Corresponds to the JSON property `matter`
# @return [Google::Apis::VaultV1::Matter]
attr_accessor :matter
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@matter = args[:matter] if args.key?(:matter)
end
end
# Corpus specific queries.
class CorpusQuery
include Google::Apis::Core::Hashable
# Query options for drive holds.
# Corresponds to the JSON property `driveQuery`
# @return [Google::Apis::VaultV1::HeldDriveQuery]
attr_accessor :drive_query
# Query options for group holds.
# Corresponds to the JSON property `groupsQuery`
# @return [Google::Apis::VaultV1::HeldGroupsQuery]
attr_accessor :groups_query
# Query options for mail holds.
# Corresponds to the JSON property `mailQuery`
# @return [Google::Apis::VaultV1::HeldMailQuery]
attr_accessor :mail_query
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@drive_query = args[:drive_query] if args.key?(:drive_query)
@groups_query = args[:groups_query] if args.key?(:groups_query)
@mail_query = args[:mail_query] if args.key?(:mail_query)
end
end
# 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 ````.
class Empty
include Google::Apis::Core::Hashable
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
end
end
# 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.
class HeldAccount
include Google::Apis::Core::Hashable
# The account's ID as provided by the <a
# href="https://developers.google.com/admin-sdk/">Admin SDK</a>.
# Corresponds to the JSON property `accountId`
# @return [String]
attr_accessor :account_id
# When the account was put on hold.
# Corresponds to the JSON property `holdTime`
# @return [String]
attr_accessor :hold_time
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@account_id = args[:account_id] if args.key?(:account_id)
@hold_time = args[:hold_time] if args.key?(:hold_time)
end
end
# Query options for drive holds.
class HeldDriveQuery
include Google::Apis::Core::Hashable
# If true, include files in Team Drives in the hold.
# Corresponds to the JSON property `includeTeamDriveFiles`
# @return [Boolean]
attr_accessor :include_team_drive_files
alias_method :include_team_drive_files?, :include_team_drive_files
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@include_team_drive_files = args[:include_team_drive_files] if args.key?(:include_team_drive_files)
end
end
# Query options for group holds.
class HeldGroupsQuery
include Google::Apis::Core::Hashable
# The end date range for the search query. These timestamps are in GMT and
# rounded down to the start of the given date.
# Corresponds to the JSON property `endTime`
# @return [String]
attr_accessor :end_time
# The start date range for the search query. These timestamps are in GMT and
# rounded down to the start of the given date.
# Corresponds to the JSON property `startTime`
# @return [String]
attr_accessor :start_time
# The search terms for the hold.
# Corresponds to the JSON property `terms`
# @return [String]
attr_accessor :terms
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@end_time = args[:end_time] if args.key?(:end_time)
@start_time = args[:start_time] if args.key?(:start_time)
@terms = args[:terms] if args.key?(:terms)
end
end
# Query options for mail holds.
class HeldMailQuery
include Google::Apis::Core::Hashable
# The end date range for the search query. These timestamps are in GMT and
# rounded down to the start of the given date.
# Corresponds to the JSON property `endTime`
# @return [String]
attr_accessor :end_time
# The start date range for the search query. These timestamps are in GMT and
# rounded down to the start of the given date.
# Corresponds to the JSON property `startTime`
# @return [String]
attr_accessor :start_time
# The search terms for the hold.
# Corresponds to the JSON property `terms`
# @return [String]
attr_accessor :terms
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@end_time = args[:end_time] if args.key?(:end_time)
@start_time = args[:start_time] if args.key?(:start_time)
@terms = args[:terms] if args.key?(:terms)
end
end
# A organizational unit being held in a particular hold.
# This structure is immutable.
class HeldOrgUnit
include Google::Apis::Core::Hashable
# When the org unit was put on hold. This property is immutable.
# Corresponds to the JSON property `holdTime`
# @return [String]
attr_accessor :hold_time
# The org unit's immutable ID as provided by the admin SDK.
# Corresponds to the JSON property `orgUnitId`
# @return [String]
attr_accessor :org_unit_id
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@hold_time = args[:hold_time] if args.key?(:hold_time)
@org_unit_id = args[:org_unit_id] if args.key?(:org_unit_id)
end
end
# 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.
class Hold
include Google::Apis::Core::Hashable
# If set, the hold applies to the enumerated accounts and org_unit must be
# empty.
# Corresponds to the JSON property `accounts`
# @return [Array<Google::Apis::VaultV1::HeldAccount>]
attr_accessor :accounts
# The corpus to be searched.
# Corresponds to the JSON property `corpus`
# @return [String]
attr_accessor :corpus
# The unique immutable ID of the hold. Assigned during creation.
# Corresponds to the JSON property `holdId`
# @return [String]
attr_accessor :hold_id
# The name of the hold.
# Corresponds to the JSON property `name`
# @return [String]
attr_accessor :name
# A organizational unit being held in a particular hold.
# This structure is immutable.
# Corresponds to the JSON property `orgUnit`
# @return [Google::Apis::VaultV1::HeldOrgUnit]
attr_accessor :org_unit
# Corpus specific queries.
# Corresponds to the JSON property `query`
# @return [Google::Apis::VaultV1::CorpusQuery]
attr_accessor :query
# The last time this hold was modified.
# Corresponds to the JSON property `updateTime`
# @return [String]
attr_accessor :update_time
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@accounts = args[:accounts] if args.key?(:accounts)
@corpus = args[:corpus] if args.key?(:corpus)
@hold_id = args[:hold_id] if args.key?(:hold_id)
@name = args[:name] if args.key?(:name)
@org_unit = args[:org_unit] if args.key?(:org_unit)
@query = args[:query] if args.key?(:query)
@update_time = args[:update_time] if args.key?(:update_time)
end
end
# Returns a list of held accounts for a hold.
class ListHeldAccountsResponse
include Google::Apis::Core::Hashable
# The held accounts on a hold.
# Corresponds to the JSON property `accounts`
# @return [Array<Google::Apis::VaultV1::HeldAccount>]
attr_accessor :accounts
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@accounts = args[:accounts] if args.key?(:accounts)
end
end
# The holds for a matter.
class ListHoldsResponse
include Google::Apis::Core::Hashable
# The list of holds.
# Corresponds to the JSON property `holds`
# @return [Array<Google::Apis::VaultV1::Hold>]
attr_accessor :holds
# Page token to retrieve the next page of results in the list.
# If this is empty, then there are no more holds to list.
# Corresponds to the JSON property `nextPageToken`
# @return [String]
attr_accessor :next_page_token
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@holds = args[:holds] if args.key?(:holds)
@next_page_token = args[:next_page_token] if args.key?(:next_page_token)
end
end
# Provides the list of matters.
class ListMattersResponse
include Google::Apis::Core::Hashable
# List of matters.
# Corresponds to the JSON property `matters`
# @return [Array<Google::Apis::VaultV1::Matter>]
attr_accessor :matters
# Page token to retrieve the next page of results in the list.
# Corresponds to the JSON property `nextPageToken`
# @return [String]
attr_accessor :next_page_token
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@matters = args[:matters] if args.key?(:matters)
@next_page_token = args[:next_page_token] if args.key?(:next_page_token)
end
end
# Represents a matter.
class Matter
include Google::Apis::Core::Hashable
# The description of the matter.
# Corresponds to the JSON property `description`
# @return [String]
attr_accessor :description
# The matter ID which is generated by the server.
# Should be blank when creating a new matter.
# Corresponds to the JSON property `matterId`
# @return [String]
attr_accessor :matter_id
# List of users and access to the matter. Currently there is no programmer
# defined limit on the number of permissions a matter can have.
# Corresponds to the JSON property `matterPermissions`
# @return [Array<Google::Apis::VaultV1::MatterPermission>]
attr_accessor :matter_permissions
# The name of the matter.
# Corresponds to the JSON property `name`
# @return [String]
attr_accessor :name
# The state of the matter.
# Corresponds to the JSON property `state`
# @return [String]
attr_accessor :state
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@description = args[:description] if args.key?(:description)
@matter_id = args[:matter_id] if args.key?(:matter_id)
@matter_permissions = args[:matter_permissions] if args.key?(:matter_permissions)
@name = args[:name] if args.key?(:name)
@state = args[:state] if args.key?(:state)
end
end
# Currently each matter only has one owner, and all others are collaborators.
# When an account is purged, its corresponding MatterPermission resources
# cease to exist.
class MatterPermission
include Google::Apis::Core::Hashable
# The account id, as provided by <a href="https://developers.google.com/admin-
# sdk/">Admin SDK</a>.
# Corresponds to the JSON property `accountId`
# @return [String]
attr_accessor :account_id
# The user's role in this matter.
# Corresponds to the JSON property `role`
# @return [String]
attr_accessor :role
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@account_id = args[:account_id] if args.key?(:account_id)
@role = args[:role] if args.key?(:role)
end
end
# Remove an account as a matter collaborator.
class RemoveMatterPermissionsRequest
include Google::Apis::Core::Hashable
# The account ID.
# Corresponds to the JSON property `accountId`
# @return [String]
attr_accessor :account_id
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@account_id = args[:account_id] if args.key?(:account_id)
end
end
# Reopen a matter by ID.
class ReopenMatterRequest
include Google::Apis::Core::Hashable
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
end
end
# Response to a ReopenMatterRequest.
class ReopenMatterResponse
include Google::Apis::Core::Hashable
# Represents a matter.
# Corresponds to the JSON property `matter`
# @return [Google::Apis::VaultV1::Matter]
attr_accessor :matter
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@matter = args[:matter] if args.key?(:matter)
end
end
# Undelete a matter by ID.
class UndeleteMatterRequest
include Google::Apis::Core::Hashable
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
end
end
end
end
end
@@ -0,0 +1,318 @@
# Copyright 2015 Google Inc.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
require 'date'
require 'google/apis/core/base_service'
require 'google/apis/core/json_representation'
require 'google/apis/core/hashable'
require 'google/apis/errors'
module Google
module Apis
module VaultV1
class AddMatterPermissionsRequest
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class CloseMatterRequest
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class CloseMatterResponse
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class CorpusQuery
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class Empty
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class HeldAccount
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class HeldDriveQuery
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class HeldGroupsQuery
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class HeldMailQuery
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class HeldOrgUnit
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class Hold
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class ListHeldAccountsResponse
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class ListHoldsResponse
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class ListMattersResponse
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class Matter
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class MatterPermission
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class RemoveMatterPermissionsRequest
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class ReopenMatterRequest
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class ReopenMatterResponse
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class UndeleteMatterRequest
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class AddMatterPermissionsRequest
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :cc_me, as: 'ccMe'
property :matter_permission, as: 'matterPermission', class: Google::Apis::VaultV1::MatterPermission, decorator: Google::Apis::VaultV1::MatterPermission::Representation
property :send_emails, as: 'sendEmails'
end
end
class CloseMatterRequest
# @private
class Representation < Google::Apis::Core::JsonRepresentation
end
end
class CloseMatterResponse
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :matter, as: 'matter', class: Google::Apis::VaultV1::Matter, decorator: Google::Apis::VaultV1::Matter::Representation
end
end
class CorpusQuery
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :drive_query, as: 'driveQuery', class: Google::Apis::VaultV1::HeldDriveQuery, decorator: Google::Apis::VaultV1::HeldDriveQuery::Representation
property :groups_query, as: 'groupsQuery', class: Google::Apis::VaultV1::HeldGroupsQuery, decorator: Google::Apis::VaultV1::HeldGroupsQuery::Representation
property :mail_query, as: 'mailQuery', class: Google::Apis::VaultV1::HeldMailQuery, decorator: Google::Apis::VaultV1::HeldMailQuery::Representation
end
end
class Empty
# @private
class Representation < Google::Apis::Core::JsonRepresentation
end
end
class HeldAccount
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :account_id, as: 'accountId'
property :hold_time, as: 'holdTime'
end
end
class HeldDriveQuery
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :include_team_drive_files, as: 'includeTeamDriveFiles'
end
end
class HeldGroupsQuery
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :end_time, as: 'endTime'
property :start_time, as: 'startTime'
property :terms, as: 'terms'
end
end
class HeldMailQuery
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :end_time, as: 'endTime'
property :start_time, as: 'startTime'
property :terms, as: 'terms'
end
end
class HeldOrgUnit
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :hold_time, as: 'holdTime'
property :org_unit_id, as: 'orgUnitId'
end
end
class Hold
# @private
class Representation < Google::Apis::Core::JsonRepresentation
collection :accounts, as: 'accounts', class: Google::Apis::VaultV1::HeldAccount, decorator: Google::Apis::VaultV1::HeldAccount::Representation
property :corpus, as: 'corpus'
property :hold_id, as: 'holdId'
property :name, as: 'name'
property :org_unit, as: 'orgUnit', class: Google::Apis::VaultV1::HeldOrgUnit, decorator: Google::Apis::VaultV1::HeldOrgUnit::Representation
property :query, as: 'query', class: Google::Apis::VaultV1::CorpusQuery, decorator: Google::Apis::VaultV1::CorpusQuery::Representation
property :update_time, as: 'updateTime'
end
end
class ListHeldAccountsResponse
# @private
class Representation < Google::Apis::Core::JsonRepresentation
collection :accounts, as: 'accounts', class: Google::Apis::VaultV1::HeldAccount, decorator: Google::Apis::VaultV1::HeldAccount::Representation
end
end
class ListHoldsResponse
# @private
class Representation < Google::Apis::Core::JsonRepresentation
collection :holds, as: 'holds', class: Google::Apis::VaultV1::Hold, decorator: Google::Apis::VaultV1::Hold::Representation
property :next_page_token, as: 'nextPageToken'
end
end
class ListMattersResponse
# @private
class Representation < Google::Apis::Core::JsonRepresentation
collection :matters, as: 'matters', class: Google::Apis::VaultV1::Matter, decorator: Google::Apis::VaultV1::Matter::Representation
property :next_page_token, as: 'nextPageToken'
end
end
class Matter
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :description, as: 'description'
property :matter_id, as: 'matterId'
collection :matter_permissions, as: 'matterPermissions', class: Google::Apis::VaultV1::MatterPermission, decorator: Google::Apis::VaultV1::MatterPermission::Representation
property :name, as: 'name'
property :state, as: 'state'
end
end
class MatterPermission
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :account_id, as: 'accountId'
property :role, as: 'role'
end
end
class RemoveMatterPermissionsRequest
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :account_id, as: 'accountId'
end
end
class ReopenMatterRequest
# @private
class Representation < Google::Apis::Core::JsonRepresentation
end
end
class ReopenMatterResponse
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :matter, as: 'matter', class: Google::Apis::VaultV1::Matter, decorator: Google::Apis::VaultV1::Matter::Representation
end
end
class UndeleteMatterRequest
# @private
class Representation < Google::Apis::Core::JsonRepresentation
end
end
end
end
end
+677
View File
@@ -0,0 +1,677 @@
# Copyright 2015 Google Inc.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
require 'google/apis/core/base_service'
require 'google/apis/core/json_representation'
require 'google/apis/core/hashable'
require 'google/apis/errors'
module Google
module Apis
module VaultV1
# Google Vault API
#
#
#
# @example
# require 'google/apis/vault_v1'
#
# Vault = Google::Apis::VaultV1 # Alias the module
# service = Vault::VaultService.new
#
# @see https://apps.google.com/products/vault/
class VaultService < Google::Apis::Core::BaseService
# @return [String]
# API key. Your API key identifies your project and provides you with API access,
# quota, and reports. Required unless you provide an OAuth 2.0 token.
attr_accessor :key
# @return [String]
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
attr_accessor :quota_user
def initialize
super('https://vault.googleapis.com/', '')
@batch_path = 'batch'
end
# Adds an account as a matter collaborator.
# @param [String] matter_id
# The matter ID.
# @param [Google::Apis::VaultV1::AddMatterPermissionsRequest] add_matter_permissions_request_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::VaultV1::MatterPermission] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::VaultV1::MatterPermission]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def add_matter_permissions(matter_id, add_matter_permissions_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:post, 'v1/matters/{matterId}:addPermissions', options)
command.request_representation = Google::Apis::VaultV1::AddMatterPermissionsRequest::Representation
command.request_object = add_matter_permissions_request_object
command.response_representation = Google::Apis::VaultV1::MatterPermission::Representation
command.response_class = Google::Apis::VaultV1::MatterPermission
command.params['matterId'] = matter_id unless matter_id.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Closes the specified matter. Returns matter with updated state.
# @param [String] matter_id
# The matter ID.
# @param [Google::Apis::VaultV1::CloseMatterRequest] close_matter_request_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::VaultV1::CloseMatterResponse] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::VaultV1::CloseMatterResponse]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def close_matter(matter_id, close_matter_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:post, 'v1/matters/{matterId}:close', options)
command.request_representation = Google::Apis::VaultV1::CloseMatterRequest::Representation
command.request_object = close_matter_request_object
command.response_representation = Google::Apis::VaultV1::CloseMatterResponse::Representation
command.response_class = Google::Apis::VaultV1::CloseMatterResponse
command.params['matterId'] = matter_id unless matter_id.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Creates a new matter. Returns created matter with default view.
# @param [Google::Apis::VaultV1::Matter] matter_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::VaultV1::Matter] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::VaultV1::Matter]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def create_matter(matter_object = nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:post, 'v1/matters', options)
command.request_representation = Google::Apis::VaultV1::Matter::Representation
command.request_object = matter_object
command.response_representation = Google::Apis::VaultV1::Matter::Representation
command.response_class = Google::Apis::VaultV1::Matter
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Deletes the specified matter. Returns matter with updated state.
# @param [String] matter_id
# The matter ID
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::VaultV1::Matter] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::VaultV1::Matter]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def delete_matter(matter_id, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:delete, 'v1/matters/{matterId}', options)
command.response_representation = Google::Apis::VaultV1::Matter::Representation
command.response_class = Google::Apis::VaultV1::Matter
command.params['matterId'] = matter_id unless matter_id.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Gets the specified matter.
# @param [String] matter_id
# The matter ID.
# @param [String] view
# Specifies which parts of the Matter to return in the response.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::VaultV1::Matter] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::VaultV1::Matter]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def get_matter(matter_id, view: nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'v1/matters/{matterId}', options)
command.response_representation = Google::Apis::VaultV1::Matter::Representation
command.response_class = Google::Apis::VaultV1::Matter
command.params['matterId'] = matter_id unless matter_id.nil?
command.query['view'] = view unless view.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Lists matters the user has access to.
# @param [Fixnum] page_size
# The number of matters to return in the response.
# Default and maximum are 100.
# @param [String] page_token
# The pagination token as returned in the response.
# @param [String] view
# Specifies which parts of the matter to return in response.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::VaultV1::ListMattersResponse] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::VaultV1::ListMattersResponse]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def list_matters(page_size: nil, page_token: nil, view: nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'v1/matters', options)
command.response_representation = Google::Apis::VaultV1::ListMattersResponse::Representation
command.response_class = Google::Apis::VaultV1::ListMattersResponse
command.query['pageSize'] = page_size unless page_size.nil?
command.query['pageToken'] = page_token unless page_token.nil?
command.query['view'] = view unless view.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Removes an account as a matter collaborator.
# @param [String] matter_id
# The matter ID.
# @param [Google::Apis::VaultV1::RemoveMatterPermissionsRequest] remove_matter_permissions_request_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::VaultV1::Empty] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::VaultV1::Empty]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def remove_matter_permissions(matter_id, remove_matter_permissions_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:post, 'v1/matters/{matterId}:removePermissions', options)
command.request_representation = Google::Apis::VaultV1::RemoveMatterPermissionsRequest::Representation
command.request_object = remove_matter_permissions_request_object
command.response_representation = Google::Apis::VaultV1::Empty::Representation
command.response_class = Google::Apis::VaultV1::Empty
command.params['matterId'] = matter_id unless matter_id.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Reopens the specified matter. Returns matter with updated state.
# @param [String] matter_id
# The matter ID.
# @param [Google::Apis::VaultV1::ReopenMatterRequest] reopen_matter_request_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::VaultV1::ReopenMatterResponse] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::VaultV1::ReopenMatterResponse]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def reopen_matter(matter_id, reopen_matter_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:post, 'v1/matters/{matterId}:reopen', options)
command.request_representation = Google::Apis::VaultV1::ReopenMatterRequest::Representation
command.request_object = reopen_matter_request_object
command.response_representation = Google::Apis::VaultV1::ReopenMatterResponse::Representation
command.response_class = Google::Apis::VaultV1::ReopenMatterResponse
command.params['matterId'] = matter_id unless matter_id.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Undeletes the specified matter. Returns matter with updated state.
# @param [String] matter_id
# The matter ID.
# @param [Google::Apis::VaultV1::UndeleteMatterRequest] undelete_matter_request_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::VaultV1::Matter] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::VaultV1::Matter]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def undelete_matter(matter_id, undelete_matter_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:post, 'v1/matters/{matterId}:undelete', options)
command.request_representation = Google::Apis::VaultV1::UndeleteMatterRequest::Representation
command.request_object = undelete_matter_request_object
command.response_representation = Google::Apis::VaultV1::Matter::Representation
command.response_class = Google::Apis::VaultV1::Matter
command.params['matterId'] = matter_id unless matter_id.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# 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.
# @param [String] matter_id
# The matter ID.
# @param [Google::Apis::VaultV1::Matter] matter_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::VaultV1::Matter] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::VaultV1::Matter]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def update_matter(matter_id, matter_object = nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:put, 'v1/matters/{matterId}', options)
command.request_representation = Google::Apis::VaultV1::Matter::Representation
command.request_object = matter_object
command.response_representation = Google::Apis::VaultV1::Matter::Representation
command.response_class = Google::Apis::VaultV1::Matter
command.params['matterId'] = matter_id unless matter_id.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Creates a hold in the given matter.
# @param [String] matter_id
# The matter ID.
# @param [Google::Apis::VaultV1::Hold] hold_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::VaultV1::Hold] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::VaultV1::Hold]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def create_matter_hold(matter_id, hold_object = nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:post, 'v1/matters/{matterId}/holds', options)
command.request_representation = Google::Apis::VaultV1::Hold::Representation
command.request_object = hold_object
command.response_representation = Google::Apis::VaultV1::Hold::Representation
command.response_class = Google::Apis::VaultV1::Hold
command.params['matterId'] = matter_id unless matter_id.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Removes a hold by ID. This will release any HeldAccounts on this Hold.
# @param [String] matter_id
# The matter ID.
# @param [String] hold_id
# The hold ID.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::VaultV1::Empty] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::VaultV1::Empty]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def delete_matter_hold(matter_id, hold_id, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:delete, 'v1/matters/{matterId}/holds/{holdId}', options)
command.response_representation = Google::Apis::VaultV1::Empty::Representation
command.response_class = Google::Apis::VaultV1::Empty
command.params['matterId'] = matter_id unless matter_id.nil?
command.params['holdId'] = hold_id unless hold_id.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Gets a hold by ID.
# @param [String] matter_id
# The matter ID.
# @param [String] hold_id
# The hold ID.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::VaultV1::Hold] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::VaultV1::Hold]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def get_matter_hold(matter_id, hold_id, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'v1/matters/{matterId}/holds/{holdId}', options)
command.response_representation = Google::Apis::VaultV1::Hold::Representation
command.response_class = Google::Apis::VaultV1::Hold
command.params['matterId'] = matter_id unless matter_id.nil?
command.params['holdId'] = hold_id unless hold_id.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Lists holds within a matter. An empty page token in ListHoldsResponse
# denotes no more holds to list.
# @param [String] matter_id
# The matter ID.
# @param [Fixnum] page_size
# 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.
# @param [String] page_token
# The pagination token as returned in the response.
# An empty token means start from the beginning.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::VaultV1::ListHoldsResponse] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::VaultV1::ListHoldsResponse]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def list_matter_holds(matter_id, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'v1/matters/{matterId}/holds', options)
command.response_representation = Google::Apis::VaultV1::ListHoldsResponse::Representation
command.response_class = Google::Apis::VaultV1::ListHoldsResponse
command.params['matterId'] = matter_id unless matter_id.nil?
command.query['pageSize'] = page_size unless page_size.nil?
command.query['pageToken'] = page_token unless page_token.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# 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.
# @param [String] matter_id
# The matter ID.
# @param [String] hold_id
# The ID of the hold.
# @param [Google::Apis::VaultV1::Hold] hold_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::VaultV1::Hold] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::VaultV1::Hold]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def update_matter_hold(matter_id, hold_id, hold_object = nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:put, 'v1/matters/{matterId}/holds/{holdId}', options)
command.request_representation = Google::Apis::VaultV1::Hold::Representation
command.request_object = hold_object
command.response_representation = Google::Apis::VaultV1::Hold::Representation
command.response_class = Google::Apis::VaultV1::Hold
command.params['matterId'] = matter_id unless matter_id.nil?
command.params['holdId'] = hold_id unless hold_id.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# 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.
# @param [String] matter_id
# The matter ID.
# @param [String] hold_id
# The hold ID.
# @param [Google::Apis::VaultV1::HeldAccount] held_account_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::VaultV1::HeldAccount] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::VaultV1::HeldAccount]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def create_matter_hold_account(matter_id, hold_id, held_account_object = nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:post, 'v1/matters/{matterId}/holds/{holdId}/accounts', options)
command.request_representation = Google::Apis::VaultV1::HeldAccount::Representation
command.request_object = held_account_object
command.response_representation = Google::Apis::VaultV1::HeldAccount::Representation
command.response_class = Google::Apis::VaultV1::HeldAccount
command.params['matterId'] = matter_id unless matter_id.nil?
command.params['holdId'] = hold_id unless hold_id.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Removes a HeldAccount from a hold. If this request leaves the hold with
# no held accounts, the hold will not apply to any accounts.
# @param [String] matter_id
# The matter ID.
# @param [String] hold_id
# The hold ID.
# @param [String] account_id
# The ID of the account to remove from the hold.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::VaultV1::Empty] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::VaultV1::Empty]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def delete_matter_hold_account(matter_id, hold_id, account_id, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:delete, 'v1/matters/{matterId}/holds/{holdId}/accounts/{accountId}', options)
command.response_representation = Google::Apis::VaultV1::Empty::Representation
command.response_class = Google::Apis::VaultV1::Empty
command.params['matterId'] = matter_id unless matter_id.nil?
command.params['holdId'] = hold_id unless hold_id.nil?
command.params['accountId'] = account_id unless account_id.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Lists HeldAccounts for a hold. This will only list individually specified
# held accounts. If the hold is on an OU, then use the <ahref="https://
# developers.google.com/admin-sdk/">Admin SDK</a>
# to enumerate its members.
# @param [String] matter_id
# The matter ID.
# @param [String] hold_id
# The hold ID.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::VaultV1::ListHeldAccountsResponse] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::VaultV1::ListHeldAccountsResponse]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def list_matter_hold_accounts(matter_id, hold_id, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'v1/matters/{matterId}/holds/{holdId}/accounts', options)
command.response_representation = Google::Apis::VaultV1::ListHeldAccountsResponse::Representation
command.response_class = Google::Apis::VaultV1::ListHeldAccountsResponse
command.params['matterId'] = matter_id unless matter_id.nil?
command.params['holdId'] = hold_id unless hold_id.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
protected
def apply_command_defaults(command)
command.query['key'] = key unless key.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
end
end
end
end
end