google-api-client 0.39.1 → 0.40.0

data/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'

data/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 = '20200519'
 
       # View and manage your data in Google BigQuery
       AUTH_BIGQUERY = 'https://www.googleapis.com/auth/bigquery'

data/generated/google/apis/bigqueryreservation_v1beta1/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
@@ -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
@@ -132,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
@@ -157,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
@@ -325,6 +292,8 @@ module Google
         # Ids of capacity commitments to merge.
         # These capacity commitments must exist under admin project and location
         # specified in the parent.
+        # ID is the last portion of capacity commitment name e.g., 'abc' for
+        # projects/myproject/locations/US/capacityCommitments/abc
         # Corresponds to the JSON property `capacityCommitmentIds`
         # @return [Array<String>]
         attr_accessor :capacity_commitment_ids
@@ -341,15 +310,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
@@ -368,18 +338,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.
@@ -389,7 +347,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
@@ -412,7 +370,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)
@@ -471,8 +428,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`
@@ -482,8 +440,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`

data/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'

data/generated/google/apis/bigqueryreservation_v1beta1/service.rb

@@ -80,34 +80,36 @@ 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
         #   location),
         #   e.g.:
-        #   "projects/myproject/locations/US".
+        #   `projects/myproject/locations/US`.
         # @param [Fixnum] page_size
         #   The maximum number of items to return.
         # @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
@@ -139,8 +141,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.
@@ -184,7 +186,7 @@ module Google
         # Creates a new capacity commitment resource.
         # @param [String] parent
         #   Required. Resource name of the parent reservation. E.g.,
-        #   projects/myproject/locations/US
+        #   `projects/myproject/locations/US`
         # @param [Google::Apis::BigqueryreservationV1beta1::CapacityCommitment] capacity_commitment_object
         # @param [Boolean] enforce_single_admin_project_per_org
         #   If true, fail the request if another project in the organization has a
@@ -224,7 +226,7 @@ module Google
         # `google.rpc.Code.FAILED_PRECONDITION`.
         # @param [String] name
         #   Required. Resource name of the capacity commitment to delete. E.g.,
-        #   projects/myproject/locations/US/capacityCommitments/123
+        #   `projects/myproject/locations/US/capacityCommitments/123`
         # @param [String] fields
         #   Selector specifying which fields to include in a partial response.
         # @param [String] quota_user
@@ -255,7 +257,7 @@ module Google
         # Returns information about the capacity commitment.
         # @param [String] name
         #   Required. Resource name of the capacity commitment to retrieve. E.g.,
-        #   projects/myproject/locations/US/capacityCommitments/123
+        #   `projects/myproject/locations/US/capacityCommitments/123`
         # @param [String] fields
         #   Selector specifying which fields to include in a partial response.
         # @param [String] quota_user
@@ -286,7 +288,7 @@ module Google
         # Lists all the capacity commitments for the admin project.
         # @param [String] parent
         #   Required. Resource name of the parent reservation. E.g.,
-        #   projects/myproject/locations/US
+        #   `projects/myproject/locations/US`
         # @param [Fixnum] page_size
         #   The maximum number of items to return.
         # @param [String] page_token
@@ -320,13 +322,14 @@ 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
+        #   `projects/myproject/locations/us`
         # @param [Google::Apis::BigqueryreservationV1beta1::MergeCapacityCommitmentsRequest] merge_capacity_commitments_request_object
         # @param [String] fields
         #   Selector specifying which fields to include in a partial response.
@@ -358,13 +361,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::BigqueryreservationV1beta1::CapacityCommitment] capacity_commitment_object
         # @param [String] update_mask
         #   Standard field mask for the set of fields to be updated.
@@ -399,13 +402,14 @@ 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
+        #   `projects/myproject/locations/US/capacityCommitments/123`
         # @param [Google::Apis::BigqueryreservationV1beta1::SplitCapacityCommitmentRequest] split_capacity_commitment_request_object
         # @param [String] fields
         #   Selector specifying which fields to include in a partial response.
@@ -439,7 +443,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::BigqueryreservationV1beta1::Reservation] reservation_object
         # @param [String] reservation_id
         #   The reservation ID. This field must only contain lower case alphanumeric
@@ -479,7 +483,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
@@ -510,7 +514,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
@@ -541,7 +545,7 @@ module Google
         # Lists all the reservations for the project in the specified location.
         # @param [String] parent
         #   Required. The parent resource name containing project and location, e.g.:
-        #   "projects/myproject/locations/US"
+        #   `projects/myproject/locations/US`
         # @param [String] filter
         #   Can be used to filter out reservations based on names, capacity, etc, e.g.:
         #   filter="reservation.slot_capacity > 200"
@@ -585,7 +589,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::BigqueryreservationV1beta1::Reservation] reservation_object
         # @param [String] update_mask
         #   Standard field mask for the set of fields to be updated.
@@ -619,6 +623,24 @@ module Google
           execute_or_queue_command(command, &block)
         end
         
+        # 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
+        # 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.
+        # 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.
@@ -626,7 +648,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::BigqueryreservationV1beta1::Assignment] assignment_object
         # @param [String] fields
         #   Selector specifying which fields to include in a partial response.
@@ -658,18 +680,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:
-        # <organizationA, res1>
-        # <project1, res1>
-        # Then deletion of <organizationA, res1> won't affect <project1, res1>. After
-        # deletion of <organizationA, res1>, 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: `<organizationA, res1>`
+        # and `<project1, res1>`
+        # In this example, deletion of the `<organizationA, res1>` assignment won't
+        # affect the other assignment `<project1, res1>`. 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
@@ -698,22 +722,25 @@ 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:
-        # <organizationA, res1>
-        # <project1, res1>
-        # 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: `<organizationA, res1>`
+        # and `<project1, res1>`
+        # 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.
         # @param [String] page_token
@@ -747,16 +774,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::BigqueryreservationV1beta1::MoveAssignmentRequest] move_assignment_request_object
         # @param [String] fields
         #   Selector specifying which fields to include in a partial response.