From cb8c50c5f28961550a7d5956d92054797917e12b Mon Sep 17 00:00:00 2001 From: Google APIs Date: Fri, 14 Aug 2020 00:38:12 +0000 Subject: [PATCH] Autogenerated update (2020-08-14) Update: - bigqueryreservation_v1 - bigqueryreservation_v1beta1 - cloudresourcemanager_v1 - cloudresourcemanager_v1beta1 - cloudresourcemanager_v2 - cloudresourcemanager_v2beta1 - datacatalog_v1beta1 - dataproc_v1 - dataproc_v1beta2 - doubleclickbidmanager_v1 - doubleclickbidmanager_v1_1 - iamcredentials_v1 - ml_v1 - pubsub_v1 - pubsub_v1beta1a - pubsub_v1beta2 - spanner_v1 - sql_v1beta4 --- api_names_out.yaml | 20 + .../google/apis/bigqueryreservation_v1.rb | 2 +- .../apis/bigqueryreservation_v1/classes.rb | 12 + .../bigqueryreservation_v1/representations.rb | 2 + .../apis/bigqueryreservation_v1beta1.rb | 2 +- .../bigqueryreservation_v1beta1/classes.rb | 12 + .../representations.rb | 2 + .../google/apis/cloudresourcemanager_v1.rb | 2 +- .../apis/cloudresourcemanager_v1/service.rb | 2 +- .../apis/cloudresourcemanager_v1beta1.rb | 2 +- .../cloudresourcemanager_v1beta1/service.rb | 2 +- .../google/apis/cloudresourcemanager_v2.rb | 2 +- .../apis/cloudresourcemanager_v2beta1.rb | 2 +- generated/google/apis/datacatalog_v1beta1.rb | 2 +- .../apis/datacatalog_v1beta1/classes.rb | 955 ++--- .../apis/datacatalog_v1beta1/service.rb | 759 ++-- generated/google/apis/dataproc_v1.rb | 2 +- generated/google/apis/dataproc_v1/classes.rb | 41 +- .../apis/dataproc_v1/representations.rb | 16 + generated/google/apis/dataproc_v1beta2.rb | 2 +- .../google/apis/dataproc_v1beta2/classes.rb | 31 + .../apis/dataproc_v1beta2/representations.rb | 16 + .../google/apis/doubleclickbidmanager_v1.rb | 2 +- .../apis/doubleclickbidmanager_v1/classes.rb | 99 +- .../apis/doubleclickbidmanager_v1/service.rb | 20 +- .../google/apis/doubleclickbidmanager_v1_1.rb | 2 +- .../doubleclickbidmanager_v1_1/classes.rb | 135 +- .../doubleclickbidmanager_v1_1/service.rb | 32 +- generated/google/apis/iamcredentials_v1.rb | 2 +- .../google/apis/iamcredentials_v1/classes.rb | 156 +- .../google/apis/iamcredentials_v1/service.rb | 24 +- generated/google/apis/ml_v1.rb | 2 +- generated/google/apis/ml_v1/classes.rb | 1957 ++++----- .../google/apis/ml_v1/representations.rb | 17 + generated/google/apis/ml_v1/service.rb | 447 +- generated/google/apis/pubsub_v1.rb | 2 +- generated/google/apis/pubsub_v1/classes.rb | 905 ++-- generated/google/apis/pubsub_v1/service.rb | 466 +-- generated/google/apis/pubsub_v1beta1a.rb | 2 +- .../google/apis/pubsub_v1beta1a/classes.rb | 157 +- .../google/apis/pubsub_v1beta1a/service.rb | 69 +- generated/google/apis/pubsub_v1beta2.rb | 2 +- .../google/apis/pubsub_v1beta2/classes.rb | 598 ++- .../google/apis/pubsub_v1beta2/service.rb | 204 +- generated/google/apis/spanner_v1.rb | 2 +- generated/google/apis/spanner_v1/classes.rb | 3703 +++++++---------- generated/google/apis/spanner_v1/service.rb | 1061 ++--- generated/google/apis/sql_v1beta4.rb | 2 +- generated/google/apis/sql_v1beta4/classes.rb | 675 ++- .../apis/sql_v1beta4/representations.rb | 2 + generated/google/apis/sql_v1beta4/service.rb | 101 +- 51 files changed, 5497 insertions(+), 7237 deletions(-) diff --git a/api_names_out.yaml b/api_names_out.yaml index 019a9a293..3788345ca 100644 --- a/api_names_out.yaml +++ b/api_names_out.yaml @@ -14657,9 +14657,11 @@ "/bigqueryreservation:v1/Operation/response": response "/bigqueryreservation:v1/Operation/response/response": response "/bigqueryreservation:v1/Reservation": reservation +"/bigqueryreservation:v1/Reservation/creationTime": creation_time "/bigqueryreservation:v1/Reservation/ignoreIdleSlots": ignore_idle_slots "/bigqueryreservation:v1/Reservation/name": name "/bigqueryreservation:v1/Reservation/slotCapacity": slot_capacity +"/bigqueryreservation:v1/Reservation/updateTime": update_time "/bigqueryreservation:v1/SearchAllAssignmentsResponse": search_all_assignments_response "/bigqueryreservation:v1/SearchAllAssignmentsResponse/assignments": assignments "/bigqueryreservation:v1/SearchAllAssignmentsResponse/assignments/assignment": assignment @@ -14882,9 +14884,11 @@ "/bigqueryreservation:v1beta1/MoveAssignmentRequest": move_assignment_request "/bigqueryreservation:v1beta1/MoveAssignmentRequest/destinationId": destination_id "/bigqueryreservation:v1beta1/Reservation": reservation +"/bigqueryreservation:v1beta1/Reservation/creationTime": creation_time "/bigqueryreservation:v1beta1/Reservation/ignoreIdleSlots": ignore_idle_slots "/bigqueryreservation:v1beta1/Reservation/name": name "/bigqueryreservation:v1beta1/Reservation/slotCapacity": slot_capacity +"/bigqueryreservation:v1beta1/Reservation/updateTime": update_time "/bigqueryreservation:v1beta1/SearchAssignmentsResponse": search_assignments_response "/bigqueryreservation:v1beta1/SearchAssignmentsResponse/assignments": assignments "/bigqueryreservation:v1beta1/SearchAssignmentsResponse/assignments/assignment": assignment @@ -59652,12 +59656,17 @@ "/dataproc:v1/InstanceGroupConfig/imageUri": image_uri "/dataproc:v1/InstanceGroupConfig/instanceNames": instance_names "/dataproc:v1/InstanceGroupConfig/instanceNames/instance_name": instance_name +"/dataproc:v1/InstanceGroupConfig/instanceReferences": instance_references +"/dataproc:v1/InstanceGroupConfig/instanceReferences/instance_reference": instance_reference "/dataproc:v1/InstanceGroupConfig/isPreemptible": is_preemptible "/dataproc:v1/InstanceGroupConfig/machineTypeUri": machine_type_uri "/dataproc:v1/InstanceGroupConfig/managedGroupConfig": managed_group_config "/dataproc:v1/InstanceGroupConfig/minCpuPlatform": min_cpu_platform "/dataproc:v1/InstanceGroupConfig/numInstances": num_instances "/dataproc:v1/InstanceGroupConfig/preemptibility": preemptibility +"/dataproc:v1/InstanceReference": instance_reference +"/dataproc:v1/InstanceReference/instanceId": instance_id +"/dataproc:v1/InstanceReference/instanceName": instance_name "/dataproc:v1/InstantiateWorkflowTemplateRequest": instantiate_workflow_template_request "/dataproc:v1/InstantiateWorkflowTemplateRequest/parameters": parameters "/dataproc:v1/InstantiateWorkflowTemplateRequest/parameters/parameter": parameter @@ -60298,12 +60307,17 @@ "/dataproc:v1beta2/InstanceGroupConfig/imageUri": image_uri "/dataproc:v1beta2/InstanceGroupConfig/instanceNames": instance_names "/dataproc:v1beta2/InstanceGroupConfig/instanceNames/instance_name": instance_name +"/dataproc:v1beta2/InstanceGroupConfig/instanceReferences": instance_references +"/dataproc:v1beta2/InstanceGroupConfig/instanceReferences/instance_reference": instance_reference "/dataproc:v1beta2/InstanceGroupConfig/isPreemptible": is_preemptible "/dataproc:v1beta2/InstanceGroupConfig/machineTypeUri": machine_type_uri "/dataproc:v1beta2/InstanceGroupConfig/managedGroupConfig": managed_group_config "/dataproc:v1beta2/InstanceGroupConfig/minCpuPlatform": min_cpu_platform "/dataproc:v1beta2/InstanceGroupConfig/numInstances": num_instances "/dataproc:v1beta2/InstanceGroupConfig/preemptibility": preemptibility +"/dataproc:v1beta2/InstanceReference": instance_reference +"/dataproc:v1beta2/InstanceReference/instanceId": instance_id +"/dataproc:v1beta2/InstanceReference/instanceName": instance_name "/dataproc:v1beta2/InstantiateWorkflowTemplateRequest": instantiate_workflow_template_request "/dataproc:v1beta2/InstantiateWorkflowTemplateRequest/instanceId": instance_id "/dataproc:v1beta2/InstantiateWorkflowTemplateRequest/parameters": parameters @@ -107603,6 +107617,10 @@ "/ml:v1/GoogleCloudMlV1__Config/tpuServiceAccount": tpu_service_account "/ml:v1/GoogleCloudMlV1__EncryptionConfig": google_cloud_ml_v1__encryption_config "/ml:v1/GoogleCloudMlV1__EncryptionConfig/kmsKeyName": kms_key_name +"/ml:v1/GoogleCloudMlV1__EndpointMap": google_cloud_ml_v1__endpoint_map +"/ml:v1/GoogleCloudMlV1__EndpointMap/explain": explain +"/ml:v1/GoogleCloudMlV1__EndpointMap/health": health +"/ml:v1/GoogleCloudMlV1__EndpointMap/predict": predict "/ml:v1/GoogleCloudMlV1__ExplainRequest": google_cloud_ml_v1__explain_request "/ml:v1/GoogleCloudMlV1__ExplainRequest/httpBody": http_body "/ml:v1/GoogleCloudMlV1__ExplanationConfig": google_cloud_ml_v1__explanation_config @@ -107840,6 +107858,7 @@ "/ml:v1/GoogleCloudMlV1__Version/createTime": create_time "/ml:v1/GoogleCloudMlV1__Version/deploymentUri": deployment_uri "/ml:v1/GoogleCloudMlV1__Version/description": description +"/ml:v1/GoogleCloudMlV1__Version/endpoints": endpoints "/ml:v1/GoogleCloudMlV1__Version/errorMessage": error_message "/ml:v1/GoogleCloudMlV1__Version/etag": etag "/ml:v1/GoogleCloudMlV1__Version/explanationConfig": explanation_config @@ -131381,6 +131400,7 @@ "/sql:v1beta4/User/password": password "/sql:v1beta4/User/project": project "/sql:v1beta4/User/sqlserverUserDetails": sqlserver_user_details +"/sql:v1beta4/User/type": type "/sql:v1beta4/UsersListResponse": users_list_response "/sql:v1beta4/UsersListResponse/items": items "/sql:v1beta4/UsersListResponse/items/item": item diff --git a/generated/google/apis/bigqueryreservation_v1.rb b/generated/google/apis/bigqueryreservation_v1.rb index 4c626f2ce..02cf7d292 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 = '20200801' + REVISION = '20200808' # 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 80ed411d9..55a9beb8b 100644 --- a/generated/google/apis/bigqueryreservation_v1/classes.rb +++ b/generated/google/apis/bigqueryreservation_v1/classes.rb @@ -421,6 +421,11 @@ module Google class Reservation include Google::Apis::Core::Hashable + # Output only. Creation time of the reservation. + # Corresponds to the JSON property `creationTime` + # @return [String] + attr_accessor :creation_time + # 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. @@ -446,15 +451,22 @@ module Google # @return [Fixnum] attr_accessor :slot_capacity + # Output only. Last update time of the reservation. + # Corresponds to the JSON property `updateTime` + # @return [String] + attr_accessor :update_time + def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) + @creation_time = args[:creation_time] if args.key?(:creation_time) @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) + @update_time = args[:update_time] if args.key?(:update_time) end end diff --git a/generated/google/apis/bigqueryreservation_v1/representations.rb b/generated/google/apis/bigqueryreservation_v1/representations.rb index c44fa04f3..b4dc7d754 100644 --- a/generated/google/apis/bigqueryreservation_v1/representations.rb +++ b/generated/google/apis/bigqueryreservation_v1/representations.rb @@ -242,9 +242,11 @@ module Google class Reservation # @private class Representation < Google::Apis::Core::JsonRepresentation + property :creation_time, as: 'creationTime' property :ignore_idle_slots, as: 'ignoreIdleSlots' property :name, as: 'name' property :slot_capacity, :numeric_string => true, as: 'slotCapacity' + property :update_time, as: 'updateTime' end end diff --git a/generated/google/apis/bigqueryreservation_v1beta1.rb b/generated/google/apis/bigqueryreservation_v1beta1.rb index 1d16e6bdd..48a87c2b1 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 = '20200801' + REVISION = '20200808' # 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 050483e26..fe75c7e0d 100644 --- a/generated/google/apis/bigqueryreservation_v1beta1/classes.rb +++ b/generated/google/apis/bigqueryreservation_v1beta1/classes.rb @@ -334,6 +334,11 @@ module Google class Reservation include Google::Apis::Core::Hashable + # Output only. Creation time of the reservation. + # Corresponds to the JSON property `creationTime` + # @return [String] + attr_accessor :creation_time + # 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. @@ -359,15 +364,22 @@ module Google # @return [Fixnum] attr_accessor :slot_capacity + # Output only. Last update time of the reservation. + # Corresponds to the JSON property `updateTime` + # @return [String] + attr_accessor :update_time + def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) + @creation_time = args[:creation_time] if args.key?(:creation_time) @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) + @update_time = args[:update_time] if args.key?(:update_time) end end diff --git a/generated/google/apis/bigqueryreservation_v1beta1/representations.rb b/generated/google/apis/bigqueryreservation_v1beta1/representations.rb index 73a326693..23cd0c192 100644 --- a/generated/google/apis/bigqueryreservation_v1beta1/representations.rb +++ b/generated/google/apis/bigqueryreservation_v1beta1/representations.rb @@ -203,9 +203,11 @@ module Google class Reservation # @private class Representation < Google::Apis::Core::JsonRepresentation + property :creation_time, as: 'creationTime' property :ignore_idle_slots, as: 'ignoreIdleSlots' property :name, as: 'name' property :slot_capacity, :numeric_string => true, as: 'slotCapacity' + property :update_time, as: 'updateTime' end end diff --git a/generated/google/apis/cloudresourcemanager_v1.rb b/generated/google/apis/cloudresourcemanager_v1.rb index 6c202a83f..c14b6f019 100644 --- a/generated/google/apis/cloudresourcemanager_v1.rb +++ b/generated/google/apis/cloudresourcemanager_v1.rb @@ -26,7 +26,7 @@ module Google # @see https://cloud.google.com/resource-manager module CloudresourcemanagerV1 VERSION = 'V1' - REVISION = '20200720' + REVISION = '20200810' # 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/cloudresourcemanager_v1/service.rb b/generated/google/apis/cloudresourcemanager_v1/service.rb index 2809ff0a9..aa3bb3eca 100644 --- a/generated/google/apis/cloudresourcemanager_v1/service.rb +++ b/generated/google/apis/cloudresourcemanager_v1/service.rb @@ -1113,7 +1113,7 @@ module Google # caller has the `resourcemanager.projects.list` permission on the parent, the # results will be drawn from an alternate index which provides more consistent # results. In future versions of this API, this List method will be split into - # List and Search to properly capture the behavorial difference. + # List and Search to properly capture the behavioral difference. # @param [String] filter # An expression for filtering the results of the request. Filter rules are case # insensitive. Some eligible fields for filtering are: + `name` + `id` + `labels. diff --git a/generated/google/apis/cloudresourcemanager_v1beta1.rb b/generated/google/apis/cloudresourcemanager_v1beta1.rb index 5ee55e568..9bbd61ce9 100644 --- a/generated/google/apis/cloudresourcemanager_v1beta1.rb +++ b/generated/google/apis/cloudresourcemanager_v1beta1.rb @@ -26,7 +26,7 @@ module Google # @see https://cloud.google.com/resource-manager module CloudresourcemanagerV1beta1 VERSION = 'V1beta1' - REVISION = '20200720' + REVISION = '20200810' # 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/cloudresourcemanager_v1beta1/service.rb b/generated/google/apis/cloudresourcemanager_v1beta1/service.rb index 293a65ca4..b8c32dd83 100644 --- a/generated/google/apis/cloudresourcemanager_v1beta1/service.rb +++ b/generated/google/apis/cloudresourcemanager_v1beta1/service.rb @@ -466,7 +466,7 @@ module Google # caller has the `resourcemanager.projects.list` permission on the parent, the # results will be drawn from an alternate index which provides more consistent # results. In future versions of this API, this List method will be split into - # List and Search to properly capture the behavorial difference. + # List and Search to properly capture the behavioral difference. # @param [String] filter # An expression for filtering the results of the request. Filter rules are case # insensitive. The fields eligible for filtering are: + `name` + `id` + `labels.` diff --git a/generated/google/apis/cloudresourcemanager_v2.rb b/generated/google/apis/cloudresourcemanager_v2.rb index a6b23e049..0ca8f9642 100644 --- a/generated/google/apis/cloudresourcemanager_v2.rb +++ b/generated/google/apis/cloudresourcemanager_v2.rb @@ -26,7 +26,7 @@ module Google # @see https://cloud.google.com/resource-manager module CloudresourcemanagerV2 VERSION = 'V2' - REVISION = '20200720' + REVISION = '20200810' # 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/cloudresourcemanager_v2beta1.rb b/generated/google/apis/cloudresourcemanager_v2beta1.rb index 69bc635e3..beb9d4783 100644 --- a/generated/google/apis/cloudresourcemanager_v2beta1.rb +++ b/generated/google/apis/cloudresourcemanager_v2beta1.rb @@ -26,7 +26,7 @@ module Google # @see https://cloud.google.com/resource-manager module CloudresourcemanagerV2beta1 VERSION = 'V2beta1' - REVISION = '20200720' + REVISION = '20200810' # 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/datacatalog_v1beta1.rb b/generated/google/apis/datacatalog_v1beta1.rb index 182460807..a04041496 100644 --- a/generated/google/apis/datacatalog_v1beta1.rb +++ b/generated/google/apis/datacatalog_v1beta1.rb @@ -26,7 +26,7 @@ module Google # @see https://cloud.google.com/data-catalog/docs/ module DatacatalogV1beta1 VERSION = 'V1beta1' - REVISION = '20200728' + REVISION = '20200810' # 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/datacatalog_v1beta1/classes.rb b/generated/google/apis/datacatalog_v1beta1/classes.rb index 5da4a0a49..f04cd886c 100644 --- a/generated/google/apis/datacatalog_v1beta1/classes.rb +++ b/generated/google/apis/datacatalog_v1beta1/classes.rb @@ -26,69 +26,57 @@ module Google class Binding include Google::Apis::Core::Hashable - # Represents a textual expression in the Common Expression Language (CEL) - # syntax. CEL is a C-like expression language. The syntax and semantics of CEL - # are documented at https://github.com/google/cel-spec. - # Example (Comparison): - # title: "Summary size limit" - # description: "Determines if a summary is less than 100 chars" - # expression: "document.summary.size() < 100" - # Example (Equality): - # title: "Requestor is owner" - # description: "Determines if requestor is the document owner" - # expression: "document.owner == request.auth.claims.email" - # Example (Logic): - # title: "Public documents" - # description: "Determine whether the document should be publicly visible" - # expression: "document.type != 'private' && document.type != 'internal'" - # Example (Data Manipulation): - # title: "Notification string" - # description: "Create a notification string with a timestamp." - # expression: "'New message received at ' + string(document.create_time)" - # The exact variables and functions that may be referenced within an expression - # are determined by the service that evaluates it. See the service - # documentation for additional information. + # Represents a textual expression in the Common Expression Language (CEL) syntax. + # CEL is a C-like expression language. The syntax and semantics of CEL are + # documented at https://github.com/google/cel-spec. Example (Comparison): title: + # "Summary size limit" description: "Determines if a summary is less than 100 + # chars" expression: "document.summary.size() < 100" Example (Equality): title: " + # Requestor is owner" description: "Determines if requestor is the document + # owner" expression: "document.owner == request.auth.claims.email" Example ( + # Logic): title: "Public documents" description: "Determine whether the document + # should be publicly visible" expression: "document.type != 'private' && + # document.type != 'internal'" Example (Data Manipulation): title: "Notification + # string" description: "Create a notification string with a timestamp." + # expression: "'New message received at ' + string(document.create_time)" The + # exact variables and functions that may be referenced within an expression are + # determined by the service that evaluates it. See the service documentation for + # additional information. # Corresponds to the JSON property `condition` # @return [Google::Apis::DatacatalogV1beta1::Expr] attr_accessor :condition - # Specifies the identities requesting access for a Cloud Platform resource. - # `members` can have the following values: - # * `allUsers`: A special identifier that represents anyone who is - # on the internet; with or without a Google account. - # * `allAuthenticatedUsers`: A special identifier that represents anyone - # who is authenticated with a Google account or a service account. - # * `user:`emailid``: An email address that represents a specific Google - # account. For example, `alice@example.com` . - # * `serviceAccount:`emailid``: An email address that represents a service - # account. For example, `my-other-app@appspot.gserviceaccount.com`. - # * `group:`emailid``: An email address that represents a Google group. - # For example, `admins@example.com`. - # * `deleted:user:`emailid`?uid=`uniqueid``: An email address (plus unique - # identifier) representing a user that has been recently deleted. For - # example, `alice@example.com?uid=123456789012345678901`. If the user is - # recovered, this value reverts to `user:`emailid`` and the recovered user - # retains the role in the binding. - # * `deleted:serviceAccount:`emailid`?uid=`uniqueid``: An email address (plus - # unique identifier) representing a service account that has been recently - # deleted. For example, - # `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. - # If the service account is undeleted, this value reverts to - # `serviceAccount:`emailid`` and the undeleted service account retains the - # role in the binding. - # * `deleted:group:`emailid`?uid=`uniqueid``: An email address (plus unique - # identifier) representing a Google group that has been recently - # deleted. For example, `admins@example.com?uid=123456789012345678901`. If - # the group is recovered, this value reverts to `group:`emailid`` and the - # recovered group retains the role in the binding. - # * `domain:`domain``: The G Suite domain (primary) that represents all the - # users of that domain. For example, `google.com` or `example.com`. + # Specifies the identities requesting access for a Cloud Platform resource. ` + # members` can have the following values: * `allUsers`: A special identifier + # that represents anyone who is on the internet; with or without a Google + # account. * `allAuthenticatedUsers`: A special identifier that represents + # anyone who is authenticated with a Google account or a service account. * ` + # user:`emailid``: An email address that represents a specific Google account. + # For example, `alice@example.com` . * `serviceAccount:`emailid``: An email + # address that represents a service account. For example, `my-other-app@appspot. + # gserviceaccount.com`. * `group:`emailid``: An email address that represents a + # Google group. For example, `admins@example.com`. * `deleted:user:`emailid`?uid= + # `uniqueid``: An email address (plus unique identifier) representing a user + # that has been recently deleted. For example, `alice@example.com?uid= + # 123456789012345678901`. If the user is recovered, this value reverts to `user:` + # emailid`` and the recovered user retains the role in the binding. * `deleted: + # serviceAccount:`emailid`?uid=`uniqueid``: An email address (plus unique + # identifier) representing a service account that has been recently deleted. For + # example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. + # If the service account is undeleted, this value reverts to `serviceAccount:` + # emailid`` and the undeleted service account retains the role in the binding. * + # `deleted:group:`emailid`?uid=`uniqueid``: An email address (plus unique + # identifier) representing a Google group that has been recently deleted. For + # example, `admins@example.com?uid=123456789012345678901`. If the group is + # recovered, this value reverts to `group:`emailid`` and the recovered group + # retains the role in the binding. * `domain:`domain``: The G Suite domain ( + # primary) that represents all the users of that domain. For example, `google. + # com` or `example.com`. # Corresponds to the JSON property `members` # @return [Array] attr_accessor :members - # Role that is assigned to `members`. - # For example, `roles/viewer`, `roles/editor`, or `roles/owner`. + # Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor` + # , or `roles/owner`. # Corresponds to the JSON property `role` # @return [String] attr_accessor :role @@ -105,13 +93,11 @@ module Google end end - # A generic empty message that you can re-use to avoid defining duplicated - # empty messages in your APIs. A typical example is to use it as the request - # or the response type of an API method. For instance: - # service Foo ` - # rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); - # ` - # The JSON representation for `Empty` is empty JSON object ````. + # A generic empty message that you can re-use to avoid defining duplicated empty + # messages in your APIs. A typical example is to use it as the request or the + # response type of an API method. For instance: service Foo ` rpc Bar(google. + # protobuf.Empty) returns (google.protobuf.Empty); ` The JSON representation for + # `Empty` is empty JSON object ````. class Empty include Google::Apis::Core::Hashable @@ -124,52 +110,43 @@ module Google end end - # Represents a textual expression in the Common Expression Language (CEL) - # syntax. CEL is a C-like expression language. The syntax and semantics of CEL - # are documented at https://github.com/google/cel-spec. - # Example (Comparison): - # title: "Summary size limit" - # description: "Determines if a summary is less than 100 chars" - # expression: "document.summary.size() < 100" - # Example (Equality): - # title: "Requestor is owner" - # description: "Determines if requestor is the document owner" - # expression: "document.owner == request.auth.claims.email" - # Example (Logic): - # title: "Public documents" - # description: "Determine whether the document should be publicly visible" - # expression: "document.type != 'private' && document.type != 'internal'" - # Example (Data Manipulation): - # title: "Notification string" - # description: "Create a notification string with a timestamp." - # expression: "'New message received at ' + string(document.create_time)" - # The exact variables and functions that may be referenced within an expression - # are determined by the service that evaluates it. See the service - # documentation for additional information. + # Represents a textual expression in the Common Expression Language (CEL) syntax. + # CEL is a C-like expression language. The syntax and semantics of CEL are + # documented at https://github.com/google/cel-spec. Example (Comparison): title: + # "Summary size limit" description: "Determines if a summary is less than 100 + # chars" expression: "document.summary.size() < 100" Example (Equality): title: " + # Requestor is owner" description: "Determines if requestor is the document + # owner" expression: "document.owner == request.auth.claims.email" Example ( + # Logic): title: "Public documents" description: "Determine whether the document + # should be publicly visible" expression: "document.type != 'private' && + # document.type != 'internal'" Example (Data Manipulation): title: "Notification + # string" description: "Create a notification string with a timestamp." + # expression: "'New message received at ' + string(document.create_time)" The + # exact variables and functions that may be referenced within an expression are + # determined by the service that evaluates it. See the service documentation for + # additional information. class Expr include Google::Apis::Core::Hashable - # Optional. Description of the expression. This is a longer text which - # describes the expression, e.g. when hovered over it in a UI. + # Optional. Description of the expression. This is a longer text which describes + # the expression, e.g. when hovered over it in a UI. # Corresponds to the JSON property `description` # @return [String] attr_accessor :description - # Textual representation of an expression in Common Expression Language - # syntax. + # Textual representation of an expression in Common Expression Language syntax. # Corresponds to the JSON property `expression` # @return [String] attr_accessor :expression - # Optional. String indicating the location of the expression for error - # reporting, e.g. a file name and a position in the file. + # Optional. String indicating the location of the expression for error reporting, + # e.g. a file name and a position in the file. # Corresponds to the JSON property `location` # @return [String] attr_accessor :location - # Optional. Title for the expression, i.e. a short string describing - # its purpose. This can be used e.g. in UIs which allow to enter the - # expression. + # Optional. Title for the expression, i.e. a short string describing its purpose. + # This can be used e.g. in UIs which allow to enter the expression. # Corresponds to the JSON property `title` # @return [String] attr_accessor :title @@ -210,15 +187,13 @@ module Google class GetPolicyOptions include Google::Apis::Core::Hashable - # Optional. The policy format version to be returned. - # Valid values are 0, 1, and 3. Requests specifying an invalid value will be - # rejected. - # 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). + # Optional. The policy format version to be returned. Valid values are 0, 1, and + # 3. Requests specifying an invalid value will be rejected. 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). # Corresponds to the JSON property `requestedPolicyVersion` # @return [Fixnum] attr_accessor :requested_policy_version @@ -234,17 +209,14 @@ module Google end # Spec for a group of BigQuery tables with name pattern `[prefix]YYYYMMDD`. - # Context: - # https://cloud.google.com/bigquery/docs/partitioned-tables# + # Context: https://cloud.google.com/bigquery/docs/partitioned-tables# # partitioning_versus_sharding class GoogleCloudDatacatalogV1beta1BigQueryDateShardedSpec include Google::Apis::Core::Hashable # Output only. The Data Catalog resource name of the dataset entry the current - # table - # belongs to, for example, - # `projects/`project_id`/locations/`location`/entrygroups/`entry_group_id`/ - # entries/`entry_id``. + # table belongs to, for example, `projects/`project_id`/locations/`location`/ + # entrygroups/`entry_group_id`/entries/`entry_id``. # Corresponds to the JSON property `dataset` # @return [String] attr_accessor :dataset @@ -255,9 +227,8 @@ module Google attr_accessor :shard_count # Output only. The table name prefix of the shards. The name of any given shard - # is - # `[table_prefix]YYYYMMDD`, for example, for shard `MyTable20180101`, the - # `table_prefix` is `MyTable`. + # is `[table_prefix]YYYYMMDD`, for example, for shard `MyTable20180101`, the ` + # table_prefix` is `MyTable`. # Corresponds to the JSON property `tablePrefix` # @return [String] attr_accessor :table_prefix @@ -321,9 +292,8 @@ module Google attr_accessor :description # Optional. A column's mode indicates whether the values in this column are - # required, - # nullable, etc. Only `NULLABLE`, `REQUIRED` and `REPEATED` are supported. - # Default mode is `NULLABLE`. + # required, nullable, etc. Only `NULLABLE`, `REQUIRED` and `REPEATED` are + # supported. Default mode is `NULLABLE`. # Corresponds to the JSON property `mode` # @return [String] attr_accessor :mode @@ -352,21 +322,17 @@ module Google end end - # Entry Metadata. - # A Data Catalog Entry resource represents another resource in Google - # Cloud Platform (such as a BigQuery dataset or a Pub/Sub topic), or + # Entry Metadata. A Data Catalog Entry resource represents another resource in + # Google Cloud Platform (such as a BigQuery dataset or a Pub/Sub topic), or # outside of Google Cloud Platform. Clients can use the `linked_resource` field # in the Entry resource to refer to the original resource ID of the source - # system. - # An Entry resource contains resource details, such as its schema. An Entry can - # also be used to attach flexible metadata, such as a - # Tag. + # system. An Entry resource contains resource details, such as its schema. An + # Entry can also be used to attach flexible metadata, such as a Tag. class GoogleCloudDatacatalogV1beta1Entry include Google::Apis::Core::Hashable # Spec for a group of BigQuery tables with name pattern `[prefix]YYYYMMDD`. - # Context: - # https://cloud.google.com/bigquery/docs/partitioned-tables# + # Context: https://cloud.google.com/bigquery/docs/partitioned-tables# # partitioning_versus_sharding # Corresponds to the JSON property `bigqueryDateShardedSpec` # @return [Google::Apis::DatacatalogV1beta1::GoogleCloudDatacatalogV1beta1BigQueryDateShardedSpec] @@ -377,15 +343,15 @@ module Google # @return [Google::Apis::DatacatalogV1beta1::GoogleCloudDatacatalogV1beta1BigQueryTableSpec] attr_accessor :bigquery_table_spec - # Entry description, which can consist of several sentences or paragraphs - # that describe entry contents. Default value is an empty string. + # Entry description, which can consist of several sentences or paragraphs that + # describe entry contents. Default value is an empty string. # Corresponds to the JSON property `description` # @return [String] attr_accessor :description # Display information such as title and description. A short name to identify - # the entry, for example, "Analytics Data - Jan 2011". Default value is an - # empty string. + # the entry, for example, "Analytics Data - Jan 2011". Default value is an empty + # string. # Corresponds to the JSON property `displayName` # @return [String] attr_accessor :display_name @@ -401,26 +367,21 @@ module Google # @return [String] attr_accessor :integrated_system - # The resource this metadata entry refers to. - # For Google Cloud Platform resources, `linked_resource` is the [full name of - # the - # resource](https://cloud.google.com/apis/design/resource_names# - # full_resource_name). - # For example, the `linked_resource` for a table resource from BigQuery is: - # * //bigquery.googleapis.com/projects/projectId/datasets/datasetId/tables/ - # tableId - # Output only when Entry is of type in the EntryType enum. For entries with - # user_specified_type, this field is optional and defaults to an empty - # string. + # The resource this metadata entry refers to. For Google Cloud Platform + # resources, `linked_resource` is the [full name of the resource](https://cloud. + # google.com/apis/design/resource_names#full_resource_name). For example, the ` + # linked_resource` for a table resource from BigQuery is: * //bigquery. + # googleapis.com/projects/projectId/datasets/datasetId/tables/tableId Output + # only when Entry is of type in the EntryType enum. For entries with + # user_specified_type, this field is optional and defaults to an empty string. # Corresponds to the JSON property `linkedResource` # @return [String] attr_accessor :linked_resource - # The Data Catalog resource name of the entry in URL format. Example: - # * projects/`project_id`/locations/`location`/entryGroups/`entry_group_id`/ - # entries/`entry_id` - # Note that this Entry and its child resources may not actually be stored in - # the location in this name. + # The Data Catalog resource name of the entry in URL format. Example: * projects/ + # `project_id`/locations/`location`/entryGroups/`entry_group_id`/entries/` + # entry_id` Note that this Entry and its child resources may not actually be + # stored in the location in this name. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name @@ -435,30 +396,27 @@ module Google # @return [Google::Apis::DatacatalogV1beta1::GoogleCloudDatacatalogV1beta1SystemTimestamps] attr_accessor :source_system_timestamps - # The type of the entry. - # Only used for Entries with types in the EntryType enum. + # The type of the entry. Only used for Entries with types in the EntryType enum. # Corresponds to the JSON property `type` # @return [String] attr_accessor :type # This field indicates the entry's source system that Data Catalog does not - # integrate with. `user_specified_system` strings must begin with a letter - # or underscore and can only contain letters, numbers, and underscores; are - # case insensitive; must be at least 1 character and at most 64 characters - # long. + # integrate with. `user_specified_system` strings must begin with a letter or + # underscore and can only contain letters, numbers, and underscores; are case + # insensitive; must be at least 1 character and at most 64 characters long. # Corresponds to the JSON property `userSpecifiedSystem` # @return [String] attr_accessor :user_specified_system - # Entry type if it does not fit any of the input-allowed values listed in - # `EntryType` enum above. When creating an entry, users should check the - # enum values first, if nothing matches the entry to be created, then - # provide a custom value, for example "my_special_type". - # `user_specified_type` strings must begin with a letter or underscore and - # can only contain letters, numbers, and underscores; are case insensitive; - # must be at least 1 character and at most 64 characters long. - # Currently, only FILESET enum value is allowed. All other entries created - # through Data Catalog must use `user_specified_type`. + # Entry type if it does not fit any of the input-allowed values listed in ` + # EntryType` enum above. When creating an entry, users should check the enum + # values first, if nothing matches the entry to be created, then provide a + # custom value, for example "my_special_type". `user_specified_type` strings + # must begin with a letter or underscore and can only contain letters, numbers, + # and underscores; are case insensitive; must be at least 1 character and at + # most 64 characters long. Currently, only FILESET enum value is allowed. All + # other entries created through Data Catalog must use `user_specified_type`. # Corresponds to the JSON property `userSpecifiedType` # @return [String] attr_accessor :user_specified_type @@ -485,9 +443,8 @@ module Google end end - # EntryGroup Metadata. - # An EntryGroup resource represents a logical grouping of zero or more - # Data Catalog Entry resources. + # EntryGroup Metadata. An EntryGroup resource represents a logical grouping of + # zero or more Data Catalog Entry resources. class GoogleCloudDatacatalogV1beta1EntryGroup include Google::Apis::Core::Hashable @@ -496,23 +453,22 @@ module Google # @return [Google::Apis::DatacatalogV1beta1::GoogleCloudDatacatalogV1beta1SystemTimestamps] attr_accessor :data_catalog_timestamps - # Entry group description, which can consist of several sentences or - # paragraphs that describe entry group contents. Default value is an empty - # string. + # Entry group description, which can consist of several sentences or paragraphs + # that describe entry group contents. Default value is an empty string. # Corresponds to the JSON property `description` # @return [String] attr_accessor :description - # A short name to identify the entry group, for example, - # "analytics data - jan 2011". Default value is an empty string. + # A short name to identify the entry group, for example, "analytics data - jan + # 2011". Default value is an empty string. # Corresponds to the JSON property `displayName` # @return [String] attr_accessor :display_name - # The resource name of the entry group in URL format. Example: - # * projects/`project_id`/locations/`location`/entryGroups/`entry_group_id` - # Note that this EntryGroup and its child resources may not actually be - # stored in the location in this name. + # The resource name of the entry group in URL format. Example: * projects/` + # project_id`/locations/`location`/entryGroups/`entry_group_id` Note that this + # EntryGroup and its child resources may not actually be stored in the location + # in this name. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name @@ -530,8 +486,7 @@ module Google end end - # Response message for - # ExportTaxonomies. + # Response message for ExportTaxonomies. class GoogleCloudDatacatalogV1beta1ExportTaxonomiesResponse include Google::Apis::Core::Hashable @@ -581,14 +536,14 @@ module Google # The set of allowed values for this enum. This set must not be empty, the # display names of the values in this set must not be empty and the display - # names of the values must be case-insensitively unique within this set. - # The order of items in this list is preserved. This field can be used to - # Required on create; optional on update. The set of allowed values for - # this enum. This set must not be empty, the display names of the values in - # this set must not be empty and the display names of the values must be - # case-insensitively unique within this set. Currently, enum values can - # only be added to the list of allowed values. Deletion and renaming of - # enum values are not supported. Can have up to 500 allowed values. + # names of the values must be case-insensitively unique within this set. The + # order of items in this list is preserved. This field can be used to Required + # on create; optional on update. The set of allowed values for this enum. This + # set must not be empty, the display names of the values in this set must not be + # empty and the display names of the values must be case-insensitively unique + # within this set. Currently, enum values can only be added to the list of + # allowed values. Deletion and renaming of enum values are not supported. Can + # have up to 500 allowed values. # Corresponds to the JSON property `allowedValues` # @return [Array] attr_accessor :allowed_values @@ -657,38 +612,28 @@ module Google class GoogleCloudDatacatalogV1beta1GcsFilesetSpec include Google::Apis::Core::Hashable - # Required. Patterns to identify a set of files in Google Cloud Storage. - # See [Cloud Storage - # documentation](https://cloud.google.com/storage/docs/gsutil/addlhelp/ - # WildcardNames) - # for more information. Note that bucket wildcards are currently not - # supported. - # Examples of valid file_patterns: - # * `gs://bucket_name/dir/*`: matches all files within `bucket_name/dir` - # directory. - # * `gs://bucket_name/dir/**`: matches all files in `bucket_name/dir` - # spanning all subdirectories. - # * `gs://bucket_name/file*`: matches files prefixed by `file` in - # `bucket_name` - # * `gs://bucket_name/??.txt`: matches files with two characters followed by - # `.txt` in `bucket_name` - # * `gs://bucket_name/[aeiou].txt`: matches files that contain a single - # vowel character followed by `.txt` in - # `bucket_name` - # * `gs://bucket_name/[a-m].txt`: matches files that contain `a`, `b`, ... - # or `m` followed by `.txt` in `bucket_name` - # * `gs://bucket_name/a/*/b`: matches all files in `bucket_name` that match - # `a/*/b` pattern, such as `a/c/b`, `a/d/b` - # * `gs://another_bucket/a.txt`: matches `gs://another_bucket/a.txt` - # You can combine wildcards to provide more powerful matches, for example: - # * `gs://bucket_name/[a-m]??.j*g` + # Required. Patterns to identify a set of files in Google Cloud Storage. See [ + # Cloud Storage documentation](https://cloud.google.com/storage/docs/gsutil/ + # addlhelp/WildcardNames) for more information. Note that bucket wildcards are + # currently not supported. Examples of valid file_patterns: * `gs://bucket_name/ + # dir/*`: matches all files within `bucket_name/dir` directory. * `gs:// + # bucket_name/dir/**`: matches all files in `bucket_name/dir` spanning all + # subdirectories. * `gs://bucket_name/file*`: matches files prefixed by `file` + # in `bucket_name` * `gs://bucket_name/??.txt`: matches files with two + # characters followed by `.txt` in `bucket_name` * `gs://bucket_name/[aeiou].txt` + # : matches files that contain a single vowel character followed by `.txt` in ` + # bucket_name` * `gs://bucket_name/[a-m].txt`: matches files that contain `a`, ` + # b`, ... or `m` followed by `.txt` in `bucket_name` * `gs://bucket_name/a/*/b`: + # matches all files in `bucket_name` that match `a/*/b` pattern, such as `a/c/b`, + # `a/d/b` * `gs://another_bucket/a.txt`: matches `gs://another_bucket/a.txt` + # You can combine wildcards to provide more powerful matches, for example: * `gs: + # //bucket_name/[a-m]??.j*g` # Corresponds to the JSON property `filePatterns` # @return [Array] attr_accessor :file_patterns # Output only. Sample files contained in this fileset, not all files contained - # in this - # fileset are represented here. + # in this fileset are represented here. # Corresponds to the JSON property `sampleGcsFileSpecs` # @return [Array] attr_accessor :sample_gcs_file_specs @@ -704,8 +649,7 @@ module Google end end - # Request message for - # ImportTaxonomies. + # Request message for ImportTaxonomies. class GoogleCloudDatacatalogV1beta1ImportTaxonomiesRequest include Google::Apis::Core::Hashable @@ -724,8 +668,7 @@ module Google end end - # Response message for - # ImportTaxonomies. + # Response message for ImportTaxonomies. class GoogleCloudDatacatalogV1beta1ImportTaxonomiesResponse include Google::Apis::Core::Hashable @@ -763,8 +706,7 @@ module Google end end - # Response message for - # ListEntries. + # Response message for ListEntries. class GoogleCloudDatacatalogV1beta1ListEntriesResponse include Google::Apis::Core::Hashable @@ -790,8 +732,7 @@ module Google end end - # Response message for - # ListEntryGroups. + # Response message for ListEntryGroups. class GoogleCloudDatacatalogV1beta1ListEntryGroupsResponse include Google::Apis::Core::Hashable @@ -817,13 +758,12 @@ module Google end end - # Response message for - # ListPolicyTags. + # Response message for ListPolicyTags. class GoogleCloudDatacatalogV1beta1ListPolicyTagsResponse include Google::Apis::Core::Hashable - # Token used to retrieve the next page of results, or empty if there are no - # more results in the list. + # Token used to retrieve the next page of results, or empty if there are no more + # results in the list. # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token @@ -844,8 +784,7 @@ module Google end end - # Response message for - # ListTags. + # Response message for ListTags. class GoogleCloudDatacatalogV1beta1ListTagsResponse include Google::Apis::Core::Hashable @@ -871,13 +810,12 @@ module Google end end - # Response message for - # ListTaxonomies. + # Response message for ListTaxonomies. class GoogleCloudDatacatalogV1beta1ListTaxonomiesResponse include Google::Apis::Core::Hashable - # Token used to retrieve the next page of results, or empty if there are no - # more results in the list. + # Token used to retrieve the next page of results, or empty if there are no more + # results in the list. # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token @@ -898,10 +836,10 @@ module Google end end - # Denotes one policy tag in a taxonomy (e.g. ssn). Policy Tags can be defined - # in a hierarchy. For example, consider the following hierarchy: - # Geolocation -> (LatLong, City, ZipCode). PolicyTag "Geolocation" - # contains three child policy tags: "LatLong", "City", and "ZipCode". + # Denotes one policy tag in a taxonomy (e.g. ssn). Policy Tags can be defined in + # a hierarchy. For example, consider the following hierarchy: Geolocation -> ( + # LatLong, City, ZipCode). PolicyTag "Geolocation" contains three child policy + # tags: "LatLong", "City", and "ZipCode". class GoogleCloudDatacatalogV1beta1PolicyTag include Google::Apis::Core::Hashable @@ -910,36 +848,34 @@ module Google # @return [Array] attr_accessor :child_policy_tags - # Description of this policy tag. It must: contain only unicode characters, - # tabs, newlines, carriage returns and page breaks; and be at most 2000 bytes - # long when encoded in UTF-8. If not set, defaults to an empty description. - # If not set, defaults to an empty description. + # Description of this policy tag. It must: contain only unicode characters, tabs, + # newlines, carriage returns and page breaks; and be at most 2000 bytes long + # when encoded in UTF-8. If not set, defaults to an empty description. If not + # set, defaults to an empty description. # Corresponds to the JSON property `description` # @return [String] attr_accessor :description # Required. User defined name of this policy tag. It must: be unique within the - # parent - # taxonomy; contain only unicode letters, numbers, underscores, dashes and - # spaces; not start or end with spaces; and be at most 200 bytes long when + # parent taxonomy; contain only unicode letters, numbers, underscores, dashes + # and spaces; not start or end with spaces; and be at most 200 bytes long when # encoded in UTF-8. # Corresponds to the JSON property `displayName` # @return [String] attr_accessor :display_name - # Output only. Resource name of this policy tag, whose format is: - # "projects/`project_number`/locations/`location_id`/taxonomies/`taxonomy_id`/ - # policyTags/`id`". + # Output only. Resource name of this policy tag, whose format is: "projects/` + # project_number`/locations/`location_id`/taxonomies/`taxonomy_id`/policyTags/` + # id`". # Corresponds to the JSON property `name` # @return [String] attr_accessor :name - # Resource name of this policy tag's parent policy tag (e.g. for the - # "LatLong" policy tag in the example above, this field contains the - # resource name of the "Geolocation" policy tag). If empty, it means this - # policy tag is a top level policy tag (e.g. this field is empty for the - # "Geolocation" policy tag in the example above). If not set, defaults to an - # empty string. + # Resource name of this policy tag's parent policy tag (e.g. for the "LatLong" + # policy tag in the example above, this field contains the resource name of the " + # Geolocation" policy tag). If empty, it means this policy tag is a top level + # policy tag (e.g. this field is empty for the "Geolocation" policy tag in the + # example above). If not set, defaults to an empty string. # Corresponds to the JSON property `parentPolicyTag` # @return [String] attr_accessor :parent_policy_tag @@ -958,8 +894,7 @@ module Google end end - # Request message for - # RenameTagTemplateFieldEnumValue. + # Request message for RenameTagTemplateFieldEnumValue. class GoogleCloudDatacatalogV1beta1RenameTagTemplateFieldEnumValueRequest include Google::Apis::Core::Hashable @@ -979,8 +914,7 @@ module Google end end - # Request message for - # RenameTagTemplateField. + # Request message for RenameTagTemplateField. class GoogleCloudDatacatalogV1beta1RenameTagTemplateFieldRequest include Google::Apis::Core::Hashable @@ -1004,8 +938,7 @@ module Google include Google::Apis::Core::Hashable # Required. Schema of columns. A maximum of 10,000 columns and sub-columns can - # be - # specified. + # be specified. # Corresponds to the JSON property `columns` # @return [Array] attr_accessor :columns @@ -1020,17 +953,14 @@ module Google end end - # Request message for - # SearchCatalog. + # Request message for SearchCatalog. class GoogleCloudDatacatalogV1beta1SearchCatalogRequest include Google::Apis::Core::Hashable - # Specifies the ordering of results, currently supported case-sensitive - # choices are: - # * `relevance`, only supports descending - # * `last_modified_timestamp [asc|desc]`, defaults to descending if not - # specified - # If not specified, defaults to `relevance` descending. + # Specifies the ordering of results, currently supported case-sensitive choices + # are: * `relevance`, only supports descending * `last_modified_timestamp [asc| + # desc]`, defaults to descending if not specified If not specified, defaults to ` + # relevance` descending. # Corresponds to the JSON property `orderBy` # @return [String] attr_accessor :order_by @@ -1041,25 +971,21 @@ module Google # @return [Fixnum] attr_accessor :page_size - # Optional. Pagination token returned in an earlier - # SearchCatalogResponse.next_page_token, which - # indicates that this is a continuation of a prior - # SearchCatalogRequest - # call, and that the system should return the next page of data. If empty, - # the first page is returned. + # Optional. Pagination token returned in an earlier SearchCatalogResponse. + # next_page_token, which indicates that this is a continuation of a prior + # SearchCatalogRequest call, and that the system should return the next page of + # data. If empty, the first page is returned. # Corresponds to the JSON property `pageToken` # @return [String] attr_accessor :page_token - # Required. The query string in search query syntax. The query must be non-empty. - # Query strings can be simple as "x" or more qualified as: - # * name:x - # * column:x - # * description:y - # Note: Query tokens need to have a minimum of 3 characters for substring - # matching to work correctly. See [Data Catalog Search - # Syntax](https://cloud.google.com/data-catalog/docs/how-to/search-reference) - # for more information. + # Optional. The query string in search query syntax. An empty query string will + # result in all data assets (in the specified scope) that the user has access to. + # Query strings can be simple as "x" or more qualified as: * name:x * column:x * + # description:y Note: Query tokens need to have a minimum of 3 characters for + # substring matching to work correctly. See [Data Catalog Search Syntax](https:// + # cloud.google.com/data-catalog/docs/how-to/search-reference) for more + # information. # Corresponds to the JSON property `query` # @return [String] attr_accessor :query @@ -1087,63 +1013,40 @@ module Google class GoogleCloudDatacatalogV1beta1SearchCatalogRequestScope include Google::Apis::Core::Hashable - # If `true`, include Google Cloud Platform (GCP) public datasets in the - # search results. Info on GCP public datasets is available at - # https://cloud.google.com/public-datasets/. By default, GCP public - # datasets are excluded. + # If `true`, include Google Cloud Platform (GCP) public datasets in the search + # results. Info on GCP public datasets is available at https://cloud.google.com/ + # public-datasets/. By default, GCP public datasets are excluded. # Corresponds to the JSON property `includeGcpPublicDatasets` # @return [Boolean] attr_accessor :include_gcp_public_datasets alias_method :include_gcp_public_datasets?, :include_gcp_public_datasets - # The list of organization IDs to search within. To find your organization - # ID, follow instructions in - # https://cloud.google.com/resource-manager/docs/creating-managing-organization. + # The list of organization IDs to search within. To find your organization ID, + # follow instructions in https://cloud.google.com/resource-manager/docs/creating- + # managing-organization. # Corresponds to the JSON property `includeOrgIds` # @return [Array] attr_accessor :include_org_ids - # The list of project IDs to search within. To learn more about the - # distinction between project names/IDs/numbers, go to - # https://cloud.google.com/docs/overview/#projects. + # The list of project IDs to search within. To learn more about the distinction + # between project names/IDs/numbers, go to https://cloud.google.com/docs/ + # overview/#projects. # Corresponds to the JSON property `includeProjectIds` # @return [Array] attr_accessor :include_project_ids - # Optional. The list of locations to search within. - # 1. If empty, search will be performed in all locations; - # 2. If any of the locations are NOT in the valid locations list, error - # will be returned; - # 3. Otherwise, search only the given locations for matching results. - # Typical usage is to leave this field empty. When a location is - # unreachable as returned in the `SearchCatalogResponse.unreachable` field, - # users can repeat the search request with this parameter set to get - # additional information on the error. - # Valid locations: - # * asia-east1 - # * asia-east2 - # * asia-northeast1 - # * asia-northeast2 - # * asia-northeast3 - # * asia-south1 - # * asia-southeast1 - # * australia-southeast1 - # * eu - # * europe-north1 - # * europe-west1 - # * europe-west2 - # * europe-west3 - # * europe-west4 - # * europe-west6 - # * global - # * northamerica-northeast1 - # * southamerica-east1 - # * us - # * us-central1 - # * us-east1 - # * us-east4 - # * us-west1 - # * us-west2 + # Optional. The list of locations to search within. 1. If empty, search will be + # performed in all locations; 2. If any of the locations are NOT in the valid + # locations list, error will be returned; 3. Otherwise, search only the given + # locations for matching results. Typical usage is to leave this field empty. + # When a location is unreachable as returned in the `SearchCatalogResponse. + # unreachable` field, users can repeat the search request with this parameter + # set to get additional information on the error. Valid locations: * asia-east1 * + # asia-east2 * asia-northeast1 * asia-northeast2 * asia-northeast3 * asia- + # south1 * asia-southeast1 * australia-southeast1 * eu * europe-north1 * europe- + # west1 * europe-west2 * europe-west3 * europe-west4 * europe-west6 * global * + # northamerica-northeast1 * southamerica-east1 * us * us-central1 * us-east1 * + # us-east4 * us-west1 * us-west2 # Corresponds to the JSON property `restrictedLocations` # @return [Array] attr_accessor :restricted_locations @@ -1161,8 +1064,7 @@ module Google end end - # Response message for - # SearchCatalog. + # Response message for SearchCatalog. class GoogleCloudDatacatalogV1beta1SearchCatalogResponse include Google::Apis::Core::Hashable @@ -1177,9 +1079,9 @@ module Google attr_accessor :results # Unreachable locations. Search result does not include data from those - # locations. Users can get additional information on the error by repeating - # the search request with a more restrictive parameter -- setting the value - # for `SearchDataCatalogRequest.scope.include_locations`. + # locations. Users can get additional information on the error by repeating the + # search request with a more restrictive parameter -- setting the value for ` + # SearchDataCatalogRequest.scope.include_locations`. # Corresponds to the JSON property `unreachable` # @return [Array] attr_accessor :unreachable @@ -1201,28 +1103,24 @@ module Google class GoogleCloudDatacatalogV1beta1SearchCatalogResult include Google::Apis::Core::Hashable - # The full name of the cloud resource the entry belongs to. See: - # https://cloud.google.com/apis/design/resource_names#full_resource_name. - # Example: - # * `//bigquery.googleapis.com/projects/projectId/datasets/datasetId/tables/ - # tableId` + # The full name of the cloud resource the entry belongs to. See: https://cloud. + # google.com/apis/design/resource_names#full_resource_name. Example: * `// + # bigquery.googleapis.com/projects/projectId/datasets/datasetId/tables/tableId` # Corresponds to the JSON property `linkedResource` # @return [String] attr_accessor :linked_resource - # The relative resource name of the resource in URL format. - # Examples: - # * `projects/`project_id`/locations/`location_id`/entryGroups/`entry_group_id`/ - # entries/`entry_id`` - # * `projects/`project_id`/tagTemplates/`tag_template_id`` + # The relative resource name of the resource in URL format. Examples: * ` + # projects/`project_id`/locations/`location_id`/entryGroups/`entry_group_id`/ + # entries/`entry_id`` * `projects/`project_id`/tagTemplates/`tag_template_id`` # Corresponds to the JSON property `relativeResourceName` # @return [String] attr_accessor :relative_resource_name # Sub-type of the search result. This is a dot-delimited description of the # resource's full type, and is the same as the value callers would provide in - # the "type" search facet. Examples: `entry.table`, `entry.dataStream`, - # `tagTemplate`. + # the "type" search facet. Examples: `entry.table`, `entry.dataStream`, ` + # tagTemplate`. # Corresponds to the JSON property `searchResultSubtype` # @return [String] attr_accessor :search_result_subtype @@ -1255,9 +1153,9 @@ module Google # @return [Array] attr_accessor :child_policy_tags - # Description of the serialized policy tag. The length of the - # description is limited to 2000 bytes when encoded in UTF-8. If not set, - # defaults to an empty description. + # Description of the serialized policy tag. The length of the description is + # limited to 2000 bytes when encoded in UTF-8. If not set, defaults to an empty + # description. # Corresponds to the JSON property `description` # @return [String] attr_accessor :description @@ -1267,8 +1165,8 @@ module Google # @return [String] attr_accessor :display_name - # Resource name of the policy tag. - # This field will be ignored when calling ImportTaxonomies. + # Resource name of the policy tag. This field will be ignored when calling + # ImportTaxonomies. # Corresponds to the JSON property `policyTag` # @return [String] attr_accessor :policy_tag @@ -1291,9 +1189,9 @@ module Google class GoogleCloudDatacatalogV1beta1SerializedTaxonomy include Google::Apis::Core::Hashable - # Description of the serialized taxonomy. The length of the - # description is limited to 2000 bytes when encoded in UTF-8. If not set, - # defaults to an empty description. + # Description of the serialized taxonomy. The length of the description is + # limited to 2000 bytes when encoded in UTF-8. If not set, defaults to an empty + # description. # Corresponds to the JSON property `description` # @return [String] attr_accessor :description @@ -1357,12 +1255,10 @@ module Google include Google::Apis::Core::Hashable # Output only. If the table is a dated shard, i.e., with name pattern `[prefix] - # YYYYMMDD`, - # `grouped_entry` is the Data Catalog resource name of the date sharded - # grouped entry, for example, - # `projects/`project_id`/locations/`location`/entrygroups/`entry_group_id`/ - # entries/`entry_id``. - # Otherwise, `grouped_entry` is empty. + # YYYYMMDD`, `grouped_entry` is the Data Catalog resource name of the date + # sharded grouped entry, for example, `projects/`project_id`/locations/`location` + # /entrygroups/`entry_group_id`/entries/`entry_id``. Otherwise, `grouped_entry` + # is empty. # Corresponds to the JSON property `groupedEntry` # @return [String] attr_accessor :grouped_entry @@ -1378,42 +1274,38 @@ module Google end # Tags are used to attach custom metadata to Data Catalog resources. Tags - # conform to the specifications within their tag template. - # See [Data Catalog - # IAM](https://cloud.google.com/data-catalog/docs/concepts/iam) for information - # on the permissions needed to create or view tags. + # conform to the specifications within their tag template. See [Data Catalog IAM] + # (https://cloud.google.com/data-catalog/docs/concepts/iam) for information on + # the permissions needed to create or view tags. class GoogleCloudDatacatalogV1beta1Tag include Google::Apis::Core::Hashable - # Resources like Entry can have schemas associated with them. This scope - # allows users to attach tags to an individual column based on that schema. - # For attaching a tag to a nested column, use `.` to separate the column - # names. Example: - # * `outer_column.inner_column` + # Resources like Entry can have schemas associated with them. This scope allows + # users to attach tags to an individual column based on that schema. For + # attaching a tag to a nested column, use `.` to separate the column names. + # Example: * `outer_column.inner_column` # Corresponds to the JSON property `column` # @return [String] attr_accessor :column # Required. This maps the ID of a tag field to the value of and additional - # information - # about that field. Valid field IDs are defined by the tag's template. A tag - # must have at least 1 field and at most 500 fields. + # information about that field. Valid field IDs are defined by the tag's + # template. A tag must have at least 1 field and at most 500 fields. # Corresponds to the JSON property `fields` # @return [Hash] attr_accessor :fields - # The resource name of the tag in URL format. Example: - # * projects/`project_id`/locations/`location`/entrygroups/`entry_group_id`/ - # entries/`entry_id`/tags/`tag_id` - # where `tag_id` is a system-generated identifier. - # Note that this Tag may not actually be stored in the location in this name. + # The resource name of the tag in URL format. Example: * projects/`project_id`/ + # locations/`location`/entrygroups/`entry_group_id`/entries/`entry_id`/tags/` + # tag_id` where `tag_id` is a system-generated identifier. Note that this Tag + # may not actually be stored in the location in this name. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name - # Required. The resource name of the tag template that this tag uses. Example: - # * projects/`project_id`/locations/`location`/tagTemplates/`tag_template_id` - # This field cannot be modified after creation. + # Required. The resource name of the tag template that this tag uses. Example: * + # projects/`project_id`/locations/`location`/tagTemplates/`tag_template_id` This + # field cannot be modified after creation. # Corresponds to the JSON property `template` # @return [String] attr_accessor :template @@ -1437,8 +1329,7 @@ module Google end end - # Contains the value and supporting information for a field within - # a Tag. + # Contains the value and supporting information for a field within a Tag. class GoogleCloudDatacatalogV1beta1TagField include Google::Apis::Core::Hashable @@ -1464,11 +1355,9 @@ module Google attr_accessor :enum_value # Output only. The order of this field with respect to other fields in this tag. - # It can be - # set in Tag. For - # example, a higher value can indicate a more important field. The value can - # be negative. Multiple fields can have the same order, and field orders - # within a tag do not have to be sequential. + # It can be set in Tag. For example, a higher value can indicate a more + # important field. The value can be negative. Multiple fields can have the same + # order, and field orders within a tag do not have to be sequential. # Corresponds to the JSON property `order` # @return [Fixnum] attr_accessor :order @@ -1518,15 +1407,13 @@ module Google end end - # A tag template defines a tag, which can have one or more typed fields. - # The template is used to create and attach the tag to GCP resources. - # [Tag template + # A tag template defines a tag, which can have one or more typed fields. The + # template is used to create and attach the tag to GCP resources. [Tag template # roles](https://cloud.google.com/iam/docs/understanding-roles#data-catalog- - # roles) - # provide permissions to create, edit, and use the template. See, for example, - # the [TagTemplate - # User](https://cloud.google.com/data-catalog/docs/how-to/template-user) role, - # which includes permission to use the tag template to tag resources. + # roles) provide permissions to create, edit, and use the template. See, for + # example, the [TagTemplate User](https://cloud.google.com/data-catalog/docs/how- + # to/template-user) role, which includes permission to use the tag template to + # tag resources. class GoogleCloudDatacatalogV1beta1TagTemplate include Google::Apis::Core::Hashable @@ -1535,21 +1422,21 @@ module Google # @return [String] attr_accessor :display_name - # Required. Map of tag template field IDs to the settings for the field. - # This map is an exhaustive list of the allowed fields. This map must contain - # at least one field and at most 500 fields. - # The keys to this map are tag template field IDs. Field IDs can contain - # letters (both uppercase and lowercase), numbers (0-9) and underscores (_). - # Field IDs must be at least 1 character long and at most - # 64 characters long. Field IDs must start with a letter or underscore. + # Required. Map of tag template field IDs to the settings for the field. This + # map is an exhaustive list of the allowed fields. This map must contain at + # least one field and at most 500 fields. The keys to this map are tag template + # field IDs. Field IDs can contain letters (both uppercase and lowercase), + # numbers (0-9) and underscores (_). Field IDs must be at least 1 character long + # and at most 64 characters long. Field IDs must start with a letter or + # underscore. # Corresponds to the JSON property `fields` # @return [Hash] attr_accessor :fields - # The resource name of the tag template in URL format. Example: - # * projects/`project_id`/locations/`location`/tagTemplates/`tag_template_id` - # Note that this TagTemplate and its child resources may not actually be - # stored in the location in this name. + # The resource name of the tag template in URL format. Example: * projects/` + # project_id`/locations/`location`/tagTemplates/`tag_template_id` Note that this + # TagTemplate and its child resources may not actually be stored in the location + # in this name. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name @@ -1582,19 +1469,17 @@ module Google alias_method :is_required?, :is_required # Output only. The resource name of the tag template field in URL format. - # Example: - # * projects/`project_id`/locations/`location`/tagTemplates/`tag_template`/ - # fields/`field` - # Note that this TagTemplateField may not actually be stored in the location - # in this name. + # Example: * projects/`project_id`/locations/`location`/tagTemplates/` + # tag_template`/fields/`field` Note that this TagTemplateField may not actually + # be stored in the location in this name. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name - # The order of this field with respect to other fields in this tag - # template. A higher value indicates a more important field. The value can - # be negative. Multiple fields can have the same order, and field orders - # within a tag do not have to be sequential. + # The order of this field with respect to other fields in this tag template. A + # higher value indicates a more important field. The value can be negative. + # Multiple fields can have the same order, and field orders within a tag do not + # have to be sequential. # Corresponds to the JSON property `order` # @return [Fixnum] attr_accessor :order @@ -1627,30 +1512,28 @@ module Google include Google::Apis::Core::Hashable # Optional. A list of policy types that are activated for this taxonomy. If not - # set, - # defaults to an empty list. + # set, defaults to an empty list. # Corresponds to the JSON property `activatedPolicyTypes` # @return [Array] attr_accessor :activated_policy_types # Optional. Description of this taxonomy. It must: contain only unicode - # characters, - # tabs, newlines, carriage returns and page breaks; and be at most 2000 bytes - # long when encoded in UTF-8. If not set, defaults to an empty description. + # characters, tabs, newlines, carriage returns and page breaks; and be at most + # 2000 bytes long when encoded in UTF-8. If not set, defaults to an empty + # description. # Corresponds to the JSON property `description` # @return [String] attr_accessor :description # Required. User defined name of this taxonomy. It must: contain only unicode - # letters, - # numbers, underscores, dashes and spaces; not start or end with spaces; and - # be at most 200 bytes long when encoded in UTF-8. + # letters, numbers, underscores, dashes and spaces; not start or end with spaces; + # and be at most 200 bytes long when encoded in UTF-8. # Corresponds to the JSON property `displayName` # @return [String] attr_accessor :display_name - # Output only. Resource name of this taxonomy, whose format is: - # "projects/`project_number`/locations/`location_id`/taxonomies/`id`". + # Output only. Resource name of this taxonomy, whose format is: "projects/` + # project_number`/locations/`location_id`/taxonomies/`id`". # Corresponds to the JSON property `name` # @return [String] attr_accessor :name @@ -1688,111 +1571,73 @@ module Google end # An Identity and Access Management (IAM) policy, which specifies access - # controls for Google Cloud resources. - # A `Policy` is a collection of `bindings`. A `binding` binds one or more - # `members` to a single `role`. Members can be user accounts, service accounts, - # 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. - # 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": [ - # ` - # "role": "roles/resourcemanager.organizationAdmin", - # "members": [ - # "user:mike@example.com", - # "group:admins@example.com", - # "domain:google.com", - # "serviceAccount:my-project-id@appspot.gserviceaccount.com" - # ] - # `, - # ` - # "role": "roles/resourcemanager.organizationViewer", - # "members": [ - # "user:eve@example.com" - # ], - # "condition": ` - # "title": "expirable access", - # "description": "Does not grant access after Sep 2020", - # "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z') - # ", - # ` - # ` - # ], - # "etag": "BwWWja0YfJA=", - # "version": 3 - # ` - # **YAML example:** - # bindings: - # - members: - # - user:mike@example.com - # - group:admins@example.com - # - domain:google.com - # - serviceAccount:my-project-id@appspot.gserviceaccount.com - # role: roles/resourcemanager.organizationAdmin - # - members: - # - user:eve@example.com - # role: roles/resourcemanager.organizationViewer - # condition: - # title: expirable access - # description: Does not grant access after Sep 2020 - # expression: request.time < timestamp('2020-10-01T00:00:00.000Z') - # - etag: BwWWja0YfJA= - # - version: 3 - # For a description of IAM and its features, see the - # [IAM documentation](https://cloud.google.com/iam/docs/). + # controls for Google Cloud resources. A `Policy` is a collection of `bindings`. + # A `binding` binds one or more `members` to a single `role`. Members can be + # user accounts, service accounts, 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. 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": [ ` "role": "roles/ + # resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", " + # group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@ + # appspot.gserviceaccount.com" ] `, ` "role": "roles/resourcemanager. + # organizationViewer", "members": [ "user:eve@example.com" ], "condition": ` " + # title": "expirable access", "description": "Does not grant access after Sep + # 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", ` + # ` ], "etag": "BwWWja0YfJA=", "version": 3 ` **YAML example:** bindings: - + # members: - user:mike@example.com - group:admins@example.com - domain:google. + # com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/ + # resourcemanager.organizationAdmin - members: - user:eve@example.com role: + # roles/resourcemanager.organizationViewer condition: title: expirable access + # description: Does not grant access after Sep 2020 expression: request.time < + # timestamp('2020-10-01T00:00:00.000Z') - etag: BwWWja0YfJA= - version: 3 For a + # description of IAM and its features, see the [IAM documentation](https://cloud. + # google.com/iam/docs/). class Policy include Google::Apis::Core::Hashable - # Associates a list of `members` to a `role`. Optionally, may specify a - # `condition` that determines how and when the `bindings` are applied. Each - # of the `bindings` must contain at least one member. + # Associates a list of `members` to a `role`. Optionally, may specify a ` + # condition` that determines how and when the `bindings` are applied. Each of + # the `bindings` must contain at least one member. # Corresponds to the JSON property `bindings` # @return [Array] attr_accessor :bindings - # `etag` is used for optimistic concurrency control as a way to help - # prevent simultaneous updates of a policy from overwriting each other. - # It is strongly suggested that systems make use of the `etag` in the - # read-modify-write cycle to perform policy updates in order to avoid race - # conditions: An `etag` is returned in the response to `getIamPolicy`, and - # systems are expected to put that etag in the request to `setIamPolicy` to - # ensure that their change will be applied to the same version of the policy. - # **Important:** If you use IAM Conditions, you must include the `etag` field - # whenever you call `setIamPolicy`. If you omit this field, then IAM allows - # you to overwrite a version `3` policy with a version `1` policy, and all of - # the conditions in the version `3` policy are lost. + # `etag` is used for optimistic concurrency control as a way to help prevent + # simultaneous updates of a policy from overwriting each other. It is strongly + # suggested that systems make use of the `etag` in the read-modify-write cycle + # to perform policy updates in order to avoid race conditions: An `etag` is + # returned in the response to `getIamPolicy`, and systems are expected to put + # that etag in the request to `setIamPolicy` to ensure that their change will be + # applied to the same version of the policy. **Important:** If you use IAM + # Conditions, you must include the `etag` field whenever you call `setIamPolicy`. + # If you omit this field, then IAM allows you to overwrite a version `3` policy + # with a version `1` policy, and all of the conditions in the version `3` policy + # are lost. # Corresponds to the JSON property `etag` # NOTE: Values are automatically base64 encoded/decoded in the client library. # @return [String] attr_accessor :etag - # Specifies the format of the policy. - # Valid values are `0`, `1`, and `3`. Requests that specify an invalid value - # are rejected. - # Any operation that affects conditional role bindings must specify version - # `3`. This requirement applies to the following operations: - # * Getting a policy that includes a conditional role binding - # * Adding a conditional role binding to a policy - # * Changing a conditional role binding in a policy - # * Removing any role binding, with or without a condition, from a policy - # that includes conditions - # **Important:** If you use IAM Conditions, you must include the `etag` field - # whenever you call `setIamPolicy`. If you omit this field, then IAM allows - # you to overwrite a version `3` policy with a version `1` policy, and all of - # 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). + # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. + # Requests that specify an invalid value are rejected. Any operation that + # affects conditional role bindings must specify version `3`. This requirement + # applies to the following operations: * Getting a policy that includes a + # conditional role binding * Adding a conditional role binding to a policy * + # Changing a conditional role binding in a policy * Removing any role binding, + # with or without a condition, from a policy that includes conditions ** + # Important:** If you use IAM Conditions, you must include the `etag` field + # whenever you call `setIamPolicy`. If you omit this field, then IAM allows you + # to overwrite a version `3` policy with a version `1` policy, and all of 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 @@ -1814,66 +1659,32 @@ module Google include Google::Apis::Core::Hashable # An Identity and Access Management (IAM) policy, which specifies access - # controls for Google Cloud resources. - # A `Policy` is a collection of `bindings`. A `binding` binds one or more - # `members` to a single `role`. Members can be user accounts, service accounts, - # 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. - # 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": [ - # ` - # "role": "roles/resourcemanager.organizationAdmin", - # "members": [ - # "user:mike@example.com", - # "group:admins@example.com", - # "domain:google.com", - # "serviceAccount:my-project-id@appspot.gserviceaccount.com" - # ] - # `, - # ` - # "role": "roles/resourcemanager.organizationViewer", - # "members": [ - # "user:eve@example.com" - # ], - # "condition": ` - # "title": "expirable access", - # "description": "Does not grant access after Sep 2020", - # "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z') - # ", - # ` - # ` - # ], - # "etag": "BwWWja0YfJA=", - # "version": 3 - # ` - # **YAML example:** - # bindings: - # - members: - # - user:mike@example.com - # - group:admins@example.com - # - domain:google.com - # - serviceAccount:my-project-id@appspot.gserviceaccount.com - # role: roles/resourcemanager.organizationAdmin - # - members: - # - user:eve@example.com - # role: roles/resourcemanager.organizationViewer - # condition: - # title: expirable access - # description: Does not grant access after Sep 2020 - # expression: request.time < timestamp('2020-10-01T00:00:00.000Z') - # - etag: BwWWja0YfJA= - # - version: 3 - # For a description of IAM and its features, see the - # [IAM documentation](https://cloud.google.com/iam/docs/). + # controls for Google Cloud resources. A `Policy` is a collection of `bindings`. + # A `binding` binds one or more `members` to a single `role`. Members can be + # user accounts, service accounts, 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. 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": [ ` "role": "roles/ + # resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", " + # group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@ + # appspot.gserviceaccount.com" ] `, ` "role": "roles/resourcemanager. + # organizationViewer", "members": [ "user:eve@example.com" ], "condition": ` " + # title": "expirable access", "description": "Does not grant access after Sep + # 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", ` + # ` ], "etag": "BwWWja0YfJA=", "version": 3 ` **YAML example:** bindings: - + # members: - user:mike@example.com - group:admins@example.com - domain:google. + # com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/ + # resourcemanager.organizationAdmin - members: - user:eve@example.com role: + # roles/resourcemanager.organizationViewer condition: title: expirable access + # description: Does not grant access after Sep 2020 expression: request.time < + # timestamp('2020-10-01T00:00:00.000Z') - etag: BwWWja0YfJA= - version: 3 For a + # description of IAM and its features, see the [IAM documentation](https://cloud. + # google.com/iam/docs/). # Corresponds to the JSON property `policy` # @return [Google::Apis::DatacatalogV1beta1::Policy] attr_accessor :policy @@ -1892,10 +1703,9 @@ module Google class TestIamPermissionsRequest include Google::Apis::Core::Hashable - # The set of permissions to check for the `resource`. Permissions with - # wildcards (such as '*' or 'storage.*') are not allowed. For more - # information see - # [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions). + # The set of permissions to check for the `resource`. Permissions with wildcards + # (such as '*' or 'storage.*') are not allowed. For more information see [IAM + # Overview](https://cloud.google.com/iam/docs/overview#permissions). # Corresponds to the JSON property `permissions` # @return [Array] attr_accessor :permissions @@ -1914,8 +1724,7 @@ module Google class TestIamPermissionsResponse include Google::Apis::Core::Hashable - # A subset of `TestPermissionsRequest.permissions` that the caller is - # allowed. + # A subset of `TestPermissionsRequest.permissions` that the caller is allowed. # Corresponds to the JSON property `permissions` # @return [Array] attr_accessor :permissions diff --git a/generated/google/apis/datacatalog_v1beta1/service.rb b/generated/google/apis/datacatalog_v1beta1/service.rb index c9060ab55..864cdce9a 100644 --- a/generated/google/apis/datacatalog_v1beta1/service.rb +++ b/generated/google/apis/datacatalog_v1beta1/service.rb @@ -48,19 +48,15 @@ module Google @batch_path = 'batch' end - # Searches Data Catalog for multiple resources like entries, tags that - # match a query. - # This is a custom method - # (https://cloud.google.com/apis/design/custom_methods) and does not return - # the complete resource, only the resource identifier and high level - # fields. Clients can subsequentally call `Get` methods. - # Note that Data Catalog search queries do not guarantee full recall. Query - # results that match your query may not be returned, even in subsequent + # Searches Data Catalog for multiple resources like entries, tags that match a + # query. This is a custom method (https://cloud.google.com/apis/design/ + # custom_methods) and does not return the complete resource, only the resource + # identifier and high level fields. Clients can subsequentally call `Get` + # methods. Note that Data Catalog search queries do not guarantee full recall. + # Query results that match your query may not be returned, even in subsequent # result pages. Also note that results returned (and not returned) can vary - # across repeated search queries. - # See [Data Catalog Search - # Syntax](https://cloud.google.com/data-catalog/docs/how-to/search-reference) - # for more information. + # across repeated search queries. See [Data Catalog Search Syntax](https://cloud. + # google.com/data-catalog/docs/how-to/search-reference) for more information. # @param [Google::Apis::DatacatalogV1beta1::GoogleCloudDatacatalogV1beta1SearchCatalogRequest] google_cloud_datacatalog_v1beta1_search_catalog_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -90,28 +86,22 @@ module Google execute_or_queue_command(command, &block) end - # Get an entry by target resource name. This method allows clients to use - # the resource name from the source Google Cloud Platform service to get the - # Data Catalog Entry. + # Get an entry by target resource name. This method allows clients to use the + # resource name from the source Google Cloud Platform service to get the Data + # Catalog Entry. # @param [String] linked_resource - # The full name of the Google Cloud Platform resource the Data Catalog - # entry represents. See: - # https://cloud.google.com/apis/design/resource_names#full_resource_name. - # Full names are case-sensitive. - # Examples: - # * //bigquery.googleapis.com/projects/projectId/datasets/datasetId/tables/ - # tableId - # * //pubsub.googleapis.com/projects/projectId/topics/topicId + # The full name of the Google Cloud Platform resource the Data Catalog entry + # represents. See: https://cloud.google.com/apis/design/resource_names# + # full_resource_name. Full names are case-sensitive. Examples: * //bigquery. + # googleapis.com/projects/projectId/datasets/datasetId/tables/tableId * //pubsub. + # googleapis.com/projects/projectId/topics/topicId # @param [String] sql_resource - # The SQL name of the entry. SQL names are case-sensitive. - # Examples: - # * `pubsub.project_id.topic_id` - # * ``pubsub.project_id.`topic.id.with.dots` `` - # * `bigquery.table.project_id.dataset_id.table_id` - # * `bigquery.dataset.project_id.dataset_id` - # * `datacatalog.entry.project_id.location_id.entry_group_id.entry_id` - # `*_id`s shoud satisfy the standard SQL rules for identifiers. - # https://cloud.google.com/bigquery/docs/reference/standard-sql/lexical. + # The SQL name of the entry. SQL names are case-sensitive. Examples: * `pubsub. + # project_id.topic_id` * ``pubsub.project_id.`topic.id.with.dots` `` * `bigquery. + # table.project_id.dataset_id.table_id` * `bigquery.dataset.project_id. + # dataset_id` * `datacatalog.entry.project_id.location_id.entry_group_id. + # entry_id` `*_id`s shoud satisfy the standard SQL rules for identifiers. https:/ + # /cloud.google.com/bigquery/docs/reference/standard-sql/lexical. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -141,21 +131,18 @@ module Google end # A maximum of 10,000 entry groups may be created per organization across all - # locations. - # Users should enable the Data Catalog API in the project identified by - # the `parent` parameter (see [Data Catalog Resource Project] - # (https://cloud.google.com/data-catalog/docs/concepts/resource-project) for - # more information). + # locations. Users should enable the Data Catalog API in the project identified + # by the `parent` parameter (see [Data Catalog Resource Project] (https://cloud. + # google.com/data-catalog/docs/concepts/resource-project) for more information). # @param [String] parent - # Required. The name of the project this entry group is in. Example: - # * projects/`project_id`/locations/`location` - # Note that this EntryGroup and its child resources may not actually be - # stored in the location in this name. + # Required. The name of the project this entry group is in. Example: * projects/` + # project_id`/locations/`location` Note that this EntryGroup and its child + # resources may not actually be stored in the location in this name. # @param [Google::Apis::DatacatalogV1beta1::GoogleCloudDatacatalogV1beta1EntryGroup] google_cloud_datacatalog_v1beta1_entry_group_object # @param [String] entry_group_id - # Required. The id of the entry group to create. - # The id must begin with a letter or underscore, contain only English - # letters, numbers and underscores, and be at most 64 characters. + # Required. The id of the entry group to create. The id must begin with a letter + # or underscore, contain only English letters, numbers and underscores, and be + # at most 64 characters. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -187,13 +174,12 @@ module Google end # Deletes an EntryGroup. Only entry groups that do not contain entries can be - # deleted. Users should enable the Data Catalog API in the project - # identified by the `name` parameter (see [Data Catalog Resource Project] - # (https://cloud.google.com/data-catalog/docs/concepts/resource-project) for - # more information). + # deleted. Users should enable the Data Catalog API in the project identified by + # the `name` parameter (see [Data Catalog Resource Project] (https://cloud. + # google.com/data-catalog/docs/concepts/resource-project) for more information). # @param [String] name - # Required. The name of the entry group. For example, - # `projects/`project_id`/locations/`location`/entryGroups/`entry_group_id``. + # Required. The name of the entry group. For example, `projects/`project_id`/ + # locations/`location`/entryGroups/`entry_group_id``. # @param [Boolean] force # Optional. If true, deletes all entries in the entry group. # @param [String] fields @@ -226,8 +212,8 @@ module Google # Gets an EntryGroup. # @param [String] name - # Required. The name of the entry group. For example, - # `projects/`project_id`/locations/`location`/entryGroups/`entry_group_id``. + # Required. The name of the entry group. For example, `projects/`project_id`/ + # locations/`location`/entryGroups/`entry_group_id``. # @param [String] read_mask # The fields to return. If not set or empty, all fields are returned. # @param [String] fields @@ -258,23 +244,18 @@ module Google execute_or_queue_command(command, &block) end - # Gets the access control policy for a resource. A `NOT_FOUND` error - # is returned if the resource does not exist. An empty policy is returned - # if the resource exists but does not have a policy set on it. - # Supported resources are: - # - Tag templates. - # - Entries. - # - Entry groups. - # Note, this method cannot be used to manage policies for BigQuery, Pub/Sub - # and any external Google Cloud Platform resources synced to Data Catalog. - # Callers must have following Google IAM permission - # - `datacatalog.tagTemplates.getIamPolicy` to get policies on tag - # templates. - # - `datacatalog.entries.getIamPolicy` to get policies on entries. - # - `datacatalog.entryGroups.getIamPolicy` to get policies on entry groups. + # Gets the access control policy for a resource. A `NOT_FOUND` error is returned + # if the resource does not exist. An empty policy is returned if the resource + # exists but does not have a policy set on it. Supported resources are: - Tag + # templates. - Entries. - Entry groups. Note, this method cannot be used to + # manage policies for BigQuery, Pub/Sub and any external Google Cloud Platform + # resources synced to Data Catalog. Callers must have following Google IAM + # permission - `datacatalog.tagTemplates.getIamPolicy` to get policies on tag + # templates. - `datacatalog.entries.getIamPolicy` to get policies on entries. - ` + # datacatalog.entryGroups.getIamPolicy` to get policies on entry groups. # @param [String] resource - # REQUIRED: The resource for which the policy is being requested. - # See the operation documentation for the appropriate value for this field. + # REQUIRED: The resource for which the policy is being requested. See the + # operation documentation for the appropriate value for this field. # @param [Google::Apis::DatacatalogV1beta1::GetIamPolicyRequest] get_iam_policy_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -308,17 +289,14 @@ module Google # Lists entry groups. # @param [String] parent # Required. The name of the location that contains the entry groups, which can - # be - # provided in URL format. Example: - # * projects/`project_id`/locations/`location` + # be provided in URL format. Example: * projects/`project_id`/locations/` + # location` # @param [Fixnum] page_size # Optional. The maximum number of items to return. Default is 10. Max limit is - # 1000. - # Throws an invalid argument for `page_size > 1000`. + # 1000. Throws an invalid argument for `page_size > 1000`. # @param [String] page_token # Optional. Token that specifies which page is requested. If empty, the first - # page is - # returned. + # page is returned. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -350,14 +328,13 @@ module Google # Updates an EntryGroup. The user should enable the Data Catalog API in the # project identified by the `entry_group.name` parameter (see [Data Catalog - # Resource Project] - # (https://cloud.google.com/data-catalog/docs/concepts/resource-project) for - # more information). + # Resource Project] (https://cloud.google.com/data-catalog/docs/concepts/ + # resource-project) for more information). # @param [String] name - # The resource name of the entry group in URL format. Example: - # * projects/`project_id`/locations/`location`/entryGroups/`entry_group_id` - # Note that this EntryGroup and its child resources may not actually be - # stored in the location in this name. + # The resource name of the entry group in URL format. Example: * projects/` + # project_id`/locations/`location`/entryGroups/`entry_group_id` Note that this + # EntryGroup and its child resources may not actually be stored in the location + # in this name. # @param [Google::Apis::DatacatalogV1beta1::GoogleCloudDatacatalogV1beta1EntryGroup] google_cloud_datacatalog_v1beta1_entry_group_object # @param [String] update_mask # The fields to update on the entry group. If absent or empty, all modifiable @@ -392,22 +369,17 @@ module Google execute_or_queue_command(command, &block) end - # Sets the access control policy for a resource. Replaces any existing - # policy. - # Supported resources are: - # - Tag templates. - # - Entries. - # - Entry groups. - # Note, this method cannot be used to manage policies for BigQuery, Pub/Sub - # and any external Google Cloud Platform resources synced to Data Catalog. - # Callers must have following Google IAM permission - # - `datacatalog.tagTemplates.setIamPolicy` to set policies on tag - # templates. - # - `datacatalog.entries.setIamPolicy` to set policies on entries. - # - `datacatalog.entryGroups.setIamPolicy` to set policies on entry groups. + # Sets the access control policy for a resource. Replaces any existing policy. + # Supported resources are: - Tag templates. - Entries. - Entry groups. Note, + # this method cannot be used to manage policies for BigQuery, Pub/Sub and any + # external Google Cloud Platform resources synced to Data Catalog. Callers must + # have following Google IAM permission - `datacatalog.tagTemplates.setIamPolicy` + # to set policies on tag templates. - `datacatalog.entries.setIamPolicy` to set + # policies on entries. - `datacatalog.entryGroups.setIamPolicy` to set policies + # on entry groups. # @param [String] resource - # REQUIRED: The resource for which the policy is being specified. - # See the operation documentation for the appropriate value for this field. + # REQUIRED: The resource for which the policy is being specified. See the + # operation documentation for the appropriate value for this field. # @param [Google::Apis::DatacatalogV1beta1::SetIamPolicyRequest] set_iam_policy_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -438,20 +410,15 @@ module Google execute_or_queue_command(command, &block) end - # Returns the caller's permissions on a resource. - # If the resource does not exist, an empty set of permissions is returned - # (We don't return a `NOT_FOUND` error). - # Supported resources are: - # - Tag templates. - # - Entries. - # - Entry groups. - # Note, this method cannot be used to manage policies for BigQuery, Pub/Sub - # and any external Google Cloud Platform resources synced to Data Catalog. - # A caller is not required to have Google IAM permission to make this - # request. + # Returns the caller's permissions on a resource. If the resource does not exist, + # an empty set of permissions is returned (We don't return a `NOT_FOUND` error). + # Supported resources are: - Tag templates. - Entries. - Entry groups. Note, + # this method cannot be used to manage policies for BigQuery, Pub/Sub and any + # external Google Cloud Platform resources synced to Data Catalog. A caller is + # not required to have Google IAM permission to make this request. # @param [String] resource - # REQUIRED: The resource for which the policy detail is being requested. - # See the operation documentation for the appropriate value for this field. + # REQUIRED: The resource for which the policy detail is being requested. See the + # operation documentation for the appropriate value for this field. # @param [Google::Apis::DatacatalogV1beta1::TestIamPermissionsRequest] test_iam_permissions_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -482,18 +449,16 @@ module Google execute_or_queue_command(command, &block) end - # Creates an entry. Only entries of 'FILESET' type or user-specified type can - # be created. - # Users should enable the Data Catalog API in the project identified by - # the `parent` parameter (see [Data Catalog Resource Project] - # (https://cloud.google.com/data-catalog/docs/concepts/resource-project) for - # more information). + # Creates an entry. Only entries of 'FILESET' type or user-specified type can be + # created. Users should enable the Data Catalog API in the project identified by + # the `parent` parameter (see [Data Catalog Resource Project] (https://cloud. + # google.com/data-catalog/docs/concepts/resource-project) for more information). # A maximum of 100,000 entries may be created per entry group. # @param [String] parent - # Required. The name of the entry group this entry is in. Example: - # * projects/`project_id`/locations/`location`/entryGroups/`entry_group_id` - # Note that this Entry and its child resources may not actually be stored in - # the location in this name. + # Required. The name of the entry group this entry is in. Example: * projects/` + # project_id`/locations/`location`/entryGroups/`entry_group_id` Note that this + # Entry and its child resources may not actually be stored in the location in + # this name. # @param [Google::Apis::DatacatalogV1beta1::GoogleCloudDatacatalogV1beta1Entry] google_cloud_datacatalog_v1beta1_entry_object # @param [String] entry_id # Required. The id of the entry to create. @@ -527,17 +492,13 @@ module Google execute_or_queue_command(command, &block) end - # Deletes an existing entry. Only entries created through - # CreateEntry - # method can be deleted. - # Users should enable the Data Catalog API in the project identified by - # the `name` parameter (see [Data Catalog Resource Project] - # (https://cloud.google.com/data-catalog/docs/concepts/resource-project) for - # more information). + # Deletes an existing entry. Only entries created through CreateEntry method can + # be deleted. Users should enable the Data Catalog API in the project identified + # by the `name` parameter (see [Data Catalog Resource Project] (https://cloud. + # google.com/data-catalog/docs/concepts/resource-project) for more information). # @param [String] name - # Required. The name of the entry. Example: - # * projects/`project_id`/locations/`location`/entryGroups/`entry_group_id`/ - # entries/`entry_id` + # Required. The name of the entry. Example: * projects/`project_id`/locations/` + # location`/entryGroups/`entry_group_id`/entries/`entry_id` # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -567,9 +528,8 @@ module Google # Gets an entry. # @param [String] name - # Required. The name of the entry. Example: - # * projects/`project_id`/locations/`location`/entryGroups/`entry_group_id`/ - # entries/`entry_id` + # Required. The name of the entry. Example: * projects/`project_id`/locations/` + # location`/entryGroups/`entry_group_id`/entries/`entry_id` # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -597,23 +557,18 @@ module Google execute_or_queue_command(command, &block) end - # Gets the access control policy for a resource. A `NOT_FOUND` error - # is returned if the resource does not exist. An empty policy is returned - # if the resource exists but does not have a policy set on it. - # Supported resources are: - # - Tag templates. - # - Entries. - # - Entry groups. - # Note, this method cannot be used to manage policies for BigQuery, Pub/Sub - # and any external Google Cloud Platform resources synced to Data Catalog. - # Callers must have following Google IAM permission - # - `datacatalog.tagTemplates.getIamPolicy` to get policies on tag - # templates. - # - `datacatalog.entries.getIamPolicy` to get policies on entries. - # - `datacatalog.entryGroups.getIamPolicy` to get policies on entry groups. + # Gets the access control policy for a resource. A `NOT_FOUND` error is returned + # if the resource does not exist. An empty policy is returned if the resource + # exists but does not have a policy set on it. Supported resources are: - Tag + # templates. - Entries. - Entry groups. Note, this method cannot be used to + # manage policies for BigQuery, Pub/Sub and any external Google Cloud Platform + # resources synced to Data Catalog. Callers must have following Google IAM + # permission - `datacatalog.tagTemplates.getIamPolicy` to get policies on tag + # templates. - `datacatalog.entries.getIamPolicy` to get policies on entries. - ` + # datacatalog.entryGroups.getIamPolicy` to get policies on entry groups. # @param [String] resource - # REQUIRED: The resource for which the policy is being requested. - # See the operation documentation for the appropriate value for this field. + # REQUIRED: The resource for which the policy is being requested. See the + # operation documentation for the appropriate value for this field. # @param [Google::Apis::DatacatalogV1beta1::GetIamPolicyRequest] get_iam_policy_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -646,9 +601,9 @@ module Google # Lists entries. # @param [String] parent - # Required. The name of the entry group that contains the entries, which can - # be provided in URL format. Example: - # * projects/`project_id`/locations/`location`/entryGroups/`entry_group_id` + # Required. The name of the entry group that contains the entries, which can be + # provided in URL format. Example: * projects/`project_id`/locations/`location`/ + # entryGroups/`entry_group_id` # @param [Fixnum] page_size # The maximum number of items to return. Default is 10. Max limit is 1000. # Throws an invalid argument for `page_size > 1000`. @@ -656,10 +611,9 @@ module Google # Token that specifies which page is requested. If empty, the first page is # returned. # @param [String] read_mask - # The fields to return for each Entry. If not set or empty, all - # fields are returned. - # For example, setting read_mask to contain only one path "name" will cause - # ListEntries to return a list of Entries with only "name" field. + # The fields to return for each Entry. If not set or empty, all fields are + # returned. For example, setting read_mask to contain only one path "name" will + # cause ListEntries to return a list of Entries with only "name" field. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -690,38 +644,24 @@ module Google execute_or_queue_command(command, &block) end - # Updates an existing entry. - # Users should enable the Data Catalog API in the project identified by - # the `entry.name` parameter (see [Data Catalog Resource Project] - # (https://cloud.google.com/data-catalog/docs/concepts/resource-project) for - # more information). + # Updates an existing entry. Users should enable the Data Catalog API in the + # project identified by the `entry.name` parameter (see [Data Catalog Resource + # Project] (https://cloud.google.com/data-catalog/docs/concepts/resource-project) + # for more information). # @param [String] name - # The Data Catalog resource name of the entry in URL format. Example: - # * projects/`project_id`/locations/`location`/entryGroups/`entry_group_id`/ - # entries/`entry_id` - # Note that this Entry and its child resources may not actually be stored in - # the location in this name. + # The Data Catalog resource name of the entry in URL format. Example: * projects/ + # `project_id`/locations/`location`/entryGroups/`entry_group_id`/entries/` + # entry_id` Note that this Entry and its child resources may not actually be + # stored in the location in this name. # @param [Google::Apis::DatacatalogV1beta1::GoogleCloudDatacatalogV1beta1Entry] google_cloud_datacatalog_v1beta1_entry_object # @param [String] update_mask - # The fields to update on the entry. If absent or empty, all modifiable - # fields are updated. - # The following fields are modifiable: - # * For entries with type `DATA_STREAM`: - # * `schema` - # * For entries with type `FILESET` - # * `schema` - # * `display_name` - # * `description` - # * `gcs_fileset_spec` - # * `gcs_fileset_spec.file_patterns` - # * For entries with `user_specified_type` - # * `schema` - # * `display_name` - # * `description` - # * user_specified_type - # * user_specified_system - # * linked_resource - # * source_system_timestamps + # The fields to update on the entry. If absent or empty, all modifiable fields + # are updated. The following fields are modifiable: * For entries with type ` + # DATA_STREAM`: * `schema` * For entries with type `FILESET` * `schema` * ` + # display_name` * `description` * `gcs_fileset_spec` * `gcs_fileset_spec. + # file_patterns` * For entries with `user_specified_type` * `schema` * ` + # display_name` * `description` * user_specified_type * user_specified_system * + # linked_resource * source_system_timestamps # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -752,20 +692,15 @@ module Google execute_or_queue_command(command, &block) end - # Returns the caller's permissions on a resource. - # If the resource does not exist, an empty set of permissions is returned - # (We don't return a `NOT_FOUND` error). - # Supported resources are: - # - Tag templates. - # - Entries. - # - Entry groups. - # Note, this method cannot be used to manage policies for BigQuery, Pub/Sub - # and any external Google Cloud Platform resources synced to Data Catalog. - # A caller is not required to have Google IAM permission to make this - # request. + # Returns the caller's permissions on a resource. If the resource does not exist, + # an empty set of permissions is returned (We don't return a `NOT_FOUND` error). + # Supported resources are: - Tag templates. - Entries. - Entry groups. Note, + # this method cannot be used to manage policies for BigQuery, Pub/Sub and any + # external Google Cloud Platform resources synced to Data Catalog. A caller is + # not required to have Google IAM permission to make this request. # @param [String] resource - # REQUIRED: The resource for which the policy detail is being requested. - # See the operation documentation for the appropriate value for this field. + # REQUIRED: The resource for which the policy detail is being requested. See the + # operation documentation for the appropriate value for this field. # @param [Google::Apis::DatacatalogV1beta1::TestIamPermissionsRequest] test_iam_permissions_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -796,23 +731,17 @@ module Google execute_or_queue_command(command, &block) end - # Creates a tag on an Entry. - # Note: The project identified by the `parent` parameter for the - # [tag](https://cloud.google.com/data-catalog/docs/reference/rest/v1beta1/ - # projects.locations.entryGroups.entries.tags/create#path-parameters) - # and the - # [tag - # template](https://cloud.google.com/data-catalog/docs/reference/rest/v1beta1/ - # projects.locations.tagTemplates/create#path-parameters) + # Creates a tag on an Entry. Note: The project identified by the `parent` + # parameter for the [tag](https://cloud.google.com/data-catalog/docs/reference/ + # rest/v1beta1/projects.locations.entryGroups.entries.tags/create#path- + # parameters) and the [tag template](https://cloud.google.com/data-catalog/docs/ + # reference/rest/v1beta1/projects.locations.tagTemplates/create#path-parameters) # used to create the tag must be from the same organization. # @param [String] parent # Required. The name of the resource to attach this tag to. Tags can be attached - # to - # Entries. Example: - # * projects/`project_id`/locations/`location`/entryGroups/`entry_group_id`/ - # entries/`entry_id` - # Note that this Tag and its child resources may not actually be stored in - # the location in this name. + # to Entries. Example: * projects/`project_id`/locations/`location`/entryGroups/` + # entry_group_id`/entries/`entry_id` Note that this Tag and its child resources + # may not actually be stored in the location in this name. # @param [Google::Apis::DatacatalogV1beta1::GoogleCloudDatacatalogV1beta1Tag] google_cloud_datacatalog_v1beta1_tag_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -845,9 +774,9 @@ module Google # Deletes a tag. # @param [String] name - # Required. The name of the tag to delete. Example: - # * projects/`project_id`/locations/`location`/entryGroups/`entry_group_id`/ - # entries/`entry_id`/tags/`tag_id` + # Required. The name of the tag to delete. Example: * projects/`project_id`/ + # locations/`location`/entryGroups/`entry_group_id`/entries/`entry_id`/tags/` + # tag_id` # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -878,13 +807,9 @@ module Google # Lists the tags on an Entry. # @param [String] parent # Required. The name of the Data Catalog resource to list the tags of. The - # resource - # could be an Entry or an - # EntryGroup. - # Examples: - # * projects/`project_id`/locations/`location`/entryGroups/`entry_group_id` - # * projects/`project_id`/locations/`location`/entryGroups/`entry_group_id`/ - # entries/`entry_id` + # resource could be an Entry or an EntryGroup. Examples: * projects/`project_id`/ + # locations/`location`/entryGroups/`entry_group_id` * projects/`project_id`/ + # locations/`location`/entryGroups/`entry_group_id`/entries/`entry_id` # @param [Fixnum] page_size # The maximum number of tags to return. Default is 10. Max limit is 1000. # @param [String] page_token @@ -921,15 +846,14 @@ module Google # Updates an existing tag. # @param [String] name - # The resource name of the tag in URL format. Example: - # * projects/`project_id`/locations/`location`/entrygroups/`entry_group_id`/ - # entries/`entry_id`/tags/`tag_id` - # where `tag_id` is a system-generated identifier. - # Note that this Tag may not actually be stored in the location in this name. + # The resource name of the tag in URL format. Example: * projects/`project_id`/ + # locations/`location`/entrygroups/`entry_group_id`/entries/`entry_id`/tags/` + # tag_id` where `tag_id` is a system-generated identifier. Note that this Tag + # may not actually be stored in the location in this name. # @param [Google::Apis::DatacatalogV1beta1::GoogleCloudDatacatalogV1beta1Tag] google_cloud_datacatalog_v1beta1_tag_object # @param [String] update_mask - # The fields to update on the Tag. If absent or empty, all modifiable fields - # are updated. Currently the only modifiable field is the field `fields`. + # The fields to update on the Tag. If absent or empty, all modifiable fields are + # updated. Currently the only modifiable field is the field `fields`. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -960,23 +884,17 @@ module Google execute_or_queue_command(command, &block) end - # Creates a tag on an Entry. - # Note: The project identified by the `parent` parameter for the - # [tag](https://cloud.google.com/data-catalog/docs/reference/rest/v1beta1/ - # projects.locations.entryGroups.entries.tags/create#path-parameters) - # and the - # [tag - # template](https://cloud.google.com/data-catalog/docs/reference/rest/v1beta1/ - # projects.locations.tagTemplates/create#path-parameters) + # Creates a tag on an Entry. Note: The project identified by the `parent` + # parameter for the [tag](https://cloud.google.com/data-catalog/docs/reference/ + # rest/v1beta1/projects.locations.entryGroups.entries.tags/create#path- + # parameters) and the [tag template](https://cloud.google.com/data-catalog/docs/ + # reference/rest/v1beta1/projects.locations.tagTemplates/create#path-parameters) # used to create the tag must be from the same organization. # @param [String] parent # Required. The name of the resource to attach this tag to. Tags can be attached - # to - # Entries. Example: - # * projects/`project_id`/locations/`location`/entryGroups/`entry_group_id`/ - # entries/`entry_id` - # Note that this Tag and its child resources may not actually be stored in - # the location in this name. + # to Entries. Example: * projects/`project_id`/locations/`location`/entryGroups/` + # entry_group_id`/entries/`entry_id` Note that this Tag and its child resources + # may not actually be stored in the location in this name. # @param [Google::Apis::DatacatalogV1beta1::GoogleCloudDatacatalogV1beta1Tag] google_cloud_datacatalog_v1beta1_tag_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -1009,9 +927,9 @@ module Google # Deletes a tag. # @param [String] name - # Required. The name of the tag to delete. Example: - # * projects/`project_id`/locations/`location`/entryGroups/`entry_group_id`/ - # entries/`entry_id`/tags/`tag_id` + # Required. The name of the tag to delete. Example: * projects/`project_id`/ + # locations/`location`/entryGroups/`entry_group_id`/entries/`entry_id`/tags/` + # tag_id` # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -1042,13 +960,9 @@ module Google # Lists the tags on an Entry. # @param [String] parent # Required. The name of the Data Catalog resource to list the tags of. The - # resource - # could be an Entry or an - # EntryGroup. - # Examples: - # * projects/`project_id`/locations/`location`/entryGroups/`entry_group_id` - # * projects/`project_id`/locations/`location`/entryGroups/`entry_group_id`/ - # entries/`entry_id` + # resource could be an Entry or an EntryGroup. Examples: * projects/`project_id`/ + # locations/`location`/entryGroups/`entry_group_id` * projects/`project_id`/ + # locations/`location`/entryGroups/`entry_group_id`/entries/`entry_id` # @param [Fixnum] page_size # The maximum number of tags to return. Default is 10. Max limit is 1000. # @param [String] page_token @@ -1085,15 +999,14 @@ module Google # Updates an existing tag. # @param [String] name - # The resource name of the tag in URL format. Example: - # * projects/`project_id`/locations/`location`/entrygroups/`entry_group_id`/ - # entries/`entry_id`/tags/`tag_id` - # where `tag_id` is a system-generated identifier. - # Note that this Tag may not actually be stored in the location in this name. + # The resource name of the tag in URL format. Example: * projects/`project_id`/ + # locations/`location`/entrygroups/`entry_group_id`/entries/`entry_id`/tags/` + # tag_id` where `tag_id` is a system-generated identifier. Note that this Tag + # may not actually be stored in the location in this name. # @param [Google::Apis::DatacatalogV1beta1::GoogleCloudDatacatalogV1beta1Tag] google_cloud_datacatalog_v1beta1_tag_object # @param [String] update_mask - # The fields to update on the Tag. If absent or empty, all modifiable fields - # are updated. Currently the only modifiable field is the field `fields`. + # The fields to update on the Tag. If absent or empty, all modifiable fields are + # updated. Currently the only modifiable field is the field `fields`. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -1124,16 +1037,14 @@ module Google execute_or_queue_command(command, &block) end - # Creates a tag template. The user should enable the Data Catalog API in - # the project identified by the `parent` parameter (see [Data Catalog - # Resource + # Creates a tag template. The user should enable the Data Catalog API in the + # project identified by the `parent` parameter (see [Data Catalog Resource # Project](https://cloud.google.com/data-catalog/docs/concepts/resource-project) # for more information). # @param [String] parent - # Required. The name of the project and the template location - # [region](https://cloud.google.com/data-catalog/docs/concepts/regions. - # Example: - # * projects/`project_id`/locations/us-central1 + # Required. The name of the project and the template location [region](https:// + # cloud.google.com/data-catalog/docs/concepts/regions. Example: * projects/` + # project_id`/locations/us-central1 # @param [Google::Apis::DatacatalogV1beta1::GoogleCloudDatacatalogV1beta1TagTemplate] google_cloud_datacatalog_v1beta1_tag_template_object # @param [String] tag_template_id # Required. The id of the tag template to create. @@ -1167,18 +1078,17 @@ module Google execute_or_queue_command(command, &block) end - # Deletes a tag template and all tags using the template. - # Users should enable the Data Catalog API in the project identified by - # the `name` parameter (see [Data Catalog Resource Project] - # (https://cloud.google.com/data-catalog/docs/concepts/resource-project) for - # more information). + # Deletes a tag template and all tags using the template. Users should enable + # the Data Catalog API in the project identified by the `name` parameter (see [ + # Data Catalog Resource Project] (https://cloud.google.com/data-catalog/docs/ + # concepts/resource-project) for more information). # @param [String] name - # Required. The name of the tag template to delete. Example: - # * projects/`project_id`/locations/`location`/tagTemplates/`tag_template_id` + # Required. The name of the tag template to delete. Example: * projects/` + # project_id`/locations/`location`/tagTemplates/`tag_template_id` # @param [Boolean] force - # Required. Currently, this field must always be set to `true`. - # This confirms the deletion of any possible tags using this template. - # `force = false` will be supported in the future. + # Required. Currently, this field must always be set to `true`. This confirms + # the deletion of any possible tags using this template. `force = false` will be + # supported in the future. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -1209,8 +1119,8 @@ module Google # Gets a tag template. # @param [String] name - # Required. The name of the tag template. Example: - # * projects/`project_id`/locations/`location`/tagTemplates/`tag_template_id` + # Required. The name of the tag template. Example: * projects/`project_id`/ + # locations/`location`/tagTemplates/`tag_template_id` # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -1238,23 +1148,18 @@ module Google execute_or_queue_command(command, &block) end - # Gets the access control policy for a resource. A `NOT_FOUND` error - # is returned if the resource does not exist. An empty policy is returned - # if the resource exists but does not have a policy set on it. - # Supported resources are: - # - Tag templates. - # - Entries. - # - Entry groups. - # Note, this method cannot be used to manage policies for BigQuery, Pub/Sub - # and any external Google Cloud Platform resources synced to Data Catalog. - # Callers must have following Google IAM permission - # - `datacatalog.tagTemplates.getIamPolicy` to get policies on tag - # templates. - # - `datacatalog.entries.getIamPolicy` to get policies on entries. - # - `datacatalog.entryGroups.getIamPolicy` to get policies on entry groups. + # Gets the access control policy for a resource. A `NOT_FOUND` error is returned + # if the resource does not exist. An empty policy is returned if the resource + # exists but does not have a policy set on it. Supported resources are: - Tag + # templates. - Entries. - Entry groups. Note, this method cannot be used to + # manage policies for BigQuery, Pub/Sub and any external Google Cloud Platform + # resources synced to Data Catalog. Callers must have following Google IAM + # permission - `datacatalog.tagTemplates.getIamPolicy` to get policies on tag + # templates. - `datacatalog.entries.getIamPolicy` to get policies on entries. - ` + # datacatalog.entryGroups.getIamPolicy` to get policies on entry groups. # @param [String] resource - # REQUIRED: The resource for which the policy is being requested. - # See the operation documentation for the appropriate value for this field. + # REQUIRED: The resource for which the policy is being requested. See the + # operation documentation for the appropriate value for this field. # @param [Google::Apis::DatacatalogV1beta1::GetIamPolicyRequest] get_iam_policy_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -1285,24 +1190,22 @@ module Google execute_or_queue_command(command, &block) end - # Updates a tag template. This method cannot be used to update the fields of - # a template. The tag template fields are represented as separate resources - # and should be updated using their own create/update/delete methods. - # Users should enable the Data Catalog API in the project identified by - # the `tag_template.name` parameter (see [Data Catalog Resource Project] - # (https://cloud.google.com/data-catalog/docs/concepts/resource-project) for - # more information). + # Updates a tag template. This method cannot be used to update the fields of a + # template. The tag template fields are represented as separate resources and + # should be updated using their own create/update/delete methods. Users should + # enable the Data Catalog API in the project identified by the `tag_template. + # name` parameter (see [Data Catalog Resource Project] (https://cloud.google.com/ + # data-catalog/docs/concepts/resource-project) for more information). # @param [String] name - # The resource name of the tag template in URL format. Example: - # * projects/`project_id`/locations/`location`/tagTemplates/`tag_template_id` - # Note that this TagTemplate and its child resources may not actually be - # stored in the location in this name. + # The resource name of the tag template in URL format. Example: * projects/` + # project_id`/locations/`location`/tagTemplates/`tag_template_id` Note that this + # TagTemplate and its child resources may not actually be stored in the location + # in this name. # @param [Google::Apis::DatacatalogV1beta1::GoogleCloudDatacatalogV1beta1TagTemplate] google_cloud_datacatalog_v1beta1_tag_template_object # @param [String] update_mask - # The field mask specifies the parts of the template to overwrite. - # Allowed fields: - # * `display_name` - # If absent or empty, all of the allowed fields above will be updated. + # The field mask specifies the parts of the template to overwrite. Allowed + # fields: * `display_name` If absent or empty, all of the allowed fields above + # will be updated. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -1333,22 +1236,17 @@ module Google execute_or_queue_command(command, &block) end - # Sets the access control policy for a resource. Replaces any existing - # policy. - # Supported resources are: - # - Tag templates. - # - Entries. - # - Entry groups. - # Note, this method cannot be used to manage policies for BigQuery, Pub/Sub - # and any external Google Cloud Platform resources synced to Data Catalog. - # Callers must have following Google IAM permission - # - `datacatalog.tagTemplates.setIamPolicy` to set policies on tag - # templates. - # - `datacatalog.entries.setIamPolicy` to set policies on entries. - # - `datacatalog.entryGroups.setIamPolicy` to set policies on entry groups. + # Sets the access control policy for a resource. Replaces any existing policy. + # Supported resources are: - Tag templates. - Entries. - Entry groups. Note, + # this method cannot be used to manage policies for BigQuery, Pub/Sub and any + # external Google Cloud Platform resources synced to Data Catalog. Callers must + # have following Google IAM permission - `datacatalog.tagTemplates.setIamPolicy` + # to set policies on tag templates. - `datacatalog.entries.setIamPolicy` to set + # policies on entries. - `datacatalog.entryGroups.setIamPolicy` to set policies + # on entry groups. # @param [String] resource - # REQUIRED: The resource for which the policy is being specified. - # See the operation documentation for the appropriate value for this field. + # REQUIRED: The resource for which the policy is being specified. See the + # operation documentation for the appropriate value for this field. # @param [Google::Apis::DatacatalogV1beta1::SetIamPolicyRequest] set_iam_policy_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -1379,20 +1277,15 @@ module Google execute_or_queue_command(command, &block) end - # Returns the caller's permissions on a resource. - # If the resource does not exist, an empty set of permissions is returned - # (We don't return a `NOT_FOUND` error). - # Supported resources are: - # - Tag templates. - # - Entries. - # - Entry groups. - # Note, this method cannot be used to manage policies for BigQuery, Pub/Sub - # and any external Google Cloud Platform resources synced to Data Catalog. - # A caller is not required to have Google IAM permission to make this - # request. + # Returns the caller's permissions on a resource. If the resource does not exist, + # an empty set of permissions is returned (We don't return a `NOT_FOUND` error). + # Supported resources are: - Tag templates. - Entries. - Entry groups. Note, + # this method cannot be used to manage policies for BigQuery, Pub/Sub and any + # external Google Cloud Platform resources synced to Data Catalog. A caller is + # not required to have Google IAM permission to make this request. # @param [String] resource - # REQUIRED: The resource for which the policy detail is being requested. - # See the operation documentation for the appropriate value for this field. + # REQUIRED: The resource for which the policy detail is being requested. See the + # operation documentation for the appropriate value for this field. # @param [Google::Apis::DatacatalogV1beta1::TestIamPermissionsRequest] test_iam_permissions_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -1423,23 +1316,20 @@ module Google execute_or_queue_command(command, &block) end - # Creates a field in a tag template. The user should enable the Data Catalog - # API in the project identified by the `parent` parameter (see - # [Data Catalog Resource - # Project](https://cloud.google.com/data-catalog/docs/concepts/resource-project) - # for more information). + # Creates a field in a tag template. The user should enable the Data Catalog API + # in the project identified by the `parent` parameter (see [Data Catalog + # Resource Project](https://cloud.google.com/data-catalog/docs/concepts/resource- + # project) for more information). # @param [String] parent - # Required. The name of the project and the template location - # [region](https://cloud.google.com/data-catalog/docs/concepts/regions). - # Example: - # * projects/`project_id`/locations/us-central1/tagTemplates/`tag_template_id` + # Required. The name of the project and the template location [region](https:// + # cloud.google.com/data-catalog/docs/concepts/regions). Example: * projects/` + # project_id`/locations/us-central1/tagTemplates/`tag_template_id` # @param [Google::Apis::DatacatalogV1beta1::GoogleCloudDatacatalogV1beta1TagTemplateField] google_cloud_datacatalog_v1beta1_tag_template_field_object # @param [String] tag_template_field_id - # Required. The ID of the tag template field to create. - # Field ids can contain letters (both uppercase and lowercase), numbers - # (0-9), underscores (_) and dashes (-). Field IDs must be at least 1 - # character long and at most 128 characters long. Field IDs must also be - # unique within their template. + # Required. The ID of the tag template field to create. Field ids can contain + # letters (both uppercase and lowercase), numbers (0-9), underscores (_) and + # dashes (-). Field IDs must be at least 1 character long and at most 128 + # characters long. Field IDs must also be unique within their template. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -1470,19 +1360,18 @@ module Google execute_or_queue_command(command, &block) end - # Deletes a field in a tag template and all uses of that field. - # Users should enable the Data Catalog API in the project identified by - # the `name` parameter (see [Data Catalog Resource Project] - # (https://cloud.google.com/data-catalog/docs/concepts/resource-project) for - # more information). + # Deletes a field in a tag template and all uses of that field. Users should + # enable the Data Catalog API in the project identified by the `name` parameter ( + # see [Data Catalog Resource Project] (https://cloud.google.com/data-catalog/ + # docs/concepts/resource-project) for more information). # @param [String] name - # Required. The name of the tag template field to delete. Example: - # * projects/`project_id`/locations/`location`/tagTemplates/`tag_template_id`/ - # fields/`tag_template_field_id` + # Required. The name of the tag template field to delete. Example: * projects/` + # project_id`/locations/`location`/tagTemplates/`tag_template_id`/fields/` + # tag_template_field_id` # @param [Boolean] force - # Required. Currently, this field must always be set to `true`. - # This confirms the deletion of this field from any tags using this field. - # `force = false` will be supported in the future. + # Required. Currently, this field must always be set to `true`. This confirms + # the deletion of this field from any tags using this field. `force = false` + # will be supported in the future. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -1512,27 +1401,22 @@ module Google end # Updates a field in a tag template. This method cannot be used to update the - # field type. Users should enable the Data Catalog API in the project - # identified by the `name` parameter (see [Data Catalog Resource Project] - # (https://cloud.google.com/data-catalog/docs/concepts/resource-project) for - # more information). + # field type. Users should enable the Data Catalog API in the project identified + # by the `name` parameter (see [Data Catalog Resource Project] (https://cloud. + # google.com/data-catalog/docs/concepts/resource-project) for more information). # @param [String] name - # Required. The name of the tag template field. Example: - # * projects/`project_id`/locations/`location`/tagTemplates/`tag_template_id`/ - # fields/`tag_template_field_id` + # Required. The name of the tag template field. Example: * projects/`project_id`/ + # locations/`location`/tagTemplates/`tag_template_id`/fields/` + # tag_template_field_id` # @param [Google::Apis::DatacatalogV1beta1::GoogleCloudDatacatalogV1beta1TagTemplateField] google_cloud_datacatalog_v1beta1_tag_template_field_object # @param [String] update_mask # Optional. The field mask specifies the parts of the template to be updated. - # Allowed fields: - # * `display_name` - # * `type.enum_type` - # * `is_required` - # If `update_mask` is not set or empty, all of the allowed fields above will - # be updated. - # When updating an enum type, the provided values will be merged with the - # existing values. Therefore, enum values can only be added, existing enum - # values cannot be deleted nor renamed. Updating a template field from - # optional to required is NOT allowed. + # Allowed fields: * `display_name` * `type.enum_type` * `is_required` If ` + # update_mask` is not set or empty, all of the allowed fields above will be + # updated. When updating an enum type, the provided values will be merged with + # the existing values. Therefore, enum values can only be added, existing enum + # values cannot be deleted nor renamed. Updating a template field from optional + # to required is NOT allowed. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -1563,15 +1447,14 @@ module Google execute_or_queue_command(command, &block) end - # Renames a field in a tag template. The user should enable the Data Catalog - # API in the project identified by the `name` parameter (see [Data Catalog - # Resource + # Renames a field in a tag template. The user should enable the Data Catalog API + # in the project identified by the `name` parameter (see [Data Catalog Resource # Project](https://cloud.google.com/data-catalog/docs/concepts/resource-project) # for more information). # @param [String] name - # Required. The name of the tag template. Example: - # * projects/`project_id`/locations/`location`/tagTemplates/`tag_template_id`/ - # fields/`tag_template_field_id` + # Required. The name of the tag template. Example: * projects/`project_id`/ + # locations/`location`/tagTemplates/`tag_template_id`/fields/` + # tag_template_field_id` # @param [Google::Apis::DatacatalogV1beta1::GoogleCloudDatacatalogV1beta1RenameTagTemplateFieldRequest] google_cloud_datacatalog_v1beta1_rename_tag_template_field_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -1603,12 +1486,12 @@ module Google end # Renames an enum value in a tag template. The enum values have to be unique - # within one enum field. Thus, an enum value cannot be renamed with a name - # used in any other enum value within the same enum field. + # within one enum field. Thus, an enum value cannot be renamed with a name used + # in any other enum value within the same enum field. # @param [String] name - # Required. The name of the enum field value. Example: - # * projects/`project_id`/locations/`location`/tagTemplates/`tag_template_id`/ - # fields/`tag_template_field_id`/enumValues/`enum_value_display_name` + # Required. The name of the enum field value. Example: * projects/`project_id`/ + # locations/`location`/tagTemplates/`tag_template_id`/fields/` + # tag_template_field_id`/enumValues/`enum_value_display_name` # @param [Google::Apis::DatacatalogV1beta1::GoogleCloudDatacatalogV1beta1RenameTagTemplateFieldEnumValueRequest] google_cloud_datacatalog_v1beta1_rename_tag_template_field_enum_value_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -1672,11 +1555,11 @@ module Google execute_or_queue_command(command, &block) end - # Deletes a taxonomy. This operation will also delete all - # policy tags in this taxonomy along with their associated policies. + # Deletes a taxonomy. This operation will also delete all policy tags in this + # taxonomy along with their associated policies. # @param [String] name - # Required. Resource name of the taxonomy to be deleted. All policy tags in - # this taxonomy will also be deleted. + # Required. Resource name of the taxonomy to be deleted. All policy tags in this + # taxonomy will also be deleted. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -1704,12 +1587,12 @@ module Google execute_or_queue_command(command, &block) end - # Exports all taxonomies and their policy tags in a project. - # This method generates SerializedTaxonomy protos with nested policy tags - # that can be used as an input for future ImportTaxonomies calls. + # Exports all taxonomies and their policy tags in a project. This method + # generates SerializedTaxonomy protos with nested policy tags that can be used + # as an input for future ImportTaxonomies calls. # @param [String] parent - # Required. Resource name of the project that taxonomies to be exported - # will share. + # Required. Resource name of the project that taxonomies to be exported will + # share. # @param [Boolean] serialized_taxonomies # Export taxonomies as serialized taxonomies. # @param [Array, String] taxonomies @@ -1775,8 +1658,8 @@ module Google # Gets the IAM policy for a taxonomy or a policy tag. # @param [String] resource - # REQUIRED: The resource for which the policy is being requested. - # See the operation documentation for the appropriate value for this field. + # REQUIRED: The resource for which the policy is being requested. See the + # operation documentation for the appropriate value for this field. # @param [Google::Apis::DatacatalogV1beta1::GetIamPolicyRequest] get_iam_policy_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -1807,10 +1690,9 @@ module Google execute_or_queue_command(command, &block) end - # Imports all taxonomies and their policy tags to a project as new - # taxonomies. - # This method provides a bulk taxonomy / policy tag creation using nested - # proto structure. + # Imports all taxonomies and their policy tags to a project as new taxonomies. + # This method provides a bulk taxonomy / policy tag creation using nested proto + # structure. # @param [String] parent # Required. Resource name of project that the imported taxonomies will belong to. # @param [Google::Apis::DatacatalogV1beta1::GoogleCloudDatacatalogV1beta1ImportTaxonomiesRequest] google_cloud_datacatalog_v1beta1_import_taxonomies_request_object @@ -1843,13 +1725,13 @@ module Google execute_or_queue_command(command, &block) end - # Lists all taxonomies in a project in a particular location that the caller - # has permission to view. + # Lists all taxonomies in a project in a particular location that the caller has + # permission to view. # @param [String] parent # Required. Resource name of the project to list the taxonomies of. # @param [Fixnum] page_size - # The maximum number of items to return. Must be a value between 1 and 1000. - # If not set, defaults to 50. + # The maximum number of items to return. Must be a value between 1 and 1000. If + # not set, defaults to 50. # @param [String] page_token # The next_page_token value returned from a previous list request, if any. If # not set, defaults to an empty string. @@ -1884,15 +1766,13 @@ module Google # Updates a taxonomy. # @param [String] name - # Output only. Resource name of this taxonomy, whose format is: - # "projects/`project_number`/locations/`location_id`/taxonomies/`id`". + # Output only. Resource name of this taxonomy, whose format is: "projects/` + # project_number`/locations/`location_id`/taxonomies/`id`". # @param [Google::Apis::DatacatalogV1beta1::GoogleCloudDatacatalogV1beta1Taxonomy] google_cloud_datacatalog_v1beta1_taxonomy_object # @param [String] update_mask - # The update mask applies to the resource. For the `FieldMask` definition, - # see + # The update mask applies to the resource. For the `FieldMask` definition, see # https://developers.google.com/protocol-buffers/docs/reference/google.protobuf# - # fieldmask - # If not set, defaults to all of the fields that are allowed to update. + # fieldmask If not set, defaults to all of the fields that are allowed to update. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -1925,8 +1805,8 @@ module Google # Sets the IAM policy for a taxonomy or a policy tag. # @param [String] resource - # REQUIRED: The resource for which the policy is being specified. - # See the operation documentation for the appropriate value for this field. + # REQUIRED: The resource for which the policy is being specified. See the + # operation documentation for the appropriate value for this field. # @param [Google::Apis::DatacatalogV1beta1::SetIamPolicyRequest] set_iam_policy_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -1957,11 +1837,11 @@ module Google execute_or_queue_command(command, &block) end - # Returns the permissions that a caller has on the specified taxonomy or - # policy tag. + # Returns the permissions that a caller has on the specified taxonomy or policy + # tag. # @param [String] resource - # REQUIRED: The resource for which the policy detail is being requested. - # See the operation documentation for the appropriate value for this field. + # REQUIRED: The resource for which the policy detail is being requested. See the + # operation documentation for the appropriate value for this field. # @param [Google::Apis::DatacatalogV1beta1::TestIamPermissionsRequest] test_iam_permissions_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -2088,8 +1968,8 @@ module Google # Gets the IAM policy for a taxonomy or a policy tag. # @param [String] resource - # REQUIRED: The resource for which the policy is being requested. - # See the operation documentation for the appropriate value for this field. + # REQUIRED: The resource for which the policy is being requested. See the + # operation documentation for the appropriate value for this field. # @param [Google::Apis::DatacatalogV1beta1::GetIamPolicyRequest] get_iam_policy_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -2124,8 +2004,8 @@ module Google # @param [String] parent # Required. Resource name of the taxonomy to list the policy tags of. # @param [Fixnum] page_size - # The maximum number of items to return. Must be a value between 1 and 1000. - # If not set, defaults to 50. + # The maximum number of items to return. Must be a value between 1 and 1000. If + # not set, defaults to 50. # @param [String] page_token # The next_page_token value returned from a previous List request, if any. If # not set, defaults to an empty string. @@ -2160,19 +2040,18 @@ module Google # Updates a policy tag. # @param [String] name - # Output only. Resource name of this policy tag, whose format is: - # "projects/`project_number`/locations/`location_id`/taxonomies/`taxonomy_id`/ - # policyTags/`id`". + # Output only. Resource name of this policy tag, whose format is: "projects/` + # project_number`/locations/`location_id`/taxonomies/`taxonomy_id`/policyTags/` + # id`". # @param [Google::Apis::DatacatalogV1beta1::GoogleCloudDatacatalogV1beta1PolicyTag] google_cloud_datacatalog_v1beta1_policy_tag_object # @param [String] update_mask # The update mask applies to the resource. Only display_name, description and # parent_policy_tag can be updated and thus can be listed in the mask. If # update_mask is not provided, all allowed fields (i.e. display_name, - # description and parent) will be updated. For more information including the - # `FieldMask` definition, see - # https://developers.google.com/protocol-buffers/docs/reference/google.protobuf# - # fieldmask - # If not set, defaults to all of the fields that are allowed to update. + # description and parent) will be updated. For more information including the ` + # FieldMask` definition, see https://developers.google.com/protocol-buffers/docs/ + # reference/google.protobuf#fieldmask If not set, defaults to all of the fields + # that are allowed to update. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -2205,8 +2084,8 @@ module Google # Sets the IAM policy for a taxonomy or a policy tag. # @param [String] resource - # REQUIRED: The resource for which the policy is being specified. - # See the operation documentation for the appropriate value for this field. + # REQUIRED: The resource for which the policy is being specified. See the + # operation documentation for the appropriate value for this field. # @param [Google::Apis::DatacatalogV1beta1::SetIamPolicyRequest] set_iam_policy_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -2237,11 +2116,11 @@ module Google execute_or_queue_command(command, &block) end - # Returns the permissions that a caller has on the specified taxonomy or - # policy tag. + # Returns the permissions that a caller has on the specified taxonomy or policy + # tag. # @param [String] resource - # REQUIRED: The resource for which the policy detail is being requested. - # See the operation documentation for the appropriate value for this field. + # REQUIRED: The resource for which the policy detail is being requested. See the + # operation documentation for the appropriate value for this field. # @param [Google::Apis::DatacatalogV1beta1::TestIamPermissionsRequest] test_iam_permissions_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. diff --git a/generated/google/apis/dataproc_v1.rb b/generated/google/apis/dataproc_v1.rb index 9235405c2..d0daaa6c2 100644 --- a/generated/google/apis/dataproc_v1.rb +++ b/generated/google/apis/dataproc_v1.rb @@ -25,7 +25,7 @@ module Google # @see https://cloud.google.com/dataproc/ module DataprocV1 VERSION = 'V1' - REVISION = '20200725' + REVISION = '20200807' # 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/dataproc_v1/classes.rb b/generated/google/apis/dataproc_v1/classes.rb index 531023b38..0be7c564e 100644 --- a/generated/google/apis/dataproc_v1/classes.rb +++ b/generated/google/apis/dataproc_v1/classes.rb @@ -178,8 +178,9 @@ module Google # for which to remove workers. A scale-down factor of 1 will result in scaling # down so that there is no available memory remaining after the update (more # aggressive scaling). A scale-down factor of 0 disables removing workers, which - # can be beneficial for autoscaling a single job. See How autoscaling works for - # more information.Bounds: 0.0, 1.0. + # can be beneficial for autoscaling a single job. See How autoscaling works ( + # https://cloud.google.com/dataproc/docs/concepts/configuring-clusters/ + # autoscaling#how_autoscaling_works) for more information.Bounds: 0.0, 1.0. # Corresponds to the JSON property `scaleDownFactor` # @return [Float] attr_accessor :scale_down_factor @@ -197,8 +198,9 @@ module Google # for which to add workers. A scale-up factor of 1.0 will result in scaling up # so that there is no pending memory remaining after the update (more aggressive # scaling). A scale-up factor closer to 0 will result in a smaller magnitude of - # scaling up (less aggressive scaling). See How autoscaling works for more - # information.Bounds: 0.0, 1.0. + # scaling up (less aggressive scaling). See How autoscaling works (https://cloud. + # google.com/dataproc/docs/concepts/configuring-clusters/autoscaling# + # how_autoscaling_works) for more information.Bounds: 0.0, 1.0. # Corresponds to the JSON property `scaleUpFactor` # @return [Float] attr_accessor :scale_up_factor @@ -1276,6 +1278,11 @@ module Google # @return [Array] attr_accessor :instance_names + # Output only. List of references to Compute Engine instances. + # Corresponds to the JSON property `instanceReferences` + # @return [Array] + attr_accessor :instance_references + # Output only. Specifies that this instance group contains preemptible instances. # Corresponds to the JSON property `isPreemptible` # @return [Boolean] @@ -1329,6 +1336,7 @@ module Google @disk_config = args[:disk_config] if args.key?(:disk_config) @image_uri = args[:image_uri] if args.key?(:image_uri) @instance_names = args[:instance_names] if args.key?(:instance_names) + @instance_references = args[:instance_references] if args.key?(:instance_references) @is_preemptible = args[:is_preemptible] if args.key?(:is_preemptible) @machine_type_uri = args[:machine_type_uri] if args.key?(:machine_type_uri) @managed_group_config = args[:managed_group_config] if args.key?(:managed_group_config) @@ -1338,6 +1346,31 @@ module Google end end + # A reference to a Compute Engine instance. + class InstanceReference + include Google::Apis::Core::Hashable + + # The unique identifier of the Compute Engine instance. + # Corresponds to the JSON property `instanceId` + # @return [String] + attr_accessor :instance_id + + # The user-friendly name of the Compute Engine instance. + # Corresponds to the JSON property `instanceName` + # @return [String] + attr_accessor :instance_name + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @instance_id = args[:instance_id] if args.key?(:instance_id) + @instance_name = args[:instance_name] if args.key?(:instance_name) + end + end + # A request to instantiate a workflow template. class InstantiateWorkflowTemplateRequest include Google::Apis::Core::Hashable diff --git a/generated/google/apis/dataproc_v1/representations.rb b/generated/google/apis/dataproc_v1/representations.rb index d01c30355..09eb2d11b 100644 --- a/generated/google/apis/dataproc_v1/representations.rb +++ b/generated/google/apis/dataproc_v1/representations.rb @@ -196,6 +196,12 @@ module Google include Google::Apis::Core::JsonObjectSupport end + class InstanceReference + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class InstantiateWorkflowTemplateRequest class Representation < Google::Apis::Core::JsonRepresentation; end @@ -776,6 +782,8 @@ module Google property :image_uri, as: 'imageUri' collection :instance_names, as: 'instanceNames' + collection :instance_references, as: 'instanceReferences', class: Google::Apis::DataprocV1::InstanceReference, decorator: Google::Apis::DataprocV1::InstanceReference::Representation + property :is_preemptible, as: 'isPreemptible' property :machine_type_uri, as: 'machineTypeUri' property :managed_group_config, as: 'managedGroupConfig', class: Google::Apis::DataprocV1::ManagedGroupConfig, decorator: Google::Apis::DataprocV1::ManagedGroupConfig::Representation @@ -786,6 +794,14 @@ module Google end end + class InstanceReference + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :instance_id, as: 'instanceId' + property :instance_name, as: 'instanceName' + end + end + class InstantiateWorkflowTemplateRequest # @private class Representation < Google::Apis::Core::JsonRepresentation diff --git a/generated/google/apis/dataproc_v1beta2.rb b/generated/google/apis/dataproc_v1beta2.rb index 592d854f0..62b77db4c 100644 --- a/generated/google/apis/dataproc_v1beta2.rb +++ b/generated/google/apis/dataproc_v1beta2.rb @@ -25,7 +25,7 @@ module Google # @see https://cloud.google.com/dataproc/ module DataprocV1beta2 VERSION = 'V1beta2' - REVISION = '20200731' + REVISION = '20200807' # 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/dataproc_v1beta2/classes.rb b/generated/google/apis/dataproc_v1beta2/classes.rb index e63d39636..ad1a4fd86 100644 --- a/generated/google/apis/dataproc_v1beta2/classes.rb +++ b/generated/google/apis/dataproc_v1beta2/classes.rb @@ -1307,6 +1307,11 @@ module Google # @return [Array] attr_accessor :instance_names + # Output only. List of references to Compute Engine instances. + # Corresponds to the JSON property `instanceReferences` + # @return [Array] + attr_accessor :instance_references + # Output only. Specifies that this instance group contains preemptible instances. # Corresponds to the JSON property `isPreemptible` # @return [Boolean] @@ -1360,6 +1365,7 @@ module Google @disk_config = args[:disk_config] if args.key?(:disk_config) @image_uri = args[:image_uri] if args.key?(:image_uri) @instance_names = args[:instance_names] if args.key?(:instance_names) + @instance_references = args[:instance_references] if args.key?(:instance_references) @is_preemptible = args[:is_preemptible] if args.key?(:is_preemptible) @machine_type_uri = args[:machine_type_uri] if args.key?(:machine_type_uri) @managed_group_config = args[:managed_group_config] if args.key?(:managed_group_config) @@ -1369,6 +1375,31 @@ module Google end end + # A reference to a Compute Engine instance. + class InstanceReference + include Google::Apis::Core::Hashable + + # The unique identifier of the Compute Engine instance. + # Corresponds to the JSON property `instanceId` + # @return [String] + attr_accessor :instance_id + + # The user-friendly name of the Compute Engine instance. + # Corresponds to the JSON property `instanceName` + # @return [String] + attr_accessor :instance_name + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @instance_id = args[:instance_id] if args.key?(:instance_id) + @instance_name = args[:instance_name] if args.key?(:instance_name) + end + end + # A request to instantiate a workflow template. class InstantiateWorkflowTemplateRequest include Google::Apis::Core::Hashable diff --git a/generated/google/apis/dataproc_v1beta2/representations.rb b/generated/google/apis/dataproc_v1beta2/representations.rb index 8d3e1a39d..fb3e0fc8a 100644 --- a/generated/google/apis/dataproc_v1beta2/representations.rb +++ b/generated/google/apis/dataproc_v1beta2/representations.rb @@ -202,6 +202,12 @@ module Google include Google::Apis::Core::JsonObjectSupport end + class InstanceReference + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class InstantiateWorkflowTemplateRequest class Representation < Google::Apis::Core::JsonRepresentation; end @@ -818,6 +824,8 @@ module Google property :image_uri, as: 'imageUri' collection :instance_names, as: 'instanceNames' + collection :instance_references, as: 'instanceReferences', class: Google::Apis::DataprocV1beta2::InstanceReference, decorator: Google::Apis::DataprocV1beta2::InstanceReference::Representation + property :is_preemptible, as: 'isPreemptible' property :machine_type_uri, as: 'machineTypeUri' property :managed_group_config, as: 'managedGroupConfig', class: Google::Apis::DataprocV1beta2::ManagedGroupConfig, decorator: Google::Apis::DataprocV1beta2::ManagedGroupConfig::Representation @@ -828,6 +836,14 @@ module Google end end + class InstanceReference + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :instance_id, as: 'instanceId' + property :instance_name, as: 'instanceName' + end + end + class InstantiateWorkflowTemplateRequest # @private class Representation < Google::Apis::Core::JsonRepresentation diff --git a/generated/google/apis/doubleclickbidmanager_v1.rb b/generated/google/apis/doubleclickbidmanager_v1.rb index d366f9b59..962254bc6 100644 --- a/generated/google/apis/doubleclickbidmanager_v1.rb +++ b/generated/google/apis/doubleclickbidmanager_v1.rb @@ -26,7 +26,7 @@ module Google # @see https://developers.google.com/bid-manager/ module DoubleclickbidmanagerV1 VERSION = 'V1' - REVISION = '20200731' + REVISION = '20200811' # View and manage your reports in DoubleClick Bid Manager AUTH_DOUBLECLICKBIDMANAGER = 'https://www.googleapis.com/auth/doubleclickbidmanager' diff --git a/generated/google/apis/doubleclickbidmanager_v1/classes.rb b/generated/google/apis/doubleclickbidmanager_v1/classes.rb index 0fdc6201e..612104a03 100644 --- a/generated/google/apis/doubleclickbidmanager_v1/classes.rb +++ b/generated/google/apis/doubleclickbidmanager_v1/classes.rb @@ -26,8 +26,8 @@ module Google class DownloadLineItemsRequest include Google::Apis::Core::Hashable - # File specification (column names, types, order) in which the line items - # will be returned. Default to EWF. + # File specification (column names, types, order) in which the line items will + # be returned. Default to EWF. # Corresponds to the JSON property `fileSpec` # @return [String] attr_accessor :file_spec @@ -43,8 +43,7 @@ module Google # @return [String] attr_accessor :filter_type - # Format in which the line items will be returned. Default to - # CSV. + # Format in which the line items will be returned. Default to CSV. # Corresponds to the JSON property `format` # @return [String] attr_accessor :format @@ -66,10 +65,8 @@ module Google class DownloadLineItemsResponse include Google::Apis::Core::Hashable - # Retrieved line items in CSV format. For more information about file - # formats, see - # Entity Write File Format. + # Retrieved line items in CSV format. For more information about file formats, + # see Entity Write File Format. # Corresponds to the JSON property `lineItems` # @return [String] attr_accessor :line_items @@ -89,18 +86,15 @@ module Google class DownloadRequest include Google::Apis::Core::Hashable - # File types that will be returned. If INVENTORY_SOURCE is requested, no - # other file types may be requested.

Acceptable values are:
    - #
  • "AD"
  • "AD_GROUP"
    • - #
  • "CAMPAIGN"
  • "INSERTION_ORDER"
    • - #
  • "INVENTORY_SOURCE"
  • "LINE_ITEM"
    • - #
+ # File types that will be returned. If INVENTORY_SOURCE is requested, no other + # file types may be requested. Acceptable values are: - "AD" - "AD_GROUP" - " + # CAMPAIGN" - "INSERTION_ORDER" - "INVENTORY_SOURCE" - "LINE_ITEM" # Corresponds to the JSON property `fileTypes` # @return [Array] attr_accessor :file_types - # The IDs of the specified filter type. This is used to filter entities to - # fetch. At least one ID must be specified. + # The IDs of the specified filter type. This is used to filter entities to fetch. + # At least one ID must be specified. # Corresponds to the JSON property `filterIds` # @return [Array] attr_accessor :filter_ids @@ -112,7 +106,7 @@ module Google attr_accessor :filter_type # SDF Version (column names, types, order) in which the entities will be - # returned. Default to 5. + # returned. Default to 5. # Corresponds to the JSON property `version` # @return [String] attr_accessor :version @@ -208,8 +202,8 @@ module Google class ListQueriesResponse include Google::Apis::Core::Hashable - # Identifies what kind of resource this is. Value: the fixed string - # "doubleclickbidmanager#listQueriesResponse". + # Identifies what kind of resource this is. Value: the fixed string " + # doubleclickbidmanager#listQueriesResponse". # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind @@ -234,8 +228,8 @@ module Google class ListReportsResponse include Google::Apis::Core::Hashable - # Identifies what kind of resource this is. Value: the fixed string - # "doubleclickbidmanager#listReportsResponse". + # Identifies what kind of resource this is. Value: the fixed string " + # doubleclickbidmanager#listReportsResponse". # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind @@ -304,8 +298,8 @@ module Google class Query include Google::Apis::Core::Hashable - # Identifies what kind of resource this is. Value: the fixed string - # "doubleclickbidmanager#query". + # Identifies what kind of resource this is. Value: the fixed string " + # doubleclickbidmanager#query". # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind @@ -326,17 +320,15 @@ module Google attr_accessor :query_id # The ending time for the data that is shown in the report. Note, - # reportDataEndTimeMs is required if - # metadata.dataRange is CUSTOM_DATES and ignored - # otherwise. + # reportDataEndTimeMs is required if metadata.dataRange is CUSTOM_DATES and + # ignored otherwise. # Corresponds to the JSON property `reportDataEndTimeMs` # @return [Fixnum] attr_accessor :report_data_end_time_ms # The starting time for the data that is shown in the report. Note, - # reportDataStartTimeMs is required if - # metadata.dataRange is CUSTOM_DATES and ignored - # otherwise. + # reportDataStartTimeMs is required if metadata.dataRange is CUSTOM_DATES and + # ignored otherwise. # Corresponds to the JSON property `reportDataStartTimeMs` # @return [Fixnum] attr_accessor :report_data_start_time_ms @@ -346,8 +338,7 @@ module Google # @return [Google::Apis::DoubleclickbidmanagerV1::QuerySchedule] attr_accessor :schedule - # Canonical timezone code for report data time. Defaults to - # America/New_York. + # Canonical timezone code for report data time. Defaults to America/New_York. # Corresponds to the JSON property `timezoneCode` # @return [String] attr_accessor :timezone_code @@ -399,12 +390,11 @@ module Google # @return [Fixnum] attr_accessor :latest_report_run_time_ms - # Locale of the generated reports. Valid values are cs CZECH de - # GERMAN en ENGLISH es SPANISH fr FRENCH it ITALIAN ja - # JAPANESE ko KOREAN pl POLISH pt-BR BRAZILIAN_PORTUGUESE ru - # RUSSIAN tr TURKISH uk UKRAINIAN zh-CN CHINA_CHINESE zh-TW - # TAIWAN_CHINESE

An locale string not in the list above will - # generate reports in English. + # Locale of the generated reports. Valid values are cs CZECH de GERMAN en + # ENGLISH es SPANISH fr FRENCH it ITALIAN ja JAPANESE ko KOREAN pl POLISH pt-BR + # BRAZILIAN_PORTUGUESE ru RUSSIAN tr TURKISH uk UKRAINIAN zh-CN CHINA_CHINESE zh- + # TW TAIWAN_CHINESE An locale string not in the list above will generate reports + # in English. # Corresponds to the JSON property `locale` # @return [String] attr_accessor :locale @@ -420,15 +410,14 @@ module Google attr_accessor :running alias_method :running?, :running - # Whether to send an email notification when a report is ready. Default to - # false. + # Whether to send an email notification when a report is ready. Default to false. # Corresponds to the JSON property `sendNotification` # @return [Boolean] attr_accessor :send_notification alias_method :send_notification?, :send_notification - # List of email addresses which are sent email notifications when the report - # is finished. Separate from sendNotification. + # List of email addresses which are sent email notifications when the report is + # finished. Separate from sendNotification. # Corresponds to the JSON property `shareEmailAddress` # @return [Array] attr_accessor :share_email_address @@ -478,8 +467,8 @@ module Google # @return [Fixnum] attr_accessor :next_run_minute_of_day - # Canonical timezone code for report generation time. Defaults to - # America/New_York. + # Canonical timezone code for report generation time. Defaults to America/ + # New_York. # Corresponds to the JSON property `nextRunTimezoneCode` # @return [String] attr_accessor :next_run_timezone_code @@ -576,8 +565,7 @@ module Google class ReportMetadata include Google::Apis::Core::Hashable - # The path to the location in Google Cloud Storage where the report is - # stored. + # The path to the location in Google Cloud Storage where the report is stored. # Corresponds to the JSON property `googleCloudStoragePath` # @return [String] attr_accessor :google_cloud_storage_path @@ -708,21 +696,20 @@ module Google attr_accessor :data_range # The ending time for the data that is shown in the report. Note, - # reportDataEndTimeMs is required if dataRange is - # CUSTOM_DATES and ignored otherwise. + # reportDataEndTimeMs is required if dataRange is CUSTOM_DATES and ignored + # otherwise. # Corresponds to the JSON property `reportDataEndTimeMs` # @return [Fixnum] attr_accessor :report_data_end_time_ms # The starting time for the data that is shown in the report. Note, - # reportDataStartTimeMs is required if dataRange is - # CUSTOM_DATES and ignored otherwise. + # reportDataStartTimeMs is required if dataRange is CUSTOM_DATES and ignored + # otherwise. # Corresponds to the JSON property `reportDataStartTimeMs` # @return [Fixnum] attr_accessor :report_data_start_time_ms - # Canonical timezone code for report data time. Defaults to - # America/New_York. + # Canonical timezone code for report data time. Defaults to America/New_York. # Corresponds to the JSON property `timezoneCode` # @return [String] attr_accessor :timezone_code @@ -744,21 +731,19 @@ module Google class UploadLineItemsRequest include Google::Apis::Core::Hashable - # Set to true to get upload status without actually persisting - # the line items. + # Set to true to get upload status without actually persisting the line items. # Corresponds to the JSON property `dryRun` # @return [Boolean] attr_accessor :dry_run alias_method :dry_run?, :dry_run - # Format the line items are in. Default to CSV. + # Format the line items are in. Default to CSV. # Corresponds to the JSON property `format` # @return [String] attr_accessor :format - # Line items in CSV to upload. Refer to - # Entity Write File Format for more information on file format. + # Line items in CSV to upload. Refer to Entity Write File Format for more + # information on file format. # Corresponds to the JSON property `lineItems` # @return [String] attr_accessor :line_items diff --git a/generated/google/apis/doubleclickbidmanager_v1/service.rb b/generated/google/apis/doubleclickbidmanager_v1/service.rb index cb10bb1c5..218912d26 100644 --- a/generated/google/apis/doubleclickbidmanager_v1/service.rb +++ b/generated/google/apis/doubleclickbidmanager_v1/service.rb @@ -44,7 +44,7 @@ module Google attr_accessor :quota_user def initialize - super('https://www.googleapis.com/', '') + super('https://www.googleapis.com/', 'doubleclickbidmanager/v1/') @batch_path = 'batch/doubleclickbidmanager' end @@ -69,7 +69,7 @@ module Google # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required def download_line_items(download_line_items_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:post, 'doubleclickbidmanager/v1/lineitems/downloadlineitems', options) + command = make_simple_command(:post, 'lineitems/downloadlineitems', options) command.request_representation = Google::Apis::DoubleclickbidmanagerV1::DownloadLineItemsRequest::Representation command.request_object = download_line_items_request_object command.response_representation = Google::Apis::DoubleclickbidmanagerV1::DownloadLineItemsResponse::Representation @@ -100,7 +100,7 @@ module Google # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required def upload_line_items(upload_line_items_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:post, 'doubleclickbidmanager/v1/lineitems/uploadlineitems', options) + command = make_simple_command(:post, 'lineitems/uploadlineitems', options) command.request_representation = Google::Apis::DoubleclickbidmanagerV1::UploadLineItemsRequest::Representation command.request_object = upload_line_items_request_object command.response_representation = Google::Apis::DoubleclickbidmanagerV1::UploadLineItemsResponse::Representation @@ -130,7 +130,7 @@ module Google # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required def create_query(query_object = nil, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:post, 'doubleclickbidmanager/v1/query', options) + command = make_simple_command(:post, 'query', options) command.request_representation = Google::Apis::DoubleclickbidmanagerV1::Query::Representation command.request_object = query_object command.response_representation = Google::Apis::DoubleclickbidmanagerV1::Query::Representation @@ -161,7 +161,7 @@ module Google # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required def deletequery(query_id, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:delete, 'doubleclickbidmanager/v1/query/{queryId}', options) + command = make_simple_command(:delete, 'query/{queryId}', options) command.params['queryId'] = query_id unless query_id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? @@ -189,7 +189,7 @@ module Google # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required def get_query(query_id, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:get, 'doubleclickbidmanager/v1/query/{queryId}', options) + command = make_simple_command(:get, 'query/{queryId}', options) command.response_representation = Google::Apis::DoubleclickbidmanagerV1::Query::Representation command.response_class = Google::Apis::DoubleclickbidmanagerV1::Query command.params['queryId'] = query_id unless query_id.nil? @@ -217,7 +217,7 @@ module Google # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required def list_queries(fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:get, 'doubleclickbidmanager/v1/queries', options) + command = make_simple_command(:get, 'queries', options) command.response_representation = Google::Apis::DoubleclickbidmanagerV1::ListQueriesResponse::Representation command.response_class = Google::Apis::DoubleclickbidmanagerV1::ListQueriesResponse command.query['fields'] = fields unless fields.nil? @@ -247,7 +247,7 @@ module Google # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required def run_query(query_id, run_query_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:post, 'doubleclickbidmanager/v1/query/{queryId}', options) + command = make_simple_command(:post, 'query/{queryId}', options) command.request_representation = Google::Apis::DoubleclickbidmanagerV1::RunQueryRequest::Representation command.request_object = run_query_request_object command.params['queryId'] = query_id unless query_id.nil? @@ -277,7 +277,7 @@ module Google # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required def list_reports(query_id, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:get, 'doubleclickbidmanager/v1/queries/{queryId}/reports', options) + command = make_simple_command(:get, 'queries/{queryId}/reports', options) command.response_representation = Google::Apis::DoubleclickbidmanagerV1::ListReportsResponse::Representation command.response_class = Google::Apis::DoubleclickbidmanagerV1::ListReportsResponse command.params['queryId'] = query_id unless query_id.nil? @@ -306,7 +306,7 @@ module Google # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required def download_sdf(download_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:post, 'doubleclickbidmanager/v1/sdf/download', options) + command = make_simple_command(:post, 'sdf/download', options) command.request_representation = Google::Apis::DoubleclickbidmanagerV1::DownloadRequest::Representation command.request_object = download_request_object command.response_representation = Google::Apis::DoubleclickbidmanagerV1::DownloadResponse::Representation diff --git a/generated/google/apis/doubleclickbidmanager_v1_1.rb b/generated/google/apis/doubleclickbidmanager_v1_1.rb index 40a5df5e2..28e514baa 100644 --- a/generated/google/apis/doubleclickbidmanager_v1_1.rb +++ b/generated/google/apis/doubleclickbidmanager_v1_1.rb @@ -26,7 +26,7 @@ module Google # @see https://developers.google.com/bid-manager/ module DoubleclickbidmanagerV1_1 VERSION = 'V1_1' - REVISION = '20200731' + REVISION = '20200811' # View and manage your reports in DoubleClick Bid Manager AUTH_DOUBLECLICKBIDMANAGER = 'https://www.googleapis.com/auth/doubleclickbidmanager' diff --git a/generated/google/apis/doubleclickbidmanager_v1_1/classes.rb b/generated/google/apis/doubleclickbidmanager_v1_1/classes.rb index bdcd95107..fc2206d00 100644 --- a/generated/google/apis/doubleclickbidmanager_v1_1/classes.rb +++ b/generated/google/apis/doubleclickbidmanager_v1_1/classes.rb @@ -38,8 +38,8 @@ module Google # @return [String] attr_accessor :name - # Rules within Channel Grouping. There is a limit of 100 rules that can be - # set per channel grouping. + # Rules within Channel Grouping. There is a limit of 100 rules that can be set + # per channel grouping. # Corresponds to the JSON property `rules` # @return [Array] attr_accessor :rules @@ -60,8 +60,8 @@ module Google class DisjunctiveMatchStatement include Google::Apis::Core::Hashable - # Filters. There is a limit of 100 filters that can be set per disjunctive - # match statement. + # Filters. There is a limit of 100 filters that can be set per disjunctive match + # statement. # Corresponds to the JSON property `eventFilters` # @return [Array] attr_accessor :event_filters @@ -80,8 +80,8 @@ module Google class DownloadLineItemsRequest include Google::Apis::Core::Hashable - # File specification (column names, types, order) in which the line items - # will be returned. Default to EWF. + # File specification (column names, types, order) in which the line items will + # be returned. Default to EWF. # Corresponds to the JSON property `fileSpec` # @return [String] attr_accessor :file_spec @@ -97,8 +97,7 @@ module Google # @return [String] attr_accessor :filter_type - # Format in which the line items will be returned. Default to - # CSV. + # Format in which the line items will be returned. Default to CSV. # Corresponds to the JSON property `format` # @return [String] attr_accessor :format @@ -120,10 +119,8 @@ module Google class DownloadLineItemsResponse include Google::Apis::Core::Hashable - # Retrieved line items in CSV format. For more information about file - # formats, see - # Entity Write File Format. + # Retrieved line items in CSV format. For more information about file formats, + # see Entity Write File Format. # Corresponds to the JSON property `lineItems` # @return [String] attr_accessor :line_items @@ -143,18 +140,15 @@ module Google class DownloadRequest include Google::Apis::Core::Hashable - # File types that will be returned. If INVENTORY_SOURCE is requested, no - # other file types may be requested.

Acceptable values are:
    - #
  • "AD"
  • "AD_GROUP"
    • - #
  • "CAMPAIGN"
  • "INSERTION_ORDER"
    • - #
  • "INVENTORY_SOURCE"
  • "LINE_ITEM"
    • - #
+ # File types that will be returned. If INVENTORY_SOURCE is requested, no other + # file types may be requested. Acceptable values are: - "AD" - "AD_GROUP" - " + # CAMPAIGN" - "INSERTION_ORDER" - "INVENTORY_SOURCE" - "LINE_ITEM" # Corresponds to the JSON property `fileTypes` # @return [Array] attr_accessor :file_types - # The IDs of the specified filter type. This is used to filter entities to - # fetch. At least one ID must be specified. + # The IDs of the specified filter type. This is used to filter entities to fetch. + # At least one ID must be specified. # Corresponds to the JSON property `filterIds` # @return [Array] attr_accessor :filter_ids @@ -166,7 +160,7 @@ module Google attr_accessor :filter_type # SDF Version (column names, types, order) in which the entities will be - # returned. Default to 5. + # returned. Default to 5. # Corresponds to the JSON property `version` # @return [String] attr_accessor :version @@ -282,8 +276,8 @@ module Google class ListQueriesResponse include Google::Apis::Core::Hashable - # Identifies what kind of resource this is. Value: the fixed string - # "doubleclickbidmanager#listQueriesResponse". + # Identifies what kind of resource this is. Value: the fixed string " + # doubleclickbidmanager#listQueriesResponse". # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind @@ -314,8 +308,8 @@ module Google class ListReportsResponse include Google::Apis::Core::Hashable - # Identifies what kind of resource this is. Value: the fixed string - # "doubleclickbidmanager#listReportsResponse". + # Identifies what kind of resource this is. Value: the fixed string " + # doubleclickbidmanager#listReportsResponse". # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind @@ -346,9 +340,9 @@ module Google class Options include Google::Apis::Core::Hashable - # Set to true and filter your report by `FILTER_INSERTION_ORDER` or - # `FILTER_LINE_ITEM` to include data for audience lists specifically targeted - # by those items. + # Set to true and filter your report by `FILTER_INSERTION_ORDER` or ` + # FILTER_LINE_ITEM` to include data for audience lists specifically targeted by + # those items. # Corresponds to the JSON property `includeOnlyTargetedUserLists` # @return [Boolean] attr_accessor :include_only_targeted_user_lists @@ -421,10 +415,10 @@ module Google end # Path filters specify which paths to include in a report. A path is the result - # of combining DV360 events based on User ID to create a workflow of - # users' actions.

When a path filter is set, the resulting report will - # only include paths that match the specified event at the specified position. - # All other paths will be excluded. + # of combining DV360 events based on User ID to create a workflow of users' + # actions. When a path filter is set, the resulting report will only include + # paths that match the specified event at the specified position. All other + # paths will be excluded. class PathFilter include Google::Apis::Core::Hashable @@ -433,8 +427,8 @@ module Google # @return [Array] attr_accessor :event_filters - # Indicates the position of the path the filter should match to (first, last, - # or any event in path). + # Indicates the position of the path the filter should match to (first, last, or + # any event in path). # Corresponds to the JSON property `pathMatchPosition` # @return [String] attr_accessor :path_match_position @@ -460,8 +454,7 @@ module Google # @return [Google::Apis::DoubleclickbidmanagerV1_1::ChannelGrouping] attr_accessor :channel_grouping - # Path Filters. There is a limit of 100 path filters that can be set per - # report. + # Path Filters. There is a limit of 100 path filters that can be set per report. # Corresponds to the JSON property `pathFilters` # @return [Array] attr_accessor :path_filters @@ -512,8 +505,8 @@ module Google class Query include Google::Apis::Core::Hashable - # Identifies what kind of resource this is. Value: the fixed string - # "doubleclickbidmanager#query". + # Identifies what kind of resource this is. Value: the fixed string " + # doubleclickbidmanager#query". # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind @@ -534,17 +527,15 @@ module Google attr_accessor :query_id # The ending time for the data that is shown in the report. Note, - # reportDataEndTimeMs is required if - # metadata.dataRange is CUSTOM_DATES and ignored - # otherwise. + # reportDataEndTimeMs is required if metadata.dataRange is CUSTOM_DATES and + # ignored otherwise. # Corresponds to the JSON property `reportDataEndTimeMs` # @return [Fixnum] attr_accessor :report_data_end_time_ms # The starting time for the data that is shown in the report. Note, - # reportDataStartTimeMs is required if - # metadata.dataRange is CUSTOM_DATES and ignored - # otherwise. + # reportDataStartTimeMs is required if metadata.dataRange is CUSTOM_DATES and + # ignored otherwise. # Corresponds to the JSON property `reportDataStartTimeMs` # @return [Fixnum] attr_accessor :report_data_start_time_ms @@ -554,8 +545,7 @@ module Google # @return [Google::Apis::DoubleclickbidmanagerV1_1::QuerySchedule] attr_accessor :schedule - # Canonical timezone code for report data time. Defaults to - # America/New_York. + # Canonical timezone code for report data time. Defaults to America/New_York. # Corresponds to the JSON property `timezoneCode` # @return [String] attr_accessor :timezone_code @@ -607,12 +597,11 @@ module Google # @return [Fixnum] attr_accessor :latest_report_run_time_ms - # Locale of the generated reports. Valid values are cs CZECH de - # GERMAN en ENGLISH es SPANISH fr FRENCH it ITALIAN ja - # JAPANESE ko KOREAN pl POLISH pt-BR BRAZILIAN_PORTUGUESE ru - # RUSSIAN tr TURKISH uk UKRAINIAN zh-CN CHINA_CHINESE zh-TW - # TAIWAN_CHINESE

An locale string not in the list above will - # generate reports in English. + # Locale of the generated reports. Valid values are cs CZECH de GERMAN en + # ENGLISH es SPANISH fr FRENCH it ITALIAN ja JAPANESE ko KOREAN pl POLISH pt-BR + # BRAZILIAN_PORTUGUESE ru RUSSIAN tr TURKISH uk UKRAINIAN zh-CN CHINA_CHINESE zh- + # TW TAIWAN_CHINESE An locale string not in the list above will generate reports + # in English. # Corresponds to the JSON property `locale` # @return [String] attr_accessor :locale @@ -628,15 +617,14 @@ module Google attr_accessor :running alias_method :running?, :running - # Whether to send an email notification when a report is ready. Default to - # false. + # Whether to send an email notification when a report is ready. Default to false. # Corresponds to the JSON property `sendNotification` # @return [Boolean] attr_accessor :send_notification alias_method :send_notification?, :send_notification - # List of email addresses which are sent email notifications when the report - # is finished. Separate from sendNotification. + # List of email addresses which are sent email notifications when the report is + # finished. Separate from sendNotification. # Corresponds to the JSON property `shareEmailAddress` # @return [Array] attr_accessor :share_email_address @@ -686,8 +674,8 @@ module Google # @return [Fixnum] attr_accessor :next_run_minute_of_day - # Canonical timezone code for report generation time. Defaults to - # America/New_York. + # Canonical timezone code for report generation time. Defaults to America/ + # New_York. # Corresponds to the JSON property `nextRunTimezoneCode` # @return [String] attr_accessor :next_run_timezone_code @@ -790,8 +778,7 @@ module Google class ReportMetadata include Google::Apis::Core::Hashable - # The path to the location in Google Cloud Storage where the report is - # stored. + # The path to the location in Google Cloud Storage where the report is stored. # Corresponds to the JSON property `googleCloudStoragePath` # @return [String] attr_accessor :google_cloud_storage_path @@ -912,10 +899,9 @@ module Google end end - # A Rule defines a name, and a boolean expression in [conjunctive normal - # form](http: - # //mathworld.wolfram.com/ConjunctiveNormalForm.html)`.external` that can be - # // applied to a path event to determine if that name should be applied. + # A Rule defines a name, and a boolean expression in [conjunctive normal form]( + # http: //mathworld.wolfram.com/ConjunctiveNormalForm.html)`.external` that can + # be // applied to a path event to determine if that name should be applied. class Rule include Google::Apis::Core::Hashable @@ -950,21 +936,20 @@ module Google attr_accessor :data_range # The ending time for the data that is shown in the report. Note, - # reportDataEndTimeMs is required if dataRange is - # CUSTOM_DATES and ignored otherwise. + # reportDataEndTimeMs is required if dataRange is CUSTOM_DATES and ignored + # otherwise. # Corresponds to the JSON property `reportDataEndTimeMs` # @return [Fixnum] attr_accessor :report_data_end_time_ms # The starting time for the data that is shown in the report. Note, - # reportDataStartTimeMs is required if dataRange is - # CUSTOM_DATES and ignored otherwise. + # reportDataStartTimeMs is required if dataRange is CUSTOM_DATES and ignored + # otherwise. # Corresponds to the JSON property `reportDataStartTimeMs` # @return [Fixnum] attr_accessor :report_data_start_time_ms - # Canonical timezone code for report data time. Defaults to - # America/New_York. + # Canonical timezone code for report data time. Defaults to America/New_York. # Corresponds to the JSON property `timezoneCode` # @return [String] attr_accessor :timezone_code @@ -986,21 +971,19 @@ module Google class UploadLineItemsRequest include Google::Apis::Core::Hashable - # Set to true to get upload status without actually persisting - # the line items. + # Set to true to get upload status without actually persisting the line items. # Corresponds to the JSON property `dryRun` # @return [Boolean] attr_accessor :dry_run alias_method :dry_run?, :dry_run - # Format the line items are in. Default to CSV. + # Format the line items are in. Default to CSV. # Corresponds to the JSON property `format` # @return [String] attr_accessor :format - # Line items in CSV to upload. Refer to - # Entity Write File Format for more information on file format. + # Line items in CSV to upload. Refer to Entity Write File Format for more + # information on file format. # Corresponds to the JSON property `lineItems` # @return [String] attr_accessor :line_items diff --git a/generated/google/apis/doubleclickbidmanager_v1_1/service.rb b/generated/google/apis/doubleclickbidmanager_v1_1/service.rb index f78979f24..6a86a4d64 100644 --- a/generated/google/apis/doubleclickbidmanager_v1_1/service.rb +++ b/generated/google/apis/doubleclickbidmanager_v1_1/service.rb @@ -44,7 +44,7 @@ module Google attr_accessor :quota_user def initialize - super('https://www.googleapis.com/', '') + super('https://www.googleapis.com/', 'doubleclickbidmanager/v1.1/') @batch_path = 'batch/doubleclickbidmanager' end @@ -69,7 +69,7 @@ module Google # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required def downloadlineitems_lineitem(download_line_items_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:post, 'doubleclickbidmanager/v1.1/lineitems/downloadlineitems', options) + command = make_simple_command(:post, 'lineitems/downloadlineitems', options) command.request_representation = Google::Apis::DoubleclickbidmanagerV1_1::DownloadLineItemsRequest::Representation command.request_object = download_line_items_request_object command.response_representation = Google::Apis::DoubleclickbidmanagerV1_1::DownloadLineItemsResponse::Representation @@ -100,7 +100,7 @@ module Google # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required def uploadlineitems_lineitem(upload_line_items_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:post, 'doubleclickbidmanager/v1.1/lineitems/uploadlineitems', options) + command = make_simple_command(:post, 'lineitems/uploadlineitems', options) command.request_representation = Google::Apis::DoubleclickbidmanagerV1_1::UploadLineItemsRequest::Representation command.request_object = upload_line_items_request_object command.response_representation = Google::Apis::DoubleclickbidmanagerV1_1::UploadLineItemsResponse::Representation @@ -113,8 +113,8 @@ module Google # Creates a query. # @param [Google::Apis::DoubleclickbidmanagerV1_1::Query] query_object # @param [Boolean] asynchronous - # If true, tries to run the query asynchronously. Only applicable when - # the frequency is ONE_TIME. + # If true, tries to run the query asynchronously. Only applicable when the + # frequency is ONE_TIME. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -133,7 +133,7 @@ module Google # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required def createquery_query(query_object = nil, asynchronous: nil, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:post, 'doubleclickbidmanager/v1.1/query', options) + command = make_simple_command(:post, 'query', options) command.request_representation = Google::Apis::DoubleclickbidmanagerV1_1::Query::Representation command.request_object = query_object command.response_representation = Google::Apis::DoubleclickbidmanagerV1_1::Query::Representation @@ -165,7 +165,7 @@ module Google # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required def deletequery_query(query_id, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:delete, 'doubleclickbidmanager/v1.1/query/{queryId}', options) + command = make_simple_command(:delete, 'query/{queryId}', options) command.params['queryId'] = query_id unless query_id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? @@ -193,7 +193,7 @@ module Google # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required def getquery_query(query_id, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:get, 'doubleclickbidmanager/v1.1/query/{queryId}', options) + command = make_simple_command(:get, 'query/{queryId}', options) command.response_representation = Google::Apis::DoubleclickbidmanagerV1_1::Query::Representation command.response_class = Google::Apis::DoubleclickbidmanagerV1_1::Query command.params['queryId'] = query_id unless query_id.nil? @@ -204,8 +204,8 @@ module Google # Retrieves stored queries. # @param [Fixnum] page_size - # Maximum number of results per page. Must be between 1 and - # 100. Defaults to 100 if unspecified. + # Maximum number of results per page. Must be between 1 and 100. Defaults to 100 + # if unspecified. # @param [String] page_token # Optional pagination token. # @param [String] fields @@ -226,7 +226,7 @@ module Google # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required def listqueries_query(page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:get, 'doubleclickbidmanager/v1.1/queries', options) + command = make_simple_command(:get, 'queries', options) command.response_representation = Google::Apis::DoubleclickbidmanagerV1_1::ListQueriesResponse::Representation command.response_class = Google::Apis::DoubleclickbidmanagerV1_1::ListQueriesResponse command.query['pageSize'] = page_size unless page_size.nil? @@ -260,7 +260,7 @@ module Google # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required def runquery_query(query_id, run_query_request_object = nil, asynchronous: nil, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:post, 'doubleclickbidmanager/v1.1/query/{queryId}', options) + command = make_simple_command(:post, 'query/{queryId}', options) command.request_representation = Google::Apis::DoubleclickbidmanagerV1_1::RunQueryRequest::Representation command.request_object = run_query_request_object command.params['queryId'] = query_id unless query_id.nil? @@ -274,8 +274,8 @@ module Google # @param [Fixnum] query_id # Query ID with which the reports are associated. # @param [Fixnum] page_size - # Maximum number of results per page. Must be between 1 and - # 100. Defaults to 100 if unspecified. + # Maximum number of results per page. Must be between 1 and 100. Defaults to 100 + # if unspecified. # @param [String] page_token # Optional pagination token. # @param [String] fields @@ -296,7 +296,7 @@ module Google # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required def listreports_report(query_id, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:get, 'doubleclickbidmanager/v1.1/queries/{queryId}/reports', options) + command = make_simple_command(:get, 'queries/{queryId}/reports', options) command.response_representation = Google::Apis::DoubleclickbidmanagerV1_1::ListReportsResponse::Representation command.response_class = Google::Apis::DoubleclickbidmanagerV1_1::ListReportsResponse command.params['queryId'] = query_id unless query_id.nil? @@ -327,7 +327,7 @@ module Google # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required def download_sdf(download_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:post, 'doubleclickbidmanager/v1.1/sdf/download', options) + command = make_simple_command(:post, 'sdf/download', options) command.request_representation = Google::Apis::DoubleclickbidmanagerV1_1::DownloadRequest::Representation command.request_object = download_request_object command.response_representation = Google::Apis::DoubleclickbidmanagerV1_1::DownloadResponse::Representation diff --git a/generated/google/apis/iamcredentials_v1.rb b/generated/google/apis/iamcredentials_v1.rb index b1223979f..04850f54a 100644 --- a/generated/google/apis/iamcredentials_v1.rb +++ b/generated/google/apis/iamcredentials_v1.rb @@ -25,7 +25,7 @@ module Google # @see https://cloud.google.com/iam/docs/creating-short-lived-service-account-credentials module IamcredentialsV1 VERSION = 'V1' - REVISION = '20200612' + REVISION = '20200807' # 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/iamcredentials_v1/classes.rb b/generated/google/apis/iamcredentials_v1/classes.rb index 1cf40eacb..e63db041e 100644 --- a/generated/google/apis/iamcredentials_v1/classes.rb +++ b/generated/google/apis/iamcredentials_v1/classes.rb @@ -26,32 +26,28 @@ module Google class GenerateAccessTokenRequest include Google::Apis::Core::Hashable - # The sequence of service accounts in a delegation chain. Each service - # account must be granted the `roles/iam.serviceAccountTokenCreator` role - # on its next service account in the chain. The last service account in the - # chain must be granted the `roles/iam.serviceAccountTokenCreator` role - # on the service account that is specified in the `name` field of the - # request. - # The delegates must have the following format: - # `projects/-/serviceAccounts/`ACCOUNT_EMAIL_OR_UNIQUEID``. The `-` wildcard - # character is required; replacing it with a project ID is invalid. + # The sequence of service accounts in a delegation chain. Each service account + # must be granted the `roles/iam.serviceAccountTokenCreator` role on its next + # service account in the chain. The last service account in the chain must be + # granted the `roles/iam.serviceAccountTokenCreator` role on the service account + # that is specified in the `name` field of the request. The delegates must have + # the following format: `projects/-/serviceAccounts/`ACCOUNT_EMAIL_OR_UNIQUEID``. + # The `-` wildcard character is required; replacing it with a project ID is + # invalid. # Corresponds to the JSON property `delegates` # @return [Array] attr_accessor :delegates - # The desired lifetime duration of the access token in seconds. - # Must be set to a value less than or equal to 3600 (1 hour). If a value is - # not specified, the token's lifetime will be set to a default value of one - # hour. + # The desired lifetime duration of the access token in seconds. Must be set to a + # value less than or equal to 3600 (1 hour). If a value is not specified, the + # token's lifetime will be set to a default value of one hour. # Corresponds to the JSON property `lifetime` # @return [String] attr_accessor :lifetime # Required. Code to identify the scopes to be included in the OAuth 2.0 access - # token. - # See https://developers.google.com/identity/protocols/googlescopes for more - # information. - # At least one value required. + # token. See https://developers.google.com/identity/protocols/googlescopes for + # more information. At least one value required. # Corresponds to the JSON property `scope` # @return [Array] attr_accessor :scope @@ -77,8 +73,7 @@ module Google # @return [String] attr_accessor :access_token - # Token expiration time. - # The expiration time is always set. + # Token expiration time. The expiration time is always set. # Corresponds to the JSON property `expireTime` # @return [String] attr_accessor :expire_time @@ -99,27 +94,25 @@ module Google include Google::Apis::Core::Hashable # Required. The audience for the token, such as the API or account that this - # token - # grants access to. + # token grants access to. # Corresponds to the JSON property `audience` # @return [String] attr_accessor :audience - # The sequence of service accounts in a delegation chain. Each service - # account must be granted the `roles/iam.serviceAccountTokenCreator` role - # on its next service account in the chain. The last service account in the - # chain must be granted the `roles/iam.serviceAccountTokenCreator` role - # on the service account that is specified in the `name` field of the - # request. - # The delegates must have the following format: - # `projects/-/serviceAccounts/`ACCOUNT_EMAIL_OR_UNIQUEID``. The `-` wildcard - # character is required; replacing it with a project ID is invalid. + # The sequence of service accounts in a delegation chain. Each service account + # must be granted the `roles/iam.serviceAccountTokenCreator` role on its next + # service account in the chain. The last service account in the chain must be + # granted the `roles/iam.serviceAccountTokenCreator` role on the service account + # that is specified in the `name` field of the request. The delegates must have + # the following format: `projects/-/serviceAccounts/`ACCOUNT_EMAIL_OR_UNIQUEID``. + # The `-` wildcard character is required; replacing it with a project ID is + # invalid. # Corresponds to the JSON property `delegates` # @return [Array] attr_accessor :delegates - # Include the service account email in the token. If set to `true`, the - # token will contain `email` and `email_verified` claims. + # Include the service account email in the token. If set to `true`, the token + # will contain `email` and `email_verified` claims. # Corresponds to the JSON property `includeEmail` # @return [Boolean] attr_accessor :include_email @@ -160,15 +153,14 @@ module Google class SignBlobRequest include Google::Apis::Core::Hashable - # The sequence of service accounts in a delegation chain. Each service - # account must be granted the `roles/iam.serviceAccountTokenCreator` role - # on its next service account in the chain. The last service account in the - # chain must be granted the `roles/iam.serviceAccountTokenCreator` role - # on the service account that is specified in the `name` field of the - # request. - # The delegates must have the following format: - # `projects/-/serviceAccounts/`ACCOUNT_EMAIL_OR_UNIQUEID``. The `-` wildcard - # character is required; replacing it with a project ID is invalid. + # The sequence of service accounts in a delegation chain. Each service account + # must be granted the `roles/iam.serviceAccountTokenCreator` role on its next + # service account in the chain. The last service account in the chain must be + # granted the `roles/iam.serviceAccountTokenCreator` role on the service account + # that is specified in the `name` field of the request. The delegates must have + # the following format: `projects/-/serviceAccounts/`ACCOUNT_EMAIL_OR_UNIQUEID``. + # The `-` wildcard character is required; replacing it with a project ID is + # invalid. # Corresponds to the JSON property `delegates` # @return [Array] attr_accessor :delegates @@ -194,24 +186,22 @@ module Google class SignBlobResponse include Google::Apis::Core::Hashable - # The ID of the key used to sign the blob. The key used for signing will - # remain valid for at least 12 hours after the blob is signed. To verify the - # signature, you can retrieve the public key in several formats from the - # following endpoints: - # - RSA public key wrapped in an X.509 v3 certificate: - # `https://www.googleapis.com/service_accounts/v1/metadata/x509/`ACCOUNT_EMAIL`` - # - Raw key in JSON format: - # `https://www.googleapis.com/service_accounts/v1/metadata/raw/`ACCOUNT_EMAIL`` - # - JSON Web Key (JWK): - # `https://www.googleapis.com/service_accounts/v1/metadata/jwk/`ACCOUNT_EMAIL`` + # The ID of the key used to sign the blob. The key used for signing will remain + # valid for at least 12 hours after the blob is signed. To verify the signature, + # you can retrieve the public key in several formats from the following + # endpoints: - RSA public key wrapped in an X.509 v3 certificate: `https://www. + # googleapis.com/service_accounts/v1/metadata/x509/`ACCOUNT_EMAIL`` - Raw key in + # JSON format: `https://www.googleapis.com/service_accounts/v1/metadata/raw/` + # ACCOUNT_EMAIL`` - JSON Web Key (JWK): `https://www.googleapis.com/ + # service_accounts/v1/metadata/jwk/`ACCOUNT_EMAIL`` # Corresponds to the JSON property `keyId` # @return [String] attr_accessor :key_id - # The signature for the blob. Does not include the original blob. - # After the key pair referenced by the `key_id` response field expires, - # Google no longer exposes the public key that can be used to verify the - # blob. As a result, the receiver can no longer verify the signature. + # The signature for the blob. Does not include the original blob. After the key + # pair referenced by the `key_id` response field expires, Google no longer + # exposes the public key that can be used to verify the blob. As a result, the + # receiver can no longer verify the signature. # Corresponds to the JSON property `signedBlob` # NOTE: Values are automatically base64 encoded/decoded in the client library. # @return [String] @@ -232,25 +222,23 @@ module Google class SignJwtRequest include Google::Apis::Core::Hashable - # The sequence of service accounts in a delegation chain. Each service - # account must be granted the `roles/iam.serviceAccountTokenCreator` role - # on its next service account in the chain. The last service account in the - # chain must be granted the `roles/iam.serviceAccountTokenCreator` role - # on the service account that is specified in the `name` field of the - # request. - # The delegates must have the following format: - # `projects/-/serviceAccounts/`ACCOUNT_EMAIL_OR_UNIQUEID``. The `-` wildcard - # character is required; replacing it with a project ID is invalid. + # The sequence of service accounts in a delegation chain. Each service account + # must be granted the `roles/iam.serviceAccountTokenCreator` role on its next + # service account in the chain. The last service account in the chain must be + # granted the `roles/iam.serviceAccountTokenCreator` role on the service account + # that is specified in the `name` field of the request. The delegates must have + # the following format: `projects/-/serviceAccounts/`ACCOUNT_EMAIL_OR_UNIQUEID``. + # The `-` wildcard character is required; replacing it with a project ID is + # invalid. # Corresponds to the JSON property `delegates` # @return [Array] attr_accessor :delegates # Required. The JWT payload to sign. Must be a serialized JSON object that - # contains a - # JWT Claims Set. For example: ``"sub": "user@example.com", "iat": 313435`` - # If the JWT Claims Set contains an expiration time (`exp`) claim, it must be - # an integer timestamp that is not in the past and no more than 12 hours in - # the future. + # contains a JWT Claims Set. For example: ``"sub": "user@example.com", "iat": + # 313435`` If the JWT Claims Set contains an expiration time (`exp`) claim, it + # must be an integer timestamp that is not in the past and no more than 12 hours + # in the future. # Corresponds to the JSON property `payload` # @return [String] attr_accessor :payload @@ -270,26 +258,24 @@ module Google class SignJwtResponse include Google::Apis::Core::Hashable - # The ID of the key used to sign the JWT. The key used for signing will - # remain valid for at least 12 hours after the JWT is signed. To verify the - # signature, you can retrieve the public key in several formats from the - # following endpoints: - # - RSA public key wrapped in an X.509 v3 certificate: - # `https://www.googleapis.com/service_accounts/v1/metadata/x509/`ACCOUNT_EMAIL`` - # - Raw key in JSON format: - # `https://www.googleapis.com/service_accounts/v1/metadata/raw/`ACCOUNT_EMAIL`` - # - JSON Web Key (JWK): - # `https://www.googleapis.com/service_accounts/v1/metadata/jwk/`ACCOUNT_EMAIL`` + # The ID of the key used to sign the JWT. The key used for signing will remain + # valid for at least 12 hours after the JWT is signed. To verify the signature, + # you can retrieve the public key in several formats from the following + # endpoints: - RSA public key wrapped in an X.509 v3 certificate: `https://www. + # googleapis.com/service_accounts/v1/metadata/x509/`ACCOUNT_EMAIL`` - Raw key in + # JSON format: `https://www.googleapis.com/service_accounts/v1/metadata/raw/` + # ACCOUNT_EMAIL`` - JSON Web Key (JWK): `https://www.googleapis.com/ + # service_accounts/v1/metadata/jwk/`ACCOUNT_EMAIL`` # Corresponds to the JSON property `keyId` # @return [String] attr_accessor :key_id - # The signed JWT. Contains the automatically generated header; the - # client-supplied payload; and the signature, which is generated using the - # key referenced by the `kid` field in the header. - # After the key pair referenced by the `key_id` response field expires, - # Google no longer exposes the public key that can be used to verify the JWT. - # As a result, the receiver can no longer verify the signature. + # The signed JWT. Contains the automatically generated header; the client- + # supplied payload; and the signature, which is generated using the key + # referenced by the `kid` field in the header. After the key pair referenced by + # the `key_id` response field expires, Google no longer exposes the public key + # that can be used to verify the JWT. As a result, the receiver can no longer + # verify the signature. # Corresponds to the JSON property `signedJwt` # @return [String] attr_accessor :signed_jwt diff --git a/generated/google/apis/iamcredentials_v1/service.rb b/generated/google/apis/iamcredentials_v1/service.rb index 38e0036a7..8eca3aef0 100644 --- a/generated/google/apis/iamcredentials_v1/service.rb +++ b/generated/google/apis/iamcredentials_v1/service.rb @@ -50,9 +50,9 @@ module Google # Generates an OAuth 2.0 access token for a service account. # @param [String] name # Required. The resource name of the service account for which the credentials - # are requested, in the following format: - # `projects/-/serviceAccounts/`ACCOUNT_EMAIL_OR_UNIQUEID``. The `-` wildcard - # character is required; replacing it with a project ID is invalid. + # are requested, in the following format: `projects/-/serviceAccounts/` + # ACCOUNT_EMAIL_OR_UNIQUEID``. The `-` wildcard character is required; replacing + # it with a project ID is invalid. # @param [Google::Apis::IamcredentialsV1::GenerateAccessTokenRequest] generate_access_token_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -86,9 +86,9 @@ module Google # Generates an OpenID Connect ID token for a service account. # @param [String] name # Required. The resource name of the service account for which the credentials - # are requested, in the following format: - # `projects/-/serviceAccounts/`ACCOUNT_EMAIL_OR_UNIQUEID``. The `-` wildcard - # character is required; replacing it with a project ID is invalid. + # are requested, in the following format: `projects/-/serviceAccounts/` + # ACCOUNT_EMAIL_OR_UNIQUEID``. The `-` wildcard character is required; replacing + # it with a project ID is invalid. # @param [Google::Apis::IamcredentialsV1::GenerateIdTokenRequest] generate_id_token_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -122,9 +122,9 @@ module Google # Signs a blob using a service account's system-managed private key. # @param [String] name # Required. The resource name of the service account for which the credentials - # are requested, in the following format: - # `projects/-/serviceAccounts/`ACCOUNT_EMAIL_OR_UNIQUEID``. The `-` wildcard - # character is required; replacing it with a project ID is invalid. + # are requested, in the following format: `projects/-/serviceAccounts/` + # ACCOUNT_EMAIL_OR_UNIQUEID``. The `-` wildcard character is required; replacing + # it with a project ID is invalid. # @param [Google::Apis::IamcredentialsV1::SignBlobRequest] sign_blob_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -158,9 +158,9 @@ module Google # Signs a JWT using a service account's system-managed private key. # @param [String] name # Required. The resource name of the service account for which the credentials - # are requested, in the following format: - # `projects/-/serviceAccounts/`ACCOUNT_EMAIL_OR_UNIQUEID``. The `-` wildcard - # character is required; replacing it with a project ID is invalid. + # are requested, in the following format: `projects/-/serviceAccounts/` + # ACCOUNT_EMAIL_OR_UNIQUEID``. The `-` wildcard character is required; replacing + # it with a project ID is invalid. # @param [Google::Apis::IamcredentialsV1::SignJwtRequest] sign_jwt_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. diff --git a/generated/google/apis/ml_v1.rb b/generated/google/apis/ml_v1.rb index 2123a7e97..dcbb81262 100644 --- a/generated/google/apis/ml_v1.rb +++ b/generated/google/apis/ml_v1.rb @@ -25,7 +25,7 @@ module Google # @see https://cloud.google.com/ml/ module MlV1 VERSION = 'V1' - REVISION = '20200714' + REVISION = '20200806' # 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/ml_v1/classes.rb b/generated/google/apis/ml_v1/classes.rb index 4ab9f6ac6..7ee64893c 100644 --- a/generated/google/apis/ml_v1/classes.rb +++ b/generated/google/apis/ml_v1/classes.rb @@ -23,34 +23,21 @@ module Google module MlV1 # Message that represents an arbitrary HTTP body. It should only be used for - # payload formats that can't be represented as JSON, such as raw binary or - # an HTML page. - # This message can be used both in streaming and non-streaming API methods in - # the request as well as the response. - # It can be used as a top-level request field, which is convenient if one - # wants to extract parameters from either the URL or HTTP template into the - # request fields and also want access to the raw HTTP body. - # Example: - # message GetResourceRequest ` - # // A unique request id. - # string request_id = 1; - # // The raw HTTP body is bound to this field. - # google.api.HttpBody http_body = 2; - # ` - # service ResourceService ` - # rpc GetResource(GetResourceRequest) returns (google.api.HttpBody); - # rpc UpdateResource(google.api.HttpBody) returns - # (google.protobuf.Empty); - # ` - # Example with streaming methods: - # service CaldavService ` - # rpc GetCalendar(stream google.api.HttpBody) - # returns (stream google.api.HttpBody); - # rpc UpdateCalendar(stream google.api.HttpBody) - # returns (stream google.api.HttpBody); - # ` - # Use of this type only changes how the request and response bodies are - # handled, all other features will continue to work unchanged. + # payload formats that can't be represented as JSON, such as raw binary or an + # HTML page. This message can be used both in streaming and non-streaming API + # methods in the request as well as the response. It can be used as a top-level + # request field, which is convenient if one wants to extract parameters from + # either the URL or HTTP template into the request fields and also want access + # to the raw HTTP body. Example: message GetResourceRequest ` // A unique + # request id. string request_id = 1; // The raw HTTP body is bound to this field. + # google.api.HttpBody http_body = 2; ` service ResourceService ` rpc + # GetResource(GetResourceRequest) returns (google.api.HttpBody); rpc + # UpdateResource(google.api.HttpBody) returns (google.protobuf.Empty); ` Example + # with streaming methods: service CaldavService ` rpc GetCalendar(stream google. + # api.HttpBody) returns (stream google.api.HttpBody); rpc UpdateCalendar(stream + # google.api.HttpBody) returns (stream google.api.HttpBody); ` Use of this type + # only changes how the request and response bodies are handled, all other + # features will continue to work unchanged. class GoogleApiHttpBody include Google::Apis::Core::Hashable @@ -65,8 +52,8 @@ module Google # @return [String] attr_accessor :data - # Application specific response metadata. Must be set in the first response - # for streaming APIs. + # Application specific response metadata. Must be set in the first response for + # streaming APIs. # Corresponds to the JSON property `extensions` # @return [Array>] attr_accessor :extensions @@ -87,9 +74,8 @@ module Google class GoogleCloudMlV1AutomatedStoppingConfigDecayCurveAutomatedStoppingConfig include Google::Apis::Core::Hashable - # If true, measurement.elapsed_time is used as the x-axis of each - # Trials Decay Curve. Otherwise, Measurement.steps will be used as the - # x-axis. + # If true, measurement.elapsed_time is used as the x-axis of each Trials Decay + # Curve. Otherwise, Measurement.steps will be used as the x-axis. # Corresponds to the JSON property `useElapsedTime` # @return [Boolean] attr_accessor :use_elapsed_time @@ -105,19 +91,18 @@ module Google end end - # The median automated stopping rule stops a pending trial if the trial's - # best objective_value is strictly below the median 'performance' of all - # completed trials reported up to the trial's last measurement. - # Currently, 'performance' refers to the running average of the objective - # values reported by the trial in each measurement. + # The median automated stopping rule stops a pending trial if the trial's best + # objective_value is strictly below the median 'performance' of all completed + # trials reported up to the trial's last measurement. Currently, 'performance' + # refers to the running average of the objective values reported by the trial in + # each measurement. class GoogleCloudMlV1AutomatedStoppingConfigMedianAutomatedStoppingConfig include Google::Apis::Core::Hashable - # If true, the median automated stopping rule applies to - # measurement.use_elapsed_time, which means the elapsed_time field of - # the current trial's - # latest measurement is used to compute the median objective - # value for each completed trial. + # If true, the median automated stopping rule applies to measurement. + # use_elapsed_time, which means the elapsed_time field of the current trial's + # latest measurement is used to compute the median objective value for each + # completed trial. # Corresponds to the JSON property `useElapsedTime` # @return [Boolean] attr_accessor :use_elapsed_time @@ -187,8 +172,7 @@ module Google class GoogleCloudMlV1StudyConfigParameterSpecCategoricalValueSpec include Google::Apis::Core::Hashable - # Must be specified if type is `CATEGORICAL`. - # The list of possible categories. + # Must be specified if type is `CATEGORICAL`. The list of possible categories. # Corresponds to the JSON property `values` # @return [Array] attr_accessor :values @@ -207,11 +191,10 @@ module Google class GoogleCloudMlV1StudyConfigParameterSpecDiscreteValueSpec include Google::Apis::Core::Hashable - # Must be specified if type is `DISCRETE`. - # A list of feasible points. - # The list should be in strictly increasing order. For instance, this - # parameter might have possible settings of 1.5, 2.5, and 4.0. This list - # should not contain more than 1,000 values. + # Must be specified if type is `DISCRETE`. A list of feasible points. The list + # should be in strictly increasing order. For instance, this parameter might + # have possible settings of 1.5, 2.5, and 4.0. This list should not contain more + # than 1,000 values. # Corresponds to the JSON property `values` # @return [Array] attr_accessor :values @@ -280,8 +263,8 @@ module Google class GoogleCloudMlV1StudyConfigParameterSpecMatchingParentCategoricalValueSpec include Google::Apis::Core::Hashable - # Matches values of the parent parameter with type 'CATEGORICAL'. - # All values must exist in `categorical_value_spec` of parent parameter. + # Matches values of the parent parameter with type 'CATEGORICAL'. All values + # must exist in `categorical_value_spec` of parent parameter. # Corresponds to the JSON property `values` # @return [Array] attr_accessor :values @@ -300,8 +283,8 @@ module Google class GoogleCloudMlV1StudyConfigParameterSpecMatchingParentDiscreteValueSpec include Google::Apis::Core::Hashable - # Matches values of the parent parameter with type 'DISCRETE'. - # All values must exist in `discrete_value_spec` of parent parameter. + # Matches values of the parent parameter with type 'DISCRETE'. All values must + # exist in `discrete_value_spec` of parent parameter. # Corresponds to the JSON property `values` # @return [Array] attr_accessor :values @@ -320,8 +303,8 @@ module Google class GoogleCloudMlV1StudyConfigParameterSpecMatchingParentIntValueSpec include Google::Apis::Core::Hashable - # Matches values of the parent parameter with type 'INTEGER'. - # All values must lie in `integer_value_spec` of parent parameter. + # Matches values of the parent parameter with type 'INTEGER'. All values must + # lie in `integer_value_spec` of parent parameter. # Corresponds to the JSON property `values` # @return [Array] attr_accessor :values @@ -371,9 +354,8 @@ module Google attr_accessor :categorical_value_spec # A child node is active if the parameter's value matches the child node's - # matching_parent_values. - # If two items in child_parameter_specs have the same name, they must have - # disjoint matching_parent_values. + # matching_parent_values. If two items in child_parameter_specs have the same + # name, they must have disjoint matching_parent_values. # Corresponds to the JSON property `childParameterSpecs` # @return [Array] attr_accessor :child_parameter_specs @@ -413,8 +395,7 @@ module Google # @return [Google::Apis::MlV1::GoogleCloudMlV1StudyConfigParameterSpecMatchingParentIntValueSpec] attr_accessor :parent_int_values - # How the parameter should be scaled. - # Leave unset for categorical parameters. + # How the parameter should be scaled. Leave unset for categorical parameters. # Corresponds to the JSON property `scaleType` # @return [String] attr_accessor :scale_type @@ -444,8 +425,8 @@ module Google end end - # A message representing a parameter to be tuned. Contains the name of - # the parameter and the suggested value to use for this trial. + # A message representing a parameter to be tuned. Contains the name of the + # parameter and the suggested value to use for this trial. class GoogleCloudMlV1TrialParameter include Google::Apis::Core::Hashable @@ -482,11 +463,10 @@ module Google end end - # Represents a hardware accelerator request config. - # Note that the AcceleratorConfig can be used in both Jobs and Versions. - # Learn more about [accelerators for training](/ml-engine/docs/using-gpus) and - # [accelerators for online - # prediction](/ml-engine/docs/machine-types-online-prediction#gpus). + # Represents a hardware accelerator request config. Note that the + # AcceleratorConfig can be used in both Jobs and Versions. Learn more about [ + # accelerators for training](/ml-engine/docs/using-gpus) and [accelerators for + # online prediction](/ml-engine/docs/machine-types-online-prediction#gpus). class GoogleCloudMlV1AcceleratorConfig include Google::Apis::Core::Hashable @@ -534,48 +514,30 @@ module Google class GoogleCloudMlV1AutoScaling include Google::Apis::Core::Hashable - # Optional. The minimum number of nodes to allocate for this model. These - # nodes are always up, starting from the time the model is deployed. - # Therefore, the cost of operating this model will be at least - # `rate` * `min_nodes` * number of hours since last billing cycle, - # where `rate` is the cost per node-hour as documented in the - # [pricing guide](/ml-engine/docs/pricing), - # even if no predictions are performed. There is additional cost for each - # prediction performed. - # Unlike manual scaling, if the load gets too heavy for the nodes - # that are up, the service will automatically add nodes to handle the - # increased load as well as scale back as traffic drops, always maintaining - # at least `min_nodes`. You will be charged for the time in which additional - # nodes are used. - # If `min_nodes` is not specified and AutoScaling is used with a [legacy - # (MLS1) machine type](/ml-engine/docs/machine-types-online-prediction), - # `min_nodes` defaults to 0, in which case, when traffic to a model stops - # (and after a cool-down period), nodes will be shut down and no charges will - # be incurred until traffic to the model resumes. - # If `min_nodes` is not specified and AutoScaling is used with a [Compute - # Engine (N1) machine type](/ml-engine/docs/machine-types-online-prediction), - # `min_nodes` defaults to 1. `min_nodes` must be at least 1 for use with a - # Compute Engine machine type. - # Note that you cannot use AutoScaling if your version uses - # [GPUs](#Version.FIELDS.accelerator_config). Instead, you must use - # ManualScaling. - # You can set `min_nodes` when creating the model version, and you can also - # update `min_nodes` for an existing version: - # 
-        # update_body.json:
-        # `
-        # 'autoScaling': `
-        # 'minNodes': 5
-        # `
-        # `
-        #
- # HTTP request: - # 
-        # PATCH
-        # https://ml.googleapis.com/v1/`name=projects/*/models/*/versions/*`?update_mask=
-        # autoScaling.minNodes
-        # -d @./update_body.json
-        #
+ # Optional. The minimum number of nodes to allocate for this model. These nodes + # are always up, starting from the time the model is deployed. Therefore, the + # cost of operating this model will be at least `rate` * `min_nodes` * number of + # hours since last billing cycle, where `rate` is the cost per node-hour as + # documented in the [pricing guide](/ml-engine/docs/pricing), even if no + # predictions are performed. There is additional cost for each prediction + # performed. Unlike manual scaling, if the load gets too heavy for the nodes + # that are up, the service will automatically add nodes to handle the increased + # load as well as scale back as traffic drops, always maintaining at least ` + # min_nodes`. You will be charged for the time in which additional nodes are + # used. If `min_nodes` is not specified and AutoScaling is used with a [legacy ( + # MLS1) machine type](/ml-engine/docs/machine-types-online-prediction), ` + # min_nodes` defaults to 0, in which case, when traffic to a model stops (and + # after a cool-down period), nodes will be shut down and no charges will be + # incurred until traffic to the model resumes. If `min_nodes` is not specified + # and AutoScaling is used with a [Compute Engine (N1) machine type](/ml-engine/ + # docs/machine-types-online-prediction), `min_nodes` defaults to 1. `min_nodes` + # must be at least 1 for use with a Compute Engine machine type. Note that you + # cannot use AutoScaling if your version uses [GPUs](#Version.FIELDS. + # accelerator_config). Instead, you must use ManualScaling. You can set ` + # min_nodes` when creating the model version, and you can also update `min_nodes` + # for an existing version: update_body.json: ` 'autoScaling': ` 'minNodes': 5 ` + # ` HTTP request: PATCH https://ml.googleapis.com/v1/`name=projects/*/models/*/ + # versions/*`?update_mask=autoScaling.minNodes -d @./update_body.json # Corresponds to the JSON property `minNodes` # @return [Fixnum] attr_accessor :min_nodes @@ -600,11 +562,11 @@ module Google # @return [Google::Apis::MlV1::GoogleCloudMlV1AutomatedStoppingConfigDecayCurveAutomatedStoppingConfig] attr_accessor :decay_curve_stopping_config - # The median automated stopping rule stops a pending trial if the trial's - # best objective_value is strictly below the median 'performance' of all - # completed trials reported up to the trial's last measurement. - # Currently, 'performance' refers to the running average of the objective - # values reported by the trial in each measurement. + # The median automated stopping rule stops a pending trial if the trial's best + # objective_value is strictly below the median 'performance' of all completed + # trials reported up to the trial's last measurement. Currently, 'performance' + # refers to the running average of the objective values reported by the trial in + # each measurement. # Corresponds to the JSON property `medianAutomatedStoppingConfig` # @return [Google::Apis::MlV1::GoogleCloudMlV1AutomatedStoppingConfigMedianAutomatedStoppingConfig] attr_accessor :median_automated_stopping_config @@ -629,9 +591,9 @@ module Google # @return [String] attr_accessor :framework - # The Cloud Storage path to the `model/` directory where the training job - # saves the trained model. Only set for successful jobs that don't use - # hyperparameter tuning. + # The Cloud Storage path to the `model/` directory where the training job saves + # the trained model. Only set for successful jobs that don't use hyperparameter + # tuning. # Corresponds to the JSON property `modelPath` # @return [String] attr_accessor :model_path @@ -641,8 +603,7 @@ module Google # @return [String] attr_accessor :python_version - # AI Platform runtime version on which the built-in algorithm was - # trained. + # AI Platform runtime version on which the built-in algorithm was trained. # Corresponds to the JSON property `runtimeVersion` # @return [String] attr_accessor :runtime_version @@ -698,9 +659,8 @@ module Google end end - # This message will be placed in the metadata field of a - # google.longrunning.Operation associated with a CheckTrialEarlyStoppingState - # request. + # This message will be placed in the metadata field of a google.longrunning. + # Operation associated with a CheckTrialEarlyStoppingState request. class GoogleCloudMlV1CheckTrialEarlyStoppingStateMetatdata include Google::Apis::Core::Hashable @@ -744,9 +704,8 @@ module Google end end - # The message will be placed in the response field of a completed - # google.longrunning.Operation associated with a CheckTrialEarlyStoppingState - # request. + # The message will be placed in the response field of a completed google. + # longrunning.Operation associated with a CheckTrialEarlyStoppingState request. class GoogleCloudMlV1CheckTrialEarlyStoppingStateResponse include Google::Apis::Core::Hashable @@ -831,15 +790,14 @@ module Google end end - # Represents a custom encryption key configuration that can be applied to - # a resource. + # Represents a custom encryption key configuration that can be applied to a + # resource. class GoogleCloudMlV1EncryptionConfig include Google::Apis::Core::Hashable - # The Cloud KMS resource identifier of the customer-managed encryption key - # used to protect a resource, such as a training job. It has the following - # format: - # `projects/`PROJECT_ID`/locations/`REGION`/keyRings/`KEY_RING_NAME`/cryptoKeys/` + # The Cloud KMS resource identifier of the customer-managed encryption key used + # to protect a resource, such as a training job. It has the following format: ` + # projects/`PROJECT_ID`/locations/`REGION`/keyRings/`KEY_RING_NAME`/cryptoKeys/` # KEY_NAME`` # Corresponds to the JSON property `kmsKeyName` # @return [String] @@ -855,39 +813,61 @@ module Google end end + # EndpointMap is used to provide paths for predict/explain/healthcheck to + # customers. It's an output only field in the version proto which can be only + # set on the server side. Public endpoints follow the format specified on the + # user facing doc, and private endpoints are customized for each privately + # deploymed model/version. + class GoogleCloudMlV1EndpointMap + include Google::Apis::Core::Hashable + + # Optional. Http(s) path to send explain requests. + # Corresponds to the JSON property `explain` + # @return [String] + attr_accessor :explain + + # Http(s) path to send health check requests. + # Corresponds to the JSON property `health` + # @return [String] + attr_accessor :health + + # Http(s) path to send prediction requests. + # Corresponds to the JSON property `predict` + # @return [String] + attr_accessor :predict + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @explain = args[:explain] if args.key?(:explain) + @health = args[:health] if args.key?(:health) + @predict = args[:predict] if args.key?(:predict) + end + end + # Request for explanations to be issued against a trained model. class GoogleCloudMlV1ExplainRequest include Google::Apis::Core::Hashable # Message that represents an arbitrary HTTP body. It should only be used for - # payload formats that can't be represented as JSON, such as raw binary or - # an HTML page. - # This message can be used both in streaming and non-streaming API methods in - # the request as well as the response. - # It can be used as a top-level request field, which is convenient if one - # wants to extract parameters from either the URL or HTTP template into the - # request fields and also want access to the raw HTTP body. - # Example: - # message GetResourceRequest ` - # // A unique request id. - # string request_id = 1; - # // The raw HTTP body is bound to this field. - # google.api.HttpBody http_body = 2; - # ` - # service ResourceService ` - # rpc GetResource(GetResourceRequest) returns (google.api.HttpBody); - # rpc UpdateResource(google.api.HttpBody) returns - # (google.protobuf.Empty); - # ` - # Example with streaming methods: - # service CaldavService ` - # rpc GetCalendar(stream google.api.HttpBody) - # returns (stream google.api.HttpBody); - # rpc UpdateCalendar(stream google.api.HttpBody) - # returns (stream google.api.HttpBody); - # ` - # Use of this type only changes how the request and response bodies are - # handled, all other features will continue to work unchanged. + # payload formats that can't be represented as JSON, such as raw binary or an + # HTML page. This message can be used both in streaming and non-streaming API + # methods in the request as well as the response. It can be used as a top-level + # request field, which is convenient if one wants to extract parameters from + # either the URL or HTTP template into the request fields and also want access + # to the raw HTTP body. Example: message GetResourceRequest ` // A unique + # request id. string request_id = 1; // The raw HTTP body is bound to this field. + # google.api.HttpBody http_body = 2; ` service ResourceService ` rpc + # GetResource(GetResourceRequest) returns (google.api.HttpBody); rpc + # UpdateResource(google.api.HttpBody) returns (google.protobuf.Empty); ` Example + # with streaming methods: service CaldavService ` rpc GetCalendar(stream google. + # api.HttpBody) returns (stream google.api.HttpBody); rpc UpdateCalendar(stream + # google.api.HttpBody) returns (stream google.api.HttpBody); ` Use of this type + # only changes how the request and response bodies are handled, all other + # features will continue to work unchanged. # Corresponds to the JSON property `httpBody` # @return [Google::Apis::MlV1::GoogleApiHttpBody] attr_accessor :http_body @@ -902,17 +882,16 @@ module Google end end - # Message holding configuration options for explaining model predictions. - # There are two feature attribution methods supported for TensorFlow models: - # integrated gradients and sampled Shapley. - # [Learn more about feature + # Message holding configuration options for explaining model predictions. There + # are two feature attribution methods supported for TensorFlow models: + # integrated gradients and sampled Shapley. [Learn more about feature # attributions.](/ai-platform/prediction/docs/ai-explanations/overview) class GoogleCloudMlV1ExplanationConfig include Google::Apis::Core::Hashable - # Attributes credit by computing the Aumann-Shapley value taking advantage - # of the model's fully differentiable structure. Refer to this paper for - # more details: https://arxiv.org/abs/1703.01365 + # Attributes credit by computing the Aumann-Shapley value taking advantage of + # the model's fully differentiable structure. Refer to this paper for more + # details: https://arxiv.org/abs/1703.01365 # Corresponds to the JSON property `integratedGradientsAttribution` # @return [Google::Apis::MlV1::GoogleCloudMlV1IntegratedGradientsAttribution] attr_accessor :integrated_gradients_attribution @@ -924,10 +903,10 @@ module Google # @return [Google::Apis::MlV1::GoogleCloudMlV1SampledShapleyAttribution] attr_accessor :sampled_shapley_attribution - # Attributes credit by computing the XRAI taking advantage - # of the model's fully differentiable structure. Refer to this paper for - # more details: https://arxiv.org/abs/1906.02825 - # Currently only implemented for models with natural image inputs. + # Attributes credit by computing the XRAI taking advantage of the model's fully + # differentiable structure. Refer to this paper for more details: https://arxiv. + # org/abs/1906.02825 Currently only implemented for models with natural image + # inputs. # Corresponds to the JSON property `xraiAttribution` # @return [Google::Apis::MlV1::GoogleCloudMlV1XraiAttribution] attr_accessor :xrai_attribution @@ -975,10 +954,10 @@ module Google end end - # Represents the result of a single hyperparameter tuning trial from a - # training job. The TrainingOutput object that is returned on successful - # completion of a training job with hyperparameter tuning includes a list - # of HyperparameterOutput objects, one for each successful trial. + # Represents the result of a single hyperparameter tuning trial from a training + # job. The TrainingOutput object that is returned on successful completion of a + # training job with hyperparameter tuning includes a list of + # HyperparameterOutput objects, one for each successful trial. class GoogleCloudMlV1HyperparameterOutput include Google::Apis::Core::Hashable @@ -1051,61 +1030,55 @@ module Google class GoogleCloudMlV1HyperparameterSpec include Google::Apis::Core::Hashable - # Optional. The search algorithm specified for the hyperparameter - # tuning job. - # Uses the default AI Platform hyperparameter tuning - # algorithm if unspecified. + # Optional. The search algorithm specified for the hyperparameter tuning job. + # Uses the default AI Platform hyperparameter tuning algorithm if unspecified. # Corresponds to the JSON property `algorithm` # @return [String] attr_accessor :algorithm - # Optional. Indicates if the hyperparameter tuning job enables auto trial - # early stopping. + # Optional. Indicates if the hyperparameter tuning job enables auto trial early + # stopping. # Corresponds to the JSON property `enableTrialEarlyStopping` # @return [Boolean] attr_accessor :enable_trial_early_stopping alias_method :enable_trial_early_stopping?, :enable_trial_early_stopping - # Required. The type of goal to use for tuning. Available types are - # `MAXIMIZE` and `MINIMIZE`. - # Defaults to `MAXIMIZE`. + # Required. The type of goal to use for tuning. Available types are `MAXIMIZE` + # and `MINIMIZE`. Defaults to `MAXIMIZE`. # Corresponds to the JSON property `goal` # @return [String] attr_accessor :goal # Optional. The TensorFlow summary tag name to use for optimizing trials. For # current versions of TensorFlow, this tag name should exactly match what is - # shown in TensorBoard, including all scopes. For versions of TensorFlow - # prior to 0.12, this should be only the tag passed to tf.Summary. - # By default, "training/hptuning/metric" will be used. + # shown in TensorBoard, including all scopes. For versions of TensorFlow prior + # to 0.12, this should be only the tag passed to tf.Summary. By default, " + # training/hptuning/metric" will be used. # Corresponds to the JSON property `hyperparameterMetricTag` # @return [String] attr_accessor :hyperparameter_metric_tag - # Optional. The number of failed trials that need to be seen before failing - # the hyperparameter tuning job. You can specify this field to override the - # default failing criteria for AI Platform hyperparameter tuning jobs. - # Defaults to zero, which means the service decides when a hyperparameter - # job should fail. + # Optional. The number of failed trials that need to be seen before failing the + # hyperparameter tuning job. You can specify this field to override the default + # failing criteria for AI Platform hyperparameter tuning jobs. Defaults to zero, + # which means the service decides when a hyperparameter job should fail. # Corresponds to the JSON property `maxFailedTrials` # @return [Fixnum] attr_accessor :max_failed_trials - # Optional. The number of training trials to run concurrently. - # You can reduce the time it takes to perform hyperparameter tuning by adding - # trials in parallel. However, each trail only benefits from the information - # gained in completed trials. That means that a trial does not get access to - # the results of trials running at the same time, which could reduce the - # quality of the overall optimization. - # Each trial will use the same scale tier and machine types. - # Defaults to one. + # Optional. The number of training trials to run concurrently. You can reduce + # the time it takes to perform hyperparameter tuning by adding trials in + # parallel. However, each trail only benefits from the information gained in + # completed trials. That means that a trial does not get access to the results + # of trials running at the same time, which could reduce the quality of the + # overall optimization. Each trial will use the same scale tier and machine + # types. Defaults to one. # Corresponds to the JSON property `maxParallelTrials` # @return [Fixnum] attr_accessor :max_parallel_trials - # Optional. How many training trials should be attempted to optimize - # the specified hyperparameters. - # Defaults to one. + # Optional. How many training trials should be attempted to optimize the + # specified hyperparameters. Defaults to one. # Corresponds to the JSON property `maxTrials` # @return [Fixnum] attr_accessor :max_trials @@ -1115,9 +1088,9 @@ module Google # @return [Array] attr_accessor :params - # Optional. The prior hyperparameter tuning job id that users hope to - # continue with. The job id will be used to find the corresponding vizier - # study guid and resume the study. + # Optional. The prior hyperparameter tuning job id that users hope to continue + # with. The job id will be used to find the corresponding vizier study guid and + # resume the study. # Corresponds to the JSON property `resumePreviousJobId` # @return [String] attr_accessor :resume_previous_job_id @@ -1140,15 +1113,15 @@ module Google end end - # Attributes credit by computing the Aumann-Shapley value taking advantage - # of the model's fully differentiable structure. Refer to this paper for - # more details: https://arxiv.org/abs/1703.01365 + # Attributes credit by computing the Aumann-Shapley value taking advantage of + # the model's fully differentiable structure. Refer to this paper for more + # details: https://arxiv.org/abs/1703.01365 class GoogleCloudMlV1IntegratedGradientsAttribution include Google::Apis::Core::Hashable - # Number of steps for approximating the path integral. - # A good value to start is 50 and gradually increase until the - # sum to diff property is met within the desired error range. + # Number of steps for approximating the path integral. A good value to start is + # 50 and gradually increase until the sum to diff property is met within the + # desired error range. # Corresponds to the JSON property `numIntegralSteps` # @return [Fixnum] attr_accessor :num_integral_steps @@ -1182,13 +1155,13 @@ module Google # @return [String] attr_accessor :error_message - # `etag` is used for optimistic concurrency control as a way to help - # prevent simultaneous updates of a job from overwriting each other. - # It is strongly suggested that systems make use of the `etag` in the - # read-modify-write cycle to perform job updates in order to avoid race - # conditions: An `etag` is returned in the response to `GetJob`, and - # systems are expected to put that etag in the request to `UpdateJob` to - # ensure that their change will be applied to the same version of the job. + # `etag` is used for optimistic concurrency control as a way to help prevent + # simultaneous updates of a job from overwriting each other. It is strongly + # suggested that systems make use of the `etag` in the read-modify-write cycle + # to perform job updates in order to avoid race conditions: An `etag` is + # returned in the response to `GetJob`, and systems are expected to put that + # etag in the request to `UpdateJob` to ensure that their change will be applied + # to the same version of the job. # Corresponds to the JSON property `etag` # NOTE: Values are automatically base64 encoded/decoded in the client library. # @return [String] @@ -1199,11 +1172,10 @@ module Google # @return [String] attr_accessor :job_id - # Optional. One or more labels that you can add, to organize your jobs. - # Each label is a key-value pair, where both the key and the value are - # arbitrary strings that you supply. - # For more information, see the documentation on - # using labels. + # Optional. One or more labels that you can add, to organize your jobs. Each + # label is a key-value pair, where both the key and the value are arbitrary + # strings that you supply. For more information, see the documentation on using + # labels. # Corresponds to the JSON property `labels` # @return [Hash] attr_accessor :labels @@ -1229,10 +1201,10 @@ module Google attr_accessor :state # Represents input parameters for a training job. When using the gcloud command - # to submit your training job, you can specify the input parameters as - # command-line arguments and/or in a YAML configuration file referenced from - # the --config command-line argument. For details, see the guide to [submitting - # a training job](/ai-platform/training/docs/training-jobs). + # to submit your training job, you can specify the input parameters as command- + # line arguments and/or in a YAML configuration file referenced from the -- + # config command-line argument. For details, see the guide to [submitting a + # training job](/ai-platform/training/docs/training-jobs). # Corresponds to the JSON property `trainingInput` # @return [Google::Apis::MlV1::GoogleCloudMlV1TrainingInput] attr_accessor :training_input @@ -1435,9 +1407,9 @@ module Google include Google::Apis::Core::Hashable # The number of nodes to allocate for this model. These nodes are always up, - # starting from the time the model is deployed, so the cost of operating - # this model will be proportional to `nodes` * number of hours since - # last billing cycle plus the cost for each prediction performed. + # starting from the time the model is deployed, so the cost of operating this + # model will be proportional to `nodes` * number of hours since last billing + # cycle plus the cost for each prediction performed. # Corresponds to the JSON property `nodes` # @return [Fixnum] attr_accessor :nodes @@ -1456,20 +1428,19 @@ module Google class GoogleCloudMlV1Measurement include Google::Apis::Core::Hashable - # Output only. Time that the trial has been running at the point of - # this measurement. + # Output only. Time that the trial has been running at the point of this + # measurement. # Corresponds to the JSON property `elapsedTime` # @return [String] attr_accessor :elapsed_time - # Provides a list of metrics that act as inputs into the objective - # function. + # Provides a list of metrics that act as inputs into the objective function. # Corresponds to the JSON property `metrics` # @return [Array] attr_accessor :metrics - # The number of steps a machine learning model has been trained for. - # Must be non-negative. + # The number of steps a machine learning model has been trained for. Must be non- + # negative. # Corresponds to the JSON property `stepCount` # @return [Fixnum] attr_accessor :step_count @@ -1486,18 +1457,16 @@ module Google end end - # Represents a machine learning solution. - # A model can have multiple versions, each of which is a deployed, trained - # model ready to receive prediction requests. The model itself is just a - # container. + # Represents a machine learning solution. A model can have multiple versions, + # each of which is a deployed, trained model ready to receive prediction + # requests. The model itself is just a container. class GoogleCloudMlV1Model include Google::Apis::Core::Hashable - # Represents a version of the model. - # Each version is a trained model deployed in the cloud, ready to handle - # prediction requests. A model can have multiple versions. You can get - # information about all of the versions of a given model by calling - # projects.models.versions.list. + # Represents a version of the model. Each version is a trained model deployed in + # the cloud, ready to handle prediction requests. A model can have multiple + # versions. You can get information about all of the versions of a given model + # by calling projects.models.versions.list. # Corresponds to the JSON property `defaultVersion` # @return [Google::Apis::MlV1::GoogleCloudMlV1Version] attr_accessor :default_version @@ -1507,41 +1476,39 @@ module Google # @return [String] attr_accessor :description - # `etag` is used for optimistic concurrency control as a way to help - # prevent simultaneous updates of a model from overwriting each other. - # It is strongly suggested that systems make use of the `etag` in the - # read-modify-write cycle to perform model updates in order to avoid race - # conditions: An `etag` is returned in the response to `GetModel`, and - # systems are expected to put that etag in the request to `UpdateModel` to - # ensure that their change will be applied to the model as intended. + # `etag` is used for optimistic concurrency control as a way to help prevent + # simultaneous updates of a model from overwriting each other. It is strongly + # suggested that systems make use of the `etag` in the read-modify-write cycle + # to perform model updates in order to avoid race conditions: An `etag` is + # returned in the response to `GetModel`, and systems are expected to put that + # etag in the request to `UpdateModel` to ensure that their change will be + # applied to the model as intended. # Corresponds to the JSON property `etag` # NOTE: Values are automatically base64 encoded/decoded in the client library. # @return [String] attr_accessor :etag - # Optional. One or more labels that you can add, to organize your models. - # Each label is a key-value pair, where both the key and the value are - # arbitrary strings that you supply. - # For more information, see the documentation on - # using labels. + # Optional. One or more labels that you can add, to organize your models. Each + # label is a key-value pair, where both the key and the value are arbitrary + # strings that you supply. For more information, see the documentation on using + # labels. # Corresponds to the JSON property `labels` # @return [Hash] attr_accessor :labels - # Required. The name specified for the model when it was created. - # The model name must be unique within the project it is created in. + # Required. The name specified for the model when it was created. The model name + # must be unique within the project it is created in. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name - # Optional. If true, online prediction nodes send `stderr` and `stdout` - # streams to Stackdriver Logging. These can be more verbose than the standard - # access logs (see `onlinePredictionLogging`) and can incur higher cost. - # However, they are helpful for debugging. Note that - # [Stackdriver logs may incur a cost](/stackdriver/pricing), especially if - # your project receives prediction requests at a high QPS. Estimate your - # costs before enabling this option. - # Default is false. + # Optional. If true, online prediction nodes send `stderr` and `stdout` streams + # to Stackdriver Logging. These can be more verbose than the standard access + # logs (see `onlinePredictionLogging`) and can incur higher cost. However, they + # are helpful for debugging. Note that [Stackdriver logs may incur a cost](/ + # stackdriver/pricing), especially if your project receives prediction requests + # at a high QPS. Estimate your costs before enabling this option. Default is + # false. # Corresponds to the JSON property `onlinePredictionConsoleLogging` # @return [Boolean] attr_accessor :online_prediction_console_logging @@ -1549,27 +1516,22 @@ module Google # Optional. If true, online prediction access logs are sent to StackDriver # Logging. These logs are like standard server access logs, containing - # information like timestamp and latency for each request. Note that - # [Stackdriver logs may incur a cost](/stackdriver/pricing), especially if - # your project receives prediction requests at a high queries per second rate - # (QPS). Estimate your costs before enabling this option. - # Default is false. + # information like timestamp and latency for each request. Note that [ + # Stackdriver logs may incur a cost](/stackdriver/pricing), especially if your + # project receives prediction requests at a high queries per second rate (QPS). + # Estimate your costs before enabling this option. Default is false. # Corresponds to the JSON property `onlinePredictionLogging` # @return [Boolean] attr_accessor :online_prediction_logging alias_method :online_prediction_logging?, :online_prediction_logging - # Optional. The list of regions where the model is going to be deployed. - # Only one region per model is supported. - # Defaults to 'us-central1' if nothing is set. - # See the available regions - # for AI Platform services. - # Note: - # * No matter where a model is deployed, it can always be accessed by - # users from anywhere, both for online and batch prediction. - # * The region for a batch prediction job is set by the region field when - # submitting the batch prediction job and does not take its value from - # this field. + # Optional. The list of regions where the model is going to be deployed. Only + # one region per model is supported. Defaults to 'us-central1' if nothing is set. + # See the available regions for AI Platform services. Note: * No matter where a + # model is deployed, it can always be accessed by users from anywhere, both for + # online and batch prediction. * The region for a batch prediction job is set by + # the region field when submitting the batch prediction job and does not take + # its value from this field. # Corresponds to the JSON property `regions` # @return [Array] attr_accessor :regions @@ -1611,8 +1573,8 @@ module Google attr_accessor :is_cancellation_requested alias_method :is_cancellation_requested?, :is_cancellation_requested - # The user labels, inherited from the model or the model version being - # operated on. + # The user labels, inherited from the model or the model version being operated + # on. # Corresponds to the JSON property `labels` # @return [Hash] attr_accessor :labels @@ -1637,11 +1599,10 @@ module Google # @return [String] attr_accessor :start_time - # Represents a version of the model. - # Each version is a trained model deployed in the cloud, ready to handle - # prediction requests. A model can have multiple versions. You can get - # information about all of the versions of a given model by calling - # projects.models.versions.list. + # Represents a version of the model. Each version is a trained model deployed in + # the cloud, ready to handle prediction requests. A model can have multiple + # versions. You can get information about all of the versions of a given model + # by calling projects.models.versions.list. # Corresponds to the JSON property `version` # @return [Google::Apis::MlV1::GoogleCloudMlV1Version] attr_accessor :version @@ -1673,39 +1634,35 @@ module Google # @return [Array] attr_accessor :categorical_values - # Required if type is `DISCRETE`. - # A list of feasible points. - # The list should be in strictly increasing order. For instance, this - # parameter might have possible settings of 1.5, 2.5, and 4.0. This list - # should not contain more than 1,000 values. + # Required if type is `DISCRETE`. A list of feasible points. The list should be + # in strictly increasing order. For instance, this parameter might have possible + # settings of 1.5, 2.5, and 4.0. This list should not contain more than 1,000 + # values. # Corresponds to the JSON property `discreteValues` # @return [Array] attr_accessor :discrete_values - # Required if type is `DOUBLE` or `INTEGER`. This field - # should be unset if type is `CATEGORICAL`. This value should be integers if - # type is `INTEGER`. + # Required if type is `DOUBLE` or `INTEGER`. This field should be unset if type + # is `CATEGORICAL`. This value should be integers if type is `INTEGER`. # Corresponds to the JSON property `maxValue` # @return [Float] attr_accessor :max_value - # Required if type is `DOUBLE` or `INTEGER`. This field - # should be unset if type is `CATEGORICAL`. This value should be integers if - # type is INTEGER. + # Required if type is `DOUBLE` or `INTEGER`. This field should be unset if type + # is `CATEGORICAL`. This value should be integers if type is INTEGER. # Corresponds to the JSON property `minValue` # @return [Float] attr_accessor :min_value - # Required. The parameter name must be unique amongst all ParameterConfigs in - # a HyperparameterSpec message. E.g., "learning_rate". + # Required. The parameter name must be unique amongst all ParameterConfigs in a + # HyperparameterSpec message. E.g., "learning_rate". # Corresponds to the JSON property `parameterName` # @return [String] attr_accessor :parameter_name - # Optional. How the parameter should be scaled to the hypercube. - # Leave unset for categorical parameters. - # Some kind of scaling is strongly recommended for real or integral - # parameters (e.g., `UNIT_LINEAR_SCALE`). + # Optional. How the parameter should be scaled to the hypercube. Leave unset for + # categorical parameters. Some kind of scaling is strongly recommended for real + # or integral parameters (e.g., `UNIT_LINEAR_SCALE`). # Corresponds to the JSON property `scaleType` # @return [String] attr_accessor :scale_type @@ -1736,34 +1693,21 @@ module Google include Google::Apis::Core::Hashable # Message that represents an arbitrary HTTP body. It should only be used for - # payload formats that can't be represented as JSON, such as raw binary or - # an HTML page. - # This message can be used both in streaming and non-streaming API methods in - # the request as well as the response. - # It can be used as a top-level request field, which is convenient if one - # wants to extract parameters from either the URL or HTTP template into the - # request fields and also want access to the raw HTTP body. - # Example: - # message GetResourceRequest ` - # // A unique request id. - # string request_id = 1; - # // The raw HTTP body is bound to this field. - # google.api.HttpBody http_body = 2; - # ` - # service ResourceService ` - # rpc GetResource(GetResourceRequest) returns (google.api.HttpBody); - # rpc UpdateResource(google.api.HttpBody) returns - # (google.protobuf.Empty); - # ` - # Example with streaming methods: - # service CaldavService ` - # rpc GetCalendar(stream google.api.HttpBody) - # returns (stream google.api.HttpBody); - # rpc UpdateCalendar(stream google.api.HttpBody) - # returns (stream google.api.HttpBody); - # ` - # Use of this type only changes how the request and response bodies are - # handled, all other features will continue to work unchanged. + # payload formats that can't be represented as JSON, such as raw binary or an + # HTML page. This message can be used both in streaming and non-streaming API + # methods in the request as well as the response. It can be used as a top-level + # request field, which is convenient if one wants to extract parameters from + # either the URL or HTTP template into the request fields and also want access + # to the raw HTTP body. Example: message GetResourceRequest ` // A unique + # request id. string request_id = 1; // The raw HTTP body is bound to this field. + # google.api.HttpBody http_body = 2; ` service ResourceService ` rpc + # GetResource(GetResourceRequest) returns (google.api.HttpBody); rpc + # UpdateResource(google.api.HttpBody) returns (google.protobuf.Empty); ` Example + # with streaming methods: service CaldavService ` rpc GetCalendar(stream google. + # api.HttpBody) returns (stream google.api.HttpBody); rpc UpdateCalendar(stream + # google.api.HttpBody) returns (stream google.api.HttpBody); ` Use of this type + # only changes how the request and response bodies are handled, all other + # features will continue to work unchanged. # Corresponds to the JSON property `httpBody` # @return [Google::Apis::MlV1::GoogleApiHttpBody] attr_accessor :http_body @@ -1782,10 +1726,10 @@ module Google class GoogleCloudMlV1PredictionInput include Google::Apis::Core::Hashable - # Optional. Number of records per batch, defaults to 64. - # The service will buffer batch_size number of records in memory before - # invoking one Tensorflow prediction call internally. So take the record - # size and memory available into consideration when setting this parameter. + # Optional. Number of records per batch, defaults to 64. The service will buffer + # batch_size number of records in memory before invoking one Tensorflow + # prediction call internally. So take the record size and memory available into + # consideration when setting this parameter. # Corresponds to the JSON property `batchSize` # @return [Fixnum] attr_accessor :batch_size @@ -1796,7 +1740,7 @@ module Google attr_accessor :data_format # Required. The Cloud Storage location of the input data files. May contain - # wildcards. + # wildcards. # Corresponds to the JSON property `inputPaths` # @return [Array] attr_accessor :input_paths @@ -1807,9 +1751,9 @@ module Google # @return [Fixnum] attr_accessor :max_worker_count - # Use this field if you want to use the default version for the specified - # model. The string must use the following format: - # `"projects/YOUR_PROJECT/models/YOUR_MODEL"` + # Use this field if you want to use the default version for the specified model. + # The string must use the following format: `"projects/YOUR_PROJECT/models/ + # YOUR_MODEL"` # Corresponds to the JSON property `modelName` # @return [String] attr_accessor :model_name @@ -1824,44 +1768,40 @@ module Google # @return [String] attr_accessor :output_path - # Required. The Google Compute Engine region to run the prediction job in. - # See the available regions - # for AI Platform services. + # Required. The Google Compute Engine region to run the prediction job in. See + # the available regions for AI Platform services. # Corresponds to the JSON property `region` # @return [String] attr_accessor :region - # Optional. The AI Platform runtime version to use for this batch - # prediction. If not set, AI Platform will pick the runtime version used - # during the CreateVersion request for this model version, or choose the - # latest stable version when model version information is not available - # such as when the model is specified by uri. + # Optional. The AI Platform runtime version to use for this batch prediction. If + # not set, AI Platform will pick the runtime version used during the + # CreateVersion request for this model version, or choose the latest stable + # version when model version information is not available such as when the model + # is specified by uri. # Corresponds to the JSON property `runtimeVersion` # @return [String] attr_accessor :runtime_version - # Optional. The name of the signature defined in the SavedModel to use for - # this job. Please refer to - # [SavedModel](https://tensorflow.github.io/serving/serving_basic.html) - # for information about how to use signatures. - # Defaults to - # [DEFAULT_SERVING_SIGNATURE_DEF_KEY](https://www.tensorflow.org/api_docs/python/ - # tf/saved_model/signature_constants) - # , which is "serving_default". + # Optional. The name of the signature defined in the SavedModel to use for this + # job. Please refer to [SavedModel](https://tensorflow.github.io/serving/ + # serving_basic.html) for information about how to use signatures. Defaults to [ + # DEFAULT_SERVING_SIGNATURE_DEF_KEY](https://www.tensorflow.org/api_docs/python/ + # tf/saved_model/signature_constants) , which is "serving_default". # Corresponds to the JSON property `signatureName` # @return [String] attr_accessor :signature_name - # Use this field if you want to specify a Google Cloud Storage path for - # the model to use. + # Use this field if you want to specify a Google Cloud Storage path for the + # model to use. # Corresponds to the JSON property `uri` # @return [String] attr_accessor :uri # Use this field if you want to specify a version of the model to use. The - # string is formatted the same way as `model_version`, with the addition - # of the version information: - # `"projects/YOUR_PROJECT/models/YOUR_MODEL/versions/YOUR_VERSION"` + # string is formatted the same way as `model_version`, with the addition of the + # version information: `"projects/YOUR_PROJECT/models/YOUR_MODEL/versions/ + # YOUR_VERSION"` # Corresponds to the JSON property `versionName` # @return [String] attr_accessor :version_name @@ -1928,68 +1868,56 @@ module Google class GoogleCloudMlV1ReplicaConfig include Google::Apis::Core::Hashable - # Represents a hardware accelerator request config. - # Note that the AcceleratorConfig can be used in both Jobs and Versions. - # Learn more about [accelerators for training](/ml-engine/docs/using-gpus) and - # [accelerators for online - # prediction](/ml-engine/docs/machine-types-online-prediction#gpus). + # Represents a hardware accelerator request config. Note that the + # AcceleratorConfig can be used in both Jobs and Versions. Learn more about [ + # accelerators for training](/ml-engine/docs/using-gpus) and [accelerators for + # online prediction](/ml-engine/docs/machine-types-online-prediction#gpus). # Corresponds to the JSON property `acceleratorConfig` # @return [Google::Apis::MlV1::GoogleCloudMlV1AcceleratorConfig] attr_accessor :accelerator_config - # Arguments to the entrypoint command. - # The following rules apply for container_command and container_args: - # - If you do not supply command or args: - # The defaults defined in the Docker image are used. - # - If you supply a command but no args: - # The default EntryPoint and the default Cmd defined in the Docker image - # are ignored. Your command is run without any arguments. - # - If you supply only args: - # The default Entrypoint defined in the Docker image is run with the args - # that you supplied. - # - If you supply a command and args: - # The default Entrypoint and the default Cmd defined in the Docker image - # are ignored. Your command is run with your args. - # It cannot be set if custom container image is - # not provided. - # Note that this field and [TrainingInput.args] are mutually exclusive, i.e., - # both cannot be set at the same time. + # Arguments to the entrypoint command. The following rules apply for + # container_command and container_args: - If you do not supply command or args: + # The defaults defined in the Docker image are used. - If you supply a command + # but no args: The default EntryPoint and the default Cmd defined in the Docker + # image are ignored. Your command is run without any arguments. - If you supply + # only args: The default Entrypoint defined in the Docker image is run with the + # args that you supplied. - If you supply a command and args: The default + # Entrypoint and the default Cmd defined in the Docker image are ignored. Your + # command is run with your args. It cannot be set if custom container image is + # not provided. Note that this field and [TrainingInput.args] are mutually + # exclusive, i.e., both cannot be set at the same time. # Corresponds to the JSON property `containerArgs` # @return [Array] attr_accessor :container_args - # The command with which the replica's custom container is run. - # If provided, it will override default ENTRYPOINT of the docker image. - # If not provided, the docker image's ENTRYPOINT is used. - # It cannot be set if custom container image is - # not provided. - # Note that this field and [TrainingInput.args] are mutually exclusive, i.e., - # both cannot be set at the same time. + # The command with which the replica's custom container is run. If provided, it + # will override default ENTRYPOINT of the docker image. If not provided, the + # docker image's ENTRYPOINT is used. It cannot be set if custom container image + # is not provided. Note that this field and [TrainingInput.args] are mutually + # exclusive, i.e., both cannot be set at the same time. # Corresponds to the JSON property `containerCommand` # @return [Array] attr_accessor :container_command # The Docker image to run on the replica. This image must be in Container - # Registry. Learn more about [configuring custom - # containers](/ai-platform/training/docs/distributed-training-containers). + # Registry. Learn more about [configuring custom containers](/ai-platform/ + # training/docs/distributed-training-containers). # Corresponds to the JSON property `imageUri` # @return [String] attr_accessor :image_uri # The AI Platform runtime version that includes a TensorFlow version matching - # the one used in the custom container. This field is required if the replica - # is a TPU worker that uses a custom container. Otherwise, do not specify - # this field. This must be a [runtime version that currently supports - # training with - # TPUs](/ml-engine/docs/tensorflow/runtime-version-list#tpu-support). - # Note that the version of TensorFlow included in a runtime version may - # differ from the numbering of the runtime version itself, because it may - # have a different [patch - # version](https://www.tensorflow.org/guide/version_compat# - # semantic_versioning_20). - # In this field, you must specify the runtime version (TensorFlow minor - # version). For example, if your custom container runs TensorFlow `1.x.y`, - # specify `1.x`. + # the one used in the custom container. This field is required if the replica is + # a TPU worker that uses a custom container. Otherwise, do not specify this + # field. This must be a [runtime version that currently supports training with + # TPUs](/ml-engine/docs/tensorflow/runtime-version-list#tpu-support). Note that + # the version of TensorFlow included in a runtime version may differ from the + # numbering of the runtime version itself, because it may have a different [ + # patch version](https://www.tensorflow.org/guide/version_compat# + # semantic_versioning_20). In this field, you must specify the runtime version ( + # TensorFlow minor version). For example, if your custom container runs + # TensorFlow `1.x.y`, specify `1.x`. # Corresponds to the JSON property `tpuTfVersion` # @return [String] attr_accessor :tpu_tf_version @@ -2008,42 +1936,32 @@ module Google end end - # Configuration for logging request-response pairs to a BigQuery table. - # Online prediction requests to a model version and the responses to these - # requests are converted to raw strings and saved to the specified BigQuery - # table. Logging is constrained by [BigQuery quotas and - # limits](/bigquery/quotas). If your project exceeds BigQuery quotas or limits, - # AI Platform Prediction does not log request-response pairs, but it continues - # to serve predictions. - # If you are using [continuous - # evaluation](/ml-engine/docs/continuous-evaluation/), you do not need to - # specify this configuration manually. Setting up continuous evaluation + # Configuration for logging request-response pairs to a BigQuery table. Online + # prediction requests to a model version and the responses to these requests are + # converted to raw strings and saved to the specified BigQuery table. Logging is + # constrained by [BigQuery quotas and limits](/bigquery/quotas). If your project + # exceeds BigQuery quotas or limits, AI Platform Prediction does not log request- + # response pairs, but it continues to serve predictions. If you are using [ + # continuous evaluation](/ml-engine/docs/continuous-evaluation/), you do not + # need to specify this configuration manually. Setting up continuous evaluation # automatically enables logging of request-response pairs. class GoogleCloudMlV1RequestLoggingConfig include Google::Apis::Core::Hashable - # Required. Fully qualified BigQuery table name in the following format: - # "project_id.dataset_name.table_name" - # The specified table must already exist, and the "Cloud ML Service Agent" - # for your project must have permission to write to it. The table must have - # the following [schema](/bigquery/docs/schemas): - # - # - # - # - # - # - # - # - # - #
Field nameTypeMode
modelSTRINGREQUIRED
model_versionSTRINGREQUIRED
timeTIMESTAMPREQUIRED
raw_dataSTRINGREQUIRED
raw_predictionSTRINGNULLABLE
groundtruthSTRINGNULLABLE
+ # Required. Fully qualified BigQuery table name in the following format: " + # project_id.dataset_name.table_name" The specified table must already exist, + # and the "Cloud ML Service Agent" for your project must have permission to + # write to it. The table must have the following [schema](/bigquery/docs/schemas) + # : Field nameType Mode model STRING REQUIRED model_version STRING REQUIRED time + # TIMESTAMP REQUIRED raw_data STRING REQUIRED raw_prediction STRING NULLABLE + # groundtruth STRING NULLABLE # Corresponds to the JSON property `bigqueryTableName` # @return [String] attr_accessor :bigquery_table_name - # Percentage of requests to be logged, expressed as a fraction from 0 to 1. - # For example, if you want to log 10% of requests, enter `0.1`. The sampling - # window is the lifetime of the model version. Defaults to 0. + # Percentage of requests to be logged, expressed as a fraction from 0 to 1. For + # example, if you want to log 10% of requests, enter `0.1`. The sampling window + # is the lifetime of the model version. Defaults to 0. # Corresponds to the JSON property `samplingPercentage` # @return [Float] attr_accessor :sampling_percentage @@ -2065,8 +1983,8 @@ module Google class GoogleCloudMlV1SampledShapleyAttribution include Google::Apis::Core::Hashable - # The number of feature permutations to consider when approximating the - # Shapley values. + # The number of feature permutations to consider when approximating the Shapley + # values. # Corresponds to the JSON property `numPaths` # @return [Fixnum] attr_accessor :num_paths @@ -2087,24 +2005,14 @@ module Google # Optional. The maximum job running time, expressed in seconds. The field can # contain up to nine fractional digits, terminated by `s`. If not specified, - # this field defaults to `604800s` (seven days). - # If the training job is still running after this duration, AI Platform - # Training cancels it. - # For example, if you want to ensure your job runs for no more than 2 hours, - # set this field to `7200s` (2 hours * 60 minutes / hour * 60 seconds / - # minute). - # If you submit your training job using the `gcloud` tool, you can [provide - # this field in a `config.yaml` - # file](/ai-platform/training/docs/training-jobs# - # formatting_your_configuration_parameters). - # For example: - # ```yaml - # trainingInput: - # ... - # scheduling: - # maxRunningTime: 7200s - # ... - # ``` + # this field defaults to `604800s` (seven days). If the training job is still + # running after this duration, AI Platform Training cancels it. For example, if + # you want to ensure your job runs for no more than 2 hours, set this field to ` + # 7200s` (2 hours * 60 minutes / hour * 60 seconds / minute). If you submit your + # training job using the `gcloud` tool, you can [provide this field in a `config. + # yaml` file](/ai-platform/training/docs/training-jobs# + # formatting_your_configuration_parameters). For example: ```yaml trainingInput: + # ... scheduling: maxRunningTime: 7200s ... ``` # Corresponds to the JSON property `maxRunningTime` # @return [String] attr_accessor :max_running_time @@ -2160,8 +2068,8 @@ module Google # @return [String] attr_accessor :create_time - # Output only. A human readable reason why the Study is inactive. - # This should be empty if a study is ACTIVE or COMPLETED. + # Output only. A human readable reason why the Study is inactive. This should be + # empty if a study is ACTIVE or COMPLETED. # Corresponds to the JSON property `inactiveReason` # @return [String] attr_accessor :inactive_reason @@ -2233,8 +2141,8 @@ module Google end end - # Metadata field of a google.longrunning.Operation associated - # with a SuggestTrialsRequest. + # Metadata field of a google.longrunning.Operation associated with a + # SuggestTrialsRequest. class GoogleCloudMlV1SuggestTrialsMetadata include Google::Apis::Core::Hashable @@ -2275,10 +2183,10 @@ module Google class GoogleCloudMlV1SuggestTrialsRequest include Google::Apis::Core::Hashable - # Required. The identifier of the client that is requesting the suggestion. - # If multiple SuggestTrialsRequests have the same `client_id`, - # the service will return the identical suggested trial if the trial is - # pending, and provide a new trial if the last suggested trial was completed. + # Required. The identifier of the client that is requesting the suggestion. If + # multiple SuggestTrialsRequests have the same `client_id`, the service will + # return the identical suggested trial if the trial is pending, and provide a + # new trial if the last suggested trial was completed. # Corresponds to the JSON property `clientId` # @return [String] attr_accessor :client_id @@ -2299,8 +2207,8 @@ module Google end end - # This message will be placed in the response field of a completed - # google.longrunning.Operation associated with a SuggestTrials request. + # This message will be placed in the response field of a completed google. + # longrunning.Operation associated with a SuggestTrials request. class GoogleCloudMlV1SuggestTrialsResponse include Google::Apis::Core::Hashable @@ -2338,24 +2246,22 @@ module Google end # Represents input parameters for a training job. When using the gcloud command - # to submit your training job, you can specify the input parameters as - # command-line arguments and/or in a YAML configuration file referenced from - # the --config command-line argument. For details, see the guide to [submitting - # a training job](/ai-platform/training/docs/training-jobs). + # to submit your training job, you can specify the input parameters as command- + # line arguments and/or in a YAML configuration file referenced from the -- + # config command-line argument. For details, see the guide to [submitting a + # training job](/ai-platform/training/docs/training-jobs). class GoogleCloudMlV1TrainingInput include Google::Apis::Core::Hashable # Optional. Command-line arguments passed to the training application when it - # starts. If your job uses a custom container, then the arguments are passed - # to the container's - # `ENTRYPOINT` command. + # starts. If your job uses a custom container, then the arguments are passed to + # the container's `ENTRYPOINT` command. # Corresponds to the JSON property `args` # @return [Array] attr_accessor :args - # Represents a custom encryption key configuration that can be applied to - # a resource. + # Represents a custom encryption key configuration that can be applied to a + # resource. # Corresponds to the JSON property `encryptionConfig` # @return [Google::Apis::MlV1::GoogleCloudMlV1EncryptionConfig] attr_accessor :encryption_config @@ -2365,25 +2271,21 @@ module Google # @return [Google::Apis::MlV1::GoogleCloudMlV1ReplicaConfig] attr_accessor :evaluator_config - # Optional. The number of evaluator replicas to use for the training job. - # Each replica in the cluster will be of the type specified in - # `evaluator_type`. - # This value can only be used when `scale_tier` is set to `CUSTOM`. If you - # set this value, you must also set `evaluator_type`. - # The default value is zero. + # Optional. The number of evaluator replicas to use for the training job. Each + # replica in the cluster will be of the type specified in `evaluator_type`. This + # value can only be used when `scale_tier` is set to `CUSTOM`. If you set this + # value, you must also set `evaluator_type`. The default value is zero. # Corresponds to the JSON property `evaluatorCount` # @return [Fixnum] attr_accessor :evaluator_count - # Optional. Specifies the type of virtual machine to use for your training - # job's evaluator nodes. - # The supported values are the same as those described in the entry for - # `masterType`. - # This value must be consistent with the category of machine type that - # `masterType` uses. In other words, both must be Compute Engine machine - # types or both must be legacy machine types. - # This value must be present when `scaleTier` is set to `CUSTOM` and - # `evaluatorCount` is greater than zero. + # Optional. Specifies the type of virtual machine to use for your training job's + # evaluator nodes. The supported values are the same as those described in the + # entry for `masterType`. This value must be consistent with the category of + # machine type that `masterType` uses. In other words, both must be Compute + # Engine machine types or both must be legacy machine types. This value must be + # present when `scaleTier` is set to `CUSTOM` and `evaluatorCount` is greater + # than zero. # Corresponds to the JSON property `evaluatorType` # @return [String] attr_accessor :evaluator_type @@ -2393,10 +2295,10 @@ module Google # @return [Google::Apis::MlV1::GoogleCloudMlV1HyperparameterSpec] attr_accessor :hyperparameters - # Optional. A Google Cloud Storage path in which to store training outputs - # and other data needed for training. This path is passed to your TensorFlow - # program as the '--job-dir' command-line argument. The benefit of specifying - # this field is that Cloud ML validates the path for use in training. + # Optional. A Google Cloud Storage path in which to store training outputs and + # other data needed for training. This path is passed to your TensorFlow program + # as the '--job-dir' command-line argument. The benefit of specifying this field + # is that Cloud ML validates the path for use in training. # Corresponds to the JSON property `jobDir` # @return [String] attr_accessor :job_dir @@ -2406,71 +2308,42 @@ module Google # @return [Google::Apis::MlV1::GoogleCloudMlV1ReplicaConfig] attr_accessor :master_config - # Optional. Specifies the type of virtual machine to use for your training - # job's master worker. You must specify this field when `scaleTier` is set to - # `CUSTOM`. - # You can use certain Compute Engine machine types directly in this field. - # The following types are supported: - # - `n1-standard-4` - # - `n1-standard-8` - # - `n1-standard-16` - # - `n1-standard-32` - # - `n1-standard-64` - # - `n1-standard-96` - # - `n1-highmem-2` - # - `n1-highmem-4` - # - `n1-highmem-8` - # - `n1-highmem-16` - # - `n1-highmem-32` - # - `n1-highmem-64` - # - `n1-highmem-96` - # - `n1-highcpu-16` - # - `n1-highcpu-32` - # - `n1-highcpu-64` - # - `n1-highcpu-96` - # Learn more about [using Compute Engine machine - # types](/ml-engine/docs/machine-types#compute-engine-machine-types). - # Alternatively, you can use the following legacy machine types: - # - `standard` - # - `large_model` - # - `complex_model_s` - # - `complex_model_m` - # - `complex_model_l` - # - `standard_gpu` - # - `complex_model_m_gpu` - # - `complex_model_l_gpu` - # - `standard_p100` - # - `complex_model_m_p100` - # - `standard_v100` - # - `large_model_v100` - # - `complex_model_m_v100` - # - `complex_model_l_v100` - # Learn more about [using legacy machine - # types](/ml-engine/docs/machine-types#legacy-machine-types). - # Finally, if you want to use a TPU for training, specify `cloud_tpu` in this - # field. Learn more about the [special configuration options for training - # with - # TPUs](/ml-engine/docs/tensorflow/using-tpus#configuring_a_custom_tpu_machine). + # Optional. Specifies the type of virtual machine to use for your training job's + # master worker. You must specify this field when `scaleTier` is set to `CUSTOM`. + # You can use certain Compute Engine machine types directly in this field. The + # following types are supported: - `n1-standard-4` - `n1-standard-8` - `n1- + # standard-16` - `n1-standard-32` - `n1-standard-64` - `n1-standard-96` - `n1- + # highmem-2` - `n1-highmem-4` - `n1-highmem-8` - `n1-highmem-16` - `n1-highmem- + # 32` - `n1-highmem-64` - `n1-highmem-96` - `n1-highcpu-16` - `n1-highcpu-32` - ` + # n1-highcpu-64` - `n1-highcpu-96` Learn more about [using Compute Engine + # machine types](/ml-engine/docs/machine-types#compute-engine-machine-types). + # Alternatively, you can use the following legacy machine types: - `standard` - ` + # large_model` - `complex_model_s` - `complex_model_m` - `complex_model_l` - ` + # standard_gpu` - `complex_model_m_gpu` - `complex_model_l_gpu` - `standard_p100` + # - `complex_model_m_p100` - `standard_v100` - `large_model_v100` - ` + # complex_model_m_v100` - `complex_model_l_v100` Learn more about [using legacy + # machine types](/ml-engine/docs/machine-types#legacy-machine-types). Finally, + # if you want to use a TPU for training, specify `cloud_tpu` in this field. + # Learn more about the [special configuration options for training with TPUs](/ + # ml-engine/docs/tensorflow/using-tpus#configuring_a_custom_tpu_machine). # Corresponds to the JSON property `masterType` # @return [String] attr_accessor :master_type # Optional. The full name of the [Compute Engine network](/vpc/docs/vpc) to - # which the - # Job is peered. For example, `projects/12345/global/networks/myVPC`. The - # format of this field is `projects/`project`/global/networks/`network``, + # which the Job is peered. For example, `projects/12345/global/networks/myVPC`. + # The format of this field is `projects/`project`/global/networks/`network``, # where `project` is a project number (like `12345`) and `network` is network - # name. - # Private services access must already be configured for the network. If left - # unspecified, the Job is not peered with any network. [Learn about using VPC - # Network Peering.](/ai-platform/training/docs/vpc-peering). + # name. Private services access must already be configured for the network. If + # left unspecified, the Job is not peered with any network. [Learn about using + # VPC Network Peering.](/ai-platform/training/docs/vpc-peering). # Corresponds to the JSON property `network` # @return [String] attr_accessor :network - # Required. The Google Cloud Storage location of the packages with - # the training program and any additional dependencies. - # The maximum number of package URIs is 100. + # Required. The Google Cloud Storage location of the packages with the training + # program and any additional dependencies. The maximum number of package URIs is + # 100. # Corresponds to the JSON property `packageUris` # @return [Array] attr_accessor :package_uris @@ -2480,25 +2353,22 @@ module Google # @return [Google::Apis::MlV1::GoogleCloudMlV1ReplicaConfig] attr_accessor :parameter_server_config - # Optional. The number of parameter server replicas to use for the training - # job. Each replica in the cluster will be of the type specified in - # `parameter_server_type`. - # This value can only be used when `scale_tier` is set to `CUSTOM`. If you - # set this value, you must also set `parameter_server_type`. + # Optional. The number of parameter server replicas to use for the training job. + # Each replica in the cluster will be of the type specified in ` + # parameter_server_type`. This value can only be used when `scale_tier` is set + # to `CUSTOM`. If you set this value, you must also set `parameter_server_type`. # The default value is zero. # Corresponds to the JSON property `parameterServerCount` # @return [Fixnum] attr_accessor :parameter_server_count - # Optional. Specifies the type of virtual machine to use for your training - # job's parameter server. - # The supported values are the same as those described in the entry for - # `master_type`. - # This value must be consistent with the category of machine type that - # `masterType` uses. In other words, both must be Compute Engine machine - # types or both must be legacy machine types. - # This value must be present when `scaleTier` is set to `CUSTOM` and - # `parameter_server_count` is greater than zero. + # Optional. Specifies the type of virtual machine to use for your training job's + # parameter server. The supported values are the same as those described in the + # entry for `master_type`. This value must be consistent with the category of + # machine type that `masterType` uses. In other words, both must be Compute + # Engine machine types or both must be legacy machine types. This value must be + # present when `scaleTier` is set to `CUSTOM` and `parameter_server_count` is + # greater than zero. # Corresponds to the JSON property `parameterServerType` # @return [String] attr_accessor :parameter_server_type @@ -2508,38 +2378,35 @@ module Google # @return [String] attr_accessor :python_module - # Optional. The version of Python used in training. You must either specify - # this field or specify `masterConfig.imageUri`. - # The following Python versions are available: - # * Python '3.7' is available when `runtime_version` is set to '1.15' or - # later. - # * Python '3.5' is available when `runtime_version` is set to a version - # from '1.4' to '1.14'. - # * Python '2.7' is available when `runtime_version` is set to '1.15' or - # earlier. - # Read more about the Python versions available for [each runtime - # version](/ml-engine/docs/runtime-version-list). + # Optional. The version of Python used in training. You must either specify this + # field or specify `masterConfig.imageUri`. The following Python versions are + # available: * Python '3.7' is available when `runtime_version` is set to '1.15' + # or later. * Python '3.5' is available when `runtime_version` is set to a + # version from '1.4' to '1.14'. * Python '2.7' is available when ` + # runtime_version` is set to '1.15' or earlier. Read more about the Python + # versions available for [each runtime version](/ml-engine/docs/runtime-version- + # list). # Corresponds to the JSON property `pythonVersion` # @return [String] attr_accessor :python_version - # Required. The region to run the training job in. See the [available - # regions](/ai-platform/training/docs/regions) for AI Platform Training. + # Required. The region to run the training job in. See the [available regions](/ + # ai-platform/training/docs/regions) for AI Platform Training. # Corresponds to the JSON property `region` # @return [String] attr_accessor :region - # Optional. The AI Platform runtime version to use for training. You must - # either specify this field or specify `masterConfig.imageUri`. - # For more information, see the [runtime version - # list](/ai-platform/training/docs/runtime-version-list) and learn [how to - # manage runtime versions](/ai-platform/training/docs/versioning). + # Optional. The AI Platform runtime version to use for training. You must either + # specify this field or specify `masterConfig.imageUri`. For more information, + # see the [runtime version list](/ai-platform/training/docs/runtime-version-list) + # and learn [how to manage runtime versions](/ai-platform/training/docs/ + # versioning). # Corresponds to the JSON property `runtimeVersion` # @return [String] attr_accessor :runtime_version - # Required. Specifies the machine types, the number of replicas for workers - # and parameter servers. + # Required. Specifies the machine types, the number of replicas for workers and + # parameter servers. # Corresponds to the JSON property `scaleTier` # @return [String] attr_accessor :scale_tier @@ -2552,23 +2419,20 @@ module Google # Optional. The email address of a service account to use when running the # training appplication. You must have the `iam.serviceAccounts.actAs` # permission for the specified service account. In addition, the AI Platform - # Training Google-managed service account must have the - # `roles/iam.serviceAccountAdmin` role for the specified service account. - # [Learn more about configuring a service - # account.](/ai-platform/training/docs/custom-service-account) - # If not specified, the AI Platform Training Google-managed service account - # is used by default. + # Training Google-managed service account must have the `roles/iam. + # serviceAccountAdmin` role for the specified service account. [Learn more about + # configuring a service account.](/ai-platform/training/docs/custom-service- + # account) If not specified, the AI Platform Training Google-managed service + # account is used by default. # Corresponds to the JSON property `serviceAccount` # @return [String] attr_accessor :service_account # Optional. Use `chief` instead of `master` in the `TF_CONFIG` environment # variable when training with a custom container. Defaults to `false`. [Learn - # more about this - # field.](/ai-platform/training/docs/distributed-training-details#chief-versus- - # master) - # This field has no effect for training jobs that don't use a custom - # container. + # more about this field.](/ai-platform/training/docs/distributed-training- + # details#chief-versus-master) This field has no effect for training jobs that + # don't use a custom container. # Corresponds to the JSON property `useChiefInTfConfig` # @return [Boolean] attr_accessor :use_chief_in_tf_config @@ -2580,27 +2444,22 @@ module Google attr_accessor :worker_config # Optional. The number of worker replicas to use for the training job. Each - # replica in the cluster will be of the type specified in `worker_type`. - # This value can only be used when `scale_tier` is set to `CUSTOM`. If you - # set this value, you must also set `worker_type`. - # The default value is zero. + # replica in the cluster will be of the type specified in `worker_type`. This + # value can only be used when `scale_tier` is set to `CUSTOM`. If you set this + # value, you must also set `worker_type`. The default value is zero. # Corresponds to the JSON property `workerCount` # @return [Fixnum] attr_accessor :worker_count - # Optional. Specifies the type of virtual machine to use for your training - # job's worker nodes. - # The supported values are the same as those described in the entry for - # `masterType`. - # This value must be consistent with the category of machine type that - # `masterType` uses. In other words, both must be Compute Engine machine - # types or both must be legacy machine types. - # If you use `cloud_tpu` for this value, see special instructions for - # [configuring a custom TPU - # machine](/ml-engine/docs/tensorflow/using-tpus# - # configuring_a_custom_tpu_machine). - # This value must be present when `scaleTier` is set to `CUSTOM` and - # `workerCount` is greater than zero. + # Optional. Specifies the type of virtual machine to use for your training job's + # worker nodes. The supported values are the same as those described in the + # entry for `masterType`. This value must be consistent with the category of + # machine type that `masterType` uses. In other words, both must be Compute + # Engine machine types or both must be legacy machine types. If you use ` + # cloud_tpu` for this value, see special instructions for [configuring a custom + # TPU machine](/ml-engine/docs/tensorflow/using-tpus# + # configuring_a_custom_tpu_machine). This value must be present when `scaleTier` + # is set to `CUSTOM` and `workerCount` is greater than zero. # Corresponds to the JSON property `workerType` # @return [String] attr_accessor :worker_type @@ -2648,8 +2507,8 @@ module Google # @return [Google::Apis::MlV1::GoogleCloudMlV1BuiltInAlgorithmOutput] attr_accessor :built_in_algorithm_output - # The number of hyperparameter tuning trials that completed successfully. - # Only set for hyperparameter tuning jobs. + # The number of hyperparameter tuning trials that completed successfully. Only + # set for hyperparameter tuning jobs. # Corresponds to the JSON property `completedTrialCount` # @return [Fixnum] attr_accessor :completed_trial_count @@ -2660,10 +2519,9 @@ module Google attr_accessor :consumed_ml_units # The TensorFlow summary tag name used for optimizing hyperparameter tuning - # trials. See - # [`HyperparameterSpec.hyperparameterMetricTag`](#HyperparameterSpec.FIELDS. - # hyperparameter_metric_tag) - # for more information. Only set for hyperparameter tuning jobs. + # trials. See [`HyperparameterSpec.hyperparameterMetricTag`](#HyperparameterSpec. + # FIELDS.hyperparameter_metric_tag) for more information. Only set for + # hyperparameter tuning jobs. # Corresponds to the JSON property `hyperparameterMetricTag` # @return [String] attr_accessor :hyperparameter_metric_tag @@ -2680,8 +2538,8 @@ module Google attr_accessor :is_hyperparameter_tuning_job alias_method :is_hyperparameter_tuning_job?, :is_hyperparameter_tuning_job - # Results for individual Hyperparameter trials. - # Only set for hyperparameter tuning jobs. + # Results for individual Hyperparameter trials. Only set for hyperparameter + # tuning jobs. # Corresponds to the JSON property `trials` # @return [Array] attr_accessor :trials @@ -2721,15 +2579,15 @@ module Google # @return [Google::Apis::MlV1::GoogleCloudMlV1Measurement] attr_accessor :final_measurement - # Output only. A human readable string describing why the trial is - # infeasible. This should only be set if trial_infeasible is true. + # Output only. A human readable string describing why the trial is infeasible. + # This should only be set if trial_infeasible is true. # Corresponds to the JSON property `infeasibleReason` # @return [String] attr_accessor :infeasible_reason - # A list of measurements that are strictly lexicographically - # ordered by their induced tuples (steps, elapsed_time). - # These are used for early stopping computations. + # A list of measurements that are strictly lexicographically ordered by their + # induced tuples (steps, elapsed_time). These are used for early stopping + # computations. # Corresponds to the JSON property `measurements` # @return [Array] attr_accessor :measurements @@ -2779,19 +2637,17 @@ module Google end end - # Represents a version of the model. - # Each version is a trained model deployed in the cloud, ready to handle - # prediction requests. A model can have multiple versions. You can get - # information about all of the versions of a given model by calling - # projects.models.versions.list. + # Represents a version of the model. Each version is a trained model deployed in + # the cloud, ready to handle prediction requests. A model can have multiple + # versions. You can get information about all of the versions of a given model + # by calling projects.models.versions.list. class GoogleCloudMlV1Version include Google::Apis::Core::Hashable - # Represents a hardware accelerator request config. - # Note that the AcceleratorConfig can be used in both Jobs and Versions. - # Learn more about [accelerators for training](/ml-engine/docs/using-gpus) and - # [accelerators for online - # prediction](/ml-engine/docs/machine-types-online-prediction#gpus). + # Represents a hardware accelerator request config. Note that the + # AcceleratorConfig can be used in both Jobs and Versions. Learn more about [ + # accelerators for training](/ml-engine/docs/using-gpus) and [accelerators for + # online prediction](/ml-engine/docs/machine-types-online-prediction#gpus). # Corresponds to the JSON property `acceleratorConfig` # @return [Google::Apis::MlV1::GoogleCloudMlV1AcceleratorConfig] attr_accessor :accelerator_config @@ -2806,16 +2662,12 @@ module Google # @return [String] attr_accessor :create_time - # Required. The Cloud Storage location of the trained model used to - # create the version. See the - # [guide to model - # deployment](/ml-engine/docs/tensorflow/deploying-models) for more - # information. - # When passing Version to - # projects.models.versions.create - # the model service uses the specified location as the source of the model. - # Once deployed, the model version is hosted by the prediction service, so - # this location is useful only as a historical record. + # Required. The Cloud Storage location of the trained model used to create the + # version. See the [guide to model deployment](/ml-engine/docs/tensorflow/ + # deploying-models) for more information. When passing Version to projects. + # models.versions.create the model service uses the specified location as the + # source of the model. Once deployed, the model version is hosted by the + # prediction service, so this location is useful only as a historical record. # The total number of model files can't exceed 1000. # Corresponds to the JSON property `deploymentUri` # @return [String] @@ -2826,62 +2678,66 @@ module Google # @return [String] attr_accessor :description + # EndpointMap is used to provide paths for predict/explain/healthcheck to + # customers. It's an output only field in the version proto which can be only + # set on the server side. Public endpoints follow the format specified on the + # user facing doc, and private endpoints are customized for each privately + # deploymed model/version. + # Corresponds to the JSON property `endpoints` + # @return [Google::Apis::MlV1::GoogleCloudMlV1EndpointMap] + attr_accessor :endpoints + # Output only. The details of a failure or a cancellation. # Corresponds to the JSON property `errorMessage` # @return [String] attr_accessor :error_message - # `etag` is used for optimistic concurrency control as a way to help - # prevent simultaneous updates of a model from overwriting each other. - # It is strongly suggested that systems make use of the `etag` in the - # read-modify-write cycle to perform model updates in order to avoid race - # conditions: An `etag` is returned in the response to `GetVersion`, and - # systems are expected to put that etag in the request to `UpdateVersion` to - # ensure that their change will be applied to the model as intended. + # `etag` is used for optimistic concurrency control as a way to help prevent + # simultaneous updates of a model from overwriting each other. It is strongly + # suggested that systems make use of the `etag` in the read-modify-write cycle + # to perform model updates in order to avoid race conditions: An `etag` is + # returned in the response to `GetVersion`, and systems are expected to put that + # etag in the request to `UpdateVersion` to ensure that their change will be + # applied to the model as intended. # Corresponds to the JSON property `etag` # NOTE: Values are automatically base64 encoded/decoded in the client library. # @return [String] attr_accessor :etag - # Message holding configuration options for explaining model predictions. - # There are two feature attribution methods supported for TensorFlow models: - # integrated gradients and sampled Shapley. - # [Learn more about feature + # Message holding configuration options for explaining model predictions. There + # are two feature attribution methods supported for TensorFlow models: + # integrated gradients and sampled Shapley. [Learn more about feature # attributions.](/ai-platform/prediction/docs/ai-explanations/overview) # Corresponds to the JSON property `explanationConfig` # @return [Google::Apis::MlV1::GoogleCloudMlV1ExplanationConfig] attr_accessor :explanation_config - # Optional. The machine learning framework AI Platform uses to train - # this version of the model. Valid values are `TENSORFLOW`, `SCIKIT_LEARN`, - # `XGBOOST`. If you do not specify a framework, AI Platform - # will analyze files in the deployment_uri to determine a framework. If you - # choose `SCIKIT_LEARN` or `XGBOOST`, you must also set the runtime version - # of the model to 1.4 or greater. - # Do **not** specify a framework if you're deploying a [custom - # prediction routine](/ml-engine/docs/tensorflow/custom-prediction-routines). - # If you specify a [Compute Engine (N1) machine - # type](/ml-engine/docs/machine-types-online-prediction) in the - # `machineType` field, you must specify `TENSORFLOW` + # Optional. The machine learning framework AI Platform uses to train this + # version of the model. Valid values are `TENSORFLOW`, `SCIKIT_LEARN`, `XGBOOST`. + # If you do not specify a framework, AI Platform will analyze files in the + # deployment_uri to determine a framework. If you choose `SCIKIT_LEARN` or ` + # XGBOOST`, you must also set the runtime version of the model to 1.4 or greater. + # Do **not** specify a framework if you're deploying a [custom prediction + # routine](/ml-engine/docs/tensorflow/custom-prediction-routines). If you + # specify a [Compute Engine (N1) machine type](/ml-engine/docs/machine-types- + # online-prediction) in the `machineType` field, you must specify `TENSORFLOW` # for the framework. # Corresponds to the JSON property `framework` # @return [String] attr_accessor :framework - # Output only. If true, this version will be used to handle prediction - # requests that do not specify a version. - # You can change the default version by calling + # Output only. If true, this version will be used to handle prediction requests + # that do not specify a version. You can change the default version by calling # projects.methods.versions.setDefault. # Corresponds to the JSON property `isDefault` # @return [Boolean] attr_accessor :is_default alias_method :is_default?, :is_default - # Optional. One or more labels that you can add, to organize your model - # versions. Each label is a key-value pair, where both the key and the value - # are arbitrary strings that you supply. - # For more information, see the documentation on - # using labels. + # Optional. One or more labels that you can add, to organize your model versions. + # Each label is a key-value pair, where both the key and the value are + # arbitrary strings that you supply. For more information, see the documentation + # on using labels. # Corresponds to the JSON property `labels` # @return [Hash] attr_accessor :labels @@ -2893,28 +2749,14 @@ module Google # Optional. The type of machine on which to serve the model. Currently only # applies to online prediction service. If this field is not specified, it - # defaults to `mls1-c1-m2`. - # Online prediction supports the following machine types: - # * `mls1-c1-m2` - # * `mls1-c4-m2` - # * `n1-standard-2` - # * `n1-standard-4` - # * `n1-standard-8` - # * `n1-standard-16` - # * `n1-standard-32` - # * `n1-highmem-2` - # * `n1-highmem-4` - # * `n1-highmem-8` - # * `n1-highmem-16` - # * `n1-highmem-32` - # * `n1-highcpu-2` - # * `n1-highcpu-4` - # * `n1-highcpu-8` - # * `n1-highcpu-16` - # * `n1-highcpu-32` - # `mls1-c1-m2` is generally available. All other machine types are available - # in beta. Learn more about the [differences between machine - # types](/ml-engine/docs/machine-types-online-prediction). + # defaults to `mls1-c1-m2`. Online prediction supports the following machine + # types: * `mls1-c1-m2` * `mls1-c4-m2` * `n1-standard-2` * `n1-standard-4` * `n1- + # standard-8` * `n1-standard-16` * `n1-standard-32` * `n1-highmem-2` * `n1- + # highmem-4` * `n1-highmem-8` * `n1-highmem-16` * `n1-highmem-32` * `n1-highcpu- + # 2` * `n1-highcpu-4` * `n1-highcpu-8` * `n1-highcpu-16` * `n1-highcpu-32` `mls1- + # c1-m2` is generally available. All other machine types are available in beta. + # Learn more about the [differences between machine types](/ml-engine/docs/ + # machine-types-online-prediction). # Corresponds to the JSON property `machineType` # @return [String] attr_accessor :machine_type @@ -2924,108 +2766,81 @@ module Google # @return [Google::Apis::MlV1::GoogleCloudMlV1ManualScaling] attr_accessor :manual_scaling - # Required. The name specified for the version when it was created. - # The version name must be unique within the model it is created in. + # Required. The name specified for the version when it was created. The version + # name must be unique within the model it is created in. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name - # Optional. Cloud Storage paths (`gs://…`) of packages for [custom - # prediction routines](/ml-engine/docs/tensorflow/custom-prediction-routines) - # or [scikit-learn pipelines with custom - # code](/ml-engine/docs/scikit/exporting-for-prediction#custom-pipeline-code). - # For a custom prediction routine, one of these packages must contain your - # Predictor class (see - # [`predictionClass`](#Version.FIELDS.prediction_class)). Additionally, - # include any dependencies used by your Predictor or scikit-learn pipeline - # uses that are not already included in your selected [runtime - # version](/ml-engine/docs/tensorflow/runtime-version-list). - # If you specify this field, you must also set - # [`runtimeVersion`](#Version.FIELDS.runtime_version) to 1.4 or greater. + # Optional. Cloud Storage paths (`gs://…`) of packages for [custom prediction + # routines](/ml-engine/docs/tensorflow/custom-prediction-routines) or [scikit- + # learn pipelines with custom code](/ml-engine/docs/scikit/exporting-for- + # prediction#custom-pipeline-code). For a custom prediction routine, one of + # these packages must contain your Predictor class (see [`predictionClass`](# + # Version.FIELDS.prediction_class)). Additionally, include any dependencies used + # by your Predictor or scikit-learn pipeline uses that are not already included + # in your selected [runtime version](/ml-engine/docs/tensorflow/runtime-version- + # list). If you specify this field, you must also set [`runtimeVersion`](# + # Version.FIELDS.runtime_version) to 1.4 or greater. # Corresponds to the JSON property `packageUris` # @return [Array] attr_accessor :package_uris - # Optional. The fully qualified name - # (module_name.class_name) of a class that implements - # the Predictor interface described in this reference field. The module - # containing this class should be included in a package provided to the - # [`packageUris` field](#Version.FIELDS.package_uris). - # Specify this field if and only if you are deploying a [custom prediction - # routine (beta)](/ml-engine/docs/tensorflow/custom-prediction-routines). - # If you specify this field, you must set - # [`runtimeVersion`](#Version.FIELDS.runtime_version) to 1.4 or greater and - # you must set `machineType` to a [legacy (MLS1) - # machine type](/ml-engine/docs/machine-types-online-prediction). - # The following code sample provides the Predictor interface: - # 
-        # class Predictor(object):
-        # """Interface for constructing custom predictors."""
-        # def predict(self, instances, **kwargs):
-        # """Performs custom prediction.
-        # Instances are the decoded values from the request. They have already
-        # been deserialized from JSON.
-        # Args:
-        # instances: A list of prediction input instances.
-        # **kwargs: A dictionary of keyword args provided as additional
-        # fields on the predict request body.
-        # Returns:
-        # A list of outputs containing the prediction results. This list must
-        # be JSON serializable.
-        # """
-        # raise NotImplementedError()
-        # @classmethod
-        # def from_path(cls, model_dir):
-        # """Creates an instance of Predictor using the given path.
-        # Loading of the predictor should be done in this method.
-        # Args:
-        # model_dir: The local directory that contains the exported model
-        # file along with any additional files uploaded when creating the
-        # version resource.
-        # Returns:
-        # An instance implementing this Predictor class.
-        # """
-        # raise NotImplementedError()
-        #
- # Learn more about [the Predictor interface and custom prediction - # routines](/ml-engine/docs/tensorflow/custom-prediction-routines). + # Optional. The fully qualified name (module_name.class_name) of a class that + # implements the Predictor interface described in this reference field. The + # module containing this class should be included in a package provided to the [` + # packageUris` field](#Version.FIELDS.package_uris). Specify this field if and + # only if you are deploying a [custom prediction routine (beta)](/ml-engine/docs/ + # tensorflow/custom-prediction-routines). If you specify this field, you must + # set [`runtimeVersion`](#Version.FIELDS.runtime_version) to 1.4 or greater and + # you must set `machineType` to a [legacy (MLS1) machine type](/ml-engine/docs/ + # machine-types-online-prediction). The following code sample provides the + # Predictor interface: class Predictor(object): """Interface for constructing + # custom predictors.""" def predict(self, instances, **kwargs): """Performs + # custom prediction. Instances are the decoded values from the request. They + # have already been deserialized from JSON. Args: instances: A list of + # prediction input instances. **kwargs: A dictionary of keyword args provided as + # additional fields on the predict request body. Returns: A list of outputs + # containing the prediction results. This list must be JSON serializable. """ + # raise NotImplementedError() @classmethod def from_path(cls, model_dir): """ + # Creates an instance of Predictor using the given path. Loading of the + # predictor should be done in this method. Args: model_dir: The local directory + # that contains the exported model file along with any additional files uploaded + # when creating the version resource. Returns: An instance implementing this + # Predictor class. """ raise NotImplementedError() Learn more about [the + # Predictor interface and custom prediction routines](/ml-engine/docs/tensorflow/ + # custom-prediction-routines). # Corresponds to the JSON property `predictionClass` # @return [String] attr_accessor :prediction_class - # Required. The version of Python used in prediction. - # The following Python versions are available: - # * Python '3.7' is available when `runtime_version` is set to '1.15' or - # later. - # * Python '3.5' is available when `runtime_version` is set to a version - # from '1.4' to '1.14'. - # * Python '2.7' is available when `runtime_version` is set to '1.15' or - # earlier. - # Read more about the Python versions available for [each runtime - # version](/ml-engine/docs/runtime-version-list). + # Required. The version of Python used in prediction. The following Python + # versions are available: * Python '3.7' is available when `runtime_version` is + # set to '1.15' or later. * Python '3.5' is available when `runtime_version` is + # set to a version from '1.4' to '1.14'. * Python '2.7' is available when ` + # runtime_version` is set to '1.15' or earlier. Read more about the Python + # versions available for [each runtime version](/ml-engine/docs/runtime-version- + # list). # Corresponds to the JSON property `pythonVersion` # @return [String] attr_accessor :python_version - # Configuration for logging request-response pairs to a BigQuery table. - # Online prediction requests to a model version and the responses to these - # requests are converted to raw strings and saved to the specified BigQuery - # table. Logging is constrained by [BigQuery quotas and - # limits](/bigquery/quotas). If your project exceeds BigQuery quotas or limits, - # AI Platform Prediction does not log request-response pairs, but it continues - # to serve predictions. - # If you are using [continuous - # evaluation](/ml-engine/docs/continuous-evaluation/), you do not need to - # specify this configuration manually. Setting up continuous evaluation + # Configuration for logging request-response pairs to a BigQuery table. Online + # prediction requests to a model version and the responses to these requests are + # converted to raw strings and saved to the specified BigQuery table. Logging is + # constrained by [BigQuery quotas and limits](/bigquery/quotas). If your project + # exceeds BigQuery quotas or limits, AI Platform Prediction does not log request- + # response pairs, but it continues to serve predictions. If you are using [ + # continuous evaluation](/ml-engine/docs/continuous-evaluation/), you do not + # need to specify this configuration manually. Setting up continuous evaluation # automatically enables logging of request-response pairs. # Corresponds to the JSON property `requestLoggingConfig` # @return [Google::Apis::MlV1::GoogleCloudMlV1RequestLoggingConfig] attr_accessor :request_logging_config - # Required. The AI Platform runtime version to use for this deployment. - # For more information, see the - # [runtime version list](/ml-engine/docs/runtime-version-list) and - # [how to manage runtime versions](/ml-engine/docs/versioning). + # Required. The AI Platform runtime version to use for this deployment. For more + # information, see the [runtime version list](/ml-engine/docs/runtime-version- + # list) and [how to manage runtime versions](/ml-engine/docs/versioning). # Corresponds to the JSON property `runtimeVersion` # @return [String] attr_accessor :runtime_version @@ -3051,6 +2866,7 @@ module Google @create_time = args[:create_time] if args.key?(:create_time) @deployment_uri = args[:deployment_uri] if args.key?(:deployment_uri) @description = args[:description] if args.key?(:description) + @endpoints = args[:endpoints] if args.key?(:endpoints) @error_message = args[:error_message] if args.key?(:error_message) @etag = args[:etag] if args.key?(:etag) @explanation_config = args[:explanation_config] if args.key?(:explanation_config) @@ -3071,16 +2887,16 @@ module Google end end - # Attributes credit by computing the XRAI taking advantage - # of the model's fully differentiable structure. Refer to this paper for - # more details: https://arxiv.org/abs/1906.02825 - # Currently only implemented for models with natural image inputs. + # Attributes credit by computing the XRAI taking advantage of the model's fully + # differentiable structure. Refer to this paper for more details: https://arxiv. + # org/abs/1906.02825 Currently only implemented for models with natural image + # inputs. class GoogleCloudMlV1XraiAttribution include Google::Apis::Core::Hashable - # Number of steps for approximating the path integral. - # A good value to start is 50 and gradually increase until the - # sum to diff property is met within the desired error range. + # Number of steps for approximating the path integral. A good value to start is + # 50 and gradually increase until the sum to diff property is met within the + # desired error range. # Corresponds to the JSON property `numIntegralSteps` # @return [Fixnum] attr_accessor :num_integral_steps @@ -3095,53 +2911,21 @@ module Google end end - # Specifies the audit configuration for a service. - # The configuration determines which permission types are logged, and what - # identities, if any, are exempted from logging. - # An AuditConfig must have one or more AuditLogConfigs. - # If there are AuditConfigs for both `allServices` and a specific service, - # the union of the two AuditConfigs is used for that service: the log_types - # specified in each AuditConfig are enabled, and the exempted_members in each - # AuditLogConfig are exempted. - # Example Policy with multiple AuditConfigs: - # ` - # "audit_configs": [ - # ` - # "service": "allServices", - # "audit_log_configs": [ - # ` - # "log_type": "DATA_READ", - # "exempted_members": [ - # "user:jose@example.com" - # ] - # `, - # ` - # "log_type": "DATA_WRITE" - # `, - # ` - # "log_type": "ADMIN_READ" - # ` - # ] - # `, - # ` - # "service": "sampleservice.googleapis.com", - # "audit_log_configs": [ - # ` - # "log_type": "DATA_READ" - # `, - # ` - # "log_type": "DATA_WRITE", - # "exempted_members": [ - # "user:aliya@example.com" - # ] - # ` - # ] - # ` - # ] - # ` - # For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ - # logging. It also exempts jose@example.com from DATA_READ logging, and - # aliya@example.com from DATA_WRITE logging. + # Specifies the audit configuration for a service. The configuration determines + # which permission types are logged, and what identities, if any, are exempted + # from logging. An AuditConfig must have one or more AuditLogConfigs. If there + # are AuditConfigs for both `allServices` and a specific service, the union of + # the two AuditConfigs is used for that service: the log_types specified in each + # AuditConfig are enabled, and the exempted_members in each AuditLogConfig are + # exempted. Example Policy with multiple AuditConfigs: ` "audit_configs": [ ` " + # service": "allServices", "audit_log_configs": [ ` "log_type": "DATA_READ", " + # exempted_members": [ "user:jose@example.com" ] `, ` "log_type": "DATA_WRITE" `, + # ` "log_type": "ADMIN_READ" ` ] `, ` "service": "sampleservice.googleapis.com", + # "audit_log_configs": [ ` "log_type": "DATA_READ" `, ` "log_type": "DATA_WRITE" + # , "exempted_members": [ "user:aliya@example.com" ] ` ] ` ] ` For sampleservice, + # this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also + # exempts jose@example.com from DATA_READ logging, and aliya@example.com from + # DATA_WRITE logging. class GoogleIamV1AuditConfig include Google::Apis::Core::Hashable @@ -3150,9 +2934,9 @@ module Google # @return [Array] attr_accessor :audit_log_configs - # Specifies a service that will be enabled for audit logging. - # For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. - # `allServices` is a special value that covers all services. + # Specifies a service that will be enabled for audit logging. For example, ` + # storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special + # value that covers all services. # Corresponds to the JSON property `service` # @return [String] attr_accessor :service @@ -3168,28 +2952,15 @@ module Google end end - # Provides the configuration for logging a type of permissions. - # Example: - # ` - # "audit_log_configs": [ - # ` - # "log_type": "DATA_READ", - # "exempted_members": [ - # "user:jose@example.com" - # ] - # `, - # ` - # "log_type": "DATA_WRITE" - # ` - # ] - # ` - # This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting - # jose@example.com from DATA_READ logging. + # Provides the configuration for logging a type of permissions. Example: ` " + # audit_log_configs": [ ` "log_type": "DATA_READ", "exempted_members": [ "user: + # jose@example.com" ] `, ` "log_type": "DATA_WRITE" ` ] ` This enables ' + # DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from + # DATA_READ logging. class GoogleIamV1AuditLogConfig include Google::Apis::Core::Hashable - # Specifies the identities that do not cause logging for this type of - # permission. + # Specifies the identities that do not cause logging for this type of permission. # Follows the same format of Binding.members. # Corresponds to the JSON property `exemptedMembers` # @return [Array] @@ -3215,69 +2986,57 @@ module Google class GoogleIamV1Binding include Google::Apis::Core::Hashable - # Represents a textual expression in the Common Expression Language (CEL) - # syntax. CEL is a C-like expression language. The syntax and semantics of CEL - # are documented at https://github.com/google/cel-spec. - # Example (Comparison): - # title: "Summary size limit" - # description: "Determines if a summary is less than 100 chars" - # expression: "document.summary.size() < 100" - # Example (Equality): - # title: "Requestor is owner" - # description: "Determines if requestor is the document owner" - # expression: "document.owner == request.auth.claims.email" - # Example (Logic): - # title: "Public documents" - # description: "Determine whether the document should be publicly visible" - # expression: "document.type != 'private' && document.type != 'internal'" - # Example (Data Manipulation): - # title: "Notification string" - # description: "Create a notification string with a timestamp." - # expression: "'New message received at ' + string(document.create_time)" - # The exact variables and functions that may be referenced within an expression - # are determined by the service that evaluates it. See the service - # documentation for additional information. + # Represents a textual expression in the Common Expression Language (CEL) syntax. + # CEL is a C-like expression language. The syntax and semantics of CEL are + # documented at https://github.com/google/cel-spec. Example (Comparison): title: + # "Summary size limit" description: "Determines if a summary is less than 100 + # chars" expression: "document.summary.size() < 100" Example (Equality): title: " + # Requestor is owner" description: "Determines if requestor is the document + # owner" expression: "document.owner == request.auth.claims.email" Example ( + # Logic): title: "Public documents" description: "Determine whether the document + # should be publicly visible" expression: "document.type != 'private' && + # document.type != 'internal'" Example (Data Manipulation): title: "Notification + # string" description: "Create a notification string with a timestamp." + # expression: "'New message received at ' + string(document.create_time)" The + # exact variables and functions that may be referenced within an expression are + # determined by the service that evaluates it. See the service documentation for + # additional information. # Corresponds to the JSON property `condition` # @return [Google::Apis::MlV1::GoogleTypeExpr] attr_accessor :condition - # Specifies the identities requesting access for a Cloud Platform resource. - # `members` can have the following values: - # * `allUsers`: A special identifier that represents anyone who is - # on the internet; with or without a Google account. - # * `allAuthenticatedUsers`: A special identifier that represents anyone - # who is authenticated with a Google account or a service account. - # * `user:`emailid``: An email address that represents a specific Google - # account. For example, `alice@example.com` . - # * `serviceAccount:`emailid``: An email address that represents a service - # account. For example, `my-other-app@appspot.gserviceaccount.com`. - # * `group:`emailid``: An email address that represents a Google group. - # For example, `admins@example.com`. - # * `deleted:user:`emailid`?uid=`uniqueid``: An email address (plus unique - # identifier) representing a user that has been recently deleted. For - # example, `alice@example.com?uid=123456789012345678901`. If the user is - # recovered, this value reverts to `user:`emailid`` and the recovered user - # retains the role in the binding. - # * `deleted:serviceAccount:`emailid`?uid=`uniqueid``: An email address (plus - # unique identifier) representing a service account that has been recently - # deleted. For example, - # `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. - # If the service account is undeleted, this value reverts to - # `serviceAccount:`emailid`` and the undeleted service account retains the - # role in the binding. - # * `deleted:group:`emailid`?uid=`uniqueid``: An email address (plus unique - # identifier) representing a Google group that has been recently - # deleted. For example, `admins@example.com?uid=123456789012345678901`. If - # the group is recovered, this value reverts to `group:`emailid`` and the - # recovered group retains the role in the binding. - # * `domain:`domain``: The G Suite domain (primary) that represents all the - # users of that domain. For example, `google.com` or `example.com`. + # Specifies the identities requesting access for a Cloud Platform resource. ` + # members` can have the following values: * `allUsers`: A special identifier + # that represents anyone who is on the internet; with or without a Google + # account. * `allAuthenticatedUsers`: A special identifier that represents + # anyone who is authenticated with a Google account or a service account. * ` + # user:`emailid``: An email address that represents a specific Google account. + # For example, `alice@example.com` . * `serviceAccount:`emailid``: An email + # address that represents a service account. For example, `my-other-app@appspot. + # gserviceaccount.com`. * `group:`emailid``: An email address that represents a + # Google group. For example, `admins@example.com`. * `deleted:user:`emailid`?uid= + # `uniqueid``: An email address (plus unique identifier) representing a user + # that has been recently deleted. For example, `alice@example.com?uid= + # 123456789012345678901`. If the user is recovered, this value reverts to `user:` + # emailid`` and the recovered user retains the role in the binding. * `deleted: + # serviceAccount:`emailid`?uid=`uniqueid``: An email address (plus unique + # identifier) representing a service account that has been recently deleted. For + # example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. + # If the service account is undeleted, this value reverts to `serviceAccount:` + # emailid`` and the undeleted service account retains the role in the binding. * + # `deleted:group:`emailid`?uid=`uniqueid``: An email address (plus unique + # identifier) representing a Google group that has been recently deleted. For + # example, `admins@example.com?uid=123456789012345678901`. If the group is + # recovered, this value reverts to `group:`emailid`` and the recovered group + # retains the role in the binding. * `domain:`domain``: The G Suite domain ( + # primary) that represents all the users of that domain. For example, `google. + # com` or `example.com`. # Corresponds to the JSON property `members` # @return [Array] attr_accessor :members - # Role that is assigned to `members`. - # For example, `roles/viewer`, `roles/editor`, or `roles/owner`. + # Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor` + # , or `roles/owner`. # Corresponds to the JSON property `role` # @return [String] attr_accessor :role @@ -3295,66 +3054,32 @@ module Google end # An Identity and Access Management (IAM) policy, which specifies access - # controls for Google Cloud resources. - # A `Policy` is a collection of `bindings`. A `binding` binds one or more - # `members` to a single `role`. Members can be user accounts, service accounts, - # 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. - # 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": [ - # ` - # "role": "roles/resourcemanager.organizationAdmin", - # "members": [ - # "user:mike@example.com", - # "group:admins@example.com", - # "domain:google.com", - # "serviceAccount:my-project-id@appspot.gserviceaccount.com" - # ] - # `, - # ` - # "role": "roles/resourcemanager.organizationViewer", - # "members": [ - # "user:eve@example.com" - # ], - # "condition": ` - # "title": "expirable access", - # "description": "Does not grant access after Sep 2020", - # "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z') - # ", - # ` - # ` - # ], - # "etag": "BwWWja0YfJA=", - # "version": 3 - # ` - # **YAML example:** - # bindings: - # - members: - # - user:mike@example.com - # - group:admins@example.com - # - domain:google.com - # - serviceAccount:my-project-id@appspot.gserviceaccount.com - # role: roles/resourcemanager.organizationAdmin - # - members: - # - user:eve@example.com - # role: roles/resourcemanager.organizationViewer - # condition: - # title: expirable access - # description: Does not grant access after Sep 2020 - # expression: request.time < timestamp('2020-10-01T00:00:00.000Z') - # - etag: BwWWja0YfJA= - # - version: 3 - # For a description of IAM and its features, see the - # [IAM documentation](https://cloud.google.com/iam/docs/). + # controls for Google Cloud resources. A `Policy` is a collection of `bindings`. + # A `binding` binds one or more `members` to a single `role`. Members can be + # user accounts, service accounts, 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. 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": [ ` "role": "roles/ + # resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", " + # group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@ + # appspot.gserviceaccount.com" ] `, ` "role": "roles/resourcemanager. + # organizationViewer", "members": [ "user:eve@example.com" ], "condition": ` " + # title": "expirable access", "description": "Does not grant access after Sep + # 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", ` + # ` ], "etag": "BwWWja0YfJA=", "version": 3 ` **YAML example:** bindings: - + # members: - user:mike@example.com - group:admins@example.com - domain:google. + # com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/ + # resourcemanager.organizationAdmin - members: - user:eve@example.com role: + # roles/resourcemanager.organizationViewer condition: title: expirable access + # description: Does not grant access after Sep 2020 expression: request.time < + # timestamp('2020-10-01T00:00:00.000Z') - etag: BwWWja0YfJA= - version: 3 For a + # description of IAM and its features, see the [IAM documentation](https://cloud. + # google.com/iam/docs/). class GoogleIamV1Policy include Google::Apis::Core::Hashable @@ -3363,48 +3088,44 @@ module Google # @return [Array] attr_accessor :audit_configs - # Associates a list of `members` to a `role`. Optionally, may specify a - # `condition` that determines how and when the `bindings` are applied. Each - # of the `bindings` must contain at least one member. + # Associates a list of `members` to a `role`. Optionally, may specify a ` + # condition` that determines how and when the `bindings` are applied. Each of + # the `bindings` must contain at least one member. # Corresponds to the JSON property `bindings` # @return [Array] attr_accessor :bindings - # `etag` is used for optimistic concurrency control as a way to help - # prevent simultaneous updates of a policy from overwriting each other. - # It is strongly suggested that systems make use of the `etag` in the - # read-modify-write cycle to perform policy updates in order to avoid race - # conditions: An `etag` is returned in the response to `getIamPolicy`, and - # systems are expected to put that etag in the request to `setIamPolicy` to - # ensure that their change will be applied to the same version of the policy. - # **Important:** If you use IAM Conditions, you must include the `etag` field - # whenever you call `setIamPolicy`. If you omit this field, then IAM allows - # you to overwrite a version `3` policy with a version `1` policy, and all of - # the conditions in the version `3` policy are lost. + # `etag` is used for optimistic concurrency control as a way to help prevent + # simultaneous updates of a policy from overwriting each other. It is strongly + # suggested that systems make use of the `etag` in the read-modify-write cycle + # to perform policy updates in order to avoid race conditions: An `etag` is + # returned in the response to `getIamPolicy`, and systems are expected to put + # that etag in the request to `setIamPolicy` to ensure that their change will be + # applied to the same version of the policy. **Important:** If you use IAM + # Conditions, you must include the `etag` field whenever you call `setIamPolicy`. + # If you omit this field, then IAM allows you to overwrite a version `3` policy + # with a version `1` policy, and all of the conditions in the version `3` policy + # are lost. # Corresponds to the JSON property `etag` # NOTE: Values are automatically base64 encoded/decoded in the client library. # @return [String] attr_accessor :etag - # Specifies the format of the policy. - # Valid values are `0`, `1`, and `3`. Requests that specify an invalid value - # are rejected. - # Any operation that affects conditional role bindings must specify version - # `3`. This requirement applies to the following operations: - # * Getting a policy that includes a conditional role binding - # * Adding a conditional role binding to a policy - # * Changing a conditional role binding in a policy - # * Removing any role binding, with or without a condition, from a policy - # that includes conditions - # **Important:** If you use IAM Conditions, you must include the `etag` field - # whenever you call `setIamPolicy`. If you omit this field, then IAM allows - # you to overwrite a version `3` policy with a version `1` policy, and all of - # 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). + # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. + # Requests that specify an invalid value are rejected. Any operation that + # affects conditional role bindings must specify version `3`. This requirement + # applies to the following operations: * Getting a policy that includes a + # conditional role binding * Adding a conditional role binding to a policy * + # Changing a conditional role binding in a policy * Removing any role binding, + # with or without a condition, from a policy that includes conditions ** + # Important:** If you use IAM Conditions, you must include the `etag` field + # whenever you call `setIamPolicy`. If you omit this field, then IAM allows you + # to overwrite a version `3` policy with a version `1` policy, and all of 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 @@ -3427,74 +3148,39 @@ module Google include Google::Apis::Core::Hashable # An Identity and Access Management (IAM) policy, which specifies access - # controls for Google Cloud resources. - # A `Policy` is a collection of `bindings`. A `binding` binds one or more - # `members` to a single `role`. Members can be user accounts, service accounts, - # 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. - # 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": [ - # ` - # "role": "roles/resourcemanager.organizationAdmin", - # "members": [ - # "user:mike@example.com", - # "group:admins@example.com", - # "domain:google.com", - # "serviceAccount:my-project-id@appspot.gserviceaccount.com" - # ] - # `, - # ` - # "role": "roles/resourcemanager.organizationViewer", - # "members": [ - # "user:eve@example.com" - # ], - # "condition": ` - # "title": "expirable access", - # "description": "Does not grant access after Sep 2020", - # "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z') - # ", - # ` - # ` - # ], - # "etag": "BwWWja0YfJA=", - # "version": 3 - # ` - # **YAML example:** - # bindings: - # - members: - # - user:mike@example.com - # - group:admins@example.com - # - domain:google.com - # - serviceAccount:my-project-id@appspot.gserviceaccount.com - # role: roles/resourcemanager.organizationAdmin - # - members: - # - user:eve@example.com - # role: roles/resourcemanager.organizationViewer - # condition: - # title: expirable access - # description: Does not grant access after Sep 2020 - # expression: request.time < timestamp('2020-10-01T00:00:00.000Z') - # - etag: BwWWja0YfJA= - # - version: 3 - # For a description of IAM and its features, see the - # [IAM documentation](https://cloud.google.com/iam/docs/). + # controls for Google Cloud resources. A `Policy` is a collection of `bindings`. + # A `binding` binds one or more `members` to a single `role`. Members can be + # user accounts, service accounts, 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. 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": [ ` "role": "roles/ + # resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", " + # group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@ + # appspot.gserviceaccount.com" ] `, ` "role": "roles/resourcemanager. + # organizationViewer", "members": [ "user:eve@example.com" ], "condition": ` " + # title": "expirable access", "description": "Does not grant access after Sep + # 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", ` + # ` ], "etag": "BwWWja0YfJA=", "version": 3 ` **YAML example:** bindings: - + # members: - user:mike@example.com - group:admins@example.com - domain:google. + # com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/ + # resourcemanager.organizationAdmin - members: - user:eve@example.com role: + # roles/resourcemanager.organizationViewer condition: title: expirable access + # description: Does not grant access after Sep 2020 expression: request.time < + # timestamp('2020-10-01T00:00:00.000Z') - etag: BwWWja0YfJA= - version: 3 For a + # description of IAM and its features, see the [IAM documentation](https://cloud. + # google.com/iam/docs/). # Corresponds to the JSON property `policy` # @return [Google::Apis::MlV1::GoogleIamV1Policy] attr_accessor :policy # 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"` + # the fields in the mask will be modified. If no mask is provided, the following + # default mask is used: `paths: "bindings, etag"` # Corresponds to the JSON property `updateMask` # @return [String] attr_accessor :update_mask @@ -3514,10 +3200,9 @@ module Google class GoogleIamV1TestIamPermissionsRequest include Google::Apis::Core::Hashable - # The set of permissions to check for the `resource`. Permissions with - # wildcards (such as '*' or 'storage.*') are not allowed. For more - # information see - # [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions). + # The set of permissions to check for the `resource`. Permissions with wildcards + # (such as '*' or 'storage.*') are not allowed. For more information see [IAM + # Overview](https://cloud.google.com/iam/docs/overview#permissions). # Corresponds to the JSON property `permissions` # @return [Array] attr_accessor :permissions @@ -3536,8 +3221,7 @@ module Google class GoogleIamV1TestIamPermissionsResponse include Google::Apis::Core::Hashable - # A subset of `TestPermissionsRequest.permissions` that the caller is - # allowed. + # A subset of `TestPermissionsRequest.permissions` that the caller is allowed. # Corresponds to the JSON property `permissions` # @return [Array] attr_accessor :permissions @@ -3582,47 +3266,45 @@ module Google class GoogleLongrunningOperation include Google::Apis::Core::Hashable - # If the value is `false`, it means the operation is still in progress. - # If `true`, the operation is completed, and either `error` or `response` is - # available. + # If the value is `false`, it means the operation is still in progress. If `true` + # , the operation is completed, and either `error` or `response` is available. # Corresponds to the JSON property `done` # @return [Boolean] attr_accessor :done alias_method :done?, :done - # The `Status` type defines a logical error model that is suitable for - # different programming environments, including REST APIs and RPC APIs. It is - # used by [gRPC](https://github.com/grpc). Each `Status` message contains - # three pieces of data: error code, error message, and error details. - # You can find out more about this error model and how to work with it in the - # [API Design Guide](https://cloud.google.com/apis/design/errors). + # The `Status` type defines a logical error model that is suitable for different + # programming environments, including REST APIs and RPC APIs. It is used by [ + # gRPC](https://github.com/grpc). Each `Status` message contains three pieces of + # data: error code, error message, and error details. You can find out more + # about this error model and how to work with it in the [API Design Guide](https: + # //cloud.google.com/apis/design/errors). # Corresponds to the JSON property `error` # @return [Google::Apis::MlV1::GoogleRpcStatus] attr_accessor :error - # Service-specific metadata associated with the operation. It typically - # contains progress information and common metadata such as create time. - # Some services might not provide such metadata. Any method that returns a - # long-running operation should document the metadata type, if any. + # Service-specific metadata associated with the operation. It typically contains + # progress information and common metadata such as create time. Some services + # might not provide such metadata. Any method that returns a long-running + # operation should document the metadata type, if any. # Corresponds to the JSON property `metadata` # @return [Hash] attr_accessor :metadata # The server-assigned name, which is only unique within the same service that - # originally returns it. If you use the default HTTP mapping, the - # `name` should be a resource name ending with `operations/`unique_id``. + # originally returns it. If you use the default HTTP mapping, the `name` should + # be a resource name ending with `operations/`unique_id``. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name - # The normal response of the operation in case of success. If the original - # method returns no data on success, such as `Delete`, the response is - # `google.protobuf.Empty`. If the original method is standard - # `Get`/`Create`/`Update`, the response should be the resource. For other - # methods, the response should have the type `XxxResponse`, where `Xxx` - # is the original method name. For example, if the original method name - # is `TakeSnapshot()`, the inferred response type is - # `TakeSnapshotResponse`. + # The normal response of the operation in case of success. If the original + # method returns no data on success, such as `Delete`, the response is `google. + # protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, + # the response should be the resource. For other methods, the response should + # have the type `XxxResponse`, where `Xxx` is the original method name. For + # example, if the original method name is `TakeSnapshot()`, the inferred + # response type is `TakeSnapshotResponse`. # Corresponds to the JSON property `response` # @return [Hash] attr_accessor :response @@ -3641,13 +3323,11 @@ module Google end end - # A generic empty message that you can re-use to avoid defining duplicated - # empty messages in your APIs. A typical example is to use it as the request - # or the response type of an API method. For instance: - # service Foo ` - # rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); - # ` - # The JSON representation for `Empty` is empty JSON object ````. + # A generic empty message that you can re-use to avoid defining duplicated empty + # messages in your APIs. A typical example is to use it as the request or the + # response type of an API method. For instance: service Foo ` rpc Bar(google. + # protobuf.Empty) returns (google.protobuf.Empty); ` The JSON representation for + # `Empty` is empty JSON object ````. class GoogleProtobufEmpty include Google::Apis::Core::Hashable @@ -3660,12 +3340,12 @@ module Google end end - # The `Status` type defines a logical error model that is suitable for - # different programming environments, including REST APIs and RPC APIs. It is - # used by [gRPC](https://github.com/grpc). Each `Status` message contains - # three pieces of data: error code, error message, and error details. - # You can find out more about this error model and how to work with it in the - # [API Design Guide](https://cloud.google.com/apis/design/errors). + # The `Status` type defines a logical error model that is suitable for different + # programming environments, including REST APIs and RPC APIs. It is used by [ + # gRPC](https://github.com/grpc). Each `Status` message contains three pieces of + # data: error code, error message, and error details. You can find out more + # about this error model and how to work with it in the [API Design Guide](https: + # //cloud.google.com/apis/design/errors). class GoogleRpcStatus include Google::Apis::Core::Hashable @@ -3674,15 +3354,15 @@ module Google # @return [Fixnum] attr_accessor :code - # A list of messages that carry the error details. There is a common set of + # A list of messages that carry the error details. There is a common set of # message types for APIs to use. # Corresponds to the JSON property `details` # @return [Array>] attr_accessor :details - # A developer-facing error message, which should be in English. Any - # user-facing error message should be localized and sent in the - # google.rpc.Status.details field, or localized by the client. + # A developer-facing error message, which should be in English. Any user-facing + # error message should be localized and sent in the google.rpc.Status.details + # field, or localized by the client. # Corresponds to the JSON property `message` # @return [String] attr_accessor :message @@ -3699,52 +3379,43 @@ module Google end end - # Represents a textual expression in the Common Expression Language (CEL) - # syntax. CEL is a C-like expression language. The syntax and semantics of CEL - # are documented at https://github.com/google/cel-spec. - # Example (Comparison): - # title: "Summary size limit" - # description: "Determines if a summary is less than 100 chars" - # expression: "document.summary.size() < 100" - # Example (Equality): - # title: "Requestor is owner" - # description: "Determines if requestor is the document owner" - # expression: "document.owner == request.auth.claims.email" - # Example (Logic): - # title: "Public documents" - # description: "Determine whether the document should be publicly visible" - # expression: "document.type != 'private' && document.type != 'internal'" - # Example (Data Manipulation): - # title: "Notification string" - # description: "Create a notification string with a timestamp." - # expression: "'New message received at ' + string(document.create_time)" - # The exact variables and functions that may be referenced within an expression - # are determined by the service that evaluates it. See the service - # documentation for additional information. + # Represents a textual expression in the Common Expression Language (CEL) syntax. + # CEL is a C-like expression language. The syntax and semantics of CEL are + # documented at https://github.com/google/cel-spec. Example (Comparison): title: + # "Summary size limit" description: "Determines if a summary is less than 100 + # chars" expression: "document.summary.size() < 100" Example (Equality): title: " + # Requestor is owner" description: "Determines if requestor is the document + # owner" expression: "document.owner == request.auth.claims.email" Example ( + # Logic): title: "Public documents" description: "Determine whether the document + # should be publicly visible" expression: "document.type != 'private' && + # document.type != 'internal'" Example (Data Manipulation): title: "Notification + # string" description: "Create a notification string with a timestamp." + # expression: "'New message received at ' + string(document.create_time)" The + # exact variables and functions that may be referenced within an expression are + # determined by the service that evaluates it. See the service documentation for + # additional information. class GoogleTypeExpr include Google::Apis::Core::Hashable - # Optional. Description of the expression. This is a longer text which - # describes the expression, e.g. when hovered over it in a UI. + # Optional. Description of the expression. This is a longer text which describes + # the expression, e.g. when hovered over it in a UI. # Corresponds to the JSON property `description` # @return [String] attr_accessor :description - # Textual representation of an expression in Common Expression Language - # syntax. + # Textual representation of an expression in Common Expression Language syntax. # Corresponds to the JSON property `expression` # @return [String] attr_accessor :expression - # Optional. String indicating the location of the expression for error - # reporting, e.g. a file name and a position in the file. + # Optional. String indicating the location of the expression for error reporting, + # e.g. a file name and a position in the file. # Corresponds to the JSON property `location` # @return [String] attr_accessor :location - # Optional. Title for the expression, i.e. a short string describing - # its purpose. This can be used e.g. in UIs which allow to enter the - # expression. + # Optional. Title for the expression, i.e. a short string describing its purpose. + # This can be used e.g. in UIs which allow to enter the expression. # Corresponds to the JSON property `title` # @return [String] attr_accessor :title diff --git a/generated/google/apis/ml_v1/representations.rb b/generated/google/apis/ml_v1/representations.rb index 7cc52b368..eaec06969 100644 --- a/generated/google/apis/ml_v1/representations.rb +++ b/generated/google/apis/ml_v1/representations.rb @@ -190,6 +190,12 @@ module Google include Google::Apis::Core::JsonObjectSupport end + class GoogleCloudMlV1EndpointMap + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class GoogleCloudMlV1ExplainRequest class Representation < Google::Apis::Core::JsonRepresentation; end @@ -728,6 +734,15 @@ module Google end end + class GoogleCloudMlV1EndpointMap + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :explain, as: 'explain' + property :health, as: 'health' + property :predict, as: 'predict' + end + end + class GoogleCloudMlV1ExplainRequest # @private class Representation < Google::Apis::Core::JsonRepresentation @@ -1162,6 +1177,8 @@ module Google property :create_time, as: 'createTime' property :deployment_uri, as: 'deploymentUri' property :description, as: 'description' + property :endpoints, as: 'endpoints', class: Google::Apis::MlV1::GoogleCloudMlV1EndpointMap, decorator: Google::Apis::MlV1::GoogleCloudMlV1EndpointMap::Representation + property :error_message, as: 'errorMessage' property :etag, :base64 => true, as: 'etag' property :explanation_config, as: 'explanationConfig', class: Google::Apis::MlV1::GoogleCloudMlV1ExplanationConfig, decorator: Google::Apis::MlV1::GoogleCloudMlV1ExplanationConfig::Representation diff --git a/generated/google/apis/ml_v1/service.rb b/generated/google/apis/ml_v1/service.rb index e06604e6b..1b53c4a68 100644 --- a/generated/google/apis/ml_v1/service.rb +++ b/generated/google/apis/ml_v1/service.rb @@ -47,11 +47,11 @@ module Google @batch_path = 'batch' end - # Performs explanation on the data in the request. - #
`% dynamic include "/ai-platform/includes/___explain-request" %`
+ # Performs explanation on the data in the request. `% dynamic include "/ai- + # platform/includes/___explain-request" %` # @param [String] name - # Required. The resource name of a model or a version. - # Authorization: requires the `predict` permission on the specified resource. + # Required. The resource name of a model or a version. Authorization: requires + # the `predict` permission on the specified resource. # @param [Google::Apis::MlV1::GoogleCloudMlV1ExplainRequest] google_cloud_ml_v1__explain_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -83,9 +83,9 @@ module Google end # Get the service account information associated with your project. You need - # this information in order to grant the service account permissions for - # the Google Cloud Storage location where you put your model training code - # for training the model with Google Cloud Machine Learning. + # this information in order to grant the service account permissions for the + # Google Cloud Storage location where you put your model training code for + # training the model with Google Cloud Machine Learning. # @param [String] name # Required. The project name. # @param [String] fields @@ -115,11 +115,11 @@ module Google execute_or_queue_command(command, &block) end - # Performs online prediction on the data in the request. - #
`% dynamic include "/ai-platform/includes/___predict-request" %`
+ # Performs online prediction on the data in the request. `% dynamic include "/ai- + # platform/includes/___predict-request" %` # @param [String] name - # Required. The resource name of a model or a version. - # Authorization: requires the `predict` permission on the specified resource. + # Required. The resource name of a model or a version. Authorization: requires + # the `predict` permission on the specified resource. # @param [Google::Apis::MlV1::GoogleCloudMlV1PredictRequest] google_cloud_ml_v1__predict_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -246,22 +246,19 @@ module Google execute_or_queue_command(command, &block) end - # Gets the access control policy for a resource. - # Returns an empty policy if the resource exists and does not have a policy - # set. + # Gets the access control policy for a resource. Returns an empty policy if the + # resource exists and does not have a policy set. # @param [String] resource - # REQUIRED: The resource for which the policy is being requested. - # See the operation documentation for the appropriate value for this field. + # REQUIRED: The resource for which the policy is being requested. See the + # operation documentation for the appropriate value for this field. # @param [Fixnum] options_requested_policy_version - # Optional. The policy format version to be returned. - # Valid values are 0, 1, and 3. Requests specifying an invalid value will be - # rejected. - # 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). + # Optional. The policy format version to be returned. Valid values are 0, 1, and + # 3. Requests specifying an invalid value will be rejected. 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 @@ -290,30 +287,25 @@ module Google execute_or_queue_command(command, &block) end - # Lists the jobs in the project. - # If there are no jobs that match the request parameters, the list - # request returns an empty response body: ``. + # Lists the jobs in the project. If there are no jobs that match the request + # parameters, the list request returns an empty response body: ``. # @param [String] parent # Required. The name of the project for which to list jobs. # @param [String] filter - # Optional. Specifies the subset of jobs to retrieve. - # You can filter on the value of one or more attributes of the job object. - # For example, retrieve jobs with a job identifier that starts with 'census': - #

gcloud ai-platform jobs list --filter='jobId:census*' - #

List all failed jobs with names that start with 'rnn': - #

gcloud ai-platform jobs list --filter='jobId:rnn* - # AND state:FAILED' - #

For more examples, see the guide to - # monitoring jobs. + # Optional. Specifies the subset of jobs to retrieve. You can filter on the + # value of one or more attributes of the job object. For example, retrieve jobs + # with a job identifier that starts with 'census': gcloud ai-platform jobs list - + # -filter='jobId:census*' List all failed jobs with names that start with 'rnn': + # gcloud ai-platform jobs list --filter='jobId:rnn* AND state:FAILED' For more + # examples, see the guide to monitoring jobs. # @param [Fixnum] page_size - # Optional. The number of jobs to retrieve per "page" of results. If there - # are more remaining results than this number, the response message will - # contain a valid value in the `next_page_token` field. - # The default value is 20, and the maximum page size is 100. + # Optional. The number of jobs to retrieve per "page" of results. If there are + # more remaining results than this number, the response message will contain a + # valid value in the `next_page_token` field. The default value is 20, and the + # maximum page size is 100. # @param [String] page_token - # Optional. A page token to request the next page of results. - # You get the token from the `next_page_token` field of the response from - # the previous call. + # Optional. A page token to request the next page of results. You get the token + # from the `next_page_token` field of the response from the previous call. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -344,28 +336,20 @@ module Google execute_or_queue_command(command, &block) end - # Updates a specific job resource. - # Currently the only supported fields to update are `labels`. + # Updates a specific job resource. Currently the only supported fields to update + # are `labels`. # @param [String] name # Required. The job name. # @param [Google::Apis::MlV1::GoogleCloudMlV1Job] google_cloud_ml_v1__job_object # @param [String] update_mask - # Required. Specifies the path, relative to `Job`, of the field to update. - # To adopt etag mechanism, include `etag` field in the mask, and include the - # `etag` value in your job resource. - # For example, to change the labels of a job, the `update_mask` parameter - # would be specified as `labels`, `etag`, and the - # `PATCH` request body would specify the new value, as follows: - # ` - # "labels": ` - # "owner": "Google", - # "color": "Blue" - # ` - # "etag": "33a64df551425fcc55e4d42a148795d9f25f89d4" - # ` + # Required. Specifies the path, relative to `Job`, of the field to update. To + # adopt etag mechanism, include `etag` field in the mask, and include the `etag` + # value in your job resource. For example, to change the labels of a job, the ` + # update_mask` parameter would be specified as `labels`, `etag`, and the `PATCH` + # request body would specify the new value, as follows: ` "labels": ` "owner": " + # Google", "color": "Blue" ` "etag": "33a64df551425fcc55e4d42a148795d9f25f89d4" ` # If `etag` matches the one on the server, the labels of the job will be - # replaced with the given ones, and the server end `etag` will be - # recalculated. + # replaced with the given ones, and the server end `etag` will be recalculated. # Currently the only supported update masks are `labels` and `etag`. # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -398,11 +382,11 @@ module Google end # Sets the access control policy on the specified resource. Replaces any - # existing policy. - # Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors. + # existing policy. 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. + # REQUIRED: The resource for which the policy is being specified. See the + # operation documentation for the appropriate value for this field. # @param [Google::Apis::MlV1::GoogleIamV1SetIamPolicyRequest] google_iam_v1__set_iam_policy_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -433,15 +417,14 @@ module Google execute_or_queue_command(command, &block) end - # 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. - # 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. + # 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. 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. # @param [String] resource - # REQUIRED: The resource for which the policy detail is being requested. - # See the operation documentation for the appropriate value for this field. + # REQUIRED: The resource for which the policy detail is being requested. See the + # operation documentation for the appropriate value for this field. # @param [Google::Apis::MlV1::GoogleIamV1TestIamPermissionsRequest] google_iam_v1__test_iam_permissions_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -508,14 +491,13 @@ module Google # Required. The name of the project for which available locations are to be # listed (since some locations might be whitelisted for specific projects). # @param [Fixnum] page_size - # Optional. The number of locations to retrieve per "page" of results. If - # there are more remaining results than this number, the response message - # will contain a valid value in the `next_page_token` field. - # The default value is 20, and the maximum page size is 100. + # Optional. The number of locations to retrieve per "page" of results. If there + # are more remaining results than this number, the response message will contain + # a valid value in the `next_page_token` field. The default value is 20, and the + # maximum page size is 100. # @param [String] page_token - # Optional. A page token to request the next page of results. - # You get the token from the `next_page_token` field of the response from - # the previous call. + # Optional. A page token to request the next page of results. You get the token + # from the `next_page_token` field of the response from the previous call. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -545,15 +527,13 @@ module Google execute_or_queue_command(command, &block) end - # Starts asynchronous cancellation on a long-running operation. The server - # makes a best effort to cancel the operation, but success is not - # guaranteed. If the server doesn't support this method, it returns - # `google.rpc.Code.UNIMPLEMENTED`. Clients can use - # Operations.GetOperation or - # other methods to check whether the cancellation succeeded or whether the - # operation completed despite cancellation. On successful cancellation, - # the operation is not deleted; instead, it becomes an operation with - # an Operation.error value with a google.rpc.Status.code of 1, + # Starts asynchronous cancellation on a long-running operation. The server makes + # a best effort to cancel the operation, but success is not guaranteed. If the + # server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. + # Clients can use Operations.GetOperation or other methods to check whether the + # cancellation succeeded or whether the operation completed despite cancellation. + # On successful cancellation, the operation is not deleted; instead, it becomes + # an operation with an Operation.error value with a google.rpc.Status.code of 1, # corresponding to `Code.CANCELLED`. # @param [String] name # The name of the operation resource to be cancelled. @@ -584,9 +564,8 @@ module Google execute_or_queue_command(command, &block) end - # Gets the latest state of a long-running operation. Clients can use this - # method to poll the operation result at intervals as recommended by the API - # service. + # Gets the latest state of a long-running operation. Clients can use this method + # to poll the operation result at intervals as recommended by the API service. # @param [String] name # The name of the operation resource. # @param [String] fields @@ -618,13 +597,12 @@ module Google # Creates a study. # @param [String] parent - # Required. The project and location that the study belongs to. - # Format: projects/`project`/locations/`location` + # Required. The project and location that the study belongs to. Format: projects/ + # `project`/locations/`location` # @param [Google::Apis::MlV1::GoogleCloudMlV1Study] google_cloud_ml_v1__study_object # @param [String] study_id # Required. The ID to use for the study, which will become the final component - # of - # the study's resource name. + # of the study's resource name. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -717,8 +695,8 @@ module Google # Lists all the studies in a region for an associated project. # @param [String] parent - # Required. The project and location that the study belongs to. - # Format: projects/`project`/locations/`location` + # Required. The project and location that the study belongs to. Format: projects/ + # `project`/locations/`location` # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -746,8 +724,8 @@ module Google execute_or_queue_command(command, &block) end - # Adds a measurement of the objective metrics to a trial. This measurement - # is assumed to have been taken before the trial is complete. + # Adds a measurement of the objective metrics to a trial. This measurement is + # assumed to have been taken before the trial is complete. # @param [String] name # Required. The trial name. # @param [Google::Apis::MlV1::GoogleCloudMlV1AddTrialMeasurementRequest] google_cloud_ml_v1__add_trial_measurement_request_object @@ -780,9 +758,8 @@ module Google execute_or_queue_command(command, &block) end - # Checks whether a trial should stop or not. Returns a - # long-running operation. When the operation is successful, - # it will contain a + # Checks whether a trial should stop or not. Returns a long-running operation. + # When the operation is successful, it will contain a # CheckTrialEarlyStoppingStateResponse. # @param [String] name # Required. The trial name. @@ -1005,11 +982,10 @@ module Google execute_or_queue_command(command, &block) end - # Adds one or more trials to a study, with parameter values - # suggested by AI Platform Optimizer. Returns a long-running - # operation associated with the generation of trial suggestions. - # When this long-running operation succeeds, it will contain - # a SuggestTrialsResponse. + # Adds one or more trials to a study, with parameter values suggested by AI + # Platform Optimizer. Returns a long-running operation associated with the + # generation of trial suggestions. When this long-running operation succeeds, it + # will contain a SuggestTrialsResponse. # @param [String] parent # Required. The name of the study that the trial belongs to. # @param [Google::Apis::MlV1::GoogleCloudMlV1SuggestTrialsRequest] google_cloud_ml_v1__suggest_trials_request_object @@ -1042,10 +1018,9 @@ module Google execute_or_queue_command(command, &block) end - # Creates a model which will later contain one or more versions. - # You must add at least one version before you can request predictions from - # the model. Add versions by calling - # projects.models.versions.create. + # Creates a model which will later contain one or more versions. You must add at + # least one version before you can request predictions from the model. Add + # versions by calling projects.models.versions.create. # @param [String] parent # Required. The project name. # @param [Google::Apis::MlV1::GoogleCloudMlV1Model] google_cloud_ml_v1__model_object @@ -1078,10 +1053,8 @@ module Google execute_or_queue_command(command, &block) end - # Deletes a model. - # You can only delete a model if there are no versions in it. You can delete - # versions by calling - # projects.models.versions.delete. + # Deletes a model. You can only delete a model if there are no versions in it. + # You can delete versions by calling projects.models.versions.delete. # @param [String] name # Required. The name of the model. # @param [String] fields @@ -1111,9 +1084,9 @@ module Google execute_or_queue_command(command, &block) end - # Gets information about a model, including its name, the description (if - # set), and the default version (if at least one version of the model has - # been deployed). + # Gets information about a model, including its name, the description (if set), + # and the default version (if at least one version of the model has been + # deployed). # @param [String] name # Required. The name of the model. # @param [String] fields @@ -1143,22 +1116,19 @@ module Google execute_or_queue_command(command, &block) end - # Gets the access control policy for a resource. - # Returns an empty policy if the resource exists and does not have a policy - # set. + # Gets the access control policy for a resource. Returns an empty policy if the + # resource exists and does not have a policy set. # @param [String] resource - # REQUIRED: The resource for which the policy is being requested. - # See the operation documentation for the appropriate value for this field. + # REQUIRED: The resource for which the policy is being requested. See the + # operation documentation for the appropriate value for this field. # @param [Fixnum] options_requested_policy_version - # Optional. The policy format version to be returned. - # Valid values are 0, 1, and 3. Requests specifying an invalid value will be - # rejected. - # 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). + # Optional. The policy format version to be returned. Valid values are 0, 1, and + # 3. Requests specifying an invalid value will be rejected. 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 @@ -1187,24 +1157,21 @@ module Google execute_or_queue_command(command, &block) end - # Lists the models in a project. - # Each project can contain multiple models, and each model can have multiple - # versions. - # If there are no models that match the request parameters, the list request - # returns an empty response body: ``. + # Lists the models in a project. Each project can contain multiple models, and + # each model can have multiple versions. If there are no models that match the + # request parameters, the list request returns an empty response body: ``. # @param [String] parent # Required. The name of the project whose models are to be listed. # @param [String] filter # Optional. Specifies the subset of models to retrieve. # @param [Fixnum] page_size - # Optional. The number of models to retrieve per "page" of results. If there - # are more remaining results than this number, the response message will - # contain a valid value in the `next_page_token` field. - # The default value is 20, and the maximum page size is 100. + # Optional. The number of models to retrieve per "page" of results. If there are + # more remaining results than this number, the response message will contain a + # valid value in the `next_page_token` field. The default value is 20, and the + # maximum page size is 100. # @param [String] page_token - # Optional. A page token to request the next page of results. - # You get the token from the `next_page_token` field of the response from - # the previous call. + # Optional. A page token to request the next page of results. You get the token + # from the `next_page_token` field of the response from the previous call. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -1235,26 +1202,19 @@ module Google execute_or_queue_command(command, &block) end - # Updates a specific model resource. - # Currently the only supported fields to update are `description` and - # `default_version.name`. + # Updates a specific model resource. Currently the only supported fields to + # update are `description` and `default_version.name`. # @param [String] name # Required. The project name. # @param [Google::Apis::MlV1::GoogleCloudMlV1Model] google_cloud_ml_v1__model_object # @param [String] update_mask - # Required. Specifies the path, relative to `Model`, of the field to update. - # For example, to change the description of a model to "foo" and set its - # default version to "version_1", the `update_mask` parameter would be - # specified as `description`, `default_version.name`, and the `PATCH` - # request body would specify the new value, as follows: - # ` - # "description": "foo", - # "defaultVersion": ` - # "name":"version_1" - # ` - # ` - # Currently the supported update masks are `description` and - # `default_version.name`. + # Required. Specifies the path, relative to `Model`, of the field to update. For + # example, to change the description of a model to "foo" and set its default + # version to "version_1", the `update_mask` parameter would be specified as ` + # description`, `default_version.name`, and the `PATCH` request body would + # specify the new value, as follows: ` "description": "foo", "defaultVersion": ` + # "name":"version_1" ` ` Currently the supported update masks are `description` + # and `default_version.name`. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -1286,11 +1246,11 @@ module Google end # Sets the access control policy on the specified resource. Replaces any - # existing policy. - # Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors. + # existing policy. 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. + # REQUIRED: The resource for which the policy is being specified. See the + # operation documentation for the appropriate value for this field. # @param [Google::Apis::MlV1::GoogleIamV1SetIamPolicyRequest] google_iam_v1__set_iam_policy_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -1321,15 +1281,14 @@ module Google execute_or_queue_command(command, &block) end - # 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. - # 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. + # 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. 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. # @param [String] resource - # REQUIRED: The resource for which the policy detail is being requested. - # See the operation documentation for the appropriate value for this field. + # REQUIRED: The resource for which the policy detail is being requested. See the + # operation documentation for the appropriate value for this field. # @param [Google::Apis::MlV1::GoogleIamV1TestIamPermissionsRequest] google_iam_v1__test_iam_permissions_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -1360,13 +1319,12 @@ module Google execute_or_queue_command(command, &block) end - # Creates a new version of a model from a trained TensorFlow model. - # If the version created in the cloud by this call is the first deployed - # version of the specified model, it will be made the default version of the - # model. When you add a version to a model that already has one or more - # versions, the default version does not automatically change. If you want a - # new version to be the default, you must call - # projects.models.versions.setDefault. + # Creates a new version of a model from a trained TensorFlow model. If the + # version created in the cloud by this call is the first deployed version of the + # specified model, it will be made the default version of the model. When you + # add a version to a model that already has one or more versions, the default + # version does not automatically change. If you want a new version to be the + # default, you must call projects.models.versions.setDefault. # @param [String] parent # Required. The name of the model. # @param [Google::Apis::MlV1::GoogleCloudMlV1Version] google_cloud_ml_v1__version_object @@ -1399,15 +1357,13 @@ module Google execute_or_queue_command(command, &block) end - # Deletes a model version. - # Each model can have multiple versions deployed and in use at any given - # time. Use this method to remove a single version. - # Note: You cannot delete the version that is set as the default version - # of the model unless it is the only remaining version. + # Deletes a model version. Each model can have multiple versions deployed and in + # use at any given time. Use this method to remove a single version. Note: You + # cannot delete the version that is set as the default version of the model + # unless it is the only remaining version. # @param [String] name - # Required. The name of the version. You can get the names of all the - # versions of a model by calling - # projects.models.versions.list. + # Required. The name of the version. You can get the names of all the versions + # of a model by calling projects.models.versions.list. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -1435,11 +1391,9 @@ module Google execute_or_queue_command(command, &block) end - # Gets information about a model version. - # Models can have multiple versions. You can call - # projects.models.versions.list - # to get the same information that this method returns for all of the - # versions of a model. + # Gets information about a model version. Models can have multiple versions. You + # can call projects.models.versions.list to get the same information that this + # method returns for all of the versions of a model. # @param [String] name # Required. The name of the version. # @param [String] fields @@ -1469,25 +1423,23 @@ module Google execute_or_queue_command(command, &block) end - # Gets basic information about all the versions of a model. - # If you expect that a model has many versions, or if you need to handle - # only a limited number of results at a time, you can request that the list - # be retrieved in batches (called pages). - # If there are no versions that match the request parameters, the list - # request returns an empty response body: ``. + # Gets basic information about all the versions of a model. If you expect that a + # model has many versions, or if you need to handle only a limited number of + # results at a time, you can request that the list be retrieved in batches ( + # called pages). If there are no versions that match the request parameters, the + # list request returns an empty response body: ``. # @param [String] parent # Required. The name of the model for which to list the version. # @param [String] filter # Optional. Specifies the subset of versions to retrieve. # @param [Fixnum] page_size - # Optional. The number of versions to retrieve per "page" of results. If - # there are more remaining results than this number, the response message - # will contain a valid value in the `next_page_token` field. - # The default value is 20, and the maximum page size is 100. + # Optional. The number of versions to retrieve per "page" of results. If there + # are more remaining results than this number, the response message will contain + # a valid value in the `next_page_token` field. The default value is 20, and the + # maximum page size is 100. # @param [String] page_token - # Optional. A page token to request the next page of results. - # You get the token from the `next_page_token` field of the response from - # the previous call. + # Optional. A page token to request the next page of results. You get the token + # from the `next_page_token` field of the response from the previous call. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -1518,28 +1470,22 @@ module Google execute_or_queue_command(command, &block) end - # Updates the specified Version resource. - # Currently the only update-able fields are `description`, - # `requestLoggingConfig`, `autoScaling.minNodes`, and `manualScaling.nodes`. + # Updates the specified Version resource. Currently the only update-able fields + # are `description`, `requestLoggingConfig`, `autoScaling.minNodes`, and ` + # manualScaling.nodes`. # @param [String] name # Required. The name of the model. # @param [Google::Apis::MlV1::GoogleCloudMlV1Version] google_cloud_ml_v1__version_object # @param [String] update_mask - # Required. Specifies the path, relative to `Version`, of the field to - # update. Must be present and non-empty. - # For example, to change the description of a version to "foo", the - # `update_mask` parameter would be specified as `description`, and the - # `PATCH` request body would specify the new value, as follows: - # ``` - # ` - # "description": "foo" - # ` - # ``` - # Currently the only supported update mask fields are `description`, - # `requestLoggingConfig`, `autoScaling.minNodes`, and `manualScaling.nodes`. - # However, you can only update `manualScaling.nodes` if the version uses a - # [Compute Engine (N1) - # machine type](/ml-engine/docs/machine-types-online-prediction). + # Required. Specifies the path, relative to `Version`, of the field to update. + # Must be present and non-empty. For example, to change the description of a + # version to "foo", the `update_mask` parameter would be specified as ` + # description`, and the `PATCH` request body would specify the new value, as + # follows: ``` ` "description": "foo" ` ``` Currently the only supported update + # mask fields are `description`, `requestLoggingConfig`, `autoScaling.minNodes`, + # and `manualScaling.nodes`. However, you can only update `manualScaling.nodes` + # if the version uses a [Compute Engine (N1) machine type](/ml-engine/docs/ + # machine-types-online-prediction). # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -1570,16 +1516,15 @@ module Google execute_or_queue_command(command, &block) end - # Designates a version to be the default for the model. - # The default version is used for prediction requests made against the model - # that don't specify a version. - # The first version to be created for a model is automatically set as the - # default. You must make any subsequent changes to the default version + # Designates a version to be the default for the model. The default version is + # used for prediction requests made against the model that don't specify a + # version. The first version to be created for a model is automatically set as + # the default. You must make any subsequent changes to the default version # setting manually using this method. # @param [String] name - # Required. The name of the version to make the default for the model. You - # can get the names of all the versions of a model by calling - # projects.models.versions.list. + # Required. The name of the version to make the default for the model. You can + # get the names of all the versions of a model by calling projects.models. + # versions.list. # @param [Google::Apis::MlV1::GoogleCloudMlV1SetDefaultVersionRequest] google_cloud_ml_v1__set_default_version_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -1610,15 +1555,13 @@ module Google execute_or_queue_command(command, &block) end - # Starts asynchronous cancellation on a long-running operation. The server - # makes a best effort to cancel the operation, but success is not - # guaranteed. If the server doesn't support this method, it returns - # `google.rpc.Code.UNIMPLEMENTED`. Clients can use - # Operations.GetOperation or - # other methods to check whether the cancellation succeeded or whether the - # operation completed despite cancellation. On successful cancellation, - # the operation is not deleted; instead, it becomes an operation with - # an Operation.error value with a google.rpc.Status.code of 1, + # Starts asynchronous cancellation on a long-running operation. The server makes + # a best effort to cancel the operation, but success is not guaranteed. If the + # server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. + # Clients can use Operations.GetOperation or other methods to check whether the + # cancellation succeeded or whether the operation completed despite cancellation. + # On successful cancellation, the operation is not deleted; instead, it becomes + # an operation with an Operation.error value with a google.rpc.Status.code of 1, # corresponding to `Code.CANCELLED`. # @param [String] name # The name of the operation resource to be cancelled. @@ -1649,9 +1592,8 @@ module Google execute_or_queue_command(command, &block) end - # Gets the latest state of a long-running operation. Clients can use this - # method to poll the operation result at intervals as recommended by the API - # service. + # Gets the latest state of a long-running operation. Clients can use this method + # to poll the operation result at intervals as recommended by the API service. # @param [String] name # The name of the operation resource. # @param [String] fields @@ -1681,15 +1623,14 @@ module Google execute_or_queue_command(command, &block) end - # Lists operations that match the specified filter in the request. If the - # server doesn't support this method, it returns `UNIMPLEMENTED`. - # NOTE: the `name` binding allows API services to override the binding - # to use different resource name schemes, such as `users/*/operations`. To - # override the binding, API services can add a binding such as - # `"/v1/`name=users/*`/operations"` to their service configuration. - # For backwards compatibility, the default name includes the operations - # collection id, however overriding users must ensure the name binding - # is the parent resource, without the operations collection id. + # Lists operations that match the specified filter in the request. If the server + # doesn't support this method, it returns `UNIMPLEMENTED`. NOTE: the `name` + # binding allows API services to override the binding to use different resource + # name schemes, such as `users/*/operations`. To override the binding, API + # services can add a binding such as `"/v1/`name=users/*`/operations"` to their + # service configuration. For backwards compatibility, the default name includes + # the operations collection id, however overriding users must ensure the name + # binding is the parent resource, without the operations collection id. # @param [String] name # The name of the operation's parent resource. # @param [String] filter diff --git a/generated/google/apis/pubsub_v1.rb b/generated/google/apis/pubsub_v1.rb index 559dd647f..e37e15842 100644 --- a/generated/google/apis/pubsub_v1.rb +++ b/generated/google/apis/pubsub_v1.rb @@ -25,7 +25,7 @@ module Google # @see https://cloud.google.com/pubsub/docs module PubsubV1 VERSION = 'V1' - REVISION = '20200731' + REVISION = '20200807' # 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/pubsub_v1/classes.rb b/generated/google/apis/pubsub_v1/classes.rb index 4d83b6d92..e691e7fa4 100644 --- a/generated/google/apis/pubsub_v1/classes.rb +++ b/generated/google/apis/pubsub_v1/classes.rb @@ -27,8 +27,7 @@ module Google include Google::Apis::Core::Hashable # Required. The acknowledgment ID for the messages being acknowledged that was - # returned - # by the Pub/Sub system in the `Pull` response. Must not be empty. + # returned by the Pub/Sub system in the `Pull` response. Must not be empty. # Corresponds to the JSON property `ackIds` # @return [Array] attr_accessor :ack_ids @@ -47,69 +46,57 @@ module Google class Binding include Google::Apis::Core::Hashable - # Represents a textual expression in the Common Expression Language (CEL) - # syntax. CEL is a C-like expression language. The syntax and semantics of CEL - # are documented at https://github.com/google/cel-spec. - # Example (Comparison): - # title: "Summary size limit" - # description: "Determines if a summary is less than 100 chars" - # expression: "document.summary.size() < 100" - # Example (Equality): - # title: "Requestor is owner" - # description: "Determines if requestor is the document owner" - # expression: "document.owner == request.auth.claims.email" - # Example (Logic): - # title: "Public documents" - # description: "Determine whether the document should be publicly visible" - # expression: "document.type != 'private' && document.type != 'internal'" - # Example (Data Manipulation): - # title: "Notification string" - # description: "Create a notification string with a timestamp." - # expression: "'New message received at ' + string(document.create_time)" - # The exact variables and functions that may be referenced within an expression - # are determined by the service that evaluates it. See the service - # documentation for additional information. + # Represents a textual expression in the Common Expression Language (CEL) syntax. + # CEL is a C-like expression language. The syntax and semantics of CEL are + # documented at https://github.com/google/cel-spec. Example (Comparison): title: + # "Summary size limit" description: "Determines if a summary is less than 100 + # chars" expression: "document.summary.size() < 100" Example (Equality): title: " + # Requestor is owner" description: "Determines if requestor is the document + # owner" expression: "document.owner == request.auth.claims.email" Example ( + # Logic): title: "Public documents" description: "Determine whether the document + # should be publicly visible" expression: "document.type != 'private' && + # document.type != 'internal'" Example (Data Manipulation): title: "Notification + # string" description: "Create a notification string with a timestamp." + # expression: "'New message received at ' + string(document.create_time)" The + # exact variables and functions that may be referenced within an expression are + # determined by the service that evaluates it. See the service documentation for + # additional information. # Corresponds to the JSON property `condition` # @return [Google::Apis::PubsubV1::Expr] attr_accessor :condition - # Specifies the identities requesting access for a Cloud Platform resource. - # `members` can have the following values: - # * `allUsers`: A special identifier that represents anyone who is - # on the internet; with or without a Google account. - # * `allAuthenticatedUsers`: A special identifier that represents anyone - # who is authenticated with a Google account or a service account. - # * `user:`emailid``: An email address that represents a specific Google - # account. For example, `alice@example.com` . - # * `serviceAccount:`emailid``: An email address that represents a service - # account. For example, `my-other-app@appspot.gserviceaccount.com`. - # * `group:`emailid``: An email address that represents a Google group. - # For example, `admins@example.com`. - # * `deleted:user:`emailid`?uid=`uniqueid``: An email address (plus unique - # identifier) representing a user that has been recently deleted. For - # example, `alice@example.com?uid=123456789012345678901`. If the user is - # recovered, this value reverts to `user:`emailid`` and the recovered user - # retains the role in the binding. - # * `deleted:serviceAccount:`emailid`?uid=`uniqueid``: An email address (plus - # unique identifier) representing a service account that has been recently - # deleted. For example, - # `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. - # If the service account is undeleted, this value reverts to - # `serviceAccount:`emailid`` and the undeleted service account retains the - # role in the binding. - # * `deleted:group:`emailid`?uid=`uniqueid``: An email address (plus unique - # identifier) representing a Google group that has been recently - # deleted. For example, `admins@example.com?uid=123456789012345678901`. If - # the group is recovered, this value reverts to `group:`emailid`` and the - # recovered group retains the role in the binding. - # * `domain:`domain``: The G Suite domain (primary) that represents all the - # users of that domain. For example, `google.com` or `example.com`. + # Specifies the identities requesting access for a Cloud Platform resource. ` + # members` can have the following values: * `allUsers`: A special identifier + # that represents anyone who is on the internet; with or without a Google + # account. * `allAuthenticatedUsers`: A special identifier that represents + # anyone who is authenticated with a Google account or a service account. * ` + # user:`emailid``: An email address that represents a specific Google account. + # For example, `alice@example.com` . * `serviceAccount:`emailid``: An email + # address that represents a service account. For example, `my-other-app@appspot. + # gserviceaccount.com`. * `group:`emailid``: An email address that represents a + # Google group. For example, `admins@example.com`. * `deleted:user:`emailid`?uid= + # `uniqueid``: An email address (plus unique identifier) representing a user + # that has been recently deleted. For example, `alice@example.com?uid= + # 123456789012345678901`. If the user is recovered, this value reverts to `user:` + # emailid`` and the recovered user retains the role in the binding. * `deleted: + # serviceAccount:`emailid`?uid=`uniqueid``: An email address (plus unique + # identifier) representing a service account that has been recently deleted. For + # example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. + # If the service account is undeleted, this value reverts to `serviceAccount:` + # emailid`` and the undeleted service account retains the role in the binding. * + # `deleted:group:`emailid`?uid=`uniqueid``: An email address (plus unique + # identifier) representing a Google group that has been recently deleted. For + # example, `admins@example.com?uid=123456789012345678901`. If the group is + # recovered, this value reverts to `group:`emailid`` and the recovered group + # retains the role in the binding. * `domain:`domain``: The G Suite domain ( + # primary) that represents all the users of that domain. For example, `google. + # com` or `example.com`. # Corresponds to the JSON property `members` # @return [Array] attr_accessor :members - # Role that is assigned to `members`. - # For example, `roles/viewer`, `roles/editor`, or `roles/owner`. + # Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor` + # , or `roles/owner`. # Corresponds to the JSON property `role` # @return [String] attr_accessor :role @@ -130,21 +117,18 @@ module Google class CreateSnapshotRequest include Google::Apis::Core::Hashable - # See Creating and - # managing labels. + # See Creating and managing labels. # Corresponds to the JSON property `labels` # @return [Hash] attr_accessor :labels - # Required. The subscription whose backlog the snapshot retains. - # Specifically, the created snapshot is guaranteed to retain: - # (a) The existing backlog on the subscription. More precisely, this is - # defined as the messages in the subscription's backlog that are - # unacknowledged upon the successful completion of the - # `CreateSnapshot` request; as well as: - # (b) Any messages published to the subscription's topic following the - # successful completion of the CreateSnapshot request. - # Format is `projects/`project`/subscriptions/`sub``. + # Required. The subscription whose backlog the snapshot retains. Specifically, + # the created snapshot is guaranteed to retain: (a) The existing backlog on the + # subscription. More precisely, this is defined as the messages in the + # subscription's backlog that are unacknowledged upon the successful completion + # of the `CreateSnapshot` request; as well as: (b) Any messages published to the + # subscription's topic following the successful completion of the CreateSnapshot + # request. Format is `projects/`project`/subscriptions/`sub``. # Corresponds to the JSON property `subscription` # @return [String] attr_accessor :subscription @@ -160,10 +144,10 @@ module Google end end - # Dead lettering is done on a best effort basis. The same message might be - # dead lettered multiple times. - # If validation on any of the fields fails at subscription creation/updation, - # the create/update subscription request will fail. + # Dead lettering is done on a best effort basis. The same message might be dead + # lettered multiple times. If validation on any of the fields fails at + # subscription creation/updation, the create/update subscription request will + # fail. class DeadLetterPolicy include Google::Apis::Core::Hashable @@ -171,23 +155,20 @@ module Google # Format is `projects/`project`/topics/`topic``.The Cloud Pub/Sub service # account associated with the enclosing subscription's parent project (i.e., # service-`project_number`@gcp-sa-pubsub.iam.gserviceaccount.com) must have - # permission to Publish() to this topic. - # The operation will fail if the topic does not exist. - # Users should ensure that there is a subscription attached to this topic - # since messages published to a topic with no subscriptions are lost. + # permission to Publish() to this topic. The operation will fail if the topic + # does not exist. Users should ensure that there is a subscription attached to + # this topic since messages published to a topic with no subscriptions are lost. # Corresponds to the JSON property `deadLetterTopic` # @return [String] attr_accessor :dead_letter_topic # The maximum number of delivery attempts for any message. The value must be - # between 5 and 100. - # The number of delivery attempts is defined as 1 + (the sum of number of - # NACKs and number of times the acknowledgement deadline has been exceeded - # for the message). - # A NACK is any call to ModifyAckDeadline with a 0 deadline. Note that - # client libraries may automatically extend ack_deadlines. - # This field will be honored on a best effort basis. - # If this parameter is 0, a default value of 5 is used. + # between 5 and 100. The number of delivery attempts is defined as 1 + (the sum + # of number of NACKs and number of times the acknowledgement deadline has been + # exceeded for the message). A NACK is any call to ModifyAckDeadline with a 0 + # deadline. Note that client libraries may automatically extend ack_deadlines. + # This field will be honored on a best effort basis. If this parameter is 0, a + # default value of 5 is used. # Corresponds to the JSON property `maxDeliveryAttempts` # @return [Fixnum] attr_accessor :max_delivery_attempts @@ -203,8 +184,7 @@ module Google end end - # Response for the DetachSubscription method. - # Reserved for future use. + # Response for the DetachSubscription method. Reserved for future use. class DetachSubscriptionResponse include Google::Apis::Core::Hashable @@ -217,13 +197,11 @@ module Google end end - # A generic empty message that you can re-use to avoid defining duplicated - # empty messages in your APIs. A typical example is to use it as the request - # or the response type of an API method. For instance: - # service Foo ` - # rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); - # ` - # The JSON representation for `Empty` is empty JSON object ````. + # A generic empty message that you can re-use to avoid defining duplicated empty + # messages in your APIs. A typical example is to use it as the request or the + # response type of an API method. For instance: service Foo ` rpc Bar(google. + # protobuf.Empty) returns (google.protobuf.Empty); ` The JSON representation for + # `Empty` is empty JSON object ````. class Empty include Google::Apis::Core::Hashable @@ -241,12 +219,11 @@ module Google class ExpirationPolicy include Google::Apis::Core::Hashable - # Specifies the "time-to-live" duration for an associated resource. The - # resource expires if it is not active for a period of `ttl`. The definition - # of "activity" depends on the type of the associated resource. The minimum - # and maximum allowed values for `ttl` depend on the type of the associated - # resource, as well. If `ttl` is not set, the associated resource never - # expires. + # Specifies the "time-to-live" duration for an associated resource. The resource + # expires if it is not active for a period of `ttl`. The definition of "activity" + # depends on the type of the associated resource. The minimum and maximum + # allowed values for `ttl` depend on the type of the associated resource, as + # well. If `ttl` is not set, the associated resource never expires. # Corresponds to the JSON property `ttl` # @return [String] attr_accessor :ttl @@ -261,52 +238,43 @@ module Google end end - # Represents a textual expression in the Common Expression Language (CEL) - # syntax. CEL is a C-like expression language. The syntax and semantics of CEL - # are documented at https://github.com/google/cel-spec. - # Example (Comparison): - # title: "Summary size limit" - # description: "Determines if a summary is less than 100 chars" - # expression: "document.summary.size() < 100" - # Example (Equality): - # title: "Requestor is owner" - # description: "Determines if requestor is the document owner" - # expression: "document.owner == request.auth.claims.email" - # Example (Logic): - # title: "Public documents" - # description: "Determine whether the document should be publicly visible" - # expression: "document.type != 'private' && document.type != 'internal'" - # Example (Data Manipulation): - # title: "Notification string" - # description: "Create a notification string with a timestamp." - # expression: "'New message received at ' + string(document.create_time)" - # The exact variables and functions that may be referenced within an expression - # are determined by the service that evaluates it. See the service - # documentation for additional information. + # Represents a textual expression in the Common Expression Language (CEL) syntax. + # CEL is a C-like expression language. The syntax and semantics of CEL are + # documented at https://github.com/google/cel-spec. Example (Comparison): title: + # "Summary size limit" description: "Determines if a summary is less than 100 + # chars" expression: "document.summary.size() < 100" Example (Equality): title: " + # Requestor is owner" description: "Determines if requestor is the document + # owner" expression: "document.owner == request.auth.claims.email" Example ( + # Logic): title: "Public documents" description: "Determine whether the document + # should be publicly visible" expression: "document.type != 'private' && + # document.type != 'internal'" Example (Data Manipulation): title: "Notification + # string" description: "Create a notification string with a timestamp." + # expression: "'New message received at ' + string(document.create_time)" The + # exact variables and functions that may be referenced within an expression are + # determined by the service that evaluates it. See the service documentation for + # additional information. class Expr include Google::Apis::Core::Hashable - # Optional. Description of the expression. This is a longer text which - # describes the expression, e.g. when hovered over it in a UI. + # Optional. Description of the expression. This is a longer text which describes + # the expression, e.g. when hovered over it in a UI. # Corresponds to the JSON property `description` # @return [String] attr_accessor :description - # Textual representation of an expression in Common Expression Language - # syntax. + # Textual representation of an expression in Common Expression Language syntax. # Corresponds to the JSON property `expression` # @return [String] attr_accessor :expression - # Optional. String indicating the location of the expression for error - # reporting, e.g. a file name and a position in the file. + # Optional. String indicating the location of the expression for error reporting, + # e.g. a file name and a position in the file. # Corresponds to the JSON property `location` # @return [String] attr_accessor :location - # Optional. Title for the expression, i.e. a short string describing - # its purpose. This can be used e.g. in UIs which allow to enter the - # expression. + # Optional. Title for the expression, i.e. a short string describing its purpose. + # This can be used e.g. in UIs which allow to enter the expression. # Corresponds to the JSON property `title` # @return [String] attr_accessor :title @@ -328,8 +296,8 @@ module Google class ListSnapshotsResponse include Google::Apis::Core::Hashable - # If not empty, indicates that there may be more snapshot that match the - # request; this value should be passed in a new `ListSnapshotsRequest`. + # If not empty, indicates that there may be more snapshot that match the request; + # this value should be passed in a new `ListSnapshotsRequest`. # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token @@ -354,9 +322,9 @@ module Google class ListSubscriptionsResponse include Google::Apis::Core::Hashable - # If not empty, indicates that there may be more subscriptions that match - # the request; this value should be passed in a new - # `ListSubscriptionsRequest` to get more subscriptions. + # If not empty, indicates that there may be more subscriptions that match the + # request; this value should be passed in a new `ListSubscriptionsRequest` to + # get more subscriptions. # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token @@ -381,9 +349,9 @@ module Google class ListTopicSnapshotsResponse include Google::Apis::Core::Hashable - # If not empty, indicates that there may be more snapshots that match - # the request; this value should be passed in a new - # `ListTopicSnapshotsRequest` to get more snapshots. + # If not empty, indicates that there may be more snapshots that match the + # request; this value should be passed in a new `ListTopicSnapshotsRequest` to + # get more snapshots. # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token @@ -408,9 +376,9 @@ module Google class ListTopicSubscriptionsResponse include Google::Apis::Core::Hashable - # If not empty, indicates that there may be more subscriptions that match - # the request; this value should be passed in a new - # `ListTopicSubscriptionsRequest` to get more subscriptions. + # If not empty, indicates that there may be more subscriptions that match the + # request; this value should be passed in a new `ListTopicSubscriptionsRequest` + # to get more subscriptions. # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token @@ -435,8 +403,8 @@ module Google class ListTopicsResponse include Google::Apis::Core::Hashable - # If not empty, indicates that there may be more topics that match the - # request; this value should be passed in a new `ListTopicsRequest`. + # If not empty, indicates that there may be more topics that match the request; + # this value should be passed in a new `ListTopicsRequest`. # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token @@ -462,10 +430,10 @@ module Google include Google::Apis::Core::Hashable # A list of IDs of GCP regions where messages that are published to the topic - # may be persisted in storage. Messages published by publishers running in - # non-allowed GCP regions (or running outside of GCP altogether) will be - # routed for storage in one of the allowed regions. An empty list means that - # no regions are allowed, and is not a valid configuration. + # may be persisted in storage. Messages published by publishers running in non- + # allowed GCP regions (or running outside of GCP altogether) will be routed for + # storage in one of the allowed regions. An empty list means that no regions are + # allowed, and is not a valid configuration. # Corresponds to the JSON property `allowedPersistenceRegions` # @return [Array] attr_accessor :allowed_persistence_regions @@ -485,14 +453,13 @@ module Google include Google::Apis::Core::Hashable # Required. The new ack deadline with respect to the time this request was sent - # to - # the Pub/Sub system. For example, if the value is 10, the new - # ack deadline will expire 10 seconds after the `ModifyAckDeadline` call - # was made. Specifying zero might immediately make the message available for - # delivery to another subscriber client. This typically results in an - # increase in the rate of message redeliveries (that is, duplicates). - # The minimum deadline you can specify is 0 seconds. - # The maximum deadline you can specify is 600 seconds (10 minutes). + # to the Pub/Sub system. For example, if the value is 10, the new ack deadline + # will expire 10 seconds after the `ModifyAckDeadline` call was made. Specifying + # zero might immediately make the message available for delivery to another + # subscriber client. This typically results in an increase in the rate of + # message redeliveries (that is, duplicates). The minimum deadline you can + # specify is 0 seconds. The maximum deadline you can specify is 600 seconds (10 + # minutes). # Corresponds to the JSON property `ackDeadlineSeconds` # @return [Fixnum] attr_accessor :ack_deadline_seconds @@ -532,27 +499,25 @@ module Google end end - # Contains information needed for generating an - # [OpenID Connect - # token](https://developers.google.com/identity/protocols/OpenIDConnect). + # Contains information needed for generating an [OpenID Connect token](https:// + # developers.google.com/identity/protocols/OpenIDConnect). class OidcToken include Google::Apis::Core::Hashable - # Audience to be used when generating OIDC token. The audience claim - # identifies the recipients that the JWT is intended for. The audience - # value is a single case-sensitive string. Having multiple values (array) - # for the audience field is not supported. More info about the OIDC JWT - # token audience here: https://tools.ietf.org/html/rfc7519#section-4.1.3 - # Note: if not specified, the Push endpoint URL will be used. + # Audience to be used when generating OIDC token. The audience claim identifies + # the recipients that the JWT is intended for. The audience value is a single + # case-sensitive string. Having multiple values (array) for the audience field + # is not supported. More info about the OIDC JWT token audience here: https:// + # tools.ietf.org/html/rfc7519#section-4.1.3 Note: if not specified, the Push + # endpoint URL will be used. # Corresponds to the JSON property `audience` # @return [String] attr_accessor :audience - # [Service account - # email](https://cloud.google.com/iam/docs/service-accounts) - # to be used for generating the OIDC token. The caller (for - # CreateSubscription, UpdateSubscription, and ModifyPushConfig RPCs) must - # have the iam.serviceAccounts.actAs permission for the service account. + # [Service account email](https://cloud.google.com/iam/docs/service-accounts) to + # be used for generating the OIDC token. The caller (for CreateSubscription, + # UpdateSubscription, and ModifyPushConfig RPCs) must have the iam. + # serviceAccounts.actAs permission for the service account. # Corresponds to the JSON property `serviceAccountEmail` # @return [String] attr_accessor :service_account_email @@ -569,111 +534,73 @@ module Google end # An Identity and Access Management (IAM) policy, which specifies access - # controls for Google Cloud resources. - # A `Policy` is a collection of `bindings`. A `binding` binds one or more - # `members` to a single `role`. Members can be user accounts, service accounts, - # 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. - # 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": [ - # ` - # "role": "roles/resourcemanager.organizationAdmin", - # "members": [ - # "user:mike@example.com", - # "group:admins@example.com", - # "domain:google.com", - # "serviceAccount:my-project-id@appspot.gserviceaccount.com" - # ] - # `, - # ` - # "role": "roles/resourcemanager.organizationViewer", - # "members": [ - # "user:eve@example.com" - # ], - # "condition": ` - # "title": "expirable access", - # "description": "Does not grant access after Sep 2020", - # "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z') - # ", - # ` - # ` - # ], - # "etag": "BwWWja0YfJA=", - # "version": 3 - # ` - # **YAML example:** - # bindings: - # - members: - # - user:mike@example.com - # - group:admins@example.com - # - domain:google.com - # - serviceAccount:my-project-id@appspot.gserviceaccount.com - # role: roles/resourcemanager.organizationAdmin - # - members: - # - user:eve@example.com - # role: roles/resourcemanager.organizationViewer - # condition: - # title: expirable access - # description: Does not grant access after Sep 2020 - # expression: request.time < timestamp('2020-10-01T00:00:00.000Z') - # - etag: BwWWja0YfJA= - # - version: 3 - # For a description of IAM and its features, see the - # [IAM documentation](https://cloud.google.com/iam/docs/). + # controls for Google Cloud resources. A `Policy` is a collection of `bindings`. + # A `binding` binds one or more `members` to a single `role`. Members can be + # user accounts, service accounts, 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. 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": [ ` "role": "roles/ + # resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", " + # group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@ + # appspot.gserviceaccount.com" ] `, ` "role": "roles/resourcemanager. + # organizationViewer", "members": [ "user:eve@example.com" ], "condition": ` " + # title": "expirable access", "description": "Does not grant access after Sep + # 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", ` + # ` ], "etag": "BwWWja0YfJA=", "version": 3 ` **YAML example:** bindings: - + # members: - user:mike@example.com - group:admins@example.com - domain:google. + # com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/ + # resourcemanager.organizationAdmin - members: - user:eve@example.com role: + # roles/resourcemanager.organizationViewer condition: title: expirable access + # description: Does not grant access after Sep 2020 expression: request.time < + # timestamp('2020-10-01T00:00:00.000Z') - etag: BwWWja0YfJA= - version: 3 For a + # description of IAM and its features, see the [IAM documentation](https://cloud. + # google.com/iam/docs/). class Policy include Google::Apis::Core::Hashable - # Associates a list of `members` to a `role`. Optionally, may specify a - # `condition` that determines how and when the `bindings` are applied. Each - # of the `bindings` must contain at least one member. + # Associates a list of `members` to a `role`. Optionally, may specify a ` + # condition` that determines how and when the `bindings` are applied. Each of + # the `bindings` must contain at least one member. # Corresponds to the JSON property `bindings` # @return [Array] attr_accessor :bindings - # `etag` is used for optimistic concurrency control as a way to help - # prevent simultaneous updates of a policy from overwriting each other. - # It is strongly suggested that systems make use of the `etag` in the - # read-modify-write cycle to perform policy updates in order to avoid race - # conditions: An `etag` is returned in the response to `getIamPolicy`, and - # systems are expected to put that etag in the request to `setIamPolicy` to - # ensure that their change will be applied to the same version of the policy. - # **Important:** If you use IAM Conditions, you must include the `etag` field - # whenever you call `setIamPolicy`. If you omit this field, then IAM allows - # you to overwrite a version `3` policy with a version `1` policy, and all of - # the conditions in the version `3` policy are lost. + # `etag` is used for optimistic concurrency control as a way to help prevent + # simultaneous updates of a policy from overwriting each other. It is strongly + # suggested that systems make use of the `etag` in the read-modify-write cycle + # to perform policy updates in order to avoid race conditions: An `etag` is + # returned in the response to `getIamPolicy`, and systems are expected to put + # that etag in the request to `setIamPolicy` to ensure that their change will be + # applied to the same version of the policy. **Important:** If you use IAM + # Conditions, you must include the `etag` field whenever you call `setIamPolicy`. + # If you omit this field, then IAM allows you to overwrite a version `3` policy + # with a version `1` policy, and all of the conditions in the version `3` policy + # are lost. # Corresponds to the JSON property `etag` # NOTE: Values are automatically base64 encoded/decoded in the client library. # @return [String] attr_accessor :etag - # Specifies the format of the policy. - # Valid values are `0`, `1`, and `3`. Requests that specify an invalid value - # are rejected. - # Any operation that affects conditional role bindings must specify version - # `3`. This requirement applies to the following operations: - # * Getting a policy that includes a conditional role binding - # * Adding a conditional role binding to a policy - # * Changing a conditional role binding in a policy - # * Removing any role binding, with or without a condition, from a policy - # that includes conditions - # **Important:** If you use IAM Conditions, you must include the `etag` field - # whenever you call `setIamPolicy`. If you omit this field, then IAM allows - # you to overwrite a version `3` policy with a version `1` policy, and all of - # 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). + # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. + # Requests that specify an invalid value are rejected. Any operation that + # affects conditional role bindings must specify version `3`. This requirement + # applies to the following operations: * Getting a policy that includes a + # conditional role binding * Adding a conditional role binding to a policy * + # Changing a conditional role binding in a policy * Removing any role binding, + # with or without a condition, from a policy that includes conditions ** + # Important:** If you use IAM Conditions, you must include the `etag` field + # whenever you call `setIamPolicy`. If you omit this field, then IAM allows you + # to overwrite a version `3` policy with a version `1` policy, and all of 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 @@ -713,9 +640,8 @@ module Google class PublishResponse include Google::Apis::Core::Hashable - # The server-assigned ID of each published message, in the same order as - # the messages in the request. IDs are guaranteed to be unique within - # the topic. + # The server-assigned ID of each published message, in the same order as the + # messages in the request. IDs are guaranteed to be unique within the topic. # Corresponds to the JSON property `messageIds` # @return [Array] attr_accessor :message_ids @@ -732,24 +658,22 @@ module Google # A message that is published by publishers and consumed by subscribers. The # message must contain either a non-empty data field or at least one attribute. - # Note that client libraries represent this object differently - # depending on the language. See the corresponding [client library - # documentation](https://cloud.google.com/pubsub/docs/reference/libraries) for - # more information. See [quotas and limits] - # (https://cloud.google.com/pubsub/quotas) for more information about message - # limits. + # Note that client libraries represent this object differently depending on the + # language. See the corresponding [client library documentation](https://cloud. + # google.com/pubsub/docs/reference/libraries) for more information. See [quotas + # and limits] (https://cloud.google.com/pubsub/quotas) for more information + # about message limits. class Message include Google::Apis::Core::Hashable - # Attributes for this message. If this field is empty, the message must - # contain non-empty data. This can be used to filter messages on the - # subscription. + # Attributes for this message. If this field is empty, the message must contain + # non-empty data. This can be used to filter messages on the subscription. # Corresponds to the JSON property `attributes` # @return [Hash] attr_accessor :attributes - # The message data field. If this field is empty, the message must contain - # at least one attribute. + # The message data field. If this field is empty, the message must contain at + # least one attribute. # Corresponds to the JSON property `data` # NOTE: Values are automatically base64 encoded/decoded in the client library. # @return [String] @@ -766,16 +690,16 @@ module Google # If non-empty, identifies related messages for which publish order should be # respected. If a `Subscription` has `enable_message_ordering` set to `true`, # messages published with the same non-empty `ordering_key` value will be - # delivered to subscribers in the order in which they are received by the - # Pub/Sub system. All `PubsubMessage`s published in a given `PublishRequest` - # must specify the same `ordering_key` value. + # delivered to subscribers in the order in which they are received by the Pub/ + # Sub system. All `PubsubMessage`s published in a given `PublishRequest` must + # specify the same `ordering_key` value. # Corresponds to the JSON property `orderingKey` # @return [String] attr_accessor :ordering_key - # The time at which the message was published, populated by the server when - # it receives the `Publish` call. It must not be populated by the - # publisher in a `Publish` call. + # The time at which the message was published, populated by the server when it + # receives the `Publish` call. It must not be populated by the publisher in a ` + # Publish` call. # Corresponds to the JSON property `publishTime` # @return [String] attr_accessor :publish_time @@ -806,13 +730,12 @@ module Google attr_accessor :max_messages # Optional. If this field set to true, the system will respond immediately even - # if - # it there are no messages available to return in the `Pull` response. - # Otherwise, the system may wait (for a bounded amount of time) until at - # least one message is available, rather than returning no messages. Warning: - # setting this field to `true` is discouraged because it adversely impacts - # the performance of `Pull` operations. We recommend that users do not set - # this field. + # if it there are no messages available to return in the `Pull` response. + # Otherwise, the system may wait (for a bounded amount of time) until at least + # one message is available, rather than returning no messages. Warning: setting + # this field to `true` is discouraged because it adversely impacts the + # performance of `Pull` operations. We recommend that users do not set this + # field. # Corresponds to the JSON property `returnImmediately` # @return [Boolean] attr_accessor :return_immediately @@ -856,34 +779,30 @@ module Google include Google::Apis::Core::Hashable # Endpoint configuration attributes that can be used to control different - # aspects of the message delivery. - # The only currently supported attribute is `x-goog-version`, which you can - # use to change the format of the pushed message. This attribute - # indicates the version of the data expected by the endpoint. This - # controls the shape of the pushed message (i.e., its fields and metadata). - # If not present during the `CreateSubscription` call, it will default to - # the version of the Pub/Sub API used to make such call. If not present in a - # `ModifyPushConfig` call, its value will not be changed. `GetSubscription` - # calls will always return a valid version, even if the subscription was - # created without this attribute. - # The only supported values for the `x-goog-version` attribute are: - # * `v1beta1`: uses the push format defined in the v1beta1 Pub/Sub API. - # * `v1` or `v1beta2`: uses the push format defined in the v1 Pub/Sub API. - # For example: - # 

attributes ` "x-goog-version": "v1" `
+ # aspects of the message delivery. The only currently supported attribute is `x- + # goog-version`, which you can use to change the format of the pushed message. + # This attribute indicates the version of the data expected by the endpoint. + # This controls the shape of the pushed message (i.e., its fields and metadata). + # If not present during the `CreateSubscription` call, it will default to the + # version of the Pub/Sub API used to make such call. If not present in a ` + # ModifyPushConfig` call, its value will not be changed. `GetSubscription` calls + # will always return a valid version, even if the subscription was created + # without this attribute. The only supported values for the `x-goog-version` + # attribute are: * `v1beta1`: uses the push format defined in the v1beta1 Pub/ + # Sub API. * `v1` or `v1beta2`: uses the push format defined in the v1 Pub/Sub + # API. For example: attributes ` "x-goog-version": "v1" ` # Corresponds to the JSON property `attributes` # @return [Hash] attr_accessor :attributes - # Contains information needed for generating an - # [OpenID Connect - # token](https://developers.google.com/identity/protocols/OpenIDConnect). + # Contains information needed for generating an [OpenID Connect token](https:// + # developers.google.com/identity/protocols/OpenIDConnect). # Corresponds to the JSON property `oidcToken` # @return [Google::Apis::PubsubV1::OidcToken] attr_accessor :oidc_token - # A URL locating the endpoint to which messages should be pushed. - # For example, a Webhook endpoint might use `https://example.com/push`. + # A URL locating the endpoint to which messages should be pushed. For example, a + # Webhook endpoint might use `https://example.com/push`. # Corresponds to the JSON property `pushEndpoint` # @return [String] attr_accessor :push_endpoint @@ -910,29 +829,26 @@ module Google attr_accessor :ack_id # The approximate number of times that Cloud Pub/Sub has attempted to deliver - # the associated message to a subscriber. - # More precisely, this is 1 + (number of NACKs) + - # (number of ack_deadline exceeds) for this message. - # A NACK is any call to ModifyAckDeadline with a 0 deadline. An ack_deadline - # exceeds event is whenever a message is not acknowledged within - # ack_deadline. Note that ack_deadline is initially - # Subscription.ackDeadlineSeconds, but may get extended automatically by - # the client library. - # Upon the first delivery of a given message, `delivery_attempt` will have a - # value of 1. The value is calculated at best effort and is approximate. - # If a DeadLetterPolicy is not set on the subscription, this will be 0. + # the associated message to a subscriber. More precisely, this is 1 + (number of + # NACKs) + (number of ack_deadline exceeds) for this message. A NACK is any call + # to ModifyAckDeadline with a 0 deadline. An ack_deadline exceeds event is + # whenever a message is not acknowledged within ack_deadline. Note that + # ack_deadline is initially Subscription.ackDeadlineSeconds, but may get + # extended automatically by the client library. Upon the first delivery of a + # given message, `delivery_attempt` will have a value of 1. The value is + # calculated at best effort and is approximate. If a DeadLetterPolicy is not set + # on the subscription, this will be 0. # Corresponds to the JSON property `deliveryAttempt` # @return [Fixnum] attr_accessor :delivery_attempt # A message that is published by publishers and consumed by subscribers. The # message must contain either a non-empty data field or at least one attribute. - # Note that client libraries represent this object differently - # depending on the language. See the corresponding [client library - # documentation](https://cloud.google.com/pubsub/docs/reference/libraries) for - # more information. See [quotas and limits] - # (https://cloud.google.com/pubsub/quotas) for more information about message - # limits. + # Note that client libraries represent this object differently depending on the + # language. See the corresponding [client library documentation](https://cloud. + # google.com/pubsub/docs/reference/libraries) for more information. See [quotas + # and limits] (https://cloud.google.com/pubsub/quotas) for more information + # about message limits. # Corresponds to the JSON property `message` # @return [Google::Apis::PubsubV1::Message] attr_accessor :message @@ -949,25 +865,24 @@ module Google end end - # A policy that specifies how Cloud Pub/Sub retries message delivery. - # Retry delay will be exponential based on provided minimum and maximum - # backoffs. https://en.wikipedia.org/wiki/Exponential_backoff. - # RetryPolicy will be triggered on NACKs or acknowledgement deadline exceeded - # events for a given message. - # Retry Policy is implemented on a best effort basis. At times, the delay - # between consecutive deliveries may not match the configuration. That is, + # A policy that specifies how Cloud Pub/Sub retries message delivery. Retry + # delay will be exponential based on provided minimum and maximum backoffs. + # https://en.wikipedia.org/wiki/Exponential_backoff. RetryPolicy will be + # triggered on NACKs or acknowledgement deadline exceeded events for a given + # message. Retry Policy is implemented on a best effort basis. At times, the + # delay between consecutive deliveries may not match the configuration. That is, # delay can be more or less than configured backoff. class RetryPolicy include Google::Apis::Core::Hashable - # The maximum delay between consecutive deliveries of a given message. - # Value should be between 0 and 600 seconds. Defaults to 600 seconds. + # The maximum delay between consecutive deliveries of a given message. Value + # should be between 0 and 600 seconds. Defaults to 600 seconds. # Corresponds to the JSON property `maximumBackoff` # @return [String] attr_accessor :maximum_backoff - # The minimum delay between consecutive deliveries of a given message. - # Value should be between 0 and 600 seconds. Defaults to 10 seconds. + # The minimum delay between consecutive deliveries of a given message. Value + # should be between 0 and 600 seconds. Defaults to 10 seconds. # Corresponds to the JSON property `minimumBackoff` # @return [String] attr_accessor :minimum_backoff @@ -987,24 +902,21 @@ module Google class SeekRequest include Google::Apis::Core::Hashable - # The snapshot to seek to. The snapshot's topic must be the same as that of - # the provided subscription. - # Format is `projects/`project`/snapshots/`snap``. + # The snapshot to seek to. The snapshot's topic must be the same as that of the + # provided subscription. Format is `projects/`project`/snapshots/`snap``. # Corresponds to the JSON property `snapshot` # @return [String] attr_accessor :snapshot - # The time to seek to. - # Messages retained in the subscription that were published before this - # time are marked as acknowledged, and messages retained in the - # subscription that were published after this time are marked as - # unacknowledged. Note that this operation affects only those messages - # retained in the subscription (configured by the combination of - # `message_retention_duration` and `retain_acked_messages`). For example, - # if `time` corresponds to a point before the message retention - # window (or to a point before the system's notion of the subscription - # creation time), only retained messages will be marked as unacknowledged, - # and already-expunged messages will not be restored. + # The time to seek to. Messages retained in the subscription that were published + # before this time are marked as acknowledged, and messages retained in the + # subscription that were published after this time are marked as unacknowledged. + # Note that this operation affects only those messages retained in the + # subscription (configured by the combination of `message_retention_duration` + # and `retain_acked_messages`). For example, if `time` corresponds to a point + # before the message retention window (or to a point before the system's notion + # of the subscription creation time), only retained messages will be marked as + # unacknowledged, and already-expunged messages will not be restored. # Corresponds to the JSON property `time` # @return [String] attr_accessor :time @@ -1038,66 +950,32 @@ module Google include Google::Apis::Core::Hashable # An Identity and Access Management (IAM) policy, which specifies access - # controls for Google Cloud resources. - # A `Policy` is a collection of `bindings`. A `binding` binds one or more - # `members` to a single `role`. Members can be user accounts, service accounts, - # 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. - # 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": [ - # ` - # "role": "roles/resourcemanager.organizationAdmin", - # "members": [ - # "user:mike@example.com", - # "group:admins@example.com", - # "domain:google.com", - # "serviceAccount:my-project-id@appspot.gserviceaccount.com" - # ] - # `, - # ` - # "role": "roles/resourcemanager.organizationViewer", - # "members": [ - # "user:eve@example.com" - # ], - # "condition": ` - # "title": "expirable access", - # "description": "Does not grant access after Sep 2020", - # "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z') - # ", - # ` - # ` - # ], - # "etag": "BwWWja0YfJA=", - # "version": 3 - # ` - # **YAML example:** - # bindings: - # - members: - # - user:mike@example.com - # - group:admins@example.com - # - domain:google.com - # - serviceAccount:my-project-id@appspot.gserviceaccount.com - # role: roles/resourcemanager.organizationAdmin - # - members: - # - user:eve@example.com - # role: roles/resourcemanager.organizationViewer - # condition: - # title: expirable access - # description: Does not grant access after Sep 2020 - # expression: request.time < timestamp('2020-10-01T00:00:00.000Z') - # - etag: BwWWja0YfJA= - # - version: 3 - # For a description of IAM and its features, see the - # [IAM documentation](https://cloud.google.com/iam/docs/). + # controls for Google Cloud resources. A `Policy` is a collection of `bindings`. + # A `binding` binds one or more `members` to a single `role`. Members can be + # user accounts, service accounts, 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. 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": [ ` "role": "roles/ + # resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", " + # group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@ + # appspot.gserviceaccount.com" ] `, ` "role": "roles/resourcemanager. + # organizationViewer", "members": [ "user:eve@example.com" ], "condition": ` " + # title": "expirable access", "description": "Does not grant access after Sep + # 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", ` + # ` ], "etag": "BwWWja0YfJA=", "version": 3 ` **YAML example:** bindings: - + # members: - user:mike@example.com - group:admins@example.com - domain:google. + # com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/ + # resourcemanager.organizationAdmin - members: - user:eve@example.com role: + # roles/resourcemanager.organizationViewer condition: title: expirable access + # description: Does not grant access after Sep 2020 expression: request.time < + # timestamp('2020-10-01T00:00:00.000Z') - etag: BwWWja0YfJA= - version: 3 For a + # description of IAM and its features, see the [IAM documentation](https://cloud. + # google.com/iam/docs/). # Corresponds to the JSON property `policy` # @return [Google::Apis::PubsubV1::Policy] attr_accessor :policy @@ -1112,30 +990,29 @@ module Google end end - # A snapshot resource. Snapshots are used in - # [Seek](https://cloud.google.com/pubsub/docs/replay-overview) - # operations, which allow you to manage message acknowledgments in bulk. That - # is, you can set the acknowledgment state of messages in an existing - # subscription to the state captured by a snapshot. + # A snapshot resource. Snapshots are used in [Seek](https://cloud.google.com/ + # pubsub/docs/replay-overview) operations, which allow you to manage message + # acknowledgments in bulk. That is, you can set the acknowledgment state of + # messages in an existing subscription to the state captured by a snapshot. class Snapshot include Google::Apis::Core::Hashable - # The snapshot is guaranteed to exist up until this time. - # A newly-created snapshot expires no later than 7 days from the time of its - # creation. Its exact lifetime is determined at creation by the existing - # backlog in the source subscription. Specifically, the lifetime of the - # snapshot is `7 days - (age of oldest unacked message in the subscription)`. - # For example, consider a subscription whose oldest unacked message is 3 days - # old. If a snapshot is created from this subscription, the snapshot -- which - # will always capture this 3-day-old backlog as long as the snapshot - # exists -- will expire in 4 days. The service will refuse to create a - # snapshot that would expire in less than 1 hour after creation. + # The snapshot is guaranteed to exist up until this time. A newly-created + # snapshot expires no later than 7 days from the time of its creation. Its exact + # lifetime is determined at creation by the existing backlog in the source + # subscription. Specifically, the lifetime of the snapshot is `7 days - (age of + # oldest unacked message in the subscription)`. For example, consider a + # subscription whose oldest unacked message is 3 days old. If a snapshot is + # created from this subscription, the snapshot -- which will always capture this + # 3-day-old backlog as long as the snapshot exists -- will expire in 4 days. The + # service will refuse to create a snapshot that would expire in less than 1 hour + # after creation. # Corresponds to the JSON property `expireTime` # @return [String] attr_accessor :expire_time - # See [Creating and managing labels] - # (https://cloud.google.com/pubsub/docs/labels). + # See [Creating and managing labels] (https://cloud.google.com/pubsub/docs/ + # labels). # Corresponds to the JSON property `labels` # @return [Hash] attr_accessor :labels @@ -1167,49 +1044,46 @@ module Google class Subscription include Google::Apis::Core::Hashable - # The approximate amount of time (on a best-effort basis) Pub/Sub waits for - # the subscriber to acknowledge receipt before resending the message. In the - # interval after the message is delivered and before it is acknowledged, it - # is considered to be outstanding. During that time period, the - # message will not be redelivered (on a best-effort basis). - # For pull subscriptions, this value is used as the initial value for the ack - # deadline. To override this value for a given message, call - # `ModifyAckDeadline` with the corresponding `ack_id` if using - # non-streaming pull or send the `ack_id` in a - # `StreamingModifyAckDeadlineRequest` if using streaming pull. - # The minimum custom deadline you can specify is 10 seconds. - # The maximum custom deadline you can specify is 600 seconds (10 minutes). - # If this parameter is 0, a default value of 10 seconds is used. - # For push delivery, this value is also used to set the request timeout for - # the call to the push endpoint. - # If the subscriber never acknowledges the message, the Pub/Sub - # system will eventually redeliver the message. + # The approximate amount of time (on a best-effort basis) Pub/Sub waits for the + # subscriber to acknowledge receipt before resending the message. In the + # interval after the message is delivered and before it is acknowledged, it is + # considered to be *outstanding*. During that time period, the message will not + # be redelivered (on a best-effort basis). For pull subscriptions, this value is + # used as the initial value for the ack deadline. To override this value for a + # given message, call `ModifyAckDeadline` with the corresponding `ack_id` if + # using non-streaming pull or send the `ack_id` in a ` + # StreamingModifyAckDeadlineRequest` if using streaming pull. The minimum custom + # deadline you can specify is 10 seconds. The maximum custom deadline you can + # specify is 600 seconds (10 minutes). If this parameter is 0, a default value + # of 10 seconds is used. For push delivery, this value is also used to set the + # request timeout for the call to the push endpoint. If the subscriber never + # acknowledges the message, the Pub/Sub system will eventually redeliver the + # message. # Corresponds to the JSON property `ackDeadlineSeconds` # @return [Fixnum] attr_accessor :ack_deadline_seconds - # Dead lettering is done on a best effort basis. The same message might be - # dead lettered multiple times. - # If validation on any of the fields fails at subscription creation/updation, - # the create/update subscription request will fail. + # Dead lettering is done on a best effort basis. The same message might be dead + # lettered multiple times. If validation on any of the fields fails at + # subscription creation/updation, the create/update subscription request will + # fail. # Corresponds to the JSON property `deadLetterPolicy` # @return [Google::Apis::PubsubV1::DeadLetterPolicy] attr_accessor :dead_letter_policy # Indicates whether the subscription is detached from its topic. Detached # subscriptions don't receive messages from their topic and don't retain any - # backlog. `Pull` and `StreamingPull` requests will return - # FAILED_PRECONDITION. If the subscription is a push subscription, pushes to - # the endpoint will not be made. + # backlog. `Pull` and `StreamingPull` requests will return FAILED_PRECONDITION. + # If the subscription is a push subscription, pushes to the endpoint will not be + # made. # Corresponds to the JSON property `detached` # @return [Boolean] attr_accessor :detached alias_method :detached?, :detached # If true, messages published with the same `ordering_key` in `PubsubMessage` - # will be delivered to the subscribers in the order in which they - # are received by the Pub/Sub system. Otherwise, they may be delivered in - # any order. + # will be delivered to the subscribers in the order in which they are received + # by the Pub/Sub system. Otherwise, they may be delivered in any order. # Corresponds to the JSON property `enableMessageOrdering` # @return [Boolean] attr_accessor :enable_message_ordering @@ -1221,37 +1095,34 @@ module Google # @return [Google::Apis::PubsubV1::ExpirationPolicy] attr_accessor :expiration_policy - # An expression written in the Pub/Sub [filter - # language](https://cloud.google.com/pubsub/docs/filtering). If non-empty, - # then only `PubsubMessage`s whose `attributes` field matches the filter are - # delivered on this subscription. If empty, then no messages are filtered - # out. + # An expression written in the Pub/Sub [filter language](https://cloud.google. + # com/pubsub/docs/filtering). If non-empty, then only `PubsubMessage`s whose ` + # attributes` field matches the filter are delivered on this subscription. If + # empty, then no messages are filtered out. # Corresponds to the JSON property `filter` # @return [String] attr_accessor :filter - # See Creating and - # managing labels. + # See Creating and managing labels. # Corresponds to the JSON property `labels` # @return [Hash] attr_accessor :labels - # How long to retain unacknowledged messages in the subscription's backlog, - # from the moment a message is published. - # If `retain_acked_messages` is true, then this also configures the retention - # of acknowledged messages, and thus configures how far back in time a `Seek` - # can be done. Defaults to 7 days. Cannot be more than 7 days or less than 10 - # minutes. + # How long to retain unacknowledged messages in the subscription's backlog, from + # the moment a message is published. If `retain_acked_messages` is true, then + # this also configures the retention of acknowledged messages, and thus + # configures how far back in time a `Seek` can be done. Defaults to 7 days. + # Cannot be more than 7 days or less than 10 minutes. # Corresponds to the JSON property `messageRetentionDuration` # @return [String] attr_accessor :message_retention_duration - # Required. The name of the subscription. It must have the format - # `"projects/`project`/subscriptions/`subscription`"`. ``subscription`` must - # start with a letter, and contain only letters (`[A-Za-z]`), numbers - # (`[0-9]`), dashes (`-`), underscores (`_`), periods (`.`), tildes (`~`), - # plus (`+`) or percent signs (`%`). It must be between 3 and 255 characters - # in length, and it must not start with `"goog"`. + # Required. The name of the subscription. It must have the format `"projects/` + # project`/subscriptions/`subscription`"`. ``subscription`` must start with a + # letter, and contain only letters (`[A-Za-z]`), numbers (`[0-9]`), dashes (`-`), + # underscores (`_`), periods (`.`), tildes (`~`), plus (`+`) or percent signs (` + # %`). It must be between 3 and 255 characters in length, and it must not start + # with `"goog"`. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name @@ -1261,33 +1132,30 @@ module Google # @return [Google::Apis::PubsubV1::PushConfig] attr_accessor :push_config - # Indicates whether to retain acknowledged messages. If true, then - # messages are not expunged from the subscription's backlog, even if they are - # acknowledged, until they fall out of the `message_retention_duration` - # window. This must be true if you would like to [Seek to a timestamp] - # (https://cloud.google.com/pubsub/docs/replay-overview#seek_to_a_time). + # Indicates whether to retain acknowledged messages. If true, then messages are + # not expunged from the subscription's backlog, even if they are acknowledged, + # until they fall out of the `message_retention_duration` window. This must be + # true if you would like to [Seek to a timestamp] (https://cloud.google.com/ + # pubsub/docs/replay-overview#seek_to_a_time). # Corresponds to the JSON property `retainAckedMessages` # @return [Boolean] attr_accessor :retain_acked_messages alias_method :retain_acked_messages?, :retain_acked_messages - # A policy that specifies how Cloud Pub/Sub retries message delivery. - # Retry delay will be exponential based on provided minimum and maximum - # backoffs. https://en.wikipedia.org/wiki/Exponential_backoff. - # RetryPolicy will be triggered on NACKs or acknowledgement deadline exceeded - # events for a given message. - # Retry Policy is implemented on a best effort basis. At times, the delay - # between consecutive deliveries may not match the configuration. That is, + # A policy that specifies how Cloud Pub/Sub retries message delivery. Retry + # delay will be exponential based on provided minimum and maximum backoffs. + # https://en.wikipedia.org/wiki/Exponential_backoff. RetryPolicy will be + # triggered on NACKs or acknowledgement deadline exceeded events for a given + # message. Retry Policy is implemented on a best effort basis. At times, the + # delay between consecutive deliveries may not match the configuration. That is, # delay can be more or less than configured backoff. # Corresponds to the JSON property `retryPolicy` # @return [Google::Apis::PubsubV1::RetryPolicy] attr_accessor :retry_policy # Required. The name of the topic from which this subscription is receiving - # messages. - # Format is `projects/`project`/topics/`topic``. - # The value of this field will be `_deleted-topic_` if the topic has been - # deleted. + # messages. Format is `projects/`project`/topics/`topic``. The value of this + # field will be `_deleted-topic_` if the topic has been deleted. # Corresponds to the JSON property `topic` # @return [String] attr_accessor :topic @@ -1318,10 +1186,9 @@ module Google class TestIamPermissionsRequest include Google::Apis::Core::Hashable - # The set of permissions to check for the `resource`. Permissions with - # wildcards (such as '*' or 'storage.*') are not allowed. For more - # information see - # [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions). + # The set of permissions to check for the `resource`. Permissions with wildcards + # (such as '*' or 'storage.*') are not allowed. For more information see [IAM + # Overview](https://cloud.google.com/iam/docs/overview#permissions). # Corresponds to the JSON property `permissions` # @return [Array] attr_accessor :permissions @@ -1340,8 +1207,7 @@ module Google class TestIamPermissionsResponse include Google::Apis::Core::Hashable - # A subset of `TestPermissionsRequest.permissions` that the caller is - # allowed. + # A subset of `TestPermissionsRequest.permissions` that the caller is allowed. # Corresponds to the JSON property `permissions` # @return [Array] attr_accessor :permissions @@ -1360,15 +1226,15 @@ module Google class Topic include Google::Apis::Core::Hashable - # The resource name of the Cloud KMS CryptoKey to be used to protect access - # to messages published on this topic. - # The expected format is `projects/*/locations/*/keyRings/*/cryptoKeys/*`. + # The resource name of the Cloud KMS CryptoKey to be used to protect access to + # messages published on this topic. The expected format is `projects/*/locations/ + # */keyRings/*/cryptoKeys/*`. # Corresponds to the JSON property `kmsKeyName` # @return [String] attr_accessor :kms_key_name - # See [Creating and managing labels] - # (https://cloud.google.com/pubsub/docs/labels). + # See [Creating and managing labels] (https://cloud.google.com/pubsub/docs/ + # labels). # Corresponds to the JSON property `labels` # @return [Hash] attr_accessor :labels @@ -1378,12 +1244,11 @@ module Google # @return [Google::Apis::PubsubV1::MessageStoragePolicy] attr_accessor :message_storage_policy - # Required. The name of the topic. It must have the format - # `"projects/`project`/topics/`topic`"`. ``topic`` must start with a letter, - # and contain only letters (`[A-Za-z]`), numbers (`[0-9]`), dashes (`-`), - # underscores (`_`), periods (`.`), tildes (`~`), plus (`+`) or percent - # signs (`%`). It must be between 3 and 255 characters in length, and it - # must not start with `"goog"`. + # Required. The name of the topic. It must have the format `"projects/`project`/ + # topics/`topic`"`. ``topic`` must start with a letter, and contain only letters + # (`[A-Za-z]`), numbers (`[0-9]`), dashes (`-`), underscores (`_`), periods (`.`) + # , tildes (`~`), plus (`+`) or percent signs (`%`). It must be between 3 and + # 255 characters in length, and it must not start with `"goog"`. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name @@ -1405,17 +1270,16 @@ module Google class UpdateSnapshotRequest include Google::Apis::Core::Hashable - # A snapshot resource. Snapshots are used in - # [Seek](https://cloud.google.com/pubsub/docs/replay-overview) - # operations, which allow you to manage message acknowledgments in bulk. That - # is, you can set the acknowledgment state of messages in an existing - # subscription to the state captured by a snapshot. + # A snapshot resource. Snapshots are used in [Seek](https://cloud.google.com/ + # pubsub/docs/replay-overview) operations, which allow you to manage message + # acknowledgments in bulk. That is, you can set the acknowledgment state of + # messages in an existing subscription to the state captured by a snapshot. # Corresponds to the JSON property `snapshot` # @return [Google::Apis::PubsubV1::Snapshot] attr_accessor :snapshot - # Required. Indicates which fields in the provided snapshot to update. - # Must be specified and non-empty. + # Required. Indicates which fields in the provided snapshot to update. Must be + # specified and non-empty. # Corresponds to the JSON property `updateMask` # @return [String] attr_accessor :update_mask @@ -1440,8 +1304,8 @@ module Google # @return [Google::Apis::PubsubV1::Subscription] attr_accessor :subscription - # Required. Indicates which fields in the provided subscription to update. - # Must be specified and non-empty. + # Required. Indicates which fields in the provided subscription to update. Must + # be specified and non-empty. # Corresponds to the JSON property `updateMask` # @return [String] attr_accessor :update_mask @@ -1467,11 +1331,10 @@ module Google attr_accessor :topic # Required. Indicates which fields in the provided topic to update. Must be - # specified - # and non-empty. Note that if `update_mask` contains - # "message_storage_policy" but the `message_storage_policy` is not set in - # the `topic` provided above, then the updated value is determined by the - # policy configured at the project or organization level. + # specified and non-empty. Note that if `update_mask` contains " + # message_storage_policy" but the `message_storage_policy` is not set in the ` + # topic` provided above, then the updated value is determined by the policy + # configured at the project or organization level. # Corresponds to the JSON property `updateMask` # @return [String] attr_accessor :update_mask diff --git a/generated/google/apis/pubsub_v1/service.rb b/generated/google/apis/pubsub_v1/service.rb index 671fb5f7e..0e0e9d137 100644 --- a/generated/google/apis/pubsub_v1/service.rb +++ b/generated/google/apis/pubsub_v1/service.rb @@ -47,30 +47,26 @@ module Google @batch_path = 'batch' end - # Creates a snapshot from the requested subscription. Snapshots are used in - # [Seek](https://cloud.google.com/pubsub/docs/replay-overview) operations, - # which allow you to manage message acknowledgments in bulk. That is, you can - # set the acknowledgment state of messages in an existing subscription to the - # state captured by a snapshot. - # If the snapshot already exists, returns `ALREADY_EXISTS`. - # If the requested subscription doesn't exist, returns `NOT_FOUND`. - # If the backlog in the subscription is too old -- and the resulting snapshot - # would expire in less than 1 hour -- then `FAILED_PRECONDITION` is returned. - # See also the `Snapshot.expire_time` field. If the name is not provided in - # the request, the server will assign a random - # name for this snapshot on the same project as the subscription, conforming - # to the [resource name format] - # (https://cloud.google.com/pubsub/docs/admin#resource_names). The + # Creates a snapshot from the requested subscription. Snapshots are used in [ + # Seek](https://cloud.google.com/pubsub/docs/replay-overview) operations, which + # allow you to manage message acknowledgments in bulk. That is, you can set the + # acknowledgment state of messages in an existing subscription to the state + # captured by a snapshot. If the snapshot already exists, returns ` + # ALREADY_EXISTS`. If the requested subscription doesn't exist, returns ` + # NOT_FOUND`. If the backlog in the subscription is too old -- and the resulting + # snapshot would expire in less than 1 hour -- then `FAILED_PRECONDITION` is + # returned. See also the `Snapshot.expire_time` field. If the name is not + # provided in the request, the server will assign a random name for this + # snapshot on the same project as the subscription, conforming to the [resource + # name format] (https://cloud.google.com/pubsub/docs/admin#resource_names). The # generated name is populated in the returned Snapshot object. Note that for # REST API requests, you must specify a name in the request. # @param [String] name # Required. User-provided name for this snapshot. If the name is not provided in - # the - # request, the server will assign a random name for this snapshot on the same - # project as the subscription. Note that for REST API requests, you must - # specify a name. See the resource - # name rules. Format is `projects/`project`/snapshots/`snap``. + # the request, the server will assign a random name for this snapshot on the + # same project as the subscription. Note that for REST API requests, you must + # specify a name. See the resource name rules. Format is `projects/`project`/ + # snapshots/`snap``. # @param [Google::Apis::PubsubV1::CreateSnapshotRequest] create_snapshot_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -101,18 +97,17 @@ module Google execute_or_queue_command(command, &block) end - # Removes an existing snapshot. Snapshots are used in [Seek] - # (https://cloud.google.com/pubsub/docs/replay-overview) operations, which - # allow you to manage message acknowledgments in bulk. That is, you can set - # the acknowledgment state of messages in an existing subscription to the - # state captured by a snapshot. - # When the snapshot is deleted, all messages retained in the snapshot - # are immediately dropped. After a snapshot is deleted, a new one may be - # created with the same name, but the new one has no association with the old - # snapshot or its subscription, unless the same subscription is specified. + # Removes an existing snapshot. Snapshots are used in [Seek] (https://cloud. + # google.com/pubsub/docs/replay-overview) operations, which allow you to manage + # message acknowledgments in bulk. That is, you can set the acknowledgment state + # of messages in an existing subscription to the state captured by a snapshot. + # When the snapshot is deleted, all messages retained in the snapshot are + # immediately dropped. After a snapshot is deleted, a new one may be created + # with the same name, but the new one has no association with the old snapshot + # or its subscription, unless the same subscription is specified. # @param [String] snapshot - # Required. The name of the snapshot to delete. - # Format is `projects/`project`/snapshots/`snap``. + # Required. The name of the snapshot to delete. Format is `projects/`project`/ + # snapshots/`snap``. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -140,14 +135,13 @@ module Google execute_or_queue_command(command, &block) end - # Gets the configuration details of a snapshot. Snapshots are used in - # Seek - # operations, which allow you to manage message acknowledgments in bulk. That - # is, you can set the acknowledgment state of messages in an existing - # subscription to the state captured by a snapshot. + # Gets the configuration details of a snapshot. Snapshots are used in Seek + # operations, which allow you to manage message acknowledgments in bulk. That is, + # you can set the acknowledgment state of messages in an existing subscription + # to the state captured by a snapshot. # @param [String] snapshot - # Required. The name of the snapshot to get. - # Format is `projects/`project`/snapshots/`snap``. + # Required. The name of the snapshot to get. Format is `projects/`project`/ + # snapshots/`snap``. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -175,22 +169,19 @@ module Google execute_or_queue_command(command, &block) end - # Gets the access control policy for a resource. - # Returns an empty policy if the resource exists and does not have a policy - # set. + # Gets the access control policy for a resource. Returns an empty policy if the + # resource exists and does not have a policy set. # @param [String] resource - # REQUIRED: The resource for which the policy is being requested. - # See the operation documentation for the appropriate value for this field. + # REQUIRED: The resource for which the policy is being requested. See the + # operation documentation for the appropriate value for this field. # @param [Fixnum] options_requested_policy_version - # Optional. The policy format version to be returned. - # Valid values are 0, 1, and 3. Requests specifying an invalid value will be - # rejected. - # 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). + # Optional. The policy format version to be returned. Valid values are 0, 1, and + # 3. Requests specifying an invalid value will be rejected. 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 @@ -219,20 +210,19 @@ module Google execute_or_queue_command(command, &block) end - # Lists the existing snapshots. Snapshots are used in [Seek]( - # https://cloud.google.com/pubsub/docs/replay-overview) operations, which - # allow you to manage message acknowledgments in bulk. That is, you can set - # the acknowledgment state of messages in an existing subscription to the - # state captured by a snapshot. + # Lists the existing snapshots. Snapshots are used in [Seek]( https://cloud. + # google.com/pubsub/docs/replay-overview) operations, which allow you to manage + # message acknowledgments in bulk. That is, you can set the acknowledgment state + # of messages in an existing subscription to the state captured by a snapshot. # @param [String] project - # Required. The name of the project in which to list snapshots. - # Format is `projects/`project-id``. + # Required. The name of the project in which to list snapshots. Format is ` + # projects/`project-id``. # @param [Fixnum] page_size # Maximum number of snapshots to return. # @param [String] page_token - # The value returned by the last `ListSnapshotsResponse`; indicates that this - # is a continuation of a prior `ListSnapshots` call, and that the system - # should return the next page of data. + # The value returned by the last `ListSnapshotsResponse`; indicates that this is + # a continuation of a prior `ListSnapshots` call, and that the system should + # return the next page of data. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -262,10 +252,8 @@ module Google execute_or_queue_command(command, &block) end - # Updates an existing snapshot. Snapshots are used in - # Seek - # operations, which allow - # you to manage message acknowledgments in bulk. That is, you can set the + # Updates an existing snapshot. Snapshots are used in Seek operations, which + # allow you to manage message acknowledgments in bulk. That is, you can set the # acknowledgment state of messages in an existing subscription to the state # captured by a snapshot. # @param [String] name @@ -301,11 +289,11 @@ module Google end # Sets the access control policy on the specified resource. Replaces any - # existing policy. - # Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors. + # existing policy. 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. + # REQUIRED: The resource for which the policy is being specified. See the + # operation documentation for the appropriate value for this field. # @param [Google::Apis::PubsubV1::SetIamPolicyRequest] set_iam_policy_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -336,15 +324,14 @@ module Google execute_or_queue_command(command, &block) end - # 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. - # 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. + # 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. 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. # @param [String] resource - # REQUIRED: The resource for which the policy detail is being requested. - # See the operation documentation for the appropriate value for this field. + # REQUIRED: The resource for which the policy detail is being requested. See the + # operation documentation for the appropriate value for this field. # @param [Google::Apis::PubsubV1::TestIamPermissionsRequest] test_iam_permissions_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -375,15 +362,14 @@ module Google execute_or_queue_command(command, &block) end - # Acknowledges the messages associated with the `ack_ids` in the - # `AcknowledgeRequest`. The Pub/Sub system can remove the relevant messages - # from the subscription. - # Acknowledging a message whose ack deadline has expired may succeed, - # but such a message may be redelivered later. Acknowledging a message more - # than once will not result in an error. + # Acknowledges the messages associated with the `ack_ids` in the ` + # AcknowledgeRequest`. The Pub/Sub system can remove the relevant messages from + # the subscription. Acknowledging a message whose ack deadline has expired may + # succeed, but such a message may be redelivered later. Acknowledging a message + # more than once will not result in an error. # @param [String] subscription - # Required. The subscription whose message is being acknowledged. - # Format is `projects/`project`/subscriptions/`sub``. + # Required. The subscription whose message is being acknowledged. Format is ` + # projects/`project`/subscriptions/`sub``. # @param [Google::Apis::PubsubV1::AcknowledgeRequest] acknowledge_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -414,23 +400,22 @@ module Google execute_or_queue_command(command, &block) end - # Creates a subscription to a given topic. See the [resource name rules] - # (https://cloud.google.com/pubsub/docs/admin#resource_names). - # If the subscription already exists, returns `ALREADY_EXISTS`. - # If the corresponding topic doesn't exist, returns `NOT_FOUND`. - # If the name is not provided in the request, the server will assign a random - # name for this subscription on the same project as the topic, conforming - # to the [resource name format] - # (https://cloud.google.com/pubsub/docs/admin#resource_names). The generated - # name is populated in the returned Subscription object. Note that for REST - # API requests, you must specify a name in the request. + # Creates a subscription to a given topic. See the [resource name rules] (https:/ + # /cloud.google.com/pubsub/docs/admin#resource_names). If the subscription + # already exists, returns `ALREADY_EXISTS`. If the corresponding topic doesn't + # exist, returns `NOT_FOUND`. If the name is not provided in the request, the + # server will assign a random name for this subscription on the same project as + # the topic, conforming to the [resource name format] (https://cloud.google.com/ + # pubsub/docs/admin#resource_names). The generated name is populated in the + # returned Subscription object. Note that for REST API requests, you must + # specify a name in the request. # @param [String] name - # Required. The name of the subscription. It must have the format - # `"projects/`project`/subscriptions/`subscription`"`. ``subscription`` must - # start with a letter, and contain only letters (`[A-Za-z]`), numbers - # (`[0-9]`), dashes (`-`), underscores (`_`), periods (`.`), tildes (`~`), - # plus (`+`) or percent signs (`%`). It must be between 3 and 255 characters - # in length, and it must not start with `"goog"`. + # Required. The name of the subscription. It must have the format `"projects/` + # project`/subscriptions/`subscription`"`. ``subscription`` must start with a + # letter, and contain only letters (`[A-Za-z]`), numbers (`[0-9]`), dashes (`-`), + # underscores (`_`), periods (`.`), tildes (`~`), plus (`+`) or percent signs (` + # %`). It must be between 3 and 255 characters in length, and it must not start + # with `"goog"`. # @param [Google::Apis::PubsubV1::Subscription] subscription_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -462,13 +447,13 @@ module Google end # Deletes an existing subscription. All messages retained in the subscription - # are immediately dropped. Calls to `Pull` after deletion will return - # `NOT_FOUND`. After a subscription is deleted, a new one may be created with - # the same name, but the new one has no association with the old - # subscription or its topic unless the same topic is specified. + # are immediately dropped. Calls to `Pull` after deletion will return `NOT_FOUND` + # . After a subscription is deleted, a new one may be created with the same name, + # but the new one has no association with the old subscription or its topic + # unless the same topic is specified. # @param [String] subscription - # Required. The subscription to delete. - # Format is `projects/`project`/subscriptions/`sub``. + # Required. The subscription to delete. Format is `projects/`project`/ + # subscriptions/`sub``. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -497,12 +482,12 @@ module Google end # Detaches a subscription from this topic. All messages retained in the - # subscription are dropped. Subsequent `Pull` and `StreamingPull` requests - # will return FAILED_PRECONDITION. If the subscription is a push - # subscription, pushes to the endpoint will stop. + # subscription are dropped. Subsequent `Pull` and `StreamingPull` requests will + # return FAILED_PRECONDITION. If the subscription is a push subscription, pushes + # to the endpoint will stop. # @param [String] subscription - # Required. The subscription to detach. - # Format is `projects/`project`/subscriptions/`subscription``. + # Required. The subscription to detach. Format is `projects/`project`/ + # subscriptions/`subscription``. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -532,8 +517,8 @@ module Google # Gets the configuration details of a subscription. # @param [String] subscription - # Required. The name of the subscription to get. - # Format is `projects/`project`/subscriptions/`sub``. + # Required. The name of the subscription to get. Format is `projects/`project`/ + # subscriptions/`sub``. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -561,22 +546,19 @@ module Google execute_or_queue_command(command, &block) end - # Gets the access control policy for a resource. - # Returns an empty policy if the resource exists and does not have a policy - # set. + # Gets the access control policy for a resource. Returns an empty policy if the + # resource exists and does not have a policy set. # @param [String] resource - # REQUIRED: The resource for which the policy is being requested. - # See the operation documentation for the appropriate value for this field. + # REQUIRED: The resource for which the policy is being requested. See the + # operation documentation for the appropriate value for this field. # @param [Fixnum] options_requested_policy_version - # Optional. The policy format version to be returned. - # Valid values are 0, 1, and 3. Requests specifying an invalid value will be - # rejected. - # 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). + # Optional. The policy format version to be returned. Valid values are 0, 1, and + # 3. Requests specifying an invalid value will be rejected. 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 @@ -607,8 +589,8 @@ module Google # Lists matching subscriptions. # @param [String] project - # Required. The name of the project in which to list subscriptions. - # Format is `projects/`project-id``. + # Required. The name of the project in which to list subscriptions. Format is ` + # projects/`project-id``. # @param [Fixnum] page_size # Maximum number of subscriptions to return. # @param [String] page_token @@ -644,14 +626,14 @@ module Google execute_or_queue_command(command, &block) end - # Modifies the ack deadline for a specific message. This method is useful - # to indicate that more time is needed to process a message by the - # subscriber, or to make the message available for redelivery if the - # processing was interrupted. Note that this does not modify the - # subscription-level `ackDeadlineSeconds` used for subsequent messages. + # Modifies the ack deadline for a specific message. This method is useful to + # indicate that more time is needed to process a message by the subscriber, or + # to make the message available for redelivery if the processing was interrupted. + # Note that this does not modify the subscription-level `ackDeadlineSeconds` + # used for subsequent messages. # @param [String] subscription - # Required. The name of the subscription. - # Format is `projects/`project`/subscriptions/`sub``. + # Required. The name of the subscription. Format is `projects/`project`/ + # subscriptions/`sub``. # @param [Google::Apis::PubsubV1::ModifyAckDeadlineRequest] modify_ack_deadline_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -682,14 +664,14 @@ module Google execute_or_queue_command(command, &block) end - # Modifies the `PushConfig` for a specified subscription. - # This may be used to change a push subscription to a pull one (signified by - # an empty `PushConfig`) or vice versa, or change the endpoint URL and other - # attributes of a push subscription. Messages will accumulate for delivery - # continuously through the call regardless of changes to the `PushConfig`. + # Modifies the `PushConfig` for a specified subscription. This may be used to + # change a push subscription to a pull one (signified by an empty `PushConfig`) + # or vice versa, or change the endpoint URL and other attributes of a push + # subscription. Messages will accumulate for delivery continuously through the + # call regardless of changes to the `PushConfig`. # @param [String] subscription - # Required. The name of the subscription. - # Format is `projects/`project`/subscriptions/`sub``. + # Required. The name of the subscription. Format is `projects/`project`/ + # subscriptions/`sub``. # @param [Google::Apis::PubsubV1::ModifyPushConfigRequest] modify_push_config_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -723,12 +705,12 @@ module Google # Updates an existing subscription. Note that certain properties of a # subscription, such as its topic, are not modifiable. # @param [String] name - # Required. The name of the subscription. It must have the format - # `"projects/`project`/subscriptions/`subscription`"`. ``subscription`` must - # start with a letter, and contain only letters (`[A-Za-z]`), numbers - # (`[0-9]`), dashes (`-`), underscores (`_`), periods (`.`), tildes (`~`), - # plus (`+`) or percent signs (`%`). It must be between 3 and 255 characters - # in length, and it must not start with `"goog"`. + # Required. The name of the subscription. It must have the format `"projects/` + # project`/subscriptions/`subscription`"`. ``subscription`` must start with a + # letter, and contain only letters (`[A-Za-z]`), numbers (`[0-9]`), dashes (`-`), + # underscores (`_`), periods (`.`), tildes (`~`), plus (`+`) or percent signs (` + # %`). It must be between 3 and 255 characters in length, and it must not start + # with `"goog"`. # @param [Google::Apis::PubsubV1::UpdateSubscriptionRequest] update_subscription_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -759,12 +741,11 @@ module Google execute_or_queue_command(command, &block) end - # Pulls messages from the server. The server may return `UNAVAILABLE` if - # there are too many concurrent pull requests pending for the given - # subscription. + # Pulls messages from the server. The server may return `UNAVAILABLE` if there + # are too many concurrent pull requests pending for the given subscription. # @param [String] subscription - # Required. The subscription from which messages should be pulled. - # Format is `projects/`project`/subscriptions/`sub``. + # Required. The subscription from which messages should be pulled. Format is ` + # projects/`project`/subscriptions/`sub``. # @param [Google::Apis::PubsubV1::PullRequest] pull_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -796,12 +777,12 @@ module Google end # Seeks an existing subscription to a point in time or to a given snapshot, - # whichever is provided in the request. Snapshots are used in [Seek]( - # https://cloud.google.com/pubsub/docs/replay-overview) operations, which - # allow you to manage message acknowledgments in bulk. That is, you can set - # the acknowledgment state of messages in an existing subscription to the - # state captured by a snapshot. Note that both the subscription and the - # snapshot must be on the same topic. + # whichever is provided in the request. Snapshots are used in [Seek]( https:// + # cloud.google.com/pubsub/docs/replay-overview) operations, which allow you to + # manage message acknowledgments in bulk. That is, you can set the + # acknowledgment state of messages in an existing subscription to the state + # captured by a snapshot. Note that both the subscription and the snapshot must + # be on the same topic. # @param [String] subscription # Required. The subscription to affect. # @param [Google::Apis::PubsubV1::SeekRequest] seek_request_object @@ -835,11 +816,11 @@ module Google end # Sets the access control policy on the specified resource. Replaces any - # existing policy. - # Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors. + # existing policy. 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. + # REQUIRED: The resource for which the policy is being specified. See the + # operation documentation for the appropriate value for this field. # @param [Google::Apis::PubsubV1::SetIamPolicyRequest] set_iam_policy_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -870,15 +851,14 @@ module Google execute_or_queue_command(command, &block) end - # 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. - # 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. + # 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. 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. # @param [String] resource - # REQUIRED: The resource for which the policy detail is being requested. - # See the operation documentation for the appropriate value for this field. + # REQUIRED: The resource for which the policy detail is being requested. See the + # operation documentation for the appropriate value for this field. # @param [Google::Apis::PubsubV1::TestIamPermissionsRequest] test_iam_permissions_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -912,12 +892,11 @@ module Google # Creates the given topic with the given name. See the [resource name rules]( # https://cloud.google.com/pubsub/docs/admin#resource_names). # @param [String] name - # Required. The name of the topic. It must have the format - # `"projects/`project`/topics/`topic`"`. ``topic`` must start with a letter, - # and contain only letters (`[A-Za-z]`), numbers (`[0-9]`), dashes (`-`), - # underscores (`_`), periods (`.`), tildes (`~`), plus (`+`) or percent - # signs (`%`). It must be between 3 and 255 characters in length, and it - # must not start with `"goog"`. + # Required. The name of the topic. It must have the format `"projects/`project`/ + # topics/`topic`"`. ``topic`` must start with a letter, and contain only letters + # (`[A-Za-z]`), numbers (`[0-9]`), dashes (`-`), underscores (`_`), periods (`.`) + # , tildes (`~`), plus (`+`) or percent signs (`%`). It must be between 3 and + # 255 characters in length, and it must not start with `"goog"`. # @param [Google::Apis::PubsubV1::Topic] topic_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -948,14 +927,14 @@ module Google execute_or_queue_command(command, &block) end - # Deletes the topic with the given name. Returns `NOT_FOUND` if the topic - # does not exist. After a topic is deleted, a new topic may be created with - # the same name; this is an entirely new topic with none of the old - # configuration or subscriptions. Existing subscriptions to this topic are - # not deleted, but their `topic` field is set to `_deleted-topic_`. + # Deletes the topic with the given name. Returns `NOT_FOUND` if the topic does + # not exist. After a topic is deleted, a new topic may be created with the same + # name; this is an entirely new topic with none of the old configuration or + # subscriptions. Existing subscriptions to this topic are not deleted, but their + # `topic` field is set to `_deleted-topic_`. # @param [String] topic - # Required. Name of the topic to delete. - # Format is `projects/`project`/topics/`topic``. + # Required. Name of the topic to delete. Format is `projects/`project`/topics/` + # topic``. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -985,8 +964,8 @@ module Google # Gets the configuration of a topic. # @param [String] topic - # Required. The name of the topic to get. - # Format is `projects/`project`/topics/`topic``. + # Required. The name of the topic to get. Format is `projects/`project`/topics/` + # topic``. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -1014,22 +993,19 @@ module Google execute_or_queue_command(command, &block) end - # Gets the access control policy for a resource. - # Returns an empty policy if the resource exists and does not have a policy - # set. + # Gets the access control policy for a resource. Returns an empty policy if the + # resource exists and does not have a policy set. # @param [String] resource - # REQUIRED: The resource for which the policy is being requested. - # See the operation documentation for the appropriate value for this field. + # REQUIRED: The resource for which the policy is being requested. See the + # operation documentation for the appropriate value for this field. # @param [Fixnum] options_requested_policy_version - # Optional. The policy format version to be returned. - # Valid values are 0, 1, and 3. Requests specifying an invalid value will be - # rejected. - # 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). + # Optional. The policy format version to be returned. Valid values are 0, 1, and + # 3. Requests specifying an invalid value will be rejected. 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 @@ -1060,14 +1036,14 @@ module Google # Lists matching topics. # @param [String] project - # Required. The name of the project in which to list topics. - # Format is `projects/`project-id``. + # Required. The name of the project in which to list topics. Format is `projects/ + # `project-id``. # @param [Fixnum] page_size # Maximum number of topics to return. # @param [String] page_token - # The value returned by the last `ListTopicsResponse`; indicates that this is - # a continuation of a prior `ListTopics` call, and that the system should - # return the next page of data. + # The value returned by the last `ListTopicsResponse`; indicates that this is a + # continuation of a prior `ListTopics` call, and that the system should return + # the next page of data. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -1097,15 +1073,14 @@ module Google execute_or_queue_command(command, &block) end - # Updates an existing topic. Note that certain properties of a - # topic are not modifiable. + # Updates an existing topic. Note that certain properties of a topic are not + # modifiable. # @param [String] name - # Required. The name of the topic. It must have the format - # `"projects/`project`/topics/`topic`"`. ``topic`` must start with a letter, - # and contain only letters (`[A-Za-z]`), numbers (`[0-9]`), dashes (`-`), - # underscores (`_`), periods (`.`), tildes (`~`), plus (`+`) or percent - # signs (`%`). It must be between 3 and 255 characters in length, and it - # must not start with `"goog"`. + # Required. The name of the topic. It must have the format `"projects/`project`/ + # topics/`topic`"`. ``topic`` must start with a letter, and contain only letters + # (`[A-Za-z]`), numbers (`[0-9]`), dashes (`-`), underscores (`_`), periods (`.`) + # , tildes (`~`), plus (`+`) or percent signs (`%`). It must be between 3 and + # 255 characters in length, and it must not start with `"goog"`. # @param [Google::Apis::PubsubV1::UpdateTopicRequest] update_topic_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -1136,11 +1111,11 @@ module Google execute_or_queue_command(command, &block) end - # Adds one or more messages to the topic. Returns `NOT_FOUND` if the topic - # does not exist. + # Adds one or more messages to the topic. Returns `NOT_FOUND` if the topic does + # not exist. # @param [String] topic - # Required. The messages in the request will be published on this topic. - # Format is `projects/`project`/topics/`topic``. + # Required. The messages in the request will be published on this topic. Format + # is `projects/`project`/topics/`topic``. # @param [Google::Apis::PubsubV1::PublishRequest] publish_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -1172,11 +1147,11 @@ module Google end # Sets the access control policy on the specified resource. Replaces any - # existing policy. - # Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors. + # existing policy. 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. + # REQUIRED: The resource for which the policy is being specified. See the + # operation documentation for the appropriate value for this field. # @param [Google::Apis::PubsubV1::SetIamPolicyRequest] set_iam_policy_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -1207,15 +1182,14 @@ module Google execute_or_queue_command(command, &block) end - # 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. - # 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. + # 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. 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. # @param [String] resource - # REQUIRED: The resource for which the policy detail is being requested. - # See the operation documentation for the appropriate value for this field. + # REQUIRED: The resource for which the policy detail is being requested. See the + # operation documentation for the appropriate value for this field. # @param [Google::Apis::PubsubV1::TestIamPermissionsRequest] test_iam_permissions_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -1246,20 +1220,20 @@ module Google execute_or_queue_command(command, &block) end - # Lists the names of the snapshots on this topic. Snapshots are used in - # [Seek](https://cloud.google.com/pubsub/docs/replay-overview) operations, - # which allow you to manage message acknowledgments in bulk. That is, you can - # set the acknowledgment state of messages in an existing subscription to the - # state captured by a snapshot. + # Lists the names of the snapshots on this topic. Snapshots are used in [Seek]( + # https://cloud.google.com/pubsub/docs/replay-overview) operations, which allow + # you to manage message acknowledgments in bulk. That is, you can set the + # acknowledgment state of messages in an existing subscription to the state + # captured by a snapshot. # @param [String] topic - # Required. The name of the topic that snapshots are attached to. - # Format is `projects/`project`/topics/`topic``. + # Required. The name of the topic that snapshots are attached to. Format is ` + # projects/`project`/topics/`topic``. # @param [Fixnum] page_size # Maximum number of snapshot names to return. # @param [String] page_token - # The value returned by the last `ListTopicSnapshotsResponse`; indicates - # that this is a continuation of a prior `ListTopicSnapshots` call, and - # that the system should return the next page of data. + # The value returned by the last `ListTopicSnapshotsResponse`; indicates that + # this is a continuation of a prior `ListTopicSnapshots` call, and that the + # system should return the next page of data. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -1291,14 +1265,14 @@ module Google # Lists the names of the attached subscriptions on this topic. # @param [String] topic - # Required. The name of the topic that subscriptions are attached to. - # Format is `projects/`project`/topics/`topic``. + # Required. The name of the topic that subscriptions are attached to. Format is ` + # projects/`project`/topics/`topic``. # @param [Fixnum] page_size # Maximum number of subscription names to return. # @param [String] page_token # The value returned by the last `ListTopicSubscriptionsResponse`; indicates - # that this is a continuation of a prior `ListTopicSubscriptions` call, and - # that the system should return the next page of data. + # that this is a continuation of a prior `ListTopicSubscriptions` call, and that + # the system should return the next page of data. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user diff --git a/generated/google/apis/pubsub_v1beta1a.rb b/generated/google/apis/pubsub_v1beta1a.rb index 90ff34acd..88ffe20de 100644 --- a/generated/google/apis/pubsub_v1beta1a.rb +++ b/generated/google/apis/pubsub_v1beta1a.rb @@ -25,7 +25,7 @@ module Google # @see https://cloud.google.com/pubsub/docs module PubsubV1beta1a VERSION = 'V1beta1a' - REVISION = '20200218' + REVISION = '20200807' # 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/pubsub_v1beta1a/classes.rb b/generated/google/apis/pubsub_v1beta1a/classes.rb index d3c6c0096..a94b001a8 100644 --- a/generated/google/apis/pubsub_v1beta1a/classes.rb +++ b/generated/google/apis/pubsub_v1beta1a/classes.rb @@ -26,8 +26,8 @@ module Google class AcknowledgeRequest include Google::Apis::Core::Hashable - # The acknowledgment ID for the message being acknowledged. This was - # returned by the Pub/Sub system in the Pull response. + # The acknowledgment ID for the message being acknowledged. This was returned by + # the Pub/Sub system in the Pull response. # Corresponds to the JSON property `ackId` # @return [Array] attr_accessor :ack_id @@ -50,16 +50,11 @@ module Google # An empty message that you can re-use to avoid defining duplicated empty # messages in your project. A typical example is to use it as argument or the - # return value of a service API. For instance: - # service Foo ` - # rpc Bar (proto2.Empty) returns (proto2.Empty) ` `; - # `; - # BEGIN GOOGLE-INTERNAL - # The difference between this one and net/rpc/empty-message.proto is that - # 1) The generated message here is in proto2 C++ API. - # 2) The proto2.Empty has minimum dependencies - # (no message_set or net/rpc dependencies) - # END GOOGLE-INTERNAL + # return value of a service API. For instance: service Foo ` rpc Bar (proto2. + # Empty) returns (proto2.Empty) ` `; `; BEGIN GOOGLE-INTERNAL The difference + # between this one and net/rpc/empty-message.proto is that 1) The generated + # message here is in proto2 C++ API. 2) The proto2.Empty has minimum + # dependencies (no message_set or net/rpc dependencies) END GOOGLE-INTERNAL class Empty include Google::Apis::Core::Hashable @@ -76,20 +71,16 @@ module Google class Label include Google::Apis::Core::Hashable - # The key of a label is a syntactically valid URL (as per RFC 1738) with - # the "scheme" and initial slashes omitted and with the additional - # restrictions noted below. Each key should be globally unique. The - # "host" portion is called the "namespace" and is not necessarily - # resolvable to a network endpoint. Instead, the namespace indicates what - # system or entity defines the semantics of the label. Namespaces do not - # restrict the set of objects to which a label may be associated. - # Keys are defined by the following grammar: - # key = hostname "/" kpath - # kpath = ksegment *[ "/" ksegment ] - # ksegment = alphadigit | *[ alphadigit | "-" | "_" | "." ] - # where "hostname" and "alphadigit" are defined as in RFC 1738. - # Example key: - # spanner.google.com/universe + # The key of a label is a syntactically valid URL (as per RFC 1738) with the " + # scheme" and initial slashes omitted and with the additional restrictions noted + # below. Each key should be globally unique. The "host" portion is called the " + # namespace" and is not necessarily resolvable to a network endpoint. Instead, + # the namespace indicates what system or entity defines the semantics of the + # label. Namespaces do not restrict the set of objects to which a label may be + # associated. Keys are defined by the following grammar: key = hostname "/" + # kpath kpath = ksegment *[ "/" ksegment ] ksegment = alphadigit | *[ alphadigit + # | "-" | "_" | "." ] where "hostname" and "alphadigit" are defined as in RFC + # 1738. Example key: spanner.google.com/universe # Corresponds to the JSON property `key` # @return [String] attr_accessor :key @@ -121,8 +112,8 @@ module Google include Google::Apis::Core::Hashable # If not empty, indicates that there are more subscriptions that match the - # request and this value should be passed to the next - # ListSubscriptionsRequest to continue. + # request and this value should be passed to the next ListSubscriptionsRequest + # to continue. # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token @@ -147,9 +138,8 @@ module Google class ListTopicsResponse include Google::Apis::Core::Hashable - # If not empty, indicates that there are more topics that match the request, - # and this value should be passed to the next ListTopicsRequest - # to continue. + # If not empty, indicates that there are more topics that match the request, and + # this value should be passed to the next ListTopicsRequest to continue. # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token @@ -174,8 +164,8 @@ module Google class ModifyAckDeadlineRequest include Google::Apis::Core::Hashable - # The new ack deadline with respect to the time this request was sent to the - # Pub/Sub system. Must be >= 0. For example, if the value is 10, the new ack + # The new ack deadline with respect to the time this request was sent to the Pub/ + # Sub system. Must be >= 0. For example, if the value is 10, the new ack # deadline will expire 10 seconds after the ModifyAckDeadline call was made. # Specifying zero may immediately make the message available for another pull # request. @@ -183,20 +173,19 @@ module Google # @return [Fixnum] attr_accessor :ack_deadline_seconds - # The acknowledgment ID. Either this or ack_ids must be populated, - # not both. + # The acknowledgment ID. Either this or ack_ids must be populated, not both. # Corresponds to the JSON property `ackId` # @return [String] attr_accessor :ack_id - # List of acknowledgment IDs. Either this field or ack_id - # should be populated, not both. + # List of acknowledgment IDs. Either this field or ack_id should be populated, + # not both. # Corresponds to the JSON property `ackIds` # @return [Array] attr_accessor :ack_ids - # Next Index: 5 - # The name of the subscription from which messages are being pulled. + # Next Index: 5 The name of the subscription from which messages are being + # pulled. # Corresponds to the JSON property `subscription` # @return [String] attr_accessor :subscription @@ -268,9 +257,8 @@ module Google class PublishBatchResponse include Google::Apis::Core::Hashable - # The server-assigned ID of each published message, in the same order as - # the messages in the request. IDs are guaranteed to be unique within - # the topic. + # The server-assigned ID of each published message, in the same order as the + # messages in the request. IDs are guaranteed to be unique within the topic. # Corresponds to the JSON property `messageIds` # @return [Array] attr_accessor :message_ids @@ -314,9 +302,9 @@ module Google class PubsubEvent include Google::Apis::Core::Hashable - # Indicates that this subscription has been deleted. (Note that pull - # subscribers will always receive NOT_FOUND in response in their pull - # request on the subscription, rather than seeing this boolean.) + # Indicates that this subscription has been deleted. (Note that pull subscribers + # will always receive NOT_FOUND in response in their pull request on the + # subscription, rather than seeing this boolean.) # Corresponds to the JSON property `deleted` # @return [Boolean] attr_accessor :deleted @@ -361,22 +349,22 @@ module Google # @return [String] attr_accessor :data - # Optional list of labels for this message. Keys in this collection must - # be unique. + # Optional list of labels for this message. Keys in this collection must be + # unique. # Corresponds to the JSON property `label` # @return [Array] attr_accessor :label - # ID of this message assigned by the server at publication time. Guaranteed - # to be unique within the topic. This value may be read by a subscriber - # that receives a PubsubMessage via a Pull call or a push delivery. It must - # not be populated by a publisher in a Publish call. + # ID of this message assigned by the server at publication time. Guaranteed to + # be unique within the topic. This value may be read by a subscriber that + # receives a PubsubMessage via a Pull call or a push delivery. It must not be + # populated by a publisher in a Publish call. # Corresponds to the JSON property `messageId` # @return [String] attr_accessor :message_id - # The time at which the message was published. - # The time is milliseconds since the UNIX epoch. + # The time at which the message was published. The time is milliseconds since + # the UNIX epoch. # Corresponds to the JSON property `publishTime` # @return [Fixnum] attr_accessor :publish_time @@ -404,11 +392,11 @@ module Google # @return [Fixnum] attr_accessor :max_events - # If this is specified as true the system will respond immediately even if - # it is not able to return a message in the Pull response. Otherwise the - # system is allowed to wait until at least one message is available rather - # than returning no messages. The client may cancel the request if it does - # not wish to wait any longer for the response. + # If this is specified as true the system will respond immediately even if it is + # not able to return a message in the Pull response. Otherwise the system is + # allowed to wait until at least one message is available rather than returning + # no messages. The client may cancel the request if it does not wish to wait any + # longer for the response. # Corresponds to the JSON property `returnImmediately` # @return [Boolean] attr_accessor :return_immediately @@ -436,9 +424,9 @@ module Google include Google::Apis::Core::Hashable # Received Pub/Sub messages or status events. The Pub/Sub system will return - # zero messages if there are no more messages available in the backlog. The - # Pub/Sub system may return fewer than the max_events requested even if - # there are more messages available in the backlog. + # zero messages if there are no more messages available in the backlog. The Pub/ + # Sub system may return fewer than the max_events requested even if there are + # more messages available in the backlog. # Corresponds to the JSON property `pullResponses` # @return [Array] attr_accessor :pull_responses @@ -457,11 +445,11 @@ module Google class PullRequest include Google::Apis::Core::Hashable - # If this is specified as true the system will respond immediately even if - # it is not able to return a message in the Pull response. Otherwise the - # system is allowed to wait until at least one message is available rather - # than returning FAILED_PRECONDITION. The client may cancel the request if - # it does not wish to wait any longer for the response. + # If this is specified as true the system will respond immediately even if it is + # not able to return a message in the Pull response. Otherwise the system is + # allowed to wait until at least one message is available rather than returning + # FAILED_PRECONDITION. The client may cancel the request if it does not wish to + # wait any longer for the response. # Corresponds to the JSON property `returnImmediately` # @return [Boolean] attr_accessor :return_immediately @@ -483,8 +471,8 @@ module Google end end - # Either a PubsubMessage or a truncation event. One of these two - # must be populated. + # Either a PubsubMessage or a truncation event. One of these two must be + # populated. class PullResponse include Google::Apis::Core::Hashable @@ -513,8 +501,8 @@ module Google class PushConfig include Google::Apis::Core::Hashable - # A URL locating the endpoint to which messages should be pushed. - # For example, a Webhook endpoint might use "https://example.com/push". + # A URL locating the endpoint to which messages should be pushed. For example, a + # Webhook endpoint might use "https://example.com/push". # Corresponds to the JSON property `pushEndpoint` # @return [String] attr_accessor :push_endpoint @@ -534,22 +522,19 @@ module Google include Google::Apis::Core::Hashable # For either push or pull delivery, the value is the maximum time after a - # subscriber receives a message before the subscriber should acknowledge or - # Nack the message. If the Ack deadline for a message passes without an - # Ack or a Nack, the Pub/Sub system will eventually redeliver the message. - # If a subscriber acknowledges after the deadline, the Pub/Sub system may - # accept the Ack, but it is possible that the message has been already - # delivered again. Multiple Acks to the message are allowed and will - # succeed. - # For push delivery, this value is used to set the request timeout for - # the call to the push endpoint. - # For pull delivery, this value is used as the initial value for the Ack - # deadline. It may be overridden for each message using its corresponding - # ack_id with ModifyAckDeadline. - # While a message is outstanding (i.e. it has been delivered to a pull - # subscriber and the subscriber has not yet Acked or Nacked), the Pub/Sub - # system will not deliver that message to another pull subscriber - # (on a best-effort basis). + # subscriber receives a message before the subscriber should acknowledge or Nack + # the message. If the Ack deadline for a message passes without an Ack or a Nack, + # the Pub/Sub system will eventually redeliver the message. If a subscriber + # acknowledges after the deadline, the Pub/Sub system may accept the Ack, but it + # is possible that the message has been already delivered again. Multiple Acks + # to the message are allowed and will succeed. For push delivery, this value is + # used to set the request timeout for the call to the push endpoint. For pull + # delivery, this value is used as the initial value for the Ack deadline. It may + # be overridden for each message using its corresponding ack_id with + # ModifyAckDeadline. While a message is outstanding (i.e. it has been delivered + # to a pull subscriber and the subscriber has not yet Acked or Nacked), the Pub/ + # Sub system will not deliver that message to another pull subscriber (on a best- + # effort basis). # Corresponds to the JSON property `ackDeadlineSeconds` # @return [Fixnum] attr_accessor :ack_deadline_seconds diff --git a/generated/google/apis/pubsub_v1beta1a/service.rb b/generated/google/apis/pubsub_v1beta1a/service.rb index e201bb577..1c370a18a 100644 --- a/generated/google/apis/pubsub_v1beta1a/service.rb +++ b/generated/google/apis/pubsub_v1beta1a/service.rb @@ -47,11 +47,11 @@ module Google @batch_path = 'batch' end - # Acknowledges a particular received message: the Pub/Sub system can remove - # the given message from the subscription. Acknowledging a message whose - # Ack deadline has expired may succeed, but the message could have been - # already redelivered. Acknowledging a message more than once will not - # result in an error. This is only used for messages received via pull. + # Acknowledges a particular received message: the Pub/Sub system can remove the + # given message from the subscription. Acknowledging a message whose Ack + # deadline has expired may succeed, but the message could have been already + # redelivered. Acknowledging a message more than once will not result in an + # error. This is only used for messages received via pull. # @param [Google::Apis::PubsubV1beta1a::AcknowledgeRequest] acknowledge_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -81,11 +81,11 @@ module Google execute_or_queue_command(command, &block) end - # Creates a subscription on a given topic for a given subscriber. - # If the subscription already exists, returns ALREADY_EXISTS. - # If the corresponding topic doesn't exist, returns NOT_FOUND. - # If the name is not provided in the request, the server will assign a random - # name for this subscription on the same project as the topic. + # Creates a subscription on a given topic for a given subscriber. If the + # subscription already exists, returns ALREADY_EXISTS. If the corresponding + # topic doesn't exist, returns NOT_FOUND. If the name is not provided in the + # request, the server will assign a random name for this subscription on the + # same project as the topic. # @param [Google::Apis::PubsubV1beta1a::Subscription] subscription_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -115,9 +115,8 @@ module Google execute_or_queue_command(command, &block) end - # Deletes an existing subscription. All pending messages in the subscription - # are immediately dropped. Calls to Pull after deletion will return - # NOT_FOUND. + # Deletes an existing subscription. All pending messages in the subscription are + # immediately dropped. Calls to Pull after deletion will return NOT_FOUND. # @param [String] subscription # The subscription to delete. # @param [String] fields @@ -181,8 +180,7 @@ module Google # @param [Fixnum] max_results # Maximum number of subscriptions to return. # @param [String] page_token - # The value obtained in the last ListSubscriptionsResponse - # for continuation. + # The value obtained in the last ListSubscriptionsResponse for continuation. # @param [String] query # A valid label query expression. # @param [String] fields @@ -244,11 +242,10 @@ module Google execute_or_queue_command(command, &block) end - # Modifies the PushConfig for a specified subscription. - # This method can be used to suspend the flow of messages to an endpoint - # by clearing the PushConfig field in the request. Messages - # will be accumulated for delivery even if no push configuration is - # defined or while the configuration is modified. + # Modifies the PushConfig for a specified subscription. This method can be used + # to suspend the flow of messages to an endpoint by clearing the PushConfig + # field in the request. Messages will be accumulated for delivery even if no + # push configuration is defined or while the configuration is modified. # @param [Google::Apis::PubsubV1beta1a::ModifyPushConfigRequest] modify_push_config_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -278,11 +275,10 @@ module Google execute_or_queue_command(command, &block) end - # Pulls a single message from the server. - # If return_immediately is true, and no messages are available in the - # subscription, this method returns FAILED_PRECONDITION. The system is free - # to return an UNAVAILABLE error if no messages are available in a - # reasonable amount of time (to reduce system load). + # Pulls a single message from the server. If return_immediately is true, and no + # messages are available in the subscription, this method returns + # FAILED_PRECONDITION. The system is free to return an UNAVAILABLE error if no + # messages are available in a reasonable amount of time (to reduce system load). # @param [Google::Apis::PubsubV1beta1a::PullRequest] pull_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -312,9 +308,9 @@ module Google execute_or_queue_command(command, &block) end - # Pulls messages from the server. Returns an empty list if there are no - # messages available in the backlog. The system is free to return UNAVAILABLE - # if there are too many pull requests outstanding for the given subscription. + # Pulls messages from the server. Returns an empty list if there are no messages + # available in the backlog. The system is free to return UNAVAILABLE if there + # are too many pull requests outstanding for the given subscription. # @param [Google::Apis::PubsubV1beta1a::PullBatchRequest] pull_batch_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -374,9 +370,8 @@ module Google execute_or_queue_command(command, &block) end - # Deletes the topic with the given name. Returns NOT_FOUND if the topic does - # not exist. After a topic is deleted, a new topic may be created with the - # same name. + # Deletes the topic with the given name. Returns NOT_FOUND if the topic does not + # exist. After a topic is deleted, a new topic may be created with the same name. # @param [String] topic # Name of the topic to delete. # @param [String] fields @@ -406,9 +401,9 @@ module Google execute_or_queue_command(command, &block) end - # Gets the configuration of a topic. Since the topic only has the name - # attribute, this method is only useful to check the existence of a topic. - # If other attributes are added in the future, they will be returned here. + # Gets the configuration of a topic. Since the topic only has the name attribute, + # this method is only useful to check the existence of a topic. If other + # attributes are added in the future, they will be returned here. # @param [String] topic # The name of the topic to get. # @param [String] fields @@ -442,8 +437,7 @@ module Google # @param [Fixnum] max_results # Maximum number of topics to return. # @param [String] page_token - # The value obtained in the last ListTopicsResponse - # for continuation. + # The value obtained in the last ListTopicsResponse for continuation. # @param [String] query # A valid label query expression. # @param [String] fields @@ -475,8 +469,7 @@ module Google execute_or_queue_command(command, &block) end - # Adds a message to the topic. Returns NOT_FOUND if the topic does not - # exist. + # Adds a message to the topic. Returns NOT_FOUND if the topic does not exist. # @param [Google::Apis::PubsubV1beta1a::PublishRequest] publish_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. diff --git a/generated/google/apis/pubsub_v1beta2.rb b/generated/google/apis/pubsub_v1beta2.rb index 7d824c8df..f2c6803a2 100644 --- a/generated/google/apis/pubsub_v1beta2.rb +++ b/generated/google/apis/pubsub_v1beta2.rb @@ -25,7 +25,7 @@ module Google # @see https://cloud.google.com/pubsub/docs module PubsubV1beta2 VERSION = 'V1beta2' - REVISION = '20200427' + REVISION = '20200807' # 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/pubsub_v1beta2/classes.rb b/generated/google/apis/pubsub_v1beta2/classes.rb index 1553c1612..67f3f8b1a 100644 --- a/generated/google/apis/pubsub_v1beta2/classes.rb +++ b/generated/google/apis/pubsub_v1beta2/classes.rb @@ -26,8 +26,8 @@ module Google class AcknowledgeRequest include Google::Apis::Core::Hashable - # The acknowledgment ID for the messages being acknowledged that was returned - # by the Pub/Sub system in the `Pull` response. Must not be empty. + # The acknowledgment ID for the messages being acknowledged that was returned by + # the Pub/Sub system in the `Pull` response. Must not be empty. # Corresponds to the JSON property `ackIds` # @return [Array] attr_accessor :ack_ids @@ -46,69 +46,57 @@ module Google class Binding include Google::Apis::Core::Hashable - # Represents a textual expression in the Common Expression Language (CEL) - # syntax. CEL is a C-like expression language. The syntax and semantics of CEL - # are documented at https://github.com/google/cel-spec. - # Example (Comparison): - # title: "Summary size limit" - # description: "Determines if a summary is less than 100 chars" - # expression: "document.summary.size() < 100" - # Example (Equality): - # title: "Requestor is owner" - # description: "Determines if requestor is the document owner" - # expression: "document.owner == request.auth.claims.email" - # Example (Logic): - # title: "Public documents" - # description: "Determine whether the document should be publicly visible" - # expression: "document.type != 'private' && document.type != 'internal'" - # Example (Data Manipulation): - # title: "Notification string" - # description: "Create a notification string with a timestamp." - # expression: "'New message received at ' + string(document.create_time)" - # The exact variables and functions that may be referenced within an expression - # are determined by the service that evaluates it. See the service - # documentation for additional information. + # Represents a textual expression in the Common Expression Language (CEL) syntax. + # CEL is a C-like expression language. The syntax and semantics of CEL are + # documented at https://github.com/google/cel-spec. Example (Comparison): title: + # "Summary size limit" description: "Determines if a summary is less than 100 + # chars" expression: "document.summary.size() < 100" Example (Equality): title: " + # Requestor is owner" description: "Determines if requestor is the document + # owner" expression: "document.owner == request.auth.claims.email" Example ( + # Logic): title: "Public documents" description: "Determine whether the document + # should be publicly visible" expression: "document.type != 'private' && + # document.type != 'internal'" Example (Data Manipulation): title: "Notification + # string" description: "Create a notification string with a timestamp." + # expression: "'New message received at ' + string(document.create_time)" The + # exact variables and functions that may be referenced within an expression are + # determined by the service that evaluates it. See the service documentation for + # additional information. # Corresponds to the JSON property `condition` # @return [Google::Apis::PubsubV1beta2::Expr] attr_accessor :condition - # Specifies the identities requesting access for a Cloud Platform resource. - # `members` can have the following values: - # * `allUsers`: A special identifier that represents anyone who is - # on the internet; with or without a Google account. - # * `allAuthenticatedUsers`: A special identifier that represents anyone - # who is authenticated with a Google account or a service account. - # * `user:`emailid``: An email address that represents a specific Google - # account. For example, `alice@example.com` . - # * `serviceAccount:`emailid``: An email address that represents a service - # account. For example, `my-other-app@appspot.gserviceaccount.com`. - # * `group:`emailid``: An email address that represents a Google group. - # For example, `admins@example.com`. - # * `deleted:user:`emailid`?uid=`uniqueid``: An email address (plus unique - # identifier) representing a user that has been recently deleted. For - # example, `alice@example.com?uid=123456789012345678901`. If the user is - # recovered, this value reverts to `user:`emailid`` and the recovered user - # retains the role in the binding. - # * `deleted:serviceAccount:`emailid`?uid=`uniqueid``: An email address (plus - # unique identifier) representing a service account that has been recently - # deleted. For example, - # `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. - # If the service account is undeleted, this value reverts to - # `serviceAccount:`emailid`` and the undeleted service account retains the - # role in the binding. - # * `deleted:group:`emailid`?uid=`uniqueid``: An email address (plus unique - # identifier) representing a Google group that has been recently - # deleted. For example, `admins@example.com?uid=123456789012345678901`. If - # the group is recovered, this value reverts to `group:`emailid`` and the - # recovered group retains the role in the binding. - # * `domain:`domain``: The G Suite domain (primary) that represents all the - # users of that domain. For example, `google.com` or `example.com`. + # Specifies the identities requesting access for a Cloud Platform resource. ` + # members` can have the following values: * `allUsers`: A special identifier + # that represents anyone who is on the internet; with or without a Google + # account. * `allAuthenticatedUsers`: A special identifier that represents + # anyone who is authenticated with a Google account or a service account. * ` + # user:`emailid``: An email address that represents a specific Google account. + # For example, `alice@example.com` . * `serviceAccount:`emailid``: An email + # address that represents a service account. For example, `my-other-app@appspot. + # gserviceaccount.com`. * `group:`emailid``: An email address that represents a + # Google group. For example, `admins@example.com`. * `deleted:user:`emailid`?uid= + # `uniqueid``: An email address (plus unique identifier) representing a user + # that has been recently deleted. For example, `alice@example.com?uid= + # 123456789012345678901`. If the user is recovered, this value reverts to `user:` + # emailid`` and the recovered user retains the role in the binding. * `deleted: + # serviceAccount:`emailid`?uid=`uniqueid``: An email address (plus unique + # identifier) representing a service account that has been recently deleted. For + # example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. + # If the service account is undeleted, this value reverts to `serviceAccount:` + # emailid`` and the undeleted service account retains the role in the binding. * + # `deleted:group:`emailid`?uid=`uniqueid``: An email address (plus unique + # identifier) representing a Google group that has been recently deleted. For + # example, `admins@example.com?uid=123456789012345678901`. If the group is + # recovered, this value reverts to `group:`emailid`` and the recovered group + # retains the role in the binding. * `domain:`domain``: The G Suite domain ( + # primary) that represents all the users of that domain. For example, `google. + # com` or `example.com`. # Corresponds to the JSON property `members` # @return [Array] attr_accessor :members - # Role that is assigned to `members`. - # For example, `roles/viewer`, `roles/editor`, or `roles/owner`. + # Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor` + # , or `roles/owner`. # Corresponds to the JSON property `role` # @return [String] attr_accessor :role @@ -125,13 +113,11 @@ module Google end end - # A generic empty message that you can re-use to avoid defining duplicated - # empty messages in your APIs. A typical example is to use it as the request - # or the response type of an API method. For instance: - # service Foo ` - # rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); - # ` - # The JSON representation for `Empty` is empty JSON object ````. + # A generic empty message that you can re-use to avoid defining duplicated empty + # messages in your APIs. A typical example is to use it as the request or the + # response type of an API method. For instance: service Foo ` rpc Bar(google. + # protobuf.Empty) returns (google.protobuf.Empty); ` The JSON representation for + # `Empty` is empty JSON object ````. class Empty include Google::Apis::Core::Hashable @@ -144,52 +130,43 @@ module Google end end - # Represents a textual expression in the Common Expression Language (CEL) - # syntax. CEL is a C-like expression language. The syntax and semantics of CEL - # are documented at https://github.com/google/cel-spec. - # Example (Comparison): - # title: "Summary size limit" - # description: "Determines if a summary is less than 100 chars" - # expression: "document.summary.size() < 100" - # Example (Equality): - # title: "Requestor is owner" - # description: "Determines if requestor is the document owner" - # expression: "document.owner == request.auth.claims.email" - # Example (Logic): - # title: "Public documents" - # description: "Determine whether the document should be publicly visible" - # expression: "document.type != 'private' && document.type != 'internal'" - # Example (Data Manipulation): - # title: "Notification string" - # description: "Create a notification string with a timestamp." - # expression: "'New message received at ' + string(document.create_time)" - # The exact variables and functions that may be referenced within an expression - # are determined by the service that evaluates it. See the service - # documentation for additional information. + # Represents a textual expression in the Common Expression Language (CEL) syntax. + # CEL is a C-like expression language. The syntax and semantics of CEL are + # documented at https://github.com/google/cel-spec. Example (Comparison): title: + # "Summary size limit" description: "Determines if a summary is less than 100 + # chars" expression: "document.summary.size() < 100" Example (Equality): title: " + # Requestor is owner" description: "Determines if requestor is the document + # owner" expression: "document.owner == request.auth.claims.email" Example ( + # Logic): title: "Public documents" description: "Determine whether the document + # should be publicly visible" expression: "document.type != 'private' && + # document.type != 'internal'" Example (Data Manipulation): title: "Notification + # string" description: "Create a notification string with a timestamp." + # expression: "'New message received at ' + string(document.create_time)" The + # exact variables and functions that may be referenced within an expression are + # determined by the service that evaluates it. See the service documentation for + # additional information. class Expr include Google::Apis::Core::Hashable - # Optional. Description of the expression. This is a longer text which - # describes the expression, e.g. when hovered over it in a UI. + # Optional. Description of the expression. This is a longer text which describes + # the expression, e.g. when hovered over it in a UI. # Corresponds to the JSON property `description` # @return [String] attr_accessor :description - # Textual representation of an expression in Common Expression Language - # syntax. + # Textual representation of an expression in Common Expression Language syntax. # Corresponds to the JSON property `expression` # @return [String] attr_accessor :expression - # Optional. String indicating the location of the expression for error - # reporting, e.g. a file name and a position in the file. + # Optional. String indicating the location of the expression for error reporting, + # e.g. a file name and a position in the file. # Corresponds to the JSON property `location` # @return [String] attr_accessor :location - # Optional. Title for the expression, i.e. a short string describing - # its purpose. This can be used e.g. in UIs which allow to enter the - # expression. + # Optional. Title for the expression, i.e. a short string describing its purpose. + # This can be used e.g. in UIs which allow to enter the expression. # Corresponds to the JSON property `title` # @return [String] attr_accessor :title @@ -211,9 +188,9 @@ module Google class ListSubscriptionsResponse include Google::Apis::Core::Hashable - # If not empty, indicates that there may be more subscriptions that match - # the request; this value should be passed in a new - # `ListSubscriptionsRequest` to get more subscriptions. + # If not empty, indicates that there may be more subscriptions that match the + # request; this value should be passed in a new `ListSubscriptionsRequest` to + # get more subscriptions. # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token @@ -238,9 +215,9 @@ module Google class ListTopicSubscriptionsResponse include Google::Apis::Core::Hashable - # If not empty, indicates that there may be more subscriptions that match - # the request; this value should be passed in a new - # `ListTopicSubscriptionsRequest` to get more subscriptions. + # If not empty, indicates that there may be more subscriptions that match the + # request; this value should be passed in a new `ListTopicSubscriptionsRequest` + # to get more subscriptions. # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token @@ -265,8 +242,8 @@ module Google class ListTopicsResponse include Google::Apis::Core::Hashable - # If not empty, indicates that there may be more topics that match the - # request; this value should be passed in a new `ListTopicsRequest`. + # If not empty, indicates that there may be more topics that match the request; + # this value should be passed in a new `ListTopicsRequest`. # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token @@ -291,17 +268,16 @@ module Google class ModifyAckDeadlineRequest include Google::Apis::Core::Hashable - # The new ack deadline with respect to the time this request was sent to - # the Pub/Sub system. Must be >= 0. For example, if the value is 10, the new - # ack deadline will expire 10 seconds after the `ModifyAckDeadline` call - # was made. Specifying zero may immediately make the message available for - # another pull request. + # The new ack deadline with respect to the time this request was sent to the Pub/ + # Sub system. Must be >= 0. For example, if the value is 10, the new ack + # deadline will expire 10 seconds after the `ModifyAckDeadline` call was made. + # Specifying zero may immediately make the message available for another pull + # request. # Corresponds to the JSON property `ackDeadlineSeconds` # @return [Fixnum] attr_accessor :ack_deadline_seconds - # The acknowledgment ID. Either this or ack_ids must be populated, but not - # both. + # The acknowledgment ID. Either this or ack_ids must be populated, but not both. # Corresponds to the JSON property `ackId` # @return [String] attr_accessor :ack_id @@ -342,27 +318,25 @@ module Google end end - # Contains information needed for generating an - # [OpenID Connect - # token](https://developers.google.com/identity/protocols/OpenIDConnect). + # Contains information needed for generating an [OpenID Connect token](https:// + # developers.google.com/identity/protocols/OpenIDConnect). class OidcToken include Google::Apis::Core::Hashable - # Audience to be used when generating OIDC token. The audience claim - # identifies the recipients that the JWT is intended for. The audience - # value is a single case-sensitive string. Having multiple values (array) - # for the audience field is not supported. More info about the OIDC JWT - # token audience here: https://tools.ietf.org/html/rfc7519#section-4.1.3 - # Note: if not specified, the Push endpoint URL will be used. + # Audience to be used when generating OIDC token. The audience claim identifies + # the recipients that the JWT is intended for. The audience value is a single + # case-sensitive string. Having multiple values (array) for the audience field + # is not supported. More info about the OIDC JWT token audience here: https:// + # tools.ietf.org/html/rfc7519#section-4.1.3 Note: if not specified, the Push + # endpoint URL will be used. # Corresponds to the JSON property `audience` # @return [String] attr_accessor :audience - # [Service account - # email](https://cloud.google.com/iam/docs/service-accounts) - # to be used for generating the OIDC token. The caller (for - # CreateSubscription, UpdateSubscription, and ModifyPushConfig RPCs) must - # have the iam.serviceAccounts.actAs permission for the service account. + # [Service account email](https://cloud.google.com/iam/docs/service-accounts) to + # be used for generating the OIDC token. The caller (for CreateSubscription, + # UpdateSubscription, and ModifyPushConfig RPCs) must have the iam. + # serviceAccounts.actAs permission for the service account. # Corresponds to the JSON property `serviceAccountEmail` # @return [String] attr_accessor :service_account_email @@ -379,111 +353,73 @@ module Google end # An Identity and Access Management (IAM) policy, which specifies access - # controls for Google Cloud resources. - # A `Policy` is a collection of `bindings`. A `binding` binds one or more - # `members` to a single `role`. Members can be user accounts, service accounts, - # 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. - # 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": [ - # ` - # "role": "roles/resourcemanager.organizationAdmin", - # "members": [ - # "user:mike@example.com", - # "group:admins@example.com", - # "domain:google.com", - # "serviceAccount:my-project-id@appspot.gserviceaccount.com" - # ] - # `, - # ` - # "role": "roles/resourcemanager.organizationViewer", - # "members": [ - # "user:eve@example.com" - # ], - # "condition": ` - # "title": "expirable access", - # "description": "Does not grant access after Sep 2020", - # "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z') - # ", - # ` - # ` - # ], - # "etag": "BwWWja0YfJA=", - # "version": 3 - # ` - # **YAML example:** - # bindings: - # - members: - # - user:mike@example.com - # - group:admins@example.com - # - domain:google.com - # - serviceAccount:my-project-id@appspot.gserviceaccount.com - # role: roles/resourcemanager.organizationAdmin - # - members: - # - user:eve@example.com - # role: roles/resourcemanager.organizationViewer - # condition: - # title: expirable access - # description: Does not grant access after Sep 2020 - # expression: request.time < timestamp('2020-10-01T00:00:00.000Z') - # - etag: BwWWja0YfJA= - # - version: 3 - # For a description of IAM and its features, see the - # [IAM documentation](https://cloud.google.com/iam/docs/). + # controls for Google Cloud resources. A `Policy` is a collection of `bindings`. + # A `binding` binds one or more `members` to a single `role`. Members can be + # user accounts, service accounts, 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. 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": [ ` "role": "roles/ + # resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", " + # group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@ + # appspot.gserviceaccount.com" ] `, ` "role": "roles/resourcemanager. + # organizationViewer", "members": [ "user:eve@example.com" ], "condition": ` " + # title": "expirable access", "description": "Does not grant access after Sep + # 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", ` + # ` ], "etag": "BwWWja0YfJA=", "version": 3 ` **YAML example:** bindings: - + # members: - user:mike@example.com - group:admins@example.com - domain:google. + # com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/ + # resourcemanager.organizationAdmin - members: - user:eve@example.com role: + # roles/resourcemanager.organizationViewer condition: title: expirable access + # description: Does not grant access after Sep 2020 expression: request.time < + # timestamp('2020-10-01T00:00:00.000Z') - etag: BwWWja0YfJA= - version: 3 For a + # description of IAM and its features, see the [IAM documentation](https://cloud. + # google.com/iam/docs/). class Policy include Google::Apis::Core::Hashable - # Associates a list of `members` to a `role`. Optionally, may specify a - # `condition` that determines how and when the `bindings` are applied. Each - # of the `bindings` must contain at least one member. + # Associates a list of `members` to a `role`. Optionally, may specify a ` + # condition` that determines how and when the `bindings` are applied. Each of + # the `bindings` must contain at least one member. # Corresponds to the JSON property `bindings` # @return [Array] attr_accessor :bindings - # `etag` is used for optimistic concurrency control as a way to help - # prevent simultaneous updates of a policy from overwriting each other. - # It is strongly suggested that systems make use of the `etag` in the - # read-modify-write cycle to perform policy updates in order to avoid race - # conditions: An `etag` is returned in the response to `getIamPolicy`, and - # systems are expected to put that etag in the request to `setIamPolicy` to - # ensure that their change will be applied to the same version of the policy. - # **Important:** If you use IAM Conditions, you must include the `etag` field - # whenever you call `setIamPolicy`. If you omit this field, then IAM allows - # you to overwrite a version `3` policy with a version `1` policy, and all of - # the conditions in the version `3` policy are lost. + # `etag` is used for optimistic concurrency control as a way to help prevent + # simultaneous updates of a policy from overwriting each other. It is strongly + # suggested that systems make use of the `etag` in the read-modify-write cycle + # to perform policy updates in order to avoid race conditions: An `etag` is + # returned in the response to `getIamPolicy`, and systems are expected to put + # that etag in the request to `setIamPolicy` to ensure that their change will be + # applied to the same version of the policy. **Important:** If you use IAM + # Conditions, you must include the `etag` field whenever you call `setIamPolicy`. + # If you omit this field, then IAM allows you to overwrite a version `3` policy + # with a version `1` policy, and all of the conditions in the version `3` policy + # are lost. # Corresponds to the JSON property `etag` # NOTE: Values are automatically base64 encoded/decoded in the client library. # @return [String] attr_accessor :etag - # Specifies the format of the policy. - # Valid values are `0`, `1`, and `3`. Requests that specify an invalid value - # are rejected. - # Any operation that affects conditional role bindings must specify version - # `3`. This requirement applies to the following operations: - # * Getting a policy that includes a conditional role binding - # * Adding a conditional role binding to a policy - # * Changing a conditional role binding in a policy - # * Removing any role binding, with or without a condition, from a policy - # that includes conditions - # **Important:** If you use IAM Conditions, you must include the `etag` field - # whenever you call `setIamPolicy`. If you omit this field, then IAM allows - # you to overwrite a version `3` policy with a version `1` policy, and all of - # 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). + # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. + # Requests that specify an invalid value are rejected. Any operation that + # affects conditional role bindings must specify version `3`. This requirement + # applies to the following operations: * Getting a policy that includes a + # conditional role binding * Adding a conditional role binding to a policy * + # Changing a conditional role binding in a policy * Removing any role binding, + # with or without a condition, from a policy that includes conditions ** + # Important:** If you use IAM Conditions, you must include the `etag` field + # whenever you call `setIamPolicy`. If you omit this field, then IAM allows you + # to overwrite a version `3` policy with a version `1` policy, and all of 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 @@ -523,9 +459,8 @@ module Google class PublishResponse include Google::Apis::Core::Hashable - # The server-assigned ID of each published message, in the same order as - # the messages in the request. IDs are guaranteed to be unique within - # the topic. + # The server-assigned ID of each published message, in the same order as the + # messages in the request. IDs are guaranteed to be unique within the topic. # Corresponds to the JSON property `messageIds` # @return [Array] attr_accessor :message_ids @@ -540,8 +475,8 @@ module Google end end - # A message data and its attributes. The message payload must not be empty; - # it must contain either a non-empty data field, or at least one attribute. + # A message data and its attributes. The message payload must not be empty; it + # must contain either a non-empty data field, or at least one attribute. class PubsubMessage include Google::Apis::Core::Hashable @@ -550,8 +485,8 @@ module Google # @return [Hash] attr_accessor :attributes - # The message payload. For JSON requests, the value of this field must be - # [base64-encoded](https://tools.ietf.org/html/rfc4648). + # The message payload. For JSON requests, the value of this field must be [ + # base64-encoded](https://tools.ietf.org/html/rfc4648). # Corresponds to the JSON property `data` # NOTE: Values are automatically base64 encoded/decoded in the client library. # @return [String] @@ -565,9 +500,9 @@ module Google # @return [String] attr_accessor :message_id - # The time at which the message was published, populated by the server when - # it receives the `Publish` call. It must not be populated by the - # publisher in a `Publish` call. + # The time at which the message was published, populated by the server when it + # receives the `Publish` call. It must not be populated by the publisher in a ` + # Publish` call. # Corresponds to the JSON property `publishTime` # @return [String] attr_accessor :publish_time @@ -589,20 +524,19 @@ module Google class PullRequest include Google::Apis::Core::Hashable - # The maximum number of messages returned for this request. The Pub/Sub - # system may return fewer than the number specified. + # The maximum number of messages returned for this request. The Pub/Sub system + # may return fewer than the number specified. # Corresponds to the JSON property `maxMessages` # @return [Fixnum] attr_accessor :max_messages # Optional. If this is specified as true the system will respond immediately - # even if - # it is not able to return a message in the `Pull` response. Otherwise the - # system is allowed to wait until at least one message is available rather - # than returning no messages. The client may cancel the request if it does - # not wish to wait any longer for the response. Warning: setting this field - # to `true` is discouraged because it adversely impacts the performance of - # `Pull` operations. We recommend that users do not set this field. + # even if it is not able to return a message in the `Pull` response. Otherwise + # the system is allowed to wait until at least one message is available rather + # than returning no messages. The client may cancel the request if it does not + # wish to wait any longer for the response. Warning: setting this field to `true` + # is discouraged because it adversely impacts the performance of `Pull` + # operations. We recommend that users do not set this field. # Corresponds to the JSON property `returnImmediately` # @return [Boolean] attr_accessor :return_immediately @@ -645,36 +579,32 @@ module Google class PushConfig include Google::Apis::Core::Hashable - # Endpoint configuration attributes. - # Every endpoint has a set of API supported attributes that can be used to - # control different aspects of the message delivery. - # The currently supported attribute is `x-goog-version`, which you can - # use to change the format of the push message. This attribute - # indicates the version of the data expected by the endpoint. This - # controls the shape of the envelope (i.e. its fields and metadata). - # The endpoint version is based on the version of the Pub/Sub + # Endpoint configuration attributes. Every endpoint has a set of API supported + # attributes that can be used to control different aspects of the message + # delivery. The currently supported attribute is `x-goog-version`, which you can + # use to change the format of the push message. This attribute indicates the + # version of the data expected by the endpoint. This controls the shape of the + # envelope (i.e. its fields and metadata). The endpoint version is based on the + # version of the Pub/Sub API. If not present during the `CreateSubscription` + # call, it will default to the version of the API used to make such call. If not + # present during a `ModifyPushConfig` call, its value will not be changed. ` + # GetSubscription` calls will always return a valid version, even if the + # subscription was created without this attribute. The possible values for this + # attribute are: * `v1beta1`: uses the push format defined in the v1beta1 Pub/ + # Sub API. * `v1` or `v1beta2`: uses the push format defined in the v1 Pub/Sub # API. - # If not present during the `CreateSubscription` call, it will default to - # the version of the API used to make such call. If not present during a - # `ModifyPushConfig` call, its value will not be changed. `GetSubscription` - # calls will always return a valid version, even if the subscription was - # created without this attribute. - # The possible values for this attribute are: - # * `v1beta1`: uses the push format defined in the v1beta1 Pub/Sub API. - # * `v1` or `v1beta2`: uses the push format defined in the v1 Pub/Sub API. # Corresponds to the JSON property `attributes` # @return [Hash] attr_accessor :attributes - # Contains information needed for generating an - # [OpenID Connect - # token](https://developers.google.com/identity/protocols/OpenIDConnect). + # Contains information needed for generating an [OpenID Connect token](https:// + # developers.google.com/identity/protocols/OpenIDConnect). # Corresponds to the JSON property `oidcToken` # @return [Google::Apis::PubsubV1beta2::OidcToken] attr_accessor :oidc_token - # A URL locating the endpoint to which messages should be pushed. - # For example, a Webhook endpoint might use "https://example.com/push". + # A URL locating the endpoint to which messages should be pushed. For example, a + # Webhook endpoint might use "https://example.com/push". # Corresponds to the JSON property `pushEndpoint` # @return [String] attr_accessor :push_endpoint @@ -700,8 +630,8 @@ module Google # @return [String] attr_accessor :ack_id - # A message data and its attributes. The message payload must not be empty; - # it must contain either a non-empty data field, or at least one attribute. + # A message data and its attributes. The message payload must not be empty; it + # must contain either a non-empty data field, or at least one attribute. # Corresponds to the JSON property `message` # @return [Google::Apis::PubsubV1beta2::PubsubMessage] attr_accessor :message @@ -722,66 +652,32 @@ module Google include Google::Apis::Core::Hashable # An Identity and Access Management (IAM) policy, which specifies access - # controls for Google Cloud resources. - # A `Policy` is a collection of `bindings`. A `binding` binds one or more - # `members` to a single `role`. Members can be user accounts, service accounts, - # 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. - # 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": [ - # ` - # "role": "roles/resourcemanager.organizationAdmin", - # "members": [ - # "user:mike@example.com", - # "group:admins@example.com", - # "domain:google.com", - # "serviceAccount:my-project-id@appspot.gserviceaccount.com" - # ] - # `, - # ` - # "role": "roles/resourcemanager.organizationViewer", - # "members": [ - # "user:eve@example.com" - # ], - # "condition": ` - # "title": "expirable access", - # "description": "Does not grant access after Sep 2020", - # "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z') - # ", - # ` - # ` - # ], - # "etag": "BwWWja0YfJA=", - # "version": 3 - # ` - # **YAML example:** - # bindings: - # - members: - # - user:mike@example.com - # - group:admins@example.com - # - domain:google.com - # - serviceAccount:my-project-id@appspot.gserviceaccount.com - # role: roles/resourcemanager.organizationAdmin - # - members: - # - user:eve@example.com - # role: roles/resourcemanager.organizationViewer - # condition: - # title: expirable access - # description: Does not grant access after Sep 2020 - # expression: request.time < timestamp('2020-10-01T00:00:00.000Z') - # - etag: BwWWja0YfJA= - # - version: 3 - # For a description of IAM and its features, see the - # [IAM documentation](https://cloud.google.com/iam/docs/). + # controls for Google Cloud resources. A `Policy` is a collection of `bindings`. + # A `binding` binds one or more `members` to a single `role`. Members can be + # user accounts, service accounts, 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. 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": [ ` "role": "roles/ + # resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", " + # group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@ + # appspot.gserviceaccount.com" ] `, ` "role": "roles/resourcemanager. + # organizationViewer", "members": [ "user:eve@example.com" ], "condition": ` " + # title": "expirable access", "description": "Does not grant access after Sep + # 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", ` + # ` ], "etag": "BwWWja0YfJA=", "version": 3 ` **YAML example:** bindings: - + # members: - user:mike@example.com - group:admins@example.com - domain:google. + # com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/ + # resourcemanager.organizationAdmin - members: - user:eve@example.com role: + # roles/resourcemanager.organizationViewer condition: title: expirable access + # description: Does not grant access after Sep 2020 expression: request.time < + # timestamp('2020-10-01T00:00:00.000Z') - etag: BwWWja0YfJA= - version: 3 For a + # description of IAM and its features, see the [IAM documentation](https://cloud. + # google.com/iam/docs/). # Corresponds to the JSON property `policy` # @return [Google::Apis::PubsubV1beta2::Policy] attr_accessor :policy @@ -800,30 +696,28 @@ module Google class Subscription include Google::Apis::Core::Hashable - # This value is the maximum time after a subscriber receives a message - # before the subscriber should acknowledge the message. After message - # delivery but before the ack deadline expires and before the message is - # acknowledged, it is an outstanding message and will not be delivered - # again during that time (on a best-effort basis). - # For pull subscriptions, this value is used as the initial value for the ack - # deadline. To override this value for a given message, call - # `ModifyAckDeadline` with the corresponding `ack_id` if using pull. - # The maximum custom deadline you can specify is 600 seconds (10 minutes). - # For push delivery, this value is also used to set the request timeout for - # the call to the push endpoint. - # If the subscriber never acknowledges the message, the Pub/Sub - # system will eventually redeliver the message. - # If this parameter is 0, a default value of 10 seconds is used. + # This value is the maximum time after a subscriber receives a message before + # the subscriber should acknowledge the message. After message delivery but + # before the ack deadline expires and before the message is acknowledged, it is + # an outstanding message and will not be delivered again during that time (on a + # best-effort basis). For pull subscriptions, this value is used as the initial + # value for the ack deadline. To override this value for a given message, call ` + # ModifyAckDeadline` with the corresponding `ack_id` if using pull. The maximum + # custom deadline you can specify is 600 seconds (10 minutes). For push delivery, + # this value is also used to set the request timeout for the call to the push + # endpoint. If the subscriber never acknowledges the message, the Pub/Sub system + # will eventually redeliver the message. If this parameter is 0, a default value + # of 10 seconds is used. # Corresponds to the JSON property `ackDeadlineSeconds` # @return [Fixnum] attr_accessor :ack_deadline_seconds - # The name of the subscription. It must have the format - # `"projects/`project`/subscriptions/`subscription`"`. ``subscription`` must - # start with a letter, and contain only letters (`[A-Za-z]`), numbers - # (`[0-9]`), dashes (`-`), underscores (`_`), periods (`.`), tildes (`~`), - # plus (`+`) or percent signs (`%`). It must be between 3 and 255 characters - # in length, and it must not start with `"goog"`. + # The name of the subscription. It must have the format `"projects/`project`/ + # subscriptions/`subscription`"`. ``subscription`` must start with a letter, and + # contain only letters (`[A-Za-z]`), numbers (`[0-9]`), dashes (`-`), + # underscores (`_`), periods (`.`), tildes (`~`), plus (`+`) or percent signs (`% + # `). It must be between 3 and 255 characters in length, and it must not start + # with `"goog"`. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name @@ -833,9 +727,8 @@ module Google # @return [Google::Apis::PubsubV1beta2::PushConfig] attr_accessor :push_config - # The name of the topic from which this subscription is receiving messages. - # The value of this field will be `_deleted-topic_` if the topic has been - # deleted. + # The name of the topic from which this subscription is receiving messages. The + # value of this field will be `_deleted-topic_` if the topic has been deleted. # Corresponds to the JSON property `topic` # @return [String] attr_accessor :topic @@ -857,10 +750,9 @@ module Google class TestIamPermissionsRequest include Google::Apis::Core::Hashable - # The set of permissions to check for the `resource`. Permissions with - # wildcards (such as '*' or 'storage.*') are not allowed. For more - # information see - # [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions). + # The set of permissions to check for the `resource`. Permissions with wildcards + # (such as '*' or 'storage.*') are not allowed. For more information see [IAM + # Overview](https://cloud.google.com/iam/docs/overview#permissions). # Corresponds to the JSON property `permissions` # @return [Array] attr_accessor :permissions @@ -879,8 +771,7 @@ module Google class TestIamPermissionsResponse include Google::Apis::Core::Hashable - # A subset of `TestPermissionsRequest.permissions` that the caller is - # allowed. + # A subset of `TestPermissionsRequest.permissions` that the caller is allowed. # Corresponds to the JSON property `permissions` # @return [Array] attr_accessor :permissions @@ -899,12 +790,11 @@ module Google class Topic include Google::Apis::Core::Hashable - # The name of the topic. It must have the format - # `"projects/`project`/topics/`topic`"`. ``topic`` must start with a letter, - # and contain only letters (`[A-Za-z]`), numbers (`[0-9]`), dashes (`-`), - # underscores (`_`), periods (`.`), tildes (`~`), plus (`+`) or percent - # signs (`%`). It must be between 3 and 255 characters in length, and it - # must not start with `"goog"`. + # The name of the topic. It must have the format `"projects/`project`/topics/` + # topic`"`. ``topic`` must start with a letter, and contain only letters (`[A-Za- + # z]`), numbers (`[0-9]`), dashes (`-`), underscores (`_`), periods (`.`), + # tildes (`~`), plus (`+`) or percent signs (`%`). It must be between 3 and 255 + # characters in length, and it must not start with `"goog"`. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name diff --git a/generated/google/apis/pubsub_v1beta2/service.rb b/generated/google/apis/pubsub_v1beta2/service.rb index f7000c8df..bc5de2a21 100644 --- a/generated/google/apis/pubsub_v1beta2/service.rb +++ b/generated/google/apis/pubsub_v1beta2/service.rb @@ -47,12 +47,11 @@ module Google @batch_path = 'batch' end - # Acknowledges the messages associated with the `ack_ids` in the - # `AcknowledgeRequest`. The Pub/Sub system can remove the relevant messages - # from the subscription. - # Acknowledging a message whose ack deadline has expired may succeed, - # but such a message may be redelivered later. Acknowledging a message more - # than once will not result in an error. + # Acknowledges the messages associated with the `ack_ids` in the ` + # AcknowledgeRequest`. The Pub/Sub system can remove the relevant messages from + # the subscription. Acknowledging a message whose ack deadline has expired may + # succeed, but such a message may be redelivered later. Acknowledging a message + # more than once will not result in an error. # @param [String] subscription # The subscription whose message is being acknowledged. # @param [Google::Apis::PubsubV1beta2::AcknowledgeRequest] acknowledge_request_object @@ -85,19 +84,18 @@ module Google execute_or_queue_command(command, &block) end - # Creates a subscription to a given topic. - # If the subscription already exists, returns `ALREADY_EXISTS`. - # If the corresponding topic doesn't exist, returns `NOT_FOUND`. - # If the name is not provided in the request, the server will assign a random - # name for this subscription on the same project as the topic. Note that - # for REST API requests, you must specify a name. + # Creates a subscription to a given topic. If the subscription already exists, + # returns `ALREADY_EXISTS`. If the corresponding topic doesn't exist, returns ` + # NOT_FOUND`. If the name is not provided in the request, the server will assign + # a random name for this subscription on the same project as the topic. Note + # that for REST API requests, you must specify a name. # @param [String] name - # The name of the subscription. It must have the format - # `"projects/`project`/subscriptions/`subscription`"`. ``subscription`` must - # start with a letter, and contain only letters (`[A-Za-z]`), numbers - # (`[0-9]`), dashes (`-`), underscores (`_`), periods (`.`), tildes (`~`), - # plus (`+`) or percent signs (`%`). It must be between 3 and 255 characters - # in length, and it must not start with `"goog"`. + # The name of the subscription. It must have the format `"projects/`project`/ + # subscriptions/`subscription`"`. ``subscription`` must start with a letter, and + # contain only letters (`[A-Za-z]`), numbers (`[0-9]`), dashes (`-`), + # underscores (`_`), periods (`.`), tildes (`~`), plus (`+`) or percent signs (`% + # `). It must be between 3 and 255 characters in length, and it must not start + # with `"goog"`. # @param [Google::Apis::PubsubV1beta2::Subscription] subscription_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -128,11 +126,11 @@ module Google execute_or_queue_command(command, &block) end - # Deletes an existing subscription. All pending messages in the subscription - # are immediately dropped. Calls to `Pull` after deletion will return - # `NOT_FOUND`. After a subscription is deleted, a new one may be created with - # the same name, but the new one has no association with the old - # subscription, or its topic unless the same topic is specified. + # Deletes an existing subscription. All pending messages in the subscription are + # immediately dropped. Calls to `Pull` after deletion will return `NOT_FOUND`. + # After a subscription is deleted, a new one may be created with the same name, + # but the new one has no association with the old subscription, or its topic + # unless the same topic is specified. # @param [String] subscription # The subscription to delete. # @param [String] fields @@ -192,22 +190,19 @@ module Google execute_or_queue_command(command, &block) end - # Gets the access control policy for a resource. - # Returns an empty policy if the resource exists and does not have a policy - # set. + # Gets the access control policy for a resource. Returns an empty policy if the + # resource exists and does not have a policy set. # @param [String] resource - # REQUIRED: The resource for which the policy is being requested. - # See the operation documentation for the appropriate value for this field. + # REQUIRED: The resource for which the policy is being requested. See the + # operation documentation for the appropriate value for this field. # @param [Fixnum] options_requested_policy_version - # Optional. The policy format version to be returned. - # Valid values are 0, 1, and 3. Requests specifying an invalid value will be - # rejected. - # 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). + # Optional. The policy format version to be returned. Valid values are 0, 1, and + # 3. Requests specifying an invalid value will be rejected. 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 @@ -274,11 +269,11 @@ module Google execute_or_queue_command(command, &block) end - # Modifies the ack deadline for a specific message. This method is useful - # to indicate that more time is needed to process a message by the - # subscriber, or to make the message available for redelivery if the - # processing was interrupted. Note that this does not modify the - # subscription-level `ackDeadlineSeconds` used for subsequent messages. + # Modifies the ack deadline for a specific message. This method is useful to + # indicate that more time is needed to process a message by the subscriber, or + # to make the message available for redelivery if the processing was interrupted. + # Note that this does not modify the subscription-level `ackDeadlineSeconds` + # used for subsequent messages. # @param [String] subscription # The name of the subscription. # @param [Google::Apis::PubsubV1beta2::ModifyAckDeadlineRequest] modify_ack_deadline_request_object @@ -311,11 +306,11 @@ module Google execute_or_queue_command(command, &block) end - # Modifies the `PushConfig` for a specified subscription. - # This may be used to change a push subscription to a pull one (signified by - # an empty `PushConfig`) or vice versa, or change the endpoint URL and other - # attributes of a push subscription. Messages will accumulate for delivery - # continuously through the call regardless of changes to the `PushConfig`. + # Modifies the `PushConfig` for a specified subscription. This may be used to + # change a push subscription to a pull one (signified by an empty `PushConfig`) + # or vice versa, or change the endpoint URL and other attributes of a push + # subscription. Messages will accumulate for delivery continuously through the + # call regardless of changes to the `PushConfig`. # @param [String] subscription # The name of the subscription. # @param [Google::Apis::PubsubV1beta2::ModifyPushConfigRequest] modify_push_config_request_object @@ -348,10 +343,9 @@ module Google execute_or_queue_command(command, &block) end - # Pulls messages from the server. Returns an empty list if there are no - # messages available in the backlog. The server may return `UNAVAILABLE` if - # there are too many concurrent pull requests pending for the given - # subscription. + # Pulls messages from the server. Returns an empty list if there are no messages + # available in the backlog. The server may return `UNAVAILABLE` if there are too + # many concurrent pull requests pending for the given subscription. # @param [String] subscription # The subscription from which messages should be pulled. # @param [Google::Apis::PubsubV1beta2::PullRequest] pull_request_object @@ -385,11 +379,11 @@ module Google end # Sets the access control policy on the specified resource. Replaces any - # existing policy. - # Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors. + # existing policy. 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. + # REQUIRED: The resource for which the policy is being specified. See the + # operation documentation for the appropriate value for this field. # @param [Google::Apis::PubsubV1beta2::SetIamPolicyRequest] set_iam_policy_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -420,15 +414,14 @@ module Google execute_or_queue_command(command, &block) end - # 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. - # 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. + # 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. 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. # @param [String] resource - # REQUIRED: The resource for which the policy detail is being requested. - # See the operation documentation for the appropriate value for this field. + # REQUIRED: The resource for which the policy detail is being requested. See the + # operation documentation for the appropriate value for this field. # @param [Google::Apis::PubsubV1beta2::TestIamPermissionsRequest] test_iam_permissions_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -461,12 +454,11 @@ module Google # Creates the given topic with the given name. # @param [String] name - # The name of the topic. It must have the format - # `"projects/`project`/topics/`topic`"`. ``topic`` must start with a letter, - # and contain only letters (`[A-Za-z]`), numbers (`[0-9]`), dashes (`-`), - # underscores (`_`), periods (`.`), tildes (`~`), plus (`+`) or percent - # signs (`%`). It must be between 3 and 255 characters in length, and it - # must not start with `"goog"`. + # The name of the topic. It must have the format `"projects/`project`/topics/` + # topic`"`. ``topic`` must start with a letter, and contain only letters (`[A-Za- + # z]`), numbers (`[0-9]`), dashes (`-`), underscores (`_`), periods (`.`), + # tildes (`~`), plus (`+`) or percent signs (`%`). It must be between 3 and 255 + # characters in length, and it must not start with `"goog"`. # @param [Google::Apis::PubsubV1beta2::Topic] topic_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -497,11 +489,11 @@ module Google execute_or_queue_command(command, &block) end - # Deletes the topic with the given name. Returns `NOT_FOUND` if the topic - # does not exist. After a topic is deleted, a new topic may be created with - # the same name; this is an entirely new topic with none of the old - # configuration or subscriptions. Existing subscriptions to this topic are - # not deleted, but their `topic` field is set to `_deleted-topic_`. + # Deletes the topic with the given name. Returns `NOT_FOUND` if the topic does + # not exist. After a topic is deleted, a new topic may be created with the same + # name; this is an entirely new topic with none of the old configuration or + # subscriptions. Existing subscriptions to this topic are not deleted, but their + # `topic` field is set to `_deleted-topic_`. # @param [String] topic # Name of the topic to delete. # @param [String] fields @@ -561,22 +553,19 @@ module Google execute_or_queue_command(command, &block) end - # Gets the access control policy for a resource. - # Returns an empty policy if the resource exists and does not have a policy - # set. + # Gets the access control policy for a resource. Returns an empty policy if the + # resource exists and does not have a policy set. # @param [String] resource - # REQUIRED: The resource for which the policy is being requested. - # See the operation documentation for the appropriate value for this field. + # REQUIRED: The resource for which the policy is being requested. See the + # operation documentation for the appropriate value for this field. # @param [Fixnum] options_requested_policy_version - # Optional. The policy format version to be returned. - # Valid values are 0, 1, and 3. Requests specifying an invalid value will be - # rejected. - # 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). + # Optional. The policy format version to be returned. Valid values are 0, 1, and + # 3. Requests specifying an invalid value will be rejected. 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 @@ -611,9 +600,9 @@ module Google # @param [Fixnum] page_size # Maximum number of topics to return. # @param [String] page_token - # The value returned by the last `ListTopicsResponse`; indicates that this is - # a continuation of a prior `ListTopics` call, and that the system should - # return the next page of data. + # The value returned by the last `ListTopicsResponse`; indicates that this is a + # continuation of a prior `ListTopics` call, and that the system should return + # the next page of data. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -643,9 +632,9 @@ module Google execute_or_queue_command(command, &block) end - # Adds one or more messages to the topic. Returns `NOT_FOUND` if the topic - # does not exist. The message payload must not be empty; it must contain - # either a non-empty data field, or at least one attribute. + # Adds one or more messages to the topic. Returns `NOT_FOUND` if the topic does + # not exist. The message payload must not be empty; it must contain either a non- + # empty data field, or at least one attribute. # @param [String] topic # The messages in the request will be published on this topic. # @param [Google::Apis::PubsubV1beta2::PublishRequest] publish_request_object @@ -679,11 +668,11 @@ module Google end # Sets the access control policy on the specified resource. Replaces any - # existing policy. - # Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors. + # existing policy. 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. + # REQUIRED: The resource for which the policy is being specified. See the + # operation documentation for the appropriate value for this field. # @param [Google::Apis::PubsubV1beta2::SetIamPolicyRequest] set_iam_policy_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -714,15 +703,14 @@ module Google execute_or_queue_command(command, &block) end - # 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. - # 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. + # 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. 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. # @param [String] resource - # REQUIRED: The resource for which the policy detail is being requested. - # See the operation documentation for the appropriate value for this field. + # REQUIRED: The resource for which the policy detail is being requested. See the + # operation documentation for the appropriate value for this field. # @param [Google::Apis::PubsubV1beta2::TestIamPermissionsRequest] test_iam_permissions_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -760,8 +748,8 @@ module Google # Maximum number of subscription names to return. # @param [String] page_token # The value returned by the last `ListTopicSubscriptionsResponse`; indicates - # that this is a continuation of a prior `ListTopicSubscriptions` call, and - # that the system should return the next page of data. + # that this is a continuation of a prior `ListTopicSubscriptions` call, and that + # the system should return the next page of data. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user diff --git a/generated/google/apis/spanner_v1.rb b/generated/google/apis/spanner_v1.rb index 535c16fdf..5fbcb4ce1 100644 --- a/generated/google/apis/spanner_v1.rb +++ b/generated/google/apis/spanner_v1.rb @@ -26,7 +26,7 @@ module Google # @see https://cloud.google.com/spanner/ module SpannerV1 VERSION = 'V1' - REVISION = '20200722' + REVISION = '20200807' # 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/spanner_v1/classes.rb b/generated/google/apis/spanner_v1/classes.rb index 96c427a9f..9a43047ca 100644 --- a/generated/google/apis/spanner_v1/classes.rb +++ b/generated/google/apis/spanner_v1/classes.rb @@ -26,55 +26,46 @@ module Google class Backup include Google::Apis::Core::Hashable - # Output only. The backup will contain an externally consistent - # copy of the database at the timestamp specified by - # `create_time`. `create_time` is approximately the time the - # CreateBackup request is received. + # Output only. The backup will contain an externally consistent copy of the + # database at the timestamp specified by `create_time`. `create_time` is + # approximately the time the CreateBackup request is received. # Corresponds to the JSON property `createTime` # @return [String] attr_accessor :create_time - # Required for the CreateBackup operation. - # Name of the database from which this backup was - # created. This needs to be in the same instance as the backup. - # Values are of the form - # `projects//instances//databases/`. + # Required for the CreateBackup operation. Name of the database from which this + # backup was created. This needs to be in the same instance as the backup. + # Values are of the form `projects//instances//databases/`. # Corresponds to the JSON property `database` # @return [String] attr_accessor :database - # Required for the CreateBackup - # operation. The expiration time of the backup, with microseconds - # granularity that must be at least 6 hours and at most 366 days - # from the time the CreateBackup request is processed. Once the `expire_time` - # has passed, the backup is eligible to be automatically deleted by Cloud - # Spanner to free the resources used by the backup. + # Required for the CreateBackup operation. The expiration time of the backup, + # with microseconds granularity that must be at least 6 hours and at most 366 + # days from the time the CreateBackup request is processed. Once the ` + # expire_time` has passed, the backup is eligible to be automatically deleted by + # Cloud Spanner to free the resources used by the backup. # Corresponds to the JSON property `expireTime` # @return [String] attr_accessor :expire_time - # Output only for the CreateBackup operation. - # Required for the UpdateBackup operation. - # A globally unique identifier for the backup which cannot be - # changed. Values are of the form - # `projects//instances//backups/a-z*[a-z0-9]` - # The final segment of the name must be between 2 and 60 characters - # in length. - # The backup is stored in the location(s) specified in the instance - # configuration of the instance containing the backup, identified - # by the prefix of the backup name of the form - # `projects//instances/`. + # Output only for the CreateBackup operation. Required for the UpdateBackup + # operation. A globally unique identifier for the backup which cannot be changed. + # Values are of the form `projects//instances//backups/a-z*[a-z0-9]` The final + # segment of the name must be between 2 and 60 characters in length. The backup + # is stored in the location(s) specified in the instance configuration of the + # instance containing the backup, identified by the prefix of the backup name of + # the form `projects//instances/`. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # Output only. The names of the restored databases that reference the backup. - # The database names are of - # the form `projects//instances//databases/`. - # Referencing databases may exist in different instances. The existence of - # any referencing database prevents the backup from being deleted. When a - # restored database from the backup enters the `READY` state, the reference - # to the backup is removed. + # The database names are of the form `projects//instances//databases/`. + # Referencing databases may exist in different instances. The existence of any + # referencing database prevents the backup from being deleted. When a restored + # database from the backup enters the `READY` state, the reference to the backup + # is removed. # Corresponds to the JSON property `referencingDatabases` # @return [Array] attr_accessor :referencing_databases @@ -114,8 +105,8 @@ module Google # @return [String] attr_accessor :backup - # The backup contains an externally consistent copy of `source_database` at - # the timestamp specified by `create_time`. + # The backup contains an externally consistent copy of `source_database` at the + # timestamp specified by `create_time`. # Corresponds to the JSON property `createTime` # @return [String] attr_accessor :create_time @@ -141,11 +132,10 @@ module Google class BatchCreateSessionsRequest include Google::Apis::Core::Hashable - # Required. The number of sessions to be created in this batch call. - # The API may return fewer than the requested number of sessions. If a - # specific number of sessions are desired, the client can make additional - # calls to BatchCreateSessions (adjusting - # session_count as necessary). + # Required. The number of sessions to be created in this batch call. The API may + # return fewer than the requested number of sessions. If a specific number of + # sessions are desired, the client can make additional calls to + # BatchCreateSessions (adjusting session_count as necessary). # Corresponds to the JSON property `sessionCount` # @return [Fixnum] attr_accessor :session_count @@ -189,222 +179,165 @@ module Google class BeginTransactionRequest include Google::Apis::Core::Hashable - # # Transactions - # Each session can have at most one active transaction at a time (note that - # standalone reads and queries use a transaction internally and do count - # towards the one transaction limit). After the active transaction is - # completed, the session can immediately be re-used for the next transaction. - # It is not necessary to create a new session for each transaction. - # # Transaction Modes - # Cloud Spanner supports three transaction modes: - # 1. Locking read-write. This type of transaction is the only way - # to write data into Cloud Spanner. These transactions rely on - # pessimistic locking and, if necessary, two-phase commit. - # Locking read-write transactions may abort, requiring the - # application to retry. - # 2. Snapshot read-only. This transaction type provides guaranteed - # consistency across several reads, but does not allow - # writes. Snapshot read-only transactions can be configured to - # read at timestamps in the past. Snapshot read-only - # transactions do not need to be committed. - # 3. Partitioned DML. This type of transaction is used to execute - # a single Partitioned DML statement. Partitioned DML partitions - # the key space and runs the DML statement over each partition - # in parallel using separate, internal transactions that commit - # independently. Partitioned DML transactions do not need to be - # committed. - # For transactions that only read, snapshot read-only transactions - # provide simpler semantics and are almost always faster. In - # particular, read-only transactions do not take locks, so they do - # not conflict with read-write transactions. As a consequence of not - # taking locks, they also do not abort, so retry loops are not needed. - # Transactions may only read/write data in a single database. They - # may, however, read/write data in different tables within that - # database. - # ## Locking Read-Write Transactions - # Locking transactions may be used to atomically read-modify-write - # data anywhere in a database. This type of transaction is externally - # consistent. - # Clients should attempt to minimize the amount of time a transaction - # is active. Faster transactions commit with higher probability - # and cause less contention. Cloud Spanner attempts to keep read locks - # active as long as the transaction continues to do reads, and the - # transaction has not been terminated by - # Commit or - # Rollback. Long periods of - # inactivity at the client may cause Cloud Spanner to release a - # transaction's locks and abort it. - # Conceptually, a read-write transaction consists of zero or more - # reads or SQL statements followed by - # Commit. At any time before - # Commit, the client can send a - # Rollback request to abort the - # transaction. - # ### Semantics - # Cloud Spanner can commit the transaction if all read locks it acquired - # are still valid at commit time, and it is able to acquire write - # locks for all writes. Cloud Spanner can abort the transaction for any - # reason. If a commit attempt returns `ABORTED`, Cloud Spanner guarantees - # that the transaction has not modified any user data in Cloud Spanner. - # Unless the transaction commits, Cloud Spanner makes no guarantees about - # how long the transaction's locks were held for. It is an error to - # use Cloud Spanner locks for any sort of mutual exclusion other than - # between Cloud Spanner transactions themselves. - # ### Retrying Aborted Transactions - # When a transaction aborts, the application can choose to retry the - # whole transaction again. To maximize the chances of successfully - # committing the retry, the client should execute the retry in the - # same session as the original attempt. The original session's lock - # priority increases with each consecutive abort, meaning that each - # attempt has a slightly better chance of success than the previous. - # Under some circumstances (e.g., many transactions attempting to - # modify the same row(s)), a transaction can abort many times in a - # short period before successfully committing. Thus, it is not a good - # idea to cap the number of retries a transaction can attempt; - # instead, it is better to limit the total amount of wall time spent - # retrying. - # ### Idle Transactions - # A transaction is considered idle if it has no outstanding reads or - # SQL queries and has not started a read or SQL query within the last 10 - # seconds. Idle transactions can be aborted by Cloud Spanner so that they - # don't hold on to locks indefinitely. In that case, the commit will - # fail with error `ABORTED`. - # If this behavior is undesirable, periodically executing a simple - # SQL query in the transaction (e.g., `SELECT 1`) prevents the - # transaction from becoming idle. - # ## Snapshot Read-Only Transactions - # Snapshot read-only transactions provides a simpler method than - # locking read-write transactions for doing several consistent - # reads. However, this type of transaction does not support writes. - # Snapshot transactions do not take locks. Instead, they work by - # choosing a Cloud Spanner timestamp, then executing all reads at that - # timestamp. Since they do not acquire locks, they do not block - # concurrent read-write transactions. - # Unlike locking read-write transactions, snapshot read-only - # transactions never abort. They can fail if the chosen read - # timestamp is garbage collected; however, the default garbage - # collection policy is generous enough that most applications do not - # need to worry about this in practice. - # Snapshot read-only transactions do not need to call - # Commit or - # Rollback (and in fact are not - # permitted to do so). - # To execute a snapshot transaction, the client specifies a timestamp - # bound, which tells Cloud Spanner how to choose a read timestamp. - # The types of timestamp bound are: - # - Strong (the default). - # - Bounded staleness. - # - Exact staleness. - # If the Cloud Spanner database to be read is geographically distributed, - # stale read-only transactions can execute more quickly than strong - # or read-write transaction, because they are able to execute far - # from the leader replica. - # Each type of timestamp bound is discussed in detail below. - # ### Strong - # Strong reads are guaranteed to see the effects of all transactions - # that have committed before the start of the read. Furthermore, all - # rows yielded by a single read are consistent with each other -- if - # any part of the read observes a transaction, all parts of the read - # see the transaction. - # Strong reads are not repeatable: two consecutive strong read-only - # transactions might return inconsistent results if there are - # concurrent writes. If consistency across reads is required, the - # reads should be executed within a transaction or at an exact read - # timestamp. - # See TransactionOptions.ReadOnly.strong. - # ### Exact Staleness - # These timestamp bounds execute reads at a user-specified - # timestamp. Reads at a timestamp are guaranteed to see a consistent - # prefix of the global transaction history: they observe - # modifications done by all transactions with a commit timestamp <= - # the read timestamp, and observe none of the modifications done by - # transactions with a larger commit timestamp. They will block until - # all conflicting transactions that may be assigned commit timestamps - # <= the read timestamp have finished. - # The timestamp can either be expressed as an absolute Cloud Spanner commit - # timestamp or a staleness relative to the current time. - # These modes do not require a "negotiation phase" to pick a - # timestamp. As a result, they execute slightly faster than the - # equivalent boundedly stale concurrency modes. On the other hand, - # boundedly stale reads usually return fresher results. - # See TransactionOptions.ReadOnly.read_timestamp and - # TransactionOptions.ReadOnly.exact_staleness. - # ### Bounded Staleness - # Bounded staleness modes allow Cloud Spanner to pick the read timestamp, - # subject to a user-provided staleness bound. Cloud Spanner chooses the - # newest timestamp within the staleness bound that allows execution - # of the reads at the closest available replica without blocking. - # All rows yielded are consistent with each other -- if any part of - # the read observes a transaction, all parts of the read see the - # transaction. Boundedly stale reads are not repeatable: two stale - # reads, even if they use the same staleness bound, can execute at - # different timestamps and thus return inconsistent results. - # Boundedly stale reads execute in two phases: the first phase - # negotiates a timestamp among all replicas needed to serve the - # read. In the second phase, reads are executed at the negotiated - # timestamp. - # As a result of the two phase execution, bounded staleness reads are - # usually a little slower than comparable exact staleness - # reads. However, they are typically able to return fresher - # results, and are more likely to execute at the closest replica. - # Because the timestamp negotiation requires up-front knowledge of - # which rows will be read, it can only be used with single-use - # read-only transactions. - # See TransactionOptions.ReadOnly.max_staleness and - # TransactionOptions.ReadOnly.min_read_timestamp. - # ### Old Read Timestamps and Garbage Collection - # Cloud Spanner continuously garbage collects deleted and overwritten data - # in the background to reclaim storage space. This process is known - # as "version GC". By default, version GC reclaims versions after they - # are one hour old. Because of this, Cloud Spanner cannot perform reads - # at read timestamps more than one hour in the past. This - # restriction also applies to in-progress reads and/or SQL queries whose - # timestamp become too old while executing. Reads and SQL queries with - # too-old read timestamps fail with the error `FAILED_PRECONDITION`. - # ## Partitioned DML Transactions - # Partitioned DML transactions are used to execute DML statements with a - # different execution strategy that provides different, and often better, - # scalability properties for large, table-wide operations than DML in a - # ReadWrite transaction. Smaller scoped statements, such as an OLTP workload, - # should prefer using ReadWrite transactions. - # Partitioned DML partitions the keyspace and runs the DML statement on each - # partition in separate, internal transactions. These transactions commit - # automatically when complete, and run independently from one another. - # To reduce lock contention, this execution strategy only acquires read locks - # on rows that match the WHERE clause of the statement. Additionally, the - # smaller per-partition transactions hold locks for less time. - # That said, Partitioned DML is not a drop-in replacement for standard DML used - # in ReadWrite transactions. - # - The DML statement must be fully-partitionable. Specifically, the statement - # must be expressible as the union of many statements which each access only - # a single row of the table. - # - The statement is not applied atomically to all rows of the table. Rather, - # the statement is applied atomically to partitions of the table, in - # independent transactions. Secondary index rows are updated atomically - # with the base table rows. - # - Partitioned DML does not guarantee exactly-once execution semantics - # against a partition. The statement will be applied at least once to each - # partition. It is strongly recommended that the DML statement should be - # idempotent to avoid unexpected results. For instance, it is potentially - # dangerous to run a statement such as - # `UPDATE table SET column = column + 1` as it could be run multiple times - # against some rows. - # - The partitions are committed automatically - there is no support for - # Commit or Rollback. If the call returns an error, or if the client issuing - # the ExecuteSql call dies, it is possible that some rows had the statement - # executed on them successfully. It is also possible that statement was - # never executed against other rows. - # - Partitioned DML transactions may only contain the execution of a single - # DML statement via ExecuteSql or ExecuteStreamingSql. - # - If any error is encountered during the execution of the partitioned DML + # # Transactions Each session can have at most one active transaction at a time ( + # note that standalone reads and queries use a transaction internally and do + # count towards the one transaction limit). After the active transaction is + # completed, the session can immediately be re-used for the next transaction. It + # is not necessary to create a new session for each transaction. # Transaction + # Modes Cloud Spanner supports three transaction modes: 1. Locking read-write. + # This type of transaction is the only way to write data into Cloud Spanner. + # These transactions rely on pessimistic locking and, if necessary, two-phase + # commit. Locking read-write transactions may abort, requiring the application + # to retry. 2. Snapshot read-only. This transaction type provides guaranteed + # consistency across several reads, but does not allow writes. Snapshot read- + # only transactions can be configured to read at timestamps in the past. + # Snapshot read-only transactions do not need to be committed. 3. Partitioned + # DML. This type of transaction is used to execute a single Partitioned DML + # statement. Partitioned DML partitions the key space and runs the DML statement + # over each partition in parallel using separate, internal transactions that + # commit independently. Partitioned DML transactions do not need to be committed. + # For transactions that only read, snapshot read-only transactions provide + # simpler semantics and are almost always faster. In particular, read-only + # transactions do not take locks, so they do not conflict with read-write + # transactions. As a consequence of not taking locks, they also do not abort, so + # retry loops are not needed. Transactions may only read/write data in a single + # database. They may, however, read/write data in different tables within that + # database. ## Locking Read-Write Transactions Locking transactions may be used + # to atomically read-modify-write data anywhere in a database. This type of + # transaction is externally consistent. Clients should attempt to minimize the + # amount of time a transaction is active. Faster transactions commit with higher + # probability and cause less contention. Cloud Spanner attempts to keep read + # locks active as long as the transaction continues to do reads, and the + # transaction has not been terminated by Commit or Rollback. Long periods of + # inactivity at the client may cause Cloud Spanner to release a transaction's + # locks and abort it. Conceptually, a read-write transaction consists of zero or + # more reads or SQL statements followed by Commit. At any time before Commit, + # the client can send a Rollback request to abort the transaction. ### Semantics + # Cloud Spanner can commit the transaction if all read locks it acquired are + # still valid at commit time, and it is able to acquire write locks for all + # writes. Cloud Spanner can abort the transaction for any reason. If a commit + # attempt returns `ABORTED`, Cloud Spanner guarantees that the transaction has + # not modified any user data in Cloud Spanner. Unless the transaction commits, + # Cloud Spanner makes no guarantees about how long the transaction's locks were + # held for. It is an error to use Cloud Spanner locks for any sort of mutual + # exclusion other than between Cloud Spanner transactions themselves. ### + # Retrying Aborted Transactions When a transaction aborts, the application can + # choose to retry the whole transaction again. To maximize the chances of + # successfully committing the retry, the client should execute the retry in the + # same session as the original attempt. The original session's lock priority + # increases with each consecutive abort, meaning that each attempt has a + # slightly better chance of success than the previous. Under some circumstances ( + # e.g., many transactions attempting to modify the same row(s)), a transaction + # can abort many times in a short period before successfully committing. Thus, + # it is not a good idea to cap the number of retries a transaction can attempt; + # instead, it is better to limit the total amount of wall time spent retrying. ## + # # Idle Transactions A transaction is considered idle if it has no outstanding + # reads or SQL queries and has not started a read or SQL query within the last + # 10 seconds. Idle transactions can be aborted by Cloud Spanner so that they don' + # t hold on to locks indefinitely. In that case, the commit will fail with error + # `ABORTED`. If this behavior is undesirable, periodically executing a simple + # SQL query in the transaction (e.g., `SELECT 1`) prevents the transaction from + # becoming idle. ## Snapshot Read-Only Transactions Snapshot read-only + # transactions provides a simpler method than locking read-write transactions + # for doing several consistent reads. However, this type of transaction does not + # support writes. Snapshot transactions do not take locks. Instead, they work by + # choosing a Cloud Spanner timestamp, then executing all reads at that timestamp. + # Since they do not acquire locks, they do not block concurrent read-write + # transactions. Unlike locking read-write transactions, snapshot read-only + # transactions never abort. They can fail if the chosen read timestamp is + # garbage collected; however, the default garbage collection policy is generous + # enough that most applications do not need to worry about this in practice. + # Snapshot read-only transactions do not need to call Commit or Rollback (and in + # fact are not permitted to do so). To execute a snapshot transaction, the + # client specifies a timestamp bound, which tells Cloud Spanner how to choose a + # read timestamp. The types of timestamp bound are: - Strong (the default). - + # Bounded staleness. - Exact staleness. If the Cloud Spanner database to be read + # is geographically distributed, stale read-only transactions can execute more + # quickly than strong or read-write transaction, because they are able to + # execute far from the leader replica. Each type of timestamp bound is discussed + # in detail below. ### Strong Strong reads are guaranteed to see the effects of + # all transactions that have committed before the start of the read. Furthermore, + # all rows yielded by a single read are consistent with each other -- if any + # part of the read observes a transaction, all parts of the read see the + # transaction. Strong reads are not repeatable: two consecutive strong read-only + # transactions might return inconsistent results if there are concurrent writes. + # If consistency across reads is required, the reads should be executed within a + # transaction or at an exact read timestamp. See TransactionOptions.ReadOnly. + # strong. ### Exact Staleness These timestamp bounds execute reads at a user- + # specified timestamp. Reads at a timestamp are guaranteed to see a consistent + # prefix of the global transaction history: they observe modifications done by + # all transactions with a commit timestamp <= the read timestamp, and observe + # none of the modifications done by transactions with a larger commit timestamp. + # They will block until all conflicting transactions that may be assigned commit + # timestamps <= the read timestamp have finished. The timestamp can either be + # expressed as an absolute Cloud Spanner commit timestamp or a staleness + # relative to the current time. These modes do not require a "negotiation phase" + # to pick a timestamp. As a result, they execute slightly faster than the + # equivalent boundedly stale concurrency modes. On the other hand, boundedly + # stale reads usually return fresher results. See TransactionOptions.ReadOnly. + # read_timestamp and TransactionOptions.ReadOnly.exact_staleness. ### Bounded + # Staleness Bounded staleness modes allow Cloud Spanner to pick the read + # timestamp, subject to a user-provided staleness bound. Cloud Spanner chooses + # the newest timestamp within the staleness bound that allows execution of the + # reads at the closest available replica without blocking. All rows yielded are + # consistent with each other -- if any part of the read observes a transaction, + # all parts of the read see the transaction. Boundedly stale reads are not + # repeatable: two stale reads, even if they use the same staleness bound, can + # execute at different timestamps and thus return inconsistent results. + # Boundedly stale reads execute in two phases: the first phase negotiates a + # timestamp among all replicas needed to serve the read. In the second phase, + # reads are executed at the negotiated timestamp. As a result of the two phase + # execution, bounded staleness reads are usually a little slower than comparable + # exact staleness reads. However, they are typically able to return fresher + # results, and are more likely to execute at the closest replica. Because the + # timestamp negotiation requires up-front knowledge of which rows will be read, + # it can only be used with single-use read-only transactions. See + # TransactionOptions.ReadOnly.max_staleness and TransactionOptions.ReadOnly. + # min_read_timestamp. ### Old Read Timestamps and Garbage Collection Cloud + # Spanner continuously garbage collects deleted and overwritten data in the + # background to reclaim storage space. This process is known as "version GC". By + # default, version GC reclaims versions after they are one hour old. Because of + # this, Cloud Spanner cannot perform reads at read timestamps more than one hour + # in the past. This restriction also applies to in-progress reads and/or SQL + # queries whose timestamp become too old while executing. Reads and SQL queries + # with too-old read timestamps fail with the error `FAILED_PRECONDITION`. ## + # Partitioned DML Transactions Partitioned DML transactions are used to execute + # DML statements with a different execution strategy that provides different, + # and often better, scalability properties for large, table-wide operations than + # DML in a ReadWrite transaction. Smaller scoped statements, such as an OLTP + # workload, should prefer using ReadWrite transactions. Partitioned DML + # partitions the keyspace and runs the DML statement on each partition in + # separate, internal transactions. These transactions commit automatically when + # complete, and run independently from one another. To reduce lock contention, + # this execution strategy only acquires read locks on rows that match the WHERE + # clause of the statement. Additionally, the smaller per-partition transactions + # hold locks for less time. That said, Partitioned DML is not a drop-in + # replacement for standard DML used in ReadWrite transactions. - The DML + # statement must be fully-partitionable. Specifically, the statement must be + # expressible as the union of many statements which each access only a single + # row of the table. - The statement is not applied atomically to all rows of the + # table. Rather, the statement is applied atomically to partitions of the table, + # in independent transactions. Secondary index rows are updated atomically with + # the base table rows. - Partitioned DML does not guarantee exactly-once + # execution semantics against a partition. The statement will be applied at + # least once to each partition. It is strongly recommended that the DML + # statement should be idempotent to avoid unexpected results. For instance, it + # is potentially dangerous to run a statement such as `UPDATE table SET column = + # column + 1` as it could be run multiple times against some rows. - The + # partitions are committed automatically - there is no support for Commit or + # Rollback. If the call returns an error, or if the client issuing the + # ExecuteSql call dies, it is possible that some rows had the statement executed + # on them successfully. It is also possible that statement was never executed + # against other rows. - Partitioned DML transactions may only contain the + # execution of a single DML statement via ExecuteSql or ExecuteStreamingSql. - + # If any error is encountered during the execution of the partitioned DML # operation (for instance, a UNIQUE INDEX violation, division by zero, or a - # value that cannot be stored due to schema constraints), then the - # operation is stopped at that point and an error is returned. It is - # possible that at this point, some partitions have been committed (or even - # committed multiple times), and other partitions have not been run at all. - # Given the above, Partitioned DML is good fit for large, database-wide, - # operations that are idempotent, such as deleting old rows from a very large - # table. + # value that cannot be stored due to schema constraints), then the operation is + # stopped at that point and an error is returned. It is possible that at this + # point, some partitions have been committed (or even committed multiple times), + # and other partitions have not been run at all. Given the above, Partitioned + # DML is good fit for large, database-wide, operations that are idempotent, such + # as deleting old rows from a very large table. # Corresponds to the JSON property `options` # @return [Google::Apis::SpannerV1::TransactionOptions] attr_accessor :options @@ -423,69 +356,57 @@ module Google class Binding include Google::Apis::Core::Hashable - # Represents a textual expression in the Common Expression Language (CEL) - # syntax. CEL is a C-like expression language. The syntax and semantics of CEL - # are documented at https://github.com/google/cel-spec. - # Example (Comparison): - # title: "Summary size limit" - # description: "Determines if a summary is less than 100 chars" - # expression: "document.summary.size() < 100" - # Example (Equality): - # title: "Requestor is owner" - # description: "Determines if requestor is the document owner" - # expression: "document.owner == request.auth.claims.email" - # Example (Logic): - # title: "Public documents" - # description: "Determine whether the document should be publicly visible" - # expression: "document.type != 'private' && document.type != 'internal'" - # Example (Data Manipulation): - # title: "Notification string" - # description: "Create a notification string with a timestamp." - # expression: "'New message received at ' + string(document.create_time)" - # The exact variables and functions that may be referenced within an expression - # are determined by the service that evaluates it. See the service - # documentation for additional information. + # Represents a textual expression in the Common Expression Language (CEL) syntax. + # CEL is a C-like expression language. The syntax and semantics of CEL are + # documented at https://github.com/google/cel-spec. Example (Comparison): title: + # "Summary size limit" description: "Determines if a summary is less than 100 + # chars" expression: "document.summary.size() < 100" Example (Equality): title: " + # Requestor is owner" description: "Determines if requestor is the document + # owner" expression: "document.owner == request.auth.claims.email" Example ( + # Logic): title: "Public documents" description: "Determine whether the document + # should be publicly visible" expression: "document.type != 'private' && + # document.type != 'internal'" Example (Data Manipulation): title: "Notification + # string" description: "Create a notification string with a timestamp." + # expression: "'New message received at ' + string(document.create_time)" The + # exact variables and functions that may be referenced within an expression are + # determined by the service that evaluates it. See the service documentation for + # additional information. # Corresponds to the JSON property `condition` # @return [Google::Apis::SpannerV1::Expr] attr_accessor :condition - # Specifies the identities requesting access for a Cloud Platform resource. - # `members` can have the following values: - # * `allUsers`: A special identifier that represents anyone who is - # on the internet; with or without a Google account. - # * `allAuthenticatedUsers`: A special identifier that represents anyone - # who is authenticated with a Google account or a service account. - # * `user:`emailid``: An email address that represents a specific Google - # account. For example, `alice@example.com` . - # * `serviceAccount:`emailid``: An email address that represents a service - # account. For example, `my-other-app@appspot.gserviceaccount.com`. - # * `group:`emailid``: An email address that represents a Google group. - # For example, `admins@example.com`. - # * `deleted:user:`emailid`?uid=`uniqueid``: An email address (plus unique - # identifier) representing a user that has been recently deleted. For - # example, `alice@example.com?uid=123456789012345678901`. If the user is - # recovered, this value reverts to `user:`emailid`` and the recovered user - # retains the role in the binding. - # * `deleted:serviceAccount:`emailid`?uid=`uniqueid``: An email address (plus - # unique identifier) representing a service account that has been recently - # deleted. For example, - # `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. - # If the service account is undeleted, this value reverts to - # `serviceAccount:`emailid`` and the undeleted service account retains the - # role in the binding. - # * `deleted:group:`emailid`?uid=`uniqueid``: An email address (plus unique - # identifier) representing a Google group that has been recently - # deleted. For example, `admins@example.com?uid=123456789012345678901`. If - # the group is recovered, this value reverts to `group:`emailid`` and the - # recovered group retains the role in the binding. - # * `domain:`domain``: The G Suite domain (primary) that represents all the - # users of that domain. For example, `google.com` or `example.com`. + # Specifies the identities requesting access for a Cloud Platform resource. ` + # members` can have the following values: * `allUsers`: A special identifier + # that represents anyone who is on the internet; with or without a Google + # account. * `allAuthenticatedUsers`: A special identifier that represents + # anyone who is authenticated with a Google account or a service account. * ` + # user:`emailid``: An email address that represents a specific Google account. + # For example, `alice@example.com` . * `serviceAccount:`emailid``: An email + # address that represents a service account. For example, `my-other-app@appspot. + # gserviceaccount.com`. * `group:`emailid``: An email address that represents a + # Google group. For example, `admins@example.com`. * `deleted:user:`emailid`?uid= + # `uniqueid``: An email address (plus unique identifier) representing a user + # that has been recently deleted. For example, `alice@example.com?uid= + # 123456789012345678901`. If the user is recovered, this value reverts to `user:` + # emailid`` and the recovered user retains the role in the binding. * `deleted: + # serviceAccount:`emailid`?uid=`uniqueid``: An email address (plus unique + # identifier) representing a service account that has been recently deleted. For + # example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. + # If the service account is undeleted, this value reverts to `serviceAccount:` + # emailid`` and the undeleted service account retains the role in the binding. * + # `deleted:group:`emailid`?uid=`uniqueid``: An email address (plus unique + # identifier) representing a Google group that has been recently deleted. For + # example, `admins@example.com?uid=123456789012345678901`. If the group is + # recovered, this value reverts to `group:`emailid`` and the recovered group + # retains the role in the binding. * `domain:`domain``: The G Suite domain ( + # primary) that represents all the users of that domain. For example, `google. + # com` or `example.com`. # Corresponds to the JSON property `members` # @return [Array] attr_accessor :members - # Role that is assigned to `members`. - # For example, `roles/viewer`, `roles/editor`, or `roles/owner`. + # Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor` + # , or `roles/owner`. # Corresponds to the JSON property `role` # @return [String] attr_accessor :role @@ -502,8 +423,7 @@ module Google end end - # Metadata associated with a parent-child relationship appearing in a - # PlanNode. + # Metadata associated with a parent-child relationship appearing in a PlanNode. class ChildLink include Google::Apis::Core::Hashable @@ -513,21 +433,19 @@ module Google attr_accessor :child_index # The type of the link. For example, in Hash Joins this could be used to - # distinguish between the build child and the probe child, or in the case - # of the child being an output variable, to represent the tag associated - # with the output variable. + # distinguish between the build child and the probe child, or in the case of the + # child being an output variable, to represent the tag associated with the + # output variable. # Corresponds to the JSON property `type` # @return [String] attr_accessor :type - # Only present if the child node is SCALAR and corresponds - # to an output variable of the parent node. The field carries the name of - # the output variable. - # For example, a `TableScan` operator that reads rows from a table will - # have child links to the `SCALAR` nodes representing the output variables - # created for each column that is read by the operator. The corresponding - # `variable` fields will be set to the variable names assigned to the - # columns. + # Only present if the child node is SCALAR and corresponds to an output variable + # of the parent node. The field carries the name of the output variable. For + # example, a `TableScan` operator that reads rows from a table will have child + # links to the `SCALAR` nodes representing the output variables created for each + # column that is read by the operator. The corresponding `variable` fields will + # be set to the variable names assigned to the columns. # Corresponds to the JSON property `variable` # @return [String] attr_accessor :variable @@ -548,229 +466,171 @@ module Google class CommitRequest include Google::Apis::Core::Hashable - # The mutations to be executed when this transaction commits. All - # mutations are applied atomically, in the order they appear in - # this list. + # The mutations to be executed when this transaction commits. All mutations are + # applied atomically, in the order they appear in this list. # Corresponds to the JSON property `mutations` # @return [Array] attr_accessor :mutations - # # Transactions - # Each session can have at most one active transaction at a time (note that - # standalone reads and queries use a transaction internally and do count - # towards the one transaction limit). After the active transaction is - # completed, the session can immediately be re-used for the next transaction. - # It is not necessary to create a new session for each transaction. - # # Transaction Modes - # Cloud Spanner supports three transaction modes: - # 1. Locking read-write. This type of transaction is the only way - # to write data into Cloud Spanner. These transactions rely on - # pessimistic locking and, if necessary, two-phase commit. - # Locking read-write transactions may abort, requiring the - # application to retry. - # 2. Snapshot read-only. This transaction type provides guaranteed - # consistency across several reads, but does not allow - # writes. Snapshot read-only transactions can be configured to - # read at timestamps in the past. Snapshot read-only - # transactions do not need to be committed. - # 3. Partitioned DML. This type of transaction is used to execute - # a single Partitioned DML statement. Partitioned DML partitions - # the key space and runs the DML statement over each partition - # in parallel using separate, internal transactions that commit - # independently. Partitioned DML transactions do not need to be - # committed. - # For transactions that only read, snapshot read-only transactions - # provide simpler semantics and are almost always faster. In - # particular, read-only transactions do not take locks, so they do - # not conflict with read-write transactions. As a consequence of not - # taking locks, they also do not abort, so retry loops are not needed. - # Transactions may only read/write data in a single database. They - # may, however, read/write data in different tables within that - # database. - # ## Locking Read-Write Transactions - # Locking transactions may be used to atomically read-modify-write - # data anywhere in a database. This type of transaction is externally - # consistent. - # Clients should attempt to minimize the amount of time a transaction - # is active. Faster transactions commit with higher probability - # and cause less contention. Cloud Spanner attempts to keep read locks - # active as long as the transaction continues to do reads, and the - # transaction has not been terminated by - # Commit or - # Rollback. Long periods of - # inactivity at the client may cause Cloud Spanner to release a - # transaction's locks and abort it. - # Conceptually, a read-write transaction consists of zero or more - # reads or SQL statements followed by - # Commit. At any time before - # Commit, the client can send a - # Rollback request to abort the - # transaction. - # ### Semantics - # Cloud Spanner can commit the transaction if all read locks it acquired - # are still valid at commit time, and it is able to acquire write - # locks for all writes. Cloud Spanner can abort the transaction for any - # reason. If a commit attempt returns `ABORTED`, Cloud Spanner guarantees - # that the transaction has not modified any user data in Cloud Spanner. - # Unless the transaction commits, Cloud Spanner makes no guarantees about - # how long the transaction's locks were held for. It is an error to - # use Cloud Spanner locks for any sort of mutual exclusion other than - # between Cloud Spanner transactions themselves. - # ### Retrying Aborted Transactions - # When a transaction aborts, the application can choose to retry the - # whole transaction again. To maximize the chances of successfully - # committing the retry, the client should execute the retry in the - # same session as the original attempt. The original session's lock - # priority increases with each consecutive abort, meaning that each - # attempt has a slightly better chance of success than the previous. - # Under some circumstances (e.g., many transactions attempting to - # modify the same row(s)), a transaction can abort many times in a - # short period before successfully committing. Thus, it is not a good - # idea to cap the number of retries a transaction can attempt; - # instead, it is better to limit the total amount of wall time spent - # retrying. - # ### Idle Transactions - # A transaction is considered idle if it has no outstanding reads or - # SQL queries and has not started a read or SQL query within the last 10 - # seconds. Idle transactions can be aborted by Cloud Spanner so that they - # don't hold on to locks indefinitely. In that case, the commit will - # fail with error `ABORTED`. - # If this behavior is undesirable, periodically executing a simple - # SQL query in the transaction (e.g., `SELECT 1`) prevents the - # transaction from becoming idle. - # ## Snapshot Read-Only Transactions - # Snapshot read-only transactions provides a simpler method than - # locking read-write transactions for doing several consistent - # reads. However, this type of transaction does not support writes. - # Snapshot transactions do not take locks. Instead, they work by - # choosing a Cloud Spanner timestamp, then executing all reads at that - # timestamp. Since they do not acquire locks, they do not block - # concurrent read-write transactions. - # Unlike locking read-write transactions, snapshot read-only - # transactions never abort. They can fail if the chosen read - # timestamp is garbage collected; however, the default garbage - # collection policy is generous enough that most applications do not - # need to worry about this in practice. - # Snapshot read-only transactions do not need to call - # Commit or - # Rollback (and in fact are not - # permitted to do so). - # To execute a snapshot transaction, the client specifies a timestamp - # bound, which tells Cloud Spanner how to choose a read timestamp. - # The types of timestamp bound are: - # - Strong (the default). - # - Bounded staleness. - # - Exact staleness. - # If the Cloud Spanner database to be read is geographically distributed, - # stale read-only transactions can execute more quickly than strong - # or read-write transaction, because they are able to execute far - # from the leader replica. - # Each type of timestamp bound is discussed in detail below. - # ### Strong - # Strong reads are guaranteed to see the effects of all transactions - # that have committed before the start of the read. Furthermore, all - # rows yielded by a single read are consistent with each other -- if - # any part of the read observes a transaction, all parts of the read - # see the transaction. - # Strong reads are not repeatable: two consecutive strong read-only - # transactions might return inconsistent results if there are - # concurrent writes. If consistency across reads is required, the - # reads should be executed within a transaction or at an exact read - # timestamp. - # See TransactionOptions.ReadOnly.strong. - # ### Exact Staleness - # These timestamp bounds execute reads at a user-specified - # timestamp. Reads at a timestamp are guaranteed to see a consistent - # prefix of the global transaction history: they observe - # modifications done by all transactions with a commit timestamp <= - # the read timestamp, and observe none of the modifications done by - # transactions with a larger commit timestamp. They will block until - # all conflicting transactions that may be assigned commit timestamps - # <= the read timestamp have finished. - # The timestamp can either be expressed as an absolute Cloud Spanner commit - # timestamp or a staleness relative to the current time. - # These modes do not require a "negotiation phase" to pick a - # timestamp. As a result, they execute slightly faster than the - # equivalent boundedly stale concurrency modes. On the other hand, - # boundedly stale reads usually return fresher results. - # See TransactionOptions.ReadOnly.read_timestamp and - # TransactionOptions.ReadOnly.exact_staleness. - # ### Bounded Staleness - # Bounded staleness modes allow Cloud Spanner to pick the read timestamp, - # subject to a user-provided staleness bound. Cloud Spanner chooses the - # newest timestamp within the staleness bound that allows execution - # of the reads at the closest available replica without blocking. - # All rows yielded are consistent with each other -- if any part of - # the read observes a transaction, all parts of the read see the - # transaction. Boundedly stale reads are not repeatable: two stale - # reads, even if they use the same staleness bound, can execute at - # different timestamps and thus return inconsistent results. - # Boundedly stale reads execute in two phases: the first phase - # negotiates a timestamp among all replicas needed to serve the - # read. In the second phase, reads are executed at the negotiated - # timestamp. - # As a result of the two phase execution, bounded staleness reads are - # usually a little slower than comparable exact staleness - # reads. However, they are typically able to return fresher - # results, and are more likely to execute at the closest replica. - # Because the timestamp negotiation requires up-front knowledge of - # which rows will be read, it can only be used with single-use - # read-only transactions. - # See TransactionOptions.ReadOnly.max_staleness and - # TransactionOptions.ReadOnly.min_read_timestamp. - # ### Old Read Timestamps and Garbage Collection - # Cloud Spanner continuously garbage collects deleted and overwritten data - # in the background to reclaim storage space. This process is known - # as "version GC". By default, version GC reclaims versions after they - # are one hour old. Because of this, Cloud Spanner cannot perform reads - # at read timestamps more than one hour in the past. This - # restriction also applies to in-progress reads and/or SQL queries whose - # timestamp become too old while executing. Reads and SQL queries with - # too-old read timestamps fail with the error `FAILED_PRECONDITION`. - # ## Partitioned DML Transactions - # Partitioned DML transactions are used to execute DML statements with a - # different execution strategy that provides different, and often better, - # scalability properties for large, table-wide operations than DML in a - # ReadWrite transaction. Smaller scoped statements, such as an OLTP workload, - # should prefer using ReadWrite transactions. - # Partitioned DML partitions the keyspace and runs the DML statement on each - # partition in separate, internal transactions. These transactions commit - # automatically when complete, and run independently from one another. - # To reduce lock contention, this execution strategy only acquires read locks - # on rows that match the WHERE clause of the statement. Additionally, the - # smaller per-partition transactions hold locks for less time. - # That said, Partitioned DML is not a drop-in replacement for standard DML used - # in ReadWrite transactions. - # - The DML statement must be fully-partitionable. Specifically, the statement - # must be expressible as the union of many statements which each access only - # a single row of the table. - # - The statement is not applied atomically to all rows of the table. Rather, - # the statement is applied atomically to partitions of the table, in - # independent transactions. Secondary index rows are updated atomically - # with the base table rows. - # - Partitioned DML does not guarantee exactly-once execution semantics - # against a partition. The statement will be applied at least once to each - # partition. It is strongly recommended that the DML statement should be - # idempotent to avoid unexpected results. For instance, it is potentially - # dangerous to run a statement such as - # `UPDATE table SET column = column + 1` as it could be run multiple times - # against some rows. - # - The partitions are committed automatically - there is no support for - # Commit or Rollback. If the call returns an error, or if the client issuing - # the ExecuteSql call dies, it is possible that some rows had the statement - # executed on them successfully. It is also possible that statement was - # never executed against other rows. - # - Partitioned DML transactions may only contain the execution of a single - # DML statement via ExecuteSql or ExecuteStreamingSql. - # - If any error is encountered during the execution of the partitioned DML + # # Transactions Each session can have at most one active transaction at a time ( + # note that standalone reads and queries use a transaction internally and do + # count towards the one transaction limit). After the active transaction is + # completed, the session can immediately be re-used for the next transaction. It + # is not necessary to create a new session for each transaction. # Transaction + # Modes Cloud Spanner supports three transaction modes: 1. Locking read-write. + # This type of transaction is the only way to write data into Cloud Spanner. + # These transactions rely on pessimistic locking and, if necessary, two-phase + # commit. Locking read-write transactions may abort, requiring the application + # to retry. 2. Snapshot read-only. This transaction type provides guaranteed + # consistency across several reads, but does not allow writes. Snapshot read- + # only transactions can be configured to read at timestamps in the past. + # Snapshot read-only transactions do not need to be committed. 3. Partitioned + # DML. This type of transaction is used to execute a single Partitioned DML + # statement. Partitioned DML partitions the key space and runs the DML statement + # over each partition in parallel using separate, internal transactions that + # commit independently. Partitioned DML transactions do not need to be committed. + # For transactions that only read, snapshot read-only transactions provide + # simpler semantics and are almost always faster. In particular, read-only + # transactions do not take locks, so they do not conflict with read-write + # transactions. As a consequence of not taking locks, they also do not abort, so + # retry loops are not needed. Transactions may only read/write data in a single + # database. They may, however, read/write data in different tables within that + # database. ## Locking Read-Write Transactions Locking transactions may be used + # to atomically read-modify-write data anywhere in a database. This type of + # transaction is externally consistent. Clients should attempt to minimize the + # amount of time a transaction is active. Faster transactions commit with higher + # probability and cause less contention. Cloud Spanner attempts to keep read + # locks active as long as the transaction continues to do reads, and the + # transaction has not been terminated by Commit or Rollback. Long periods of + # inactivity at the client may cause Cloud Spanner to release a transaction's + # locks and abort it. Conceptually, a read-write transaction consists of zero or + # more reads or SQL statements followed by Commit. At any time before Commit, + # the client can send a Rollback request to abort the transaction. ### Semantics + # Cloud Spanner can commit the transaction if all read locks it acquired are + # still valid at commit time, and it is able to acquire write locks for all + # writes. Cloud Spanner can abort the transaction for any reason. If a commit + # attempt returns `ABORTED`, Cloud Spanner guarantees that the transaction has + # not modified any user data in Cloud Spanner. Unless the transaction commits, + # Cloud Spanner makes no guarantees about how long the transaction's locks were + # held for. It is an error to use Cloud Spanner locks for any sort of mutual + # exclusion other than between Cloud Spanner transactions themselves. ### + # Retrying Aborted Transactions When a transaction aborts, the application can + # choose to retry the whole transaction again. To maximize the chances of + # successfully committing the retry, the client should execute the retry in the + # same session as the original attempt. The original session's lock priority + # increases with each consecutive abort, meaning that each attempt has a + # slightly better chance of success than the previous. Under some circumstances ( + # e.g., many transactions attempting to modify the same row(s)), a transaction + # can abort many times in a short period before successfully committing. Thus, + # it is not a good idea to cap the number of retries a transaction can attempt; + # instead, it is better to limit the total amount of wall time spent retrying. ## + # # Idle Transactions A transaction is considered idle if it has no outstanding + # reads or SQL queries and has not started a read or SQL query within the last + # 10 seconds. Idle transactions can be aborted by Cloud Spanner so that they don' + # t hold on to locks indefinitely. In that case, the commit will fail with error + # `ABORTED`. If this behavior is undesirable, periodically executing a simple + # SQL query in the transaction (e.g., `SELECT 1`) prevents the transaction from + # becoming idle. ## Snapshot Read-Only Transactions Snapshot read-only + # transactions provides a simpler method than locking read-write transactions + # for doing several consistent reads. However, this type of transaction does not + # support writes. Snapshot transactions do not take locks. Instead, they work by + # choosing a Cloud Spanner timestamp, then executing all reads at that timestamp. + # Since they do not acquire locks, they do not block concurrent read-write + # transactions. Unlike locking read-write transactions, snapshot read-only + # transactions never abort. They can fail if the chosen read timestamp is + # garbage collected; however, the default garbage collection policy is generous + # enough that most applications do not need to worry about this in practice. + # Snapshot read-only transactions do not need to call Commit or Rollback (and in + # fact are not permitted to do so). To execute a snapshot transaction, the + # client specifies a timestamp bound, which tells Cloud Spanner how to choose a + # read timestamp. The types of timestamp bound are: - Strong (the default). - + # Bounded staleness. - Exact staleness. If the Cloud Spanner database to be read + # is geographically distributed, stale read-only transactions can execute more + # quickly than strong or read-write transaction, because they are able to + # execute far from the leader replica. Each type of timestamp bound is discussed + # in detail below. ### Strong Strong reads are guaranteed to see the effects of + # all transactions that have committed before the start of the read. Furthermore, + # all rows yielded by a single read are consistent with each other -- if any + # part of the read observes a transaction, all parts of the read see the + # transaction. Strong reads are not repeatable: two consecutive strong read-only + # transactions might return inconsistent results if there are concurrent writes. + # If consistency across reads is required, the reads should be executed within a + # transaction or at an exact read timestamp. See TransactionOptions.ReadOnly. + # strong. ### Exact Staleness These timestamp bounds execute reads at a user- + # specified timestamp. Reads at a timestamp are guaranteed to see a consistent + # prefix of the global transaction history: they observe modifications done by + # all transactions with a commit timestamp <= the read timestamp, and observe + # none of the modifications done by transactions with a larger commit timestamp. + # They will block until all conflicting transactions that may be assigned commit + # timestamps <= the read timestamp have finished. The timestamp can either be + # expressed as an absolute Cloud Spanner commit timestamp or a staleness + # relative to the current time. These modes do not require a "negotiation phase" + # to pick a timestamp. As a result, they execute slightly faster than the + # equivalent boundedly stale concurrency modes. On the other hand, boundedly + # stale reads usually return fresher results. See TransactionOptions.ReadOnly. + # read_timestamp and TransactionOptions.ReadOnly.exact_staleness. ### Bounded + # Staleness Bounded staleness modes allow Cloud Spanner to pick the read + # timestamp, subject to a user-provided staleness bound. Cloud Spanner chooses + # the newest timestamp within the staleness bound that allows execution of the + # reads at the closest available replica without blocking. All rows yielded are + # consistent with each other -- if any part of the read observes a transaction, + # all parts of the read see the transaction. Boundedly stale reads are not + # repeatable: two stale reads, even if they use the same staleness bound, can + # execute at different timestamps and thus return inconsistent results. + # Boundedly stale reads execute in two phases: the first phase negotiates a + # timestamp among all replicas needed to serve the read. In the second phase, + # reads are executed at the negotiated timestamp. As a result of the two phase + # execution, bounded staleness reads are usually a little slower than comparable + # exact staleness reads. However, they are typically able to return fresher + # results, and are more likely to execute at the closest replica. Because the + # timestamp negotiation requires up-front knowledge of which rows will be read, + # it can only be used with single-use read-only transactions. See + # TransactionOptions.ReadOnly.max_staleness and TransactionOptions.ReadOnly. + # min_read_timestamp. ### Old Read Timestamps and Garbage Collection Cloud + # Spanner continuously garbage collects deleted and overwritten data in the + # background to reclaim storage space. This process is known as "version GC". By + # default, version GC reclaims versions after they are one hour old. Because of + # this, Cloud Spanner cannot perform reads at read timestamps more than one hour + # in the past. This restriction also applies to in-progress reads and/or SQL + # queries whose timestamp become too old while executing. Reads and SQL queries + # with too-old read timestamps fail with the error `FAILED_PRECONDITION`. ## + # Partitioned DML Transactions Partitioned DML transactions are used to execute + # DML statements with a different execution strategy that provides different, + # and often better, scalability properties for large, table-wide operations than + # DML in a ReadWrite transaction. Smaller scoped statements, such as an OLTP + # workload, should prefer using ReadWrite transactions. Partitioned DML + # partitions the keyspace and runs the DML statement on each partition in + # separate, internal transactions. These transactions commit automatically when + # complete, and run independently from one another. To reduce lock contention, + # this execution strategy only acquires read locks on rows that match the WHERE + # clause of the statement. Additionally, the smaller per-partition transactions + # hold locks for less time. That said, Partitioned DML is not a drop-in + # replacement for standard DML used in ReadWrite transactions. - The DML + # statement must be fully-partitionable. Specifically, the statement must be + # expressible as the union of many statements which each access only a single + # row of the table. - The statement is not applied atomically to all rows of the + # table. Rather, the statement is applied atomically to partitions of the table, + # in independent transactions. Secondary index rows are updated atomically with + # the base table rows. - Partitioned DML does not guarantee exactly-once + # execution semantics against a partition. The statement will be applied at + # least once to each partition. It is strongly recommended that the DML + # statement should be idempotent to avoid unexpected results. For instance, it + # is potentially dangerous to run a statement such as `UPDATE table SET column = + # column + 1` as it could be run multiple times against some rows. - The + # partitions are committed automatically - there is no support for Commit or + # Rollback. If the call returns an error, or if the client issuing the + # ExecuteSql call dies, it is possible that some rows had the statement executed + # on them successfully. It is also possible that statement was never executed + # against other rows. - Partitioned DML transactions may only contain the + # execution of a single DML statement via ExecuteSql or ExecuteStreamingSql. - + # If any error is encountered during the execution of the partitioned DML # operation (for instance, a UNIQUE INDEX violation, division by zero, or a - # value that cannot be stored due to schema constraints), then the - # operation is stopped at that point and an error is returned. It is - # possible that at this point, some partitions have been committed (or even - # committed multiple times), and other partitions have not been run at all. - # Given the above, Partitioned DML is good fit for large, database-wide, - # operations that are idempotent, such as deleting old rows from a very large - # table. + # value that cannot be stored due to schema constraints), then the operation is + # stopped at that point and an error is returned. It is possible that at this + # point, some partitions have been committed (or even committed multiple times), + # and other partitions have not been run at all. Given the above, Partitioned + # DML is good fit for large, database-wide, operations that are idempotent, such + # as deleting old rows from a very large table. # Corresponds to the JSON property `singleUseTransaction` # @return [Google::Apis::SpannerV1::TransactionOptions] attr_accessor :single_use_transaction @@ -812,22 +672,18 @@ module Google end end - # Metadata type for the operation returned by - # CreateBackup. + # Metadata type for the operation returned by CreateBackup. class CreateBackupMetadata include Google::Apis::Core::Hashable - # The time at which cancellation of this operation was received. - # Operations.CancelOperation - # starts asynchronous cancellation on a long-running operation. The server - # makes a best effort to cancel the operation, but success is not guaranteed. - # Clients can use - # Operations.GetOperation or - # other methods to check whether the cancellation succeeded or whether the - # operation completed despite cancellation. On successful cancellation, - # the operation is not deleted; instead, it becomes an operation with - # an Operation.error value with a google.rpc.Status.code of 1, - # corresponding to `Code.CANCELLED`. + # The time at which cancellation of this operation was received. Operations. + # CancelOperation starts asynchronous cancellation on a long-running operation. + # The server makes a best effort to cancel the operation, but success is not + # guaranteed. Clients can use Operations.GetOperation or other methods to check + # whether the cancellation succeeded or whether the operation completed despite + # cancellation. On successful cancellation, the operation is not deleted; + # instead, it becomes an operation with an Operation.error value with a google. + # rpc.Status.code of 1, corresponding to `Code.CANCELLED`. # Corresponds to the JSON property `cancelTime` # @return [String] attr_accessor :cancel_time @@ -842,8 +698,8 @@ module Google # @return [String] attr_accessor :name - # Encapsulates progress related information for a Cloud Spanner long - # running operation. + # Encapsulates progress related information for a Cloud Spanner long running + # operation. # Corresponds to the JSON property `progress` # @return [Google::Apis::SpannerV1::OperationProgress] attr_accessor :progress @@ -861,8 +717,7 @@ module Google end end - # Metadata type for the operation returned by - # CreateDatabase. + # Metadata type for the operation returned by CreateDatabase. class CreateDatabaseMetadata include Google::Apis::Core::Hashable @@ -885,19 +740,19 @@ module Google class CreateDatabaseRequest include Google::Apis::Core::Hashable - # Required. A `CREATE DATABASE` statement, which specifies the ID of the - # new database. The database ID must conform to the regular expression - # `a-z*[a-z0-9]` and be between 2 and 30 characters in length. - # If the database ID is a reserved word or if it contains a hyphen, the - # database ID must be enclosed in backticks (`` ` ``). + # Required. A `CREATE DATABASE` statement, which specifies the ID of the new + # database. The database ID must conform to the regular expression `a-z*[a-z0-9]` + # and be between 2 and 30 characters in length. If the database ID is a + # reserved word or if it contains a hyphen, the database ID must be enclosed in + # backticks (`` ` ``). # Corresponds to the JSON property `createStatement` # @return [String] attr_accessor :create_statement - # Optional. A list of DDL statements to run inside the newly created - # database. Statements can create tables, indexes, etc. These - # statements execute atomically with the creation of the database: - # if there is an error in any statement, the database is not created. + # Optional. A list of DDL statements to run inside the newly created database. + # Statements can create tables, indexes, etc. These statements execute + # atomically with the creation of the database: if there is an error in any + # statement, the database is not created. # Corresponds to the JSON property `extraStatements` # @return [Array] attr_accessor :extra_statements @@ -913,14 +768,13 @@ module Google end end - # Metadata type for the operation returned by - # CreateInstance. + # Metadata type for the operation returned by CreateInstance. class CreateInstanceMetadata include Google::Apis::Core::Hashable - # The time at which this operation was cancelled. If set, this operation is - # in the process of undoing itself (which is guaranteed to succeed) and - # cannot be cancelled again. + # The time at which this operation was cancelled. If set, this operation is in + # the process of undoing itself (which is guaranteed to succeed) and cannot be + # cancelled again. # Corresponds to the JSON property `cancelTime` # @return [String] attr_accessor :cancel_time @@ -935,9 +789,7 @@ module Google # @return [Google::Apis::SpannerV1::Instance] attr_accessor :instance - # The time at which the - # CreateInstance request was - # received. + # The time at which the CreateInstance request was received. # Corresponds to the JSON property `startTime` # @return [String] attr_accessor :start_time @@ -964,9 +816,8 @@ module Google # @return [Google::Apis::SpannerV1::Instance] attr_accessor :instance - # Required. The ID of the instance to create. Valid identifiers are of the - # form `a-z*[a-z0-9]` and must be between 2 and 64 characters in - # length. + # Required. The ID of the instance to create. Valid identifiers are of the form ` + # a-z*[a-z0-9]` and must be between 2 and 64 characters in length. # Corresponds to the JSON property `instanceId` # @return [String] attr_accessor :instance_id @@ -1010,11 +861,10 @@ module Google # @return [String] attr_accessor :create_time - # Required. The name of the database. Values are of the form - # `projects//instances//databases/`, - # where `` is as specified in the `CREATE DATABASE` - # statement. This name can be passed to other API methods to - # identify the database. + # Required. The name of the database. Values are of the form `projects// + # instances//databases/`, where `` is as specified in the `CREATE DATABASE` + # statement. This name can be passed to other API methods to identify the + # database. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name @@ -1046,12 +896,11 @@ module Google class Delete include Google::Apis::Core::Hashable - # `KeySet` defines a collection of Cloud Spanner keys and/or key ranges. All - # the keys are expected to be in the same table or index. The keys need - # not be sorted in any particular way. - # If the same key is specified multiple times in the set (for example - # if two ranges, two keys, or a key and a range overlap), Cloud Spanner - # behaves as if the key were only specified once. + # `KeySet` defines a collection of Cloud Spanner keys and/or key ranges. All the + # keys are expected to be in the same table or index. The keys need not be + # sorted in any particular way. If the same key is specified multiple times in + # the set (for example if two ranges, two keys, or a key and a range overlap), + # Cloud Spanner behaves as if the key were only specified once. # Corresponds to the JSON property `keySet` # @return [Google::Apis::SpannerV1::KeySet] attr_accessor :key_set @@ -1072,13 +921,11 @@ module Google end end - # A generic empty message that you can re-use to avoid defining duplicated - # empty messages in your APIs. A typical example is to use it as the request - # or the response type of an API method. For instance: - # service Foo ` - # rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); - # ` - # The JSON representation for `Empty` is empty JSON object ````. + # A generic empty message that you can re-use to avoid defining duplicated empty + # messages in your APIs. A typical example is to use it as the request or the + # response type of an API method. For instance: service Foo ` rpc Bar(google. + # protobuf.Empty) returns (google.protobuf.Empty); ` The JSON representation for + # `Empty` is empty JSON object ````. class Empty include Google::Apis::Core::Hashable @@ -1096,31 +943,27 @@ module Google include Google::Apis::Core::Hashable # Required. A per-transaction sequence number used to identify this request. - # This field - # makes each request idempotent such that if the request is received multiple - # times, at most one will succeed. - # The sequence number must be monotonically increasing within the - # transaction. If a request arrives for the first time with an out-of-order - # sequence number, the transaction may be aborted. Replays of previously - # handled requests will yield the same response as the first execution. + # This field makes each request idempotent such that if the request is received + # multiple times, at most one will succeed. The sequence number must be + # monotonically increasing within the transaction. If a request arrives for the + # first time with an out-of-order sequence number, the transaction may be + # aborted. Replays of previously handled requests will yield the same response + # as the first execution. # Corresponds to the JSON property `seqno` # @return [Fixnum] attr_accessor :seqno # Required. The list of statements to execute in this batch. Statements are - # executed - # serially, such that the effects of statement `i` are visible to statement - # `i+1`. Each statement must be a DML statement. Execution stops at the - # first failed statement; the remaining statements are not executed. - # Callers must provide at least one statement. + # executed serially, such that the effects of statement `i` are visible to + # statement `i+1`. Each statement must be a DML statement. Execution stops at + # the first failed statement; the remaining statements are not executed. Callers + # must provide at least one statement. # Corresponds to the JSON property `statements` # @return [Array] attr_accessor :statements - # This message is used to select the transaction in which a - # Read or - # ExecuteSql call runs. - # See TransactionOptions for more information about transactions. + # This message is used to select the transaction in which a Read or ExecuteSql + # call runs. See TransactionOptions for more information about transactions. # Corresponds to the JSON property `transaction` # @return [Google::Apis::SpannerV1::TransactionSelector] attr_accessor :transaction @@ -1137,43 +980,38 @@ module Google end end - # The response for ExecuteBatchDml. Contains a list - # of ResultSet messages, one for each DML statement that has successfully - # executed, in the same order as the statements in the request. If a statement - # fails, the status in the response body identifies the cause of the failure. - # To check for DML statements that failed, use the following approach: - # 1. Check the status in the response message. The google.rpc.Code enum - # value `OK` indicates that all statements were executed successfully. - # 2. If the status was not `OK`, check the number of result sets in the - # response. If the response contains `N` ResultSet messages, then - # statement `N+1` in the request failed. - # Example 1: - # * Request: 5 DML statements, all executed successfully. - # * Response: 5 ResultSet messages, with the status `OK`. - # Example 2: - # * Request: 5 DML statements. The third statement has a syntax error. - # * Response: 2 ResultSet messages, and a syntax error (`INVALID_ARGUMENT`) - # status. The number of ResultSet messages indicates that the third - # statement failed, and the fourth and fifth statements were not executed. + # The response for ExecuteBatchDml. Contains a list of ResultSet messages, one + # for each DML statement that has successfully executed, in the same order as + # the statements in the request. If a statement fails, the status in the + # response body identifies the cause of the failure. To check for DML statements + # that failed, use the following approach: 1. Check the status in the response + # message. The google.rpc.Code enum value `OK` indicates that all statements + # were executed successfully. 2. If the status was not `OK`, check the number of + # result sets in the response. If the response contains `N` ResultSet messages, + # then statement `N+1` in the request failed. Example 1: * Request: 5 DML + # statements, all executed successfully. * Response: 5 ResultSet messages, with + # the status `OK`. Example 2: * Request: 5 DML statements. The third statement + # has a syntax error. * Response: 2 ResultSet messages, and a syntax error (` + # INVALID_ARGUMENT`) status. The number of ResultSet messages indicates that the + # third statement failed, and the fourth and fifth statements were not executed. class ExecuteBatchDmlResponse include Google::Apis::Core::Hashable - # One ResultSet for each statement in the request that ran successfully, - # in the same order as the statements in the request. Each ResultSet does - # not contain any rows. The ResultSetStats in each ResultSet contain - # the number of rows modified by the statement. - # Only the first ResultSet in the response contains valid - # ResultSetMetadata. + # One ResultSet for each statement in the request that ran successfully, in the + # same order as the statements in the request. Each ResultSet does not contain + # any rows. The ResultSetStats in each ResultSet contain the number of rows + # modified by the statement. Only the first ResultSet in the response contains + # valid ResultSetMetadata. # Corresponds to the JSON property `resultSets` # @return [Array] attr_accessor :result_sets - # The `Status` type defines a logical error model that is suitable for - # different programming environments, including REST APIs and RPC APIs. It is - # used by [gRPC](https://github.com/grpc). Each `Status` message contains - # three pieces of data: error code, error message, and error details. - # You can find out more about this error model and how to work with it in the - # [API Design Guide](https://cloud.google.com/apis/design/errors). + # The `Status` type defines a logical error model that is suitable for different + # programming environments, including REST APIs and RPC APIs. It is used by [ + # gRPC](https://github.com/grpc). Each `Status` message contains three pieces of + # data: error code, error message, and error details. You can find out more + # about this error model and how to work with it in the [API Design Guide](https: + # //cloud.google.com/apis/design/errors). # Corresponds to the JSON property `status` # @return [Google::Apis::SpannerV1::Status] attr_accessor :status @@ -1189,47 +1027,42 @@ module Google end end - # The request for ExecuteSql and - # ExecuteStreamingSql. + # The request for ExecuteSql and ExecuteStreamingSql. class ExecuteSqlRequest include Google::Apis::Core::Hashable - # It is not always possible for Cloud Spanner to infer the right SQL type - # from a JSON value. For example, values of type `BYTES` and values - # of type `STRING` both appear in params as JSON strings. - # In these cases, `param_types` can be used to specify the exact - # SQL type for some or all of the SQL statement parameters. See the - # definition of Type for more information - # about SQL types. + # It is not always possible for Cloud Spanner to infer the right SQL type from a + # JSON value. For example, values of type `BYTES` and values of type `STRING` + # both appear in params as JSON strings. In these cases, `param_types` can be + # used to specify the exact SQL type for some or all of the SQL statement + # parameters. See the definition of Type for more information about SQL types. # Corresponds to the JSON property `paramTypes` # @return [Hash] attr_accessor :param_types - # Parameter names and values that bind to placeholders in the SQL string. - # A parameter placeholder consists of the `@` character followed by the - # parameter name (for example, `@firstName`). Parameter names must conform - # to the naming requirements of identifiers as specified at - # https://cloud.google.com/spanner/docs/lexical#identifiers. - # Parameters can appear anywhere that a literal value is expected. The same - # parameter name can be used more than once, for example: - # `"WHERE id > @msg_id AND id < @msg_id + 100"` - # It is an error to execute a SQL statement with unbound parameters. + # Parameter names and values that bind to placeholders in the SQL string. A + # parameter placeholder consists of the `@` character followed by the parameter + # name (for example, `@firstName`). Parameter names must conform to the naming + # requirements of identifiers as specified at https://cloud.google.com/spanner/ + # docs/lexical#identifiers. Parameters can appear anywhere that a literal value + # is expected. The same parameter name can be used more than once, for example: ` + # "WHERE id > @msg_id AND id < @msg_id + 100"` It is an error to execute a SQL + # statement with unbound parameters. # Corresponds to the JSON property `params` # @return [Hash] attr_accessor :params - # If present, results will be restricted to the specified partition - # previously created using PartitionQuery(). There must be an exact - # match for the values of fields common to this message and the - # PartitionQueryRequest message used to create this partition_token. + # If present, results will be restricted to the specified partition previously + # created using PartitionQuery(). There must be an exact match for the values of + # fields common to this message and the PartitionQueryRequest message used to + # create this partition_token. # Corresponds to the JSON property `partitionToken` # NOTE: Values are automatically base64 encoded/decoded in the client library. # @return [String] attr_accessor :partition_token - # Used to control the amount of debugging information returned in - # ResultSetStats. If partition_token is set, query_mode can only - # be set to QueryMode.NORMAL. + # Used to control the amount of debugging information returned in ResultSetStats. + # If partition_token is set, query_mode can only be set to QueryMode.NORMAL. # Corresponds to the JSON property `queryMode` # @return [String] attr_accessor :query_mode @@ -1239,12 +1072,11 @@ module Google # @return [Google::Apis::SpannerV1::QueryOptions] attr_accessor :query_options - # If this request is resuming a previously interrupted SQL statement - # execution, `resume_token` should be copied from the last - # PartialResultSet yielded before the interruption. Doing this - # enables the new SQL statement execution to resume where the last one left - # off. The rest of the request parameters must exactly match the - # request that yielded this token. + # If this request is resuming a previously interrupted SQL statement execution, ` + # resume_token` should be copied from the last PartialResultSet yielded before + # the interruption. Doing this enables the new SQL statement execution to resume + # where the last one left off. The rest of the request parameters must exactly + # match the request that yielded this token. # Corresponds to the JSON property `resumeToken` # NOTE: Values are automatically base64 encoded/decoded in the client library. # @return [String] @@ -1252,12 +1084,11 @@ module Google # A per-transaction sequence number used to identify this request. This field # makes each request idempotent such that if the request is received multiple - # times, at most one will succeed. - # The sequence number must be monotonically increasing within the - # transaction. If a request arrives for the first time with an out-of-order - # sequence number, the transaction may be aborted. Replays of previously - # handled requests will yield the same response as the first execution. - # Required for DML statements. Ignored for queries. + # times, at most one will succeed. The sequence number must be monotonically + # increasing within the transaction. If a request arrives for the first time + # with an out-of-order sequence number, the transaction may be aborted. Replays + # of previously handled requests will yield the same response as the first + # execution. Required for DML statements. Ignored for queries. # Corresponds to the JSON property `seqno` # @return [Fixnum] attr_accessor :seqno @@ -1267,10 +1098,8 @@ module Google # @return [String] attr_accessor :sql - # This message is used to select the transaction in which a - # Read or - # ExecuteSql call runs. - # See TransactionOptions for more information about transactions. + # This message is used to select the transaction in which a Read or ExecuteSql + # call runs. See TransactionOptions for more information about transactions. # Corresponds to the JSON property `transaction` # @return [Google::Apis::SpannerV1::TransactionSelector] attr_accessor :transaction @@ -1293,52 +1122,43 @@ module Google end end - # Represents a textual expression in the Common Expression Language (CEL) - # syntax. CEL is a C-like expression language. The syntax and semantics of CEL - # are documented at https://github.com/google/cel-spec. - # Example (Comparison): - # title: "Summary size limit" - # description: "Determines if a summary is less than 100 chars" - # expression: "document.summary.size() < 100" - # Example (Equality): - # title: "Requestor is owner" - # description: "Determines if requestor is the document owner" - # expression: "document.owner == request.auth.claims.email" - # Example (Logic): - # title: "Public documents" - # description: "Determine whether the document should be publicly visible" - # expression: "document.type != 'private' && document.type != 'internal'" - # Example (Data Manipulation): - # title: "Notification string" - # description: "Create a notification string with a timestamp." - # expression: "'New message received at ' + string(document.create_time)" - # The exact variables and functions that may be referenced within an expression - # are determined by the service that evaluates it. See the service - # documentation for additional information. + # Represents a textual expression in the Common Expression Language (CEL) syntax. + # CEL is a C-like expression language. The syntax and semantics of CEL are + # documented at https://github.com/google/cel-spec. Example (Comparison): title: + # "Summary size limit" description: "Determines if a summary is less than 100 + # chars" expression: "document.summary.size() < 100" Example (Equality): title: " + # Requestor is owner" description: "Determines if requestor is the document + # owner" expression: "document.owner == request.auth.claims.email" Example ( + # Logic): title: "Public documents" description: "Determine whether the document + # should be publicly visible" expression: "document.type != 'private' && + # document.type != 'internal'" Example (Data Manipulation): title: "Notification + # string" description: "Create a notification string with a timestamp." + # expression: "'New message received at ' + string(document.create_time)" The + # exact variables and functions that may be referenced within an expression are + # determined by the service that evaluates it. See the service documentation for + # additional information. class Expr include Google::Apis::Core::Hashable - # Optional. Description of the expression. This is a longer text which - # describes the expression, e.g. when hovered over it in a UI. + # Optional. Description of the expression. This is a longer text which describes + # the expression, e.g. when hovered over it in a UI. # Corresponds to the JSON property `description` # @return [String] attr_accessor :description - # Textual representation of an expression in Common Expression Language - # syntax. + # Textual representation of an expression in Common Expression Language syntax. # Corresponds to the JSON property `expression` # @return [String] attr_accessor :expression - # Optional. String indicating the location of the expression for error - # reporting, e.g. a file name and a position in the file. + # Optional. String indicating the location of the expression for error reporting, + # e.g. a file name and a position in the file. # Corresponds to the JSON property `location` # @return [String] attr_accessor :location - # Optional. Title for the expression, i.e. a short string describing - # its purpose. This can be used e.g. in UIs which allow to enter the - # expression. + # Optional. Title for the expression, i.e. a short string describing its purpose. + # This can be used e.g. in UIs which allow to enter the expression. # Corresponds to the JSON property `title` # @return [String] attr_accessor :title @@ -1360,13 +1180,11 @@ module Google class Field include Google::Apis::Core::Hashable - # The name of the field. For reads, this is the column name. For - # SQL queries, it is the column alias (e.g., `"Word"` in the - # query `"SELECT 'hello' AS Word"`), or the column name (e.g., - # `"ColName"` in the query `"SELECT ColName FROM Table"`). Some - # columns might have an empty name (e.g., !"SELECT - # UPPER(ColName)"`). Note that a query result can contain - # multiple fields with the same name. + # The name of the field. For reads, this is the column name. For SQL queries, it + # is the column alias (e.g., `"Word"` in the query `"SELECT 'hello' AS Word"`), + # or the column name (e.g., `"ColName"` in the query `"SELECT ColName FROM Table" + # `). Some columns might have an empty name (e.g., !"SELECT UPPER(ColName)"`). + # Note that a query result can contain multiple fields with the same name. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name @@ -1431,15 +1249,13 @@ module Google class GetPolicyOptions include Google::Apis::Core::Hashable - # Optional. The policy format version to be returned. - # Valid values are 0, 1, and 3. Requests specifying an invalid value will be - # rejected. - # 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). + # Optional. The policy format version to be returned. Valid values are 0, 1, and + # 3. Requests specifying an invalid value will be rejected. 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). # Corresponds to the JSON property `requestedPolicyVersion` # @return [Fixnum] attr_accessor :requested_policy_version @@ -1458,16 +1274,14 @@ module Google class Instance include Google::Apis::Core::Hashable - # Required. The name of the instance's configuration. Values are of the form - # `projects//instanceConfigs/`. See - # also InstanceConfig and - # ListInstanceConfigs. + # Required. The name of the instance's configuration. Values are of the form ` + # projects//instanceConfigs/`. See also InstanceConfig and ListInstanceConfigs. # Corresponds to the JSON property `config` # @return [String] attr_accessor :config - # Required. The descriptive name for this instance as it appears in UIs. - # Must be unique per project and between 4 and 30 characters in length. + # Required. The descriptive name for this instance as it appears in UIs. Must be + # unique per project and between 4 and 30 characters in length. # Corresponds to the JSON property `displayName` # @return [String] attr_accessor :display_name @@ -1482,45 +1296,39 @@ module Google # deployment strategies. Cloud Labels can be used to filter collections of # resources. They can be used to control how resource metrics are aggregated. # And they can be used as arguments to policy management rules (e.g. route, - # firewall, load balancing, etc.). - # * Label keys must be between 1 and 63 characters long and must conform to - # the following regular expression: `[a-z]([-a-z0-9]*[a-z0-9])?`. - # * Label values must be between 0 and 63 characters long and must conform - # to the regular expression `([a-z]([-a-z0-9]*[a-z0-9])?)?`. - # * No more than 64 labels can be associated with a given resource. - # See https://goo.gl/xmQnxf for more information on and examples of labels. - # If you plan to use labels in your own code, please note that additional - # characters may be allowed in the future. And so you are advised to use an - # internal label representation, such as JSON, which doesn't rely upon - # specific characters being disallowed. For example, representing labels - # as the string: name + "_" + value would prove problematic if we were to - # allow "_" in a future release. + # firewall, load balancing, etc.). * Label keys must be between 1 and 63 + # characters long and must conform to the following regular expression: `[a-z]([- + # a-z0-9]*[a-z0-9])?`. * Label values must be between 0 and 63 characters long + # and must conform to the regular expression `([a-z]([-a-z0-9]*[a-z0-9])?)?`. * + # No more than 64 labels can be associated with a given resource. See https:// + # goo.gl/xmQnxf for more information on and examples of labels. If you plan to + # use labels in your own code, please note that additional characters may be + # allowed in the future. And so you are advised to use an internal label + # representation, such as JSON, which doesn't rely upon specific characters + # being disallowed. For example, representing labels as the string: name + "_" + + # value would prove problematic if we were to allow "_" in a future release. # Corresponds to the JSON property `labels` # @return [Hash] attr_accessor :labels - # Required. A unique identifier for the instance, which cannot be changed - # after the instance is created. Values are of the form - # `projects//instances/a-z*[a-z0-9]`. The final - # segment of the name must be between 2 and 64 characters in length. + # Required. A unique identifier for the instance, which cannot be changed after + # the instance is created. Values are of the form `projects//instances/a-z*[a-z0- + # 9]`. The final segment of the name must be between 2 and 64 characters in + # length. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name - # The number of nodes allocated to this instance. This - # may be zero in API responses for instances that are not yet in state - # `READY`. - # See [the - # documentation](https://cloud.google.com/spanner/docs/instances#node_count) - # for more information about nodes. + # The number of nodes allocated to this instance. This may be zero in API + # responses for instances that are not yet in state `READY`. See [the + # documentation](https://cloud.google.com/spanner/docs/instances#node_count) for + # more information about nodes. # Corresponds to the JSON property `nodeCount` # @return [Fixnum] attr_accessor :node_count - # Output only. The current instance state. For - # CreateInstance, the state must be - # either omitted or set to `CREATING`. For - # UpdateInstance, the state must be + # Output only. The current instance state. For CreateInstance, the state must be + # either omitted or set to `CREATING`. For UpdateInstance, the state must be # either omitted or set to `READY`. # Corresponds to the JSON property `state` # @return [String] @@ -1542,8 +1350,8 @@ module Google end end - # A possible configuration for a Cloud Spanner instance. Configurations - # define the geographic placement of nodes and their replication. + # A possible configuration for a Cloud Spanner instance. Configurations define + # the geographic placement of nodes and their replication. class InstanceConfig include Google::Apis::Core::Hashable @@ -1552,9 +1360,8 @@ module Google # @return [String] attr_accessor :display_name - # A unique identifier for the instance configuration. Values - # are of the form - # `projects//instanceConfigs/a-z*` + # A unique identifier for the instance configuration. Values are of the form ` + # projects//instanceConfigs/a-z*` # Corresponds to the JSON property `name` # @return [String] attr_accessor :name @@ -1577,89 +1384,63 @@ module Google end end - # KeyRange represents a range of rows in a table or index. - # A range has a start key and an end key. These keys can be open or - # closed, indicating if the range includes rows with that key. - # Keys are represented by lists, where the ith value in the list - # corresponds to the ith component of the table or index primary key. - # Individual values are encoded as described - # here. - # For example, consider the following table definition: - # CREATE TABLE UserEvents ( - # UserName STRING(MAX), - # EventDate STRING(10) - # ) PRIMARY KEY(UserName, EventDate); - # The following keys name rows in this table: - # "Bob", "2014-09-23" - # Since the `UserEvents` table's `PRIMARY KEY` clause names two - # columns, each `UserEvents` key has two elements; the first is the - # `UserName`, and the second is the `EventDate`. - # Key ranges with multiple components are interpreted - # lexicographically by component using the table or index key's declared - # sort order. For example, the following range returns all events for - # user `"Bob"` that occurred in the year 2015: - # "start_closed": ["Bob", "2015-01-01"] - # "end_closed": ["Bob", "2015-12-31"] - # Start and end keys can omit trailing key components. This affects the - # inclusion and exclusion of rows that exactly match the provided key - # components: if the key is closed, then rows that exactly match the - # provided components are included; if the key is open, then rows - # that exactly match are not included. - # For example, the following range includes all events for `"Bob"` that - # occurred during and after the year 2000: - # "start_closed": ["Bob", "2000-01-01"] - # "end_closed": ["Bob"] - # The next example retrieves all events for `"Bob"`: - # "start_closed": ["Bob"] - # "end_closed": ["Bob"] - # To retrieve events before the year 2000: - # "start_closed": ["Bob"] - # "end_open": ["Bob", "2000-01-01"] - # The following range includes all rows in the table: - # "start_closed": [] - # "end_closed": [] - # This range returns all users whose `UserName` begins with any - # character from A to C: - # "start_closed": ["A"] - # "end_open": ["D"] - # This range returns all users whose `UserName` begins with B: - # "start_closed": ["B"] - # "end_open": ["C"] - # Key ranges honor column sort order. For example, suppose a table is - # defined as follows: - # CREATE TABLE DescendingSortedTable ` - # Key INT64, - # ... - # ) PRIMARY KEY(Key DESC); - # The following range retrieves all rows with key values between 1 - # and 100 inclusive: - # "start_closed": ["100"] - # "end_closed": ["1"] - # Note that 100 is passed as the start, and 1 is passed as the end, - # because `Key` is a descending column in the schema. + # KeyRange represents a range of rows in a table or index. A range has a start + # key and an end key. These keys can be open or closed, indicating if the range + # includes rows with that key. Keys are represented by lists, where the ith + # value in the list corresponds to the ith component of the table or index + # primary key. Individual values are encoded as described here. For example, + # consider the following table definition: CREATE TABLE UserEvents ( UserName + # STRING(MAX), EventDate STRING(10) ) PRIMARY KEY(UserName, EventDate); The + # following keys name rows in this table: "Bob", "2014-09-23" Since the ` + # UserEvents` table's `PRIMARY KEY` clause names two columns, each `UserEvents` + # key has two elements; the first is the `UserName`, and the second is the ` + # EventDate`. Key ranges with multiple components are interpreted + # lexicographically by component using the table or index key's declared sort + # order. For example, the following range returns all events for user `"Bob"` + # that occurred in the year 2015: "start_closed": ["Bob", "2015-01-01"] " + # end_closed": ["Bob", "2015-12-31"] Start and end keys can omit trailing key + # components. This affects the inclusion and exclusion of rows that exactly + # match the provided key components: if the key is closed, then rows that + # exactly match the provided components are included; if the key is open, then + # rows that exactly match are not included. For example, the following range + # includes all events for `"Bob"` that occurred during and after the year 2000: " + # start_closed": ["Bob", "2000-01-01"] "end_closed": ["Bob"] The next example + # retrieves all events for `"Bob"`: "start_closed": ["Bob"] "end_closed": ["Bob"] + # To retrieve events before the year 2000: "start_closed": ["Bob"] "end_open": [ + # "Bob", "2000-01-01"] The following range includes all rows in the table: " + # start_closed": [] "end_closed": [] This range returns all users whose ` + # UserName` begins with any character from A to C: "start_closed": ["A"] " + # end_open": ["D"] This range returns all users whose `UserName` begins with B: " + # start_closed": ["B"] "end_open": ["C"] Key ranges honor column sort order. For + # example, suppose a table is defined as follows: CREATE TABLE + # DescendingSortedTable ` Key INT64, ... ) PRIMARY KEY(Key DESC); The following + # range retrieves all rows with key values between 1 and 100 inclusive: " + # start_closed": ["100"] "end_closed": ["1"] Note that 100 is passed as the + # start, and 1 is passed as the end, because `Key` is a descending column in the + # schema. class KeyRange include Google::Apis::Core::Hashable - # If the end is closed, then the range includes all rows whose - # first `len(end_closed)` key columns exactly match `end_closed`. + # If the end is closed, then the range includes all rows whose first `len( + # end_closed)` key columns exactly match `end_closed`. # Corresponds to the JSON property `endClosed` # @return [Array] attr_accessor :end_closed - # If the end is open, then the range excludes rows whose first - # `len(end_open)` key columns exactly match `end_open`. + # If the end is open, then the range excludes rows whose first `len(end_open)` + # key columns exactly match `end_open`. # Corresponds to the JSON property `endOpen` # @return [Array] attr_accessor :end_open - # If the start is closed, then the range includes all rows whose - # first `len(start_closed)` key columns exactly match `start_closed`. + # If the start is closed, then the range includes all rows whose first `len( + # start_closed)` key columns exactly match `start_closed`. # Corresponds to the JSON property `startClosed` # @return [Array] attr_accessor :start_closed - # If the start is open, then the range excludes rows whose first - # `len(start_open)` key columns exactly match `start_open`. + # If the start is open, then the range excludes rows whose first `len(start_open) + # ` key columns exactly match `start_open`. # Corresponds to the JSON property `startOpen` # @return [Array] attr_accessor :start_open @@ -1677,33 +1458,31 @@ module Google end end - # `KeySet` defines a collection of Cloud Spanner keys and/or key ranges. All - # the keys are expected to be in the same table or index. The keys need - # not be sorted in any particular way. - # If the same key is specified multiple times in the set (for example - # if two ranges, two keys, or a key and a range overlap), Cloud Spanner - # behaves as if the key were only specified once. + # `KeySet` defines a collection of Cloud Spanner keys and/or key ranges. All the + # keys are expected to be in the same table or index. The keys need not be + # sorted in any particular way. If the same key is specified multiple times in + # the set (for example if two ranges, two keys, or a key and a range overlap), + # Cloud Spanner behaves as if the key were only specified once. class KeySet include Google::Apis::Core::Hashable - # For convenience `all` can be set to `true` to indicate that this - # `KeySet` matches all keys in the table or index. Note that any keys - # specified in `keys` or `ranges` are only yielded once. + # For convenience `all` can be set to `true` to indicate that this `KeySet` + # matches all keys in the table or index. Note that any keys specified in `keys` + # or `ranges` are only yielded once. # Corresponds to the JSON property `all` # @return [Boolean] attr_accessor :all alias_method :all?, :all - # A list of specific keys. Entries in `keys` should have exactly as - # many elements as there are columns in the primary or index key - # with which this `KeySet` is used. Individual key values are - # encoded as described here. + # A list of specific keys. Entries in `keys` should have exactly as many + # elements as there are columns in the primary or index key with which this ` + # KeySet` is used. Individual key values are encoded as described here. # Corresponds to the JSON property `keys` # @return [Array>] attr_accessor :keys - # A list of key ranges. See KeyRange for more information about - # key range specifications. + # A list of key ranges. See KeyRange for more information about key range + # specifications. # Corresponds to the JSON property `ranges` # @return [Array] attr_accessor :ranges @@ -1720,27 +1499,22 @@ module Google end end - # The response for - # ListBackupOperations. + # The response for ListBackupOperations. class ListBackupOperationsResponse include Google::Apis::Core::Hashable - # `next_page_token` can be sent in a subsequent - # ListBackupOperations - # call to fetch more of the matching metadata. + # `next_page_token` can be sent in a subsequent ListBackupOperations call to + # fetch more of the matching metadata. # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token - # The list of matching backup long-running - # operations. Each operation's name will be - # prefixed by the backup's name and the operation's - # metadata will be of type - # CreateBackupMetadata. Operations returned include those that are - # pending or have completed/failed/canceled within the last 7 days. - # Operations returned are ordered by - # `operation.metadata.value.progress.start_time` in descending order starting - # from the most recently started operation. + # The list of matching backup long-running operations. Each operation's name + # will be prefixed by the backup's name and the operation's metadata will be of + # type CreateBackupMetadata. Operations returned include those that are pending + # or have completed/failed/canceled within the last 7 days. Operations returned + # are ordered by `operation.metadata.value.progress.start_time` in descending + # order starting from the most recently started operation. # Corresponds to the JSON property `operations` # @return [Array] attr_accessor :operations @@ -1760,14 +1534,13 @@ module Google class ListBackupsResponse include Google::Apis::Core::Hashable - # The list of matching backups. Backups returned are ordered by `create_time` - # in descending order, starting from the most recent `create_time`. + # The list of matching backups. Backups returned are ordered by `create_time` in + # descending order, starting from the most recent `create_time`. # Corresponds to the JSON property `backups` # @return [Array] attr_accessor :backups - # `next_page_token` can be sent in a subsequent - # ListBackups call to fetch more + # `next_page_token` can be sent in a subsequent ListBackups call to fetch more # of the matching backups. # Corresponds to the JSON property `nextPageToken` # @return [String] @@ -1784,23 +1557,19 @@ module Google end end - # The response for - # ListDatabaseOperations. + # The response for ListDatabaseOperations. class ListDatabaseOperationsResponse include Google::Apis::Core::Hashable - # `next_page_token` can be sent in a subsequent - # ListDatabaseOperations - # call to fetch more of the matching metadata. + # `next_page_token` can be sent in a subsequent ListDatabaseOperations call to + # fetch more of the matching metadata. # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token - # The list of matching database long-running - # operations. Each operation's name will be - # prefixed by the database's name. The operation's - # metadata field type - # `metadata.type_url` describes the type of the metadata. + # The list of matching database long-running operations. Each operation's name + # will be prefixed by the database's name. The operation's metadata field type ` + # metadata.type_url` describes the type of the metadata. # Corresponds to the JSON property `operations` # @return [Array] attr_accessor :operations @@ -1825,8 +1594,7 @@ module Google # @return [Array] attr_accessor :databases - # `next_page_token` can be sent in a subsequent - # ListDatabases call to fetch more + # `next_page_token` can be sent in a subsequent ListDatabases call to fetch more # of the matching databases. # Corresponds to the JSON property `nextPageToken` # @return [String] @@ -1852,8 +1620,7 @@ module Google # @return [Array] attr_accessor :instance_configs - # `next_page_token` can be sent in a subsequent - # ListInstanceConfigs call to + # `next_page_token` can be sent in a subsequent ListInstanceConfigs call to # fetch more of the matching instance configurations. # Corresponds to the JSON property `nextPageToken` # @return [String] @@ -1879,8 +1646,7 @@ module Google # @return [Array] attr_accessor :instances - # `next_page_token` can be sent in a subsequent - # ListInstances call to fetch more + # `next_page_token` can be sent in a subsequent ListInstances call to fetch more # of the matching instances. # Corresponds to the JSON property `nextPageToken` # @return [String] @@ -1926,9 +1692,8 @@ module Google class ListSessionsResponse include Google::Apis::Core::Hashable - # `next_page_token` can be sent in a subsequent - # ListSessions call to fetch more of the matching - # sessions. + # `next_page_token` can be sent in a subsequent ListSessions call to fetch more + # of the matching sessions. # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token @@ -1949,9 +1714,8 @@ module Google end end - # A modification to one or more Cloud Spanner rows. Mutations can be - # applied to a Cloud Spanner database by sending them in a - # Commit call. + # A modification to one or more Cloud Spanner rows. Mutations can be applied to + # a Cloud Spanner database by sending them in a Commit call. class Mutation include Google::Apis::Core::Hashable @@ -1960,26 +1724,22 @@ module Google # @return [Google::Apis::SpannerV1::Delete] attr_accessor :delete - # Arguments to insert, update, insert_or_update, and - # replace operations. + # Arguments to insert, update, insert_or_update, and replace operations. # Corresponds to the JSON property `insert` # @return [Google::Apis::SpannerV1::Write] attr_accessor :insert - # Arguments to insert, update, insert_or_update, and - # replace operations. + # Arguments to insert, update, insert_or_update, and replace operations. # Corresponds to the JSON property `insertOrUpdate` # @return [Google::Apis::SpannerV1::Write] attr_accessor :insert_or_update - # Arguments to insert, update, insert_or_update, and - # replace operations. + # Arguments to insert, update, insert_or_update, and replace operations. # Corresponds to the JSON property `replace` # @return [Google::Apis::SpannerV1::Write] attr_accessor :replace - # Arguments to insert, update, insert_or_update, and - # replace operations. + # Arguments to insert, update, insert_or_update, and replace operations. # Corresponds to the JSON property `update` # @return [Google::Apis::SpannerV1::Write] attr_accessor :update @@ -2003,47 +1763,45 @@ module Google class Operation include Google::Apis::Core::Hashable - # If the value is `false`, it means the operation is still in progress. - # If `true`, the operation is completed, and either `error` or `response` is - # available. + # If the value is `false`, it means the operation is still in progress. If `true` + # , the operation is completed, and either `error` or `response` is available. # Corresponds to the JSON property `done` # @return [Boolean] attr_accessor :done alias_method :done?, :done - # The `Status` type defines a logical error model that is suitable for - # different programming environments, including REST APIs and RPC APIs. It is - # used by [gRPC](https://github.com/grpc). Each `Status` message contains - # three pieces of data: error code, error message, and error details. - # You can find out more about this error model and how to work with it in the - # [API Design Guide](https://cloud.google.com/apis/design/errors). + # The `Status` type defines a logical error model that is suitable for different + # programming environments, including REST APIs and RPC APIs. It is used by [ + # gRPC](https://github.com/grpc). Each `Status` message contains three pieces of + # data: error code, error message, and error details. You can find out more + # about this error model and how to work with it in the [API Design Guide](https: + # //cloud.google.com/apis/design/errors). # Corresponds to the JSON property `error` # @return [Google::Apis::SpannerV1::Status] attr_accessor :error - # Service-specific metadata associated with the operation. It typically - # contains progress information and common metadata such as create time. - # Some services might not provide such metadata. Any method that returns a - # long-running operation should document the metadata type, if any. + # Service-specific metadata associated with the operation. It typically contains + # progress information and common metadata such as create time. Some services + # might not provide such metadata. Any method that returns a long-running + # operation should document the metadata type, if any. # Corresponds to the JSON property `metadata` # @return [Hash] attr_accessor :metadata # The server-assigned name, which is only unique within the same service that - # originally returns it. If you use the default HTTP mapping, the - # `name` should be a resource name ending with `operations/`unique_id``. + # originally returns it. If you use the default HTTP mapping, the `name` should + # be a resource name ending with `operations/`unique_id``. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name - # The normal response of the operation in case of success. If the original - # method returns no data on success, such as `Delete`, the response is - # `google.protobuf.Empty`. If the original method is standard - # `Get`/`Create`/`Update`, the response should be the resource. For other - # methods, the response should have the type `XxxResponse`, where `Xxx` - # is the original method name. For example, if the original method name - # is `TakeSnapshot()`, the inferred response type is - # `TakeSnapshotResponse`. + # The normal response of the operation in case of success. If the original + # method returns no data on success, such as `Delete`, the response is `google. + # protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, + # the response should be the resource. For other methods, the response should + # have the type `XxxResponse`, where `Xxx` is the original method name. For + # example, if the original method name is `TakeSnapshot()`, the inferred + # response type is `TakeSnapshotResponse`. # Corresponds to the JSON property `response` # @return [Hash] attr_accessor :response @@ -2062,19 +1820,17 @@ module Google end end - # Encapsulates progress related information for a Cloud Spanner long - # running operation. + # Encapsulates progress related information for a Cloud Spanner long running + # operation. class OperationProgress include Google::Apis::Core::Hashable - # If set, the time at which this operation failed or was completed - # successfully. + # If set, the time at which this operation failed or was completed successfully. # Corresponds to the JSON property `endTime` # @return [String] attr_accessor :end_time - # Percent completion of the operation. - # Values are between 0 and 100 inclusive. + # Percent completion of the operation. Values are between 0 and 100 inclusive. # Corresponds to the JSON property `progressPercent` # @return [Fixnum] attr_accessor :progress_percent @@ -2096,8 +1852,8 @@ module Google end end - # Metadata type for the long-running operation used to track the progress - # of optimizations performed on a newly restored database. This long-running + # Metadata type for the long-running operation used to track the progress of + # optimizations performed on a newly restored database. This long-running # operation is automatically created by the system after the successful # completion of a database restore, and cannot be cancelled. class OptimizeRestoredDatabaseMetadata @@ -2108,8 +1864,8 @@ module Google # @return [String] attr_accessor :name - # Encapsulates progress related information for a Cloud Spanner long - # running operation. + # Encapsulates progress related information for a Cloud Spanner long running + # operation. # Corresponds to the JSON property `progress` # @return [Google::Apis::SpannerV1::OperationProgress] attr_accessor :progress @@ -2125,15 +1881,15 @@ module Google end end - # Partial results from a streaming read or SQL query. Streaming reads and - # SQL queries better tolerate large result sets, large rows, and large - # values, but are a little trickier to consume. + # Partial results from a streaming read or SQL query. Streaming reads and SQL + # queries better tolerate large result sets, large rows, and large values, but + # are a little trickier to consume. class PartialResultSet include Google::Apis::Core::Hashable - # If true, then the final value in values is chunked, and must - # be combined with more values from subsequent `PartialResultSet`s - # to obtain a complete field value. + # If true, then the final value in values is chunked, and must be combined with + # more values from subsequent `PartialResultSet`s to obtain a complete field + # value. # Corresponds to the JSON property `chunkedValue` # @return [Boolean] attr_accessor :chunked_value @@ -2144,11 +1900,10 @@ module Google # @return [Google::Apis::SpannerV1::ResultSetMetadata] attr_accessor :metadata - # Streaming calls might be interrupted for a variety of reasons, such - # as TCP connection loss. If this occurs, the stream of results can - # be resumed by re-sending the original request and including - # `resume_token`. Note that executing any other transaction in the - # same session invalidates the token. + # Streaming calls might be interrupted for a variety of reasons, such as TCP + # connection loss. If this occurs, the stream of results can be resumed by re- + # sending the original request and including `resume_token`. Note that executing + # any other transaction in the same session invalidates the token. # Corresponds to the JSON property `resumeToken` # NOTE: Values are automatically base64 encoded/decoded in the client library. # @return [String] @@ -2159,65 +1914,38 @@ module Google # @return [Google::Apis::SpannerV1::ResultSetStats] attr_accessor :stats - # A streamed result set consists of a stream of values, which might - # be split into many `PartialResultSet` messages to accommodate - # large rows and/or large values. Every N complete values defines a - # row, where N is equal to the number of entries in - # metadata.row_type.fields. - # Most values are encoded based on type as described - # here. - # It is possible that the last value in values is "chunked", - # meaning that the rest of the value is sent in subsequent - # `PartialResultSet`(s). This is denoted by the chunked_value - # field. Two or more chunked values can be merged to form a - # complete value as follows: - # * `bool/number/null`: cannot be chunked - # * `string`: concatenate the strings - # * `list`: concatenate the lists. If the last element in a list is a - # `string`, `list`, or `object`, merge it with the first element in - # the next list by applying these rules recursively. - # * `object`: concatenate the (field name, field value) pairs. If a - # field name is duplicated, then apply these rules recursively - # to merge the field values. - # Some examples of merging: - # # Strings are concatenated. - # "foo", "bar" => "foobar" - # # Lists of non-strings are concatenated. - # [2, 3], [4] => [2, 3, 4] - # # Lists are concatenated, but the last and first elements are merged - # # because they are strings. - # ["a", "b"], ["c", "d"] => ["a", "bc", "d"] - # # Lists are concatenated, but the last and first elements are merged - # # because they are lists. Recursively, the last and first elements - # # of the inner lists are merged because they are strings. - # ["a", ["b", "c"]], [["d"], "e"] => ["a", ["b", "cd"], "e"] - # # Non-overlapping object fields are combined. - # `"a": "1"`, `"b": "2"` => `"a": "1", "b": 2"` - # # Overlapping object fields are merged. - # `"a": "1"`, `"a": "2"` => `"a": "12"` - # # Examples of merging objects containing lists of strings. - # `"a": ["1"]`, `"a": ["2"]` => `"a": ["12"]` - # For a more complete example, suppose a streaming SQL query is - # yielding a result set whose rows contain a single string - # field. The following `PartialResultSet`s might be yielded: - # ` - # "metadata": ` ... ` - # "values": ["Hello", "W"] - # "chunked_value": true - # "resume_token": "Af65..." - # ` - # ` - # "values": ["orl"] - # "chunked_value": true - # "resume_token": "Bqp2..." - # ` - # ` - # "values": ["d"] - # "resume_token": "Zx1B..." - # ` - # This sequence of `PartialResultSet`s encodes two rows, one - # containing the field value `"Hello"`, and a second containing the - # field value `"World" = "W" + "orl" + "d"`. + # A streamed result set consists of a stream of values, which might be split + # into many `PartialResultSet` messages to accommodate large rows and/or large + # values. Every N complete values defines a row, where N is equal to the number + # of entries in metadata.row_type.fields. Most values are encoded based on type + # as described here. It is possible that the last value in values is "chunked", + # meaning that the rest of the value is sent in subsequent `PartialResultSet`(s). + # This is denoted by the chunked_value field. Two or more chunked values can be + # merged to form a complete value as follows: * `bool/number/null`: cannot be + # chunked * `string`: concatenate the strings * `list`: concatenate the lists. + # If the last element in a list is a `string`, `list`, or `object`, merge it + # with the first element in the next list by applying these rules recursively. * + # `object`: concatenate the (field name, field value) pairs. If a field name is + # duplicated, then apply these rules recursively to merge the field values. Some + # examples of merging: # Strings are concatenated. "foo", "bar" => "foobar" # + # Lists of non-strings are concatenated. [2, 3], [4] => [2, 3, 4] # Lists are + # concatenated, but the last and first elements are merged # because they are + # strings. ["a", "b"], ["c", "d"] => ["a", "bc", "d"] # Lists are concatenated, + # but the last and first elements are merged # because they are lists. + # Recursively, the last and first elements # of the inner lists are merged + # because they are strings. ["a", ["b", "c"]], [["d"], "e"] => ["a", ["b", "cd"], + # "e"] # Non-overlapping object fields are combined. `"a": "1"`, `"b": "2"` => ` + # "a": "1", "b": 2"` # Overlapping object fields are merged. `"a": "1"`, `"a": " + # 2"` => `"a": "12"` # Examples of merging objects containing lists of strings. ` + # "a": ["1"]`, `"a": ["2"]` => `"a": ["12"]` For a more complete example, + # suppose a streaming SQL query is yielding a result set whose rows contain a + # single string field. The following `PartialResultSet`s might be yielded: ` " + # metadata": ` ... ` "values": ["Hello", "W"] "chunked_value": true " + # resume_token": "Af65..." ` ` "values": ["orl"] "chunked_value": true " + # resume_token": "Bqp2..." ` ` "values": ["d"] "resume_token": "Zx1B..." ` This + # sequence of `PartialResultSet`s encodes two rows, one containing the field + # value `"Hello"`, and a second containing the field value `"World" = "W" + "orl" + # + "d"`. # Corresponds to the JSON property `values` # @return [Array] attr_accessor :values @@ -2236,8 +1964,7 @@ module Google end end - # Information returned for each partition returned in a - # PartitionResponse. + # Information returned for each partition returned in a PartitionResponse. class Partition include Google::Apis::Core::Hashable @@ -2259,26 +1986,23 @@ module Google end end - # Options for a PartitionQueryRequest and - # PartitionReadRequest. + # Options for a PartitionQueryRequest and PartitionReadRequest. class PartitionOptions include Google::Apis::Core::Hashable - # **Note:** This hint is currently ignored by PartitionQuery and - # PartitionRead requests. - # The desired maximum number of partitions to return. For example, this may - # be set to the number of workers available. The default for this option - # is currently 10,000. The maximum value is currently 200,000. This is only - # a hint. The actual number of partitions returned may be smaller or larger + # **Note:** This hint is currently ignored by PartitionQuery and PartitionRead + # requests. The desired maximum number of partitions to return. For example, + # this may be set to the number of workers available. The default for this + # option is currently 10,000. The maximum value is currently 200,000. This is + # only a hint. The actual number of partitions returned may be smaller or larger # than this maximum count request. # Corresponds to the JSON property `maxPartitions` # @return [Fixnum] attr_accessor :max_partitions - # **Note:** This hint is currently ignored by PartitionQuery and - # PartitionRead requests. - # The desired data size for each partition generated. The default for this - # option is currently 1 GiB. This is only a hint. The actual size of each + # **Note:** This hint is currently ignored by PartitionQuery and PartitionRead + # requests. The desired data size for each partition generated. The default for + # this option is currently 1 GiB. This is only a hint. The actual size of each # partition may be smaller or larger than this size request. # Corresponds to the JSON property `partitionSizeBytes` # @return [Fixnum] @@ -2299,53 +2023,45 @@ module Google class PartitionQueryRequest include Google::Apis::Core::Hashable - # It is not always possible for Cloud Spanner to infer the right SQL type - # from a JSON value. For example, values of type `BYTES` and values - # of type `STRING` both appear in params as JSON strings. - # In these cases, `param_types` can be used to specify the exact - # SQL type for some or all of the SQL query parameters. See the - # definition of Type for more information - # about SQL types. + # It is not always possible for Cloud Spanner to infer the right SQL type from a + # JSON value. For example, values of type `BYTES` and values of type `STRING` + # both appear in params as JSON strings. In these cases, `param_types` can be + # used to specify the exact SQL type for some or all of the SQL query parameters. + # See the definition of Type for more information about SQL types. # Corresponds to the JSON property `paramTypes` # @return [Hash] attr_accessor :param_types - # Parameter names and values that bind to placeholders in the SQL string. - # A parameter placeholder consists of the `@` character followed by the - # parameter name (for example, `@firstName`). Parameter names can contain - # letters, numbers, and underscores. - # Parameters can appear anywhere that a literal value is expected. The same - # parameter name can be used more than once, for example: - # `"WHERE id > @msg_id AND id < @msg_id + 100"` - # It is an error to execute a SQL statement with unbound parameters. + # Parameter names and values that bind to placeholders in the SQL string. A + # parameter placeholder consists of the `@` character followed by the parameter + # name (for example, `@firstName`). Parameter names can contain letters, numbers, + # and underscores. Parameters can appear anywhere that a literal value is + # expected. The same parameter name can be used more than once, for example: `" + # WHERE id > @msg_id AND id < @msg_id + 100"` It is an error to execute a SQL + # statement with unbound parameters. # Corresponds to the JSON property `params` # @return [Hash] attr_accessor :params - # Options for a PartitionQueryRequest and - # PartitionReadRequest. + # Options for a PartitionQueryRequest and PartitionReadRequest. # Corresponds to the JSON property `partitionOptions` # @return [Google::Apis::SpannerV1::PartitionOptions] attr_accessor :partition_options # Required. The query request to generate partitions for. The request will fail - # if - # the query is not root partitionable. The query plan of a root - # partitionable query has a single distributed union operator. A distributed - # union operator conceptually divides one or more tables into multiple - # splits, remotely evaluates a subquery independently on each split, and - # then unions all results. - # This must not contain DML commands, such as INSERT, UPDATE, or - # DELETE. Use ExecuteStreamingSql with a - # PartitionedDml transaction for large, partition-friendly DML operations. + # if the query is not root partitionable. The query plan of a root partitionable + # query has a single distributed union operator. A distributed union operator + # conceptually divides one or more tables into multiple splits, remotely + # evaluates a subquery independently on each split, and then unions all results. + # This must not contain DML commands, such as INSERT, UPDATE, or DELETE. Use + # ExecuteStreamingSql with a PartitionedDml transaction for large, partition- + # friendly DML operations. # Corresponds to the JSON property `sql` # @return [String] attr_accessor :sql - # This message is used to select the transaction in which a - # Read or - # ExecuteSql call runs. - # See TransactionOptions for more information about transactions. + # This message is used to select the transaction in which a Read or ExecuteSql + # call runs. See TransactionOptions for more information about transactions. # Corresponds to the JSON property `transaction` # @return [Google::Apis::SpannerV1::TransactionSelector] attr_accessor :transaction @@ -2368,31 +2084,28 @@ module Google class PartitionReadRequest include Google::Apis::Core::Hashable - # The columns of table to be returned for each row matching - # this request. + # The columns of table to be returned for each row matching this request. # Corresponds to the JSON property `columns` # @return [Array] attr_accessor :columns - # If non-empty, the name of an index on table. This index is - # used instead of the table primary key when interpreting key_set - # and sorting result rows. See key_set for further information. + # If non-empty, the name of an index on table. This index is used instead of the + # table primary key when interpreting key_set and sorting result rows. See + # key_set for further information. # Corresponds to the JSON property `index` # @return [String] attr_accessor :index - # `KeySet` defines a collection of Cloud Spanner keys and/or key ranges. All - # the keys are expected to be in the same table or index. The keys need - # not be sorted in any particular way. - # If the same key is specified multiple times in the set (for example - # if two ranges, two keys, or a key and a range overlap), Cloud Spanner - # behaves as if the key were only specified once. + # `KeySet` defines a collection of Cloud Spanner keys and/or key ranges. All the + # keys are expected to be in the same table or index. The keys need not be + # sorted in any particular way. If the same key is specified multiple times in + # the set (for example if two ranges, two keys, or a key and a range overlap), + # Cloud Spanner behaves as if the key were only specified once. # Corresponds to the JSON property `keySet` # @return [Google::Apis::SpannerV1::KeySet] attr_accessor :key_set - # Options for a PartitionQueryRequest and - # PartitionReadRequest. + # Options for a PartitionQueryRequest and PartitionReadRequest. # Corresponds to the JSON property `partitionOptions` # @return [Google::Apis::SpannerV1::PartitionOptions] attr_accessor :partition_options @@ -2402,10 +2115,8 @@ module Google # @return [String] attr_accessor :table - # This message is used to select the transaction in which a - # Read or - # ExecuteSql call runs. - # See TransactionOptions for more information about transactions. + # This message is used to select the transaction in which a Read or ExecuteSql + # call runs. See TransactionOptions for more information about transactions. # Corresponds to the JSON property `transaction` # @return [Google::Apis::SpannerV1::TransactionSelector] attr_accessor :transaction @@ -2425,8 +2136,7 @@ module Google end end - # The response for PartitionQuery - # or PartitionRead + # The response for PartitionQuery or PartitionRead class PartitionResponse include Google::Apis::Core::Hashable @@ -2478,10 +2188,10 @@ module Google # @return [String] attr_accessor :display_name - # The execution statistics associated with the node, contained in a group of - # key-value pairs. Only present if the plan was returned as a result of a - # profile query. For example, number of executions, number of rows/time per - # execution etc. + # The execution statistics associated with the node, contained in a group of key- + # value pairs. Only present if the plan was returned as a result of a profile + # query. For example, number of executions, number of rows/time per execution + # etc. # Corresponds to the JSON property `executionStats` # @return [Hash] attr_accessor :execution_stats @@ -2491,28 +2201,23 @@ module Google # @return [Fixnum] attr_accessor :index - # Used to determine the type of node. May be needed for visualizing - # different kinds of nodes differently. For example, If the node is a - # SCALAR node, it will have a condensed representation - # which can be used to directly embed a description of the node in its - # parent. + # Used to determine the type of node. May be needed for visualizing different + # kinds of nodes differently. For example, If the node is a SCALAR node, it will + # have a condensed representation which can be used to directly embed a + # description of the node in its parent. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind - # Attributes relevant to the node contained in a group of key-value pairs. - # For example, a Parameter Reference node could have the following - # information in its metadata: - # ` - # "parameter_reference": "param1", - # "parameter_type": "array" - # ` + # Attributes relevant to the node contained in a group of key-value pairs. For + # example, a Parameter Reference node could have the following information in + # its metadata: ` "parameter_reference": "param1", "parameter_type": "array" ` # Corresponds to the JSON property `metadata` # @return [Hash] attr_accessor :metadata - # Condensed representation of a node and its subtree. Only present for - # `SCALAR` PlanNode(s). + # Condensed representation of a node and its subtree. Only present for `SCALAR` + # PlanNode(s). # Corresponds to the JSON property `shortRepresentation` # @return [Google::Apis::SpannerV1::ShortRepresentation] attr_accessor :short_representation @@ -2534,111 +2239,73 @@ module Google end # An Identity and Access Management (IAM) policy, which specifies access - # controls for Google Cloud resources. - # A `Policy` is a collection of `bindings`. A `binding` binds one or more - # `members` to a single `role`. Members can be user accounts, service accounts, - # 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. - # 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": [ - # ` - # "role": "roles/resourcemanager.organizationAdmin", - # "members": [ - # "user:mike@example.com", - # "group:admins@example.com", - # "domain:google.com", - # "serviceAccount:my-project-id@appspot.gserviceaccount.com" - # ] - # `, - # ` - # "role": "roles/resourcemanager.organizationViewer", - # "members": [ - # "user:eve@example.com" - # ], - # "condition": ` - # "title": "expirable access", - # "description": "Does not grant access after Sep 2020", - # "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z') - # ", - # ` - # ` - # ], - # "etag": "BwWWja0YfJA=", - # "version": 3 - # ` - # **YAML example:** - # bindings: - # - members: - # - user:mike@example.com - # - group:admins@example.com - # - domain:google.com - # - serviceAccount:my-project-id@appspot.gserviceaccount.com - # role: roles/resourcemanager.organizationAdmin - # - members: - # - user:eve@example.com - # role: roles/resourcemanager.organizationViewer - # condition: - # title: expirable access - # description: Does not grant access after Sep 2020 - # expression: request.time < timestamp('2020-10-01T00:00:00.000Z') - # - etag: BwWWja0YfJA= - # - version: 3 - # For a description of IAM and its features, see the - # [IAM documentation](https://cloud.google.com/iam/docs/). + # controls for Google Cloud resources. A `Policy` is a collection of `bindings`. + # A `binding` binds one or more `members` to a single `role`. Members can be + # user accounts, service accounts, 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. 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": [ ` "role": "roles/ + # resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", " + # group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@ + # appspot.gserviceaccount.com" ] `, ` "role": "roles/resourcemanager. + # organizationViewer", "members": [ "user:eve@example.com" ], "condition": ` " + # title": "expirable access", "description": "Does not grant access after Sep + # 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", ` + # ` ], "etag": "BwWWja0YfJA=", "version": 3 ` **YAML example:** bindings: - + # members: - user:mike@example.com - group:admins@example.com - domain:google. + # com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/ + # resourcemanager.organizationAdmin - members: - user:eve@example.com role: + # roles/resourcemanager.organizationViewer condition: title: expirable access + # description: Does not grant access after Sep 2020 expression: request.time < + # timestamp('2020-10-01T00:00:00.000Z') - etag: BwWWja0YfJA= - version: 3 For a + # description of IAM and its features, see the [IAM documentation](https://cloud. + # google.com/iam/docs/). class Policy include Google::Apis::Core::Hashable - # Associates a list of `members` to a `role`. Optionally, may specify a - # `condition` that determines how and when the `bindings` are applied. Each - # of the `bindings` must contain at least one member. + # Associates a list of `members` to a `role`. Optionally, may specify a ` + # condition` that determines how and when the `bindings` are applied. Each of + # the `bindings` must contain at least one member. # Corresponds to the JSON property `bindings` # @return [Array] attr_accessor :bindings - # `etag` is used for optimistic concurrency control as a way to help - # prevent simultaneous updates of a policy from overwriting each other. - # It is strongly suggested that systems make use of the `etag` in the - # read-modify-write cycle to perform policy updates in order to avoid race - # conditions: An `etag` is returned in the response to `getIamPolicy`, and - # systems are expected to put that etag in the request to `setIamPolicy` to - # ensure that their change will be applied to the same version of the policy. - # **Important:** If you use IAM Conditions, you must include the `etag` field - # whenever you call `setIamPolicy`. If you omit this field, then IAM allows - # you to overwrite a version `3` policy with a version `1` policy, and all of - # the conditions in the version `3` policy are lost. + # `etag` is used for optimistic concurrency control as a way to help prevent + # simultaneous updates of a policy from overwriting each other. It is strongly + # suggested that systems make use of the `etag` in the read-modify-write cycle + # to perform policy updates in order to avoid race conditions: An `etag` is + # returned in the response to `getIamPolicy`, and systems are expected to put + # that etag in the request to `setIamPolicy` to ensure that their change will be + # applied to the same version of the policy. **Important:** If you use IAM + # Conditions, you must include the `etag` field whenever you call `setIamPolicy`. + # If you omit this field, then IAM allows you to overwrite a version `3` policy + # with a version `1` policy, and all of the conditions in the version `3` policy + # are lost. # Corresponds to the JSON property `etag` # NOTE: Values are automatically base64 encoded/decoded in the client library. # @return [String] attr_accessor :etag - # Specifies the format of the policy. - # Valid values are `0`, `1`, and `3`. Requests that specify an invalid value - # are rejected. - # Any operation that affects conditional role bindings must specify version - # `3`. This requirement applies to the following operations: - # * Getting a policy that includes a conditional role binding - # * Adding a conditional role binding to a policy - # * Changing a conditional role binding in a policy - # * Removing any role binding, with or without a condition, from a policy - # that includes conditions - # **Important:** If you use IAM Conditions, you must include the `etag` field - # whenever you call `setIamPolicy`. If you omit this field, then IAM allows - # you to overwrite a version `3` policy with a version `1` policy, and all of - # 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). + # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. + # Requests that specify an invalid value are rejected. Any operation that + # affects conditional role bindings must specify version `3`. This requirement + # applies to the following operations: * Getting a policy that includes a + # conditional role binding * Adding a conditional role binding to a policy * + # Changing a conditional role binding in a policy * Removing any role binding, + # with or without a condition, from a policy that includes conditions ** + # Important:** If you use IAM Conditions, you must include the `etag` field + # whenever you call `setIamPolicy`. If you omit this field, then IAM allows you + # to overwrite a version `3` policy with a version `1` policy, and all of 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 @@ -2659,22 +2326,18 @@ module Google class QueryOptions include Google::Apis::Core::Hashable - # An option to control the selection of optimizer version. - # This parameter allows individual queries to pick different query - # optimizer versions. - # Specifying "latest" as a value instructs Cloud Spanner to use the - # latest supported query optimizer version. If not specified, Cloud Spanner - # uses optimizer version set at the database level options. Any other - # positive integer (from the list of supported optimizer versions) - # overrides the default optimizer version for query execution. - # The list of supported optimizer versions can be queried from - # SPANNER_SYS.SUPPORTED_OPTIMIZER_VERSIONS. Executing a SQL statement - # with an invalid optimizer version will fail with a syntax error - # (`INVALID_ARGUMENT`) status. - # See - # https://cloud.google.com/spanner/docs/query-optimizer/manage-query-optimizer - # for more information on managing the query optimizer. - # The `optimizer_version` statement hint has precedence over this setting. + # An option to control the selection of optimizer version. This parameter allows + # individual queries to pick different query optimizer versions. Specifying " + # latest" as a value instructs Cloud Spanner to use the latest supported query + # optimizer version. If not specified, Cloud Spanner uses optimizer version set + # at the database level options. Any other positive integer (from the list of + # supported optimizer versions) overrides the default optimizer version for + # query execution. The list of supported optimizer versions can be queried from + # SPANNER_SYS.SUPPORTED_OPTIMIZER_VERSIONS. Executing a SQL statement with an + # invalid optimizer version will fail with a syntax error (`INVALID_ARGUMENT`) + # status. See https://cloud.google.com/spanner/docs/query-optimizer/manage-query- + # optimizer for more information on managing the query optimizer. The ` + # optimizer_version` statement hint has precedence over this setting. # Corresponds to the JSON property `optimizerVersion` # @return [String] attr_accessor :optimizer_version @@ -2694,8 +2357,8 @@ module Google include Google::Apis::Core::Hashable # The nodes in the query plan. Plan nodes are returned in pre-order starting - # with the plan root. Each PlanNode's `id` corresponds to its index in - # `plan_nodes`. + # with the plan root. Each PlanNode's `id` corresponds to its index in ` + # plan_nodes`. # Corresponds to the JSON property `planNodes` # @return [Array] attr_accessor :plan_nodes @@ -2714,68 +2377,57 @@ module Google class ReadOnly include Google::Apis::Core::Hashable - # Executes all reads at a timestamp that is `exact_staleness` - # old. The timestamp is chosen soon after the read is started. - # Guarantees that all writes that have committed more than the - # specified number of seconds ago are visible. Because Cloud Spanner - # chooses the exact timestamp, this mode works even if the client's - # local clock is substantially skewed from Cloud Spanner commit - # timestamps. - # Useful for reading at nearby replicas without the distributed - # timestamp negotiation overhead of `max_staleness`. + # Executes all reads at a timestamp that is `exact_staleness` old. The timestamp + # is chosen soon after the read is started. Guarantees that all writes that have + # committed more than the specified number of seconds ago are visible. Because + # Cloud Spanner chooses the exact timestamp, this mode works even if the client' + # s local clock is substantially skewed from Cloud Spanner commit timestamps. + # Useful for reading at nearby replicas without the distributed timestamp + # negotiation overhead of `max_staleness`. # Corresponds to the JSON property `exactStaleness` # @return [String] attr_accessor :exact_staleness - # Read data at a timestamp >= `NOW - max_staleness` - # seconds. Guarantees that all writes that have committed more - # than the specified number of seconds ago are visible. Because - # Cloud Spanner chooses the exact timestamp, this mode works even if - # the client's local clock is substantially skewed from Cloud Spanner - # commit timestamps. - # Useful for reading the freshest data available at a nearby - # replica, while bounding the possible staleness if the local - # replica has fallen behind. - # Note that this option can only be used in single-use - # transactions. + # Read data at a timestamp >= `NOW - max_staleness` seconds. Guarantees that all + # writes that have committed more than the specified number of seconds ago are + # visible. Because Cloud Spanner chooses the exact timestamp, this mode works + # even if the client's local clock is substantially skewed from Cloud Spanner + # commit timestamps. Useful for reading the freshest data available at a nearby + # replica, while bounding the possible staleness if the local replica has fallen + # behind. Note that this option can only be used in single-use transactions. # Corresponds to the JSON property `maxStaleness` # @return [String] attr_accessor :max_staleness - # Executes all reads at a timestamp >= `min_read_timestamp`. - # This is useful for requesting fresher data than some previous - # read, or data that is fresh enough to observe the effects of some - # previously committed transaction whose timestamp is known. - # Note that this option can only be used in single-use transactions. - # A timestamp in RFC3339 UTC \"Zulu\" format, accurate to nanoseconds. - # Example: `"2014-10-02T15:01:23.045123456Z"`. + # Executes all reads at a timestamp >= `min_read_timestamp`. This is useful for + # requesting fresher data than some previous read, or data that is fresh enough + # to observe the effects of some previously committed transaction whose + # timestamp is known. Note that this option can only be used in single-use + # transactions. A timestamp in RFC3339 UTC \"Zulu\" format, accurate to + # nanoseconds. Example: `"2014-10-02T15:01:23.045123456Z"`. # Corresponds to the JSON property `minReadTimestamp` # @return [String] attr_accessor :min_read_timestamp - # Executes all reads at the given timestamp. Unlike other modes, - # reads at a specific timestamp are repeatable; the same read at - # the same timestamp always returns the same data. If the - # timestamp is in the future, the read will block until the - # specified timestamp, modulo the read's deadline. - # Useful for large scale consistent reads such as mapreduces, or - # for coordinating many reads against a consistent snapshot of the - # data. - # A timestamp in RFC3339 UTC \"Zulu\" format, accurate to nanoseconds. - # Example: `"2014-10-02T15:01:23.045123456Z"`. + # Executes all reads at the given timestamp. Unlike other modes, reads at a + # specific timestamp are repeatable; the same read at the same timestamp always + # returns the same data. If the timestamp is in the future, the read will block + # until the specified timestamp, modulo the read's deadline. Useful for large + # scale consistent reads such as mapreduces, or for coordinating many reads + # against a consistent snapshot of the data. A timestamp in RFC3339 UTC \"Zulu\" + # format, accurate to nanoseconds. Example: `"2014-10-02T15:01:23.045123456Z"`. # Corresponds to the JSON property `readTimestamp` # @return [String] attr_accessor :read_timestamp - # If true, the Cloud Spanner-selected read timestamp is included in - # the Transaction message that describes the transaction. + # If true, the Cloud Spanner-selected read timestamp is included in the + # Transaction message that describes the transaction. # Corresponds to the JSON property `returnReadTimestamp` # @return [Boolean] attr_accessor :return_read_timestamp alias_method :return_read_timestamp?, :return_read_timestamp - # Read at a timestamp where all previously committed transactions - # are visible. + # Read at a timestamp where all previously committed transactions are visible. # Corresponds to the JSON property `strong` # @return [Boolean] attr_accessor :strong @@ -2796,55 +2448,52 @@ module Google end end - # The request for Read and - # StreamingRead. + # The request for Read and StreamingRead. class ReadRequest include Google::Apis::Core::Hashable - # Required. The columns of table to be returned for each row matching - # this request. + # Required. The columns of table to be returned for each row matching this + # request. # Corresponds to the JSON property `columns` # @return [Array] attr_accessor :columns - # If non-empty, the name of an index on table. This index is - # used instead of the table primary key when interpreting key_set - # and sorting result rows. See key_set for further information. + # If non-empty, the name of an index on table. This index is used instead of the + # table primary key when interpreting key_set and sorting result rows. See + # key_set for further information. # Corresponds to the JSON property `index` # @return [String] attr_accessor :index - # `KeySet` defines a collection of Cloud Spanner keys and/or key ranges. All - # the keys are expected to be in the same table or index. The keys need - # not be sorted in any particular way. - # If the same key is specified multiple times in the set (for example - # if two ranges, two keys, or a key and a range overlap), Cloud Spanner - # behaves as if the key were only specified once. + # `KeySet` defines a collection of Cloud Spanner keys and/or key ranges. All the + # keys are expected to be in the same table or index. The keys need not be + # sorted in any particular way. If the same key is specified multiple times in + # the set (for example if two ranges, two keys, or a key and a range overlap), + # Cloud Spanner behaves as if the key were only specified once. # Corresponds to the JSON property `keySet` # @return [Google::Apis::SpannerV1::KeySet] attr_accessor :key_set - # If greater than zero, only the first `limit` rows are yielded. If `limit` - # is zero, the default is no limit. A limit cannot be specified if - # `partition_token` is set. + # If greater than zero, only the first `limit` rows are yielded. If `limit` is + # zero, the default is no limit. A limit cannot be specified if `partition_token` + # is set. # Corresponds to the JSON property `limit` # @return [Fixnum] attr_accessor :limit - # If present, results will be restricted to the specified partition - # previously created using PartitionRead(). There must be an exact - # match for the values of fields common to this message and the - # PartitionReadRequest message used to create this partition_token. + # If present, results will be restricted to the specified partition previously + # created using PartitionRead(). There must be an exact match for the values of + # fields common to this message and the PartitionReadRequest message used to + # create this partition_token. # Corresponds to the JSON property `partitionToken` # NOTE: Values are automatically base64 encoded/decoded in the client library. # @return [String] attr_accessor :partition_token - # If this request is resuming a previously interrupted read, - # `resume_token` should be copied from the last - # PartialResultSet yielded before the interruption. Doing this - # enables the new read to resume where the last read left off. The - # rest of the request parameters must exactly match the request + # If this request is resuming a previously interrupted read, `resume_token` + # should be copied from the last PartialResultSet yielded before the + # interruption. Doing this enables the new read to resume where the last read + # left off. The rest of the request parameters must exactly match the request # that yielded this token. # Corresponds to the JSON property `resumeToken` # NOTE: Values are automatically base64 encoded/decoded in the client library. @@ -2856,10 +2505,8 @@ module Google # @return [String] attr_accessor :table - # This message is used to select the transaction in which a - # Read or - # ExecuteSql call runs. - # See TransactionOptions for more information about transactions. + # This message is used to select the transaction in which a Read or ExecuteSql + # call runs. See TransactionOptions for more information about transactions. # Corresponds to the JSON property `transaction` # @return [Google::Apis::SpannerV1::TransactionSelector] attr_accessor :transaction @@ -2881,8 +2528,8 @@ module Google end end - # Message type to initiate a read-write transaction. Currently this - # transaction type has no options. + # Message type to initiate a read-write transaction. Currently this transaction + # type has no options. class ReadWrite include Google::Apis::Core::Hashable @@ -2900,9 +2547,8 @@ module Google include Google::Apis::Core::Hashable # If true, this location is designated as the default leader location where - # leader replicas are placed. See the [region types - # documentation](https://cloud.google.com/spanner/docs/instances#region_types) - # for more details. + # leader replicas are placed. See the [region types documentation](https://cloud. + # google.com/spanner/docs/instances#region_types) for more details. # Corresponds to the JSON property `defaultLeaderLocation` # @return [Boolean] attr_accessor :default_leader_location @@ -2930,8 +2576,7 @@ module Google end end - # Metadata type for the long-running operation returned by - # RestoreDatabase. + # Metadata type for the long-running operation returned by RestoreDatabase. class RestoreDatabaseMetadata include Google::Apis::Core::Hashable @@ -2940,17 +2585,14 @@ module Google # @return [Google::Apis::SpannerV1::BackupInfo] attr_accessor :backup_info - # The time at which cancellation of this operation was received. - # Operations.CancelOperation - # starts asynchronous cancellation on a long-running operation. The server - # makes a best effort to cancel the operation, but success is not guaranteed. - # Clients can use - # Operations.GetOperation or - # other methods to check whether the cancellation succeeded or whether the - # operation completed despite cancellation. On successful cancellation, - # the operation is not deleted; instead, it becomes an operation with - # an Operation.error value with a - # google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`. + # The time at which cancellation of this operation was received. Operations. + # CancelOperation starts asynchronous cancellation on a long-running operation. + # The server makes a best effort to cancel the operation, but success is not + # guaranteed. Clients can use Operations.GetOperation or other methods to check + # whether the cancellation succeeded or whether the operation completed despite + # cancellation. On successful cancellation, the operation is not deleted; + # instead, it becomes an operation with an Operation.error value with a google. + # rpc.Status.code of 1, corresponding to `Code.CANCELLED`. # Corresponds to the JSON property `cancelTime` # @return [String] attr_accessor :cancel_time @@ -2960,24 +2602,21 @@ module Google # @return [String] attr_accessor :name - # If exists, the name of the long-running operation that will be used to - # track the post-restore optimization process to optimize the performance of - # the restored database, and remove the dependency on the restore source. - # The name is of the form - # `projects//instances//databases//operations/< - # operation>` - # where the is the name of database being created and restored to. - # The metadata type of the long-running operation is - # OptimizeRestoredDatabaseMetadata. This long-running operation will be - # automatically created by the system after the RestoreDatabase long-running - # operation completes successfully. This operation will not be created if the - # restore was not successful. + # If exists, the name of the long-running operation that will be used to track + # the post-restore optimization process to optimize the performance of the + # restored database, and remove the dependency on the restore source. The name + # is of the form `projects//instances//databases//operations/` where the is the + # name of database being created and restored to. The metadata type of the long- + # running operation is OptimizeRestoredDatabaseMetadata. This long-running + # operation will be automatically created by the system after the + # RestoreDatabase long-running operation completes successfully. This operation + # will not be created if the restore was not successful. # Corresponds to the JSON property `optimizeDatabaseOperationName` # @return [String] attr_accessor :optimize_database_operation_name - # Encapsulates progress related information for a Cloud Spanner long - # running operation. + # Encapsulates progress related information for a Cloud Spanner long running + # operation. # Corresponds to the JSON property `progress` # @return [Google::Apis::SpannerV1::OperationProgress] attr_accessor :progress @@ -3002,21 +2641,19 @@ module Google end end - # The request for - # RestoreDatabase. + # The request for RestoreDatabase. class RestoreDatabaseRequest include Google::Apis::Core::Hashable - # Name of the backup from which to restore. Values are of the form - # `projects//instances//backups/`. + # Name of the backup from which to restore. Values are of the form `projects// + # instances//backups/`. # Corresponds to the JSON property `backup` # @return [String] attr_accessor :backup - # Required. The id of the database to create and restore to. This - # database must not already exist. The `database_id` appended to - # `parent` forms the full database name of the form - # `projects//instances//databases/`. + # Required. The id of the database to create and restore to. This database must + # not already exist. The `database_id` appended to `parent` forms the full + # database name of the form `projects//instances//databases/`. # Corresponds to the JSON property `databaseId` # @return [String] attr_accessor :database_id @@ -3057,8 +2694,7 @@ module Google end end - # Results from Read or - # ExecuteSql. + # Results from Read or ExecuteSql. class ResultSet include Google::Apis::Core::Hashable @@ -3067,12 +2703,9 @@ module Google # @return [Google::Apis::SpannerV1::ResultSetMetadata] attr_accessor :metadata - # Each element in `rows` is a row whose format is defined by - # metadata.row_type. The ith element - # in each row matches the ith field in - # metadata.row_type. Elements are - # encoded based on type as described - # here. + # Each element in `rows` is a row whose format is defined by metadata.row_type. + # The ith element in each row matches the ith field in metadata.row_type. + # Elements are encoded based on type as described here. # Corresponds to the JSON property `rows` # @return [Array>] attr_accessor :rows @@ -3128,14 +2761,9 @@ module Google # @return [Google::Apis::SpannerV1::QueryPlan] attr_accessor :query_plan - # Aggregated statistics from the execution of the query. Only present when - # the query is profiled. For example, a query could return the statistics as - # follows: - # ` - # "rows_returned": "3", - # "elapsed_time": "1.22 secs", - # "cpu_time": "1.19 secs" - # ` + # Aggregated statistics from the execution of the query. Only present when the + # query is profiled. For example, a query could return the statistics as follows: + # ` "rows_returned": "3", "elapsed_time": "1.22 secs", "cpu_time": "1.19 secs" ` # Corresponds to the JSON property `queryStats` # @return [Hash] attr_accessor :query_stats @@ -3145,8 +2773,8 @@ module Google # @return [Fixnum] attr_accessor :row_count_exact - # Partitioned DML does not offer exactly-once semantics, so it - # returns a lower bound of the rows modified. + # Partitioned DML does not offer exactly-once semantics, so it returns a lower + # bound of the rows modified. # Corresponds to the JSON property `rowCountLowerBound` # @return [Fixnum] attr_accessor :row_count_lower_bound @@ -3199,13 +2827,12 @@ module Google # @return [String] attr_accessor :create_time - # The labels for the session. - # * Label keys must be between 1 and 63 characters long and must conform to - # the following regular expression: `[a-z]([-a-z0-9]*[a-z0-9])?`. - # * Label values must be between 0 and 63 characters long and must conform - # to the regular expression `([a-z]([-a-z0-9]*[a-z0-9])?)?`. - # * No more than 64 labels can be associated with a given session. - # See https://goo.gl/xmQnxf for more information on and examples of labels. + # The labels for the session. * Label keys must be between 1 and 63 characters + # long and must conform to the following regular expression: `[a-z]([-a-z0-9]*[a- + # z0-9])?`. * Label values must be between 0 and 63 characters long and must + # conform to the regular expression `([a-z]([-a-z0-9]*[a-z0-9])?)?`. * No more + # than 64 labels can be associated with a given session. See https://goo.gl/ + # xmQnxf for more information on and examples of labels. # Corresponds to the JSON property `labels` # @return [Hash] attr_accessor :labels @@ -3233,66 +2860,32 @@ module Google include Google::Apis::Core::Hashable # An Identity and Access Management (IAM) policy, which specifies access - # controls for Google Cloud resources. - # A `Policy` is a collection of `bindings`. A `binding` binds one or more - # `members` to a single `role`. Members can be user accounts, service accounts, - # 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. - # 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": [ - # ` - # "role": "roles/resourcemanager.organizationAdmin", - # "members": [ - # "user:mike@example.com", - # "group:admins@example.com", - # "domain:google.com", - # "serviceAccount:my-project-id@appspot.gserviceaccount.com" - # ] - # `, - # ` - # "role": "roles/resourcemanager.organizationViewer", - # "members": [ - # "user:eve@example.com" - # ], - # "condition": ` - # "title": "expirable access", - # "description": "Does not grant access after Sep 2020", - # "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z') - # ", - # ` - # ` - # ], - # "etag": "BwWWja0YfJA=", - # "version": 3 - # ` - # **YAML example:** - # bindings: - # - members: - # - user:mike@example.com - # - group:admins@example.com - # - domain:google.com - # - serviceAccount:my-project-id@appspot.gserviceaccount.com - # role: roles/resourcemanager.organizationAdmin - # - members: - # - user:eve@example.com - # role: roles/resourcemanager.organizationViewer - # condition: - # title: expirable access - # description: Does not grant access after Sep 2020 - # expression: request.time < timestamp('2020-10-01T00:00:00.000Z') - # - etag: BwWWja0YfJA= - # - version: 3 - # For a description of IAM and its features, see the - # [IAM documentation](https://cloud.google.com/iam/docs/). + # controls for Google Cloud resources. A `Policy` is a collection of `bindings`. + # A `binding` binds one or more `members` to a single `role`. Members can be + # user accounts, service accounts, 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. 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": [ ` "role": "roles/ + # resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", " + # group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@ + # appspot.gserviceaccount.com" ] `, ` "role": "roles/resourcemanager. + # organizationViewer", "members": [ "user:eve@example.com" ], "condition": ` " + # title": "expirable access", "description": "Does not grant access after Sep + # 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", ` + # ` ], "etag": "BwWWja0YfJA=", "version": 3 ` **YAML example:** bindings: - + # members: - user:mike@example.com - group:admins@example.com - domain:google. + # com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/ + # resourcemanager.organizationAdmin - members: - user:eve@example.com role: + # roles/resourcemanager.organizationViewer condition: title: expirable access + # description: Does not grant access after Sep 2020 expression: request.time < + # timestamp('2020-10-01T00:00:00.000Z') - etag: BwWWja0YfJA= - version: 3 For a + # description of IAM and its features, see the [IAM documentation](https://cloud. + # google.com/iam/docs/). # Corresponds to the JSON property `policy` # @return [Google::Apis::SpannerV1::Policy] attr_accessor :policy @@ -3307,8 +2900,8 @@ module Google end end - # Condensed representation of a node and its subtree. Only present for - # `SCALAR` PlanNode(s). + # Condensed representation of a node and its subtree. Only present for `SCALAR` + # PlanNode(s). class ShortRepresentation include Google::Apis::Core::Hashable @@ -3317,11 +2910,10 @@ module Google # @return [String] attr_accessor :description - # A mapping of (subquery variable name) -> (subquery node id) for cases - # where the `description` string of this node references a `SCALAR` - # subquery contained in the expression subtree rooted at this node. The - # referenced `SCALAR` subquery may not necessarily be a direct child of - # this node. + # A mapping of (subquery variable name) -> (subquery node id) for cases where + # the `description` string of this node references a `SCALAR` subquery contained + # in the expression subtree rooted at this node. The referenced `SCALAR` + # subquery may not necessarily be a direct child of this node. # Corresponds to the JSON property `subqueries` # @return [Hash] attr_accessor :subqueries @@ -3341,25 +2933,22 @@ module Google class Statement include Google::Apis::Core::Hashable - # It is not always possible for Cloud Spanner to infer the right SQL type - # from a JSON value. For example, values of type `BYTES` and values - # of type `STRING` both appear in params as JSON strings. - # In these cases, `param_types` can be used to specify the exact - # SQL type for some or all of the SQL statement parameters. See the - # definition of Type for more information - # about SQL types. + # It is not always possible for Cloud Spanner to infer the right SQL type from a + # JSON value. For example, values of type `BYTES` and values of type `STRING` + # both appear in params as JSON strings. In these cases, `param_types` can be + # used to specify the exact SQL type for some or all of the SQL statement + # parameters. See the definition of Type for more information about SQL types. # Corresponds to the JSON property `paramTypes` # @return [Hash] attr_accessor :param_types - # Parameter names and values that bind to placeholders in the DML string. - # A parameter placeholder consists of the `@` character followed by the - # parameter name (for example, `@firstName`). Parameter names can contain - # letters, numbers, and underscores. - # Parameters can appear anywhere that a literal value is expected. The - # same parameter name can be used more than once, for example: - # `"WHERE id > @msg_id AND id < @msg_id + 100"` - # It is an error to execute a SQL statement with unbound parameters. + # Parameter names and values that bind to placeholders in the DML string. A + # parameter placeholder consists of the `@` character followed by the parameter + # name (for example, `@firstName`). Parameter names can contain letters, numbers, + # and underscores. Parameters can appear anywhere that a literal value is + # expected. The same parameter name can be used more than once, for example: `" + # WHERE id > @msg_id AND id < @msg_id + 100"` It is an error to execute a SQL + # statement with unbound parameters. # Corresponds to the JSON property `params` # @return [Hash] attr_accessor :params @@ -3381,12 +2970,12 @@ module Google end end - # The `Status` type defines a logical error model that is suitable for - # different programming environments, including REST APIs and RPC APIs. It is - # used by [gRPC](https://github.com/grpc). Each `Status` message contains - # three pieces of data: error code, error message, and error details. - # You can find out more about this error model and how to work with it in the - # [API Design Guide](https://cloud.google.com/apis/design/errors). + # The `Status` type defines a logical error model that is suitable for different + # programming environments, including REST APIs and RPC APIs. It is used by [ + # gRPC](https://github.com/grpc). Each `Status` message contains three pieces of + # data: error code, error message, and error details. You can find out more + # about this error model and how to work with it in the [API Design Guide](https: + # //cloud.google.com/apis/design/errors). class Status include Google::Apis::Core::Hashable @@ -3395,15 +2984,15 @@ module Google # @return [Fixnum] attr_accessor :code - # A list of messages that carry the error details. There is a common set of + # A list of messages that carry the error details. There is a common set of # message types for APIs to use. # Corresponds to the JSON property `details` # @return [Array>] attr_accessor :details - # A developer-facing error message, which should be in English. Any - # user-facing error message should be localized and sent in the - # google.rpc.Status.details field, or localized by the client. + # A developer-facing error message, which should be in English. Any user-facing + # error message should be localized and sent in the google.rpc.Status.details + # field, or localized by the client. # Corresponds to the JSON property `message` # @return [String] attr_accessor :message @@ -3424,12 +3013,11 @@ module Google class StructType include Google::Apis::Core::Hashable - # The list of fields that make up this struct. Order is - # significant, because values of this struct type are represented as - # lists, where the order of field values matches the order of - # fields in the StructType. In turn, the order of fields - # matches the order of columns in a read request, or the order of - # fields in the `SELECT` clause of a query. + # The list of fields that make up this struct. Order is significant, because + # values of this struct type are represented as lists, where the order of field + # values matches the order of fields in the StructType. In turn, the order of + # fields matches the order of columns in a read request, or the order of fields + # in the `SELECT` clause of a query. # Corresponds to the JSON property `fields` # @return [Array] attr_accessor :fields @@ -3448,9 +3036,8 @@ module Google class TestIamPermissionsRequest include Google::Apis::Core::Hashable - # REQUIRED: The set of permissions to check for 'resource'. - # Permissions with wildcards (such as '*', 'spanner.*', 'spanner.instances.*') - # are not allowed. + # REQUIRED: The set of permissions to check for 'resource'. Permissions with + # wildcards (such as '*', 'spanner.*', 'spanner.instances.*') are not allowed. # Corresponds to the JSON property `permissions` # @return [Array] attr_accessor :permissions @@ -3469,8 +3056,7 @@ module Google class TestIamPermissionsResponse include Google::Apis::Core::Hashable - # A subset of `TestPermissionsRequest.permissions` that the caller is - # allowed. + # A subset of `TestPermissionsRequest.permissions` that the caller is allowed. # Corresponds to the JSON property `permissions` # @return [Array] attr_accessor :permissions @@ -3489,23 +3075,18 @@ module Google class Transaction include Google::Apis::Core::Hashable - # `id` may be used to identify the transaction in subsequent - # Read, - # ExecuteSql, - # Commit, or - # Rollback calls. - # Single-use read-only transactions do not have IDs, because - # single-use transactions do not support multiple requests. + # `id` may be used to identify the transaction in subsequent Read, ExecuteSql, + # Commit, or Rollback calls. Single-use read-only transactions do not have IDs, + # because single-use transactions do not support multiple requests. # Corresponds to the JSON property `id` # NOTE: Values are automatically base64 encoded/decoded in the client library. # @return [String] attr_accessor :id - # For snapshot read-only transactions, the read timestamp chosen - # for the transaction. Not returned by default: see - # TransactionOptions.ReadOnly.return_read_timestamp. - # A timestamp in RFC3339 UTC \"Zulu\" format, accurate to nanoseconds. - # Example: `"2014-10-02T15:01:23.045123456Z"`. + # For snapshot read-only transactions, the read timestamp chosen for the + # transaction. Not returned by default: see TransactionOptions.ReadOnly. + # return_read_timestamp. A timestamp in RFC3339 UTC \"Zulu\" format, accurate to + # nanoseconds. Example: `"2014-10-02T15:01:23.045123456Z"`. # Corresponds to the JSON property `readTimestamp` # @return [String] attr_accessor :read_timestamp @@ -3521,222 +3102,165 @@ module Google end end - # # Transactions - # Each session can have at most one active transaction at a time (note that - # standalone reads and queries use a transaction internally and do count - # towards the one transaction limit). After the active transaction is - # completed, the session can immediately be re-used for the next transaction. - # It is not necessary to create a new session for each transaction. - # # Transaction Modes - # Cloud Spanner supports three transaction modes: - # 1. Locking read-write. This type of transaction is the only way - # to write data into Cloud Spanner. These transactions rely on - # pessimistic locking and, if necessary, two-phase commit. - # Locking read-write transactions may abort, requiring the - # application to retry. - # 2. Snapshot read-only. This transaction type provides guaranteed - # consistency across several reads, but does not allow - # writes. Snapshot read-only transactions can be configured to - # read at timestamps in the past. Snapshot read-only - # transactions do not need to be committed. - # 3. Partitioned DML. This type of transaction is used to execute - # a single Partitioned DML statement. Partitioned DML partitions - # the key space and runs the DML statement over each partition - # in parallel using separate, internal transactions that commit - # independently. Partitioned DML transactions do not need to be - # committed. - # For transactions that only read, snapshot read-only transactions - # provide simpler semantics and are almost always faster. In - # particular, read-only transactions do not take locks, so they do - # not conflict with read-write transactions. As a consequence of not - # taking locks, they also do not abort, so retry loops are not needed. - # Transactions may only read/write data in a single database. They - # may, however, read/write data in different tables within that - # database. - # ## Locking Read-Write Transactions - # Locking transactions may be used to atomically read-modify-write - # data anywhere in a database. This type of transaction is externally - # consistent. - # Clients should attempt to minimize the amount of time a transaction - # is active. Faster transactions commit with higher probability - # and cause less contention. Cloud Spanner attempts to keep read locks - # active as long as the transaction continues to do reads, and the - # transaction has not been terminated by - # Commit or - # Rollback. Long periods of - # inactivity at the client may cause Cloud Spanner to release a - # transaction's locks and abort it. - # Conceptually, a read-write transaction consists of zero or more - # reads or SQL statements followed by - # Commit. At any time before - # Commit, the client can send a - # Rollback request to abort the - # transaction. - # ### Semantics - # Cloud Spanner can commit the transaction if all read locks it acquired - # are still valid at commit time, and it is able to acquire write - # locks for all writes. Cloud Spanner can abort the transaction for any - # reason. If a commit attempt returns `ABORTED`, Cloud Spanner guarantees - # that the transaction has not modified any user data in Cloud Spanner. - # Unless the transaction commits, Cloud Spanner makes no guarantees about - # how long the transaction's locks were held for. It is an error to - # use Cloud Spanner locks for any sort of mutual exclusion other than - # between Cloud Spanner transactions themselves. - # ### Retrying Aborted Transactions - # When a transaction aborts, the application can choose to retry the - # whole transaction again. To maximize the chances of successfully - # committing the retry, the client should execute the retry in the - # same session as the original attempt. The original session's lock - # priority increases with each consecutive abort, meaning that each - # attempt has a slightly better chance of success than the previous. - # Under some circumstances (e.g., many transactions attempting to - # modify the same row(s)), a transaction can abort many times in a - # short period before successfully committing. Thus, it is not a good - # idea to cap the number of retries a transaction can attempt; - # instead, it is better to limit the total amount of wall time spent - # retrying. - # ### Idle Transactions - # A transaction is considered idle if it has no outstanding reads or - # SQL queries and has not started a read or SQL query within the last 10 - # seconds. Idle transactions can be aborted by Cloud Spanner so that they - # don't hold on to locks indefinitely. In that case, the commit will - # fail with error `ABORTED`. - # If this behavior is undesirable, periodically executing a simple - # SQL query in the transaction (e.g., `SELECT 1`) prevents the - # transaction from becoming idle. - # ## Snapshot Read-Only Transactions - # Snapshot read-only transactions provides a simpler method than - # locking read-write transactions for doing several consistent - # reads. However, this type of transaction does not support writes. - # Snapshot transactions do not take locks. Instead, they work by - # choosing a Cloud Spanner timestamp, then executing all reads at that - # timestamp. Since they do not acquire locks, they do not block - # concurrent read-write transactions. - # Unlike locking read-write transactions, snapshot read-only - # transactions never abort. They can fail if the chosen read - # timestamp is garbage collected; however, the default garbage - # collection policy is generous enough that most applications do not - # need to worry about this in practice. - # Snapshot read-only transactions do not need to call - # Commit or - # Rollback (and in fact are not - # permitted to do so). - # To execute a snapshot transaction, the client specifies a timestamp - # bound, which tells Cloud Spanner how to choose a read timestamp. - # The types of timestamp bound are: - # - Strong (the default). - # - Bounded staleness. - # - Exact staleness. - # If the Cloud Spanner database to be read is geographically distributed, - # stale read-only transactions can execute more quickly than strong - # or read-write transaction, because they are able to execute far - # from the leader replica. - # Each type of timestamp bound is discussed in detail below. - # ### Strong - # Strong reads are guaranteed to see the effects of all transactions - # that have committed before the start of the read. Furthermore, all - # rows yielded by a single read are consistent with each other -- if - # any part of the read observes a transaction, all parts of the read - # see the transaction. - # Strong reads are not repeatable: two consecutive strong read-only - # transactions might return inconsistent results if there are - # concurrent writes. If consistency across reads is required, the - # reads should be executed within a transaction or at an exact read - # timestamp. - # See TransactionOptions.ReadOnly.strong. - # ### Exact Staleness - # These timestamp bounds execute reads at a user-specified - # timestamp. Reads at a timestamp are guaranteed to see a consistent - # prefix of the global transaction history: they observe - # modifications done by all transactions with a commit timestamp <= - # the read timestamp, and observe none of the modifications done by - # transactions with a larger commit timestamp. They will block until - # all conflicting transactions that may be assigned commit timestamps - # <= the read timestamp have finished. - # The timestamp can either be expressed as an absolute Cloud Spanner commit - # timestamp or a staleness relative to the current time. - # These modes do not require a "negotiation phase" to pick a - # timestamp. As a result, they execute slightly faster than the - # equivalent boundedly stale concurrency modes. On the other hand, - # boundedly stale reads usually return fresher results. - # See TransactionOptions.ReadOnly.read_timestamp and - # TransactionOptions.ReadOnly.exact_staleness. - # ### Bounded Staleness - # Bounded staleness modes allow Cloud Spanner to pick the read timestamp, - # subject to a user-provided staleness bound. Cloud Spanner chooses the - # newest timestamp within the staleness bound that allows execution - # of the reads at the closest available replica without blocking. - # All rows yielded are consistent with each other -- if any part of - # the read observes a transaction, all parts of the read see the - # transaction. Boundedly stale reads are not repeatable: two stale - # reads, even if they use the same staleness bound, can execute at - # different timestamps and thus return inconsistent results. - # Boundedly stale reads execute in two phases: the first phase - # negotiates a timestamp among all replicas needed to serve the - # read. In the second phase, reads are executed at the negotiated - # timestamp. - # As a result of the two phase execution, bounded staleness reads are - # usually a little slower than comparable exact staleness - # reads. However, they are typically able to return fresher - # results, and are more likely to execute at the closest replica. - # Because the timestamp negotiation requires up-front knowledge of - # which rows will be read, it can only be used with single-use - # read-only transactions. - # See TransactionOptions.ReadOnly.max_staleness and - # TransactionOptions.ReadOnly.min_read_timestamp. - # ### Old Read Timestamps and Garbage Collection - # Cloud Spanner continuously garbage collects deleted and overwritten data - # in the background to reclaim storage space. This process is known - # as "version GC". By default, version GC reclaims versions after they - # are one hour old. Because of this, Cloud Spanner cannot perform reads - # at read timestamps more than one hour in the past. This - # restriction also applies to in-progress reads and/or SQL queries whose - # timestamp become too old while executing. Reads and SQL queries with - # too-old read timestamps fail with the error `FAILED_PRECONDITION`. - # ## Partitioned DML Transactions - # Partitioned DML transactions are used to execute DML statements with a - # different execution strategy that provides different, and often better, - # scalability properties for large, table-wide operations than DML in a - # ReadWrite transaction. Smaller scoped statements, such as an OLTP workload, - # should prefer using ReadWrite transactions. - # Partitioned DML partitions the keyspace and runs the DML statement on each - # partition in separate, internal transactions. These transactions commit - # automatically when complete, and run independently from one another. - # To reduce lock contention, this execution strategy only acquires read locks - # on rows that match the WHERE clause of the statement. Additionally, the - # smaller per-partition transactions hold locks for less time. - # That said, Partitioned DML is not a drop-in replacement for standard DML used - # in ReadWrite transactions. - # - The DML statement must be fully-partitionable. Specifically, the statement - # must be expressible as the union of many statements which each access only - # a single row of the table. - # - The statement is not applied atomically to all rows of the table. Rather, - # the statement is applied atomically to partitions of the table, in - # independent transactions. Secondary index rows are updated atomically - # with the base table rows. - # - Partitioned DML does not guarantee exactly-once execution semantics - # against a partition. The statement will be applied at least once to each - # partition. It is strongly recommended that the DML statement should be - # idempotent to avoid unexpected results. For instance, it is potentially - # dangerous to run a statement such as - # `UPDATE table SET column = column + 1` as it could be run multiple times - # against some rows. - # - The partitions are committed automatically - there is no support for - # Commit or Rollback. If the call returns an error, or if the client issuing - # the ExecuteSql call dies, it is possible that some rows had the statement - # executed on them successfully. It is also possible that statement was - # never executed against other rows. - # - Partitioned DML transactions may only contain the execution of a single - # DML statement via ExecuteSql or ExecuteStreamingSql. - # - If any error is encountered during the execution of the partitioned DML + # # Transactions Each session can have at most one active transaction at a time ( + # note that standalone reads and queries use a transaction internally and do + # count towards the one transaction limit). After the active transaction is + # completed, the session can immediately be re-used for the next transaction. It + # is not necessary to create a new session for each transaction. # Transaction + # Modes Cloud Spanner supports three transaction modes: 1. Locking read-write. + # This type of transaction is the only way to write data into Cloud Spanner. + # These transactions rely on pessimistic locking and, if necessary, two-phase + # commit. Locking read-write transactions may abort, requiring the application + # to retry. 2. Snapshot read-only. This transaction type provides guaranteed + # consistency across several reads, but does not allow writes. Snapshot read- + # only transactions can be configured to read at timestamps in the past. + # Snapshot read-only transactions do not need to be committed. 3. Partitioned + # DML. This type of transaction is used to execute a single Partitioned DML + # statement. Partitioned DML partitions the key space and runs the DML statement + # over each partition in parallel using separate, internal transactions that + # commit independently. Partitioned DML transactions do not need to be committed. + # For transactions that only read, snapshot read-only transactions provide + # simpler semantics and are almost always faster. In particular, read-only + # transactions do not take locks, so they do not conflict with read-write + # transactions. As a consequence of not taking locks, they also do not abort, so + # retry loops are not needed. Transactions may only read/write data in a single + # database. They may, however, read/write data in different tables within that + # database. ## Locking Read-Write Transactions Locking transactions may be used + # to atomically read-modify-write data anywhere in a database. This type of + # transaction is externally consistent. Clients should attempt to minimize the + # amount of time a transaction is active. Faster transactions commit with higher + # probability and cause less contention. Cloud Spanner attempts to keep read + # locks active as long as the transaction continues to do reads, and the + # transaction has not been terminated by Commit or Rollback. Long periods of + # inactivity at the client may cause Cloud Spanner to release a transaction's + # locks and abort it. Conceptually, a read-write transaction consists of zero or + # more reads or SQL statements followed by Commit. At any time before Commit, + # the client can send a Rollback request to abort the transaction. ### Semantics + # Cloud Spanner can commit the transaction if all read locks it acquired are + # still valid at commit time, and it is able to acquire write locks for all + # writes. Cloud Spanner can abort the transaction for any reason. If a commit + # attempt returns `ABORTED`, Cloud Spanner guarantees that the transaction has + # not modified any user data in Cloud Spanner. Unless the transaction commits, + # Cloud Spanner makes no guarantees about how long the transaction's locks were + # held for. It is an error to use Cloud Spanner locks for any sort of mutual + # exclusion other than between Cloud Spanner transactions themselves. ### + # Retrying Aborted Transactions When a transaction aborts, the application can + # choose to retry the whole transaction again. To maximize the chances of + # successfully committing the retry, the client should execute the retry in the + # same session as the original attempt. The original session's lock priority + # increases with each consecutive abort, meaning that each attempt has a + # slightly better chance of success than the previous. Under some circumstances ( + # e.g., many transactions attempting to modify the same row(s)), a transaction + # can abort many times in a short period before successfully committing. Thus, + # it is not a good idea to cap the number of retries a transaction can attempt; + # instead, it is better to limit the total amount of wall time spent retrying. ## + # # Idle Transactions A transaction is considered idle if it has no outstanding + # reads or SQL queries and has not started a read or SQL query within the last + # 10 seconds. Idle transactions can be aborted by Cloud Spanner so that they don' + # t hold on to locks indefinitely. In that case, the commit will fail with error + # `ABORTED`. If this behavior is undesirable, periodically executing a simple + # SQL query in the transaction (e.g., `SELECT 1`) prevents the transaction from + # becoming idle. ## Snapshot Read-Only Transactions Snapshot read-only + # transactions provides a simpler method than locking read-write transactions + # for doing several consistent reads. However, this type of transaction does not + # support writes. Snapshot transactions do not take locks. Instead, they work by + # choosing a Cloud Spanner timestamp, then executing all reads at that timestamp. + # Since they do not acquire locks, they do not block concurrent read-write + # transactions. Unlike locking read-write transactions, snapshot read-only + # transactions never abort. They can fail if the chosen read timestamp is + # garbage collected; however, the default garbage collection policy is generous + # enough that most applications do not need to worry about this in practice. + # Snapshot read-only transactions do not need to call Commit or Rollback (and in + # fact are not permitted to do so). To execute a snapshot transaction, the + # client specifies a timestamp bound, which tells Cloud Spanner how to choose a + # read timestamp. The types of timestamp bound are: - Strong (the default). - + # Bounded staleness. - Exact staleness. If the Cloud Spanner database to be read + # is geographically distributed, stale read-only transactions can execute more + # quickly than strong or read-write transaction, because they are able to + # execute far from the leader replica. Each type of timestamp bound is discussed + # in detail below. ### Strong Strong reads are guaranteed to see the effects of + # all transactions that have committed before the start of the read. Furthermore, + # all rows yielded by a single read are consistent with each other -- if any + # part of the read observes a transaction, all parts of the read see the + # transaction. Strong reads are not repeatable: two consecutive strong read-only + # transactions might return inconsistent results if there are concurrent writes. + # If consistency across reads is required, the reads should be executed within a + # transaction or at an exact read timestamp. See TransactionOptions.ReadOnly. + # strong. ### Exact Staleness These timestamp bounds execute reads at a user- + # specified timestamp. Reads at a timestamp are guaranteed to see a consistent + # prefix of the global transaction history: they observe modifications done by + # all transactions with a commit timestamp <= the read timestamp, and observe + # none of the modifications done by transactions with a larger commit timestamp. + # They will block until all conflicting transactions that may be assigned commit + # timestamps <= the read timestamp have finished. The timestamp can either be + # expressed as an absolute Cloud Spanner commit timestamp or a staleness + # relative to the current time. These modes do not require a "negotiation phase" + # to pick a timestamp. As a result, they execute slightly faster than the + # equivalent boundedly stale concurrency modes. On the other hand, boundedly + # stale reads usually return fresher results. See TransactionOptions.ReadOnly. + # read_timestamp and TransactionOptions.ReadOnly.exact_staleness. ### Bounded + # Staleness Bounded staleness modes allow Cloud Spanner to pick the read + # timestamp, subject to a user-provided staleness bound. Cloud Spanner chooses + # the newest timestamp within the staleness bound that allows execution of the + # reads at the closest available replica without blocking. All rows yielded are + # consistent with each other -- if any part of the read observes a transaction, + # all parts of the read see the transaction. Boundedly stale reads are not + # repeatable: two stale reads, even if they use the same staleness bound, can + # execute at different timestamps and thus return inconsistent results. + # Boundedly stale reads execute in two phases: the first phase negotiates a + # timestamp among all replicas needed to serve the read. In the second phase, + # reads are executed at the negotiated timestamp. As a result of the two phase + # execution, bounded staleness reads are usually a little slower than comparable + # exact staleness reads. However, they are typically able to return fresher + # results, and are more likely to execute at the closest replica. Because the + # timestamp negotiation requires up-front knowledge of which rows will be read, + # it can only be used with single-use read-only transactions. See + # TransactionOptions.ReadOnly.max_staleness and TransactionOptions.ReadOnly. + # min_read_timestamp. ### Old Read Timestamps and Garbage Collection Cloud + # Spanner continuously garbage collects deleted and overwritten data in the + # background to reclaim storage space. This process is known as "version GC". By + # default, version GC reclaims versions after they are one hour old. Because of + # this, Cloud Spanner cannot perform reads at read timestamps more than one hour + # in the past. This restriction also applies to in-progress reads and/or SQL + # queries whose timestamp become too old while executing. Reads and SQL queries + # with too-old read timestamps fail with the error `FAILED_PRECONDITION`. ## + # Partitioned DML Transactions Partitioned DML transactions are used to execute + # DML statements with a different execution strategy that provides different, + # and often better, scalability properties for large, table-wide operations than + # DML in a ReadWrite transaction. Smaller scoped statements, such as an OLTP + # workload, should prefer using ReadWrite transactions. Partitioned DML + # partitions the keyspace and runs the DML statement on each partition in + # separate, internal transactions. These transactions commit automatically when + # complete, and run independently from one another. To reduce lock contention, + # this execution strategy only acquires read locks on rows that match the WHERE + # clause of the statement. Additionally, the smaller per-partition transactions + # hold locks for less time. That said, Partitioned DML is not a drop-in + # replacement for standard DML used in ReadWrite transactions. - The DML + # statement must be fully-partitionable. Specifically, the statement must be + # expressible as the union of many statements which each access only a single + # row of the table. - The statement is not applied atomically to all rows of the + # table. Rather, the statement is applied atomically to partitions of the table, + # in independent transactions. Secondary index rows are updated atomically with + # the base table rows. - Partitioned DML does not guarantee exactly-once + # execution semantics against a partition. The statement will be applied at + # least once to each partition. It is strongly recommended that the DML + # statement should be idempotent to avoid unexpected results. For instance, it + # is potentially dangerous to run a statement such as `UPDATE table SET column = + # column + 1` as it could be run multiple times against some rows. - The + # partitions are committed automatically - there is no support for Commit or + # Rollback. If the call returns an error, or if the client issuing the + # ExecuteSql call dies, it is possible that some rows had the statement executed + # on them successfully. It is also possible that statement was never executed + # against other rows. - Partitioned DML transactions may only contain the + # execution of a single DML statement via ExecuteSql or ExecuteStreamingSql. - + # If any error is encountered during the execution of the partitioned DML # operation (for instance, a UNIQUE INDEX violation, division by zero, or a - # value that cannot be stored due to schema constraints), then the - # operation is stopped at that point and an error is returned. It is - # possible that at this point, some partitions have been committed (or even - # committed multiple times), and other partitions have not been run at all. - # Given the above, Partitioned DML is good fit for large, database-wide, - # operations that are idempotent, such as deleting old rows from a very large - # table. + # value that cannot be stored due to schema constraints), then the operation is + # stopped at that point and an error is returned. It is possible that at this + # point, some partitions have been committed (or even committed multiple times), + # and other partitions have not been run at all. Given the above, Partitioned + # DML is good fit for large, database-wide, operations that are idempotent, such + # as deleting old rows from a very large table. class TransactionOptions include Google::Apis::Core::Hashable @@ -3750,8 +3274,8 @@ module Google # @return [Google::Apis::SpannerV1::ReadOnly] attr_accessor :read_only - # Message type to initiate a read-write transaction. Currently this - # transaction type has no options. + # Message type to initiate a read-write transaction. Currently this transaction + # type has no options. # Corresponds to the JSON property `readWrite` # @return [Google::Apis::SpannerV1::ReadWrite] attr_accessor :read_write @@ -3768,229 +3292,170 @@ module Google end end - # This message is used to select the transaction in which a - # Read or - # ExecuteSql call runs. - # See TransactionOptions for more information about transactions. + # This message is used to select the transaction in which a Read or ExecuteSql + # call runs. See TransactionOptions for more information about transactions. class TransactionSelector include Google::Apis::Core::Hashable - # # Transactions - # Each session can have at most one active transaction at a time (note that - # standalone reads and queries use a transaction internally and do count - # towards the one transaction limit). After the active transaction is - # completed, the session can immediately be re-used for the next transaction. - # It is not necessary to create a new session for each transaction. - # # Transaction Modes - # Cloud Spanner supports three transaction modes: - # 1. Locking read-write. This type of transaction is the only way - # to write data into Cloud Spanner. These transactions rely on - # pessimistic locking and, if necessary, two-phase commit. - # Locking read-write transactions may abort, requiring the - # application to retry. - # 2. Snapshot read-only. This transaction type provides guaranteed - # consistency across several reads, but does not allow - # writes. Snapshot read-only transactions can be configured to - # read at timestamps in the past. Snapshot read-only - # transactions do not need to be committed. - # 3. Partitioned DML. This type of transaction is used to execute - # a single Partitioned DML statement. Partitioned DML partitions - # the key space and runs the DML statement over each partition - # in parallel using separate, internal transactions that commit - # independently. Partitioned DML transactions do not need to be - # committed. - # For transactions that only read, snapshot read-only transactions - # provide simpler semantics and are almost always faster. In - # particular, read-only transactions do not take locks, so they do - # not conflict with read-write transactions. As a consequence of not - # taking locks, they also do not abort, so retry loops are not needed. - # Transactions may only read/write data in a single database. They - # may, however, read/write data in different tables within that - # database. - # ## Locking Read-Write Transactions - # Locking transactions may be used to atomically read-modify-write - # data anywhere in a database. This type of transaction is externally - # consistent. - # Clients should attempt to minimize the amount of time a transaction - # is active. Faster transactions commit with higher probability - # and cause less contention. Cloud Spanner attempts to keep read locks - # active as long as the transaction continues to do reads, and the - # transaction has not been terminated by - # Commit or - # Rollback. Long periods of - # inactivity at the client may cause Cloud Spanner to release a - # transaction's locks and abort it. - # Conceptually, a read-write transaction consists of zero or more - # reads or SQL statements followed by - # Commit. At any time before - # Commit, the client can send a - # Rollback request to abort the - # transaction. - # ### Semantics - # Cloud Spanner can commit the transaction if all read locks it acquired - # are still valid at commit time, and it is able to acquire write - # locks for all writes. Cloud Spanner can abort the transaction for any - # reason. If a commit attempt returns `ABORTED`, Cloud Spanner guarantees - # that the transaction has not modified any user data in Cloud Spanner. - # Unless the transaction commits, Cloud Spanner makes no guarantees about - # how long the transaction's locks were held for. It is an error to - # use Cloud Spanner locks for any sort of mutual exclusion other than - # between Cloud Spanner transactions themselves. - # ### Retrying Aborted Transactions - # When a transaction aborts, the application can choose to retry the - # whole transaction again. To maximize the chances of successfully - # committing the retry, the client should execute the retry in the - # same session as the original attempt. The original session's lock - # priority increases with each consecutive abort, meaning that each - # attempt has a slightly better chance of success than the previous. - # Under some circumstances (e.g., many transactions attempting to - # modify the same row(s)), a transaction can abort many times in a - # short period before successfully committing. Thus, it is not a good - # idea to cap the number of retries a transaction can attempt; - # instead, it is better to limit the total amount of wall time spent - # retrying. - # ### Idle Transactions - # A transaction is considered idle if it has no outstanding reads or - # SQL queries and has not started a read or SQL query within the last 10 - # seconds. Idle transactions can be aborted by Cloud Spanner so that they - # don't hold on to locks indefinitely. In that case, the commit will - # fail with error `ABORTED`. - # If this behavior is undesirable, periodically executing a simple - # SQL query in the transaction (e.g., `SELECT 1`) prevents the - # transaction from becoming idle. - # ## Snapshot Read-Only Transactions - # Snapshot read-only transactions provides a simpler method than - # locking read-write transactions for doing several consistent - # reads. However, this type of transaction does not support writes. - # Snapshot transactions do not take locks. Instead, they work by - # choosing a Cloud Spanner timestamp, then executing all reads at that - # timestamp. Since they do not acquire locks, they do not block - # concurrent read-write transactions. - # Unlike locking read-write transactions, snapshot read-only - # transactions never abort. They can fail if the chosen read - # timestamp is garbage collected; however, the default garbage - # collection policy is generous enough that most applications do not - # need to worry about this in practice. - # Snapshot read-only transactions do not need to call - # Commit or - # Rollback (and in fact are not - # permitted to do so). - # To execute a snapshot transaction, the client specifies a timestamp - # bound, which tells Cloud Spanner how to choose a read timestamp. - # The types of timestamp bound are: - # - Strong (the default). - # - Bounded staleness. - # - Exact staleness. - # If the Cloud Spanner database to be read is geographically distributed, - # stale read-only transactions can execute more quickly than strong - # or read-write transaction, because they are able to execute far - # from the leader replica. - # Each type of timestamp bound is discussed in detail below. - # ### Strong - # Strong reads are guaranteed to see the effects of all transactions - # that have committed before the start of the read. Furthermore, all - # rows yielded by a single read are consistent with each other -- if - # any part of the read observes a transaction, all parts of the read - # see the transaction. - # Strong reads are not repeatable: two consecutive strong read-only - # transactions might return inconsistent results if there are - # concurrent writes. If consistency across reads is required, the - # reads should be executed within a transaction or at an exact read - # timestamp. - # See TransactionOptions.ReadOnly.strong. - # ### Exact Staleness - # These timestamp bounds execute reads at a user-specified - # timestamp. Reads at a timestamp are guaranteed to see a consistent - # prefix of the global transaction history: they observe - # modifications done by all transactions with a commit timestamp <= - # the read timestamp, and observe none of the modifications done by - # transactions with a larger commit timestamp. They will block until - # all conflicting transactions that may be assigned commit timestamps - # <= the read timestamp have finished. - # The timestamp can either be expressed as an absolute Cloud Spanner commit - # timestamp or a staleness relative to the current time. - # These modes do not require a "negotiation phase" to pick a - # timestamp. As a result, they execute slightly faster than the - # equivalent boundedly stale concurrency modes. On the other hand, - # boundedly stale reads usually return fresher results. - # See TransactionOptions.ReadOnly.read_timestamp and - # TransactionOptions.ReadOnly.exact_staleness. - # ### Bounded Staleness - # Bounded staleness modes allow Cloud Spanner to pick the read timestamp, - # subject to a user-provided staleness bound. Cloud Spanner chooses the - # newest timestamp within the staleness bound that allows execution - # of the reads at the closest available replica without blocking. - # All rows yielded are consistent with each other -- if any part of - # the read observes a transaction, all parts of the read see the - # transaction. Boundedly stale reads are not repeatable: two stale - # reads, even if they use the same staleness bound, can execute at - # different timestamps and thus return inconsistent results. - # Boundedly stale reads execute in two phases: the first phase - # negotiates a timestamp among all replicas needed to serve the - # read. In the second phase, reads are executed at the negotiated - # timestamp. - # As a result of the two phase execution, bounded staleness reads are - # usually a little slower than comparable exact staleness - # reads. However, they are typically able to return fresher - # results, and are more likely to execute at the closest replica. - # Because the timestamp negotiation requires up-front knowledge of - # which rows will be read, it can only be used with single-use - # read-only transactions. - # See TransactionOptions.ReadOnly.max_staleness and - # TransactionOptions.ReadOnly.min_read_timestamp. - # ### Old Read Timestamps and Garbage Collection - # Cloud Spanner continuously garbage collects deleted and overwritten data - # in the background to reclaim storage space. This process is known - # as "version GC". By default, version GC reclaims versions after they - # are one hour old. Because of this, Cloud Spanner cannot perform reads - # at read timestamps more than one hour in the past. This - # restriction also applies to in-progress reads and/or SQL queries whose - # timestamp become too old while executing. Reads and SQL queries with - # too-old read timestamps fail with the error `FAILED_PRECONDITION`. - # ## Partitioned DML Transactions - # Partitioned DML transactions are used to execute DML statements with a - # different execution strategy that provides different, and often better, - # scalability properties for large, table-wide operations than DML in a - # ReadWrite transaction. Smaller scoped statements, such as an OLTP workload, - # should prefer using ReadWrite transactions. - # Partitioned DML partitions the keyspace and runs the DML statement on each - # partition in separate, internal transactions. These transactions commit - # automatically when complete, and run independently from one another. - # To reduce lock contention, this execution strategy only acquires read locks - # on rows that match the WHERE clause of the statement. Additionally, the - # smaller per-partition transactions hold locks for less time. - # That said, Partitioned DML is not a drop-in replacement for standard DML used - # in ReadWrite transactions. - # - The DML statement must be fully-partitionable. Specifically, the statement - # must be expressible as the union of many statements which each access only - # a single row of the table. - # - The statement is not applied atomically to all rows of the table. Rather, - # the statement is applied atomically to partitions of the table, in - # independent transactions. Secondary index rows are updated atomically - # with the base table rows. - # - Partitioned DML does not guarantee exactly-once execution semantics - # against a partition. The statement will be applied at least once to each - # partition. It is strongly recommended that the DML statement should be - # idempotent to avoid unexpected results. For instance, it is potentially - # dangerous to run a statement such as - # `UPDATE table SET column = column + 1` as it could be run multiple times - # against some rows. - # - The partitions are committed automatically - there is no support for - # Commit or Rollback. If the call returns an error, or if the client issuing - # the ExecuteSql call dies, it is possible that some rows had the statement - # executed on them successfully. It is also possible that statement was - # never executed against other rows. - # - Partitioned DML transactions may only contain the execution of a single - # DML statement via ExecuteSql or ExecuteStreamingSql. - # - If any error is encountered during the execution of the partitioned DML + # # Transactions Each session can have at most one active transaction at a time ( + # note that standalone reads and queries use a transaction internally and do + # count towards the one transaction limit). After the active transaction is + # completed, the session can immediately be re-used for the next transaction. It + # is not necessary to create a new session for each transaction. # Transaction + # Modes Cloud Spanner supports three transaction modes: 1. Locking read-write. + # This type of transaction is the only way to write data into Cloud Spanner. + # These transactions rely on pessimistic locking and, if necessary, two-phase + # commit. Locking read-write transactions may abort, requiring the application + # to retry. 2. Snapshot read-only. This transaction type provides guaranteed + # consistency across several reads, but does not allow writes. Snapshot read- + # only transactions can be configured to read at timestamps in the past. + # Snapshot read-only transactions do not need to be committed. 3. Partitioned + # DML. This type of transaction is used to execute a single Partitioned DML + # statement. Partitioned DML partitions the key space and runs the DML statement + # over each partition in parallel using separate, internal transactions that + # commit independently. Partitioned DML transactions do not need to be committed. + # For transactions that only read, snapshot read-only transactions provide + # simpler semantics and are almost always faster. In particular, read-only + # transactions do not take locks, so they do not conflict with read-write + # transactions. As a consequence of not taking locks, they also do not abort, so + # retry loops are not needed. Transactions may only read/write data in a single + # database. They may, however, read/write data in different tables within that + # database. ## Locking Read-Write Transactions Locking transactions may be used + # to atomically read-modify-write data anywhere in a database. This type of + # transaction is externally consistent. Clients should attempt to minimize the + # amount of time a transaction is active. Faster transactions commit with higher + # probability and cause less contention. Cloud Spanner attempts to keep read + # locks active as long as the transaction continues to do reads, and the + # transaction has not been terminated by Commit or Rollback. Long periods of + # inactivity at the client may cause Cloud Spanner to release a transaction's + # locks and abort it. Conceptually, a read-write transaction consists of zero or + # more reads or SQL statements followed by Commit. At any time before Commit, + # the client can send a Rollback request to abort the transaction. ### Semantics + # Cloud Spanner can commit the transaction if all read locks it acquired are + # still valid at commit time, and it is able to acquire write locks for all + # writes. Cloud Spanner can abort the transaction for any reason. If a commit + # attempt returns `ABORTED`, Cloud Spanner guarantees that the transaction has + # not modified any user data in Cloud Spanner. Unless the transaction commits, + # Cloud Spanner makes no guarantees about how long the transaction's locks were + # held for. It is an error to use Cloud Spanner locks for any sort of mutual + # exclusion other than between Cloud Spanner transactions themselves. ### + # Retrying Aborted Transactions When a transaction aborts, the application can + # choose to retry the whole transaction again. To maximize the chances of + # successfully committing the retry, the client should execute the retry in the + # same session as the original attempt. The original session's lock priority + # increases with each consecutive abort, meaning that each attempt has a + # slightly better chance of success than the previous. Under some circumstances ( + # e.g., many transactions attempting to modify the same row(s)), a transaction + # can abort many times in a short period before successfully committing. Thus, + # it is not a good idea to cap the number of retries a transaction can attempt; + # instead, it is better to limit the total amount of wall time spent retrying. ## + # # Idle Transactions A transaction is considered idle if it has no outstanding + # reads or SQL queries and has not started a read or SQL query within the last + # 10 seconds. Idle transactions can be aborted by Cloud Spanner so that they don' + # t hold on to locks indefinitely. In that case, the commit will fail with error + # `ABORTED`. If this behavior is undesirable, periodically executing a simple + # SQL query in the transaction (e.g., `SELECT 1`) prevents the transaction from + # becoming idle. ## Snapshot Read-Only Transactions Snapshot read-only + # transactions provides a simpler method than locking read-write transactions + # for doing several consistent reads. However, this type of transaction does not + # support writes. Snapshot transactions do not take locks. Instead, they work by + # choosing a Cloud Spanner timestamp, then executing all reads at that timestamp. + # Since they do not acquire locks, they do not block concurrent read-write + # transactions. Unlike locking read-write transactions, snapshot read-only + # transactions never abort. They can fail if the chosen read timestamp is + # garbage collected; however, the default garbage collection policy is generous + # enough that most applications do not need to worry about this in practice. + # Snapshot read-only transactions do not need to call Commit or Rollback (and in + # fact are not permitted to do so). To execute a snapshot transaction, the + # client specifies a timestamp bound, which tells Cloud Spanner how to choose a + # read timestamp. The types of timestamp bound are: - Strong (the default). - + # Bounded staleness. - Exact staleness. If the Cloud Spanner database to be read + # is geographically distributed, stale read-only transactions can execute more + # quickly than strong or read-write transaction, because they are able to + # execute far from the leader replica. Each type of timestamp bound is discussed + # in detail below. ### Strong Strong reads are guaranteed to see the effects of + # all transactions that have committed before the start of the read. Furthermore, + # all rows yielded by a single read are consistent with each other -- if any + # part of the read observes a transaction, all parts of the read see the + # transaction. Strong reads are not repeatable: two consecutive strong read-only + # transactions might return inconsistent results if there are concurrent writes. + # If consistency across reads is required, the reads should be executed within a + # transaction or at an exact read timestamp. See TransactionOptions.ReadOnly. + # strong. ### Exact Staleness These timestamp bounds execute reads at a user- + # specified timestamp. Reads at a timestamp are guaranteed to see a consistent + # prefix of the global transaction history: they observe modifications done by + # all transactions with a commit timestamp <= the read timestamp, and observe + # none of the modifications done by transactions with a larger commit timestamp. + # They will block until all conflicting transactions that may be assigned commit + # timestamps <= the read timestamp have finished. The timestamp can either be + # expressed as an absolute Cloud Spanner commit timestamp or a staleness + # relative to the current time. These modes do not require a "negotiation phase" + # to pick a timestamp. As a result, they execute slightly faster than the + # equivalent boundedly stale concurrency modes. On the other hand, boundedly + # stale reads usually return fresher results. See TransactionOptions.ReadOnly. + # read_timestamp and TransactionOptions.ReadOnly.exact_staleness. ### Bounded + # Staleness Bounded staleness modes allow Cloud Spanner to pick the read + # timestamp, subject to a user-provided staleness bound. Cloud Spanner chooses + # the newest timestamp within the staleness bound that allows execution of the + # reads at the closest available replica without blocking. All rows yielded are + # consistent with each other -- if any part of the read observes a transaction, + # all parts of the read see the transaction. Boundedly stale reads are not + # repeatable: two stale reads, even if they use the same staleness bound, can + # execute at different timestamps and thus return inconsistent results. + # Boundedly stale reads execute in two phases: the first phase negotiates a + # timestamp among all replicas needed to serve the read. In the second phase, + # reads are executed at the negotiated timestamp. As a result of the two phase + # execution, bounded staleness reads are usually a little slower than comparable + # exact staleness reads. However, they are typically able to return fresher + # results, and are more likely to execute at the closest replica. Because the + # timestamp negotiation requires up-front knowledge of which rows will be read, + # it can only be used with single-use read-only transactions. See + # TransactionOptions.ReadOnly.max_staleness and TransactionOptions.ReadOnly. + # min_read_timestamp. ### Old Read Timestamps and Garbage Collection Cloud + # Spanner continuously garbage collects deleted and overwritten data in the + # background to reclaim storage space. This process is known as "version GC". By + # default, version GC reclaims versions after they are one hour old. Because of + # this, Cloud Spanner cannot perform reads at read timestamps more than one hour + # in the past. This restriction also applies to in-progress reads and/or SQL + # queries whose timestamp become too old while executing. Reads and SQL queries + # with too-old read timestamps fail with the error `FAILED_PRECONDITION`. ## + # Partitioned DML Transactions Partitioned DML transactions are used to execute + # DML statements with a different execution strategy that provides different, + # and often better, scalability properties for large, table-wide operations than + # DML in a ReadWrite transaction. Smaller scoped statements, such as an OLTP + # workload, should prefer using ReadWrite transactions. Partitioned DML + # partitions the keyspace and runs the DML statement on each partition in + # separate, internal transactions. These transactions commit automatically when + # complete, and run independently from one another. To reduce lock contention, + # this execution strategy only acquires read locks on rows that match the WHERE + # clause of the statement. Additionally, the smaller per-partition transactions + # hold locks for less time. That said, Partitioned DML is not a drop-in + # replacement for standard DML used in ReadWrite transactions. - The DML + # statement must be fully-partitionable. Specifically, the statement must be + # expressible as the union of many statements which each access only a single + # row of the table. - The statement is not applied atomically to all rows of the + # table. Rather, the statement is applied atomically to partitions of the table, + # in independent transactions. Secondary index rows are updated atomically with + # the base table rows. - Partitioned DML does not guarantee exactly-once + # execution semantics against a partition. The statement will be applied at + # least once to each partition. It is strongly recommended that the DML + # statement should be idempotent to avoid unexpected results. For instance, it + # is potentially dangerous to run a statement such as `UPDATE table SET column = + # column + 1` as it could be run multiple times against some rows. - The + # partitions are committed automatically - there is no support for Commit or + # Rollback. If the call returns an error, or if the client issuing the + # ExecuteSql call dies, it is possible that some rows had the statement executed + # on them successfully. It is also possible that statement was never executed + # against other rows. - Partitioned DML transactions may only contain the + # execution of a single DML statement via ExecuteSql or ExecuteStreamingSql. - + # If any error is encountered during the execution of the partitioned DML # operation (for instance, a UNIQUE INDEX violation, division by zero, or a - # value that cannot be stored due to schema constraints), then the - # operation is stopped at that point and an error is returned. It is - # possible that at this point, some partitions have been committed (or even - # committed multiple times), and other partitions have not been run at all. - # Given the above, Partitioned DML is good fit for large, database-wide, - # operations that are idempotent, such as deleting old rows from a very large - # table. + # value that cannot be stored due to schema constraints), then the operation is + # stopped at that point and an error is returned. It is possible that at this + # point, some partitions have been committed (or even committed multiple times), + # and other partitions have not been run at all. Given the above, Partitioned + # DML is good fit for large, database-wide, operations that are idempotent, such + # as deleting old rows from a very large table. # Corresponds to the JSON property `begin` # @return [Google::Apis::SpannerV1::TransactionOptions] attr_accessor :begin @@ -4001,222 +3466,165 @@ module Google # @return [String] attr_accessor :id - # # Transactions - # Each session can have at most one active transaction at a time (note that - # standalone reads and queries use a transaction internally and do count - # towards the one transaction limit). After the active transaction is - # completed, the session can immediately be re-used for the next transaction. - # It is not necessary to create a new session for each transaction. - # # Transaction Modes - # Cloud Spanner supports three transaction modes: - # 1. Locking read-write. This type of transaction is the only way - # to write data into Cloud Spanner. These transactions rely on - # pessimistic locking and, if necessary, two-phase commit. - # Locking read-write transactions may abort, requiring the - # application to retry. - # 2. Snapshot read-only. This transaction type provides guaranteed - # consistency across several reads, but does not allow - # writes. Snapshot read-only transactions can be configured to - # read at timestamps in the past. Snapshot read-only - # transactions do not need to be committed. - # 3. Partitioned DML. This type of transaction is used to execute - # a single Partitioned DML statement. Partitioned DML partitions - # the key space and runs the DML statement over each partition - # in parallel using separate, internal transactions that commit - # independently. Partitioned DML transactions do not need to be - # committed. - # For transactions that only read, snapshot read-only transactions - # provide simpler semantics and are almost always faster. In - # particular, read-only transactions do not take locks, so they do - # not conflict with read-write transactions. As a consequence of not - # taking locks, they also do not abort, so retry loops are not needed. - # Transactions may only read/write data in a single database. They - # may, however, read/write data in different tables within that - # database. - # ## Locking Read-Write Transactions - # Locking transactions may be used to atomically read-modify-write - # data anywhere in a database. This type of transaction is externally - # consistent. - # Clients should attempt to minimize the amount of time a transaction - # is active. Faster transactions commit with higher probability - # and cause less contention. Cloud Spanner attempts to keep read locks - # active as long as the transaction continues to do reads, and the - # transaction has not been terminated by - # Commit or - # Rollback. Long periods of - # inactivity at the client may cause Cloud Spanner to release a - # transaction's locks and abort it. - # Conceptually, a read-write transaction consists of zero or more - # reads or SQL statements followed by - # Commit. At any time before - # Commit, the client can send a - # Rollback request to abort the - # transaction. - # ### Semantics - # Cloud Spanner can commit the transaction if all read locks it acquired - # are still valid at commit time, and it is able to acquire write - # locks for all writes. Cloud Spanner can abort the transaction for any - # reason. If a commit attempt returns `ABORTED`, Cloud Spanner guarantees - # that the transaction has not modified any user data in Cloud Spanner. - # Unless the transaction commits, Cloud Spanner makes no guarantees about - # how long the transaction's locks were held for. It is an error to - # use Cloud Spanner locks for any sort of mutual exclusion other than - # between Cloud Spanner transactions themselves. - # ### Retrying Aborted Transactions - # When a transaction aborts, the application can choose to retry the - # whole transaction again. To maximize the chances of successfully - # committing the retry, the client should execute the retry in the - # same session as the original attempt. The original session's lock - # priority increases with each consecutive abort, meaning that each - # attempt has a slightly better chance of success than the previous. - # Under some circumstances (e.g., many transactions attempting to - # modify the same row(s)), a transaction can abort many times in a - # short period before successfully committing. Thus, it is not a good - # idea to cap the number of retries a transaction can attempt; - # instead, it is better to limit the total amount of wall time spent - # retrying. - # ### Idle Transactions - # A transaction is considered idle if it has no outstanding reads or - # SQL queries and has not started a read or SQL query within the last 10 - # seconds. Idle transactions can be aborted by Cloud Spanner so that they - # don't hold on to locks indefinitely. In that case, the commit will - # fail with error `ABORTED`. - # If this behavior is undesirable, periodically executing a simple - # SQL query in the transaction (e.g., `SELECT 1`) prevents the - # transaction from becoming idle. - # ## Snapshot Read-Only Transactions - # Snapshot read-only transactions provides a simpler method than - # locking read-write transactions for doing several consistent - # reads. However, this type of transaction does not support writes. - # Snapshot transactions do not take locks. Instead, they work by - # choosing a Cloud Spanner timestamp, then executing all reads at that - # timestamp. Since they do not acquire locks, they do not block - # concurrent read-write transactions. - # Unlike locking read-write transactions, snapshot read-only - # transactions never abort. They can fail if the chosen read - # timestamp is garbage collected; however, the default garbage - # collection policy is generous enough that most applications do not - # need to worry about this in practice. - # Snapshot read-only transactions do not need to call - # Commit or - # Rollback (and in fact are not - # permitted to do so). - # To execute a snapshot transaction, the client specifies a timestamp - # bound, which tells Cloud Spanner how to choose a read timestamp. - # The types of timestamp bound are: - # - Strong (the default). - # - Bounded staleness. - # - Exact staleness. - # If the Cloud Spanner database to be read is geographically distributed, - # stale read-only transactions can execute more quickly than strong - # or read-write transaction, because they are able to execute far - # from the leader replica. - # Each type of timestamp bound is discussed in detail below. - # ### Strong - # Strong reads are guaranteed to see the effects of all transactions - # that have committed before the start of the read. Furthermore, all - # rows yielded by a single read are consistent with each other -- if - # any part of the read observes a transaction, all parts of the read - # see the transaction. - # Strong reads are not repeatable: two consecutive strong read-only - # transactions might return inconsistent results if there are - # concurrent writes. If consistency across reads is required, the - # reads should be executed within a transaction or at an exact read - # timestamp. - # See TransactionOptions.ReadOnly.strong. - # ### Exact Staleness - # These timestamp bounds execute reads at a user-specified - # timestamp. Reads at a timestamp are guaranteed to see a consistent - # prefix of the global transaction history: they observe - # modifications done by all transactions with a commit timestamp <= - # the read timestamp, and observe none of the modifications done by - # transactions with a larger commit timestamp. They will block until - # all conflicting transactions that may be assigned commit timestamps - # <= the read timestamp have finished. - # The timestamp can either be expressed as an absolute Cloud Spanner commit - # timestamp or a staleness relative to the current time. - # These modes do not require a "negotiation phase" to pick a - # timestamp. As a result, they execute slightly faster than the - # equivalent boundedly stale concurrency modes. On the other hand, - # boundedly stale reads usually return fresher results. - # See TransactionOptions.ReadOnly.read_timestamp and - # TransactionOptions.ReadOnly.exact_staleness. - # ### Bounded Staleness - # Bounded staleness modes allow Cloud Spanner to pick the read timestamp, - # subject to a user-provided staleness bound. Cloud Spanner chooses the - # newest timestamp within the staleness bound that allows execution - # of the reads at the closest available replica without blocking. - # All rows yielded are consistent with each other -- if any part of - # the read observes a transaction, all parts of the read see the - # transaction. Boundedly stale reads are not repeatable: two stale - # reads, even if they use the same staleness bound, can execute at - # different timestamps and thus return inconsistent results. - # Boundedly stale reads execute in two phases: the first phase - # negotiates a timestamp among all replicas needed to serve the - # read. In the second phase, reads are executed at the negotiated - # timestamp. - # As a result of the two phase execution, bounded staleness reads are - # usually a little slower than comparable exact staleness - # reads. However, they are typically able to return fresher - # results, and are more likely to execute at the closest replica. - # Because the timestamp negotiation requires up-front knowledge of - # which rows will be read, it can only be used with single-use - # read-only transactions. - # See TransactionOptions.ReadOnly.max_staleness and - # TransactionOptions.ReadOnly.min_read_timestamp. - # ### Old Read Timestamps and Garbage Collection - # Cloud Spanner continuously garbage collects deleted and overwritten data - # in the background to reclaim storage space. This process is known - # as "version GC". By default, version GC reclaims versions after they - # are one hour old. Because of this, Cloud Spanner cannot perform reads - # at read timestamps more than one hour in the past. This - # restriction also applies to in-progress reads and/or SQL queries whose - # timestamp become too old while executing. Reads and SQL queries with - # too-old read timestamps fail with the error `FAILED_PRECONDITION`. - # ## Partitioned DML Transactions - # Partitioned DML transactions are used to execute DML statements with a - # different execution strategy that provides different, and often better, - # scalability properties for large, table-wide operations than DML in a - # ReadWrite transaction. Smaller scoped statements, such as an OLTP workload, - # should prefer using ReadWrite transactions. - # Partitioned DML partitions the keyspace and runs the DML statement on each - # partition in separate, internal transactions. These transactions commit - # automatically when complete, and run independently from one another. - # To reduce lock contention, this execution strategy only acquires read locks - # on rows that match the WHERE clause of the statement. Additionally, the - # smaller per-partition transactions hold locks for less time. - # That said, Partitioned DML is not a drop-in replacement for standard DML used - # in ReadWrite transactions. - # - The DML statement must be fully-partitionable. Specifically, the statement - # must be expressible as the union of many statements which each access only - # a single row of the table. - # - The statement is not applied atomically to all rows of the table. Rather, - # the statement is applied atomically to partitions of the table, in - # independent transactions. Secondary index rows are updated atomically - # with the base table rows. - # - Partitioned DML does not guarantee exactly-once execution semantics - # against a partition. The statement will be applied at least once to each - # partition. It is strongly recommended that the DML statement should be - # idempotent to avoid unexpected results. For instance, it is potentially - # dangerous to run a statement such as - # `UPDATE table SET column = column + 1` as it could be run multiple times - # against some rows. - # - The partitions are committed automatically - there is no support for - # Commit or Rollback. If the call returns an error, or if the client issuing - # the ExecuteSql call dies, it is possible that some rows had the statement - # executed on them successfully. It is also possible that statement was - # never executed against other rows. - # - Partitioned DML transactions may only contain the execution of a single - # DML statement via ExecuteSql or ExecuteStreamingSql. - # - If any error is encountered during the execution of the partitioned DML + # # Transactions Each session can have at most one active transaction at a time ( + # note that standalone reads and queries use a transaction internally and do + # count towards the one transaction limit). After the active transaction is + # completed, the session can immediately be re-used for the next transaction. It + # is not necessary to create a new session for each transaction. # Transaction + # Modes Cloud Spanner supports three transaction modes: 1. Locking read-write. + # This type of transaction is the only way to write data into Cloud Spanner. + # These transactions rely on pessimistic locking and, if necessary, two-phase + # commit. Locking read-write transactions may abort, requiring the application + # to retry. 2. Snapshot read-only. This transaction type provides guaranteed + # consistency across several reads, but does not allow writes. Snapshot read- + # only transactions can be configured to read at timestamps in the past. + # Snapshot read-only transactions do not need to be committed. 3. Partitioned + # DML. This type of transaction is used to execute a single Partitioned DML + # statement. Partitioned DML partitions the key space and runs the DML statement + # over each partition in parallel using separate, internal transactions that + # commit independently. Partitioned DML transactions do not need to be committed. + # For transactions that only read, snapshot read-only transactions provide + # simpler semantics and are almost always faster. In particular, read-only + # transactions do not take locks, so they do not conflict with read-write + # transactions. As a consequence of not taking locks, they also do not abort, so + # retry loops are not needed. Transactions may only read/write data in a single + # database. They may, however, read/write data in different tables within that + # database. ## Locking Read-Write Transactions Locking transactions may be used + # to atomically read-modify-write data anywhere in a database. This type of + # transaction is externally consistent. Clients should attempt to minimize the + # amount of time a transaction is active. Faster transactions commit with higher + # probability and cause less contention. Cloud Spanner attempts to keep read + # locks active as long as the transaction continues to do reads, and the + # transaction has not been terminated by Commit or Rollback. Long periods of + # inactivity at the client may cause Cloud Spanner to release a transaction's + # locks and abort it. Conceptually, a read-write transaction consists of zero or + # more reads or SQL statements followed by Commit. At any time before Commit, + # the client can send a Rollback request to abort the transaction. ### Semantics + # Cloud Spanner can commit the transaction if all read locks it acquired are + # still valid at commit time, and it is able to acquire write locks for all + # writes. Cloud Spanner can abort the transaction for any reason. If a commit + # attempt returns `ABORTED`, Cloud Spanner guarantees that the transaction has + # not modified any user data in Cloud Spanner. Unless the transaction commits, + # Cloud Spanner makes no guarantees about how long the transaction's locks were + # held for. It is an error to use Cloud Spanner locks for any sort of mutual + # exclusion other than between Cloud Spanner transactions themselves. ### + # Retrying Aborted Transactions When a transaction aborts, the application can + # choose to retry the whole transaction again. To maximize the chances of + # successfully committing the retry, the client should execute the retry in the + # same session as the original attempt. The original session's lock priority + # increases with each consecutive abort, meaning that each attempt has a + # slightly better chance of success than the previous. Under some circumstances ( + # e.g., many transactions attempting to modify the same row(s)), a transaction + # can abort many times in a short period before successfully committing. Thus, + # it is not a good idea to cap the number of retries a transaction can attempt; + # instead, it is better to limit the total amount of wall time spent retrying. ## + # # Idle Transactions A transaction is considered idle if it has no outstanding + # reads or SQL queries and has not started a read or SQL query within the last + # 10 seconds. Idle transactions can be aborted by Cloud Spanner so that they don' + # t hold on to locks indefinitely. In that case, the commit will fail with error + # `ABORTED`. If this behavior is undesirable, periodically executing a simple + # SQL query in the transaction (e.g., `SELECT 1`) prevents the transaction from + # becoming idle. ## Snapshot Read-Only Transactions Snapshot read-only + # transactions provides a simpler method than locking read-write transactions + # for doing several consistent reads. However, this type of transaction does not + # support writes. Snapshot transactions do not take locks. Instead, they work by + # choosing a Cloud Spanner timestamp, then executing all reads at that timestamp. + # Since they do not acquire locks, they do not block concurrent read-write + # transactions. Unlike locking read-write transactions, snapshot read-only + # transactions never abort. They can fail if the chosen read timestamp is + # garbage collected; however, the default garbage collection policy is generous + # enough that most applications do not need to worry about this in practice. + # Snapshot read-only transactions do not need to call Commit or Rollback (and in + # fact are not permitted to do so). To execute a snapshot transaction, the + # client specifies a timestamp bound, which tells Cloud Spanner how to choose a + # read timestamp. The types of timestamp bound are: - Strong (the default). - + # Bounded staleness. - Exact staleness. If the Cloud Spanner database to be read + # is geographically distributed, stale read-only transactions can execute more + # quickly than strong or read-write transaction, because they are able to + # execute far from the leader replica. Each type of timestamp bound is discussed + # in detail below. ### Strong Strong reads are guaranteed to see the effects of + # all transactions that have committed before the start of the read. Furthermore, + # all rows yielded by a single read are consistent with each other -- if any + # part of the read observes a transaction, all parts of the read see the + # transaction. Strong reads are not repeatable: two consecutive strong read-only + # transactions might return inconsistent results if there are concurrent writes. + # If consistency across reads is required, the reads should be executed within a + # transaction or at an exact read timestamp. See TransactionOptions.ReadOnly. + # strong. ### Exact Staleness These timestamp bounds execute reads at a user- + # specified timestamp. Reads at a timestamp are guaranteed to see a consistent + # prefix of the global transaction history: they observe modifications done by + # all transactions with a commit timestamp <= the read timestamp, and observe + # none of the modifications done by transactions with a larger commit timestamp. + # They will block until all conflicting transactions that may be assigned commit + # timestamps <= the read timestamp have finished. The timestamp can either be + # expressed as an absolute Cloud Spanner commit timestamp or a staleness + # relative to the current time. These modes do not require a "negotiation phase" + # to pick a timestamp. As a result, they execute slightly faster than the + # equivalent boundedly stale concurrency modes. On the other hand, boundedly + # stale reads usually return fresher results. See TransactionOptions.ReadOnly. + # read_timestamp and TransactionOptions.ReadOnly.exact_staleness. ### Bounded + # Staleness Bounded staleness modes allow Cloud Spanner to pick the read + # timestamp, subject to a user-provided staleness bound. Cloud Spanner chooses + # the newest timestamp within the staleness bound that allows execution of the + # reads at the closest available replica without blocking. All rows yielded are + # consistent with each other -- if any part of the read observes a transaction, + # all parts of the read see the transaction. Boundedly stale reads are not + # repeatable: two stale reads, even if they use the same staleness bound, can + # execute at different timestamps and thus return inconsistent results. + # Boundedly stale reads execute in two phases: the first phase negotiates a + # timestamp among all replicas needed to serve the read. In the second phase, + # reads are executed at the negotiated timestamp. As a result of the two phase + # execution, bounded staleness reads are usually a little slower than comparable + # exact staleness reads. However, they are typically able to return fresher + # results, and are more likely to execute at the closest replica. Because the + # timestamp negotiation requires up-front knowledge of which rows will be read, + # it can only be used with single-use read-only transactions. See + # TransactionOptions.ReadOnly.max_staleness and TransactionOptions.ReadOnly. + # min_read_timestamp. ### Old Read Timestamps and Garbage Collection Cloud + # Spanner continuously garbage collects deleted and overwritten data in the + # background to reclaim storage space. This process is known as "version GC". By + # default, version GC reclaims versions after they are one hour old. Because of + # this, Cloud Spanner cannot perform reads at read timestamps more than one hour + # in the past. This restriction also applies to in-progress reads and/or SQL + # queries whose timestamp become too old while executing. Reads and SQL queries + # with too-old read timestamps fail with the error `FAILED_PRECONDITION`. ## + # Partitioned DML Transactions Partitioned DML transactions are used to execute + # DML statements with a different execution strategy that provides different, + # and often better, scalability properties for large, table-wide operations than + # DML in a ReadWrite transaction. Smaller scoped statements, such as an OLTP + # workload, should prefer using ReadWrite transactions. Partitioned DML + # partitions the keyspace and runs the DML statement on each partition in + # separate, internal transactions. These transactions commit automatically when + # complete, and run independently from one another. To reduce lock contention, + # this execution strategy only acquires read locks on rows that match the WHERE + # clause of the statement. Additionally, the smaller per-partition transactions + # hold locks for less time. That said, Partitioned DML is not a drop-in + # replacement for standard DML used in ReadWrite transactions. - The DML + # statement must be fully-partitionable. Specifically, the statement must be + # expressible as the union of many statements which each access only a single + # row of the table. - The statement is not applied atomically to all rows of the + # table. Rather, the statement is applied atomically to partitions of the table, + # in independent transactions. Secondary index rows are updated atomically with + # the base table rows. - Partitioned DML does not guarantee exactly-once + # execution semantics against a partition. The statement will be applied at + # least once to each partition. It is strongly recommended that the DML + # statement should be idempotent to avoid unexpected results. For instance, it + # is potentially dangerous to run a statement such as `UPDATE table SET column = + # column + 1` as it could be run multiple times against some rows. - The + # partitions are committed automatically - there is no support for Commit or + # Rollback. If the call returns an error, or if the client issuing the + # ExecuteSql call dies, it is possible that some rows had the statement executed + # on them successfully. It is also possible that statement was never executed + # against other rows. - Partitioned DML transactions may only contain the + # execution of a single DML statement via ExecuteSql or ExecuteStreamingSql. - + # If any error is encountered during the execution of the partitioned DML # operation (for instance, a UNIQUE INDEX violation, division by zero, or a - # value that cannot be stored due to schema constraints), then the - # operation is stopped at that point and an error is returned. It is - # possible that at this point, some partitions have been committed (or even - # committed multiple times), and other partitions have not been run at all. - # Given the above, Partitioned DML is good fit for large, database-wide, - # operations that are idempotent, such as deleting old rows from a very large - # table. + # value that cannot be stored due to schema constraints), then the operation is + # stopped at that point and an error is returned. It is possible that at this + # point, some partitions have been committed (or even committed multiple times), + # and other partitions have not been run at all. Given the above, Partitioned + # DML is good fit for large, database-wide, operations that are idempotent, such + # as deleting old rows from a very large table. # Corresponds to the JSON property `singleUse` # @return [Google::Apis::SpannerV1::TransactionOptions] attr_accessor :single_use @@ -4266,14 +3674,13 @@ module Google end end - # Metadata type for the operation returned by - # UpdateDatabaseDdl. + # Metadata type for the operation returned by UpdateDatabaseDdl. class UpdateDatabaseDdlMetadata include Google::Apis::Core::Hashable - # Reports the commit timestamps of all statements that have - # succeeded so far, where `commit_timestamps[i]` is the commit - # timestamp for the statement `statements[i]`. + # Reports the commit timestamps of all statements that have succeeded so far, + # where `commit_timestamps[i]` is the commit timestamp for the statement ` + # statements[i]`. # Corresponds to the JSON property `commitTimestamps` # @return [Array] attr_accessor :commit_timestamps @@ -4283,8 +3690,8 @@ module Google # @return [String] attr_accessor :database - # For an update this list contains all the statements. For an - # individual statement, this list contains only that statement. + # For an update this list contains all the statements. For an individual + # statement, this list contains only that statement. # Corresponds to the JSON property `statements` # @return [Array] attr_accessor :statements @@ -4301,41 +3708,30 @@ module Google end end - # Enqueues the given DDL statements to be applied, in order but not - # necessarily all at once, to the database schema at some point (or - # points) in the future. The server checks that the statements - # are executable (syntactically valid, name tables that exist, etc.) - # before enqueueing them, but they may still fail upon - # later execution (e.g., if a statement from another batch of - # statements is applied first and it conflicts in some way, or if - # there is some data-related problem like a `NULL` value in a column to - # which `NOT NULL` would be added). If a statement fails, all - # subsequent statements in the batch are automatically cancelled. - # Each batch of statements is assigned a name which can be used with - # the Operations API to monitor - # progress. See the - # operation_id field for more + # Enqueues the given DDL statements to be applied, in order but not necessarily + # all at once, to the database schema at some point (or points) in the future. + # The server checks that the statements are executable (syntactically valid, + # name tables that exist, etc.) before enqueueing them, but they may still fail + # upon later execution (e.g., if a statement from another batch of statements is + # applied first and it conflicts in some way, or if there is some data-related + # problem like a `NULL` value in a column to which `NOT NULL` would be added). + # If a statement fails, all subsequent statements in the batch are automatically + # cancelled. Each batch of statements is assigned a name which can be used with + # the Operations API to monitor progress. See the operation_id field for more # details. class UpdateDatabaseDdlRequest include Google::Apis::Core::Hashable - # If empty, the new update request is assigned an - # automatically-generated operation ID. Otherwise, `operation_id` - # is used to construct the name of the resulting - # Operation. - # Specifying an explicit operation ID simplifies determining - # whether the statements were executed in the event that the - # UpdateDatabaseDdl call is replayed, - # or the return value is otherwise lost: the database and - # `operation_id` fields can be combined to form the - # name of the resulting - # longrunning.Operation: `/operations/`. - # `operation_id` should be unique within the database, and must be - # a valid identifier: `a-z*`. Note that - # automatically-generated operation IDs always begin with an - # underscore. If the named operation already exists, - # UpdateDatabaseDdl returns - # `ALREADY_EXISTS`. + # If empty, the new update request is assigned an automatically-generated + # operation ID. Otherwise, `operation_id` is used to construct the name of the + # resulting Operation. Specifying an explicit operation ID simplifies + # determining whether the statements were executed in the event that the + # UpdateDatabaseDdl call is replayed, or the return value is otherwise lost: the + # database and `operation_id` fields can be combined to form the name of the + # resulting longrunning.Operation: `/operations/`. `operation_id` should be + # unique within the database, and must be a valid identifier: `a-z*`. Note that + # automatically-generated operation IDs always begin with an underscore. If the + # named operation already exists, UpdateDatabaseDdl returns `ALREADY_EXISTS`. # Corresponds to the JSON property `operationId` # @return [String] attr_accessor :operation_id @@ -4356,14 +3752,13 @@ module Google end end - # Metadata type for the operation returned by - # UpdateInstance. + # Metadata type for the operation returned by UpdateInstance. class UpdateInstanceMetadata include Google::Apis::Core::Hashable - # The time at which this operation was cancelled. If set, this operation is - # in the process of undoing itself (which is guaranteed to succeed) and - # cannot be cancelled again. + # The time at which this operation was cancelled. If set, this operation is in + # the process of undoing itself (which is guaranteed to succeed) and cannot be + # cancelled again. # Corresponds to the JSON property `cancelTime` # @return [String] attr_accessor :cancel_time @@ -4378,8 +3773,7 @@ module Google # @return [Google::Apis::SpannerV1::Instance] attr_accessor :instance - # The time at which UpdateInstance - # request was received. + # The time at which UpdateInstance request was received. # Corresponds to the JSON property `startTime` # @return [String] attr_accessor :start_time @@ -4401,10 +3795,9 @@ module Google class UpdateInstanceRequest include Google::Apis::Core::Hashable - # Required. A mask specifying which fields in Instance should be updated. - # The field mask must always be specified; this prevents any future fields in - # Instance from being erased accidentally by clients that do not know - # about them. + # Required. A mask specifying which fields in Instance should be updated. The + # field mask must always be specified; this prevents any future fields in + # Instance from being erased accidentally by clients that do not know about them. # Corresponds to the JSON property `fieldMask` # @return [String] attr_accessor :field_mask @@ -4425,15 +3818,13 @@ module Google end end - # Arguments to insert, update, insert_or_update, and - # replace operations. + # Arguments to insert, update, insert_or_update, and replace operations. class Write include Google::Apis::Core::Hashable - # The names of the columns in table to be written. - # The list of columns must contain enough columns to allow - # Cloud Spanner to derive values for all primary key columns in the - # row(s) to be modified. + # The names of the columns in table to be written. The list of columns must + # contain enough columns to allow Cloud Spanner to derive values for all primary + # key columns in the row(s) to be modified. # Corresponds to the JSON property `columns` # @return [Array] attr_accessor :columns @@ -4443,14 +3834,12 @@ module Google # @return [String] attr_accessor :table - # The values to be written. `values` can contain more than one - # list of values. If it does, then multiple rows are written, one - # for each entry in `values`. Each list in `values` must have - # exactly as many entries as there are entries in columns - # above. Sending multiple lists is equivalent to sending multiple - # `Mutation`s, each containing one `values` entry and repeating - # table and columns. Individual values in each list are - # encoded as described here. + # The values to be written. `values` can contain more than one list of values. + # If it does, then multiple rows are written, one for each entry in `values`. + # Each list in `values` must have exactly as many entries as there are entries + # in columns above. Sending multiple lists is equivalent to sending multiple ` + # Mutation`s, each containing one `values` entry and repeating table and columns. + # Individual values in each list are encoded as described here. # Corresponds to the JSON property `values` # @return [Array>] attr_accessor :values diff --git a/generated/google/apis/spanner_v1/service.rb b/generated/google/apis/spanner_v1/service.rb index ef13b3635..ac9d7d196 100644 --- a/generated/google/apis/spanner_v1/service.rb +++ b/generated/google/apis/spanner_v1/service.rb @@ -50,8 +50,8 @@ module Google # Gets information about a particular instance configuration. # @param [String] name - # Required. The name of the requested instance configuration. Values are of - # the form `projects//instanceConfigs/`. + # Required. The name of the requested instance configuration. Values are of the + # form `projects//instanceConfigs/`. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -82,15 +82,13 @@ module Google # Lists the supported instance configurations for a given project. # @param [String] parent # Required. The name of the project for which a list of supported instance - # configurations is requested. Values are of the form - # `projects/`. + # configurations is requested. Values are of the form `projects/`. # @param [Fixnum] page_size - # Number of instance configurations to be returned in the response. If 0 or - # less, defaults to the server's maximum allowed page size. + # Number of instance configurations to be returned in the response. If 0 or less, + # defaults to the server's maximum allowed page size. # @param [String] page_token - # If non-empty, `page_token` should contain a - # next_page_token - # from a previous ListInstanceConfigsResponse. + # If non-empty, `page_token` should contain a next_page_token from a previous + # ListInstanceConfigsResponse. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -120,36 +118,25 @@ module Google execute_or_queue_command(command, &block) end - # Creates an instance and begins preparing it to begin serving. The - # returned long-running operation - # can be used to track the progress of preparing the new - # instance. The instance name is assigned by the caller. If the - # named instance already exists, `CreateInstance` returns - # `ALREADY_EXISTS`. - # Immediately upon completion of this request: - # * The instance is readable via the API, with all requested attributes - # but no allocated resources. Its state is `CREATING`. - # Until completion of the returned operation: - # * Cancelling the operation renders the instance immediately unreadable - # via the API. - # * The instance can be deleted. - # * All other attempts to modify the instance are rejected. - # Upon completion of the returned operation: - # * Billing for all successfully-allocated resources begins (some types - # may have lower than the requested levels). - # * Databases can be created in the instance. - # * The instance's allocated resource levels are readable via the API. - # * The instance's state becomes `READY`. - # The returned long-running operation will - # have a name of the format `/operations/` and - # can be used to track creation of the instance. The - # metadata field type is - # CreateInstanceMetadata. - # The response field type is - # Instance, if successful. + # Creates an instance and begins preparing it to begin serving. The returned + # long-running operation can be used to track the progress of preparing the new + # instance. The instance name is assigned by the caller. If the named instance + # already exists, `CreateInstance` returns `ALREADY_EXISTS`. Immediately upon + # completion of this request: * The instance is readable via the API, with all + # requested attributes but no allocated resources. Its state is `CREATING`. + # Until completion of the returned operation: * Cancelling the operation renders + # the instance immediately unreadable via the API. * The instance can be deleted. + # * All other attempts to modify the instance are rejected. Upon completion of + # the returned operation: * Billing for all successfully-allocated resources + # begins (some types may have lower than the requested levels). * Databases can + # be created in the instance. * The instance's allocated resource levels are + # readable via the API. * The instance's state becomes `READY`. The returned + # long-running operation will have a name of the format `/operations/` and can + # be used to track creation of the instance. The metadata field type is + # CreateInstanceMetadata. The response field type is Instance, if successful. # @param [String] parent - # Required. The name of the project in which to create the instance. Values - # are of the form `projects/`. + # Required. The name of the project in which to create the instance. Values are + # of the form `projects/`. # @param [Google::Apis::SpannerV1::CreateInstanceRequest] create_instance_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -180,16 +167,13 @@ module Google execute_or_queue_command(command, &block) end - # Deletes an instance. - # Immediately upon completion of the request: - # * Billing ceases for all of the instance's reserved resources. - # Soon afterward: - # * The instance and *all of its databases* immediately and - # irrevocably disappear from the API. All data in the databases - # is permanently deleted. + # Deletes an instance. Immediately upon completion of the request: * Billing + # ceases for all of the instance's reserved resources. Soon afterward: * The + # instance and *all of its databases* immediately and irrevocably disappear from + # the API. All data in the databases is permanently deleted. # @param [String] name - # Required. The name of the instance to be deleted. Values are of the form - # `projects//instances/` + # Required. The name of the instance to be deleted. Values are of the form ` + # projects//instances/` # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -219,12 +203,11 @@ module Google # Gets information about a particular instance. # @param [String] name - # Required. The name of the requested instance. Values are of the form - # `projects//instances/`. + # Required. The name of the requested instance. Values are of the form `projects/ + # /instances/`. # @param [String] field_mask - # If field_mask is present, specifies the subset of Instance fields that - # should be returned. - # If absent, all Instance fields are returned. + # If field_mask is present, specifies the subset of Instance fields that should + # be returned. If absent, all Instance fields are returned. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -254,14 +237,12 @@ module Google end # Gets the access control policy for an instance resource. Returns an empty - # policy if an instance exists but does not have a policy set. - # Authorization requires `spanner.instances.getIamPolicy` on - # resource. + # policy if an instance exists but does not have a policy set. Authorization + # requires `spanner.instances.getIamPolicy` on resource. # @param [String] resource # REQUIRED: The Cloud Spanner resource for which the policy is being retrieved. - # The format is `projects//instances/` for instance - # resources and `projects//instances//databases/< - # database ID>` for database resources. + # The format is `projects//instances/` for instance resources and `projects// + # instances//databases/` for database resources. # @param [Google::Apis::SpannerV1::GetIamPolicyRequest] get_iam_policy_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -294,32 +275,25 @@ module Google # Lists all instances in the given project. # @param [String] parent - # Required. The name of the project for which a list of instances is - # requested. Values are of the form `projects/`. + # Required. The name of the project for which a list of instances is requested. + # Values are of the form `projects/`. # @param [String] filter - # An expression for filtering the results of the request. Filter rules are - # case insensitive. The fields eligible for filtering are: - # * `name` - # * `display_name` - # * `labels.key` where key is the name of a label - # Some examples of using filters are: - # * `name:*` --> The instance has a name. - # * `name:Howl` --> The instance's name contains the string "howl". - # * `name:HOWL` --> Equivalent to above. - # * `NAME:howl` --> Equivalent to above. - # * `labels.env:*` --> The instance has the label "env". - # * `labels.env:dev` --> The instance has the label "env" and the value of - # the label contains the string "dev". - # * `name:howl labels.env:dev` --> The instance's name contains "howl" and - # it has the label "env" with its value + # An expression for filtering the results of the request. Filter rules are case + # insensitive. The fields eligible for filtering are: * `name` * `display_name` * + # `labels.key` where key is the name of a label Some examples of using filters + # are: * `name:*` --> The instance has a name. * `name:Howl` --> The instance's + # name contains the string "howl". * `name:HOWL` --> Equivalent to above. * ` + # NAME:howl` --> Equivalent to above. * `labels.env:*` --> The instance has the + # label "env". * `labels.env:dev` --> The instance has the label "env" and the + # value of the label contains the string "dev". * `name:howl labels.env:dev` --> + # The instance's name contains "howl" and it has the label "env" with its value # containing "dev". # @param [Fixnum] page_size - # Number of instances to be returned in the response. If 0 or less, defaults - # to the server's maximum allowed page size. + # Number of instances to be returned in the response. If 0 or less, defaults to + # the server's maximum allowed page size. # @param [String] page_token - # If non-empty, `page_token` should contain a - # next_page_token from a - # previous ListInstancesResponse. + # If non-empty, `page_token` should contain a next_page_token from a previous + # ListInstancesResponse. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -350,43 +324,31 @@ module Google execute_or_queue_command(command, &block) end - # Updates an instance, and begins allocating or releasing resources - # as requested. The returned long-running - # operation can be used to track the - # progress of updating the instance. If the named instance does not - # exist, returns `NOT_FOUND`. - # Immediately upon completion of this request: - # * For resource types for which a decrease in the instance's allocation - # has been requested, billing is based on the newly-requested level. - # Until completion of the returned operation: - # * Cancelling the operation sets its metadata's - # cancel_time, and begins - # restoring resources to their pre-request values. The operation - # is guaranteed to succeed at undoing all resource changes, - # after which point it terminates with a `CANCELLED` status. - # * All other attempts to modify the instance are rejected. - # * Reading the instance via the API continues to give the pre-request - # resource levels. - # Upon completion of the returned operation: - # * Billing begins for all successfully-allocated resources (some types - # may have lower than the requested levels). - # * All newly-reserved resources are available for serving the instance's - # tables. - # * The instance's new resource levels are readable via the API. - # The returned long-running operation will - # have a name of the format `/operations/` and - # can be used to track the instance modification. The - # metadata field type is - # UpdateInstanceMetadata. - # The response field type is - # Instance, if successful. - # Authorization requires `spanner.instances.update` permission on - # resource name. + # Updates an instance, and begins allocating or releasing resources as requested. + # The returned long-running operation can be used to track the progress of + # updating the instance. If the named instance does not exist, returns ` + # NOT_FOUND`. Immediately upon completion of this request: * For resource types + # for which a decrease in the instance's allocation has been requested, billing + # is based on the newly-requested level. Until completion of the returned + # operation: * Cancelling the operation sets its metadata's cancel_time, and + # begins restoring resources to their pre-request values. The operation is + # guaranteed to succeed at undoing all resource changes, after which point it + # terminates with a `CANCELLED` status. * All other attempts to modify the + # instance are rejected. * Reading the instance via the API continues to give + # the pre-request resource levels. Upon completion of the returned operation: * + # Billing begins for all successfully-allocated resources (some types may have + # lower than the requested levels). * All newly-reserved resources are available + # for serving the instance's tables. * The instance's new resource levels are + # readable via the API. The returned long-running operation will have a name of + # the format `/operations/` and can be used to track the instance modification. + # The metadata field type is UpdateInstanceMetadata. The response field type is + # Instance, if successful. Authorization requires `spanner.instances.update` + # permission on resource name. # @param [String] name - # Required. A unique identifier for the instance, which cannot be changed - # after the instance is created. Values are of the form - # `projects//instances/a-z*[a-z0-9]`. The final - # segment of the name must be between 2 and 64 characters in length. + # Required. A unique identifier for the instance, which cannot be changed after + # the instance is created. Values are of the form `projects//instances/a-z*[a-z0- + # 9]`. The final segment of the name must be between 2 and 64 characters in + # length. # @param [Google::Apis::SpannerV1::UpdateInstanceRequest] update_instance_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -417,15 +379,12 @@ module Google execute_or_queue_command(command, &block) end - # Sets the access control policy on an instance resource. Replaces any - # existing policy. - # Authorization requires `spanner.instances.setIamPolicy` on - # resource. + # Sets the access control policy on an instance resource. Replaces any existing + # policy. Authorization requires `spanner.instances.setIamPolicy` on resource. # @param [String] resource # REQUIRED: The Cloud Spanner resource for which the policy is being set. The - # format is `projects//instances/` for instance - # resources and `projects//instances//databases/< - # database ID>` for databases resources. + # format is `projects//instances/` for instance resources and `projects// + # instances//databases/` for databases resources. # @param [Google::Apis::SpannerV1::SetIamPolicyRequest] set_iam_policy_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -459,13 +418,12 @@ module Google # Returns permissions that the caller has on the specified instance resource. # Attempting this RPC on a non-existent Cloud Spanner instance resource will # result in a NOT_FOUND error if the user has `spanner.instances.list` - # permission on the containing Google Cloud Project. Otherwise returns an - # empty set of permissions. + # permission on the containing Google Cloud Project. Otherwise returns an empty + # set of permissions. # @param [String] resource # REQUIRED: The Cloud Spanner resource for which permissions are being tested. - # The format is `projects//instances/` for instance - # resources and `projects//instances//databases/< - # database ID>` for database resources. + # The format is `projects//instances/` for instance resources and `projects// + # instances//databases/` for database resources. # @param [Google::Apis::SpannerV1::TestIamPermissionsRequest] test_iam_permissions_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -496,63 +454,47 @@ module Google execute_or_queue_command(command, &block) end - # Lists the backup long-running operations in - # the given instance. A backup operation has a name of the form - # `projects//instances//backups//operations/< - # operation>`. - # The long-running operation - # metadata field type - # `metadata.type_url` describes the type of the metadata. Operations returned - # include those that have completed/failed/canceled within the last 7 days, - # and pending operations. Operations returned are ordered by - # `operation.metadata.value.progress.start_time` in descending order starting - # from the most recently started operation. + # Lists the backup long-running operations in the given instance. A backup + # operation has a name of the form `projects//instances//backups//operations/`. + # The long-running operation metadata field type `metadata.type_url` describes + # the type of the metadata. Operations returned include those that have + # completed/failed/canceled within the last 7 days, and pending operations. + # Operations returned are ordered by `operation.metadata.value.progress. + # start_time` in descending order starting from the most recently started + # operation. # @param [String] parent - # Required. The instance of the backup operations. Values are of - # the form `projects//instances/`. + # Required. The instance of the backup operations. Values are of the form ` + # projects//instances/`. # @param [String] filter - # An expression that filters the list of returned backup operations. - # A filter expression consists of a field name, a - # comparison operator, and a value for filtering. - # The value must be a string, a number, or a boolean. The comparison operator - # must be one of: `<`, `>`, `<=`, `>=`, `!=`, `=`, or `:`. - # Colon `:` is the contains operator. Filter rules are not case sensitive. - # The following fields in the operation - # are eligible for filtering: - # * `name` - The name of the long-running operation - # * `done` - False if the operation is in progress, else true. - # * `metadata.@type` - the type of metadata. For example, the type string - # for CreateBackupMetadata is - # `type.googleapis.com/google.spanner.admin.database.v1. - # CreateBackupMetadata`. - # * `metadata.` - any field in metadata.value. - # * `error` - Error associated with the long-running operation. - # * `response.@type` - the type of response. - # * `response.` - any field in response.value. - # You can combine multiple expressions by enclosing each expression in - # parentheses. By default, expressions are combined with AND logic, but - # you can specify AND, OR, and NOT logic explicitly. - # Here are a few examples: - # * `done:true` - The operation is complete. - # * `metadata.database:prod` - The database the backup was taken from has - # a name containing the string "prod". - # * `(metadata.@type=type.googleapis.com/google.spanner.admin.database.v1. - # CreateBackupMetadata) AND` \ - # `(metadata.name:howl) AND` \ - # `(metadata.progress.start_time < \"2018-03-28T14:50:00Z\") AND` \ - # `(error:*)` - Returns operations where: - # * The operation's metadata type is CreateBackupMetadata. - # * The backup name contains the string "howl". - # * The operation started before 2018-03-28T14:50:00Z. - # * The operation resulted in an error. + # An expression that filters the list of returned backup operations. A filter + # expression consists of a field name, a comparison operator, and a value for + # filtering. The value must be a string, a number, or a boolean. The comparison + # operator must be one of: `<`, `>`, `<=`, `>=`, `!=`, `=`, or `:`. Colon `:` is + # the contains operator. Filter rules are not case sensitive. The following + # fields in the operation are eligible for filtering: * `name` - The name of the + # long-running operation * `done` - False if the operation is in progress, else + # true. * `metadata.@type` - the type of metadata. For example, the type string + # for CreateBackupMetadata is `type.googleapis.com/google.spanner.admin.database. + # v1.CreateBackupMetadata`. * `metadata.` - any field in metadata.value. * ` + # error` - Error associated with the long-running operation. * `response.@type` - + # the type of response. * `response.` - any field in response.value. You can + # combine multiple expressions by enclosing each expression in parentheses. By + # default, expressions are combined with AND logic, but you can specify AND, OR, + # and NOT logic explicitly. Here are a few examples: * `done:true` - The + # operation is complete. * `metadata.database:prod` - The database the backup + # was taken from has a name containing the string "prod". * `(metadata.@type= + # type.googleapis.com/google.spanner.admin.database.v1.CreateBackupMetadata) AND` + # \ `(metadata.name:howl) AND` \ `(metadata.progress.start_time < \"2018-03- + # 28T14:50:00Z\") AND` \ `(error:*)` - Returns operations where: * The operation' + # s metadata type is CreateBackupMetadata. * The backup name contains the string + # "howl". * The operation started before 2018-03-28T14:50:00Z. * The operation + # resulted in an error. # @param [Fixnum] page_size - # Number of operations to be returned in the response. If 0 or - # less, defaults to the server's maximum allowed page size. + # Number of operations to be returned in the response. If 0 or less, defaults to + # the server's maximum allowed page size. # @param [String] page_token - # If non-empty, `page_token` should contain a - # next_page_token - # from a previous ListBackupOperationsResponse to the - # same `parent` and with the same `filter`. + # If non-empty, `page_token` should contain a next_page_token from a previous + # ListBackupOperationsResponse to the same `parent` and with the same `filter`. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -583,31 +525,23 @@ module Google execute_or_queue_command(command, &block) end - # Starts creating a new Cloud Spanner Backup. - # The returned backup long-running operation - # will have a name of the format - # `projects//instances//backups//operations/< - # operation_id>` - # and can be used to track creation of the backup. The - # metadata field type is - # CreateBackupMetadata. The - # response field type is - # Backup, if successful. Cancelling the returned operation will stop the - # creation and delete the backup. - # There can be only one pending backup creation per database. Backup creation - # of different databases can run concurrently. + # Starts creating a new Cloud Spanner Backup. The returned backup long-running + # operation will have a name of the format `projects//instances//backups// + # operations/` and can be used to track creation of the backup. The metadata + # field type is CreateBackupMetadata. The response field type is Backup, if + # successful. Cancelling the returned operation will stop the creation and + # delete the backup. There can be only one pending backup creation per database. + # Backup creation of different databases can run concurrently. # @param [String] parent - # Required. The name of the instance in which the backup will be - # created. This must be the same instance that contains the database the - # backup will be created from. The backup will be stored in the - # location(s) specified in the instance configuration of this - # instance. Values are of the form - # `projects//instances/`. + # Required. The name of the instance in which the backup will be created. This + # must be the same instance that contains the database the backup will be + # created from. The backup will be stored in the location(s) specified in the + # instance configuration of this instance. Values are of the form `projects// + # instances/`. # @param [Google::Apis::SpannerV1::Backup] backup_object # @param [String] backup_id - # Required. The id of the backup to be created. The `backup_id` appended to - # `parent` forms the full backup name of the form - # `projects//instances//backups/`. + # Required. The id of the backup to be created. The `backup_id` appended to ` + # parent` forms the full backup name of the form `projects//instances//backups/`. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -640,9 +574,8 @@ module Google # Deletes a pending or completed Backup. # @param [String] name - # Required. Name of the backup to delete. - # Values are of the form - # `projects//instances//backups/`. + # Required. Name of the backup to delete. Values are of the form `projects// + # instances//backups/`. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -672,9 +605,8 @@ module Google # Gets metadata on a pending or completed Backup. # @param [String] name - # Required. Name of the backup. - # Values are of the form - # `projects//instances//backups/`. + # Required. Name of the backup. Values are of the form `projects//instances// + # backups/`. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -702,18 +634,15 @@ module Google execute_or_queue_command(command, &block) end - # Gets the access control policy for a database or backup resource. - # Returns an empty policy if a database or backup exists but does not have a - # policy set. - # Authorization requires `spanner.databases.getIamPolicy` permission on - # resource. - # For backups, authorization requires `spanner.backups.getIamPolicy` - # permission on resource. + # Gets the access control policy for a database or backup resource. Returns an + # empty policy if a database or backup exists but does not have a policy set. + # Authorization requires `spanner.databases.getIamPolicy` permission on resource. + # For backups, authorization requires `spanner.backups.getIamPolicy` permission + # on resource. # @param [String] resource # REQUIRED: The Cloud Spanner resource for which the policy is being retrieved. - # The format is `projects//instances/` for instance - # resources and `projects//instances//databases/< - # database ID>` for database resources. + # The format is `projects//instances/` for instance resources and `projects// + # instances//databases/` for database resources. # @param [Google::Apis::SpannerV1::GetIamPolicyRequest] get_iam_policy_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -744,49 +673,37 @@ module Google execute_or_queue_command(command, &block) end - # Lists completed and pending backups. - # Backups returned are ordered by `create_time` in descending order, - # starting from the most recent `create_time`. + # Lists completed and pending backups. Backups returned are ordered by ` + # create_time` in descending order, starting from the most recent `create_time`. # @param [String] parent - # Required. The instance to list backups from. Values are of the - # form `projects//instances/`. + # Required. The instance to list backups from. Values are of the form `projects// + # instances/`. # @param [String] filter - # An expression that filters the list of returned backups. - # A filter expression consists of a field name, a comparison operator, and a - # value for filtering. + # An expression that filters the list of returned backups. A filter expression + # consists of a field name, a comparison operator, and a value for filtering. # The value must be a string, a number, or a boolean. The comparison operator - # must be one of: `<`, `>`, `<=`, `>=`, `!=`, `=`, or `:`. - # Colon `:` is the contains operator. Filter rules are not case sensitive. - # The following fields in the Backup are eligible for filtering: - # * `name` - # * `database` - # * `state` - # * `create_time` (and values are of the format YYYY-MM-DDTHH:MM:SSZ) - # * `expire_time` (and values are of the format YYYY-MM-DDTHH:MM:SSZ) - # * `size_bytes` + # must be one of: `<`, `>`, `<=`, `>=`, `!=`, `=`, or `:`. Colon `:` is the + # contains operator. Filter rules are not case sensitive. The following fields + # in the Backup are eligible for filtering: * `name` * `database` * `state` * ` + # create_time` (and values are of the format YYYY-MM-DDTHH:MM:SSZ) * ` + # expire_time` (and values are of the format YYYY-MM-DDTHH:MM:SSZ) * `size_bytes` # You can combine multiple expressions by enclosing each expression in - # parentheses. By default, expressions are combined with AND logic, but - # you can specify AND, OR, and NOT logic explicitly. - # Here are a few examples: - # * `name:Howl` - The backup's name contains the string "howl". - # * `database:prod` - # - The database's name contains the string "prod". - # * `state:CREATING` - The backup is pending creation. - # * `state:READY` - The backup is fully created and ready for use. - # * `(name:howl) AND (create_time < \"2018-03-28T14:50:00Z\")` - # - The backup name contains the string "howl" and `create_time` - # of the backup is before 2018-03-28T14:50:00Z. - # * `expire_time < \"2018-03-28T14:50:00Z\"` - # - The backup `expire_time` is before 2018-03-28T14:50:00Z. - # * `size_bytes > 10000000000` - The backup's size is greater than 10GB + # parentheses. By default, expressions are combined with AND logic, but you can + # specify AND, OR, and NOT logic explicitly. Here are a few examples: * `name: + # Howl` - The backup's name contains the string "howl". * `database:prod` - The + # database's name contains the string "prod". * `state:CREATING` - The backup is + # pending creation. * `state:READY` - The backup is fully created and ready for + # use. * `(name:howl) AND (create_time < \"2018-03-28T14:50:00Z\")` - The backup + # name contains the string "howl" and `create_time` of the backup is before 2018- + # 03-28T14:50:00Z. * `expire_time < \"2018-03-28T14:50:00Z\"` - The backup ` + # expire_time` is before 2018-03-28T14:50:00Z. * `size_bytes > 10000000000` - + # The backup's size is greater than 10GB # @param [Fixnum] page_size - # Number of backups to be returned in the response. If 0 or - # less, defaults to the server's maximum allowed page size. + # Number of backups to be returned in the response. If 0 or less, defaults to + # the server's maximum allowed page size. # @param [String] page_token - # If non-empty, `page_token` should contain a - # next_page_token from a - # previous ListBackupsResponse to the same `parent` and with the same - # `filter`. + # If non-empty, `page_token` should contain a next_page_token from a previous + # ListBackupsResponse to the same `parent` and with the same `filter`. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -819,24 +736,20 @@ module Google # Updates a pending or completed Backup. # @param [String] name - # Output only for the CreateBackup operation. - # Required for the UpdateBackup operation. - # A globally unique identifier for the backup which cannot be - # changed. Values are of the form - # `projects//instances//backups/a-z*[a-z0-9]` - # The final segment of the name must be between 2 and 60 characters - # in length. - # The backup is stored in the location(s) specified in the instance - # configuration of the instance containing the backup, identified - # by the prefix of the backup name of the form - # `projects//instances/`. + # Output only for the CreateBackup operation. Required for the UpdateBackup + # operation. A globally unique identifier for the backup which cannot be changed. + # Values are of the form `projects//instances//backups/a-z*[a-z0-9]` The final + # segment of the name must be between 2 and 60 characters in length. The backup + # is stored in the location(s) specified in the instance configuration of the + # instance containing the backup, identified by the prefix of the backup name of + # the form `projects//instances/`. # @param [Google::Apis::SpannerV1::Backup] backup_object # @param [String] update_mask - # Required. A mask specifying which fields (e.g. `expire_time`) in the - # Backup resource should be updated. This mask is relative to the Backup - # resource, not to the request message. The field mask must always be - # specified; this prevents any future fields from being erased accidentally - # by clients that do not know about them. + # Required. A mask specifying which fields (e.g. `expire_time`) in the Backup + # resource should be updated. This mask is relative to the Backup resource, not + # to the request message. The field mask must always be specified; this prevents + # any future fields from being erased accidentally by clients that do not know + # about them. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -867,17 +780,14 @@ module Google execute_or_queue_command(command, &block) end - # Sets the access control policy on a database or backup resource. - # Replaces any existing policy. - # Authorization requires `spanner.databases.setIamPolicy` - # permission on resource. - # For backups, authorization requires `spanner.backups.setIamPolicy` - # permission on resource. + # Sets the access control policy on a database or backup resource. Replaces any + # existing policy. Authorization requires `spanner.databases.setIamPolicy` + # permission on resource. For backups, authorization requires `spanner.backups. + # setIamPolicy` permission on resource. # @param [String] resource # REQUIRED: The Cloud Spanner resource for which the policy is being set. The - # format is `projects//instances/` for instance - # resources and `projects//instances//databases/< - # database ID>` for databases resources. + # format is `projects//instances/` for instance resources and `projects// + # instances//databases/` for databases resources. # @param [Google::Apis::SpannerV1::SetIamPolicyRequest] set_iam_policy_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -909,19 +819,16 @@ module Google end # Returns permissions that the caller has on the specified database or backup - # resource. - # Attempting this RPC on a non-existent Cloud Spanner database will - # result in a NOT_FOUND error if the user has - # `spanner.databases.list` permission on the containing Cloud - # Spanner instance. Otherwise returns an empty set of permissions. - # Calling this method on a backup that does not exist will - # result in a NOT_FOUND error if the user has - # `spanner.backups.list` permission on the containing instance. + # resource. Attempting this RPC on a non-existent Cloud Spanner database will + # result in a NOT_FOUND error if the user has `spanner.databases.list` + # permission on the containing Cloud Spanner instance. Otherwise returns an + # empty set of permissions. Calling this method on a backup that does not exist + # will result in a NOT_FOUND error if the user has `spanner.backups.list` + # permission on the containing instance. # @param [String] resource # REQUIRED: The Cloud Spanner resource for which permissions are being tested. - # The format is `projects//instances/` for instance - # resources and `projects//instances//databases/< - # database ID>` for database resources. + # The format is `projects//instances/` for instance resources and `projects// + # instances//databases/` for database resources. # @param [Google::Apis::SpannerV1::TestIamPermissionsRequest] test_iam_permissions_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -952,15 +859,13 @@ module Google execute_or_queue_command(command, &block) end - # Starts asynchronous cancellation on a long-running operation. The server - # makes a best effort to cancel the operation, but success is not - # guaranteed. If the server doesn't support this method, it returns - # `google.rpc.Code.UNIMPLEMENTED`. Clients can use - # Operations.GetOperation or - # other methods to check whether the cancellation succeeded or whether the - # operation completed despite cancellation. On successful cancellation, - # the operation is not deleted; instead, it becomes an operation with - # an Operation.error value with a google.rpc.Status.code of 1, + # Starts asynchronous cancellation on a long-running operation. The server makes + # a best effort to cancel the operation, but success is not guaranteed. If the + # server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. + # Clients can use Operations.GetOperation or other methods to check whether the + # cancellation succeeded or whether the operation completed despite cancellation. + # On successful cancellation, the operation is not deleted; instead, it becomes + # an operation with an Operation.error value with a google.rpc.Status.code of 1, # corresponding to `Code.CANCELLED`. # @param [String] name # The name of the operation resource to be cancelled. @@ -991,10 +896,10 @@ module Google execute_or_queue_command(command, &block) end - # Deletes a long-running operation. This method indicates that the client is - # no longer interested in the operation result. It does not cancel the - # operation. If the server doesn't support this method, it returns - # `google.rpc.Code.UNIMPLEMENTED`. + # Deletes a long-running operation. This method indicates that the client is no + # longer interested in the operation result. It does not cancel the operation. + # If the server doesn't support this method, it returns `google.rpc.Code. + # UNIMPLEMENTED`. # @param [String] name # The name of the operation resource to be deleted. # @param [String] fields @@ -1024,9 +929,8 @@ module Google execute_or_queue_command(command, &block) end - # Gets the latest state of a long-running operation. Clients can use this - # method to poll the operation result at intervals as recommended by the API - # service. + # Gets the latest state of a long-running operation. Clients can use this method + # to poll the operation result at intervals as recommended by the API service. # @param [String] name # The name of the operation resource. # @param [String] fields @@ -1056,15 +960,14 @@ module Google execute_or_queue_command(command, &block) end - # Lists operations that match the specified filter in the request. If the - # server doesn't support this method, it returns `UNIMPLEMENTED`. - # NOTE: the `name` binding allows API services to override the binding - # to use different resource name schemes, such as `users/*/operations`. To - # override the binding, API services can add a binding such as - # `"/v1/`name=users/*`/operations"` to their service configuration. - # For backwards compatibility, the default name includes the operations - # collection id, however overriding users must ensure the name binding - # is the parent resource, without the operations collection id. + # Lists operations that match the specified filter in the request. If the server + # doesn't support this method, it returns `UNIMPLEMENTED`. NOTE: the `name` + # binding allows API services to override the binding to use different resource + # name schemes, such as `users/*/operations`. To override the binding, API + # services can add a binding such as `"/v1/`name=users/*`/operations"` to their + # service configuration. For backwards compatibility, the default name includes + # the operations collection id, however overriding users must ensure the name + # binding is the parent resource, without the operations collection id. # @param [String] name # The name of the operation's parent resource. # @param [String] filter @@ -1103,63 +1006,45 @@ module Google execute_or_queue_command(command, &block) end - # Lists database longrunning-operations. - # A database operation has a name of the form - # `projects//instances//databases//operations/< - # operation>`. - # The long-running operation - # metadata field type - # `metadata.type_url` describes the type of the metadata. Operations returned - # include those that have completed/failed/canceled within the last 7 days, - # and pending operations. + # Lists database longrunning-operations. A database operation has a name of the + # form `projects//instances//databases//operations/`. The long-running operation + # metadata field type `metadata.type_url` describes the type of the metadata. + # Operations returned include those that have completed/failed/canceled within + # the last 7 days, and pending operations. # @param [String] parent - # Required. The instance of the database operations. - # Values are of the form `projects//instances/`. + # Required. The instance of the database operations. Values are of the form ` + # projects//instances/`. # @param [String] filter - # An expression that filters the list of returned operations. - # A filter expression consists of a field name, a - # comparison operator, and a value for filtering. - # The value must be a string, a number, or a boolean. The comparison operator - # must be one of: `<`, `>`, `<=`, `>=`, `!=`, `=`, or `:`. - # Colon `:` is the contains operator. Filter rules are not case sensitive. - # The following fields in the Operation - # are eligible for filtering: - # * `name` - The name of the long-running operation - # * `done` - False if the operation is in progress, else true. - # * `metadata.@type` - the type of metadata. For example, the type string - # for RestoreDatabaseMetadata is - # `type.googleapis.com/google.spanner.admin.database.v1. - # RestoreDatabaseMetadata`. - # * `metadata.` - any field in metadata.value. - # * `error` - Error associated with the long-running operation. - # * `response.@type` - the type of response. - # * `response.` - any field in response.value. - # You can combine multiple expressions by enclosing each expression in - # parentheses. By default, expressions are combined with AND logic. However, - # you can specify AND, OR, and NOT logic explicitly. - # Here are a few examples: - # * `done:true` - The operation is complete. - # * `(metadata.@type=type.googleapis.com/google.spanner.admin.database.v1. - # RestoreDatabaseMetadata) AND` \ - # `(metadata.source_type:BACKUP) AND` \ - # `(metadata.backup_info.backup:backup_howl) AND` \ - # `(metadata.name:restored_howl) AND` \ - # `(metadata.progress.start_time < \"2018-03-28T14:50:00Z\") AND` \ - # `(error:*)` - Return operations where: - # * The operation's metadata type is RestoreDatabaseMetadata. - # * The database is restored from a backup. - # * The backup name contains "backup_howl". - # * The restored database's name contains "restored_howl". - # * The operation started before 2018-03-28T14:50:00Z. - # * The operation resulted in an error. + # An expression that filters the list of returned operations. A filter + # expression consists of a field name, a comparison operator, and a value for + # filtering. The value must be a string, a number, or a boolean. The comparison + # operator must be one of: `<`, `>`, `<=`, `>=`, `!=`, `=`, or `:`. Colon `:` is + # the contains operator. Filter rules are not case sensitive. The following + # fields in the Operation are eligible for filtering: * `name` - The name of the + # long-running operation * `done` - False if the operation is in progress, else + # true. * `metadata.@type` - the type of metadata. For example, the type string + # for RestoreDatabaseMetadata is `type.googleapis.com/google.spanner.admin. + # database.v1.RestoreDatabaseMetadata`. * `metadata.` - any field in metadata. + # value. * `error` - Error associated with the long-running operation. * ` + # response.@type` - the type of response. * `response.` - any field in response. + # value. You can combine multiple expressions by enclosing each expression in + # parentheses. By default, expressions are combined with AND logic. However, you + # can specify AND, OR, and NOT logic explicitly. Here are a few examples: * ` + # done:true` - The operation is complete. * `(metadata.@type=type.googleapis.com/ + # google.spanner.admin.database.v1.RestoreDatabaseMetadata) AND` \ `(metadata. + # source_type:BACKUP) AND` \ `(metadata.backup_info.backup:backup_howl) AND` \ `( + # metadata.name:restored_howl) AND` \ `(metadata.progress.start_time < \"2018-03- + # 28T14:50:00Z\") AND` \ `(error:*)` - Return operations where: * The operation' + # s metadata type is RestoreDatabaseMetadata. * The database is restored from a + # backup. * The backup name contains "backup_howl". * The restored database's + # name contains "restored_howl". * The operation started before 2018-03-28T14:50: + # 00Z. * The operation resulted in an error. # @param [Fixnum] page_size - # Number of operations to be returned in the response. If 0 or - # less, defaults to the server's maximum allowed page size. + # Number of operations to be returned in the response. If 0 or less, defaults to + # the server's maximum allowed page size. # @param [String] page_token - # If non-empty, `page_token` should contain a - # next_page_token - # from a previous ListDatabaseOperationsResponse to the - # same `parent` and with the same `filter`. + # If non-empty, `page_token` should contain a next_page_token from a previous + # ListDatabaseOperationsResponse to the same `parent` and with the same `filter`. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -1190,17 +1075,13 @@ module Google execute_or_queue_command(command, &block) end - # Creates a new Cloud Spanner database and starts to prepare it for serving. - # The returned long-running operation will - # have a name of the format `/operations/` and - # can be used to track preparation of the database. The - # metadata field type is - # CreateDatabaseMetadata. The - # response field type is - # Database, if successful. + # Creates a new Cloud Spanner database and starts to prepare it for serving. The + # returned long-running operation will have a name of the format `/operations/` + # and can be used to track preparation of the database. The metadata field type + # is CreateDatabaseMetadata. The response field type is Database, if successful. # @param [String] parent - # Required. The name of the instance that will serve the new database. - # Values are of the form `projects//instances/`. + # Required. The name of the instance that will serve the new database. Values + # are of the form `projects//instances/`. # @param [Google::Apis::SpannerV1::CreateDatabaseRequest] create_database_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -1231,9 +1112,8 @@ module Google execute_or_queue_command(command, &block) end - # Drops (aka deletes) a Cloud Spanner database. - # Completed backups for the database will be retained according to their - # `expire_time`. + # Drops (aka deletes) a Cloud Spanner database. Completed backups for the + # database will be retained according to their `expire_time`. # @param [String] database # Required. The database to be dropped. # @param [String] fields @@ -1265,8 +1145,8 @@ module Google # Gets the state of a Cloud Spanner database. # @param [String] name - # Required. The name of the requested database. Values are of the form - # `projects//instances//databases/`. + # Required. The name of the requested database. Values are of the form `projects/ + # /instances//databases/`. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -1294,13 +1174,12 @@ module Google execute_or_queue_command(command, &block) end - # Returns the schema of a Cloud Spanner database as a list of formatted - # DDL statements. This method does not show pending schema updates, those may - # be queried using the Operations API. + # Returns the schema of a Cloud Spanner database as a list of formatted DDL + # statements. This method does not show pending schema updates, those may be + # queried using the Operations API. # @param [String] database - # Required. The database whose schema we wish to get. - # Values are of the form - # `projects//instances//databases/` + # Required. The database whose schema we wish to get. Values are of the form ` + # projects//instances//databases/` # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -1328,18 +1207,15 @@ module Google execute_or_queue_command(command, &block) end - # Gets the access control policy for a database or backup resource. - # Returns an empty policy if a database or backup exists but does not have a - # policy set. - # Authorization requires `spanner.databases.getIamPolicy` permission on - # resource. - # For backups, authorization requires `spanner.backups.getIamPolicy` - # permission on resource. + # Gets the access control policy for a database or backup resource. Returns an + # empty policy if a database or backup exists but does not have a policy set. + # Authorization requires `spanner.databases.getIamPolicy` permission on resource. + # For backups, authorization requires `spanner.backups.getIamPolicy` permission + # on resource. # @param [String] resource # REQUIRED: The Cloud Spanner resource for which the policy is being retrieved. - # The format is `projects//instances/` for instance - # resources and `projects//instances//databases/< - # database ID>` for database resources. + # The format is `projects//instances/` for instance resources and `projects// + # instances//databases/` for database resources. # @param [Google::Apis::SpannerV1::GetIamPolicyRequest] get_iam_policy_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -1372,15 +1248,14 @@ module Google # Lists Cloud Spanner databases. # @param [String] parent - # Required. The instance whose databases should be listed. - # Values are of the form `projects//instances/`. + # Required. The instance whose databases should be listed. Values are of the + # form `projects//instances/`. # @param [Fixnum] page_size - # Number of databases to be returned in the response. If 0 or less, - # defaults to the server's maximum allowed page size. + # Number of databases to be returned in the response. If 0 or less, defaults to + # the server's maximum allowed page size. # @param [String] page_token - # If non-empty, `page_token` should contain a - # next_page_token from a - # previous ListDatabasesResponse. + # If non-empty, `page_token` should contain a next_page_token from a previous + # ListDatabasesResponse. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -1410,30 +1285,23 @@ module Google execute_or_queue_command(command, &block) end - # Create a new database by restoring from a completed backup. The new - # database must be in the same project and in an instance with the same - # instance configuration as the instance containing - # the backup. The returned database long-running - # operation has a name of the format - # `projects//instances//databases//operations/< - # operation_id>`, - # and can be used to track the progress of the operation, and to cancel it. - # The metadata field type is - # RestoreDatabaseMetadata. - # The response type - # is Database, if - # successful. Cancelling the returned operation will stop the restore and - # delete the database. - # There can be only one database being restored into an instance at a time. - # Once the restore operation completes, a new restore operation can be + # Create a new database by restoring from a completed backup. The new database + # must be in the same project and in an instance with the same instance + # configuration as the instance containing the backup. The returned database + # long-running operation has a name of the format `projects//instances// + # databases//operations/`, and can be used to track the progress of the + # operation, and to cancel it. The metadata field type is + # RestoreDatabaseMetadata. The response type is Database, if successful. + # Cancelling the returned operation will stop the restore and delete the + # database. There can be only one database being restored into an instance at a + # time. Once the restore operation completes, a new restore operation can be # initiated, without waiting for the optimize operation associated with the # first restore to complete. # @param [String] parent - # Required. The name of the instance in which to create the - # restored database. This instance must be in the same project and - # have the same instance configuration as the instance containing - # the source backup. Values are of the form - # `projects//instances/`. + # Required. The name of the instance in which to create the restored database. + # This instance must be in the same project and have the same instance + # configuration as the instance containing the source backup. Values are of the + # form `projects//instances/`. # @param [Google::Apis::SpannerV1::RestoreDatabaseRequest] restore_database_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -1464,17 +1332,14 @@ module Google execute_or_queue_command(command, &block) end - # Sets the access control policy on a database or backup resource. - # Replaces any existing policy. - # Authorization requires `spanner.databases.setIamPolicy` - # permission on resource. - # For backups, authorization requires `spanner.backups.setIamPolicy` - # permission on resource. + # Sets the access control policy on a database or backup resource. Replaces any + # existing policy. Authorization requires `spanner.databases.setIamPolicy` + # permission on resource. For backups, authorization requires `spanner.backups. + # setIamPolicy` permission on resource. # @param [String] resource # REQUIRED: The Cloud Spanner resource for which the policy is being set. The - # format is `projects//instances/` for instance - # resources and `projects//instances//databases/< - # database ID>` for databases resources. + # format is `projects//instances/` for instance resources and `projects// + # instances//databases/` for databases resources. # @param [Google::Apis::SpannerV1::SetIamPolicyRequest] set_iam_policy_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -1506,19 +1371,16 @@ module Google end # Returns permissions that the caller has on the specified database or backup - # resource. - # Attempting this RPC on a non-existent Cloud Spanner database will - # result in a NOT_FOUND error if the user has - # `spanner.databases.list` permission on the containing Cloud - # Spanner instance. Otherwise returns an empty set of permissions. - # Calling this method on a backup that does not exist will - # result in a NOT_FOUND error if the user has - # `spanner.backups.list` permission on the containing instance. + # resource. Attempting this RPC on a non-existent Cloud Spanner database will + # result in a NOT_FOUND error if the user has `spanner.databases.list` + # permission on the containing Cloud Spanner instance. Otherwise returns an + # empty set of permissions. Calling this method on a backup that does not exist + # will result in a NOT_FOUND error if the user has `spanner.backups.list` + # permission on the containing instance. # @param [String] resource # REQUIRED: The Cloud Spanner resource for which permissions are being tested. - # The format is `projects//instances/` for instance - # resources and `projects//instances//databases/< - # database ID>` for database resources. + # The format is `projects//instances/` for instance resources and `projects// + # instances//databases/` for database resources. # @param [Google::Apis::SpannerV1::TestIamPermissionsRequest] test_iam_permissions_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -1549,13 +1411,11 @@ module Google execute_or_queue_command(command, &block) end - # Updates the schema of a Cloud Spanner database by - # creating/altering/dropping tables, columns, indexes, etc. The returned - # long-running operation will have a name of - # the format `/operations/` and can be used to - # track execution of the schema change(s). The - # metadata field type is - # UpdateDatabaseDdlMetadata. The operation has no response. + # Updates the schema of a Cloud Spanner database by creating/altering/dropping + # tables, columns, indexes, etc. The returned long-running operation will have a + # name of the format `/operations/` and can be used to track execution of the + # schema change(s). The metadata field type is UpdateDatabaseDdlMetadata. The + # operation has no response. # @param [String] database # Required. The database to update. # @param [Google::Apis::SpannerV1::UpdateDatabaseDdlRequest] update_database_ddl_request_object @@ -1588,15 +1448,13 @@ module Google execute_or_queue_command(command, &block) end - # Starts asynchronous cancellation on a long-running operation. The server - # makes a best effort to cancel the operation, but success is not - # guaranteed. If the server doesn't support this method, it returns - # `google.rpc.Code.UNIMPLEMENTED`. Clients can use - # Operations.GetOperation or - # other methods to check whether the cancellation succeeded or whether the - # operation completed despite cancellation. On successful cancellation, - # the operation is not deleted; instead, it becomes an operation with - # an Operation.error value with a google.rpc.Status.code of 1, + # Starts asynchronous cancellation on a long-running operation. The server makes + # a best effort to cancel the operation, but success is not guaranteed. If the + # server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. + # Clients can use Operations.GetOperation or other methods to check whether the + # cancellation succeeded or whether the operation completed despite cancellation. + # On successful cancellation, the operation is not deleted; instead, it becomes + # an operation with an Operation.error value with a google.rpc.Status.code of 1, # corresponding to `Code.CANCELLED`. # @param [String] name # The name of the operation resource to be cancelled. @@ -1627,10 +1485,10 @@ module Google execute_or_queue_command(command, &block) end - # Deletes a long-running operation. This method indicates that the client is - # no longer interested in the operation result. It does not cancel the - # operation. If the server doesn't support this method, it returns - # `google.rpc.Code.UNIMPLEMENTED`. + # Deletes a long-running operation. This method indicates that the client is no + # longer interested in the operation result. It does not cancel the operation. + # If the server doesn't support this method, it returns `google.rpc.Code. + # UNIMPLEMENTED`. # @param [String] name # The name of the operation resource to be deleted. # @param [String] fields @@ -1660,9 +1518,8 @@ module Google execute_or_queue_command(command, &block) end - # Gets the latest state of a long-running operation. Clients can use this - # method to poll the operation result at intervals as recommended by the API - # service. + # Gets the latest state of a long-running operation. Clients can use this method + # to poll the operation result at intervals as recommended by the API service. # @param [String] name # The name of the operation resource. # @param [String] fields @@ -1692,15 +1549,14 @@ module Google execute_or_queue_command(command, &block) end - # Lists operations that match the specified filter in the request. If the - # server doesn't support this method, it returns `UNIMPLEMENTED`. - # NOTE: the `name` binding allows API services to override the binding - # to use different resource name schemes, such as `users/*/operations`. To - # override the binding, API services can add a binding such as - # `"/v1/`name=users/*`/operations"` to their service configuration. - # For backwards compatibility, the default name includes the operations - # collection id, however overriding users must ensure the name binding - # is the parent resource, without the operations collection id. + # Lists operations that match the specified filter in the request. If the server + # doesn't support this method, it returns `UNIMPLEMENTED`. NOTE: the `name` + # binding allows API services to override the binding to use different resource + # name schemes, such as `users/*/operations`. To override the binding, API + # services can add a binding such as `"/v1/`name=users/*`/operations"` to their + # service configuration. For backwards compatibility, the default name includes + # the operations collection id, however overriding users must ensure the name + # binding is the parent resource, without the operations collection id. # @param [String] name # The name of the operation's parent resource. # @param [String] filter @@ -1739,9 +1595,9 @@ module Google execute_or_queue_command(command, &block) end - # Creates multiple new sessions. - # This API can be used to initialize a session cache on the clients. - # See https://goo.gl/TgSFN2 for best practices on session cache management. + # Creates multiple new sessions. This API can be used to initialize a session + # cache on the clients. See https://goo.gl/TgSFN2 for best practices on session + # cache management. # @param [String] database # Required. The database in which the new sessions are created. # @param [Google::Apis::SpannerV1::BatchCreateSessionsRequest] batch_create_sessions_request_object @@ -1774,10 +1630,8 @@ module Google execute_or_queue_command(command, &block) end - # Begins a new transaction. This step can often be skipped: - # Read, ExecuteSql and - # Commit can begin a new transaction as a - # side-effect. + # Begins a new transaction. This step can often be skipped: Read, ExecuteSql and + # Commit can begin a new transaction as a side-effect. # @param [String] session # Required. The session in which the transaction runs. # @param [Google::Apis::SpannerV1::BeginTransactionRequest] begin_transaction_request_object @@ -1810,18 +1664,16 @@ module Google execute_or_queue_command(command, &block) end - # Commits a transaction. The request includes the mutations to be - # applied to rows in the database. - # `Commit` might return an `ABORTED` error. This can occur at any time; - # commonly, the cause is conflicts with concurrent - # transactions. However, it can also happen for a variety of other - # reasons. If `Commit` returns `ABORTED`, the caller should re-attempt - # the transaction from the beginning, re-using the same session. - # On very rare occasions, `Commit` might return `UNKNOWN`. This can happen, - # for example, if the client job experiences a 1+ hour networking failure. - # At that point, Cloud Spanner has lost track of the transaction outcome and - # we recommend that you perform another read from the database to see the - # state of things as they are now. + # Commits a transaction. The request includes the mutations to be applied to + # rows in the database. `Commit` might return an `ABORTED` error. This can occur + # at any time; commonly, the cause is conflicts with concurrent transactions. + # However, it can also happen for a variety of other reasons. If `Commit` + # returns `ABORTED`, the caller should re-attempt the transaction from the + # beginning, re-using the same session. On very rare occasions, `Commit` might + # return `UNKNOWN`. This can happen, for example, if the client job experiences + # a 1+ hour networking failure. At that point, Cloud Spanner has lost track of + # the transaction outcome and we recommend that you perform another read from + # the database to see the state of things as they are now. # @param [String] session # Required. The session in which the transaction to be committed is running. # @param [Google::Apis::SpannerV1::CommitRequest] commit_request_object @@ -1854,22 +1706,17 @@ module Google execute_or_queue_command(command, &block) end - # Creates a new session. A session can be used to perform - # transactions that read and/or modify data in a Cloud Spanner database. - # Sessions are meant to be reused for many consecutive - # transactions. - # Sessions can only execute one transaction at a time. To execute - # multiple concurrent read-write/write-only transactions, create - # multiple sessions. Note that standalone reads and queries use a - # transaction internally, and count toward the one transaction - # limit. + # Creates a new session. A session can be used to perform transactions that read + # and/or modify data in a Cloud Spanner database. Sessions are meant to be + # reused for many consecutive transactions. Sessions can only execute one + # transaction at a time. To execute multiple concurrent read-write/write-only + # transactions, create multiple sessions. Note that standalone reads and queries + # use a transaction internally, and count toward the one transaction limit. # Active sessions use additional server resources, so it is a good idea to - # delete idle and unneeded sessions. - # Aside from explicit deletes, Cloud Spanner may delete sessions for which no - # operations are sent for more than an hour. If a session is deleted, - # requests to it return `NOT_FOUND`. - # Idle sessions can be kept alive by sending a trivial SQL query - # periodically, e.g., `"SELECT 1"`. + # delete idle and unneeded sessions. Aside from explicit deletes, Cloud Spanner + # may delete sessions for which no operations are sent for more than an hour. If + # a session is deleted, requests to it return `NOT_FOUND`. Idle sessions can be + # kept alive by sending a trivial SQL query periodically, e.g., `"SELECT 1"`. # @param [String] database # Required. The database in which the new session is created. # @param [Google::Apis::SpannerV1::CreateSessionRequest] create_session_request_object @@ -1934,15 +1781,13 @@ module Google execute_or_queue_command(command, &block) end - # Executes a batch of SQL DML statements. This method allows many statements - # to be run with lower latency than submitting them sequentially with - # ExecuteSql. - # Statements are executed in sequential order. A request can succeed even if - # a statement fails. The ExecuteBatchDmlResponse.status field in the - # response provides information about the statement that failed. Clients must - # inspect this field to determine whether an error occurred. - # Execution stops after the first failed statement; the remaining statements - # are not executed. + # Executes a batch of SQL DML statements. This method allows many statements to + # be run with lower latency than submitting them sequentially with ExecuteSql. + # Statements are executed in sequential order. A request can succeed even if a + # statement fails. The ExecuteBatchDmlResponse.status field in the response + # provides information about the statement that failed. Clients must inspect + # this field to determine whether an error occurred. Execution stops after the + # first failed statement; the remaining statements are not executed. # @param [String] session # Required. The session in which the DML statements should be performed. # @param [Google::Apis::SpannerV1::ExecuteBatchDmlRequest] execute_batch_dml_request_object @@ -1976,14 +1821,12 @@ module Google end # Executes an SQL statement, returning all results in a single reply. This - # method cannot be used to return a result set larger than 10 MiB; - # if the query yields more data than that, the query fails with - # a `FAILED_PRECONDITION` error. - # Operations inside read-write transactions might return `ABORTED`. If - # this occurs, the application should restart the transaction from - # the beginning. See Transaction for more details. - # Larger result sets can be fetched in streaming fashion by calling - # ExecuteStreamingSql instead. + # method cannot be used to return a result set larger than 10 MiB; if the query + # yields more data than that, the query fails with a `FAILED_PRECONDITION` error. + # Operations inside read-write transactions might return `ABORTED`. If this + # occurs, the application should restart the transaction from the beginning. See + # Transaction for more details. Larger result sets can be fetched in streaming + # fashion by calling ExecuteStreamingSql instead. # @param [String] session # Required. The session in which the SQL query should be performed. # @param [Google::Apis::SpannerV1::ExecuteSqlRequest] execute_sql_request_object @@ -2016,11 +1859,10 @@ module Google execute_or_queue_command(command, &block) end - # Like ExecuteSql, except returns the result - # set as a stream. Unlike ExecuteSql, there - # is no limit on the size of the returned result set. However, no - # individual row in the result set can exceed 100 MiB, and no - # column value can exceed 10 MiB. + # Like ExecuteSql, except returns the result set as a stream. Unlike ExecuteSql, + # there is no limit on the size of the returned result set. However, no + # individual row in the result set can exceed 100 MiB, and no column value can + # exceed 10 MiB. # @param [String] session # Required. The session in which the SQL query should be performed. # @param [Google::Apis::SpannerV1::ExecuteSqlRequest] execute_sql_request_object @@ -2053,9 +1895,8 @@ module Google execute_or_queue_command(command, &block) end - # Gets a session. Returns `NOT_FOUND` if the session does not exist. - # This is mainly useful for determining whether a session is still - # alive. + # Gets a session. Returns `NOT_FOUND` if the session does not exist. This is + # mainly useful for determining whether a session is still alive. # @param [String] name # Required. The name of the session to retrieve. # @param [String] fields @@ -2089,19 +1930,16 @@ module Google # @param [String] database # Required. The database in which to list sessions. # @param [String] filter - # An expression for filtering the results of the request. Filter rules are - # case insensitive. The fields eligible for filtering are: - # * `labels.key` where key is the name of a label - # Some examples of using filters are: - # * `labels.env:*` --> The session has the label "env". - # * `labels.env:dev` --> The session has the label "env" and the value of - # the label contains the string "dev". + # An expression for filtering the results of the request. Filter rules are case + # insensitive. The fields eligible for filtering are: * `labels.key` where key + # is the name of a label Some examples of using filters are: * `labels.env:*` --> + # The session has the label "env". * `labels.env:dev` --> The session has the + # label "env" and the value of the label contains the string "dev". # @param [Fixnum] page_size - # Number of sessions to be returned in the response. If 0 or less, defaults - # to the server's maximum allowed page size. + # Number of sessions to be returned in the response. If 0 or less, defaults to + # the server's maximum allowed page size. # @param [String] page_token - # If non-empty, `page_token` should contain a - # next_page_token from a previous + # If non-empty, `page_token` should contain a next_page_token from a previous # ListSessionsResponse. # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -2134,15 +1972,14 @@ module Google end # Creates a set of partition tokens that can be used to execute a query - # operation in parallel. Each of the returned partition tokens can be used - # by ExecuteStreamingSql to specify a subset - # of the query result to read. The same session and read-only transaction - # must be used by the PartitionQueryRequest used to create the - # partition tokens and the ExecuteSqlRequests that use the partition tokens. - # Partition tokens become invalid when the session used to create them - # is deleted, is idle for too long, begins a new transaction, or becomes too - # old. When any of these happen, it is not possible to resume the query, and - # the whole operation must be restarted from the beginning. + # operation in parallel. Each of the returned partition tokens can be used by + # ExecuteStreamingSql to specify a subset of the query result to read. The same + # session and read-only transaction must be used by the PartitionQueryRequest + # used to create the partition tokens and the ExecuteSqlRequests that use the + # partition tokens. Partition tokens become invalid when the session used to + # create them is deleted, is idle for too long, begins a new transaction, or + # becomes too old. When any of these happen, it is not possible to resume the + # query, and the whole operation must be restarted from the beginning. # @param [String] session # Required. The session used to create the partitions. # @param [Google::Apis::SpannerV1::PartitionQueryRequest] partition_query_request_object @@ -2175,18 +2012,17 @@ module Google execute_or_queue_command(command, &block) end - # Creates a set of partition tokens that can be used to execute a read - # operation in parallel. Each of the returned partition tokens can be used - # by StreamingRead to specify a subset of the read - # result to read. The same session and read-only transaction must be used by - # the PartitionReadRequest used to create the partition tokens and the - # ReadRequests that use the partition tokens. There are no ordering - # guarantees on rows returned among the returned partition tokens, or even - # within each individual StreamingRead call issued with a partition_token. - # Partition tokens become invalid when the session used to create them - # is deleted, is idle for too long, begins a new transaction, or becomes too - # old. When any of these happen, it is not possible to resume the read, and - # the whole operation must be restarted from the beginning. + # Creates a set of partition tokens that can be used to execute a read operation + # in parallel. Each of the returned partition tokens can be used by + # StreamingRead to specify a subset of the read result to read. The same session + # and read-only transaction must be used by the PartitionReadRequest used to + # create the partition tokens and the ReadRequests that use the partition tokens. + # There are no ordering guarantees on rows returned among the returned + # partition tokens, or even within each individual StreamingRead call issued + # with a partition_token. Partition tokens become invalid when the session used + # to create them is deleted, is idle for too long, begins a new transaction, or + # becomes too old. When any of these happen, it is not possible to resume the + # read, and the whole operation must be restarted from the beginning. # @param [String] session # Required. The session used to create the partitions. # @param [Google::Apis::SpannerV1::PartitionReadRequest] partition_read_request_object @@ -2219,15 +2055,12 @@ module Google execute_or_queue_command(command, &block) end - # Reads rows from the database using key lookups and scans, as a - # simple key/value style alternative to - # ExecuteSql. This method cannot be used to - # return a result set larger than 10 MiB; if the read matches more - # data than that, the read fails with a `FAILED_PRECONDITION` - # error. - # Reads inside read-write transactions might return `ABORTED`. If - # this occurs, the application should restart the transaction from - # the beginning. See Transaction for more details. + # Reads rows from the database using key lookups and scans, as a simple key/ + # value style alternative to ExecuteSql. This method cannot be used to return a + # result set larger than 10 MiB; if the read matches more data than that, the + # read fails with a `FAILED_PRECONDITION` error. Reads inside read-write + # transactions might return `ABORTED`. If this occurs, the application should + # restart the transaction from the beginning. See Transaction for more details. # Larger result sets can be yielded in streaming fashion by calling # StreamingRead instead. # @param [String] session @@ -2262,13 +2095,11 @@ module Google execute_or_queue_command(command, &block) end - # Rolls back a transaction, releasing any locks it holds. It is a good - # idea to call this for any transaction that includes one or more - # Read or ExecuteSql requests and - # ultimately decides not to commit. - # `Rollback` returns `OK` if it successfully aborts the transaction, the - # transaction was already aborted, or the transaction is not - # found. `Rollback` never returns `ABORTED`. + # Rolls back a transaction, releasing any locks it holds. It is a good idea to + # call this for any transaction that includes one or more Read or ExecuteSql + # requests and ultimately decides not to commit. `Rollback` returns `OK` if it + # successfully aborts the transaction, the transaction was already aborted, or + # the transaction is not found. `Rollback` never returns `ABORTED`. # @param [String] session # Required. The session in which the transaction to roll back is running. # @param [Google::Apis::SpannerV1::RollbackRequest] rollback_request_object @@ -2301,11 +2132,9 @@ module Google execute_or_queue_command(command, &block) end - # Like Read, except returns the result set as a - # stream. Unlike Read, there is no limit on the - # size of the returned result set. However, no individual row in - # the result set can exceed 100 MiB, and no column value can exceed - # 10 MiB. + # Like Read, except returns the result set as a stream. Unlike Read, there is no + # limit on the size of the returned result set. However, no individual row in + # the result set can exceed 100 MiB, and no column value can exceed 10 MiB. # @param [String] session # Required. The session in which the read should be performed. # @param [Google::Apis::SpannerV1::ReadRequest] read_request_object @@ -2338,15 +2167,13 @@ module Google execute_or_queue_command(command, &block) end - # Starts asynchronous cancellation on a long-running operation. The server - # makes a best effort to cancel the operation, but success is not - # guaranteed. If the server doesn't support this method, it returns - # `google.rpc.Code.UNIMPLEMENTED`. Clients can use - # Operations.GetOperation or - # other methods to check whether the cancellation succeeded or whether the - # operation completed despite cancellation. On successful cancellation, - # the operation is not deleted; instead, it becomes an operation with - # an Operation.error value with a google.rpc.Status.code of 1, + # Starts asynchronous cancellation on a long-running operation. The server makes + # a best effort to cancel the operation, but success is not guaranteed. If the + # server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. + # Clients can use Operations.GetOperation or other methods to check whether the + # cancellation succeeded or whether the operation completed despite cancellation. + # On successful cancellation, the operation is not deleted; instead, it becomes + # an operation with an Operation.error value with a google.rpc.Status.code of 1, # corresponding to `Code.CANCELLED`. # @param [String] name # The name of the operation resource to be cancelled. @@ -2377,10 +2204,10 @@ module Google execute_or_queue_command(command, &block) end - # Deletes a long-running operation. This method indicates that the client is - # no longer interested in the operation result. It does not cancel the - # operation. If the server doesn't support this method, it returns - # `google.rpc.Code.UNIMPLEMENTED`. + # Deletes a long-running operation. This method indicates that the client is no + # longer interested in the operation result. It does not cancel the operation. + # If the server doesn't support this method, it returns `google.rpc.Code. + # UNIMPLEMENTED`. # @param [String] name # The name of the operation resource to be deleted. # @param [String] fields @@ -2410,9 +2237,8 @@ module Google execute_or_queue_command(command, &block) end - # Gets the latest state of a long-running operation. Clients can use this - # method to poll the operation result at intervals as recommended by the API - # service. + # Gets the latest state of a long-running operation. Clients can use this method + # to poll the operation result at intervals as recommended by the API service. # @param [String] name # The name of the operation resource. # @param [String] fields @@ -2442,15 +2268,14 @@ module Google execute_or_queue_command(command, &block) end - # Lists operations that match the specified filter in the request. If the - # server doesn't support this method, it returns `UNIMPLEMENTED`. - # NOTE: the `name` binding allows API services to override the binding - # to use different resource name schemes, such as `users/*/operations`. To - # override the binding, API services can add a binding such as - # `"/v1/`name=users/*`/operations"` to their service configuration. - # For backwards compatibility, the default name includes the operations - # collection id, however overriding users must ensure the name binding - # is the parent resource, without the operations collection id. + # Lists operations that match the specified filter in the request. If the server + # doesn't support this method, it returns `UNIMPLEMENTED`. NOTE: the `name` + # binding allows API services to override the binding to use different resource + # name schemes, such as `users/*/operations`. To override the binding, API + # services can add a binding such as `"/v1/`name=users/*`/operations"` to their + # service configuration. For backwards compatibility, the default name includes + # the operations collection id, however overriding users must ensure the name + # binding is the parent resource, without the operations collection id. # @param [String] name # The name of the operation's parent resource. # @param [String] filter diff --git a/generated/google/apis/sql_v1beta4.rb b/generated/google/apis/sql_v1beta4.rb index a0b5385df..3a18b0e5a 100644 --- a/generated/google/apis/sql_v1beta4.rb +++ b/generated/google/apis/sql_v1beta4.rb @@ -25,7 +25,7 @@ module Google # @see https://developers.google.com/cloud-sql/ module SqlV1beta4 VERSION = 'V1beta4' - REVISION = '20200728' + REVISION = '20200805' # 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/sql_v1beta4/classes.rb b/generated/google/apis/sql_v1beta4/classes.rb index 389106fb1..fb33fe762 100644 --- a/generated/google/apis/sql_v1beta4/classes.rb +++ b/generated/google/apis/sql_v1beta4/classes.rb @@ -26,14 +26,13 @@ module Google class AclEntry include Google::Apis::Core::Hashable - # The time when this access control entry expires in RFC 3339 format, for example - # 2012-11-15T16:19:00.094Z. + # The time when this access control entry expires in RFC 3339 format, for + # example *2012-11-15T16:19:00.094Z*. # Corresponds to the JSON property `expirationTime` # @return [String] attr_accessor :expiration_time - # This is always sql#aclEntry. + # This is always *sql#aclEntry*. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind @@ -103,7 +102,7 @@ module Google attr_accessor :enabled alias_method :enabled?, :enabled - # This is always sql#backupConfiguration. + # This is always *sql#backupConfiguration*. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind @@ -125,8 +124,8 @@ module Google attr_accessor :replication_log_archiving_enabled alias_method :replication_log_archiving_enabled?, :replication_log_archiving_enabled - # Start time for the daily backup configuration in UTC timezone in the 24 - # hour format - HH:MM. + # Start time for the daily backup configuration in UTC timezone in the 24 hour + # format - *HH:MM*. # Corresponds to the JSON property `startTime` # @return [String] attr_accessor :start_time @@ -171,16 +170,14 @@ module Google # @return [Google::Apis::SqlV1beta4::DiskEncryptionStatus] attr_accessor :disk_encryption_status - # The time the backup operation completed in UTC timezone in RFC 3339 format, for example - # 2012-11-15T16:19:00.094Z. + # The time the backup operation completed in UTC timezone in RFC 3339 format, + # for example *2012-11-15T16:19:00.094Z*. # Corresponds to the JSON property `endTime` # @return [String] attr_accessor :end_time - # The time the run was enqueued in UTC timezone in RFC 3339 format, for example - # 2012-11-15T16:19:00.094Z. + # The time the run was enqueued in UTC timezone in RFC 3339 format, for example * + # 2012-11-15T16:19:00.094Z*. # Corresponds to the JSON property `enqueuedTime` # @return [String] attr_accessor :enqueued_time @@ -201,7 +198,7 @@ module Google # @return [String] attr_accessor :instance - # This is always sql#backupRun. + # This is always *sql#backupRun*. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind @@ -216,9 +213,8 @@ module Google # @return [String] attr_accessor :self_link - # The time the backup operation actually started in UTC timezone in RFC 3339 format, for example - # 2012-11-15T16:19:00.094Z. + # The time the backup operation actually started in UTC timezone in RFC 3339 + # format, for example *2012-11-15T16:19:00.094Z*. # Corresponds to the JSON property `startTime` # @return [String] attr_accessor :start_time @@ -233,9 +229,8 @@ module Google # @return [String] attr_accessor :type - # The start time of the backup window during which this the backup was - # attempted in RFC 3339 - # format, for example 2012-11-15T16:19:00.094Z. + # The start time of the backup window during which this the backup was attempted + # in RFC 3339 format, for example *2012-11-15T16:19:00.094Z*. # Corresponds to the JSON property `windowStartTime` # @return [String] attr_accessor :window_start_time @@ -274,13 +269,13 @@ module Google # @return [Array] attr_accessor :items - # This is always sql#backupRunsList. + # This is always *sql#backupRunsList*. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind - # The continuation token, used to page through large result sets. Provide - # this value in a subsequent request to return the next page of results. + # The continuation token, used to page through large result sets. Provide this + # value in a subsequent request to return the next page of results. # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token @@ -311,7 +306,7 @@ module Google # @return [Fixnum] attr_accessor :bin_log_position - # This is always sql#binLogCoordinates. + # This is always *sql#binLogCoordinates*. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind @@ -342,7 +337,7 @@ module Google # @return [String] attr_accessor :destination_instance_name - # This is always sql#cloneContext. + # This is always *sql#cloneContext*. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind @@ -385,8 +380,7 @@ module Google # @return [String] attr_accessor :collation - # This field is deprecated and will be removed from a future version of the - # API. + # This field is deprecated and will be removed from a future version of the API. # Corresponds to the JSON property `etag` # @return [String] attr_accessor :etag @@ -396,13 +390,13 @@ module Google # @return [String] attr_accessor :instance - # This is always sql#database. + # This is always *sql#database*. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind - # The name of the database in the Cloud SQL instance. This does not include - # the project ID or instance name. + # The name of the database in the Cloud SQL instance. This does not include the + # project ID or instance name. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name @@ -445,18 +439,16 @@ module Google class DatabaseFlags include Google::Apis::Core::Hashable - # The name of the flag. These flags are passed at instance startup, so - # include both server options and system variables for MySQL. Flags are - # specified with underscores, not hyphens. For more information, see Configuring Database Flags in the Cloud - # SQL documentation. + # The name of the flag. These flags are passed at instance startup, so include + # both server options and system variables for MySQL. Flags are specified with + # underscores, not hyphens. For more information, see Configuring Database Flags + # in the Cloud SQL documentation. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name - # The value of the flag. Booleans are set to on for true - # and off for false. This field must be omitted if the flag - # doesn't take a value. + # The value of the flag. Booleans are set to *on* for true and *off* for false. + # This field must be omitted if the flag doesn't take a value. # Corresponds to the JSON property `value` # @return [String] attr_accessor :value @@ -472,16 +464,13 @@ module Google end end - # A Cloud SQL instance resource. - # Next field: 34 + # A Cloud SQL instance resource. Next field: 34 class DatabaseInstance include Google::Apis::Core::Hashable - #
SECOND_GEN: Cloud SQL database instance. - #
EXTERNAL: A database server that is not - # managed by Google.
This property is read-only; use the - # tier property in the settings object to determine - # the database type. + # *SECOND_GEN*: Cloud SQL database instance. *EXTERNAL*: A database server that + # is not managed by Google. This property is read-only; use the *tier* property + # in the *settings* object to determine the database type. # Corresponds to the JSON property `backendType` # @return [String] attr_accessor :backend_type @@ -492,24 +481,18 @@ module Google attr_accessor :connection_name # The current disk usage of the instance in bytes. This property has been - # deprecated. Use the - # "cloudsql.googleapis.com/database/disk/bytes_used" metric in Cloud - # Monitoring API instead. Please see this - # announcement for details. + # deprecated. Use the "cloudsql.googleapis.com/database/disk/bytes_used" metric + # in Cloud Monitoring API instead. Please see this announcement for details. # Corresponds to the JSON property `currentDiskSize` # @return [Fixnum] attr_accessor :current_disk_size - # The database engine type and version. The databaseVersion - # field cannot be changed after instance creation. - #
MySQL instances: MYSQL_5_7 (default), or MYSQL_5_6. - #
PostgreSQL instances: POSTGRES_9_6 (default), or - # POSTGRES_10, or POSTGRES_11 Beta, or POSTGRES_12. - #
SQL Server instances: SQLSERVER_2017_STANDARD (default), - # SQLSERVER_2017_ENTERPRISE, SQLSERVER_2017_EXPRESS, or - # SQLSERVER_2017_WEB. + # The database engine type and version. The *databaseVersion* field cannot be + # changed after instance creation. MySQL instances: *MYSQL_5_7* (default), or * + # MYSQL_5_6*. PostgreSQL instances: *POSTGRES_9_6*, *POSTGRES_10*, *POSTGRES_11* + # or *POSTGRES_12* (default). SQL Server instances: *SQLSERVER_2017_STANDARD* ( + # default), *SQLSERVER_2017_ENTERPRISE*, *SQLSERVER_2017_EXPRESS*, or * + # SQLSERVER_2017_WEB*. # Corresponds to the JSON property `databaseVersion` # @return [String] attr_accessor :database_version @@ -524,14 +507,14 @@ module Google # @return [Google::Apis::SqlV1beta4::DiskEncryptionStatus] attr_accessor :disk_encryption_status - # This field is deprecated and will be removed from a future version of the - # API. Use the settings.settingsVersion field instead. + # This field is deprecated and will be removed from a future version of the API. + # Use the *settings.settingsVersion* field instead. # Corresponds to the JSON property `etag` # @return [String] attr_accessor :etag - # The name and status of the failover replica. This property is applicable - # only to Second Generation instances. + # The name and status of the failover replica. This property is applicable only + # to Second Generation instances. # Corresponds to the JSON property `failoverReplica` # @return [Google::Apis::SqlV1beta4::DatabaseInstance::FailoverReplica] attr_accessor :failover_replica @@ -543,11 +526,10 @@ module Google # @return [String] attr_accessor :gce_zone - # The instance type. This can be one of the following. - #
CLOUD_SQL_INSTANCE: A Cloud SQL instance that is not replicating - # from a master.
ON_PREMISES_INSTANCE: An instance running on the - # customer's premises.
READ_REPLICA_INSTANCE: A Cloud SQL instance - # configured as a read-replica. + # The instance type. This can be one of the following. *CLOUD_SQL_INSTANCE*: A + # Cloud SQL instance that is not replicating from a master. * + # ON_PREMISES_INSTANCE*: An instance running on the customer's premises. * + # READ_REPLICA_INSTANCE*: A Cloud SQL instance configured as a read-replica. # Corresponds to the JSON property `instanceType` # @return [String] attr_accessor :instance_type @@ -557,14 +539,13 @@ module Google # @return [Array] attr_accessor :ip_addresses - # The IPv6 address assigned to the instance. - # (Deprecated) This property was applicable only - # to First Generation instances. + # The IPv6 address assigned to the instance. (Deprecated) This property was + # applicable only to First Generation instances. # Corresponds to the JSON property `ipv6Address` # @return [String] attr_accessor :ipv6_address - # This is always sql#instance. + # This is always *sql#instance*. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind @@ -595,13 +576,10 @@ module Google # @return [String] attr_accessor :project - # The geographical region. Can be - #
us-central (FIRST_GEN instances only) - #
us-central1 (SECOND_GEN instances only) - #
asia-east1 or europe-west1. - #
Defaults to us-central or - # us-central1 depending on the instance type. - # The region cannot be changed after instance creation. + # The geographical region. Can be *us-central* (*FIRST_GEN* instances only) *us- + # central1* (*SECOND_GEN* instances only) *asia-east1* or *europe-west1*. + # Defaults to *us-central* or *us-central1* depending on the instance type. The + # region cannot be changed after instance creation. # Corresponds to the JSON property `region` # @return [String] attr_accessor :region @@ -636,8 +614,8 @@ module Google # @return [Google::Apis::SqlV1beta4::SslCert] attr_accessor :server_ca_cert - # The service account email address assigned to the instance. This property - # is applicable only to Second Generation instances. + # The service account email address assigned to the instance. This property is + # applicable only to Second Generation instances. # Corresponds to the JSON property `serviceAccountEmailAddress` # @return [String] attr_accessor :service_account_email_address @@ -648,13 +626,11 @@ module Google attr_accessor :settings # The current serving state of the Cloud SQL instance. This can be one of the - # following.
RUNNABLE: The instance is running, or is ready - # to run when accessed.
SUSPENDED: The instance is not - # available, for example due to problems with billing. - #
PENDING_CREATE: The instance is being created. - #
MAINTENANCE: The instance is down for maintenance. - #
FAILED: The instance creation failed. - #
UNKNOWN_STATE: The state of the instance is unknown. + # following. *RUNNABLE*: The instance is running, or is ready to run when + # accessed. *SUSPENDED*: The instance is not available, for example due to + # problems with billing. *PENDING_CREATE*: The instance is being created. * + # MAINTENANCE*: The instance is down for maintenance. *FAILED*: The instance + # creation failed. *UNKNOWN_STATE*: The state of the instance is unknown. # Corresponds to the JSON property `state` # @return [String] attr_accessor :state @@ -701,23 +677,22 @@ module Google @suspension_reason = args[:suspension_reason] if args.key?(:suspension_reason) end - # The name and status of the failover replica. This property is applicable - # only to Second Generation instances. + # The name and status of the failover replica. This property is applicable only + # to Second Generation instances. class FailoverReplica include Google::Apis::Core::Hashable - # The availability status of the failover replica. A false status indicates - # that the failover replica is out of sync. The master can only failover to - # the failover replica when the status is true. + # The availability status of the failover replica. A false status indicates that + # the failover replica is out of sync. The master can only failover to the + # failover replica when the status is true. # Corresponds to the JSON property `available` # @return [Boolean] attr_accessor :available alias_method :available?, :available # The name of the failover replica. If specified at instance creation, a - # failover replica is created for the instance. The name - # doesn't include the project ID. This property is applicable only to - # Second Generation instances. + # failover replica is created for the instance. The name doesn't include the + # project ID. This property is applicable only to Second Generation instances. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name @@ -743,7 +718,7 @@ module Google # @return [Array] attr_accessor :items - # This is always sql#databasesList. + # This is always *sql#databasesList*. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind @@ -763,7 +738,7 @@ module Google class DemoteMasterConfiguration include Google::Apis::Core::Hashable - # This is always sql#demoteMasterConfiguration. + # This is always *sql#demoteMasterConfiguration*. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind @@ -788,7 +763,7 @@ module Google class DemoteMasterContext include Google::Apis::Core::Hashable - # This is always sql#demoteMasterContext. + # This is always *sql#demoteMasterContext*. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind @@ -804,13 +779,13 @@ module Google # @return [Google::Apis::SqlV1beta4::DemoteMasterConfiguration] attr_accessor :replica_configuration - # Verify GTID consistency for demote operation. Default value: - # True. Second Generation instances only. Setting this flag to - # false enables you to bypass GTID consistency check between on-premises - # master and Cloud SQL instance during the demotion operation but also - # exposes you to the risk of future replication failures. Change the value - # only if you know the reason for the GTID divergence and are confident that - # doing so will not cause any replication issues. + # Verify GTID consistency for demote operation. Default value: *True*. Second + # Generation instances only. Setting this flag to false enables you to bypass + # GTID consistency check between on-premises master and Cloud SQL instance + # during the demotion operation but also exposes you to the risk of future + # replication failures. Change the value only if you know the reason for the + # GTID divergence and are confident that doing so will not cause any replication + # issues. # Corresponds to the JSON property `verifyGtidConsistency` # @return [Boolean] attr_accessor :verify_gtid_consistency @@ -843,14 +818,14 @@ module Google # @return [String] attr_accessor :client_certificate - # PEM representation of the replica's private key. The corresponsing public - # key is encoded in the client's certificate. The format of the replica's - # private key can be either PKCS #1 or PKCS #8. + # PEM representation of the replica's private key. The corresponsing public key + # is encoded in the client's certificate. The format of the replica's private + # key can be either PKCS #1 or PKCS #8. # Corresponds to the JSON property `clientKey` # @return [String] attr_accessor :client_key - # This is always sql#demoteMasterMysqlReplicaConfiguration. + # This is always *sql#demoteMasterMysqlReplicaConfiguration*. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind @@ -884,7 +859,7 @@ module Google class DiskEncryptionConfiguration include Google::Apis::Core::Hashable - # This is always sql#diskEncryptionConfiguration. + # This is always *sql#diskEncryptionConfiguration*. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind @@ -909,7 +884,7 @@ module Google class DiskEncryptionStatus include Google::Apis::Core::Hashable - # This is always sql#diskEncryptionStatus. + # This is always *sql#diskEncryptionStatus*. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind @@ -939,42 +914,43 @@ module Google # @return [Google::Apis::SqlV1beta4::ExportContext::CsvExportOptions] attr_accessor :csv_export_options - # Databases to be exported.
MySQL instances: If - # fileType is SQL and no database is specified, all - # databases are exported, except for the mysql system database. - # If fileType is CSV, you can specify one database, - # either by using this property or by using the - # csvExportOptions.selectQuery property, which takes precedence - # over this property.
PostgreSQL instances: You must specify - # one database to be exported. If fileType is CSV, - # this database must match the one specified in the - # csvExportOptions.selectQuery property. + # Databases to be exported. *MySQL instances:* If *fileType* is *SQL* and no + # database is specified, all databases are exported, except for the *mysql* + # system database. If *fileType* is *CSV*, you can specify one database, either + # by using this property or by using the *csvExportOptions.selectQuery* property, + # which takes precedence over this property. *PostgreSQL instances:* You must + # specify one database to be exported. If *fileType* is *CSV*, this database + # must match the one specified in the *csvExportOptions.selectQuery* property. # Corresponds to the JSON property `databases` # @return [Array] attr_accessor :databases - # The file type for the specified uri.
SQL: The file - # contains SQL statements.
CSV: The file contains CSV data. + # The file type for the specified uri. *SQL*: The file contains SQL statements. * + # CSV*: The file contains CSV data. # Corresponds to the JSON property `fileType` # @return [String] attr_accessor :file_type - # This is always sql#exportContext. + # This is always *sql#exportContext*. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind + # Option for export offload. + # Corresponds to the JSON property `offload` + # @return [Boolean] + attr_accessor :offload + alias_method :offload?, :offload + # Options for exporting data as SQL statements. # Corresponds to the JSON property `sqlExportOptions` # @return [Google::Apis::SqlV1beta4::ExportContext::SqlExportOptions] attr_accessor :sql_export_options - # The path to the file in Google Cloud Storage where the export will be - # stored. The URI is in the form gs: - # //bucketName/fileName. If the file already exists, the requests - # // succeeds, but the operation fails. If fileType is - # // SQL and the filename ends with .gz, the contents are - # // compressed. + # The path to the file in Google Cloud Storage where the export will be stored. + # The URI is in the form *gs: //bucketName/fileName*. If the file already exists, + # the requests // succeeds, but the operation fails. If *fileType* is // *SQL* + # and the filename ends with .gz, the contents are // compressed. # Corresponds to the JSON property `uri` # @return [String] attr_accessor :uri @@ -989,6 +965,7 @@ module Google @databases = args[:databases] if args.key?(:databases) @file_type = args[:file_type] if args.key?(:file_type) @kind = args[:kind] if args.key?(:kind) + @offload = args[:offload] if args.key?(:offload) @sql_export_options = args[:sql_export_options] if args.key?(:sql_export_options) @uri = args[:uri] if args.key?(:uri) end @@ -1027,9 +1004,9 @@ module Google attr_accessor :schema_only alias_method :schema_only?, :schema_only - # Tables to export, or that were exported, from the specified database. If - # you specify tables, specify one and only one database. For PostgreSQL - # instances, you can specify only one table. + # Tables to export, or that were exported, from the specified database. If you + # specify tables, specify one and only one database. For PostgreSQL instances, + # you can specify only one table. # Corresponds to the JSON property `tables` # @return [Array] attr_accessor :tables @@ -1049,12 +1026,10 @@ module Google class MysqlExportOptions include Google::Apis::Core::Hashable - # Option to include SQL statement required to set up replication. - #
If set to 1, the dump file includes - # a CHANGE MASTER TO statement with the binary log coordinates. - #
If set to 2, the CHANGE MASTER TO statement is written as - # a SQL comment, and has no effect. - # All other values are ignored. + # Option to include SQL statement required to set up replication. If set to *1*, + # the dump file includes a CHANGE MASTER TO statement with the binary log + # coordinates. If set to *2*, the CHANGE MASTER TO statement is written as a SQL + # comment, and has no effect. All other values are ignored. # Corresponds to the JSON property `masterData` # @return [Fixnum] attr_accessor :master_data @@ -1075,7 +1050,7 @@ module Google class FailoverContext include Google::Apis::Core::Hashable - # This is always sql#failoverContext. + # This is always *sql#failoverContext*. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind @@ -1101,21 +1076,19 @@ module Google class Flag include Google::Apis::Core::Hashable - # Use this field if only certain integers are accepted. Can be combined - # with min_value and max_value to add additional values. + # Use this field if only certain integers are accepted. Can be combined with + # min_value and max_value to add additional values. # Corresponds to the JSON property `allowedIntValues` # @return [Array] attr_accessor :allowed_int_values - # For STRING flags, a list of strings that the value can be set - # to. + # For *STRING* flags, a list of strings that the value can be set to. # Corresponds to the JSON property `allowedStringValues` # @return [Array] attr_accessor :allowed_string_values - # The database version this flag applies to. Can be MYSQL_5_5, - # MYSQL_5_6, or MYSQL_5_7. MYSQL_5_7 - # is applicable only to Second Generation instances. + # The database version this flag applies to. Can be *MYSQL_5_5*, *MYSQL_5_6*, or + # *MYSQL_5_7*. *MYSQL_5_7* is applicable only to Second Generation instances. # Corresponds to the JSON property `appliesTo` # @return [Array] attr_accessor :applies_to @@ -1126,23 +1099,23 @@ module Google attr_accessor :in_beta alias_method :in_beta?, :in_beta - # This is always sql#flag. + # This is always *sql#flag*. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind - # For INTEGER flags, the maximum allowed value. + # For *INTEGER* flags, the maximum allowed value. # Corresponds to the JSON property `maxValue` # @return [Fixnum] attr_accessor :max_value - # For INTEGER flags, the minimum allowed value. + # For *INTEGER* flags, the minimum allowed value. # Corresponds to the JSON property `minValue` # @return [Fixnum] attr_accessor :min_value - # This is the name of the flag. Flag names always use underscores, not - # hyphens, for example: max_allowed_packet + # This is the name of the flag. Flag names always use underscores, not hyphens, + # for example: *max_allowed_packet* # Corresponds to the JSON property `name` # @return [String] attr_accessor :name @@ -1154,10 +1127,9 @@ module Google attr_accessor :requires_restart alias_method :requires_restart?, :requires_restart - # The type of the flag. Flags are typed to being BOOLEAN, - # STRING, INTEGER or NONE. - # NONE is used for flags which do not take a value, such as - # skip_grant_tables. + # The type of the flag. Flags are typed to being *BOOLEAN*, *STRING*, *INTEGER* + # or *NONE*. *NONE* is used for flags which do not take a value, such as * + # skip_grant_tables*. # Corresponds to the JSON property `type` # @return [String] attr_accessor :type @@ -1190,7 +1162,7 @@ module Google # @return [Array] attr_accessor :items - # This is always sql#flagsList. + # This is always *sql#flagsList*. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind @@ -1220,17 +1192,16 @@ module Google # @return [Google::Apis::SqlV1beta4::ImportContext::CsvImportOptions] attr_accessor :csv_import_options - # The target database for the import. If fileType is - # SQL, this field is required only if the import file does not - # specify a database, and is overridden by any database specification in the - # import file. If fileType is CSV, one database - # must be specified. + # The target database for the import. If *fileType* is *SQL*, this field is + # required only if the import file does not specify a database, and is + # overridden by any database specification in the import file. If *fileType* is * + # CSV*, one database must be specified. # Corresponds to the JSON property `database` # @return [String] attr_accessor :database - # The file type for the specified uri.
SQL: The file - # contains SQL statements.
CSV: The file contains CSV data. + # The file type for the specified uri. *SQL*: The file contains SQL statements. * + # CSV*: The file contains CSV data. # Corresponds to the JSON property `fileType` # @return [String] attr_accessor :file_type @@ -1240,16 +1211,15 @@ module Google # @return [String] attr_accessor :import_user - # This is always sql#importContext. + # This is always *sql#importContext*. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind - # Path to the import file in Cloud Storage, in the form - # gs: - # //bucketName/fileName. Compressed gzip files (.gz) are supported - # // when fileType is SQL. The instance must have - # // write permissions to the bucket and read access to the file. + # Path to the import file in Cloud Storage, in the form *gs: //bucketName/ + # fileName*. Compressed gzip files (.gz) are supported // when *fileType* is * + # SQL*. The instance must have // write permissions to the bucket and read + # access to the file. # Corresponds to the JSON property `uri` # @return [String] attr_accessor :uri @@ -1291,9 +1261,9 @@ module Google class EncryptionOptions include Google::Apis::Core::Hashable - # Path to the Certificate (.cer) in Cloud Storage, in the form - # gs://bucketName/fileName. The instance must have - # write permissions to the bucket and read access to the file. + # Path to the Certificate (.cer) in Cloud Storage, in the form *gs://bucketName/ + # fileName*. The instance must have write permissions to the bucket and read + # access to the file. # Corresponds to the JSON property `certPath` # @return [String] attr_accessor :cert_path @@ -1303,9 +1273,9 @@ module Google # @return [String] attr_accessor :pvk_password - # Path to the Certificate Private Key (.pvk) in Cloud Storage, in the - # form gs://bucketName/fileName. The instance must have - # write permissions to the bucket and read access to the file. + # Path to the Certificate Private Key (.pvk) in Cloud Storage, in the form *gs:// + # bucketName/fileName*. The instance must have write permissions to the bucket + # and read access to the file. # Corresponds to the JSON property `pvkPath` # @return [String] attr_accessor :pvk_path @@ -1327,8 +1297,8 @@ module Google class CsvImportOptions include Google::Apis::Core::Hashable - # The columns to which CSV data is imported. If not specified, all columns - # of the database table are loaded with CSV data. + # The columns to which CSV data is imported. If not specified, all columns of + # the database table are loaded with CSV data. # Corresponds to the JSON property `columns` # @return [Array] attr_accessor :columns @@ -1454,13 +1424,13 @@ module Google # @return [Array] attr_accessor :items - # This is always sql#instancesList. + # This is always *sql#instancesList*. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind - # The continuation token, used to page through large result sets. Provide - # this value in a subsequent request to return the next page of results. + # The continuation token, used to page through large result sets. Provide this + # value in a subsequent request to return the next page of results. # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token @@ -1497,7 +1467,7 @@ module Google # @return [Array] attr_accessor :certs - # This is always sql#instancesListServerCas. + # This is always *sql#instancesListServerCas*. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind @@ -1518,8 +1488,8 @@ module Google class InstancesRestoreBackupRequest include Google::Apis::Core::Hashable - # Database instance restore from backup context. - # Backup context contains source instance id and project id. + # Database instance restore from backup context. Backup context contains source + # instance id and project id. # Corresponds to the JSON property `restoreBackupContext` # @return [Google::Apis::SqlV1beta4::RestoreBackupContext] attr_accessor :restore_backup_context @@ -1577,8 +1547,8 @@ module Google include Google::Apis::Core::Hashable # The list of external networks that are allowed to connect to the instance - # using the IP. In 'CIDR' notation, also known as 'slash' notation (for - # example: 192.168.100.0/24). + # using the IP. In 'CIDR' notation, also known as 'slash' notation (for example: + # *192.168.100.0/24*). # Corresponds to the JSON property `authorizedNetworks` # @return [Array] attr_accessor :authorized_networks @@ -1590,9 +1560,9 @@ module Google alias_method :ipv4_enabled?, :ipv4_enabled # The resource link for the VPC network from which the Cloud SQL instance is - # accessible for private IP. For example, - # /projects/myProject/global/networks/default. This setting can - # be updated, but it cannot be removed after it is set. + # accessible for private IP. For example, */projects/myProject/global/networks/ + # default*. This setting can be updated, but it cannot be removed after it is + # set. # Corresponds to the JSON property `privateNetwork` # @return [String] attr_accessor :private_network @@ -1625,19 +1595,17 @@ module Google # @return [String] attr_accessor :ip_address - # The due time for this IP to be retired in RFC 3339 format, for example - # 2012-11-15T16:19:00.094Z. This field is only available when - # the IP is scheduled to be retired. + # The due time for this IP to be retired in RFC 3339 format, for example *2012- + # 11-15T16:19:00.094Z*. This field is only available when the IP is scheduled to + # be retired. # Corresponds to the JSON property `timeToRetire` # @return [String] attr_accessor :time_to_retire - # The type of this IP address. A PRIMARY address is a public - # address that can accept incoming connections. A PRIVATE - # address is a private address that can accept incoming connections. An - # OUTGOING address is the source address of connections - # originating from the instance, if supported. + # The type of this IP address. A *PRIMARY* address is a public address that can + # accept incoming connections. A *PRIVATE* address is a private address that can + # accept incoming connections. An *OUTGOING* address is the source address of + # connections originating from the instance, if supported. # Corresponds to the JSON property `type` # @return [String] attr_accessor :type @@ -1654,11 +1622,11 @@ module Google end end - # Preferred location. This specifies where a Cloud SQL instance - # is located, either in a specific Compute Engine zone, or - # co-located with an App Engine application. Note that if the preferred - # location is not available, the instance will be located as close as possible - # within the region. Only one location may be specified. + # Preferred location. This specifies where a Cloud SQL instance is located, + # either in a specific Compute Engine zone, or co-located with an App Engine + # application. Note that if the preferred location is not available, the + # instance will be located as close as possible within the region. Only one + # location may be specified. class LocationPreference include Google::Apis::Core::Hashable @@ -1668,13 +1636,13 @@ module Google # @return [String] attr_accessor :follow_gae_application - # This is always sql#locationPreference. + # This is always *sql#locationPreference*. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind - # The preferred Compute Engine zone (for example: us-central1-a, - # us-central1-b, etc.). + # The preferred Compute Engine zone (for example: us-central1-a, us-central1-b, + # etc.). # Corresponds to the JSON property `zone` # @return [String] attr_accessor :zone @@ -1691,8 +1659,8 @@ module Google end end - # Maintenance window. This specifies when a Cloud SQL instance - # is restarted for system maintenance purposes. + # Maintenance window. This specifies when a Cloud SQL instance is restarted for + # system maintenance purposes. class MaintenanceWindow include Google::Apis::Core::Hashable @@ -1706,15 +1674,12 @@ module Google # @return [Fixnum] attr_accessor :hour - # This is always sql#maintenanceWindow. + # This is always *sql#maintenanceWindow*. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind - # Maintenance timing setting: canary (Earlier) or - # stable (Later).
- # Learn more. + # Maintenance timing setting: *canary* (Earlier) or *stable* (Later). Learn more. # Corresponds to the JSON property `updateTrack` # @return [String] attr_accessor :update_track @@ -1746,8 +1711,8 @@ module Google # @return [String] attr_accessor :client_certificate - # PEM representation of the replica's private key. The corresponsing public - # key is encoded in the client's certificate. + # PEM representation of the replica's private key. The corresponsing public key + # is encoded in the client's certificate. # Corresponds to the JSON property `clientKey` # @return [String] attr_accessor :client_key @@ -1759,15 +1724,14 @@ module Google # Path to a SQL dump file in Google Cloud Storage from which the replica # instance is to be created. The URI is in the form gs://bucketName/fileName. - # Compressed gzip files (.gz) are also supported. - # Dumps have the binlog co-ordinates from which replication - # begins. This can be accomplished by setting --master-data to 1 when using - # mysqldump. + # Compressed gzip files (.gz) are also supported. Dumps have the binlog co- + # ordinates from which replication begins. This can be accomplished by setting -- + # master-data to 1 when using mysqldump. # Corresponds to the JSON property `dumpFilePath` # @return [String] attr_accessor :dump_file_path - # This is always sql#mysqlReplicaConfiguration. + # This is always *sql#mysqlReplicaConfiguration*. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind @@ -1792,8 +1756,8 @@ module Google # @return [String] attr_accessor :username - # Whether or not to check the master's Common Name value in the certificate - # that it sends during the SSL handshake. + # Whether or not to check the master's Common Name value in the certificate that + # it sends during the SSL handshake. # Corresponds to the JSON property `verifyServerCertificate` # @return [Boolean] attr_accessor :verify_server_certificate @@ -1833,8 +1797,8 @@ module Google # @return [String] attr_accessor :client_certificate - # PEM representation of the replica's private key. The corresponsing public - # key is encoded in the client's certificate. + # PEM representation of the replica's private key. The corresponsing public key + # is encoded in the client's certificate. # Corresponds to the JSON property `clientKey` # @return [String] attr_accessor :client_key @@ -1849,7 +1813,7 @@ module Google # @return [String] attr_accessor :host_port - # This is always sql#onPremisesConfiguration. + # This is always *sql#onPremisesConfiguration*. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind @@ -1881,15 +1845,14 @@ module Google end end - # An Operation resource. For successful operations that return an - # Operation resource, only the fields relevant to the operation are populated - # in the resource. + # An Operation resource. For successful operations that return an Operation + # resource, only the fields relevant to the operation are populated in the + # resource. class Operation include Google::Apis::Core::Hashable - # The time this operation finished in UTC timezone in RFC 3339 format, for example - # 2012-11-15T16:19:00.094Z. + # The time this operation finished in UTC timezone in RFC 3339 format, for + # example *2012-11-15T16:19:00.094Z*. # Corresponds to the JSON property `endTime` # @return [String] attr_accessor :end_time @@ -1909,38 +1872,27 @@ module Google # @return [Google::Apis::SqlV1beta4::ImportContext] attr_accessor :import_context - # The time this operation was enqueued in UTC timezone in RFC 3339 format, for example - # 2012-11-15T16:19:00.094Z. + # The time this operation was enqueued in UTC timezone in RFC 3339 format, for + # example *2012-11-15T16:19:00.094Z*. # Corresponds to the JSON property `insertTime` # @return [String] attr_accessor :insert_time - # This is always sql#operation. + # This is always *sql#operation*. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # An identifier that uniquely identifies the operation. You can use this - # identifier to retrieve the Operations resource that has information about - # the operation. + # identifier to retrieve the Operations resource that has information about the + # operation. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name - # The type of the operation. Valid values are: - #
CREATE - #
DELETE - #
UPDATE - #
RESTART - #
IMPORT - #
EXPORT - #
BACKUP_VOLUME - #
RESTORE_VOLUME - #
CREATE_USER - #
DELETE_USER - #
CREATE_DATABASE - #
DELETE_DATABASE + # The type of the operation. Valid values are: *CREATE* *DELETE* *UPDATE* * + # RESTART* *IMPORT* *EXPORT* *BACKUP_VOLUME* *RESTORE_VOLUME* *CREATE_USER* * + # DELETE_USER* *CREATE_DATABASE* *DELETE_DATABASE* # Corresponds to the JSON property `operationType` # @return [String] attr_accessor :operation_type @@ -1950,18 +1902,14 @@ module Google # @return [String] attr_accessor :self_link - # The time this operation actually started in UTC timezone in RFC 3339 format, for example - # 2012-11-15T16:19:00.094Z. + # The time this operation actually started in UTC timezone in RFC 3339 format, + # for example *2012-11-15T16:19:00.094Z*. # Corresponds to the JSON property `startTime` # @return [String] attr_accessor :start_time - # The status of an operation. Valid values are: - #
PENDING - #
RUNNING - #
DONE - #
SQL_OPERATION_STATUS_UNSPECIFIED + # The status of an operation. Valid values are: *PENDING* *RUNNING* *DONE* * + # SQL_OPERATION_STATUS_UNSPECIFIED* # Corresponds to the JSON property `status` # @return [String] attr_accessor :status @@ -2019,7 +1967,7 @@ module Google # @return [String] attr_accessor :code - # This is always sql#operationError. + # This is always *sql#operationError*. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind @@ -2050,7 +1998,7 @@ module Google # @return [Array] attr_accessor :errors - # This is always sql#operationErrors. + # This is always *sql#operationErrors*. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind @@ -2075,13 +2023,13 @@ module Google # @return [Array] attr_accessor :items - # This is always sql#operationsList. + # This is always *sql#operationsList*. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind - # The continuation token, used to page through large result sets. Provide - # this value in a subsequent request to return the next page of results. + # The continuation token, used to page through large result sets. Provide this + # value in a subsequent request to return the next page of results. # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token @@ -2102,18 +2050,17 @@ module Google class ReplicaConfiguration include Google::Apis::Core::Hashable - # Specifies if the replica is the failover target. If the field is set to - # true the replica will be designated as a failover replica. In - # case the master instance fails, the replica instance will be promoted as - # the new master instance.

Only one replica can be specified as failover - # target, and the replica has to be in different zone with the master - # instance. + # Specifies if the replica is the failover target. If the field is set to *true* + # the replica will be designated as a failover replica. In case the master + # instance fails, the replica instance will be promoted as the new master + # instance. Only one replica can be specified as failover target, and the + # replica has to be in different zone with the master instance. # Corresponds to the JSON property `failoverTarget` # @return [Boolean] attr_accessor :failover_target alias_method :failover_target?, :failover_target - # This is always sql#replicaConfiguration. + # This is always *sql#replicaConfiguration*. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind @@ -2145,9 +2092,8 @@ module Google attr_accessor :reschedule_type # Optional. Timestamp when the maintenance shall be rescheduled to if - # reschedule_type=SPECIFIC_TIME, in RFC 3339 format, for - # example 2012-11-15T16:19:00.094Z. + # reschedule_type=SPECIFIC_TIME, in RFC 3339 format, for example *2012-11-15T16: + # 19:00.094Z*. # Corresponds to the JSON property `scheduleTime` # @return [String] attr_accessor :schedule_time @@ -2163,8 +2109,8 @@ module Google end end - # Database instance restore from backup context. - # Backup context contains source instance id and project id. + # Database instance restore from backup context. Backup context contains source + # instance id and project id. class RestoreBackupContext include Google::Apis::Core::Hashable @@ -2178,7 +2124,7 @@ module Google # @return [String] attr_accessor :instance_id - # This is always sql#restoreBackupContext. + # This is always *sql#restoreBackupContext*. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind @@ -2205,7 +2151,7 @@ module Google class RotateServerCaContext include Google::Apis::Core::Hashable - # This is always sql#rotateServerCaContext. + # This is always *sql#rotateServerCaContext*. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind @@ -2232,29 +2178,25 @@ module Google include Google::Apis::Core::Hashable # The activation policy specifies when the instance is activated; it is - # applicable only when the instance state is RUNNABLE. Valid values: - #
ALWAYS: The instance is on, and remains so even in - # the absence of connection requests. - #
NEVER: The instance is off; it is not activated, even if a - # connection request arrives. + # applicable only when the instance state is RUNNABLE. Valid values: *ALWAYS*: + # The instance is on, and remains so even in the absence of connection requests. + # *NEVER*: The instance is off; it is not activated, even if a connection + # request arrives. # Corresponds to the JSON property `activationPolicy` # @return [String] attr_accessor :activation_policy - # The App Engine app IDs that can access this instance. - # (Deprecated) Applied to First Generation instances only. + # The App Engine app IDs that can access this instance. (Deprecated) Applied to + # First Generation instances only. # Corresponds to the JSON property `authorizedGaeApplications` # @return [Array] attr_accessor :authorized_gae_applications - # Availability type. Potential values: - #
ZONAL: The instance serves data from only one zone. - # Outages in that zone affect data accessibility. - #
REGIONAL: The instance can serve data from more than one zone - # in a region - # (it is highly available).
For more information, see - # - # Overview of the High Availability Configuration. + # Availability type. Potential values: *ZONAL*: The instance serves data from + # only one zone. Outages in that zone affect data accessibility. *REGIONAL*: The + # instance can serve data from more than one zone in a region (it is highly + # available). For more information, see Overview of the High Availability + # Configuration. # Corresponds to the JSON property `availabilityType` # @return [String] attr_accessor :availability_type @@ -2269,9 +2211,9 @@ module Google # @return [String] attr_accessor :collation - # Configuration specific to read replica instances. Indicates whether - # database flags for crash-safe replication are enabled. This property was - # only applicable to First Generation instances. + # Configuration specific to read replica instances. Indicates whether database + # flags for crash-safe replication are enabled. This property was only + # applicable to First Generation instances. # Corresponds to the JSON property `crashSafeReplicationEnabled` # @return [Boolean] attr_accessor :crash_safe_replication_enabled @@ -2282,8 +2224,8 @@ module Google # @return [Fixnum] attr_accessor :data_disk_size_gb - # The type of data disk: PD_SSD (default) or - # PD_HDD. Not used for First Generation instances. + # The type of data disk: PD_SSD (default) or PD_HDD. Not used for First + # Generation instances. # Corresponds to the JSON property `dataDiskType` # @return [String] attr_accessor :data_disk_type @@ -2305,45 +2247,43 @@ module Google # @return [Google::Apis::SqlV1beta4::IpConfiguration] attr_accessor :ip_configuration - # This is always sql#settings. + # This is always *sql#settings*. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind - # Preferred location. This specifies where a Cloud SQL instance - # is located, either in a specific Compute Engine zone, or - # co-located with an App Engine application. Note that if the preferred - # location is not available, the instance will be located as close as possible - # within the region. Only one location may be specified. + # Preferred location. This specifies where a Cloud SQL instance is located, + # either in a specific Compute Engine zone, or co-located with an App Engine + # application. Note that if the preferred location is not available, the + # instance will be located as close as possible within the region. Only one + # location may be specified. # Corresponds to the JSON property `locationPreference` # @return [Google::Apis::SqlV1beta4::LocationPreference] attr_accessor :location_preference - # Maintenance window. This specifies when a Cloud SQL instance - # is restarted for system maintenance purposes. + # Maintenance window. This specifies when a Cloud SQL instance is restarted for + # system maintenance purposes. # Corresponds to the JSON property `maintenanceWindow` # @return [Google::Apis::SqlV1beta4::MaintenanceWindow] attr_accessor :maintenance_window - # The pricing plan for this instance. This can be either PER_USE - # or PACKAGE. Only PER_USE is supported for Second - # Generation instances. + # The pricing plan for this instance. This can be either *PER_USE* or *PACKAGE*. + # Only *PER_USE* is supported for Second Generation instances. # Corresponds to the JSON property `pricingPlan` # @return [String] attr_accessor :pricing_plan - # The type of replication this instance uses. This can be either - # ASYNCHRONOUS or SYNCHRONOUS. - # (Deprecated_ This property was only applicable to - # First Generation instances. + # The type of replication this instance uses. This can be either *ASYNCHRONOUS* + # or *SYNCHRONOUS*. (Deprecated_ This property was only applicable to First + # Generation instances. # Corresponds to the JSON property `replicationType` # @return [String] attr_accessor :replication_type - # The version of instance settings. This is a required field for update - # method to make sure concurrent updates are handled properly. During update, - # use the most recent settingsVersion value for this instance and do not try - # to update this value. + # The version of instance settings. This is a required field for update method + # to make sure concurrent updates are handled properly. During update, use the + # most recent settingsVersion value for this instance and do not try to update + # this value. # Corresponds to the JSON property `settingsVersion` # @return [Fixnum] attr_accessor :settings_version @@ -2355,21 +2295,20 @@ module Google attr_accessor :storage_auto_resize alias_method :storage_auto_resize?, :storage_auto_resize - # The maximum size to which storage capacity can be automatically increased. - # The default value is 0, which specifies that there is no limit. + # The maximum size to which storage capacity can be automatically increased. The + # default value is 0, which specifies that there is no limit. # Corresponds to the JSON property `storageAutoResizeLimit` # @return [Fixnum] attr_accessor :storage_auto_resize_limit - # The tier (or machine type) for this instance, for example - # db-n1-standard-1 (MySQL instances) or - # db-custom-1-3840 (PostgreSQL instances). + # The tier (or machine type) for this instance, for example *db-n1-standard-1* ( + # MySQL instances) or *db-custom-1-3840* (PostgreSQL instances). # Corresponds to the JSON property `tier` # @return [String] attr_accessor :tier - # User-provided labels, represented as a dictionary where each label is a - # single key value pair. + # User-provided labels, represented as a dictionary where each label is a single + # key value pair. # Corresponds to the JSON property `userLabels` # @return [Hash] attr_accessor :user_labels @@ -2413,7 +2352,7 @@ module Google # @return [String] attr_accessor :detail - # This is always sql#migrationSettingError. + # This is always *sql#migrationSettingError*. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind @@ -2463,7 +2402,7 @@ module Google # @return [Array] attr_accessor :errors - # This is always sql#migrationSettingErrorList. + # This is always *sql#migrationSettingErrorList*. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind @@ -2577,21 +2516,19 @@ module Google # @return [String] attr_accessor :cert_serial_number - # User supplied name. Constrained to [a-zA-Z.-_ ]+. + # User supplied name. Constrained to [a-zA-Z.-_ ]+. # Corresponds to the JSON property `commonName` # @return [String] attr_accessor :common_name - # The time when the certificate was created in RFC 3339 format, for example - # 2012-11-15T16:19:00.094Z + # The time when the certificate was created in RFC 3339 format, for example * + # 2012-11-15T16:19:00.094Z* # Corresponds to the JSON property `createTime` # @return [String] attr_accessor :create_time - # The time when the certificate expires in RFC 3339 format, for example - # 2012-11-15T16:19:00.094Z. + # The time when the certificate expires in RFC 3339 format, for example *2012-11- + # 15T16:19:00.094Z*. # Corresponds to the JSON property `expirationTime` # @return [String] attr_accessor :expiration_time @@ -2601,7 +2538,7 @@ module Google # @return [String] attr_accessor :instance - # This is always sql#sslCert. + # This is always *sql#sslCert*. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind @@ -2643,8 +2580,8 @@ module Google # @return [Google::Apis::SqlV1beta4::SslCert] attr_accessor :cert_info - # The private key for the client cert, in pem format. Keep private in order - # to protect your security. + # The private key for the client cert, in pem format. Keep private in order to + # protect your security. # Corresponds to the JSON property `certPrivateKey` # @return [String] attr_accessor :cert_private_key @@ -2683,8 +2620,8 @@ module Google class SslCertsInsertRequest include Google::Apis::Core::Hashable - # User supplied name. Must be a distinct name from the other certificates - # for this instance. + # User supplied name. Must be a distinct name from the other certificates for + # this instance. # Corresponds to the JSON property `commonName` # @return [String] attr_accessor :common_name @@ -2708,14 +2645,14 @@ module Google # @return [Google::Apis::SqlV1beta4::SslCertDetail] attr_accessor :client_cert - # This is always sql#sslCertsInsert. + # This is always *sql#sslCertsInsert*. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind - # An Operation resource. For successful operations that return an - # Operation resource, only the fields relevant to the operation are populated - # in the resource. + # An Operation resource. For successful operations that return an Operation + # resource, only the fields relevant to the operation are populated in the + # resource. # Corresponds to the JSON property `operation` # @return [Google::Apis::SqlV1beta4::Operation] attr_accessor :operation @@ -2747,7 +2684,7 @@ module Google # @return [Array] attr_accessor :items - # This is always sql#sslCertsList. + # This is always *sql#sslCertsList*. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind @@ -2777,7 +2714,7 @@ module Google # @return [Fixnum] attr_accessor :ram - # This is always sql#tier. + # This is always *sql#tier*. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind @@ -2787,8 +2724,8 @@ module Google # @return [Array] attr_accessor :region - # An identifier for the machine type, for example, db-n1-standard-1. For - # related information, see Pricing. + # An identifier for the machine type, for example, db-n1-standard-1. For related + # information, see Pricing. # Corresponds to the JSON property `tier` # @return [String] attr_accessor :tier @@ -2816,7 +2753,7 @@ module Google # @return [Array] attr_accessor :items - # This is always sql#tiersList. + # This is always *sql#tiersList*. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind @@ -2836,13 +2773,13 @@ module Google class TruncateLogContext include Google::Apis::Core::Hashable - # This is always sql#truncateLogContext. + # This is always *sql#truncateLogContext*. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind - # The type of log to truncate. Valid values are - # MYSQL_GENERAL_TABLE and MYSQL_SLOW_TABLE. + # The type of log to truncate. Valid values are *MYSQL_GENERAL_TABLE* and * + # MYSQL_SLOW_TABLE*. # Corresponds to the JSON property `logType` # @return [String] attr_accessor :log_type @@ -2862,34 +2799,31 @@ module Google class User include Google::Apis::Core::Hashable - # This field is deprecated and will be removed from a future version of the - # API. + # This field is deprecated and will be removed from a future version of the API. # Corresponds to the JSON property `etag` # @return [String] attr_accessor :etag - # The host name from which the user can connect. For insert - # operations, host defaults to an empty string. For update - # operations, host is specified as part of the request URL. The host name - # cannot be updated after insertion. + # The host name from which the user can connect. For *insert* operations, host + # defaults to an empty string. For *update* operations, host is specified as + # part of the request URL. The host name cannot be updated after insertion. # Corresponds to the JSON property `host` # @return [String] attr_accessor :host - # The name of the Cloud SQL instance. This does not include the project ID. - # Can be omitted for update since it is already specified on the - # URL. + # The name of the Cloud SQL instance. This does not include the project ID. Can + # be omitted for *update* since it is already specified on the URL. # Corresponds to the JSON property `instance` # @return [String] attr_accessor :instance - # This is always sql#user. + # This is always *sql#user*. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind - # The name of the user in the Cloud SQL instance. Can be omitted for - # update since it is already specified in the URL. + # The name of the user in the Cloud SQL instance. Can be omitted for *update* + # since it is already specified in the URL. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name @@ -2900,8 +2834,8 @@ module Google attr_accessor :password # The project ID of the project containing the Cloud SQL database. The Google - # apps domain is prefixed if applicable. Can be omitted for - # update since it is already specified on the URL. + # apps domain is prefixed if applicable. Can be omitted for *update* since it is + # already specified on the URL. # Corresponds to the JSON property `project` # @return [String] attr_accessor :project @@ -2911,6 +2845,12 @@ module Google # @return [Google::Apis::SqlV1beta4::SqlServerUserDetails] attr_accessor :sqlserver_user_details + # The user type. It determines the method to authenticate the user during login. + # The default is the database's built-in user type. + # Corresponds to the JSON property `type` + # @return [String] + attr_accessor :type + def initialize(**args) update!(**args) end @@ -2925,6 +2865,7 @@ module Google @password = args[:password] if args.key?(:password) @project = args[:project] if args.key?(:project) @sqlserver_user_details = args[:sqlserver_user_details] if args.key?(:sqlserver_user_details) + @type = args[:type] if args.key?(:type) end end @@ -2937,14 +2878,14 @@ module Google # @return [Array] attr_accessor :items - # This is always sql#usersList. + # This is always *sql#usersList*. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # An identifier that uniquely identifies the operation. You can use this - # identifier to retrieve the Operations resource that has information about - # the operation. + # identifier to retrieve the Operations resource that has information about the + # operation. # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token diff --git a/generated/google/apis/sql_v1beta4/representations.rb b/generated/google/apis/sql_v1beta4/representations.rb index 7038754ed..f785caeac 100644 --- a/generated/google/apis/sql_v1beta4/representations.rb +++ b/generated/google/apis/sql_v1beta4/representations.rb @@ -670,6 +670,7 @@ module Google collection :databases, as: 'databases' property :file_type, as: 'fileType' property :kind, as: 'kind' + property :offload, as: 'offload' property :sql_export_options, as: 'sqlExportOptions', class: Google::Apis::SqlV1beta4::ExportContext::SqlExportOptions, decorator: Google::Apis::SqlV1beta4::ExportContext::SqlExportOptions::Representation property :uri, as: 'uri' @@ -1200,6 +1201,7 @@ module Google property :project, as: 'project' property :sqlserver_user_details, as: 'sqlserverUserDetails', class: Google::Apis::SqlV1beta4::SqlServerUserDetails, decorator: Google::Apis::SqlV1beta4::SqlServerUserDetails::Representation + property :type, as: 'type' end end diff --git a/generated/google/apis/sql_v1beta4/service.rb b/generated/google/apis/sql_v1beta4/service.rb index 8854665a0..87fdf7f72 100644 --- a/generated/google/apis/sql_v1beta4/service.rb +++ b/generated/google/apis/sql_v1beta4/service.rb @@ -53,8 +53,7 @@ module Google # @param [String] instance # Cloud SQL instance ID. This does not include the project ID. # @param [Fixnum] id - # The ID of the Backup Run to delete. To find a Backup Run ID, use the list + # The ID of the Backup Run to delete. To find a Backup Run ID, use the list # method. # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -121,8 +120,8 @@ module Google execute_or_queue_command(command, &block) end - # Creates a new backup run on demand. This method is applicable only to - # Second Generation instances. + # Creates a new backup run on demand. This method is applicable only to Second + # Generation instances. # @param [String] project # Project ID of the project that contains the instance. # @param [String] instance @@ -272,8 +271,8 @@ module Google execute_or_queue_command(command, &block) end - # Inserts a resource containing information about a database inside a Cloud - # SQL instance. + # Inserts a resource containing information about a database inside a Cloud SQL + # instance. # @param [String] project # Project ID of the project that contains the instance. # @param [String] instance @@ -342,8 +341,8 @@ module Google execute_or_queue_command(command, &block) end - # Partially updates a resource containing information about a database inside - # a Cloud SQL instance. This method supports patch semantics. + # Partially updates a resource containing information about a database inside a + # Cloud SQL instance. This method supports patch semantics. # @param [String] project # Project ID of the project that contains the instance. # @param [String] instance @@ -382,8 +381,8 @@ module Google execute_or_queue_command(command, &block) end - # Updates a resource containing information about a database inside a Cloud - # SQL instance. + # Updates a resource containing information about a database inside a Cloud SQL + # instance. # @param [String] project # Project ID of the project that contains the instance. # @param [String] instance @@ -454,10 +453,10 @@ module Google end # Add a new trusted Certificate Authority (CA) version for the specified - # instance. Required to prepare for a certificate rotation. If a CA version - # was previously added but never used in a certificate rotation, this - # operation replaces that version. There cannot be more than one CA version - # waiting to be rotated in. + # instance. Required to prepare for a certificate rotation. If a CA version was + # previously added but never used in a certificate rotation, this operation + # replaces that version. There cannot be more than one CA version waiting to be + # rotated in. # @param [String] project # Project ID of the project that contains the instance. # @param [String] instance @@ -495,8 +494,8 @@ module Google # @param [String] project # Project ID of the source as well as the clone Cloud SQL instance. # @param [String] instance - # The ID of the Cloud SQL instance to be cloned (source). This does not - # include the project ID. + # The ID of the Cloud SQL instance to be cloned (source). This does not include + # the project ID. # @param [Google::Apis::SqlV1beta4::InstancesCloneRequest] instances_clone_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -598,8 +597,8 @@ module Google execute_or_queue_command(command, &block) end - # Exports data from a Cloud SQL instance to a Cloud Storage bucket as a SQL - # dump or CSV file. + # Exports data from a Cloud SQL instance to a Cloud Storage bucket as a SQL dump + # or CSV file. # @param [String] project # Project ID of the project that contains the instance to be exported. # @param [String] instance @@ -635,8 +634,8 @@ module Google execute_or_queue_command(command, &block) end - # Failover the instance to its failover replica instance. Using this - # operation might cause your instance to restart. + # Failover the instance to its failover replica instance. Using this operation + # might cause your instance to restart. # @param [String] project # ID of the project that contains the read replica. # @param [String] instance @@ -705,8 +704,8 @@ module Google execute_or_queue_command(command, &block) end - # Imports data into a Cloud SQL instance from a SQL dump or CSV file in - # Cloud Storage. + # Imports data into a Cloud SQL instance from a SQL dump or CSV file in Cloud + # Storage. # @param [String] project # Project ID of the project that contains the instance. # @param [String] instance @@ -780,14 +779,13 @@ module Google # @param [String] project # Project ID of the project for which to list Cloud SQL instances. # @param [String] filter - # A filter expression that filters resources listed in the response. - # The expression is in the form of field:value. For example, - # 'instanceType:CLOUD_SQL_INSTANCE'. Fields can be nested as needed as per - # their JSON representation, such as 'settings.userLabels.auto_start:true'. - # Multiple filter queries are space-separated. For example. - # 'state:RUNNABLE instanceType:CLOUD_SQL_INSTANCE'. By default, each - # expression is an AND expression. However, you can include AND and OR - # expressions explicitly. + # A filter expression that filters resources listed in the response. The + # expression is in the form of field:value. For example, 'instanceType: + # CLOUD_SQL_INSTANCE'. Fields can be nested as needed as per their JSON + # representation, such as 'settings.userLabels.auto_start:true'. Multiple filter + # queries are space-separated. For example. 'state:RUNNABLE instanceType: + # CLOUD_SQL_INSTANCE'. By default, each expression is an AND expression. However, + # you can include AND and OR expressions explicitly. # @param [Fixnum] max_results # The maximum number of results to return per response. # @param [String] page_token @@ -825,9 +823,9 @@ module Google # Lists all of the trusted Certificate Authorities (CAs) for the specified # instance. There can be up to three CAs listed: the CA that was used to sign - # the certificate that is currently in use, a CA that has been added but not - # yet used to sign a certificate, and a CA used to sign a certificate that - # has previously rotated out. + # the certificate that is currently in use, a CA that has been added but not yet + # used to sign a certificate, and a CA used to sign a certificate that has + # previously rotated out. # @param [String] project # Project ID of the project that contains the instance. # @param [String] instance @@ -860,8 +858,7 @@ module Google execute_or_queue_command(command, &block) end - # Updates settings of a Cloud SQL instance. - # This method supports patch semantics. + # Updates settings of a Cloud SQL instance. This method supports patch semantics. # @param [String] project # Project ID of the project that contains the instance. # @param [String] instance @@ -931,8 +928,8 @@ module Google execute_or_queue_command(command, &block) end - # Deletes all client certificates and generates a new server SSL certificate - # for the instance. + # Deletes all client certificates and generates a new server SSL certificate for + # the instance. # @param [String] project # Project ID of the project that contains the instance. # @param [String] instance @@ -1035,8 +1032,8 @@ module Google execute_or_queue_command(command, &block) end - # Rotates the server certificate to one signed by the Certificate Authority - # (CA) version previously added with the addServerCA method. + # Rotates the server certificate to one signed by the Certificate Authority (CA) + # version previously added with the addServerCA method. # @param [String] project # Project ID of the project that contains the instance. # @param [String] instance @@ -1244,8 +1241,8 @@ module Google execute_or_queue_command(command, &block) end - # Lists all instance operations that have been performed on the given Cloud - # SQL instance in the reverse chronological order of the start time. + # Lists all instance operations that have been performed on the given Cloud SQL + # instance in the reverse chronological order of the start time. # @param [String] project # Project ID of the project that contains the instance. # @param [String] instance @@ -1397,9 +1394,8 @@ module Google end # Generates a short-lived X509 certificate containing the provided public key - # and signed by a private key specific to the target instance. Users may use - # the certificate to authenticate as themselves when connecting to the - # database. + # and signed by a private key specific to the target instance. Users may use the + # certificate to authenticate as themselves when connecting to the database. # @param [String] project # Project ID of the Cloud SQL project. # @param [String] instance @@ -1435,8 +1431,8 @@ module Google execute_or_queue_command(command, &block) end - # Deletes the SSL certificate. For First Generation instances, the - # certificate remains valid until the instance is restarted. + # Deletes the SSL certificate. For First Generation instances, the certificate + # remains valid until the instance is restarted. # @param [String] project # Project ID of the project that contains the instance. # @param [String] instance @@ -1472,8 +1468,8 @@ module Google execute_or_queue_command(command, &block) end - # Retrieves a particular SSL certificate. Does not include the private key - # (required for usage). The private key must be saved from the response to + # Retrieves a particular SSL certificate. Does not include the private key ( + # required for usage). The private key must be saved from the response to # initial creation. # @param [String] project # Project ID of the project that contains the instance. @@ -1511,8 +1507,8 @@ module Google end # Creates an SSL certificate and returns it along with the private key and - # server certificate authority. The new certificate will not be usable until - # the instance is restarted. + # server certificate authority. The new certificate will not be usable until the + # instance is restarted. # @param [String] project # Project ID of the project that contains the instance. # @param [String] instance @@ -1581,9 +1577,8 @@ module Google execute_or_queue_command(command, &block) end - # Lists all available machine types (tiers) for Cloud SQL, for example, - # db-n1-standard-1. For related information, see Pricing. + # Lists all available machine types (tiers) for Cloud SQL, for example, db-n1- + # standard-1. For related information, see Pricing. # @param [String] project # Project ID of the project for which to list tiers. # @param [String] fields