From f2fb36e6f17ebd71283e22e215c3106509d1c5dd Mon Sep 17 00:00:00 2001 From: Google APIs Date: Thu, 14 May 2020 00:38:09 +0000 Subject: [PATCH] Autogenerated update (2020-05-14) Update: - appengine_v1 - appengine_v1beta - bigqueryreservation_v1 - bigqueryreservation_v1alpha2 - bigqueryreservation_v1beta1 - container_v1 - firebasehosting_v1beta1 - games_management_v1management - gameservices_v1beta - gmail_v1 - healthcare_v1 - healthcare_v1beta1 - jobs_v3p1beta1 - run_v1 - run_v1alpha1 - storage_v1 - testing_v1 - toolresults_v1beta3 - youtube_partner_v1 --- generated/google/apis/appengine_v1.rb | 2 +- generated/google/apis/appengine_v1/classes.rb | 7 + .../apis/appengine_v1/representations.rb | 1 + generated/google/apis/appengine_v1beta.rb | 2 +- .../google/apis/appengine_v1beta/classes.rb | 7 + .../apis/appengine_v1beta/representations.rb | 1 + .../google/apis/bigqueryreservation_v1.rb | 2 +- .../apis/bigqueryreservation_v1/classes.rb | 34 +- .../apis/bigqueryreservation_v1/service.rb | 159 +- .../apis/bigqueryreservation_v1alpha2.rb | 2 +- .../apis/bigqueryreservation_v1beta1.rb | 2 +- .../bigqueryreservation_v1beta1/classes.rb | 47 - .../representations.rb | 16 - generated/google/apis/container_v1.rb | 2 +- generated/google/apis/container_v1/classes.rb | 5 +- .../google/apis/firebasehosting_v1beta1.rb | 2 +- .../apis/firebasehosting_v1beta1/classes.rb | 8 +- .../apis/games_management_v1management.rb | 10 +- .../games_management_v1management/classes.rb | 140 +- .../representations.rb | 17 - .../games_management_v1management/service.rb | 406 ++---- generated/google/apis/gameservices_v1beta.rb | 2 +- .../apis/gameservices_v1beta/classes.rb | 133 +- .../apis/gameservices_v1beta/service.rb | 117 +- generated/google/apis/gmail_v1.rb | 5 +- generated/google/apis/gmail_v1/classes.rb | 457 +++--- generated/google/apis/gmail_v1/service.rb | 1294 ++++++++++------- generated/google/apis/healthcare_v1.rb | 2 +- .../google/apis/healthcare_v1/classes.rb | 56 +- .../google/apis/healthcare_v1/service.rb | 157 +- generated/google/apis/healthcare_v1beta1.rb | 2 +- .../google/apis/healthcare_v1beta1/classes.rb | 56 +- .../google/apis/healthcare_v1beta1/service.rb | 176 +-- generated/google/apis/jobs_v3p1beta1.rb | 2 +- .../google/apis/jobs_v3p1beta1/classes.rb | 6 +- generated/google/apis/run_v1.rb | 2 +- generated/google/apis/run_v1/classes.rb | 80 +- .../google/apis/run_v1/representations.rb | 18 +- generated/google/apis/run_v1/service.rb | 3 + generated/google/apis/run_v1alpha1.rb | 2 +- generated/google/apis/run_v1alpha1/classes.rb | 33 +- generated/google/apis/run_v1alpha1/service.rb | 3 + generated/google/apis/storage_v1.rb | 2 +- generated/google/apis/storage_v1/classes.rb | 18 + .../google/apis/storage_v1/representations.rb | 3 + generated/google/apis/testing_v1.rb | 2 +- generated/google/apis/testing_v1/classes.rb | 5 +- generated/google/apis/toolresults_v1beta3.rb | 2 +- .../apis/toolresults_v1beta3/classes.rb | 143 +- .../toolresults_v1beta3/representations.rb | 77 + generated/google/apis/youtube_partner_v1.rb | 2 +- 51 files changed, 1875 insertions(+), 1857 deletions(-) diff --git a/generated/google/apis/appengine_v1.rb b/generated/google/apis/appengine_v1.rb index 21cd7590f..a3a7865fb 100644 --- a/generated/google/apis/appengine_v1.rb +++ b/generated/google/apis/appengine_v1.rb @@ -25,7 +25,7 @@ module Google # @see https://cloud.google.com/appengine/docs/admin-api/ module AppengineV1 VERSION = 'V1' - REVISION = '20200329' + REVISION = '20200507' # View and manage your applications deployed on Google App Engine AUTH_APPENGINE_ADMIN = 'https://www.googleapis.com/auth/appengine.admin' diff --git a/generated/google/apis/appengine_v1/classes.rb b/generated/google/apis/appengine_v1/classes.rb index 6174ffc38..30eca9ae6 100644 --- a/generated/google/apis/appengine_v1/classes.rb +++ b/generated/google/apis/appengine_v1/classes.rb @@ -104,6 +104,12 @@ module Google # @return [String] attr_accessor :code_bucket + # The type of the Cloud Firestore or Cloud Datastore database associated with + # this application. + # Corresponds to the JSON property `databaseType` + # @return [String] + attr_accessor :database_type + # Google Cloud Storage bucket that can be used by this application to store # content.@OutputOnly # Corresponds to the JSON property `defaultBucket` @@ -178,6 +184,7 @@ module Google def update!(**args) @auth_domain = args[:auth_domain] if args.key?(:auth_domain) @code_bucket = args[:code_bucket] if args.key?(:code_bucket) + @database_type = args[:database_type] if args.key?(:database_type) @default_bucket = args[:default_bucket] if args.key?(:default_bucket) @default_cookie_expiration = args[:default_cookie_expiration] if args.key?(:default_cookie_expiration) @default_hostname = args[:default_hostname] if args.key?(:default_hostname) diff --git a/generated/google/apis/appengine_v1/representations.rb b/generated/google/apis/appengine_v1/representations.rb index e29dddf6b..d8f63ca77 100644 --- a/generated/google/apis/appengine_v1/representations.rb +++ b/generated/google/apis/appengine_v1/representations.rb @@ -459,6 +459,7 @@ module Google class Representation < Google::Apis::Core::JsonRepresentation property :auth_domain, as: 'authDomain' property :code_bucket, as: 'codeBucket' + property :database_type, as: 'databaseType' property :default_bucket, as: 'defaultBucket' property :default_cookie_expiration, as: 'defaultCookieExpiration' property :default_hostname, as: 'defaultHostname' diff --git a/generated/google/apis/appengine_v1beta.rb b/generated/google/apis/appengine_v1beta.rb index 9b43bca51..6d0d5e478 100644 --- a/generated/google/apis/appengine_v1beta.rb +++ b/generated/google/apis/appengine_v1beta.rb @@ -25,7 +25,7 @@ module Google # @see https://cloud.google.com/appengine/docs/admin-api/ module AppengineV1beta VERSION = 'V1beta' - REVISION = '20200329' + REVISION = '20200507' # View and manage your applications deployed on Google App Engine AUTH_APPENGINE_ADMIN = 'https://www.googleapis.com/auth/appengine.admin' diff --git a/generated/google/apis/appengine_v1beta/classes.rb b/generated/google/apis/appengine_v1beta/classes.rb index d3e8dad7f..314b560d9 100644 --- a/generated/google/apis/appengine_v1beta/classes.rb +++ b/generated/google/apis/appengine_v1beta/classes.rb @@ -104,6 +104,12 @@ module Google # @return [String] attr_accessor :code_bucket + # The type of the Cloud Firestore or Cloud Datastore database associated with + # this application. + # Corresponds to the JSON property `databaseType` + # @return [String] + attr_accessor :database_type + # Google Cloud Storage bucket that can be used by this application to store # content.@OutputOnly # Corresponds to the JSON property `defaultBucket` @@ -178,6 +184,7 @@ module Google def update!(**args) @auth_domain = args[:auth_domain] if args.key?(:auth_domain) @code_bucket = args[:code_bucket] if args.key?(:code_bucket) + @database_type = args[:database_type] if args.key?(:database_type) @default_bucket = args[:default_bucket] if args.key?(:default_bucket) @default_cookie_expiration = args[:default_cookie_expiration] if args.key?(:default_cookie_expiration) @default_hostname = args[:default_hostname] if args.key?(:default_hostname) diff --git a/generated/google/apis/appengine_v1beta/representations.rb b/generated/google/apis/appengine_v1beta/representations.rb index 9282b07bc..e6af713fa 100644 --- a/generated/google/apis/appengine_v1beta/representations.rb +++ b/generated/google/apis/appengine_v1beta/representations.rb @@ -471,6 +471,7 @@ module Google class Representation < Google::Apis::Core::JsonRepresentation property :auth_domain, as: 'authDomain' property :code_bucket, as: 'codeBucket' + property :database_type, as: 'databaseType' property :default_bucket, as: 'defaultBucket' property :default_cookie_expiration, as: 'defaultCookieExpiration' property :default_hostname, as: 'defaultHostname' diff --git a/generated/google/apis/bigqueryreservation_v1.rb b/generated/google/apis/bigqueryreservation_v1.rb index e3ed40843..48f89eafd 100644 --- a/generated/google/apis/bigqueryreservation_v1.rb +++ b/generated/google/apis/bigqueryreservation_v1.rb @@ -25,7 +25,7 @@ module Google # @see https://cloud.google.com/bigquery/ module BigqueryreservationV1 VERSION = 'V1' - REVISION = '20200410' + REVISION = '20200509' # View and manage your data in Google BigQuery AUTH_BIGQUERY = 'https://www.googleapis.com/auth/bigquery' diff --git a/generated/google/apis/bigqueryreservation_v1/classes.rb b/generated/google/apis/bigqueryreservation_v1/classes.rb index dede78493..c8f80c522 100644 --- a/generated/google/apis/bigqueryreservation_v1/classes.rb +++ b/generated/google/apis/bigqueryreservation_v1/classes.rb @@ -28,7 +28,7 @@ module Google include Google::Apis::Core::Hashable # The resource which will use the reservation. E.g. - # projects/myproject, folders/123, organizations/456. + # `projects/myproject`, `folders/123`, or `organizations/456`. # Corresponds to the JSON property `assignee` # @return [String] attr_accessor :assignee @@ -39,7 +39,7 @@ module Google attr_accessor :job_type # Output only. Name of the resource. E.g.: - # projects/myproject/locations/US/reservations/team1-prod/assignments/123. + # `projects/myproject/locations/US/reservations/team1-prod/assignments/123`. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name @@ -98,8 +98,9 @@ module Google # Capacity commitment is a way to purchase compute capacity for BigQuery jobs # (in the form of slots) with some committed period of usage. Annual # commitments renew by default. Commitments can be removed after their - # commitment end time passes. In order to remove annual commitment, its plan - # needs to be changed to monthly or flex first. + # commitment end time passes. + # In order to remove annual commitment, its plan needs to be changed + # to monthly or flex first. # A capacity commitment resource exists as a child resource of the admin # project. class CapacityCommitment @@ -123,7 +124,7 @@ module Google attr_accessor :failure_status # Output only. The resource name of the capacity commitment, e.g., - # projects/myproject/locations/US/capacityCommitments/123 + # `projects/myproject/locations/US/capacityCommitments/123` # Corresponds to the JSON property `name` # @return [String] attr_accessor :name @@ -135,7 +136,7 @@ module Google # The plan this capacity commitment is converted to after commitment_end_time # passes. Once the plan is changed, committed period is extended according to - # commitment plan. Only applicable for ANNUAL commitments. + # commitment plan. Only applicable for ANNUAL and TRIAL commitments. # Corresponds to the JSON property `renewalPlan` # @return [String] attr_accessor :renewal_plan @@ -332,15 +333,16 @@ module Google # The request for # ReservationService.MoveAssignment. - # Note: "bigquery.reservationAssignments.create" permission is required on the - # destination_id. Note: "bigquery.reservationAssignments.create" and - # "bigquery.reservationAssignments.delete" permission is required on the + # **Note**: "bigquery.reservationAssignments.create" permission is required on + # the destination_id. + # **Note**: "bigquery.reservationAssignments.create" and + # "bigquery.reservationAssignments.delete" permission are required on the # related assignee. class MoveAssignmentRequest include Google::Apis::Core::Hashable # The new reservation ID, e.g.: - # projects/myotherproject/locations/US/reservations/team2-prod + # `projects/myotherproject/locations/US/reservations/team2-prod` # Corresponds to the JSON property `destinationId` # @return [String] attr_accessor :destination_id @@ -432,7 +434,7 @@ module Google alias_method :ignore_idle_slots?, :ignore_idle_slots # The resource name of the reservation, e.g., - # "projects/*/locations/*/reservations/team1-prod". + # `projects/*/locations/*/reservations/team1-prod`. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name @@ -513,8 +515,9 @@ module Google # Capacity commitment is a way to purchase compute capacity for BigQuery jobs # (in the form of slots) with some committed period of usage. Annual # commitments renew by default. Commitments can be removed after their - # commitment end time passes. In order to remove annual commitment, its plan - # needs to be changed to monthly or flex first. + # commitment end time passes. + # In order to remove annual commitment, its plan needs to be changed + # to monthly or flex first. # A capacity commitment resource exists as a child resource of the admin # project. # Corresponds to the JSON property `first` @@ -524,8 +527,9 @@ module Google # Capacity commitment is a way to purchase compute capacity for BigQuery jobs # (in the form of slots) with some committed period of usage. Annual # commitments renew by default. Commitments can be removed after their - # commitment end time passes. In order to remove annual commitment, its plan - # needs to be changed to monthly or flex first. + # commitment end time passes. + # In order to remove annual commitment, its plan needs to be changed + # to monthly or flex first. # A capacity commitment resource exists as a child resource of the admin # project. # Corresponds to the JSON property `second` diff --git a/generated/google/apis/bigqueryreservation_v1/service.rb b/generated/google/apis/bigqueryreservation_v1/service.rb index d141cfcbd..39f18e5e5 100644 --- a/generated/google/apis/bigqueryreservation_v1/service.rb +++ b/generated/google/apis/bigqueryreservation_v1/service.rb @@ -160,19 +160,20 @@ module Google # Looks up assignments for a specified resource for a particular region. # If the request is about a project: - # 1) Assignments created on the project will be returned if they exist. - # 2) Otherwise assignments created on the closest ancestor will be - # returned. 3) Assignments for different JobTypes will all be returned. - # Same logic applies if the request is about a folder. + # 1. Assignments created on the project will be returned if they exist. + # 2. Otherwise assignments created on the closest ancestor will be + # returned. + # 3. Assignments for different JobTypes will all be returned. + # The same logic applies if the request is about a folder. # If the request is about an organization, then assignments created on the # organization will be returned (organization doesn't have ancestors). # Comparing to ListAssignments, there are some behavior # differences: - # 1) permission on the assignee will be verified in this API. - # 2) Hierarchy lookup (project->folder->organization) happens in this API. - # 3) Parent here is projects/*/locations/*, instead of - # projects/*/locations/*reservations/*. - # Note "-" cannot be used for projects + # 1. permission on the assignee will be verified in this API. + # 2. Hierarchy lookup (project->folder->organization) happens in this API. + # 3. Parent here is `projects/*/locations/*`, instead of + # `projects/*/locations/*reservations/*`. + # **Note** "-" cannot be used for projects # nor locations. # @param [String] parent # Required. The resource name of the admin project(containing project and @@ -180,14 +181,15 @@ module Google # e.g.: # "projects/myproject/locations/US". # @param [Fixnum] page_size - # The maximum number of items to return. + # The maximum number of items to return per page. # @param [String] page_token # The next_page_token value returned from a previous List request, if any. # @param [String] query # Please specify resource name as assignee in the query. - # e.g., "assignee=projects/myproject" - # "assignee=folders/123" - # "assignee=organizations/456" + # Examples: + # * `assignee=projects/myproject` + # * `assignee=folders/123` + # * `assignee=organizations/456` # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -219,8 +221,8 @@ module Google end # Updates a BI reservation. - # Only fields specified in the field_mask are updated. - # Singleton BI reservation always exists with default size 0. + # Only fields specified in the `field_mask` are updated. + # A singleton BI reservation always exists with default size 0. # In order to reserve BI capacity it needs to be updated to an amount # greater than 0. In order to release BI capacity reservation size # must be set to 0. @@ -400,10 +402,11 @@ module Google execute_or_queue_command(command, &block) end - # Merges capacity commitments of the same plan into one. Resulting capacity - # commitment has the longer commitment_end_time out of the two. Attempting to - # merge capacity commitments of different plan will fail with the error code - # `google.rpc.Code.FAILED_PRECONDITION`. + # Merges capacity commitments of the same plan into a single commitment. + # The resulting capacity commitment has the greater commitment_end_time + # out of the to-be-merged capacity commitments. + # Attempting to merge capacity commitments of different plan will fail + # with the error code `google.rpc.Code.FAILED_PRECONDITION`. # @param [String] parent # Parent resource that identifies admin project and location e.g., # projects/myproject/locations/us @@ -438,13 +441,13 @@ module Google end # Updates an existing capacity commitment. - # Only plan and renewal_plan fields can be updated. + # Only `plan` and `renewal_plan` fields can be updated. # Plan can only be changed to a plan of a longer commitment period. # Attempting to change to a plan with shorter commitment period will fail # with the error code `google.rpc.Code.FAILED_PRECONDITION`. # @param [String] name # Output only. The resource name of the capacity commitment, e.g., - # projects/myproject/locations/US/capacityCommitments/123 + # `projects/myproject/locations/US/capacityCommitments/123` # @param [Google::Apis::BigqueryreservationV1::CapacityCommitment] capacity_commitment_object # @param [String] update_mask # Standard field mask for the set of fields to be updated. @@ -479,10 +482,11 @@ module Google end # Splits capacity commitment to two commitments of the same plan and - # commitment_end_time. A common use case to do that is to perform a downgrade - # e.g., in order to downgrade from 10000 slots to 8000, one might split 10000 - # capacity commitment to 2000 and 8000, change the plan of the first one to - # flex and then delete it. + # `commitment_end_time`. + # A common use case is to enable downgrading commitments. + # For example, in order to downgrade from 10000 slots to 8000, you might + # split a 10000 capacity commitment into commitments of 2000 and 8000. Then, + # you would change the plan of the first one to `FLEX` and then delete it. # @param [String] name # Required. The resource name e.g.,: # projects/myproject/locations/US/capacityCommitments/123 @@ -519,7 +523,7 @@ module Google # Creates a new reservation resource. # @param [String] parent # Required. Project, location. E.g., - # projects/myproject/locations/US + # `projects/myproject/locations/US` # @param [Google::Apis::BigqueryreservationV1::Reservation] reservation_object # @param [String] reservation_id # The reservation ID. This field must only contain lower case alphanumeric @@ -559,7 +563,7 @@ module Google # assignments. # @param [String] name # Required. Resource name of the reservation to retrieve. E.g., - # projects/myproject/locations/US/reservations/team1-prod + # `projects/myproject/locations/US/reservations/team1-prod` # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -590,7 +594,7 @@ module Google # Returns information about the reservation. # @param [String] name # Required. Resource name of the reservation to retrieve. E.g., - # projects/myproject/locations/US/reservations/team1-prod + # `projects/myproject/locations/US/reservations/team1-prod` # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -623,7 +627,7 @@ module Google # Required. The parent resource name containing project and location, e.g.: # "projects/myproject/locations/US" # @param [Fixnum] page_size - # The maximum number of items to return. + # The maximum number of items to return per page. # @param [String] page_token # The next_page_token value returned from a previous List request, if any. # @param [String] fields @@ -658,7 +662,7 @@ module Google # Updates an existing reservation resource. # @param [String] name # The resource name of the reservation, e.g., - # "projects/*/locations/*/reservations/team1-prod". + # `projects/*/locations/*/reservations/team1-prod`. # @param [Google::Apis::BigqueryreservationV1::Reservation] reservation_object # @param [String] update_mask # Standard field mask for the set of fields to be updated. @@ -692,18 +696,24 @@ module Google execute_or_queue_command(command, &block) end - # Creates an object which allows the given project to submit jobs - # of a certain type using slots from the specified reservation. Currently a + # Creates an assignment object which allows the given project to submit jobs + # of a certain type using slots from the specified reservation. + # Currently a # resource (project, folder, organization) can only have one assignment per - # `job_type, location`, and that reservation will be used for all jobs of the - # matching type. Within the organization, different assignments can be - # created on projects, folders or organization level. During query execution, + # each (job_type, location) combination, and that reservation will be used + # for all jobs of the matching type. + # Different assignments can be created on different levels of the + # projects, folders or organization hierarchy. During query execution, # the assignment is looked up at the project, folder and organization levels - # in that order. The first assignment found is applied to the query. When - # creating assignments, it does not matter if other assignments exist at - # higher levels. E.g: organizationA contains project1, project2. Assignments - # for organizationA, project1 and project2 could all be created, mapping to - # the same or different reservations. + # in that order. The first assignment found is applied to the query. + # When creating assignments, it does not matter if other assignments exist at + # higher levels. + # Example: + # * The organization `organizationA` contains two projects, `project1` + # and `project2`. + # * Assignments for all three entities (`organizationA`, `project1`, and + # `project2`) could all be created and mapped to the same or different + # reservations. # Returns `google.rpc.Code.PERMISSION_DENIED` if user does not have # 'bigquery.admin' permissions on the project using the reservation # and the project that owns this reservation. @@ -711,7 +721,7 @@ module Google # does not match location of the reservation. # @param [String] parent # Required. The parent resource name of the assignment - # E.g.: projects/myproject/locations/US/reservations/team1-prod + # E.g. `projects/myproject/locations/US/reservations/team1-prod` # @param [Google::Apis::BigqueryreservationV1::Assignment] assignment_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -743,18 +753,20 @@ module Google end # Deletes a assignment. No expansion will happen. - # E.g: - # organizationA contains project1 and project2. Reservation res1 exists. - # CreateAssignment was invoked previously and following assignments were - # created explicitly: - # - # - # Then deletion of won't affect . After - # deletion of , queries from project1 will still use - # res1, while queries from project2 will use on-demand mode. + # Example: + # * Organization `organizationA` contains two projects, `project1` and + # `project2`. + # * Reservation `res1` exists and was created previously. + # * CreateAssignment was used previously to define the following + # associations between entities and reservations: `` + # and `` + # In this example, deletion of the `` assignment won't + # affect the other assignment ``. After said deletion, + # queries from `project1` will still use `res1` while queries from + # `project2` will switch to use on-demand mode. # @param [String] name - # Required. Name of the resource, e.g.: - # projects/myproject/locations/US/reservations/team1-prod/assignments/123 + # Required. Name of the resource, e.g. + # `projects/myproject/locations/US/reservations/team1-prod/assignments/123` # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -783,24 +795,27 @@ module Google end # Lists assignments. - # Only explicitly created assignments will be returned. E.g: - # organizationA contains project1 and project2. Reservation res1 exists. - # CreateAssignment was invoked previously and following assignments were - # created explicitly: - # - # - # Then this API will just return the above two assignments for reservation - # res1, and no expansion/merge will happen. Wildcard "-" can be used for + # Only explicitly created assignments will be returned. + # Example: + # * Organization `organizationA` contains two projects, `project1` and + # `project2`. + # * Reservation `res1` exists and was created previously. + # * CreateAssignment was used previously to define the following + # associations between entities and reservations: `` + # and `` + # In this example, ListAssignments will just return the above two assignments + # for reservation `res1`, and no expansion/merge will happen. + # The wildcard "-" can be used for # reservations in the request. In that case all assignments belongs to the - # specified project and location will be listed. Note - # "-" cannot be used for projects nor locations. + # specified project and location will be listed. + # **Note** "-" cannot be used for projects nor locations. # @param [String] parent # Required. The parent resource name e.g.: - # projects/myproject/locations/US/reservations/team1-prod + # `projects/myproject/locations/US/reservations/team1-prod` # Or: - # projects/myproject/locations/US/reservations/- + # `projects/myproject/locations/US/reservations/-` # @param [Fixnum] page_size - # The maximum number of items to return. + # The maximum number of items to return per page. # @param [String] page_token # The next_page_token value returned from a previous List request, if any. # @param [String] fields @@ -832,16 +847,14 @@ module Google execute_or_queue_command(command, &block) end - # Moves a assignment under a new reservation. Customers can do this by - # deleting the existing assignment followed by creating another assignment - # under the new reservation, but this method provides a transactional way to - # do so, to make sure the assignee always has an associated reservation. - # Without the method customers might see some queries run on-demand which - # might be unexpected. + # Moves an assignment under a new reservation. + # This differs from removing an existing assignment and recreating a new one + # by providing a transactional change that ensures an assignee always has an + # associated reservation. # @param [String] name # Required. The resource name of the assignment, - # e.g.: - # projects/myproject/locations/US/reservations/team1-prod/assignments/123 + # e.g. + # `projects/myproject/locations/US/reservations/team1-prod/assignments/123` # @param [Google::Apis::BigqueryreservationV1::MoveAssignmentRequest] move_assignment_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. diff --git a/generated/google/apis/bigqueryreservation_v1alpha2.rb b/generated/google/apis/bigqueryreservation_v1alpha2.rb index 1769869f7..b0d879a49 100644 --- a/generated/google/apis/bigqueryreservation_v1alpha2.rb +++ b/generated/google/apis/bigqueryreservation_v1alpha2.rb @@ -25,7 +25,7 @@ module Google # @see https://cloud.google.com/bigquery/ module BigqueryreservationV1alpha2 VERSION = 'V1alpha2' - REVISION = '20200220' + REVISION = '20200509' # View and manage your data in Google BigQuery AUTH_BIGQUERY = 'https://www.googleapis.com/auth/bigquery' diff --git a/generated/google/apis/bigqueryreservation_v1beta1.rb b/generated/google/apis/bigqueryreservation_v1beta1.rb index 29aa6e257..988cce6ad 100644 --- a/generated/google/apis/bigqueryreservation_v1beta1.rb +++ b/generated/google/apis/bigqueryreservation_v1beta1.rb @@ -25,7 +25,7 @@ module Google # @see https://cloud.google.com/bigquery/ module BigqueryreservationV1beta1 VERSION = 'V1beta1' - REVISION = '20200410' + REVISION = '20200509' # View and manage your data in Google BigQuery AUTH_BIGQUERY = 'https://www.googleapis.com/auth/bigquery' diff --git a/generated/google/apis/bigqueryreservation_v1beta1/classes.rb b/generated/google/apis/bigqueryreservation_v1beta1/classes.rb index aff64329c..fad2551f8 100644 --- a/generated/google/apis/bigqueryreservation_v1beta1/classes.rb +++ b/generated/google/apis/bigqueryreservation_v1beta1/classes.rb @@ -62,40 +62,6 @@ module Google end end - # Auto scaling settings and current situation. - # System will create a dedicated FLEX capacity commitment to hold the slots - # for auto-scale. Users won't be able to manage it,to avoid conflicts. - # Scale-up will happen, if there are always pending tasks for the past 10 - # minutes. - # Scale-down will happen, if the system knows that scale-up won't be - # triggered again. - # Note this is an alpha feature. - class Autoscale - include Google::Apis::Core::Hashable - - # Output only. The slot capacity added to this reservation when autoscale - # happens. Will - # be between [0, max_slots]. - # Corresponds to the JSON property `currentSlots` - # @return [Fixnum] - attr_accessor :current_slots - - # Number of slots to be scaled when needed. - # Corresponds to the JSON property `maxSlots` - # @return [Fixnum] - attr_accessor :max_slots - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @current_slots = args[:current_slots] if args.key?(:current_slots) - @max_slots = args[:max_slots] if args.key?(:max_slots) - end - end - # Represents a BI Reservation. class BiReservation include Google::Apis::Core::Hashable @@ -368,18 +334,6 @@ module Google class Reservation include Google::Apis::Core::Hashable - # Auto scaling settings and current situation. - # System will create a dedicated FLEX capacity commitment to hold the slots - # for auto-scale. Users won't be able to manage it,to avoid conflicts. - # Scale-up will happen, if there are always pending tasks for the past 10 - # minutes. - # Scale-down will happen, if the system knows that scale-up won't be - # triggered again. - # Note this is an alpha feature. - # Corresponds to the JSON property `autoscale` - # @return [Google::Apis::BigqueryreservationV1beta1::Autoscale] - attr_accessor :autoscale - # If false, any query using this reservation will use idle slots from other # reservations within the same admin project. If true, a query using this # reservation will execute with the slot capacity specified above at most. @@ -412,7 +366,6 @@ module Google # Update properties of this object def update!(**args) - @autoscale = args[:autoscale] if args.key?(:autoscale) @ignore_idle_slots = args[:ignore_idle_slots] if args.key?(:ignore_idle_slots) @name = args[:name] if args.key?(:name) @slot_capacity = args[:slot_capacity] if args.key?(:slot_capacity) diff --git a/generated/google/apis/bigqueryreservation_v1beta1/representations.rb b/generated/google/apis/bigqueryreservation_v1beta1/representations.rb index 052d14045..6cb92b796 100644 --- a/generated/google/apis/bigqueryreservation_v1beta1/representations.rb +++ b/generated/google/apis/bigqueryreservation_v1beta1/representations.rb @@ -28,12 +28,6 @@ module Google include Google::Apis::Core::JsonObjectSupport end - class Autoscale - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - class BiReservation class Representation < Google::Apis::Core::JsonRepresentation; end @@ -128,14 +122,6 @@ module Google end end - class Autoscale - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :current_slots, :numeric_string => true, as: 'currentSlots' - property :max_slots, :numeric_string => true, as: 'maxSlots' - end - end - class BiReservation # @private class Representation < Google::Apis::Core::JsonRepresentation @@ -216,8 +202,6 @@ module Google class Reservation # @private class Representation < Google::Apis::Core::JsonRepresentation - property :autoscale, as: 'autoscale', class: Google::Apis::BigqueryreservationV1beta1::Autoscale, decorator: Google::Apis::BigqueryreservationV1beta1::Autoscale::Representation - property :ignore_idle_slots, as: 'ignoreIdleSlots' property :name, as: 'name' property :slot_capacity, :numeric_string => true, as: 'slotCapacity' diff --git a/generated/google/apis/container_v1.rb b/generated/google/apis/container_v1.rb index 5600f9c73..8489d9c57 100644 --- a/generated/google/apis/container_v1.rb +++ b/generated/google/apis/container_v1.rb @@ -26,7 +26,7 @@ module Google # @see https://cloud.google.com/container-engine/ module ContainerV1 VERSION = 'V1' - REVISION = '20200425' + REVISION = '20200501' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' diff --git a/generated/google/apis/container_v1/classes.rb b/generated/google/apis/container_v1/classes.rb index 4b0b9c94d..2ce2ba954 100644 --- a/generated/google/apis/container_v1/classes.rb +++ b/generated/google/apis/container_v1/classes.rb @@ -2492,8 +2492,9 @@ module Google # Kubernetes taint is comprised of three fields: key, value, and effect. Effect # can only be one of three types: NoSchedule, PreferNoSchedule or NoExecute. - # For more information, including usage and the valid values, see: - # https://kubernetes.io/docs/concepts/configuration/taint-and-toleration/ + # See + # [here](https://kubernetes.io/docs/concepts/configuration/taint-and-toleration) + # for more information, including usage and the valid values. class NodeTaint include Google::Apis::Core::Hashable diff --git a/generated/google/apis/firebasehosting_v1beta1.rb b/generated/google/apis/firebasehosting_v1beta1.rb index ed2a8c174..1b47d0768 100644 --- a/generated/google/apis/firebasehosting_v1beta1.rb +++ b/generated/google/apis/firebasehosting_v1beta1.rb @@ -27,7 +27,7 @@ module Google # @see https://firebase.google.com/docs/hosting/ module FirebasehostingV1beta1 VERSION = 'V1beta1' - REVISION = '20200430' + REVISION = '20200512' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' diff --git a/generated/google/apis/firebasehosting_v1beta1/classes.rb b/generated/google/apis/firebasehosting_v1beta1/classes.rb index d95a6dfe1..09359284a 100644 --- a/generated/google/apis/firebasehosting_v1beta1/classes.rb +++ b/generated/google/apis/firebasehosting_v1beta1/classes.rb @@ -352,7 +352,7 @@ module Google end end - # The response when listing Releases. + # class ListReleasesResponse include Google::Apis::Core::Hashable @@ -380,7 +380,7 @@ module Google end end - # The response when listing a Version's Files.. + # class ListVersionFilesResponse include Google::Apis::Core::Hashable @@ -405,7 +405,7 @@ module Google end end - # The response when listing Versions. + # class ListVersionsResponse include Google::Apis::Core::Hashable @@ -516,7 +516,7 @@ module Google end end - # The response to a PopulateVersionFilesRequest. + # class PopulateVersionFilesResponse include Google::Apis::Core::Hashable diff --git a/generated/google/apis/games_management_v1management.rb b/generated/google/apis/games_management_v1management.rb index 6ca6840e5..b8b847648 100644 --- a/generated/google/apis/games_management_v1management.rb +++ b/generated/google/apis/games_management_v1management.rb @@ -18,14 +18,16 @@ require 'google/apis/games_management_v1management/representations.rb' module Google module Apis - # Google Play Game Services Management API + # Google Play Game Management # - # The Management API for Google Play Game Services. + # The Google Play Game Management API allows developers to manage resources from + # the Google + # Play Game service. # - # @see https://developers.google.com/games/services + # @see https://developers.google.com/games/ module GamesManagementV1management VERSION = 'V1management' - REVISION = '20200416' + REVISION = '20200504' # Create, edit, and delete your Google Play Games activity AUTH_GAMES = 'https://www.googleapis.com/auth/games' diff --git a/generated/google/apis/games_management_v1management/classes.rb b/generated/google/apis/games_management_v1management/classes.rb index 5d8a9ccdb..a1a458aa7 100644 --- a/generated/google/apis/games_management_v1management/classes.rb +++ b/generated/google/apis/games_management_v1management/classes.rb @@ -22,12 +22,12 @@ module Google module Apis module GamesManagementV1management - # This is a JSON template for achievement reset all response. + # Achievement reset all response. class AchievementResetAllResponse include Google::Apis::Core::Hashable # Uniquely identifies the type of this resource. Value is always the fixed - # string gamesManagement#achievementResetAllResponse. + # string `gamesManagement#achievementResetAllResponse`. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind @@ -48,7 +48,7 @@ module Google end end - # This is a JSON template for multiple achievements reset all request. + # class AchievementResetMultipleForAllRequest include Google::Apis::Core::Hashable @@ -58,7 +58,7 @@ module Google attr_accessor :achievement_ids # Uniquely identifies the type of this resource. Value is always the fixed - # string gamesManagement#achievementResetMultipleForAllRequest. + # string `gamesManagement#achievementResetMultipleForAllRequest`. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind @@ -74,16 +74,15 @@ module Google end end - # This is a JSON template for an achievement reset response. + # An achievement reset response. class AchievementResetResponse include Google::Apis::Core::Hashable - # The current state of the achievement. This is the same as the initial state of - # the achievement. - # Possible values are: - # - "HIDDEN"- Achievement is hidden. - # - "REVEALED" - Achievement is revealed. - # - "UNLOCKED" - Achievement is unlocked. + # The current state of the achievement. This is the same as the initial + # state of the achievement.
Possible values are:
    + #
  • "`HIDDEN`"- Achievement is hidden.
    • + #
  • "`REVEALED`" - Achievement is revealed.
    • + #
  • "`UNLOCKED`" - Achievement is unlocked.
# Corresponds to the JSON property `currentState` # @return [String] attr_accessor :current_state @@ -94,7 +93,7 @@ module Google attr_accessor :definition_id # Uniquely identifies the type of this resource. Value is always the fixed - # string gamesManagement#achievementResetResponse. + # string `gamesManagement#achievementResetResponse`. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind @@ -118,7 +117,7 @@ module Google end end - # This is a JSON template for multiple events reset all request. + # Multiple events reset all request. class EventsResetMultipleForAllRequest include Google::Apis::Core::Hashable @@ -128,7 +127,7 @@ module Google attr_accessor :event_ids # Uniquely identifies the type of this resource. Value is always the fixed - # string gamesManagement#eventsResetMultipleForAllRequest. + # string `gamesManagement#eventsResetMultipleForAllRequest`. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind @@ -144,35 +143,7 @@ module Google end end - # This is a JSON template for metadata about a player playing a game with the - # currently authenticated user. - class GamesPlayedResource - include Google::Apis::Core::Hashable - - # True if the player was auto-matched with the currently authenticated user. - # Corresponds to the JSON property `autoMatched` - # @return [Boolean] - attr_accessor :auto_matched - alias_method :auto_matched?, :auto_matched - - # The last time the player played the game in milliseconds since the epoch in - # UTC. - # Corresponds to the JSON property `timeMillis` - # @return [Fixnum] - attr_accessor :time_millis - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @auto_matched = args[:auto_matched] if args.key?(:auto_matched) - @time_millis = args[:time_millis] if args.key?(:time_millis) - end - end - - # This is a JSON template for 1P/3P metadata about the player's experience. + # 1P/3P metadata about the player's experience. class GamesPlayerExperienceInfoResource include Google::Apis::Core::Hashable @@ -181,17 +152,18 @@ module Google # @return [Fixnum] attr_accessor :current_experience_points - # This is a JSON template for 1P/3P metadata about a user's level. + # 1P/3P metadata about a user's level. # Corresponds to the JSON property `currentLevel` # @return [Google::Apis::GamesManagementV1management::GamesPlayerLevelResource] attr_accessor :current_level - # The timestamp when the player was leveled up, in millis since Unix epoch UTC. + # The timestamp when the player was leveled up, in millis since Unix epoch + # UTC. # Corresponds to the JSON property `lastLevelUpTimestampMillis` # @return [Fixnum] attr_accessor :last_level_up_timestamp_millis - # This is a JSON template for 1P/3P metadata about a user's level. + # 1P/3P metadata about a user's level. # Corresponds to the JSON property `nextLevel` # @return [Google::Apis::GamesManagementV1management::GamesPlayerLevelResource] attr_accessor :next_level @@ -209,7 +181,7 @@ module Google end end - # This is a JSON template for 1P/3P metadata about a user's level. + # 1P/3P metadata about a user's level. class GamesPlayerLevelResource include Google::Apis::Core::Hashable @@ -240,22 +212,23 @@ module Google end end - # This is a JSON template for the HiddenPlayer resource. + # The HiddenPlayer resource. class HiddenPlayer include Google::Apis::Core::Hashable - # The time this player was hidden. + # Output only. The time this player was hidden. # Corresponds to the JSON property `hiddenTimeMillis` # @return [Fixnum] attr_accessor :hidden_time_millis - # Uniquely identifies the type of this resource. Value is always the fixed - # string gamesManagement#hiddenPlayer. + # Output only. Uniquely identifies the type of this resource. Value is always + # the fixed + # string `gamesManagement#hiddenPlayer`. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind - # This is a JSON template for a Player resource. + # A Player resource. # Corresponds to the JSON property `player` # @return [Google::Apis::GamesManagementV1management::Player] attr_accessor :player @@ -272,7 +245,7 @@ module Google end end - # This is a JSON template for a list of hidden players. + # A list of hidden players. class HiddenPlayerList include Google::Apis::Core::Hashable @@ -282,7 +255,7 @@ module Google attr_accessor :items # Uniquely identifies the type of this resource. Value is always the fixed - # string gamesManagement#hiddenPlayerList. + # string `gamesManagement#hiddenPlayerList`. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind @@ -304,7 +277,7 @@ module Google end end - # This is a JSON template for a Player resource. + # A Player resource. class Player include Google::Apis::Core::Hashable @@ -328,29 +301,17 @@ module Google # @return [String] attr_accessor :display_name - # This is a JSON template for 1P/3P metadata about the player's experience. + # 1P/3P metadata about the player's experience. # Corresponds to the JSON property `experienceInfo` # @return [Google::Apis::GamesManagementV1management::GamesPlayerExperienceInfoResource] attr_accessor :experience_info - # The friend status of the given player, relative to the requester. This is - # unset if the player is not sharing their friends list with the game. - # Corresponds to the JSON property `friendStatus` - # @return [String] - attr_accessor :friend_status - # Uniquely identifies the type of this resource. Value is always the fixed - # string gamesManagement#player. + # string `gamesManagement#player`. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind - # This is a JSON template for metadata about a player playing a game with the - # currently authenticated user. - # Corresponds to the JSON property `lastPlayedWith` - # @return [Google::Apis::GamesManagementV1management::GamesPlayedResource] - attr_accessor :last_played_with - # An object representation of the individual components of the player's name. # For some players, these fields may not be present. # Corresponds to the JSON property `name` @@ -358,9 +319,9 @@ module Google attr_accessor :name # The player ID that was used for this player the first time they signed into - # the game in question. This is only populated for calls to player.get for the - # requesting player, only if the player ID has subsequently changed, and only to - # clients that support remapping player IDs. + # the game in question. This is only populated for calls to player.get for + # the requesting player, only if the player ID has subsequently changed, and + # only to clients that support remapping player IDs. # Corresponds to the JSON property `originalPlayerId` # @return [String] attr_accessor :original_player_id @@ -370,7 +331,7 @@ module Google # @return [String] attr_accessor :player_id - # This is a JSON template for profile settings + # Profile settings # Corresponds to the JSON property `profileSettings` # @return [Google::Apis::GamesManagementV1management::ProfileSettings] attr_accessor :profile_settings @@ -391,9 +352,7 @@ module Google @banner_url_portrait = args[:banner_url_portrait] if args.key?(:banner_url_portrait) @display_name = args[:display_name] if args.key?(:display_name) @experience_info = args[:experience_info] if args.key?(:experience_info) - @friend_status = args[:friend_status] if args.key?(:friend_status) @kind = args[:kind] if args.key?(:kind) - @last_played_with = args[:last_played_with] if args.key?(:last_played_with) @name = args[:name] if args.key?(:name) @original_player_id = args[:original_player_id] if args.key?(:original_player_id) @player_id = args[:player_id] if args.key?(:player_id) @@ -406,12 +365,14 @@ module Google class Name include Google::Apis::Core::Hashable - # The family name of this player. In some places, this is known as the last name. + # The family name of this player. In some places, this is known as the last + # name. # Corresponds to the JSON property `familyName` # @return [String] attr_accessor :family_name - # The given name of this player. In some places, this is known as the first name. + # The given name of this player. In some places, this is known as the first + # name. # Corresponds to the JSON property `givenName` # @return [String] attr_accessor :given_name @@ -428,12 +389,12 @@ module Google end end - # This is a JSON template for a list of leaderboard reset resources. + # A list of leaderboard reset resources. class PlayerScoreResetAllResponse include Google::Apis::Core::Hashable # Uniquely identifies the type of this resource. Value is always the fixed - # string gamesManagement#playerScoreResetResponse. + # string `gamesManagement#playerScoreResetAllResponse`. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind @@ -454,7 +415,7 @@ module Google end end - # This is a JSON template for a list of reset leaderboard entry resources. + # A list of reset leaderboard entry resources. class PlayerScoreResetResponse include Google::Apis::Core::Hashable @@ -464,16 +425,15 @@ module Google attr_accessor :definition_id # Uniquely identifies the type of this resource. Value is always the fixed - # string gamesManagement#playerScoreResetResponse. + # string `gamesManagement#playerScoreResetResponse`. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind - # The time spans of the updated score. - # Possible values are: - # - "ALL_TIME" - The score is an all-time score. - # - "WEEKLY" - The score is a weekly score. - # - "DAILY" - The score is a daily score. + # The time spans of the updated score.
Possible values are:
    + #
  • "`ALL_TIME`" - The score is an all-time score.
    • + #
  • "`WEEKLY`" - The score is a weekly score.
    • + #
  • "`DAILY`" - The score is a daily score.
# Corresponds to the JSON property `resetScoreTimeSpans` # @return [Array] attr_accessor :reset_score_time_spans @@ -490,12 +450,12 @@ module Google end end - # This is a JSON template for profile settings + # Profile settings class ProfileSettings include Google::Apis::Core::Hashable # Uniquely identifies the type of this resource. Value is always the fixed - # string gamesManagement#profileSettings. + # string `gamesManagement#profileSettings`. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind @@ -517,12 +477,12 @@ module Google end end - # This is a JSON template for multiple scores reset all request. + # class ScoresResetMultipleForAllRequest include Google::Apis::Core::Hashable # Uniquely identifies the type of this resource. Value is always the fixed - # string gamesManagement#scoresResetMultipleForAllRequest. + # string `gamesManagement#scoresResetMultipleForAllRequest`. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind diff --git a/generated/google/apis/games_management_v1management/representations.rb b/generated/google/apis/games_management_v1management/representations.rb index 14a373821..dcc5d9fca 100644 --- a/generated/google/apis/games_management_v1management/representations.rb +++ b/generated/google/apis/games_management_v1management/representations.rb @@ -46,12 +46,6 @@ module Google include Google::Apis::Core::JsonObjectSupport end - class GamesPlayedResource - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - class GamesPlayerExperienceInfoResource class Representation < Google::Apis::Core::JsonRepresentation; end @@ -147,14 +141,6 @@ module Google end end - class GamesPlayedResource - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :auto_matched, as: 'autoMatched' - property :time_millis, :numeric_string => true, as: 'timeMillis' - end - end - class GamesPlayerExperienceInfoResource # @private class Representation < Google::Apis::Core::JsonRepresentation @@ -205,10 +191,7 @@ module Google property :display_name, as: 'displayName' property :experience_info, as: 'experienceInfo', class: Google::Apis::GamesManagementV1management::GamesPlayerExperienceInfoResource, decorator: Google::Apis::GamesManagementV1management::GamesPlayerExperienceInfoResource::Representation - property :friend_status, as: 'friendStatus' property :kind, as: 'kind' - property :last_played_with, as: 'lastPlayedWith', class: Google::Apis::GamesManagementV1management::GamesPlayedResource, decorator: Google::Apis::GamesManagementV1management::GamesPlayedResource::Representation - property :name, as: 'name', class: Google::Apis::GamesManagementV1management::Player::Name, decorator: Google::Apis::GamesManagementV1management::Player::Name::Representation property :original_player_id, as: 'originalPlayerId' diff --git a/generated/google/apis/games_management_v1management/service.rb b/generated/google/apis/games_management_v1management/service.rb index 1f46fa172..884102e9c 100644 --- a/generated/google/apis/games_management_v1management/service.rb +++ b/generated/google/apis/games_management_v1management/service.rb @@ -20,9 +20,11 @@ require 'google/apis/errors' module Google module Apis module GamesManagementV1management - # Google Play Game Services Management API + # Google Play Game Management # - # The Management API for Google Play Game Services. + # The Google Play Game Management API allows developers to manage resources from + # the Google + # Play Game service. # # @example # require 'google/apis/games_management_v1management' @@ -30,7 +32,7 @@ module Google # GamesManagement = Google::Apis::GamesManagementV1management # Alias the module # service = GamesManagement::GamesManagementService.new # - # @see https://developers.google.com/games/services + # @see https://developers.google.com/games/ class GamesManagementService < Google::Apis::Core::BaseService # @return [String] # API key. Your API key identifies your project and provides you with API access, @@ -38,31 +40,25 @@ module Google attr_accessor :key # @return [String] - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. + # 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 - # @return [String] - # Deprecated. Please use quotaUser instead. - attr_accessor :user_ip - def initialize - super('https://www.googleapis.com/', 'games/v1management/') - @batch_path = 'batch/gamesManagement/v1management' + super('https://www.googleapis.com/', '') + @batch_path = 'batch' end # Resets the achievement with the given ID for the currently authenticated - # player. This method is only accessible to whitelisted tester accounts for your - # application. + # player. This method is only accessible to whitelisted tester accounts for + # your application. # @param [String] achievement_id # The ID of the achievement used by this method. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # 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 # @@ -75,27 +71,24 @@ module Google # @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 reset_achievement(achievement_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:post, 'achievements/{achievementId}/reset', options) + def reset_achievement(achievement_id, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'games/v1management/achievements/{achievementId}/reset', options) command.response_representation = Google::Apis::GamesManagementV1management::AchievementResetResponse::Representation command.response_class = Google::Apis::GamesManagementV1management::AchievementResetResponse command.params['achievementId'] = achievement_id unless achievement_id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end # Resets all achievements for the currently authenticated player for your - # application. This method is only accessible to whitelisted tester accounts for - # your application. + # application. This method is only accessible to whitelisted tester accounts + # for your application. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # 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 # @@ -108,25 +101,22 @@ module Google # @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 reset_achievement_all(fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:post, 'achievements/reset', options) + def reset_achievement_all(fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'games/v1management/achievements/reset', options) command.response_representation = Google::Apis::GamesManagementV1management::AchievementResetAllResponse::Representation command.response_class = Google::Apis::GamesManagementV1management::AchievementResetAllResponse command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end - # Resets all draft achievements for all players. This method is only available - # to user accounts for your developer console. + # Resets all draft achievements for all players. This method is only + # available to user accounts for your developer console. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # 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 # @@ -139,26 +129,23 @@ module Google # @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 reset_achievement_all_for_all_players(fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:post, 'achievements/resetAllForAllPlayers', options) + def reset_achievement_all_for_all_players(fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'games/v1management/achievements/resetAllForAllPlayers', options) command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end - # Resets the achievement with the given ID for all players. This method is only - # available to user accounts for your developer console. Only draft achievements - # can be reset. + # Resets the achievement with the given ID for all players. This method is + # only available to user accounts for your developer console. Only draft + # achievements can be reset. # @param [String] achievement_id # The ID of the achievement used by this method. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # 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 # @@ -171,26 +158,23 @@ module Google # @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 reset_achievement_for_all_players(achievement_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:post, 'achievements/{achievementId}/resetForAllPlayers', options) + def reset_achievement_for_all_players(achievement_id, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'games/v1management/achievements/{achievementId}/resetForAllPlayers', options) command.params['achievementId'] = achievement_id unless achievement_id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end # Resets achievements with the given IDs for all players. This method is only - # available to user accounts for your developer console. Only draft achievements - # may be reset. + # available to user accounts for your developer console. Only draft + # achievements may be reset. # @param [Google::Apis::GamesManagementV1management::AchievementResetMultipleForAllRequest] achievement_reset_multiple_for_all_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # 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 # @@ -203,33 +187,30 @@ module Google # @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 reset_achievement_multiple_for_all_players(achievement_reset_multiple_for_all_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:post, 'achievements/resetMultipleForAllPlayers', options) + def reset_achievement_multiple_for_all_players(achievement_reset_multiple_for_all_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'games/v1management/achievements/resetMultipleForAllPlayers', options) command.request_representation = Google::Apis::GamesManagementV1management::AchievementResetMultipleForAllRequest::Representation command.request_object = achievement_reset_multiple_for_all_request_object command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end - # Get the list of players hidden from the given application. This method is only - # available to user accounts for your developer console. + # Get the list of players hidden from the given application. This method is + # only available to user accounts for your developer console. # @param [String] application_id # The application ID from the Google Play developer console. # @param [Fixnum] max_results # The maximum number of player resources to return in the response, used for - # paging. For any response, the actual number of player resources returned may - # be less than the specified maxResults. + # paging. For any response, the actual number of player resources returned + # may be less than the specified `maxResults`. # @param [String] page_token # The token returned by the previous request. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # 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 # @@ -242,8 +223,8 @@ module Google # @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_application_hidden(application_id, max_results: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:get, 'applications/{applicationId}/players/hidden', options) + def list_application_hidden(application_id, max_results: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'games/v1management/applications/{applicationId}/players/hidden', options) command.response_representation = Google::Apis::GamesManagementV1management::HiddenPlayerList::Representation command.response_class = Google::Apis::GamesManagementV1management::HiddenPlayerList command.params['applicationId'] = application_id unless application_id.nil? @@ -251,7 +232,6 @@ module Google 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? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end @@ -263,10 +243,8 @@ module Google # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # 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 # @@ -279,25 +257,22 @@ module Google # @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 reset_event(event_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:post, 'events/{eventId}/reset', options) + def reset_event(event_id, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'games/v1management/events/{eventId}/reset', options) command.params['eventId'] = event_id unless event_id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end # Resets all player progress on all events for the currently authenticated - # player. This method is only accessible to whitelisted tester accounts for your - # application. + # player. This method is only accessible to whitelisted tester accounts for + # your application. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # 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 # @@ -310,23 +285,20 @@ module Google # @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 reset_event_all(fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:post, 'events/reset', options) + def reset_event_all(fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'games/v1management/events/reset', options) command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end - # Resets all draft events for all players. This method is only available to user - # accounts for your developer console. + # Resets all draft events for all players. This method is only available to + # user accounts for your developer console. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # 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 # @@ -339,26 +311,23 @@ module Google # @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 reset_event_all_for_all_players(fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:post, 'events/resetAllForAllPlayers', options) + def reset_event_all_for_all_players(fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'games/v1management/events/resetAllForAllPlayers', options) command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end # Resets the event with the given ID for all players. This method is only - # available to user accounts for your developer console. Only draft events can - # be reset. + # available to user accounts for your developer console. Only draft events + # can be reset. # @param [String] event_id # The ID of the event. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # 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 # @@ -371,26 +340,23 @@ module Google # @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 reset_event_for_all_players(event_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:post, 'events/{eventId}/resetForAllPlayers', options) + def reset_event_for_all_players(event_id, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'games/v1management/events/{eventId}/resetForAllPlayers', options) command.params['eventId'] = event_id unless event_id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end # Resets events with the given IDs for all players. This method is only - # available to user accounts for your developer console. Only draft events may - # be reset. + # available to user accounts for your developer console. Only draft events + # may be reset. # @param [Google::Apis::GamesManagementV1management::EventsResetMultipleForAllRequest] events_reset_multiple_for_all_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # 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 # @@ -403,13 +369,12 @@ module Google # @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 reset_event_multiple_for_all_players(events_reset_multiple_for_all_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:post, 'events/resetMultipleForAllPlayers', options) + def reset_event_multiple_for_all_players(events_reset_multiple_for_all_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'games/v1management/events/resetMultipleForAllPlayers', options) command.request_representation = Google::Apis::GamesManagementV1management::EventsResetMultipleForAllRequest::Representation command.request_object = events_reset_multiple_for_all_request_object command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end @@ -418,15 +383,13 @@ module Google # @param [String] application_id # The application ID from the Google Play developer console. # @param [String] player_id - # A player ID. A value of me may be used in place of the authenticated player's - # ID. + # A player ID. A value of `me` may be used in place of the + # authenticated player's ID. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # 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 # @@ -439,30 +402,27 @@ module Google # @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 hide_player(application_id, player_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:post, 'applications/{applicationId}/players/hidden/{playerId}', options) + def hide_player(application_id, player_id, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'games/v1management/applications/{applicationId}/players/hidden/{playerId}', options) command.params['applicationId'] = application_id unless application_id.nil? command.params['playerId'] = player_id unless player_id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end - # Unhide the given player's leaderboard scores from the given application. This - # method is only available to user accounts for your developer console. + # Unhide the given player's leaderboard scores from the given application. + # This method is only available to user accounts for your developer console. # @param [String] application_id # The application ID from the Google Play developer console. # @param [String] player_id - # A player ID. A value of me may be used in place of the authenticated player's - # ID. + # A player ID. A value of `me` may be used in place of the + # authenticated player's ID. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # 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 # @@ -475,73 +435,12 @@ module Google # @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 unhide_player(application_id, player_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:delete, 'applications/{applicationId}/players/hidden/{playerId}', options) + def unhide_player(application_id, player_id, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:delete, 'games/v1management/applications/{applicationId}/players/hidden/{playerId}', options) command.params['applicationId'] = application_id unless application_id.nil? command.params['playerId'] = player_id unless player_id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? - execute_or_queue_command(command, &block) - end - - # Reset all rooms for the currently authenticated player for your application. - # This method is only accessible to whitelisted tester accounts for your - # application. - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [NilClass] No result returned for this method - # @yieldparam err [StandardError] error object if request failed - # - # @return [void] - # - # @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 reset_room(fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:post, 'rooms/reset', options) - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? - execute_or_queue_command(command, &block) - end - - # Deletes rooms where the only room participants are from whitelisted tester - # accounts for your application. This method is only available to user accounts - # for your developer console. - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [NilClass] No result returned for this method - # @yieldparam err [StandardError] error object if request failed - # - # @return [void] - # - # @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 reset_room_for_all_players(fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:post, 'rooms/resetForAllPlayers', options) - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end @@ -553,10 +452,8 @@ module Google # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # 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 # @@ -569,27 +466,24 @@ module Google # @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 reset_score(leaderboard_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:post, 'leaderboards/{leaderboardId}/scores/reset', options) + def reset_score(leaderboard_id, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'games/v1management/leaderboards/{leaderboardId}/scores/reset', options) command.response_representation = Google::Apis::GamesManagementV1management::PlayerScoreResetResponse::Representation command.response_class = Google::Apis::GamesManagementV1management::PlayerScoreResetResponse command.params['leaderboardId'] = leaderboard_id unless leaderboard_id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end - # Resets all scores for all leaderboards for the currently authenticated players. - # This method is only accessible to whitelisted tester accounts for your - # application. + # Resets all scores for all leaderboards for the currently authenticated + # players. This method is only accessible to whitelisted tester accounts for + # your application. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # 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 # @@ -602,25 +496,22 @@ module Google # @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 reset_score_all(fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:post, 'scores/reset', options) + def reset_score_all(fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'games/v1management/scores/reset', options) command.response_representation = Google::Apis::GamesManagementV1management::PlayerScoreResetAllResponse::Representation command.response_class = Google::Apis::GamesManagementV1management::PlayerScoreResetAllResponse command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end - # Resets scores for all draft leaderboards for all players. This method is only - # available to user accounts for your developer console. + # Resets scores for all draft leaderboards for all players. This method is + # only available to user accounts for your developer console. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # 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 # @@ -633,11 +524,10 @@ module Google # @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 reset_score_all_for_all_players(fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:post, 'scores/resetAllForAllPlayers', options) + def reset_score_all_for_all_players(fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'games/v1management/scores/resetAllForAllPlayers', options) command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end @@ -649,10 +539,8 @@ module Google # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # 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 # @@ -665,12 +553,11 @@ module Google # @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 reset_score_for_all_players(leaderboard_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:post, 'leaderboards/{leaderboardId}/scores/resetForAllPlayers', options) + def reset_score_for_all_players(leaderboard_id, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'games/v1management/leaderboards/{leaderboardId}/scores/resetForAllPlayers', options) command.params['leaderboardId'] = leaderboard_id unless leaderboard_id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end @@ -681,10 +568,8 @@ module Google # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # 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 # @@ -697,72 +582,12 @@ module Google # @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 reset_score_multiple_for_all_players(scores_reset_multiple_for_all_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:post, 'scores/resetMultipleForAllPlayers', options) + def reset_score_multiple_for_all_players(scores_reset_multiple_for_all_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'games/v1management/scores/resetMultipleForAllPlayers', options) command.request_representation = Google::Apis::GamesManagementV1management::ScoresResetMultipleForAllRequest::Representation command.request_object = scores_reset_multiple_for_all_request_object command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? - execute_or_queue_command(command, &block) - end - - # Reset all turn-based match data for a user. This method is only accessible to - # whitelisted tester accounts for your application. - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [NilClass] No result returned for this method - # @yieldparam err [StandardError] error object if request failed - # - # @return [void] - # - # @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 reset_turn_based_match(fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:post, 'turnbasedmatches/reset', options) - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? - execute_or_queue_command(command, &block) - end - - # Deletes turn-based matches where the only match participants are from - # whitelisted tester accounts for your application. This method is only - # available to user accounts for your developer console. - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [NilClass] No result returned for this method - # @yieldparam err [StandardError] error object if request failed - # - # @return [void] - # - # @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 reset_turn_based_match_for_all_players(fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:post, 'turnbasedmatches/resetForAllPlayers', options) - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end @@ -771,7 +596,6 @@ module Google def apply_command_defaults(command) command.query['key'] = key unless key.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? end end end diff --git a/generated/google/apis/gameservices_v1beta.rb b/generated/google/apis/gameservices_v1beta.rb index b495e6fb0..07b108e91 100644 --- a/generated/google/apis/gameservices_v1beta.rb +++ b/generated/google/apis/gameservices_v1beta.rb @@ -25,7 +25,7 @@ module Google # @see https://cloud.google.com/solutions/gaming/ module GameservicesV1beta VERSION = 'V1beta' - REVISION = '20200423' + REVISION = '20200507' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' diff --git a/generated/google/apis/gameservices_v1beta/classes.rb b/generated/google/apis/gameservices_v1beta/classes.rb index 1f8d4d274..efbfe5f71 100644 --- a/generated/google/apis/gameservices_v1beta/classes.rb +++ b/generated/google/apis/gameservices_v1beta/classes.rb @@ -431,7 +431,7 @@ module Google end end - # The Game Server Cluster changes made by the Game Server Deployment. + # The game server cluster changes made by the game server deployment. class DeployedClusterState include Google::Apis::Core::Hashable @@ -441,7 +441,7 @@ module Google attr_accessor :cluster # The details about the Agones fleets and autoscalers created in the - # Game Server Cluster. + # game server cluster. # Corresponds to the JSON property `fleetDetails` # @return [Array] attr_accessor :fleet_details @@ -690,12 +690,12 @@ module Google class FetchDeploymentStateResponse include Google::Apis::Core::Hashable - # The state of the Game Server Deployment in each Game Server Cluster. + # The state of the game server deployment in each game server cluster. # Corresponds to the JSON property `clusterState` # @return [Array] attr_accessor :cluster_state - # List of Locations that could not be reached. + # List of locations that could not be reached. # Corresponds to the JSON property `unavailable` # @return [Array] attr_accessor :unavailable @@ -737,11 +737,11 @@ module Google end end - # A Game Server Cluster resource. + # A game server cluster resource. class GameServerCluster include Google::Apis::Core::Hashable - # The Game Server Cluster connection information. + # The game server cluster connection information. # Corresponds to the JSON property `connectionInfo` # @return [Google::Apis::GameservicesV1beta::GameServerClusterConnectionInfo] attr_accessor :connection_info @@ -761,13 +761,13 @@ module Google # @return [String] attr_accessor :etag - # The labels associated with this Game Server Cluster. Each label is a + # The labels associated with this game server cluster. Each label is a # key-value pair. # Corresponds to the JSON property `labels` # @return [Hash] attr_accessor :labels - # Required. The resource name of the Game Server Cluster. Uses the form: + # Required. The resource name of the game server cluster. Uses the form: # `projects/`project`/locations/`location`/realms/`realm`/gameServerClusters/` # cluster``. # For example, @@ -798,7 +798,7 @@ module Google end end - # The Game Server Cluster connection information. + # The game server cluster connection information. class GameServerClusterConnectionInfo include Google::Apis::Core::Hashable @@ -807,7 +807,7 @@ module Google # @return [Google::Apis::GameservicesV1beta::GkeClusterReference] attr_accessor :gke_cluster_reference - # Namespace designated on the Game Server Cluster where the Agones game + # Namespace designated on the game server cluster where the Agones game # server instances will be created. Existence of the namespace will be # validated during creation. # Corresponds to the JSON property `namespace` @@ -825,7 +825,7 @@ module Google end end - # A Game Server Config resource. + # A game server config resource. class GameServerConfig include Google::Apis::Core::Hashable @@ -834,7 +834,7 @@ module Google # @return [String] attr_accessor :create_time - # The description of the Game Server Config. + # The description of the game server config. # Corresponds to the JSON property `description` # @return [String] attr_accessor :description @@ -845,13 +845,13 @@ module Google # @return [Array] attr_accessor :fleet_configs - # The labels associated with this Game Server Config. Each label is a + # The labels associated with this game server config. Each label is a # key-value pair. # Corresponds to the JSON property `labels` # @return [Hash] attr_accessor :labels - # The resource name of the Game Server Config. Uses the form: + # The resource name of the game server config. Uses the form: # `projects/`project`/locations/`location`/gameServerDeployments/`deployment`/ # configs/`config``. # For example, @@ -887,7 +887,7 @@ module Google end end - # A Game Server Config override. + # A game server config override. class GameServerConfigOverride include Google::Apis::Core::Hashable @@ -896,7 +896,7 @@ module Google # @return [String] attr_accessor :config_version - # The Realm selector, used to match Realm resources. + # The realm selector, used to match realm resources. # Corresponds to the JSON property `realmsSelector` # @return [Google::Apis::GameservicesV1beta::RealmSelector] attr_accessor :realms_selector @@ -912,7 +912,7 @@ module Google end end - # A Game Server Deployment resource. + # A game server deployment resource. class GameServerDeployment include Google::Apis::Core::Hashable @@ -921,7 +921,7 @@ module Google # @return [String] attr_accessor :create_time - # Human readable description of the Game Server Deployment. + # Human readable description of the game server delpoyment. # Corresponds to the JSON property `description` # @return [String] attr_accessor :description @@ -931,13 +931,13 @@ module Google # @return [String] attr_accessor :etag - # The labels associated with this Game Server Deployment. Each label is a + # The labels associated with this game server deployment. Each label is a # key-value pair. # Corresponds to the JSON property `labels` # @return [Hash] attr_accessor :labels - # The resource name of the Game Server Deployment. Uses the form: + # The resource name of the game server deployment. Uses the form: # `projects/`project`/locations/`location`/gameServerDeployments/`deployment``. # For example, # `projects/my-project/locations/`location`/gameServerDeployments/my-deployment`. @@ -965,7 +965,7 @@ module Google end end - # The Game Server Deployment Rollout which represents the desired rollout + # The game server deployment rollout which represents the desired rollout # state. class GameServerDeploymentRollout include Google::Apis::Core::Hashable @@ -975,8 +975,8 @@ module Google # @return [String] attr_accessor :create_time - # The default Game Server Config is applied to all Realms unless overridden - # in the Rollout. For example, + # The default game server config is applied to all realms unless overridden + # in the rollout. For example, # `projects/my-project/locations/global/gameServerDeployments/my-game/configs/my- # config`. # Corresponds to the JSON property `defaultGameServerConfig` @@ -988,14 +988,14 @@ module Google # @return [String] attr_accessor :etag - # Contains the Game Server Config Rollout overrides. Overrides are processed - # in the order they are listed. Once a match is found for a Realm, the rest + # Contains the game server config rollout overrides. Overrides are processed + # in the order they are listed. Once a match is found for a realm, the rest # of the list is not processed. # Corresponds to the JSON property `gameServerConfigOverrides` # @return [Array] attr_accessor :game_server_config_overrides - # The resource name of the Game Server Deployment Rollout. Uses the form: + # The resource name of the game server deployment rollout. Uses the form: # `projects/`project`/locations/`location`/gameServerDeployments/`deployment`/ # rollout`. # For example, @@ -1074,7 +1074,7 @@ module Google class ListGameServerClustersResponse include Google::Apis::Core::Hashable - # The list of Game Server Clusters. + # The list of game server clusters. # Corresponds to the JSON property `gameServerClusters` # @return [Array] attr_accessor :game_server_clusters @@ -1085,7 +1085,7 @@ module Google # @return [String] attr_accessor :next_page_token - # List of Locations that could not be reached. + # List of locations that could not be reached. # Corresponds to the JSON property `unreachable` # @return [Array] attr_accessor :unreachable @@ -1106,7 +1106,7 @@ module Google class ListGameServerConfigsResponse include Google::Apis::Core::Hashable - # The list of Game Server Configs. + # The list of game server configs. # Corresponds to the JSON property `gameServerConfigs` # @return [Array] attr_accessor :game_server_configs @@ -1117,7 +1117,7 @@ module Google # @return [String] attr_accessor :next_page_token - # List of Locations that could not be reached. + # List of locations that could not be reached. # Corresponds to the JSON property `unreachable` # @return [Array] attr_accessor :unreachable @@ -1138,7 +1138,7 @@ module Google class ListGameServerDeploymentsResponse include Google::Apis::Core::Hashable - # The list of Game Server Delpoyments. + # The list of game server deployments. # Corresponds to the JSON property `gameServerDeployments` # @return [Array] attr_accessor :game_server_deployments @@ -1149,7 +1149,7 @@ module Google # @return [String] attr_accessor :next_page_token - # List of Locations that could not be reached. + # List of locations that could not be reached. # Corresponds to the JSON property `unreachable` # @return [Array] attr_accessor :unreachable @@ -1226,12 +1226,12 @@ module Google # @return [String] attr_accessor :next_page_token - # The list of Realms. + # The list of realms. # Corresponds to the JSON property `realms` # @return [Array] attr_accessor :realms - # List of Locations that could not be reached. + # List of locations that could not be reached. # Corresponds to the JSON property `unreachable` # @return [Array] attr_accessor :unreachable @@ -1425,7 +1425,7 @@ module Google # @return [String] attr_accessor :end_time - # Output only. Operation status for gameservices API operations. Operation + # Output only. Operation status for Game Services API operations. Operation # status is in # the form of key-value pairs where keys are resource IDs and the values show # the status of the operation. In case of failures, the value includes an @@ -1520,10 +1520,13 @@ module Google # Google groups, and domains (such as G Suite). A `role` is a named list of # permissions; each `role` can be an IAM predefined role or a user-created # custom role. - # Optionally, a `binding` can specify a `condition`, which is a logical - # expression that allows access to a resource only if the expression evaluates - # to `true`. A condition can add constraints based on attributes of the - # request, the resource, or both. + # For some types of Google Cloud resources, a `binding` can also specify a + # `condition`, which is a logical expression that allows access to a resource + # only if the expression evaluates to `true`. A condition can add constraints + # based on attributes of the request, the resource, or both. To learn which + # resources support conditions in their IAM policies, see the + # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource- + # policies). # **JSON example:** # ` # "bindings": [ @@ -1538,7 +1541,9 @@ module Google # `, # ` # "role": "roles/resourcemanager.organizationViewer", - # "members": ["user:eve@example.com"], + # "members": [ + # "user:eve@example.com" + # ], # "condition": ` # "title": "expirable access", # "description": "Does not grant access after Sep 2020", @@ -1635,6 +1640,9 @@ module Google # the conditions in the version `3` policy are lost. # If a policy does not include any conditions, operations on that policy may # specify any valid version or leave the field unset. + # To learn which resources support conditions in their IAM policies, see the + # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource- + # policies). # Corresponds to the JSON property `version` # @return [Fixnum] attr_accessor :version @@ -1711,7 +1719,7 @@ module Google class PreviewGameServerDeploymentRolloutResponse include Google::Apis::Core::Hashable - # ETag of the Game Server Deployment. + # ETag of the game server deployment. # Corresponds to the JSON property `etag` # @return [String] attr_accessor :etag @@ -1788,7 +1796,7 @@ module Google end end - # A Realm resource. + # A realm resource. class Realm include Google::Apis::Core::Hashable @@ -1797,7 +1805,7 @@ module Google # @return [String] attr_accessor :create_time - # Human readable description of the Realm. + # Human readable description of the realm. # Corresponds to the JSON property `description` # @return [String] attr_accessor :description @@ -1807,19 +1815,19 @@ module Google # @return [String] attr_accessor :etag - # The labels associated with this Realm. Each label is a key-value pair. + # The labels associated with this realm. Each label is a key-value pair. # Corresponds to the JSON property `labels` # @return [Hash] attr_accessor :labels - # The resource name of the Realm. Uses the form: + # The resource name of the realm. Uses the form: # `projects/`project`/locations/`location`/realms/`realm``. For # example, `projects/my-project/locations/`location`/realms/my-realm`. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name - # Required. Time zone where all policies targeting this Realm are evaluated. The + # Required. Time zone where all policies targeting this realm are evaluated. The # value # of this field must be from the IANA time zone database: # https://www.iana.org/time-zones. @@ -1848,11 +1856,11 @@ module Google end end - # The Realm selector, used to match Realm resources. + # The realm selector, used to match realm resources. class RealmSelector include Google::Apis::Core::Hashable - # List of Realms to match. + # List of realms to match. # Corresponds to the JSON property `realms` # @return [Array] attr_accessor :realms @@ -1950,8 +1958,8 @@ module Google # @return [Array] attr_accessor :schedules - # Labels used to identify the Game Server Clusters to which this Agones - # scaling config applies. A Game Server Cluster is subject to this Agones + # Labels used to identify the game server clusters to which this Agones + # scaling config applies. A game server cluster is subject to this Agones # scaling config if its labels match any of the selector entries. # Corresponds to the JSON property `selectors` # @return [Array] @@ -1988,7 +1996,7 @@ module Google # The cron definition of the scheduled event. See # https://en.wikipedia.org/wiki/Cron. Cron spec specifies the local time as - # defined by the Realm. + # defined by the realm. # Corresponds to the JSON property `cronSpec` # @return [String] attr_accessor :cron_spec @@ -2027,10 +2035,13 @@ module Google # Google groups, and domains (such as G Suite). A `role` is a named list of # permissions; each `role` can be an IAM predefined role or a user-created # custom role. - # Optionally, a `binding` can specify a `condition`, which is a logical - # expression that allows access to a resource only if the expression evaluates - # to `true`. A condition can add constraints based on attributes of the - # request, the resource, or both. + # For some types of Google Cloud resources, a `binding` can also specify a + # `condition`, which is a logical expression that allows access to a resource + # only if the expression evaluates to `true`. A condition can add constraints + # based on attributes of the request, the resource, or both. To learn which + # resources support conditions in their IAM policies, see the + # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource- + # policies). # **JSON example:** # ` # "bindings": [ @@ -2045,7 +2056,9 @@ module Google # `, # ` # "role": "roles/resourcemanager.organizationViewer", - # "members": ["user:eve@example.com"], + # "members": [ + # "user:eve@example.com" + # ], # "condition": ` # "title": "expirable access", # "description": "Does not grant access after Sep 2020", @@ -2103,7 +2116,7 @@ module Google class SpecSource include Google::Apis::Core::Hashable - # The Game Server Config resource. Uses the form: + # The game server config resource. Uses the form: # `projects/`project`/locations/`location`/gameServerDeployments/`deployment_id`/ # configs/`config_id``. # Corresponds to the JSON property `gameServerConfigName` @@ -2170,19 +2183,19 @@ module Google class TargetDetails include Google::Apis::Core::Hashable - # Agones fleet details for Game Server Clusters and Game Server Deployments. + # Agones fleet details for game server clusters and game server deployments. # Corresponds to the JSON property `fleetDetails` # @return [Array] attr_accessor :fleet_details - # The Game Server Cluster name. Uses the form: + # The game server cluster name. Uses the form: # `projects/`project`/locations/`location`/realms/`realm`/gameServerClusters/` # cluster``. # Corresponds to the JSON property `gameServerClusterName` # @return [String] attr_accessor :game_server_cluster_name - # The Game Server Deployment name. Uses the form: + # The game server deployment name. Uses the form: # `projects/`project`/locations/`location`/gameServerDeployments/`deployment_id`` # . # Corresponds to the JSON property `gameServerDeploymentName` diff --git a/generated/google/apis/gameservices_v1beta/service.rb b/generated/google/apis/gameservices_v1beta/service.rb index 5befc0ef4..1a8d8bd33 100644 --- a/generated/google/apis/gameservices_v1beta/service.rb +++ b/generated/google/apis/gameservices_v1beta/service.rb @@ -120,13 +120,13 @@ module Google execute_or_queue_command(command, &block) end - # Creates a new Game Server Deployment in a given project and Location. + # Creates a new game server deployment in a given project and location. # @param [String] parent # Required. The parent resource name. Uses the form: # `projects/`project`/locations/`location``. # @param [Google::Apis::GameservicesV1beta::GameServerDeployment] game_server_deployment_object # @param [String] deployment_id - # Required. The ID of the Game Server Deployment resource to be created. + # Required. The ID of the game server delpoyment resource to be created. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -157,9 +157,9 @@ module Google execute_or_queue_command(command, &block) end - # Deletes a single Game Server Deployment. + # Deletes a single game server deployment. # @param [String] name - # Required. The name of the Game Server Deployment to delete. Uses the form: + # Required. The name of the game server delpoyment to delete. Uses the form: # `projects/`project`/locations/`location`/gameServerDeployments/`deployment``. # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -188,11 +188,11 @@ module Google execute_or_queue_command(command, &block) end - # Retrieves information about the current state of the Game Server - # Ddeployment. Gathers all the Agones fleets and Agones autoscalers, - # including fleets running an older version of the Game Server Deployment. + # Retrieves information about the current state of the game server + # deployment. Gathers all the Agones fleets and Agones autoscalers, + # including fleets running an older version of the game server deployment. # @param [String] name - # Required. The name of the Game Server Deployment. Uses the form: + # Required. The name of the game server delpoyment. Uses the form: # `projects/`project`/locations/`location`/gameServerDeployments/`deployment``. # @param [Google::Apis::GameservicesV1beta::FetchDeploymentStateRequest] fetch_deployment_state_request_object # @param [String] fields @@ -224,9 +224,9 @@ module Google execute_or_queue_command(command, &block) end - # Gets details of a single Game Server Deployment. + # Gets details of a single game server deployment. # @param [String] name - # Required. The name of the Game Server Deployment to retrieve. Uses the form: + # Required. The name of the game server delpoyment to retrieve. Uses the form: # `projects/`project`/locations/`location`/gameServerDeployments/`deployment``. # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -268,6 +268,9 @@ module Google # Requests for policies with any conditional bindings must specify version 3. # Policies without any conditional bindings may specify any valid value or # leave the field unset. + # To learn which resources support conditions in their IAM policies, see the + # [IAM + # documentation](https://cloud.google.com/iam/help/conditions/resource-policies). # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -296,9 +299,9 @@ module Google execute_or_queue_command(command, &block) end - # Gets details a single Game Server Deployment Rollout. + # Gets details a single game server deployment rollout. # @param [String] name - # Required. The name of the Game Server Deployment to retrieve. Uses the form: + # Required. The name of the game server delpoyment to retrieve. Uses the form: # `projects/`project`/locations/`location`/gameServerDeployments/`deployment`/ # rollout`. # @param [String] fields @@ -328,7 +331,7 @@ module Google execute_or_queue_command(command, &block) end - # Lists Game Server Deployments in a given project and Location. + # Lists game server deployments in a given project and location. # @param [String] parent # Required. The parent resource name. Uses the form: # `projects/`project`/locations/`location``. @@ -338,8 +341,8 @@ module Google # Optional. Specifies the ordering of results following syntax at # https://cloud.google.com/apis/design/design_patterns#sorting_order. # @param [Fixnum] page_size - # Optional. The maximum number of items to return. If unspecified, server - # will pick an appropriate default. Server may return fewer items than + # Optional. The maximum number of items to return. If unspecified, the server + # will pick an appropriate default. The server may return fewer items than # requested. A caller should only rely on response's # next_page_token to # determine if there are more GameServerDeployments left to be queried. @@ -377,9 +380,9 @@ module Google execute_or_queue_command(command, &block) end - # Patches a Game Server Deployment. + # Patches a game server deployment. # @param [String] name - # The resource name of the Game Server Deployment. Uses the form: + # The resource name of the game server deployment. Uses the form: # `projects/`project`/locations/`location`/gameServerDeployments/`deployment``. # For example, # `projects/my-project/locations/`location`/gameServerDeployments/my-deployment`. @@ -420,10 +423,10 @@ module Google execute_or_queue_command(command, &block) end - # Previews the Game Server Deployment Rollout. This API does not mutate the - # Rollout resource. + # Previews the game server deployment rollout. This API does not mutate the + # rollout resource. # @param [String] name - # The resource name of the Game Server Deployment Rollout. Uses the form: + # The resource name of the game server deployment rollout. Uses the form: # `projects/`project`/locations/`location`/gameServerDeployments/`deployment`/ # rollout`. # For example, @@ -433,7 +436,7 @@ module Google # @param [String] preview_time # Optional. The target timestamp to compute the preview. Defaults to the # immediately - # after the proposed Rollout completes. + # after the proposed rollout completes. # @param [String] update_mask # Optional. Mask of fields to update. At least one path must be supplied in # this field. For the `FieldMask` definition, see @@ -546,14 +549,14 @@ module Google execute_or_queue_command(command, &block) end - # Patches a single Game Server Deployment Rollout. + # Patches a single game server deployment rollout. # The method will not return an error if the update does not affect any # existing realms. For example - if the default_game_server_config is changed # but all existing realms use the override, that is valid. Similarly, if a # non existing realm is explicitly called out in game_server_config_overrides # field, that will also not result in an error. # @param [String] name - # The resource name of the Game Server Deployment Rollout. Uses the form: + # The resource name of the game server deployment rollout. Uses the form: # `projects/`project`/locations/`location`/gameServerDeployments/`deployment`/ # rollout`. # For example, @@ -596,15 +599,15 @@ module Google execute_or_queue_command(command, &block) end - # Creates a new Game Server Config in a given project, Location, and Game - # Server Deployment. Game Server Configs are immutable, and are not applied - # until referenced in the Game Server Deployment Rollout resource. + # Creates a new game server config in a given project, location, and game + # server deployment. Game server configs are immutable, and are not applied + # until referenced in the game server deployment rollout resource. # @param [String] parent # Required. The parent resource name. Uses the form: # `projects/`project`/locations/`location`/gameServerDeployments/`deployment`/`. # @param [Google::Apis::GameservicesV1beta::GameServerConfig] game_server_config_object # @param [String] config_id - # Required. The ID of the Game Server Config resource to be created. + # Required. The ID of the game server config resource to be created. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -635,10 +638,10 @@ module Google execute_or_queue_command(command, &block) end - # Deletes a single Game Server Config. The deletion will fail if the Game - # Server Config is referenced in a Game Server Deployment Rollout. + # Deletes a single game server config. The deletion will fail if the game + # server config is referenced in a game server deployment rollout. # @param [String] name - # Required. The name of the Game Server Config to delete. Uses the form: + # Required. The name of the game server config to delete. Uses the form: # `projects/`project`/locations/`location`/gameServerDeployments/`deployment`/ # configs/`config``. # @param [String] fields @@ -668,9 +671,9 @@ module Google execute_or_queue_command(command, &block) end - # Gets details of a single Game Server Config. + # Gets details of a single game server config. # @param [String] name - # Required. The name of the Game Server Config to retrieve. Uses the form: + # Required. The name of the game server config to retrieve. Uses the form: # `projects/`project`/locations/`location`/gameServerDeployments/`deployment`/ # configs/`config``. # @param [String] fields @@ -700,8 +703,8 @@ module Google execute_or_queue_command(command, &block) end - # Lists Game Server Configs in a given project, Location, and Game Server - # Deployment. + # Lists game server configs in a given project, location, and game server + # deployment. # @param [String] parent # Required. The parent resource name. Uses the form: # `projects/`project`/locations/`location`/gameServerDeployments/`deployment`/ @@ -718,7 +721,7 @@ module Google # next_page_token to # determine if there are more GameServerConfigs left to be queried. # @param [String] page_token - # Optional. The next_page_token value returned from a previous List request, if + # Optional. The next_page_token value returned from a previous list request, if # any. # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -905,13 +908,13 @@ module Google execute_or_queue_command(command, &block) end - # Creates a new Realm in a given project and Location. + # Creates a new realm in a given project and location. # @param [String] parent # Required. The parent resource name. Uses the form: # `projects/`project`/locations/`location``. # @param [Google::Apis::GameservicesV1beta::Realm] realm_object # @param [String] realm_id - # Required. The ID of the Realm resource to be created. + # Required. The ID of the realm resource to be created. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -942,9 +945,9 @@ module Google execute_or_queue_command(command, &block) end - # Deletes a single Realm. + # Deletes a single realm. # @param [String] name - # Required. The name of the Realm to delete. Uses the form: + # Required. The name of the realm to delete. Uses the form: # `projects/`project`/locations/`location`/realms/`realm``. # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -973,9 +976,9 @@ module Google execute_or_queue_command(command, &block) end - # Gets details of a single Realm. + # Gets details of a single realm. # @param [String] name - # Required. The name of the Realm to retrieve. Uses the form: + # Required. The name of the realm to retrieve. Uses the form: # `projects/`project`/locations/`location`/realms/`realm``. # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -1004,7 +1007,7 @@ module Google execute_or_queue_command(command, &block) end - # Lists Realms in a given project and Location. + # Lists realms in a given project and location. # @param [String] parent # Required. The parent resource name. Uses the form: # `projects/`project`/locations/`location``. @@ -1018,7 +1021,7 @@ module Google # will pick an appropriate default. Server may return fewer items than # requested. A caller should only rely on response's # next_page_token to - # determine if there are more Realms left to be queried. + # determine if there are more realms left to be queried. # @param [String] page_token # Optional. The next_page_token value returned from a previous List request, # if any. @@ -1053,9 +1056,9 @@ module Google execute_or_queue_command(command, &block) end - # Patches a single Realm. + # Patches a single realm. # @param [String] name - # The resource name of the Realm. Uses the form: + # The resource name of the realm. Uses the form: # `projects/`project`/locations/`location`/realms/`realm``. For # example, `projects/my-project/locations/`location`/realms/my-realm`. # @param [Google::Apis::GameservicesV1beta::Realm] realm_object @@ -1095,9 +1098,9 @@ module Google execute_or_queue_command(command, &block) end - # Previews patches to a single Realm. + # Previews patches to a single realm. # @param [String] name - # The resource name of the Realm. Uses the form: + # The resource name of the realm. Uses the form: # `projects/`project`/locations/`location`/realms/`realm``. For # example, `projects/my-project/locations/`location`/realms/my-realm`. # @param [Google::Apis::GameservicesV1beta::Realm] realm_object @@ -1146,7 +1149,7 @@ module Google # `projects/`project`/locations/`location`/realms/`realm-id``. # @param [Google::Apis::GameservicesV1beta::GameServerCluster] game_server_cluster_object # @param [String] game_server_cluster_id - # Required. The ID of the Game Server Cluster resource to be created. + # Required. The ID of the game server cluster resource to be created. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -1179,7 +1182,7 @@ module Google # Deletes a single game server cluster. # @param [String] name - # Required. The name of the Game Server Cluster to delete. Uses the form: + # Required. The name of the game server cluster to delete. Uses the form: # `projects/`project`/locations/`location`/gameServerClusters/`cluster``. # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -1210,7 +1213,7 @@ module Google # Gets details of a single game server cluster. # @param [String] name - # Required. The name of the Game Server Cluster to retrieve. Uses the form: + # Required. The name of the game server cluster to retrieve. Uses the form: # `projects/`project`/locations/`location`/realms/`realm-id`/gameServerClusters/` # cluster``. # @param [String] fields @@ -1240,7 +1243,7 @@ module Google execute_or_queue_command(command, &block) end - # Lists Game Server Clusters in a given project and location. + # Lists game server clusters in a given project and location. # @param [String] parent # Required. The parent resource name. Uses the form: # "projects/`project`/locations/`location`/realms/`realm`". @@ -1250,8 +1253,8 @@ module Google # Optional. Specifies the ordering of results following syntax at # https://cloud.google.com/apis/design/design_patterns#sorting_order. # @param [Fixnum] page_size - # Optional. The maximum number of items to return. If unspecified, server - # will pick an appropriate default. Server may return fewer items than + # Optional. The maximum number of items to return. If unspecified, the server + # will pick an appropriate default. The server may return fewer items than # requested. A caller should only rely on response's # next_page_token to # determine if there are more GameServerClusters left to be queried. @@ -1291,7 +1294,7 @@ module Google # Patches a single game server cluster. # @param [String] name - # Required. The resource name of the Game Server Cluster. Uses the form: + # Required. The resource name of the game server cluster. Uses the form: # `projects/`project`/locations/`location`/realms/`realm`/gameServerClusters/` # cluster``. # For example, @@ -1341,7 +1344,7 @@ module Google # `projects/`project`/locations/`location`/realms/`realm``. # @param [Google::Apis::GameservicesV1beta::GameServerCluster] game_server_cluster_object # @param [String] game_server_cluster_id - # Required. The ID of the Game Server Cluster resource to be created. + # Required. The ID of the game server cluster resource to be created. # @param [String] preview_time # Optional. The target timestamp to compute the preview. # @param [String] fields @@ -1377,7 +1380,7 @@ module Google # Previews deletion of a single game server cluster. # @param [String] name - # Required. The name of the Game Server Cluster to delete. Uses the form: + # Required. The name of the game server cluster to delete. Uses the form: # `projects/`project`/locations/`location`/gameServerClusters/`cluster``. # @param [String] preview_time # Optional. The target timestamp to compute the preview. @@ -1411,7 +1414,7 @@ module Google # Previews updating a GameServerCluster. # @param [String] name - # Required. The resource name of the Game Server Cluster. Uses the form: + # Required. The resource name of the game server cluster. Uses the form: # `projects/`project`/locations/`location`/realms/`realm`/gameServerClusters/` # cluster``. # For example, diff --git a/generated/google/apis/gmail_v1.rb b/generated/google/apis/gmail_v1.rb index b2b4ae30d..cb77c244c 100644 --- a/generated/google/apis/gmail_v1.rb +++ b/generated/google/apis/gmail_v1.rb @@ -20,13 +20,12 @@ module Google module Apis # Gmail API # - # The Gmail API lets you view and manage Gmail mailbox data like - # threads, messages, and labels. + # Access Gmail mailboxes including sending user email. # # @see https://developers.google.com/gmail/api/ module GmailV1 VERSION = 'V1' - REVISION = '20200406' + REVISION = '20200504' # Read, compose, send, and permanently delete all your email from Gmail AUTH_SCOPE = 'https://mail.google.com/' diff --git a/generated/google/apis/gmail_v1/classes.rb b/generated/google/apis/gmail_v1/classes.rb index dae18fa09..82fbda4ae 100644 --- a/generated/google/apis/gmail_v1/classes.rb +++ b/generated/google/apis/gmail_v1/classes.rb @@ -31,8 +31,8 @@ module Google # @return [String] attr_accessor :disposition - # Email address to which all incoming messages are forwarded. This email - # address must be a verified member of the forwarding addresses. + # Email address to which all incoming messages are forwarded. This email address + # must be a verified member of the forwarding addresses. # Corresponds to the JSON property `emailAddress` # @return [String] attr_accessor :email_address @@ -83,8 +83,7 @@ module Google # @return [Array] attr_accessor :add_label_ids - # The IDs of the messages to modify. There is a limit of 1000 ids per - # request. + # The IDs of the messages to modify. There is a limit of 1000 ids per request. # Corresponds to the JSON property `ids` # @return [Array] attr_accessor :ids @@ -107,9 +106,8 @@ module Google end # Settings for a delegate. Delegates can read, send, and delete messages, as - # well as view and add contacts, for the delegator's account. See - # "Set up - # mail delegation" for more information about delegates. + # well as view and add contacts, for the delegator's account. See "Set up mail + # delegation" for more information about delegates. class Delegate include Google::Apis::Core::Hashable @@ -118,8 +116,8 @@ module Google # @return [String] attr_accessor :delegate_email - # Indicates whether this address has been verified and can act as a delegate - # for the account. Read-only. + # Indicates whether this address has been verified and can act as a delegate for + # the account. Read-only. # Corresponds to the JSON property `verificationStatus` # @return [String] attr_accessor :verification_status @@ -244,18 +242,16 @@ module Google attr_accessor :has_attachment alias_method :has_attachment?, :has_attachment - # Only return messages not matching the specified query. Supports the same - # query format as the Gmail search box. For example, - # "from:someuser@example.com rfc822msgid: - # is:unread". + # Only return messages not matching the specified query. Supports the same query + # format as the Gmail search box. For example, "from:someuser@example.com + # rfc822msgid: is:unread". # Corresponds to the JSON property `negatedQuery` # @return [String] attr_accessor :negated_query - # Only return messages matching the specified query. Supports the same - # query format as the Gmail search box. For example, - # "from:someuser@example.com rfc822msgid: - # is:unread". + # Only return messages matching the specified query. Supports the same query + # format as the Gmail search box. For example, "from:someuser@example.com + # rfc822msgid: is:unread". # Corresponds to the JSON property `query` # @return [String] attr_accessor :query @@ -271,16 +267,16 @@ module Google # @return [String] attr_accessor :size_comparison - # Case-insensitive phrase found in the message's subject. Trailing and - # leading whitespace are be trimmed and adjacent spaces are collapsed. + # Case-insensitive phrase found in the message's subject. Trailing and leading + # whitespace are be trimmed and adjacent spaces are collapsed. # Corresponds to the JSON property `subject` # @return [String] attr_accessor :subject - # The recipient's display name or email address. Includes recipients in the - # "to", "cc", and "bcc" header fields. You can use simply the local part of - # the email address. For example, "example" and "example@" both match - # "example@gmail.com". This field is case-insensitive. + # The recipient's display name or email address. Includes recipients in the "to", + # "cc", and "bcc" header fields. You can use simply the local part of the email + # address. For example, "example" and "example@" both match "example@gmail.com". + # This field is case-insensitive. # Corresponds to the JSON property `to` # @return [String] attr_accessor :to @@ -312,8 +308,8 @@ module Google # @return [String] attr_accessor :forwarding_email - # Indicates whether this address has been verified and is usable for - # forwarding. Read-only. + # Indicates whether this address has been verified and is usable for forwarding. + # Read-only. # Corresponds to the JSON property `verificationStatus` # @return [String] attr_accessor :verification_status @@ -349,10 +345,9 @@ module Google # @return [Array] attr_accessor :labels_removed - # List of messages changed in this history record. The fields for specific - # change types, such as messagesAdded may duplicate messages in - # this field. We recommend using the specific change-type fields instead - # of this. + # List of messages changed in this history record. The fields for specific + # change types, such as messagesAdded may duplicate messages in this field. We + # recommend using the specific change-type fields instead of this. # Corresponds to the JSON property `messages` # @return [Array] attr_accessor :messages @@ -475,8 +470,8 @@ module Google include Google::Apis::Core::Hashable # If this value is true, Gmail will immediately expunge a message when it is - # marked as deleted in IMAP. Otherwise, Gmail will wait for an update from - # the client before expunging messages marked as deleted. + # marked as deleted in IMAP. Otherwise, Gmail will wait for an update from the + # client before expunging messages marked as deleted. # Corresponds to the JSON property `autoExpunge` # @return [Boolean] attr_accessor :auto_expunge @@ -488,15 +483,15 @@ module Google attr_accessor :enabled alias_method :enabled?, :enabled - # The action that will be executed on a message when it is marked as deleted - # and expunged from the last visible IMAP folder. + # The action that will be executed on a message when it is marked as deleted and + # expunged from the last visible IMAP folder. # Corresponds to the JSON property `expungeBehavior` # @return [String] attr_accessor :expunge_behavior - # An optional limit on the number of messages that an IMAP folder may - # contain. Legal values are 0, 1000, 2000, 5000 or 10000. A value of zero - # is interpreted to mean that there is no limit. + # An optional limit on the number of messages that an IMAP folder may contain. + # Legal values are 0, 1000, 2000, 5000 or 10000. A value of zero is interpreted + # to mean that there is no limit. # Corresponds to the JSON property `maxFolderSize` # @return [Fixnum] attr_accessor :max_folder_size @@ -514,14 +509,12 @@ module Google end end - # Labels are used to categorize messages and threads within the - # user's mailbox. + # Labels are used to categorize messages and threads within the user's mailbox. class Label include Google::Apis::Core::Hashable - # The color to assign to the label. Color is only available for labels that - # have their type set to user. - # @mutable gmail.users.labels.create gmail.users.labels.update + # The color to assign to the label. Color is only available for labels that have + # their type set to user. # Corresponds to the JSON property `color` # @return [Google::Apis::GmailV1::LabelColor] attr_accessor :color @@ -532,14 +525,11 @@ module Google attr_accessor :id # The visibility of the label in the label list in the Gmail web interface. - # @mutable gmail.users.labels.create gmail.users.labels.update # Corresponds to the JSON property `labelListVisibility` # @return [String] attr_accessor :label_list_visibility - # The visibility of the label in the message list in the - # Gmail web interface. - # @mutable gmail.users.labels.create gmail.users.labels.update + # The visibility of the label in the message list in the Gmail web interface. # Corresponds to the JSON property `messageListVisibility` # @return [String] attr_accessor :message_list_visibility @@ -555,7 +545,6 @@ module Google attr_accessor :messages_unread # The display name of the label. - # @mutable gmail.users.labels.create gmail.users.labels.update # Corresponds to the JSON property `name` # @return [String] attr_accessor :name @@ -570,15 +559,14 @@ module Google # @return [Fixnum] attr_accessor :threads_unread - # The owner type for the label. User labels are created by the user and - # can be modified and deleted by the user and can be applied to any - # message or thread. System labels are internally created and cannot be - # added, modified, or deleted. System labels may be able to be applied to or - # removed from messages and threads under some circumstances but this is - # not guaranteed. For example, users can apply and remove the - # INBOX and UNREAD labels from messages and - # threads, but cannot apply or remove the DRAFTS or - # SENT labels from messages or threads. + # The owner type for the label. User labels are created by the user and can be + # modified and deleted by the user and can be applied to any message or thread. + # System labels are internally created and cannot be added, modified, or deleted. + # System labels may be able to be applied to or removed from messages and + # threads under some circumstances but this is not guaranteed. For example, + # users can apply and remove the INBOX and UNREAD labels from messages and + # threads, but cannot apply or remove the DRAFTS or SENT labels from messages or + # threads. # Corresponds to the JSON property `type` # @return [String] attr_accessor :type @@ -606,46 +594,40 @@ module Google class LabelColor include Google::Apis::Core::Hashable - # The background color represented as hex string #RRGGBB (ex #000000). - # This field is required in order to set the color of a label. - # Only the following predefined set of color values are allowed: - #
- # # 000000, #434343, #666666, #999999, #cccccc, #efefef, #f3f3f3, #ffffff, - # # fb4c2f, #ffad47, #fad165, #16a766, #43d692, #4a86e8, #a479e2, #f691b3, - # # f6c5be, #ffe6c7, #fef1d1, #b9e4d0, #c6f3de, #c9daf8, #e4d7f5, #fcdee8, - # # efa093, #ffd6a2, #fce8b3, #89d3b2, #a0eac9, #a4c2f4, #d0bcf1, #fbc8d9, - # # e66550, #ffbc6b, #fcda83, #44b984, #68dfa9, #6d9eeb, #b694e8, #f7a7c0, - # # cc3a21, #eaa041, #f2c960, #149e60, #3dc789, #3c78d8, #8e63ce, #e07798, - # # ac2b16, #cf8933, #d5ae49, #0b804b, #2a9c68, #285bac, #653e9b, #b65775, - # # 822111, #a46a21, #aa8831, #076239, #1a764d, #1c4587, #41236d, #83334c - # # 464646, #e7e7e7, #0d3472, #b6cff5, #0d3b44, #98d7e4, #3d188e, #e3d7ff, - # # 711a36, #fbd3e0, #8a1c0a, #f2b2a8, #7a2e0b, #ffc8af, #7a4706, #ffdeb5, - # # 594c05, #fbe983, #684e07, #fdedc1, #0b4f30, #b3efd3, #04502e, #a2dcc1, - # # c2c2c2, #4986e7, #2da2bb, #b99aff, #994a64, #f691b2, #ff7537, #ffad46, - # # 662e37, #ebdbde, #cca6ac, #094228, #42d692, #16a765 - # @mutable gmail.users.labels.create gmail.users.labels.update + # The background color represented as hex string #RRGGBB (ex #000000). This + # field is required in order to set the color of a label. Only the following + # predefined set of color values are allowed: + # #000000, #434343, #666666, #999999, #cccccc, #efefef, #f3f3f3, #ffffff, # + # fb4c2f, #ffad47, #fad165, #16a766, #43d692, #4a86e8, #a479e2, #f691b3, #f6c5be, + # #ffe6c7, #fef1d1, #b9e4d0, #c6f3de, #c9daf8, #e4d7f5, #fcdee8, #efa093, # + # ffd6a2, #fce8b3, #89d3b2, #a0eac9, #a4c2f4, #d0bcf1, #fbc8d9, #e66550, #ffbc6b, + # #fcda83, #44b984, #68dfa9, #6d9eeb, #b694e8, #f7a7c0, #cc3a21, #eaa041, # + # f2c960, #149e60, #3dc789, #3c78d8, #8e63ce, #e07798, #ac2b16, #cf8933, #d5ae49, + # #0b804b, #2a9c68, #285bac, #653e9b, #b65775, #822111, #a46a21, #aa8831, # + # 076239, #1a764d, #1c4587, #41236d, #83334c #464646, #e7e7e7, #0d3472, #b6cff5, + # #0d3b44, #98d7e4, #3d188e, #e3d7ff, #711a36, #fbd3e0, #8a1c0a, #f2b2a8, # + # 7a2e0b, #ffc8af, #7a4706, #ffdeb5, #594c05, #fbe983, #684e07, #fdedc1, #0b4f30, + # #b3efd3, #04502e, #a2dcc1, #c2c2c2, #4986e7, #2da2bb, #b99aff, #994a64, # + # f691b2, #ff7537, #ffad46, #662e37, #ebdbde, #cca6ac, #094228, #42d692, #16a765 # Corresponds to the JSON property `backgroundColor` # @return [String] attr_accessor :background_color - # The text color of the label, represented as hex string. - # This field is required in order to set the color of a label. - # Only the following predefined set of color values are allowed: - #
- # # 000000, #434343, #666666, #999999, #cccccc, #efefef, #f3f3f3, #ffffff, - # # fb4c2f, #ffad47, #fad165, #16a766, #43d692, #4a86e8, #a479e2, #f691b3, - # # f6c5be, #ffe6c7, #fef1d1, #b9e4d0, #c6f3de, #c9daf8, #e4d7f5, #fcdee8, - # # efa093, #ffd6a2, #fce8b3, #89d3b2, #a0eac9, #a4c2f4, #d0bcf1, #fbc8d9, - # # e66550, #ffbc6b, #fcda83, #44b984, #68dfa9, #6d9eeb, #b694e8, #f7a7c0, - # # cc3a21, #eaa041, #f2c960, #149e60, #3dc789, #3c78d8, #8e63ce, #e07798, - # # ac2b16, #cf8933, #d5ae49, #0b804b, #2a9c68, #285bac, #653e9b, #b65775, - # # 822111, #a46a21, #aa8831, #076239, #1a764d, #1c4587, #41236d, #83334c - # # 464646, #e7e7e7, #0d3472, #b6cff5, #0d3b44, #98d7e4, #3d188e, #e3d7ff, - # # 711a36, #fbd3e0, #8a1c0a, #f2b2a8, #7a2e0b, #ffc8af, #7a4706, #ffdeb5, - # # 594c05, #fbe983, #684e07, #fdedc1, #0b4f30, #b3efd3, #04502e, #a2dcc1, - # # c2c2c2, #4986e7, #2da2bb, #b99aff, #994a64, #f691b2, #ff7537, #ffad46, - # # 662e37, #ebdbde, #cca6ac, #094228, #42d692, #16a765 - # @mutable gmail.users.labels.create gmail.users.labels.update + # The text color of the label, represented as hex string. This field is required + # in order to set the color of a label. Only the following predefined set of + # color values are allowed: + # #000000, #434343, #666666, #999999, #cccccc, #efefef, #f3f3f3, #ffffff, # + # fb4c2f, #ffad47, #fad165, #16a766, #43d692, #4a86e8, #a479e2, #f691b3, #f6c5be, + # #ffe6c7, #fef1d1, #b9e4d0, #c6f3de, #c9daf8, #e4d7f5, #fcdee8, #efa093, # + # ffd6a2, #fce8b3, #89d3b2, #a0eac9, #a4c2f4, #d0bcf1, #fbc8d9, #e66550, #ffbc6b, + # #fcda83, #44b984, #68dfa9, #6d9eeb, #b694e8, #f7a7c0, #cc3a21, #eaa041, # + # f2c960, #149e60, #3dc789, #3c78d8, #8e63ce, #e07798, #ac2b16, #cf8933, #d5ae49, + # #0b804b, #2a9c68, #285bac, #653e9b, #b65775, #822111, #a46a21, #aa8831, # + # 076239, #1a764d, #1c4587, #41236d, #83334c #464646, #e7e7e7, #0d3472, #b6cff5, + # #0d3b44, #98d7e4, #3d188e, #e3d7ff, #711a36, #fbd3e0, #8a1c0a, #f2b2a8, # + # 7a2e0b, #ffc8af, #7a4706, #ffdeb5, #594c05, #fbe983, #684e07, #fdedc1, #0b4f30, + # #b3efd3, #04502e, #a2dcc1, #c2c2c2, #4986e7, #2da2bb, #b99aff, #994a64, # + # f691b2, #ff7537, #ffad46, #662e37, #ebdbde, #cca6ac, #094228, #42d692, #16a765 # Corresponds to the JSON property `textColor` # @return [String] attr_accessor :text_color @@ -661,28 +643,21 @@ module Google end end - # Language settings for an account. These settings correspond to - # the "Language - # settings" feature in the web interface. + # Language settings for an account. These settings correspond to the "Language + # settings" feature in the web interface. class LanguageSettings include Google::Apis::Core::Hashable - # The language to display Gmail in, formatted as an - # RFC 3066 - # Language Tag (for example en-GB, fr or - # ja for British English, French, or Japanese respectively). - # The set of languages supported by Gmail evolves over time, so please refer - # to the "Language" dropdown in the - # Gmail settings - # for all available options, as described in the - # language settings - # help article. A table of sample values is also provided in the - # Managing - # Language Settings guide - # Not all Gmail clients can display the same set of languages. In the case - # that a user's display language is not available for use on a particular - # client, said client automatically chooses to display in the closest - # supported variant (or a reasonable default). + # The language to display Gmail in, formatted as an RFC 3066 Language Tag (for + # example en-GB, fr or ja for British English, French, or Japanese respectively). + # The set of languages supported by Gmail evolves over time, so please refer to + # the "Language" dropdown in the Gmail settings for all available options, as + # described in the language settings help article. A table of sample values is + # also provided in the Managing Language Settings guide + # Not all Gmail clients can display the same set of languages. In the case that + # a user's display language is not available for use on a particular client, + # said client automatically chooses to display in the closest supported variant ( + # or a reasonable default). # Corresponds to the JSON property `displayLanguage` # @return [String] attr_accessor :display_language @@ -720,11 +695,9 @@ module Google class ListDraftsResponse include Google::Apis::Core::Hashable - # List of drafts. Note that the Message property in each - # Draft resource only contains an id and a - # threadId. The - # messages.get - # method can fetch additional message details. + # List of drafts. Note that the Message property in each Draft resource only + # contains an id and a threadId. The messages.get method can fetch additional + # message details. # Corresponds to the JSON property `drafts` # @return [Array] attr_accessor :drafts @@ -793,9 +766,8 @@ module Google class ListHistoryResponse include Google::Apis::Core::Hashable - # List of history records. Any messages contained in the - # response will typically only have id and - # threadId fields populated. + # List of history records. Any messages contained in the response will typically + # only have id and threadId fields populated. # Corresponds to the JSON property `history` # @return [Array] attr_accessor :history @@ -826,10 +798,8 @@ module Google class ListLabelsResponse include Google::Apis::Core::Hashable - # List of labels. Note that each label resource only contains an - # id, name, messageListVisibility, - # labelListVisibility, and type. The - # labels.get method + # List of labels. Note that each label resource only contains an id, name, + # messageListVisibility, labelListVisibility, and type. The labels.get method # can fetch additional label details. # Corresponds to the JSON property `labels` # @return [Array] @@ -849,10 +819,8 @@ module Google class ListMessagesResponse include Google::Apis::Core::Hashable - # List of messages. Note that each message resource contains only an - # id and a threadId. Additional message details can - # be fetched using the - # messages.get + # List of messages. Note that each message resource contains only an id and a + # threadId. Additional message details can be fetched using the messages.get # method. # Corresponds to the JSON property `messages` # @return [Array] @@ -933,9 +901,8 @@ module Google attr_accessor :result_size_estimate # List of threads. Note that each thread resource does not contain a list of - # messages. The list of messages for a given thread - # can be fetched using the - # threads.get method. + # messages. The list of messages for a given thread can be fetched using the + # threads.get method. # Corresponds to the JSON property `threads` # @return [Array] attr_accessor :threads @@ -966,17 +933,16 @@ module Google # @return [String] attr_accessor :id - # The internal message creation timestamp (epoch ms), which determines - # ordering in the inbox. For normal SMTP-received email, this represents the - # time the message was originally accepted by Google, which is more reliable - # than the Date header. However, for API-migrated mail, it can - # be configured by client to be based on the Date header. + # The internal message creation timestamp (epoch ms), which determines ordering + # in the inbox. For normal SMTP-received email, this represents the time the + # message was originally accepted by Google, which is more reliable than the + # Date header. However, for API-migrated mail, it can be configured by client to + # be based on the Date header. # Corresponds to the JSON property `internalDate` # @return [Fixnum] attr_accessor :internal_date # List of IDs of labels applied to this message. - # @mutable gmail.users.messages.insert gmail.users.messages.modify # Corresponds to the JSON property `labelIds` # @return [Array] attr_accessor :label_ids @@ -986,12 +952,9 @@ module Google # @return [Google::Apis::GmailV1::MessagePart] attr_accessor :payload - # The entire email message in an RFC 2822 formatted and base64url - # encoded string. Returned in messages.get and - # drafts.get responses when the format=RAW + # The entire email message in an RFC 2822 formatted and base64url encoded string. + # Returned in messages.get and drafts.get responses when the format=RAW # parameter is supplied. - # @mutable gmail.users.messages.insert gmail.users.messages.send - # @mutable gmail.users.drafts.create gmail.users.drafts.update # Corresponds to the JSON property `raw` # NOTE: Values are automatically base64 encoded/decoded in the client library. # @return [String] @@ -1007,17 +970,13 @@ module Google # @return [String] attr_accessor :snippet - # The ID of the thread the message belongs to. To add a message or draft to - # a thread, the following criteria must be met: - #
  1. The requested threadId must be specified on the - # Message or Draft.Message you supply with your - # request.
    2. - #
  2. The References and In-Reply-To headers must - # be set in compliance with the - # RFC 2822 standard.
    3. - #
  3. The Subject headers must match. - # @mutable gmail.users.messages.insert gmail.users.messages.send - # @mutable gmail.users.drafts.create gmail.users.drafts.update + # The ID of the thread the message belongs to. To add a message or draft to a + # thread, the following criteria must be met: + # - The requested threadId must be specified on the Message or Draft.Message you + # supply with your request. + # - The References and In-Reply-To headers must be set in compliance with the + # RFC 2822 standard. + # - The Subject headers must match. # Corresponds to the JSON property `threadId` # @return [String] attr_accessor :thread_id @@ -1049,16 +1008,15 @@ module Google # @return [Google::Apis::GmailV1::MessagePartBody] attr_accessor :body - # The filename of the attachment. Only present if this message part - # represents an attachment. + # The filename of the attachment. Only present if this message part represents + # an attachment. # Corresponds to the JSON property `filename` # @return [String] attr_accessor :filename # List of headers on this message part. For the top-level message part, - # representing the entire message payload, it will contain the standard - # RFC 2822 email headers such as To, From, and - # Subject. + # representing the entire message payload, it will contain the standard RFC 2822 + # email headers such as To, From, and Subject. # Corresponds to the JSON property `headers` # @return [Array] attr_accessor :headers @@ -1073,11 +1031,10 @@ module Google # @return [String] attr_accessor :part_id - # The child MIME message parts of this part. This only applies to container - # MIME message parts, for example multipart/*. For non- - # container MIME message part types, such as text/plain, this - # field is empty. For more information, see - # RFC 1521. + # The child MIME message parts of this part. This only applies to container MIME + # message parts, for example multipart/*. For non- container MIME message part + # types, such as text/plain, this field is empty. For more information, see RFC + # 1521. # Corresponds to the JSON property `parts` # @return [Array] attr_accessor :parts @@ -1101,19 +1058,17 @@ module Google class MessagePartBody include Google::Apis::Core::Hashable - # When present, contains the ID of an external attachment that can be - # retrieved in a separate messages.attachments.get request. - # When not present, the entire content of the message part body is - # contained in the data field. + # When present, contains the ID of an external attachment that can be retrieved + # in a separate messages.attachments.get request. When not present, the entire + # content of the message part body is contained in the data field. # Corresponds to the JSON property `attachmentId` # @return [String] attr_accessor :attachment_id - # The body data of a MIME message part as a base64url encoded string. - # May be empty for MIME container - # types that have no message body or when the body data is sent as a - # separate attachment. An attachment ID is present if the body data is - # contained in a separate attachment. + # The body data of a MIME message part as a base64url encoded string. May be + # empty for MIME container types that have no message body or when the body data + # is sent as a separate attachment. An attachment ID is present if the body data + # is contained in a separate attachment. # Corresponds to the JSON property `data` # NOTE: Values are automatically base64 encoded/decoded in the client library. # @return [String] @@ -1140,14 +1095,13 @@ module Google class MessagePartHeader include Google::Apis::Core::Hashable - # The name of the header before the : separator. For - # example, To. + # The name of the header before the : separator. For example, To. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name - # The value of the header after the : separator. For example, - # someuser@example.com. + # The value of the header after the : separator. For example, someuser@example. + # com. # Corresponds to the JSON property `value` # @return [String] attr_accessor :value @@ -1277,53 +1231,48 @@ module Google end # Settings associated with a send-as alias, which can be either the primary - # login address associated with the account or a custom "from" address. - # Send-as aliases correspond to the - # "Send Mail As" - # feature in the web interface. + # login address associated with the account or a custom "from" address. Send-as + # aliases correspond to the "Send Mail As" feature in the web interface. class SendAs include Google::Apis::Core::Hashable - # A name that appears in the "From:" header for mail sent using this alias. - # For custom "from" addresses, when this is empty, Gmail will populate the - # "From:" header with the name that is used for the primary address - # associated with the account. - # If the admin has disabled the ability for users to update their name - # format, requests to update this field for the primary login will silently - # fail. + # A name that appears in the "From:" header for mail sent using this alias. For + # custom "from" addresses, when this is empty, Gmail will populate the "From:" + # header with the name that is used for the primary address associated with the + # account. If the admin has disabled the ability for users to update their name + # format, requests to update this field for the primary login will silently fail. # Corresponds to the JSON property `displayName` # @return [String] attr_accessor :display_name - # Whether this address is selected as the default "From:" address in - # situations such as composing a new message or sending a vacation - # auto-reply. Every Gmail account has exactly one default send-as address, - # so the only legal value that clients may write to this field is - # true. Changing this from false to - # true for an address will result in this field becoming - # false for the other previous default address. + # Whether this address is selected as the default "From:" address in situations + # such as composing a new message or sending a vacation auto-reply. Every Gmail + # account has exactly one default send-as address, so the only legal value that + # clients may write to this field is true. Changing this from false to true for + # an address will result in this field becoming false for the other previous + # default address. # Corresponds to the JSON property `isDefault` # @return [Boolean] attr_accessor :is_default alias_method :is_default?, :is_default # Whether this address is the primary address used to login to the account. - # Every Gmail account has exactly one primary address, and it cannot be - # deleted from the collection of send-as aliases. This field is read-only. + # Every Gmail account has exactly one primary address, and it cannot be deleted + # from the collection of send-as aliases. This field is read-only. # Corresponds to the JSON property `isPrimary` # @return [Boolean] attr_accessor :is_primary alias_method :is_primary?, :is_primary # An optional email address that is included in a "Reply-To:" header for mail - # sent using this alias. If this is empty, Gmail will not generate a - # "Reply-To:" header. + # sent using this alias. If this is empty, Gmail will not generate a "Reply-To:" + # header. # Corresponds to the JSON property `replyToAddress` # @return [String] attr_accessor :reply_to_address - # The email address that appears in the "From:" header for mail sent using - # this alias. This is read-only for all operations except create. + # The email address that appears in the "From:" header for mail sent using this + # alias. This is read-only for all operations except create. # Corresponds to the JSON property `sendAsEmail` # @return [String] attr_accessor :send_as_email @@ -1339,16 +1288,15 @@ module Google # @return [Google::Apis::GmailV1::SmtpMsa] attr_accessor :smtp_msa - # Whether Gmail should - # treat this address as an alias for the user's primary email address. - # This setting only applies to custom "from" aliases. + # Whether Gmail should treat this address as an alias for the user's primary + # email address. This setting only applies to custom "from" aliases. # Corresponds to the JSON property `treatAsAlias` # @return [Boolean] attr_accessor :treat_as_alias alias_method :treat_as_alias?, :treat_as_alias - # Indicates whether this address has been verified for use as a send-as - # alias. Read-only. This setting only applies to custom "from" aliases. + # Indicates whether this address has been verified for use as a send-as alias. + # Read-only. This setting only applies to custom "from" aliases. # Corresponds to the JSON property `verificationStatus` # @return [String] attr_accessor :verification_status @@ -1401,18 +1349,18 @@ module Google # @return [String] attr_accessor :issuer_cn - # PEM formatted X509 concatenated certificate string (standard base64 - # encoding). Format used for returning key, which includes public key - # as well as certificate chain (not private key). + # PEM formatted X509 concatenated certificate string (standard base64 encoding). + # Format used for returning key, which includes public key as well as + # certificate chain (not private key). # Corresponds to the JSON property `pem` # @return [String] attr_accessor :pem - # PKCS#12 format containing a single private/public key pair and - # certificate chain. This format is only accepted from client - # for creating a new SmimeInfo and is never returned, because the - # private key is not intended to be exported. PKCS#12 may be encrypted, - # in which case encryptedKeyPassword should be set appropriately. + # PKCS#12 format containing a single private/public key pair and certificate + # chain. This format is only accepted from client for creating a new SmimeInfo + # and is never returned, because the private key is not intended to be exported. + # PKCS#12 may be encrypted, in which case encryptedKeyPassword should be set + # appropriately. # Corresponds to the JSON property `pkcs12` # NOTE: Values are automatically base64 encoded/decoded in the client library. # @return [String] @@ -1438,32 +1386,32 @@ module Google class SmtpMsa include Google::Apis::Core::Hashable - # The hostname of the SMTP service. Required. + # The hostname of the SMTP service. Required. # Corresponds to the JSON property `host` # @return [String] attr_accessor :host - # The password that will be used for authentication with the SMTP service. - # This is a write-only field that can be specified in requests to create or - # update SendAs settings; it is never populated in responses. + # The password that will be used for authentication with the SMTP service. This + # is a write-only field that can be specified in requests to create or update + # SendAs settings; it is never populated in responses. # Corresponds to the JSON property `password` # @return [String] attr_accessor :password - # The port of the SMTP service. Required. + # The port of the SMTP service. Required. # Corresponds to the JSON property `port` # @return [Fixnum] attr_accessor :port - # The protocol that will be used to secure communication with the SMTP - # service. Required. + # The protocol that will be used to secure communication with the SMTP service. + # Required. # Corresponds to the JSON property `securityMode` # @return [String] attr_accessor :security_mode - # The username that will be used for authentication with the SMTP service. - # This is a write-only field that can be specified in requests to create or - # update SendAs settings; it is never populated in responses. + # The username that will be used for authentication with the SMTP service. This + # is a write-only field that can be specified in requests to create or update + # SendAs settings; it is never populated in responses. # Corresponds to the JSON property `username` # @return [String] attr_accessor :username @@ -1519,9 +1467,8 @@ module Google end end - # Vacation auto-reply settings for an account. These settings correspond to - # the "Vacation - # responder" feature in the web interface. + # Vacation auto-reply settings for an account. These settings correspond to the " + # Vacation responder" feature in the web interface. class VacationSettings include Google::Apis::Core::Hashable @@ -1531,17 +1478,15 @@ module Google attr_accessor :enable_auto_reply alias_method :enable_auto_reply?, :enable_auto_reply - # An optional end time for sending auto-replies (epoch ms). - # When this is specified, Gmail will automatically reply only to messages - # that it receives before the end time. If both startTime and - # endTime are specified, startTime must precede - # endTime. + # An optional end time for sending auto-replies (epoch ms). When this is + # specified, Gmail will automatically reply only to messages that it receives + # before the end time. If both startTime and endTime are specified, startTime + # must precede endTime. # Corresponds to the JSON property `endTime` # @return [Fixnum] attr_accessor :end_time - # Response body in HTML format. Gmail will sanitize the HTML before - # storing it. + # Response body in HTML format. Gmail will sanitize the HTML before storing it. # Corresponds to the JSON property `responseBodyHtml` # @return [String] attr_accessor :response_body_html @@ -1551,33 +1496,31 @@ module Google # @return [String] attr_accessor :response_body_plain_text - # Optional text to prepend to the subject line in vacation responses. In - # order to enable auto-replies, either the response subject or the response - # body must be nonempty. + # Optional text to prepend to the subject line in vacation responses. In order + # to enable auto-replies, either the response subject or the response body must + # be nonempty. # Corresponds to the JSON property `responseSubject` # @return [String] attr_accessor :response_subject - # Flag that determines whether responses are sent to recipients who are not - # in the user's list of contacts. + # Flag that determines whether responses are sent to recipients who are not in + # the user's list of contacts. # Corresponds to the JSON property `restrictToContacts` # @return [Boolean] attr_accessor :restrict_to_contacts alias_method :restrict_to_contacts?, :restrict_to_contacts - # Flag that determines whether responses are sent to recipients who are - # outside of the user's domain. This feature is only available for G Suite - # users. + # Flag that determines whether responses are sent to recipients who are outside + # of the user's domain. This feature is only available for G Suite users. # Corresponds to the JSON property `restrictToDomain` # @return [Boolean] attr_accessor :restrict_to_domain alias_method :restrict_to_domain?, :restrict_to_domain - # An optional start time for sending auto-replies (epoch ms). - # When this is specified, Gmail will automatically reply only to messages - # that it receives after the start time. If both startTime and - # endTime are specified, startTime must precede - # endTime. + # An optional start time for sending auto-replies (epoch ms). When this is + # specified, Gmail will automatically reply only to messages that it receives + # after the start time. If both startTime and endTime are specified, startTime + # must precede endTime. # Corresponds to the JSON property `startTime` # @return [Fixnum] attr_accessor :start_time @@ -1608,21 +1551,20 @@ module Google # @return [String] attr_accessor :label_filter_action - # List of label_ids to restrict notifications about. By default, - # if unspecified, all changes are pushed out. If specified then - # dictates which labels are required for a push notification to - # be generated. + # List of label_ids to restrict notifications about. By default, if unspecified, + # all changes are pushed out. If specified then dictates which labels are + # required for a push notification to be generated. # Corresponds to the JSON property `labelIds` # @return [Array] attr_accessor :label_ids - # A fully qualified Google Cloud Pub/Sub API topic name to publish the - # events to. This topic name **must** already exist in Cloud Pub/Sub and - # you **must** have already granted gmail "publish" permission on it. - # For example, "projects/my-project-identifier/topics/my-topic-name" - # (using the Cloud Pub/Sub "v1" topic naming format). - # Note that the "my-project-identifier" portion must exactly match your - # Google developer project id (the one executing this watch request). + # A fully qualified Google Cloud Pub/Sub API topic name to publish the events to. + # This topic name **must** already exist in Cloud Pub/Sub and you **must** have + # already granted gmail "publish" permission on it. For example, "projects/my- + # project-identifier/topics/my-topic-name" (using the Cloud Pub/Sub "v1" topic + # naming format). + # Note that the "my-project-identifier" portion must exactly match your Google + # developer project id (the one executing this watch request). # Corresponds to the JSON property `topicName` # @return [String] attr_accessor :topic_name @@ -1643,9 +1585,8 @@ module Google class WatchResponse include Google::Apis::Core::Hashable - # When Gmail will stop sending notifications for mailbox updates - # (epoch millis). Call watch again before this time to renew - # the watch. + # When Gmail will stop sending notifications for mailbox updates (epoch millis). + # Call watch again before this time to renew the watch. # Corresponds to the JSON property `expiration` # @return [Fixnum] attr_accessor :expiration diff --git a/generated/google/apis/gmail_v1/service.rb b/generated/google/apis/gmail_v1/service.rb index 59625b461..980b56899 100644 --- a/generated/google/apis/gmail_v1/service.rb +++ b/generated/google/apis/gmail_v1/service.rb @@ -22,8 +22,7 @@ module Google module GmailV1 # Gmail API # - # The Gmail API lets you view and manage Gmail mailbox data like - # threads, messages, and labels. + # Access Gmail mailboxes including sending user email. # # @example # require 'google/apis/gmail_v1' @@ -39,24 +38,30 @@ module Google 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. + # An opaque string that represents a user for quota purposes. Must not exceed 40 + # characters. attr_accessor :quota_user + # @return [String] + # Deprecated. Please use quotaUser instead. + attr_accessor :user_ip + def initialize - super('https://www.googleapis.com/', '') - @batch_path = 'batch' + super('https://www.googleapis.com/', 'gmail/v1/users/') + @batch_path = 'batch/gmail/v1' end # Gets the current user's Gmail profile. # @param [String] user_id - # The user's email address. The special value me - # can be used to indicate the authenticated user. + # The user's email address. The special value me can be used to indicate the + # authenticated user. # @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. + # An opaque string that represents a user for quota purposes. Must not exceed 40 + # characters. + # @param [String] user_ip + # Deprecated. Please use quotaUser instead. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -69,25 +74,28 @@ module Google # @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_user_profile(user_id, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:get, 'gmail/v1/users/{userId}/profile', options) + def get_user_profile(user_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:get, '{userId}/profile', options) command.response_representation = Google::Apis::GmailV1::Profile::Representation command.response_class = Google::Apis::GmailV1::Profile command.params['userId'] = user_id unless user_id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end # Stop receiving push notifications for the given user mailbox. # @param [String] user_id - # The user's email address. The special value me - # can be used to indicate the authenticated user. + # The user's email address. The special value me can be used to indicate the + # authenticated user. # @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. + # An opaque string that represents a user for quota purposes. Must not exceed 40 + # characters. + # @param [String] user_ip + # Deprecated. Please use quotaUser instead. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -100,24 +108,27 @@ module Google # @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 stop_user(user_id, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:post, 'gmail/v1/users/{userId}/stop', options) + def stop_user(user_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:post, '{userId}/stop', options) command.params['userId'] = user_id unless user_id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end # Set up or update a push notification watch on the given user mailbox. # @param [String] user_id - # The user's email address. The special value me - # can be used to indicate the authenticated user. + # The user's email address. The special value me can be used to indicate the + # authenticated user. # @param [Google::Apis::GmailV1::WatchRequest] watch_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. + # An opaque string that represents a user for quota purposes. Must not exceed 40 + # characters. + # @param [String] user_ip + # Deprecated. Please use quotaUser instead. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -130,8 +141,8 @@ module Google # @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 watch_user(user_id, watch_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:post, 'gmail/v1/users/{userId}/watch', options) + def watch_user(user_id, watch_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:post, '{userId}/watch', options) command.request_representation = Google::Apis::GmailV1::WatchRequest::Representation command.request_object = watch_request_object command.response_representation = Google::Apis::GmailV1::WatchResponse::Representation @@ -139,19 +150,22 @@ module Google command.params['userId'] = user_id unless user_id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end - # Creates a new draft with the DRAFT label. + # Creates a new draft with the DRAFT label. # @param [String] user_id - # The user's email address. The special value me - # can be used to indicate the authenticated user. + # The user's email address. The special value me can be used to indicate the + # authenticated user. # @param [Google::Apis::GmailV1::Draft] draft_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. + # An opaque string that represents a user for quota purposes. Must not exceed 40 + # characters. + # @param [String] user_ip + # Deprecated. Please use quotaUser instead. # @param [IO, String] upload_source # IO stream or filename containing content to upload # @param [String] content_type @@ -168,11 +182,11 @@ module Google # @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_user_draft(user_id, draft_object = nil, fields: nil, quota_user: nil, upload_source: nil, content_type: nil, options: nil, &block) + def create_user_draft(user_id, draft_object = nil, fields: nil, quota_user: nil, user_ip: nil, upload_source: nil, content_type: nil, options: nil, &block) if upload_source.nil? - command = make_simple_command(:post, 'gmail/v1/users/{userId}/drafts', options) + command = make_simple_command(:post, '{userId}/drafts', options) else - command = make_upload_command(:post, 'gmail/v1/users/{userId}/drafts', options) + command = make_upload_command(:post, '{userId}/drafts', options) command.upload_source = upload_source command.upload_content_type = content_type end @@ -183,21 +197,24 @@ module Google command.params['userId'] = user_id unless user_id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end - # Immediately and permanently deletes the specified draft. - # Does not simply trash it. + # Immediately and permanently deletes the specified draft. Does not simply trash + # it. # @param [String] user_id - # The user's email address. The special value me - # can be used to indicate the authenticated user. + # The user's email address. The special value me can be used to indicate the + # authenticated user. # @param [String] id # The ID of the draft to delete. # @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. + # An opaque string that represents a user for quota purposes. Must not exceed 40 + # characters. + # @param [String] user_ip + # Deprecated. Please use quotaUser instead. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -210,19 +227,20 @@ module Google # @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_user_draft(user_id, id, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:delete, 'gmail/v1/users/{userId}/drafts/{id}', options) + def delete_user_draft(user_id, id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:delete, '{userId}/drafts/{id}', options) command.params['userId'] = user_id unless user_id.nil? command.params['id'] = id unless id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end # Gets the specified draft. # @param [String] user_id - # The user's email address. The special value me - # can be used to indicate the authenticated user. + # The user's email address. The special value me can be used to indicate the + # authenticated user. # @param [String] id # The ID of the draft to retrieve. # @param [String] format @@ -230,8 +248,10 @@ module Google # @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. + # An opaque string that represents a user for quota purposes. Must not exceed 40 + # characters. + # @param [String] user_ip + # Deprecated. Please use quotaUser instead. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -244,8 +264,8 @@ module Google # @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_user_draft(user_id, id, format: nil, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:get, 'gmail/v1/users/{userId}/drafts/{id}', options) + def get_user_draft(user_id, id, format: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:get, '{userId}/drafts/{id}', options) command.response_representation = Google::Apis::GmailV1::Draft::Representation command.response_class = Google::Apis::GmailV1::Draft command.params['userId'] = user_id unless user_id.nil? @@ -253,30 +273,31 @@ module Google command.query['format'] = format unless format.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end # Lists the drafts in the user's mailbox. # @param [String] user_id - # The user's email address. The special value me - # can be used to indicate the authenticated user. + # The user's email address. The special value me can be used to indicate the + # authenticated user. # @param [Boolean] include_spam_trash - # Include drafts from SPAM and TRASH - # in the results. + # Include drafts from SPAM and TRASH in the results. # @param [Fixnum] max_results # Maximum number of drafts to return. # @param [String] page_token # Page token to retrieve a specific page of results in the list. # @param [String] q # Only return draft messages matching the specified query. Supports the same - # query format as the Gmail search box. For example, - # "from:someuser@example.com rfc822msgid: - # is:unread". + # query format as the Gmail search box. For example, "from:someuser@example.com + # rfc822msgid: is:unread". # @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. + # An opaque string that represents a user for quota purposes. Must not exceed 40 + # characters. + # @param [String] user_ip + # Deprecated. Please use quotaUser instead. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -289,8 +310,8 @@ module Google # @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_user_drafts(user_id, include_spam_trash: nil, max_results: nil, page_token: nil, q: nil, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:get, 'gmail/v1/users/{userId}/drafts', options) + def list_user_drafts(user_id, include_spam_trash: nil, max_results: nil, page_token: nil, q: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:get, '{userId}/drafts', options) command.response_representation = Google::Apis::GmailV1::ListDraftsResponse::Representation command.response_class = Google::Apis::GmailV1::ListDraftsResponse command.params['userId'] = user_id unless user_id.nil? @@ -300,20 +321,23 @@ module Google command.query['q'] = q unless q.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end - # Sends the specified, existing draft to the recipients in the - # To, Cc, and Bcc headers. + # Sends the specified, existing draft to the recipients in the To, Cc, and Bcc + # headers. # @param [String] user_id - # The user's email address. The special value me - # can be used to indicate the authenticated user. + # The user's email address. The special value me can be used to indicate the + # authenticated user. # @param [Google::Apis::GmailV1::Draft] draft_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. + # An opaque string that represents a user for quota purposes. Must not exceed 40 + # characters. + # @param [String] user_ip + # Deprecated. Please use quotaUser instead. # @param [IO, String] upload_source # IO stream or filename containing content to upload # @param [String] content_type @@ -330,11 +354,11 @@ module Google # @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 send_user_draft(user_id, draft_object = nil, fields: nil, quota_user: nil, upload_source: nil, content_type: nil, options: nil, &block) + def send_user_draft(user_id, draft_object = nil, fields: nil, quota_user: nil, user_ip: nil, upload_source: nil, content_type: nil, options: nil, &block) if upload_source.nil? - command = make_simple_command(:post, 'gmail/v1/users/{userId}/drafts/send', options) + command = make_simple_command(:post, '{userId}/drafts/send', options) else - command = make_upload_command(:post, 'gmail/v1/users/{userId}/drafts/send', options) + command = make_upload_command(:post, '{userId}/drafts/send', options) command.upload_source = upload_source command.upload_content_type = content_type end @@ -345,21 +369,24 @@ module Google command.params['userId'] = user_id unless user_id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end # Replaces a draft's content. # @param [String] user_id - # The user's email address. The special value me - # can be used to indicate the authenticated user. + # The user's email address. The special value me can be used to indicate the + # authenticated user. # @param [String] id # The ID of the draft to update. # @param [Google::Apis::GmailV1::Draft] draft_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. + # An opaque string that represents a user for quota purposes. Must not exceed 40 + # characters. + # @param [String] user_ip + # Deprecated. Please use quotaUser instead. # @param [IO, String] upload_source # IO stream or filename containing content to upload # @param [String] content_type @@ -376,11 +403,11 @@ module Google # @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_user_draft(user_id, id, draft_object = nil, fields: nil, quota_user: nil, upload_source: nil, content_type: nil, options: nil, &block) + def update_user_draft(user_id, id, draft_object = nil, fields: nil, quota_user: nil, user_ip: nil, upload_source: nil, content_type: nil, options: nil, &block) if upload_source.nil? - command = make_simple_command(:put, 'gmail/v1/users/{userId}/drafts/{id}', options) + command = make_simple_command(:put, '{userId}/drafts/{id}', options) else - command = make_upload_command(:put, 'gmail/v1/users/{userId}/drafts/{id}', options) + command = make_upload_command(:put, '{userId}/drafts/{id}', options) command.upload_source = upload_source command.upload_content_type = content_type end @@ -392,14 +419,15 @@ module Google command.params['id'] = id unless id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end # Lists the history of all changes to the given mailbox. History results are - # returned in chronological order (increasing historyId). + # returned in chronological order (increasing historyId). # @param [String] user_id - # The user's email address. The special value me - # can be used to indicate the authenticated user. + # The user's email address. The special value me can be used to indicate the + # authenticated user. # @param [Array, String] history_types # History types to be returned by the function # @param [String] label_id @@ -409,24 +437,23 @@ module Google # @param [String] page_token # Page token to retrieve a specific page of results in the list. # @param [Fixnum] start_history_id - # Required. Returns history records after the specified - # startHistoryId. The supplied startHistoryId - # should be obtained from the historyId of a message, thread, or - # previous list response. History IDs increase - # chronologically but are not contiguous with random gaps in between valid - # IDs. Supplying an invalid or out of date startHistoryId - # typically returns an HTTP 404 error code. A - # historyId is typically valid for at least a week, but in some - # rare circumstances may be valid for only a few hours. If you receive an - # HTTP 404 error response, your application should perform a - # full sync. If you receive no nextPageToken in the response, - # there are no updates to retrieve and you can store the returned - # historyId for a future request. + # Required. Returns history records after the specified startHistoryId. The + # supplied startHistoryId should be obtained from the historyId of a message, + # thread, or previous list response. History IDs increase chronologically but + # are not contiguous with random gaps in between valid IDs. Supplying an invalid + # or out of date startHistoryId typically returns an HTTP 404 error code. A + # historyId is typically valid for at least a week, but in some rare + # circumstances may be valid for only a few hours. If you receive an HTTP 404 + # error response, your application should perform a full sync. If you receive no + # nextPageToken in the response, there are no updates to retrieve and you can + # store the returned historyId for a future request. # @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. + # An opaque string that represents a user for quota purposes. Must not exceed 40 + # characters. + # @param [String] user_ip + # Deprecated. Please use quotaUser instead. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -439,8 +466,8 @@ module Google # @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_user_histories(user_id, history_types: nil, label_id: nil, max_results: nil, page_token: nil, start_history_id: nil, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:get, 'gmail/v1/users/{userId}/history', options) + def list_user_histories(user_id, history_types: nil, label_id: nil, max_results: nil, page_token: nil, start_history_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:get, '{userId}/history', options) command.response_representation = Google::Apis::GmailV1::ListHistoryResponse::Representation command.response_class = Google::Apis::GmailV1::ListHistoryResponse command.params['userId'] = user_id unless user_id.nil? @@ -451,19 +478,22 @@ module Google command.query['startHistoryId'] = start_history_id unless start_history_id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end # Creates a new label. # @param [String] user_id - # The user's email address. The special value me - # can be used to indicate the authenticated user. + # The user's email address. The special value me can be used to indicate the + # authenticated user. # @param [Google::Apis::GmailV1::Label] label_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. + # An opaque string that represents a user for quota purposes. Must not exceed 40 + # characters. + # @param [String] user_ip + # Deprecated. Please use quotaUser instead. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -476,8 +506,8 @@ module Google # @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_user_label(user_id, label_object = nil, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:post, 'gmail/v1/users/{userId}/labels', options) + def create_user_label(user_id, label_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:post, '{userId}/labels', options) command.request_representation = Google::Apis::GmailV1::Label::Representation command.request_object = label_object command.response_representation = Google::Apis::GmailV1::Label::Representation @@ -485,21 +515,24 @@ module Google command.params['userId'] = user_id unless user_id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end # Immediately and permanently deletes the specified label and removes it from # any messages and threads that it is applied to. # @param [String] user_id - # The user's email address. The special value me - # can be used to indicate the authenticated user. + # The user's email address. The special value me can be used to indicate the + # authenticated user. # @param [String] id # The ID of the label to delete. # @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. + # An opaque string that represents a user for quota purposes. Must not exceed 40 + # characters. + # @param [String] user_ip + # Deprecated. Please use quotaUser instead. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -512,26 +545,29 @@ module Google # @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_user_label(user_id, id, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:delete, 'gmail/v1/users/{userId}/labels/{id}', options) + def delete_user_label(user_id, id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:delete, '{userId}/labels/{id}', options) command.params['userId'] = user_id unless user_id.nil? command.params['id'] = id unless id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end # Gets the specified label. # @param [String] user_id - # The user's email address. The special value me - # can be used to indicate the authenticated user. + # The user's email address. The special value me can be used to indicate the + # authenticated user. # @param [String] id # The ID of the label to retrieve. # @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. + # An opaque string that represents a user for quota purposes. Must not exceed 40 + # characters. + # @param [String] user_ip + # Deprecated. Please use quotaUser instead. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -544,26 +580,29 @@ module Google # @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_user_label(user_id, id, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:get, 'gmail/v1/users/{userId}/labels/{id}', options) + def get_user_label(user_id, id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:get, '{userId}/labels/{id}', options) command.response_representation = Google::Apis::GmailV1::Label::Representation command.response_class = Google::Apis::GmailV1::Label command.params['userId'] = user_id unless user_id.nil? command.params['id'] = id unless id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end # Lists all labels in the user's mailbox. # @param [String] user_id - # The user's email address. The special value me - # can be used to indicate the authenticated user. + # The user's email address. The special value me can be used to indicate the + # authenticated user. # @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. + # An opaque string that represents a user for quota purposes. Must not exceed 40 + # characters. + # @param [String] user_ip + # Deprecated. Please use quotaUser instead. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -576,28 +615,31 @@ module Google # @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_user_labels(user_id, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:get, 'gmail/v1/users/{userId}/labels', options) + def list_user_labels(user_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:get, '{userId}/labels', options) command.response_representation = Google::Apis::GmailV1::ListLabelsResponse::Representation command.response_class = Google::Apis::GmailV1::ListLabelsResponse command.params['userId'] = user_id unless user_id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end - # Patch the specified label. + # Updates the specified label. This method supports patch semantics. # @param [String] user_id - # The user's email address. The special value me - # can be used to indicate the authenticated user. + # The user's email address. The special value me can be used to indicate the + # authenticated user. # @param [String] id # The ID of the label to update. # @param [Google::Apis::GmailV1::Label] label_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. + # An opaque string that represents a user for quota purposes. Must not exceed 40 + # characters. + # @param [String] user_ip + # Deprecated. Please use quotaUser instead. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -610,8 +652,8 @@ module Google # @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 patch_user_label(user_id, id, label_object = nil, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:patch, 'gmail/v1/users/{userId}/labels/{id}', options) + def patch_user_label(user_id, id, label_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:patch, '{userId}/labels/{id}', options) command.request_representation = Google::Apis::GmailV1::Label::Representation command.request_object = label_object command.response_representation = Google::Apis::GmailV1::Label::Representation @@ -620,21 +662,24 @@ module Google command.params['id'] = id unless id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end # Updates the specified label. # @param [String] user_id - # The user's email address. The special value me - # can be used to indicate the authenticated user. + # The user's email address. The special value me can be used to indicate the + # authenticated user. # @param [String] id # The ID of the label to update. # @param [Google::Apis::GmailV1::Label] label_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. + # An opaque string that represents a user for quota purposes. Must not exceed 40 + # characters. + # @param [String] user_ip + # Deprecated. Please use quotaUser instead. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -647,8 +692,8 @@ module Google # @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_user_label(user_id, id, label_object = nil, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:put, 'gmail/v1/users/{userId}/labels/{id}', options) + def update_user_label(user_id, id, label_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:put, '{userId}/labels/{id}', options) command.request_representation = Google::Apis::GmailV1::Label::Representation command.request_object = label_object command.response_representation = Google::Apis::GmailV1::Label::Representation @@ -657,20 +702,23 @@ module Google command.params['id'] = id unless id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end - # Deletes many messages by message ID. Provides no guarantees that messages - # were not already deleted or even existed at all. + # Deletes many messages by message ID. Provides no guarantees that messages were + # not already deleted or even existed at all. # @param [String] user_id - # The user's email address. The special value me - # can be used to indicate the authenticated user. + # The user's email address. The special value me can be used to indicate the + # authenticated user. # @param [Google::Apis::GmailV1::BatchDeleteMessagesRequest] batch_delete_messages_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. + # An opaque string that represents a user for quota purposes. Must not exceed 40 + # characters. + # @param [String] user_ip + # Deprecated. Please use quotaUser instead. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -683,26 +731,29 @@ module Google # @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 batch_delete_messages(user_id, batch_delete_messages_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:post, 'gmail/v1/users/{userId}/messages/batchDelete', options) + def batch_delete_messages(user_id, batch_delete_messages_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:post, '{userId}/messages/batchDelete', options) command.request_representation = Google::Apis::GmailV1::BatchDeleteMessagesRequest::Representation command.request_object = batch_delete_messages_request_object command.params['userId'] = user_id unless user_id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end # Modifies the labels on the specified messages. # @param [String] user_id - # The user's email address. The special value me - # can be used to indicate the authenticated user. + # The user's email address. The special value me can be used to indicate the + # authenticated user. # @param [Google::Apis::GmailV1::BatchModifyMessagesRequest] batch_modify_messages_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. + # An opaque string that represents a user for quota purposes. Must not exceed 40 + # characters. + # @param [String] user_ip + # Deprecated. Please use quotaUser instead. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -715,28 +766,31 @@ module Google # @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 batch_modify_messages(user_id, batch_modify_messages_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:post, 'gmail/v1/users/{userId}/messages/batchModify', options) + def batch_modify_messages(user_id, batch_modify_messages_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:post, '{userId}/messages/batchModify', options) command.request_representation = Google::Apis::GmailV1::BatchModifyMessagesRequest::Representation command.request_object = batch_modify_messages_request_object command.params['userId'] = user_id unless user_id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end # Immediately and permanently deletes the specified message. This operation - # cannot be undone. Prefer messages.trash instead. + # cannot be undone. Prefer messages.trash instead. # @param [String] user_id - # The user's email address. The special value me - # can be used to indicate the authenticated user. + # The user's email address. The special value me can be used to indicate the + # authenticated user. # @param [String] id # The ID of the message to delete. # @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. + # An opaque string that represents a user for quota purposes. Must not exceed 40 + # characters. + # @param [String] user_ip + # Deprecated. Please use quotaUser instead. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -749,19 +803,20 @@ module Google # @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_user_message(user_id, id, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:delete, 'gmail/v1/users/{userId}/messages/{id}', options) + def delete_user_message(user_id, id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:delete, '{userId}/messages/{id}', options) command.params['userId'] = user_id unless user_id.nil? command.params['id'] = id unless id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end # Gets the specified message. # @param [String] user_id - # The user's email address. The special value me - # can be used to indicate the authenticated user. + # The user's email address. The special value me can be used to indicate the + # authenticated user. # @param [String] id # The ID of the message to retrieve. # @param [String] format @@ -771,8 +826,10 @@ module Google # @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. + # An opaque string that represents a user for quota purposes. Must not exceed 40 + # characters. + # @param [String] user_ip + # Deprecated. Please use quotaUser instead. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -785,8 +842,8 @@ module Google # @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_user_message(user_id, id, format: nil, metadata_headers: nil, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:get, 'gmail/v1/users/{userId}/messages/{id}', options) + def get_user_message(user_id, id, format: nil, metadata_headers: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:get, '{userId}/messages/{id}', options) command.response_representation = Google::Apis::GmailV1::Message::Representation command.response_class = Google::Apis::GmailV1::Message command.params['userId'] = user_id unless user_id.nil? @@ -795,34 +852,35 @@ module Google command.query['metadataHeaders'] = metadata_headers unless metadata_headers.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end - # Imports a message into only this user's mailbox, with standard - # email delivery scanning and classification similar to receiving via SMTP. - # Does not send a message. + # Imports a message into only this user's mailbox, with standard email delivery + # scanning and classification similar to receiving via SMTP. Does not send a + # message. # @param [String] user_id - # The user's email address. The special value me - # can be used to indicate the authenticated user. + # The user's email address. The special value me can be used to indicate the + # authenticated user. # @param [Google::Apis::GmailV1::Message] message_object # @param [Boolean] deleted - # Mark the email as permanently deleted (not TRASH) and - # only visible in - # Google Vault to - # a Vault administrator. Only used for G Suite accounts. + # Mark the email as permanently deleted (not TRASH) and only visible in Google + # Vault to a Vault administrator. Only used for G Suite accounts. # @param [String] internal_date_source # Source for Gmail's internal date of the message. # @param [Boolean] never_mark_spam - # Ignore the Gmail spam classifier decision and never mark - # this email as SPAM in the mailbox. + # Ignore the Gmail spam classifier decision and never mark this email as SPAM in + # the mailbox. # @param [Boolean] process_for_calendar - # Process calendar invites in the email and add any extracted - # meetings to the Google Calendar for this user. + # Process calendar invites in the email and add any extracted meetings to the + # Google Calendar for this user. # @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. + # An opaque string that represents a user for quota purposes. Must not exceed 40 + # characters. + # @param [String] user_ip + # Deprecated. Please use quotaUser instead. # @param [IO, String] upload_source # IO stream or filename containing content to upload # @param [String] content_type @@ -839,11 +897,11 @@ module Google # @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 import_user_message(user_id, message_object = nil, deleted: nil, internal_date_source: nil, never_mark_spam: nil, process_for_calendar: nil, fields: nil, quota_user: nil, upload_source: nil, content_type: nil, options: nil, &block) + def import_user_message(user_id, message_object = nil, deleted: nil, internal_date_source: nil, never_mark_spam: nil, process_for_calendar: nil, fields: nil, quota_user: nil, user_ip: nil, upload_source: nil, content_type: nil, options: nil, &block) if upload_source.nil? - command = make_simple_command(:post, 'gmail/v1/users/{userId}/messages/import', options) + command = make_simple_command(:post, '{userId}/messages/import', options) else - command = make_upload_command(:post, 'gmail/v1/users/{userId}/messages/import', options) + command = make_upload_command(:post, '{userId}/messages/import', options) command.upload_source = upload_source command.upload_content_type = content_type end @@ -858,28 +916,28 @@ module Google command.query['processForCalendar'] = process_for_calendar unless process_for_calendar.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end - # Directly inserts a message into only this user's mailbox similar to - # IMAP APPEND, bypassing most scanning and classification. - # Does not send a message. + # Directly inserts a message into only this user's mailbox similar to IMAP + # APPEND, bypassing most scanning and classification. Does not send a message. # @param [String] user_id - # The user's email address. The special value me - # can be used to indicate the authenticated user. + # The user's email address. The special value me can be used to indicate the + # authenticated user. # @param [Google::Apis::GmailV1::Message] message_object # @param [Boolean] deleted - # Mark the email as permanently deleted (not TRASH) and - # only visible in - # Google Vault to - # a Vault administrator. Only used for G Suite accounts. + # Mark the email as permanently deleted (not TRASH) and only visible in Google + # Vault to a Vault administrator. Only used for G Suite accounts. # @param [String] internal_date_source # Source for Gmail's internal date of the message. # @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. + # An opaque string that represents a user for quota purposes. Must not exceed 40 + # characters. + # @param [String] user_ip + # Deprecated. Please use quotaUser instead. # @param [IO, String] upload_source # IO stream or filename containing content to upload # @param [String] content_type @@ -896,11 +954,11 @@ module Google # @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 insert_user_message(user_id, message_object = nil, deleted: nil, internal_date_source: nil, fields: nil, quota_user: nil, upload_source: nil, content_type: nil, options: nil, &block) + def insert_user_message(user_id, message_object = nil, deleted: nil, internal_date_source: nil, fields: nil, quota_user: nil, user_ip: nil, upload_source: nil, content_type: nil, options: nil, &block) if upload_source.nil? - command = make_simple_command(:post, 'gmail/v1/users/{userId}/messages', options) + command = make_simple_command(:post, '{userId}/messages', options) else - command = make_upload_command(:post, 'gmail/v1/users/{userId}/messages', options) + command = make_upload_command(:post, '{userId}/messages', options) command.upload_source = upload_source command.upload_content_type = content_type end @@ -913,16 +971,16 @@ module Google command.query['internalDateSource'] = internal_date_source unless internal_date_source.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end # Lists the messages in the user's mailbox. # @param [String] user_id - # The user's email address. The special value me - # can be used to indicate the authenticated user. + # The user's email address. The special value me can be used to indicate the + # authenticated user. # @param [Boolean] include_spam_trash - # Include messages from SPAM and TRASH - # in the results. + # Include messages from SPAM and TRASH in the results. # @param [Array, String] label_ids # Only return messages with labels that match all of the specified label IDs. # @param [Fixnum] max_results @@ -930,16 +988,17 @@ module Google # @param [String] page_token # Page token to retrieve a specific page of results in the list. # @param [String] q - # Only return messages matching the specified query. Supports the same - # query format as the Gmail search box. For example, - # "from:someuser@example.com rfc822msgid:<somemsgid@example.com> - # is:unread". Parameter cannot be used when accessing the api - # using the gmail.metadata scope. + # Only return messages matching the specified query. Supports the same query + # format as the Gmail search box. For example, "from:someuser@example.com + # rfc822msgid: is:unread". Parameter cannot be used when + # accessing the api using the gmail.metadata scope. # @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. + # An opaque string that represents a user for quota purposes. Must not exceed 40 + # characters. + # @param [String] user_ip + # Deprecated. Please use quotaUser instead. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -952,8 +1011,8 @@ module Google # @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_user_messages(user_id, include_spam_trash: nil, label_ids: nil, max_results: nil, page_token: nil, q: nil, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:get, 'gmail/v1/users/{userId}/messages', options) + def list_user_messages(user_id, include_spam_trash: nil, label_ids: nil, max_results: nil, page_token: nil, q: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:get, '{userId}/messages', options) command.response_representation = Google::Apis::GmailV1::ListMessagesResponse::Representation command.response_class = Google::Apis::GmailV1::ListMessagesResponse command.params['userId'] = user_id unless user_id.nil? @@ -964,21 +1023,24 @@ module Google command.query['q'] = q unless q.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end # Modifies the labels on the specified message. # @param [String] user_id - # The user's email address. The special value me - # can be used to indicate the authenticated user. + # The user's email address. The special value me can be used to indicate the + # authenticated user. # @param [String] id # The ID of the message to modify. # @param [Google::Apis::GmailV1::ModifyMessageRequest] modify_message_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. + # An opaque string that represents a user for quota purposes. Must not exceed 40 + # characters. + # @param [String] user_ip + # Deprecated. Please use quotaUser instead. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -991,8 +1053,8 @@ module Google # @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 modify_message(user_id, id, modify_message_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:post, 'gmail/v1/users/{userId}/messages/{id}/modify', options) + def modify_message(user_id, id, modify_message_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:post, '{userId}/messages/{id}/modify', options) command.request_representation = Google::Apis::GmailV1::ModifyMessageRequest::Representation command.request_object = modify_message_request_object command.response_representation = Google::Apis::GmailV1::Message::Representation @@ -1001,20 +1063,22 @@ module Google command.params['id'] = id unless id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end - # Sends the specified message to the recipients in the - # To, Cc, and Bcc headers. + # Sends the specified message to the recipients in the To, Cc, and Bcc headers. # @param [String] user_id - # The user's email address. The special value me - # can be used to indicate the authenticated user. + # The user's email address. The special value me can be used to indicate the + # authenticated user. # @param [Google::Apis::GmailV1::Message] message_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. + # An opaque string that represents a user for quota purposes. Must not exceed 40 + # characters. + # @param [String] user_ip + # Deprecated. Please use quotaUser instead. # @param [IO, String] upload_source # IO stream or filename containing content to upload # @param [String] content_type @@ -1031,11 +1095,11 @@ module Google # @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 send_user_message(user_id, message_object = nil, fields: nil, quota_user: nil, upload_source: nil, content_type: nil, options: nil, &block) + def send_user_message(user_id, message_object = nil, fields: nil, quota_user: nil, user_ip: nil, upload_source: nil, content_type: nil, options: nil, &block) if upload_source.nil? - command = make_simple_command(:post, 'gmail/v1/users/{userId}/messages/send', options) + command = make_simple_command(:post, '{userId}/messages/send', options) else - command = make_upload_command(:post, 'gmail/v1/users/{userId}/messages/send', options) + command = make_upload_command(:post, '{userId}/messages/send', options) command.upload_source = upload_source command.upload_content_type = content_type end @@ -1046,20 +1110,23 @@ module Google command.params['userId'] = user_id unless user_id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end # Moves the specified message to the trash. # @param [String] user_id - # The user's email address. The special value me - # can be used to indicate the authenticated user. + # The user's email address. The special value me can be used to indicate the + # authenticated user. # @param [String] id # The ID of the message to Trash. # @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. + # An opaque string that represents a user for quota purposes. Must not exceed 40 + # characters. + # @param [String] user_ip + # Deprecated. Please use quotaUser instead. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -1072,28 +1139,31 @@ module Google # @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 trash_user_message(user_id, id, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:post, 'gmail/v1/users/{userId}/messages/{id}/trash', options) + def trash_user_message(user_id, id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:post, '{userId}/messages/{id}/trash', options) command.response_representation = Google::Apis::GmailV1::Message::Representation command.response_class = Google::Apis::GmailV1::Message command.params['userId'] = user_id unless user_id.nil? command.params['id'] = id unless id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end # Removes the specified message from the trash. # @param [String] user_id - # The user's email address. The special value me - # can be used to indicate the authenticated user. + # The user's email address. The special value me can be used to indicate the + # authenticated user. # @param [String] id # The ID of the message to remove from Trash. # @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. + # An opaque string that represents a user for quota purposes. Must not exceed 40 + # characters. + # @param [String] user_ip + # Deprecated. Please use quotaUser instead. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -1106,21 +1176,22 @@ module Google # @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 untrash_user_message(user_id, id, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:post, 'gmail/v1/users/{userId}/messages/{id}/untrash', options) + def untrash_user_message(user_id, id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:post, '{userId}/messages/{id}/untrash', options) command.response_representation = Google::Apis::GmailV1::Message::Representation command.response_class = Google::Apis::GmailV1::Message command.params['userId'] = user_id unless user_id.nil? command.params['id'] = id unless id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end # Gets the specified message attachment. # @param [String] user_id - # The user's email address. The special value me - # can be used to indicate the authenticated user. + # The user's email address. The special value me can be used to indicate the + # authenticated user. # @param [String] message_id # The ID of the message containing the attachment. # @param [String] id @@ -1128,8 +1199,10 @@ module Google # @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. + # An opaque string that represents a user for quota purposes. Must not exceed 40 + # characters. + # @param [String] user_ip + # Deprecated. Please use quotaUser instead. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -1142,8 +1215,8 @@ module Google # @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_user_message_attachment(user_id, message_id, id, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:get, 'gmail/v1/users/{userId}/messages/{messageId}/attachments/{id}', options) + def get_user_message_attachment(user_id, message_id, id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:get, '{userId}/messages/{messageId}/attachments/{id}', options) command.response_representation = Google::Apis::GmailV1::MessagePartBody::Representation command.response_class = Google::Apis::GmailV1::MessagePartBody command.params['userId'] = user_id unless user_id.nil? @@ -1151,18 +1224,21 @@ module Google command.params['id'] = id unless id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end # Gets the auto-forwarding setting for the specified account. # @param [String] user_id - # User's email address. The special value "me" - # can be used to indicate the authenticated user. + # User's email address. The special value "me" can be used to indicate the + # authenticated user. # @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. + # An opaque string that represents a user for quota purposes. Must not exceed 40 + # characters. + # @param [String] user_ip + # Deprecated. Please use quotaUser instead. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -1175,25 +1251,28 @@ module Google # @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_user_setting_auto_forwarding(user_id, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:get, 'gmail/v1/users/{userId}/settings/autoForwarding', options) + def get_user_setting_auto_forwarding(user_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:get, '{userId}/settings/autoForwarding', options) command.response_representation = Google::Apis::GmailV1::AutoForwarding::Representation command.response_class = Google::Apis::GmailV1::AutoForwarding command.params['userId'] = user_id unless user_id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end # Gets IMAP settings. # @param [String] user_id - # User's email address. The special value "me" - # can be used to indicate the authenticated user. + # User's email address. The special value "me" can be used to indicate the + # authenticated user. # @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. + # An opaque string that represents a user for quota purposes. Must not exceed 40 + # characters. + # @param [String] user_ip + # Deprecated. Please use quotaUser instead. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -1206,25 +1285,28 @@ module Google # @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_user_setting_imap(user_id, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:get, 'gmail/v1/users/{userId}/settings/imap', options) + def get_user_setting_imap(user_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:get, '{userId}/settings/imap', options) command.response_representation = Google::Apis::GmailV1::ImapSettings::Representation command.response_class = Google::Apis::GmailV1::ImapSettings command.params['userId'] = user_id unless user_id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end # Gets language settings. # @param [String] user_id - # User's email address. The special value "me" - # can be used to indicate the authenticated user. + # User's email address. The special value "me" can be used to indicate the + # authenticated user. # @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. + # An opaque string that represents a user for quota purposes. Must not exceed 40 + # characters. + # @param [String] user_ip + # Deprecated. Please use quotaUser instead. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -1237,25 +1319,28 @@ module Google # @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_user_setting_language(user_id, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:get, 'gmail/v1/users/{userId}/settings/language', options) + def get_user_setting_language(user_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:get, '{userId}/settings/language', options) command.response_representation = Google::Apis::GmailV1::LanguageSettings::Representation command.response_class = Google::Apis::GmailV1::LanguageSettings command.params['userId'] = user_id unless user_id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end # Gets POP settings. # @param [String] user_id - # User's email address. The special value "me" - # can be used to indicate the authenticated user. + # User's email address. The special value "me" can be used to indicate the + # authenticated user. # @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. + # An opaque string that represents a user for quota purposes. Must not exceed 40 + # characters. + # @param [String] user_ip + # Deprecated. Please use quotaUser instead. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -1268,25 +1353,28 @@ module Google # @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_user_setting_pop(user_id, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:get, 'gmail/v1/users/{userId}/settings/pop', options) + def get_user_setting_pop(user_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:get, '{userId}/settings/pop', options) command.response_representation = Google::Apis::GmailV1::PopSettings::Representation command.response_class = Google::Apis::GmailV1::PopSettings command.params['userId'] = user_id unless user_id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end # Gets vacation responder settings. # @param [String] user_id - # User's email address. The special value "me" - # can be used to indicate the authenticated user. + # User's email address. The special value "me" can be used to indicate the + # authenticated user. # @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. + # An opaque string that represents a user for quota purposes. Must not exceed 40 + # characters. + # @param [String] user_ip + # Deprecated. Please use quotaUser instead. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -1299,29 +1387,32 @@ module Google # @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_user_setting_vacation(user_id, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:get, 'gmail/v1/users/{userId}/settings/vacation', options) + def get_user_setting_vacation(user_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:get, '{userId}/settings/vacation', options) command.response_representation = Google::Apis::GmailV1::VacationSettings::Representation command.response_class = Google::Apis::GmailV1::VacationSettings command.params['userId'] = user_id unless user_id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end - # Updates the auto-forwarding setting for the specified account. A verified + # Updates the auto-forwarding setting for the specified account. A verified # forwarding address must be specified when auto-forwarding is enabled. # This method is only available to service account clients that have been # delegated domain-wide authority. # @param [String] user_id - # User's email address. The special value "me" - # can be used to indicate the authenticated user. + # User's email address. The special value "me" can be used to indicate the + # authenticated user. # @param [Google::Apis::GmailV1::AutoForwarding] auto_forwarding_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. + # An opaque string that represents a user for quota purposes. Must not exceed 40 + # characters. + # @param [String] user_ip + # Deprecated. Please use quotaUser instead. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -1334,8 +1425,8 @@ module Google # @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_user_setting_auto_forwarding(user_id, auto_forwarding_object = nil, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:put, 'gmail/v1/users/{userId}/settings/autoForwarding', options) + def update_user_setting_auto_forwarding(user_id, auto_forwarding_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:put, '{userId}/settings/autoForwarding', options) command.request_representation = Google::Apis::GmailV1::AutoForwarding::Representation command.request_object = auto_forwarding_object command.response_representation = Google::Apis::GmailV1::AutoForwarding::Representation @@ -1343,19 +1434,22 @@ module Google command.params['userId'] = user_id unless user_id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end # Updates IMAP settings. # @param [String] user_id - # User's email address. The special value "me" - # can be used to indicate the authenticated user. + # User's email address. The special value "me" can be used to indicate the + # authenticated user. # @param [Google::Apis::GmailV1::ImapSettings] imap_settings_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. + # An opaque string that represents a user for quota purposes. Must not exceed 40 + # characters. + # @param [String] user_ip + # Deprecated. Please use quotaUser instead. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -1368,8 +1462,8 @@ module Google # @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_user_setting_imap(user_id, imap_settings_object = nil, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:put, 'gmail/v1/users/{userId}/settings/imap', options) + def update_user_setting_imap(user_id, imap_settings_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:put, '{userId}/settings/imap', options) command.request_representation = Google::Apis::GmailV1::ImapSettings::Representation command.request_object = imap_settings_object command.response_representation = Google::Apis::GmailV1::ImapSettings::Representation @@ -1377,24 +1471,27 @@ module Google command.params['userId'] = user_id unless user_id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end # Updates language settings. - # If successful, the return object contains the displayLanguage - # that was saved for the user, which may differ from the value passed into - # the request. This is because the requested displayLanguage may - # not be directly supported by Gmail but have a close variant that is, and so - # the variant may be chosen and saved instead. + # If successful, the return object contains the displayLanguage that was saved + # for the user, which may differ from the value passed into the request. This is + # because the requested displayLanguage may not be directly supported by Gmail + # but have a close variant that is, and so the variant may be chosen and saved + # instead. # @param [String] user_id - # User's email address. The special value "me" - # can be used to indicate the authenticated user. + # User's email address. The special value "me" can be used to indicate the + # authenticated user. # @param [Google::Apis::GmailV1::LanguageSettings] language_settings_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. + # An opaque string that represents a user for quota purposes. Must not exceed 40 + # characters. + # @param [String] user_ip + # Deprecated. Please use quotaUser instead. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -1407,8 +1504,8 @@ module Google # @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_user_setting_language(user_id, language_settings_object = nil, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:put, 'gmail/v1/users/{userId}/settings/language', options) + def update_user_setting_language(user_id, language_settings_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:put, '{userId}/settings/language', options) command.request_representation = Google::Apis::GmailV1::LanguageSettings::Representation command.request_object = language_settings_object command.response_representation = Google::Apis::GmailV1::LanguageSettings::Representation @@ -1416,19 +1513,22 @@ module Google command.params['userId'] = user_id unless user_id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end # Updates POP settings. # @param [String] user_id - # User's email address. The special value "me" - # can be used to indicate the authenticated user. + # User's email address. The special value "me" can be used to indicate the + # authenticated user. # @param [Google::Apis::GmailV1::PopSettings] pop_settings_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. + # An opaque string that represents a user for quota purposes. Must not exceed 40 + # characters. + # @param [String] user_ip + # Deprecated. Please use quotaUser instead. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -1441,8 +1541,8 @@ module Google # @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_user_setting_pop(user_id, pop_settings_object = nil, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:put, 'gmail/v1/users/{userId}/settings/pop', options) + def update_user_setting_pop(user_id, pop_settings_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:put, '{userId}/settings/pop', options) command.request_representation = Google::Apis::GmailV1::PopSettings::Representation command.request_object = pop_settings_object command.response_representation = Google::Apis::GmailV1::PopSettings::Representation @@ -1450,19 +1550,22 @@ module Google command.params['userId'] = user_id unless user_id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end # Updates vacation responder settings. # @param [String] user_id - # User's email address. The special value "me" - # can be used to indicate the authenticated user. + # User's email address. The special value "me" can be used to indicate the + # authenticated user. # @param [Google::Apis::GmailV1::VacationSettings] vacation_settings_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. + # An opaque string that represents a user for quota purposes. Must not exceed 40 + # characters. + # @param [String] user_ip + # Deprecated. Please use quotaUser instead. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -1475,8 +1578,8 @@ module Google # @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_user_setting_vacation(user_id, vacation_settings_object = nil, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:put, 'gmail/v1/users/{userId}/settings/vacation', options) + def update_user_setting_vacation(user_id, vacation_settings_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:put, '{userId}/settings/vacation', options) command.request_representation = Google::Apis::GmailV1::VacationSettings::Representation command.request_object = vacation_settings_object command.response_representation = Google::Apis::GmailV1::VacationSettings::Representation @@ -1484,32 +1587,33 @@ module Google command.params['userId'] = user_id unless user_id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end - # Adds a delegate with its verification status set directly to - # accepted, without sending any verification email. The - # delegate user must be a member of the same G Suite organization as the - # delegator user. - # Gmail imposes limitations on the number of delegates and delegators each - # user in a G Suite organization can have. These limits depend on your - # organization, but in general each user can have up to 25 delegates and - # up to 10 delegators. - # Note that a delegate user must be referred to by their primary email - # address, and not an email alias. - # Also note that when a new delegate is created, there may be up to a one - # minute delay before the new delegate is available for use. + # Adds a delegate with its verification status set directly to accepted, without + # sending any verification email. The delegate user must be a member of the same + # G Suite organization as the delegator user. + # Gmail imposes limitations on the number of delegates and delegators each user + # in a G Suite organization can have. These limits depend on your organization, + # but in general each user can have up to 25 delegates and up to 10 delegators. + # Note that a delegate user must be referred to by their primary email address, + # and not an email alias. + # Also note that when a new delegate is created, there may be up to a one minute + # delay before the new delegate is available for use. # This method is only available to service account clients that have been # delegated domain-wide authority. # @param [String] user_id - # User's email address. The special value "me" - # can be used to indicate the authenticated user. + # User's email address. The special value "me" can be used to indicate the + # authenticated user. # @param [Google::Apis::GmailV1::Delegate] delegate_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. + # An opaque string that represents a user for quota purposes. Must not exceed 40 + # characters. + # @param [String] user_ip + # Deprecated. Please use quotaUser instead. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -1522,8 +1626,8 @@ module Google # @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_user_setting_delegate(user_id, delegate_object = nil, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:post, 'gmail/v1/users/{userId}/settings/delegates', options) + def create_user_setting_delegate(user_id, delegate_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:post, '{userId}/settings/delegates', options) command.request_representation = Google::Apis::GmailV1::Delegate::Representation command.request_object = delegate_object command.response_representation = Google::Apis::GmailV1::Delegate::Representation @@ -1531,25 +1635,28 @@ module Google command.params['userId'] = user_id unless user_id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end - # Removes the specified delegate (which can be of any verification status), - # and revokes any verification that may have been required for using it. - # Note that a delegate user must be referred to by their primary email - # address, and not an email alias. + # Removes the specified delegate (which can be of any verification status), and + # revokes any verification that may have been required for using it. + # Note that a delegate user must be referred to by their primary email address, + # and not an email alias. # This method is only available to service account clients that have been # delegated domain-wide authority. # @param [String] user_id - # User's email address. The special value "me" - # can be used to indicate the authenticated user. + # User's email address. The special value "me" can be used to indicate the + # authenticated user. # @param [String] delegate_email # The email address of the user to be removed as a delegate. # @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. + # An opaque string that represents a user for quota purposes. Must not exceed 40 + # characters. + # @param [String] user_ip + # Deprecated. Please use quotaUser instead. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -1562,31 +1669,33 @@ module Google # @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_user_setting_delegate(user_id, delegate_email, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:delete, 'gmail/v1/users/{userId}/settings/delegates/{delegateEmail}', options) + def delete_user_setting_delegate(user_id, delegate_email, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:delete, '{userId}/settings/delegates/{delegateEmail}', options) command.params['userId'] = user_id unless user_id.nil? command.params['delegateEmail'] = delegate_email unless delegate_email.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end # Gets the specified delegate. - # Note that a delegate user must be referred to by their primary email - # address, and not an email alias. + # Note that a delegate user must be referred to by their primary email address, + # and not an email alias. # This method is only available to service account clients that have been # delegated domain-wide authority. # @param [String] user_id - # User's email address. The special value "me" - # can be used to indicate the authenticated user. + # User's email address. The special value "me" can be used to indicate the + # authenticated user. # @param [String] delegate_email - # The email address of the user whose delegate relationship is to be - # retrieved. + # The email address of the user whose delegate relationship is to be retrieved. # @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. + # An opaque string that represents a user for quota purposes. Must not exceed 40 + # characters. + # @param [String] user_ip + # Deprecated. Please use quotaUser instead. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -1599,14 +1708,15 @@ module Google # @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_user_setting_delegate(user_id, delegate_email, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:get, 'gmail/v1/users/{userId}/settings/delegates/{delegateEmail}', options) + def get_user_setting_delegate(user_id, delegate_email, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:get, '{userId}/settings/delegates/{delegateEmail}', options) command.response_representation = Google::Apis::GmailV1::Delegate::Representation command.response_class = Google::Apis::GmailV1::Delegate command.params['userId'] = user_id unless user_id.nil? command.params['delegateEmail'] = delegate_email unless delegate_email.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end @@ -1614,13 +1724,15 @@ module Google # This method is only available to service account clients that have been # delegated domain-wide authority. # @param [String] user_id - # User's email address. The special value "me" - # can be used to indicate the authenticated user. + # User's email address. The special value "me" can be used to indicate the + # authenticated user. # @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. + # An opaque string that represents a user for quota purposes. Must not exceed 40 + # characters. + # @param [String] user_ip + # Deprecated. Please use quotaUser instead. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -1633,26 +1745,29 @@ module Google # @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_user_setting_delegates(user_id, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:get, 'gmail/v1/users/{userId}/settings/delegates', options) + def list_user_setting_delegates(user_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:get, '{userId}/settings/delegates', options) command.response_representation = Google::Apis::GmailV1::ListDelegatesResponse::Representation command.response_class = Google::Apis::GmailV1::ListDelegatesResponse command.params['userId'] = user_id unless user_id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end # Creates a filter. # @param [String] user_id - # User's email address. The special value "me" - # can be used to indicate the authenticated user. + # User's email address. The special value "me" can be used to indicate the + # authenticated user. # @param [Google::Apis::GmailV1::Filter] filter_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. + # An opaque string that represents a user for quota purposes. Must not exceed 40 + # characters. + # @param [String] user_ip + # Deprecated. Please use quotaUser instead. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -1665,8 +1780,8 @@ module Google # @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_user_setting_filter(user_id, filter_object = nil, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:post, 'gmail/v1/users/{userId}/settings/filters', options) + def create_user_setting_filter(user_id, filter_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:post, '{userId}/settings/filters', options) command.request_representation = Google::Apis::GmailV1::Filter::Representation command.request_object = filter_object command.response_representation = Google::Apis::GmailV1::Filter::Representation @@ -1674,20 +1789,23 @@ module Google command.params['userId'] = user_id unless user_id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end # Deletes a filter. # @param [String] user_id - # User's email address. The special value "me" - # can be used to indicate the authenticated user. + # User's email address. The special value "me" can be used to indicate the + # authenticated user. # @param [String] id # The ID of the filter to be deleted. # @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. + # An opaque string that represents a user for quota purposes. Must not exceed 40 + # characters. + # @param [String] user_ip + # Deprecated. Please use quotaUser instead. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -1700,26 +1818,29 @@ module Google # @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_user_setting_filter(user_id, id, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:delete, 'gmail/v1/users/{userId}/settings/filters/{id}', options) + def delete_user_setting_filter(user_id, id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:delete, '{userId}/settings/filters/{id}', options) command.params['userId'] = user_id unless user_id.nil? command.params['id'] = id unless id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end # Gets a filter. # @param [String] user_id - # User's email address. The special value "me" - # can be used to indicate the authenticated user. + # User's email address. The special value "me" can be used to indicate the + # authenticated user. # @param [String] id # The ID of the filter to be fetched. # @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. + # An opaque string that represents a user for quota purposes. Must not exceed 40 + # characters. + # @param [String] user_ip + # Deprecated. Please use quotaUser instead. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -1732,26 +1853,29 @@ module Google # @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_user_setting_filter(user_id, id, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:get, 'gmail/v1/users/{userId}/settings/filters/{id}', options) + def get_user_setting_filter(user_id, id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:get, '{userId}/settings/filters/{id}', options) command.response_representation = Google::Apis::GmailV1::Filter::Representation command.response_class = Google::Apis::GmailV1::Filter command.params['userId'] = user_id unless user_id.nil? command.params['id'] = id unless id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end # Lists the message filters of a Gmail user. # @param [String] user_id - # User's email address. The special value "me" - # can be used to indicate the authenticated user. + # User's email address. The special value "me" can be used to indicate the + # authenticated user. # @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. + # An opaque string that represents a user for quota purposes. Must not exceed 40 + # characters. + # @param [String] user_ip + # Deprecated. Please use quotaUser instead. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -1764,31 +1888,34 @@ module Google # @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_user_setting_filters(user_id, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:get, 'gmail/v1/users/{userId}/settings/filters', options) + def list_user_setting_filters(user_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:get, '{userId}/settings/filters', options) command.response_representation = Google::Apis::GmailV1::ListFiltersResponse::Representation command.response_class = Google::Apis::GmailV1::ListFiltersResponse command.params['userId'] = user_id unless user_id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end - # Creates a forwarding address. If ownership verification is required, a - # message will be sent to the recipient and the resource's verification - # status will be set to pending; otherwise, the resource will be - # created with verification status set to accepted. + # Creates a forwarding address. If ownership verification is required, a message + # will be sent to the recipient and the resource's verification status will be + # set to pending; otherwise, the resource will be created with verification + # status set to accepted. # This method is only available to service account clients that have been # delegated domain-wide authority. # @param [String] user_id - # User's email address. The special value "me" - # can be used to indicate the authenticated user. + # User's email address. The special value "me" can be used to indicate the + # authenticated user. # @param [Google::Apis::GmailV1::ForwardingAddress] forwarding_address_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. + # An opaque string that represents a user for quota purposes. Must not exceed 40 + # characters. + # @param [String] user_ip + # Deprecated. Please use quotaUser instead. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -1801,8 +1928,8 @@ module Google # @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_user_setting_forwarding_address(user_id, forwarding_address_object = nil, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:post, 'gmail/v1/users/{userId}/settings/forwardingAddresses', options) + def create_user_setting_forwarding_address(user_id, forwarding_address_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:post, '{userId}/settings/forwardingAddresses', options) command.request_representation = Google::Apis::GmailV1::ForwardingAddress::Representation command.request_object = forwarding_address_object command.response_representation = Google::Apis::GmailV1::ForwardingAddress::Representation @@ -1810,23 +1937,26 @@ module Google command.params['userId'] = user_id unless user_id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end - # Deletes the specified forwarding address and revokes any verification that - # may have been required. + # Deletes the specified forwarding address and revokes any verification that may + # have been required. # This method is only available to service account clients that have been # delegated domain-wide authority. # @param [String] user_id - # User's email address. The special value "me" - # can be used to indicate the authenticated user. + # User's email address. The special value "me" can be used to indicate the + # authenticated user. # @param [String] forwarding_email # The forwarding address to be deleted. # @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. + # An opaque string that represents a user for quota purposes. Must not exceed 40 + # characters. + # @param [String] user_ip + # Deprecated. Please use quotaUser instead. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -1839,26 +1969,29 @@ module Google # @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_user_setting_forwarding_address(user_id, forwarding_email, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:delete, 'gmail/v1/users/{userId}/settings/forwardingAddresses/{forwardingEmail}', options) + def delete_user_setting_forwarding_address(user_id, forwarding_email, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:delete, '{userId}/settings/forwardingAddresses/{forwardingEmail}', options) command.params['userId'] = user_id unless user_id.nil? command.params['forwardingEmail'] = forwarding_email unless forwarding_email.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end # Gets the specified forwarding address. # @param [String] user_id - # User's email address. The special value "me" - # can be used to indicate the authenticated user. + # User's email address. The special value "me" can be used to indicate the + # authenticated user. # @param [String] forwarding_email # The forwarding address to be retrieved. # @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. + # An opaque string that represents a user for quota purposes. Must not exceed 40 + # characters. + # @param [String] user_ip + # Deprecated. Please use quotaUser instead. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -1871,26 +2004,29 @@ module Google # @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_user_setting_forwarding_address(user_id, forwarding_email, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:get, 'gmail/v1/users/{userId}/settings/forwardingAddresses/{forwardingEmail}', options) + def get_user_setting_forwarding_address(user_id, forwarding_email, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:get, '{userId}/settings/forwardingAddresses/{forwardingEmail}', options) command.response_representation = Google::Apis::GmailV1::ForwardingAddress::Representation command.response_class = Google::Apis::GmailV1::ForwardingAddress command.params['userId'] = user_id unless user_id.nil? command.params['forwardingEmail'] = forwarding_email unless forwarding_email.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end # Lists the forwarding addresses for the specified account. # @param [String] user_id - # User's email address. The special value "me" - # can be used to indicate the authenticated user. + # User's email address. The special value "me" can be used to indicate the + # authenticated user. # @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. + # An opaque string that represents a user for quota purposes. Must not exceed 40 + # characters. + # @param [String] user_ip + # Deprecated. Please use quotaUser instead. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -1903,35 +2039,37 @@ module Google # @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_user_setting_forwarding_addresses(user_id, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:get, 'gmail/v1/users/{userId}/settings/forwardingAddresses', options) + def list_user_setting_forwarding_addresses(user_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:get, '{userId}/settings/forwardingAddresses', options) command.response_representation = Google::Apis::GmailV1::ListForwardingAddressesResponse::Representation command.response_class = Google::Apis::GmailV1::ListForwardingAddressesResponse command.params['userId'] = user_id unless user_id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end - # Creates a custom "from" send-as alias. If an SMTP MSA is specified, Gmail - # will attempt to connect to the SMTP service to validate the configuration - # before creating the alias. If ownership verification is required for the - # alias, a message will be sent to the email address and the resource's - # verification status will be set to pending; otherwise, the - # resource will be created with verification status set to - # accepted. If a signature is provided, Gmail will sanitize the - # HTML before saving it with the alias. + # Creates a custom "from" send-as alias. If an SMTP MSA is specified, Gmail will + # attempt to connect to the SMTP service to validate the configuration before + # creating the alias. If ownership verification is required for the alias, a + # message will be sent to the email address and the resource's verification + # status will be set to pending; otherwise, the resource will be created with + # verification status set to accepted. If a signature is provided, Gmail will + # sanitize the HTML before saving it with the alias. # This method is only available to service account clients that have been # delegated domain-wide authority. # @param [String] user_id - # User's email address. The special value "me" - # can be used to indicate the authenticated user. + # User's email address. The special value "me" can be used to indicate the + # authenticated user. # @param [Google::Apis::GmailV1::SendAs] send_as_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. + # An opaque string that represents a user for quota purposes. Must not exceed 40 + # characters. + # @param [String] user_ip + # Deprecated. Please use quotaUser instead. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -1944,8 +2082,8 @@ module Google # @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_user_setting_send_as(user_id, send_as_object = nil, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:post, 'gmail/v1/users/{userId}/settings/sendAs', options) + def create_user_setting_send_as(user_id, send_as_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:post, '{userId}/settings/sendAs', options) command.request_representation = Google::Apis::GmailV1::SendAs::Representation command.request_object = send_as_object command.response_representation = Google::Apis::GmailV1::SendAs::Representation @@ -1953,23 +2091,26 @@ module Google command.params['userId'] = user_id unless user_id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end - # Deletes the specified send-as alias. Revokes any verification that may - # have been required for using it. + # Deletes the specified send-as alias. Revokes any verification that may have + # been required for using it. # This method is only available to service account clients that have been # delegated domain-wide authority. # @param [String] user_id - # User's email address. The special value "me" - # can be used to indicate the authenticated user. + # User's email address. The special value "me" can be used to indicate the + # authenticated user. # @param [String] send_as_email # The send-as alias to be deleted. # @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. + # An opaque string that represents a user for quota purposes. Must not exceed 40 + # characters. + # @param [String] user_ip + # Deprecated. Please use quotaUser instead. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -1982,27 +2123,30 @@ module Google # @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_user_setting_send_as(user_id, send_as_email, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:delete, 'gmail/v1/users/{userId}/settings/sendAs/{sendAsEmail}', options) + def delete_user_setting_send_as(user_id, send_as_email, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:delete, '{userId}/settings/sendAs/{sendAsEmail}', options) command.params['userId'] = user_id unless user_id.nil? command.params['sendAsEmail'] = send_as_email unless send_as_email.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end - # Gets the specified send-as alias. Fails with an HTTP 404 error if the + # Gets the specified send-as alias. Fails with an HTTP 404 error if the # specified address is not a member of the collection. # @param [String] user_id - # User's email address. The special value "me" - # can be used to indicate the authenticated user. + # User's email address. The special value "me" can be used to indicate the + # authenticated user. # @param [String] send_as_email # The send-as alias to be retrieved. # @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. + # An opaque string that represents a user for quota purposes. Must not exceed 40 + # characters. + # @param [String] user_ip + # Deprecated. Please use quotaUser instead. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -2015,28 +2159,31 @@ module Google # @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_user_setting_send_as(user_id, send_as_email, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:get, 'gmail/v1/users/{userId}/settings/sendAs/{sendAsEmail}', options) + def get_user_setting_send_as(user_id, send_as_email, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:get, '{userId}/settings/sendAs/{sendAsEmail}', options) command.response_representation = Google::Apis::GmailV1::SendAs::Representation command.response_class = Google::Apis::GmailV1::SendAs command.params['userId'] = user_id unless user_id.nil? command.params['sendAsEmail'] = send_as_email unless send_as_email.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end - # Lists the send-as aliases for the specified account. The result includes - # the primary send-as address associated with the account as well as any - # custom "from" aliases. + # Lists the send-as aliases for the specified account. The result includes the + # primary send-as address associated with the account as well as any custom " + # from" aliases. # @param [String] user_id - # User's email address. The special value "me" - # can be used to indicate the authenticated user. + # User's email address. The special value "me" can be used to indicate the + # authenticated user. # @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. + # An opaque string that represents a user for quota purposes. Must not exceed 40 + # characters. + # @param [String] user_ip + # Deprecated. Please use quotaUser instead. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -2049,28 +2196,35 @@ module Google # @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_user_setting_send_as(user_id, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:get, 'gmail/v1/users/{userId}/settings/sendAs', options) + def list_user_setting_send_as(user_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:get, '{userId}/settings/sendAs', options) command.response_representation = Google::Apis::GmailV1::ListSendAsResponse::Representation command.response_class = Google::Apis::GmailV1::ListSendAsResponse command.params['userId'] = user_id unless user_id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end - # Patch the specified send-as alias. + # Updates a send-as alias. If a signature is provided, Gmail will sanitize the + # HTML before saving it with the alias. + # Addresses other than the primary address for the account can only be updated + # by service account clients that have been delegated domain-wide authority. + # This method supports patch semantics. # @param [String] user_id - # User's email address. The special value "me" - # can be used to indicate the authenticated user. + # User's email address. The special value "me" can be used to indicate the + # authenticated user. # @param [String] send_as_email # The send-as alias to be updated. # @param [Google::Apis::GmailV1::SendAs] send_as_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. + # An opaque string that represents a user for quota purposes. Must not exceed 40 + # characters. + # @param [String] user_ip + # Deprecated. Please use quotaUser instead. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -2083,8 +2237,8 @@ module Google # @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 patch_user_setting_send_as(user_id, send_as_email, send_as_object = nil, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:patch, 'gmail/v1/users/{userId}/settings/sendAs/{sendAsEmail}', options) + def patch_user_setting_send_as(user_id, send_as_email, send_as_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:patch, '{userId}/settings/sendAs/{sendAsEmail}', options) command.request_representation = Google::Apis::GmailV1::SendAs::Representation command.request_object = send_as_object command.response_representation = Google::Apis::GmailV1::SendAs::Representation @@ -2093,25 +2247,27 @@ module Google command.params['sendAsEmail'] = send_as_email unless send_as_email.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end - # Updates a send-as alias. If a signature is provided, Gmail will sanitize - # the HTML before saving it with the alias. - # Addresses other than the primary address for the account can only be - # updated by service account clients that have been delegated domain-wide - # authority. + # Updates a send-as alias. If a signature is provided, Gmail will sanitize the + # HTML before saving it with the alias. + # Addresses other than the primary address for the account can only be updated + # by service account clients that have been delegated domain-wide authority. # @param [String] user_id - # User's email address. The special value "me" - # can be used to indicate the authenticated user. + # User's email address. The special value "me" can be used to indicate the + # authenticated user. # @param [String] send_as_email # The send-as alias to be updated. # @param [Google::Apis::GmailV1::SendAs] send_as_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. + # An opaque string that represents a user for quota purposes. Must not exceed 40 + # characters. + # @param [String] user_ip + # Deprecated. Please use quotaUser instead. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -2124,8 +2280,8 @@ module Google # @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_user_setting_send_as(user_id, send_as_email, send_as_object = nil, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:put, 'gmail/v1/users/{userId}/settings/sendAs/{sendAsEmail}', options) + def update_user_setting_send_as(user_id, send_as_email, send_as_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:put, '{userId}/settings/sendAs/{sendAsEmail}', options) command.request_representation = Google::Apis::GmailV1::SendAs::Representation command.request_object = send_as_object command.response_representation = Google::Apis::GmailV1::SendAs::Representation @@ -2134,23 +2290,26 @@ module Google command.params['sendAsEmail'] = send_as_email unless send_as_email.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end - # Sends a verification email to the specified send-as alias address. - # The verification status must be pending. + # Sends a verification email to the specified send-as alias address. The + # verification status must be pending. # This method is only available to service account clients that have been # delegated domain-wide authority. # @param [String] user_id - # User's email address. The special value "me" - # can be used to indicate the authenticated user. + # User's email address. The special value "me" can be used to indicate the + # authenticated user. # @param [String] send_as_email # The send-as alias to be verified. # @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. + # An opaque string that represents a user for quota purposes. Must not exceed 40 + # characters. + # @param [String] user_ip + # Deprecated. Please use quotaUser instead. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -2163,29 +2322,32 @@ module Google # @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 verify_user_setting_send_as(user_id, send_as_email, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:post, 'gmail/v1/users/{userId}/settings/sendAs/{sendAsEmail}/verify', options) + def verify_user_setting_send_as(user_id, send_as_email, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:post, '{userId}/settings/sendAs/{sendAsEmail}/verify', options) command.params['userId'] = user_id unless user_id.nil? command.params['sendAsEmail'] = send_as_email unless send_as_email.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end # Deletes the specified S/MIME config for the specified send-as alias. # @param [String] user_id - # The user's email address. The special value me - # can be used to indicate the authenticated user. + # The user's email address. The special value me can be used to indicate the + # authenticated user. # @param [String] send_as_email - # The email address that appears in the "From:" header for mail sent using - # this alias. + # The email address that appears in the "From:" header for mail sent using this + # alias. # @param [String] id # The immutable ID for the SmimeInfo. # @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. + # An opaque string that represents a user for quota purposes. Must not exceed 40 + # characters. + # @param [String] user_ip + # Deprecated. Please use quotaUser instead. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -2198,30 +2360,33 @@ module Google # @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_user_setting_send_a_smime_info(user_id, send_as_email, id, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:delete, 'gmail/v1/users/{userId}/settings/sendAs/{sendAsEmail}/smimeInfo/{id}', options) + def delete_user_setting_send_a_smime_info(user_id, send_as_email, id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:delete, '{userId}/settings/sendAs/{sendAsEmail}/smimeInfo/{id}', options) command.params['userId'] = user_id unless user_id.nil? command.params['sendAsEmail'] = send_as_email unless send_as_email.nil? command.params['id'] = id unless id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end # Gets the specified S/MIME config for the specified send-as alias. # @param [String] user_id - # The user's email address. The special value me - # can be used to indicate the authenticated user. + # The user's email address. The special value me can be used to indicate the + # authenticated user. # @param [String] send_as_email - # The email address that appears in the "From:" header for mail sent using - # this alias. + # The email address that appears in the "From:" header for mail sent using this + # alias. # @param [String] id # The immutable ID for the SmimeInfo. # @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. + # An opaque string that represents a user for quota purposes. Must not exceed 40 + # characters. + # @param [String] user_ip + # Deprecated. Please use quotaUser instead. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -2234,8 +2399,8 @@ module Google # @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_user_setting_send_a_smime_info(user_id, send_as_email, id, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:get, 'gmail/v1/users/{userId}/settings/sendAs/{sendAsEmail}/smimeInfo/{id}', options) + def get_user_setting_send_a_smime_info(user_id, send_as_email, id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:get, '{userId}/settings/sendAs/{sendAsEmail}/smimeInfo/{id}', options) command.response_representation = Google::Apis::GmailV1::SmimeInfo::Representation command.response_class = Google::Apis::GmailV1::SmimeInfo command.params['userId'] = user_id unless user_id.nil? @@ -2243,23 +2408,26 @@ module Google command.params['id'] = id unless id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end - # Insert (upload) the given S/MIME config for the specified send-as alias. - # Note that pkcs12 format is required for the key. + # Insert (upload) the given S/MIME config for the specified send-as alias. Note + # that pkcs12 format is required for the key. # @param [String] user_id - # The user's email address. The special value me - # can be used to indicate the authenticated user. + # The user's email address. The special value me can be used to indicate the + # authenticated user. # @param [String] send_as_email - # The email address that appears in the "From:" header for mail sent using - # this alias. + # The email address that appears in the "From:" header for mail sent using this + # alias. # @param [Google::Apis::GmailV1::SmimeInfo] smime_info_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. + # An opaque string that represents a user for quota purposes. Must not exceed 40 + # characters. + # @param [String] user_ip + # Deprecated. Please use quotaUser instead. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -2272,8 +2440,8 @@ module Google # @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 insert_user_setting_send_a_smime_info(user_id, send_as_email, smime_info_object = nil, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:post, 'gmail/v1/users/{userId}/settings/sendAs/{sendAsEmail}/smimeInfo', options) + def insert_user_setting_send_a_smime_info(user_id, send_as_email, smime_info_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:post, '{userId}/settings/sendAs/{sendAsEmail}/smimeInfo', options) command.request_representation = Google::Apis::GmailV1::SmimeInfo::Representation command.request_object = smime_info_object command.response_representation = Google::Apis::GmailV1::SmimeInfo::Representation @@ -2282,21 +2450,24 @@ module Google command.params['sendAsEmail'] = send_as_email unless send_as_email.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end # Lists S/MIME configs for the specified send-as alias. # @param [String] user_id - # The user's email address. The special value me - # can be used to indicate the authenticated user. + # The user's email address. The special value me can be used to indicate the + # authenticated user. # @param [String] send_as_email - # The email address that appears in the "From:" header for mail sent using - # this alias. + # The email address that appears in the "From:" header for mail sent using this + # alias. # @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. + # An opaque string that represents a user for quota purposes. Must not exceed 40 + # characters. + # @param [String] user_ip + # Deprecated. Please use quotaUser instead. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -2309,31 +2480,34 @@ module Google # @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_user_setting_send_a_smime_infos(user_id, send_as_email, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:get, 'gmail/v1/users/{userId}/settings/sendAs/{sendAsEmail}/smimeInfo', options) + def list_user_setting_send_a_smime_infos(user_id, send_as_email, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:get, '{userId}/settings/sendAs/{sendAsEmail}/smimeInfo', options) command.response_representation = Google::Apis::GmailV1::ListSmimeInfoResponse::Representation command.response_class = Google::Apis::GmailV1::ListSmimeInfoResponse command.params['userId'] = user_id unless user_id.nil? command.params['sendAsEmail'] = send_as_email unless send_as_email.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end # Sets the default S/MIME config for the specified send-as alias. # @param [String] user_id - # The user's email address. The special value me - # can be used to indicate the authenticated user. + # The user's email address. The special value me can be used to indicate the + # authenticated user. # @param [String] send_as_email - # The email address that appears in the "From:" header for mail sent using - # this alias. + # The email address that appears in the "From:" header for mail sent using this + # alias. # @param [String] id # The immutable ID for the SmimeInfo. # @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. + # An opaque string that represents a user for quota purposes. Must not exceed 40 + # characters. + # @param [String] user_ip + # Deprecated. Please use quotaUser instead. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -2346,28 +2520,31 @@ module Google # @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 set_user_setting_send_a_smime_info_default(user_id, send_as_email, id, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:post, 'gmail/v1/users/{userId}/settings/sendAs/{sendAsEmail}/smimeInfo/{id}/setDefault', options) + def set_user_setting_send_a_smime_info_default(user_id, send_as_email, id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:post, '{userId}/settings/sendAs/{sendAsEmail}/smimeInfo/{id}/setDefault', options) command.params['userId'] = user_id unless user_id.nil? command.params['sendAsEmail'] = send_as_email unless send_as_email.nil? command.params['id'] = id unless id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end # Immediately and permanently deletes the specified thread. This operation - # cannot be undone. Prefer threads.trash instead. + # cannot be undone. Prefer threads.trash instead. # @param [String] user_id - # The user's email address. The special value me - # can be used to indicate the authenticated user. + # The user's email address. The special value me can be used to indicate the + # authenticated user. # @param [String] id # ID of the Thread to delete. # @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. + # An opaque string that represents a user for quota purposes. Must not exceed 40 + # characters. + # @param [String] user_ip + # Deprecated. Please use quotaUser instead. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -2380,19 +2557,20 @@ module Google # @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_user_thread(user_id, id, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:delete, 'gmail/v1/users/{userId}/threads/{id}', options) + def delete_user_thread(user_id, id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:delete, '{userId}/threads/{id}', options) command.params['userId'] = user_id unless user_id.nil? command.params['id'] = id unless id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end # Gets the specified thread. # @param [String] user_id - # The user's email address. The special value me - # can be used to indicate the authenticated user. + # The user's email address. The special value me can be used to indicate the + # authenticated user. # @param [String] id # The ID of the thread to retrieve. # @param [String] format @@ -2402,8 +2580,10 @@ module Google # @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. + # An opaque string that represents a user for quota purposes. Must not exceed 40 + # characters. + # @param [String] user_ip + # Deprecated. Please use quotaUser instead. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -2416,8 +2596,8 @@ module Google # @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_user_thread(user_id, id, format: nil, metadata_headers: nil, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:get, 'gmail/v1/users/{userId}/threads/{id}', options) + def get_user_thread(user_id, id, format: nil, metadata_headers: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:get, '{userId}/threads/{id}', options) command.response_representation = Google::Apis::GmailV1::Thread::Representation command.response_class = Google::Apis::GmailV1::Thread command.params['userId'] = user_id unless user_id.nil? @@ -2426,16 +2606,16 @@ module Google command.query['metadataHeaders'] = metadata_headers unless metadata_headers.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end # Lists the threads in the user's mailbox. # @param [String] user_id - # The user's email address. The special value me - # can be used to indicate the authenticated user. + # The user's email address. The special value me can be used to indicate the + # authenticated user. # @param [Boolean] include_spam_trash - # Include threads from SPAM and TRASH - # in the results. + # Include threads from SPAM and TRASH in the results. # @param [Array, String] label_ids # Only return threads with labels that match all of the specified label IDs. # @param [Fixnum] max_results @@ -2443,16 +2623,17 @@ module Google # @param [String] page_token # Page token to retrieve a specific page of results in the list. # @param [String] q - # Only return threads matching the specified query. Supports the same - # query format as the Gmail search box. For example, - # "from:someuser@example.com rfc822msgid: - # is:unread". Parameter cannot be used when accessing the api - # using the gmail.metadata scope. + # Only return threads matching the specified query. Supports the same query + # format as the Gmail search box. For example, "from:someuser@example.com + # rfc822msgid: is:unread". Parameter cannot be used when accessing the api using + # the gmail.metadata scope. # @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. + # An opaque string that represents a user for quota purposes. Must not exceed 40 + # characters. + # @param [String] user_ip + # Deprecated. Please use quotaUser instead. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -2465,8 +2646,8 @@ module Google # @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_user_threads(user_id, include_spam_trash: nil, label_ids: nil, max_results: nil, page_token: nil, q: nil, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:get, 'gmail/v1/users/{userId}/threads', options) + def list_user_threads(user_id, include_spam_trash: nil, label_ids: nil, max_results: nil, page_token: nil, q: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:get, '{userId}/threads', options) command.response_representation = Google::Apis::GmailV1::ListThreadsResponse::Representation command.response_class = Google::Apis::GmailV1::ListThreadsResponse command.params['userId'] = user_id unless user_id.nil? @@ -2477,22 +2658,25 @@ module Google command.query['q'] = q unless q.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end - # Modifies the labels applied to the thread. This applies to all messages - # in the thread. + # Modifies the labels applied to the thread. This applies to all messages in the + # thread. # @param [String] user_id - # The user's email address. The special value me - # can be used to indicate the authenticated user. + # The user's email address. The special value me can be used to indicate the + # authenticated user. # @param [String] id # The ID of the thread to modify. # @param [Google::Apis::GmailV1::ModifyThreadRequest] modify_thread_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. + # An opaque string that represents a user for quota purposes. Must not exceed 40 + # characters. + # @param [String] user_ip + # Deprecated. Please use quotaUser instead. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -2505,8 +2689,8 @@ module Google # @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 modify_thread(user_id, id, modify_thread_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:post, 'gmail/v1/users/{userId}/threads/{id}/modify', options) + def modify_thread(user_id, id, modify_thread_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:post, '{userId}/threads/{id}/modify', options) command.request_representation = Google::Apis::GmailV1::ModifyThreadRequest::Representation command.request_object = modify_thread_request_object command.response_representation = Google::Apis::GmailV1::Thread::Representation @@ -2515,20 +2699,23 @@ module Google command.params['id'] = id unless id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end # Moves the specified thread to the trash. # @param [String] user_id - # The user's email address. The special value me - # can be used to indicate the authenticated user. + # The user's email address. The special value me can be used to indicate the + # authenticated user. # @param [String] id # The ID of the thread to Trash. # @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. + # An opaque string that represents a user for quota purposes. Must not exceed 40 + # characters. + # @param [String] user_ip + # Deprecated. Please use quotaUser instead. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -2541,28 +2728,31 @@ module Google # @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 trash_user_thread(user_id, id, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:post, 'gmail/v1/users/{userId}/threads/{id}/trash', options) + def trash_user_thread(user_id, id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:post, '{userId}/threads/{id}/trash', options) command.response_representation = Google::Apis::GmailV1::Thread::Representation command.response_class = Google::Apis::GmailV1::Thread command.params['userId'] = user_id unless user_id.nil? command.params['id'] = id unless id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end # Removes the specified thread from the trash. # @param [String] user_id - # The user's email address. The special value me - # can be used to indicate the authenticated user. + # The user's email address. The special value me can be used to indicate the + # authenticated user. # @param [String] id # The ID of the thread to remove from Trash. # @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. + # An opaque string that represents a user for quota purposes. Must not exceed 40 + # characters. + # @param [String] user_ip + # Deprecated. Please use quotaUser instead. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -2575,14 +2765,15 @@ module Google # @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 untrash_user_thread(user_id, id, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:post, 'gmail/v1/users/{userId}/threads/{id}/untrash', options) + def untrash_user_thread(user_id, id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:post, '{userId}/threads/{id}/untrash', options) command.response_representation = Google::Apis::GmailV1::Thread::Representation command.response_class = Google::Apis::GmailV1::Thread command.params['userId'] = user_id unless user_id.nil? command.params['id'] = id unless id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end @@ -2591,6 +2782,7 @@ module Google def apply_command_defaults(command) command.query['key'] = key unless key.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? end end end diff --git a/generated/google/apis/healthcare_v1.rb b/generated/google/apis/healthcare_v1.rb index ffc1fdd1d..7b1b3e380 100644 --- a/generated/google/apis/healthcare_v1.rb +++ b/generated/google/apis/healthcare_v1.rb @@ -25,7 +25,7 @@ module Google # @see https://cloud.google.com/healthcare module HealthcareV1 VERSION = 'V1' - REVISION = '20200414' + REVISION = '20200501' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' diff --git a/generated/google/apis/healthcare_v1/classes.rb b/generated/google/apis/healthcare_v1/classes.rb index a92ee6a49..e6d2f4546 100644 --- a/generated/google/apis/healthcare_v1/classes.rb +++ b/generated/google/apis/healthcare_v1/classes.rb @@ -1266,7 +1266,7 @@ module Google # @return [String] attr_accessor :filter - # The [Cloud Pubsub](https://cloud.google.com/pubsub/docs/) topic that + # The [Cloud Pub/Sub](https://cloud.google.com/pubsub/docs/) topic that # notifications of changes are published on. Supplied by the client. The # notification is a `PubsubMessage` with the following fields: # * `PubsubMessage.Data` contains the resource name. @@ -1276,12 +1276,12 @@ module Google # published. # Note that notifications are only sent if the topic is non-empty. [Topic # names](https://cloud.google.com/pubsub/docs/overview#names) must be - # scoped to a project. cloud-healthcare@system.gserviceaccount.com must - # have publisher permissions on the given Pubsub topic. Not having adequate + # scoped to a project. Cloud Healthcare API service account must have + # publisher permissions on the given Pub/Sub topic. Not having adequate # permissions causes the calls that send notifications to fail. # If a notification cannot be published to Cloud Pub/Sub, errors will be - # logged to Stackdriver (see [Viewing logs](/healthcare/docs/how- - # tos/stackdriver-logging)). + # logged to Cloud Logging (see [Viewing logs](/healthcare/docs/how- + # tos/logging)). # Corresponds to the JSON property `pubsubTopic` # @return [String] attr_accessor :pubsub_topic @@ -1888,12 +1888,12 @@ module Google # Notifications are only sent if the topic is # non-empty. [Topic # names](https://cloud.google.com/pubsub/docs/overview#names) must be scoped - # to a project. cloud-healthcare@system.gserviceaccount.com must have - # publisher permissions on the given Cloud Pub/Sub topic. Not having adequate + # to a project. Cloud Healthcare API service account must have publisher + # permissions on the given Cloud Pub/Sub topic. Not having adequate # permissions causes the calls that send notifications to fail. # If a notification can't be published to Cloud Pub/Sub, errors are logged to - # Stackdriver (see [Viewing - # logs](/healthcare/docs/how-tos/stackdriver-logging)). If the number of + # Cloud Logging (see [Viewing + # logs](/healthcare/docs/how-tos/logging)). If the number of # errors exceeds a certain rate, some aren't submitted. # Corresponds to the JSON property `pubsubTopic` # @return [String] @@ -2006,7 +2006,7 @@ module Google # A link to audit and error logs in the log viewer. Error logs are generated # only by some operations, listed at - # https://cloud.google.com/healthcare/docs/how-tos/stackdriver-logging. + # [Viewing logs](/healthcare/docs/how-tos/logging). # Corresponds to the JSON property `logsUrl` # @return [String] attr_accessor :logs_url @@ -2106,10 +2106,13 @@ module Google # Google groups, and domains (such as G Suite). A `role` is a named list of # permissions; each `role` can be an IAM predefined role or a user-created # custom role. - # Optionally, a `binding` can specify a `condition`, which is a logical - # expression that allows access to a resource only if the expression evaluates - # to `true`. A condition can add constraints based on attributes of the - # request, the resource, or both. + # For some types of Google Cloud resources, a `binding` can also specify a + # `condition`, which is a logical expression that allows access to a resource + # only if the expression evaluates to `true`. A condition can add constraints + # based on attributes of the request, the resource, or both. To learn which + # resources support conditions in their IAM policies, see the + # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource- + # policies). # **JSON example:** # ` # "bindings": [ @@ -2124,7 +2127,9 @@ module Google # `, # ` # "role": "roles/resourcemanager.organizationViewer", - # "members": ["user:eve@example.com"], + # "members": [ + # "user:eve@example.com" + # ], # "condition": ` # "title": "expirable access", # "description": "Does not grant access after Sep 2020", @@ -2202,6 +2207,9 @@ module Google # the conditions in the version `3` policy are lost. # If a policy does not include any conditions, operations on that policy may # specify any valid version or leave the field unset. + # To learn which resources support conditions in their IAM policies, see the + # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource- + # policies). # Corresponds to the JSON property `version` # @return [Fixnum] attr_accessor :version @@ -2409,10 +2417,13 @@ module Google # Google groups, and domains (such as G Suite). A `role` is a named list of # permissions; each `role` can be an IAM predefined role or a user-created # custom role. - # Optionally, a `binding` can specify a `condition`, which is a logical - # expression that allows access to a resource only if the expression evaluates - # to `true`. A condition can add constraints based on attributes of the - # request, the resource, or both. + # For some types of Google Cloud resources, a `binding` can also specify a + # `condition`, which is a logical expression that allows access to a resource + # only if the expression evaluates to `true`. A condition can add constraints + # based on attributes of the request, the resource, or both. To learn which + # resources support conditions in their IAM policies, see the + # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource- + # policies). # **JSON example:** # ` # "bindings": [ @@ -2427,7 +2438,9 @@ module Google # `, # ` # "role": "roles/resourcemanager.organizationViewer", - # "members": ["user:eve@example.com"], + # "members": [ + # "user:eve@example.com" + # ], # "condition": ` # "title": "expirable access", # "description": "Does not grant access after Sep 2020", @@ -2465,8 +2478,7 @@ module Google # OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only # the fields in the mask will be modified. If no mask is provided, the # following default mask is used: - # paths: "bindings, etag" - # This field is only used by Cloud IAM. + # `paths: "bindings, etag"` # Corresponds to the JSON property `updateMask` # @return [String] attr_accessor :update_mask diff --git a/generated/google/apis/healthcare_v1/service.rb b/generated/google/apis/healthcare_v1/service.rb index 933e4f3f5..a1eb3e844 100644 --- a/generated/google/apis/healthcare_v1/service.rb +++ b/generated/google/apis/healthcare_v1/service.rb @@ -102,8 +102,8 @@ module Google # DICOM instances. The new de-identified dataset will not contain these # failed resources. Failed resource totals are tracked in # Operation.metadata. - # Error details are also logged to Stackdriver Logging. For more information, - # see [Viewing logs](/healthcare/docs/how-tos/stackdriver-logging). + # Error details are also logged to Cloud Logging. For more information, + # see [Viewing logs](/healthcare/docs/how-tos/logging). # @param [String] source_dataset # Source dataset resource name. For example, # `projects/`project_id`/locations/`location_id`/datasets/`dataset_id``. @@ -214,6 +214,9 @@ module Google # Requests for policies with any conditional bindings must specify version 3. # Policies without any conditional bindings may specify any valid value or # leave the field unset. + # To learn which resources support conditions in their IAM policies, see the + # [IAM + # documentation](https://cloud.google.com/iam/help/conditions/resource-policies). # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -322,7 +325,7 @@ module Google # Sets the access control policy on the specified resource. Replaces any # existing policy. - # Can return Public Errors: NOT_FOUND, INVALID_ARGUMENT and PERMISSION_DENIED + # Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors. # @param [String] resource # REQUIRED: The resource for which the policy is being specified. # See the operation documentation for the appropriate value for this field. @@ -358,7 +361,7 @@ module Google # Returns permissions that a caller has on the specified resource. # If the resource does not exist, this will return an empty set of - # permissions, not a NOT_FOUND error. + # permissions, not a `NOT_FOUND` error. # Note: This operation is designed to be used for building permission-aware # UIs and command-line tools, not for authorization checking. This operation # may "fail open" without warning. @@ -443,8 +446,8 @@ module Google # DICOM instances. The output DICOM store will not contain # these failed resources. Failed resource totals are tracked in # Operation.metadata. - # Error details are also logged to Stackdriver - # (see [Viewing logs](/healthcare/docs/how-tos/stackdriver-logging)). + # Error details are also logged to Cloud Logging + # (see [Viewing logs](/healthcare/docs/how-tos/logging)). # @param [String] source_store # Source DICOM store resource name. For example, # `projects/`project_id`/locations/`location_id`/datasets/`dataset_id`/ @@ -512,8 +515,8 @@ module Google # Exports data to the specified destination by copying it from the DICOM # store. - # Errors are also logged to Stackdriver Logging. For more information, - # see [Viewing logs](/healthcare/docs/how-tos/stackdriver-logging). + # Errors are also logged to Cloud Logging. For more information, + # see [Viewing logs](/healthcare/docs/how-tos/logging). # The metadata field type is # OperationMetadata. # @param [String] name @@ -594,6 +597,9 @@ module Google # Requests for policies with any conditional bindings must specify version 3. # Policies without any conditional bindings may specify any valid value or # leave the field unset. + # To learn which resources support conditions in their IAM policies, see the + # [IAM + # documentation](https://cloud.google.com/iam/help/conditions/resource-policies). # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -623,8 +629,8 @@ module Google end # Imports data into the DICOM store by copying it from the specified source. - # Errors are logged to Stackdriver Logging. For more information, see - # [Viewing logs](/healthcare/docs/how-tos/stackdriver-logging). The + # Errors are logged to Cloud Logging. For more information, see + # [Viewing logs](/healthcare/docs/how-tos/logging). The # metadata field type is # OperationMetadata. # @param [String] name @@ -858,7 +864,7 @@ module Google # Sets the access control policy on the specified resource. Replaces any # existing policy. - # Can return Public Errors: NOT_FOUND, INVALID_ARGUMENT and PERMISSION_DENIED + # Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors. # @param [String] resource # REQUIRED: The resource for which the policy is being specified. # See the operation documentation for the appropriate value for this field. @@ -935,7 +941,7 @@ module Google # Returns permissions that a caller has on the specified resource. # If the resource does not exist, this will return an empty set of - # permissions, not a NOT_FOUND error. + # permissions, not a `NOT_FOUND` error. # Note: This operation is designed to be used for building permission-aware # UIs and command-line tools, not for authorization checking. This operation # may "fail open" without warning. @@ -1627,8 +1633,8 @@ module Google # response field type is # DeidentifyFhirStoreSummary. If errors occur, # error is set. - # Error details are also logged to Stackdriver - # (see [Viewing logs](/healthcare/docs/how-tos/stackdriver-logging)). + # Error details are also logged to Cloud Logging + # (see [Viewing logs](/healthcare/docs/how-tos/logging)). # @param [String] source_store # Source FHIR store resource name. For example, # `projects/`project_id`/locations/`location_id`/datasets/`dataset_id`/ @@ -1699,8 +1705,8 @@ module Google # GetOperation. # Immediate fatal errors appear in the # error field, errors are also logged - # to Stackdriver (see [Viewing - # logs](/healthcare/docs/how-tos/stackdriver-logging)). + # to Cloud Logging (see [Viewing + # logs](/healthcare/docs/how-tos/logging)). # Otherwise, when the operation finishes, a detailed response of type # ExportResourcesResponse is returned in the # response field. @@ -1784,6 +1790,9 @@ module Google # Requests for policies with any conditional bindings must specify version 3. # Policies without any conditional bindings may specify any valid value or # leave the field unset. + # To learn which resources support conditions in their IAM policies, see the + # [IAM + # documentation](https://cloud.google.com/iam/help/conditions/resource-policies). # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -1831,7 +1840,7 @@ module Google # if the input data contains invalid references or if some resources fail to # be imported, the FHIR store might be left in a state that violates # referential integrity. - # The import process does not trigger PubSub notification or BigQuery + # The import process does not trigger Pub/Sub notification or BigQuery # streaming update, regardless of how those are configured on the FHIR store. # If a resource with the specified ID already exists, the most recent # version of the resource is overwritten without creating a new historical @@ -1870,8 +1879,8 @@ module Google # GetOperation. # Immediate fatal errors appear in the # error field, errors are also logged - # to Stackdriver (see [Viewing - # logs](/healthcare/docs/how-tos/stackdriver-logging)). Otherwise, when the + # to Cloud Logging (see [Viewing + # logs](/healthcare/docs/how-tos/logging)). Otherwise, when the # operation finishes, a detailed response of type ImportResourcesResponse # is returned in the response field. # The metadata field type for this @@ -1993,95 +2002,9 @@ module Google execute_or_queue_command(command, &block) end - # Searches for resources in the given FHIR store according to criteria - # specified as query parameters. - # Implements the FHIR standard search interaction - # ([DSTU2](http://hl7.org/implement/standards/fhir/DSTU2/http.html#search), - # [STU3](http://hl7.org/implement/standards/fhir/STU3/http.html#search), - # [R4](http://hl7.org/implement/standards/fhir/R4/http.html#search)) - # using the search semantics described in the FHIR Search specification - # ([DSTU2](http://hl7.org/implement/standards/fhir/DSTU2/search.html), - # [STU3](http://hl7.org/implement/standards/fhir/STU3/search.html), - # [R4](http://hl7.org/implement/standards/fhir/R4/search.html)). - # Supports three methods of search defined by the specification: - # * `GET [base]?[parameters]` to search across all resources. - # * `GET [base]/[type]?[parameters]` to search resources of a specified - # type. - # * `POST [base]/[type]/_search?[parameters]` as an alternate form having - # the same semantics as the `GET` method. - # The `GET` methods do not support compartment searches. The `POST` method - # does not support `application/x-www-form-urlencoded` search parameters. - # On success, the response body will contain a JSON-encoded representation - # of a `Bundle` resource of type `searchset`, containing the results of the - # search. - # Errors generated by the FHIR store will contain a JSON-encoded - # `OperationOutcome` resource describing the reason for the error. If the - # request cannot be mapped to a valid API method on a FHIR store, a generic - # GCP error might be returned instead. - # The server's capability statement, retrieved through - # capabilities, indicates what search parameters - # are supported on each FHIR resource. A list of all search parameters - # defined by the specification can be found in the FHIR Search Parameter - # Registry - # ([STU3](http://hl7.org/implement/standards/fhir/STU3/searchparameter-registry. - # html), - # [R4](http://hl7.org/implement/standards/fhir/R4/searchparameter-registry.html)) - # . - # FHIR search parameters for DSTU2 can be found on each resource's definition - # page. - # Supported search modifiers: `:missing`, `:exact`, `:contains`, `:text`, - # `:in`, `:not-in`, `:above`, `:below`, `:[type]`, `:not`, and `:recurse`. - # Supported search result parameters: `_sort`, `_count`, `_include`, - # `_revinclude`, `_summary=text`, `_summary=data`, and `_elements`. - # The maximum number of search results returned defaults to 100, which can - # be overridden by the `_count` parameter up to a maximum limit of 1000. If - # there are additional results, the returned `Bundle` will contain - # pagination links. - # Resources with a total size larger than 5MB or a field count larger than - # 50,000 might not be fully searchable as the server might trim its generated - # search index in those cases. - # Note: FHIR resources are indexed asynchronously, so there might be a slight - # delay between the time a resource is created or changes and when the change - # is reflected in search results. - # @param [String] parent - # Name of the FHIR store to retrieve resources from. - # @param [String] resource_type - # The FHIR resource type to search, such as Patient or Observation. For a - # complete list, see the FHIR Resource Index - # ([DSTU2](http://hl7.org/implement/standards/fhir/DSTU2/resourcelist.html), - # [STU3](http://hl7.org/implement/standards/fhir/STU3/resourcelist.html), - # [R4](http://hl7.org/implement/standards/fhir/R4/resourcelist.html)). - # @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::HealthcareV1::HttpBody] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::HealthcareV1::HttpBody] - # - # @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 search_project_location_dataset_fhir_stores(parent, resource_type: nil, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:get, 'v1/{+parent}/fhir', options) - command.response_representation = Google::Apis::HealthcareV1::HttpBody::Representation - command.response_class = Google::Apis::HealthcareV1::HttpBody - command.params['parent'] = parent unless parent.nil? - command.query['resourceType'] = resource_type unless resource_type.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - execute_or_queue_command(command, &block) - end - # Sets the access control policy on the specified resource. Replaces any # existing policy. - # Can return Public Errors: NOT_FOUND, INVALID_ARGUMENT and PERMISSION_DENIED + # Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors. # @param [String] resource # REQUIRED: The resource for which the policy is being specified. # See the operation documentation for the appropriate value for this field. @@ -2117,7 +2040,7 @@ module Google # Returns permissions that a caller has on the specified resource. # If the resource does not exist, this will return an empty set of - # permissions, not a NOT_FOUND error. + # permissions, not a `NOT_FOUND` error. # Note: This operation is designed to be used for building permission-aware # UIs and command-line tools, not for authorization checking. This operation # may "fail open" without warning. @@ -2154,8 +2077,7 @@ module Google execute_or_queue_command(command, &block) end - # Retrieves all the resources directly referenced by a patient, as well as - # all of the resources in the patient compartment. + # Retrieves a Patient resource and resources related to that patient. # Implements the FHIR extended operation Patient-everything # ([DSTU2](http://hl7.org/implement/standards/fhir/DSTU2/patient-operations.html# # everything), @@ -2170,6 +2092,16 @@ module Google # `OperationOutcome` resource describing the reason for the error. If the # request cannot be mapped to a valid API method on a FHIR store, a generic # GCP error might be returned instead. + # The resources in scope for the response are: + # * The patient resource itself. + # * All the resources directly referenced by the patient resource. + # * Resources directly referencing the patient resource that meet the + # inclusion criteria. The inclusion criteria are based on the membership + # rules in the patient compartment definition + # ([DSTU2](http://hl7.org/fhir/DSTU2/compartment-patient.html), + # [STU3](http://www.hl7.org/fhir/stu3/compartmentdefinition-patient.html), + # [R4](http://hl7.org/fhir/R4/compartmentdefinition-patient.html)), which + # details the eligible resource types and referencing search parameters. # @param [String] name # Name of the `Patient` resource for which the information is required. # @param [Fixnum] _count @@ -2896,6 +2828,9 @@ module Google # Requests for policies with any conditional bindings must specify version 3. # Policies without any conditional bindings may specify any valid value or # leave the field unset. + # To learn which resources support conditions in their IAM policies, see the + # [IAM + # documentation](https://cloud.google.com/iam/help/conditions/resource-policies). # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -3008,7 +2943,7 @@ module Google # Sets the access control policy on the specified resource. Replaces any # existing policy. - # Can return Public Errors: NOT_FOUND, INVALID_ARGUMENT and PERMISSION_DENIED + # Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors. # @param [String] resource # REQUIRED: The resource for which the policy is being specified. # See the operation documentation for the appropriate value for this field. @@ -3044,7 +2979,7 @@ module Google # Returns permissions that a caller has on the specified resource. # If the resource does not exist, this will return an empty set of - # permissions, not a NOT_FOUND error. + # permissions, not a `NOT_FOUND` error. # Note: This operation is designed to be used for building permission-aware # UIs and command-line tools, not for authorization checking. This operation # may "fail open" without warning. diff --git a/generated/google/apis/healthcare_v1beta1.rb b/generated/google/apis/healthcare_v1beta1.rb index 2bc5b889c..d4c09be88 100644 --- a/generated/google/apis/healthcare_v1beta1.rb +++ b/generated/google/apis/healthcare_v1beta1.rb @@ -25,7 +25,7 @@ module Google # @see https://cloud.google.com/healthcare module HealthcareV1beta1 VERSION = 'V1beta1' - REVISION = '20200414' + REVISION = '20200501' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' diff --git a/generated/google/apis/healthcare_v1beta1/classes.rb b/generated/google/apis/healthcare_v1beta1/classes.rb index 1e1e8bdb7..2bd5da144 100644 --- a/generated/google/apis/healthcare_v1beta1/classes.rb +++ b/generated/google/apis/healthcare_v1beta1/classes.rb @@ -1658,7 +1658,7 @@ module Google # @return [String] attr_accessor :filter - # The [Cloud Pubsub](https://cloud.google.com/pubsub/docs/) topic that + # The [Cloud Pub/Sub](https://cloud.google.com/pubsub/docs/) topic that # notifications of changes are published on. Supplied by the client. The # notification is a `PubsubMessage` with the following fields: # * `PubsubMessage.Data` contains the resource name. @@ -1668,12 +1668,12 @@ module Google # published. # Note that notifications are only sent if the topic is non-empty. [Topic # names](https://cloud.google.com/pubsub/docs/overview#names) must be - # scoped to a project. cloud-healthcare@system.gserviceaccount.com must - # have publisher permissions on the given Pubsub topic. Not having adequate + # scoped to a project. Cloud Healthcare API service account must have + # publisher permissions on the given Pub/Sub topic. Not having adequate # permissions causes the calls that send notifications to fail. # If a notification cannot be published to Cloud Pub/Sub, errors will be - # logged to Stackdriver (see [Viewing logs](/healthcare/docs/how- - # tos/stackdriver-logging)). + # logged to Cloud Logging (see [Viewing logs](/healthcare/docs/how- + # tos/logging)). # Corresponds to the JSON property `pubsubTopic` # @return [String] attr_accessor :pubsub_topic @@ -2371,12 +2371,12 @@ module Google # Notifications are only sent if the topic is # non-empty. [Topic # names](https://cloud.google.com/pubsub/docs/overview#names) must be scoped - # to a project. cloud-healthcare@system.gserviceaccount.com must have - # publisher permissions on the given Cloud Pub/Sub topic. Not having adequate + # to a project. Cloud Healthcare API service account must have publisher + # permissions on the given Cloud Pub/Sub topic. Not having adequate # permissions causes the calls that send notifications to fail. # If a notification can't be published to Cloud Pub/Sub, errors are logged to - # Stackdriver (see [Viewing - # logs](/healthcare/docs/how-tos/stackdriver-logging)). If the number of + # Cloud Logging (see [Viewing + # logs](/healthcare/docs/how-tos/logging)). If the number of # errors exceeds a certain rate, some aren't submitted. # Corresponds to the JSON property `pubsubTopic` # @return [String] @@ -2489,7 +2489,7 @@ module Google # A link to audit and error logs in the log viewer. Error logs are generated # only by some operations, listed at - # https://cloud.google.com/healthcare/docs/how-tos/stackdriver-logging. + # [Viewing logs](/healthcare/docs/how-tos/logging). # Corresponds to the JSON property `logsUrl` # @return [String] attr_accessor :logs_url @@ -2596,10 +2596,13 @@ module Google # Google groups, and domains (such as G Suite). A `role` is a named list of # permissions; each `role` can be an IAM predefined role or a user-created # custom role. - # Optionally, a `binding` can specify a `condition`, which is a logical - # expression that allows access to a resource only if the expression evaluates - # to `true`. A condition can add constraints based on attributes of the - # request, the resource, or both. + # For some types of Google Cloud resources, a `binding` can also specify a + # `condition`, which is a logical expression that allows access to a resource + # only if the expression evaluates to `true`. A condition can add constraints + # based on attributes of the request, the resource, or both. To learn which + # resources support conditions in their IAM policies, see the + # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource- + # policies). # **JSON example:** # ` # "bindings": [ @@ -2614,7 +2617,9 @@ module Google # `, # ` # "role": "roles/resourcemanager.organizationViewer", - # "members": ["user:eve@example.com"], + # "members": [ + # "user:eve@example.com" + # ], # "condition": ` # "title": "expirable access", # "description": "Does not grant access after Sep 2020", @@ -2692,6 +2697,9 @@ module Google # the conditions in the version `3` policy are lost. # If a policy does not include any conditions, operations on that policy may # specify any valid version or leave the field unset. + # To learn which resources support conditions in their IAM policies, see the + # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource- + # policies). # Corresponds to the JSON property `version` # @return [Fixnum] attr_accessor :version @@ -3050,10 +3058,13 @@ module Google # Google groups, and domains (such as G Suite). A `role` is a named list of # permissions; each `role` can be an IAM predefined role or a user-created # custom role. - # Optionally, a `binding` can specify a `condition`, which is a logical - # expression that allows access to a resource only if the expression evaluates - # to `true`. A condition can add constraints based on attributes of the - # request, the resource, or both. + # For some types of Google Cloud resources, a `binding` can also specify a + # `condition`, which is a logical expression that allows access to a resource + # only if the expression evaluates to `true`. A condition can add constraints + # based on attributes of the request, the resource, or both. To learn which + # resources support conditions in their IAM policies, see the + # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource- + # policies). # **JSON example:** # ` # "bindings": [ @@ -3068,7 +3079,9 @@ module Google # `, # ` # "role": "roles/resourcemanager.organizationViewer", - # "members": ["user:eve@example.com"], + # "members": [ + # "user:eve@example.com" + # ], # "condition": ` # "title": "expirable access", # "description": "Does not grant access after Sep 2020", @@ -3106,8 +3119,7 @@ module Google # OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only # the fields in the mask will be modified. If no mask is provided, the # following default mask is used: - # paths: "bindings, etag" - # This field is only used by Cloud IAM. + # `paths: "bindings, etag"` # Corresponds to the JSON property `updateMask` # @return [String] attr_accessor :update_mask diff --git a/generated/google/apis/healthcare_v1beta1/service.rb b/generated/google/apis/healthcare_v1beta1/service.rb index f10ac4da8..55026243d 100644 --- a/generated/google/apis/healthcare_v1beta1/service.rb +++ b/generated/google/apis/healthcare_v1beta1/service.rb @@ -174,8 +174,8 @@ module Google # DICOM instances. The new de-identified dataset will not contain these # failed resources. Failed resource totals are tracked in # DeidentifySummary.failure_resource_count. - # Error details are also logged to Stackdriver Logging. For more information, - # see [Viewing logs](/healthcare/docs/how-tos/stackdriver-logging). + # Error details are also logged to Cloud Logging. For more information, + # see [Viewing logs](/healthcare/docs/how-tos/logging). # @param [String] source_dataset # Source dataset resource name. For example, # `projects/`project_id`/locations/`location_id`/datasets/`dataset_id``. @@ -286,6 +286,9 @@ module Google # Requests for policies with any conditional bindings must specify version 3. # Policies without any conditional bindings may specify any valid value or # leave the field unset. + # To learn which resources support conditions in their IAM policies, see the + # [IAM + # documentation](https://cloud.google.com/iam/help/conditions/resource-policies). # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -394,7 +397,7 @@ module Google # Sets the access control policy on the specified resource. Replaces any # existing policy. - # Can return Public Errors: NOT_FOUND, INVALID_ARGUMENT and PERMISSION_DENIED + # Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors. # @param [String] resource # REQUIRED: The resource for which the policy is being specified. # See the operation documentation for the appropriate value for this field. @@ -430,7 +433,7 @@ module Google # Returns permissions that a caller has on the specified resource. # If the resource does not exist, this will return an empty set of - # permissions, not a NOT_FOUND error. + # permissions, not a `NOT_FOUND` error. # Note: This operation is designed to be used for building permission-aware # UIs and command-line tools, not for authorization checking. This operation # may "fail open" without warning. @@ -480,6 +483,9 @@ module Google # Requests for policies with any conditional bindings must specify version 3. # Policies without any conditional bindings may specify any valid value or # leave the field unset. + # To learn which resources support conditions in their IAM policies, see the + # [IAM + # documentation](https://cloud.google.com/iam/help/conditions/resource-policies). # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -510,7 +516,7 @@ module Google # Sets the access control policy on the specified resource. Replaces any # existing policy. - # Can return Public Errors: NOT_FOUND, INVALID_ARGUMENT and PERMISSION_DENIED + # Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors. # @param [String] resource # REQUIRED: The resource for which the policy is being specified. # See the operation documentation for the appropriate value for this field. @@ -546,7 +552,7 @@ module Google # Returns permissions that a caller has on the specified resource. # If the resource does not exist, this will return an empty set of - # permissions, not a NOT_FOUND error. + # permissions, not a `NOT_FOUND` error. # Note: This operation is designed to be used for building permission-aware # UIs and command-line tools, not for authorization checking. This operation # may "fail open" without warning. @@ -633,8 +639,8 @@ module Google # DICOM instances. The output DICOM store will not contain # these failed resources. Failed resource totals are tracked in # DeidentifySummary.failure_resource_count. - # Error details are also logged to Stackdriver - # (see [Viewing logs](/healthcare/docs/how-tos/stackdriver-logging)). + # Error details are also logged to Cloud Logging + # (see [Viewing logs](/healthcare/docs/how-tos/logging)). # @param [String] source_store # Source DICOM store resource name. For example, # `projects/`project_id`/locations/`location_id`/datasets/`dataset_id`/ @@ -702,8 +708,8 @@ module Google # Exports data to the specified destination by copying it from the DICOM # store. - # Errors are also logged to Stackdriver Logging. For more information, - # see [Viewing logs](/healthcare/docs/how-tos/stackdriver-logging). + # Errors are also logged to Cloud Logging. For more information, + # see [Viewing logs](/healthcare/docs/how-tos/logging). # The metadata field type is # OperationMetadata. # @param [String] name @@ -784,6 +790,9 @@ module Google # Requests for policies with any conditional bindings must specify version 3. # Policies without any conditional bindings may specify any valid value or # leave the field unset. + # To learn which resources support conditions in their IAM policies, see the + # [IAM + # documentation](https://cloud.google.com/iam/help/conditions/resource-policies). # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -815,9 +824,8 @@ module Google # Imports data into the DICOM store by copying it from the specified source. # For errors, the Operation is populated with error details (in the form # of ImportDicomDataErrorDetails in error.details), which hold - # finer-grained error information. Errors are also logged to Stackdriver - # Logging. For more information, - # see [Viewing logs](/healthcare/docs/how-tos/stackdriver-logging). + # finer-grained error information. Errors are also logged to Cloud Logging. + # For more information, see [Viewing logs](/healthcare/docs/how-tos/logging). # The metadata field type is # OperationMetadata. # @param [String] name @@ -1051,7 +1059,7 @@ module Google # Sets the access control policy on the specified resource. Replaces any # existing policy. - # Can return Public Errors: NOT_FOUND, INVALID_ARGUMENT and PERMISSION_DENIED + # Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors. # @param [String] resource # REQUIRED: The resource for which the policy is being specified. # See the operation documentation for the appropriate value for this field. @@ -1128,7 +1136,7 @@ module Google # Returns permissions that a caller has on the specified resource. # If the resource does not exist, this will return an empty set of - # permissions, not a NOT_FOUND error. + # permissions, not a `NOT_FOUND` error. # Note: This operation is designed to be used for building permission-aware # UIs and command-line tools, not for authorization checking. This operation # may "fail open" without warning. @@ -1818,8 +1826,8 @@ module Google # error # details field type is # DeidentifyErrorDetails. - # Errors are also logged to Stackdriver - # (see [Viewing logs](/healthcare/docs/how-tos/stackdriver-logging)). + # Errors are also logged to Cloud Logging + # (see [Viewing logs](/healthcare/docs/how-tos/logging)). # @param [String] source_store # Source FHIR store resource name. For example, # `projects/`project_id`/locations/`location_id`/datasets/`dataset_id`/ @@ -1890,8 +1898,8 @@ module Google # GetOperation. # Immediate fatal errors appear in the # error field, errors are also logged - # to Stackdriver (see [Viewing - # logs](/healthcare/docs/how-tos/stackdriver-logging)). + # to Cloud Logging (see [Viewing + # logs](/healthcare/docs/how-tos/logging)). # Otherwise, when the operation finishes, a detailed response of type # ExportResourcesResponse is returned in the # response field. @@ -1975,6 +1983,9 @@ module Google # Requests for policies with any conditional bindings must specify version 3. # Policies without any conditional bindings may specify any valid value or # leave the field unset. + # To learn which resources support conditions in their IAM policies, see the + # [IAM + # documentation](https://cloud.google.com/iam/help/conditions/resource-policies). # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -2061,8 +2072,8 @@ module Google # GetOperation. # Immediate fatal errors appear in the # error field, errors are also logged - # to Stackdriver (see [Viewing - # logs](/healthcare/docs/how-tos/stackdriver-logging)). Otherwise, when the + # to Cloud Logging (see [Viewing + # logs](/healthcare/docs/how-tos/logging)). Otherwise, when the # operation finishes, a detailed response of type ImportResourcesResponse # is returned in the response field. # The metadata field type for this @@ -2184,95 +2195,9 @@ module Google execute_or_queue_command(command, &block) end - # Searches for resources in the given FHIR store according to criteria - # specified as query parameters. - # Implements the FHIR standard search interaction - # ([DSTU2](http://hl7.org/implement/standards/fhir/DSTU2/http.html#search), - # [STU3](http://hl7.org/implement/standards/fhir/STU3/http.html#search), - # [R4](http://hl7.org/implement/standards/fhir/R4/http.html#search)) - # using the search semantics described in the FHIR Search specification - # ([DSTU2](http://hl7.org/implement/standards/fhir/DSTU2/search.html), - # [STU3](http://hl7.org/implement/standards/fhir/STU3/search.html), - # [R4](http://hl7.org/implement/standards/fhir/R4/search.html)). - # Supports three methods of search defined by the specification: - # * `GET [base]?[parameters]` to search across all resources. - # * `GET [base]/[type]?[parameters]` to search resources of a specified - # type. - # * `POST [base]/[type]/_search?[parameters]` as an alternate form having - # the same semantics as the `GET` method. - # The `GET` methods do not support compartment searches. The `POST` method - # does not support `application/x-www-form-urlencoded` search parameters. - # On success, the response body will contain a JSON-encoded representation - # of a `Bundle` resource of type `searchset`, containing the results of the - # search. - # Errors generated by the FHIR store will contain a JSON-encoded - # `OperationOutcome` resource describing the reason for the error. If the - # request cannot be mapped to a valid API method on a FHIR store, a generic - # GCP error might be returned instead. - # The server's capability statement, retrieved through - # capabilities, indicates what search parameters - # are supported on each FHIR resource. A list of all search parameters - # defined by the specification can be found in the FHIR Search Parameter - # Registry - # ([STU3](http://hl7.org/implement/standards/fhir/STU3/searchparameter-registry. - # html), - # [R4](http://hl7.org/implement/standards/fhir/R4/searchparameter-registry.html)) - # . - # FHIR search parameters for DSTU2 can be found on each resource's definition - # page. - # Supported search modifiers: `:missing`, `:exact`, `:contains`, `:text`, - # `:in`, `:not-in`, `:above`, `:below`, `:[type]`, `:not`, and `:recurse`. - # Supported search result parameters: `_sort`, `_count`, `_include`, - # `_revinclude`, `_summary=text`, `_summary=data`, and `_elements`. - # The maximum number of search results returned defaults to 100, which can - # be overridden by the `_count` parameter up to a maximum limit of 1000. If - # there are additional results, the returned `Bundle` will contain - # pagination links. - # Resources with a total size larger than 5MB or a field count larger than - # 50,000 might not be fully searchable as the server might trim its generated - # search index in those cases. - # Note: FHIR resources are indexed asynchronously, so there might be a slight - # delay between the time a resource is created or changes and when the change - # is reflected in search results. - # @param [String] parent - # Name of the FHIR store to retrieve resources from. - # @param [String] resource_type - # The FHIR resource type to search, such as Patient or Observation. For a - # complete list, see the FHIR Resource Index - # ([DSTU2](http://hl7.org/implement/standards/fhir/DSTU2/resourcelist.html), - # [STU3](http://hl7.org/implement/standards/fhir/STU3/resourcelist.html), - # [R4](http://hl7.org/implement/standards/fhir/R4/resourcelist.html)). - # @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::HealthcareV1beta1::HttpBody] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::HealthcareV1beta1::HttpBody] - # - # @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 search_project_location_dataset_fhir_stores(parent, resource_type: nil, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:get, 'v1beta1/{+parent}/fhir', options) - command.response_representation = Google::Apis::HealthcareV1beta1::HttpBody::Representation - command.response_class = Google::Apis::HealthcareV1beta1::HttpBody - command.params['parent'] = parent unless parent.nil? - command.query['resourceType'] = resource_type unless resource_type.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - execute_or_queue_command(command, &block) - end - # Sets the access control policy on the specified resource. Replaces any # existing policy. - # Can return Public Errors: NOT_FOUND, INVALID_ARGUMENT and PERMISSION_DENIED + # Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors. # @param [String] resource # REQUIRED: The resource for which the policy is being specified. # See the operation documentation for the appropriate value for this field. @@ -2308,7 +2233,7 @@ module Google # Returns permissions that a caller has on the specified resource. # If the resource does not exist, this will return an empty set of - # permissions, not a NOT_FOUND error. + # permissions, not a `NOT_FOUND` error. # Note: This operation is designed to be used for building permission-aware # UIs and command-line tools, not for authorization checking. This operation # may "fail open" without warning. @@ -2519,8 +2444,7 @@ module Google execute_or_queue_command(command, &block) end - # Retrieves all the resources directly referenced by a patient, as well as - # all of the resources in the patient compartment. + # Retrieves a Patient resource and resources related to that patient. # Implements the FHIR extended operation Patient-everything # ([DSTU2](http://hl7.org/implement/standards/fhir/DSTU2/patient-operations.html# # everything), @@ -2535,6 +2459,16 @@ module Google # `OperationOutcome` resource describing the reason for the error. If the # request cannot be mapped to a valid API method on a FHIR store, a generic # GCP error might be returned instead. + # The resources in scope for the response are: + # * The patient resource itself. + # * All the resources directly referenced by the patient resource. + # * Resources directly referencing the patient resource that meet the + # inclusion criteria. The inclusion criteria are based on the membership + # rules in the patient compartment definition + # ([DSTU2](http://hl7.org/fhir/DSTU2/compartment-patient.html), + # [STU3](http://www.hl7.org/fhir/stu3/compartmentdefinition-patient.html), + # [R4](http://hl7.org/fhir/R4/compartmentdefinition-patient.html)), which + # details the eligible resource types and referencing search parameters. # @param [String] name # Name of the `Patient` resource for which the information is required. # @param [Fixnum] _count @@ -2675,6 +2609,8 @@ module Google # repository that can still be retrieved through vread # and related methods, unless they are removed by the # purge method. + # This method requires the`healthcare.fhirStores.searchResources` and + # `healthcare.fhirResources.delete` permissions on the parent FHIR store. # @param [String] parent # The name of the FHIR store this resource belongs to. # @param [String] type @@ -2731,6 +2667,9 @@ module Google # `OperationOutcome` resource describing the reason for the error. If the # request cannot be mapped to a valid API method on a FHIR store, a generic # GCP error might be returned instead. + # This method requires the`healthcare.fhirStores.searchResources` permission + # on the parent FHIR store and the `healthcare.fhirResources.patch` + # permission on the requested FHIR store resource. # @param [String] parent # The name of the FHIR store this resource belongs to. # @param [String] type @@ -2795,6 +2734,8 @@ module Google # `OperationOutcome` resource describing the reason for the error. If the # request cannot be mapped to a valid API method on a FHIR store, a generic # GCP error might be returned instead. + # This method requires the`healthcare.fhirStores.searchResources` and + # `healthcare.fhirResources.update` permissions on the parent FHIR store. # @param [String] parent # The name of the FHIR store this resource belongs to. # @param [String] type @@ -2962,6 +2903,12 @@ module Google # a JSON-encoded `OperationOutcome` resource describing the reason for the # error. If the request cannot be mapped to a valid API method on a FHIR # store, a generic GCP error might be returned instead. + # This method requires permission for executing the requests in the bundle. + # The `executeBundle` permission grants permission to execute the request in + # the bundle but you must grant sufficient permissions to execute the + # individual requests in the bundle. For example, if the bundle contains a + # `create` request, you must have permission to execute the `create` request. + # Logging is available for the `executeBundle` permission. # @param [String] parent # Name of the FHIR store in which this bundle will be executed. # @param [Google::Apis::HealthcareV1beta1::HttpBody] http_body_object @@ -3442,6 +3389,9 @@ module Google # Requests for policies with any conditional bindings must specify version 3. # Policies without any conditional bindings may specify any valid value or # leave the field unset. + # To learn which resources support conditions in their IAM policies, see the + # [IAM + # documentation](https://cloud.google.com/iam/help/conditions/resource-policies). # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -3554,7 +3504,7 @@ module Google # Sets the access control policy on the specified resource. Replaces any # existing policy. - # Can return Public Errors: NOT_FOUND, INVALID_ARGUMENT and PERMISSION_DENIED + # Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors. # @param [String] resource # REQUIRED: The resource for which the policy is being specified. # See the operation documentation for the appropriate value for this field. @@ -3590,7 +3540,7 @@ module Google # Returns permissions that a caller has on the specified resource. # If the resource does not exist, this will return an empty set of - # permissions, not a NOT_FOUND error. + # permissions, not a `NOT_FOUND` error. # Note: This operation is designed to be used for building permission-aware # UIs and command-line tools, not for authorization checking. This operation # may "fail open" without warning. diff --git a/generated/google/apis/jobs_v3p1beta1.rb b/generated/google/apis/jobs_v3p1beta1.rb index c62c9f476..dbf525963 100644 --- a/generated/google/apis/jobs_v3p1beta1.rb +++ b/generated/google/apis/jobs_v3p1beta1.rb @@ -26,7 +26,7 @@ module Google # @see https://cloud.google.com/talent-solution/job-search/docs/ module JobsV3p1beta1 VERSION = 'V3p1beta1' - REVISION = '20200505' + REVISION = '20200506' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' diff --git a/generated/google/apis/jobs_v3p1beta1/classes.rb b/generated/google/apis/jobs_v3p1beta1/classes.rb index b373da87d..e10a88fd2 100644 --- a/generated/google/apis/jobs_v3p1beta1/classes.rb +++ b/generated/google/apis/jobs_v3p1beta1/classes.rb @@ -808,10 +808,8 @@ module Google class CustomAttribute include Google::Apis::Core::Hashable - # Optional. If the `filterable` flag is true, the custom field values may be - # used for - # custom attribute filters JobQuery.custom_attribute_filter. - # If false, these values may not be used for custom attribute filters. + # Optional. If the `filterable` flag is true, custom field values are searchable. + # If false, values are not searchable. # Default is false. # Corresponds to the JSON property `filterable` # @return [Boolean] diff --git a/generated/google/apis/run_v1.rb b/generated/google/apis/run_v1.rb index dbb1172f3..949c59b0e 100644 --- a/generated/google/apis/run_v1.rb +++ b/generated/google/apis/run_v1.rb @@ -26,7 +26,7 @@ module Google # @see https://cloud.google.com/run/ module RunV1 VERSION = 'V1' - REVISION = '20200415' + REVISION = '20200505' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' diff --git a/generated/google/apis/run_v1/classes.rb b/generated/google/apis/run_v1/classes.rb index f43857f85..1f0bc968e 100644 --- a/generated/google/apis/run_v1/classes.rb +++ b/generated/google/apis/run_v1/classes.rb @@ -1250,40 +1250,6 @@ module Google end end - # IntOrString is a type that can hold an int32 or a string. When used in - # JSON or YAML marshalling and unmarshalling, it produces or consumes the - # inner type. This allows you to have, for example, a JSON field that can - # accept a name or number. - class IntOrString - include Google::Apis::Core::Hashable - - # The int value. - # Corresponds to the JSON property `intVal` - # @return [Fixnum] - attr_accessor :int_val - - # The string value. - # Corresponds to the JSON property `strVal` - # @return [String] - attr_accessor :str_val - - # The type of the value. - # Corresponds to the JSON property `type` - # @return [Fixnum] - attr_accessor :type - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @int_val = args[:int_val] if args.key?(:int_val) - @str_val = args[:str_val] if args.key?(:str_val) - @type = args[:type] if args.key?(:type) - end - end - # Cloud Run fully managed: not supported # Cloud Run for Anthos: supported # Maps a string key to a path within a volume. @@ -2101,10 +2067,13 @@ module Google # Google groups, and domains (such as G Suite). A `role` is a named list of # permissions; each `role` can be an IAM predefined role or a user-created # custom role. - # Optionally, a `binding` can specify a `condition`, which is a logical - # expression that allows access to a resource only if the expression evaluates - # to `true`. A condition can add constraints based on attributes of the - # request, the resource, or both. + # For some types of Google Cloud resources, a `binding` can also specify a + # `condition`, which is a logical expression that allows access to a resource + # only if the expression evaluates to `true`. A condition can add constraints + # based on attributes of the request, the resource, or both. To learn which + # resources support conditions in their IAM policies, see the + # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource- + # policies). # **JSON example:** # ` # "bindings": [ @@ -2119,7 +2088,9 @@ module Google # `, # ` # "role": "roles/resourcemanager.organizationViewer", - # "members": ["user:eve@example.com"], + # "members": [ + # "user:eve@example.com" + # ], # "condition": ` # "title": "expirable access", # "description": "Does not grant access after Sep 2020", @@ -2197,6 +2168,9 @@ module Google # the conditions in the version `3` policy are lost. # If a policy does not include any conditions, operations on that policy may # specify any valid version or leave the field unset. + # To learn which resources support conditions in their IAM policies, see the + # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource- + # policies). # Corresponds to the JSON property `version` # @return [Fixnum] attr_accessor :version @@ -3122,10 +3096,13 @@ module Google # Google groups, and domains (such as G Suite). A `role` is a named list of # permissions; each `role` can be an IAM predefined role or a user-created # custom role. - # Optionally, a `binding` can specify a `condition`, which is a logical - # expression that allows access to a resource only if the expression evaluates - # to `true`. A condition can add constraints based on attributes of the - # request, the resource, or both. + # For some types of Google Cloud resources, a `binding` can also specify a + # `condition`, which is a logical expression that allows access to a resource + # only if the expression evaluates to `true`. A condition can add constraints + # based on attributes of the request, the resource, or both. To learn which + # resources support conditions in their IAM policies, see the + # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource- + # policies). # **JSON example:** # ` # "bindings": [ @@ -3140,7 +3117,9 @@ module Google # `, # ` # "role": "roles/resourcemanager.organizationViewer", - # "members": ["user:eve@example.com"], + # "members": [ + # "user:eve@example.com" + # ], # "condition": ` # "title": "expirable access", # "description": "Does not grant access after Sep 2020", @@ -3388,12 +3367,15 @@ module Google # @return [String] attr_accessor :host - # IntOrString is a type that can hold an int32 or a string. When used in - # JSON or YAML marshalling and unmarshalling, it produces or consumes the - # inner type. This allows you to have, for example, a JSON field that can - # accept a name or number. + # Cloud Run fully managed: not supported + # Cloud Run for Anthos: supported + # Number or name of the port to access on the container. + # Number must be in the range 1 to 65535. + # Name must be an IANA_SVC_NAME. + # This field is currently limited to integer types only because of proto's + # inability to properly support the IntOrString golang type. # Corresponds to the JSON property `port` - # @return [Google::Apis::RunV1::IntOrString] + # @return [Fixnum] attr_accessor :port def initialize(**args) diff --git a/generated/google/apis/run_v1/representations.rb b/generated/google/apis/run_v1/representations.rb index 317f7ade3..23cf4d281 100644 --- a/generated/google/apis/run_v1/representations.rb +++ b/generated/google/apis/run_v1/representations.rb @@ -166,12 +166,6 @@ module Google include Google::Apis::Core::JsonObjectSupport end - class IntOrString - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - class KeyToPath class Representation < Google::Apis::Core::JsonRepresentation; end @@ -702,15 +696,6 @@ module Google end end - class IntOrString - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :int_val, as: 'intVal' - property :str_val, as: 'strVal' - property :type, as: 'type' - end - end - class KeyToPath # @private class Representation < Google::Apis::Core::JsonRepresentation @@ -1160,8 +1145,7 @@ module Google # @private class Representation < Google::Apis::Core::JsonRepresentation property :host, as: 'host' - property :port, as: 'port', class: Google::Apis::RunV1::IntOrString, decorator: Google::Apis::RunV1::IntOrString::Representation - + property :port, as: 'port' end end diff --git a/generated/google/apis/run_v1/service.rb b/generated/google/apis/run_v1/service.rb index 5430fc9fd..9db33cbc0 100644 --- a/generated/google/apis/run_v1/service.rb +++ b/generated/google/apis/run_v1/service.rb @@ -1807,6 +1807,9 @@ module Google # Requests for policies with any conditional bindings must specify version 3. # Policies without any conditional bindings may specify any valid value or # leave the field unset. + # To learn which resources support conditions in their IAM policies, see the + # [IAM + # documentation](https://cloud.google.com/iam/help/conditions/resource-policies). # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user diff --git a/generated/google/apis/run_v1alpha1.rb b/generated/google/apis/run_v1alpha1.rb index 0c2bd6be7..51800d861 100644 --- a/generated/google/apis/run_v1alpha1.rb +++ b/generated/google/apis/run_v1alpha1.rb @@ -26,7 +26,7 @@ module Google # @see https://cloud.google.com/run/ module RunV1alpha1 VERSION = 'V1alpha1' - REVISION = '20200415' + REVISION = '20200505' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' diff --git a/generated/google/apis/run_v1alpha1/classes.rb b/generated/google/apis/run_v1alpha1/classes.rb index a7e8075ac..80b2504de 100644 --- a/generated/google/apis/run_v1alpha1/classes.rb +++ b/generated/google/apis/run_v1alpha1/classes.rb @@ -3231,10 +3231,13 @@ module Google # Google groups, and domains (such as G Suite). A `role` is a named list of # permissions; each `role` can be an IAM predefined role or a user-created # custom role. - # Optionally, a `binding` can specify a `condition`, which is a logical - # expression that allows access to a resource only if the expression evaluates - # to `true`. A condition can add constraints based on attributes of the - # request, the resource, or both. + # For some types of Google Cloud resources, a `binding` can also specify a + # `condition`, which is a logical expression that allows access to a resource + # only if the expression evaluates to `true`. A condition can add constraints + # based on attributes of the request, the resource, or both. To learn which + # resources support conditions in their IAM policies, see the + # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource- + # policies). # **JSON example:** # ` # "bindings": [ @@ -3249,7 +3252,9 @@ module Google # `, # ` # "role": "roles/resourcemanager.organizationViewer", - # "members": ["user:eve@example.com"], + # "members": [ + # "user:eve@example.com" + # ], # "condition": ` # "title": "expirable access", # "description": "Does not grant access after Sep 2020", @@ -3327,6 +3332,9 @@ module Google # the conditions in the version `3` policy are lost. # If a policy does not include any conditions, operations on that policy may # specify any valid version or leave the field unset. + # To learn which resources support conditions in their IAM policies, see the + # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource- + # policies). # Corresponds to the JSON property `version` # @return [Fixnum] attr_accessor :version @@ -4676,10 +4684,13 @@ module Google # Google groups, and domains (such as G Suite). A `role` is a named list of # permissions; each `role` can be an IAM predefined role or a user-created # custom role. - # Optionally, a `binding` can specify a `condition`, which is a logical - # expression that allows access to a resource only if the expression evaluates - # to `true`. A condition can add constraints based on attributes of the - # request, the resource, or both. + # For some types of Google Cloud resources, a `binding` can also specify a + # `condition`, which is a logical expression that allows access to a resource + # only if the expression evaluates to `true`. A condition can add constraints + # based on attributes of the request, the resource, or both. To learn which + # resources support conditions in their IAM policies, see the + # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource- + # policies). # **JSON example:** # ` # "bindings": [ @@ -4694,7 +4705,9 @@ module Google # `, # ` # "role": "roles/resourcemanager.organizationViewer", - # "members": ["user:eve@example.com"], + # "members": [ + # "user:eve@example.com" + # ], # "condition": ` # "title": "expirable access", # "description": "Does not grant access after Sep 2020", diff --git a/generated/google/apis/run_v1alpha1/service.rb b/generated/google/apis/run_v1alpha1/service.rb index a2797a1c2..be813bddb 100644 --- a/generated/google/apis/run_v1alpha1/service.rb +++ b/generated/google/apis/run_v1alpha1/service.rb @@ -3125,6 +3125,9 @@ module Google # Requests for policies with any conditional bindings must specify version 3. # Policies without any conditional bindings may specify any valid value or # leave the field unset. + # To learn which resources support conditions in their IAM policies, see the + # [IAM + # documentation](https://cloud.google.com/iam/help/conditions/resource-policies). # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user diff --git a/generated/google/apis/storage_v1.rb b/generated/google/apis/storage_v1.rb index 2938ee207..e77aab68f 100644 --- a/generated/google/apis/storage_v1.rb +++ b/generated/google/apis/storage_v1.rb @@ -25,7 +25,7 @@ module Google # @see https://developers.google.com/storage/docs/json_api/ module StorageV1 VERSION = 'V1' - REVISION = '20200410' + REVISION = '20200430' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' diff --git a/generated/google/apis/storage_v1/classes.rb b/generated/google/apis/storage_v1/classes.rb index 8348e9523..da040f21b 100644 --- a/generated/google/apis/storage_v1/classes.rb +++ b/generated/google/apis/storage_v1/classes.rb @@ -512,6 +512,15 @@ module Google # @return [Fixnum] attr_accessor :days_since_custom_time + # Number of days elapsed since the noncurrent timestamp of an object. The + # condition is satisfied if the days elapsed is at least this number. This + # condition is relevant only for versioned objects. The value of the field must + # be a nonnegative integer. If it's zero, the object version will become + # eligible for Lifecycle action as soon as it becomes noncurrent. + # Corresponds to the JSON property `daysSinceNoncurrentTime` + # @return [Fixnum] + attr_accessor :days_since_noncurrent_time + # Relevant only for versioned objects. If the value is true, this condition # matches live objects; if the value is false, it matches archived objects. # Corresponds to the JSON property `isLive` @@ -535,6 +544,13 @@ module Google # @return [Array] attr_accessor :matches_storage_class + # A timestamp in RFC 3339 format. This condition is satisfied when the + # noncurrent time on an object is before this timestamp. This condition is + # relevant only for versioned objects. + # Corresponds to the JSON property `noncurrentTimeBefore` + # @return [DateTime] + attr_accessor :noncurrent_time_before + # Relevant only for versioned objects. If the value is N, this condition is # satisfied when there are at least N versions (including the live version) # newer than this version of the object. @@ -552,9 +568,11 @@ module Google @created_before = args[:created_before] if args.key?(:created_before) @custom_time_before = args[:custom_time_before] if args.key?(:custom_time_before) @days_since_custom_time = args[:days_since_custom_time] if args.key?(:days_since_custom_time) + @days_since_noncurrent_time = args[:days_since_noncurrent_time] if args.key?(:days_since_noncurrent_time) @is_live = args[:is_live] if args.key?(:is_live) @matches_pattern = args[:matches_pattern] if args.key?(:matches_pattern) @matches_storage_class = args[:matches_storage_class] if args.key?(:matches_storage_class) + @noncurrent_time_before = args[:noncurrent_time_before] if args.key?(:noncurrent_time_before) @num_newer_versions = args[:num_newer_versions] if args.key?(:num_newer_versions) end end diff --git a/generated/google/apis/storage_v1/representations.rb b/generated/google/apis/storage_v1/representations.rb index a774c0966..303773209 100644 --- a/generated/google/apis/storage_v1/representations.rb +++ b/generated/google/apis/storage_v1/representations.rb @@ -406,9 +406,12 @@ module Google property :custom_time_before, as: 'customTimeBefore', type: DateTime property :days_since_custom_time, as: 'daysSinceCustomTime' + property :days_since_noncurrent_time, as: 'daysSinceNoncurrentTime' property :is_live, as: 'isLive' property :matches_pattern, as: 'matchesPattern' collection :matches_storage_class, as: 'matchesStorageClass' + property :noncurrent_time_before, as: 'noncurrentTimeBefore', type: DateTime + property :num_newer_versions, as: 'numNewerVersions' end end diff --git a/generated/google/apis/testing_v1.rb b/generated/google/apis/testing_v1.rb index 9ef6cc2d1..11262f612 100644 --- a/generated/google/apis/testing_v1.rb +++ b/generated/google/apis/testing_v1.rb @@ -26,7 +26,7 @@ module Google # @see https://developers.google.com/cloud-test-lab/ module TestingV1 VERSION = 'V1' - REVISION = '20200429' + REVISION = '20200508' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' diff --git a/generated/google/apis/testing_v1/classes.rb b/generated/google/apis/testing_v1/classes.rb index 425c32cc7..c6f5ae3ab 100644 --- a/generated/google/apis/testing_v1/classes.rb +++ b/generated/google/apis/testing_v1/classes.rb @@ -368,7 +368,8 @@ module Google # @return [Array] attr_accessor :tags - # URL of a thumbnail image of the device. + # URL of a thumbnail image (photo) of the device. + # e.g. https://lh3.googleusercontent.com/90WcauuJiCYABEl8U0lcZeuS5STUbf2yW... # Corresponds to the JSON property `thumbnailUrl` # @return [String] attr_accessor :thumbnail_url @@ -1209,7 +1210,7 @@ module Google end # A description of an iOS device tests may be run on. - # Next tag: 12 + # Next tag: 13 class IosModel include Google::Apis::Core::Hashable diff --git a/generated/google/apis/toolresults_v1beta3.rb b/generated/google/apis/toolresults_v1beta3.rb index f03b8616a..c84fc08b1 100644 --- a/generated/google/apis/toolresults_v1beta3.rb +++ b/generated/google/apis/toolresults_v1beta3.rb @@ -25,7 +25,7 @@ module Google # @see https://firebase.google.com/docs/test-lab/ module ToolresultsV1beta3 VERSION = 'V1beta3' - REVISION = '20200507' + REVISION = '20200513' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' diff --git a/generated/google/apis/toolresults_v1beta3/classes.rb b/generated/google/apis/toolresults_v1beta3/classes.rb index e56bf75de..a21268c8c 100644 --- a/generated/google/apis/toolresults_v1beta3/classes.rb +++ b/generated/google/apis/toolresults_v1beta3/classes.rb @@ -205,7 +205,7 @@ module Google attr_accessor :android_robo_test # Test Loops are tests that can be launched by the app itself, determining - # when to run by listening for an intent. go/ftl-games-dd + # when to run by listening for an intent. # Corresponds to the JSON property `androidTestLoop` # @return [Google::Apis::ToolresultsV1beta3::AndroidTestLoop] attr_accessor :android_test_loop @@ -235,7 +235,7 @@ module Google end # Test Loops are tests that can be launched by the app itself, determining - # when to run by listening for an intent. go/ftl-games-dd + # when to run by listening for an intent. class AndroidTestLoop include Google::Apis::Core::Hashable @@ -1142,6 +1142,13 @@ module Google # @return [String] attr_accessor :name + # The platform of the test history. + # - In response: always set. Returns the platform of the last execution if + # unknown. + # Corresponds to the JSON property `testPlatform` + # @return [String] + attr_accessor :test_platform + def initialize(**args) update!(**args) end @@ -1151,6 +1158,7 @@ module Google @display_name = args[:display_name] if args.key?(:display_name) @history_id = args[:history_id] if args.key?(:history_id) @name = args[:name] if args.key?(:name) + @test_platform = args[:test_platform] if args.key?(:test_platform) end end @@ -1341,6 +1349,131 @@ module Google end end + # iOS app information + class IosAppInfo + include Google::Apis::Core::Hashable + + # The name of the app. + # Required + # Corresponds to the JSON property `name` + # @return [String] + attr_accessor :name + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @name = args[:name] if args.key?(:name) + end + end + + # A Robo test for an iOS application. + class IosRoboTest + include Google::Apis::Core::Hashable + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + end + end + + # A iOS mobile test specification + class IosTest + include Google::Apis::Core::Hashable + + # iOS app information + # Corresponds to the JSON property `iosAppInfo` + # @return [Google::Apis::ToolresultsV1beta3::IosAppInfo] + attr_accessor :ios_app_info + + # A Robo test for an iOS application. + # Corresponds to the JSON property `iosRoboTest` + # @return [Google::Apis::ToolresultsV1beta3::IosRoboTest] + attr_accessor :ios_robo_test + + # A game loop test of an iOS application. + # Corresponds to the JSON property `iosTestLoop` + # @return [Google::Apis::ToolresultsV1beta3::IosTestLoop] + attr_accessor :ios_test_loop + + # A test of an iOS application that uses the XCTest framework. + # Corresponds to the JSON property `iosXcTest` + # @return [Google::Apis::ToolresultsV1beta3::IosXcTest] + attr_accessor :ios_xc_test + + # A Duration represents a signed, fixed-length span of time represented + # as a count of seconds and fractions of seconds at nanosecond + # resolution. It is independent of any calendar and concepts like "day" + # or "month". It is related to Timestamp in that the difference between + # two Timestamp values is a Duration and it can be added or subtracted + # from a Timestamp. Range is approximately +-10,000 years. + # Corresponds to the JSON property `testTimeout` + # @return [Google::Apis::ToolresultsV1beta3::Duration] + attr_accessor :test_timeout + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @ios_app_info = args[:ios_app_info] if args.key?(:ios_app_info) + @ios_robo_test = args[:ios_robo_test] if args.key?(:ios_robo_test) + @ios_test_loop = args[:ios_test_loop] if args.key?(:ios_test_loop) + @ios_xc_test = args[:ios_xc_test] if args.key?(:ios_xc_test) + @test_timeout = args[:test_timeout] if args.key?(:test_timeout) + end + end + + # A game loop test of an iOS application. + class IosTestLoop + include Google::Apis::Core::Hashable + + # Bundle ID of the app. + # Corresponds to the JSON property `bundleId` + # @return [String] + attr_accessor :bundle_id + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @bundle_id = args[:bundle_id] if args.key?(:bundle_id) + end + end + + # A test of an iOS application that uses the XCTest framework. + class IosXcTest + include Google::Apis::Core::Hashable + + # Bundle ID of the app. + # Corresponds to the JSON property `bundleId` + # @return [String] + attr_accessor :bundle_id + + # Xcode version that the test was run with. + # Corresponds to the JSON property `xcodeVersion` + # @return [String] + attr_accessor :xcode_version + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @bundle_id = args[:bundle_id] if args.key?(:bundle_id) + @xcode_version = args[:xcode_version] if args.key?(:xcode_version) + end + end + # Failed to find the launcher activity of an app. class LauncherActivityNotFound include Google::Apis::Core::Hashable @@ -2591,6 +2724,11 @@ module Google # @return [Google::Apis::ToolresultsV1beta3::AndroidTest] attr_accessor :android_test + # A iOS mobile test specification + # Corresponds to the JSON property `iosTest` + # @return [Google::Apis::ToolresultsV1beta3::IosTest] + attr_accessor :ios_test + def initialize(**args) update!(**args) end @@ -2598,6 +2736,7 @@ module Google # Update properties of this object def update!(**args) @android_test = args[:android_test] if args.key?(:android_test) + @ios_test = args[:ios_test] if args.key?(:ios_test) end end diff --git a/generated/google/apis/toolresults_v1beta3/representations.rb b/generated/google/apis/toolresults_v1beta3/representations.rb index 94a501b42..305c4f10c 100644 --- a/generated/google/apis/toolresults_v1beta3/representations.rb +++ b/generated/google/apis/toolresults_v1beta3/representations.rb @@ -226,6 +226,36 @@ module Google include Google::Apis::Core::JsonObjectSupport end + class IosAppInfo + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class IosRoboTest + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class IosTest + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class IosTestLoop + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class IosXcTest + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class LauncherActivityNotFound class Representation < Google::Apis::Core::JsonRepresentation; end @@ -912,6 +942,7 @@ module Google property :display_name, as: 'displayName' property :history_id, as: 'historyId' property :name, as: 'name' + property :test_platform, as: 'testPlatform' end end @@ -970,6 +1001,50 @@ module Google end end + class IosAppInfo + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :name, as: 'name' + end + end + + class IosRoboTest + # @private + class Representation < Google::Apis::Core::JsonRepresentation + end + end + + class IosTest + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :ios_app_info, as: 'iosAppInfo', class: Google::Apis::ToolresultsV1beta3::IosAppInfo, decorator: Google::Apis::ToolresultsV1beta3::IosAppInfo::Representation + + property :ios_robo_test, as: 'iosRoboTest', class: Google::Apis::ToolresultsV1beta3::IosRoboTest, decorator: Google::Apis::ToolresultsV1beta3::IosRoboTest::Representation + + property :ios_test_loop, as: 'iosTestLoop', class: Google::Apis::ToolresultsV1beta3::IosTestLoop, decorator: Google::Apis::ToolresultsV1beta3::IosTestLoop::Representation + + property :ios_xc_test, as: 'iosXcTest', class: Google::Apis::ToolresultsV1beta3::IosXcTest, decorator: Google::Apis::ToolresultsV1beta3::IosXcTest::Representation + + property :test_timeout, as: 'testTimeout', class: Google::Apis::ToolresultsV1beta3::Duration, decorator: Google::Apis::ToolresultsV1beta3::Duration::Representation + + end + end + + class IosTestLoop + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :bundle_id, as: 'bundleId' + end + end + + class IosXcTest + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :bundle_id, as: 'bundleId' + property :xcode_version, as: 'xcodeVersion' + end + end + class LauncherActivityNotFound # @private class Representation < Google::Apis::Core::JsonRepresentation @@ -1351,6 +1426,8 @@ module Google class Representation < Google::Apis::Core::JsonRepresentation property :android_test, as: 'androidTest', class: Google::Apis::ToolresultsV1beta3::AndroidTest, decorator: Google::Apis::ToolresultsV1beta3::AndroidTest::Representation + property :ios_test, as: 'iosTest', class: Google::Apis::ToolresultsV1beta3::IosTest, decorator: Google::Apis::ToolresultsV1beta3::IosTest::Representation + end end diff --git a/generated/google/apis/youtube_partner_v1.rb b/generated/google/apis/youtube_partner_v1.rb index a25a0ebe3..7ce90520c 100644 --- a/generated/google/apis/youtube_partner_v1.rb +++ b/generated/google/apis/youtube_partner_v1.rb @@ -25,7 +25,7 @@ module Google # @see https://developers.google.com/youtube/partner/ module YoutubePartnerV1 VERSION = 'V1' - REVISION = '20200422' + REVISION = '20200505' # View and manage your assets and associated content on YouTube AUTH_YOUTUBEPARTNER = 'https://www.googleapis.com/auth/youtubepartner'