From cfefabb1171186f39241ccbc72074e31947eceef Mon Sep 17 00:00:00 2001 From: Google APIs Date: Sat, 15 Aug 2020 00:38:25 +0000 Subject: [PATCH] Autogenerated update (2020-08-15) Delete: - dns_v2beta1 Update: - cloudfunctions_v1 - cloudtasks_v2 - container_v1beta1 - pagespeedonline_v5 - people_v1 - prod_tt_sasportal_v1alpha1 - recommendationengine_v1beta1 - servicecontrol_v2 - texttospeech_v1 - texttospeech_v1beta1 - videointelligence_v1 - videointelligence_v1beta2 - videointelligence_v1p1beta1 - videointelligence_v1p2beta1 --- api_names_out.yaml | 36 + generated/google/apis/cloudfunctions_v1.rb | 2 +- .../google/apis/cloudfunctions_v1/classes.rb | 816 +++---- .../google/apis/cloudfunctions_v1/service.rb | 172 +- generated/google/apis/cloudtasks_v2.rb | 2 +- .../google/apis/cloudtasks_v2/classes.rb | 1538 +++++------- .../google/apis/cloudtasks_v2/service.rb | 363 ++- generated/google/apis/container_v1beta1.rb | 2 +- .../google/apis/container_v1beta1/classes.rb | 2064 ++++++++--------- .../apis/container_v1beta1/representations.rb | 70 + .../google/apis/container_v1beta1/service.rb | 869 ++++--- generated/google/apis/dns_v2beta1.rb | 43 - generated/google/apis/dns_v2beta1/classes.rb | 1424 ------------ .../apis/dns_v2beta1/representations.rb | 588 ----- generated/google/apis/dns_v2beta1/service.rb | 913 -------- generated/google/apis/pagespeedonline_v5.rb | 4 +- .../google/apis/pagespeedonline_v5/classes.rb | 42 +- .../google/apis/pagespeedonline_v5/service.rb | 7 +- generated/google/apis/people_v1.rb | 2 +- generated/google/apis/people_v1/classes.rb | 87 +- .../google/apis/people_v1/representations.rb | 23 + generated/google/apis/people_v1/service.rb | 58 +- .../google/apis/prod_tt_sasportal_v1alpha1.rb | 2 +- .../prod_tt_sasportal_v1alpha1/classes.rb | 6 + .../representations.rb | 1 + .../apis/recommendationengine_v1beta1.rb | 2 +- .../recommendationengine_v1beta1/classes.rb | 6 +- .../recommendationengine_v1beta1/service.rb | 5 +- generated/google/apis/servicecontrol_v2.rb | 2 +- .../google/apis/servicecontrol_v2/classes.rb | 604 +++-- .../google/apis/servicecontrol_v2/service.rb | 76 +- generated/google/apis/texttospeech_v1.rb | 2 +- .../google/apis/texttospeech_v1/classes.rb | 108 +- .../google/apis/texttospeech_v1/service.rb | 17 +- generated/google/apis/texttospeech_v1beta1.rb | 2 +- .../apis/texttospeech_v1beta1/classes.rb | 112 +- .../apis/texttospeech_v1beta1/service.rb | 17 +- generated/google/apis/videointelligence_v1.rb | 2 +- .../apis/videointelligence_v1/classes.rb | 1671 ++++++------- .../apis/videointelligence_v1/service.rb | 88 +- .../google/apis/videointelligence_v1beta2.rb | 2 +- .../apis/videointelligence_v1beta2/classes.rb | 1659 ++++++------- .../apis/videointelligence_v1beta2/service.rb | 8 +- .../apis/videointelligence_v1p1beta1.rb | 2 +- .../videointelligence_v1p1beta1/classes.rb | 1659 ++++++------- .../videointelligence_v1p1beta1/service.rb | 8 +- .../apis/videointelligence_v1p2beta1.rb | 2 +- .../videointelligence_v1p2beta1/classes.rb | 1659 ++++++------- .../videointelligence_v1p2beta1/service.rb | 8 +- 49 files changed, 6345 insertions(+), 10510 deletions(-) delete mode 100644 generated/google/apis/dns_v2beta1.rb delete mode 100644 generated/google/apis/dns_v2beta1/classes.rb delete mode 100644 generated/google/apis/dns_v2beta1/representations.rb delete mode 100644 generated/google/apis/dns_v2beta1/service.rb diff --git a/api_names_out.yaml b/api_names_out.yaml index 3788345ca..e9d801e78 100644 --- a/api_names_out.yaml +++ b/api_names_out.yaml @@ -50763,6 +50763,7 @@ "/container:v1beta1/Cluster/nodeIpv4CidrSize": node_ipv4_cidr_size "/container:v1beta1/Cluster/nodePools": node_pools "/container:v1beta1/Cluster/nodePools/node_pool": node_pool +"/container:v1beta1/Cluster/notificationConfig": notification_config "/container:v1beta1/Cluster/podSecurityPolicyConfig": pod_security_policy_config "/container:v1beta1/Cluster/privateCluster": private_cluster "/container:v1beta1/Cluster/privateClusterConfig": private_cluster_config @@ -50797,6 +50798,7 @@ "/container:v1beta1/ClusterUpdate/desiredClusterAutoscaling": desired_cluster_autoscaling "/container:v1beta1/ClusterUpdate/desiredClusterTelemetry": desired_cluster_telemetry "/container:v1beta1/ClusterUpdate/desiredDatabaseEncryption": desired_database_encryption +"/container:v1beta1/ClusterUpdate/desiredDatapathProvider": desired_datapath_provider "/container:v1beta1/ClusterUpdate/desiredDefaultSnatStatus": desired_default_snat_status "/container:v1beta1/ClusterUpdate/desiredImageType": desired_image_type "/container:v1beta1/ClusterUpdate/desiredIntraNodeVisibilityConfig": desired_intra_node_visibility_config @@ -50810,6 +50812,7 @@ "/container:v1beta1/ClusterUpdate/desiredNodePoolAutoscaling": desired_node_pool_autoscaling "/container:v1beta1/ClusterUpdate/desiredNodePoolId": desired_node_pool_id "/container:v1beta1/ClusterUpdate/desiredNodeVersion": desired_node_version +"/container:v1beta1/ClusterUpdate/desiredNotificationConfig": desired_notification_config "/container:v1beta1/ClusterUpdate/desiredPodSecurityPolicyConfig": desired_pod_security_policy_config "/container:v1beta1/ClusterUpdate/desiredPrivateClusterConfig": desired_private_cluster_config "/container:v1beta1/ClusterUpdate/desiredReleaseChannel": desired_release_channel @@ -50987,6 +50990,7 @@ "/container:v1beta1/Metric/name": name "/container:v1beta1/Metric/stringValue": string_value "/container:v1beta1/NetworkConfig": network_config +"/container:v1beta1/NetworkConfig/datapathProvider": datapath_provider "/container:v1beta1/NetworkConfig/defaultSnatStatus": default_snat_status "/container:v1beta1/NetworkConfig/enableIntraNodeVisibility": enable_intra_node_visibility "/container:v1beta1/NetworkConfig/network": network @@ -51061,11 +51065,14 @@ "/container:v1beta1/NodeTaint/effect": effect "/container:v1beta1/NodeTaint/key": key "/container:v1beta1/NodeTaint/value": value +"/container:v1beta1/NotificationConfig": notification_config +"/container:v1beta1/NotificationConfig/pubsub": pubsub "/container:v1beta1/Operation": operation "/container:v1beta1/Operation/clusterConditions": cluster_conditions "/container:v1beta1/Operation/clusterConditions/cluster_condition": cluster_condition "/container:v1beta1/Operation/detail": detail "/container:v1beta1/Operation/endTime": end_time +"/container:v1beta1/Operation/error": error "/container:v1beta1/Operation/location": location "/container:v1beta1/Operation/name": name "/container:v1beta1/Operation/nodepoolConditions": nodepool_conditions @@ -51097,6 +51104,9 @@ "/container:v1beta1/PrivateClusterConfig/publicEndpoint": public_endpoint "/container:v1beta1/PrivateClusterMasterGlobalAccessConfig": private_cluster_master_global_access_config "/container:v1beta1/PrivateClusterMasterGlobalAccessConfig/enabled": enabled +"/container:v1beta1/PubSub": pub_sub +"/container:v1beta1/PubSub/enabled": enabled +"/container:v1beta1/PubSub/topic": topic "/container:v1beta1/RecurringTimeWindow": recurring_time_window "/container:v1beta1/RecurringTimeWindow/recurrence": recurrence "/container:v1beta1/RecurringTimeWindow/window": window @@ -51232,7 +51242,14 @@ "/container:v1beta1/StartIPRotationRequest/projectId": project_id "/container:v1beta1/StartIPRotationRequest/rotateCredentials": rotate_credentials "/container:v1beta1/StartIPRotationRequest/zone": zone +"/container:v1beta1/Status": status +"/container:v1beta1/Status/code": code +"/container:v1beta1/Status/details": details +"/container:v1beta1/Status/details/detail": detail +"/container:v1beta1/Status/details/detail/detail": detail +"/container:v1beta1/Status/message": message "/container:v1beta1/StatusCondition": status_condition +"/container:v1beta1/StatusCondition/canonicalCode": canonical_code "/container:v1beta1/StatusCondition/code": code "/container:v1beta1/StatusCondition/message": message "/container:v1beta1/TimeWindow": time_window @@ -51268,6 +51285,13 @@ "/container:v1beta1/UpdateNodePoolRequest/upgradeSettings": upgrade_settings "/container:v1beta1/UpdateNodePoolRequest/workloadMetadataConfig": workload_metadata_config "/container:v1beta1/UpdateNodePoolRequest/zone": zone +"/container:v1beta1/UpgradeEvent": upgrade_event +"/container:v1beta1/UpgradeEvent/currentVersion": current_version +"/container:v1beta1/UpgradeEvent/operation": operation +"/container:v1beta1/UpgradeEvent/operationStartTime": operation_start_time +"/container:v1beta1/UpgradeEvent/resource": resource +"/container:v1beta1/UpgradeEvent/resourceType": resource_type +"/container:v1beta1/UpgradeEvent/targetVersion": target_version "/container:v1beta1/UpgradeSettings": upgrade_settings "/container:v1beta1/UpgradeSettings/maxSurge": max_surge "/container:v1beta1/UpgradeSettings/maxUnavailable": max_unavailable @@ -112223,6 +112247,15 @@ "/people:v1/Locale": locale "/people:v1/Locale/metadata": metadata "/people:v1/Locale/value": value +"/people:v1/Location": location +"/people:v1/Location/buildingId": building_id +"/people:v1/Location/current": current +"/people:v1/Location/deskCode": desk_code +"/people:v1/Location/floor": floor +"/people:v1/Location/floorSection": floor_section +"/people:v1/Location/metadata": metadata +"/people:v1/Location/type": type +"/people:v1/Location/value": value "/people:v1/Membership": membership "/people:v1/Membership/contactGroupMembership": contact_group_membership "/people:v1/Membership/domainMembership": domain_membership @@ -112316,6 +112349,8 @@ "/people:v1/Person/interests/interest": interest "/people:v1/Person/locales": locales "/people:v1/Person/locales/locale": locale +"/people:v1/Person/locations": locations +"/people:v1/Person/locations/location": location "/people:v1/Person/memberships": memberships "/people:v1/Person/memberships/membership": membership "/people:v1/Person/metadata": metadata @@ -114239,6 +114274,7 @@ "/prod_tt_sasportal:v1alpha1/SasPortalDeviceGrant/channelType": channel_type "/prod_tt_sasportal:v1alpha1/SasPortalDeviceGrant/expireTime": expire_time "/prod_tt_sasportal:v1alpha1/SasPortalDeviceGrant/frequencyRange": frequency_range +"/prod_tt_sasportal:v1alpha1/SasPortalDeviceGrant/grantId": grant_id "/prod_tt_sasportal:v1alpha1/SasPortalDeviceGrant/maxEirp": max_eirp "/prod_tt_sasportal:v1alpha1/SasPortalDeviceGrant/moveList": move_list "/prod_tt_sasportal:v1alpha1/SasPortalDeviceGrant/moveList/move_list": move_list diff --git a/generated/google/apis/cloudfunctions_v1.rb b/generated/google/apis/cloudfunctions_v1.rb index 73d746459..01e840b63 100644 --- a/generated/google/apis/cloudfunctions_v1.rb +++ b/generated/google/apis/cloudfunctions_v1.rb @@ -25,7 +25,7 @@ module Google # @see https://cloud.google.com/functions module CloudfunctionsV1 VERSION = 'V1' - REVISION = '20200717' + 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/cloudfunctions_v1/classes.rb b/generated/google/apis/cloudfunctions_v1/classes.rb index 26c40a14b..02cb38cad 100644 --- a/generated/google/apis/cloudfunctions_v1/classes.rb +++ b/generated/google/apis/cloudfunctions_v1/classes.rb @@ -22,53 +22,21 @@ module Google module Apis module CloudfunctionsV1 - # 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 AuditConfig include Google::Apis::Core::Hashable @@ -77,9 +45,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 @@ -95,28 +63,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 AuditLogConfig 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] @@ -142,69 +97,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::CloudfunctionsV1::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 @@ -244,8 +187,8 @@ module Google class CallFunctionResponse include Google::Apis::Core::Hashable - # Either system or user-function generated error. Set if execution - # was not successful. + # Either system or user-function generated error. Set if execution was not + # successful. # Corresponds to the JSON property `error` # @return [String] attr_accessor :error @@ -255,8 +198,8 @@ module Google # @return [String] attr_accessor :execution_id - # Result populated for successful execution of synchronous function. Will - # not be populated if function does not return a result through context. + # Result populated for successful execution of synchronous function. Will not be + # populated if function does not return a result through context. # Corresponds to the JSON property `result` # @return [String] attr_accessor :result @@ -273,13 +216,12 @@ module Google end end - # Describes a Cloud Function that contains user computation executed in - # response to an event. It encapsulate function and triggers configurations. + # Describes a Cloud Function that contains user computation executed in response + # to an event. It encapsulate function and triggers configurations. class CloudFunction include Google::Apis::Core::Hashable - # The amount of memory in MB available for a function. - # Defaults to 256MB. + # The amount of memory in MB available for a function. Defaults to 256MB. # Corresponds to the JSON property `availableMemoryMb` # @return [Fixnum] attr_accessor :available_memory_mb @@ -295,12 +237,11 @@ module Google # @return [String] attr_accessor :description - # The name of the function (as defined in source code) that will be - # executed. Defaults to the resource name suffix, if not specified. For - # backward compatibility, if function with given name is not found, then the - # system will try to use function named "function". - # For Node.js this is name of a function exported by the module specified - # in `source_location`. + # The name of the function (as defined in source code) that will be executed. + # Defaults to the resource name suffix, if not specified. For backward + # compatibility, if function with given name is not found, then the system will + # try to use function named "function". For Node.js this is name of a function + # exported by the module specified in `source_location`. # Corresponds to the JSON property `entryPoint` # @return [String] attr_accessor :entry_point @@ -310,8 +251,7 @@ module Google # @return [Hash] attr_accessor :environment_variables - # Describes EventTrigger, used to request events be sent from another - # service. + # Describes EventTrigger, used to request events be sent from another service. # Corresponds to the JSON property `eventTrigger` # @return [Google::Apis::CloudfunctionsV1::EventTrigger] attr_accessor :event_trigger @@ -321,8 +261,7 @@ module Google # @return [Google::Apis::CloudfunctionsV1::HttpsTrigger] attr_accessor :https_trigger - # The ingress settings for the function, controlling what traffic can reach - # it. + # The ingress settings for the function, controlling what traffic can reach it. # Corresponds to the JSON property `ingressSettings` # @return [String] attr_accessor :ingress_settings @@ -338,57 +277,54 @@ module Google # @return [Fixnum] attr_accessor :max_instances - # A user-defined name of the function. Function names must be unique - # globally and match pattern `projects/*/locations/*/functions/*` + # A user-defined name of the function. Function names must be unique globally + # and match pattern `projects/*/locations/*/functions/*` # Corresponds to the JSON property `name` # @return [String] attr_accessor :name - # The VPC Network that this cloud function can connect to. It can be - # either the fully-qualified URI, or the short name of the network resource. - # If the short network name is used, the network must belong to the same - # project. Otherwise, it must belong to a project within the same - # organization. The format of this field is either - # `projects/`project`/global/networks/`network`` or ``network``, where - # `project` is a project id where the network is defined, and `network` is - # the short name of the network. - # This field is mutually exclusive with `vpc_connector` and will be replaced - # by it. - # See [the VPC documentation](https://cloud.google.com/compute/docs/vpc) for - # more information on connecting Cloud projects. + # The VPC Network that this cloud function can connect to. It can be either the + # fully-qualified URI, or the short name of the network resource. If the short + # network name is used, the network must belong to the same project. Otherwise, + # it must belong to a project within the same organization. The format of this + # field is either `projects/`project`/global/networks/`network`` or ``network``, + # where `project` is a project id where the network is defined, and `network` is + # the short name of the network. This field is mutually exclusive with ` + # vpc_connector` and will be replaced by it. See [the VPC documentation](https:// + # cloud.google.com/compute/docs/vpc) for more information on connecting Cloud + # projects. # Corresponds to the JSON property `network` # @return [String] attr_accessor :network # The runtime in which to run the function. Required when deploying a new - # function, optional when updating an existing function. For a complete - # list of possible choices, see the - # [`gcloud` command - # reference](/sdk/gcloud/reference/functions/deploy#--runtime). + # function, optional when updating an existing function. For a complete list of + # possible choices, see the [`gcloud` command reference](/sdk/gcloud/reference/ + # functions/deploy#--runtime). # Corresponds to the JSON property `runtime` # @return [String] attr_accessor :runtime - # The email of the function's service account. If empty, defaults to - # ``project_id`@appspot.gserviceaccount.com`. + # The email of the function's service account. If empty, defaults to `` + # project_id`@appspot.gserviceaccount.com`. # Corresponds to the JSON property `serviceAccountEmail` # @return [String] attr_accessor :service_account_email - # The Google Cloud Storage URL, starting with gs://, pointing to the zip - # archive which contains the function. + # The Google Cloud Storage URL, starting with gs://, pointing to the zip archive + # which contains the function. # Corresponds to the JSON property `sourceArchiveUrl` # @return [String] attr_accessor :source_archive_url - # Describes SourceRepository, used to represent parameters related to - # source repository where a function is hosted. + # Describes SourceRepository, used to represent parameters related to source + # repository where a function is hosted. # Corresponds to the JSON property `sourceRepository` # @return [Google::Apis::CloudfunctionsV1::SourceRepository] attr_accessor :source_repository - # The Google Cloud Storage signed URL used for source uploading, generated - # by google.cloud.functions.v1.GenerateUploadUrl + # The Google Cloud Storage signed URL used for source uploading, generated by + # google.cloud.functions.v1.GenerateUploadUrl # Corresponds to the JSON property `sourceUploadUrl` # @return [String] attr_accessor :source_upload_url @@ -398,9 +334,9 @@ module Google # @return [String] attr_accessor :status - # The function execution timeout. Execution is considered failed and - # can be terminated if the function is not completed at the end of the - # timeout period. Defaults to 60 seconds. + # The function execution timeout. Execution is considered failed and can be + # terminated if the function is not completed at the end of the timeout period. + # Defaults to 60 seconds. # Corresponds to the JSON property `timeout` # @return [String] attr_accessor :timeout @@ -411,20 +347,17 @@ module Google attr_accessor :update_time # Output only. The version identifier of the Cloud Function. Each deployment - # attempt - # results in a new version of a function being created. + # attempt results in a new version of a function being created. # Corresponds to the JSON property `versionId` # @return [Fixnum] attr_accessor :version_id - # The VPC Network Connector that this cloud function can connect to. It can - # be either the fully-qualified URI, or the short name of the network - # connector resource. The format of this field is - # `projects/*/locations/*/connectors/*` + # The VPC Network Connector that this cloud function can connect to. It can be + # either the fully-qualified URI, or the short name of the network connector + # resource. The format of this field is `projects/*/locations/*/connectors/*` # This field is mutually exclusive with `network` field and will eventually - # replace it. - # See [the VPC documentation](https://cloud.google.com/compute/docs/vpc) for - # more information on connecting Cloud projects. + # replace it. See [the VPC documentation](https://cloud.google.com/compute/docs/ + # vpc) for more information on connecting Cloud projects. # Corresponds to the JSON property `vpcConnector` # @return [String] attr_accessor :vpc_connector @@ -467,56 +400,47 @@ module Google end end - # Describes EventTrigger, used to request events be sent from another - # service. + # Describes EventTrigger, used to request events be sent from another service. class EventTrigger include Google::Apis::Core::Hashable - # Required. The type of event to observe. For example: - # `providers/cloud.storage/eventTypes/object.change` and - # `providers/cloud.pubsub/eventTypes/topic.publish`. - # Event types match pattern `providers/*/eventTypes/*.*`. - # The pattern contains: - # 1. namespace: For example, `cloud.storage` and - # `google.firebase.analytics`. - # 2. resource type: The type of resource on which event occurs. For - # example, the Google Cloud Storage API includes the type `object`. - # 3. action: The action that generates the event. For example, action for - # a Google Cloud Storage Object is 'change'. - # These parts are lower case. + # Required. The type of event to observe. For example: `providers/cloud.storage/ + # eventTypes/object.change` and `providers/cloud.pubsub/eventTypes/topic.publish` + # . Event types match pattern `providers/*/eventTypes/*.*`. The pattern contains: + # 1. namespace: For example, `cloud.storage` and `google.firebase.analytics`. 2. + # resource type: The type of resource on which event occurs. For example, the + # Google Cloud Storage API includes the type `object`. 3. action: The action + # that generates the event. For example, action for a Google Cloud Storage + # Object is 'change'. These parts are lower case. # Corresponds to the JSON property `eventType` # @return [String] attr_accessor :event_type - # Describes the policy in case of function's execution failure. - # If empty, then defaults to ignoring failures (i.e. not retrying them). + # Describes the policy in case of function's execution failure. If empty, then + # defaults to ignoring failures (i.e. not retrying them). # Corresponds to the JSON property `failurePolicy` # @return [Google::Apis::CloudfunctionsV1::FailurePolicy] attr_accessor :failure_policy - # Required. The resource(s) from which to observe events, for example, - # `projects/_/buckets/myBucket`. - # Not all syntactically correct values are accepted by all services. For - # example: - # 1. The authorization model must support it. Google Cloud Functions - # only allows EventTriggers to be deployed that observe resources in the - # same project as the `CloudFunction`. - # 2. The resource type must match the pattern expected for an - # `event_type`. For example, an `EventTrigger` that has an - # `event_type` of "google.pubsub.topic.publish" should have a resource - # that matches Google Cloud Pub/Sub topics. - # Additionally, some services may support short names when creating an - # `EventTrigger`. These will always be returned in the normalized "long" - # format. - # See each *service's* documentation for supported formats. + # Required. The resource(s) from which to observe events, for example, `projects/ + # _/buckets/myBucket`. Not all syntactically correct values are accepted by all + # services. For example: 1. The authorization model must support it. Google + # Cloud Functions only allows EventTriggers to be deployed that observe + # resources in the same project as the `CloudFunction`. 2. The resource type + # must match the pattern expected for an `event_type`. For example, an ` + # EventTrigger` that has an `event_type` of "google.pubsub.topic.publish" should + # have a resource that matches Google Cloud Pub/Sub topics. Additionally, some + # services may support short names when creating an `EventTrigger`. These will + # always be returned in the normalized "long" format. See each *service's* + # documentation for supported formats. # Corresponds to the JSON property `resource` # @return [String] attr_accessor :resource - # The hostname of the service that should be observed. - # If no string is provided, the default service implementing the API will - # be used. For example, `storage.googleapis.com` is the default for all - # event types in the `google.storage` namespace. + # The hostname of the service that should be observed. If no string is provided, + # the default service implementing the API will be used. For example, `storage. + # googleapis.com` is the default for all event types in the `google.storage` + # namespace. # Corresponds to the JSON property `service` # @return [String] attr_accessor :service @@ -534,52 +458,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 @@ -597,16 +512,15 @@ module Google end end - # Describes the policy in case of function's execution failure. - # If empty, then defaults to ignoring failures (i.e. not retrying them). + # Describes the policy in case of function's execution failure. If empty, then + # defaults to ignoring failures (i.e. not retrying them). class FailurePolicy include Google::Apis::Core::Hashable - # Describes the retry policy in case of function's execution failure. - # A function execution will be retried on any failure. - # A failed execution will be retried up to 7 days with an exponential backoff - # (capped at 10 seconds). - # Retried execution is charged as any other execution. + # Describes the retry policy in case of function's execution failure. A function + # execution will be retried on any failure. A failed execution will be retried + # up to 7 days with an exponential backoff (capped at 10 seconds). Retried + # execution is charged as any other execution. # Corresponds to the JSON property `retry` # @return [Google::Apis::CloudfunctionsV1::Retry] attr_accessor :retry @@ -625,8 +539,7 @@ module Google class GenerateDownloadUrlRequest include Google::Apis::Core::Hashable - # The optional version of function. If not set, default, current version - # is used. + # The optional version of function. If not set, default, current version is used. # Corresponds to the JSON property `versionId` # @return [Fixnum] attr_accessor :version_id @@ -645,8 +558,8 @@ module Google class GenerateDownloadUrlResponse include Google::Apis::Core::Hashable - # The generated Google Cloud Storage signed URL that should be used for - # function source code download. + # The generated Google Cloud Storage signed URL that should be used for function + # source code download. # Corresponds to the JSON property `downloadUrl` # @return [String] attr_accessor :download_url @@ -679,8 +592,8 @@ module Google include Google::Apis::Core::Hashable # The generated Google Cloud Storage signed URL that should be used for a - # function source code upload. The uploaded file should be a zip archive - # which contains a function. + # function source code upload. The uploaded file should be a zip archive which + # contains a function. # Corresponds to the JSON property `uploadUrl` # @return [String] attr_accessor :upload_url @@ -723,10 +636,9 @@ module Google # @return [Array] attr_accessor :functions - # If not empty, indicates that there may be more functions that match - # the request; this value should be passed in a new - # google.cloud.functions.v1.ListFunctionsRequest - # to get more functions. + # If not empty, indicates that there may be more functions that match the + # request; this value should be passed in a new google.cloud.functions.v1. + # ListFunctionsRequest to get more functions. # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token @@ -803,14 +715,14 @@ module Google class Location include Google::Apis::Core::Hashable - # The friendly name for this location, typically a nearby city name. - # For example, "Tokyo". + # The friendly name for this location, typically a nearby city name. For example, + # "Tokyo". # Corresponds to the JSON property `displayName` # @return [String] attr_accessor :display_name - # Cross-service attributes for the location. For example - # `"cloud.googleapis.com/region": "us-east1"` + # Cross-service attributes for the location. For example `"cloud.googleapis.com/ + # region": "us-east1"` # Corresponds to the JSON property `labels` # @return [Hash] attr_accessor :labels @@ -826,8 +738,8 @@ module Google # @return [Hash] attr_accessor :metadata - # Resource name for the location, which may vary between implementations. - # For example: `"projects/example-project/locations/us-east1"` + # Resource name for the location, which may vary between implementations. For + # example: `"projects/example-project/locations/us-east1"` # Corresponds to the JSON property `name` # @return [String] attr_accessor :name @@ -851,47 +763,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::CloudfunctionsV1::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 @@ -914,8 +824,8 @@ module Google class OperationMetadataV1 include Google::Apis::Core::Hashable - # The Cloud Build ID of the function created or updated by an API call. - # This field is only populated for Create and Update operations. + # The Cloud Build ID of the function created or updated by an API call. This + # field is only populated for Create and Update operations. # Corresponds to the JSON property `buildId` # @return [String] attr_accessor :build_id @@ -925,8 +835,8 @@ module Google # @return [Hash] attr_accessor :request - # Target of the operation - for example - # projects/project-1/locations/region-1/functions/function-1 + # Target of the operation - for example projects/project-1/locations/region-1/ + # functions/function-1 # Corresponds to the JSON property `target` # @return [String] attr_accessor :target @@ -941,8 +851,8 @@ module Google # @return [String] attr_accessor :update_time - # Version id of the function created or updated by an API call. - # This field is only populated for Create and Update operations. + # Version id of the function created or updated by an API call. This field is + # only populated for Create and Update operations. # Corresponds to the JSON property `versionId` # @return [Fixnum] attr_accessor :version_id @@ -963,66 +873,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 Policy include Google::Apis::Core::Hashable @@ -1031,48 +907,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 @@ -1090,11 +962,10 @@ module Google end end - # Describes the retry policy in case of function's execution failure. - # A function execution will be retried on any failure. - # A failed execution will be retried up to 7 days with an exponential backoff - # (capped at 10 seconds). - # Retried execution is charged as any other execution. + # Describes the retry policy in case of function's execution failure. A function + # execution will be retried on any failure. A failed execution will be retried + # up to 7 days with an exponential backoff (capped at 10 seconds). Retried + # execution is charged as any other execution. class Retry include Google::Apis::Core::Hashable @@ -1112,74 +983,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::CloudfunctionsV1::Policy] 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 @@ -1195,31 +1031,27 @@ module Google end end - # Describes SourceRepository, used to represent parameters related to - # source repository where a function is hosted. + # Describes SourceRepository, used to represent parameters related to source + # repository where a function is hosted. class SourceRepository include Google::Apis::Core::Hashable - # Output only. The URL pointing to the hosted repository where the function - # were defined at the time of deployment. It always points to a specific - # commit in the format described above. + # Output only. The URL pointing to the hosted repository where the function were + # defined at the time of deployment. It always points to a specific commit in + # the format described above. # Corresponds to the JSON property `deployedUrl` # @return [String] attr_accessor :deployed_url - # The URL pointing to the hosted repository where the function is defined. - # There are supported Cloud Source Repository URLs in the following - # formats: - # To refer to a specific commit: - # `https://source.developers.google.com/projects/*/repos/*/revisions/*/paths/*` - # To refer to a moveable alias (branch): - # `https://source.developers.google.com/projects/*/repos/*/moveable-aliases/*/ - # paths/*` - # In particular, to refer to HEAD use `master` moveable alias. - # To refer to a specific fixed alias (tag): - # `https://source.developers.google.com/projects/*/repos/*/fixed-aliases/*/paths/ - # *` - # You may omit `paths/*` if you want to use the main directory. + # The URL pointing to the hosted repository where the function is defined. There + # are supported Cloud Source Repository URLs in the following formats: To refer + # to a specific commit: `https://source.developers.google.com/projects/*/repos/*/ + # revisions/*/paths/*` To refer to a moveable alias (branch): `https://source. + # developers.google.com/projects/*/repos/*/moveable-aliases/*/paths/*` In + # particular, to refer to HEAD use `master` moveable alias. To refer to a + # specific fixed alias (tag): `https://source.developers.google.com/projects/*/ + # repos/*/fixed-aliases/*/paths/*` You may omit `paths/*` if you want to use the + # main directory. # Corresponds to the JSON property `url` # @return [String] attr_accessor :url @@ -1235,12 +1067,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 @@ -1249,15 +1081,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 @@ -1278,10 +1110,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 @@ -1300,8 +1131,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/cloudfunctions_v1/service.rb b/generated/google/apis/cloudfunctions_v1/service.rb index fc750a173..f891ec922 100644 --- a/generated/google/apis/cloudfunctions_v1/service.rb +++ b/generated/google/apis/cloudfunctions_v1/service.rb @@ -47,9 +47,8 @@ module Google @batch_path = 'batch' 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 @@ -79,30 +78,28 @@ 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] filter - # Required. A filter for matching the requested operations.

The - # supported formats of filter are:
To query for a specific function: < - # code>project:*,location:*,function:*
To query for all of the latest - # operations for a project: project:*,latest:true + # Required. A filter for matching the requested operations. The supported + # formats of *filter* are: To query for a specific function: project:*,location:* + # ,function:* To query for all of the latest operations for a project: project:*, + # latest:true # @param [String] name # Must not be set. # @param [Fixnum] page_size - # The maximum number of records that should be returned.
Requested page size - # cannot exceed 100. If not set, the default page size is 100.

- # Pagination is only supported when querying for a specific function. + # The maximum number of records that should be returned. Requested page size + # cannot exceed 100. If not set, the default page size is 100. Pagination is + # only supported when querying for a specific function. # @param [String] page_token # Token identifying which result to start with, which is returned by a previous - # list call.

Pagination is only supported when querying for a specific - # function. + # list call. Pagination is only supported when querying for a specific function. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -173,9 +170,9 @@ module Google end # Synchronously invokes a deployed Cloud Function. To be used for testing - # purposes as very limited traffic is allowed. For more information on - # the actual limits, refer to - # [Rate Limits](https://cloud.google.com/functions/quotas#rate_limits). + # purposes as very limited traffic is allowed. For more information on the + # actual limits, refer to [Rate Limits](https://cloud.google.com/functions/ + # quotas#rate_limits). # @param [String] name # Required. The name of the function to be called. # @param [Google::Apis::CloudfunctionsV1::CallFunctionRequest] call_function_request_object @@ -209,12 +206,11 @@ module Google end # Creates a new function. If a function with the given name already exists in - # the specified project, the long running operation will return - # `ALREADY_EXISTS` error. + # the specified project, the long running operation will return `ALREADY_EXISTS` + # error. # @param [String] location # Required. The project and location in which the function should be created, - # specified - # in the format `projects/*/locations/*` + # specified in the format `projects/*/locations/*` # @param [Google::Apis::CloudfunctionsV1::CloudFunction] cloud_function_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -246,8 +242,8 @@ module Google end # Deletes a function with the given name from the specified project. If the - # given function is used by some trigger, the trigger will be updated to - # remove this function. + # given function is used by some trigger, the trigger will be updated to remove + # this function. # @param [String] name # Required. The name of the function which should be deleted. # @param [String] fields @@ -277,14 +273,13 @@ module Google execute_or_queue_command(command, &block) end - # Returns a signed URL for downloading deployed function source code. - # The URL is only valid for a limited period and should be used within - # minutes after generation. - # For more information about the signed URL usage see: - # https://cloud.google.com/storage/docs/access-control/signed-urls + # Returns a signed URL for downloading deployed function source code. The URL is + # only valid for a limited period and should be used within minutes after + # generation. For more information about the signed URL usage see: https://cloud. + # google.com/storage/docs/access-control/signed-urls # @param [String] name - # The name of function for which source code Google Cloud Storage signed - # URL should be generated. + # The name of function for which source code Google Cloud Storage signed URL + # should be generated. # @param [Google::Apis::CloudfunctionsV1::GenerateDownloadUrlRequest] generate_download_url_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -315,28 +310,24 @@ module Google execute_or_queue_command(command, &block) end - # Returns a signed URL for uploading a function source code. - # For more information about the signed URL usage see: - # https://cloud.google.com/storage/docs/access-control/signed-urls. - # Once the function source code upload is complete, the used signed - # URL should be provided in CreateFunction or UpdateFunction request - # as a reference to the function source code. - # When uploading source code to the generated signed URL, please follow - # these restrictions: - # * Source file type should be a zip file. - # * Source file size should not exceed 100MB limit. - # * No credentials should be attached - the signed URLs provide access to the - # target bucket using internal service identity; if credentials were - # attached, the identity from the credentials would be used, but that - # identity does not have permissions to upload files to the URL. - # When making a HTTP PUT request, these two headers need to be specified: - # * `content-type: application/zip` - # * `x-goog-content-length-range: 0,104857600` - # And this header SHOULD NOT be specified: - # * `Authorization: Bearer YOUR_TOKEN` + # Returns a signed URL for uploading a function source code. For more + # information about the signed URL usage see: https://cloud.google.com/storage/ + # docs/access-control/signed-urls. Once the function source code upload is + # complete, the used signed URL should be provided in CreateFunction or + # UpdateFunction request as a reference to the function source code. When + # uploading source code to the generated signed URL, please follow these + # restrictions: * Source file type should be a zip file. * Source file size + # should not exceed 100MB limit. * No credentials should be attached - the + # signed URLs provide access to the target bucket using internal service + # identity; if credentials were attached, the identity from the credentials + # would be used, but that identity does not have permissions to upload files to + # the URL. When making a HTTP PUT request, these two headers need to be + # specified: * `content-type: application/zip` * `x-goog-content-length-range: 0, + # 104857600` And this header SHOULD NOT be specified: * `Authorization: Bearer + # YOUR_TOKEN` # @param [String] parent - # The project and location in which the Google Cloud Storage signed URL - # should be generated, specified in the format `projects/*/locations/*`. + # The project and location in which the Google Cloud Storage signed URL should + # be generated, specified in the format `projects/*/locations/*`. # @param [Google::Apis::CloudfunctionsV1::GenerateUploadUrlRequest] generate_upload_url_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -397,22 +388,19 @@ module Google execute_or_queue_command(command, &block) end - # Gets the IAM access control policy for a function. - # Returns an empty policy if the function exists and does not have a policy - # set. + # Gets the IAM access control policy for a function. Returns an empty policy if + # the function 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 @@ -443,19 +431,18 @@ module Google # Returns a list of functions that belong to the requested project. # @param [String] parent - # The project and location from which the function should be listed, - # specified in the format `projects/*/locations/*` - # If you want to list functions in all locations, use "-" in place of a - # location. When listing functions in all locations, if one or more - # location(s) are unreachable, the response will contain functions from all - # reachable locations along with the names of any unreachable locations. + # The project and location from which the function should be listed, specified + # in the format `projects/*/locations/*` If you want to list functions in all + # locations, use "-" in place of a location. When listing functions in all + # locations, if one or more location(s) are unreachable, the response will + # contain functions from all reachable locations along with the names of any + # unreachable locations. # @param [Fixnum] page_size # Maximum number of functions to return per call. # @param [String] page_token - # The value returned by the last - # `ListFunctionsResponse`; indicates that - # this is a continuation of a prior `ListFunctions` call, and that the - # system should return the next page of data. + # The value returned by the last `ListFunctionsResponse`; indicates that this is + # a continuation of a prior `ListFunctions` 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 @@ -487,8 +474,8 @@ module Google # Updates existing function. # @param [String] name - # A user-defined name of the function. Function names must be unique - # globally and match pattern `projects/*/locations/*/functions/*` + # A user-defined name of the function. Function names must be unique globally + # and match pattern `projects/*/locations/*/functions/*` # @param [Google::Apis::CloudfunctionsV1::CloudFunction] cloud_function_object # @param [String] update_mask # Required list of fields to be updated in this request. @@ -522,11 +509,11 @@ module Google execute_or_queue_command(command, &block) end - # Sets the IAM access control policy on the specified function. - # Replaces any existing policy. + # Sets the IAM access control policy on the specified function. Replaces any + # existing policy. # @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::CloudfunctionsV1::SetIamPolicyRequest] set_iam_policy_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -557,13 +544,12 @@ module Google execute_or_queue_command(command, &block) end - # Tests the specified permissions against the IAM access control policy - # for a function. - # If the function does not exist, this will return an empty set of + # Tests the specified permissions against the IAM access control policy for a + # function. If the function does not exist, this will return an empty set of # permissions, not a NOT_FOUND error. # @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::CloudfunctionsV1::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/cloudtasks_v2.rb b/generated/google/apis/cloudtasks_v2.rb index f4ca382a2..22cf6076d 100644 --- a/generated/google/apis/cloudtasks_v2.rb +++ b/generated/google/apis/cloudtasks_v2.rb @@ -25,7 +25,7 @@ module Google # @see https://cloud.google.com/tasks/ module CloudtasksV2 VERSION = 'V2' - REVISION = '20200529' + REVISION = '20200804' # 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/cloudtasks_v2/classes.rb b/generated/google/apis/cloudtasks_v2/classes.rb index b1a47c148..953e84d8f 100644 --- a/generated/google/apis/cloudtasks_v2/classes.rb +++ b/generated/google/apis/cloudtasks_v2/classes.rb @@ -22,152 +22,106 @@ module Google module Apis module CloudtasksV2 - # App Engine HTTP request. - # The message defines the HTTP request that is sent to an App Engine app when - # the task is dispatched. - # Using AppEngineHttpRequest requires - # [`appengine.applications.get`](https://cloud.google.com/appengine/docs/admin- - # api/access-control) - # Google IAM permission for the project - # and the following scope: - # `https://www.googleapis.com/auth/cloud-platform` - # The task will be delivered to the App Engine app which belongs to the same - # project as the queue. For more information, see - # [How Requests are - # Routed](https://cloud.google.com/appengine/docs/standard/python/how-requests- - # are-routed) - # and how routing is affected by - # [dispatch - # files](https://cloud.google.com/appengine/docs/python/config/dispatchref). - # Traffic is encrypted during transport and never leaves Google datacenters. - # Because this traffic is carried over a communication mechanism internal to - # Google, you cannot explicitly set the protocol (for example, HTTP or HTTPS). - # The request to the handler, however, will appear to have used the HTTP - # protocol. - # The AppEngineRouting used to construct the URL that the task is - # delivered to can be set at the queue-level or task-level: - # * If app_engine_routing_override is set on the - # queue, this value - # is used for all tasks in the queue, no matter what the setting is for the - # task-level - # app_engine_routing. - # The `url` that the task will be sent to is: - # * `url =` host `+` - # relative_uri - # Tasks can be dispatched to secure app handlers, unsecure app handlers, and - # URIs restricted with - # [`login: - # admin`](https://cloud.google.com/appengine/docs/standard/python/config/appref). - # Because tasks are not run as any user, they cannot be dispatched to URIs - # restricted with - # [`login: - # required`](https://cloud.google.com/appengine/docs/standard/python/config/ - # appref) - # Task dispatches also do not follow redirects. - # The task attempt has succeeded if the app's request handler returns an HTTP - # response code in the range [`200` - `299`]. The task attempt has failed if - # the app's handler returns a non-2xx response code or Cloud Tasks does - # not receive response before the deadline. Failed - # tasks will be retried according to the - # retry configuration. `503` (Service Unavailable) is - # considered an App Engine system error instead of an application error and - # will cause Cloud Tasks' traffic congestion control to temporarily throttle - # the queue's dispatches. Unlike other types of task targets, a `429` (Too Many - # Requests) response from an app handler does not cause traffic congestion - # control to throttle the queue. + # App Engine HTTP request. The message defines the HTTP request that is sent to + # an App Engine app when the task is dispatched. Using AppEngineHttpRequest + # requires [`appengine.applications.get`](https://cloud.google.com/appengine/ + # docs/admin-api/access-control) Google IAM permission for the project and the + # following scope: `https://www.googleapis.com/auth/cloud-platform` The task + # will be delivered to the App Engine app which belongs to the same project as + # the queue. For more information, see [How Requests are Routed](https://cloud. + # google.com/appengine/docs/standard/python/how-requests-are-routed) and how + # routing is affected by [dispatch files](https://cloud.google.com/appengine/ + # docs/python/config/dispatchref). Traffic is encrypted during transport and + # never leaves Google datacenters. Because this traffic is carried over a + # communication mechanism internal to Google, you cannot explicitly set the + # protocol (for example, HTTP or HTTPS). The request to the handler, however, + # will appear to have used the HTTP protocol. The AppEngineRouting used to + # construct the URL that the task is delivered to can be set at the queue-level + # or task-level: * If app_engine_routing_override is set on the queue, this + # value is used for all tasks in the queue, no matter what the setting is for + # the task-level app_engine_routing. The `url` that the task will be sent to is: + # * `url =` host `+` relative_uri Tasks can be dispatched to secure app handlers, + # unsecure app handlers, and URIs restricted with [`login: admin`](https:// + # cloud.google.com/appengine/docs/standard/python/config/appref). Because tasks + # are not run as any user, they cannot be dispatched to URIs restricted with [` + # login: required`](https://cloud.google.com/appengine/docs/standard/python/ + # config/appref) Task dispatches also do not follow redirects. The task attempt + # has succeeded if the app's request handler returns an HTTP response code in + # the range [`200` - `299`]. The task attempt has failed if the app's handler + # returns a non-2xx response code or Cloud Tasks does not receive response + # before the deadline. Failed tasks will be retried according to the retry + # configuration. `503` (Service Unavailable) is considered an App Engine system + # error instead of an application error and will cause Cloud Tasks' traffic + # congestion control to temporarily throttle the queue's dispatches. Unlike + # other types of task targets, a `429` (Too Many Requests) response from an app + # handler does not cause traffic congestion control to throttle the queue. class AppEngineHttpRequest include Google::Apis::Core::Hashable - # App Engine Routing. - # Defines routing characteristics specific to App Engine - service, version, - # and instance. - # For more information about services, versions, and instances see - # [An Overview of App - # Engine](https://cloud.google.com/appengine/docs/python/an-overview-of-app- - # engine), - # [Microservices Architecture on Google App - # Engine](https://cloud.google.com/appengine/docs/python/microservices-on-app- - # engine), - # [App Engine Standard request - # routing](https://cloud.google.com/appengine/docs/standard/python/how-requests- - # are-routed), - # and [App Engine Flex request - # routing](https://cloud.google.com/appengine/docs/flexible/python/how-requests- - # are-routed). - # Using AppEngineRouting requires - # [`appengine.applications.get`](https://cloud.google.com/appengine/docs/admin- - # api/access-control) - # Google IAM permission for the project - # and the following scope: + # App Engine Routing. Defines routing characteristics specific to App Engine - + # service, version, and instance. For more information about services, versions, + # and instances see [An Overview of App Engine](https://cloud.google.com/ + # appengine/docs/python/an-overview-of-app-engine), [Microservices Architecture + # on Google App Engine](https://cloud.google.com/appengine/docs/python/ + # microservices-on-app-engine), [App Engine Standard request routing](https:// + # cloud.google.com/appengine/docs/standard/python/how-requests-are-routed), and [ + # App Engine Flex request routing](https://cloud.google.com/appengine/docs/ + # flexible/python/how-requests-are-routed). Using AppEngineRouting requires [` + # appengine.applications.get`](https://cloud.google.com/appengine/docs/admin-api/ + # access-control) Google IAM permission for the project and the following scope: # `https://www.googleapis.com/auth/cloud-platform` # Corresponds to the JSON property `appEngineRouting` # @return [Google::Apis::CloudtasksV2::AppEngineRouting] attr_accessor :app_engine_routing - # HTTP request body. - # A request body is allowed only if the HTTP method is POST or PUT. It is - # an error to set a body on a task with an incompatible HttpMethod. + # HTTP request body. A request body is allowed only if the HTTP method is POST + # or PUT. It is an error to set a body on a task with an incompatible HttpMethod. # Corresponds to the JSON property `body` # NOTE: Values are automatically base64 encoded/decoded in the client library. # @return [String] attr_accessor :body - # HTTP request headers. - # This map contains the header field names and values. - # Headers can be set when the - # task is created. - # Repeated headers are not supported but a header value can contain commas. - # Cloud Tasks sets some headers to default values: - # * `User-Agent`: By default, this header is - # `"AppEngine-Google; (+http://code.google.com/appengine)"`. - # This header can be modified, but Cloud Tasks will append - # `"AppEngine-Google; (+http://code.google.com/appengine)"` to the - # modified `User-Agent`. - # If the task has a body, Cloud - # Tasks sets the following headers: - # * `Content-Type`: By default, the `Content-Type` header is set to - # `"application/octet-stream"`. The default can be overridden by explicitly - # setting `Content-Type` to a particular media type when the - # task is created. - # For example, `Content-Type` can be set to `"application/json"`. - # * `Content-Length`: This is computed by Cloud Tasks. This value is - # output only. It cannot be changed. - # The headers below cannot be set or overridden: - # * `Host` - # * `X-Google-*` - # * `X-AppEngine-*` - # In addition, Cloud Tasks sets some headers when the task is dispatched, - # such as headers containing information about the task; see - # [request - # headers](https://cloud.google.com/tasks/docs/creating-appengine-handlers# - # reading_request_headers). - # These headers are set only when the task is dispatched, so they are not - # visible when the task is returned in a Cloud Tasks response. - # Although there is no specific limit for the maximum number of headers or - # the size, there is a limit on the maximum size of the Task. For more - # information, see the CreateTask documentation. + # HTTP request headers. This map contains the header field names and values. + # Headers can be set when the task is created. Repeated headers are not + # supported but a header value can contain commas. Cloud Tasks sets some headers + # to default values: * `User-Agent`: By default, this header is `"AppEngine- + # Google; (+http://code.google.com/appengine)"`. This header can be modified, + # but Cloud Tasks will append `"AppEngine-Google; (+http://code.google.com/ + # appengine)"` to the modified `User-Agent`. If the task has a body, Cloud Tasks + # sets the following headers: * `Content-Type`: By default, the `Content-Type` + # header is set to `"application/octet-stream"`. The default can be overridden + # by explicitly setting `Content-Type` to a particular media type when the task + # is created. For example, `Content-Type` can be set to `"application/json"`. * ` + # Content-Length`: This is computed by Cloud Tasks. This value is output only. + # It cannot be changed. The headers below cannot be set or overridden: * `Host` * + # `X-Google-*` * `X-AppEngine-*` In addition, Cloud Tasks sets some headers + # when the task is dispatched, such as headers containing information about the + # task; see [request headers](https://cloud.google.com/tasks/docs/creating- + # appengine-handlers#reading_request_headers). These headers are set only when + # the task is dispatched, so they are not visible when the task is returned in a + # Cloud Tasks response. Although there is no specific limit for the maximum + # number of headers or the size, there is a limit on the maximum size of the + # Task. For more information, see the CreateTask documentation. # Corresponds to the JSON property `headers` # @return [Hash] attr_accessor :headers - # The HTTP method to use for the request. The default is POST. - # The app's request handler for the task's target URL must be able to handle - # HTTP requests with this http_method, otherwise the task attempt fails with - # error code 405 (Method Not Allowed). See [Writing a push task request - # handler](https://cloud.google.com/appengine/docs/java/taskqueue/push/creating- - # handlers#writing_a_push_task_request_handler) - # and the App Engine documentation for your runtime on [How Requests are - # Handled](https://cloud.google.com/appengine/docs/standard/python3/how-requests- - # are-handled). + # The HTTP method to use for the request. The default is POST. The app's request + # handler for the task's target URL must be able to handle HTTP requests with + # this http_method, otherwise the task attempt fails with error code 405 (Method + # Not Allowed). See [Writing a push task request handler](https://cloud.google. + # com/appengine/docs/java/taskqueue/push/creating-handlers# + # writing_a_push_task_request_handler) and the App Engine documentation for your + # runtime on [How Requests are Handled](https://cloud.google.com/appengine/docs/ + # standard/python3/how-requests-are-handled). # Corresponds to the JSON property `httpMethod` # @return [String] attr_accessor :http_method - # The relative URI. - # The relative URI must begin with "/" and must be a valid HTTP relative URI. - # It can contain a path and query string arguments. - # If the relative URI is empty, then the root path "/" will be used. - # No spaces are allowed, and the maximum length allowed is 2083 characters. + # The relative URI. The relative URI must begin with "/" and must be a valid + # HTTP relative URI. It can contain a path and query string arguments. If the + # relative URI is empty, then the root path "/" will be used. No spaces are + # allowed, and the maximum length allowed is 2083 characters. # Corresponds to the JSON property `relativeUri` # @return [String] attr_accessor :relative_uri @@ -186,95 +140,62 @@ module Google end end - # App Engine Routing. - # Defines routing characteristics specific to App Engine - service, version, - # and instance. - # For more information about services, versions, and instances see - # [An Overview of App - # Engine](https://cloud.google.com/appengine/docs/python/an-overview-of-app- - # engine), - # [Microservices Architecture on Google App - # Engine](https://cloud.google.com/appengine/docs/python/microservices-on-app- - # engine), - # [App Engine Standard request - # routing](https://cloud.google.com/appengine/docs/standard/python/how-requests- - # are-routed), - # and [App Engine Flex request - # routing](https://cloud.google.com/appengine/docs/flexible/python/how-requests- - # are-routed). - # Using AppEngineRouting requires - # [`appengine.applications.get`](https://cloud.google.com/appengine/docs/admin- - # api/access-control) - # Google IAM permission for the project - # and the following scope: + # App Engine Routing. Defines routing characteristics specific to App Engine - + # service, version, and instance. For more information about services, versions, + # and instances see [An Overview of App Engine](https://cloud.google.com/ + # appengine/docs/python/an-overview-of-app-engine), [Microservices Architecture + # on Google App Engine](https://cloud.google.com/appengine/docs/python/ + # microservices-on-app-engine), [App Engine Standard request routing](https:// + # cloud.google.com/appengine/docs/standard/python/how-requests-are-routed), and [ + # App Engine Flex request routing](https://cloud.google.com/appengine/docs/ + # flexible/python/how-requests-are-routed). Using AppEngineRouting requires [` + # appengine.applications.get`](https://cloud.google.com/appengine/docs/admin-api/ + # access-control) Google IAM permission for the project and the following scope: # `https://www.googleapis.com/auth/cloud-platform` class AppEngineRouting include Google::Apis::Core::Hashable - # Output only. The host that the task is sent to. - # The host is constructed from the domain name of the app associated with - # the queue's project ID (for example .appspot.com), and the - # service, version, - # and instance. Tasks which were created using - # the App Engine SDK might have a custom domain name. - # For more information, see - # [How Requests are - # Routed](https://cloud.google.com/appengine/docs/standard/python/how-requests- - # are-routed). + # Output only. The host that the task is sent to. The host is constructed from + # the domain name of the app associated with the queue's project ID (for example + # .appspot.com), and the service, version, and instance. Tasks which were + # created using the App Engine SDK might have a custom domain name. For more + # information, see [How Requests are Routed](https://cloud.google.com/appengine/ + # docs/standard/python/how-requests-are-routed). # Corresponds to the JSON property `host` # @return [String] attr_accessor :host - # App instance. - # By default, the task is sent to an instance which is available when - # the task is attempted. - # Requests can only be sent to a specific instance if - # [manual scaling is used in App Engine - # Standard](https://cloud.google.com/appengine/docs/python/an-overview-of-app- - # engine?hl=en_US#scaling_types_and_instance_classes). - # App Engine Flex does not support instances. For more information, see - # [App Engine Standard request - # routing](https://cloud.google.com/appengine/docs/standard/python/how-requests- - # are-routed) - # and [App Engine Flex request - # routing](https://cloud.google.com/appengine/docs/flexible/python/how-requests- - # are-routed). + # App instance. By default, the task is sent to an instance which is available + # when the task is attempted. Requests can only be sent to a specific instance + # if [manual scaling is used in App Engine Standard](https://cloud.google.com/ + # appengine/docs/python/an-overview-of-app-engine?hl=en_US# + # scaling_types_and_instance_classes). App Engine Flex does not support + # instances. For more information, see [App Engine Standard request routing]( + # https://cloud.google.com/appengine/docs/standard/python/how-requests-are- + # routed) and [App Engine Flex request routing](https://cloud.google.com/ + # appengine/docs/flexible/python/how-requests-are-routed). # Corresponds to the JSON property `instance` # @return [String] attr_accessor :instance - # App service. - # By default, the task is sent to the service which is the default - # service when the task is attempted. - # For some queues or tasks which were created using the App Engine - # Task Queue API, host is not parsable - # into service, - # version, and - # instance. For example, some tasks - # which were created using the App Engine SDK use a custom domain - # name; custom domains are not parsed by Cloud Tasks. If - # host is not parsable, then - # service, - # version, and - # instance are the empty string. + # App service. By default, the task is sent to the service which is the default + # service when the task is attempted. For some queues or tasks which were + # created using the App Engine Task Queue API, host is not parsable into service, + # version, and instance. For example, some tasks which were created using the + # App Engine SDK use a custom domain name; custom domains are not parsed by + # Cloud Tasks. If host is not parsable, then service, version, and instance are + # the empty string. # Corresponds to the JSON property `service` # @return [String] attr_accessor :service - # App version. - # By default, the task is sent to the version which is the default - # version when the task is attempted. - # For some queues or tasks which were created using the App Engine - # Task Queue API, host is not parsable - # into service, - # version, and - # instance. For example, some tasks - # which were created using the App Engine SDK use a custom domain - # name; custom domains are not parsed by Cloud Tasks. If - # host is not parsable, then - # service, - # version, and - # instance are the empty string. + # App version. By default, the task is sent to the version which is the default + # version when the task is attempted. For some queues or tasks which were + # created using the App Engine Task Queue API, host is not parsable into service, + # version, and instance. For example, some tasks which were created using the + # App Engine SDK use a custom domain name; custom domains are not parsed by + # Cloud Tasks. If host is not parsable, then service, version, and instance are + # the empty string. # Corresponds to the JSON property `version` # @return [String] attr_accessor :version @@ -296,30 +217,30 @@ module Google class Attempt include Google::Apis::Core::Hashable - # Output only. The time that this attempt was dispatched. - # `dispatch_time` will be truncated to the nearest microsecond. + # Output only. The time that this attempt was dispatched. `dispatch_time` will + # be truncated to the nearest microsecond. # Corresponds to the JSON property `dispatchTime` # @return [String] attr_accessor :dispatch_time - # 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 `responseStatus` # @return [Google::Apis::CloudtasksV2::Status] attr_accessor :response_status - # Output only. The time that this attempt response was received. - # `response_time` will be truncated to the nearest microsecond. + # Output only. The time that this attempt response was received. `response_time` + # will be truncated to the nearest microsecond. # Corresponds to the JSON property `responseTime` # @return [String] attr_accessor :response_time - # Output only. The time that this attempt was scheduled. - # `schedule_time` will be truncated to the nearest microsecond. + # Output only. The time that this attempt was scheduled. `schedule_time` will be + # truncated to the nearest microsecond. # Corresponds to the JSON property `scheduleTime` # @return [String] attr_accessor :schedule_time @@ -341,69 +262,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::CloudtasksV2::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 @@ -424,16 +333,12 @@ module Google class CreateTaskRequest include Google::Apis::Core::Hashable - # The response_view specifies which subset of the Task will be - # returned. - # By default response_view is BASIC; not all - # information is retrieved by default because some data, such as - # payloads, might be desirable to return only when needed because - # of its large size or because of the sensitivity of data that it - # contains. - # Authorization for FULL requires - # `cloudtasks.tasks.fullView` [Google IAM](https://cloud.google.com/iam/) - # permission on the Task resource. + # The response_view specifies which subset of the Task will be returned. By + # default response_view is BASIC; not all information is retrieved by default + # because some data, such as payloads, might be desirable to return only when + # needed because of its large size or because of the sensitivity of data that it + # contains. Authorization for FULL requires `cloudtasks.tasks.fullView` [Google + # IAM](https://cloud.google.com/iam/) permission on the Task resource. # Corresponds to the JSON property `responseView` # @return [String] attr_accessor :response_view @@ -454,13 +359,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 @@ -473,52 +376,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 @@ -559,15 +453,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 @@ -582,61 +474,48 @@ module Google end end - # HTTP request. - # The task will be pushed to the worker as an HTTP request. If the worker - # or the redirected worker acknowledges the task by returning a successful HTTP - # response code ([`200` - `299`]), the task will be removed from the queue. If - # any other HTTP response code is returned or no response is received, the - # task will be retried according to the following: - # * User-specified throttling: retry configuration, - # rate limits, and the queue's state. + # HTTP request. The task will be pushed to the worker as an HTTP request. If the + # worker or the redirected worker acknowledges the task by returning a + # successful HTTP response code ([`200` - `299`]), the task will be removed from + # the queue. If any other HTTP response code is returned or no response is + # received, the task will be retried according to the following: * User- + # specified throttling: retry configuration, rate limits, and the queue's state. # * System throttling: To prevent the worker from overloading, Cloud Tasks may - # temporarily reduce the queue's effective rate. User-specified settings - # will not be changed. - # System throttling happens because: - # * Cloud Tasks backs off on all errors. Normally the backoff specified in - # rate limits will be used. But if the worker returns - # `429` (Too Many Requests), `503` (Service Unavailable), or the rate of - # errors is high, Cloud Tasks will use a higher backoff rate. The retry - # specified in the `Retry-After` HTTP response header is considered. - # * To prevent traffic spikes and to smooth sudden increases in traffic, - # dispatches ramp up slowly when the queue is newly created or idle and - # if large numbers of tasks suddenly become available to dispatch (due to - # spikes in create task rates, the queue being unpaused, or many tasks - # that are scheduled at the same time). + # temporarily reduce the queue's effective rate. User-specified settings will + # not be changed. System throttling happens because: * Cloud Tasks backs off on + # all errors. Normally the backoff specified in rate limits will be used. But if + # the worker returns `429` (Too Many Requests), `503` (Service Unavailable), or + # the rate of errors is high, Cloud Tasks will use a higher backoff rate. The + # retry specified in the `Retry-After` HTTP response header is considered. * To + # prevent traffic spikes and to smooth sudden increases in traffic, dispatches + # ramp up slowly when the queue is newly created or idle and if large numbers of + # tasks suddenly become available to dispatch (due to spikes in create task + # rates, the queue being unpaused, or many tasks that are scheduled at the same + # time). class HttpRequest include Google::Apis::Core::Hashable - # HTTP request body. - # A request body is allowed only if the - # HTTP method is POST, PUT, or PATCH. It is an - # error to set body on a task with an incompatible HttpMethod. + # HTTP request body. A request body is allowed only if the HTTP method is POST, + # PUT, or PATCH. It is an error to set body on a task with an incompatible + # HttpMethod. # Corresponds to the JSON property `body` # NOTE: Values are automatically base64 encoded/decoded in the client library. # @return [String] attr_accessor :body - # HTTP request headers. - # This map contains the header field names and values. - # Headers can be set when the - # task is created. - # These headers represent a subset of the headers that will accompany the - # task's HTTP request. Some HTTP request headers will be ignored or replaced. - # A partial list of headers that will be ignored or replaced is: - # * Host: This will be computed by Cloud Tasks and derived from - # HttpRequest.url. - # * Content-Length: This will be computed by Cloud Tasks. - # * User-Agent: This will be set to `"Google-Cloud-Tasks"`. - # * X-Google-*: Google use only. - # * X-AppEngine-*: Google use only. - # `Content-Type` won't be set by Cloud Tasks. You can explicitly set - # `Content-Type` to a media type when the - # task is created. - # For example, `Content-Type` can be set to `"application/octet-stream"` or - # `"application/json"`. - # Headers which can have multiple values (according to RFC2616) can be - # specified using comma-separated values. - # The size of the headers must be less than 80KB. + # HTTP request headers. This map contains the header field names and values. + # Headers can be set when the task is created. These headers represent a subset + # of the headers that will accompany the task's HTTP request. Some HTTP request + # headers will be ignored or replaced. A partial list of headers that will be + # ignored or replaced is: * Host: This will be computed by Cloud Tasks and + # derived from HttpRequest.url. * Content-Length: This will be computed by Cloud + # Tasks. * User-Agent: This will be set to `"Google-Cloud-Tasks"`. * X-Google-*: + # Google use only. * X-AppEngine-*: Google use only. `Content-Type` won't be set + # by Cloud Tasks. You can explicitly set `Content-Type` to a media type when the + # task is created. For example, `Content-Type` can be set to `"application/octet- + # stream"` or `"application/json"`. Headers which can have multiple values ( + # according to RFC2616) can be specified using comma-separated values. The size + # of the headers must be less than 80KB. # Corresponds to the JSON property `headers` # @return [Hash] attr_accessor :headers @@ -646,31 +525,28 @@ module Google # @return [String] attr_accessor :http_method - # Contains information needed for generating an - # [OAuth token](https://developers.google.com/identity/protocols/OAuth2). - # This type of authorization should generally only be used when calling Google - # APIs hosted on *.googleapis.com. + # Contains information needed for generating an [OAuth token](https://developers. + # google.com/identity/protocols/OAuth2). This type of authorization should + # generally only be used when calling Google APIs hosted on *.googleapis.com. # Corresponds to the JSON property `oauthToken` # @return [Google::Apis::CloudtasksV2::OAuthToken] attr_accessor :oauth_token - # Contains information needed for generating an - # [OpenID Connect - # token](https://developers.google.com/identity/protocols/OpenIDConnect). - # This type of authorization can be used for many scenarios, including - # calling Cloud Run, or endpoints where you intend to validate the token - # yourself. + # Contains information needed for generating an [OpenID Connect token](https:// + # developers.google.com/identity/protocols/OpenIDConnect). This type of + # authorization can be used for many scenarios, including calling Cloud Run, or + # endpoints where you intend to validate the token yourself. # Corresponds to the JSON property `oidcToken` # @return [Google::Apis::CloudtasksV2::OidcToken] attr_accessor :oidc_token - # Required. The full url path that the request will be sent to. - # This string must begin with either "http://" or "https://". Some examples - # are: `http://acme.com` and `https://acme.com/sales:8080`. Cloud Tasks will - # encode some characters for safety and compatibility. The maximum allowed - # URL length is 2083 characters after encoding. - # The `Location` header response from a redirect response [`300` - `399`] - # may be followed. The redirect is not counted as a separate attempt. + # Required. The full url path that the request will be sent to. This string must + # begin with either "http://" or "https://". Some examples are: `http://acme.com` + # and `https://acme.com/sales:8080`. Cloud Tasks will encode some characters + # for safety and compatibility. The maximum allowed URL length is 2083 + # characters after encoding. The `Location` header response from a redirect + # response [`300` - `399`] may be followed. The redirect is not counted as a + # separate attempt. # Corresponds to the JSON property `url` # @return [String] attr_accessor :url @@ -719,12 +595,9 @@ module Google class ListQueuesResponse include Google::Apis::Core::Hashable - # A token to retrieve next page of results. - # To return the next page of results, call - # ListQueues with this value as the - # page_token. - # If the next_page_token is empty, there are no more results. - # The page token is valid for only 2 hours. + # A token to retrieve next page of results. To return the next page of results, + # call ListQueues with this value as the page_token. If the next_page_token is + # empty, there are no more results. The page token is valid for only 2 hours. # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token @@ -749,11 +622,9 @@ module Google class ListTasksResponse include Google::Apis::Core::Hashable - # A token to retrieve next page of results. - # To return the next page of results, call - # ListTasks with this value as the - # page_token. - # If the next_page_token is empty, there are no more results. + # A token to retrieve next page of results. To return the next page of results, + # call ListTasks with this value as the page_token. If the next_page_token is + # empty, there are no more results. # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token @@ -778,14 +649,14 @@ module Google class Location include Google::Apis::Core::Hashable - # The friendly name for this location, typically a nearby city name. - # For example, "Tokyo". + # The friendly name for this location, typically a nearby city name. For example, + # "Tokyo". # Corresponds to the JSON property `displayName` # @return [String] attr_accessor :display_name - # Cross-service attributes for the location. For example - # `"cloud.googleapis.com/region": "us-east1"` + # Cross-service attributes for the location. For example `"cloud.googleapis.com/ + # region": "us-east1"` # Corresponds to the JSON property `labels` # @return [Hash] attr_accessor :labels @@ -801,8 +672,8 @@ module Google # @return [Hash] attr_accessor :metadata - # Resource name for the location, which may vary between implementations. - # For example: `"projects/example-project/locations/us-east1"` + # Resource name for the location, which may vary between implementations. For + # example: `"projects/example-project/locations/us-east1"` # Corresponds to the JSON property `name` # @return [String] attr_accessor :name @@ -821,25 +692,22 @@ module Google end end - # Contains information needed for generating an - # [OAuth token](https://developers.google.com/identity/protocols/OAuth2). - # This type of authorization should generally only be used when calling Google - # APIs hosted on *.googleapis.com. + # Contains information needed for generating an [OAuth token](https://developers. + # google.com/identity/protocols/OAuth2). This type of authorization should + # generally only be used when calling Google APIs hosted on *.googleapis.com. class OAuthToken include Google::Apis::Core::Hashable - # OAuth scope to be used for generating OAuth access token. - # If not specified, "https://www.googleapis.com/auth/cloud-platform" - # will be used. + # OAuth scope to be used for generating OAuth access token. If not specified, " + # https://www.googleapis.com/auth/cloud-platform" will be used. # Corresponds to the JSON property `scope` # @return [String] attr_accessor :scope - # [Service account email](https://cloud.google.com/iam/docs/service-accounts) - # to be used for generating OAuth token. - # The service account must be within the same project as the queue. The - # caller must have iam.serviceAccounts.actAs permission for the service - # account. + # [Service account email](https://cloud.google.com/iam/docs/service-accounts) to + # be used for generating OAuth token. The service account must be within the + # same project as the queue. The caller must have iam.serviceAccounts.actAs + # permission for the service account. # Corresponds to the JSON property `serviceAccountEmail` # @return [String] attr_accessor :service_account_email @@ -855,12 +723,10 @@ module Google end end - # Contains information needed for generating an - # [OpenID Connect - # token](https://developers.google.com/identity/protocols/OpenIDConnect). - # This type of authorization can be used for many scenarios, including - # calling Cloud Run, or endpoints where you intend to validate the token - # yourself. + # Contains information needed for generating an [OpenID Connect token](https:// + # developers.google.com/identity/protocols/OpenIDConnect). This type of + # authorization can be used for many scenarios, including calling Cloud Run, or + # endpoints where you intend to validate the token yourself. class OidcToken include Google::Apis::Core::Hashable @@ -870,11 +736,10 @@ module Google # @return [String] attr_accessor :audience - # [Service account email](https://cloud.google.com/iam/docs/service-accounts) - # to be used for generating OIDC token. - # The service account must be within the same project as the queue. The - # caller must have iam.serviceAccounts.actAs permission for the service - # account. + # [Service account email](https://cloud.google.com/iam/docs/service-accounts) to + # be used for generating OIDC token. The service account must be within the same + # project as the queue. The caller must have iam.serviceAccounts.actAs + # permission for the service account. # Corresponds to the JSON property `serviceAccountEmail` # @return [String] attr_accessor :service_account_email @@ -904,111 +769,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 @@ -1038,100 +865,76 @@ module Google end end - # A queue is a container of related tasks. Queues are configured to manage - # how those tasks are dispatched. Configurable properties include rate limits, - # retry options, queue types, and others. + # A queue is a container of related tasks. Queues are configured to manage how + # those tasks are dispatched. Configurable properties include rate limits, retry + # options, queue types, and others. class Queue include Google::Apis::Core::Hashable - # App Engine Routing. - # Defines routing characteristics specific to App Engine - service, version, - # and instance. - # For more information about services, versions, and instances see - # [An Overview of App - # Engine](https://cloud.google.com/appengine/docs/python/an-overview-of-app- - # engine), - # [Microservices Architecture on Google App - # Engine](https://cloud.google.com/appengine/docs/python/microservices-on-app- - # engine), - # [App Engine Standard request - # routing](https://cloud.google.com/appengine/docs/standard/python/how-requests- - # are-routed), - # and [App Engine Flex request - # routing](https://cloud.google.com/appengine/docs/flexible/python/how-requests- - # are-routed). - # Using AppEngineRouting requires - # [`appengine.applications.get`](https://cloud.google.com/appengine/docs/admin- - # api/access-control) - # Google IAM permission for the project - # and the following scope: + # App Engine Routing. Defines routing characteristics specific to App Engine - + # service, version, and instance. For more information about services, versions, + # and instances see [An Overview of App Engine](https://cloud.google.com/ + # appengine/docs/python/an-overview-of-app-engine), [Microservices Architecture + # on Google App Engine](https://cloud.google.com/appengine/docs/python/ + # microservices-on-app-engine), [App Engine Standard request routing](https:// + # cloud.google.com/appengine/docs/standard/python/how-requests-are-routed), and [ + # App Engine Flex request routing](https://cloud.google.com/appengine/docs/ + # flexible/python/how-requests-are-routed). Using AppEngineRouting requires [` + # appengine.applications.get`](https://cloud.google.com/appengine/docs/admin-api/ + # access-control) Google IAM permission for the project and the following scope: # `https://www.googleapis.com/auth/cloud-platform` # Corresponds to the JSON property `appEngineRoutingOverride` # @return [Google::Apis::CloudtasksV2::AppEngineRouting] attr_accessor :app_engine_routing_override - # Caller-specified and required in CreateQueue, - # after which it becomes output only. - # The queue name. - # The queue name must have the following format: - # `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID` - # * `PROJECT_ID` can contain letters ([A-Za-z]), numbers ([0-9]), - # hyphens (-), colons (:), or periods (.). - # For more information, see - # [Identifying - # projects](https://cloud.google.com/resource-manager/docs/creating-managing- - # projects#identifying_projects) - # * `LOCATION_ID` is the canonical ID for the queue's location. - # The list of available locations can be obtained by calling - # ListLocations. - # For more information, see https://cloud.google.com/about/locations/. - # * `QUEUE_ID` can contain letters ([A-Za-z]), numbers ([0-9]), or - # hyphens (-). The maximum length is 100 characters. + # Caller-specified and required in CreateQueue, after which it becomes output + # only. The queue name. The queue name must have the following format: `projects/ + # PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID` * `PROJECT_ID` can contain + # letters ([A-Za-z]), numbers ([0-9]), hyphens (-), colons (:), or periods (.). + # For more information, see [Identifying projects](https://cloud.google.com/ + # resource-manager/docs/creating-managing-projects#identifying_projects) * ` + # LOCATION_ID` is the canonical ID for the queue's location. The list of + # available locations can be obtained by calling ListLocations. For more + # information, see https://cloud.google.com/about/locations/. * `QUEUE_ID` can + # contain letters ([A-Za-z]), numbers ([0-9]), or hyphens (-). The maximum + # length is 100 characters. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name - # Output only. The last time this queue was purged. - # All tasks that were created before this time - # were purged. - # A queue can be purged using PurgeQueue, the - # [App Engine Task Queue SDK, or the Cloud - # Console](https://cloud.google.com/appengine/docs/standard/python/taskqueue/ - # push/deleting-tasks-and-queues#purging_all_tasks_from_a_queue). - # Purge time will be truncated to the nearest microsecond. Purge - # time will be unset if the queue has never been purged. + # Output only. The last time this queue was purged. All tasks that were created + # before this time were purged. A queue can be purged using PurgeQueue, the [App + # Engine Task Queue SDK, or the Cloud Console](https://cloud.google.com/ + # appengine/docs/standard/python/taskqueue/push/deleting-tasks-and-queues# + # purging_all_tasks_from_a_queue). Purge time will be truncated to the nearest + # microsecond. Purge time will be unset if the queue has never been purged. # Corresponds to the JSON property `purgeTime` # @return [String] attr_accessor :purge_time - # Rate limits. - # This message determines the maximum rate that tasks can be dispatched by a - # queue, regardless of whether the dispatch is a first task attempt or a retry. - # Note: The debugging command, RunTask, will run a task - # even if the queue has reached its RateLimits. + # Rate limits. This message determines the maximum rate that tasks can be + # dispatched by a queue, regardless of whether the dispatch is a first task + # attempt or a retry. Note: The debugging command, RunTask, will run a task even + # if the queue has reached its RateLimits. # Corresponds to the JSON property `rateLimits` # @return [Google::Apis::CloudtasksV2::RateLimits] attr_accessor :rate_limits - # Retry config. - # These settings determine when a failed task attempt is retried. + # Retry config. These settings determine when a failed task attempt is retried. # Corresponds to the JSON property `retryConfig` # @return [Google::Apis::CloudtasksV2::RetryConfig] attr_accessor :retry_config - # Configuration options for writing logs to - # [Stackdriver Logging](https://cloud.google.com/logging/docs/). + # Configuration options for writing logs to [Stackdriver Logging](https://cloud. + # google.com/logging/docs/). # Corresponds to the JSON property `stackdriverLoggingConfig` # @return [Google::Apis::CloudtasksV2::StackdriverLoggingConfig] attr_accessor :stackdriver_logging_config - # Output only. The state of the queue. - # `state` can only be changed by called - # PauseQueue, - # ResumeQueue, or uploading - # [queue.yaml/xml](https://cloud.google.com/appengine/docs/python/config/ - # queueref). - # UpdateQueue cannot be used to change `state`. + # Output only. The state of the queue. `state` can only be changed by called + # PauseQueue, ResumeQueue, or uploading [queue.yaml/xml](https://cloud.google. + # com/appengine/docs/python/config/queueref). UpdateQueue cannot be used to + # change `state`. # Corresponds to the JSON property `state` # @return [String] attr_accessor :state @@ -1152,70 +955,51 @@ module Google end end - # Rate limits. - # This message determines the maximum rate that tasks can be dispatched by a - # queue, regardless of whether the dispatch is a first task attempt or a retry. - # Note: The debugging command, RunTask, will run a task - # even if the queue has reached its RateLimits. + # Rate limits. This message determines the maximum rate that tasks can be + # dispatched by a queue, regardless of whether the dispatch is a first task + # attempt or a retry. Note: The debugging command, RunTask, will run a task even + # if the queue has reached its RateLimits. class RateLimits include Google::Apis::Core::Hashable - # Output only. The max burst size. - # Max burst size limits how fast tasks in queue are processed when - # many tasks are in the queue and the rate is high. This field - # allows the queue to have a high rate so processing starts shortly - # after a task is enqueued, but still limits resource usage when - # many tasks are enqueued in a short period of time. - # The [token bucket](https://wikipedia.org/wiki/Token_Bucket) - # algorithm is used to control the rate of task dispatches. Each - # queue has a token bucket that holds tokens, up to the maximum - # specified by `max_burst_size`. Each time a task is dispatched, a - # token is removed from the bucket. Tasks will be dispatched until - # the queue's bucket runs out of tokens. The bucket will be - # continuously refilled with new tokens based on - # max_dispatches_per_second. - # Cloud Tasks will pick the value of `max_burst_size` based on the - # value of - # max_dispatches_per_second. - # For queues that were created or updated using - # `queue.yaml/xml`, `max_burst_size` is equal to - # [bucket_size](https://cloud.google.com/appengine/docs/standard/python/config/ - # queueref#bucket_size). - # Since `max_burst_size` is output only, if - # UpdateQueue is called on a queue - # created by `queue.yaml/xml`, `max_burst_size` will be reset based - # on the value of - # max_dispatches_per_second, - # regardless of whether - # max_dispatches_per_second - # is updated. + # Output only. The max burst size. Max burst size limits how fast tasks in queue + # are processed when many tasks are in the queue and the rate is high. This + # field allows the queue to have a high rate so processing starts shortly after + # a task is enqueued, but still limits resource usage when many tasks are + # enqueued in a short period of time. The [token bucket](https://wikipedia.org/ + # wiki/Token_Bucket) algorithm is used to control the rate of task dispatches. + # Each queue has a token bucket that holds tokens, up to the maximum specified + # by `max_burst_size`. Each time a task is dispatched, a token is removed from + # the bucket. Tasks will be dispatched until the queue's bucket runs out of + # tokens. The bucket will be continuously refilled with new tokens based on + # max_dispatches_per_second. Cloud Tasks will pick the value of `max_burst_size` + # based on the value of max_dispatches_per_second. For queues that were created + # or updated using `queue.yaml/xml`, `max_burst_size` is equal to [bucket_size]( + # https://cloud.google.com/appengine/docs/standard/python/config/queueref# + # bucket_size). Since `max_burst_size` is output only, if UpdateQueue is called + # on a queue created by `queue.yaml/xml`, `max_burst_size` will be reset based + # on the value of max_dispatches_per_second, regardless of whether + # max_dispatches_per_second is updated. # Corresponds to the JSON property `maxBurstSize` # @return [Fixnum] attr_accessor :max_burst_size - # The maximum number of concurrent tasks that Cloud Tasks allows - # to be dispatched for this queue. After this threshold has been - # reached, Cloud Tasks stops dispatching tasks until the number of - # concurrent requests decreases. - # If unspecified when the queue is created, Cloud Tasks will pick the - # default. - # The maximum allowed value is 5,000. - # This field has the same meaning as - # [max_concurrent_requests in - # queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/ - # queueref#max_concurrent_requests). + # The maximum number of concurrent tasks that Cloud Tasks allows to be + # dispatched for this queue. After this threshold has been reached, Cloud Tasks + # stops dispatching tasks until the number of concurrent requests decreases. If + # unspecified when the queue is created, Cloud Tasks will pick the default. The + # maximum allowed value is 5,000. This field has the same meaning as [ + # max_concurrent_requests in queue.yaml/xml](https://cloud.google.com/appengine/ + # docs/standard/python/config/queueref#max_concurrent_requests). # Corresponds to the JSON property `maxConcurrentDispatches` # @return [Fixnum] attr_accessor :max_concurrent_dispatches - # The maximum rate at which tasks are dispatched from this queue. - # If unspecified when the queue is created, Cloud Tasks will pick the - # default. - # * The maximum allowed value is 500. - # This field has the same meaning as - # [rate in - # queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/ - # queueref#rate). + # The maximum rate at which tasks are dispatched from this queue. If unspecified + # when the queue is created, Cloud Tasks will pick the default. * The maximum + # allowed value is 500. This field has the same meaning as [rate in queue.yaml/ + # xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref# + # rate). # Corresponds to the JSON property `maxDispatchesPerSecond` # @return [Float] attr_accessor :max_dispatches_per_second @@ -1245,98 +1029,67 @@ module Google end end - # Retry config. - # These settings determine when a failed task attempt is retried. + # Retry config. These settings determine when a failed task attempt is retried. class RetryConfig include Google::Apis::Core::Hashable - # Number of attempts per task. - # Cloud Tasks will attempt the task `max_attempts` times (that is, if the - # first attempt fails, then there will be `max_attempts - 1` retries). Must - # be >= -1. - # If unspecified when the queue is created, Cloud Tasks will pick the - # default. - # -1 indicates unlimited attempts. - # This field has the same meaning as - # [task_retry_limit in - # queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/ - # queueref#retry_parameters). + # Number of attempts per task. Cloud Tasks will attempt the task `max_attempts` + # times (that is, if the first attempt fails, then there will be `max_attempts - + # 1` retries). Must be >= -1. If unspecified when the queue is created, Cloud + # Tasks will pick the default. -1 indicates unlimited attempts. This field has + # the same meaning as [task_retry_limit in queue.yaml/xml](https://cloud.google. + # com/appengine/docs/standard/python/config/queueref#retry_parameters). # Corresponds to the JSON property `maxAttempts` # @return [Fixnum] attr_accessor :max_attempts - # A task will be scheduled for retry between - # min_backoff and - # max_backoff duration after it fails, - # if the queue's RetryConfig specifies that the task should be - # retried. - # If unspecified when the queue is created, Cloud Tasks will pick the - # default. - # `max_backoff` will be truncated to the nearest second. - # This field has the same meaning as - # [max_backoff_seconds in - # queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/ - # queueref#retry_parameters). + # A task will be scheduled for retry between min_backoff and max_backoff + # duration after it fails, if the queue's RetryConfig specifies that the task + # should be retried. If unspecified when the queue is created, Cloud Tasks will + # pick the default. `max_backoff` will be truncated to the nearest second. This + # field has the same meaning as [max_backoff_seconds in queue.yaml/xml](https:// + # cloud.google.com/appengine/docs/standard/python/config/queueref# + # retry_parameters). # Corresponds to the JSON property `maxBackoff` # @return [String] attr_accessor :max_backoff - # The time between retries will double `max_doublings` times. - # A task's retry interval starts at - # min_backoff, then doubles - # `max_doublings` times, then increases linearly, and finally - # retries at intervals of - # max_backoff up to - # max_attempts times. - # For example, if min_backoff is 10s, - # max_backoff is 300s, and - # `max_doublings` is 3, then the a task will first be retried in - # 10s. The retry interval will double three times, and then - # increase linearly by 2^3 * 10s. Finally, the task will retry at - # intervals of max_backoff until the - # task has been attempted max_attempts - # times. Thus, the requests will retry at 10s, 20s, 40s, 80s, 160s, - # 240s, 300s, 300s, .... - # If unspecified when the queue is created, Cloud Tasks will pick the - # default. - # This field has the same meaning as - # [max_doublings in - # queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/ - # queueref#retry_parameters). + # The time between retries will double `max_doublings` times. A task's retry + # interval starts at min_backoff, then doubles `max_doublings` times, then + # increases linearly, and finally retries at intervals of max_backoff up to + # max_attempts times. For example, if min_backoff is 10s, max_backoff is 300s, + # and `max_doublings` is 3, then the a task will first be retried in 10s. The + # retry interval will double three times, and then increase linearly by 2^3 * + # 10s. Finally, the task will retry at intervals of max_backoff until the task + # has been attempted max_attempts times. Thus, the requests will retry at 10s, + # 20s, 40s, 80s, 160s, 240s, 300s, 300s, .... If unspecified when the queue is + # created, Cloud Tasks will pick the default. This field has the same meaning as + # [max_doublings in queue.yaml/xml](https://cloud.google.com/appengine/docs/ + # standard/python/config/queueref#retry_parameters). # Corresponds to the JSON property `maxDoublings` # @return [Fixnum] attr_accessor :max_doublings - # If positive, `max_retry_duration` specifies the time limit for - # retrying a failed task, measured from when the task was first - # attempted. Once `max_retry_duration` time has passed *and* the - # task has been attempted max_attempts - # times, no further attempts will be made and the task will be - # deleted. - # If zero, then the task age is unlimited. - # If unspecified when the queue is created, Cloud Tasks will pick the - # default. - # `max_retry_duration` will be truncated to the nearest second. - # This field has the same meaning as - # [task_age_limit in - # queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/ - # queueref#retry_parameters). + # If positive, `max_retry_duration` specifies the time limit for retrying a + # failed task, measured from when the task was first attempted. Once ` + # max_retry_duration` time has passed *and* the task has been attempted + # max_attempts times, no further attempts will be made and the task will be + # deleted. If zero, then the task age is unlimited. If unspecified when the + # queue is created, Cloud Tasks will pick the default. `max_retry_duration` will + # be truncated to the nearest second. This field has the same meaning as [ + # task_age_limit in queue.yaml/xml](https://cloud.google.com/appengine/docs/ + # standard/python/config/queueref#retry_parameters). # Corresponds to the JSON property `maxRetryDuration` # @return [String] attr_accessor :max_retry_duration - # A task will be scheduled for retry between - # min_backoff and - # max_backoff duration after it fails, - # if the queue's RetryConfig specifies that the task should be - # retried. - # If unspecified when the queue is created, Cloud Tasks will pick the - # default. - # `min_backoff` will be truncated to the nearest second. - # This field has the same meaning as - # [min_backoff_seconds in - # queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/ - # queueref#retry_parameters). + # A task will be scheduled for retry between min_backoff and max_backoff + # duration after it fails, if the queue's RetryConfig specifies that the task + # should be retried. If unspecified when the queue is created, Cloud Tasks will + # pick the default. `min_backoff` will be truncated to the nearest second. This + # field has the same meaning as [min_backoff_seconds in queue.yaml/xml](https:// + # cloud.google.com/appengine/docs/standard/python/config/queueref# + # retry_parameters). # Corresponds to the JSON property `minBackoff` # @return [String] attr_accessor :min_backoff @@ -1355,21 +1108,16 @@ module Google end end - # Request message for forcing a task to run now using - # RunTask. + # Request message for forcing a task to run now using RunTask. class RunTaskRequest include Google::Apis::Core::Hashable - # The response_view specifies which subset of the Task will be - # returned. - # By default response_view is BASIC; not all - # information is retrieved by default because some data, such as - # payloads, might be desirable to return only when needed because - # of its large size or because of the sensitivity of data that it - # contains. - # Authorization for FULL requires - # `cloudtasks.tasks.fullView` [Google IAM](https://cloud.google.com/iam/) - # permission on the Task resource. + # The response_view specifies which subset of the Task will be returned. By + # default response_view is BASIC; not all information is retrieved by default + # because some data, such as payloads, might be desirable to return only when + # needed because of its large size or because of the sensitivity of data that it + # contains. Authorization for FULL requires `cloudtasks.tasks.fullView` [Google + # IAM](https://cloud.google.com/iam/) permission on the Task resource. # Corresponds to the JSON property `responseView` # @return [String] attr_accessor :response_view @@ -1389,66 +1137,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::CloudtasksV2::Policy] attr_accessor :policy @@ -1463,15 +1177,14 @@ module Google end end - # Configuration options for writing logs to - # [Stackdriver Logging](https://cloud.google.com/logging/docs/). + # Configuration options for writing logs to [Stackdriver Logging](https://cloud. + # google.com/logging/docs/). class StackdriverLoggingConfig include Google::Apis::Core::Hashable - # Specifies the fraction of operations to write to - # [Stackdriver Logging](https://cloud.google.com/logging/docs/). - # This field may contain any value between 0.0 and 1.0, inclusive. - # 0.0 is the default and means that no operations are logged. + # Specifies the fraction of operations to write to [Stackdriver Logging](https:// + # cloud.google.com/logging/docs/). This field may contain any value between 0.0 + # and 1.0, inclusive. 0.0 is the default and means that no operations are logged. # Corresponds to the JSON property `samplingRatio` # @return [Float] attr_accessor :sampling_ratio @@ -1486,12 +1199,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 @@ -1500,15 +1213,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 @@ -1529,104 +1242,76 @@ module Google class Task include Google::Apis::Core::Hashable - # App Engine HTTP request. - # The message defines the HTTP request that is sent to an App Engine app when - # the task is dispatched. - # Using AppEngineHttpRequest requires - # [`appengine.applications.get`](https://cloud.google.com/appengine/docs/admin- - # api/access-control) - # Google IAM permission for the project - # and the following scope: - # `https://www.googleapis.com/auth/cloud-platform` - # The task will be delivered to the App Engine app which belongs to the same - # project as the queue. For more information, see - # [How Requests are - # Routed](https://cloud.google.com/appengine/docs/standard/python/how-requests- - # are-routed) - # and how routing is affected by - # [dispatch - # files](https://cloud.google.com/appengine/docs/python/config/dispatchref). - # Traffic is encrypted during transport and never leaves Google datacenters. - # Because this traffic is carried over a communication mechanism internal to - # Google, you cannot explicitly set the protocol (for example, HTTP or HTTPS). - # The request to the handler, however, will appear to have used the HTTP - # protocol. - # The AppEngineRouting used to construct the URL that the task is - # delivered to can be set at the queue-level or task-level: - # * If app_engine_routing_override is set on the - # queue, this value - # is used for all tasks in the queue, no matter what the setting is for the - # task-level - # app_engine_routing. - # The `url` that the task will be sent to is: - # * `url =` host `+` - # relative_uri - # Tasks can be dispatched to secure app handlers, unsecure app handlers, and - # URIs restricted with - # [`login: - # admin`](https://cloud.google.com/appengine/docs/standard/python/config/appref). - # Because tasks are not run as any user, they cannot be dispatched to URIs - # restricted with - # [`login: - # required`](https://cloud.google.com/appengine/docs/standard/python/config/ - # appref) - # Task dispatches also do not follow redirects. - # The task attempt has succeeded if the app's request handler returns an HTTP - # response code in the range [`200` - `299`]. The task attempt has failed if - # the app's handler returns a non-2xx response code or Cloud Tasks does - # not receive response before the deadline. Failed - # tasks will be retried according to the - # retry configuration. `503` (Service Unavailable) is - # considered an App Engine system error instead of an application error and - # will cause Cloud Tasks' traffic congestion control to temporarily throttle - # the queue's dispatches. Unlike other types of task targets, a `429` (Too Many - # Requests) response from an app handler does not cause traffic congestion - # control to throttle the queue. + # App Engine HTTP request. The message defines the HTTP request that is sent to + # an App Engine app when the task is dispatched. Using AppEngineHttpRequest + # requires [`appengine.applications.get`](https://cloud.google.com/appengine/ + # docs/admin-api/access-control) Google IAM permission for the project and the + # following scope: `https://www.googleapis.com/auth/cloud-platform` The task + # will be delivered to the App Engine app which belongs to the same project as + # the queue. For more information, see [How Requests are Routed](https://cloud. + # google.com/appengine/docs/standard/python/how-requests-are-routed) and how + # routing is affected by [dispatch files](https://cloud.google.com/appengine/ + # docs/python/config/dispatchref). Traffic is encrypted during transport and + # never leaves Google datacenters. Because this traffic is carried over a + # communication mechanism internal to Google, you cannot explicitly set the + # protocol (for example, HTTP or HTTPS). The request to the handler, however, + # will appear to have used the HTTP protocol. The AppEngineRouting used to + # construct the URL that the task is delivered to can be set at the queue-level + # or task-level: * If app_engine_routing_override is set on the queue, this + # value is used for all tasks in the queue, no matter what the setting is for + # the task-level app_engine_routing. The `url` that the task will be sent to is: + # * `url =` host `+` relative_uri Tasks can be dispatched to secure app handlers, + # unsecure app handlers, and URIs restricted with [`login: admin`](https:// + # cloud.google.com/appengine/docs/standard/python/config/appref). Because tasks + # are not run as any user, they cannot be dispatched to URIs restricted with [` + # login: required`](https://cloud.google.com/appengine/docs/standard/python/ + # config/appref) Task dispatches also do not follow redirects. The task attempt + # has succeeded if the app's request handler returns an HTTP response code in + # the range [`200` - `299`]. The task attempt has failed if the app's handler + # returns a non-2xx response code or Cloud Tasks does not receive response + # before the deadline. Failed tasks will be retried according to the retry + # configuration. `503` (Service Unavailable) is considered an App Engine system + # error instead of an application error and will cause Cloud Tasks' traffic + # congestion control to temporarily throttle the queue's dispatches. Unlike + # other types of task targets, a `429` (Too Many Requests) response from an app + # handler does not cause traffic congestion control to throttle the queue. # Corresponds to the JSON property `appEngineHttpRequest` # @return [Google::Apis::CloudtasksV2::AppEngineHttpRequest] attr_accessor :app_engine_http_request - # Output only. The time that the task was created. - # `create_time` will be truncated to the nearest second. + # Output only. The time that the task was created. `create_time` will be + # truncated to the nearest second. # Corresponds to the JSON property `createTime` # @return [String] attr_accessor :create_time - # Output only. The number of attempts dispatched. - # This count includes attempts which have been dispatched but haven't - # received a response. + # Output only. The number of attempts dispatched. This count includes attempts + # which have been dispatched but haven't received a response. # Corresponds to the JSON property `dispatchCount` # @return [Fixnum] attr_accessor :dispatch_count - # The deadline for requests sent to the worker. If the worker does not - # respond by this deadline then the request is cancelled and the attempt - # is marked as a `DEADLINE_EXCEEDED` failure. Cloud Tasks will retry the - # task according to the RetryConfig. - # Note that when the request is cancelled, Cloud Tasks will stop listening - # for the response, but whether the worker stops processing depends on the - # worker. For example, if the worker is stuck, it may not react to cancelled - # requests. - # The default and maximum values depend on the type of request: - # * For HTTP tasks, the default is 10 minutes. The deadline - # must be in the interval [15 seconds, 30 minutes]. - # * For App Engine tasks, 0 indicates that the - # request has the default deadline. The default deadline depends on the - # [scaling - # type](https://cloud.google.com/appengine/docs/standard/go/how-instances-are- - # managed#instance_scaling) - # of the service: 10 minutes for standard apps with automatic scaling, 24 - # hours for standard apps with manual and basic scaling, and 60 minutes for - # flex apps. If the request deadline is set, it must be in the interval [15 - # seconds, 24 hours 15 seconds]. Regardless of the task's - # `dispatch_deadline`, the app handler will not run for longer than than - # the service's timeout. We recommend setting the `dispatch_deadline` to - # at most a few seconds more than the app handler's timeout. For more - # information see - # [Timeouts](https://cloud.google.com/tasks/docs/creating-appengine-handlers# - # timeouts). - # `dispatch_deadline` will be truncated to the nearest millisecond. The - # deadline is an approximate deadline. + # The deadline for requests sent to the worker. If the worker does not respond + # by this deadline then the request is cancelled and the attempt is marked as a ` + # DEADLINE_EXCEEDED` failure. Cloud Tasks will retry the task according to the + # RetryConfig. Note that when the request is cancelled, Cloud Tasks will stop + # listening for the response, but whether the worker stops processing depends on + # the worker. For example, if the worker is stuck, it may not react to cancelled + # requests. The default and maximum values depend on the type of request: * For + # HTTP tasks, the default is 10 minutes. The deadline must be in the interval [ + # 15 seconds, 30 minutes]. * For App Engine tasks, 0 indicates that the request + # has the default deadline. The default deadline depends on the [scaling type]( + # https://cloud.google.com/appengine/docs/standard/go/how-instances-are-managed# + # instance_scaling) of the service: 10 minutes for standard apps with automatic + # scaling, 24 hours for standard apps with manual and basic scaling, and 60 + # minutes for flex apps. If the request deadline is set, it must be in the + # interval [15 seconds, 24 hours 15 seconds]. Regardless of the task's ` + # dispatch_deadline`, the app handler will not run for longer than than the + # service's timeout. We recommend setting the `dispatch_deadline` to at most a + # few seconds more than the app handler's timeout. For more information see [ + # Timeouts](https://cloud.google.com/tasks/docs/creating-appengine-handlers# + # timeouts). `dispatch_deadline` will be truncated to the nearest millisecond. + # The deadline is an approximate deadline. # Corresponds to the JSON property `dispatchDeadline` # @return [String] attr_accessor :dispatch_deadline @@ -1636,28 +1321,24 @@ module Google # @return [Google::Apis::CloudtasksV2::Attempt] attr_accessor :first_attempt - # HTTP request. - # The task will be pushed to the worker as an HTTP request. If the worker - # or the redirected worker acknowledges the task by returning a successful HTTP - # response code ([`200` - `299`]), the task will be removed from the queue. If - # any other HTTP response code is returned or no response is received, the - # task will be retried according to the following: - # * User-specified throttling: retry configuration, - # rate limits, and the queue's state. + # HTTP request. The task will be pushed to the worker as an HTTP request. If the + # worker or the redirected worker acknowledges the task by returning a + # successful HTTP response code ([`200` - `299`]), the task will be removed from + # the queue. If any other HTTP response code is returned or no response is + # received, the task will be retried according to the following: * User- + # specified throttling: retry configuration, rate limits, and the queue's state. # * System throttling: To prevent the worker from overloading, Cloud Tasks may - # temporarily reduce the queue's effective rate. User-specified settings - # will not be changed. - # System throttling happens because: - # * Cloud Tasks backs off on all errors. Normally the backoff specified in - # rate limits will be used. But if the worker returns - # `429` (Too Many Requests), `503` (Service Unavailable), or the rate of - # errors is high, Cloud Tasks will use a higher backoff rate. The retry - # specified in the `Retry-After` HTTP response header is considered. - # * To prevent traffic spikes and to smooth sudden increases in traffic, - # dispatches ramp up slowly when the queue is newly created or idle and - # if large numbers of tasks suddenly become available to dispatch (due to - # spikes in create task rates, the queue being unpaused, or many tasks - # that are scheduled at the same time). + # temporarily reduce the queue's effective rate. User-specified settings will + # not be changed. System throttling happens because: * Cloud Tasks backs off on + # all errors. Normally the backoff specified in rate limits will be used. But if + # the worker returns `429` (Too Many Requests), `503` (Service Unavailable), or + # the rate of errors is high, Cloud Tasks will use a higher backoff rate. The + # retry specified in the `Retry-After` HTTP response header is considered. * To + # prevent traffic spikes and to smooth sudden increases in traffic, dispatches + # ramp up slowly when the queue is newly created or idle and if large numbers of + # tasks suddenly become available to dispatch (due to spikes in create task + # rates, the queue being unpaused, or many tasks that are scheduled at the same + # time). # Corresponds to the JSON property `httpRequest` # @return [Google::Apis::CloudtasksV2::HttpRequest] attr_accessor :http_request @@ -1667,24 +1348,18 @@ module Google # @return [Google::Apis::CloudtasksV2::Attempt] attr_accessor :last_attempt - # Optionally caller-specified in CreateTask. - # The task name. - # The task name must have the following format: - # `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID` - # * `PROJECT_ID` can contain letters ([A-Za-z]), numbers ([0-9]), - # hyphens (-), colons (:), or periods (.). - # For more information, see - # [Identifying - # projects](https://cloud.google.com/resource-manager/docs/creating-managing- - # projects#identifying_projects) - # * `LOCATION_ID` is the canonical ID for the task's location. - # The list of available locations can be obtained by calling - # ListLocations. - # For more information, see https://cloud.google.com/about/locations/. - # * `QUEUE_ID` can contain letters ([A-Za-z]), numbers ([0-9]), or - # hyphens (-). The maximum length is 100 characters. - # * `TASK_ID` can contain only letters ([A-Za-z]), numbers ([0-9]), - # hyphens (-), or underscores (_). The maximum length is 500 characters. + # Optionally caller-specified in CreateTask. The task name. The task name must + # have the following format: `projects/PROJECT_ID/locations/LOCATION_ID/queues/ + # QUEUE_ID/tasks/TASK_ID` * `PROJECT_ID` can contain letters ([A-Za-z]), numbers + # ([0-9]), hyphens (-), colons (:), or periods (.). For more information, see [ + # Identifying projects](https://cloud.google.com/resource-manager/docs/creating- + # managing-projects#identifying_projects) * `LOCATION_ID` is the canonical ID + # for the task's location. The list of available locations can be obtained by + # calling ListLocations. For more information, see https://cloud.google.com/ + # about/locations/. * `QUEUE_ID` can contain letters ([A-Za-z]), numbers ([0-9]), + # or hyphens (-). The maximum length is 100 characters. * `TASK_ID` can contain + # only letters ([A-Za-z]), numbers ([0-9]), hyphens (-), or underscores (_). The + # maximum length is 500 characters. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name @@ -1694,14 +1369,13 @@ module Google # @return [Fixnum] attr_accessor :response_count - # The time when the task is scheduled to be attempted or retried. - # `schedule_time` will be truncated to the nearest microsecond. + # The time when the task is scheduled to be attempted or retried. `schedule_time` + # will be truncated to the nearest microsecond. # Corresponds to the JSON property `scheduleTime` # @return [String] attr_accessor :schedule_time - # Output only. The view specifies which subset of the Task has - # been returned. + # Output only. The view specifies which subset of the Task has been returned. # Corresponds to the JSON property `view` # @return [String] attr_accessor :view @@ -1730,10 +1404,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 @@ -1752,8 +1425,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/cloudtasks_v2/service.rb b/generated/google/apis/cloudtasks_v2/service.rb index 0752eaf14..34cf14af4 100644 --- a/generated/google/apis/cloudtasks_v2/service.rb +++ b/generated/google/apis/cloudtasks_v2/service.rb @@ -116,23 +116,17 @@ module Google execute_or_queue_command(command, &block) end - # Creates a queue. - # Queues created with this method allow tasks to live for a maximum of 31 - # days. After a task is 31 days old, the task will be deleted regardless of - # whether - # it was dispatched or not. - # WARNING: Using this method may have unintended side effects if you are - # using an App Engine `queue.yaml` or `queue.xml` file to manage your queues. - # Read - # [Overview of Queue Management and - # queue.yaml](https://cloud.google.com/tasks/docs/queue-yaml) before using - # this method. + # Creates a queue. Queues created with this method allow tasks to live for a + # maximum of 31 days. After a task is 31 days old, the task will be deleted + # regardless of whether it was dispatched or not. WARNING: Using this method may + # have unintended side effects if you are using an App Engine `queue.yaml` or ` + # queue.xml` file to manage your queues. Read [Overview of Queue Management and + # queue.yaml](https://cloud.google.com/tasks/docs/queue-yaml) before using this + # method. # @param [String] parent - # Required. The location name in which the queue will be created. - # For example: `projects/PROJECT_ID/locations/LOCATION_ID` - # The list of allowed locations can be obtained by calling Cloud - # Tasks' implementation of - # ListLocations. + # Required. The location name in which the queue will be created. For example: ` + # projects/PROJECT_ID/locations/LOCATION_ID` The list of allowed locations can + # be obtained by calling Cloud Tasks' implementation of ListLocations. # @param [Google::Apis::CloudtasksV2::Queue] queue_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -163,19 +157,15 @@ module Google execute_or_queue_command(command, &block) end - # Deletes a queue. - # This command will delete the queue even if it has tasks in it. - # Note: If you delete a queue, a queue with the same name can't be created - # for 7 days. - # WARNING: Using this method may have unintended side effects if you are + # Deletes a queue. This command will delete the queue even if it has tasks in it. + # Note: If you delete a queue, a queue with the same name can't be created for + # 7 days. WARNING: Using this method may have unintended side effects if you are # using an App Engine `queue.yaml` or `queue.xml` file to manage your queues. - # Read - # [Overview of Queue Management and - # queue.yaml](https://cloud.google.com/tasks/docs/queue-yaml) before using - # this method. + # Read [Overview of Queue Management and queue.yaml](https://cloud.google.com/ + # tasks/docs/queue-yaml) before using this method. # @param [String] name - # Required. The queue name. For example: - # `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID` + # Required. The queue name. For example: `projects/PROJECT_ID/locations/ + # LOCATION_ID/queues/QUEUE_ID` # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -205,8 +195,8 @@ module Google # Gets a queue. # @param [String] name - # Required. The resource name of the queue. For example: - # `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID` + # Required. The resource name of the queue. For example: `projects/PROJECT_ID/ + # locations/LOCATION_ID/queues/QUEUE_ID` # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -234,16 +224,13 @@ module Google execute_or_queue_command(command, &block) end - # Gets the access control policy for a Queue. - # Returns an empty policy if the resource exists and does not have a policy - # set. - # Authorization requires the following - # [Google IAM](https://cloud.google.com/iam) permission on the specified - # resource parent: - # * `cloudtasks.queues.getIamPolicy` + # Gets the access control policy for a Queue. Returns an empty policy if the + # resource exists and does not have a policy set. Authorization requires the + # following [Google IAM](https://cloud.google.com/iam) permission on the + # specified resource parent: * `cloudtasks.queues.getIamPolicy` # @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::CloudtasksV2::GetIamPolicyRequest] get_iam_policy_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -274,36 +261,28 @@ module Google execute_or_queue_command(command, &block) end - # Lists queues. - # Queues are returned in lexicographical order. + # Lists queues. Queues are returned in lexicographical order. # @param [String] parent - # Required. The location name. - # For example: `projects/PROJECT_ID/locations/LOCATION_ID` + # Required. The location name. For example: `projects/PROJECT_ID/locations/ + # LOCATION_ID` # @param [String] filter - # `filter` can be used to specify a subset of queues. Any Queue - # field can be used as a filter and several operators as supported. - # For example: `<=, <, >=, >, !=, =, :`. The filter syntax is the same as - # described in - # [Stackdriver's Advanced Logs - # Filters](https://cloud.google.com/logging/docs/view/advanced_filters). - # Sample filter "state: PAUSED". - # Note that using filters might cause fewer queues than the - # requested page_size to be returned. + # `filter` can be used to specify a subset of queues. Any Queue field can be + # used as a filter and several operators as supported. For example: `<=, <, >=, > + # , !=, =, :`. The filter syntax is the same as described in [Stackdriver's + # Advanced Logs Filters](https://cloud.google.com/logging/docs/view/ + # advanced_filters). Sample filter "state: PAUSED". Note that using filters + # might cause fewer queues than the requested page_size to be returned. # @param [Fixnum] page_size - # Requested page size. - # The maximum page size is 9800. If unspecified, the page size will - # be the maximum. Fewer queues than requested might be returned, - # even if more queues exist; use the - # next_page_token in the - # response to determine if more queues exist. + # Requested page size. The maximum page size is 9800. If unspecified, the page + # size will be the maximum. Fewer queues than requested might be returned, even + # if more queues exist; use the next_page_token in the response to determine if + # more queues exist. # @param [String] page_token - # A token identifying the page of results to return. - # To request the first page results, page_token must be empty. To - # request the next page of results, page_token must be the value of - # next_page_token returned - # from the previous call to ListQueues - # method. It is an error to switch the value of the - # filter while iterating through pages. + # A token identifying the page of results to return. To request the first page + # results, page_token must be empty. To request the next page of results, + # page_token must be the value of next_page_token returned from the previous + # call to ListQueues method. It is an error to switch the value of the filter + # while iterating through pages. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -334,41 +313,30 @@ module Google execute_or_queue_command(command, &block) end - # Updates a queue. - # This method creates the queue if it does not exist and updates - # the queue if it does exist. - # Queues created with this method allow tasks to live for a maximum of 31 - # days. After a task is 31 days old, the task will be deleted regardless of - # whether - # it was dispatched or not. - # WARNING: Using this method may have unintended side effects if you are - # using an App Engine `queue.yaml` or `queue.xml` file to manage your queues. - # Read - # [Overview of Queue Management and - # queue.yaml](https://cloud.google.com/tasks/docs/queue-yaml) before using - # this method. + # Updates a queue. This method creates the queue if it does not exist and + # updates the queue if it does exist. Queues created with this method allow + # tasks to live for a maximum of 31 days. After a task is 31 days old, the task + # will be deleted regardless of whether it was dispatched or not. WARNING: Using + # this method may have unintended side effects if you are using an App Engine ` + # queue.yaml` or `queue.xml` file to manage your queues. Read [Overview of Queue + # Management and queue.yaml](https://cloud.google.com/tasks/docs/queue-yaml) + # before using this method. # @param [String] name - # Caller-specified and required in CreateQueue, - # after which it becomes output only. - # The queue name. - # The queue name must have the following format: - # `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID` - # * `PROJECT_ID` can contain letters ([A-Za-z]), numbers ([0-9]), - # hyphens (-), colons (:), or periods (.). - # For more information, see - # [Identifying - # projects](https://cloud.google.com/resource-manager/docs/creating-managing- - # projects#identifying_projects) - # * `LOCATION_ID` is the canonical ID for the queue's location. - # The list of available locations can be obtained by calling - # ListLocations. - # For more information, see https://cloud.google.com/about/locations/. - # * `QUEUE_ID` can contain letters ([A-Za-z]), numbers ([0-9]), or - # hyphens (-). The maximum length is 100 characters. + # Caller-specified and required in CreateQueue, after which it becomes output + # only. The queue name. The queue name must have the following format: `projects/ + # PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID` * `PROJECT_ID` can contain + # letters ([A-Za-z]), numbers ([0-9]), hyphens (-), colons (:), or periods (.). + # For more information, see [Identifying projects](https://cloud.google.com/ + # resource-manager/docs/creating-managing-projects#identifying_projects) * ` + # LOCATION_ID` is the canonical ID for the queue's location. The list of + # available locations can be obtained by calling ListLocations. For more + # information, see https://cloud.google.com/about/locations/. * `QUEUE_ID` can + # contain letters ([A-Za-z]), numbers ([0-9]), or hyphens (-). The maximum + # length is 100 characters. # @param [Google::Apis::CloudtasksV2::Queue] queue_object # @param [String] update_mask - # A mask used to specify which fields of the queue are being updated. - # If empty, then all fields will be updated. + # A mask used to specify which fields of the queue are being updated. If empty, + # then all fields will be updated. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -399,15 +367,12 @@ module Google execute_or_queue_command(command, &block) end - # Pauses the queue. - # If a queue is paused then the system will stop dispatching tasks - # until the queue is resumed via - # ResumeQueue. Tasks can still be added - # when the queue is paused. A queue is paused if its - # state is PAUSED. + # Pauses the queue. If a queue is paused then the system will stop dispatching + # tasks until the queue is resumed via ResumeQueue. Tasks can still be added + # when the queue is paused. A queue is paused if its state is PAUSED. # @param [String] name - # Required. The queue name. For example: - # `projects/PROJECT_ID/location/LOCATION_ID/queues/QUEUE_ID` + # Required. The queue name. For example: `projects/PROJECT_ID/location/ + # LOCATION_ID/queues/QUEUE_ID` # @param [Google::Apis::CloudtasksV2::PauseQueueRequest] pause_queue_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -438,13 +403,13 @@ module Google execute_or_queue_command(command, &block) end - # Purges a queue by deleting all of its tasks. - # All tasks created before this method is called are permanently deleted. - # Purge operations can take up to one minute to take effect. Tasks - # might be dispatched before the purge takes effect. A purge is irreversible. + # Purges a queue by deleting all of its tasks. All tasks created before this + # method is called are permanently deleted. Purge operations can take up to one + # minute to take effect. Tasks might be dispatched before the purge takes effect. + # A purge is irreversible. # @param [String] name - # Required. The queue name. For example: - # `projects/PROJECT_ID/location/LOCATION_ID/queues/QUEUE_ID` + # Required. The queue name. For example: `projects/PROJECT_ID/location/ + # LOCATION_ID/queues/QUEUE_ID` # @param [Google::Apis::CloudtasksV2::PurgeQueueRequest] purge_queue_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -475,20 +440,15 @@ module Google execute_or_queue_command(command, &block) end - # Resume a queue. - # This method resumes a queue after it has been - # PAUSED or - # DISABLED. The state of a queue is stored - # in the queue's state; after calling this method it - # will be set to RUNNING. - # WARNING: Resuming many high-QPS queues at the same time can - # lead to target overloading. If you are resuming high-QPS - # queues, follow the 500/50/5 pattern described in - # [Managing Cloud Tasks Scaling + # Resume a queue. This method resumes a queue after it has been PAUSED or + # DISABLED. The state of a queue is stored in the queue's state; after calling + # this method it will be set to RUNNING. WARNING: Resuming many high-QPS queues + # at the same time can lead to target overloading. If you are resuming high-QPS + # queues, follow the 500/50/5 pattern described in [Managing Cloud Tasks Scaling # Risks](https://cloud.google.com/tasks/docs/manage-cloud-task-scaling). # @param [String] name - # Required. The queue name. For example: - # `projects/PROJECT_ID/location/LOCATION_ID/queues/QUEUE_ID` + # Required. The queue name. For example: `projects/PROJECT_ID/location/ + # LOCATION_ID/queues/QUEUE_ID` # @param [Google::Apis::CloudtasksV2::ResumeQueueRequest] resume_queue_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -519,17 +479,14 @@ module Google execute_or_queue_command(command, &block) end - # Sets the access control policy for a Queue. Replaces any existing - # policy. - # Note: The Cloud Console does not check queue-level IAM permissions yet. - # Project-level permissions are required to use the Cloud Console. - # Authorization requires the following - # [Google IAM](https://cloud.google.com/iam) permission on the specified - # resource parent: - # * `cloudtasks.queues.setIamPolicy` + # Sets the access control policy for a Queue. Replaces any existing policy. Note: + # The Cloud Console does not check queue-level IAM permissions yet. Project- + # level permissions are required to use the Cloud Console. Authorization + # requires the following [Google IAM](https://cloud.google.com/iam) permission + # on the specified resource parent: * `cloudtasks.queues.setIamPolicy` # @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::CloudtasksV2::SetIamPolicyRequest] set_iam_policy_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -560,15 +517,14 @@ module Google execute_or_queue_command(command, &block) end - # Returns permissions that a caller has on a Queue. - # 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 a Queue. 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::CloudtasksV2::TestIamPermissionsRequest] test_iam_permissions_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -599,13 +555,11 @@ module Google execute_or_queue_command(command, &block) end - # Creates a task and adds it to a queue. - # Tasks cannot be updated after creation; there is no UpdateTask command. - # * The maximum task size is 100KB. + # Creates a task and adds it to a queue. Tasks cannot be updated after creation; + # there is no UpdateTask command. * The maximum task size is 100KB. # @param [String] parent - # Required. The queue name. For example: - # `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID` - # The queue must already exist. + # Required. The queue name. For example: `projects/PROJECT_ID/locations/ + # LOCATION_ID/queues/QUEUE_ID` The queue must already exist. # @param [Google::Apis::CloudtasksV2::CreateTaskRequest] create_task_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -636,13 +590,11 @@ module Google execute_or_queue_command(command, &block) end - # Deletes a task. - # A task can be deleted if it is scheduled or dispatched. A task - # cannot be deleted if it has executed successfully or permanently - # failed. + # Deletes a task. A task can be deleted if it is scheduled or dispatched. A task + # cannot be deleted if it has executed successfully or permanently failed. # @param [String] name - # Required. The task name. For example: - # `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID` + # Required. The task name. For example: `projects/PROJECT_ID/locations/ + # LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID` # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -672,19 +624,15 @@ module Google # Gets a task. # @param [String] name - # Required. The task name. For example: - # `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID` + # Required. The task name. For example: `projects/PROJECT_ID/locations/ + # LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID` # @param [String] response_view - # The response_view specifies which subset of the Task will be - # returned. - # By default response_view is BASIC; not all - # information is retrieved by default because some data, such as - # payloads, might be desirable to return only when needed because - # of its large size or because of the sensitivity of data that it - # contains. - # Authorization for FULL requires - # `cloudtasks.tasks.fullView` [Google IAM](https://cloud.google.com/iam/) - # permission on the Task resource. + # The response_view specifies which subset of the Task will be returned. By + # default response_view is BASIC; not all information is retrieved by default + # because some data, such as payloads, might be desirable to return only when + # needed because of its large size or because of the sensitivity of data that it + # contains. Authorization for FULL requires `cloudtasks.tasks.fullView` [Google + # IAM](https://cloud.google.com/iam/) permission on the Task resource. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -713,42 +661,30 @@ module Google execute_or_queue_command(command, &block) end - # Lists the tasks in a queue. - # By default, only the BASIC view is retrieved - # due to performance considerations; - # response_view controls the - # subset of information which is returned. - # The tasks may be returned in any order. The ordering may change at any - # time. + # Lists the tasks in a queue. By default, only the BASIC view is retrieved due + # to performance considerations; response_view controls the subset of + # information which is returned. The tasks may be returned in any order. The + # ordering may change at any time. # @param [String] parent - # Required. The queue name. For example: - # `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID` + # Required. The queue name. For example: `projects/PROJECT_ID/locations/ + # LOCATION_ID/queues/QUEUE_ID` # @param [Fixnum] page_size - # Maximum page size. - # Fewer tasks than requested might be returned, even if more tasks exist; use - # next_page_token in the response to - # determine if more tasks exist. - # The maximum page size is 1000. If unspecified, the page size will be the - # maximum. + # Maximum page size. Fewer tasks than requested might be returned, even if more + # tasks exist; use next_page_token in the response to determine if more tasks + # exist. The maximum page size is 1000. If unspecified, the page size will be + # the maximum. # @param [String] page_token - # A token identifying the page of results to return. - # To request the first page results, page_token must be empty. To - # request the next page of results, page_token must be the value of - # next_page_token returned - # from the previous call to ListTasks - # method. - # The page token is valid for only 2 hours. + # A token identifying the page of results to return. To request the first page + # results, page_token must be empty. To request the next page of results, + # page_token must be the value of next_page_token returned from the previous + # call to ListTasks method. The page token is valid for only 2 hours. # @param [String] response_view - # The response_view specifies which subset of the Task will be - # returned. - # By default response_view is BASIC; not all - # information is retrieved by default because some data, such as - # payloads, might be desirable to return only when needed because - # of its large size or because of the sensitivity of data that it - # contains. - # Authorization for FULL requires - # `cloudtasks.tasks.fullView` [Google IAM](https://cloud.google.com/iam/) - # permission on the Task resource. + # The response_view specifies which subset of the Task will be returned. By + # default response_view is BASIC; not all information is retrieved by default + # because some data, such as payloads, might be desirable to return only when + # needed because of its large size or because of the sensitivity of data that it + # contains. Authorization for FULL requires `cloudtasks.tasks.fullView` [Google + # IAM](https://cloud.google.com/iam/) permission on the Task resource. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -779,28 +715,21 @@ module Google execute_or_queue_command(command, &block) end - # Forces a task to run now. - # When this method is called, Cloud Tasks will dispatch the task, even if - # the task is already running, the queue has reached its RateLimits or - # is PAUSED. - # This command is meant to be used for manual debugging. For - # example, RunTask can be used to retry a failed - # task after a fix has been made or to manually force a task to be - # dispatched now. - # The dispatched task is returned. That is, the task that is returned - # contains the status after the task is dispatched but - # before the task is received by its target. - # If Cloud Tasks receives a successful response from the task's - # target, then the task will be deleted; otherwise the task's - # schedule_time will be reset to the time that - # RunTask was called plus the retry delay specified - # in the queue's RetryConfig. - # RunTask returns - # NOT_FOUND when it is called on a - # task that has already succeeded or permanently failed. + # Forces a task to run now. When this method is called, Cloud Tasks will + # dispatch the task, even if the task is already running, the queue has reached + # its RateLimits or is PAUSED. This command is meant to be used for manual + # debugging. For example, RunTask can be used to retry a failed task after a fix + # has been made or to manually force a task to be dispatched now. The dispatched + # task is returned. That is, the task that is returned contains the status after + # the task is dispatched but before the task is received by its target. If Cloud + # Tasks receives a successful response from the task's target, then the task + # will be deleted; otherwise the task's schedule_time will be reset to the time + # that RunTask was called plus the retry delay specified in the queue's + # RetryConfig. RunTask returns NOT_FOUND when it is called on a task that has + # already succeeded or permanently failed. # @param [String] name - # Required. The task name. For example: - # `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID` + # Required. The task name. For example: `projects/PROJECT_ID/locations/ + # LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID` # @param [Google::Apis::CloudtasksV2::RunTaskRequest] run_task_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. diff --git a/generated/google/apis/container_v1beta1.rb b/generated/google/apis/container_v1beta1.rb index 087b09791..5684fa989 100644 --- a/generated/google/apis/container_v1beta1.rb +++ b/generated/google/apis/container_v1beta1.rb @@ -26,7 +26,7 @@ module Google # @see https://cloud.google.com/container-engine/ module ContainerV1beta1 VERSION = 'V1beta1' - REVISION = '20200724' + 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/container_v1beta1/classes.rb b/generated/google/apis/container_v1beta1/classes.rb index b42bea106..fbfb41943 100644 --- a/generated/google/apis/container_v1beta1/classes.rb +++ b/generated/google/apis/container_v1beta1/classes.rb @@ -31,8 +31,8 @@ module Google # @return [Fixnum] attr_accessor :accelerator_count - # The accelerator type resource name. List of supported accelerators - # [here](https://cloud.google.com/compute/docs/gpus) + # The accelerator type resource name. List of supported accelerators [here]( + # https://cloud.google.com/compute/docs/gpus) # Corresponds to the JSON property `acceleratorType` # @return [String] attr_accessor :accelerator_type @@ -48,8 +48,8 @@ module Google end end - # Configuration for the addons that can be automatically spun up in the - # cluster, enabling additional functionality. + # Configuration for the addons that can be automatically spun up in the cluster, + # enabling additional functionality. class AddonsConfig include Google::Apis::Core::Hashable @@ -75,14 +75,14 @@ module Google attr_accessor :gce_persistent_disk_csi_driver_config # Configuration options for the horizontal pod autoscaling feature, which - # increases or decreases the number of replica pods a replication controller - # has based on the resource usage of the existing pods. + # increases or decreases the number of replica pods a replication controller has + # based on the resource usage of the existing pods. # Corresponds to the JSON property `horizontalPodAutoscaling` # @return [Google::Apis::ContainerV1beta1::HorizontalPodAutoscaling] attr_accessor :horizontal_pod_autoscaling - # Configuration options for the HTTP (L7) load balancing controller addon, - # which makes it easy to set up HTTP load balancers for services in a cluster. + # Configuration options for the HTTP (L7) load balancing controller addon, which + # makes it easy to set up HTTP load balancers for services in a cluster. # Corresponds to the JSON property `httpLoadBalancing` # @return [Google::Apis::ContainerV1beta1::HttpLoadBalancing] attr_accessor :http_load_balancing @@ -102,9 +102,9 @@ module Google # @return [Google::Apis::ContainerV1beta1::KubernetesDashboard] attr_accessor :kubernetes_dashboard - # Configuration for NetworkPolicy. This only tracks whether the addon - # is enabled or not on the Master, it does not track whether network policy - # is enabled for the nodes. + # Configuration for NetworkPolicy. This only tracks whether the addon is enabled + # or not on the Master, it does not track whether network policy is enabled for + # the nodes. # Corresponds to the JSON property `networkPolicyConfig` # @return [Google::Apis::ContainerV1beta1::NetworkPolicyConfig] attr_accessor :network_policy_config @@ -132,15 +132,15 @@ module Google class AuthenticatorGroupsConfig include Google::Apis::Core::Hashable - # Whether this cluster should return group membership lookups - # during authentication using a group of security groups. + # Whether this cluster should return group membership lookups during + # authentication using a group of security groups. # Corresponds to the JSON property `enabled` # @return [Boolean] attr_accessor :enabled alias_method :enabled?, :enabled - # The name of the security group-of-groups to be used. Only relevant - # if enabled = true. + # The name of the security group-of-groups to be used. Only relevant if enabled = + # true. # Corresponds to the JSON property `securityGroup` # @return [String] attr_accessor :security_group @@ -156,20 +156,20 @@ module Google end end - # AutoUpgradeOptions defines the set of options for the user to control how - # the Auto Upgrades will proceed. + # AutoUpgradeOptions defines the set of options for the user to control how the + # Auto Upgrades will proceed. class AutoUpgradeOptions include Google::Apis::Core::Hashable - # [Output only] This field is set when upgrades are about to commence - # with the approximate start time for the upgrades, in - # [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + # [Output only] This field is set when upgrades are about to commence with the + # approximate start time for the upgrades, in [RFC3339](https://www.ietf.org/rfc/ + # rfc3339.txt) text format. # Corresponds to the JSON property `autoUpgradeStartTime` # @return [String] attr_accessor :auto_upgrade_start_time - # [Output only] This field is set when upgrades are about to commence - # with the description of the upgrade. + # [Output only] This field is set when upgrades are about to commence with the + # description of the upgrade. # Corresponds to the JSON property `description` # @return [String] attr_accessor :description @@ -185,8 +185,8 @@ module Google end end - # AutoprovisioningNodePoolDefaults contains defaults for a node pool created - # by NAP. + # AutoprovisioningNodePoolDefaults contains defaults for a node pool created by + # NAP. class AutoprovisioningNodePoolDefaults include Google::Apis::Core::Hashable @@ -198,59 +198,49 @@ module Google # Minimum CPU platform to be used by this instance. The instance may be # scheduled on the specified or newer CPU platform. Applicable values are the - # friendly names of CPU platforms, such as - # `minCpuPlatform: "Intel Haswell"` or - # `minCpuPlatform: "Intel Sandy Bridge"`. For more - # information, read [how to specify min CPU - # platform](https://cloud.google.com/compute/docs/instances/specify-min-cpu- - # platform) - # To unset the min cpu platform field pass "automatic" + # friendly names of CPU platforms, such as `minCpuPlatform: "Intel Haswell"` or ` + # minCpuPlatform: "Intel Sandy Bridge"`. For more information, read [how to + # specify min CPU platform](https://cloud.google.com/compute/docs/instances/ + # specify-min-cpu-platform) To unset the min cpu platform field pass "automatic" # as field value. # Corresponds to the JSON property `minCpuPlatform` # @return [String] attr_accessor :min_cpu_platform - # The set of Google API scopes to be made available on all of the - # node VMs under the "default" service account. - # The following scopes are recommended, but not required, and by default are - # not included: - # * `https://www.googleapis.com/auth/compute` is required for mounting - # persistent storage on your nodes. - # * `https://www.googleapis.com/auth/devstorage.read_only` is required for - # communicating with **gcr.io** - # (the [Google Container - # Registry](https://cloud.google.com/container-registry/)). - # If unspecified, no scopes are added, unless Cloud Logging or Cloud - # Monitoring are enabled, in which case their required scopes will be added. + # The set of Google API scopes to be made available on all of the node VMs under + # the "default" service account. The following scopes are recommended, but not + # required, and by default are not included: * `https://www.googleapis.com/auth/ + # compute` is required for mounting persistent storage on your nodes. * `https:// + # www.googleapis.com/auth/devstorage.read_only` is required for communicating + # with **gcr.io** (the [Google Container Registry](https://cloud.google.com/ + # container-registry/)). If unspecified, no scopes are added, unless Cloud + # Logging or Cloud Monitoring are enabled, in which case their required scopes + # will be added. # Corresponds to the JSON property `oauthScopes` # @return [Array] attr_accessor :oauth_scopes - # The Google Cloud Platform Service Account to be used by the node VMs. - # Specify the email address of the Service Account; otherwise, if no Service - # Account is specified, the "default" service account is used. + # The Google Cloud Platform Service Account to be used by the node VMs. Specify + # the email address of the Service Account; otherwise, if no Service Account is + # specified, the "default" service account is used. # Corresponds to the JSON property `serviceAccount` # @return [String] attr_accessor :service_account # These upgrade settings control the level of parallelism and the level of - # disruption caused by an upgrade. - # maxUnavailable controls the number of nodes that can be simultaneously - # unavailable. - # maxSurge controls the number of additional nodes that can be added to the - # node pool temporarily for the time of the upgrade to increase the number of - # available nodes. - # (maxUnavailable + maxSurge) determines the level of parallelism (how many - # nodes are being upgraded at the same time). - # Note: upgrades inevitably introduce some disruption since workloads need to - # be moved from old nodes to new, upgraded ones. Even if maxUnavailable=0, - # this holds true. (Disruption stays within the limits of - # PodDisruptionBudget, if it is configured.) - # Consider a hypothetical node pool with 5 nodes having maxSurge=2, - # maxUnavailable=1. This means the upgrade process upgrades 3 nodes - # simultaneously. It creates 2 additional (upgraded) nodes, then it brings - # down 3 old (not yet upgraded) nodes at the same time. This ensures that - # there are always at least 4 nodes available. + # disruption caused by an upgrade. maxUnavailable controls the number of nodes + # that can be simultaneously unavailable. maxSurge controls the number of + # additional nodes that can be added to the node pool temporarily for the time + # of the upgrade to increase the number of available nodes. (maxUnavailable + + # maxSurge) determines the level of parallelism (how many nodes are being + # upgraded at the same time). Note: upgrades inevitably introduce some + # disruption since workloads need to be moved from old nodes to new, upgraded + # ones. Even if maxUnavailable=0, this holds true. (Disruption stays within the + # limits of PodDisruptionBudget, if it is configured.) Consider a hypothetical + # node pool with 5 nodes having maxSurge=2, maxUnavailable=1. This means the + # upgrade process upgrades 3 nodes simultaneously. It creates 2 additional ( + # upgraded) nodes, then it brings down 3 old (not yet upgraded) nodes at the + # same time. This ensures that there are always at least 4 nodes available. # Corresponds to the JSON property `upgradeSettings` # @return [Google::Apis::ContainerV1beta1::UpgradeSettings] attr_accessor :upgrade_settings @@ -317,8 +307,8 @@ module Google class BinaryAuthorization include Google::Apis::Core::Hashable - # Enable Binary Authorization for this cluster. If enabled, all container - # images will be validated by Google Binauthz. + # Enable Binary Authorization for this cluster. If enabled, all container images + # will be validated by Google Binauthz. # Corresponds to the JSON property `enabled` # @return [Boolean] attr_accessor :enabled @@ -344,23 +334,22 @@ module Google # @return [String] attr_accessor :name - # Required. Deprecated. The server-assigned `name` of the operation. - # This field has been deprecated and replaced by the name field. + # Required. Deprecated. The server-assigned `name` of the operation. This field + # has been deprecated and replaced by the name field. # Corresponds to the JSON property `operationId` # @return [String] attr_accessor :operation_id # Required. Deprecated. The Google Developers Console [project ID or project - # number](https://support.google.com/cloud/answer/6158840). - # This field has been deprecated and replaced by the name field. + # number](https://support.google.com/cloud/answer/6158840). This field has been + # deprecated and replaced by the name field. # Corresponds to the JSON property `projectId` # @return [String] attr_accessor :project_id - # Required. Deprecated. The name of the Google Compute Engine - # [zone](https://cloud.google.com/compute/docs/zones#available) in which the - # operation resides. This field has been deprecated and replaced by the name - # field. + # Required. Deprecated. The name of the Google Compute Engine [zone](https:// + # cloud.google.com/compute/docs/zones#available) in which the operation resides. + # This field has been deprecated and replaced by the name field. # Corresponds to the JSON property `zone` # @return [String] attr_accessor :zone @@ -447,8 +436,8 @@ module Google class Cluster include Google::Apis::Core::Hashable - # Configuration for the addons that can be automatically spun up in the - # cluster, enabling additional functionality. + # Configuration for the addons that can be automatically spun up in the cluster, + # enabling additional functionality. # Corresponds to the JSON property `addonsConfig` # @return [Google::Apis::ContainerV1beta1::AddonsConfig] attr_accessor :addons_config @@ -458,10 +447,9 @@ module Google # @return [Google::Apis::ContainerV1beta1::AuthenticatorGroupsConfig] attr_accessor :authenticator_groups_config - # ClusterAutoscaling contains global, per-cluster information - # required by Cluster Autoscaler to automatically adjust - # the size of the cluster and create/delete - # node pools based on the current needs. + # ClusterAutoscaling contains global, per-cluster information required by + # Cluster Autoscaler to automatically adjust the size of the cluster and create/ + # delete node pools based on the current needs. # Corresponds to the JSON property `autoscaling` # @return [Google::Apis::ContainerV1beta1::ClusterAutoscaling] attr_accessor :autoscaling @@ -471,10 +459,10 @@ module Google # @return [Google::Apis::ContainerV1beta1::BinaryAuthorization] attr_accessor :binary_authorization - # The IP address range of the container pods in this cluster, in - # [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) - # notation (e.g. `10.96.0.0/14`). Leave blank to have - # one automatically chosen or specify a `/14` block in `10.0.0.0/8`. + # The IP address range of the container pods in this cluster, in [CIDR](http:// + # en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `10.96.0. + # 0/14`). Leave blank to have one automatically chosen or specify a `/14` block + # in `10.0.0.0/8`. # Corresponds to the JSON property `clusterIpv4Cidr` # @return [String] attr_accessor :cluster_ipv4_cidr @@ -489,8 +477,8 @@ module Google # @return [Array] attr_accessor :conditions - # [Output only] The time the cluster was created, in - # [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + # [Output only] The time the cluster was created, in [RFC3339](https://www.ietf. + # org/rfc/rfc3339.txt) text format. # Corresponds to the JSON property `createTime` # @return [String] attr_accessor :create_time @@ -500,18 +488,17 @@ module Google # @return [String] attr_accessor :current_master_version - # [Output only] The number of nodes currently in the cluster. Deprecated. - # Call Kubernetes API directly to retrieve node information. + # [Output only] The number of nodes currently in the cluster. Deprecated. Call + # Kubernetes API directly to retrieve node information. # Corresponds to the JSON property `currentNodeCount` # @return [Fixnum] attr_accessor :current_node_count - # [Output only] Deprecated, use - # [NodePool.version](https://cloud.google.com/kubernetes-engine/docs/reference/ - # rest/v1beta1/projects.locations.clusters.nodePools) - # instead. The current version of the node software components. - # If they are currently at multiple versions because they're in the process - # of being upgraded, this reflects the minimum version of all nodes. + # [Output only] Deprecated, use [NodePool.version](https://cloud.google.com/ + # kubernetes-engine/docs/reference/rest/v1beta1/projects.locations.clusters. + # nodePools) instead. The current version of the node software components. If + # they are currently at multiple versions because they're in the process of + # being upgraded, this reflects the minimum version of all nodes. # Corresponds to the JSON property `currentNodeVersion` # @return [String] attr_accessor :current_node_version @@ -531,63 +518,58 @@ module Google # @return [String] attr_accessor :description - # Kubernetes alpha features are enabled on this cluster. This includes alpha - # API groups (e.g. v1beta1) and features that may not be production ready in - # the kubernetes version of the master and nodes. - # The cluster has no SLA for uptime and master/node upgrades are disabled. - # Alpha enabled clusters are automatically deleted thirty days after - # creation. + # Kubernetes alpha features are enabled on this cluster. This includes alpha API + # groups (e.g. v1beta1) and features that may not be production ready in the + # kubernetes version of the master and nodes. The cluster has no SLA for uptime + # and master/node upgrades are disabled. Alpha enabled clusters are + # automatically deleted thirty days after creation. # Corresponds to the JSON property `enableKubernetesAlpha` # @return [Boolean] attr_accessor :enable_kubernetes_alpha alias_method :enable_kubernetes_alpha?, :enable_kubernetes_alpha - # Enable the ability to use Cloud TPUs in this cluster. - # This field is deprecated, use tpu_config.enabled instead. + # Enable the ability to use Cloud TPUs in this cluster. This field is deprecated, + # use tpu_config.enabled instead. # Corresponds to the JSON property `enableTpu` # @return [Boolean] attr_accessor :enable_tpu alias_method :enable_tpu?, :enable_tpu - # [Output only] The IP address of this cluster's master endpoint. - # The endpoint can be accessed from the internet at - # `https://username:password@endpoint/`. - # See the `masterAuth` property of this resource for username and - # password information. + # [Output only] The IP address of this cluster's master endpoint. The endpoint + # can be accessed from the internet at `https://username:password@endpoint/`. + # See the `masterAuth` property of this resource for username and password + # information. # Corresponds to the JSON property `endpoint` # @return [String] attr_accessor :endpoint - # [Output only] The time the cluster will be automatically - # deleted in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + # [Output only] The time the cluster will be automatically deleted in [RFC3339]( + # https://www.ietf.org/rfc/rfc3339.txt) text format. # Corresponds to the JSON property `expireTime` # @return [String] attr_accessor :expire_time - # The initial Kubernetes version for this cluster. Valid versions are those - # found in validMasterVersions returned by getServerConfig. The version can - # be upgraded over time; such upgrades are reflected in - # currentMasterVersion and currentNodeVersion. - # Users may specify either explicit versions offered by - # Kubernetes Engine or version aliases, which have the following behavior: - # - "latest": picks the highest valid Kubernetes version - # - "1.X": picks the highest valid patch+gke.N patch in the 1.X version - # - "1.X.Y": picks the highest valid gke.N patch in the 1.X.Y version - # - "1.X.Y-gke.N": picks an explicit Kubernetes version - # - "","-": picks the default Kubernetes version + # The initial Kubernetes version for this cluster. Valid versions are those + # found in validMasterVersions returned by getServerConfig. The version can be + # upgraded over time; such upgrades are reflected in currentMasterVersion and + # currentNodeVersion. Users may specify either explicit versions offered by + # Kubernetes Engine or version aliases, which have the following behavior: - " + # latest": picks the highest valid Kubernetes version - "1.X": picks the highest + # valid patch+gke.N patch in the 1.X version - "1.X.Y": picks the highest valid + # gke.N patch in the 1.X.Y version - "1.X.Y-gke.N": picks an explicit Kubernetes + # version - "","-": picks the default Kubernetes version # Corresponds to the JSON property `initialClusterVersion` # @return [String] attr_accessor :initial_cluster_version # The number of nodes to create in this cluster. You must ensure that your - # Compute Engine [resource quota](https://cloud.google.com/compute/quotas) - # is sufficient for this number of instances. You must also have available - # firewall and routes quota. - # For requests, this field should only be used in lieu of a - # "node_pool" object, since this configuration (along with the - # "node_config") will be used to create a "NodePool" object with an - # auto-generated name. Do not use this and a node_pool at the same time. - # This field is deprecated, use node_pool.initial_node_count instead. + # Compute Engine [resource quota](https://cloud.google.com/compute/quotas) is + # sufficient for this number of instances. You must also have available firewall + # and routes quota. For requests, this field should only be used in lieu of a " + # node_pool" object, since this configuration (along with the "node_config") + # will be used to create a "NodePool" object with an auto-generated name. Do not + # use this and a node_pool at the same time. This field is deprecated, use + # node_pool.initial_node_count instead. # Corresponds to the JSON property `initialNodeCount` # @return [Fixnum] attr_accessor :initial_node_count @@ -607,39 +589,32 @@ module Google # @return [String] attr_accessor :label_fingerprint - # Configuration for the legacy Attribute Based Access Control authorization - # mode. + # Configuration for the legacy Attribute Based Access Control authorization mode. # Corresponds to the JSON property `legacyAbac` # @return [Google::Apis::ContainerV1beta1::LegacyAbac] attr_accessor :legacy_abac - # [Output only] The name of the Google Compute Engine - # [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones# - # available) - # or - # [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones# - # available) + # [Output only] The name of the Google Compute Engine [zone](https://cloud. + # google.com/compute/docs/regions-zones/regions-zones#available) or [region]( + # https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) # in which the cluster resides. # Corresponds to the JSON property `location` # @return [String] attr_accessor :location - # The list of Google Compute Engine - # [zones](https://cloud.google.com/compute/docs/zones#available) in which the - # cluster's nodes should be located. + # The list of Google Compute Engine [zones](https://cloud.google.com/compute/ + # docs/zones#available) in which the cluster's nodes should be located. # Corresponds to the JSON property `locations` # @return [Array] attr_accessor :locations - # The logging service the cluster should use to write logs. - # Currently available options: - # * `logging.googleapis.com/kubernetes` - The Cloud Logging - # service with a Kubernetes-native resource model - # * `logging.googleapis.com` - The legacy Cloud Logging service (no longer - # available as of GKE 1.15). - # * `none` - no logs will be exported from the cluster. - # If left as an empty string,`logging.googleapis.com/kubernetes` will be - # used for GKE 1.14+ or `logging.googleapis.com` for earlier versions. + # The logging service the cluster should use to write logs. Currently available + # options: * `logging.googleapis.com/kubernetes` - The Cloud Logging service + # with a Kubernetes-native resource model * `logging.googleapis.com` - The + # legacy Cloud Logging service (no longer available as of GKE 1.15). * `none` - + # no logs will be exported from the cluster. If left as an empty string,`logging. + # googleapis.com/kubernetes` will be used for GKE 1.14+ or `logging.googleapis. + # com` for earlier versions. # Corresponds to the JSON property `loggingService` # @return [String] attr_accessor :logging_service @@ -655,8 +630,7 @@ module Google attr_accessor :master # The authentication information for accessing the master endpoint. - # Authentication can be done using HTTP basic auth or using client - # certificates. + # Authentication can be done using HTTP basic auth or using client certificates. # Corresponds to the JSON property `masterAuth` # @return [Google::Apis::ContainerV1beta1::MasterAuth] attr_accessor :master_auth @@ -669,44 +643,37 @@ module Google # @return [Google::Apis::ContainerV1beta1::MasterAuthorizedNetworksConfig] attr_accessor :master_authorized_networks_config - # The IP prefix in CIDR notation to use for the hosted master network. - # This prefix will be used for assigning private IP addresses to the - # master or set of masters, as well as the ILB VIP. - # This field is deprecated, use + # The IP prefix in CIDR notation to use for the hosted master network. This + # prefix will be used for assigning private IP addresses to the master or set of + # masters, as well as the ILB VIP. This field is deprecated, use # private_cluster_config.master_ipv4_cidr_block instead. # Corresponds to the JSON property `masterIpv4CidrBlock` # @return [String] attr_accessor :master_ipv4_cidr_block - # The monitoring service the cluster should use to write metrics. - # Currently available options: - # * "monitoring.googleapis.com/kubernetes" - The Cloud Monitoring - # service with a Kubernetes-native resource model - # * `monitoring.googleapis.com` - The legacy Cloud Monitoring service (no - # longer available as of GKE 1.15). - # * `none` - No metrics will be exported from the cluster. - # If left as an empty string,`monitoring.googleapis.com/kubernetes` will be - # used for GKE 1.14+ or `monitoring.googleapis.com` for earlier versions. + # The monitoring service the cluster should use to write metrics. Currently + # available options: * "monitoring.googleapis.com/kubernetes" - The Cloud + # Monitoring service with a Kubernetes-native resource model * `monitoring. + # googleapis.com` - The legacy Cloud Monitoring service (no longer available as + # of GKE 1.15). * `none` - No metrics will be exported from the cluster. If left + # as an empty string,`monitoring.googleapis.com/kubernetes` will be used for GKE + # 1.14+ or `monitoring.googleapis.com` for earlier versions. # Corresponds to the JSON property `monitoringService` # @return [String] attr_accessor :monitoring_service - # The name of this cluster. The name must be unique within this project - # and location (e.g. zone or region), and can be up to 40 characters with - # the following restrictions: - # * Lowercase letters, numbers, and hyphens only. - # * Must start with a letter. - # * Must end with a number or a letter. + # The name of this cluster. The name must be unique within this project and + # location (e.g. zone or region), and can be up to 40 characters with the + # following restrictions: * Lowercase letters, numbers, and hyphens only. * Must + # start with a letter. * Must end with a number or a letter. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name - # The name of the Google Compute Engine - # [network](https://cloud.google.com/compute/docs/networks-and-firewalls# - # networks) - # to which the cluster is connected. If left unspecified, the `default` - # network will be used. On output this shows the network ID instead of the - # name. + # The name of the Google Compute Engine [network](https://cloud.google.com/ + # compute/docs/networks-and-firewalls#networks) to which the cluster is + # connected. If left unspecified, the `default` network will be used. On output + # this shows the network ID instead of the name. # Corresponds to the JSON property `network` # @return [String] attr_accessor :network @@ -716,8 +683,8 @@ module Google # @return [Google::Apis::ContainerV1beta1::NetworkConfig] attr_accessor :network_config - # Configuration options for the NetworkPolicy feature. - # https://kubernetes.io/docs/concepts/services-networking/networkpolicies/ + # Configuration options for the NetworkPolicy feature. https://kubernetes.io/ + # docs/concepts/services-networking/networkpolicies/ # Corresponds to the JSON property `networkPolicy` # @return [Google::Apis::ContainerV1beta1::NetworkPolicy] attr_accessor :network_policy @@ -728,20 +695,23 @@ module Google attr_accessor :node_config # [Output only] The size of the address space on each node for hosting - # containers. This is provisioned from within the `container_ipv4_cidr` - # range. This field will only be set when cluster is in route-based network - # mode. + # containers. This is provisioned from within the `container_ipv4_cidr` range. + # This field will only be set when cluster is in route-based network mode. # Corresponds to the JSON property `nodeIpv4CidrSize` # @return [Fixnum] attr_accessor :node_ipv4_cidr_size - # The node pools associated with this cluster. - # This field should not be set if "node_config" or "initial_node_count" are - # specified. + # The node pools associated with this cluster. This field should not be set if " + # node_config" or "initial_node_count" are specified. # Corresponds to the JSON property `nodePools` # @return [Array] attr_accessor :node_pools + # NotificationConfig is the configuration of notifications. + # Corresponds to the JSON property `notificationConfig` + # @return [Google::Apis::ContainerV1beta1::NotificationConfig] + attr_accessor :notification_config + # Configuration for the PodSecurityPolicy feature. # Corresponds to the JSON property `podSecurityPolicyConfig` # @return [Google::Apis::ContainerV1beta1::PodSecurityPolicyConfig] @@ -749,9 +719,8 @@ module Google # If this is a private cluster setup. Private clusters are clusters that, by # default have no external IP addresses on the nodes and where nodes and the - # master communicate over private IP addresses. - # This field is deprecated, use private_cluster_config.enable_private_nodes - # instead. + # master communicate over private IP addresses. This field is deprecated, use + # private_cluster_config.enable_private_nodes instead. # Corresponds to the JSON property `privateCluster` # @return [Boolean] attr_accessor :private_cluster @@ -762,17 +731,16 @@ module Google # @return [Google::Apis::ContainerV1beta1::PrivateClusterConfig] attr_accessor :private_cluster_config - # ReleaseChannel indicates which release channel a cluster is - # subscribed to. Release channels are arranged in order of risk. - # When a cluster is subscribed to a release channel, Google maintains - # both the master version and the node version. Node auto-upgrade - # defaults to true and cannot be disabled. + # ReleaseChannel indicates which release channel a cluster is subscribed to. + # Release channels are arranged in order of risk. When a cluster is subscribed + # to a release channel, Google maintains both the master version and the node + # version. Node auto-upgrade defaults to true and cannot be disabled. # Corresponds to the JSON property `releaseChannel` # @return [Google::Apis::ContainerV1beta1::ReleaseChannel] attr_accessor :release_channel - # The resource labels for the cluster to use to annotate any related - # Google Compute Engine resources. + # The resource labels for the cluster to use to annotate any related Google + # Compute Engine resources. # Corresponds to the JSON property `resourceLabels` # @return [Hash] attr_accessor :resource_labels @@ -787,11 +755,10 @@ module Google # @return [String] attr_accessor :self_link - # [Output only] The IP address range of the Kubernetes services in - # this cluster, in - # [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) - # notation (e.g. `1.2.3.4/29`). Service addresses are - # typically put in the last `/16` from the container CIDR. + # [Output only] The IP address range of the Kubernetes services in this cluster, + # in [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) + # notation (e.g. `1.2.3.4/29`). Service addresses are typically put in the last ` + # /16` from the container CIDR. # Corresponds to the JSON property `servicesIpv4Cidr` # @return [String] attr_accessor :services_ipv4_cidr @@ -806,16 +773,15 @@ module Google # @return [String] attr_accessor :status - # [Output only] Additional information about the current status of this - # cluster, if available. + # [Output only] Additional information about the current status of this cluster, + # if available. # Corresponds to the JSON property `statusMessage` # @return [String] attr_accessor :status_message - # The name of the Google Compute Engine - # [subnetwork](https://cloud.google.com/compute/docs/subnetworks) to which - # the cluster is connected. On output this shows the subnetwork ID instead of - # the name. + # The name of the Google Compute Engine [subnetwork](https://cloud.google.com/ + # compute/docs/subnetworks) to which the cluster is connected. On output this + # shows the subnetwork ID instead of the name. # Corresponds to the JSON property `subnetwork` # @return [String] attr_accessor :subnetwork @@ -825,29 +791,28 @@ module Google # @return [Google::Apis::ContainerV1beta1::TpuConfig] attr_accessor :tpu_config - # [Output only] The IP address range of the Cloud TPUs in this cluster, in - # [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) - # notation (e.g. `1.2.3.4/29`). + # [Output only] The IP address range of the Cloud TPUs in this cluster, in [CIDR] + # (http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. ` + # 1.2.3.4/29`). # Corresponds to the JSON property `tpuIpv4CidrBlock` # @return [String] attr_accessor :tpu_ipv4_cidr_block - # VerticalPodAutoscaling contains global, per-cluster information - # required by Vertical Pod Autoscaler to automatically adjust - # the resources of pods controlled by it. + # VerticalPodAutoscaling contains global, per-cluster information required by + # Vertical Pod Autoscaler to automatically adjust the resources of pods + # controlled by it. # Corresponds to the JSON property `verticalPodAutoscaling` # @return [Google::Apis::ContainerV1beta1::VerticalPodAutoscaling] attr_accessor :vertical_pod_autoscaling - # Configuration for the use of Kubernetes Service Accounts in GCP IAM - # policies. + # Configuration for the use of Kubernetes Service Accounts in GCP IAM policies. # Corresponds to the JSON property `workloadIdentityConfig` # @return [Google::Apis::ContainerV1beta1::WorkloadIdentityConfig] attr_accessor :workload_identity_config - # [Output only] The name of the Google Compute Engine - # [zone](https://cloud.google.com/compute/docs/zones#available) in which the - # cluster resides. This field is deprecated, use location instead. + # [Output only] The name of the Google Compute Engine [zone](https://cloud. + # google.com/compute/docs/zones#available) in which the cluster resides. This + # field is deprecated, use location instead. # Corresponds to the JSON property `zone` # @return [String] attr_accessor :zone @@ -898,6 +863,7 @@ module Google @node_config = args[:node_config] if args.key?(:node_config) @node_ipv4_cidr_size = args[:node_ipv4_cidr_size] if args.key?(:node_ipv4_cidr_size) @node_pools = args[:node_pools] if args.key?(:node_pools) + @notification_config = args[:notification_config] if args.key?(:notification_config) @pod_security_policy_config = args[:pod_security_policy_config] if args.key?(:pod_security_policy_config) @private_cluster = args[:private_cluster] if args.key?(:private_cluster) @private_cluster_config = args[:private_cluster_config] if args.key?(:private_cluster_config) @@ -918,22 +884,20 @@ module Google end end - # ClusterAutoscaling contains global, per-cluster information - # required by Cluster Autoscaler to automatically adjust - # the size of the cluster and create/delete - # node pools based on the current needs. + # ClusterAutoscaling contains global, per-cluster information required by + # Cluster Autoscaler to automatically adjust the size of the cluster and create/ + # delete node pools based on the current needs. class ClusterAutoscaling include Google::Apis::Core::Hashable - # The list of Google Compute Engine - # [zones](https://cloud.google.com/compute/docs/zones#available) in which the - # NodePool's nodes can be created by NAP. + # The list of Google Compute Engine [zones](https://cloud.google.com/compute/ + # docs/zones#available) in which the NodePool's nodes can be created by NAP. # Corresponds to the JSON property `autoprovisioningLocations` # @return [Array] attr_accessor :autoprovisioning_locations - # AutoprovisioningNodePoolDefaults contains defaults for a node pool created - # by NAP. + # AutoprovisioningNodePoolDefaults contains defaults for a node pool created by + # NAP. # Corresponds to the JSON property `autoprovisioningNodePoolDefaults` # @return [Google::Apis::ContainerV1beta1::AutoprovisioningNodePoolDefaults] attr_accessor :autoprovisioning_node_pool_defaults @@ -949,8 +913,8 @@ module Google attr_accessor :enable_node_autoprovisioning alias_method :enable_node_autoprovisioning?, :enable_node_autoprovisioning - # Contains global constraints regarding minimum and maximum - # amount of resources in the cluster. + # Contains global constraints regarding minimum and maximum amount of resources + # in the cluster. # Corresponds to the JSON property `resourceLimits` # @return [Array] attr_accessor :resource_limits @@ -988,14 +952,13 @@ module Google end end - # ClusterUpdate describes an update to the cluster. Exactly one update can - # be applied to a cluster with each request, so at most one field can be - # provided. + # ClusterUpdate describes an update to the cluster. Exactly one update can be + # applied to a cluster with each request, so at most one field can be provided. class ClusterUpdate include Google::Apis::Core::Hashable - # Configuration for the addons that can be automatically spun up in the - # cluster, enabling additional functionality. + # Configuration for the addons that can be automatically spun up in the cluster, + # enabling additional functionality. # Corresponds to the JSON property `desiredAddonsConfig` # @return [Google::Apis::ContainerV1beta1::AddonsConfig] attr_accessor :desired_addons_config @@ -1005,10 +968,9 @@ module Google # @return [Google::Apis::ContainerV1beta1::BinaryAuthorization] attr_accessor :desired_binary_authorization - # ClusterAutoscaling contains global, per-cluster information - # required by Cluster Autoscaler to automatically adjust - # the size of the cluster and create/delete - # node pools based on the current needs. + # ClusterAutoscaling contains global, per-cluster information required by + # Cluster Autoscaler to automatically adjust the size of the cluster and create/ + # delete node pools based on the current needs. # Corresponds to the JSON property `desiredClusterAutoscaling` # @return [Google::Apis::ContainerV1beta1::ClusterAutoscaling] attr_accessor :desired_cluster_autoscaling @@ -1023,14 +985,19 @@ module Google # @return [Google::Apis::ContainerV1beta1::DatabaseEncryption] attr_accessor :desired_database_encryption - # DefaultSnatStatus contains the desired state of whether default sNAT should - # be disabled on the cluster. + # The desired datapath provider for the cluster. + # Corresponds to the JSON property `desiredDatapathProvider` + # @return [String] + attr_accessor :desired_datapath_provider + + # DefaultSnatStatus contains the desired state of whether default sNAT should be + # disabled on the cluster. # Corresponds to the JSON property `desiredDefaultSnatStatus` # @return [Google::Apis::ContainerV1beta1::DefaultSnatStatus] attr_accessor :desired_default_snat_status - # The desired image type for the node pool. - # NOTE: Set the "desired_node_pool" field as well. + # The desired image type for the node pool. NOTE: Set the "desired_node_pool" + # field as well. # Corresponds to the JSON property `desiredImageType` # @return [String] attr_accessor :desired_image_type @@ -1041,25 +1008,22 @@ module Google # @return [Google::Apis::ContainerV1beta1::IntraNodeVisibilityConfig] attr_accessor :desired_intra_node_visibility_config - # The desired list of Google Compute Engine - # [zones](https://cloud.google.com/compute/docs/zones#available) in which the - # cluster's nodes should be located. Changing the locations a cluster is in - # will result in nodes being either created or removed from the cluster, - # depending on whether locations are being added or removed. - # This list must always include the cluster's primary zone. + # The desired list of Google Compute Engine [zones](https://cloud.google.com/ + # compute/docs/zones#available) in which the cluster's nodes should be located. + # Changing the locations a cluster is in will result in nodes being either + # created or removed from the cluster, depending on whether locations are being + # added or removed. This list must always include the cluster's primary zone. # Corresponds to the JSON property `desiredLocations` # @return [Array] attr_accessor :desired_locations - # The logging service the cluster should use to write logs. - # Currently available options: - # * `logging.googleapis.com/kubernetes` - The Cloud Logging - # service with a Kubernetes-native resource model - # * `logging.googleapis.com` - The legacy Cloud Logging service (no longer - # available as of GKE 1.15). - # * `none` - no logs will be exported from the cluster. - # If left as an empty string,`logging.googleapis.com/kubernetes` will be - # used for GKE 1.14+ or `logging.googleapis.com` for earlier versions. + # The logging service the cluster should use to write logs. Currently available + # options: * `logging.googleapis.com/kubernetes` - The Cloud Logging service + # with a Kubernetes-native resource model * `logging.googleapis.com` - The + # legacy Cloud Logging service (no longer available as of GKE 1.15). * `none` - + # no logs will be exported from the cluster. If left as an empty string,`logging. + # googleapis.com/kubernetes` will be used for GKE 1.14+ or `logging.googleapis. + # com` for earlier versions. # Corresponds to the JSON property `desiredLoggingService` # @return [String] attr_accessor :desired_logging_service @@ -1078,27 +1042,23 @@ module Google attr_accessor :desired_master_authorized_networks_config # The Kubernetes version to change the master to. The only valid value is the - # latest supported version. - # Users may specify either explicit versions offered by - # Kubernetes Engine or version aliases, which have the following behavior: - # - "latest": picks the highest valid Kubernetes version - # - "1.X": picks the highest valid patch+gke.N patch in the 1.X version - # - "1.X.Y": picks the highest valid gke.N patch in the 1.X.Y version - # - "1.X.Y-gke.N": picks an explicit Kubernetes version - # - "-": picks the default Kubernetes version + # latest supported version. Users may specify either explicit versions offered + # by Kubernetes Engine or version aliases, which have the following behavior: - " + # latest": picks the highest valid Kubernetes version - "1.X": picks the highest + # valid patch+gke.N patch in the 1.X version - "1.X.Y": picks the highest valid + # gke.N patch in the 1.X.Y version - "1.X.Y-gke.N": picks an explicit Kubernetes + # version - "-": picks the default Kubernetes version # Corresponds to the JSON property `desiredMasterVersion` # @return [String] attr_accessor :desired_master_version - # The monitoring service the cluster should use to write metrics. - # Currently available options: - # * "monitoring.googleapis.com/kubernetes" - The Cloud Monitoring - # service with a Kubernetes-native resource model - # * `monitoring.googleapis.com` - The legacy Cloud Monitoring service (no - # longer available as of GKE 1.15). - # * `none` - No metrics will be exported from the cluster. - # If left as an empty string,`monitoring.googleapis.com/kubernetes` will be - # used for GKE 1.14+ or `monitoring.googleapis.com` for earlier versions. + # The monitoring service the cluster should use to write metrics. Currently + # available options: * "monitoring.googleapis.com/kubernetes" - The Cloud + # Monitoring service with a Kubernetes-native resource model * `monitoring. + # googleapis.com` - The legacy Cloud Monitoring service (no longer available as + # of GKE 1.15). * `none` - No metrics will be exported from the cluster. If left + # as an empty string,`monitoring.googleapis.com/kubernetes` will be used for GKE + # 1.14+ or `monitoring.googleapis.com` for earlier versions. # Corresponds to the JSON property `desiredMonitoringService` # @return [String] attr_accessor :desired_monitoring_service @@ -1109,27 +1069,30 @@ module Google # @return [Google::Apis::ContainerV1beta1::NodePoolAutoscaling] attr_accessor :desired_node_pool_autoscaling - # The node pool to be upgraded. This field is mandatory if - # "desired_node_version", "desired_image_family", - # "desired_node_pool_autoscaling", or "desired_workload_metadata_config" - # is specified and there is more than one node pool on the cluster. + # The node pool to be upgraded. This field is mandatory if "desired_node_version" + # , "desired_image_family", "desired_node_pool_autoscaling", or " + # desired_workload_metadata_config" is specified and there is more than one node + # pool on the cluster. # Corresponds to the JSON property `desiredNodePoolId` # @return [String] attr_accessor :desired_node_pool_id - # The Kubernetes version to change the nodes to (typically an - # upgrade). - # Users may specify either explicit versions offered by - # Kubernetes Engine or version aliases, which have the following behavior: - # - "latest": picks the highest valid Kubernetes version - # - "1.X": picks the highest valid patch+gke.N patch in the 1.X version - # - "1.X.Y": picks the highest valid gke.N patch in the 1.X.Y version - # - "1.X.Y-gke.N": picks an explicit Kubernetes version - # - "-": picks the Kubernetes master version + # The Kubernetes version to change the nodes to (typically an upgrade). Users + # may specify either explicit versions offered by Kubernetes Engine or version + # aliases, which have the following behavior: - "latest": picks the highest + # valid Kubernetes version - "1.X": picks the highest valid patch+gke.N patch in + # the 1.X version - "1.X.Y": picks the highest valid gke.N patch in the 1.X.Y + # version - "1.X.Y-gke.N": picks an explicit Kubernetes version - "-": picks the + # Kubernetes master version # Corresponds to the JSON property `desiredNodeVersion` # @return [String] attr_accessor :desired_node_version + # NotificationConfig is the configuration of notifications. + # Corresponds to the JSON property `desiredNotificationConfig` + # @return [Google::Apis::ContainerV1beta1::NotificationConfig] + attr_accessor :desired_notification_config + # Configuration for the PodSecurityPolicy feature. # Corresponds to the JSON property `desiredPodSecurityPolicyConfig` # @return [Google::Apis::ContainerV1beta1::PodSecurityPolicyConfig] @@ -1140,11 +1103,10 @@ module Google # @return [Google::Apis::ContainerV1beta1::PrivateClusterConfig] attr_accessor :desired_private_cluster_config - # ReleaseChannel indicates which release channel a cluster is - # subscribed to. Release channels are arranged in order of risk. - # When a cluster is subscribed to a release channel, Google maintains - # both the master version and the node version. Node auto-upgrade - # defaults to true and cannot be disabled. + # ReleaseChannel indicates which release channel a cluster is subscribed to. + # Release channels are arranged in order of risk. When a cluster is subscribed + # to a release channel, Google maintains both the master version and the node + # version. Node auto-upgrade defaults to true and cannot be disabled. # Corresponds to the JSON property `desiredReleaseChannel` # @return [Google::Apis::ContainerV1beta1::ReleaseChannel] attr_accessor :desired_release_channel @@ -1164,15 +1126,14 @@ module Google # @return [Google::Apis::ContainerV1beta1::TpuConfig] attr_accessor :desired_tpu_config - # VerticalPodAutoscaling contains global, per-cluster information - # required by Vertical Pod Autoscaler to automatically adjust - # the resources of pods controlled by it. + # VerticalPodAutoscaling contains global, per-cluster information required by + # Vertical Pod Autoscaler to automatically adjust the resources of pods + # controlled by it. # Corresponds to the JSON property `desiredVerticalPodAutoscaling` # @return [Google::Apis::ContainerV1beta1::VerticalPodAutoscaling] attr_accessor :desired_vertical_pod_autoscaling - # Configuration for the use of Kubernetes Service Accounts in GCP IAM - # policies. + # Configuration for the use of Kubernetes Service Accounts in GCP IAM policies. # Corresponds to the JSON property `desiredWorkloadIdentityConfig` # @return [Google::Apis::ContainerV1beta1::WorkloadIdentityConfig] attr_accessor :desired_workload_identity_config @@ -1188,6 +1149,7 @@ module Google @desired_cluster_autoscaling = args[:desired_cluster_autoscaling] if args.key?(:desired_cluster_autoscaling) @desired_cluster_telemetry = args[:desired_cluster_telemetry] if args.key?(:desired_cluster_telemetry) @desired_database_encryption = args[:desired_database_encryption] if args.key?(:desired_database_encryption) + @desired_datapath_provider = args[:desired_datapath_provider] if args.key?(:desired_datapath_provider) @desired_default_snat_status = args[:desired_default_snat_status] if args.key?(:desired_default_snat_status) @desired_image_type = args[:desired_image_type] if args.key?(:desired_image_type) @desired_intra_node_visibility_config = args[:desired_intra_node_visibility_config] if args.key?(:desired_intra_node_visibility_config) @@ -1200,6 +1162,7 @@ module Google @desired_node_pool_autoscaling = args[:desired_node_pool_autoscaling] if args.key?(:desired_node_pool_autoscaling) @desired_node_pool_id = args[:desired_node_pool_id] if args.key?(:desired_node_pool_id) @desired_node_version = args[:desired_node_version] if args.key?(:desired_node_version) + @desired_notification_config = args[:desired_notification_config] if args.key?(:desired_notification_config) @desired_pod_security_policy_config = args[:desired_pod_security_policy_config] if args.key?(:desired_pod_security_policy_config) @desired_private_cluster_config = args[:desired_private_cluster_config] if args.key?(:desired_private_cluster_config) @desired_release_channel = args[:desired_release_channel] if args.key?(:desired_release_channel) @@ -1215,8 +1178,8 @@ module Google class CompleteIpRotationRequest include Google::Apis::Core::Hashable - # Required. Deprecated. The name of the cluster. - # This field has been deprecated and replaced by the name field. + # Required. Deprecated. The name of the cluster. This field has been deprecated + # and replaced by the name field. # Corresponds to the JSON property `clusterId` # @return [String] attr_accessor :cluster_id @@ -1228,16 +1191,15 @@ module Google attr_accessor :name # Required. Deprecated. The Google Developers Console [project ID or project - # number](https://developers.google.com/console/help/new/#projectnumber). - # This field has been deprecated and replaced by the name field. + # number](https://developers.google.com/console/help/new/#projectnumber). This + # field has been deprecated and replaced by the name field. # Corresponds to the JSON property `projectId` # @return [String] attr_accessor :project_id - # Required. Deprecated. The name of the Google Compute Engine - # [zone](https://cloud.google.com/compute/docs/zones#available) in which the - # cluster resides. This field has been deprecated and replaced by the name - # field. + # Required. Deprecated. The name of the Google Compute Engine [zone](https:// + # cloud.google.com/compute/docs/zones#available) in which the cluster resides. + # This field has been deprecated and replaced by the name field. # Corresponds to the JSON property `zone` # @return [String] attr_accessor :zone @@ -1279,9 +1241,8 @@ module Google class ConsumptionMeteringConfig include Google::Apis::Core::Hashable - # Whether to enable consumption metering for this cluster. If enabled, a - # second BigQuery table will be created to hold resource consumption - # records. + # Whether to enable consumption metering for this cluster. If enabled, a second + # BigQuery table will be created to hold resource consumption records. # Corresponds to the JSON property `enabled` # @return [Boolean] attr_accessor :enabled @@ -1306,23 +1267,22 @@ module Google # @return [Google::Apis::ContainerV1beta1::Cluster] attr_accessor :cluster - # The parent (project and location) where the cluster will be created. - # Specified in the format `projects/*/locations/*`. + # The parent (project and location) where the cluster will be created. Specified + # in the format `projects/*/locations/*`. # Corresponds to the JSON property `parent` # @return [String] attr_accessor :parent # Required. Deprecated. The Google Developers Console [project ID or project - # number](https://support.google.com/cloud/answer/6158840). - # This field has been deprecated and replaced by the parent field. + # number](https://support.google.com/cloud/answer/6158840). This field has been + # deprecated and replaced by the parent field. # Corresponds to the JSON property `projectId` # @return [String] attr_accessor :project_id - # Required. Deprecated. The name of the Google Compute Engine - # [zone](https://cloud.google.com/compute/docs/zones#available) in which the - # cluster resides. This field has been deprecated and replaced by the parent - # field. + # Required. Deprecated. The name of the Google Compute Engine [zone](https:// + # cloud.google.com/compute/docs/zones#available) in which the cluster resides. + # This field has been deprecated and replaced by the parent field. # Corresponds to the JSON property `zone` # @return [String] attr_accessor :zone @@ -1344,40 +1304,38 @@ module Google class CreateNodePoolRequest include Google::Apis::Core::Hashable - # Required. Deprecated. The name of the cluster. - # This field has been deprecated and replaced by the parent field. + # Required. Deprecated. The name of the cluster. This field has been deprecated + # and replaced by the parent field. # Corresponds to the JSON property `clusterId` # @return [String] attr_accessor :cluster_id - # NodePool contains the name and configuration for a cluster's node pool. - # Node pools are a set of nodes (i.e. VM's), with a common configuration and - # specification, under the control of the cluster master. They may have a set - # of Kubernetes labels applied to them, which may be used to reference them - # during pod scheduling. They may also be resized up or down, to accommodate - # the workload. + # NodePool contains the name and configuration for a cluster's node pool. Node + # pools are a set of nodes (i.e. VM's), with a common configuration and + # specification, under the control of the cluster master. They may have a set of + # Kubernetes labels applied to them, which may be used to reference them during + # pod scheduling. They may also be resized up or down, to accommodate the + # workload. # Corresponds to the JSON property `nodePool` # @return [Google::Apis::ContainerV1beta1::NodePool] attr_accessor :node_pool - # The parent (project, location, cluster id) where the node pool will be - # created. Specified in the format - # `projects/*/locations/*/clusters/*`. + # The parent (project, location, cluster id) where the node pool will be created. + # Specified in the format `projects/*/locations/*/clusters/*`. # Corresponds to the JSON property `parent` # @return [String] attr_accessor :parent # Required. Deprecated. The Google Developers Console [project ID or project - # number](https://developers.google.com/console/help/new/#projectnumber). - # This field has been deprecated and replaced by the parent field. + # number](https://developers.google.com/console/help/new/#projectnumber). This + # field has been deprecated and replaced by the parent field. # Corresponds to the JSON property `projectId` # @return [String] attr_accessor :project_id - # Required. Deprecated. The name of the Google Compute Engine - # [zone](https://cloud.google.com/compute/docs/zones#available) in which the - # cluster resides. This field has been deprecated and replaced by the parent - # field. + # Required. Deprecated. The name of the Google Compute Engine [zone](https:// + # cloud.google.com/compute/docs/zones#available) in which the cluster resides. + # This field has been deprecated and replaced by the parent field. # Corresponds to the JSON property `zone` # @return [String] attr_accessor :zone @@ -1400,14 +1358,14 @@ module Google class DailyMaintenanceWindow include Google::Apis::Core::Hashable - # [Output only] Duration of the time window, automatically chosen to be - # smallest possible in the given scenario. + # [Output only] Duration of the time window, automatically chosen to be smallest + # possible in the given scenario. # Corresponds to the JSON property `duration` # @return [String] attr_accessor :duration - # Time within the maintenance window to start the maintenance operations. - # It must be in format "HH:MM", where HH : [00-23] and MM : [00-59] GMT. + # Time within the maintenance window to start the maintenance operations. It + # must be in format "HH:MM", where HH : [00-23] and MM : [00-59] GMT. # Corresponds to the JSON property `startTime` # @return [String] attr_accessor :start_time @@ -1427,8 +1385,8 @@ module Google class DatabaseEncryption include Google::Apis::Core::Hashable - # Name of CloudKMS key to use for the encryption of secrets in etcd. - # Ex. projects/my-project/locations/global/keyRings/my-ring/cryptoKeys/my-key + # Name of CloudKMS key to use for the encryption of secrets in etcd. Ex. + # projects/my-project/locations/global/keyRings/my-ring/cryptoKeys/my-key # Corresponds to the JSON property `keyName` # @return [String] attr_accessor :key_name @@ -1449,8 +1407,8 @@ module Google end end - # DefaultSnatStatus contains the desired state of whether default sNAT should - # be disabled on the cluster. + # DefaultSnatStatus contains the desired state of whether default sNAT should be + # disabled on the cluster. class DefaultSnatStatus include Google::Apis::Core::Hashable @@ -1490,13 +1448,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 @@ -1539,8 +1495,7 @@ module Google # @return [Google::Apis::ContainerV1beta1::HttpCacheControlResponseHeader] attr_accessor :cache_header - # The public component of the keys used by the cluster to sign token - # requests. + # The public component of the keys used by the cluster to sign token requests. # Corresponds to the JSON property `keys` # @return [Array] attr_accessor :keys @@ -1556,8 +1511,8 @@ module Google end end - # GetOpenIDConfigResponse is an OIDC discovery document for the cluster. - # See the OpenID Connect Discovery 1.0 specification for details. + # GetOpenIDConfigResponse is an OIDC discovery document for the cluster. See the + # OpenID Connect Discovery 1.0 specification for details. class GetOpenIdConfigResponse include Google::Apis::Core::Hashable @@ -1619,14 +1574,13 @@ module Google end # Configuration options for the horizontal pod autoscaling feature, which - # increases or decreases the number of replica pods a replication controller - # has based on the resource usage of the existing pods. + # increases or decreases the number of replica pods a replication controller has + # based on the resource usage of the existing pods. class HorizontalPodAutoscaling include Google::Apis::Core::Hashable - # Whether the Horizontal Pod Autoscaling feature is enabled in the cluster. - # When enabled, it ensures that metrics are collected into Stackdriver - # Monitoring. + # Whether the Horizontal Pod Autoscaling feature is enabled in the cluster. When + # enabled, it ensures that metrics are collected into Stackdriver Monitoring. # Corresponds to the JSON property `disabled` # @return [Boolean] attr_accessor :disabled @@ -1673,14 +1627,13 @@ module Google end end - # Configuration options for the HTTP (L7) load balancing controller addon, - # which makes it easy to set up HTTP load balancers for services in a cluster. + # Configuration options for the HTTP (L7) load balancing controller addon, which + # makes it easy to set up HTTP load balancers for services in a cluster. class HttpLoadBalancing include Google::Apis::Core::Hashable - # Whether the HTTP Load Balancing controller is enabled in the cluster. - # When enabled, it runs a small pod in the cluster that manages the load - # balancers. + # Whether the HTTP Load Balancing controller is enabled in the cluster. When + # enabled, it runs a small pod in the cluster that manages the load balancers. # Corresponds to the JSON property `disabled` # @return [Boolean] attr_accessor :disabled @@ -1702,15 +1655,13 @@ module Google # If true, allow allocation of cluster CIDR ranges that overlap with certain # kinds of network routes. By default we do not allow cluster CIDR ranges to - # intersect with any user declared routes. With allow_route_overlap == true, - # we allow overlapping with CIDR ranges that are larger than the cluster CIDR - # range. - # If this field is set to true, then cluster and services CIDRs must be - # fully-specified (e.g. `10.96.0.0/14`, but not `/14`), which means: - # 1) When `use_ip_aliases` is true, `cluster_ipv4_cidr_block` and - # `services_ipv4_cidr_block` must be fully-specified. - # 2) When `use_ip_aliases` is false, `cluster.cluster_ipv4_cidr` muse be - # fully-specified. + # intersect with any user declared routes. With allow_route_overlap == true, we + # allow overlapping with CIDR ranges that are larger than the cluster CIDR range. + # If this field is set to true, then cluster and services CIDRs must be fully- + # specified (e.g. `10.96.0.0/14`, but not `/14`), which means: 1) When ` + # use_ip_aliases` is true, `cluster_ipv4_cidr_block` and ` + # services_ipv4_cidr_block` must be fully-specified. 2) When `use_ip_aliases` is + # false, `cluster.cluster_ipv4_cidr` muse be fully-specified. # Corresponds to the JSON property `allowRouteOverlap` # @return [Boolean] attr_accessor :allow_route_overlap @@ -1721,33 +1672,28 @@ module Google # @return [String] attr_accessor :cluster_ipv4_cidr - # The IP address range for the cluster pod IPs. If this field is set, then - # `cluster.cluster_ipv4_cidr` must be left blank. - # This field is only applicable when `use_ip_aliases` is true. - # Set to blank to have a range chosen with the default size. - # Set to /netmask (e.g. `/14`) to have a range chosen with a specific - # netmask. - # Set to a - # [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) - # notation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g. - # `10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range - # to use. + # The IP address range for the cluster pod IPs. If this field is set, then ` + # cluster.cluster_ipv4_cidr` must be left blank. This field is only applicable + # when `use_ip_aliases` is true. Set to blank to have a range chosen with the + # default size. Set to /netmask (e.g. `/14`) to have a range chosen with a + # specific netmask. Set to a [CIDR](http://en.wikipedia.org/wiki/Classless_Inter- + # Domain_Routing) notation (e.g. `10.96.0.0/14`) from the RFC-1918 private + # networks (e.g. `10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a + # specific range to use. # Corresponds to the JSON property `clusterIpv4CidrBlock` # @return [String] attr_accessor :cluster_ipv4_cidr_block - # The name of the secondary range to be used for the cluster CIDR - # block. The secondary range will be used for pod IP - # addresses. This must be an existing secondary range associated - # with the cluster subnetwork. - # This field is only applicable with use_ip_aliases and - # create_subnetwork is false. + # The name of the secondary range to be used for the cluster CIDR block. The + # secondary range will be used for pod IP addresses. This must be an existing + # secondary range associated with the cluster subnetwork. This field is only + # applicable with use_ip_aliases and create_subnetwork is false. # Corresponds to the JSON property `clusterSecondaryRangeName` # @return [String] attr_accessor :cluster_secondary_range_name - # Whether a new subnetwork will be created automatically for the cluster. - # This field is only applicable when `use_ip_aliases` is true. + # Whether a new subnetwork will be created automatically for the cluster. This + # field is only applicable when `use_ip_aliases` is true. # Corresponds to the JSON property `createSubnetwork` # @return [Boolean] attr_accessor :create_subnetwork @@ -1758,16 +1704,13 @@ module Google # @return [String] attr_accessor :node_ipv4_cidr - # The IP address range of the instance IPs in this cluster. - # This is applicable only if `create_subnetwork` is true. - # Set to blank to have a range chosen with the default size. - # Set to /netmask (e.g. `/14`) to have a range chosen with a specific - # netmask. - # Set to a - # [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) - # notation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g. - # `10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range - # to use. + # The IP address range of the instance IPs in this cluster. This is applicable + # only if `create_subnetwork` is true. Set to blank to have a range chosen with + # the default size. Set to /netmask (e.g. `/14`) to have a range chosen with a + # specific netmask. Set to a [CIDR](http://en.wikipedia.org/wiki/Classless_Inter- + # Domain_Routing) notation (e.g. `10.96.0.0/14`) from the RFC-1918 private + # networks (e.g. `10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a + # specific range to use. # Corresponds to the JSON property `nodeIpv4CidrBlock` # @return [String] attr_accessor :node_ipv4_cidr_block @@ -1778,66 +1721,57 @@ module Google attr_accessor :services_ipv4_cidr # The IP address range of the services IPs in this cluster. If blank, a range - # will be automatically chosen with the default size. - # This field is only applicable when `use_ip_aliases` is true. - # Set to blank to have a range chosen with the default size. - # Set to /netmask (e.g. `/14`) to have a range chosen with a specific - # netmask. - # Set to a - # [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) - # notation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g. - # `10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range - # to use. + # will be automatically chosen with the default size. This field is only + # applicable when `use_ip_aliases` is true. Set to blank to have a range chosen + # with the default size. Set to /netmask (e.g. `/14`) to have a range chosen + # with a specific netmask. Set to a [CIDR](http://en.wikipedia.org/wiki/ + # Classless_Inter-Domain_Routing) notation (e.g. `10.96.0.0/14`) from the RFC- + # 1918 private networks (e.g. `10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) + # to pick a specific range to use. # Corresponds to the JSON property `servicesIpv4CidrBlock` # @return [String] attr_accessor :services_ipv4_cidr_block - # The name of the secondary range to be used as for the services - # CIDR block. The secondary range will be used for service - # ClusterIPs. This must be an existing secondary range associated - # with the cluster subnetwork. - # This field is only applicable with use_ip_aliases and - # create_subnetwork is false. + # The name of the secondary range to be used as for the services CIDR block. The + # secondary range will be used for service ClusterIPs. This must be an existing + # secondary range associated with the cluster subnetwork. This field is only + # applicable with use_ip_aliases and create_subnetwork is false. # Corresponds to the JSON property `servicesSecondaryRangeName` # @return [String] attr_accessor :services_secondary_range_name - # A custom subnetwork name to be used if `create_subnetwork` is true. If - # this field is empty, then an automatic name will be chosen for the new - # subnetwork. + # A custom subnetwork name to be used if `create_subnetwork` is true. If this + # field is empty, then an automatic name will be chosen for the new subnetwork. # Corresponds to the JSON property `subnetworkName` # @return [String] attr_accessor :subnetwork_name # The IP address range of the Cloud TPUs in this cluster. If unspecified, a - # range will be automatically chosen with the default size. - # This field is only applicable when `use_ip_aliases` is true. - # If unspecified, the range will use the default size. - # Set to /netmask (e.g. `/14`) to have a range chosen with a specific - # netmask. - # Set to a - # [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) - # notation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g. - # `10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range - # to use. - # This field is deprecated, use cluster.tpu_config.ipv4_cidr_block instead. + # range will be automatically chosen with the default size. This field is only + # applicable when `use_ip_aliases` is true. If unspecified, the range will use + # the default size. Set to /netmask (e.g. `/14`) to have a range chosen with a + # specific netmask. Set to a [CIDR](http://en.wikipedia.org/wiki/Classless_Inter- + # Domain_Routing) notation (e.g. `10.96.0.0/14`) from the RFC-1918 private + # networks (e.g. `10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a + # specific range to use. This field is deprecated, use cluster.tpu_config. + # ipv4_cidr_block instead. # Corresponds to the JSON property `tpuIpv4CidrBlock` # @return [String] attr_accessor :tpu_ipv4_cidr_block - # Whether alias IPs will be used for pod IPs in the cluster. - # This is used in conjunction with use_routes. It cannot - # be true if use_routes is true. If both use_ip_aliases and use_routes are - # false, then the server picks the default IP allocation mode + # Whether alias IPs will be used for pod IPs in the cluster. This is used in + # conjunction with use_routes. It cannot be true if use_routes is true. If both + # use_ip_aliases and use_routes are false, then the server picks the default IP + # allocation mode # Corresponds to the JSON property `useIpAliases` # @return [Boolean] attr_accessor :use_ip_aliases alias_method :use_ip_aliases?, :use_ip_aliases - # Whether routes will be used for pod IPs in the cluster. - # This is used in conjunction with use_ip_aliases. It cannot be true if - # use_ip_aliases is true. If both use_ip_aliases and use_routes are false, - # then the server picks the default IP allocation mode + # Whether routes will be used for pod IPs in the cluster. This is used in + # conjunction with use_ip_aliases. It cannot be true if use_ip_aliases is true. + # If both use_ip_aliases and use_routes are false, then the server picks the + # default IP allocation mode # Corresponds to the JSON property `useRoutes` # @return [Boolean] attr_accessor :use_routes @@ -2020,15 +1954,14 @@ module Google end end - # Configuration for the legacy Attribute Based Access Control authorization - # mode. + # Configuration for the legacy Attribute Based Access Control authorization mode. class LegacyAbac include Google::Apis::Core::Hashable # Whether the ABAC authorizer is enabled for this cluster. When enabled, - # identities in the system, including service accounts, nodes, and - # controllers, will have statically granted permissions beyond those - # provided by the RBAC configuration or IAM. + # identities in the system, including service accounts, nodes, and controllers, + # will have statically granted permissions beyond those provided by the RBAC + # configuration or IAM. # Corresponds to the JSON property `enabled` # @return [Boolean] attr_accessor :enabled @@ -2048,18 +1981,10 @@ module Google class LinuxNodeConfig include Google::Apis::Core::Hashable - # The Linux kernel parameters to be applied to the nodes and all pods running - # on the nodes. - # The following parameters are supported. - # net.core.netdev_max_backlog - # net.core.rmem_max - # net.core.wmem_default - # net.core.wmem_max - # net.core.optmem_max - # net.core.somaxconn - # net.ipv4.tcp_rmem - # net.ipv4.tcp_wmem - # net.ipv4.tcp_tw_reuse + # The Linux kernel parameters to be applied to the nodes and all pods running on + # the nodes. The following parameters are supported. net.core.netdev_max_backlog + # net.core.rmem_max net.core.wmem_default net.core.wmem_max net.core.optmem_max + # net.core.somaxconn net.ipv4.tcp_rmem net.ipv4.tcp_wmem net.ipv4.tcp_tw_reuse # Corresponds to the JSON property `sysctls` # @return [Hash] attr_accessor :sysctls @@ -2078,14 +2003,13 @@ module Google class ListClustersResponse include Google::Apis::Core::Hashable - # A list of clusters in the project in the specified zone, or - # across all ones. + # A list of clusters in the project in the specified zone, or across all ones. # Corresponds to the JSON property `clusters` # @return [Array] attr_accessor :clusters - # If any zones are listed here, the list of clusters returned - # may be missing those zones. + # If any zones are listed here, the list of clusters returned may be missing + # those zones. # Corresponds to the JSON property `missingZones` # @return [Array] attr_accessor :missing_zones @@ -2111,10 +2035,10 @@ module Google # @return [Array] attr_accessor :locations - # Only return ListLocationsResponse that occur after the page_token. This - # value should be populated from the ListLocationsResponse.next_page_token if - # that response token was set (which happens when listing more Locations than - # fit in a single ListLocationsResponse). + # Only return ListLocationsResponse that occur after the page_token. This value + # should be populated from the ListLocationsResponse.next_page_token if that + # response token was set (which happens when listing more Locations than fit in + # a single ListLocationsResponse). # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token @@ -2153,8 +2077,8 @@ module Google class ListOperationsResponse include Google::Apis::Core::Hashable - # If any zones are listed here, the list of operations returned - # may be missing the operations from those zones. + # If any zones are listed here, the list of operations returned may be missing + # the operations from those zones. # Corresponds to the JSON property `missingZones` # @return [Array] attr_accessor :missing_zones @@ -2175,15 +2099,14 @@ module Google end end - # ListUsableSubnetworksResponse is the response of - # ListUsableSubnetworksRequest. + # ListUsableSubnetworksResponse is the response of ListUsableSubnetworksRequest. class ListUsableSubnetworksResponse include Google::Apis::Core::Hashable - # This token allows you to get the next page of results for list requests. - # If the number of results is larger than `page_size`, use the - # `next_page_token` as a value for the query parameter `page_token` in the - # next request. The value will become empty when there are no more pages. + # This token allows you to get the next page of results for list requests. If + # the number of results is larger than `page_size`, use the `next_page_token` as + # a value for the query parameter `page_token` in the next request. The value + # will become empty when there are no more pages. # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token @@ -2204,13 +2127,13 @@ module Google end end - # Location returns the location name, and if the location is recommended - # for GKE cluster scheduling. + # Location returns the location name, and if the location is recommended for GKE + # cluster scheduling. class Location include Google::Apis::Core::Hashable - # Contains the name of the resource requested. - # Specified in the format `projects/*/locations/*`. + # Contains the name of the resource requested. Specified in the format `projects/ + # */locations/*`. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name @@ -2221,8 +2144,7 @@ module Google attr_accessor :recommended alias_method :recommended?, :recommended - # Contains the type of location this Location is for. - # Regional or Zonal. + # Contains the type of location this Location is for. Regional or Zonal. # Corresponds to the JSON property `type` # @return [String] attr_accessor :type @@ -2244,10 +2166,10 @@ module Google include Google::Apis::Core::Hashable # A hash identifying the version of this policy, so that updates to fields of - # the policy won't accidentally undo intermediate changes (and so that users - # of the API unaware of some fields won't accidentally remove other fields). - # Make a `get()` request to the cluster to get the current - # resource version and include it with requests to set the policy. + # the policy won't accidentally undo intermediate changes (and so that users of + # the API unaware of some fields won't accidentally remove other fields). Make a + # `get()` request to the cluster to get the current resource version and include + # it with requests to set the policy. # Corresponds to the JSON property `resourceVersion` # @return [String] attr_accessor :resource_version @@ -2277,8 +2199,8 @@ module Google # @return [Google::Apis::ContainerV1beta1::DailyMaintenanceWindow] attr_accessor :daily_maintenance_window - # Exceptions to maintenance window. Non-emergency maintenance should not - # occur in these windows. + # Exceptions to maintenance window. Non-emergency maintenance should not occur + # in these windows. # Corresponds to the JSON property `maintenanceExclusions` # @return [Hash] attr_accessor :maintenance_exclusions @@ -2314,8 +2236,7 @@ module Google end # The authentication information for accessing the master endpoint. - # Authentication can be done using HTTP basic auth or using client - # certificates. + # Authentication can be done using HTTP basic auth or using client certificates. class MasterAuth include Google::Apis::Core::Hashable @@ -2330,8 +2251,8 @@ module Google # @return [Google::Apis::ContainerV1beta1::ClientCertificateConfig] attr_accessor :client_certificate_config - # [Output only] Base64-encoded private key used by clients to authenticate - # to the cluster endpoint. + # [Output only] Base64-encoded private key used by clients to authenticate to + # the cluster endpoint. # Corresponds to the JSON property `clientKey` # @return [String] attr_accessor :client_key @@ -2343,15 +2264,15 @@ module Google # The password to use for HTTP basic authentication to the master endpoint. # Because the master endpoint is open to the Internet, you should create a - # strong password. If a password is provided for cluster creation, username - # must be non-empty. + # strong password. If a password is provided for cluster creation, username must + # be non-empty. # Corresponds to the JSON property `password` # @return [String] attr_accessor :password - # The username to use for HTTP basic authentication to the master endpoint. - # For clusters v1.6.0 and later, basic authentication can be disabled by - # leaving username unspecified (or setting it to the empty string). + # The username to use for HTTP basic authentication to the master endpoint. For + # clusters v1.6.0 and later, basic authentication can be disabled by leaving + # username unspecified (or setting it to the empty string). # Corresponds to the JSON property `username` # @return [String] attr_accessor :username @@ -2378,8 +2299,8 @@ module Google class MasterAuthorizedNetworksConfig include Google::Apis::Core::Hashable - # cidr_blocks define up to 10 external networks that could access - # Kubernetes master through HTTPS. + # cidr_blocks define up to 10 external networks that could access Kubernetes + # master through HTTPS. # Corresponds to the JSON property `cidrBlocks` # @return [Array] attr_accessor :cidr_blocks @@ -2461,31 +2382,35 @@ module Google class NetworkConfig include Google::Apis::Core::Hashable - # DefaultSnatStatus contains the desired state of whether default sNAT should - # be disabled on the cluster. + # The desired datapath provider for this cluster. By default, uses the IPTables- + # based kube-proxy implementation. + # Corresponds to the JSON property `datapathProvider` + # @return [String] + attr_accessor :datapath_provider + + # DefaultSnatStatus contains the desired state of whether default sNAT should be + # disabled on the cluster. # Corresponds to the JSON property `defaultSnatStatus` # @return [Google::Apis::ContainerV1beta1::DefaultSnatStatus] attr_accessor :default_snat_status - # Whether Intra-node visibility is enabled for this cluster. - # This makes same node pod to pod traffic visible for VPC network. + # Whether Intra-node visibility is enabled for this cluster. This makes same + # node pod to pod traffic visible for VPC network. # Corresponds to the JSON property `enableIntraNodeVisibility` # @return [Boolean] attr_accessor :enable_intra_node_visibility alias_method :enable_intra_node_visibility?, :enable_intra_node_visibility - # Output only. The relative name of the Google Compute Engine - # network(https://cloud.google.com/compute/docs/networks-and-firewalls#networks) - # to which the cluster is connected. Example: - # projects/my-project/global/networks/my-network + # Output only. The relative name of the Google Compute Engine network(https:// + # cloud.google.com/compute/docs/networks-and-firewalls#networks) to which the + # cluster is connected. Example: projects/my-project/global/networks/my-network # Corresponds to the JSON property `network` # @return [String] attr_accessor :network - # Output only. The relative name of the Google Compute Engine - # [subnetwork](https://cloud.google.com/compute/docs/vpc) to which the - # cluster is connected. Example: - # projects/my-project/regions/us-central1/subnetworks/my-subnet + # Output only. The relative name of the Google Compute Engine [subnetwork](https: + # //cloud.google.com/compute/docs/vpc) to which the cluster is connected. + # Example: projects/my-project/regions/us-central1/subnetworks/my-subnet # Corresponds to the JSON property `subnetwork` # @return [String] attr_accessor :subnetwork @@ -2496,6 +2421,7 @@ module Google # Update properties of this object def update!(**args) + @datapath_provider = args[:datapath_provider] if args.key?(:datapath_provider) @default_snat_status = args[:default_snat_status] if args.key?(:default_snat_status) @enable_intra_node_visibility = args[:enable_intra_node_visibility] if args.key?(:enable_intra_node_visibility) @network = args[:network] if args.key?(:network) @@ -2503,8 +2429,8 @@ module Google end end - # Configuration options for the NetworkPolicy feature. - # https://kubernetes.io/docs/concepts/services-networking/networkpolicies/ + # Configuration options for the NetworkPolicy feature. https://kubernetes.io/ + # docs/concepts/services-networking/networkpolicies/ class NetworkPolicy include Google::Apis::Core::Hashable @@ -2530,9 +2456,9 @@ module Google end end - # Configuration for NetworkPolicy. This only tracks whether the addon - # is enabled or not on the Master, it does not track whether network policy - # is enabled for the nodes. + # Configuration for NetworkPolicy. This only tracks whether the addon is enabled + # or not on the Master, it does not track whether network policy is enabled for + # the nodes. class NetworkPolicyConfig include Google::Apis::Core::Hashable @@ -2556,39 +2482,35 @@ module Google class NodeConfig include Google::Apis::Core::Hashable - # A list of hardware accelerators to be attached to each node. - # See https://cloud.google.com/compute/docs/gpus for more information about - # support for GPUs. + # A list of hardware accelerators to be attached to each node. See https://cloud. + # google.com/compute/docs/gpus for more information about support for GPUs. # Corresponds to the JSON property `accelerators` # @return [Array] attr_accessor :accelerators - # The Customer Managed Encryption Key used to encrypt the boot disk attached - # to each node in the node pool. This should be of the form - # projects/[KEY_PROJECT_ID]/locations/[LOCATION]/keyRings/[RING_NAME]/cryptoKeys/ - # [KEY_NAME]. - # For more information about protecting resources with Cloud KMS Keys please - # see: - # https://cloud.google.com/compute/docs/disks/customer-managed-encryption + # The Customer Managed Encryption Key used to encrypt the boot disk attached to + # each node in the node pool. This should be of the form projects/[ + # KEY_PROJECT_ID]/locations/[LOCATION]/keyRings/[RING_NAME]/cryptoKeys/[KEY_NAME] + # . For more information about protecting resources with Cloud KMS Keys please + # see: https://cloud.google.com/compute/docs/disks/customer-managed-encryption # Corresponds to the JSON property `bootDiskKmsKey` # @return [String] attr_accessor :boot_disk_kms_key - # Size of the disk attached to each node, specified in GB. - # The smallest allowed disk size is 10GB. - # If unspecified, the default disk size is 100GB. + # Size of the disk attached to each node, specified in GB. The smallest allowed + # disk size is 10GB. If unspecified, the default disk size is 100GB. # Corresponds to the JSON property `diskSizeGb` # @return [Fixnum] attr_accessor :disk_size_gb - # Type of the disk attached to each node (e.g. 'pd-standard' or 'pd-ssd') - # If unspecified, the default disk type is 'pd-standard' + # Type of the disk attached to each node (e.g. 'pd-standard' or 'pd-ssd') If + # unspecified, the default disk type is 'pd-standard' # Corresponds to the JSON property `diskType` # @return [String] attr_accessor :disk_type - # The image type to use for this node. Note that for a given image type, - # the latest version of it will be used. + # The image type to use for this node. Note that for a given image type, the + # latest version of it will be used. # Corresponds to the JSON property `imageType` # @return [String] attr_accessor :image_type @@ -2599,13 +2521,12 @@ module Google attr_accessor :kubelet_config # The map of Kubernetes labels (key/value pairs) to be applied to each node. - # These will added in addition to any default label(s) that - # Kubernetes may apply to the node. - # In case of conflict in label keys, the applied set may differ depending on - # the Kubernetes version -- it's best to assume the behavior is undefined - # and conflicts should be avoided. - # For more information, including usage and the valid values, see: - # https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/ + # These will added in addition to any default label(s) that Kubernetes may apply + # to the node. In case of conflict in label keys, the applied set may differ + # depending on the Kubernetes version -- it's best to assume the behavior is + # undefined and conflicts should be avoided. For more information, including + # usage and the valid values, see: https://kubernetes.io/docs/concepts/overview/ + # working-with-objects/labels/ # Corresponds to the JSON property `labels` # @return [Hash] attr_accessor :labels @@ -2615,105 +2536,80 @@ module Google # @return [Google::Apis::ContainerV1beta1::LinuxNodeConfig] attr_accessor :linux_node_config - # The number of local SSD disks to be attached to the node. - # The limit for this value is dependent upon the maximum number of - # disks available on a machine per zone. See: - # https://cloud.google.com/compute/docs/disks/local-ssd - # for more information. + # The number of local SSD disks to be attached to the node. The limit for this + # value is dependent upon the maximum number of disks available on a machine per + # zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more + # information. # Corresponds to the JSON property `localSsdCount` # @return [Fixnum] attr_accessor :local_ssd_count - # The name of a Google Compute Engine [machine - # type](https://cloud.google.com/compute/docs/machine-types) (e.g. - # `n1-standard-1`). - # If unspecified, the default machine type is - # `n1-standard-1`. + # The name of a Google Compute Engine [machine type](https://cloud.google.com/ + # compute/docs/machine-types). If unspecified, the default machine type is `e2- + # medium`. # Corresponds to the JSON property `machineType` # @return [String] attr_accessor :machine_type - # The metadata key/value pairs assigned to instances in the cluster. - # Keys must conform to the regexp `[a-zA-Z0-9-_]+` and be less than 128 bytes - # in length. These are reflected as part of a URL in the metadata server. - # Additionally, to avoid ambiguity, keys must not conflict with any other - # metadata keys for the project or be one of the reserved keys: - # - "cluster-location" - # - "cluster-name" - # - "cluster-uid" - # - "configure-sh" - # - "containerd-configure-sh" - # - "enable-oslogin" - # - "gci-ensure-gke-docker" - # - "gci-metrics-enabled" - # - "gci-update-strategy" - # - "instance-template" - # - "kube-env" - # - "startup-script" - # - "user-data" - # - "disable-address-manager" - # - "windows-startup-script-ps1" - # - "common-psm1" - # - "k8s-node-setup-psm1" - # - "install-ssh-psm1" - # - "user-profile-psm1" - # - "serial-port-logging-enable" - # Values are free-form strings, and only have meaning as interpreted by - # the image running in the instance. The only restriction placed on them is - # that each value's size must be less than or equal to 32 KB. - # The total size of all keys and values must be less than 512 KB. + # The metadata key/value pairs assigned to instances in the cluster. Keys must + # conform to the regexp `[a-zA-Z0-9-_]+` and be less than 128 bytes in length. + # These are reflected as part of a URL in the metadata server. Additionally, to + # avoid ambiguity, keys must not conflict with any other metadata keys for the + # project or be one of the reserved keys: - "cluster-location" - "cluster-name" - + # "cluster-uid" - "configure-sh" - "containerd-configure-sh" - "enable-oslogin" + # - "gci-ensure-gke-docker" - "gci-metrics-enabled" - "gci-update-strategy" - " + # instance-template" - "kube-env" - "startup-script" - "user-data" - "disable- + # address-manager" - "windows-startup-script-ps1" - "common-psm1" - "k8s-node- + # setup-psm1" - "install-ssh-psm1" - "user-profile-psm1" - "serial-port-logging- + # enable" Values are free-form strings, and only have meaning as interpreted by + # the image running in the instance. The only restriction placed on them is that + # each value's size must be less than or equal to 32 KB. The total size of all + # keys and values must be less than 512 KB. # Corresponds to the JSON property `metadata` # @return [Hash] attr_accessor :metadata # Minimum CPU platform to be used by this instance. The instance may be # scheduled on the specified or newer CPU platform. Applicable values are the - # friendly names of CPU platforms, such as - # `minCpuPlatform: "Intel Haswell"` or - # `minCpuPlatform: "Intel Sandy Bridge"`. For more - # information, read [how to specify min CPU - # platform](https://cloud.google.com/compute/docs/instances/specify-min-cpu- - # platform) + # friendly names of CPU platforms, such as `minCpuPlatform: "Intel Haswell"` or ` + # minCpuPlatform: "Intel Sandy Bridge"`. For more information, read [how to + # specify min CPU platform](https://cloud.google.com/compute/docs/instances/ + # specify-min-cpu-platform) # Corresponds to the JSON property `minCpuPlatform` # @return [String] attr_accessor :min_cpu_platform - # Setting this field will assign instances of this - # pool to run on the specified node group. This is useful for running - # workloads on [sole tenant - # nodes](https://cloud.google.com/compute/docs/nodes/sole-tenant-nodes). + # Setting this field will assign instances of this pool to run on the specified + # node group. This is useful for running workloads on [sole tenant nodes](https:/ + # /cloud.google.com/compute/docs/nodes/sole-tenant-nodes). # Corresponds to the JSON property `nodeGroup` # @return [String] attr_accessor :node_group - # The set of Google API scopes to be made available on all of the - # node VMs under the "default" service account. - # The following scopes are recommended, but not required, and by default are - # not included: - # * `https://www.googleapis.com/auth/compute` is required for mounting - # persistent storage on your nodes. - # * `https://www.googleapis.com/auth/devstorage.read_only` is required for - # communicating with **gcr.io** - # (the [Google Container - # Registry](https://cloud.google.com/container-registry/)). - # If unspecified, no scopes are added, unless Cloud Logging or Cloud - # Monitoring are enabled, in which case their required scopes will be added. + # The set of Google API scopes to be made available on all of the node VMs under + # the "default" service account. The following scopes are recommended, but not + # required, and by default are not included: * `https://www.googleapis.com/auth/ + # compute` is required for mounting persistent storage on your nodes. * `https:// + # www.googleapis.com/auth/devstorage.read_only` is required for communicating + # with **gcr.io** (the [Google Container Registry](https://cloud.google.com/ + # container-registry/)). If unspecified, no scopes are added, unless Cloud + # Logging or Cloud Monitoring are enabled, in which case their required scopes + # will be added. # Corresponds to the JSON property `oauthScopes` # @return [Array] attr_accessor :oauth_scopes - # Whether the nodes are created as preemptible VM instances. See: - # https://cloud.google.com/compute/docs/instances/preemptible for more - # inforamtion about preemptible VM instances. + # Whether the nodes are created as preemptible VM instances. See: https://cloud. + # google.com/compute/docs/instances/preemptible for more inforamtion about + # preemptible VM instances. # Corresponds to the JSON property `preemptible` # @return [Boolean] attr_accessor :preemptible alias_method :preemptible?, :preemptible # [ReservationAffinity](https://cloud.google.com/compute/docs/instances/ - # reserving-zonal-resources) - # is the configuration of desired reservation which instances could take - # capacity from. + # reserving-zonal-resources) is the configuration of desired reservation which + # instances could take capacity from. # Corresponds to the JSON property `reservationAffinity` # @return [Google::Apis::ContainerV1beta1::ReservationAffinity] attr_accessor :reservation_affinity @@ -2723,9 +2619,9 @@ module Google # @return [Google::Apis::ContainerV1beta1::SandboxConfig] attr_accessor :sandbox_config - # The Google Cloud Platform Service Account to be used by the node VMs. - # Specify the email address of the Service Account; otherwise, if no Service - # Account is specified, the "default" service account is used. + # The Google Cloud Platform Service Account to be used by the node VMs. Specify + # the email address of the Service Account; otherwise, if no Service Account is + # specified, the "default" service account is used. # Corresponds to the JSON property `serviceAccount` # @return [String] attr_accessor :service_account @@ -2736,16 +2632,16 @@ module Google attr_accessor :shielded_instance_config # The list of instance tags applied to all nodes. Tags are used to identify - # valid sources or targets for network firewalls and are specified by - # the client during cluster or node pool creation. Each tag within the list - # must comply with RFC1035. + # valid sources or targets for network firewalls and are specified by the client + # during cluster or node pool creation. Each tag within the list must comply + # with RFC1035. # Corresponds to the JSON property `tags` # @return [Array] attr_accessor :tags - # List of kubernetes taints to be applied to each node. - # For more information, including usage and the valid values, see: - # https://kubernetes.io/docs/concepts/configuration/taint-and-toleration/ + # List of kubernetes taints to be applied to each node. For more information, + # including usage and the valid values, see: https://kubernetes.io/docs/concepts/ + # configuration/taint-and-toleration/ # Corresponds to the JSON property `taints` # @return [Array] attr_accessor :taints @@ -2791,34 +2687,30 @@ module Google class NodeKubeletConfig include Google::Apis::Core::Hashable - # Enable CPU CFS quota enforcement for containers that specify CPU limits. - # If this option is enabled, kubelet uses CFS quota - # (https://www.kernel.org/doc/Documentation/scheduler/sched-bwc.txt) to - # enforce container CPU limits. Otherwise, CPU limits will not be enforced at - # all. - # Disable this option to mitigate CPU throttling problems while still having - # your pods to be in Guaranteed QoS class by specifying the CPU limits. - # The default value is 'true' if unspecified. + # Enable CPU CFS quota enforcement for containers that specify CPU limits. If + # this option is enabled, kubelet uses CFS quota (https://www.kernel.org/doc/ + # Documentation/scheduler/sched-bwc.txt) to enforce container CPU limits. + # Otherwise, CPU limits will not be enforced at all. Disable this option to + # mitigate CPU throttling problems while still having your pods to be in + # Guaranteed QoS class by specifying the CPU limits. The default value is 'true' + # if unspecified. # Corresponds to the JSON property `cpuCfsQuota` # @return [Boolean] attr_accessor :cpu_cfs_quota alias_method :cpu_cfs_quota?, :cpu_cfs_quota - # Set the CPU CFS quota period value 'cpu.cfs_period_us'. - # The string must be a sequence of decimal numbers, each with optional - # fraction and a unit suffix, such as "300ms". - # Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". - # The value must be a positive duration. + # Set the CPU CFS quota period value 'cpu.cfs_period_us'. The string must be a + # sequence of decimal numbers, each with optional fraction and a unit suffix, + # such as "300ms". Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h" + # . The value must be a positive duration. # Corresponds to the JSON property `cpuCfsQuotaPeriod` # @return [String] attr_accessor :cpu_cfs_quota_period - # Control the CPU management policy on the node. - # See - # https://kubernetes.io/docs/tasks/administer-cluster/cpu-management-policies/ - # The following values are allowed. - # - "none": the default, which represents the existing scheduling behavior. - # - "static": allows pods with certain resource characteristics to be + # Control the CPU management policy on the node. See https://kubernetes.io/docs/ + # tasks/administer-cluster/cpu-management-policies/ The following values are + # allowed. - "none": the default, which represents the existing scheduling + # behavior. - "static": allows pods with certain resource characteristics to be # granted increased CPU affinity and exclusivity on the node. # Corresponds to the JSON property `cpuManagerPolicy` # @return [String] @@ -2853,8 +2745,8 @@ module Google attr_accessor :auto_upgrade alias_method :auto_upgrade?, :auto_upgrade - # AutoUpgradeOptions defines the set of options for the user to control how - # the Auto Upgrades will proceed. + # AutoUpgradeOptions defines the set of options for the user to control how the + # Auto Upgrades will proceed. # Corresponds to the JSON property `upgradeOptions` # @return [Google::Apis::ContainerV1beta1::AutoUpgradeOptions] attr_accessor :upgrade_options @@ -2871,12 +2763,12 @@ module Google end end - # NodePool contains the name and configuration for a cluster's node pool. - # Node pools are a set of nodes (i.e. VM's), with a common configuration and - # specification, under the control of the cluster master. They may have a set - # of Kubernetes labels applied to them, which may be used to reference them - # during pod scheduling. They may also be resized up or down, to accommodate - # the workload. + # NodePool contains the name and configuration for a cluster's node pool. Node + # pools are a set of nodes (i.e. VM's), with a common configuration and + # specification, under the control of the cluster master. They may have a set of + # Kubernetes labels applied to them, which may be used to reference them during + # pod scheduling. They may also be resized up or down, to accommodate the + # workload. class NodePool include Google::Apis::Core::Hashable @@ -2896,25 +2788,23 @@ module Google # @return [Google::Apis::ContainerV1beta1::NodeConfig] attr_accessor :config - # The initial node count for the pool. You must ensure that your - # Compute Engine [resource quota](https://cloud.google.com/compute/quotas) - # is sufficient for this number of instances. You must also have available - # firewall and routes quota. + # The initial node count for the pool. You must ensure that your Compute Engine [ + # resource quota](https://cloud.google.com/compute/quotas) is sufficient for + # this number of instances. You must also have available firewall and routes + # quota. # Corresponds to the JSON property `initialNodeCount` # @return [Fixnum] attr_accessor :initial_node_count - # [Output only] The resource URLs of the [managed instance - # groups](https://cloud.google.com/compute/docs/instance-groups/creating-groups- - # of-managed-instances) + # [Output only] The resource URLs of the [managed instance groups](https://cloud. + # google.com/compute/docs/instance-groups/creating-groups-of-managed-instances) # associated with this node pool. # Corresponds to the JSON property `instanceGroupUrls` # @return [Array] attr_accessor :instance_group_urls - # The list of Google Compute Engine - # [zones](https://cloud.google.com/compute/docs/zones#available) in which the - # NodePool's nodes should be located. + # The list of Google Compute Engine [zones](https://cloud.google.com/compute/ + # docs/zones#available) in which the NodePool's nodes should be located. # Corresponds to the JSON property `locations` # @return [Array] attr_accessor :locations @@ -2950,30 +2840,26 @@ module Google # @return [String] attr_accessor :status - # [Output only] Additional information about the current status of this - # node pool instance, if available. + # [Output only] Additional information about the current status of this node + # pool instance, if available. # Corresponds to the JSON property `statusMessage` # @return [String] attr_accessor :status_message # These upgrade settings control the level of parallelism and the level of - # disruption caused by an upgrade. - # maxUnavailable controls the number of nodes that can be simultaneously - # unavailable. - # maxSurge controls the number of additional nodes that can be added to the - # node pool temporarily for the time of the upgrade to increase the number of - # available nodes. - # (maxUnavailable + maxSurge) determines the level of parallelism (how many - # nodes are being upgraded at the same time). - # Note: upgrades inevitably introduce some disruption since workloads need to - # be moved from old nodes to new, upgraded ones. Even if maxUnavailable=0, - # this holds true. (Disruption stays within the limits of - # PodDisruptionBudget, if it is configured.) - # Consider a hypothetical node pool with 5 nodes having maxSurge=2, - # maxUnavailable=1. This means the upgrade process upgrades 3 nodes - # simultaneously. It creates 2 additional (upgraded) nodes, then it brings - # down 3 old (not yet upgraded) nodes at the same time. This ensures that - # there are always at least 4 nodes available. + # disruption caused by an upgrade. maxUnavailable controls the number of nodes + # that can be simultaneously unavailable. maxSurge controls the number of + # additional nodes that can be added to the node pool temporarily for the time + # of the upgrade to increase the number of available nodes. (maxUnavailable + + # maxSurge) determines the level of parallelism (how many nodes are being + # upgraded at the same time). Note: upgrades inevitably introduce some + # disruption since workloads need to be moved from old nodes to new, upgraded + # ones. Even if maxUnavailable=0, this holds true. (Disruption stays within the + # limits of PodDisruptionBudget, if it is configured.) Consider a hypothetical + # node pool with 5 nodes having maxSurge=2, maxUnavailable=1. This means the + # upgrade process upgrades 3 nodes simultaneously. It creates 2 additional ( + # upgraded) nodes, then it brings down 3 old (not yet upgraded) nodes at the + # same time. This ensures that there are always at least 4 nodes available. # Corresponds to the JSON property `upgradeSettings` # @return [Google::Apis::ContainerV1beta1::UpgradeSettings] attr_accessor :upgrade_settings @@ -3024,14 +2910,13 @@ module Google attr_accessor :enabled alias_method :enabled?, :enabled - # Maximum number of nodes in the NodePool. Must be >= min_node_count. There - # has to enough quota to scale up the cluster. + # Maximum number of nodes in the NodePool. Must be >= min_node_count. There has + # to enough quota to scale up the cluster. # Corresponds to the JSON property `maxNodeCount` # @return [Fixnum] attr_accessor :max_node_count - # Minimum number of nodes in the NodePool. Must be >= 1 and <= - # max_node_count. + # Minimum number of nodes in the NodePool. Must be >= 1 and <= max_node_count. # Corresponds to the JSON property `minNodeCount` # @return [Fixnum] attr_accessor :min_node_count @@ -3050,8 +2935,7 @@ module Google end # Kubernetes taint is comprised of three fields: key, value, and effect. Effect - # can only be one of three types: NoSchedule, PreferNoSchedule or NoExecute. - # See + # can only be one of three types: NoSchedule, PreferNoSchedule or NoExecute. See # [here](https://kubernetes.io/docs/concepts/configuration/taint-and-toleration) # for more information, including usage and the valid values. class NodeTaint @@ -3084,12 +2968,32 @@ module Google end end + # NotificationConfig is the configuration of notifications. + class NotificationConfig + include Google::Apis::Core::Hashable + + # Pub/Sub specific notification config. + # Corresponds to the JSON property `pubsub` + # @return [Google::Apis::ContainerV1beta1::PubSub] + attr_accessor :pubsub + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @pubsub = args[:pubsub] if args.key?(:pubsub) + end + end + # This operation resource represents operations that may have happened or are # happening on the cluster. All fields are output only. class Operation include Google::Apis::Core::Hashable - # Which conditions caused the current cluster state. + # Which conditions caused the current cluster state. Deprecated. Use field error + # instead. # Corresponds to the JSON property `clusterConditions` # @return [Array] attr_accessor :cluster_conditions @@ -3099,18 +3003,25 @@ module Google # @return [String] attr_accessor :detail - # [Output only] The time the operation completed, in - # [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + # [Output only] The time the operation completed, in [RFC3339](https://www.ietf. + # org/rfc/rfc3339.txt) text format. # Corresponds to the JSON property `endTime` # @return [String] attr_accessor :end_time - # [Output only] The name of the Google Compute Engine - # [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones# - # available) - # or - # [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones# - # available) + # 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::ContainerV1beta1::Status] + attr_accessor :error + + # [Output only] The name of the Google Compute Engine [zone](https://cloud. + # google.com/compute/docs/regions-zones/regions-zones#available) or [region]( + # https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) # in which the cluster resides. # Corresponds to the JSON property `location` # @return [String] @@ -3121,7 +3032,8 @@ module Google # @return [String] attr_accessor :name - # Which conditions caused the current node pool state. + # Which conditions caused the current node pool state. Deprecated. Use field + # error instead. # Corresponds to the JSON property `nodepoolConditions` # @return [Array] attr_accessor :nodepool_conditions @@ -3141,8 +3053,8 @@ module Google # @return [String] attr_accessor :self_link - # [Output only] The time the operation started, in - # [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + # [Output only] The time the operation started, in [RFC3339](https://www.ietf. + # org/rfc/rfc3339.txt) text format. # Corresponds to the JSON property `startTime` # @return [String] attr_accessor :start_time @@ -3153,6 +3065,7 @@ module Google attr_accessor :status # Output only. If an error has occurred, a textual description of the error. + # Deprecated. Use field error instead. # Corresponds to the JSON property `statusMessage` # @return [String] attr_accessor :status_message @@ -3162,9 +3075,9 @@ module Google # @return [String] attr_accessor :target_link - # The name of the Google Compute Engine - # [zone](https://cloud.google.com/compute/docs/zones#available) in which the - # operation is taking place. This field is deprecated, use location instead. + # The name of the Google Compute Engine [zone](https://cloud.google.com/compute/ + # docs/zones#available) in which the operation is taking place. This field is + # deprecated, use location instead. # Corresponds to the JSON property `zone` # @return [String] attr_accessor :zone @@ -3178,6 +3091,7 @@ module Google @cluster_conditions = args[:cluster_conditions] if args.key?(:cluster_conditions) @detail = args[:detail] if args.key?(:detail) @end_time = args[:end_time] if args.key?(:end_time) + @error = args[:error] if args.key?(:error) @location = args[:location] if args.key?(:location) @name = args[:name] if args.key?(:name) @nodepool_conditions = args[:nodepool_conditions] if args.key?(:nodepool_conditions) @@ -3196,18 +3110,15 @@ module Google class OperationProgress include Google::Apis::Core::Hashable - # Progress metric bundle, for example: - # metrics: [`name: "nodes done", int_value: 15`, - # `name: "nodes total", int_value: 32`] - # or - # metrics: [`name: "progress", double_value: 0.56`, - # `name: "progress scale", double_value: 1.0`] + # Progress metric bundle, for example: metrics: [`name: "nodes done", int_value: + # 15`, `name: "nodes total", int_value: 32`] or metrics: [`name: "progress", + # double_value: 0.56`, `name: "progress scale", double_value: 1.0`] # Corresponds to the JSON property `metrics` # @return [Array] attr_accessor :metrics - # A non-parameterized string describing an operation stage. - # Unset for single-stage operations. + # A non-parameterized string describing an operation stage. Unset for single- + # stage operations. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name @@ -3217,8 +3128,7 @@ module Google # @return [Array] attr_accessor :stages - # Status of an operation stage. - # Unset for single-stage operations. + # Status of an operation stage. Unset for single-stage operations. # Corresponds to the JSON property `status` # @return [String] attr_accessor :status @@ -3267,9 +3177,9 @@ module Google attr_accessor :enable_private_endpoint alias_method :enable_private_endpoint?, :enable_private_endpoint - # Whether nodes have internal IP addresses only. If enabled, all nodes are - # given only RFC 1918 private addresses and communicate with the master via - # private networking. + # Whether nodes have internal IP addresses only. If enabled, all nodes are given + # only RFC 1918 private addresses and communicate with the master via private + # networking. # Corresponds to the JSON property `enablePrivateNodes` # @return [Boolean] attr_accessor :enable_private_nodes @@ -3280,10 +3190,10 @@ module Google # @return [Google::Apis::ContainerV1beta1::PrivateClusterMasterGlobalAccessConfig] attr_accessor :master_global_access_config - # The IP range in CIDR notation to use for the hosted master network. This - # range will be used for assigning internal IP addresses to the master or - # set of masters, as well as the ILB VIP. This range must not overlap with - # any other ranges in use within the cluster's network. + # The IP range in CIDR notation to use for the hosted master network. This range + # will be used for assigning internal IP addresses to the master or set of + # masters, as well as the ILB VIP. This range must not overlap with any other + # ranges in use within the cluster's network. # Corresponds to the JSON property `masterIpv4CidrBlock` # @return [String] attr_accessor :master_ipv4_cidr_block @@ -3339,36 +3249,52 @@ module Google end end + # Pub/Sub specific notification config. + class PubSub + include Google::Apis::Core::Hashable + + # Enable notifications for Pub/Sub. + # Corresponds to the JSON property `enabled` + # @return [Boolean] + attr_accessor :enabled + alias_method :enabled?, :enabled + + # The desired Pub/Sub topic to which notifications will be sent by GKE. Format + # is `projects/`project`/topics/`topic``. + # Corresponds to the JSON property `topic` + # @return [String] + attr_accessor :topic + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @enabled = args[:enabled] if args.key?(:enabled) + @topic = args[:topic] if args.key?(:topic) + end + end + # Represents an arbitrary window of time that recurs. class RecurringTimeWindow include Google::Apis::Core::Hashable - # An RRULE (https://tools.ietf.org/html/rfc5545#section-3.8.5.3) for how - # this window reccurs. They go on for the span of time between the start and - # end time. - # For example, to have something repeat every weekday, you'd use: - # `FREQ=WEEKLY;BYDAY=MO,TU,WE,TH,FR` - # To repeat some window daily (equivalent to the DailyMaintenanceWindow): - # `FREQ=DAILY` - # For the first weekend of every month: - # `FREQ=MONTHLY;BYSETPOS=1;BYDAY=SA,SU` - # This specifies how frequently the window starts. Eg, if you wanted to have - # a 9-5 UTC-4 window every weekday, you'd use something like: - # ``` - # start time = 2019-01-01T09:00:00-0400 - # end time = 2019-01-01T17:00:00-0400 - # recurrence = FREQ=WEEKLY;BYDAY=MO,TU,WE,TH,FR - # ``` - # Windows can span multiple days. Eg, to make the window encompass every - # weekend from midnight Saturday till the last minute of Sunday UTC: - # ``` - # start time = 2019-01-05T00:00:00Z - # end time = 2019-01-07T23:59:00Z - # recurrence = FREQ=WEEKLY;BYDAY=SA - # ``` - # Note the start and end time's specific dates are largely arbitrary except - # to specify duration of the window and when it first starts. - # The FREQ values of HOURLY, MINUTELY, and SECONDLY are not supported. + # An RRULE (https://tools.ietf.org/html/rfc5545#section-3.8.5.3) for how this + # window reccurs. They go on for the span of time between the start and end time. + # For example, to have something repeat every weekday, you'd use: `FREQ=WEEKLY; + # BYDAY=MO,TU,WE,TH,FR` To repeat some window daily (equivalent to the + # DailyMaintenanceWindow): `FREQ=DAILY` For the first weekend of every month: ` + # FREQ=MONTHLY;BYSETPOS=1;BYDAY=SA,SU` This specifies how frequently the window + # starts. Eg, if you wanted to have a 9-5 UTC-4 window every weekday, you'd use + # something like: ``` start time = 2019-01-01T09:00:00-0400 end time = 2019-01- + # 01T17:00:00-0400 recurrence = FREQ=WEEKLY;BYDAY=MO,TU,WE,TH,FR ``` Windows can + # span multiple days. Eg, to make the window encompass every weekend from + # midnight Saturday till the last minute of Sunday UTC: ``` start time = 2019-01- + # 05T00:00:00Z end time = 2019-01-07T23:59:00Z recurrence = FREQ=WEEKLY;BYDAY=SA + # ``` Note the start and end time's specific dates are largely arbitrary except + # to specify duration of the window and when it first starts. The FREQ values of + # HOURLY, MINUTELY, and SECONDLY are not supported. # Corresponds to the JSON property `recurrence` # @return [String] attr_accessor :recurrence @@ -3389,11 +3315,10 @@ module Google end end - # ReleaseChannel indicates which release channel a cluster is - # subscribed to. Release channels are arranged in order of risk. - # When a cluster is subscribed to a release channel, Google maintains - # both the master version and the node version. Node auto-upgrade - # defaults to true and cannot be disabled. + # ReleaseChannel indicates which release channel a cluster is subscribed to. + # Release channels are arranged in order of risk. When a cluster is subscribed + # to a release channel, Google maintains both the master version and the node + # version. Node auto-upgrade defaults to true and cannot be disabled. class ReleaseChannel include Google::Apis::Core::Hashable @@ -3416,9 +3341,8 @@ module Google class ReleaseChannelConfig include Google::Apis::Core::Hashable - # Deprecated. - # This field has been deprecated and replaced with the valid_versions - # field. + # Deprecated. This field has been deprecated and replaced with the + # valid_versions field. # Corresponds to the JSON property `availableVersions` # @return [Array] attr_accessor :available_versions @@ -3452,9 +3376,8 @@ module Google end # [ReservationAffinity](https://cloud.google.com/compute/docs/instances/ - # reserving-zonal-resources) - # is the configuration of desired reservation which instances could take - # capacity from. + # reserving-zonal-resources) is the configuration of desired reservation which + # instances could take capacity from. class ReservationAffinity include Google::Apis::Core::Hashable @@ -3464,8 +3387,8 @@ module Google attr_accessor :consume_reservation_type # Corresponds to the label key of a reservation resource. To target a - # SPECIFIC_RESERVATION by name, specify "googleapis.com/reservation-name" as - # the key and specify the name of your reservation as its value. + # SPECIFIC_RESERVATION by name, specify "googleapis.com/reservation-name" as the + # key and specify the name of your reservation as its value. # Corresponds to the JSON property `key` # @return [String] attr_accessor :key @@ -3487,8 +3410,8 @@ module Google end end - # Contains information about amount of some resource in the cluster. - # For memory, value should be in GB. + # Contains information about amount of some resource in the cluster. For memory, + # value should be in GB. class ResourceLimit include Google::Apis::Core::Hashable @@ -3558,36 +3481,35 @@ module Google class RollbackNodePoolUpgradeRequest include Google::Apis::Core::Hashable - # Required. Deprecated. The name of the cluster to rollback. - # This field has been deprecated and replaced by the name field. + # Required. Deprecated. The name of the cluster to rollback. This field has been + # deprecated and replaced by the name field. # Corresponds to the JSON property `clusterId` # @return [String] attr_accessor :cluster_id # The name (project, location, cluster, node pool id) of the node poll to - # rollback upgrade. - # Specified in the format `projects/*/locations/*/clusters/*/nodePools/*`. + # rollback upgrade. Specified in the format `projects/*/locations/*/clusters/*/ + # nodePools/*`. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name - # Required. Deprecated. The name of the node pool to rollback. - # This field has been deprecated and replaced by the name field. + # Required. Deprecated. The name of the node pool to rollback. This field has + # been deprecated and replaced by the name field. # Corresponds to the JSON property `nodePoolId` # @return [String] attr_accessor :node_pool_id # Required. Deprecated. The Google Developers Console [project ID or project - # number](https://support.google.com/cloud/answer/6158840). - # This field has been deprecated and replaced by the name field. + # number](https://support.google.com/cloud/answer/6158840). This field has been + # deprecated and replaced by the name field. # Corresponds to the JSON property `projectId` # @return [String] attr_accessor :project_id - # Required. Deprecated. The name of the Google Compute Engine - # [zone](https://cloud.google.com/compute/docs/zones#available) in which the - # cluster resides. This field has been deprecated and replaced by the name - # field. + # Required. Deprecated. The name of the Google Compute Engine [zone](https:// + # cloud.google.com/compute/docs/zones#available) in which the cluster resides. + # This field has been deprecated and replaced by the name field. # Corresponds to the JSON property `zone` # @return [String] attr_accessor :zone @@ -3684,35 +3606,34 @@ module Google class SetAddonsConfigRequest include Google::Apis::Core::Hashable - # Configuration for the addons that can be automatically spun up in the - # cluster, enabling additional functionality. + # Configuration for the addons that can be automatically spun up in the cluster, + # enabling additional functionality. # Corresponds to the JSON property `addonsConfig` # @return [Google::Apis::ContainerV1beta1::AddonsConfig] attr_accessor :addons_config - # Required. Deprecated. The name of the cluster to upgrade. - # This field has been deprecated and replaced by the name field. + # Required. Deprecated. The name of the cluster to upgrade. This field has been + # deprecated and replaced by the name field. # Corresponds to the JSON property `clusterId` # @return [String] attr_accessor :cluster_id - # The name (project, location, cluster) of the cluster to set addons. - # Specified in the format `projects/*/locations/*/clusters/*`. + # The name (project, location, cluster) of the cluster to set addons. Specified + # in the format `projects/*/locations/*/clusters/*`. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # Required. Deprecated. The Google Developers Console [project ID or project - # number](https://support.google.com/cloud/answer/6158840). - # This field has been deprecated and replaced by the name field. + # number](https://support.google.com/cloud/answer/6158840). This field has been + # deprecated and replaced by the name field. # Corresponds to the JSON property `projectId` # @return [String] attr_accessor :project_id - # Required. Deprecated. The name of the Google Compute Engine - # [zone](https://cloud.google.com/compute/docs/zones#available) in which the - # cluster resides. This field has been deprecated and replaced by the name - # field. + # Required. Deprecated. The name of the Google Compute Engine [zone](https:// + # cloud.google.com/compute/docs/zones#available) in which the cluster resides. + # This field has been deprecated and replaced by the name field. # Corresponds to the JSON property `zone` # @return [String] attr_accessor :zone @@ -3737,18 +3658,17 @@ module Google class SetLabelsRequest include Google::Apis::Core::Hashable - # Required. Deprecated. The name of the cluster. - # This field has been deprecated and replaced by the name field. + # Required. Deprecated. The name of the cluster. This field has been deprecated + # and replaced by the name field. # Corresponds to the JSON property `clusterId` # @return [String] attr_accessor :cluster_id # Required. The fingerprint of the previous set of labels for this resource, - # used to detect conflicts. The fingerprint is initially generated by - # Kubernetes Engine and changes after every request to modify or update - # labels. You must always provide an up-to-date fingerprint hash when - # updating or changing labels. Make a `get()` request to the - # resource to get the latest fingerprint. + # used to detect conflicts. The fingerprint is initially generated by Kubernetes + # Engine and changes after every request to modify or update labels. You must + # always provide an up-to-date fingerprint hash when updating or changing labels. + # Make a `get()` request to the resource to get the latest fingerprint. # Corresponds to the JSON property `labelFingerprint` # @return [String] attr_accessor :label_fingerprint @@ -3760,8 +3680,8 @@ module Google attr_accessor :name # Required. Deprecated. The Google Developers Console [project ID or project - # number](https://developers.google.com/console/help/new/#projectnumber). - # This field has been deprecated and replaced by the name field. + # number](https://developers.google.com/console/help/new/#projectnumber). This + # field has been deprecated and replaced by the name field. # Corresponds to the JSON property `projectId` # @return [String] attr_accessor :project_id @@ -3771,10 +3691,9 @@ module Google # @return [Hash] attr_accessor :resource_labels - # Required. Deprecated. The name of the Google Compute Engine - # [zone](https://cloud.google.com/compute/docs/zones#available) in which the - # cluster resides. This field has been deprecated and replaced by the name - # field. + # Required. Deprecated. The name of the Google Compute Engine [zone](https:// + # cloud.google.com/compute/docs/zones#available) in which the cluster resides. + # This field has been deprecated and replaced by the name field. # Corresponds to the JSON property `zone` # @return [String] attr_accessor :zone @@ -3799,8 +3718,8 @@ module Google class SetLegacyAbacRequest include Google::Apis::Core::Hashable - # Required. Deprecated. The name of the cluster to update. - # This field has been deprecated and replaced by the name field. + # Required. Deprecated. The name of the cluster to update. This field has been + # deprecated and replaced by the name field. # Corresponds to the JSON property `clusterId` # @return [String] attr_accessor :cluster_id @@ -3818,16 +3737,15 @@ module Google attr_accessor :name # Required. Deprecated. The Google Developers Console [project ID or project - # number](https://support.google.com/cloud/answer/6158840). - # This field has been deprecated and replaced by the name field. + # number](https://support.google.com/cloud/answer/6158840). This field has been + # deprecated and replaced by the name field. # Corresponds to the JSON property `projectId` # @return [String] attr_accessor :project_id - # Required. Deprecated. The name of the Google Compute Engine - # [zone](https://cloud.google.com/compute/docs/zones#available) in which the - # cluster resides. This field has been deprecated and replaced by the name - # field. + # Required. Deprecated. The name of the Google Compute Engine [zone](https:// + # cloud.google.com/compute/docs/zones#available) in which the cluster resides. + # This field has been deprecated and replaced by the name field. # Corresponds to the JSON property `zone` # @return [String] attr_accessor :zone @@ -3850,18 +3768,18 @@ module Google class SetLocationsRequest include Google::Apis::Core::Hashable - # Required. Deprecated. The name of the cluster to upgrade. - # This field has been deprecated and replaced by the name field. + # Required. Deprecated. The name of the cluster to upgrade. This field has been + # deprecated and replaced by the name field. # Corresponds to the JSON property `clusterId` # @return [String] attr_accessor :cluster_id - # Required. The desired list of Google Compute Engine - # [zones](https://cloud.google.com/compute/docs/zones#available) in which the - # cluster's nodes should be located. Changing the locations a cluster is in - # will result in nodes being either created or removed from the cluster, - # depending on whether locations are being added or removed. - # This list must always include the cluster's primary zone. + # Required. The desired list of Google Compute Engine [zones](https://cloud. + # google.com/compute/docs/zones#available) in which the cluster's nodes should + # be located. Changing the locations a cluster is in will result in nodes being + # either created or removed from the cluster, depending on whether locations are + # being added or removed. This list must always include the cluster's primary + # zone. # Corresponds to the JSON property `locations` # @return [Array] attr_accessor :locations @@ -3873,16 +3791,15 @@ module Google attr_accessor :name # Required. Deprecated. The Google Developers Console [project ID or project - # number](https://support.google.com/cloud/answer/6158840). - # This field has been deprecated and replaced by the name field. + # number](https://support.google.com/cloud/answer/6158840). This field has been + # deprecated and replaced by the name field. # Corresponds to the JSON property `projectId` # @return [String] attr_accessor :project_id - # Required. Deprecated. The name of the Google Compute Engine - # [zone](https://cloud.google.com/compute/docs/zones#available) in which the - # cluster resides. This field has been deprecated and replaced by the name - # field. + # Required. Deprecated. The name of the Google Compute Engine [zone](https:// + # cloud.google.com/compute/docs/zones#available) in which the cluster resides. + # This field has been deprecated and replaced by the name field. # Corresponds to the JSON property `zone` # @return [String] attr_accessor :zone @@ -3905,42 +3822,39 @@ module Google class SetLoggingServiceRequest include Google::Apis::Core::Hashable - # Required. Deprecated. The name of the cluster to upgrade. - # This field has been deprecated and replaced by the name field. + # Required. Deprecated. The name of the cluster to upgrade. This field has been + # deprecated and replaced by the name field. # Corresponds to the JSON property `clusterId` # @return [String] attr_accessor :cluster_id - # Required. The logging service the cluster should use to write logs. - # Currently available options: - # * `logging.googleapis.com/kubernetes` - The Cloud Logging - # service with a Kubernetes-native resource model - # * `logging.googleapis.com` - The legacy Cloud Logging service (no longer - # available as of GKE 1.15). - # * `none` - no logs will be exported from the cluster. - # If left as an empty string,`logging.googleapis.com/kubernetes` will be - # used for GKE 1.14+ or `logging.googleapis.com` for earlier versions. + # Required. The logging service the cluster should use to write logs. Currently + # available options: * `logging.googleapis.com/kubernetes` - The Cloud Logging + # service with a Kubernetes-native resource model * `logging.googleapis.com` - + # The legacy Cloud Logging service (no longer available as of GKE 1.15). * `none` + # - no logs will be exported from the cluster. If left as an empty string,` + # logging.googleapis.com/kubernetes` will be used for GKE 1.14+ or `logging. + # googleapis.com` for earlier versions. # Corresponds to the JSON property `loggingService` # @return [String] attr_accessor :logging_service - # The name (project, location, cluster) of the cluster to set logging. - # Specified in the format `projects/*/locations/*/clusters/*`. + # The name (project, location, cluster) of the cluster to set logging. Specified + # in the format `projects/*/locations/*/clusters/*`. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # Required. Deprecated. The Google Developers Console [project ID or project - # number](https://support.google.com/cloud/answer/6158840). - # This field has been deprecated and replaced by the name field. + # number](https://support.google.com/cloud/answer/6158840). This field has been + # deprecated and replaced by the name field. # Corresponds to the JSON property `projectId` # @return [String] attr_accessor :project_id - # Required. Deprecated. The name of the Google Compute Engine - # [zone](https://cloud.google.com/compute/docs/zones#available) in which the - # cluster resides. This field has been deprecated and replaced by the name - # field. + # Required. Deprecated. The name of the Google Compute Engine [zone](https:// + # cloud.google.com/compute/docs/zones#available) in which the cluster resides. + # This field has been deprecated and replaced by the name field. # Corresponds to the JSON property `zone` # @return [String] attr_accessor :zone @@ -3974,21 +3888,19 @@ module Google attr_accessor :maintenance_policy # The name (project, location, cluster id) of the cluster to set maintenance - # policy. - # Specified in the format `projects/*/locations/*/clusters/*`. + # policy. Specified in the format `projects/*/locations/*/clusters/*`. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name - # Required. The Google Developers Console [project ID or project - # number](https://support.google.com/cloud/answer/6158840). + # Required. The Google Developers Console [project ID or project number](https:// + # support.google.com/cloud/answer/6158840). # Corresponds to the JSON property `projectId` # @return [String] attr_accessor :project_id - # Required. The name of the Google Compute Engine - # [zone](https://cloud.google.com/compute/docs/zones#available) in which the - # cluster resides. + # Required. The name of the Google Compute Engine [zone](https://cloud.google. + # com/compute/docs/zones#available) in which the cluster resides. # Corresponds to the JSON property `zone` # @return [String] attr_accessor :zone @@ -4016,36 +3928,34 @@ module Google # @return [String] attr_accessor :action - # Required. Deprecated. The name of the cluster to upgrade. - # This field has been deprecated and replaced by the name field. + # Required. Deprecated. The name of the cluster to upgrade. This field has been + # deprecated and replaced by the name field. # Corresponds to the JSON property `clusterId` # @return [String] attr_accessor :cluster_id - # The name (project, location, cluster) of the cluster to set auth. - # Specified in the format `projects/*/locations/*/clusters/*`. + # The name (project, location, cluster) of the cluster to set auth. Specified in + # the format `projects/*/locations/*/clusters/*`. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # Required. Deprecated. The Google Developers Console [project ID or project - # number](https://support.google.com/cloud/answer/6158840). - # This field has been deprecated and replaced by the name field. + # number](https://support.google.com/cloud/answer/6158840). This field has been + # deprecated and replaced by the name field. # Corresponds to the JSON property `projectId` # @return [String] attr_accessor :project_id # The authentication information for accessing the master endpoint. - # Authentication can be done using HTTP basic auth or using client - # certificates. + # Authentication can be done using HTTP basic auth or using client certificates. # Corresponds to the JSON property `update` # @return [Google::Apis::ContainerV1beta1::MasterAuth] attr_accessor :update - # Required. Deprecated. The name of the Google Compute Engine - # [zone](https://cloud.google.com/compute/docs/zones#available) in which the - # cluster resides. This field has been deprecated and replaced by the name - # field. + # Required. Deprecated. The name of the Google Compute Engine [zone](https:// + # cloud.google.com/compute/docs/zones#available) in which the cluster resides. + # This field has been deprecated and replaced by the name field. # Corresponds to the JSON property `zone` # @return [String] attr_accessor :zone @@ -4069,21 +3979,19 @@ module Google class SetMonitoringServiceRequest include Google::Apis::Core::Hashable - # Required. Deprecated. The name of the cluster to upgrade. - # This field has been deprecated and replaced by the name field. + # Required. Deprecated. The name of the cluster to upgrade. This field has been + # deprecated and replaced by the name field. # Corresponds to the JSON property `clusterId` # @return [String] attr_accessor :cluster_id # Required. The monitoring service the cluster should use to write metrics. - # Currently available options: - # * "monitoring.googleapis.com/kubernetes" - The Cloud Monitoring - # service with a Kubernetes-native resource model - # * `monitoring.googleapis.com` - The legacy Cloud Monitoring service (no - # longer available as of GKE 1.15). - # * `none` - No metrics will be exported from the cluster. - # If left as an empty string,`monitoring.googleapis.com/kubernetes` will be - # used for GKE 1.14+ or `monitoring.googleapis.com` for earlier versions. + # Currently available options: * "monitoring.googleapis.com/kubernetes" - The + # Cloud Monitoring service with a Kubernetes-native resource model * `monitoring. + # googleapis.com` - The legacy Cloud Monitoring service (no longer available as + # of GKE 1.15). * `none` - No metrics will be exported from the cluster. If left + # as an empty string,`monitoring.googleapis.com/kubernetes` will be used for GKE + # 1.14+ or `monitoring.googleapis.com` for earlier versions. # Corresponds to the JSON property `monitoringService` # @return [String] attr_accessor :monitoring_service @@ -4095,16 +4003,15 @@ module Google attr_accessor :name # Required. Deprecated. The Google Developers Console [project ID or project - # number](https://support.google.com/cloud/answer/6158840). - # This field has been deprecated and replaced by the name field. + # number](https://support.google.com/cloud/answer/6158840). This field has been + # deprecated and replaced by the name field. # Corresponds to the JSON property `projectId` # @return [String] attr_accessor :project_id - # Required. Deprecated. The name of the Google Compute Engine - # [zone](https://cloud.google.com/compute/docs/zones#available) in which the - # cluster resides. This field has been deprecated and replaced by the name - # field. + # Required. Deprecated. The name of the Google Compute Engine [zone](https:// + # cloud.google.com/compute/docs/zones#available) in which the cluster resides. + # This field has been deprecated and replaced by the name field. # Corresponds to the JSON property `zone` # @return [String] attr_accessor :zone @@ -4127,8 +4034,8 @@ module Google class SetNetworkPolicyRequest include Google::Apis::Core::Hashable - # Required. Deprecated. The name of the cluster. - # This field has been deprecated and replaced by the name field. + # Required. Deprecated. The name of the cluster. This field has been deprecated + # and replaced by the name field. # Corresponds to the JSON property `clusterId` # @return [String] attr_accessor :cluster_id @@ -4139,23 +4046,22 @@ module Google # @return [String] attr_accessor :name - # Configuration options for the NetworkPolicy feature. - # https://kubernetes.io/docs/concepts/services-networking/networkpolicies/ + # Configuration options for the NetworkPolicy feature. https://kubernetes.io/ + # docs/concepts/services-networking/networkpolicies/ # Corresponds to the JSON property `networkPolicy` # @return [Google::Apis::ContainerV1beta1::NetworkPolicy] attr_accessor :network_policy # Required. Deprecated. The Google Developers Console [project ID or project - # number](https://developers.google.com/console/help/new/#projectnumber). - # This field has been deprecated and replaced by the name field. + # number](https://developers.google.com/console/help/new/#projectnumber). This + # field has been deprecated and replaced by the name field. # Corresponds to the JSON property `projectId` # @return [String] attr_accessor :project_id - # Required. Deprecated. The name of the Google Compute Engine - # [zone](https://cloud.google.com/compute/docs/zones#available) in which the - # cluster resides. This field has been deprecated and replaced by the name - # field. + # Required. Deprecated. The name of the Google Compute Engine [zone](https:// + # cloud.google.com/compute/docs/zones#available) in which the cluster resides. + # This field has been deprecated and replaced by the name field. # Corresponds to the JSON property `zone` # @return [String] attr_accessor :zone @@ -4184,36 +4090,35 @@ module Google # @return [Google::Apis::ContainerV1beta1::NodePoolAutoscaling] attr_accessor :autoscaling - # Required. Deprecated. The name of the cluster to upgrade. - # This field has been deprecated and replaced by the name field. + # Required. Deprecated. The name of the cluster to upgrade. This field has been + # deprecated and replaced by the name field. # Corresponds to the JSON property `clusterId` # @return [String] attr_accessor :cluster_id # The name (project, location, cluster, node pool) of the node pool to set - # autoscaler settings. Specified in the format - # `projects/*/locations/*/clusters/*/nodePools/*`. + # autoscaler settings. Specified in the format `projects/*/locations/*/clusters/* + # /nodePools/*`. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name - # Required. Deprecated. The name of the node pool to upgrade. - # This field has been deprecated and replaced by the name field. + # Required. Deprecated. The name of the node pool to upgrade. This field has + # been deprecated and replaced by the name field. # Corresponds to the JSON property `nodePoolId` # @return [String] attr_accessor :node_pool_id # Required. Deprecated. The Google Developers Console [project ID or project - # number](https://support.google.com/cloud/answer/6158840). - # This field has been deprecated and replaced by the name field. + # number](https://support.google.com/cloud/answer/6158840). This field has been + # deprecated and replaced by the name field. # Corresponds to the JSON property `projectId` # @return [String] attr_accessor :project_id - # Required. Deprecated. The name of the Google Compute Engine - # [zone](https://cloud.google.com/compute/docs/zones#available) in which the - # cluster resides. This field has been deprecated and replaced by the name - # field. + # Required. Deprecated. The name of the Google Compute Engine [zone](https:// + # cloud.google.com/compute/docs/zones#available) in which the cluster resides. + # This field has been deprecated and replaced by the name field. # Corresponds to the JSON property `zone` # @return [String] attr_accessor :zone @@ -4238,8 +4143,8 @@ module Google class SetNodePoolManagementRequest include Google::Apis::Core::Hashable - # Required. Deprecated. The name of the cluster to update. - # This field has been deprecated and replaced by the name field. + # Required. Deprecated. The name of the cluster to update. This field has been + # deprecated and replaced by the name field. # Corresponds to the JSON property `clusterId` # @return [String] attr_accessor :cluster_id @@ -4251,29 +4156,28 @@ module Google attr_accessor :management # The name (project, location, cluster, node pool id) of the node pool to set - # management properties. Specified in the format - # `projects/*/locations/*/clusters/*/nodePools/*`. + # management properties. Specified in the format `projects/*/locations/*/ + # clusters/*/nodePools/*`. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name - # Required. Deprecated. The name of the node pool to update. - # This field has been deprecated and replaced by the name field. + # Required. Deprecated. The name of the node pool to update. This field has been + # deprecated and replaced by the name field. # Corresponds to the JSON property `nodePoolId` # @return [String] attr_accessor :node_pool_id # Required. Deprecated. The Google Developers Console [project ID or project - # number](https://support.google.com/cloud/answer/6158840). - # This field has been deprecated and replaced by the name field. + # number](https://support.google.com/cloud/answer/6158840). This field has been + # deprecated and replaced by the name field. # Corresponds to the JSON property `projectId` # @return [String] attr_accessor :project_id - # Required. Deprecated. The name of the Google Compute Engine - # [zone](https://cloud.google.com/compute/docs/zones#available) in which the - # cluster resides. This field has been deprecated and replaced by the name - # field. + # Required. Deprecated. The name of the Google Compute Engine [zone](https:// + # cloud.google.com/compute/docs/zones#available) in which the cluster resides. + # This field has been deprecated and replaced by the name field. # Corresponds to the JSON property `zone` # @return [String] attr_accessor :zone @@ -4293,20 +4197,18 @@ module Google end end - # SetNodePoolSizeRequest sets the size a node - # pool. + # SetNodePoolSizeRequest sets the size a node pool. class SetNodePoolSizeRequest include Google::Apis::Core::Hashable - # Required. Deprecated. The name of the cluster to update. - # This field has been deprecated and replaced by the name field. + # Required. Deprecated. The name of the cluster to update. This field has been + # deprecated and replaced by the name field. # Corresponds to the JSON property `clusterId` # @return [String] attr_accessor :cluster_id # The name (project, location, cluster, node pool id) of the node pool to set - # size. - # Specified in the format `projects/*/locations/*/clusters/*/nodePools/*`. + # size. Specified in the format `projects/*/locations/*/clusters/*/nodePools/*`. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name @@ -4316,23 +4218,22 @@ module Google # @return [Fixnum] attr_accessor :node_count - # Required. Deprecated. The name of the node pool to update. - # This field has been deprecated and replaced by the name field. + # Required. Deprecated. The name of the node pool to update. This field has been + # deprecated and replaced by the name field. # Corresponds to the JSON property `nodePoolId` # @return [String] attr_accessor :node_pool_id # Required. Deprecated. The Google Developers Console [project ID or project - # number](https://support.google.com/cloud/answer/6158840). - # This field has been deprecated and replaced by the name field. + # number](https://support.google.com/cloud/answer/6158840). This field has been + # deprecated and replaced by the name field. # Corresponds to the JSON property `projectId` # @return [String] attr_accessor :project_id - # Required. Deprecated. The name of the Google Compute Engine - # [zone](https://cloud.google.com/compute/docs/zones#available) in which the - # cluster resides. This field has been deprecated and replaced by the name - # field. + # Required. Deprecated. The name of the Google Compute Engine [zone](https:// + # cloud.google.com/compute/docs/zones#available) in which the cluster resides. + # This field has been deprecated and replaced by the name field. # Corresponds to the JSON property `zone` # @return [String] attr_accessor :zone @@ -4356,20 +4257,20 @@ module Google class ShieldedInstanceConfig include Google::Apis::Core::Hashable - # Defines whether the instance has integrity monitoring enabled. - # Enables monitoring and attestation of the boot integrity of the instance. - # The attestation is performed against the integrity policy baseline. This - # baseline is initially derived from the implicitly trusted boot image when - # the instance is created. + # Defines whether the instance has integrity monitoring enabled. Enables + # monitoring and attestation of the boot integrity of the instance. The + # attestation is performed against the integrity policy baseline. This baseline + # is initially derived from the implicitly trusted boot image when the instance + # is created. # Corresponds to the JSON property `enableIntegrityMonitoring` # @return [Boolean] attr_accessor :enable_integrity_monitoring alias_method :enable_integrity_monitoring?, :enable_integrity_monitoring - # Defines whether the instance has Secure Boot enabled. - # Secure Boot helps ensure that the system only runs authentic software by - # verifying the digital signature of all boot components, and halting the - # boot process if signature verification fails. + # Defines whether the instance has Secure Boot enabled. Secure Boot helps ensure + # that the system only runs authentic software by verifying the digital + # signature of all boot components, and halting the boot process if signature + # verification fails. # Corresponds to the JSON property `enableSecureBoot` # @return [Boolean] attr_accessor :enable_secure_boot @@ -4406,26 +4307,26 @@ module Google end end - # StartIPRotationRequest creates a new IP for the cluster and then performs - # a node upgrade on each node pool to point to the new IP. + # StartIPRotationRequest creates a new IP for the cluster and then performs a + # node upgrade on each node pool to point to the new IP. class StartIpRotationRequest include Google::Apis::Core::Hashable - # Required. Deprecated. The name of the cluster. - # This field has been deprecated and replaced by the name field. + # Required. Deprecated. The name of the cluster. This field has been deprecated + # and replaced by the name field. # Corresponds to the JSON property `clusterId` # @return [String] attr_accessor :cluster_id - # The name (project, location, cluster id) of the cluster to start IP - # rotation. Specified in the format `projects/*/locations/*/clusters/*`. + # The name (project, location, cluster id) of the cluster to start IP rotation. + # Specified in the format `projects/*/locations/*/clusters/*`. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # Required. Deprecated. The Google Developers Console [project ID or project - # number](https://developers.google.com/console/help/new/#projectnumber). - # This field has been deprecated and replaced by the name field. + # number](https://developers.google.com/console/help/new/#projectnumber). This + # field has been deprecated and replaced by the name field. # Corresponds to the JSON property `projectId` # @return [String] attr_accessor :project_id @@ -4436,10 +4337,9 @@ module Google attr_accessor :rotate_credentials alias_method :rotate_credentials?, :rotate_credentials - # Required. Deprecated. The name of the Google Compute Engine - # [zone](https://cloud.google.com/compute/docs/zones#available) in which the - # cluster resides. This field has been deprecated and replaced by the name - # field. + # Required. Deprecated. The name of the Google Compute Engine [zone](https:// + # cloud.google.com/compute/docs/zones#available) in which the cluster resides. + # This field has been deprecated and replaced by the name field. # Corresponds to the JSON property `zone` # @return [String] attr_accessor :zone @@ -4458,12 +4358,57 @@ module Google end end - # StatusCondition describes why a cluster or a node pool has a certain status - # (e.g., ERROR or DEGRADED). + # 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 + + # The status code, which should be an enum value of google.rpc.Code. + # Corresponds to the JSON property `code` + # @return [Fixnum] + attr_accessor :code + + # 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. + # Corresponds to the JSON property `message` + # @return [String] + attr_accessor :message + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @code = args[:code] if args.key?(:code) + @details = args[:details] if args.key?(:details) + @message = args[:message] if args.key?(:message) + end + end + + # StatusCondition describes why a cluster or a node pool has a certain status (e. + # g., ERROR or DEGRADED). class StatusCondition include Google::Apis::Core::Hashable - # Machine-friendly representation of the condition + # Canonical code of the condition. + # Corresponds to the JSON property `canonicalCode` + # @return [String] + attr_accessor :canonical_code + + # Machine-friendly representation of the condition Deprecated. Use + # canonical_code instead. # Corresponds to the JSON property `code` # @return [String] attr_accessor :code @@ -4479,6 +4424,7 @@ module Google # Update properties of this object def update!(**args) + @canonical_code = args[:canonical_code] if args.key?(:canonical_code) @code = args[:code] if args.key?(:code) @message = args[:message] if args.key?(:message) end @@ -4488,8 +4434,8 @@ module Google class TimeWindow include Google::Apis::Core::Hashable - # The time that the window ends. The end time should take place after the - # start time. + # The time that the window ends. The end time should take place after the start + # time. # Corresponds to the JSON property `endTime` # @return [String] attr_accessor :end_time @@ -4547,36 +4493,34 @@ module Google class UpdateClusterRequest include Google::Apis::Core::Hashable - # Required. Deprecated. The name of the cluster to upgrade. - # This field has been deprecated and replaced by the name field. + # Required. Deprecated. The name of the cluster to upgrade. This field has been + # deprecated and replaced by the name field. # Corresponds to the JSON property `clusterId` # @return [String] attr_accessor :cluster_id - # The name (project, location, cluster) of the cluster to update. - # Specified in the format `projects/*/locations/*/clusters/*`. + # The name (project, location, cluster) of the cluster to update. Specified in + # the format `projects/*/locations/*/clusters/*`. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # Required. Deprecated. The Google Developers Console [project ID or project - # number](https://support.google.com/cloud/answer/6158840). - # This field has been deprecated and replaced by the name field. + # number](https://support.google.com/cloud/answer/6158840). This field has been + # deprecated and replaced by the name field. # Corresponds to the JSON property `projectId` # @return [String] attr_accessor :project_id - # ClusterUpdate describes an update to the cluster. Exactly one update can - # be applied to a cluster with each request, so at most one field can be - # provided. + # ClusterUpdate describes an update to the cluster. Exactly one update can be + # applied to a cluster with each request, so at most one field can be provided. # Corresponds to the JSON property `update` # @return [Google::Apis::ContainerV1beta1::ClusterUpdate] attr_accessor :update - # Required. Deprecated. The name of the Google Compute Engine - # [zone](https://cloud.google.com/compute/docs/zones#available) in which the - # cluster resides. This field has been deprecated and replaced by the name - # field. + # Required. Deprecated. The name of the Google Compute Engine [zone](https:// + # cloud.google.com/compute/docs/zones#available) in which the cluster resides. + # This field has been deprecated and replaced by the name field. # Corresponds to the JSON property `zone` # @return [String] attr_accessor :zone @@ -4599,41 +4543,39 @@ module Google class UpdateMasterRequest include Google::Apis::Core::Hashable - # Required. Deprecated. The name of the cluster to upgrade. - # This field has been deprecated and replaced by the name field. + # Required. Deprecated. The name of the cluster to upgrade. This field has been + # deprecated and replaced by the name field. # Corresponds to the JSON property `clusterId` # @return [String] attr_accessor :cluster_id - # Required. The Kubernetes version to change the master to. - # Users may specify either explicit versions offered by - # Kubernetes Engine or version aliases, which have the following behavior: - # - "latest": picks the highest valid Kubernetes version - # - "1.X": picks the highest valid patch+gke.N patch in the 1.X version - # - "1.X.Y": picks the highest valid gke.N patch in the 1.X.Y version - # - "1.X.Y-gke.N": picks an explicit Kubernetes version - # - "-": picks the default Kubernetes version + # Required. The Kubernetes version to change the master to. Users may specify + # either explicit versions offered by Kubernetes Engine or version aliases, + # which have the following behavior: - "latest": picks the highest valid + # Kubernetes version - "1.X": picks the highest valid patch+gke.N patch in the 1. + # X version - "1.X.Y": picks the highest valid gke.N patch in the 1.X.Y version - + # "1.X.Y-gke.N": picks an explicit Kubernetes version - "-": picks the default + # Kubernetes version # Corresponds to the JSON property `masterVersion` # @return [String] attr_accessor :master_version - # The name (project, location, cluster) of the cluster to update. - # Specified in the format `projects/*/locations/*/clusters/*`. + # The name (project, location, cluster) of the cluster to update. Specified in + # the format `projects/*/locations/*/clusters/*`. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # Required. Deprecated. The Google Developers Console [project ID or project - # number](https://support.google.com/cloud/answer/6158840). - # This field has been deprecated and replaced by the name field. + # number](https://support.google.com/cloud/answer/6158840). This field has been + # deprecated and replaced by the name field. # Corresponds to the JSON property `projectId` # @return [String] attr_accessor :project_id - # Required. Deprecated. The name of the Google Compute Engine - # [zone](https://cloud.google.com/compute/docs/zones#available) in which the - # cluster resides. This field has been deprecated and replaced by the name - # field. + # Required. Deprecated. The name of the Google Compute Engine [zone](https:// + # cloud.google.com/compute/docs/zones#available) in which the cluster resides. + # This field has been deprecated and replaced by the name field. # Corresponds to the JSON property `zone` # @return [String] attr_accessor :zone @@ -4656,8 +4598,8 @@ module Google class UpdateNodePoolRequest include Google::Apis::Core::Hashable - # Required. Deprecated. The name of the cluster to upgrade. - # This field has been deprecated and replaced by the name field. + # Required. Deprecated. The name of the cluster to upgrade. This field has been + # deprecated and replaced by the name field. # Corresponds to the JSON property `clusterId` # @return [String] attr_accessor :cluster_id @@ -4677,66 +4619,59 @@ module Google # @return [Google::Apis::ContainerV1beta1::LinuxNodeConfig] attr_accessor :linux_node_config - # The desired list of Google Compute Engine - # [zones](https://cloud.google.com/compute/docs/zones#available) in which the - # node pool's nodes should be located. Changing the locations for a node pool - # will result in nodes being either created or removed from the node pool, - # depending on whether locations are being added or removed. + # The desired list of Google Compute Engine [zones](https://cloud.google.com/ + # compute/docs/zones#available) in which the node pool's nodes should be located. + # Changing the locations for a node pool will result in nodes being either + # created or removed from the node pool, depending on whether locations are + # being added or removed. # Corresponds to the JSON property `locations` # @return [Array] attr_accessor :locations - # The name (project, location, cluster, node pool) of the node pool to - # update. Specified in the format - # `projects/*/locations/*/clusters/*/nodePools/*`. + # The name (project, location, cluster, node pool) of the node pool to update. + # Specified in the format `projects/*/locations/*/clusters/*/nodePools/*`. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name - # Required. Deprecated. The name of the node pool to upgrade. - # This field has been deprecated and replaced by the name field. + # Required. Deprecated. The name of the node pool to upgrade. This field has + # been deprecated and replaced by the name field. # Corresponds to the JSON property `nodePoolId` # @return [String] attr_accessor :node_pool_id - # Required. The Kubernetes version to change the nodes to (typically an - # upgrade). + # Required. The Kubernetes version to change the nodes to (typically an upgrade). # Users may specify either explicit versions offered by Kubernetes Engine or - # version aliases, which have the following behavior: - # - "latest": picks the highest valid Kubernetes version - # - "1.X": picks the highest valid patch+gke.N patch in the 1.X version - # - "1.X.Y": picks the highest valid gke.N patch in the 1.X.Y version - # - "1.X.Y-gke.N": picks an explicit Kubernetes version - # - "-": picks the Kubernetes master version + # version aliases, which have the following behavior: - "latest": picks the + # highest valid Kubernetes version - "1.X": picks the highest valid patch+gke.N + # patch in the 1.X version - "1.X.Y": picks the highest valid gke.N patch in the + # 1.X.Y version - "1.X.Y-gke.N": picks an explicit Kubernetes version - "-": + # picks the Kubernetes master version # Corresponds to the JSON property `nodeVersion` # @return [String] attr_accessor :node_version # Required. Deprecated. The Google Developers Console [project ID or project - # number](https://support.google.com/cloud/answer/6158840). - # This field has been deprecated and replaced by the name field. + # number](https://support.google.com/cloud/answer/6158840). This field has been + # deprecated and replaced by the name field. # Corresponds to the JSON property `projectId` # @return [String] attr_accessor :project_id # These upgrade settings control the level of parallelism and the level of - # disruption caused by an upgrade. - # maxUnavailable controls the number of nodes that can be simultaneously - # unavailable. - # maxSurge controls the number of additional nodes that can be added to the - # node pool temporarily for the time of the upgrade to increase the number of - # available nodes. - # (maxUnavailable + maxSurge) determines the level of parallelism (how many - # nodes are being upgraded at the same time). - # Note: upgrades inevitably introduce some disruption since workloads need to - # be moved from old nodes to new, upgraded ones. Even if maxUnavailable=0, - # this holds true. (Disruption stays within the limits of - # PodDisruptionBudget, if it is configured.) - # Consider a hypothetical node pool with 5 nodes having maxSurge=2, - # maxUnavailable=1. This means the upgrade process upgrades 3 nodes - # simultaneously. It creates 2 additional (upgraded) nodes, then it brings - # down 3 old (not yet upgraded) nodes at the same time. This ensures that - # there are always at least 4 nodes available. + # disruption caused by an upgrade. maxUnavailable controls the number of nodes + # that can be simultaneously unavailable. maxSurge controls the number of + # additional nodes that can be added to the node pool temporarily for the time + # of the upgrade to increase the number of available nodes. (maxUnavailable + + # maxSurge) determines the level of parallelism (how many nodes are being + # upgraded at the same time). Note: upgrades inevitably introduce some + # disruption since workloads need to be moved from old nodes to new, upgraded + # ones. Even if maxUnavailable=0, this holds true. (Disruption stays within the + # limits of PodDisruptionBudget, if it is configured.) Consider a hypothetical + # node pool with 5 nodes having maxSurge=2, maxUnavailable=1. This means the + # upgrade process upgrades 3 nodes simultaneously. It creates 2 additional ( + # upgraded) nodes, then it brings down 3 old (not yet upgraded) nodes at the + # same time. This ensures that there are always at least 4 nodes available. # Corresponds to the JSON property `upgradeSettings` # @return [Google::Apis::ContainerV1beta1::UpgradeSettings] attr_accessor :upgrade_settings @@ -4747,10 +4682,9 @@ module Google # @return [Google::Apis::ContainerV1beta1::WorkloadMetadataConfig] attr_accessor :workload_metadata_config - # Required. Deprecated. The name of the Google Compute Engine - # [zone](https://cloud.google.com/compute/docs/zones#available) in which the - # cluster resides. This field has been deprecated and replaced by the name - # field. + # Required. Deprecated. The name of the Google Compute Engine [zone](https:// + # cloud.google.com/compute/docs/zones#available) in which the cluster resides. + # This field has been deprecated and replaced by the name field. # Corresponds to the JSON property `zone` # @return [String] attr_accessor :zone @@ -4776,36 +4710,82 @@ module Google end end + # UpgradeEvent is a notification sent to customers by the cluster server when a + # resource is upgrading. + class UpgradeEvent + include Google::Apis::Core::Hashable + + # Required. The current version before the upgrade. + # Corresponds to the JSON property `currentVersion` + # @return [String] + attr_accessor :current_version + + # Required. The operation associated with this upgrade. + # Corresponds to the JSON property `operation` + # @return [String] + attr_accessor :operation + + # Required. The time when the operation was started. + # Corresponds to the JSON property `operationStartTime` + # @return [String] + attr_accessor :operation_start_time + + # Optional. Optional relative path to the resource. For example in node pool + # upgrades, the relative path of the node pool. + # Corresponds to the JSON property `resource` + # @return [String] + attr_accessor :resource + + # Required. The resource type that is upgrading. + # Corresponds to the JSON property `resourceType` + # @return [String] + attr_accessor :resource_type + + # Required. The target version for the upgrade. + # Corresponds to the JSON property `targetVersion` + # @return [String] + attr_accessor :target_version + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @current_version = args[:current_version] if args.key?(:current_version) + @operation = args[:operation] if args.key?(:operation) + @operation_start_time = args[:operation_start_time] if args.key?(:operation_start_time) + @resource = args[:resource] if args.key?(:resource) + @resource_type = args[:resource_type] if args.key?(:resource_type) + @target_version = args[:target_version] if args.key?(:target_version) + end + end + # These upgrade settings control the level of parallelism and the level of - # disruption caused by an upgrade. - # maxUnavailable controls the number of nodes that can be simultaneously - # unavailable. - # maxSurge controls the number of additional nodes that can be added to the - # node pool temporarily for the time of the upgrade to increase the number of - # available nodes. - # (maxUnavailable + maxSurge) determines the level of parallelism (how many - # nodes are being upgraded at the same time). - # Note: upgrades inevitably introduce some disruption since workloads need to - # be moved from old nodes to new, upgraded ones. Even if maxUnavailable=0, - # this holds true. (Disruption stays within the limits of - # PodDisruptionBudget, if it is configured.) - # Consider a hypothetical node pool with 5 nodes having maxSurge=2, - # maxUnavailable=1. This means the upgrade process upgrades 3 nodes - # simultaneously. It creates 2 additional (upgraded) nodes, then it brings - # down 3 old (not yet upgraded) nodes at the same time. This ensures that - # there are always at least 4 nodes available. + # disruption caused by an upgrade. maxUnavailable controls the number of nodes + # that can be simultaneously unavailable. maxSurge controls the number of + # additional nodes that can be added to the node pool temporarily for the time + # of the upgrade to increase the number of available nodes. (maxUnavailable + + # maxSurge) determines the level of parallelism (how many nodes are being + # upgraded at the same time). Note: upgrades inevitably introduce some + # disruption since workloads need to be moved from old nodes to new, upgraded + # ones. Even if maxUnavailable=0, this holds true. (Disruption stays within the + # limits of PodDisruptionBudget, if it is configured.) Consider a hypothetical + # node pool with 5 nodes having maxSurge=2, maxUnavailable=1. This means the + # upgrade process upgrades 3 nodes simultaneously. It creates 2 additional ( + # upgraded) nodes, then it brings down 3 old (not yet upgraded) nodes at the + # same time. This ensures that there are always at least 4 nodes available. class UpgradeSettings include Google::Apis::Core::Hashable - # The maximum number of nodes that can be created beyond the current size - # of the node pool during the upgrade process. + # The maximum number of nodes that can be created beyond the current size of the + # node pool during the upgrade process. # Corresponds to the JSON property `maxSurge` # @return [Fixnum] attr_accessor :max_surge - # The maximum number of nodes that can be simultaneously unavailable during - # the upgrade process. A node is considered available if its status is - # Ready. + # The maximum number of nodes that can be simultaneously unavailable during the + # upgrade process. A node is considered available if its status is Ready. # Corresponds to the JSON property `maxUnavailable` # @return [Fixnum] attr_accessor :max_unavailable @@ -4831,8 +4811,7 @@ module Google # @return [String] attr_accessor :ip_cidr_range - # Network Name. - # Example: projects/my-project/global/networks/my-network + # Network Name. Example: projects/my-project/global/networks/my-network # Corresponds to the JSON property `network` # @return [String] attr_accessor :network @@ -4842,16 +4821,16 @@ module Google # @return [Array] attr_accessor :secondary_ip_ranges - # A human readable status message representing the reasons for cases where - # the caller cannot use the secondary ranges under the subnet. For example if - # the secondary_ip_ranges is empty due to a permission issue, an insufficient + # A human readable status message representing the reasons for cases where the + # caller cannot use the secondary ranges under the subnet. For example if the + # secondary_ip_ranges is empty due to a permission issue, an insufficient # permission message will be given by status_message. # Corresponds to the JSON property `statusMessage` # @return [String] attr_accessor :status_message - # Subnetwork Name. - # Example: projects/my-project/regions/us-central1/subnetworks/my-subnet + # Subnetwork Name. Example: projects/my-project/regions/us-central1/subnetworks/ + # my-subnet # Corresponds to the JSON property `subnetwork` # @return [String] attr_accessor :subnetwork @@ -4879,8 +4858,8 @@ module Google # @return [String] attr_accessor :ip_cidr_range - # The name associated with this subnetwork secondary range, used when adding - # an alias IP range to a VM instance. + # The name associated with this subnetwork secondary range, used when adding an + # alias IP range to a VM instance. # Corresponds to the JSON property `rangeName` # @return [String] attr_accessor :range_name @@ -4902,9 +4881,9 @@ module Google end end - # VerticalPodAutoscaling contains global, per-cluster information - # required by Vertical Pod Autoscaler to automatically adjust - # the resources of pods controlled by it. + # VerticalPodAutoscaling contains global, per-cluster information required by + # Vertical Pod Autoscaler to automatically adjust the resources of pods + # controlled by it. class VerticalPodAutoscaling include Google::Apis::Core::Hashable @@ -4924,8 +4903,7 @@ module Google end end - # Configuration for the use of Kubernetes Service Accounts in GCP IAM - # policies. + # Configuration for the use of Kubernetes Service Accounts in GCP IAM policies. class WorkloadIdentityConfig include Google::Apis::Core::Hashable @@ -4961,14 +4939,14 @@ module Google class WorkloadMetadataConfig include Google::Apis::Core::Hashable - # Mode is the configuration for how to expose metadata to workloads running - # on the node pool. + # Mode is the configuration for how to expose metadata to workloads running on + # the node pool. # Corresponds to the JSON property `mode` # @return [String] attr_accessor :mode - # NodeMetadata is the configuration for how to expose metadata to the - # workloads running on the node. + # NodeMetadata is the configuration for how to expose metadata to the workloads + # running on the node. # Corresponds to the JSON property `nodeMetadata` # @return [String] attr_accessor :node_metadata diff --git a/generated/google/apis/container_v1beta1/representations.rb b/generated/google/apis/container_v1beta1/representations.rb index 721d6b563..93d807c94 100644 --- a/generated/google/apis/container_v1beta1/representations.rb +++ b/generated/google/apis/container_v1beta1/representations.rb @@ -394,6 +394,12 @@ module Google include Google::Apis::Core::JsonObjectSupport end + class NotificationConfig + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class Operation class Representation < Google::Apis::Core::JsonRepresentation; end @@ -424,6 +430,12 @@ module Google include Google::Apis::Core::JsonObjectSupport end + class PubSub + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class RecurringTimeWindow class Representation < Google::Apis::Core::JsonRepresentation; end @@ -568,6 +580,12 @@ module Google include Google::Apis::Core::JsonObjectSupport end + class Status + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class StatusCondition class Representation < Google::Apis::Core::JsonRepresentation; end @@ -604,6 +622,12 @@ module Google include Google::Apis::Core::JsonObjectSupport end + class UpgradeEvent + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class UpgradeSettings class Representation < Google::Apis::Core::JsonRepresentation; end @@ -818,6 +842,8 @@ module Google property :node_ipv4_cidr_size, as: 'nodeIpv4CidrSize' collection :node_pools, as: 'nodePools', class: Google::Apis::ContainerV1beta1::NodePool, decorator: Google::Apis::ContainerV1beta1::NodePool::Representation + property :notification_config, as: 'notificationConfig', class: Google::Apis::ContainerV1beta1::NotificationConfig, decorator: Google::Apis::ContainerV1beta1::NotificationConfig::Representation + property :pod_security_policy_config, as: 'podSecurityPolicyConfig', class: Google::Apis::ContainerV1beta1::PodSecurityPolicyConfig, decorator: Google::Apis::ContainerV1beta1::PodSecurityPolicyConfig::Representation property :private_cluster, as: 'privateCluster' @@ -879,6 +905,7 @@ module Google property :desired_database_encryption, as: 'desiredDatabaseEncryption', class: Google::Apis::ContainerV1beta1::DatabaseEncryption, decorator: Google::Apis::ContainerV1beta1::DatabaseEncryption::Representation + property :desired_datapath_provider, as: 'desiredDatapathProvider' property :desired_default_snat_status, as: 'desiredDefaultSnatStatus', class: Google::Apis::ContainerV1beta1::DefaultSnatStatus, decorator: Google::Apis::ContainerV1beta1::DefaultSnatStatus::Representation property :desired_image_type, as: 'desiredImageType' @@ -896,6 +923,8 @@ module Google property :desired_node_pool_id, as: 'desiredNodePoolId' property :desired_node_version, as: 'desiredNodeVersion' + property :desired_notification_config, as: 'desiredNotificationConfig', class: Google::Apis::ContainerV1beta1::NotificationConfig, decorator: Google::Apis::ContainerV1beta1::NotificationConfig::Representation + property :desired_pod_security_policy_config, as: 'desiredPodSecurityPolicyConfig', class: Google::Apis::ContainerV1beta1::PodSecurityPolicyConfig, decorator: Google::Apis::ContainerV1beta1::PodSecurityPolicyConfig::Representation property :desired_private_cluster_config, as: 'desiredPrivateClusterConfig', class: Google::Apis::ContainerV1beta1::PrivateClusterConfig, decorator: Google::Apis::ContainerV1beta1::PrivateClusterConfig::Representation @@ -1253,6 +1282,7 @@ module Google class NetworkConfig # @private class Representation < Google::Apis::Core::JsonRepresentation + property :datapath_provider, as: 'datapathProvider' property :default_snat_status, as: 'defaultSnatStatus', class: Google::Apis::ContainerV1beta1::DefaultSnatStatus, decorator: Google::Apis::ContainerV1beta1::DefaultSnatStatus::Representation property :enable_intra_node_visibility, as: 'enableIntraNodeVisibility' @@ -1377,6 +1407,14 @@ module Google end end + class NotificationConfig + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :pubsub, as: 'pubsub', class: Google::Apis::ContainerV1beta1::PubSub, decorator: Google::Apis::ContainerV1beta1::PubSub::Representation + + end + end + class Operation # @private class Representation < Google::Apis::Core::JsonRepresentation @@ -1384,6 +1422,8 @@ module Google property :detail, as: 'detail' property :end_time, as: 'endTime' + property :error, as: 'error', class: Google::Apis::ContainerV1beta1::Status, decorator: Google::Apis::ContainerV1beta1::Status::Representation + property :location, as: 'location' property :name, as: 'name' collection :nodepool_conditions, as: 'nodepoolConditions', class: Google::Apis::ContainerV1beta1::StatusCondition, decorator: Google::Apis::ContainerV1beta1::StatusCondition::Representation @@ -1440,6 +1480,14 @@ module Google end end + class PubSub + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :enabled, as: 'enabled' + property :topic, as: 'topic' + end + end + class RecurringTimeWindow # @private class Representation < Google::Apis::Core::JsonRepresentation @@ -1697,9 +1745,19 @@ module Google end end + class Status + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :code, as: 'code' + collection :details, as: 'details' + property :message, as: 'message' + end + end + class StatusCondition # @private class Representation < Google::Apis::Core::JsonRepresentation + property :canonical_code, as: 'canonicalCode' property :code, as: 'code' property :message, as: 'message' end @@ -1767,6 +1825,18 @@ module Google end end + class UpgradeEvent + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :current_version, as: 'currentVersion' + property :operation, as: 'operation' + property :operation_start_time, as: 'operationStartTime' + property :resource, as: 'resource' + property :resource_type, as: 'resourceType' + property :target_version, as: 'targetVersion' + end + end + class UpgradeSettings # @private class Representation < Google::Apis::Core::JsonRepresentation diff --git a/generated/google/apis/container_v1beta1/service.rb b/generated/google/apis/container_v1beta1/service.rb index 191dfbe3d..e466cb8ff 100644 --- a/generated/google/apis/container_v1beta1/service.rb +++ b/generated/google/apis/container_v1beta1/service.rb @@ -50,18 +50,18 @@ module Google # Lists subnetworks that can be used for creating clusters in a project. # @param [String] parent - # Required. The parent project where subnetworks are usable. - # Specified in the format `projects/*`. + # Required. The parent project where subnetworks are usable. Specified in the + # format `projects/*`. # @param [String] filter - # Filtering currently only supports equality on the networkProjectId and must - # be in the form: "networkProjectId=[PROJECTID]", where `networkProjectId` - # is the project which owns the listed subnetworks. This defaults to the - # parent project ID. + # Filtering currently only supports equality on the networkProjectId and must be + # in the form: "networkProjectId=[PROJECTID]", where `networkProjectId` is the + # project which owns the listed subnetworks. This defaults to the parent project + # ID. # @param [Fixnum] page_size - # The max number of results per page that should be returned. If the number - # of available results is larger than `page_size`, a `next_page_token` is - # returned which can be used to get the next page of results in subsequent - # requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + # The max number of results per page that should be returned. If the number of + # available results is larger than `page_size`, a `next_page_token` is returned + # which can be used to get the next page of results in subsequent requests. + # Acceptable values are 0 to 500, inclusive. (Default: 500) # @param [String] page_token # Specifies a page token to use. Set this to the nextPageToken returned by # previous list requests to get the next page of results. @@ -97,17 +97,16 @@ module Google # Returns configuration info about the Google Kubernetes Engine service. # @param [String] name - # The name (project and location) of the server config to get, - # specified in the format `projects/*/locations/*`. + # The name (project and location) of the server config to get, specified in the + # format `projects/*/locations/*`. # @param [String] project_id # Required. Deprecated. The Google Developers Console [project ID or project - # number](https://support.google.com/cloud/answer/6158840). - # This field has been deprecated and replaced by the name field. + # number](https://support.google.com/cloud/answer/6158840). This field has been + # deprecated and replaced by the name field. # @param [String] zone - # Required. Deprecated. The name of the Google Compute Engine - # [zone](https://cloud.google.com/compute/docs/zones#available) to return - # operations for. This field has been deprecated and replaced by the name - # field. + # Required. Deprecated. The name of the Google Compute Engine [zone](https:// + # cloud.google.com/compute/docs/zones#available) to return operations for. This + # field has been deprecated and replaced by the name field. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -139,8 +138,8 @@ module Google # Fetches locations that offer Google Kubernetes Engine. # @param [String] parent - # Required. Contains the name of the resource requested. - # Specified in the format `projects/*`. + # Required. Contains the name of the resource requested. Specified in the format + # `projects/*`. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -203,20 +202,16 @@ module Google end # Creates a cluster, consisting of the specified number and type of Google - # Compute Engine instances. - # By default, the cluster is created in the project's - # [default - # network](https://cloud.google.com/compute/docs/networks-and-firewalls#networks) - # . - # One firewall is added for the cluster. After cluster creation, - # the Kubelet creates routes for each node to allow the containers - # on that node to communicate with all other instances in the - # cluster. - # Finally, an entry is added to the project's global metadata indicating - # which CIDR range the cluster is using. + # Compute Engine instances. By default, the cluster is created in the project's [ + # default network](https://cloud.google.com/compute/docs/networks-and-firewalls# + # networks). One firewall is added for the cluster. After cluster creation, the + # Kubelet creates routes for each node to allow the containers on that node to + # communicate with all other instances in the cluster. Finally, an entry is + # added to the project's global metadata indicating which CIDR range the cluster + # is using. # @param [String] parent - # The parent (project and location) where the cluster will be created. - # Specified in the format `projects/*/locations/*`. + # The parent (project and location) where the cluster will be created. Specified + # in the format `projects/*/locations/*`. # @param [Google::Apis::ContainerV1beta1::CreateClusterRequest] create_cluster_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -247,28 +242,25 @@ module Google execute_or_queue_command(command, &block) end - # Deletes the cluster, including the Kubernetes endpoint and all worker - # nodes. - # Firewalls and routes that were configured during cluster creation - # are also deleted. - # Other Google Compute Engine resources that might be in use by the cluster, - # such as load balancer resources, are not deleted if they weren't present - # when the cluster was initially created. + # Deletes the cluster, including the Kubernetes endpoint and all worker nodes. + # Firewalls and routes that were configured during cluster creation are also + # deleted. Other Google Compute Engine resources that might be in use by the + # cluster, such as load balancer resources, are not deleted if they weren't + # present when the cluster was initially created. # @param [String] name - # The name (project, location, cluster) of the cluster to delete. - # Specified in the format `projects/*/locations/*/clusters/*`. + # The name (project, location, cluster) of the cluster to delete. Specified in + # the format `projects/*/locations/*/clusters/*`. # @param [String] cluster_id - # Required. Deprecated. The name of the cluster to delete. - # This field has been deprecated and replaced by the name field. + # Required. Deprecated. The name of the cluster to delete. This field has been + # deprecated and replaced by the name field. # @param [String] project_id # Required. Deprecated. The Google Developers Console [project ID or project - # number](https://support.google.com/cloud/answer/6158840). - # This field has been deprecated and replaced by the name field. + # number](https://support.google.com/cloud/answer/6158840). This field has been + # deprecated and replaced by the name field. # @param [String] zone - # Required. Deprecated. The name of the Google Compute Engine - # [zone](https://cloud.google.com/compute/docs/zones#available) in which the - # cluster resides. This field has been deprecated and replaced by the name - # field. + # Required. Deprecated. The name of the Google Compute Engine [zone](https:// + # cloud.google.com/compute/docs/zones#available) in which the cluster resides. + # This field has been deprecated and replaced by the name field. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -301,20 +293,19 @@ module Google # Gets the details for a specific cluster. # @param [String] name - # The name (project, location, cluster) of the cluster to retrieve. - # Specified in the format `projects/*/locations/*/clusters/*`. + # The name (project, location, cluster) of the cluster to retrieve. Specified in + # the format `projects/*/locations/*/clusters/*`. # @param [String] cluster_id - # Required. Deprecated. The name of the cluster to retrieve. - # This field has been deprecated and replaced by the name field. + # Required. Deprecated. The name of the cluster to retrieve. This field has been + # deprecated and replaced by the name field. # @param [String] project_id # Required. Deprecated. The Google Developers Console [project ID or project - # number](https://support.google.com/cloud/answer/6158840). - # This field has been deprecated and replaced by the name field. + # number](https://support.google.com/cloud/answer/6158840). This field has been + # deprecated and replaced by the name field. # @param [String] zone - # Required. Deprecated. The name of the Google Compute Engine - # [zone](https://cloud.google.com/compute/docs/zones#available) in which the - # cluster resides. This field has been deprecated and replaced by the name - # field. + # Required. Deprecated. The name of the Google Compute Engine [zone](https:// + # cloud.google.com/compute/docs/zones#available) in which the cluster resides. + # This field has been deprecated and replaced by the name field. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -345,13 +336,12 @@ module Google execute_or_queue_command(command, &block) end - # Gets the public component of the cluster signing keys in - # JSON Web Key format. + # Gets the public component of the cluster signing keys in JSON Web Key format. # This API is not yet intended for general use, and is not available for all # clusters. # @param [String] parent - # The cluster (project, location, cluster id) to get keys for. Specified in - # the format `projects/*/locations/*/clusters/*`. + # The cluster (project, location, cluster id) to get keys for. Specified in the + # format `projects/*/locations/*/clusters/*`. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -382,18 +372,18 @@ module Google # Lists all clusters owned by a project in either the specified zone or all # zones. # @param [String] parent - # The parent (project and location) where the clusters will be listed. - # Specified in the format `projects/*/locations/*`. - # Location "-" matches all zones and all regions. + # The parent (project and location) where the clusters will be listed. Specified + # in the format `projects/*/locations/*`. Location "-" matches all zones and all + # regions. # @param [String] project_id # Required. Deprecated. The Google Developers Console [project ID or project - # number](https://support.google.com/cloud/answer/6158840). - # This field has been deprecated and replaced by the parent field. + # number](https://support.google.com/cloud/answer/6158840). This field has been + # deprecated and replaced by the parent field. # @param [String] zone - # Required. Deprecated. The name of the Google Compute Engine - # [zone](https://cloud.google.com/compute/docs/zones#available) in which the - # cluster resides, or "-" for all zones. This field has been deprecated and - # replaced by the parent field. + # Required. Deprecated. The name of the Google Compute Engine [zone](https:// + # cloud.google.com/compute/docs/zones#available) in which the cluster resides, + # or "-" for all zones. This field has been deprecated and replaced by the + # parent field. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -425,8 +415,8 @@ module Google # Sets the addons for a specific cluster. # @param [String] name - # The name (project, location, cluster) of the cluster to set addons. - # Specified in the format `projects/*/locations/*/clusters/*`. + # The name (project, location, cluster) of the cluster to set addons. Specified + # in the format `projects/*/locations/*/clusters/*`. # @param [Google::Apis::ContainerV1beta1::SetAddonsConfigRequest] set_addons_config_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -491,11 +481,9 @@ module Google execute_or_queue_command(command, &block) end - # Sets the locations for a specific cluster. - # Deprecated. Use - # [projects.locations.clusters.update](https://cloud.google.com/kubernetes- - # engine/docs/reference/rest/v1beta1/projects.locations.clusters/update) - # instead. + # Sets the locations for a specific cluster. Deprecated. Use [projects.locations. + # clusters.update](https://cloud.google.com/kubernetes-engine/docs/reference/ + # rest/v1beta1/projects.locations.clusters/update) instead. # @param [String] name # The name (project, location, cluster) of the cluster to set locations. # Specified in the format `projects/*/locations/*/clusters/*`. @@ -531,8 +519,8 @@ module Google # Sets the logging service for a specific cluster. # @param [String] name - # The name (project, location, cluster) of the cluster to set logging. - # Specified in the format `projects/*/locations/*/clusters/*`. + # The name (project, location, cluster) of the cluster to set logging. Specified + # in the format `projects/*/locations/*/clusters/*`. # @param [Google::Apis::ContainerV1beta1::SetLoggingServiceRequest] set_logging_service_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -566,8 +554,7 @@ module Google # Sets the maintenance policy for a cluster. # @param [String] name # The name (project, location, cluster id) of the cluster to set maintenance - # policy. - # Specified in the format `projects/*/locations/*/clusters/*`. + # policy. Specified in the format `projects/*/locations/*/clusters/*`. # @param [Google::Apis::ContainerV1beta1::SetMaintenancePolicyRequest] set_maintenance_policy_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -598,12 +585,12 @@ module Google execute_or_queue_command(command, &block) end - # Sets master auth materials. Currently supports changing the admin password - # or a specific cluster, either via password generation or explicitly setting - # the password. + # Sets master auth materials. Currently supports changing the admin password or + # a specific cluster, either via password generation or explicitly setting the + # password. # @param [String] name - # The name (project, location, cluster) of the cluster to set auth. - # Specified in the format `projects/*/locations/*/clusters/*`. + # The name (project, location, cluster) of the cluster to set auth. Specified in + # the format `projects/*/locations/*/clusters/*`. # @param [Google::Apis::ContainerV1beta1::SetMasterAuthRequest] set_master_auth_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -738,8 +725,8 @@ module Google # Starts master IP rotation. # @param [String] name - # The name (project, location, cluster id) of the cluster to start IP - # rotation. Specified in the format `projects/*/locations/*/clusters/*`. + # The name (project, location, cluster id) of the cluster to start IP rotation. + # Specified in the format `projects/*/locations/*/clusters/*`. # @param [Google::Apis::ContainerV1beta1::StartIpRotationRequest] start_ip_rotation_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -772,8 +759,8 @@ module Google # Updates the settings for a specific cluster. # @param [String] name - # The name (project, location, cluster) of the cluster to update. - # Specified in the format `projects/*/locations/*/clusters/*`. + # The name (project, location, cluster) of the cluster to update. Specified in + # the format `projects/*/locations/*/clusters/*`. # @param [Google::Apis::ContainerV1beta1::UpdateClusterRequest] update_cluster_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -806,8 +793,8 @@ module Google # Updates the master for a specific cluster. # @param [String] name - # The name (project, location, cluster) of the cluster to update. - # Specified in the format `projects/*/locations/*/clusters/*`. + # The name (project, location, cluster) of the cluster to update. Specified in + # the format `projects/*/locations/*/clusters/*`. # @param [Google::Apis::ContainerV1beta1::UpdateMasterRequest] update_master_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -840,9 +827,8 @@ module Google # Creates a node pool for a cluster. # @param [String] parent - # The parent (project, location, cluster id) where the node pool will be - # created. Specified in the format - # `projects/*/locations/*/clusters/*`. + # The parent (project, location, cluster id) where the node pool will be created. + # Specified in the format `projects/*/locations/*/clusters/*`. # @param [Google::Apis::ContainerV1beta1::CreateNodePoolRequest] create_node_pool_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -875,24 +861,22 @@ module Google # Deletes a node pool from a cluster. # @param [String] name - # The name (project, location, cluster, node pool id) of the node pool to - # delete. Specified in the format - # `projects/*/locations/*/clusters/*/nodePools/*`. + # The name (project, location, cluster, node pool id) of the node pool to delete. + # Specified in the format `projects/*/locations/*/clusters/*/nodePools/*`. # @param [String] cluster_id - # Required. Deprecated. The name of the cluster. - # This field has been deprecated and replaced by the name field. + # Required. Deprecated. The name of the cluster. This field has been deprecated + # and replaced by the name field. # @param [String] node_pool_id - # Required. Deprecated. The name of the node pool to delete. - # This field has been deprecated and replaced by the name field. + # Required. Deprecated. The name of the node pool to delete. This field has been + # deprecated and replaced by the name field. # @param [String] project_id # Required. Deprecated. The Google Developers Console [project ID or project - # number](https://developers.google.com/console/help/new/#projectnumber). - # This field has been deprecated and replaced by the name field. + # number](https://developers.google.com/console/help/new/#projectnumber). This + # field has been deprecated and replaced by the name field. # @param [String] zone - # Required. Deprecated. The name of the Google Compute Engine - # [zone](https://cloud.google.com/compute/docs/zones#available) in which the - # cluster resides. This field has been deprecated and replaced by the name - # field. + # Required. Deprecated. The name of the Google Compute Engine [zone](https:// + # cloud.google.com/compute/docs/zones#available) in which the cluster resides. + # This field has been deprecated and replaced by the name field. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -926,24 +910,22 @@ module Google # Retrieves the requested node pool. # @param [String] name - # The name (project, location, cluster, node pool id) of the node pool to - # get. Specified in the format - # `projects/*/locations/*/clusters/*/nodePools/*`. + # The name (project, location, cluster, node pool id) of the node pool to get. + # Specified in the format `projects/*/locations/*/clusters/*/nodePools/*`. # @param [String] cluster_id - # Required. Deprecated. The name of the cluster. - # This field has been deprecated and replaced by the name field. + # Required. Deprecated. The name of the cluster. This field has been deprecated + # and replaced by the name field. # @param [String] node_pool_id - # Required. Deprecated. The name of the node pool. - # This field has been deprecated and replaced by the name field. + # Required. Deprecated. The name of the node pool. This field has been + # deprecated and replaced by the name field. # @param [String] project_id # Required. Deprecated. The Google Developers Console [project ID or project - # number](https://developers.google.com/console/help/new/#projectnumber). - # This field has been deprecated and replaced by the name field. + # number](https://developers.google.com/console/help/new/#projectnumber). This + # field has been deprecated and replaced by the name field. # @param [String] zone - # Required. Deprecated. The name of the Google Compute Engine - # [zone](https://cloud.google.com/compute/docs/zones#available) in which the - # cluster resides. This field has been deprecated and replaced by the name - # field. + # Required. Deprecated. The name of the Google Compute Engine [zone](https:// + # cloud.google.com/compute/docs/zones#available) in which the cluster resides. + # This field has been deprecated and replaced by the name field. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -977,20 +959,19 @@ module Google # Lists the node pools for a cluster. # @param [String] parent - # The parent (project, location, cluster id) where the node pools will be - # listed. Specified in the format `projects/*/locations/*/clusters/*`. + # The parent (project, location, cluster id) where the node pools will be listed. + # Specified in the format `projects/*/locations/*/clusters/*`. # @param [String] cluster_id - # Required. Deprecated. The name of the cluster. - # This field has been deprecated and replaced by the parent field. + # Required. Deprecated. The name of the cluster. This field has been deprecated + # and replaced by the parent field. # @param [String] project_id # Required. Deprecated. The Google Developers Console [project ID or project - # number](https://developers.google.com/console/help/new/#projectnumber). - # This field has been deprecated and replaced by the parent field. + # number](https://developers.google.com/console/help/new/#projectnumber). This + # field has been deprecated and replaced by the parent field. # @param [String] zone - # Required. Deprecated. The name of the Google Compute Engine - # [zone](https://cloud.google.com/compute/docs/zones#available) in which the - # cluster resides. This field has been deprecated and replaced by the parent - # field. + # Required. Deprecated. The name of the Google Compute Engine [zone](https:// + # cloud.google.com/compute/docs/zones#available) in which the cluster resides. + # This field has been deprecated and replaced by the parent field. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -1021,12 +1002,12 @@ module Google execute_or_queue_command(command, &block) end - # Rolls back a previously Aborted or Failed NodePool upgrade. - # This makes no changes if the last upgrade successfully completed. + # Rolls back a previously Aborted or Failed NodePool upgrade. This makes no + # changes if the last upgrade successfully completed. # @param [String] name # The name (project, location, cluster, node pool id) of the node poll to - # rollback upgrade. - # Specified in the format `projects/*/locations/*/clusters/*/nodePools/*`. + # rollback upgrade. Specified in the format `projects/*/locations/*/clusters/*/ + # nodePools/*`. # @param [Google::Apis::ContainerV1beta1::RollbackNodePoolUpgradeRequest] rollback_node_pool_upgrade_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -1060,8 +1041,8 @@ module Google # Sets the autoscaling settings of a specific node pool. # @param [String] name # The name (project, location, cluster, node pool) of the node pool to set - # autoscaler settings. Specified in the format - # `projects/*/locations/*/clusters/*/nodePools/*`. + # autoscaler settings. Specified in the format `projects/*/locations/*/clusters/* + # /nodePools/*`. # @param [Google::Apis::ContainerV1beta1::SetNodePoolAutoscalingRequest] set_node_pool_autoscaling_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -1095,8 +1076,8 @@ module Google # Sets the NodeManagement options for a node pool. # @param [String] name # The name (project, location, cluster, node pool id) of the node pool to set - # management properties. Specified in the format - # `projects/*/locations/*/clusters/*/nodePools/*`. + # management properties. Specified in the format `projects/*/locations/*/ + # clusters/*/nodePools/*`. # @param [Google::Apis::ContainerV1beta1::SetNodePoolManagementRequest] set_node_pool_management_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -1130,8 +1111,7 @@ module Google # Sets the size for a specific node pool. # @param [String] name # The name (project, location, cluster, node pool id) of the node pool to set - # size. - # Specified in the format `projects/*/locations/*/clusters/*/nodePools/*`. + # size. Specified in the format `projects/*/locations/*/clusters/*/nodePools/*`. # @param [Google::Apis::ContainerV1beta1::SetNodePoolSizeRequest] set_node_pool_size_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -1164,9 +1144,8 @@ module Google # Updates the version and/or image type of a specific node pool. # @param [String] name - # The name (project, location, cluster, node pool) of the node pool to - # update. Specified in the format - # `projects/*/locations/*/clusters/*/nodePools/*`. + # The name (project, location, cluster, node pool) of the node pool to update. + # Specified in the format `projects/*/locations/*/clusters/*/nodePools/*`. # @param [Google::Apis::ContainerV1beta1::UpdateNodePoolRequest] update_node_pool_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -1197,16 +1176,13 @@ module Google execute_or_queue_command(command, &block) end - # Gets the OIDC discovery document for the cluster. - # See the - # [OpenID Connect Discovery 1.0 - # specification](https://openid.net/specs/openid-connect-discovery-1_0.html) - # for details. - # This API is not yet intended for general use, and is not available for all - # clusters. + # Gets the OIDC discovery document for the cluster. See the [OpenID Connect + # Discovery 1.0 specification](https://openid.net/specs/openid-connect-discovery- + # 1_0.html) for details. This API is not yet intended for general use, and is + # not available for all clusters. # @param [String] parent - # The cluster (project, location, cluster id) to get the discovery document - # for. Specified in the format `projects/*/locations/*/clusters/*`. + # The cluster (project, location, cluster id) to get the discovery document for. + # Specified in the format `projects/*/locations/*/clusters/*`. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -1270,20 +1246,19 @@ module Google # Gets the specified operation. # @param [String] name - # The name (project, location, operation id) of the operation to get. - # Specified in the format `projects/*/locations/*/operations/*`. + # The name (project, location, operation id) of the operation to get. Specified + # in the format `projects/*/locations/*/operations/*`. # @param [String] operation_id - # Required. Deprecated. The server-assigned `name` of the operation. - # This field has been deprecated and replaced by the name field. + # Required. Deprecated. The server-assigned `name` of the operation. This field + # has been deprecated and replaced by the name field. # @param [String] project_id # Required. Deprecated. The Google Developers Console [project ID or project - # number](https://support.google.com/cloud/answer/6158840). - # This field has been deprecated and replaced by the name field. + # number](https://support.google.com/cloud/answer/6158840). This field has been + # deprecated and replaced by the name field. # @param [String] zone - # Required. Deprecated. The name of the Google Compute Engine - # [zone](https://cloud.google.com/compute/docs/zones#available) in which the - # cluster resides. This field has been deprecated and replaced by the name - # field. + # Required. Deprecated. The name of the Google Compute Engine [zone](https:// + # cloud.google.com/compute/docs/zones#available) in which the cluster resides. + # This field has been deprecated and replaced by the name field. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -1317,17 +1292,17 @@ module Google # Lists all operations in a project in the specified zone or all zones. # @param [String] parent # The parent (project and location) where the operations will be listed. - # Specified in the format `projects/*/locations/*`. - # Location "-" matches all zones and all regions. + # Specified in the format `projects/*/locations/*`. Location "-" matches all + # zones and all regions. # @param [String] project_id # Required. Deprecated. The Google Developers Console [project ID or project - # number](https://support.google.com/cloud/answer/6158840). - # This field has been deprecated and replaced by the parent field. + # number](https://support.google.com/cloud/answer/6158840). This field has been + # deprecated and replaced by the parent field. # @param [String] zone - # Required. Deprecated. The name of the Google Compute Engine - # [zone](https://cloud.google.com/compute/docs/zones#available) to return - # operations for, or `-` for all zones. This field has been deprecated and - # replaced by the parent field. + # Required. Deprecated. The name of the Google Compute Engine [zone](https:// + # cloud.google.com/compute/docs/zones#available) to return operations for, or `-` + # for all zones. This field has been deprecated and replaced by the parent + # field. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -1360,16 +1335,15 @@ module Google # Returns configuration info about the Google Kubernetes Engine service. # @param [String] project_id # Required. Deprecated. The Google Developers Console [project ID or project - # number](https://support.google.com/cloud/answer/6158840). - # This field has been deprecated and replaced by the name field. + # number](https://support.google.com/cloud/answer/6158840). This field has been + # deprecated and replaced by the name field. # @param [String] zone - # Required. Deprecated. The name of the Google Compute Engine - # [zone](https://cloud.google.com/compute/docs/zones#available) to return - # operations for. This field has been deprecated and replaced by the name - # field. + # Required. Deprecated. The name of the Google Compute Engine [zone](https:// + # cloud.google.com/compute/docs/zones#available) to return operations for. This + # field has been deprecated and replaced by the name field. # @param [String] name - # The name (project and location) of the server config to get, - # specified in the format `projects/*/locations/*`. + # The name (project and location) of the server config to get, specified in the + # format `projects/*/locations/*`. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -1402,16 +1376,15 @@ module Google # Sets the addons for a specific cluster. # @param [String] project_id # Required. Deprecated. The Google Developers Console [project ID or project - # number](https://support.google.com/cloud/answer/6158840). - # This field has been deprecated and replaced by the name field. + # number](https://support.google.com/cloud/answer/6158840). This field has been + # deprecated and replaced by the name field. # @param [String] zone - # Required. Deprecated. The name of the Google Compute Engine - # [zone](https://cloud.google.com/compute/docs/zones#available) in which the - # cluster resides. This field has been deprecated and replaced by the name - # field. - # @param [String] cluster_id - # Required. Deprecated. The name of the cluster to upgrade. + # Required. Deprecated. The name of the Google Compute Engine [zone](https:// + # cloud.google.com/compute/docs/zones#available) in which the cluster resides. # This field has been deprecated and replaced by the name field. + # @param [String] cluster_id + # Required. Deprecated. The name of the cluster to upgrade. This field has been + # deprecated and replaced by the name field. # @param [Google::Apis::ContainerV1beta1::SetAddonsConfigRequest] set_addons_config_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -1447,16 +1420,15 @@ module Google # Completes master IP rotation. # @param [String] project_id # Required. Deprecated. The Google Developers Console [project ID or project - # number](https://developers.google.com/console/help/new/#projectnumber). - # This field has been deprecated and replaced by the name field. + # number](https://developers.google.com/console/help/new/#projectnumber). This + # field has been deprecated and replaced by the name field. # @param [String] zone - # Required. Deprecated. The name of the Google Compute Engine - # [zone](https://cloud.google.com/compute/docs/zones#available) in which the - # cluster resides. This field has been deprecated and replaced by the name - # field. - # @param [String] cluster_id - # Required. Deprecated. The name of the cluster. + # Required. Deprecated. The name of the Google Compute Engine [zone](https:// + # cloud.google.com/compute/docs/zones#available) in which the cluster resides. # This field has been deprecated and replaced by the name field. + # @param [String] cluster_id + # Required. Deprecated. The name of the cluster. This field has been deprecated + # and replaced by the name field. # @param [Google::Apis::ContainerV1beta1::CompleteIpRotationRequest] complete_ip_rotation_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -1490,26 +1462,21 @@ module Google end # Creates a cluster, consisting of the specified number and type of Google - # Compute Engine instances. - # By default, the cluster is created in the project's - # [default - # network](https://cloud.google.com/compute/docs/networks-and-firewalls#networks) - # . - # One firewall is added for the cluster. After cluster creation, - # the Kubelet creates routes for each node to allow the containers - # on that node to communicate with all other instances in the - # cluster. - # Finally, an entry is added to the project's global metadata indicating - # which CIDR range the cluster is using. + # Compute Engine instances. By default, the cluster is created in the project's [ + # default network](https://cloud.google.com/compute/docs/networks-and-firewalls# + # networks). One firewall is added for the cluster. After cluster creation, the + # Kubelet creates routes for each node to allow the containers on that node to + # communicate with all other instances in the cluster. Finally, an entry is + # added to the project's global metadata indicating which CIDR range the cluster + # is using. # @param [String] project_id # Required. Deprecated. The Google Developers Console [project ID or project - # number](https://support.google.com/cloud/answer/6158840). - # This field has been deprecated and replaced by the parent field. + # number](https://support.google.com/cloud/answer/6158840). This field has been + # deprecated and replaced by the parent field. # @param [String] zone - # Required. Deprecated. The name of the Google Compute Engine - # [zone](https://cloud.google.com/compute/docs/zones#available) in which the - # cluster resides. This field has been deprecated and replaced by the parent - # field. + # Required. Deprecated. The name of the Google Compute Engine [zone](https:// + # cloud.google.com/compute/docs/zones#available) in which the cluster resides. + # This field has been deprecated and replaced by the parent field. # @param [Google::Apis::ContainerV1beta1::CreateClusterRequest] create_cluster_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -1541,28 +1508,25 @@ module Google execute_or_queue_command(command, &block) end - # Deletes the cluster, including the Kubernetes endpoint and all worker - # nodes. - # Firewalls and routes that were configured during cluster creation - # are also deleted. - # Other Google Compute Engine resources that might be in use by the cluster, - # such as load balancer resources, are not deleted if they weren't present - # when the cluster was initially created. + # Deletes the cluster, including the Kubernetes endpoint and all worker nodes. + # Firewalls and routes that were configured during cluster creation are also + # deleted. Other Google Compute Engine resources that might be in use by the + # cluster, such as load balancer resources, are not deleted if they weren't + # present when the cluster was initially created. # @param [String] project_id # Required. Deprecated. The Google Developers Console [project ID or project - # number](https://support.google.com/cloud/answer/6158840). - # This field has been deprecated and replaced by the name field. + # number](https://support.google.com/cloud/answer/6158840). This field has been + # deprecated and replaced by the name field. # @param [String] zone - # Required. Deprecated. The name of the Google Compute Engine - # [zone](https://cloud.google.com/compute/docs/zones#available) in which the - # cluster resides. This field has been deprecated and replaced by the name - # field. - # @param [String] cluster_id - # Required. Deprecated. The name of the cluster to delete. + # Required. Deprecated. The name of the Google Compute Engine [zone](https:// + # cloud.google.com/compute/docs/zones#available) in which the cluster resides. # This field has been deprecated and replaced by the name field. + # @param [String] cluster_id + # Required. Deprecated. The name of the cluster to delete. This field has been + # deprecated and replaced by the name field. # @param [String] name - # The name (project, location, cluster) of the cluster to delete. - # Specified in the format `projects/*/locations/*/clusters/*`. + # The name (project, location, cluster) of the cluster to delete. Specified in + # the format `projects/*/locations/*/clusters/*`. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -1596,19 +1560,18 @@ module Google # Gets the details for a specific cluster. # @param [String] project_id # Required. Deprecated. The Google Developers Console [project ID or project - # number](https://support.google.com/cloud/answer/6158840). - # This field has been deprecated and replaced by the name field. + # number](https://support.google.com/cloud/answer/6158840). This field has been + # deprecated and replaced by the name field. # @param [String] zone - # Required. Deprecated. The name of the Google Compute Engine - # [zone](https://cloud.google.com/compute/docs/zones#available) in which the - # cluster resides. This field has been deprecated and replaced by the name - # field. - # @param [String] cluster_id - # Required. Deprecated. The name of the cluster to retrieve. + # Required. Deprecated. The name of the Google Compute Engine [zone](https:// + # cloud.google.com/compute/docs/zones#available) in which the cluster resides. # This field has been deprecated and replaced by the name field. + # @param [String] cluster_id + # Required. Deprecated. The name of the cluster to retrieve. This field has been + # deprecated and replaced by the name field. # @param [String] name - # The name (project, location, cluster) of the cluster to retrieve. - # Specified in the format `projects/*/locations/*/clusters/*`. + # The name (project, location, cluster) of the cluster to retrieve. Specified in + # the format `projects/*/locations/*/clusters/*`. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -1642,16 +1605,15 @@ module Google # Enables or disables the ABAC authorization mechanism on a cluster. # @param [String] project_id # Required. Deprecated. The Google Developers Console [project ID or project - # number](https://support.google.com/cloud/answer/6158840). - # This field has been deprecated and replaced by the name field. + # number](https://support.google.com/cloud/answer/6158840). This field has been + # deprecated and replaced by the name field. # @param [String] zone - # Required. Deprecated. The name of the Google Compute Engine - # [zone](https://cloud.google.com/compute/docs/zones#available) in which the - # cluster resides. This field has been deprecated and replaced by the name - # field. - # @param [String] cluster_id - # Required. Deprecated. The name of the cluster to update. + # Required. Deprecated. The name of the Google Compute Engine [zone](https:// + # cloud.google.com/compute/docs/zones#available) in which the cluster resides. # This field has been deprecated and replaced by the name field. + # @param [String] cluster_id + # Required. Deprecated. The name of the cluster to update. This field has been + # deprecated and replaced by the name field. # @param [Google::Apis::ContainerV1beta1::SetLegacyAbacRequest] set_legacy_abac_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -1688,17 +1650,17 @@ module Google # zones. # @param [String] project_id # Required. Deprecated. The Google Developers Console [project ID or project - # number](https://support.google.com/cloud/answer/6158840). - # This field has been deprecated and replaced by the parent field. + # number](https://support.google.com/cloud/answer/6158840). This field has been + # deprecated and replaced by the parent field. # @param [String] zone - # Required. Deprecated. The name of the Google Compute Engine - # [zone](https://cloud.google.com/compute/docs/zones#available) in which the - # cluster resides, or "-" for all zones. This field has been deprecated and - # replaced by the parent field. + # Required. Deprecated. The name of the Google Compute Engine [zone](https:// + # cloud.google.com/compute/docs/zones#available) in which the cluster resides, + # or "-" for all zones. This field has been deprecated and replaced by the + # parent field. # @param [String] parent - # The parent (project and location) where the clusters will be listed. - # Specified in the format `projects/*/locations/*`. - # Location "-" matches all zones and all regions. + # The parent (project and location) where the clusters will be listed. Specified + # in the format `projects/*/locations/*`. Location "-" matches all zones and all + # regions. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -1728,23 +1690,20 @@ module Google execute_or_queue_command(command, &block) end - # Sets the locations for a specific cluster. - # Deprecated. Use - # [projects.locations.clusters.update](https://cloud.google.com/kubernetes- - # engine/docs/reference/rest/v1beta1/projects.locations.clusters/update) - # instead. + # Sets the locations for a specific cluster. Deprecated. Use [projects.locations. + # clusters.update](https://cloud.google.com/kubernetes-engine/docs/reference/ + # rest/v1beta1/projects.locations.clusters/update) instead. # @param [String] project_id # Required. Deprecated. The Google Developers Console [project ID or project - # number](https://support.google.com/cloud/answer/6158840). - # This field has been deprecated and replaced by the name field. + # number](https://support.google.com/cloud/answer/6158840). This field has been + # deprecated and replaced by the name field. # @param [String] zone - # Required. Deprecated. The name of the Google Compute Engine - # [zone](https://cloud.google.com/compute/docs/zones#available) in which the - # cluster resides. This field has been deprecated and replaced by the name - # field. - # @param [String] cluster_id - # Required. Deprecated. The name of the cluster to upgrade. + # Required. Deprecated. The name of the Google Compute Engine [zone](https:// + # cloud.google.com/compute/docs/zones#available) in which the cluster resides. # This field has been deprecated and replaced by the name field. + # @param [String] cluster_id + # Required. Deprecated. The name of the cluster to upgrade. This field has been + # deprecated and replaced by the name field. # @param [Google::Apis::ContainerV1beta1::SetLocationsRequest] set_locations_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -1780,16 +1739,15 @@ module Google # Sets the logging service for a specific cluster. # @param [String] project_id # Required. Deprecated. The Google Developers Console [project ID or project - # number](https://support.google.com/cloud/answer/6158840). - # This field has been deprecated and replaced by the name field. + # number](https://support.google.com/cloud/answer/6158840). This field has been + # deprecated and replaced by the name field. # @param [String] zone - # Required. Deprecated. The name of the Google Compute Engine - # [zone](https://cloud.google.com/compute/docs/zones#available) in which the - # cluster resides. This field has been deprecated and replaced by the name - # field. - # @param [String] cluster_id - # Required. Deprecated. The name of the cluster to upgrade. + # Required. Deprecated. The name of the Google Compute Engine [zone](https:// + # cloud.google.com/compute/docs/zones#available) in which the cluster resides. # This field has been deprecated and replaced by the name field. + # @param [String] cluster_id + # Required. Deprecated. The name of the cluster to upgrade. This field has been + # deprecated and replaced by the name field. # @param [Google::Apis::ContainerV1beta1::SetLoggingServiceRequest] set_logging_service_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -1825,16 +1783,15 @@ module Google # Updates the master for a specific cluster. # @param [String] project_id # Required. Deprecated. The Google Developers Console [project ID or project - # number](https://support.google.com/cloud/answer/6158840). - # This field has been deprecated and replaced by the name field. + # number](https://support.google.com/cloud/answer/6158840). This field has been + # deprecated and replaced by the name field. # @param [String] zone - # Required. Deprecated. The name of the Google Compute Engine - # [zone](https://cloud.google.com/compute/docs/zones#available) in which the - # cluster resides. This field has been deprecated and replaced by the name - # field. - # @param [String] cluster_id - # Required. Deprecated. The name of the cluster to upgrade. + # Required. Deprecated. The name of the Google Compute Engine [zone](https:// + # cloud.google.com/compute/docs/zones#available) in which the cluster resides. # This field has been deprecated and replaced by the name field. + # @param [String] cluster_id + # Required. Deprecated. The name of the cluster to upgrade. This field has been + # deprecated and replaced by the name field. # @param [Google::Apis::ContainerV1beta1::UpdateMasterRequest] update_master_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -1870,16 +1827,15 @@ module Google # Sets the monitoring service for a specific cluster. # @param [String] project_id # Required. Deprecated. The Google Developers Console [project ID or project - # number](https://support.google.com/cloud/answer/6158840). - # This field has been deprecated and replaced by the name field. + # number](https://support.google.com/cloud/answer/6158840). This field has been + # deprecated and replaced by the name field. # @param [String] zone - # Required. Deprecated. The name of the Google Compute Engine - # [zone](https://cloud.google.com/compute/docs/zones#available) in which the - # cluster resides. This field has been deprecated and replaced by the name - # field. - # @param [String] cluster_id - # Required. Deprecated. The name of the cluster to upgrade. + # Required. Deprecated. The name of the Google Compute Engine [zone](https:// + # cloud.google.com/compute/docs/zones#available) in which the cluster resides. # This field has been deprecated and replaced by the name field. + # @param [String] cluster_id + # Required. Deprecated. The name of the cluster to upgrade. This field has been + # deprecated and replaced by the name field. # @param [Google::Apis::ContainerV1beta1::SetMonitoringServiceRequest] set_monitoring_service_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -1915,16 +1871,15 @@ module Google # Sets labels on a cluster. # @param [String] project_id # Required. Deprecated. The Google Developers Console [project ID or project - # number](https://developers.google.com/console/help/new/#projectnumber). - # This field has been deprecated and replaced by the name field. + # number](https://developers.google.com/console/help/new/#projectnumber). This + # field has been deprecated and replaced by the name field. # @param [String] zone - # Required. Deprecated. The name of the Google Compute Engine - # [zone](https://cloud.google.com/compute/docs/zones#available) in which the - # cluster resides. This field has been deprecated and replaced by the name - # field. - # @param [String] cluster_id - # Required. Deprecated. The name of the cluster. + # Required. Deprecated. The name of the Google Compute Engine [zone](https:// + # cloud.google.com/compute/docs/zones#available) in which the cluster resides. # This field has been deprecated and replaced by the name field. + # @param [String] cluster_id + # Required. Deprecated. The name of the cluster. This field has been deprecated + # and replaced by the name field. # @param [Google::Apis::ContainerV1beta1::SetLabelsRequest] set_labels_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -1959,12 +1914,11 @@ module Google # Sets the maintenance policy for a cluster. # @param [String] project_id - # Required. The Google Developers Console [project ID or project - # number](https://support.google.com/cloud/answer/6158840). + # Required. The Google Developers Console [project ID or project number](https:// + # support.google.com/cloud/answer/6158840). # @param [String] zone - # Required. The name of the Google Compute Engine - # [zone](https://cloud.google.com/compute/docs/zones#available) in which the - # cluster resides. + # Required. The name of the Google Compute Engine [zone](https://cloud.google. + # com/compute/docs/zones#available) in which the cluster resides. # @param [String] cluster_id # Required. The name of the cluster to update. # @param [Google::Apis::ContainerV1beta1::SetMaintenancePolicyRequest] set_maintenance_policy_request_object @@ -1999,21 +1953,20 @@ module Google execute_or_queue_command(command, &block) end - # Sets master auth materials. Currently supports changing the admin password - # or a specific cluster, either via password generation or explicitly setting - # the password. + # Sets master auth materials. Currently supports changing the admin password or + # a specific cluster, either via password generation or explicitly setting the + # password. # @param [String] project_id # Required. Deprecated. The Google Developers Console [project ID or project - # number](https://support.google.com/cloud/answer/6158840). - # This field has been deprecated and replaced by the name field. + # number](https://support.google.com/cloud/answer/6158840). This field has been + # deprecated and replaced by the name field. # @param [String] zone - # Required. Deprecated. The name of the Google Compute Engine - # [zone](https://cloud.google.com/compute/docs/zones#available) in which the - # cluster resides. This field has been deprecated and replaced by the name - # field. - # @param [String] cluster_id - # Required. Deprecated. The name of the cluster to upgrade. + # Required. Deprecated. The name of the Google Compute Engine [zone](https:// + # cloud.google.com/compute/docs/zones#available) in which the cluster resides. # This field has been deprecated and replaced by the name field. + # @param [String] cluster_id + # Required. Deprecated. The name of the cluster to upgrade. This field has been + # deprecated and replaced by the name field. # @param [Google::Apis::ContainerV1beta1::SetMasterAuthRequest] set_master_auth_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -2049,16 +2002,15 @@ module Google # Enables or disables Network Policy for a cluster. # @param [String] project_id # Required. Deprecated. The Google Developers Console [project ID or project - # number](https://developers.google.com/console/help/new/#projectnumber). - # This field has been deprecated and replaced by the name field. + # number](https://developers.google.com/console/help/new/#projectnumber). This + # field has been deprecated and replaced by the name field. # @param [String] zone - # Required. Deprecated. The name of the Google Compute Engine - # [zone](https://cloud.google.com/compute/docs/zones#available) in which the - # cluster resides. This field has been deprecated and replaced by the name - # field. - # @param [String] cluster_id - # Required. Deprecated. The name of the cluster. + # Required. Deprecated. The name of the Google Compute Engine [zone](https:// + # cloud.google.com/compute/docs/zones#available) in which the cluster resides. # This field has been deprecated and replaced by the name field. + # @param [String] cluster_id + # Required. Deprecated. The name of the cluster. This field has been deprecated + # and replaced by the name field. # @param [Google::Apis::ContainerV1beta1::SetNetworkPolicyRequest] set_network_policy_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -2094,16 +2046,15 @@ module Google # Starts master IP rotation. # @param [String] project_id # Required. Deprecated. The Google Developers Console [project ID or project - # number](https://developers.google.com/console/help/new/#projectnumber). - # This field has been deprecated and replaced by the name field. + # number](https://developers.google.com/console/help/new/#projectnumber). This + # field has been deprecated and replaced by the name field. # @param [String] zone - # Required. Deprecated. The name of the Google Compute Engine - # [zone](https://cloud.google.com/compute/docs/zones#available) in which the - # cluster resides. This field has been deprecated and replaced by the name - # field. - # @param [String] cluster_id - # Required. Deprecated. The name of the cluster. + # Required. Deprecated. The name of the Google Compute Engine [zone](https:// + # cloud.google.com/compute/docs/zones#available) in which the cluster resides. # This field has been deprecated and replaced by the name field. + # @param [String] cluster_id + # Required. Deprecated. The name of the cluster. This field has been deprecated + # and replaced by the name field. # @param [Google::Apis::ContainerV1beta1::StartIpRotationRequest] start_ip_rotation_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -2139,16 +2090,15 @@ module Google # Updates the settings for a specific cluster. # @param [String] project_id # Required. Deprecated. The Google Developers Console [project ID or project - # number](https://support.google.com/cloud/answer/6158840). - # This field has been deprecated and replaced by the name field. + # number](https://support.google.com/cloud/answer/6158840). This field has been + # deprecated and replaced by the name field. # @param [String] zone - # Required. Deprecated. The name of the Google Compute Engine - # [zone](https://cloud.google.com/compute/docs/zones#available) in which the - # cluster resides. This field has been deprecated and replaced by the name - # field. - # @param [String] cluster_id - # Required. Deprecated. The name of the cluster to upgrade. + # Required. Deprecated. The name of the Google Compute Engine [zone](https:// + # cloud.google.com/compute/docs/zones#available) in which the cluster resides. # This field has been deprecated and replaced by the name field. + # @param [String] cluster_id + # Required. Deprecated. The name of the cluster to upgrade. This field has been + # deprecated and replaced by the name field. # @param [Google::Apis::ContainerV1beta1::UpdateClusterRequest] update_cluster_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -2184,19 +2134,18 @@ module Google # Sets the autoscaling settings of a specific node pool. # @param [String] project_id # Required. Deprecated. The Google Developers Console [project ID or project - # number](https://support.google.com/cloud/answer/6158840). - # This field has been deprecated and replaced by the name field. + # number](https://support.google.com/cloud/answer/6158840). This field has been + # deprecated and replaced by the name field. # @param [String] zone - # Required. Deprecated. The name of the Google Compute Engine - # [zone](https://cloud.google.com/compute/docs/zones#available) in which the - # cluster resides. This field has been deprecated and replaced by the name - # field. + # Required. Deprecated. The name of the Google Compute Engine [zone](https:// + # cloud.google.com/compute/docs/zones#available) in which the cluster resides. + # This field has been deprecated and replaced by the name field. # @param [String] cluster_id - # Required. Deprecated. The name of the cluster to upgrade. - # This field has been deprecated and replaced by the name field. + # Required. Deprecated. The name of the cluster to upgrade. This field has been + # deprecated and replaced by the name field. # @param [String] node_pool_id - # Required. Deprecated. The name of the node pool to upgrade. - # This field has been deprecated and replaced by the name field. + # Required. Deprecated. The name of the node pool to upgrade. This field has + # been deprecated and replaced by the name field. # @param [Google::Apis::ContainerV1beta1::SetNodePoolAutoscalingRequest] set_node_pool_autoscaling_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -2233,16 +2182,15 @@ module Google # Creates a node pool for a cluster. # @param [String] project_id # Required. Deprecated. The Google Developers Console [project ID or project - # number](https://developers.google.com/console/help/new/#projectnumber). - # This field has been deprecated and replaced by the parent field. + # number](https://developers.google.com/console/help/new/#projectnumber). This + # field has been deprecated and replaced by the parent field. # @param [String] zone - # Required. Deprecated. The name of the Google Compute Engine - # [zone](https://cloud.google.com/compute/docs/zones#available) in which the - # cluster resides. This field has been deprecated and replaced by the parent - # field. - # @param [String] cluster_id - # Required. Deprecated. The name of the cluster. + # Required. Deprecated. The name of the Google Compute Engine [zone](https:// + # cloud.google.com/compute/docs/zones#available) in which the cluster resides. # This field has been deprecated and replaced by the parent field. + # @param [String] cluster_id + # Required. Deprecated. The name of the cluster. This field has been deprecated + # and replaced by the parent field. # @param [Google::Apis::ContainerV1beta1::CreateNodePoolRequest] create_node_pool_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -2278,23 +2226,21 @@ module Google # Deletes a node pool from a cluster. # @param [String] project_id # Required. Deprecated. The Google Developers Console [project ID or project - # number](https://developers.google.com/console/help/new/#projectnumber). - # This field has been deprecated and replaced by the name field. + # number](https://developers.google.com/console/help/new/#projectnumber). This + # field has been deprecated and replaced by the name field. # @param [String] zone - # Required. Deprecated. The name of the Google Compute Engine - # [zone](https://cloud.google.com/compute/docs/zones#available) in which the - # cluster resides. This field has been deprecated and replaced by the name - # field. + # Required. Deprecated. The name of the Google Compute Engine [zone](https:// + # cloud.google.com/compute/docs/zones#available) in which the cluster resides. + # This field has been deprecated and replaced by the name field. # @param [String] cluster_id - # Required. Deprecated. The name of the cluster. - # This field has been deprecated and replaced by the name field. + # Required. Deprecated. The name of the cluster. This field has been deprecated + # and replaced by the name field. # @param [String] node_pool_id - # Required. Deprecated. The name of the node pool to delete. - # This field has been deprecated and replaced by the name field. + # Required. Deprecated. The name of the node pool to delete. This field has been + # deprecated and replaced by the name field. # @param [String] name - # The name (project, location, cluster, node pool id) of the node pool to - # delete. Specified in the format - # `projects/*/locations/*/clusters/*/nodePools/*`. + # The name (project, location, cluster, node pool id) of the node pool to delete. + # Specified in the format `projects/*/locations/*/clusters/*/nodePools/*`. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -2329,23 +2275,21 @@ module Google # Retrieves the requested node pool. # @param [String] project_id # Required. Deprecated. The Google Developers Console [project ID or project - # number](https://developers.google.com/console/help/new/#projectnumber). - # This field has been deprecated and replaced by the name field. + # number](https://developers.google.com/console/help/new/#projectnumber). This + # field has been deprecated and replaced by the name field. # @param [String] zone - # Required. Deprecated. The name of the Google Compute Engine - # [zone](https://cloud.google.com/compute/docs/zones#available) in which the - # cluster resides. This field has been deprecated and replaced by the name - # field. + # Required. Deprecated. The name of the Google Compute Engine [zone](https:// + # cloud.google.com/compute/docs/zones#available) in which the cluster resides. + # This field has been deprecated and replaced by the name field. # @param [String] cluster_id - # Required. Deprecated. The name of the cluster. - # This field has been deprecated and replaced by the name field. + # Required. Deprecated. The name of the cluster. This field has been deprecated + # and replaced by the name field. # @param [String] node_pool_id - # Required. Deprecated. The name of the node pool. - # This field has been deprecated and replaced by the name field. + # Required. Deprecated. The name of the node pool. This field has been + # deprecated and replaced by the name field. # @param [String] name - # The name (project, location, cluster, node pool id) of the node pool to - # get. Specified in the format - # `projects/*/locations/*/clusters/*/nodePools/*`. + # The name (project, location, cluster, node pool id) of the node pool to get. + # Specified in the format `projects/*/locations/*/clusters/*/nodePools/*`. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -2380,19 +2324,18 @@ module Google # Lists the node pools for a cluster. # @param [String] project_id # Required. Deprecated. The Google Developers Console [project ID or project - # number](https://developers.google.com/console/help/new/#projectnumber). - # This field has been deprecated and replaced by the parent field. + # number](https://developers.google.com/console/help/new/#projectnumber). This + # field has been deprecated and replaced by the parent field. # @param [String] zone - # Required. Deprecated. The name of the Google Compute Engine - # [zone](https://cloud.google.com/compute/docs/zones#available) in which the - # cluster resides. This field has been deprecated and replaced by the parent - # field. - # @param [String] cluster_id - # Required. Deprecated. The name of the cluster. + # Required. Deprecated. The name of the Google Compute Engine [zone](https:// + # cloud.google.com/compute/docs/zones#available) in which the cluster resides. # This field has been deprecated and replaced by the parent field. + # @param [String] cluster_id + # Required. Deprecated. The name of the cluster. This field has been deprecated + # and replaced by the parent field. # @param [String] parent - # The parent (project, location, cluster id) where the node pools will be - # listed. Specified in the format `projects/*/locations/*/clusters/*`. + # The parent (project, location, cluster id) where the node pools will be listed. + # Specified in the format `projects/*/locations/*/clusters/*`. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -2423,23 +2366,22 @@ module Google execute_or_queue_command(command, &block) end - # Rolls back a previously Aborted or Failed NodePool upgrade. - # This makes no changes if the last upgrade successfully completed. + # Rolls back a previously Aborted or Failed NodePool upgrade. This makes no + # changes if the last upgrade successfully completed. # @param [String] project_id # Required. Deprecated. The Google Developers Console [project ID or project - # number](https://support.google.com/cloud/answer/6158840). - # This field has been deprecated and replaced by the name field. + # number](https://support.google.com/cloud/answer/6158840). This field has been + # deprecated and replaced by the name field. # @param [String] zone - # Required. Deprecated. The name of the Google Compute Engine - # [zone](https://cloud.google.com/compute/docs/zones#available) in which the - # cluster resides. This field has been deprecated and replaced by the name - # field. + # Required. Deprecated. The name of the Google Compute Engine [zone](https:// + # cloud.google.com/compute/docs/zones#available) in which the cluster resides. + # This field has been deprecated and replaced by the name field. # @param [String] cluster_id - # Required. Deprecated. The name of the cluster to rollback. - # This field has been deprecated and replaced by the name field. + # Required. Deprecated. The name of the cluster to rollback. This field has been + # deprecated and replaced by the name field. # @param [String] node_pool_id - # Required. Deprecated. The name of the node pool to rollback. - # This field has been deprecated and replaced by the name field. + # Required. Deprecated. The name of the node pool to rollback. This field has + # been deprecated and replaced by the name field. # @param [Google::Apis::ContainerV1beta1::RollbackNodePoolUpgradeRequest] rollback_node_pool_upgrade_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -2476,19 +2418,18 @@ module Google # Sets the NodeManagement options for a node pool. # @param [String] project_id # Required. Deprecated. The Google Developers Console [project ID or project - # number](https://support.google.com/cloud/answer/6158840). - # This field has been deprecated and replaced by the name field. + # number](https://support.google.com/cloud/answer/6158840). This field has been + # deprecated and replaced by the name field. # @param [String] zone - # Required. Deprecated. The name of the Google Compute Engine - # [zone](https://cloud.google.com/compute/docs/zones#available) in which the - # cluster resides. This field has been deprecated and replaced by the name - # field. + # Required. Deprecated. The name of the Google Compute Engine [zone](https:// + # cloud.google.com/compute/docs/zones#available) in which the cluster resides. + # This field has been deprecated and replaced by the name field. # @param [String] cluster_id - # Required. Deprecated. The name of the cluster to update. - # This field has been deprecated and replaced by the name field. + # Required. Deprecated. The name of the cluster to update. This field has been + # deprecated and replaced by the name field. # @param [String] node_pool_id - # Required. Deprecated. The name of the node pool to update. - # This field has been deprecated and replaced by the name field. + # Required. Deprecated. The name of the node pool to update. This field has been + # deprecated and replaced by the name field. # @param [Google::Apis::ContainerV1beta1::SetNodePoolManagementRequest] set_node_pool_management_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -2525,19 +2466,18 @@ module Google # Sets the size for a specific node pool. # @param [String] project_id # Required. Deprecated. The Google Developers Console [project ID or project - # number](https://support.google.com/cloud/answer/6158840). - # This field has been deprecated and replaced by the name field. + # number](https://support.google.com/cloud/answer/6158840). This field has been + # deprecated and replaced by the name field. # @param [String] zone - # Required. Deprecated. The name of the Google Compute Engine - # [zone](https://cloud.google.com/compute/docs/zones#available) in which the - # cluster resides. This field has been deprecated and replaced by the name - # field. + # Required. Deprecated. The name of the Google Compute Engine [zone](https:// + # cloud.google.com/compute/docs/zones#available) in which the cluster resides. + # This field has been deprecated and replaced by the name field. # @param [String] cluster_id - # Required. Deprecated. The name of the cluster to update. - # This field has been deprecated and replaced by the name field. + # Required. Deprecated. The name of the cluster to update. This field has been + # deprecated and replaced by the name field. # @param [String] node_pool_id - # Required. Deprecated. The name of the node pool to update. - # This field has been deprecated and replaced by the name field. + # Required. Deprecated. The name of the node pool to update. This field has been + # deprecated and replaced by the name field. # @param [Google::Apis::ContainerV1beta1::SetNodePoolSizeRequest] set_node_pool_size_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -2574,19 +2514,18 @@ module Google # Updates the version and/or image type of a specific node pool. # @param [String] project_id # Required. Deprecated. The Google Developers Console [project ID or project - # number](https://support.google.com/cloud/answer/6158840). - # This field has been deprecated and replaced by the name field. + # number](https://support.google.com/cloud/answer/6158840). This field has been + # deprecated and replaced by the name field. # @param [String] zone - # Required. Deprecated. The name of the Google Compute Engine - # [zone](https://cloud.google.com/compute/docs/zones#available) in which the - # cluster resides. This field has been deprecated and replaced by the name - # field. + # Required. Deprecated. The name of the Google Compute Engine [zone](https:// + # cloud.google.com/compute/docs/zones#available) in which the cluster resides. + # This field has been deprecated and replaced by the name field. # @param [String] cluster_id - # Required. Deprecated. The name of the cluster to upgrade. - # This field has been deprecated and replaced by the name field. + # Required. Deprecated. The name of the cluster to upgrade. This field has been + # deprecated and replaced by the name field. # @param [String] node_pool_id - # Required. Deprecated. The name of the node pool to upgrade. - # This field has been deprecated and replaced by the name field. + # Required. Deprecated. The name of the node pool to upgrade. This field has + # been deprecated and replaced by the name field. # @param [Google::Apis::ContainerV1beta1::UpdateNodePoolRequest] update_node_pool_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -2623,16 +2562,15 @@ module Google # Cancels the specified operation. # @param [String] project_id # Required. Deprecated. The Google Developers Console [project ID or project - # number](https://support.google.com/cloud/answer/6158840). - # This field has been deprecated and replaced by the name field. + # number](https://support.google.com/cloud/answer/6158840). This field has been + # deprecated and replaced by the name field. # @param [String] zone - # Required. Deprecated. The name of the Google Compute Engine - # [zone](https://cloud.google.com/compute/docs/zones#available) in which the - # operation resides. This field has been deprecated and replaced by the name - # field. - # @param [String] operation_id - # Required. Deprecated. The server-assigned `name` of the operation. + # Required. Deprecated. The name of the Google Compute Engine [zone](https:// + # cloud.google.com/compute/docs/zones#available) in which the operation resides. # This field has been deprecated and replaced by the name field. + # @param [String] operation_id + # Required. Deprecated. The server-assigned `name` of the operation. This field + # has been deprecated and replaced by the name field. # @param [Google::Apis::ContainerV1beta1::CancelOperationRequest] cancel_operation_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -2668,19 +2606,18 @@ module Google # Gets the specified operation. # @param [String] project_id # Required. Deprecated. The Google Developers Console [project ID or project - # number](https://support.google.com/cloud/answer/6158840). - # This field has been deprecated and replaced by the name field. + # number](https://support.google.com/cloud/answer/6158840). This field has been + # deprecated and replaced by the name field. # @param [String] zone - # Required. Deprecated. The name of the Google Compute Engine - # [zone](https://cloud.google.com/compute/docs/zones#available) in which the - # cluster resides. This field has been deprecated and replaced by the name - # field. - # @param [String] operation_id - # Required. Deprecated. The server-assigned `name` of the operation. + # Required. Deprecated. The name of the Google Compute Engine [zone](https:// + # cloud.google.com/compute/docs/zones#available) in which the cluster resides. # This field has been deprecated and replaced by the name field. + # @param [String] operation_id + # Required. Deprecated. The server-assigned `name` of the operation. This field + # has been deprecated and replaced by the name field. # @param [String] name - # The name (project, location, operation id) of the operation to get. - # Specified in the format `projects/*/locations/*/operations/*`. + # The name (project, location, operation id) of the operation to get. Specified + # in the format `projects/*/locations/*/operations/*`. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -2714,17 +2651,17 @@ module Google # Lists all operations in a project in the specified zone or all zones. # @param [String] project_id # Required. Deprecated. The Google Developers Console [project ID or project - # number](https://support.google.com/cloud/answer/6158840). - # This field has been deprecated and replaced by the parent field. + # number](https://support.google.com/cloud/answer/6158840). This field has been + # deprecated and replaced by the parent field. # @param [String] zone - # Required. Deprecated. The name of the Google Compute Engine - # [zone](https://cloud.google.com/compute/docs/zones#available) to return - # operations for, or `-` for all zones. This field has been deprecated and - # replaced by the parent field. + # Required. Deprecated. The name of the Google Compute Engine [zone](https:// + # cloud.google.com/compute/docs/zones#available) to return operations for, or `-` + # for all zones. This field has been deprecated and replaced by the parent + # field. # @param [String] parent # The parent (project and location) where the operations will be listed. - # Specified in the format `projects/*/locations/*`. - # Location "-" matches all zones and all regions. + # Specified in the format `projects/*/locations/*`. Location "-" matches all + # zones and all regions. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user diff --git a/generated/google/apis/dns_v2beta1.rb b/generated/google/apis/dns_v2beta1.rb deleted file mode 100644 index b55fdb58a..000000000 --- a/generated/google/apis/dns_v2beta1.rb +++ /dev/null @@ -1,43 +0,0 @@ -# Copyright 2015 Google Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - -require 'google/apis/dns_v2beta1/service.rb' -require 'google/apis/dns_v2beta1/classes.rb' -require 'google/apis/dns_v2beta1/representations.rb' - -module Google - module Apis - # Cloud DNS API - # - # - # - # @see http://developers.google.com/cloud-dns - module DnsV2beta1 - VERSION = 'V2beta1' - REVISION = '20200806' - - # View and manage your data across Google Cloud Platform services - AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' - - # View your data across Google Cloud Platform services - AUTH_CLOUD_PLATFORM_READ_ONLY = 'https://www.googleapis.com/auth/cloud-platform.read-only' - - # View your DNS records hosted by Google Cloud DNS - AUTH_NDEV_CLOUDDNS_READONLY = 'https://www.googleapis.com/auth/ndev.clouddns.readonly' - - # View and manage your DNS records hosted by Google Cloud DNS - AUTH_NDEV_CLOUDDNS_READWRITE = 'https://www.googleapis.com/auth/ndev.clouddns.readwrite' - end - end -end diff --git a/generated/google/apis/dns_v2beta1/classes.rb b/generated/google/apis/dns_v2beta1/classes.rb deleted file mode 100644 index 868304b28..000000000 --- a/generated/google/apis/dns_v2beta1/classes.rb +++ /dev/null @@ -1,1424 +0,0 @@ -# Copyright 2015 Google Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - -require 'date' -require 'google/apis/core/base_service' -require 'google/apis/core/json_representation' -require 'google/apis/core/hashable' -require 'google/apis/errors' - -module Google - module Apis - module DnsV2beta1 - - # A Change represents a set of ResourceRecordSet additions and deletions applied - # atomically to a ManagedZone. ResourceRecordSets within a ManagedZone are - # modified by creating a new Change element in the Changes collection. In turn - # the Changes collection also records the past modifications to the - # ResourceRecordSets in a ManagedZone. The current state of the ManagedZone is - # the sum effect of applying all Change elements in the Changes collection in - # sequence. - class Change - include Google::Apis::Core::Hashable - - # Which ResourceRecordSets to add? - # Corresponds to the JSON property `additions` - # @return [Array] - attr_accessor :additions - - # Which ResourceRecordSets to remove? Must match existing data exactly. - # Corresponds to the JSON property `deletions` - # @return [Array] - attr_accessor :deletions - - # Unique identifier for the resource; defined by the server (output only). - # Corresponds to the JSON property `id` - # @return [String] - attr_accessor :id - - # If the DNS queries for the zone will be served. - # Corresponds to the JSON property `isServing` - # @return [Boolean] - attr_accessor :is_serving - alias_method :is_serving?, :is_serving - - # - # Corresponds to the JSON property `kind` - # @return [String] - attr_accessor :kind - - # The time that this operation was started by the server (output only). This is - # in RFC3339 text format. - # Corresponds to the JSON property `startTime` - # @return [String] - attr_accessor :start_time - - # Status of the operation (output only). A status of "done" means that the - # request to update the authoritative servers has been sent but the servers - # might not be updated yet. - # Corresponds to the JSON property `status` - # @return [String] - attr_accessor :status - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @additions = args[:additions] if args.key?(:additions) - @deletions = args[:deletions] if args.key?(:deletions) - @id = args[:id] if args.key?(:id) - @is_serving = args[:is_serving] if args.key?(:is_serving) - @kind = args[:kind] if args.key?(:kind) - @start_time = args[:start_time] if args.key?(:start_time) - @status = args[:status] if args.key?(:status) - end - end - - # The response to a request to enumerate Changes to a ResourceRecordSets - # collection. - class ChangesListResponse - include Google::Apis::Core::Hashable - - # The requested changes. - # Corresponds to the JSON property `changes` - # @return [Array] - attr_accessor :changes - - # Elements common to every response. - # Corresponds to the JSON property `header` - # @return [Google::Apis::DnsV2beta1::ResponseHeader] - attr_accessor :header - - # Type of resource. - # Corresponds to the JSON property `kind` - # @return [String] - attr_accessor :kind - - # The presence of this field indicates that there exist more results following - # your last page of results in pagination order. To fetch them, make another - # list request using this value as your pagination token. In this way you can - # retrieve the complete contents of even very large collections one page at a - # time. However, if the contents of the collection change between the first and - # last paginated list request, the set of all elements returned will be an - # inconsistent view of the collection. There is no way to retrieve a "snapshot" - # of collections larger than the maximum page size. - # Corresponds to the JSON property `nextPageToken` - # @return [String] - attr_accessor :next_page_token - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @changes = args[:changes] if args.key?(:changes) - @header = args[:header] if args.key?(:header) - @kind = args[:kind] if args.key?(:kind) - @next_page_token = args[:next_page_token] if args.key?(:next_page_token) - end - end - - # A DNSSEC key pair. - class DnsKey - include Google::Apis::Core::Hashable - - # String mnemonic specifying the DNSSEC algorithm of this key. Immutable after - # creation time. - # Corresponds to the JSON property `algorithm` - # @return [String] - attr_accessor :algorithm - - # The time that this resource was created in the control plane. This is in - # RFC3339 text format. Output only. - # Corresponds to the JSON property `creationTime` - # @return [String] - attr_accessor :creation_time - - # A mutable string of at most 1024 characters associated with this resource for - # the user's convenience. Has no effect on the resource's function. - # Corresponds to the JSON property `description` - # @return [String] - attr_accessor :description - - # Cryptographic hashes of the DNSKEY resource record associated with this DnsKey. - # These digests are needed to construct a DS record that points at this DNS key. - # Output only. - # Corresponds to the JSON property `digests` - # @return [Array] - attr_accessor :digests - - # Unique identifier for the resource; defined by the server (output only). - # Corresponds to the JSON property `id` - # @return [String] - attr_accessor :id - - # Active keys will be used to sign subsequent changes to the ManagedZone. - # Inactive keys will still be present as DNSKEY Resource Records for the use of - # resolvers validating existing signatures. - # Corresponds to the JSON property `isActive` - # @return [Boolean] - attr_accessor :is_active - alias_method :is_active?, :is_active - - # Length of the key in bits. Specified at creation time then immutable. - # Corresponds to the JSON property `keyLength` - # @return [Fixnum] - attr_accessor :key_length - - # The key tag is a non-cryptographic hash of the a DNSKEY resource record - # associated with this DnsKey. The key tag can be used to identify a DNSKEY more - # quickly (but it is not a unique identifier). In particular, the key tag is - # used in a parent zone's DS record to point at the DNSKEY in this child - # ManagedZone. The key tag is a number in the range [0, 65535] and the algorithm - # to calculate it is specified in RFC4034 Appendix B. Output only. - # Corresponds to the JSON property `keyTag` - # @return [Fixnum] - attr_accessor :key_tag - - # - # Corresponds to the JSON property `kind` - # @return [String] - attr_accessor :kind - - # Base64 encoded public half of this key. Output only. - # Corresponds to the JSON property `publicKey` - # @return [String] - attr_accessor :public_key - - # One of "KEY_SIGNING" or "ZONE_SIGNING". Keys of type KEY_SIGNING have the - # Secure Entry Point flag set and, when active, will be used to sign only - # resource record sets of type DNSKEY. Otherwise, the Secure Entry Point flag - # will be cleared and this key will be used to sign only resource record sets of - # other types. Immutable after creation time. - # Corresponds to the JSON property `type` - # @return [String] - attr_accessor :type - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @algorithm = args[:algorithm] if args.key?(:algorithm) - @creation_time = args[:creation_time] if args.key?(:creation_time) - @description = args[:description] if args.key?(:description) - @digests = args[:digests] if args.key?(:digests) - @id = args[:id] if args.key?(:id) - @is_active = args[:is_active] if args.key?(:is_active) - @key_length = args[:key_length] if args.key?(:key_length) - @key_tag = args[:key_tag] if args.key?(:key_tag) - @kind = args[:kind] if args.key?(:kind) - @public_key = args[:public_key] if args.key?(:public_key) - @type = args[:type] if args.key?(:type) - end - end - - # - class DnsKeyDigest - include Google::Apis::Core::Hashable - - # The base-16 encoded bytes of this digest. Suitable for use in a DS resource - # record. - # Corresponds to the JSON property `digest` - # @return [String] - attr_accessor :digest - - # Specifies the algorithm used to calculate this digest. - # Corresponds to the JSON property `type` - # @return [String] - attr_accessor :type - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @digest = args[:digest] if args.key?(:digest) - @type = args[:type] if args.key?(:type) - end - end - - # Parameters for DnsKey key generation. Used for generating initial keys for a - # new ManagedZone and as default when adding a new DnsKey. - class DnsKeySpec - include Google::Apis::Core::Hashable - - # String mnemonic specifying the DNSSEC algorithm of this key. - # Corresponds to the JSON property `algorithm` - # @return [String] - attr_accessor :algorithm - - # Length of the keys in bits. - # Corresponds to the JSON property `keyLength` - # @return [Fixnum] - attr_accessor :key_length - - # Specifies whether this is a key signing key (KSK) or a zone signing key (ZSK). - # Key signing keys have the Secure Entry Point flag set and, when active, will - # only be used to sign resource record sets of type DNSKEY. Zone signing keys do - # not have the Secure Entry Point flag set and will be used to sign all other - # types of resource record sets. - # Corresponds to the JSON property `keyType` - # @return [String] - attr_accessor :key_type - - # - # Corresponds to the JSON property `kind` - # @return [String] - attr_accessor :kind - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @algorithm = args[:algorithm] if args.key?(:algorithm) - @key_length = args[:key_length] if args.key?(:key_length) - @key_type = args[:key_type] if args.key?(:key_type) - @kind = args[:kind] if args.key?(:kind) - end - end - - # The response to a request to enumerate DnsKeys in a ManagedZone. - class DnsKeysListResponse - include Google::Apis::Core::Hashable - - # The requested resources. - # Corresponds to the JSON property `dnsKeys` - # @return [Array] - attr_accessor :dns_keys - - # Elements common to every response. - # Corresponds to the JSON property `header` - # @return [Google::Apis::DnsV2beta1::ResponseHeader] - attr_accessor :header - - # Type of resource. - # Corresponds to the JSON property `kind` - # @return [String] - attr_accessor :kind - - # The presence of this field indicates that there exist more results following - # your last page of results in pagination order. To fetch them, make another - # list request using this value as your pagination token. In this way you can - # retrieve the complete contents of even very large collections one page at a - # time. However, if the contents of the collection change between the first and - # last paginated list request, the set of all elements returned will be an - # inconsistent view of the collection. There is no way to retrieve a "snapshot" - # of collections larger than the maximum page size. - # Corresponds to the JSON property `nextPageToken` - # @return [String] - attr_accessor :next_page_token - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @dns_keys = args[:dns_keys] if args.key?(:dns_keys) - @header = args[:header] if args.key?(:header) - @kind = args[:kind] if args.key?(:kind) - @next_page_token = args[:next_page_token] if args.key?(:next_page_token) - end - end - - # A zone is a subtree of the DNS namespace under one administrative - # responsibility. A ManagedZone is a resource that represents a DNS zone hosted - # by the Cloud DNS service. - class ManagedZone - include Google::Apis::Core::Hashable - - # The time that this resource was created on the server. This is in RFC3339 text - # format. Output only. - # Corresponds to the JSON property `creationTime` - # @return [String] - attr_accessor :creation_time - - # A mutable string of at most 1024 characters associated with this resource for - # the user's convenience. Has no effect on the managed zone's function. - # Corresponds to the JSON property `description` - # @return [String] - attr_accessor :description - - # The DNS name of this managed zone, for instance "example.com.". - # Corresponds to the JSON property `dnsName` - # @return [String] - attr_accessor :dns_name - - # DNSSEC configuration. - # Corresponds to the JSON property `dnssecConfig` - # @return [Google::Apis::DnsV2beta1::ManagedZoneDnsSecConfig] - attr_accessor :dnssec_config - - # The presence for this field indicates that outbound forwarding is enabled for - # this zone. The value of this field contains the set of destinations to forward - # to. - # Corresponds to the JSON property `forwardingConfig` - # @return [Google::Apis::DnsV2beta1::ManagedZoneForwardingConfig] - attr_accessor :forwarding_config - - # Unique identifier for the resource; defined by the server (output only) - # Corresponds to the JSON property `id` - # @return [Fixnum] - attr_accessor :id - - # - # Corresponds to the JSON property `kind` - # @return [String] - attr_accessor :kind - - # User labels. - # Corresponds to the JSON property `labels` - # @return [Hash] - attr_accessor :labels - - # User assigned name for this resource. Must be unique within the project. The - # name must be 1-63 characters long, must begin with a letter, end with a letter - # or digit, and only contain lowercase letters, digits or dashes. - # Corresponds to the JSON property `name` - # @return [String] - attr_accessor :name - - # Optionally specifies the NameServerSet for this ManagedZone. A NameServerSet - # is a set of DNS name servers that all host the same ManagedZones. Most users - # will leave this field unset. - # Corresponds to the JSON property `nameServerSet` - # @return [String] - attr_accessor :name_server_set - - # Delegate your managed_zone to these virtual name servers; defined by the - # server (output only) - # Corresponds to the JSON property `nameServers` - # @return [Array] - attr_accessor :name_servers - - # The presence of this field indicates that DNS Peering is enabled for this zone. - # The value of this field contains the network to peer with. - # Corresponds to the JSON property `peeringConfig` - # @return [Google::Apis::DnsV2beta1::ManagedZonePeeringConfig] - attr_accessor :peering_config - - # For privately visible zones, the set of Virtual Private Cloud resources that - # the zone is visible from. - # Corresponds to the JSON property `privateVisibilityConfig` - # @return [Google::Apis::DnsV2beta1::ManagedZonePrivateVisibilityConfig] - attr_accessor :private_visibility_config - - # The presence of this field indicates that this is a managed reverse lookup - # zone and Cloud DNS will resolve reverse lookup queries using automatically - # configured records for VPC resources. This only applies to networks listed - # under private_visibility_config. - # Corresponds to the JSON property `reverseLookupConfig` - # @return [Google::Apis::DnsV2beta1::ManagedZoneReverseLookupConfig] - attr_accessor :reverse_lookup_config - - # The zone's visibility: public zones are exposed to the Internet, while private - # zones are visible only to Virtual Private Cloud resources. - # Corresponds to the JSON property `visibility` - # @return [String] - attr_accessor :visibility - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @creation_time = args[:creation_time] if args.key?(:creation_time) - @description = args[:description] if args.key?(:description) - @dns_name = args[:dns_name] if args.key?(:dns_name) - @dnssec_config = args[:dnssec_config] if args.key?(:dnssec_config) - @forwarding_config = args[:forwarding_config] if args.key?(:forwarding_config) - @id = args[:id] if args.key?(:id) - @kind = args[:kind] if args.key?(:kind) - @labels = args[:labels] if args.key?(:labels) - @name = args[:name] if args.key?(:name) - @name_server_set = args[:name_server_set] if args.key?(:name_server_set) - @name_servers = args[:name_servers] if args.key?(:name_servers) - @peering_config = args[:peering_config] if args.key?(:peering_config) - @private_visibility_config = args[:private_visibility_config] if args.key?(:private_visibility_config) - @reverse_lookup_config = args[:reverse_lookup_config] if args.key?(:reverse_lookup_config) - @visibility = args[:visibility] if args.key?(:visibility) - end - end - - # - class ManagedZoneDnsSecConfig - include Google::Apis::Core::Hashable - - # Specifies parameters for generating initial DnsKeys for this ManagedZone. Can - # only be changed while the state is OFF. - # Corresponds to the JSON property `defaultKeySpecs` - # @return [Array] - attr_accessor :default_key_specs - - # - # Corresponds to the JSON property `kind` - # @return [String] - attr_accessor :kind - - # Specifies the mechanism for authenticated denial-of-existence responses. Can - # only be changed while the state is OFF. - # Corresponds to the JSON property `nonExistence` - # @return [String] - attr_accessor :non_existence - - # Specifies whether DNSSEC is enabled, and what mode it is in. - # Corresponds to the JSON property `state` - # @return [String] - attr_accessor :state - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @default_key_specs = args[:default_key_specs] if args.key?(:default_key_specs) - @kind = args[:kind] if args.key?(:kind) - @non_existence = args[:non_existence] if args.key?(:non_existence) - @state = args[:state] if args.key?(:state) - end - end - - # - class ManagedZoneForwardingConfig - include Google::Apis::Core::Hashable - - # - # Corresponds to the JSON property `kind` - # @return [String] - attr_accessor :kind - - # List of target name servers to forward to. Cloud DNS will select the best - # available name server if more than one target is given. - # Corresponds to the JSON property `targetNameServers` - # @return [Array] - attr_accessor :target_name_servers - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @kind = args[:kind] if args.key?(:kind) - @target_name_servers = args[:target_name_servers] if args.key?(:target_name_servers) - end - end - - # - class ManagedZoneForwardingConfigNameServerTarget - include Google::Apis::Core::Hashable - - # Forwarding path for this NameServerTarget. If unset or set to DEFAULT, Cloud - # DNS will make forwarding decision based on address ranges, i.e. RFC1918 - # addresses go to the VPC, non-RFC1918 addresses go to the Internet. When set to - # PRIVATE, Cloud DNS will always send queries through VPC for this target. - # Corresponds to the JSON property `forwardingPath` - # @return [String] - attr_accessor :forwarding_path - - # IPv4 address of a target name server. - # Corresponds to the JSON property `ipv4Address` - # @return [String] - attr_accessor :ipv4_address - - # - # Corresponds to the JSON property `kind` - # @return [String] - attr_accessor :kind - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @forwarding_path = args[:forwarding_path] if args.key?(:forwarding_path) - @ipv4_address = args[:ipv4_address] if args.key?(:ipv4_address) - @kind = args[:kind] if args.key?(:kind) - end - end - - # - class ManagedZoneOperationsListResponse - include Google::Apis::Core::Hashable - - # Elements common to every response. - # Corresponds to the JSON property `header` - # @return [Google::Apis::DnsV2beta1::ResponseHeader] - attr_accessor :header - - # - # Corresponds to the JSON property `kind` - # @return [String] - attr_accessor :kind - - # The presence of this field indicates that there exist more results following - # your last page of results in pagination order. To fetch them, make another - # list request using this value as your page token. In this way you can retrieve - # the complete contents of even very large collections one page at a time. - # However, if the contents of the collection change between the first and last - # paginated list request, the set of all elements returned will be an - # inconsistent view of the collection. There is no way to retrieve a consistent - # snapshot of a collection larger than the maximum page size. - # Corresponds to the JSON property `nextPageToken` - # @return [String] - attr_accessor :next_page_token - - # The operation resources. - # Corresponds to the JSON property `operations` - # @return [Array] - attr_accessor :operations - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @header = args[:header] if args.key?(:header) - @kind = args[:kind] if args.key?(:kind) - @next_page_token = args[:next_page_token] if args.key?(:next_page_token) - @operations = args[:operations] if args.key?(:operations) - end - end - - # - class ManagedZonePeeringConfig - include Google::Apis::Core::Hashable - - # - # Corresponds to the JSON property `kind` - # @return [String] - attr_accessor :kind - - # The network with which to peer. - # Corresponds to the JSON property `targetNetwork` - # @return [Google::Apis::DnsV2beta1::ManagedZonePeeringConfigTargetNetwork] - attr_accessor :target_network - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @kind = args[:kind] if args.key?(:kind) - @target_network = args[:target_network] if args.key?(:target_network) - end - end - - # - class ManagedZonePeeringConfigTargetNetwork - include Google::Apis::Core::Hashable - - # The time at which the zone was deactivated, in RFC 3339 date-time format. An - # empty string indicates that the peering connection is active. The producer - # network can deactivate a zone. The zone is automatically deactivated if the - # producer network that the zone targeted is deleted. Output only. - # Corresponds to the JSON property `deactivateTime` - # @return [String] - attr_accessor :deactivate_time - - # - # Corresponds to the JSON property `kind` - # @return [String] - attr_accessor :kind - - # The fully qualified URL of the VPC network to forward queries to. This should - # be formatted like https://www.googleapis.com/compute/v1/projects/`project`/ - # global/networks/`network` - # Corresponds to the JSON property `networkUrl` - # @return [String] - attr_accessor :network_url - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @deactivate_time = args[:deactivate_time] if args.key?(:deactivate_time) - @kind = args[:kind] if args.key?(:kind) - @network_url = args[:network_url] if args.key?(:network_url) - end - end - - # - class ManagedZonePrivateVisibilityConfig - include Google::Apis::Core::Hashable - - # - # Corresponds to the JSON property `kind` - # @return [String] - attr_accessor :kind - - # The list of VPC networks that can see this zone. - # Corresponds to the JSON property `networks` - # @return [Array] - attr_accessor :networks - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @kind = args[:kind] if args.key?(:kind) - @networks = args[:networks] if args.key?(:networks) - end - end - - # - class ManagedZonePrivateVisibilityConfigNetwork - include Google::Apis::Core::Hashable - - # - # Corresponds to the JSON property `kind` - # @return [String] - attr_accessor :kind - - # The fully qualified URL of the VPC network to bind to. This should be - # formatted like https://www.googleapis.com/compute/v1/projects/`project`/global/ - # networks/`network` - # Corresponds to the JSON property `networkUrl` - # @return [String] - attr_accessor :network_url - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @kind = args[:kind] if args.key?(:kind) - @network_url = args[:network_url] if args.key?(:network_url) - end - end - - # - class ManagedZoneReverseLookupConfig - include Google::Apis::Core::Hashable - - # - # Corresponds to the JSON property `kind` - # @return [String] - attr_accessor :kind - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @kind = args[:kind] if args.key?(:kind) - end - end - - # - class ManagedZonesListResponse - include Google::Apis::Core::Hashable - - # Elements common to every response. - # Corresponds to the JSON property `header` - # @return [Google::Apis::DnsV2beta1::ResponseHeader] - attr_accessor :header - - # Type of resource. - # Corresponds to the JSON property `kind` - # @return [String] - attr_accessor :kind - - # The managed zone resources. - # Corresponds to the JSON property `managedZones` - # @return [Array] - attr_accessor :managed_zones - - # The presence of this field indicates that there exist more results following - # your last page of results in pagination order. To fetch them, make another - # list request using this value as your page token. In this way you can retrieve - # the complete contents of even very large collections one page at a time. - # However, if the contents of the collection change between the first and last - # paginated list request, the set of all elements returned will be an - # inconsistent view of the collection. There is no way to retrieve a consistent - # snapshot of a collection larger than the maximum page size. - # Corresponds to the JSON property `nextPageToken` - # @return [String] - attr_accessor :next_page_token - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @header = args[:header] if args.key?(:header) - @kind = args[:kind] if args.key?(:kind) - @managed_zones = args[:managed_zones] if args.key?(:managed_zones) - @next_page_token = args[:next_page_token] if args.key?(:next_page_token) - end - end - - # An operation represents a successful mutation performed on a Cloud DNS - # resource. Operations provide: - An audit log of server resource mutations. - A - # way to recover/retry API calls in the case where the response is never - # received by the caller. Use the caller specified client_operation_id. - class Operation - include Google::Apis::Core::Hashable - - # Only populated if the operation targeted a DnsKey (output only). - # Corresponds to the JSON property `dnsKeyContext` - # @return [Google::Apis::DnsV2beta1::OperationDnsKeyContext] - attr_accessor :dns_key_context - - # Unique identifier for the resource. This is the client_operation_id if the - # client specified it when the mutation was initiated, otherwise, it is - # generated by the server. The name must be 1-63 characters long and match the - # regular expression [-a-z0-9]? (output only) - # Corresponds to the JSON property `id` - # @return [String] - attr_accessor :id - - # - # Corresponds to the JSON property `kind` - # @return [String] - attr_accessor :kind - - # The time that this operation was started by the server. This is in RFC3339 - # text format (output only). - # Corresponds to the JSON property `startTime` - # @return [String] - attr_accessor :start_time - - # Status of the operation. Can be one of the following: "PENDING" or "DONE" ( - # output only). A status of "DONE" means that the request to update the - # authoritative servers has been sent, but the servers might not be updated yet. - # Corresponds to the JSON property `status` - # @return [String] - attr_accessor :status - - # Type of the operation. Operations include insert, update, and delete (output - # only). - # Corresponds to the JSON property `type` - # @return [String] - attr_accessor :type - - # User who requested the operation, for example: user@example.com. cloud-dns- - # system for operations automatically done by the system. (output only) - # Corresponds to the JSON property `user` - # @return [String] - attr_accessor :user - - # Only populated if the operation targeted a ManagedZone (output only). - # Corresponds to the JSON property `zoneContext` - # @return [Google::Apis::DnsV2beta1::OperationManagedZoneContext] - attr_accessor :zone_context - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @dns_key_context = args[:dns_key_context] if args.key?(:dns_key_context) - @id = args[:id] if args.key?(:id) - @kind = args[:kind] if args.key?(:kind) - @start_time = args[:start_time] if args.key?(:start_time) - @status = args[:status] if args.key?(:status) - @type = args[:type] if args.key?(:type) - @user = args[:user] if args.key?(:user) - @zone_context = args[:zone_context] if args.key?(:zone_context) - end - end - - # - class OperationDnsKeyContext - include Google::Apis::Core::Hashable - - # A DNSSEC key pair. - # Corresponds to the JSON property `newValue` - # @return [Google::Apis::DnsV2beta1::DnsKey] - attr_accessor :new_value - - # A DNSSEC key pair. - # Corresponds to the JSON property `oldValue` - # @return [Google::Apis::DnsV2beta1::DnsKey] - attr_accessor :old_value - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @new_value = args[:new_value] if args.key?(:new_value) - @old_value = args[:old_value] if args.key?(:old_value) - end - end - - # - class OperationManagedZoneContext - include Google::Apis::Core::Hashable - - # A zone is a subtree of the DNS namespace under one administrative - # responsibility. A ManagedZone is a resource that represents a DNS zone hosted - # by the Cloud DNS service. - # Corresponds to the JSON property `newValue` - # @return [Google::Apis::DnsV2beta1::ManagedZone] - attr_accessor :new_value - - # A zone is a subtree of the DNS namespace under one administrative - # responsibility. A ManagedZone is a resource that represents a DNS zone hosted - # by the Cloud DNS service. - # Corresponds to the JSON property `oldValue` - # @return [Google::Apis::DnsV2beta1::ManagedZone] - attr_accessor :old_value - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @new_value = args[:new_value] if args.key?(:new_value) - @old_value = args[:old_value] if args.key?(:old_value) - end - end - - # - class PoliciesListResponse - include Google::Apis::Core::Hashable - - # Elements common to every response. - # Corresponds to the JSON property `header` - # @return [Google::Apis::DnsV2beta1::ResponseHeader] - attr_accessor :header - - # Type of resource. - # Corresponds to the JSON property `kind` - # @return [String] - attr_accessor :kind - - # The presence of this field indicates that there exist more results following - # your last page of results in pagination order. To fetch them, make another - # list request using this value as your page token. In this way you can retrieve - # the complete contents of even very large collections one page at a time. - # However, if the contents of the collection change between the first and last - # paginated list request, the set of all elements returned will be an - # inconsistent view of the collection. There is no way to retrieve a consistent - # snapshot of a collection larger than the maximum page size. - # Corresponds to the JSON property `nextPageToken` - # @return [String] - attr_accessor :next_page_token - - # The policy resources. - # Corresponds to the JSON property `policies` - # @return [Array] - attr_accessor :policies - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @header = args[:header] if args.key?(:header) - @kind = args[:kind] if args.key?(:kind) - @next_page_token = args[:next_page_token] if args.key?(:next_page_token) - @policies = args[:policies] if args.key?(:policies) - end - end - - # - class PoliciesPatchResponse - include Google::Apis::Core::Hashable - - # Elements common to every response. - # Corresponds to the JSON property `header` - # @return [Google::Apis::DnsV2beta1::ResponseHeader] - attr_accessor :header - - # A policy is a collection of DNS rules applied to one or more Virtual Private - # Cloud resources. - # Corresponds to the JSON property `policy` - # @return [Google::Apis::DnsV2beta1::Policy] - attr_accessor :policy - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @header = args[:header] if args.key?(:header) - @policy = args[:policy] if args.key?(:policy) - end - end - - # - class PoliciesUpdateResponse - include Google::Apis::Core::Hashable - - # Elements common to every response. - # Corresponds to the JSON property `header` - # @return [Google::Apis::DnsV2beta1::ResponseHeader] - attr_accessor :header - - # A policy is a collection of DNS rules applied to one or more Virtual Private - # Cloud resources. - # Corresponds to the JSON property `policy` - # @return [Google::Apis::DnsV2beta1::Policy] - attr_accessor :policy - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @header = args[:header] if args.key?(:header) - @policy = args[:policy] if args.key?(:policy) - end - end - - # A policy is a collection of DNS rules applied to one or more Virtual Private - # Cloud resources. - class Policy - include Google::Apis::Core::Hashable - - # Sets an alternative name server for the associated networks. When specified, - # all DNS queries are forwarded to a name server that you choose. Names such as . - # internal are not available when an alternative name server is specified. - # Corresponds to the JSON property `alternativeNameServerConfig` - # @return [Google::Apis::DnsV2beta1::PolicyAlternativeNameServerConfig] - attr_accessor :alternative_name_server_config - - # A mutable string of at most 1024 characters associated with this resource for - # the user's convenience. Has no effect on the policy's function. - # Corresponds to the JSON property `description` - # @return [String] - attr_accessor :description - - # Allows networks bound to this policy to receive DNS queries sent by VMs or - # applications over VPN connections. When enabled, a virtual IP address will be - # allocated from each of the sub-networks that are bound to this policy. - # Corresponds to the JSON property `enableInboundForwarding` - # @return [Boolean] - attr_accessor :enable_inbound_forwarding - alias_method :enable_inbound_forwarding?, :enable_inbound_forwarding - - # Controls whether logging is enabled for the networks bound to this policy. - # Defaults to no logging if not set. - # Corresponds to the JSON property `enableLogging` - # @return [Boolean] - attr_accessor :enable_logging - alias_method :enable_logging?, :enable_logging - - # Unique identifier for the resource; defined by the server (output only). - # Corresponds to the JSON property `id` - # @return [Fixnum] - attr_accessor :id - - # - # Corresponds to the JSON property `kind` - # @return [String] - attr_accessor :kind - - # User assigned name for this policy. - # Corresponds to the JSON property `name` - # @return [String] - attr_accessor :name - - # List of network names specifying networks to which this policy is applied. - # Corresponds to the JSON property `networks` - # @return [Array] - attr_accessor :networks - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @alternative_name_server_config = args[:alternative_name_server_config] if args.key?(:alternative_name_server_config) - @description = args[:description] if args.key?(:description) - @enable_inbound_forwarding = args[:enable_inbound_forwarding] if args.key?(:enable_inbound_forwarding) - @enable_logging = args[:enable_logging] if args.key?(:enable_logging) - @id = args[:id] if args.key?(:id) - @kind = args[:kind] if args.key?(:kind) - @name = args[:name] if args.key?(:name) - @networks = args[:networks] if args.key?(:networks) - end - end - - # - class PolicyAlternativeNameServerConfig - include Google::Apis::Core::Hashable - - # - # Corresponds to the JSON property `kind` - # @return [String] - attr_accessor :kind - - # Sets an alternative name server for the associated networks. When specified, - # all DNS queries are forwarded to a name server that you choose. Names such as . - # internal are not available when an alternative name server is specified. - # Corresponds to the JSON property `targetNameServers` - # @return [Array] - attr_accessor :target_name_servers - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @kind = args[:kind] if args.key?(:kind) - @target_name_servers = args[:target_name_servers] if args.key?(:target_name_servers) - end - end - - # - class PolicyAlternativeNameServerConfigTargetNameServer - include Google::Apis::Core::Hashable - - # Forwarding path for this TargetNameServer. If unset or set to DEFAULT, Cloud - # DNS will make forwarding decision based on address ranges, i.e. RFC1918 - # addresses go to the VPC, non-RFC1918 addresses go to the Internet. When set to - # PRIVATE, Cloud DNS will always send queries through VPC for this target. - # Corresponds to the JSON property `forwardingPath` - # @return [String] - attr_accessor :forwarding_path - - # IPv4 address to forward to. - # Corresponds to the JSON property `ipv4Address` - # @return [String] - attr_accessor :ipv4_address - - # - # Corresponds to the JSON property `kind` - # @return [String] - attr_accessor :kind - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @forwarding_path = args[:forwarding_path] if args.key?(:forwarding_path) - @ipv4_address = args[:ipv4_address] if args.key?(:ipv4_address) - @kind = args[:kind] if args.key?(:kind) - end - end - - # - class PolicyNetwork - include Google::Apis::Core::Hashable - - # - # Corresponds to the JSON property `kind` - # @return [String] - attr_accessor :kind - - # The fully qualified URL of the VPC network to bind to. This should be - # formatted like https://www.googleapis.com/compute/v1/projects/`project`/global/ - # networks/`network` - # Corresponds to the JSON property `networkUrl` - # @return [String] - attr_accessor :network_url - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @kind = args[:kind] if args.key?(:kind) - @network_url = args[:network_url] if args.key?(:network_url) - end - end - - # A project resource. The project is a top level container for resources - # including Cloud DNS ManagedZones. Projects can be created only in the APIs - # console. - class Project - include Google::Apis::Core::Hashable - - # User assigned unique identifier for the resource (output only). - # Corresponds to the JSON property `id` - # @return [String] - attr_accessor :id - - # - # Corresponds to the JSON property `kind` - # @return [String] - attr_accessor :kind - - # Unique numeric identifier for the resource; defined by the server (output only) - # . - # Corresponds to the JSON property `number` - # @return [Fixnum] - attr_accessor :number - - # Limits associated with a Project. - # Corresponds to the JSON property `quota` - # @return [Google::Apis::DnsV2beta1::Quota] - attr_accessor :quota - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @id = args[:id] if args.key?(:id) - @kind = args[:kind] if args.key?(:kind) - @number = args[:number] if args.key?(:number) - @quota = args[:quota] if args.key?(:quota) - end - end - - # Limits associated with a Project. - class Quota - include Google::Apis::Core::Hashable - - # Maximum allowed number of DnsKeys per ManagedZone. - # Corresponds to the JSON property `dnsKeysPerManagedZone` - # @return [Fixnum] - attr_accessor :dns_keys_per_managed_zone - - # - # Corresponds to the JSON property `kind` - # @return [String] - attr_accessor :kind - - # Maximum allowed number of managed zones in the project. - # Corresponds to the JSON property `managedZones` - # @return [Fixnum] - attr_accessor :managed_zones - - # Maximum allowed number of managed zones which can be attached to a network. - # Corresponds to the JSON property `managedZonesPerNetwork` - # @return [Fixnum] - attr_accessor :managed_zones_per_network - - # Maximum allowed number of networks to which a privately scoped zone can be - # attached. - # Corresponds to the JSON property `networksPerManagedZone` - # @return [Fixnum] - attr_accessor :networks_per_managed_zone - - # Maximum allowed number of networks per policy. - # Corresponds to the JSON property `networksPerPolicy` - # @return [Fixnum] - attr_accessor :networks_per_policy - - # Maximum allowed number of policies per project. - # Corresponds to the JSON property `policies` - # @return [Fixnum] - attr_accessor :policies - - # Maximum allowed number of ResourceRecords per ResourceRecordSet. - # Corresponds to the JSON property `resourceRecordsPerRrset` - # @return [Fixnum] - attr_accessor :resource_records_per_rrset - - # Maximum allowed number of ResourceRecordSets to add per ChangesCreateRequest. - # Corresponds to the JSON property `rrsetAdditionsPerChange` - # @return [Fixnum] - attr_accessor :rrset_additions_per_change - - # Maximum allowed number of ResourceRecordSets to delete per - # ChangesCreateRequest. - # Corresponds to the JSON property `rrsetDeletionsPerChange` - # @return [Fixnum] - attr_accessor :rrset_deletions_per_change - - # Maximum allowed number of ResourceRecordSets per zone in the project. - # Corresponds to the JSON property `rrsetsPerManagedZone` - # @return [Fixnum] - attr_accessor :rrsets_per_managed_zone - - # Maximum allowed number of target name servers per managed forwarding zone. - # Corresponds to the JSON property `targetNameServersPerManagedZone` - # @return [Fixnum] - attr_accessor :target_name_servers_per_managed_zone - - # Maximum allowed number of alternative target name servers per policy. - # Corresponds to the JSON property `targetNameServersPerPolicy` - # @return [Fixnum] - attr_accessor :target_name_servers_per_policy - - # Maximum allowed size for total rrdata in one ChangesCreateRequest in bytes. - # Corresponds to the JSON property `totalRrdataSizePerChange` - # @return [Fixnum] - attr_accessor :total_rrdata_size_per_change - - # DNSSEC algorithm and key length types that can be used for DnsKeys. - # Corresponds to the JSON property `whitelistedKeySpecs` - # @return [Array] - attr_accessor :whitelisted_key_specs - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @dns_keys_per_managed_zone = args[:dns_keys_per_managed_zone] if args.key?(:dns_keys_per_managed_zone) - @kind = args[:kind] if args.key?(:kind) - @managed_zones = args[:managed_zones] if args.key?(:managed_zones) - @managed_zones_per_network = args[:managed_zones_per_network] if args.key?(:managed_zones_per_network) - @networks_per_managed_zone = args[:networks_per_managed_zone] if args.key?(:networks_per_managed_zone) - @networks_per_policy = args[:networks_per_policy] if args.key?(:networks_per_policy) - @policies = args[:policies] if args.key?(:policies) - @resource_records_per_rrset = args[:resource_records_per_rrset] if args.key?(:resource_records_per_rrset) - @rrset_additions_per_change = args[:rrset_additions_per_change] if args.key?(:rrset_additions_per_change) - @rrset_deletions_per_change = args[:rrset_deletions_per_change] if args.key?(:rrset_deletions_per_change) - @rrsets_per_managed_zone = args[:rrsets_per_managed_zone] if args.key?(:rrsets_per_managed_zone) - @target_name_servers_per_managed_zone = args[:target_name_servers_per_managed_zone] if args.key?(:target_name_servers_per_managed_zone) - @target_name_servers_per_policy = args[:target_name_servers_per_policy] if args.key?(:target_name_servers_per_policy) - @total_rrdata_size_per_change = args[:total_rrdata_size_per_change] if args.key?(:total_rrdata_size_per_change) - @whitelisted_key_specs = args[:whitelisted_key_specs] if args.key?(:whitelisted_key_specs) - end - end - - # A unit of data that will be returned by the DNS servers. - class ResourceRecordSet - include Google::Apis::Core::Hashable - - # - # Corresponds to the JSON property `kind` - # @return [String] - attr_accessor :kind - - # For example, www.example.com. - # Corresponds to the JSON property `name` - # @return [String] - attr_accessor :name - - # As defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1) -- see - # examples. - # Corresponds to the JSON property `rrdatas` - # @return [Array] - attr_accessor :rrdatas - - # As defined in RFC 4034 (section 3.2). - # Corresponds to the JSON property `signatureRrdatas` - # @return [Array] - attr_accessor :signature_rrdatas - - # Number of seconds that this ResourceRecordSet can be cached by resolvers. - # Corresponds to the JSON property `ttl` - # @return [Fixnum] - attr_accessor :ttl - - # The identifier of a supported record type. See the list of Supported DNS - # record types. - # Corresponds to the JSON property `type` - # @return [String] - attr_accessor :type - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @kind = args[:kind] if args.key?(:kind) - @name = args[:name] if args.key?(:name) - @rrdatas = args[:rrdatas] if args.key?(:rrdatas) - @signature_rrdatas = args[:signature_rrdatas] if args.key?(:signature_rrdatas) - @ttl = args[:ttl] if args.key?(:ttl) - @type = args[:type] if args.key?(:type) - end - end - - # - class ResourceRecordSetsListResponse - include Google::Apis::Core::Hashable - - # Elements common to every response. - # Corresponds to the JSON property `header` - # @return [Google::Apis::DnsV2beta1::ResponseHeader] - attr_accessor :header - - # Type of resource. - # Corresponds to the JSON property `kind` - # @return [String] - attr_accessor :kind - - # The presence of this field indicates that there exist more results following - # your last page of results in pagination order. To fetch them, make another - # list request using this value as your pagination token. In this way you can - # retrieve the complete contents of even very large collections one page at a - # time. However, if the contents of the collection change between the first and - # last paginated list request, the set of all elements returned will be an - # inconsistent view of the collection. There is no way to retrieve a consistent - # snapshot of a collection larger than the maximum page size. - # Corresponds to the JSON property `nextPageToken` - # @return [String] - attr_accessor :next_page_token - - # The resource record set resources. - # Corresponds to the JSON property `rrsets` - # @return [Array] - attr_accessor :rrsets - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @header = args[:header] if args.key?(:header) - @kind = args[:kind] if args.key?(:kind) - @next_page_token = args[:next_page_token] if args.key?(:next_page_token) - @rrsets = args[:rrsets] if args.key?(:rrsets) - end - end - - # Elements common to every response. - class ResponseHeader - include Google::Apis::Core::Hashable - - # For mutating operation requests that completed successfully. This is the - # client_operation_id if the client specified it, otherwise it is generated by - # the server (output only). - # Corresponds to the JSON property `operationId` - # @return [String] - attr_accessor :operation_id - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @operation_id = args[:operation_id] if args.key?(:operation_id) - end - end - end - end -end diff --git a/generated/google/apis/dns_v2beta1/representations.rb b/generated/google/apis/dns_v2beta1/representations.rb deleted file mode 100644 index 13d2dd94b..000000000 --- a/generated/google/apis/dns_v2beta1/representations.rb +++ /dev/null @@ -1,588 +0,0 @@ -# Copyright 2015 Google Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - -require 'date' -require 'google/apis/core/base_service' -require 'google/apis/core/json_representation' -require 'google/apis/core/hashable' -require 'google/apis/errors' - -module Google - module Apis - module DnsV2beta1 - - class Change - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class ChangesListResponse - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class DnsKey - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class DnsKeyDigest - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class DnsKeySpec - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class DnsKeysListResponse - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class ManagedZone - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class ManagedZoneDnsSecConfig - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class ManagedZoneForwardingConfig - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class ManagedZoneForwardingConfigNameServerTarget - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class ManagedZoneOperationsListResponse - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class ManagedZonePeeringConfig - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class ManagedZonePeeringConfigTargetNetwork - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class ManagedZonePrivateVisibilityConfig - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class ManagedZonePrivateVisibilityConfigNetwork - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class ManagedZoneReverseLookupConfig - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class ManagedZonesListResponse - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class Operation - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class OperationDnsKeyContext - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class OperationManagedZoneContext - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class PoliciesListResponse - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class PoliciesPatchResponse - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class PoliciesUpdateResponse - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class Policy - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class PolicyAlternativeNameServerConfig - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class PolicyAlternativeNameServerConfigTargetNameServer - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class PolicyNetwork - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class Project - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class Quota - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class ResourceRecordSet - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class ResourceRecordSetsListResponse - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class ResponseHeader - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class Change - # @private - class Representation < Google::Apis::Core::JsonRepresentation - collection :additions, as: 'additions', class: Google::Apis::DnsV2beta1::ResourceRecordSet, decorator: Google::Apis::DnsV2beta1::ResourceRecordSet::Representation - - collection :deletions, as: 'deletions', class: Google::Apis::DnsV2beta1::ResourceRecordSet, decorator: Google::Apis::DnsV2beta1::ResourceRecordSet::Representation - - property :id, as: 'id' - property :is_serving, as: 'isServing' - property :kind, as: 'kind' - property :start_time, as: 'startTime' - property :status, as: 'status' - end - end - - class ChangesListResponse - # @private - class Representation < Google::Apis::Core::JsonRepresentation - collection :changes, as: 'changes', class: Google::Apis::DnsV2beta1::Change, decorator: Google::Apis::DnsV2beta1::Change::Representation - - property :header, as: 'header', class: Google::Apis::DnsV2beta1::ResponseHeader, decorator: Google::Apis::DnsV2beta1::ResponseHeader::Representation - - property :kind, as: 'kind' - property :next_page_token, as: 'nextPageToken' - end - end - - class DnsKey - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :algorithm, as: 'algorithm' - property :creation_time, as: 'creationTime' - property :description, as: 'description' - collection :digests, as: 'digests', class: Google::Apis::DnsV2beta1::DnsKeyDigest, decorator: Google::Apis::DnsV2beta1::DnsKeyDigest::Representation - - property :id, as: 'id' - property :is_active, as: 'isActive' - property :key_length, as: 'keyLength' - property :key_tag, as: 'keyTag' - property :kind, as: 'kind' - property :public_key, as: 'publicKey' - property :type, as: 'type' - end - end - - class DnsKeyDigest - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :digest, as: 'digest' - property :type, as: 'type' - end - end - - class DnsKeySpec - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :algorithm, as: 'algorithm' - property :key_length, as: 'keyLength' - property :key_type, as: 'keyType' - property :kind, as: 'kind' - end - end - - class DnsKeysListResponse - # @private - class Representation < Google::Apis::Core::JsonRepresentation - collection :dns_keys, as: 'dnsKeys', class: Google::Apis::DnsV2beta1::DnsKey, decorator: Google::Apis::DnsV2beta1::DnsKey::Representation - - property :header, as: 'header', class: Google::Apis::DnsV2beta1::ResponseHeader, decorator: Google::Apis::DnsV2beta1::ResponseHeader::Representation - - property :kind, as: 'kind' - property :next_page_token, as: 'nextPageToken' - end - end - - class ManagedZone - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :creation_time, as: 'creationTime' - property :description, as: 'description' - property :dns_name, as: 'dnsName' - property :dnssec_config, as: 'dnssecConfig', class: Google::Apis::DnsV2beta1::ManagedZoneDnsSecConfig, decorator: Google::Apis::DnsV2beta1::ManagedZoneDnsSecConfig::Representation - - property :forwarding_config, as: 'forwardingConfig', class: Google::Apis::DnsV2beta1::ManagedZoneForwardingConfig, decorator: Google::Apis::DnsV2beta1::ManagedZoneForwardingConfig::Representation - - property :id, :numeric_string => true, as: 'id' - property :kind, as: 'kind' - hash :labels, as: 'labels' - property :name, as: 'name' - property :name_server_set, as: 'nameServerSet' - collection :name_servers, as: 'nameServers' - property :peering_config, as: 'peeringConfig', class: Google::Apis::DnsV2beta1::ManagedZonePeeringConfig, decorator: Google::Apis::DnsV2beta1::ManagedZonePeeringConfig::Representation - - property :private_visibility_config, as: 'privateVisibilityConfig', class: Google::Apis::DnsV2beta1::ManagedZonePrivateVisibilityConfig, decorator: Google::Apis::DnsV2beta1::ManagedZonePrivateVisibilityConfig::Representation - - property :reverse_lookup_config, as: 'reverseLookupConfig', class: Google::Apis::DnsV2beta1::ManagedZoneReverseLookupConfig, decorator: Google::Apis::DnsV2beta1::ManagedZoneReverseLookupConfig::Representation - - property :visibility, as: 'visibility' - end - end - - class ManagedZoneDnsSecConfig - # @private - class Representation < Google::Apis::Core::JsonRepresentation - collection :default_key_specs, as: 'defaultKeySpecs', class: Google::Apis::DnsV2beta1::DnsKeySpec, decorator: Google::Apis::DnsV2beta1::DnsKeySpec::Representation - - property :kind, as: 'kind' - property :non_existence, as: 'nonExistence' - property :state, as: 'state' - end - end - - class ManagedZoneForwardingConfig - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :kind, as: 'kind' - collection :target_name_servers, as: 'targetNameServers', class: Google::Apis::DnsV2beta1::ManagedZoneForwardingConfigNameServerTarget, decorator: Google::Apis::DnsV2beta1::ManagedZoneForwardingConfigNameServerTarget::Representation - - end - end - - class ManagedZoneForwardingConfigNameServerTarget - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :forwarding_path, as: 'forwardingPath' - property :ipv4_address, as: 'ipv4Address' - property :kind, as: 'kind' - end - end - - class ManagedZoneOperationsListResponse - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :header, as: 'header', class: Google::Apis::DnsV2beta1::ResponseHeader, decorator: Google::Apis::DnsV2beta1::ResponseHeader::Representation - - property :kind, as: 'kind' - property :next_page_token, as: 'nextPageToken' - collection :operations, as: 'operations', class: Google::Apis::DnsV2beta1::Operation, decorator: Google::Apis::DnsV2beta1::Operation::Representation - - end - end - - class ManagedZonePeeringConfig - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :kind, as: 'kind' - property :target_network, as: 'targetNetwork', class: Google::Apis::DnsV2beta1::ManagedZonePeeringConfigTargetNetwork, decorator: Google::Apis::DnsV2beta1::ManagedZonePeeringConfigTargetNetwork::Representation - - end - end - - class ManagedZonePeeringConfigTargetNetwork - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :deactivate_time, as: 'deactivateTime' - property :kind, as: 'kind' - property :network_url, as: 'networkUrl' - end - end - - class ManagedZonePrivateVisibilityConfig - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :kind, as: 'kind' - collection :networks, as: 'networks', class: Google::Apis::DnsV2beta1::ManagedZonePrivateVisibilityConfigNetwork, decorator: Google::Apis::DnsV2beta1::ManagedZonePrivateVisibilityConfigNetwork::Representation - - end - end - - class ManagedZonePrivateVisibilityConfigNetwork - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :kind, as: 'kind' - property :network_url, as: 'networkUrl' - end - end - - class ManagedZoneReverseLookupConfig - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :kind, as: 'kind' - end - end - - class ManagedZonesListResponse - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :header, as: 'header', class: Google::Apis::DnsV2beta1::ResponseHeader, decorator: Google::Apis::DnsV2beta1::ResponseHeader::Representation - - property :kind, as: 'kind' - collection :managed_zones, as: 'managedZones', class: Google::Apis::DnsV2beta1::ManagedZone, decorator: Google::Apis::DnsV2beta1::ManagedZone::Representation - - property :next_page_token, as: 'nextPageToken' - end - end - - class Operation - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :dns_key_context, as: 'dnsKeyContext', class: Google::Apis::DnsV2beta1::OperationDnsKeyContext, decorator: Google::Apis::DnsV2beta1::OperationDnsKeyContext::Representation - - property :id, as: 'id' - property :kind, as: 'kind' - property :start_time, as: 'startTime' - property :status, as: 'status' - property :type, as: 'type' - property :user, as: 'user' - property :zone_context, as: 'zoneContext', class: Google::Apis::DnsV2beta1::OperationManagedZoneContext, decorator: Google::Apis::DnsV2beta1::OperationManagedZoneContext::Representation - - end - end - - class OperationDnsKeyContext - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :new_value, as: 'newValue', class: Google::Apis::DnsV2beta1::DnsKey, decorator: Google::Apis::DnsV2beta1::DnsKey::Representation - - property :old_value, as: 'oldValue', class: Google::Apis::DnsV2beta1::DnsKey, decorator: Google::Apis::DnsV2beta1::DnsKey::Representation - - end - end - - class OperationManagedZoneContext - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :new_value, as: 'newValue', class: Google::Apis::DnsV2beta1::ManagedZone, decorator: Google::Apis::DnsV2beta1::ManagedZone::Representation - - property :old_value, as: 'oldValue', class: Google::Apis::DnsV2beta1::ManagedZone, decorator: Google::Apis::DnsV2beta1::ManagedZone::Representation - - end - end - - class PoliciesListResponse - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :header, as: 'header', class: Google::Apis::DnsV2beta1::ResponseHeader, decorator: Google::Apis::DnsV2beta1::ResponseHeader::Representation - - property :kind, as: 'kind' - property :next_page_token, as: 'nextPageToken' - collection :policies, as: 'policies', class: Google::Apis::DnsV2beta1::Policy, decorator: Google::Apis::DnsV2beta1::Policy::Representation - - end - end - - class PoliciesPatchResponse - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :header, as: 'header', class: Google::Apis::DnsV2beta1::ResponseHeader, decorator: Google::Apis::DnsV2beta1::ResponseHeader::Representation - - property :policy, as: 'policy', class: Google::Apis::DnsV2beta1::Policy, decorator: Google::Apis::DnsV2beta1::Policy::Representation - - end - end - - class PoliciesUpdateResponse - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :header, as: 'header', class: Google::Apis::DnsV2beta1::ResponseHeader, decorator: Google::Apis::DnsV2beta1::ResponseHeader::Representation - - property :policy, as: 'policy', class: Google::Apis::DnsV2beta1::Policy, decorator: Google::Apis::DnsV2beta1::Policy::Representation - - end - end - - class Policy - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :alternative_name_server_config, as: 'alternativeNameServerConfig', class: Google::Apis::DnsV2beta1::PolicyAlternativeNameServerConfig, decorator: Google::Apis::DnsV2beta1::PolicyAlternativeNameServerConfig::Representation - - property :description, as: 'description' - property :enable_inbound_forwarding, as: 'enableInboundForwarding' - property :enable_logging, as: 'enableLogging' - property :id, :numeric_string => true, as: 'id' - property :kind, as: 'kind' - property :name, as: 'name' - collection :networks, as: 'networks', class: Google::Apis::DnsV2beta1::PolicyNetwork, decorator: Google::Apis::DnsV2beta1::PolicyNetwork::Representation - - end - end - - class PolicyAlternativeNameServerConfig - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :kind, as: 'kind' - collection :target_name_servers, as: 'targetNameServers', class: Google::Apis::DnsV2beta1::PolicyAlternativeNameServerConfigTargetNameServer, decorator: Google::Apis::DnsV2beta1::PolicyAlternativeNameServerConfigTargetNameServer::Representation - - end - end - - class PolicyAlternativeNameServerConfigTargetNameServer - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :forwarding_path, as: 'forwardingPath' - property :ipv4_address, as: 'ipv4Address' - property :kind, as: 'kind' - end - end - - class PolicyNetwork - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :kind, as: 'kind' - property :network_url, as: 'networkUrl' - end - end - - class Project - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :id, as: 'id' - property :kind, as: 'kind' - property :number, :numeric_string => true, as: 'number' - property :quota, as: 'quota', class: Google::Apis::DnsV2beta1::Quota, decorator: Google::Apis::DnsV2beta1::Quota::Representation - - end - end - - class Quota - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :dns_keys_per_managed_zone, as: 'dnsKeysPerManagedZone' - property :kind, as: 'kind' - property :managed_zones, as: 'managedZones' - property :managed_zones_per_network, as: 'managedZonesPerNetwork' - property :networks_per_managed_zone, as: 'networksPerManagedZone' - property :networks_per_policy, as: 'networksPerPolicy' - property :policies, as: 'policies' - property :resource_records_per_rrset, as: 'resourceRecordsPerRrset' - property :rrset_additions_per_change, as: 'rrsetAdditionsPerChange' - property :rrset_deletions_per_change, as: 'rrsetDeletionsPerChange' - property :rrsets_per_managed_zone, as: 'rrsetsPerManagedZone' - property :target_name_servers_per_managed_zone, as: 'targetNameServersPerManagedZone' - property :target_name_servers_per_policy, as: 'targetNameServersPerPolicy' - property :total_rrdata_size_per_change, as: 'totalRrdataSizePerChange' - collection :whitelisted_key_specs, as: 'whitelistedKeySpecs', class: Google::Apis::DnsV2beta1::DnsKeySpec, decorator: Google::Apis::DnsV2beta1::DnsKeySpec::Representation - - end - end - - class ResourceRecordSet - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :kind, as: 'kind' - property :name, as: 'name' - collection :rrdatas, as: 'rrdatas' - collection :signature_rrdatas, as: 'signatureRrdatas' - property :ttl, as: 'ttl' - property :type, as: 'type' - end - end - - class ResourceRecordSetsListResponse - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :header, as: 'header', class: Google::Apis::DnsV2beta1::ResponseHeader, decorator: Google::Apis::DnsV2beta1::ResponseHeader::Representation - - property :kind, as: 'kind' - property :next_page_token, as: 'nextPageToken' - collection :rrsets, as: 'rrsets', class: Google::Apis::DnsV2beta1::ResourceRecordSet, decorator: Google::Apis::DnsV2beta1::ResourceRecordSet::Representation - - end - end - - class ResponseHeader - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :operation_id, as: 'operationId' - end - end - end - end -end diff --git a/generated/google/apis/dns_v2beta1/service.rb b/generated/google/apis/dns_v2beta1/service.rb deleted file mode 100644 index 2310bbb87..000000000 --- a/generated/google/apis/dns_v2beta1/service.rb +++ /dev/null @@ -1,913 +0,0 @@ -# Copyright 2015 Google Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - -require 'google/apis/core/base_service' -require 'google/apis/core/json_representation' -require 'google/apis/core/hashable' -require 'google/apis/errors' - -module Google - module Apis - module DnsV2beta1 - # Cloud DNS API - # - # - # - # @example - # require 'google/apis/dns_v2beta1' - # - # Dns = Google::Apis::DnsV2beta1 # Alias the module - # service = Dns::DnsService.new - # - # @see http://developers.google.com/cloud-dns - class DnsService < Google::Apis::Core::BaseService - # @return [String] - # API key. Your API key identifies your project and provides you with API access, - # quota, and reports. Required unless you provide an OAuth 2.0 token. - attr_accessor :key - - # @return [String] - # Available to use for quota purposes for server-side applications. Can be any - # arbitrary string assigned to a user, but should not exceed 40 characters. - attr_accessor :quota_user - - def initialize - super('https://dns.googleapis.com/', '') - @batch_path = 'batch' - end - - # Atomically update the ResourceRecordSet collection. - # @param [String] project - # Identifies the project addressed by this request. - # @param [String] managed_zone - # Identifies the managed zone addressed by this request. Can be the managed zone - # name or id. - # @param [Google::Apis::DnsV2beta1::Change] change_object - # @param [String] client_operation_id - # For mutating operation requests only. An optional identifier specified by the - # client. Must be unique for operation resources in the Operations collection. - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # Available to use for quota purposes for server-side applications. Can be any - # arbitrary string assigned to a user, but should not exceed 40 characters. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::DnsV2beta1::Change] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::DnsV2beta1::Change] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def create_change(project, managed_zone, change_object = nil, client_operation_id: nil, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:post, 'dns/v2beta1/projects/{project}/managedZones/{managedZone}/changes', options) - command.request_representation = Google::Apis::DnsV2beta1::Change::Representation - command.request_object = change_object - command.response_representation = Google::Apis::DnsV2beta1::Change::Representation - command.response_class = Google::Apis::DnsV2beta1::Change - command.params['project'] = project unless project.nil? - command.params['managedZone'] = managed_zone unless managed_zone.nil? - command.query['clientOperationId'] = client_operation_id unless client_operation_id.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - execute_or_queue_command(command, &block) - end - - # Fetch the representation of an existing Change. - # @param [String] project - # Identifies the project addressed by this request. - # @param [String] managed_zone - # Identifies the managed zone addressed by this request. Can be the managed zone - # name or id. - # @param [String] change_id - # The identifier of the requested change, from a previous - # ResourceRecordSetsChangeResponse. - # @param [String] client_operation_id - # For mutating operation requests only. An optional identifier specified by the - # client. Must be unique for operation resources in the Operations collection. - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # Available to use for quota purposes for server-side applications. Can be any - # arbitrary string assigned to a user, but should not exceed 40 characters. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::DnsV2beta1::Change] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::DnsV2beta1::Change] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def get_change(project, managed_zone, change_id, client_operation_id: nil, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:get, 'dns/v2beta1/projects/{project}/managedZones/{managedZone}/changes/{changeId}', options) - command.response_representation = Google::Apis::DnsV2beta1::Change::Representation - command.response_class = Google::Apis::DnsV2beta1::Change - command.params['project'] = project unless project.nil? - command.params['managedZone'] = managed_zone unless managed_zone.nil? - command.params['changeId'] = change_id unless change_id.nil? - command.query['clientOperationId'] = client_operation_id unless client_operation_id.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - execute_or_queue_command(command, &block) - end - - # Enumerate Changes to a ResourceRecordSet collection. - # @param [String] project - # Identifies the project addressed by this request. - # @param [String] managed_zone - # Identifies the managed zone addressed by this request. Can be the managed zone - # name or id. - # @param [Fixnum] max_results - # Optional. Maximum number of results to be returned. If unspecified, the server - # will decide how many results to return. - # @param [String] page_token - # Optional. A tag returned by a previous list request that was truncated. Use - # this parameter to continue a previous list request. - # @param [String] sort_by - # Sorting criterion. The only supported value is change sequence. - # @param [String] sort_order - # Sorting order direction: 'ascending' or 'descending'. - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # Available to use for quota purposes for server-side applications. Can be any - # arbitrary string assigned to a user, but should not exceed 40 characters. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::DnsV2beta1::ChangesListResponse] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::DnsV2beta1::ChangesListResponse] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def list_changes(project, managed_zone, max_results: nil, page_token: nil, sort_by: nil, sort_order: nil, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:get, 'dns/v2beta1/projects/{project}/managedZones/{managedZone}/changes', options) - command.response_representation = Google::Apis::DnsV2beta1::ChangesListResponse::Representation - command.response_class = Google::Apis::DnsV2beta1::ChangesListResponse - command.params['project'] = project unless project.nil? - command.params['managedZone'] = managed_zone unless managed_zone.nil? - command.query['maxResults'] = max_results unless max_results.nil? - command.query['pageToken'] = page_token unless page_token.nil? - command.query['sortBy'] = sort_by unless sort_by.nil? - command.query['sortOrder'] = sort_order unless sort_order.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - execute_or_queue_command(command, &block) - end - - # Fetch the representation of an existing DnsKey. - # @param [String] project - # Identifies the project addressed by this request. - # @param [String] managed_zone - # Identifies the managed zone addressed by this request. Can be the managed zone - # name or id. - # @param [String] dns_key_id - # The identifier of the requested DnsKey. - # @param [String] client_operation_id - # For mutating operation requests only. An optional identifier specified by the - # client. Must be unique for operation resources in the Operations collection. - # @param [String] digest_type - # An optional comma-separated list of digest types to compute and display for - # key signing keys. If omitted, the recommended digest type will be computed and - # displayed. - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # Available to use for quota purposes for server-side applications. Can be any - # arbitrary string assigned to a user, but should not exceed 40 characters. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::DnsV2beta1::DnsKey] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::DnsV2beta1::DnsKey] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def get_dns_key(project, managed_zone, dns_key_id, client_operation_id: nil, digest_type: nil, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:get, 'dns/v2beta1/projects/{project}/managedZones/{managedZone}/dnsKeys/{dnsKeyId}', options) - command.response_representation = Google::Apis::DnsV2beta1::DnsKey::Representation - command.response_class = Google::Apis::DnsV2beta1::DnsKey - command.params['project'] = project unless project.nil? - command.params['managedZone'] = managed_zone unless managed_zone.nil? - command.params['dnsKeyId'] = dns_key_id unless dns_key_id.nil? - command.query['clientOperationId'] = client_operation_id unless client_operation_id.nil? - command.query['digestType'] = digest_type unless digest_type.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - execute_or_queue_command(command, &block) - end - - # Enumerate DnsKeys to a ResourceRecordSet collection. - # @param [String] project - # Identifies the project addressed by this request. - # @param [String] managed_zone - # Identifies the managed zone addressed by this request. Can be the managed zone - # name or id. - # @param [String] digest_type - # An optional comma-separated list of digest types to compute and display for - # key signing keys. If omitted, the recommended digest type will be computed and - # displayed. - # @param [Fixnum] max_results - # Optional. Maximum number of results to be returned. If unspecified, the server - # will decide how many results to return. - # @param [String] page_token - # Optional. A tag returned by a previous list request that was truncated. Use - # this parameter to continue a previous list request. - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # Available to use for quota purposes for server-side applications. Can be any - # arbitrary string assigned to a user, but should not exceed 40 characters. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::DnsV2beta1::DnsKeysListResponse] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::DnsV2beta1::DnsKeysListResponse] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def list_dns_keys(project, managed_zone, digest_type: nil, max_results: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:get, 'dns/v2beta1/projects/{project}/managedZones/{managedZone}/dnsKeys', options) - command.response_representation = Google::Apis::DnsV2beta1::DnsKeysListResponse::Representation - command.response_class = Google::Apis::DnsV2beta1::DnsKeysListResponse - command.params['project'] = project unless project.nil? - command.params['managedZone'] = managed_zone unless managed_zone.nil? - command.query['digestType'] = digest_type unless digest_type.nil? - command.query['maxResults'] = max_results unless max_results.nil? - command.query['pageToken'] = page_token unless page_token.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - execute_or_queue_command(command, &block) - end - - # Fetch the representation of an existing Operation. - # @param [String] project - # Identifies the project addressed by this request. - # @param [String] managed_zone - # Identifies the managed zone addressed by this request. - # @param [String] operation - # Identifies the operation addressed by this request. - # @param [String] client_operation_id - # For mutating operation requests only. An optional identifier specified by the - # client. Must be unique for operation resources in the Operations collection. - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # Available to use for quota purposes for server-side applications. Can be any - # arbitrary string assigned to a user, but should not exceed 40 characters. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::DnsV2beta1::Operation] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::DnsV2beta1::Operation] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def get_managed_zone_operation(project, managed_zone, operation, client_operation_id: nil, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:get, 'dns/v2beta1/projects/{project}/managedZones/{managedZone}/operations/{operation}', options) - command.response_representation = Google::Apis::DnsV2beta1::Operation::Representation - command.response_class = Google::Apis::DnsV2beta1::Operation - command.params['project'] = project unless project.nil? - command.params['managedZone'] = managed_zone unless managed_zone.nil? - command.params['operation'] = operation unless operation.nil? - command.query['clientOperationId'] = client_operation_id unless client_operation_id.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - execute_or_queue_command(command, &block) - end - - # Enumerate Operations for the given ManagedZone. - # @param [String] project - # Identifies the project addressed by this request. - # @param [String] managed_zone - # Identifies the managed zone addressed by this request. - # @param [Fixnum] max_results - # Optional. Maximum number of results to be returned. If unspecified, the server - # will decide how many results to return. - # @param [String] page_token - # Optional. A tag returned by a previous list request that was truncated. Use - # this parameter to continue a previous list request. - # @param [String] sort_by - # Sorting criterion. The only supported values are START_TIME and ID. - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # Available to use for quota purposes for server-side applications. Can be any - # arbitrary string assigned to a user, but should not exceed 40 characters. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::DnsV2beta1::ManagedZoneOperationsListResponse] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::DnsV2beta1::ManagedZoneOperationsListResponse] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def list_managed_zone_operations(project, managed_zone, max_results: nil, page_token: nil, sort_by: nil, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:get, 'dns/v2beta1/projects/{project}/managedZones/{managedZone}/operations', options) - command.response_representation = Google::Apis::DnsV2beta1::ManagedZoneOperationsListResponse::Representation - command.response_class = Google::Apis::DnsV2beta1::ManagedZoneOperationsListResponse - command.params['project'] = project unless project.nil? - command.params['managedZone'] = managed_zone unless managed_zone.nil? - command.query['maxResults'] = max_results unless max_results.nil? - command.query['pageToken'] = page_token unless page_token.nil? - command.query['sortBy'] = sort_by unless sort_by.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - execute_or_queue_command(command, &block) - end - - # Create a new ManagedZone. - # @param [String] project - # Identifies the project addressed by this request. - # @param [Google::Apis::DnsV2beta1::ManagedZone] managed_zone_object - # @param [String] client_operation_id - # For mutating operation requests only. An optional identifier specified by the - # client. Must be unique for operation resources in the Operations collection. - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # Available to use for quota purposes for server-side applications. Can be any - # arbitrary string assigned to a user, but should not exceed 40 characters. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::DnsV2beta1::ManagedZone] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::DnsV2beta1::ManagedZone] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def create_managed_zone(project, managed_zone_object = nil, client_operation_id: nil, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:post, 'dns/v2beta1/projects/{project}/managedZones', options) - command.request_representation = Google::Apis::DnsV2beta1::ManagedZone::Representation - command.request_object = managed_zone_object - command.response_representation = Google::Apis::DnsV2beta1::ManagedZone::Representation - command.response_class = Google::Apis::DnsV2beta1::ManagedZone - command.params['project'] = project unless project.nil? - command.query['clientOperationId'] = client_operation_id unless client_operation_id.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - execute_or_queue_command(command, &block) - end - - # Delete a previously created ManagedZone. - # @param [String] project - # Identifies the project addressed by this request. - # @param [String] managed_zone - # Identifies the managed zone addressed by this request. Can be the managed zone - # name or id. - # @param [String] client_operation_id - # For mutating operation requests only. An optional identifier specified by the - # client. Must be unique for operation resources in the Operations collection. - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # Available to use for quota purposes for server-side applications. Can be any - # arbitrary string assigned to a user, but should not exceed 40 characters. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [NilClass] No result returned for this method - # @yieldparam err [StandardError] error object if request failed - # - # @return [void] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def delete_managed_zone(project, managed_zone, client_operation_id: nil, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:delete, 'dns/v2beta1/projects/{project}/managedZones/{managedZone}', options) - command.params['project'] = project unless project.nil? - command.params['managedZone'] = managed_zone unless managed_zone.nil? - command.query['clientOperationId'] = client_operation_id unless client_operation_id.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - execute_or_queue_command(command, &block) - end - - # Fetch the representation of an existing ManagedZone. - # @param [String] project - # Identifies the project addressed by this request. - # @param [String] managed_zone - # Identifies the managed zone addressed by this request. Can be the managed zone - # name or id. - # @param [String] client_operation_id - # For mutating operation requests only. An optional identifier specified by the - # client. Must be unique for operation resources in the Operations collection. - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # Available to use for quota purposes for server-side applications. Can be any - # arbitrary string assigned to a user, but should not exceed 40 characters. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::DnsV2beta1::ManagedZone] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::DnsV2beta1::ManagedZone] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def get_managed_zone(project, managed_zone, client_operation_id: nil, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:get, 'dns/v2beta1/projects/{project}/managedZones/{managedZone}', options) - command.response_representation = Google::Apis::DnsV2beta1::ManagedZone::Representation - command.response_class = Google::Apis::DnsV2beta1::ManagedZone - command.params['project'] = project unless project.nil? - command.params['managedZone'] = managed_zone unless managed_zone.nil? - command.query['clientOperationId'] = client_operation_id unless client_operation_id.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - execute_or_queue_command(command, &block) - end - - # Enumerate ManagedZones that have been created but not yet deleted. - # @param [String] project - # Identifies the project addressed by this request. - # @param [String] dns_name - # Restricts the list to return only zones with this domain name. - # @param [Fixnum] max_results - # Optional. Maximum number of results to be returned. If unspecified, the server - # will decide how many results to return. - # @param [String] page_token - # Optional. A tag returned by a previous list request that was truncated. Use - # this parameter to continue a previous list request. - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # Available to use for quota purposes for server-side applications. Can be any - # arbitrary string assigned to a user, but should not exceed 40 characters. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::DnsV2beta1::ManagedZonesListResponse] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::DnsV2beta1::ManagedZonesListResponse] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def list_managed_zones(project, dns_name: nil, max_results: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:get, 'dns/v2beta1/projects/{project}/managedZones', options) - command.response_representation = Google::Apis::DnsV2beta1::ManagedZonesListResponse::Representation - command.response_class = Google::Apis::DnsV2beta1::ManagedZonesListResponse - command.params['project'] = project unless project.nil? - command.query['dnsName'] = dns_name unless dns_name.nil? - command.query['maxResults'] = max_results unless max_results.nil? - command.query['pageToken'] = page_token unless page_token.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - execute_or_queue_command(command, &block) - end - - # Apply a partial update to an existing ManagedZone. - # @param [String] project - # Identifies the project addressed by this request. - # @param [String] managed_zone - # Identifies the managed zone addressed by this request. Can be the managed zone - # name or id. - # @param [Google::Apis::DnsV2beta1::ManagedZone] managed_zone_object - # @param [String] client_operation_id - # For mutating operation requests only. An optional identifier specified by the - # client. Must be unique for operation resources in the Operations collection. - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # Available to use for quota purposes for server-side applications. Can be any - # arbitrary string assigned to a user, but should not exceed 40 characters. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::DnsV2beta1::Operation] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::DnsV2beta1::Operation] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def patch_managed_zone(project, managed_zone, managed_zone_object = nil, client_operation_id: nil, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:patch, 'dns/v2beta1/projects/{project}/managedZones/{managedZone}', options) - command.request_representation = Google::Apis::DnsV2beta1::ManagedZone::Representation - command.request_object = managed_zone_object - command.response_representation = Google::Apis::DnsV2beta1::Operation::Representation - command.response_class = Google::Apis::DnsV2beta1::Operation - command.params['project'] = project unless project.nil? - command.params['managedZone'] = managed_zone unless managed_zone.nil? - command.query['clientOperationId'] = client_operation_id unless client_operation_id.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - execute_or_queue_command(command, &block) - end - - # Update an existing ManagedZone. - # @param [String] project - # Identifies the project addressed by this request. - # @param [String] managed_zone - # Identifies the managed zone addressed by this request. Can be the managed zone - # name or id. - # @param [Google::Apis::DnsV2beta1::ManagedZone] managed_zone_object - # @param [String] client_operation_id - # For mutating operation requests only. An optional identifier specified by the - # client. Must be unique for operation resources in the Operations collection. - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # Available to use for quota purposes for server-side applications. Can be any - # arbitrary string assigned to a user, but should not exceed 40 characters. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::DnsV2beta1::Operation] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::DnsV2beta1::Operation] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def update_managed_zone(project, managed_zone, managed_zone_object = nil, client_operation_id: nil, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:put, 'dns/v2beta1/projects/{project}/managedZones/{managedZone}', options) - command.request_representation = Google::Apis::DnsV2beta1::ManagedZone::Representation - command.request_object = managed_zone_object - command.response_representation = Google::Apis::DnsV2beta1::Operation::Representation - command.response_class = Google::Apis::DnsV2beta1::Operation - command.params['project'] = project unless project.nil? - command.params['managedZone'] = managed_zone unless managed_zone.nil? - command.query['clientOperationId'] = client_operation_id unless client_operation_id.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - execute_or_queue_command(command, &block) - end - - # Create a new Policy - # @param [String] project - # Identifies the project addressed by this request. - # @param [Google::Apis::DnsV2beta1::Policy] policy_object - # @param [String] client_operation_id - # For mutating operation requests only. An optional identifier specified by the - # client. Must be unique for operation resources in the Operations collection. - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # Available to use for quota purposes for server-side applications. Can be any - # arbitrary string assigned to a user, but should not exceed 40 characters. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::DnsV2beta1::Policy] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::DnsV2beta1::Policy] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def create_policy(project, policy_object = nil, client_operation_id: nil, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:post, 'dns/v2beta1/projects/{project}/policies', options) - command.request_representation = Google::Apis::DnsV2beta1::Policy::Representation - command.request_object = policy_object - command.response_representation = Google::Apis::DnsV2beta1::Policy::Representation - command.response_class = Google::Apis::DnsV2beta1::Policy - command.params['project'] = project unless project.nil? - command.query['clientOperationId'] = client_operation_id unless client_operation_id.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - execute_or_queue_command(command, &block) - end - - # Delete a previously created Policy. Will fail if the policy is still being - # referenced by a network. - # @param [String] project - # Identifies the project addressed by this request. - # @param [String] policy - # User given friendly name of the policy addressed by this request. - # @param [String] client_operation_id - # For mutating operation requests only. An optional identifier specified by the - # client. Must be unique for operation resources in the Operations collection. - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # Available to use for quota purposes for server-side applications. Can be any - # arbitrary string assigned to a user, but should not exceed 40 characters. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [NilClass] No result returned for this method - # @yieldparam err [StandardError] error object if request failed - # - # @return [void] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def delete_policy(project, policy, client_operation_id: nil, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:delete, 'dns/v2beta1/projects/{project}/policies/{policy}', options) - command.params['project'] = project unless project.nil? - command.params['policy'] = policy unless policy.nil? - command.query['clientOperationId'] = client_operation_id unless client_operation_id.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - execute_or_queue_command(command, &block) - end - - # Fetch the representation of an existing Policy. - # @param [String] project - # Identifies the project addressed by this request. - # @param [String] policy - # User given friendly name of the policy addressed by this request. - # @param [String] client_operation_id - # For mutating operation requests only. An optional identifier specified by the - # client. Must be unique for operation resources in the Operations collection. - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # Available to use for quota purposes for server-side applications. Can be any - # arbitrary string assigned to a user, but should not exceed 40 characters. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::DnsV2beta1::Policy] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::DnsV2beta1::Policy] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def get_policy(project, policy, client_operation_id: nil, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:get, 'dns/v2beta1/projects/{project}/policies/{policy}', options) - command.response_representation = Google::Apis::DnsV2beta1::Policy::Representation - command.response_class = Google::Apis::DnsV2beta1::Policy - command.params['project'] = project unless project.nil? - command.params['policy'] = policy unless policy.nil? - command.query['clientOperationId'] = client_operation_id unless client_operation_id.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - execute_or_queue_command(command, &block) - end - - # Enumerate all Policies associated with a project. - # @param [String] project - # Identifies the project addressed by this request. - # @param [Fixnum] max_results - # Optional. Maximum number of results to be returned. If unspecified, the server - # will decide how many results to return. - # @param [String] page_token - # Optional. A tag returned by a previous list request that was truncated. Use - # this parameter to continue a previous list request. - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # Available to use for quota purposes for server-side applications. Can be any - # arbitrary string assigned to a user, but should not exceed 40 characters. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::DnsV2beta1::PoliciesListResponse] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::DnsV2beta1::PoliciesListResponse] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def list_policies(project, max_results: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:get, 'dns/v2beta1/projects/{project}/policies', options) - command.response_representation = Google::Apis::DnsV2beta1::PoliciesListResponse::Representation - command.response_class = Google::Apis::DnsV2beta1::PoliciesListResponse - command.params['project'] = project unless project.nil? - command.query['maxResults'] = max_results unless max_results.nil? - command.query['pageToken'] = page_token unless page_token.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - execute_or_queue_command(command, &block) - end - - # Apply a partial update to an existing Policy. - # @param [String] project - # Identifies the project addressed by this request. - # @param [String] policy - # User given friendly name of the policy addressed by this request. - # @param [Google::Apis::DnsV2beta1::Policy] policy_object - # @param [String] client_operation_id - # For mutating operation requests only. An optional identifier specified by the - # client. Must be unique for operation resources in the Operations collection. - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # Available to use for quota purposes for server-side applications. Can be any - # arbitrary string assigned to a user, but should not exceed 40 characters. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::DnsV2beta1::PoliciesPatchResponse] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::DnsV2beta1::PoliciesPatchResponse] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def patch_policy(project, policy, policy_object = nil, client_operation_id: nil, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:patch, 'dns/v2beta1/projects/{project}/policies/{policy}', options) - command.request_representation = Google::Apis::DnsV2beta1::Policy::Representation - command.request_object = policy_object - command.response_representation = Google::Apis::DnsV2beta1::PoliciesPatchResponse::Representation - command.response_class = Google::Apis::DnsV2beta1::PoliciesPatchResponse - command.params['project'] = project unless project.nil? - command.params['policy'] = policy unless policy.nil? - command.query['clientOperationId'] = client_operation_id unless client_operation_id.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - execute_or_queue_command(command, &block) - end - - # Update an existing Policy. - # @param [String] project - # Identifies the project addressed by this request. - # @param [String] policy - # User given friendly name of the policy addressed by this request. - # @param [Google::Apis::DnsV2beta1::Policy] policy_object - # @param [String] client_operation_id - # For mutating operation requests only. An optional identifier specified by the - # client. Must be unique for operation resources in the Operations collection. - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # Available to use for quota purposes for server-side applications. Can be any - # arbitrary string assigned to a user, but should not exceed 40 characters. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::DnsV2beta1::PoliciesUpdateResponse] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::DnsV2beta1::PoliciesUpdateResponse] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def update_policy(project, policy, policy_object = nil, client_operation_id: nil, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:put, 'dns/v2beta1/projects/{project}/policies/{policy}', options) - command.request_representation = Google::Apis::DnsV2beta1::Policy::Representation - command.request_object = policy_object - command.response_representation = Google::Apis::DnsV2beta1::PoliciesUpdateResponse::Representation - command.response_class = Google::Apis::DnsV2beta1::PoliciesUpdateResponse - command.params['project'] = project unless project.nil? - command.params['policy'] = policy unless policy.nil? - command.query['clientOperationId'] = client_operation_id unless client_operation_id.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - execute_or_queue_command(command, &block) - end - - # Fetch the representation of an existing Project. - # @param [String] project - # Identifies the project addressed by this request. - # @param [String] client_operation_id - # For mutating operation requests only. An optional identifier specified by the - # client. Must be unique for operation resources in the Operations collection. - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # Available to use for quota purposes for server-side applications. Can be any - # arbitrary string assigned to a user, but should not exceed 40 characters. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::DnsV2beta1::Project] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::DnsV2beta1::Project] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def get_project(project, client_operation_id: nil, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:get, 'dns/v2beta1/projects/{project}', options) - command.response_representation = Google::Apis::DnsV2beta1::Project::Representation - command.response_class = Google::Apis::DnsV2beta1::Project - command.params['project'] = project unless project.nil? - command.query['clientOperationId'] = client_operation_id unless client_operation_id.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - execute_or_queue_command(command, &block) - end - - # Enumerate ResourceRecordSets that have been created but not yet deleted. - # @param [String] project - # Identifies the project addressed by this request. - # @param [String] managed_zone - # Identifies the managed zone addressed by this request. Can be the managed zone - # name or id. - # @param [Fixnum] max_results - # Optional. Maximum number of results to be returned. If unspecified, the server - # will decide how many results to return. - # @param [String] name - # Restricts the list to return only records with this fully qualified domain - # name. - # @param [String] page_token - # Optional. A tag returned by a previous list request that was truncated. Use - # this parameter to continue a previous list request. - # @param [String] type - # Restricts the list to return only records of this type. If present, the "name" - # parameter must also be present. - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # Available to use for quota purposes for server-side applications. Can be any - # arbitrary string assigned to a user, but should not exceed 40 characters. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::DnsV2beta1::ResourceRecordSetsListResponse] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::DnsV2beta1::ResourceRecordSetsListResponse] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def list_resource_record_sets(project, managed_zone, max_results: nil, name: nil, page_token: nil, type: nil, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:get, 'dns/v2beta1/projects/{project}/managedZones/{managedZone}/rrsets', options) - command.response_representation = Google::Apis::DnsV2beta1::ResourceRecordSetsListResponse::Representation - command.response_class = Google::Apis::DnsV2beta1::ResourceRecordSetsListResponse - command.params['project'] = project unless project.nil? - command.params['managedZone'] = managed_zone unless managed_zone.nil? - command.query['maxResults'] = max_results unless max_results.nil? - command.query['name'] = name unless name.nil? - command.query['pageToken'] = page_token unless page_token.nil? - command.query['type'] = type unless type.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - execute_or_queue_command(command, &block) - end - - protected - - def apply_command_defaults(command) - command.query['key'] = key unless key.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - end - end - end - end -end diff --git a/generated/google/apis/pagespeedonline_v5.rb b/generated/google/apis/pagespeedonline_v5.rb index c5ffae9bc..e1ea79a65 100644 --- a/generated/google/apis/pagespeedonline_v5.rb +++ b/generated/google/apis/pagespeedonline_v5.rb @@ -21,14 +21,14 @@ module Google # PageSpeed Insights API # # The PageSpeed Insights API lets you analyze the performance of your website - # with a simple API. It offers tailored suggestions for how you can optimize + # with a simple API. It offers tailored suggestions for how you can optimize # your site, and lets you easily integrate PageSpeed Insights analysis into your # development tools and workflow. # # @see https://developers.google.com/speed/docs/insights/v5/about module PagespeedonlineV5 VERSION = 'V5' - REVISION = '20200721' + REVISION = '20200813' # Associate you with your personal info on Google PENID = 'openid' diff --git a/generated/google/apis/pagespeedonline_v5/classes.rb b/generated/google/apis/pagespeedonline_v5/classes.rb index 387d09292..98aba29bf 100644 --- a/generated/google/apis/pagespeedonline_v5/classes.rb +++ b/generated/google/apis/pagespeedonline_v5/classes.rb @@ -55,8 +55,7 @@ module Google end # A proportion of data in the total distribution, bucketed by a min/max - # percentage. Each bucket's range is bounded by min <= x < max, In - # millisecond. + # percentage. Each bucket's range is bounded by min <= x < max, In millisecond. class Bucket include Google::Apis::Core::Hashable @@ -159,8 +158,7 @@ module Google class ConfigSettings include Google::Apis::Core::Hashable - # How Lighthouse was run, e.g. from the Chrome extension or from the npm - # module. + # How Lighthouse was run, e.g. from the Chrome extension or from the npm module. # Corresponds to the JSON property `channel` # @return [String] attr_accessor :channel @@ -277,9 +275,9 @@ module Google # @return [String] attr_accessor :id - # A numeric value that has a meaning specific to the audit, e.g. the number - # of nodes in the DOM or the timestamp of a specific load event. More - # information can be found in the audit details, if present. + # A numeric value that has a meaning specific to the audit, e.g. the number of + # nodes in the DOM or the timestamp of a specific load event. More information + # can be found in the audit details, if present. # Corresponds to the JSON property `numericValue` # @return [Float] attr_accessor :numeric_value @@ -348,8 +346,8 @@ module Google # @return [String] attr_accessor :manual_description - # The overall score of the category, the weighted average of all its audits. - # (The category's score, can be null.) + # The overall score of the category, the weighted average of all its audits. ( + # The category's score, can be null.) # Corresponds to the JSON property `score` # @return [Object] attr_accessor :score @@ -428,7 +426,7 @@ module Google # @return [String] attr_accessor :requested_url - # List of all run warnings in the LHR. Will always output to at least `[]`. + # List of all run warnings in the LHR. Will always output to at least `[]`. # Corresponds to the JSON property `runWarnings` # @return [Array] attr_accessor :run_warnings @@ -491,7 +489,7 @@ module Google # @return [String] attr_accessor :initial_url - # The map of . + # The map of . # Corresponds to the JSON property `metrics` # @return [Hash] attr_accessor :metrics @@ -535,8 +533,8 @@ module Google # @return [String] attr_accessor :captcha_result - # Canonicalized and final URL for the document, after following page - # redirects (if any). + # Canonicalized and final URL for the document, after following page redirects ( + # if any). # Corresponds to the JSON property `id` # @return [String] attr_accessor :id @@ -642,14 +640,12 @@ module Google # @return [String] attr_accessor :lab_data_title - # The disclaimer shown under performance explaning that the network can - # vary. + # The disclaimer shown under performance explaning that the network can vary. # Corresponds to the JSON property `lsPerformanceCategoryDescription` # @return [String] attr_accessor :ls_performance_category_description - # The heading shown above a list of audits that were not computerd in the - # run. + # The heading shown above a list of audits that were not computerd in the run. # Corresponds to the JSON property `manualAuditsGroupTitle` # @return [String] attr_accessor :manual_audits_group_title @@ -659,8 +655,7 @@ module Google # @return [String] attr_accessor :not_applicable_audits_group_title - # The heading for the estimated page load savings opportunity of an - # audit. + # The heading for the estimated page load savings opportunity of an audit. # Corresponds to the JSON property `opportunityResourceColumnLabel` # @return [String] attr_accessor :opportunity_resource_column_label @@ -680,8 +675,8 @@ module Google # @return [String] attr_accessor :scorescale_label - # The label shown preceding important warnings that may have invalidated - # an entire report. + # The label shown preceding important warnings that may have invalidated an + # entire report. # Corresponds to the JSON property `toplevelWarningsMessage` # @return [String] attr_accessor :toplevel_warnings_message @@ -831,9 +826,8 @@ module Google # @return [String] attr_accessor :metric_id - # We use this field to store certain percentile value for this metric. - # For v4, this field contains pc50. - # For v5, this field contains pc90. + # We use this field to store certain percentile value for this metric. For v4, + # this field contains pc50. For v5, this field contains pc90. # Corresponds to the JSON property `percentile` # @return [Fixnum] attr_accessor :percentile diff --git a/generated/google/apis/pagespeedonline_v5/service.rb b/generated/google/apis/pagespeedonline_v5/service.rb index d27c40baf..35ecad1e7 100644 --- a/generated/google/apis/pagespeedonline_v5/service.rb +++ b/generated/google/apis/pagespeedonline_v5/service.rb @@ -23,7 +23,7 @@ module Google # PageSpeed Insights API # # The PageSpeed Insights API lets you analyze the performance of your website - # with a simple API. It offers tailored suggestions for how you can optimize + # with a simple API. It offers tailored suggestions for how you can optimize # your site, and lets you easily integrate PageSpeed Insights analysis into your # development tools and workflow. # @@ -61,10 +61,9 @@ module Google # @param [String] locale # The locale used to localize formatted results # @param [String] strategy - # The analysis strategy (desktop or mobile) to use, and desktop is the - # default + # The analysis strategy (desktop or mobile) to use, and desktop is the default # @param [String] url - # The URL to fetch and analyze + # Required. The URL to fetch and analyze # @param [String] utm_campaign # Campaign name for analytics. # @param [String] utm_source diff --git a/generated/google/apis/people_v1.rb b/generated/google/apis/people_v1.rb index d3d3f1a36..9c53939ef 100644 --- a/generated/google/apis/people_v1.rb +++ b/generated/google/apis/people_v1.rb @@ -25,7 +25,7 @@ module Google # @see https://developers.google.com/people/ module PeopleV1 VERSION = 'V1' - REVISION = '20200805' + REVISION = '20200813' # See, edit, download, and permanently delete your contacts AUTH_CONTACTS = 'https://www.googleapis.com/auth/contacts' diff --git a/generated/google/apis/people_v1/classes.rb b/generated/google/apis/people_v1/classes.rb index 4a773f362..901b465ca 100644 --- a/generated/google/apis/people_v1/classes.rb +++ b/generated/google/apis/people_v1/classes.rb @@ -502,9 +502,9 @@ module Google # the copy mask with metadata and membership fields if not set. Valid values are: # * addresses * ageRanges * biographies * birthdays * calendarUrls * clientData # * coverPhotos * emailAddresses * events * externalIds * genders * imClients * - # interests * locales * memberships * metadata * miscKeywords * names * - # nicknames * occupations * organizations * phoneNumbers * photos * relations * - # residences * sipAddresses * skills * urls * userDefined + # interests * locales * locations * memberships * metadata * miscKeywords * + # names * nicknames * occupations * organizations * phoneNumbers * photos * + # relations * sipAddresses * skills * urls * userDefined # Corresponds to the JSON property `readMask` # @return [String] attr_accessor :read_mask @@ -1187,6 +1187,69 @@ module Google end end + # A person's location. + class Location + include Google::Apis::Core::Hashable + + # The building identifier. + # Corresponds to the JSON property `buildingId` + # @return [String] + attr_accessor :building_id + + # Whether the location is the current location. + # Corresponds to the JSON property `current` + # @return [Boolean] + attr_accessor :current + alias_method :current?, :current + + # The individual desk location. + # Corresponds to the JSON property `deskCode` + # @return [String] + attr_accessor :desk_code + + # The floor name or number. + # Corresponds to the JSON property `floor` + # @return [String] + attr_accessor :floor + + # The floor section in `floor_name`. + # Corresponds to the JSON property `floorSection` + # @return [String] + attr_accessor :floor_section + + # Metadata about a field. + # Corresponds to the JSON property `metadata` + # @return [Google::Apis::PeopleV1::FieldMetadata] + attr_accessor :metadata + + # The type of the location. The type can be custom or one of these predefined + # values: * `desk` * `grewUp` + # Corresponds to the JSON property `type` + # @return [String] + attr_accessor :type + + # The free-form value of the location. + # Corresponds to the JSON property `value` + # @return [String] + attr_accessor :value + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @building_id = args[:building_id] if args.key?(:building_id) + @current = args[:current] if args.key?(:current) + @desk_code = args[:desk_code] if args.key?(:desk_code) + @floor = args[:floor] if args.key?(:floor) + @floor_section = args[:floor_section] if args.key?(:floor_section) + @metadata = args[:metadata] if args.key?(:metadata) + @type = args[:type] if args.key?(:type) + @value = args[:value] if args.key?(:value) + end + end + # A person's membership in a group. Only contact group memberships can be # modified. class Membership @@ -1689,6 +1752,11 @@ module Google # @return [Array] attr_accessor :locales + # The person's locations. + # Corresponds to the JSON property `locations` + # @return [Array] + attr_accessor :locations + # The person's group memberships. # Corresponds to the JSON property `memberships` # @return [Array] @@ -1751,7 +1819,8 @@ module Google # @return [Array] attr_accessor :relationship_statuses - # The person's residences. + # **DEPRECATED**: (Please use `person.locations` instead) The person's + # residences. # Corresponds to the JSON property `residences` # @return [Array] attr_accessor :residences @@ -1811,6 +1880,7 @@ module Google @im_clients = args[:im_clients] if args.key?(:im_clients) @interests = args[:interests] if args.key?(:interests) @locales = args[:locales] if args.key?(:locales) + @locations = args[:locations] if args.key?(:locations) @memberships = args[:memberships] if args.key?(:memberships) @metadata = args[:metadata] if args.key?(:metadata) @misc_keywords = args[:misc_keywords] if args.key?(:misc_keywords) @@ -2154,7 +2224,8 @@ module Google end end - # A person's past or current residence. + # **DEPRECATED**: Please use `person.locations` instead. A person's past or + # current residence. class Residence include Google::Apis::Core::Hashable @@ -2426,9 +2497,9 @@ module Google # empty if not set, which will skip the post mutate get. Valid values are: * # addresses * ageRanges * biographies * birthdays * calendarUrls * clientData * # coverPhotos * emailAddresses * events * externalIds * genders * imClients * - # interests * locales * memberships * metadata * miscKeywords * names * - # nicknames * occupations * organizations * phoneNumbers * photos * relations * - # residences * sipAddresses * skills * urls * userDefined + # interests * locales * locations * memberships * metadata * miscKeywords * + # names * nicknames * occupations * organizations * phoneNumbers * photos * + # relations * sipAddresses * skills * urls * userDefined # Corresponds to the JSON property `personFields` # @return [String] attr_accessor :person_fields diff --git a/generated/google/apis/people_v1/representations.rb b/generated/google/apis/people_v1/representations.rb index bc274662a..78325a0a3 100644 --- a/generated/google/apis/people_v1/representations.rb +++ b/generated/google/apis/people_v1/representations.rb @@ -220,6 +220,12 @@ module Google include Google::Apis::Core::JsonObjectSupport end + class Location + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class Membership class Representation < Google::Apis::Core::JsonRepresentation; end @@ -727,6 +733,21 @@ module Google end end + class Location + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :building_id, as: 'buildingId' + property :current, as: 'current' + property :desk_code, as: 'deskCode' + property :floor, as: 'floor' + property :floor_section, as: 'floorSection' + property :metadata, as: 'metadata', class: Google::Apis::PeopleV1::FieldMetadata, decorator: Google::Apis::PeopleV1::FieldMetadata::Representation + + property :type, as: 'type' + property :value, as: 'value' + end + end + class Membership # @private class Representation < Google::Apis::Core::JsonRepresentation @@ -867,6 +888,8 @@ module Google collection :locales, as: 'locales', class: Google::Apis::PeopleV1::Locale, decorator: Google::Apis::PeopleV1::Locale::Representation + collection :locations, as: 'locations', class: Google::Apis::PeopleV1::Location, decorator: Google::Apis::PeopleV1::Location::Representation + collection :memberships, as: 'memberships', class: Google::Apis::PeopleV1::Membership, decorator: Google::Apis::PeopleV1::Membership::Representation property :metadata, as: 'metadata', class: Google::Apis::PeopleV1::PersonMetadata, decorator: Google::Apis::PeopleV1::PersonMetadata::Representation diff --git a/generated/google/apis/people_v1/service.rb b/generated/google/apis/people_v1/service.rb index b6fa2d822..67c6baf44 100644 --- a/generated/google/apis/people_v1/service.rb +++ b/generated/google/apis/people_v1/service.rb @@ -392,10 +392,10 @@ module Google # Multiple fields can be specified by separating them with commas. Defaults to # all fields if not set. Valid values are: * addresses * ageRanges * biographies # * birthdays * calendarUrls * clientData * coverPhotos * emailAddresses * - # events * externalIds * genders * imClients * interests * locales * memberships - # * metadata * miscKeywords * names * nicknames * occupations * organizations * - # phoneNumbers * photos * relations * residences * sipAddresses * skills * urls * - # userDefined + # events * externalIds * genders * imClients * interests * locales * locations * + # memberships * metadata * miscKeywords * names * nicknames * occupations * + # organizations * phoneNumbers * photos * relations * sipAddresses * skills * + # urls * userDefined # @param [Array, String] sources # Optional. A mask of what source types to return. Defaults to ReadSourceType. # CONTACT and ReadSourceType.PROFILE if not set. @@ -468,9 +468,9 @@ module Google # empty if not set, which will skip the post mutate get. Valid values are: * # addresses * ageRanges * biographies * birthdays * calendarUrls * clientData * # coverPhotos * emailAddresses * events * externalIds * genders * imClients * - # interests * locales * memberships * metadata * miscKeywords * names * - # nicknames * occupations * organizations * phoneNumbers * photos * relations * - # residences * sipAddresses * skills * urls * userDefined + # interests * locales * locations * memberships * metadata * miscKeywords * + # names * nicknames * occupations * organizations * phoneNumbers * photos * + # relations * sipAddresses * skills * urls * userDefined # @param [Array, String] sources # Optional. A mask of what source types to return. Defaults to ReadSourceType. # CONTACT and ReadSourceType.PROFILE if not set. @@ -518,9 +518,9 @@ module Google # Multiple fields can be specified by separating them with commas. Valid values # are: * addresses * ageRanges * biographies * birthdays * calendarUrls * # clientData * coverPhotos * emailAddresses * events * externalIds * genders * - # imClients * interests * locales * memberships * metadata * miscKeywords * - # names * nicknames * occupations * organizations * phoneNumbers * photos * - # relations * residences * sipAddresses * skills * urls * userDefined + # imClients * interests * locales * locations * memberships * metadata * + # miscKeywords * names * nicknames * occupations * organizations * phoneNumbers * + # photos * relations * sipAddresses * skills * urls * userDefined # @param [String] request_mask_include_field # Required. Comma-separated list of person fields to be included in the response. # Each path should start with `person.`: for example, `person.names` or `person. @@ -566,9 +566,9 @@ module Google # Multiple fields can be specified by separating them with commas. Valid values # are: * addresses * ageRanges * biographies * birthdays * calendarUrls * # clientData * coverPhotos * emailAddresses * events * externalIds * genders * - # imClients * interests * locales * memberships * metadata * miscKeywords * - # names * nicknames * occupations * organizations * phoneNumbers * photos * - # relations * residences * sipAddresses * skills * urls * userDefined + # imClients * interests * locales * locations * memberships * metadata * + # miscKeywords * names * nicknames * occupations * organizations * phoneNumbers * + # photos * relations * sipAddresses * skills * urls * userDefined # @param [String] request_mask_include_field # Required. Comma-separated list of person fields to be included in the response. # Each path should start with `person.`: for example, `person.names` or `person. @@ -631,9 +631,9 @@ module Google # Multiple fields can be specified by separating them with commas. Valid values # are: * addresses * ageRanges * biographies * birthdays * calendarUrls * # clientData * coverPhotos * emailAddresses * events * externalIds * genders * - # imClients * interests * locales * memberships * metadata * miscKeywords * - # names * nicknames * occupations * organizations * phoneNumbers * photos * - # relations * residences * sipAddresses * skills * urls * userDefined + # imClients * interests * locales * locations * memberships * metadata * + # miscKeywords * names * nicknames * occupations * organizations * phoneNumbers * + # photos * relations * sipAddresses * skills * urls * userDefined # @param [Boolean] request_sync_token # Optional. Whether the response should include `next_sync_token`, which can be # used to get all changes since the last request. For subsequent sync requests @@ -699,9 +699,9 @@ module Google # Multiple fields can be specified by separating them with commas. Valid values # are: * addresses * ageRanges * biographies * birthdays * calendarUrls * # clientData * coverPhotos * emailAddresses * events * externalIds * genders * - # imClients * interests * locales * memberships * metadata * miscKeywords * - # names * nicknames * occupations * organizations * phoneNumbers * photos * - # relations * residences * sipAddresses * skills * urls * userDefined + # imClients * interests * locales * locations * memberships * metadata * + # miscKeywords * names * nicknames * occupations * organizations * phoneNumbers * + # photos * relations * sipAddresses * skills * urls * userDefined # @param [Array, String] sources # Required. Directory sources to return. # @param [String] fields @@ -758,10 +758,10 @@ module Google # Multiple fields can be specified by separating them with commas. Defaults to # all fields if not set. Valid values are: * addresses * ageRanges * biographies # * birthdays * calendarUrls * clientData * coverPhotos * emailAddresses * - # events * externalIds * genders * imClients * interests * locales * memberships - # * metadata * miscKeywords * names * nicknames * occupations * organizations * - # phoneNumbers * photos * relations * residences * sipAddresses * skills * urls * - # userDefined + # events * externalIds * genders * imClients * interests * locales * locations * + # memberships * metadata * miscKeywords * names * nicknames * occupations * + # organizations * phoneNumbers * photos * relations * sipAddresses * skills * + # urls * userDefined # @param [Array, String] sources # Optional. A mask of what source types to return. Defaults to ReadSourceType. # CONTACT and ReadSourceType.PROFILE if not set. @@ -770,9 +770,9 @@ module Google # Multiple fields can be specified by separating them with commas. All updated # fields will be replaced. Valid values are: * addresses * biographies * # birthdays * calendarUrls * clientData * emailAddresses * events * externalIds * - # genders * imClients * interests * locales * memberships * miscKeywords * - # names * nicknames * occupations * organizations * phoneNumbers * relations * - # residences * sipAddresses * urls * userDefined + # genders * imClients * interests * locales * locations * memberships * + # miscKeywords * names * nicknames * occupations * organizations * phoneNumbers * + # relations * sipAddresses * urls * userDefined # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -856,9 +856,9 @@ module Google # Multiple fields can be specified by separating them with commas. Valid values # are: * addresses * ageRanges * biographies * birthdays * calendarUrls * # clientData * coverPhotos * emailAddresses * events * externalIds * genders * - # imClients * interests * locales * memberships * metadata * miscKeywords * - # names * nicknames * occupations * organizations * phoneNumbers * photos * - # relations * residences * sipAddresses * skills * urls * userDefined + # imClients * interests * locales * locations * memberships * metadata * + # miscKeywords * names * nicknames * occupations * organizations * phoneNumbers * + # photos * relations * sipAddresses * skills * urls * userDefined # @param [String] request_mask_include_field # Required. Comma-separated list of person fields to be included in the response. # Each path should start with `person.`: for example, `person.names` or `person. diff --git a/generated/google/apis/prod_tt_sasportal_v1alpha1.rb b/generated/google/apis/prod_tt_sasportal_v1alpha1.rb index 286b2e4a5..5bf7ce601 100644 --- a/generated/google/apis/prod_tt_sasportal_v1alpha1.rb +++ b/generated/google/apis/prod_tt_sasportal_v1alpha1.rb @@ -25,7 +25,7 @@ module Google # @see https://developers.google.com/spectrum-access-system/ module ProdTtSasportalV1alpha1 VERSION = 'V1alpha1' - REVISION = '20200801' + REVISION = '20200813' # View your email address AUTH_USERINFO_EMAIL = 'https://www.googleapis.com/auth/userinfo.email' diff --git a/generated/google/apis/prod_tt_sasportal_v1alpha1/classes.rb b/generated/google/apis/prod_tt_sasportal_v1alpha1/classes.rb index bf04144bb..8ff78d0d5 100644 --- a/generated/google/apis/prod_tt_sasportal_v1alpha1/classes.rb +++ b/generated/google/apis/prod_tt_sasportal_v1alpha1/classes.rb @@ -338,6 +338,11 @@ module Google # @return [Google::Apis::ProdTtSasportalV1alpha1::SasPortalFrequencyRange] attr_accessor :frequency_range + # Grant Id. + # Corresponds to the JSON property `grantId` + # @return [String] + attr_accessor :grant_id + # Maximum Equivalent Isotropically Radiated Power (EIRP) permitted by the grant. # The maximum EIRP is in units of dBm/MHz. The value of maxEirp represents the # average (RMS) EIRP that would be measured by the procedure defined in FCC part @@ -370,6 +375,7 @@ module Google @channel_type = args[:channel_type] if args.key?(:channel_type) @expire_time = args[:expire_time] if args.key?(:expire_time) @frequency_range = args[:frequency_range] if args.key?(:frequency_range) + @grant_id = args[:grant_id] if args.key?(:grant_id) @max_eirp = args[:max_eirp] if args.key?(:max_eirp) @move_list = args[:move_list] if args.key?(:move_list) @state = args[:state] if args.key?(:state) diff --git a/generated/google/apis/prod_tt_sasportal_v1alpha1/representations.rb b/generated/google/apis/prod_tt_sasportal_v1alpha1/representations.rb index f8fce0fc6..2323be1fc 100644 --- a/generated/google/apis/prod_tt_sasportal_v1alpha1/representations.rb +++ b/generated/google/apis/prod_tt_sasportal_v1alpha1/representations.rb @@ -319,6 +319,7 @@ module Google property :expire_time, as: 'expireTime' property :frequency_range, as: 'frequencyRange', class: Google::Apis::ProdTtSasportalV1alpha1::SasPortalFrequencyRange, decorator: Google::Apis::ProdTtSasportalV1alpha1::SasPortalFrequencyRange::Representation + property :grant_id, as: 'grantId' property :max_eirp, as: 'maxEirp' collection :move_list, as: 'moveList', class: Google::Apis::ProdTtSasportalV1alpha1::SasPortalDpaMoveList, decorator: Google::Apis::ProdTtSasportalV1alpha1::SasPortalDpaMoveList::Representation diff --git a/generated/google/apis/recommendationengine_v1beta1.rb b/generated/google/apis/recommendationengine_v1beta1.rb index ce820694b..a0f69afb1 100644 --- a/generated/google/apis/recommendationengine_v1beta1.rb +++ b/generated/google/apis/recommendationengine_v1beta1.rb @@ -27,7 +27,7 @@ module Google # @see https://cloud.google.com/recommendations-ai/docs module RecommendationengineV1beta1 VERSION = 'V1beta1' - REVISION = '20200803' + 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/recommendationengine_v1beta1/classes.rb b/generated/google/apis/recommendationengine_v1beta1/classes.rb index b170bc205..899d3a3fb 100644 --- a/generated/google/apis/recommendationengine_v1beta1/classes.rb +++ b/generated/google/apis/recommendationengine_v1beta1/classes.rb @@ -147,7 +147,8 @@ module Google # com/recommendations-ai/docs/upload-catalog#mc Supported values for user event # imports: 1: "user_events_recommendations_ai" using https://cloud.google.com/ # recommendations-ai/docs/manage-user-events#import (Default for userEvents. - # import) + # import) 2. "user_events_ga360" using https://support.google.com/analytics/ + # answer/3437719?hl=en # Corresponds to the JSON property `dataSchema` # @return [String] attr_accessor :data_schema @@ -564,7 +565,8 @@ module Google # com/recommendations-ai/docs/upload-catalog#mc Supported values for user events # imports: 1: "user_events_recommendations_ai" using https://cloud.google.com/ # recommendations-ai/docs/manage-user-events#import (Default for userEvents. - # import) + # import) 2. "user_events_ga360" using https://support.google.com/analytics/ + # answer/3437719?hl=en # Corresponds to the JSON property `jsonSchema` # @return [String] attr_accessor :json_schema diff --git a/generated/google/apis/recommendationengine_v1beta1/service.rb b/generated/google/apis/recommendationengine_v1beta1/service.rb index 7f32e3c74..e1ba16294 100644 --- a/generated/google/apis/recommendationengine_v1beta1/service.rb +++ b/generated/google/apis/recommendationengine_v1beta1/service.rb @@ -92,8 +92,9 @@ module Google # The fully qualified resource name of the catalog. # @param [Google::Apis::RecommendationengineV1beta1::GoogleCloudRecommendationengineV1beta1Catalog] google_cloud_recommendationengine_v1beta1_catalog_object # @param [String] update_mask - # Optional. Indicates which fields in the provided 'recommendation_model' to - # update. If not set, will only update the catalog_item_level_config field. + # Optional. Indicates which fields in the provided 'catalog' to update. If not + # set, will only update the catalog_item_level_config field. Currently only + # fields that can be updated are catalog_item_level_config. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user diff --git a/generated/google/apis/servicecontrol_v2.rb b/generated/google/apis/servicecontrol_v2.rb index 0de52148a..5b8080a95 100644 --- a/generated/google/apis/servicecontrol_v2.rb +++ b/generated/google/apis/servicecontrol_v2.rb @@ -26,7 +26,7 @@ module Google # @see https://cloud.google.com/service-control/ module ServicecontrolV2 VERSION = 'V2' - REVISION = '20200727' + REVISION = '20200808' # 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/servicecontrol_v2/classes.rb b/generated/google/apis/servicecontrol_v2/classes.rb index 39f2f156c..41ea7d15f 100644 --- a/generated/google/apis/servicecontrol_v2/classes.rb +++ b/generated/google/apis/servicecontrol_v2/classes.rb @@ -22,9 +22,9 @@ module Google module Apis module ServicecontrolV2 - # This message defines attributes associated with API operations, such as - # a network API request. The terminology is based on the conventions used - # by Google APIs, Istio, and OpenAPI. + # This message defines attributes associated with API operations, such as a + # network API request. The terminology is based on the conventions used by + # Google APIs, Istio, and OpenAPI. class Api include Google::Apis::Core::Hashable @@ -35,21 +35,21 @@ module Google # @return [String] attr_accessor :operation - # The API protocol used for sending the request, such as "http", "https", - # "grpc", or "internal". + # The API protocol used for sending the request, such as "http", "https", "grpc", + # or "internal". # Corresponds to the JSON property `protocol` # @return [String] attr_accessor :protocol - # The API service name. It is a logical identifier for a networked API, - # such as "pubsub.googleapis.com". The naming syntax depends on the - # API management system being used for handling the request. + # The API service name. It is a logical identifier for a networked API, such as " + # pubsub.googleapis.com". The naming syntax depends on the API management system + # being used for handling the request. # Corresponds to the JSON property `service` # @return [String] attr_accessor :service - # The API version associated with the API operation above, such as "v1" or - # "v1alpha1". + # The API version associated with the API operation above, such as "v1" or " + # v1alpha1". # Corresponds to the JSON property `version` # @return [String] attr_accessor :version @@ -67,33 +67,31 @@ module Google end end - # This message defines the standard attribute vocabulary for Google APIs. - # An attribute is a piece of metadata that describes an activity on a network - # service. For example, the size of an HTTP request, or the status code of - # an HTTP response. - # Each attribute has a type and a name, which is logically defined as - # a proto message field in `AttributeContext`. The field type becomes the - # attribute type, and the field path becomes the attribute name. For example, - # the attribute `source.ip` maps to field `AttributeContext.source.ip`. - # This message definition is guaranteed not to have any wire breaking change. - # So you can use it directly for passing attributes across different systems. - # NOTE: Different system may generate different subset of attributes. Please - # verify the system specification before relying on an attribute generated - # a system. + # This message defines the standard attribute vocabulary for Google APIs. An + # attribute is a piece of metadata that describes an activity on a network + # service. For example, the size of an HTTP request, or the status code of an + # HTTP response. Each attribute has a type and a name, which is logically + # defined as a proto message field in `AttributeContext`. The field type becomes + # the attribute type, and the field path becomes the attribute name. For example, + # the attribute `source.ip` maps to field `AttributeContext.source.ip`. This + # message definition is guaranteed not to have any wire breaking change. So you + # can use it directly for passing attributes across different systems. NOTE: + # Different system may generate different subset of attributes. Please verify + # the system specification before relying on an attribute generated a system. class AttributeContext include Google::Apis::Core::Hashable - # This message defines attributes associated with API operations, such as - # a network API request. The terminology is based on the conventions used - # by Google APIs, Istio, and OpenAPI. + # This message defines attributes associated with API operations, such as a + # network API request. The terminology is based on the conventions used by + # Google APIs, Istio, and OpenAPI. # Corresponds to the JSON property `api` # @return [Google::Apis::ServicecontrolV2::Api] attr_accessor :api - # This message defines attributes for a node that handles a network request. - # The node can be either a service or an application that sends, forwards, - # or receives the request. Service peers should fill in - # `principal` and `labels` as appropriate. + # This message defines attributes for a node that handles a network request. The + # node can be either a service or an application that sends, forwards, or + # receives the request. Service peers should fill in `principal` and `labels` as + # appropriate. # Corresponds to the JSON property `destination` # @return [Google::Apis::ServicecontrolV2::Peer] attr_accessor :destination @@ -103,38 +101,38 @@ module Google # @return [Array>] attr_accessor :extensions - # This message defines attributes for a node that handles a network request. - # The node can be either a service or an application that sends, forwards, - # or receives the request. Service peers should fill in - # `principal` and `labels` as appropriate. + # This message defines attributes for a node that handles a network request. The + # node can be either a service or an application that sends, forwards, or + # receives the request. Service peers should fill in `principal` and `labels` as + # appropriate. # Corresponds to the JSON property `origin` # @return [Google::Apis::ServicecontrolV2::Peer] attr_accessor :origin - # This message defines attributes for an HTTP request. If the actual - # request is not an HTTP request, the runtime system should try to map - # the actual request to an equivalent HTTP request. + # This message defines attributes for an HTTP request. If the actual request is + # not an HTTP request, the runtime system should try to map the actual request + # to an equivalent HTTP request. # Corresponds to the JSON property `request` # @return [Google::Apis::ServicecontrolV2::Request] attr_accessor :request # This message defines core attributes for a resource. A resource is an - # addressable (named) entity provided by the destination service. For - # example, a file stored on a network storage service. + # addressable (named) entity provided by the destination service. For example, a + # file stored on a network storage service. # Corresponds to the JSON property `resource` # @return [Google::Apis::ServicecontrolV2::Resource] attr_accessor :resource - # This message defines attributes for a typical network response. It - # generally models semantics of an HTTP response. + # This message defines attributes for a typical network response. It generally + # models semantics of an HTTP response. # Corresponds to the JSON property `response` # @return [Google::Apis::ServicecontrolV2::Response] attr_accessor :response - # This message defines attributes for a node that handles a network request. - # The node can be either a service or an application that sends, forwards, - # or receives the request. Service peers should fill in - # `principal` and `labels` as appropriate. + # This message defines attributes for a node that handles a network request. The + # node can be either a service or an application that sends, forwards, or + # receives the request. Service peers should fill in `principal` and `labels` as + # appropriate. # Corresponds to the JSON property `source` # @return [Google::Apis::ServicecontrolV2::Peer] attr_accessor :source @@ -165,40 +163,36 @@ module Google # @return [Google::Apis::ServicecontrolV2::AuthenticationInfo] attr_accessor :authentication_info - # Authorization information. If there are multiple - # resources or permissions involved, then there is - # one AuthorizationInfo element for each `resource, permission` tuple. + # Authorization information. If there are multiple resources or permissions + # involved, then there is one AuthorizationInfo element for each `resource, + # permission` tuple. # Corresponds to the JSON property `authorizationInfo` # @return [Array] attr_accessor :authorization_info - # Other service-specific data about the request, response, and other - # information associated with the current audited event. + # Other service-specific data about the request, response, and other information + # associated with the current audited event. # Corresponds to the JSON property `metadata` # @return [Hash] attr_accessor :metadata - # The name of the service method or operation. - # For API calls, this should be the name of the API method. - # For example, - # "google.cloud.bigquery.v2.TableService.InsertTable" - # "google.logging.v2.ConfigServiceV2.CreateSink" + # The name of the service method or operation. For API calls, this should be the + # name of the API method. For example, "google.cloud.bigquery.v2.TableService. + # InsertTable" "google.logging.v2.ConfigServiceV2.CreateSink" # Corresponds to the JSON property `methodName` # @return [String] attr_accessor :method_name - # The number of items returned from a List or Query API method, - # if applicable. + # The number of items returned from a List or Query API method, if applicable. # Corresponds to the JSON property `numResponseItems` # @return [Fixnum] attr_accessor :num_response_items - # The operation request. This may not include all request parameters, - # such as those that are too large, privacy-sensitive, or duplicated - # elsewhere in the log record. - # It should never include user-generated data, such as file contents. - # When the JSON object represented here has a proto equivalent, the proto - # name will be indicated in the `@type` property. + # The operation request. This may not include all request parameters, such as + # those that are too large, privacy-sensitive, or duplicated elsewhere in the + # log record. It should never include user-generated data, such as file contents. + # When the JSON object represented here has a proto equivalent, the proto name + # will be indicated in the `@type` property. # Corresponds to the JSON property `request` # @return [Hash] attr_accessor :request @@ -213,55 +207,51 @@ module Google # @return [Google::Apis::ServicecontrolV2::ResourceLocation] attr_accessor :resource_location - # The resource or collection that is the target of the operation. - # The name is a scheme-less URI, not including the API service name. - # For example: - # "projects/PROJECT_ID/zones/us-central1-a/instances" - # "projects/PROJECT_ID/datasets/DATASET_ID" + # The resource or collection that is the target of the operation. The name is a + # scheme-less URI, not including the API service name. For example: "projects/ + # PROJECT_ID/zones/us-central1-a/instances" "projects/PROJECT_ID/datasets/ + # DATASET_ID" # Corresponds to the JSON property `resourceName` # @return [String] attr_accessor :resource_name - # The resource's original state before mutation. Present only for - # operations which have successfully modified the targeted resource(s). - # In general, this field should contain all changed fields, except those - # that are already been included in `request`, `response`, `metadata` or - # `service_data` fields. - # When the JSON object represented here has a proto equivalent, - # the proto name will be indicated in the `@type` property. + # The resource's original state before mutation. Present only for operations + # which have successfully modified the targeted resource(s). In general, this + # field should contain all changed fields, except those that are already been + # included in `request`, `response`, `metadata` or `service_data` fields. When + # the JSON object represented here has a proto equivalent, the proto name will + # be indicated in the `@type` property. # Corresponds to the JSON property `resourceOriginalState` # @return [Hash] attr_accessor :resource_original_state - # The operation response. This may not include all response elements, - # such as those that are too large, privacy-sensitive, or duplicated - # elsewhere in the log record. - # It should never include user-generated data, such as file contents. - # When the JSON object represented here has a proto equivalent, the proto - # name will be indicated in the `@type` property. + # The operation response. This may not include all response elements, such as + # those that are too large, privacy-sensitive, or duplicated elsewhere in the + # log record. It should never include user-generated data, such as file contents. + # When the JSON object represented here has a proto equivalent, the proto name + # will be indicated in the `@type` property. # Corresponds to the JSON property `response` # @return [Hash] attr_accessor :response - # Deprecated. Use the `metadata` field instead. - # Other service-specific data about the request, response, and other - # activities. + # Deprecated. Use the `metadata` field instead. Other service-specific data + # about the request, response, and other activities. # Corresponds to the JSON property `serviceData` # @return [Hash] attr_accessor :service_data - # The name of the API service performing the operation. For example, - # `"compute.googleapis.com"`. + # The name of the API service performing the operation. For example, `"compute. + # googleapis.com"`. # Corresponds to the JSON property `serviceName` # @return [String] attr_accessor :service_name - # 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::ServicecontrolV2::Status] attr_accessor :status @@ -289,69 +279,59 @@ module Google end end - # This message defines request authentication attributes. Terminology is - # based on the JSON Web Token (JWT) standard, but the terms also - # correlate to concepts in other standards. + # This message defines request authentication attributes. Terminology is based + # on the JSON Web Token (JWT) standard, but the terms also correlate to concepts + # in other standards. class Auth include Google::Apis::Core::Hashable - # A list of access level resource names that allow resources to be - # accessed by authenticated requester. It is part of Secure GCP processing - # for the incoming request. An access level string has the format: - # "//`api_service_name`/accessPolicies/`policy_id`/accessLevels/`short_name`" - # Example: - # "//accesscontextmanager.googleapis.com/accessPolicies/MY_POLICY_ID/ - # accessLevels/MY_LEVEL" + # A list of access level resource names that allow resources to be accessed by + # authenticated requester. It is part of Secure GCP processing for the incoming + # request. An access level string has the format: "//`api_service_name`/ + # accessPolicies/`policy_id`/accessLevels/`short_name`" Example: "// + # accesscontextmanager.googleapis.com/accessPolicies/MY_POLICY_ID/accessLevels/ + # MY_LEVEL" # Corresponds to the JSON property `accessLevels` # @return [Array] attr_accessor :access_levels - # The intended audience(s) for this authentication information. Reflects - # the audience (`aud`) claim within a JWT. The audience - # value(s) depends on the `issuer`, but typically include one or more of - # the following pieces of information: - # * The services intended to receive the credential. For example, - # ["https://pubsub.googleapis.com/", "https://storage.googleapis.com/"]. - # * A set of service-based scopes. For example, - # ["https://www.googleapis.com/auth/cloud-platform"]. - # * The client id of an app, such as the Firebase project id for JWTs - # from Firebase Auth. - # Consult the documentation for the credential issuer to determine the - # information provided. + # The intended audience(s) for this authentication information. Reflects the + # audience (`aud`) claim within a JWT. The audience value(s) depends on the ` + # issuer`, but typically include one or more of the following pieces of + # information: * The services intended to receive the credential. For example, [" + # https://pubsub.googleapis.com/", "https://storage.googleapis.com/"]. * A set + # of service-based scopes. For example, ["https://www.googleapis.com/auth/cloud- + # platform"]. * The client id of an app, such as the Firebase project id for + # JWTs from Firebase Auth. Consult the documentation for the credential issuer + # to determine the information provided. # Corresponds to the JSON property `audiences` # @return [Array] attr_accessor :audiences - # Structured claims presented with the credential. JWTs include - # ``key: value`` pairs for standard and private claims. The following - # is a subset of the standard required and optional claims that would - # typically be presented for a Google-based JWT: - # `'iss': 'accounts.google.com', - # 'sub': '113289723416554971153', - # 'aud': ['123456789012', 'pubsub.googleapis.com'], - # 'azp': '123456789012.apps.googleusercontent.com', - # 'email': 'jsmith@example.com', - # 'iat': 1353601026, - # 'exp': 1353604926` - # SAML assertions are similarly specified, but with an identity provider - # dependent structure. + # Structured claims presented with the credential. JWTs include ``key: value`` + # pairs for standard and private claims. The following is a subset of the + # standard required and optional claims that would typically be presented for a + # Google-based JWT: `'iss': 'accounts.google.com', 'sub': '113289723416554971153' + # , 'aud': ['123456789012', 'pubsub.googleapis.com'], 'azp': '123456789012.apps. + # googleusercontent.com', 'email': 'jsmith@example.com', 'iat': 1353601026, 'exp' + # : 1353604926` SAML assertions are similarly specified, but with an identity + # provider dependent structure. # Corresponds to the JSON property `claims` # @return [Hash] attr_accessor :claims - # The authorized presenter of the credential. Reflects the optional - # Authorized Presenter (`azp`) claim within a JWT or the - # OAuth client id. For example, a Google Cloud Platform client id looks - # as follows: "123456789012.apps.googleusercontent.com". + # The authorized presenter of the credential. Reflects the optional Authorized + # Presenter (`azp`) claim within a JWT or the OAuth client id. For example, a + # Google Cloud Platform client id looks as follows: "123456789012.apps. + # googleusercontent.com". # Corresponds to the JSON property `presenter` # @return [String] attr_accessor :presenter - # The authenticated principal. Reflects the issuer (`iss`) and subject - # (`sub`) claims within a JWT. The issuer and subject should be `/` - # delimited, with `/` percent-encoded within the subject fragment. For - # Google accounts, the principal format is: - # "https://accounts.google.com/`id`" + # The authenticated principal. Reflects the issuer (`iss`) and subject (`sub`) + # claims within a JWT. The issuer and subject should be `/` delimited, with `/` + # percent-encoded within the subject fragment. For Google accounts, the + # principal format is: "https://accounts.google.com/`id`" # Corresponds to the JSON property `principal` # @return [String] attr_accessor :principal @@ -374,48 +354,46 @@ module Google class AuthenticationInfo include Google::Apis::Core::Hashable - # The authority selector specified by the requestor, if any. - # It is not guaranteed that the principal was allowed to use this authority. + # The authority selector specified by the requestor, if any. It is not + # guaranteed that the principal was allowed to use this authority. # Corresponds to the JSON property `authoritySelector` # @return [String] attr_accessor :authority_selector - # The email address of the authenticated user (or service account on behalf - # of third party principal) making the request. For privacy reasons, the - # principal email address is redacted for all read-only operations that fail - # with a "permission denied" error. + # The email address of the authenticated user (or service account on behalf of + # third party principal) making the request. For privacy reasons, the principal + # email address is redacted for all read-only operations that fail with a " + # permission denied" error. # Corresponds to the JSON property `principalEmail` # @return [String] attr_accessor :principal_email - # String representation of identity of requesting party. - # Populated for both first and third party identities. + # String representation of identity of requesting party. Populated for both + # first and third party identities. # Corresponds to the JSON property `principalSubject` # @return [String] attr_accessor :principal_subject - # Identity delegation history of an authenticated service account that makes - # the request. It contains information on the real authorities that try to - # access GCP resources by delegating on a service account. When multiple - # authorities present, they are guaranteed to be sorted based on the original - # ordering of the identity delegation events. + # Identity delegation history of an authenticated service account that makes the + # request. It contains information on the real authorities that try to access + # GCP resources by delegating on a service account. When multiple authorities + # present, they are guaranteed to be sorted based on the original ordering of + # the identity delegation events. # Corresponds to the JSON property `serviceAccountDelegationInfo` # @return [Array] attr_accessor :service_account_delegation_info - # The name of the service account key used to create or exchange - # credentials for authenticating the service account making the request. - # This is a scheme-less URI full resource name. For example: - # "//iam.googleapis.com/projects/`PROJECT_ID`/serviceAccounts/`ACCOUNT`/keys/` - # key`" + # The name of the service account key used to create or exchange credentials for + # authenticating the service account making the request. This is a scheme-less + # URI full resource name. For example: "//iam.googleapis.com/projects/` + # PROJECT_ID`/serviceAccounts/`ACCOUNT`/keys/`key`" # Corresponds to the JSON property `serviceAccountKeyName` # @return [String] attr_accessor :service_account_key_name - # The third party identification (if any) of the authenticated user making - # the request. - # When the JSON object represented here has a proto equivalent, the proto - # name will be indicated in the `@type` property. + # The third party identification (if any) of the authenticated user making the + # request. When the JSON object represented here has a proto equivalent, the + # proto name will be indicated in the `@type` property. # Corresponds to the JSON property `thirdPartyPrincipal` # @return [Hash] attr_accessor :third_party_principal @@ -439,8 +417,7 @@ module Google class AuthorizationInfo include Google::Apis::Core::Hashable - # Whether or not authorization for `resource` and `permission` - # was granted. + # Whether or not authorization for `resource` and `permission` was granted. # Corresponds to the JSON property `granted` # @return [Boolean] attr_accessor :granted @@ -451,15 +428,15 @@ module Google # @return [String] attr_accessor :permission - # The resource being accessed, as a REST-style string. For example: - # bigquery.googleapis.com/projects/PROJECTID/datasets/DATASETID + # The resource being accessed, as a REST-style string. For example: bigquery. + # googleapis.com/projects/PROJECTID/datasets/DATASETID # Corresponds to the JSON property `resource` # @return [String] attr_accessor :resource # This message defines core attributes for a resource. A resource is an - # addressable (named) entity provided by the destination service. For - # example, a file stored on a network storage service. + # addressable (named) entity provided by the destination service. For example, a + # file stored on a network storage service. # Corresponds to the JSON property `resourceAttributes` # @return [Google::Apis::ServicecontrolV2::Resource] attr_accessor :resource_attributes @@ -481,19 +458,17 @@ module Google class CheckRequest include Google::Apis::Core::Hashable - # This message defines the standard attribute vocabulary for Google APIs. - # An attribute is a piece of metadata that describes an activity on a network - # service. For example, the size of an HTTP request, or the status code of - # an HTTP response. - # Each attribute has a type and a name, which is logically defined as - # a proto message field in `AttributeContext`. The field type becomes the - # attribute type, and the field path becomes the attribute name. For example, - # the attribute `source.ip` maps to field `AttributeContext.source.ip`. - # This message definition is guaranteed not to have any wire breaking change. - # So you can use it directly for passing attributes across different systems. - # NOTE: Different system may generate different subset of attributes. Please - # verify the system specification before relying on an attribute generated - # a system. + # This message defines the standard attribute vocabulary for Google APIs. An + # attribute is a piece of metadata that describes an activity on a network + # service. For example, the size of an HTTP request, or the status code of an + # HTTP response. Each attribute has a type and a name, which is logically + # defined as a proto message field in `AttributeContext`. The field type becomes + # the attribute type, and the field path becomes the attribute name. For example, + # the attribute `source.ip` maps to field `AttributeContext.source.ip`. This + # message definition is guaranteed not to have any wire breaking change. So you + # can use it directly for passing attributes across different systems. NOTE: + # Different system may generate different subset of attributes. Please verify + # the system specification before relying on an attribute generated a system. # Corresponds to the JSON property `attributes` # @return [Google::Apis::ServicecontrolV2::AttributeContext] attr_accessor :attributes @@ -504,8 +479,8 @@ module Google attr_accessor :resources # Specifies the version of the service configuration that should be used to - # process the request. Must not be empty. Set this field to 'latest' to - # specify using the latest configuration. + # process the request. Must not be empty. Set this field to 'latest' to specify + # using the latest configuration. # Corresponds to the JSON property `serviceConfigId` # @return [String] attr_accessor :service_config_id @@ -531,12 +506,12 @@ module Google # @return [Hash] attr_accessor :headers - # 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::ServicecontrolV2::Status] attr_accessor :status @@ -556,14 +531,12 @@ module Google class FirstPartyPrincipal include Google::Apis::Core::Hashable - # The email address of a Google account. - # . + # The email address of a Google account. . # Corresponds to the JSON property `principalEmail` # @return [String] attr_accessor :principal_email - # Metadata about the service that uses the service account. - # . + # Metadata about the service that uses the service account. . # Corresponds to the JSON property `serviceMetadata` # @return [Hash] attr_accessor :service_metadata @@ -579,10 +552,10 @@ module Google end end - # This message defines attributes for a node that handles a network request. - # The node can be either a service or an application that sends, forwards, - # or receives the request. Service peers should fill in - # `principal` and `labels` as appropriate. + # This message defines attributes for a node that handles a network request. The + # node can be either a service or an application that sends, forwards, or + # receives the request. Service peers should fill in `principal` and `labels` as + # appropriate. class Peer include Google::Apis::Core::Hashable @@ -601,16 +574,16 @@ module Google # @return [Fixnum] attr_accessor :port - # The identity of this peer. Similar to `Request.auth.principal`, but - # relative to the peer instead of the request. For example, the - # idenity associated with a load balancer that forwared the request. + # The identity of this peer. Similar to `Request.auth.principal`, but relative + # to the peer instead of the request. For example, the idenity associated with a + # load balancer that forwared the request. # Corresponds to the JSON property `principal` # @return [String] attr_accessor :principal - # The CLDR country/region code associated with the above IP address. - # If the IP address is private, the `region_code` should reflect the - # physical location where this peer is running. + # The CLDR country/region code associated with the above IP address. If the IP + # address is private, the `region_code` should reflect the physical location + # where this peer is running. # Corresponds to the JSON property `regionCode` # @return [String] attr_accessor :region_code @@ -633,16 +606,15 @@ module Google class ReportRequest include Google::Apis::Core::Hashable - # Describes the list of operations to be reported. Each operation is - # represented as an AttributeContext, and contains all attributes around an - # API access. + # Describes the list of operations to be reported. Each operation is represented + # as an AttributeContext, and contains all attributes around an API access. # Corresponds to the JSON property `operations` # @return [Array] attr_accessor :operations # Specifies the version of the service configuration that should be used to - # process the request. Must not be empty. Set this field to 'latest' to - # specify using the latest configuration. + # process the request. Must not be empty. Set this field to 'latest' to specify + # using the latest configuration. # Corresponds to the JSON property `serviceConfigId` # @return [String] attr_accessor :service_config_id @@ -658,8 +630,8 @@ module Google end end - # Response message for the Report method. - # If the request contains any invalid data, the server returns an RPC error. + # Response message for the Report method. If the request contains any invalid + # data, the server returns an RPC error. class ReportResponse include Google::Apis::Core::Hashable @@ -672,22 +644,22 @@ module Google end end - # This message defines attributes for an HTTP request. If the actual - # request is not an HTTP request, the runtime system should try to map - # the actual request to an equivalent HTTP request. + # This message defines attributes for an HTTP request. If the actual request is + # not an HTTP request, the runtime system should try to map the actual request + # to an equivalent HTTP request. class Request include Google::Apis::Core::Hashable - # This message defines request authentication attributes. Terminology is - # based on the JSON Web Token (JWT) standard, but the terms also - # correlate to concepts in other standards. + # This message defines request authentication attributes. Terminology is based + # on the JSON Web Token (JWT) standard, but the terms also correlate to concepts + # in other standards. # Corresponds to the JSON property `auth` # @return [Google::Apis::ServicecontrolV2::Auth] attr_accessor :auth - # The HTTP request headers. If multiple headers share the same key, they - # must be merged according to the HTTP spec. All header keys must be - # lowercased, because HTTP header keys are case-insensitive. + # The HTTP request headers. If multiple headers share the same key, they must be + # merged according to the HTTP spec. All header keys must be lowercased, because + # HTTP header keys are case-insensitive. # Corresponds to the JSON property `headers` # @return [Hash] attr_accessor :headers @@ -697,9 +669,9 @@ module Google # @return [String] attr_accessor :host - # The unique ID for a request, which can be propagated to downstream - # systems. The ID should have low probability of collision - # within a single day for a specific service. + # The unique ID for a request, which can be propagated to downstream systems. + # The ID should have low probability of collision within a single day for a + # specific service. # Corresponds to the JSON property `id` # @return [String] attr_accessor :id @@ -714,23 +686,22 @@ module Google # @return [String] attr_accessor :path - # The network protocol used with the request, such as "http/1.1", - # "spdy/3", "h2", "h2c", "webrtc", "tcp", "udp", "quic". See - # https://www.iana.org/assignments/tls-extensiontype-values/tls-extensiontype- - # values.xhtml#alpn-protocol-ids - # for details. + # The network protocol used with the request, such as "http/1.1", "spdy/3", "h2", + # "h2c", "webrtc", "tcp", "udp", "quic". See https://www.iana.org/assignments/ + # tls-extensiontype-values/tls-extensiontype-values.xhtml#alpn-protocol-ids for + # details. # Corresponds to the JSON property `protocol` # @return [String] attr_accessor :protocol - # The HTTP URL query in the format of `name1=value1&name2=value2`, as it - # appears in the first line of the HTTP request. No decoding is performed. + # The HTTP URL query in the format of `name1=value1&name2=value2`, as it appears + # in the first line of the HTTP request. No decoding is performed. # Corresponds to the JSON property `query` # @return [String] attr_accessor :query - # A special parameter for request reason. It is used by security systems - # to associate auditing information with a request. + # A special parameter for request reason. It is used by security systems to + # associate auditing information with a request. # Corresponds to the JSON property `reason` # @return [String] attr_accessor :reason @@ -745,8 +716,8 @@ module Google # @return [Fixnum] attr_accessor :size - # The timestamp when the `destination` service receives the first byte of - # the request. + # The timestamp when the `destination` service receives the first byte of the + # request. # Corresponds to the JSON property `time` # @return [String] attr_accessor :time @@ -776,55 +747,48 @@ module Google class RequestMetadata include Google::Apis::Core::Hashable - # The IP address of the caller. - # For caller from internet, this will be public IPv4 or IPv6 address. - # For caller from a Compute Engine VM with external IP address, this - # will be the VM's external IP address. For caller from a Compute - # Engine VM without external IP address, if the VM is in the same - # organization (or project) as the accessed resource, `caller_ip` will - # be the VM's internal IPv4 address, otherwise the `caller_ip` will be - # redacted to "gce-internal-ip". + # The IP address of the caller. For caller from internet, this will be public + # IPv4 or IPv6 address. For caller from a Compute Engine VM with external IP + # address, this will be the VM's external IP address. For caller from a Compute + # Engine VM without external IP address, if the VM is in the same organization ( + # or project) as the accessed resource, `caller_ip` will be the VM's internal + # IPv4 address, otherwise the `caller_ip` will be redacted to "gce-internal-ip". # See https://cloud.google.com/compute/docs/vpc/ for more information. # Corresponds to the JSON property `callerIp` # @return [String] attr_accessor :caller_ip - # The network of the caller. - # Set only if the network host project is part of the same GCP organization - # (or project) as the accessed resource. - # See https://cloud.google.com/compute/docs/vpc/ for more information. - # This is a scheme-less URI full resource name. For example: - # "//compute.googleapis.com/projects/PROJECT_ID/global/networks/NETWORK_ID" + # The network of the caller. Set only if the network host project is part of the + # same GCP organization (or project) as the accessed resource. See https://cloud. + # google.com/compute/docs/vpc/ for more information. This is a scheme-less URI + # full resource name. For example: "//compute.googleapis.com/projects/PROJECT_ID/ + # global/networks/NETWORK_ID" # Corresponds to the JSON property `callerNetwork` # @return [String] attr_accessor :caller_network - # The user agent of the caller. - # This information is not authenticated and should be treated accordingly. - # For example: - # + `google-api-python-client/1.4.0`: - # The request was made by the Google API client for Python. - # + `Cloud SDK Command Line Tool apitools-client/1.0 gcloud/0.9.62`: - # The request was made by the Google Cloud SDK CLI (gcloud). - # + `AppEngine-Google; (+http://code.google.com/appengine; appid: - # s~my-project`: - # The request was made from the `my-project` App Engine app. - # NOLINT + # The user agent of the caller. This information is not authenticated and should + # be treated accordingly. For example: + `google-api-python-client/1.4.0`: The + # request was made by the Google API client for Python. + `Cloud SDK Command + # Line Tool apitools-client/1.0 gcloud/0.9.62`: The request was made by the + # Google Cloud SDK CLI (gcloud). + `AppEngine-Google; (+http://code.google.com/ + # appengine; appid: s~my-project`: The request was made from the `my-project` + # App Engine app. NOLINT # Corresponds to the JSON property `callerSuppliedUserAgent` # @return [String] attr_accessor :caller_supplied_user_agent - # This message defines attributes for a node that handles a network request. - # The node can be either a service or an application that sends, forwards, - # or receives the request. Service peers should fill in - # `principal` and `labels` as appropriate. + # This message defines attributes for a node that handles a network request. The + # node can be either a service or an application that sends, forwards, or + # receives the request. Service peers should fill in `principal` and `labels` as + # appropriate. # Corresponds to the JSON property `destinationAttributes` # @return [Google::Apis::ServicecontrolV2::Peer] attr_accessor :destination_attributes - # This message defines attributes for an HTTP request. If the actual - # request is not an HTTP request, the runtime system should try to map - # the actual request to an equivalent HTTP request. + # This message defines attributes for an HTTP request. If the actual request is + # not an HTTP request, the runtime system should try to map the actual request + # to an equivalent HTTP request. # Corresponds to the JSON property `requestAttributes` # @return [Google::Apis::ServicecontrolV2::Request] attr_accessor :request_attributes @@ -844,41 +808,40 @@ module Google end # This message defines core attributes for a resource. A resource is an - # addressable (named) entity provided by the destination service. For - # example, a file stored on a network storage service. + # addressable (named) entity provided by the destination service. For example, a + # file stored on a network storage service. class Resource include Google::Apis::Core::Hashable - # The labels or tags on the resource, such as AWS resource tags and - # Kubernetes resource labels. + # The labels or tags on the resource, such as AWS resource tags and Kubernetes + # resource labels. # Corresponds to the JSON property `labels` # @return [Hash] attr_accessor :labels - # The stable identifier (name) of a resource on the `service`. A resource - # can be logically identified as "//`resource.service`/`resource.name`". - # The differences between a resource name and a URI are: - # * Resource name is a logical identifier, independent of network - # protocol and API version. For example, - # `//pubsub.googleapis.com/projects/123/topics/news-feed`. - # * URI often includes protocol and version information, so it can - # be used directly by applications. For example, - # `https://pubsub.googleapis.com/v1/projects/123/topics/news-feed`. - # See https://cloud.google.com/apis/design/resource_names for details. + # The stable identifier (name) of a resource on the `service`. A resource can be + # logically identified as "//`resource.service`/`resource.name`". The + # differences between a resource name and a URI are: * Resource name is a + # logical identifier, independent of network protocol and API version. For + # example, `//pubsub.googleapis.com/projects/123/topics/news-feed`. * URI often + # includes protocol and version information, so it can be used directly by + # applications. For example, `https://pubsub.googleapis.com/v1/projects/123/ + # topics/news-feed`. See https://cloud.google.com/apis/design/resource_names for + # details. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name - # The name of the service that this resource belongs to, such as - # `pubsub.googleapis.com`. The service may be different from the DNS - # hostname that actually serves the request. + # The name of the service that this resource belongs to, such as `pubsub. + # googleapis.com`. The service may be different from the DNS hostname that + # actually serves the request. # Corresponds to the JSON property `service` # @return [String] attr_accessor :service - # The type of the resource. The syntax is platform-specific because - # different platforms define their resources differently. - # For Google APIs, the type format must be "`service`/`kind`". + # The type of the resource. The syntax is platform-specific because different + # platforms define their resources differently. For Google APIs, the type format + # must be "`service`/`kind`". # Corresponds to the JSON property `type` # @return [String] attr_accessor :type @@ -905,8 +868,8 @@ module Google # @return [String] attr_accessor :name - # The resource permission needed for this request. - # The format must be "`service`/`plural`.`verb`". + # The resource permission needed for this request. The format must be "`service`/ + # `plural`.`verb`". # Corresponds to the JSON property `permission` # @return [String] attr_accessor :permission @@ -932,24 +895,18 @@ module Google class ResourceLocation include Google::Apis::Core::Hashable - # The locations of a resource after the execution of the operation. - # Requests to create or delete a location based resource must populate - # the 'current_locations' field and not the 'original_locations' field. - # For example: - # "europe-west1-a" - # "us-east1" - # "nam3" + # The locations of a resource after the execution of the operation. Requests to + # create or delete a location based resource must populate the ' + # current_locations' field and not the 'original_locations' field. For example: " + # europe-west1-a" "us-east1" "nam3" # Corresponds to the JSON property `currentLocations` # @return [Array] attr_accessor :current_locations - # The locations of a resource prior to the execution of the operation. - # Requests that mutate the resource's location must populate both the - # 'original_locations' as well as the 'current_locations' fields. - # For example: - # "europe-west1-a" - # "us-east1" - # "nam3" + # The locations of a resource prior to the execution of the operation. Requests + # that mutate the resource's location must populate both the 'original_locations' + # as well as the 'current_locations' fields. For example: "europe-west1-a" "us- + # east1" "nam3" # Corresponds to the JSON property `originalLocations` # @return [Array] attr_accessor :original_locations @@ -965,8 +922,8 @@ module Google end end - # This message defines attributes for a typical network response. It - # generally models semantics of an HTTP response. + # This message defines attributes for a typical network response. It generally + # models semantics of an HTTP response. class Response include Google::Apis::Core::Hashable @@ -975,9 +932,9 @@ module Google # @return [Fixnum] attr_accessor :code - # The HTTP response headers. If multiple headers share the same key, they - # must be merged according to HTTP spec. All header keys must be - # lowercased, because HTTP header keys are case-insensitive. + # The HTTP response headers. If multiple headers share the same key, they must + # be merged according to HTTP spec. All header keys must be lowercased, because + # HTTP header keys are case-insensitive. # Corresponds to the JSON property `headers` # @return [Hash] attr_accessor :headers @@ -987,8 +944,8 @@ module Google # @return [Fixnum] attr_accessor :size - # The timestamp when the `destination` service generates the first byte of - # the response. + # The timestamp when the `destination` service generates the first byte of the + # response. # Corresponds to the JSON property `time` # @return [String] attr_accessor :time @@ -1031,20 +988,17 @@ module Google end end - # The context of a span, attached to - # Exemplars - # in Distribution values during aggregation. - # It contains the name of a span with format: - # projects/[PROJECT_ID_OR_NUMBER]/traces/[TRACE_ID]/spans/[SPAN_ID] + # The context of a span, attached to Exemplars in Distribution values during + # aggregation. It contains the name of a span with format: projects/[ + # PROJECT_ID_OR_NUMBER]/traces/[TRACE_ID]/spans/[SPAN_ID] class SpanContext include Google::Apis::Core::Hashable - # The resource name of the span. The format is: - # projects/[PROJECT_ID_OR_NUMBER]/traces/[TRACE_ID]/spans/[SPAN_ID] - # `[TRACE_ID]` is a unique identifier for a trace within a project; - # it is a 32-character hexadecimal encoding of a 16-byte array. - # `[SPAN_ID]` is a unique identifier for a span within a trace; it - # is a 16-character hexadecimal encoding of an 8-byte array. + # The resource name of the span. The format is: projects/[PROJECT_ID_OR_NUMBER]/ + # traces/[TRACE_ID]/spans/[SPAN_ID] `[TRACE_ID]` is a unique identifier for a + # trace within a project; it is a 32-character hexadecimal encoding of a 16-byte + # array. `[SPAN_ID]` is a unique identifier for a span within a trace; it is a + # 16-character hexadecimal encoding of an 8-byte array. # Corresponds to the JSON property `spanName` # @return [String] attr_accessor :span_name @@ -1059,12 +1013,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 @@ -1073,15 +1027,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 diff --git a/generated/google/apis/servicecontrol_v2/service.rb b/generated/google/apis/servicecontrol_v2/service.rb index 40615a6e0..b0dabd0e2 100644 --- a/generated/google/apis/servicecontrol_v2/service.rb +++ b/generated/google/apis/servicecontrol_v2/service.rb @@ -48,30 +48,25 @@ module Google @batch_path = 'batch' end - # Private Preview. This feature is only available for approved services. - # This method provides admission control for services that are integrated - # with [Service Infrastructure](/service-infrastructure). It checks whether - # an operation should be allowed based on the service configuration and - # relevant policies. It must be called before the operation is executed. - # For more information, see - # [Admission Control](/service-infrastructure/docs/admission-control). - # NOTE: The admission control has an expected policy propagation delay of - # 60s. The caller **must** not depend on the most recent policy changes. - # NOTE: The admission control has a hard limit of 1 referenced resources - # per call. If an operation refers to more than 1 resources, the caller - # must call the Check method multiple times. - # This method requires the `servicemanagement.services.check` permission - # on the specified service. For more information, see - # [Service Control API Access - # Control](https://cloud.google.com/service-infrastructure/docs/service-control/ - # access-control). + # Private Preview. This feature is only available for approved services. This + # method provides admission control for services that are integrated with [ + # Service Infrastructure](/service-infrastructure). It checks whether an + # operation should be allowed based on the service configuration and relevant + # policies. It must be called before the operation is executed. For more + # information, see [Admission Control](/service-infrastructure/docs/admission- + # control). NOTE: The admission control has an expected policy propagation delay + # of 60s. The caller **must** not depend on the most recent policy changes. NOTE: + # The admission control has a hard limit of 1 referenced resources per call. If + # an operation refers to more than 1 resources, the caller must call the Check + # method multiple times. This method requires the `servicemanagement.services. + # check` permission on the specified service. For more information, see [Service + # Control API Access Control](https://cloud.google.com/service-infrastructure/ + # docs/service-control/access-control). # @param [String] service_name - # The service name as specified in its service configuration. For example, - # `"pubsub.googleapis.com"`. - # See - # [google.api.Service](https://cloud.google.com/service-management/reference/rpc/ - # google.api#google.api.Service) - # for the definition of a service name. + # The service name as specified in its service configuration. For example, `" + # pubsub.googleapis.com"`. See [google.api.Service](https://cloud.google.com/ + # service-management/reference/rpc/google.api#google.api.Service) for the + # definition of a service name. # @param [Google::Apis::ServicecontrolV2::CheckRequest] check_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -102,27 +97,22 @@ module Google execute_or_queue_command(command, &block) end - # Private Preview. This feature is only available for approved services. - # This method provides telemetry reporting for services that are integrated - # with [Service Infrastructure](/service-infrastructure). It reports a list - # of operations that have occurred on a service. It must be called after the - # operations have been executed. For more information, see - # [Telemetry Reporting](/service-infrastructure/docs/telemetry-reporting). - # NOTE: The telemetry reporting has a hard limit of 1000 operations and 1MB - # per Report call. It is recommended to have no more than 100 operations per - # call. - # This method requires the `servicemanagement.services.report` permission - # on the specified service. For more information, see - # [Service Control API Access - # Control](https://cloud.google.com/service-infrastructure/docs/service-control/ - # access-control). + # Private Preview. This feature is only available for approved services. This + # method provides telemetry reporting for services that are integrated with [ + # Service Infrastructure](/service-infrastructure). It reports a list of + # operations that have occurred on a service. It must be called after the + # operations have been executed. For more information, see [Telemetry Reporting]( + # /service-infrastructure/docs/telemetry-reporting). NOTE: The telemetry + # reporting has a hard limit of 1000 operations and 1MB per Report call. It is + # recommended to have no more than 100 operations per call. This method requires + # the `servicemanagement.services.report` permission on the specified service. + # For more information, see [Service Control API Access Control](https://cloud. + # google.com/service-infrastructure/docs/service-control/access-control). # @param [String] service_name - # The service name as specified in its service configuration. For example, - # `"pubsub.googleapis.com"`. - # See - # [google.api.Service](https://cloud.google.com/service-management/reference/rpc/ - # google.api#google.api.Service) - # for the definition of a service name. + # The service name as specified in its service configuration. For example, `" + # pubsub.googleapis.com"`. See [google.api.Service](https://cloud.google.com/ + # service-management/reference/rpc/google.api#google.api.Service) for the + # definition of a service name. # @param [Google::Apis::ServicecontrolV2::ReportRequest] report_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. diff --git a/generated/google/apis/texttospeech_v1.rb b/generated/google/apis/texttospeech_v1.rb index e69cac700..8c6bf7db0 100644 --- a/generated/google/apis/texttospeech_v1.rb +++ b/generated/google/apis/texttospeech_v1.rb @@ -25,7 +25,7 @@ module Google # @see https://cloud.google.com/text-to-speech/ module TexttospeechV1 VERSION = 'V1' - REVISION = '20200619' + 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/texttospeech_v1/classes.rb b/generated/google/apis/texttospeech_v1/classes.rb index 9a8ad2f4c..8cd13c375 100644 --- a/generated/google/apis/texttospeech_v1/classes.rb +++ b/generated/google/apis/texttospeech_v1/classes.rb @@ -32,18 +32,17 @@ module Google attr_accessor :audio_encoding # Optional. Input only. An identifier which selects 'audio effects' profiles - # that are applied on (post synthesized) text to speech. Effects are applied - # on top of each other in the order they are given. See - # [audio - # profiles](https://cloud.google.com/text-to-speech/docs/audio-profiles) for - # current supported profile ids. + # that are applied on (post synthesized) text to speech. Effects are applied on + # top of each other in the order they are given. See [audio profiles](https:// + # cloud.google.com/text-to-speech/docs/audio-profiles) for current supported + # profile ids. # Corresponds to the JSON property `effectsProfileId` # @return [Array] attr_accessor :effects_profile_id # Optional. Input only. Speaking pitch, in the range [-20.0, 20.0]. 20 means - # increase 20 semitones from the original pitch. -20 means decrease 20 - # semitones from the original pitch. + # increase 20 semitones from the original pitch. -20 means decrease 20 semitones + # from the original pitch. # Corresponds to the JSON property `pitch` # @return [Float] attr_accessor :pitch @@ -52,29 +51,29 @@ module Google # specified in SynthesizeSpeechRequest, if this is different from the voice's # natural sample rate, then the synthesizer will honor this request by # converting to the desired sample rate (which might result in worse audio - # quality), unless the specified sample rate is not supported for the - # encoding chosen, in which case it will fail the request and return - # google.rpc.Code.INVALID_ARGUMENT. + # quality), unless the specified sample rate is not supported for the encoding + # chosen, in which case it will fail the request and return google.rpc.Code. + # INVALID_ARGUMENT. # Corresponds to the JSON property `sampleRateHertz` # @return [Fixnum] attr_accessor :sample_rate_hertz # Optional. Input only. Speaking rate/speed, in the range [0.25, 4.0]. 1.0 is - # the normal native speed supported by the specific voice. 2.0 is twice as - # fast, and 0.5 is half as fast. If unset(0.0), defaults to the native 1.0 - # speed. Any other values < 0.25 or > 4.0 will return an error. + # the normal native speed supported by the specific voice. 2.0 is twice as fast, + # and 0.5 is half as fast. If unset(0.0), defaults to the native 1.0 speed. Any + # other values < 0.25 or > 4.0 will return an error. # Corresponds to the JSON property `speakingRate` # @return [Float] attr_accessor :speaking_rate # Optional. Input only. Volume gain (in dB) of the normal native volume - # supported by the specific voice, in the range [-96.0, 16.0]. If unset, or - # set to a value of 0.0 (dB), will play at normal native signal amplitude. A - # value of -6.0 (dB) will play at approximately half the amplitude of the - # normal native signal amplitude. A value of +6.0 (dB) will play at - # approximately twice the amplitude of the normal native signal amplitude. - # Strongly recommend not to exceed +10 (dB) as there's usually no effective - # increase in loudness for any value greater than that. + # supported by the specific voice, in the range [-96.0, 16.0]. If unset, or set + # to a value of 0.0 (dB), will play at normal native signal amplitude. A value + # of -6.0 (dB) will play at approximately half the amplitude of the normal + # native signal amplitude. A value of +6.0 (dB) will play at approximately twice + # the amplitude of the normal native signal amplitude. Strongly recommend not to + # exceed +10 (dB) as there's usually no effective increase in loudness for any + # value greater than that. # Corresponds to the JSON property `volumeGainDb` # @return [Float] attr_accessor :volume_gain_db @@ -114,16 +113,15 @@ module Google end # Contains text input to be synthesized. Either `text` or `ssml` must be - # supplied. Supplying both or neither returns - # google.rpc.Code.INVALID_ARGUMENT. The input size is limited to 5000 - # characters. + # supplied. Supplying both or neither returns google.rpc.Code.INVALID_ARGUMENT. + # The input size is limited to 5000 characters. class SynthesisInput include Google::Apis::Core::Hashable - # The SSML document to be synthesized. The SSML document must be valid - # and well-formed. Otherwise the RPC will fail and return - # google.rpc.Code.INVALID_ARGUMENT. For more information, see - # [SSML](https://cloud.google.com/text-to-speech/docs/ssml). + # The SSML document to be synthesized. The SSML document must be valid and well- + # formed. Otherwise the RPC will fail and return google.rpc.Code. + # INVALID_ARGUMENT. For more information, see [SSML](https://cloud.google.com/ + # text-to-speech/docs/ssml). # Corresponds to the JSON property `ssml` # @return [String] attr_accessor :ssml @@ -154,9 +152,8 @@ module Google attr_accessor :audio_config # Contains text input to be synthesized. Either `text` or `ssml` must be - # supplied. Supplying both or neither returns - # google.rpc.Code.INVALID_ARGUMENT. The input size is limited to 5000 - # characters. + # supplied. Supplying both or neither returns google.rpc.Code.INVALID_ARGUMENT. + # The input size is limited to 5000 characters. # Corresponds to the JSON property `input` # @return [Google::Apis::TexttospeechV1::SynthesisInput] attr_accessor :input @@ -182,11 +179,11 @@ module Google class SynthesizeSpeechResponse include Google::Apis::Core::Hashable - # The audio data bytes encoded as specified in the request, including the - # header for encodings that are wrapped in containers (e.g. MP3, OGG_OPUS). - # For LINEAR16 audio, we include the WAV header. Note: as - # with all bytes fields, protobuffers use a pure binary representation, - # whereas JSON representations use base64. + # The audio data bytes encoded as specified in the request, including the header + # for encodings that are wrapped in containers (e.g. MP3, OGG_OPUS). For + # LINEAR16 audio, we include the WAV header. Note: as with all bytes fields, + # protobuffers use a pure binary representation, whereas JSON representations + # use base64. # Corresponds to the JSON property `audioContent` # NOTE: Values are automatically base64 encoded/decoded in the client library. # @return [String] @@ -206,14 +203,13 @@ module Google class Voice include Google::Apis::Core::Hashable - # The languages that this voice supports, expressed as - # [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) language tags (e.g. - # "en-US", "es-419", "cmn-tw"). + # The languages that this voice supports, expressed as [BCP-47](https://www.rfc- + # editor.org/rfc/bcp/bcp47.txt) language tags (e.g. "en-US", "es-419", "cmn-tw"). # Corresponds to the JSON property `languageCodes` # @return [Array] attr_accessor :language_codes - # The name of this voice. Each distinct voice has a unique name. + # The name of this voice. Each distinct voice has a unique name. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name @@ -246,32 +242,30 @@ module Google include Google::Apis::Core::Hashable # Required. The language (and potentially also the region) of the voice - # expressed as a - # [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) language tag, e.g. - # "en-US". This should not include a script tag (e.g. use - # "cmn-cn" rather than "cmn-Hant-cn"), because the script will be inferred - # from the input provided in the SynthesisInput. The TTS service - # will use this parameter to help choose an appropriate voice. Note that - # the TTS service may choose a voice with a slightly different language code - # than the one selected; it may substitute a different region - # (e.g. using en-US rather than en-CA if there isn't a Canadian voice - # available), or even a different language, e.g. using "nb" (Norwegian - # Bokmal) instead of "no" (Norwegian)". + # expressed as a [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) language + # tag, e.g. "en-US". This should not include a script tag (e.g. use "cmn-cn" + # rather than "cmn-Hant-cn"), because the script will be inferred from the input + # provided in the SynthesisInput. The TTS service will use this parameter to + # help choose an appropriate voice. Note that the TTS service may choose a voice + # with a slightly different language code than the one selected; it may + # substitute a different region (e.g. using en-US rather than en-CA if there isn' + # t a Canadian voice available), or even a different language, e.g. using "nb" ( + # Norwegian Bokmal) instead of "no" (Norwegian)". # Corresponds to the JSON property `languageCode` # @return [String] attr_accessor :language_code - # The name of the voice. If not set, the service will choose a - # voice based on the other parameters such as language_code and gender. + # The name of the voice. If not set, the service will choose a voice based on + # the other parameters such as language_code and gender. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name - # The preferred gender of the voice. If not set, the service will - # choose a voice based on the other parameters such as language_code and - # name. Note that this is only a preference, not requirement; if a - # voice of the appropriate gender is not available, the synthesizer should - # substitute a voice with a different gender rather than failing the request. + # The preferred gender of the voice. If not set, the service will choose a voice + # based on the other parameters such as language_code and name. Note that this + # is only a preference, not requirement; if a voice of the appropriate gender is + # not available, the synthesizer should substitute a voice with a different + # gender rather than failing the request. # Corresponds to the JSON property `ssmlGender` # @return [String] attr_accessor :ssml_gender diff --git a/generated/google/apis/texttospeech_v1/service.rb b/generated/google/apis/texttospeech_v1/service.rb index 83d59ee57..c5007e0ee 100644 --- a/generated/google/apis/texttospeech_v1/service.rb +++ b/generated/google/apis/texttospeech_v1/service.rb @@ -47,8 +47,8 @@ module Google @batch_path = 'batch' end - # Synthesizes speech synchronously: receive results after all text input - # has been processed. + # Synthesizes speech synchronously: receive results after all text input has + # been processed. # @param [Google::Apis::TexttospeechV1::SynthesizeSpeechRequest] synthesize_speech_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -80,13 +80,12 @@ module Google # Returns a list of Voice supported for synthesis. # @param [String] language_code - # Optional. Recommended. - # [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) language tag. If - # specified, the ListVoices call will only return voices that can be used to - # synthesize this language_code. E.g. when specifying "en-NZ", you will get - # supported "en-*" voices; when specifying "no", you will get supported - # "no-*" (Norwegian) and "nb-*" (Norwegian Bokmal) voices; specifying "zh" - # will also get supported "cmn-*" voices; specifying "zh-hk" will also get + # Optional. Recommended. [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) + # language tag. If specified, the ListVoices call will only return voices that + # can be used to synthesize this language_code. E.g. when specifying "en-NZ", + # you will get supported "en-*" voices; when specifying "no", you will get + # supported "no-*" (Norwegian) and "nb-*" (Norwegian Bokmal) voices; specifying " + # zh" will also get supported "cmn-*" voices; specifying "zh-hk" will also get # supported "yue-*" voices. # @param [String] fields # Selector specifying which fields to include in a partial response. diff --git a/generated/google/apis/texttospeech_v1beta1.rb b/generated/google/apis/texttospeech_v1beta1.rb index 9dea57832..592062e12 100644 --- a/generated/google/apis/texttospeech_v1beta1.rb +++ b/generated/google/apis/texttospeech_v1beta1.rb @@ -25,7 +25,7 @@ module Google # @see https://cloud.google.com/text-to-speech/ module TexttospeechV1beta1 VERSION = 'V1beta1' - 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/texttospeech_v1beta1/classes.rb b/generated/google/apis/texttospeech_v1beta1/classes.rb index 63a366768..19d495adb 100644 --- a/generated/google/apis/texttospeech_v1beta1/classes.rb +++ b/generated/google/apis/texttospeech_v1beta1/classes.rb @@ -32,18 +32,17 @@ module Google attr_accessor :audio_encoding # Optional. Input only. An identifier which selects 'audio effects' profiles - # that are applied on (post synthesized) text to speech. Effects are applied - # on top of each other in the order they are given. See - # [audio - # profiles](https://cloud.google.com/text-to-speech/docs/audio-profiles) for - # current supported profile ids. + # that are applied on (post synthesized) text to speech. Effects are applied on + # top of each other in the order they are given. See [audio profiles](https:// + # cloud.google.com/text-to-speech/docs/audio-profiles) for current supported + # profile ids. # Corresponds to the JSON property `effectsProfileId` # @return [Array] attr_accessor :effects_profile_id # Optional. Input only. Speaking pitch, in the range [-20.0, 20.0]. 20 means - # increase 20 semitones from the original pitch. -20 means decrease 20 - # semitones from the original pitch. + # increase 20 semitones from the original pitch. -20 means decrease 20 semitones + # from the original pitch. # Corresponds to the JSON property `pitch` # @return [Float] attr_accessor :pitch @@ -52,29 +51,29 @@ module Google # specified in SynthesizeSpeechRequest, if this is different from the voice's # natural sample rate, then the synthesizer will honor this request by # converting to the desired sample rate (which might result in worse audio - # quality), unless the specified sample rate is not supported for the - # encoding chosen, in which case it will fail the request and return - # google.rpc.Code.INVALID_ARGUMENT. + # quality), unless the specified sample rate is not supported for the encoding + # chosen, in which case it will fail the request and return google.rpc.Code. + # INVALID_ARGUMENT. # Corresponds to the JSON property `sampleRateHertz` # @return [Fixnum] attr_accessor :sample_rate_hertz # Optional. Input only. Speaking rate/speed, in the range [0.25, 4.0]. 1.0 is - # the normal native speed supported by the specific voice. 2.0 is twice as - # fast, and 0.5 is half as fast. If unset(0.0), defaults to the native 1.0 - # speed. Any other values < 0.25 or > 4.0 will return an error. + # the normal native speed supported by the specific voice. 2.0 is twice as fast, + # and 0.5 is half as fast. If unset(0.0), defaults to the native 1.0 speed. Any + # other values < 0.25 or > 4.0 will return an error. # Corresponds to the JSON property `speakingRate` # @return [Float] attr_accessor :speaking_rate # Optional. Input only. Volume gain (in dB) of the normal native volume - # supported by the specific voice, in the range [-96.0, 16.0]. If unset, or - # set to a value of 0.0 (dB), will play at normal native signal amplitude. A - # value of -6.0 (dB) will play at approximately half the amplitude of the - # normal native signal amplitude. A value of +6.0 (dB) will play at - # approximately twice the amplitude of the normal native signal amplitude. - # Strongly recommend not to exceed +10 (dB) as there's usually no effective - # increase in loudness for any value greater than that. + # supported by the specific voice, in the range [-96.0, 16.0]. If unset, or set + # to a value of 0.0 (dB), will play at normal native signal amplitude. A value + # of -6.0 (dB) will play at approximately half the amplitude of the normal + # native signal amplitude. A value of +6.0 (dB) will play at approximately twice + # the amplitude of the normal native signal amplitude. Strongly recommend not to + # exceed +10 (dB) as there's usually no effective increase in loudness for any + # value greater than that. # Corresponds to the JSON property `volumeGainDb` # @return [Float] attr_accessor :volume_gain_db @@ -114,16 +113,15 @@ module Google end # Contains text input to be synthesized. Either `text` or `ssml` must be - # supplied. Supplying both or neither returns - # google.rpc.Code.INVALID_ARGUMENT. The input size is limited to 5000 - # characters. + # supplied. Supplying both or neither returns google.rpc.Code.INVALID_ARGUMENT. + # The input size is limited to 5000 characters. class SynthesisInput include Google::Apis::Core::Hashable - # The SSML document to be synthesized. The SSML document must be valid - # and well-formed. Otherwise the RPC will fail and return - # google.rpc.Code.INVALID_ARGUMENT. For more information, see - # [SSML](https://cloud.google.com/text-to-speech/docs/ssml). + # The SSML document to be synthesized. The SSML document must be valid and well- + # formed. Otherwise the RPC will fail and return google.rpc.Code. + # INVALID_ARGUMENT. For more information, see [SSML](https://cloud.google.com/ + # text-to-speech/docs/ssml). # Corresponds to the JSON property `ssml` # @return [String] attr_accessor :ssml @@ -159,9 +157,8 @@ module Google attr_accessor :enable_time_pointing # Contains text input to be synthesized. Either `text` or `ssml` must be - # supplied. Supplying both or neither returns - # google.rpc.Code.INVALID_ARGUMENT. The input size is limited to 5000 - # characters. + # supplied. Supplying both or neither returns google.rpc.Code.INVALID_ARGUMENT. + # The input size is limited to 5000 characters. # Corresponds to the JSON property `input` # @return [Google::Apis::TexttospeechV1beta1::SynthesisInput] attr_accessor :input @@ -193,18 +190,18 @@ module Google # @return [Google::Apis::TexttospeechV1beta1::AudioConfig] attr_accessor :audio_config - # The audio data bytes encoded as specified in the request, including the - # header for encodings that are wrapped in containers (e.g. MP3, OGG_OPUS). - # For LINEAR16 audio, we include the WAV header. Note: as - # with all bytes fields, protobuffers use a pure binary representation, - # whereas JSON representations use base64. + # The audio data bytes encoded as specified in the request, including the header + # for encodings that are wrapped in containers (e.g. MP3, OGG_OPUS). For + # LINEAR16 audio, we include the WAV header. Note: as with all bytes fields, + # protobuffers use a pure binary representation, whereas JSON representations + # use base64. # Corresponds to the JSON property `audioContent` # NOTE: Values are automatically base64 encoded/decoded in the client library. # @return [String] attr_accessor :audio_content # A link between a position in the original request input and a corresponding - # time in the output audio. It's only supported via of SSML input. + # time in the output audio. It's only supported via of SSML input. # Corresponds to the JSON property `timepoints` # @return [Array] attr_accessor :timepoints @@ -226,7 +223,7 @@ module Google class Timepoint include Google::Apis::Core::Hashable - # Timepoint name as received from the client within tag. + # Timepoint name as received from the client within tag. # Corresponds to the JSON property `markName` # @return [String] attr_accessor :mark_name @@ -251,14 +248,13 @@ module Google class Voice include Google::Apis::Core::Hashable - # The languages that this voice supports, expressed as - # [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) language tags (e.g. - # "en-US", "es-419", "cmn-tw"). + # The languages that this voice supports, expressed as [BCP-47](https://www.rfc- + # editor.org/rfc/bcp/bcp47.txt) language tags (e.g. "en-US", "es-419", "cmn-tw"). # Corresponds to the JSON property `languageCodes` # @return [Array] attr_accessor :language_codes - # The name of this voice. Each distinct voice has a unique name. + # The name of this voice. Each distinct voice has a unique name. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name @@ -291,32 +287,30 @@ module Google include Google::Apis::Core::Hashable # Required. The language (and potentially also the region) of the voice - # expressed as a - # [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) language tag, e.g. - # "en-US". This should not include a script tag (e.g. use - # "cmn-cn" rather than "cmn-Hant-cn"), because the script will be inferred - # from the input provided in the SynthesisInput. The TTS service - # will use this parameter to help choose an appropriate voice. Note that - # the TTS service may choose a voice with a slightly different language code - # than the one selected; it may substitute a different region - # (e.g. using en-US rather than en-CA if there isn't a Canadian voice - # available), or even a different language, e.g. using "nb" (Norwegian - # Bokmal) instead of "no" (Norwegian)". + # expressed as a [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) language + # tag, e.g. "en-US". This should not include a script tag (e.g. use "cmn-cn" + # rather than "cmn-Hant-cn"), because the script will be inferred from the input + # provided in the SynthesisInput. The TTS service will use this parameter to + # help choose an appropriate voice. Note that the TTS service may choose a voice + # with a slightly different language code than the one selected; it may + # substitute a different region (e.g. using en-US rather than en-CA if there isn' + # t a Canadian voice available), or even a different language, e.g. using "nb" ( + # Norwegian Bokmal) instead of "no" (Norwegian)". # Corresponds to the JSON property `languageCode` # @return [String] attr_accessor :language_code - # The name of the voice. If not set, the service will choose a - # voice based on the other parameters such as language_code and gender. + # The name of the voice. If not set, the service will choose a voice based on + # the other parameters such as language_code and gender. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name - # The preferred gender of the voice. If not set, the service will - # choose a voice based on the other parameters such as language_code and - # name. Note that this is only a preference, not requirement; if a - # voice of the appropriate gender is not available, the synthesizer should - # substitute a voice with a different gender rather than failing the request. + # The preferred gender of the voice. If not set, the service will choose a voice + # based on the other parameters such as language_code and name. Note that this + # is only a preference, not requirement; if a voice of the appropriate gender is + # not available, the synthesizer should substitute a voice with a different + # gender rather than failing the request. # Corresponds to the JSON property `ssmlGender` # @return [String] attr_accessor :ssml_gender diff --git a/generated/google/apis/texttospeech_v1beta1/service.rb b/generated/google/apis/texttospeech_v1beta1/service.rb index eec4c99b3..540c3e87d 100644 --- a/generated/google/apis/texttospeech_v1beta1/service.rb +++ b/generated/google/apis/texttospeech_v1beta1/service.rb @@ -47,8 +47,8 @@ module Google @batch_path = 'batch' end - # Synthesizes speech synchronously: receive results after all text input - # has been processed. + # Synthesizes speech synchronously: receive results after all text input has + # been processed. # @param [Google::Apis::TexttospeechV1beta1::SynthesizeSpeechRequest] synthesize_speech_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -80,13 +80,12 @@ module Google # Returns a list of Voice supported for synthesis. # @param [String] language_code - # Optional. Recommended. - # [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) language tag. If - # specified, the ListVoices call will only return voices that can be used to - # synthesize this language_code. E.g. when specifying "en-NZ", you will get - # supported "en-*" voices; when specifying "no", you will get supported - # "no-*" (Norwegian) and "nb-*" (Norwegian Bokmal) voices; specifying "zh" - # will also get supported "cmn-*" voices; specifying "zh-hk" will also get + # Optional. Recommended. [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) + # language tag. If specified, the ListVoices call will only return voices that + # can be used to synthesize this language_code. E.g. when specifying "en-NZ", + # you will get supported "en-*" voices; when specifying "no", you will get + # supported "no-*" (Norwegian) and "nb-*" (Norwegian Bokmal) voices; specifying " + # zh" will also get supported "cmn-*" voices; specifying "zh-hk" will also get # supported "yue-*" voices. # @param [String] fields # Selector specifying which fields to include in a partial response. diff --git a/generated/google/apis/videointelligence_v1.rb b/generated/google/apis/videointelligence_v1.rb index 40bd36a32..93f068a12 100644 --- a/generated/google/apis/videointelligence_v1.rb +++ b/generated/google/apis/videointelligence_v1.rb @@ -27,7 +27,7 @@ module Google # @see https://cloud.google.com/video-intelligence/docs/ module VideointelligenceV1 VERSION = 'V1' - REVISION = '20200602' + 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/videointelligence_v1/classes.rb b/generated/google/apis/videointelligence_v1/classes.rb index 572a593ff..ee4ce1176 100644 --- a/generated/google/apis/videointelligence_v1/classes.rb +++ b/generated/google/apis/videointelligence_v1/classes.rb @@ -22,9 +22,9 @@ module Google module Apis module VideointelligenceV1 - # Video annotation progress. Included in the `metadata` - # field of the `Operation` returned by the `GetOperation` - # call of the `google::longrunning::Operations` service. + # Video annotation progress. Included in the `metadata` field of the `Operation` + # returned by the `GetOperation` call of the `google::longrunning::Operations` + # service. class GoogleCloudVideointelligenceV1AnnotateVideoProgress include Google::Apis::Core::Hashable @@ -52,24 +52,22 @@ module Google # @return [Array] attr_accessor :features - # The video data bytes. - # If unset, the input video(s) should be specified via the `input_uri`. - # If set, `input_uri` must be unset. + # The video data bytes. If unset, the input video(s) should be specified via the + # `input_uri`. If set, `input_uri` must be unset. # Corresponds to the JSON property `inputContent` # NOTE: Values are automatically base64 encoded/decoded in the client library. # @return [String] attr_accessor :input_content - # Input video location. Currently, only - # [Cloud Storage](https://cloud.google.com/storage/) URIs are - # supported. URIs must be specified in the following format: - # `gs://bucket-id/object-id` (other URI formats return - # google.rpc.Code.INVALID_ARGUMENT). For more information, see - # [Request URIs](https://cloud.google.com/storage/docs/request-endpoints). - # To identify multiple videos, a video URI may include wildcards in the - # `object-id`. Supported wildcards: '*' to match 0 or more characters; - # '?' to match 1 character. If unset, the input video should be embedded - # in the request as `input_content`. If set, `input_content` must be unset. + # Input video location. Currently, only [Cloud Storage](https://cloud.google.com/ + # storage/) URIs are supported. URIs must be specified in the following format: ` + # gs://bucket-id/object-id` (other URI formats return google.rpc.Code. + # INVALID_ARGUMENT). For more information, see [Request URIs](https://cloud. + # google.com/storage/docs/request-endpoints). To identify multiple videos, a + # video URI may include wildcards in the `object-id`. Supported wildcards: '*' + # to match 0 or more characters; '?' to match 1 character. If unset, the input + # video should be embedded in the request as `input_content`. If set, ` + # input_content` must be unset. # Corresponds to the JSON property `inputUri` # @return [String] attr_accessor :input_uri @@ -83,11 +81,11 @@ module Google attr_accessor :location_id # Optional. Location where the output (in JSON format) should be stored. - # Currently, only [Cloud Storage](https://cloud.google.com/storage/) - # URIs are supported. These must be specified in the following format: - # `gs://bucket-id/object-id` (other URI formats return - # google.rpc.Code.INVALID_ARGUMENT). For more information, see - # [Request URIs](https://cloud.google.com/storage/docs/request-endpoints). + # Currently, only [Cloud Storage](https://cloud.google.com/storage/) URIs are + # supported. These must be specified in the following format: `gs://bucket-id/ + # object-id` (other URI formats return google.rpc.Code.INVALID_ARGUMENT). For + # more information, see [Request URIs](https://cloud.google.com/storage/docs/ + # request-endpoints). # Corresponds to the JSON property `outputUri` # @return [String] attr_accessor :output_uri @@ -112,9 +110,9 @@ module Google end end - # Video annotation response. Included in the `response` - # field of the `Operation` returned by the `GetOperation` - # call of the `google::longrunning::Operations` service. + # Video annotation response. Included in the `response` field of the `Operation` + # returned by the `GetOperation` call of the `google::longrunning::Operations` + # service. class GoogleCloudVideointelligenceV1AnnotateVideoResponse include Google::Apis::Core::Hashable @@ -142,14 +140,14 @@ module Google # @return [Float] attr_accessor :confidence - # The name of the attribute, for example, glasses, dark_glasses, mouth_open. - # A full list of supported type names will be provided in the document. + # The name of the attribute, for example, glasses, dark_glasses, mouth_open. A + # full list of supported type names will be provided in the document. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name - # Text value of the detection result. For example, the value for "HairColor" - # can be "black", "blonde", etc. + # Text value of the detection result. For example, the value for "HairColor" can + # be "black", "blonde", etc. # Corresponds to the JSON property `value` # @return [String] attr_accessor :value @@ -181,9 +179,8 @@ module Google # @return [String] attr_accessor :name - # A vertex represents a 2D point in the image. - # NOTE: the normalized vertex coordinates are relative to the original image - # and range from 0 to 1. + # A vertex represents a 2D point in the image. NOTE: the normalized vertex + # coordinates are relative to the original image and range from 0 to 1. # Corresponds to the JSON property `point` # @return [Google::Apis::VideointelligenceV1::GoogleCloudVideointelligenceV1NormalizedVertex] attr_accessor :point @@ -209,8 +206,7 @@ module Google # @return [String] attr_accessor :description - # Opaque entity ID. Some IDs may be available in - # [Google Knowledge Graph Search + # Opaque entity ID. Some IDs may be available in [Google Knowledge Graph Search # API](https://developers.google.com/knowledge-graph/). # Corresponds to the JSON property `entityId` # @return [String] @@ -233,9 +229,9 @@ module Google end end - # Explicit content annotation (based on per-frame visual signals only). - # If no explicit content has been detected in a frame, no annotations are - # present for that frame. + # Explicit content annotation (based on per-frame visual signals only). If no + # explicit content has been detected in a frame, no annotations are present for + # that frame. class GoogleCloudVideointelligenceV1ExplicitContentAnnotation include Google::Apis::Core::Hashable @@ -264,9 +260,8 @@ module Google class GoogleCloudVideointelligenceV1ExplicitContentDetectionConfig include Google::Apis::Core::Hashable - # Model to use for explicit content detection. - # Supported values: "builtin/stable" (the default if unset) and - # "builtin/latest". + # Model to use for explicit content detection. Supported values: "builtin/stable" + # (the default if unset) and "builtin/latest". # Corresponds to the JSON property `model` # @return [String] attr_accessor :model @@ -311,10 +306,9 @@ module Google class GoogleCloudVideointelligenceV1LabelAnnotation include Google::Apis::Core::Hashable - # Common categories for the detected entity. - # For example, when the label is `Terrier`, the category is likely `dog`. And - # in some cases there might be more than one categories e.g., `Terrier` could - # also be a `pet`. + # Common categories for the detected entity. For example, when the label is ` + # Terrier`, the category is likely `dog`. And in some cases there might be more + # than one categories e.g., `Terrier` could also be a `pet`. # Corresponds to the JSON property `categoryEntities` # @return [Array] attr_accessor :category_entities @@ -357,44 +351,40 @@ module Google class GoogleCloudVideointelligenceV1LabelDetectionConfig include Google::Apis::Core::Hashable - # The confidence threshold we perform filtering on the labels from - # frame-level detection. If not set, it is set to 0.4 by default. The valid - # range for this threshold is [0.1, 0.9]. Any value set outside of this - # range will be clipped. - # Note: For best results, follow the default threshold. We will update - # the default threshold everytime when we release a new model. + # The confidence threshold we perform filtering on the labels from frame-level + # detection. If not set, it is set to 0.4 by default. The valid range for this + # threshold is [0.1, 0.9]. Any value set outside of this range will be clipped. + # Note: For best results, follow the default threshold. We will update the + # default threshold everytime when we release a new model. # Corresponds to the JSON property `frameConfidenceThreshold` # @return [Float] attr_accessor :frame_confidence_threshold - # What labels should be detected with LABEL_DETECTION, in addition to - # video-level labels or segment-level labels. - # If unspecified, defaults to `SHOT_MODE`. + # What labels should be detected with LABEL_DETECTION, in addition to video- + # level labels or segment-level labels. If unspecified, defaults to `SHOT_MODE`. # Corresponds to the JSON property `labelDetectionMode` # @return [String] attr_accessor :label_detection_mode - # Model to use for label detection. - # Supported values: "builtin/stable" (the default if unset) and - # "builtin/latest". + # Model to use for label detection. Supported values: "builtin/stable" (the + # default if unset) and "builtin/latest". # Corresponds to the JSON property `model` # @return [String] attr_accessor :model - # Whether the video has been shot from a stationary (i.e., non-moving) - # camera. When set to true, might improve detection accuracy for moving - # objects. Should be used with `SHOT_AND_FRAME_MODE` enabled. + # Whether the video has been shot from a stationary (i.e., non-moving) camera. + # When set to true, might improve detection accuracy for moving objects. Should + # be used with `SHOT_AND_FRAME_MODE` enabled. # Corresponds to the JSON property `stationaryCamera` # @return [Boolean] attr_accessor :stationary_camera alias_method :stationary_camera?, :stationary_camera - # The confidence threshold we perform filtering on the labels from - # video-level and shot-level detections. If not set, it's set to 0.3 by - # default. The valid range for this threshold is [0.1, 0.9]. Any value set - # outside of this range will be clipped. - # Note: For best results, follow the default threshold. We will update - # the default threshold everytime when we release a new model. + # The confidence threshold we perform filtering on the labels from video-level + # and shot-level detections. If not set, it's set to 0.3 by default. The valid + # range for this threshold is [0.1, 0.9]. Any value set outside of this range + # will be clipped. Note: For best results, follow the default threshold. We will + # update the default threshold everytime when we release a new model. # Corresponds to the JSON property `videoConfidenceThreshold` # @return [Float] attr_accessor :video_confidence_threshold @@ -473,14 +463,14 @@ module Google # @return [Google::Apis::VideointelligenceV1::GoogleCloudVideointelligenceV1Entity] attr_accessor :entity - # All video segments where the recognized logo appears. There might be - # multiple instances of the same logo class appearing in one VideoSegment. + # All video segments where the recognized logo appears. There might be multiple + # instances of the same logo class appearing in one VideoSegment. # Corresponds to the JSON property `segments` # @return [Array] attr_accessor :segments - # All logo tracks where the recognized logo appears. Each track corresponds - # to one logo instance appearing in consecutive frames. + # All logo tracks where the recognized logo appears. Each track corresponds to + # one logo instance appearing in consecutive frames. # Corresponds to the JSON property `tracks` # @return [Array] attr_accessor :tracks @@ -497,9 +487,8 @@ module Google end end - # Normalized bounding box. - # The normalized vertex coordinates are relative to the original image. - # Range: [0, 1]. + # Normalized bounding box. The normalized vertex coordinates are relative to the + # original image. Range: [0, 1]. class GoogleCloudVideointelligenceV1NormalizedBoundingBox include Google::Apis::Core::Hashable @@ -537,20 +526,12 @@ module Google end # Normalized bounding polygon for text (that might not be aligned with axis). - # Contains list of the corner points in clockwise order starting from - # top-left corner. For example, for a rectangular bounding box: - # When the text is horizontal it might look like: - # 0----1 - # | | - # 3----2 - # When it's clockwise rotated 180 degrees around the top-left corner it - # becomes: - # 2----3 - # | | - # 1----0 - # and the vertex order will still be (0, 1, 2, 3). Note that values can be less - # than 0, or greater than 1 due to trignometric calculations for location of - # the box. + # Contains list of the corner points in clockwise order starting from top-left + # corner. For example, for a rectangular bounding box: When the text is + # horizontal it might look like: 0----1 | | 3----2 When it's clockwise rotated + # 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the + # vertex order will still be (0, 1, 2, 3). Note that values can be less than 0, + # or greater than 1 due to trignometric calculations for location of the box. class GoogleCloudVideointelligenceV1NormalizedBoundingPoly include Google::Apis::Core::Hashable @@ -569,9 +550,8 @@ module Google end end - # A vertex represents a 2D point in the image. - # NOTE: the normalized vertex coordinates are relative to the original image - # and range from 0 to 1. + # A vertex represents a 2D point in the image. NOTE: the normalized vertex + # coordinates are relative to the original image and range from 0 to 1. class GoogleCloudVideointelligenceV1NormalizedVertex include Google::Apis::Core::Hashable @@ -610,10 +590,10 @@ module Google # @return [Google::Apis::VideointelligenceV1::GoogleCloudVideointelligenceV1Entity] attr_accessor :entity - # Information corresponding to all frames where this object track appears. - # Non-streaming batch mode: it may be one or multiple ObjectTrackingFrame - # messages in frames. - # Streaming mode: it can only be one ObjectTrackingFrame message in frames. + # Information corresponding to all frames where this object track appears. Non- + # streaming batch mode: it may be one or multiple ObjectTrackingFrame messages + # in frames. Streaming mode: it can only be one ObjectTrackingFrame message in + # frames. # Corresponds to the JSON property `frames` # @return [Array] attr_accessor :frames @@ -623,12 +603,11 @@ module Google # @return [Google::Apis::VideointelligenceV1::GoogleCloudVideointelligenceV1VideoSegment] attr_accessor :segment - # Streaming mode ONLY. - # In streaming mode, we do not know the end time of a tracked object - # before it is completed. Hence, there is no VideoSegment info returned. - # Instead, we provide a unique identifiable integer track_id so that - # the customers can correlate the results of the ongoing - # ObjectTrackAnnotation of the same track_id over time. + # Streaming mode ONLY. In streaming mode, we do not know the end time of a + # tracked object before it is completed. Hence, there is no VideoSegment info + # returned. Instead, we provide a unique identifiable integer track_id so that + # the customers can correlate the results of the ongoing ObjectTrackAnnotation + # of the same track_id over time. # Corresponds to the JSON property `trackId` # @return [Fixnum] attr_accessor :track_id @@ -657,9 +636,8 @@ module Google class GoogleCloudVideointelligenceV1ObjectTrackingConfig include Google::Apis::Core::Hashable - # Model to use for object tracking. - # Supported values: "builtin/stable" (the default if unset) and - # "builtin/latest". + # Model to use for object tracking. Supported values: "builtin/stable" (the + # default if unset) and "builtin/latest". # Corresponds to the JSON property `model` # @return [String] attr_accessor :model @@ -679,9 +657,8 @@ module Google class GoogleCloudVideointelligenceV1ObjectTrackingFrame include Google::Apis::Core::Hashable - # Normalized bounding box. - # The normalized vertex coordinates are relative to the original image. - # Range: [0, 1]. + # Normalized bounding box. The normalized vertex coordinates are relative to the + # original image. Range: [0, 1]. # Corresponds to the JSON property `normalizedBoundingBox` # @return [Google::Apis::VideointelligenceV1::GoogleCloudVideointelligenceV1NormalizedBoundingBox] attr_accessor :normalized_bounding_box @@ -706,9 +683,8 @@ module Google class GoogleCloudVideointelligenceV1ShotChangeDetectionConfig include Google::Apis::Core::Hashable - # Model to use for shot change detection. - # Supported values: "builtin/stable" (the default if unset) and - # "builtin/latest". + # Model to use for shot change detection. Supported values: "builtin/stable" ( + # the default if unset) and "builtin/latest". # Corresponds to the JSON property `model` # @return [String] attr_accessor :model @@ -728,12 +704,12 @@ module Google class GoogleCloudVideointelligenceV1SpeechContext include Google::Apis::Core::Hashable - # Optional. A list of strings containing words and phrases "hints" so that - # the speech recognition is more likely to recognize them. This can be used - # to improve the accuracy for specific words and phrases, for example, if - # specific commands are typically spoken by the user. This can also be used - # to add additional words to the vocabulary of the recognizer. See - # [usage limits](https://cloud.google.com/speech/limits#content). + # Optional. A list of strings containing words and phrases "hints" so that the + # speech recognition is more likely to recognize them. This can be used to + # improve the accuracy for specific words and phrases, for example, if specific + # commands are typically spoken by the user. This can also be used to add + # additional words to the vocabulary of the recognizer. See [usage limits](https: + # //cloud.google.com/speech/limits#content). # Corresponds to the JSON property `phrases` # @return [Array] attr_accessor :phrases @@ -754,10 +730,10 @@ module Google # Output only. The confidence estimate between 0.0 and 1.0. A higher number # indicates an estimated greater likelihood that the recognized words are - # correct. This field is set only for the top alternative. - # This field is not guaranteed to be accurate and users should not rely on it - # to be always provided. - # The default of 0.0 is a sentinel value indicating `confidence` was not set. + # correct. This field is set only for the top alternative. This field is not + # guaranteed to be accurate and users should not rely on it to be always + # provided. The default of 0.0 is a sentinel value indicating `confidence` was + # not set. # Corresponds to the JSON property `confidence` # @return [Float] attr_accessor :confidence @@ -768,8 +744,8 @@ module Google attr_accessor :transcript # Output only. A list of word-specific information for each recognized word. - # Note: When `enable_speaker_diarization` is set to true, you will see all - # the words from the beginning of the audio. + # Note: When `enable_speaker_diarization` is set to true, you will see all the + # words from the beginning of the audio. # Corresponds to the JSON property `words` # @return [Array] attr_accessor :words @@ -790,18 +766,17 @@ module Google class GoogleCloudVideointelligenceV1SpeechTranscription include Google::Apis::Core::Hashable - # May contain one or more recognition hypotheses (up to the maximum specified - # in `max_alternatives`). These alternatives are ordered in terms of - # accuracy, with the top (first) alternative being the most probable, as - # ranked by the recognizer. + # May contain one or more recognition hypotheses (up to the maximum specified in + # `max_alternatives`). These alternatives are ordered in terms of accuracy, with + # the top (first) alternative being the most probable, as ranked by the + # recognizer. # Corresponds to the JSON property `alternatives` # @return [Array] attr_accessor :alternatives # Output only. The [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) - # language tag of - # the language in this result. This language code was detected to have the - # most likelihood of being spoken in the audio. + # language tag of the language in this result. This language code was detected + # to have the most likelihood of being spoken in the audio. # Corresponds to the JSON property `languageCode` # @return [String] attr_accessor :language_code @@ -828,66 +803,62 @@ module Google attr_accessor :audio_tracks # Optional. If set, specifies the estimated number of speakers in the - # conversation. - # If not set, defaults to '2'. - # Ignored unless enable_speaker_diarization is set to true. + # conversation. If not set, defaults to '2'. Ignored unless + # enable_speaker_diarization is set to true. # Corresponds to the JSON property `diarizationSpeakerCount` # @return [Fixnum] attr_accessor :diarization_speaker_count - # Optional. If 'true', adds punctuation to recognition result hypotheses. - # This feature is only available in select languages. Setting this for - # requests in other languages has no effect at all. The default 'false' value - # does not add punctuation to result hypotheses. NOTE: "This is currently - # offered as an experimental service, complimentary to all users. In the - # future this may be exclusively available as a premium feature." + # Optional. If 'true', adds punctuation to recognition result hypotheses. This + # feature is only available in select languages. Setting this for requests in + # other languages has no effect at all. The default 'false' value does not add + # punctuation to result hypotheses. NOTE: "This is currently offered as an + # experimental service, complimentary to all users. In the future this may be + # exclusively available as a premium feature." # Corresponds to the JSON property `enableAutomaticPunctuation` # @return [Boolean] attr_accessor :enable_automatic_punctuation alias_method :enable_automatic_punctuation?, :enable_automatic_punctuation - # Optional. If 'true', enables speaker detection for each recognized word in - # the top alternative of the recognition result using a speaker_tag provided - # in the WordInfo. - # Note: When this is true, we send all the words from the beginning of the - # audio for the top alternative in every consecutive response. - # This is done in order to improve our speaker tags as our models learn to - # identify the speakers in the conversation over time. + # Optional. If 'true', enables speaker detection for each recognized word in the + # top alternative of the recognition result using a speaker_tag provided in the + # WordInfo. Note: When this is true, we send all the words from the beginning of + # the audio for the top alternative in every consecutive response. This is done + # in order to improve our speaker tags as our models learn to identify the + # speakers in the conversation over time. # Corresponds to the JSON property `enableSpeakerDiarization` # @return [Boolean] attr_accessor :enable_speaker_diarization alias_method :enable_speaker_diarization?, :enable_speaker_diarization # Optional. If `true`, the top result includes a list of words and the - # confidence for those words. If `false`, no word-level confidence - # information is returned. The default is `false`. + # confidence for those words. If `false`, no word-level confidence information + # is returned. The default is `false`. # Corresponds to the JSON property `enableWordConfidence` # @return [Boolean] attr_accessor :enable_word_confidence alias_method :enable_word_confidence?, :enable_word_confidence - # Optional. If set to `true`, the server will attempt to filter out - # profanities, replacing all but the initial character in each filtered word - # with asterisks, e.g. "f***". If set to `false` or omitted, profanities - # won't be filtered out. + # Optional. If set to `true`, the server will attempt to filter out profanities, + # replacing all but the initial character in each filtered word with asterisks, + # e.g. "f***". If set to `false` or omitted, profanities won't be filtered out. # Corresponds to the JSON property `filterProfanity` # @return [Boolean] attr_accessor :filter_profanity alias_method :filter_profanity?, :filter_profanity - # Required. *Required* The language of the supplied audio as a - # [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) language tag. - # Example: "en-US". - # See [Language Support](https://cloud.google.com/speech/docs/languages) - # for a list of the currently supported language codes. + # Required. *Required* The language of the supplied audio as a [BCP-47](https:// + # www.rfc-editor.org/rfc/bcp/bcp47.txt) language tag. Example: "en-US". See [ + # Language Support](https://cloud.google.com/speech/docs/languages) for a list + # of the currently supported language codes. # Corresponds to the JSON property `languageCode` # @return [String] attr_accessor :language_code # Optional. Maximum number of recognition hypotheses to be returned. # Specifically, the maximum number of `SpeechRecognitionAlternative` messages - # within each `SpeechTranscription`. The server may return fewer than - # `max_alternatives`. Valid values are `0`-`30`. A value of `0` or `1` will + # within each `SpeechTranscription`. The server may return fewer than ` + # max_alternatives`. Valid values are `0`-`30`. A value of `0` or `1` will # return a maximum of one. If omitted, will return a maximum of one. # Corresponds to the JSON property `maxAlternatives` # @return [Fixnum] @@ -954,16 +925,15 @@ module Google include Google::Apis::Core::Hashable # Language hint can be specified if the language to be detected is known a - # priori. It can increase the accuracy of the detection. Language hint must - # be language code in BCP-47 format. - # Automatic language detection is performed if no hint is provided. + # priori. It can increase the accuracy of the detection. Language hint must be + # language code in BCP-47 format. Automatic language detection is performed if + # no hint is provided. # Corresponds to the JSON property `languageHints` # @return [Array] attr_accessor :language_hints - # Model to use for text detection. - # Supported values: "builtin/stable" (the default if unset) and - # "builtin/latest". + # Model to use for text detection. Supported values: "builtin/stable" (the + # default if unset) and "builtin/latest". # Corresponds to the JSON property `model` # @return [String] attr_accessor :model @@ -979,27 +949,19 @@ module Google end end - # Video frame level annotation results for text annotation (OCR). - # Contains information regarding timestamp and bounding box locations for the - # frames containing detected OCR text snippets. + # Video frame level annotation results for text annotation (OCR). Contains + # information regarding timestamp and bounding box locations for the frames + # containing detected OCR text snippets. class GoogleCloudVideointelligenceV1TextFrame include Google::Apis::Core::Hashable # Normalized bounding polygon for text (that might not be aligned with axis). - # Contains list of the corner points in clockwise order starting from - # top-left corner. For example, for a rectangular bounding box: - # When the text is horizontal it might look like: - # 0----1 - # | | - # 3----2 - # When it's clockwise rotated 180 degrees around the top-left corner it - # becomes: - # 2----3 - # | | - # 1----0 - # and the vertex order will still be (0, 1, 2, 3). Note that values can be less - # than 0, or greater than 1 due to trignometric calculations for location of - # the box. + # Contains list of the corner points in clockwise order starting from top-left + # corner. For example, for a rectangular bounding box: When the text is + # horizontal it might look like: 0----1 | | 3----2 When it's clockwise rotated + # 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the + # vertex order will still be (0, 1, 2, 3). Note that values can be less than 0, + # or greater than 1 due to trignometric calculations for location of the box. # Corresponds to the JSON property `rotatedBoundingBox` # @return [Google::Apis::VideointelligenceV1::GoogleCloudVideointelligenceV1NormalizedBoundingPoly] attr_accessor :rotated_bounding_box @@ -1052,9 +1014,8 @@ module Google end end - # For tracking related features. - # An object at time_offset with attributes, and located with - # normalized_bounding_box. + # For tracking related features. An object at time_offset with attributes, and + # located with normalized_bounding_box. class GoogleCloudVideointelligenceV1TimestampedObject include Google::Apis::Core::Hashable @@ -1068,15 +1029,14 @@ module Google # @return [Array] attr_accessor :landmarks - # Normalized bounding box. - # The normalized vertex coordinates are relative to the original image. - # Range: [0, 1]. + # Normalized bounding box. The normalized vertex coordinates are relative to the + # original image. Range: [0, 1]. # Corresponds to the JSON property `normalizedBoundingBox` # @return [Google::Apis::VideointelligenceV1::GoogleCloudVideointelligenceV1NormalizedBoundingBox] attr_accessor :normalized_bounding_box - # Time-offset, relative to the beginning of the video, - # corresponding to the video frame for this object. + # Time-offset, relative to the beginning of the video, corresponding to the + # video frame for this object. # Corresponds to the JSON property `timeOffset` # @return [String] attr_accessor :time_offset @@ -1135,20 +1095,19 @@ module Google class GoogleCloudVideointelligenceV1VideoAnnotationProgress include Google::Apis::Core::Hashable - # Specifies which feature is being tracked if the request contains more than - # one feature. + # Specifies which feature is being tracked if the request contains more than one + # feature. # Corresponds to the JSON property `feature` # @return [String] attr_accessor :feature - # Video file location in - # [Cloud Storage](https://cloud.google.com/storage/). + # Video file location in [Cloud Storage](https://cloud.google.com/storage/). # Corresponds to the JSON property `inputUri` # @return [String] attr_accessor :input_uri - # Approximate percentage processed thus far. Guaranteed to be - # 100 when fully processed. + # Approximate percentage processed thus far. Guaranteed to be 100 when fully + # processed. # Corresponds to the JSON property `progressPercent` # @return [Fixnum] attr_accessor :progress_percent @@ -1187,31 +1146,30 @@ module Google class GoogleCloudVideointelligenceV1VideoAnnotationResults include Google::Apis::Core::Hashable - # 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::VideointelligenceV1::GoogleRpcStatus] attr_accessor :error - # Explicit content annotation (based on per-frame visual signals only). - # If no explicit content has been detected in a frame, no annotations are - # present for that frame. + # Explicit content annotation (based on per-frame visual signals only). If no + # explicit content has been detected in a frame, no annotations are present for + # that frame. # Corresponds to the JSON property `explicitAnnotation` # @return [Google::Apis::VideointelligenceV1::GoogleCloudVideointelligenceV1ExplicitContentAnnotation] attr_accessor :explicit_annotation - # Label annotations on frame level. - # There is exactly one element for each unique label. + # Label annotations on frame level. There is exactly one element for each unique + # label. # Corresponds to the JSON property `frameLabelAnnotations` # @return [Array] attr_accessor :frame_label_annotations - # Video file location in - # [Cloud Storage](https://cloud.google.com/storage/). + # Video file location in [Cloud Storage](https://cloud.google.com/storage/). # Corresponds to the JSON property `inputUri` # @return [String] attr_accessor :input_uri @@ -1238,11 +1196,11 @@ module Google attr_accessor :segment_label_annotations # Presence label annotations on video level or user-specified segment level. - # There is exactly one element for each unique label. Compared to the - # existing topical `segment_label_annotations`, this field presents more - # fine-grained, segment-level labels detected in video content and is made - # available only when the client sets `LabelDetectionConfig.model` to - # "builtin/latest" in the request. + # There is exactly one element for each unique label. Compared to the existing + # topical `segment_label_annotations`, this field presents more fine-grained, + # segment-level labels detected in video content and is made available only when + # the client sets `LabelDetectionConfig.model` to "builtin/latest" in the + # request. # Corresponds to the JSON property `segmentPresenceLabelAnnotations` # @return [Array] attr_accessor :segment_presence_label_annotations @@ -1252,17 +1210,17 @@ module Google # @return [Array] attr_accessor :shot_annotations - # Topical label annotations on shot level. - # There is exactly one element for each unique label. + # Topical label annotations on shot level. There is exactly one element for each + # unique label. # Corresponds to the JSON property `shotLabelAnnotations` # @return [Array] attr_accessor :shot_label_annotations # Presence label annotations on shot level. There is exactly one element for - # each unique label. Compared to the existing topical - # `shot_label_annotations`, this field presents more fine-grained, shot-level - # labels detected in video content and is made available only when the client - # sets `LabelDetectionConfig.model` to "builtin/latest" in the request. + # each unique label. Compared to the existing topical `shot_label_annotations`, + # this field presents more fine-grained, shot-level labels detected in video + # content and is made available only when the client sets `LabelDetectionConfig. + # model` to "builtin/latest" in the request. # Corresponds to the JSON property `shotPresenceLabelAnnotations` # @return [Array] attr_accessor :shot_presence_label_annotations @@ -1272,9 +1230,8 @@ module Google # @return [Array] attr_accessor :speech_transcriptions - # OCR text detection and tracking. - # Annotations for list of detected text snippets. Each will have list of - # frame information associated with it. + # OCR text detection and tracking. Annotations for list of detected text + # snippets. Each will have list of frame information associated with it. # Corresponds to the JSON property `textAnnotations` # @return [Array] attr_accessor :text_annotations @@ -1321,9 +1278,9 @@ module Google # @return [Google::Apis::VideointelligenceV1::GoogleCloudVideointelligenceV1ObjectTrackingConfig] attr_accessor :object_tracking_config - # Video segments to annotate. The segments may overlap and are not required - # to be contiguous or span the whole video. If unspecified, each video is - # treated as a single segment. + # Video segments to annotate. The segments may overlap and are not required to + # be contiguous or span the whole video. If unspecified, each video is treated + # as a single segment. # Corresponds to the JSON property `segments` # @return [Array] attr_accessor :segments @@ -1363,14 +1320,14 @@ module Google class GoogleCloudVideointelligenceV1VideoSegment include Google::Apis::Core::Hashable - # Time-offset, relative to the beginning of the video, - # corresponding to the end of the segment (inclusive). + # Time-offset, relative to the beginning of the video, corresponding to the end + # of the segment (inclusive). # Corresponds to the JSON property `endTimeOffset` # @return [String] attr_accessor :end_time_offset - # Time-offset, relative to the beginning of the video, - # corresponding to the start of the segment (inclusive). + # Time-offset, relative to the beginning of the video, corresponding to the + # start of the segment (inclusive). # Corresponds to the JSON property `startTimeOffset` # @return [String] attr_accessor :start_time_offset @@ -1387,41 +1344,41 @@ module Google end # Word-specific information for recognized words. Word information is only - # included in the response when certain request parameters are set, such - # as `enable_word_time_offsets`. + # included in the response when certain request parameters are set, such as ` + # enable_word_time_offsets`. class GoogleCloudVideointelligenceV1WordInfo include Google::Apis::Core::Hashable # Output only. The confidence estimate between 0.0 and 1.0. A higher number # indicates an estimated greater likelihood that the recognized words are - # correct. This field is set only for the top alternative. - # This field is not guaranteed to be accurate and users should not rely on it - # to be always provided. - # The default of 0.0 is a sentinel value indicating `confidence` was not set. + # correct. This field is set only for the top alternative. This field is not + # guaranteed to be accurate and users should not rely on it to be always + # provided. The default of 0.0 is a sentinel value indicating `confidence` was + # not set. # Corresponds to the JSON property `confidence` # @return [Float] attr_accessor :confidence - # Time offset relative to the beginning of the audio, and - # corresponding to the end of the spoken word. This field is only set if - # `enable_word_time_offsets=true` and only in the top hypothesis. This is an - # experimental feature and the accuracy of the time offset can vary. + # Time offset relative to the beginning of the audio, and corresponding to the + # end of the spoken word. This field is only set if `enable_word_time_offsets= + # true` and only in the top hypothesis. This is an experimental feature and the + # accuracy of the time offset can vary. # Corresponds to the JSON property `endTime` # @return [String] attr_accessor :end_time - # Output only. A distinct integer value is assigned for every speaker within - # the audio. This field specifies which one of those speakers was detected to - # have spoken this word. Value ranges from 1 up to diarization_speaker_count, - # and is only set if speaker diarization is enabled. + # Output only. A distinct integer value is assigned for every speaker within the + # audio. This field specifies which one of those speakers was detected to have + # spoken this word. Value ranges from 1 up to diarization_speaker_count, and is + # only set if speaker diarization is enabled. # Corresponds to the JSON property `speakerTag` # @return [Fixnum] attr_accessor :speaker_tag - # Time offset relative to the beginning of the audio, and - # corresponding to the start of the spoken word. This field is only set if - # `enable_word_time_offsets=true` and only in the top hypothesis. This is an - # experimental feature and the accuracy of the time offset can vary. + # Time offset relative to the beginning of the audio, and corresponding to the + # start of the spoken word. This field is only set if `enable_word_time_offsets= + # true` and only in the top hypothesis. This is an experimental feature and the + # accuracy of the time offset can vary. # Corresponds to the JSON property `startTime` # @return [String] attr_accessor :start_time @@ -1445,9 +1402,9 @@ module Google end end - # Video annotation progress. Included in the `metadata` - # field of the `Operation` returned by the `GetOperation` - # call of the `google::longrunning::Operations` service. + # Video annotation progress. Included in the `metadata` field of the `Operation` + # returned by the `GetOperation` call of the `google::longrunning::Operations` + # service. class GoogleCloudVideointelligenceV1beta2AnnotateVideoProgress include Google::Apis::Core::Hashable @@ -1466,9 +1423,9 @@ module Google end end - # Video annotation response. Included in the `response` - # field of the `Operation` returned by the `GetOperation` - # call of the `google::longrunning::Operations` service. + # Video annotation response. Included in the `response` field of the `Operation` + # returned by the `GetOperation` call of the `google::longrunning::Operations` + # service. class GoogleCloudVideointelligenceV1beta2AnnotateVideoResponse include Google::Apis::Core::Hashable @@ -1496,14 +1453,14 @@ module Google # @return [Float] attr_accessor :confidence - # The name of the attribute, for example, glasses, dark_glasses, mouth_open. - # A full list of supported type names will be provided in the document. + # The name of the attribute, for example, glasses, dark_glasses, mouth_open. A + # full list of supported type names will be provided in the document. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name - # Text value of the detection result. For example, the value for "HairColor" - # can be "black", "blonde", etc. + # Text value of the detection result. For example, the value for "HairColor" can + # be "black", "blonde", etc. # Corresponds to the JSON property `value` # @return [String] attr_accessor :value @@ -1535,9 +1492,8 @@ module Google # @return [String] attr_accessor :name - # A vertex represents a 2D point in the image. - # NOTE: the normalized vertex coordinates are relative to the original image - # and range from 0 to 1. + # A vertex represents a 2D point in the image. NOTE: the normalized vertex + # coordinates are relative to the original image and range from 0 to 1. # Corresponds to the JSON property `point` # @return [Google::Apis::VideointelligenceV1::GoogleCloudVideointelligenceV1beta2NormalizedVertex] attr_accessor :point @@ -1563,8 +1519,7 @@ module Google # @return [String] attr_accessor :description - # Opaque entity ID. Some IDs may be available in - # [Google Knowledge Graph Search + # Opaque entity ID. Some IDs may be available in [Google Knowledge Graph Search # API](https://developers.google.com/knowledge-graph/). # Corresponds to the JSON property `entityId` # @return [String] @@ -1587,9 +1542,9 @@ module Google end end - # Explicit content annotation (based on per-frame visual signals only). - # If no explicit content has been detected in a frame, no annotations are - # present for that frame. + # Explicit content annotation (based on per-frame visual signals only). If no + # explicit content has been detected in a frame, no annotations are present for + # that frame. class GoogleCloudVideointelligenceV1beta2ExplicitContentAnnotation include Google::Apis::Core::Hashable @@ -1644,10 +1599,9 @@ module Google class GoogleCloudVideointelligenceV1beta2LabelAnnotation include Google::Apis::Core::Hashable - # Common categories for the detected entity. - # For example, when the label is `Terrier`, the category is likely `dog`. And - # in some cases there might be more than one categories e.g., `Terrier` could - # also be a `pet`. + # Common categories for the detected entity. For example, when the label is ` + # Terrier`, the category is likely `dog`. And in some cases there might be more + # than one categories e.g., `Terrier` could also be a `pet`. # Corresponds to the JSON property `categoryEntities` # @return [Array] attr_accessor :category_entities @@ -1746,14 +1700,14 @@ module Google # @return [Google::Apis::VideointelligenceV1::GoogleCloudVideointelligenceV1beta2Entity] attr_accessor :entity - # All video segments where the recognized logo appears. There might be - # multiple instances of the same logo class appearing in one VideoSegment. + # All video segments where the recognized logo appears. There might be multiple + # instances of the same logo class appearing in one VideoSegment. # Corresponds to the JSON property `segments` # @return [Array] attr_accessor :segments - # All logo tracks where the recognized logo appears. Each track corresponds - # to one logo instance appearing in consecutive frames. + # All logo tracks where the recognized logo appears. Each track corresponds to + # one logo instance appearing in consecutive frames. # Corresponds to the JSON property `tracks` # @return [Array] attr_accessor :tracks @@ -1770,9 +1724,8 @@ module Google end end - # Normalized bounding box. - # The normalized vertex coordinates are relative to the original image. - # Range: [0, 1]. + # Normalized bounding box. The normalized vertex coordinates are relative to the + # original image. Range: [0, 1]. class GoogleCloudVideointelligenceV1beta2NormalizedBoundingBox include Google::Apis::Core::Hashable @@ -1810,20 +1763,12 @@ module Google end # Normalized bounding polygon for text (that might not be aligned with axis). - # Contains list of the corner points in clockwise order starting from - # top-left corner. For example, for a rectangular bounding box: - # When the text is horizontal it might look like: - # 0----1 - # | | - # 3----2 - # When it's clockwise rotated 180 degrees around the top-left corner it - # becomes: - # 2----3 - # | | - # 1----0 - # and the vertex order will still be (0, 1, 2, 3). Note that values can be less - # than 0, or greater than 1 due to trignometric calculations for location of - # the box. + # Contains list of the corner points in clockwise order starting from top-left + # corner. For example, for a rectangular bounding box: When the text is + # horizontal it might look like: 0----1 | | 3----2 When it's clockwise rotated + # 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the + # vertex order will still be (0, 1, 2, 3). Note that values can be less than 0, + # or greater than 1 due to trignometric calculations for location of the box. class GoogleCloudVideointelligenceV1beta2NormalizedBoundingPoly include Google::Apis::Core::Hashable @@ -1842,9 +1787,8 @@ module Google end end - # A vertex represents a 2D point in the image. - # NOTE: the normalized vertex coordinates are relative to the original image - # and range from 0 to 1. + # A vertex represents a 2D point in the image. NOTE: the normalized vertex + # coordinates are relative to the original image and range from 0 to 1. class GoogleCloudVideointelligenceV1beta2NormalizedVertex include Google::Apis::Core::Hashable @@ -1883,10 +1827,10 @@ module Google # @return [Google::Apis::VideointelligenceV1::GoogleCloudVideointelligenceV1beta2Entity] attr_accessor :entity - # Information corresponding to all frames where this object track appears. - # Non-streaming batch mode: it may be one or multiple ObjectTrackingFrame - # messages in frames. - # Streaming mode: it can only be one ObjectTrackingFrame message in frames. + # Information corresponding to all frames where this object track appears. Non- + # streaming batch mode: it may be one or multiple ObjectTrackingFrame messages + # in frames. Streaming mode: it can only be one ObjectTrackingFrame message in + # frames. # Corresponds to the JSON property `frames` # @return [Array] attr_accessor :frames @@ -1896,12 +1840,11 @@ module Google # @return [Google::Apis::VideointelligenceV1::GoogleCloudVideointelligenceV1beta2VideoSegment] attr_accessor :segment - # Streaming mode ONLY. - # In streaming mode, we do not know the end time of a tracked object - # before it is completed. Hence, there is no VideoSegment info returned. - # Instead, we provide a unique identifiable integer track_id so that - # the customers can correlate the results of the ongoing - # ObjectTrackAnnotation of the same track_id over time. + # Streaming mode ONLY. In streaming mode, we do not know the end time of a + # tracked object before it is completed. Hence, there is no VideoSegment info + # returned. Instead, we provide a unique identifiable integer track_id so that + # the customers can correlate the results of the ongoing ObjectTrackAnnotation + # of the same track_id over time. # Corresponds to the JSON property `trackId` # @return [Fixnum] attr_accessor :track_id @@ -1931,9 +1874,8 @@ module Google class GoogleCloudVideointelligenceV1beta2ObjectTrackingFrame include Google::Apis::Core::Hashable - # Normalized bounding box. - # The normalized vertex coordinates are relative to the original image. - # Range: [0, 1]. + # Normalized bounding box. The normalized vertex coordinates are relative to the + # original image. Range: [0, 1]. # Corresponds to the JSON property `normalizedBoundingBox` # @return [Google::Apis::VideointelligenceV1::GoogleCloudVideointelligenceV1beta2NormalizedBoundingBox] attr_accessor :normalized_bounding_box @@ -1960,10 +1902,10 @@ module Google # Output only. The confidence estimate between 0.0 and 1.0. A higher number # indicates an estimated greater likelihood that the recognized words are - # correct. This field is set only for the top alternative. - # This field is not guaranteed to be accurate and users should not rely on it - # to be always provided. - # The default of 0.0 is a sentinel value indicating `confidence` was not set. + # correct. This field is set only for the top alternative. This field is not + # guaranteed to be accurate and users should not rely on it to be always + # provided. The default of 0.0 is a sentinel value indicating `confidence` was + # not set. # Corresponds to the JSON property `confidence` # @return [Float] attr_accessor :confidence @@ -1974,8 +1916,8 @@ module Google attr_accessor :transcript # Output only. A list of word-specific information for each recognized word. - # Note: When `enable_speaker_diarization` is set to true, you will see all - # the words from the beginning of the audio. + # Note: When `enable_speaker_diarization` is set to true, you will see all the + # words from the beginning of the audio. # Corresponds to the JSON property `words` # @return [Array] attr_accessor :words @@ -1996,18 +1938,17 @@ module Google class GoogleCloudVideointelligenceV1beta2SpeechTranscription include Google::Apis::Core::Hashable - # May contain one or more recognition hypotheses (up to the maximum specified - # in `max_alternatives`). These alternatives are ordered in terms of - # accuracy, with the top (first) alternative being the most probable, as - # ranked by the recognizer. + # May contain one or more recognition hypotheses (up to the maximum specified in + # `max_alternatives`). These alternatives are ordered in terms of accuracy, with + # the top (first) alternative being the most probable, as ranked by the + # recognizer. # Corresponds to the JSON property `alternatives` # @return [Array] attr_accessor :alternatives # Output only. The [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) - # language tag of - # the language in this result. This language code was detected to have the - # most likelihood of being spoken in the audio. + # language tag of the language in this result. This language code was detected + # to have the most likelihood of being spoken in the audio. # Corresponds to the JSON property `languageCode` # @return [String] attr_accessor :language_code @@ -2056,27 +1997,19 @@ module Google end end - # Video frame level annotation results for text annotation (OCR). - # Contains information regarding timestamp and bounding box locations for the - # frames containing detected OCR text snippets. + # Video frame level annotation results for text annotation (OCR). Contains + # information regarding timestamp and bounding box locations for the frames + # containing detected OCR text snippets. class GoogleCloudVideointelligenceV1beta2TextFrame include Google::Apis::Core::Hashable # Normalized bounding polygon for text (that might not be aligned with axis). - # Contains list of the corner points in clockwise order starting from - # top-left corner. For example, for a rectangular bounding box: - # When the text is horizontal it might look like: - # 0----1 - # | | - # 3----2 - # When it's clockwise rotated 180 degrees around the top-left corner it - # becomes: - # 2----3 - # | | - # 1----0 - # and the vertex order will still be (0, 1, 2, 3). Note that values can be less - # than 0, or greater than 1 due to trignometric calculations for location of - # the box. + # Contains list of the corner points in clockwise order starting from top-left + # corner. For example, for a rectangular bounding box: When the text is + # horizontal it might look like: 0----1 | | 3----2 When it's clockwise rotated + # 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the + # vertex order will still be (0, 1, 2, 3). Note that values can be less than 0, + # or greater than 1 due to trignometric calculations for location of the box. # Corresponds to the JSON property `rotatedBoundingBox` # @return [Google::Apis::VideointelligenceV1::GoogleCloudVideointelligenceV1beta2NormalizedBoundingPoly] attr_accessor :rotated_bounding_box @@ -2129,9 +2062,8 @@ module Google end end - # For tracking related features. - # An object at time_offset with attributes, and located with - # normalized_bounding_box. + # For tracking related features. An object at time_offset with attributes, and + # located with normalized_bounding_box. class GoogleCloudVideointelligenceV1beta2TimestampedObject include Google::Apis::Core::Hashable @@ -2145,15 +2077,14 @@ module Google # @return [Array] attr_accessor :landmarks - # Normalized bounding box. - # The normalized vertex coordinates are relative to the original image. - # Range: [0, 1]. + # Normalized bounding box. The normalized vertex coordinates are relative to the + # original image. Range: [0, 1]. # Corresponds to the JSON property `normalizedBoundingBox` # @return [Google::Apis::VideointelligenceV1::GoogleCloudVideointelligenceV1beta2NormalizedBoundingBox] attr_accessor :normalized_bounding_box - # Time-offset, relative to the beginning of the video, - # corresponding to the video frame for this object. + # Time-offset, relative to the beginning of the video, corresponding to the + # video frame for this object. # Corresponds to the JSON property `timeOffset` # @return [String] attr_accessor :time_offset @@ -2212,20 +2143,19 @@ module Google class GoogleCloudVideointelligenceV1beta2VideoAnnotationProgress include Google::Apis::Core::Hashable - # Specifies which feature is being tracked if the request contains more than - # one feature. + # Specifies which feature is being tracked if the request contains more than one + # feature. # Corresponds to the JSON property `feature` # @return [String] attr_accessor :feature - # Video file location in - # [Cloud Storage](https://cloud.google.com/storage/). + # Video file location in [Cloud Storage](https://cloud.google.com/storage/). # Corresponds to the JSON property `inputUri` # @return [String] attr_accessor :input_uri - # Approximate percentage processed thus far. Guaranteed to be - # 100 when fully processed. + # Approximate percentage processed thus far. Guaranteed to be 100 when fully + # processed. # Corresponds to the JSON property `progressPercent` # @return [Fixnum] attr_accessor :progress_percent @@ -2264,31 +2194,30 @@ module Google class GoogleCloudVideointelligenceV1beta2VideoAnnotationResults include Google::Apis::Core::Hashable - # 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::VideointelligenceV1::GoogleRpcStatus] attr_accessor :error - # Explicit content annotation (based on per-frame visual signals only). - # If no explicit content has been detected in a frame, no annotations are - # present for that frame. + # Explicit content annotation (based on per-frame visual signals only). If no + # explicit content has been detected in a frame, no annotations are present for + # that frame. # Corresponds to the JSON property `explicitAnnotation` # @return [Google::Apis::VideointelligenceV1::GoogleCloudVideointelligenceV1beta2ExplicitContentAnnotation] attr_accessor :explicit_annotation - # Label annotations on frame level. - # There is exactly one element for each unique label. + # Label annotations on frame level. There is exactly one element for each unique + # label. # Corresponds to the JSON property `frameLabelAnnotations` # @return [Array] attr_accessor :frame_label_annotations - # Video file location in - # [Cloud Storage](https://cloud.google.com/storage/). + # Video file location in [Cloud Storage](https://cloud.google.com/storage/). # Corresponds to the JSON property `inputUri` # @return [String] attr_accessor :input_uri @@ -2315,11 +2244,11 @@ module Google attr_accessor :segment_label_annotations # Presence label annotations on video level or user-specified segment level. - # There is exactly one element for each unique label. Compared to the - # existing topical `segment_label_annotations`, this field presents more - # fine-grained, segment-level labels detected in video content and is made - # available only when the client sets `LabelDetectionConfig.model` to - # "builtin/latest" in the request. + # There is exactly one element for each unique label. Compared to the existing + # topical `segment_label_annotations`, this field presents more fine-grained, + # segment-level labels detected in video content and is made available only when + # the client sets `LabelDetectionConfig.model` to "builtin/latest" in the + # request. # Corresponds to the JSON property `segmentPresenceLabelAnnotations` # @return [Array] attr_accessor :segment_presence_label_annotations @@ -2329,17 +2258,17 @@ module Google # @return [Array] attr_accessor :shot_annotations - # Topical label annotations on shot level. - # There is exactly one element for each unique label. + # Topical label annotations on shot level. There is exactly one element for each + # unique label. # Corresponds to the JSON property `shotLabelAnnotations` # @return [Array] attr_accessor :shot_label_annotations # Presence label annotations on shot level. There is exactly one element for - # each unique label. Compared to the existing topical - # `shot_label_annotations`, this field presents more fine-grained, shot-level - # labels detected in video content and is made available only when the client - # sets `LabelDetectionConfig.model` to "builtin/latest" in the request. + # each unique label. Compared to the existing topical `shot_label_annotations`, + # this field presents more fine-grained, shot-level labels detected in video + # content and is made available only when the client sets `LabelDetectionConfig. + # model` to "builtin/latest" in the request. # Corresponds to the JSON property `shotPresenceLabelAnnotations` # @return [Array] attr_accessor :shot_presence_label_annotations @@ -2349,9 +2278,8 @@ module Google # @return [Array] attr_accessor :speech_transcriptions - # OCR text detection and tracking. - # Annotations for list of detected text snippets. Each will have list of - # frame information associated with it. + # OCR text detection and tracking. Annotations for list of detected text + # snippets. Each will have list of frame information associated with it. # Corresponds to the JSON property `textAnnotations` # @return [Array] attr_accessor :text_annotations @@ -2383,14 +2311,14 @@ module Google class GoogleCloudVideointelligenceV1beta2VideoSegment include Google::Apis::Core::Hashable - # Time-offset, relative to the beginning of the video, - # corresponding to the end of the segment (inclusive). + # Time-offset, relative to the beginning of the video, corresponding to the end + # of the segment (inclusive). # Corresponds to the JSON property `endTimeOffset` # @return [String] attr_accessor :end_time_offset - # Time-offset, relative to the beginning of the video, - # corresponding to the start of the segment (inclusive). + # Time-offset, relative to the beginning of the video, corresponding to the + # start of the segment (inclusive). # Corresponds to the JSON property `startTimeOffset` # @return [String] attr_accessor :start_time_offset @@ -2407,41 +2335,41 @@ module Google end # Word-specific information for recognized words. Word information is only - # included in the response when certain request parameters are set, such - # as `enable_word_time_offsets`. + # included in the response when certain request parameters are set, such as ` + # enable_word_time_offsets`. class GoogleCloudVideointelligenceV1beta2WordInfo include Google::Apis::Core::Hashable # Output only. The confidence estimate between 0.0 and 1.0. A higher number # indicates an estimated greater likelihood that the recognized words are - # correct. This field is set only for the top alternative. - # This field is not guaranteed to be accurate and users should not rely on it - # to be always provided. - # The default of 0.0 is a sentinel value indicating `confidence` was not set. + # correct. This field is set only for the top alternative. This field is not + # guaranteed to be accurate and users should not rely on it to be always + # provided. The default of 0.0 is a sentinel value indicating `confidence` was + # not set. # Corresponds to the JSON property `confidence` # @return [Float] attr_accessor :confidence - # Time offset relative to the beginning of the audio, and - # corresponding to the end of the spoken word. This field is only set if - # `enable_word_time_offsets=true` and only in the top hypothesis. This is an - # experimental feature and the accuracy of the time offset can vary. + # Time offset relative to the beginning of the audio, and corresponding to the + # end of the spoken word. This field is only set if `enable_word_time_offsets= + # true` and only in the top hypothesis. This is an experimental feature and the + # accuracy of the time offset can vary. # Corresponds to the JSON property `endTime` # @return [String] attr_accessor :end_time - # Output only. A distinct integer value is assigned for every speaker within - # the audio. This field specifies which one of those speakers was detected to - # have spoken this word. Value ranges from 1 up to diarization_speaker_count, - # and is only set if speaker diarization is enabled. + # Output only. A distinct integer value is assigned for every speaker within the + # audio. This field specifies which one of those speakers was detected to have + # spoken this word. Value ranges from 1 up to diarization_speaker_count, and is + # only set if speaker diarization is enabled. # Corresponds to the JSON property `speakerTag` # @return [Fixnum] attr_accessor :speaker_tag - # Time offset relative to the beginning of the audio, and - # corresponding to the start of the spoken word. This field is only set if - # `enable_word_time_offsets=true` and only in the top hypothesis. This is an - # experimental feature and the accuracy of the time offset can vary. + # Time offset relative to the beginning of the audio, and corresponding to the + # start of the spoken word. This field is only set if `enable_word_time_offsets= + # true` and only in the top hypothesis. This is an experimental feature and the + # accuracy of the time offset can vary. # Corresponds to the JSON property `startTime` # @return [String] attr_accessor :start_time @@ -2465,9 +2393,9 @@ module Google end end - # Video annotation progress. Included in the `metadata` - # field of the `Operation` returned by the `GetOperation` - # call of the `google::longrunning::Operations` service. + # Video annotation progress. Included in the `metadata` field of the `Operation` + # returned by the `GetOperation` call of the `google::longrunning::Operations` + # service. class GoogleCloudVideointelligenceV1p1beta1AnnotateVideoProgress include Google::Apis::Core::Hashable @@ -2486,9 +2414,9 @@ module Google end end - # Video annotation response. Included in the `response` - # field of the `Operation` returned by the `GetOperation` - # call of the `google::longrunning::Operations` service. + # Video annotation response. Included in the `response` field of the `Operation` + # returned by the `GetOperation` call of the `google::longrunning::Operations` + # service. class GoogleCloudVideointelligenceV1p1beta1AnnotateVideoResponse include Google::Apis::Core::Hashable @@ -2516,14 +2444,14 @@ module Google # @return [Float] attr_accessor :confidence - # The name of the attribute, for example, glasses, dark_glasses, mouth_open. - # A full list of supported type names will be provided in the document. + # The name of the attribute, for example, glasses, dark_glasses, mouth_open. A + # full list of supported type names will be provided in the document. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name - # Text value of the detection result. For example, the value for "HairColor" - # can be "black", "blonde", etc. + # Text value of the detection result. For example, the value for "HairColor" can + # be "black", "blonde", etc. # Corresponds to the JSON property `value` # @return [String] attr_accessor :value @@ -2555,9 +2483,8 @@ module Google # @return [String] attr_accessor :name - # A vertex represents a 2D point in the image. - # NOTE: the normalized vertex coordinates are relative to the original image - # and range from 0 to 1. + # A vertex represents a 2D point in the image. NOTE: the normalized vertex + # coordinates are relative to the original image and range from 0 to 1. # Corresponds to the JSON property `point` # @return [Google::Apis::VideointelligenceV1::GoogleCloudVideointelligenceV1p1beta1NormalizedVertex] attr_accessor :point @@ -2583,8 +2510,7 @@ module Google # @return [String] attr_accessor :description - # Opaque entity ID. Some IDs may be available in - # [Google Knowledge Graph Search + # Opaque entity ID. Some IDs may be available in [Google Knowledge Graph Search # API](https://developers.google.com/knowledge-graph/). # Corresponds to the JSON property `entityId` # @return [String] @@ -2607,9 +2533,9 @@ module Google end end - # Explicit content annotation (based on per-frame visual signals only). - # If no explicit content has been detected in a frame, no annotations are - # present for that frame. + # Explicit content annotation (based on per-frame visual signals only). If no + # explicit content has been detected in a frame, no annotations are present for + # that frame. class GoogleCloudVideointelligenceV1p1beta1ExplicitContentAnnotation include Google::Apis::Core::Hashable @@ -2664,10 +2590,9 @@ module Google class GoogleCloudVideointelligenceV1p1beta1LabelAnnotation include Google::Apis::Core::Hashable - # Common categories for the detected entity. - # For example, when the label is `Terrier`, the category is likely `dog`. And - # in some cases there might be more than one categories e.g., `Terrier` could - # also be a `pet`. + # Common categories for the detected entity. For example, when the label is ` + # Terrier`, the category is likely `dog`. And in some cases there might be more + # than one categories e.g., `Terrier` could also be a `pet`. # Corresponds to the JSON property `categoryEntities` # @return [Array] attr_accessor :category_entities @@ -2766,14 +2691,14 @@ module Google # @return [Google::Apis::VideointelligenceV1::GoogleCloudVideointelligenceV1p1beta1Entity] attr_accessor :entity - # All video segments where the recognized logo appears. There might be - # multiple instances of the same logo class appearing in one VideoSegment. + # All video segments where the recognized logo appears. There might be multiple + # instances of the same logo class appearing in one VideoSegment. # Corresponds to the JSON property `segments` # @return [Array] attr_accessor :segments - # All logo tracks where the recognized logo appears. Each track corresponds - # to one logo instance appearing in consecutive frames. + # All logo tracks where the recognized logo appears. Each track corresponds to + # one logo instance appearing in consecutive frames. # Corresponds to the JSON property `tracks` # @return [Array] attr_accessor :tracks @@ -2790,9 +2715,8 @@ module Google end end - # Normalized bounding box. - # The normalized vertex coordinates are relative to the original image. - # Range: [0, 1]. + # Normalized bounding box. The normalized vertex coordinates are relative to the + # original image. Range: [0, 1]. class GoogleCloudVideointelligenceV1p1beta1NormalizedBoundingBox include Google::Apis::Core::Hashable @@ -2830,20 +2754,12 @@ module Google end # Normalized bounding polygon for text (that might not be aligned with axis). - # Contains list of the corner points in clockwise order starting from - # top-left corner. For example, for a rectangular bounding box: - # When the text is horizontal it might look like: - # 0----1 - # | | - # 3----2 - # When it's clockwise rotated 180 degrees around the top-left corner it - # becomes: - # 2----3 - # | | - # 1----0 - # and the vertex order will still be (0, 1, 2, 3). Note that values can be less - # than 0, or greater than 1 due to trignometric calculations for location of - # the box. + # Contains list of the corner points in clockwise order starting from top-left + # corner. For example, for a rectangular bounding box: When the text is + # horizontal it might look like: 0----1 | | 3----2 When it's clockwise rotated + # 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the + # vertex order will still be (0, 1, 2, 3). Note that values can be less than 0, + # or greater than 1 due to trignometric calculations for location of the box. class GoogleCloudVideointelligenceV1p1beta1NormalizedBoundingPoly include Google::Apis::Core::Hashable @@ -2862,9 +2778,8 @@ module Google end end - # A vertex represents a 2D point in the image. - # NOTE: the normalized vertex coordinates are relative to the original image - # and range from 0 to 1. + # A vertex represents a 2D point in the image. NOTE: the normalized vertex + # coordinates are relative to the original image and range from 0 to 1. class GoogleCloudVideointelligenceV1p1beta1NormalizedVertex include Google::Apis::Core::Hashable @@ -2903,10 +2818,10 @@ module Google # @return [Google::Apis::VideointelligenceV1::GoogleCloudVideointelligenceV1p1beta1Entity] attr_accessor :entity - # Information corresponding to all frames where this object track appears. - # Non-streaming batch mode: it may be one or multiple ObjectTrackingFrame - # messages in frames. - # Streaming mode: it can only be one ObjectTrackingFrame message in frames. + # Information corresponding to all frames where this object track appears. Non- + # streaming batch mode: it may be one or multiple ObjectTrackingFrame messages + # in frames. Streaming mode: it can only be one ObjectTrackingFrame message in + # frames. # Corresponds to the JSON property `frames` # @return [Array] attr_accessor :frames @@ -2916,12 +2831,11 @@ module Google # @return [Google::Apis::VideointelligenceV1::GoogleCloudVideointelligenceV1p1beta1VideoSegment] attr_accessor :segment - # Streaming mode ONLY. - # In streaming mode, we do not know the end time of a tracked object - # before it is completed. Hence, there is no VideoSegment info returned. - # Instead, we provide a unique identifiable integer track_id so that - # the customers can correlate the results of the ongoing - # ObjectTrackAnnotation of the same track_id over time. + # Streaming mode ONLY. In streaming mode, we do not know the end time of a + # tracked object before it is completed. Hence, there is no VideoSegment info + # returned. Instead, we provide a unique identifiable integer track_id so that + # the customers can correlate the results of the ongoing ObjectTrackAnnotation + # of the same track_id over time. # Corresponds to the JSON property `trackId` # @return [Fixnum] attr_accessor :track_id @@ -2951,9 +2865,8 @@ module Google class GoogleCloudVideointelligenceV1p1beta1ObjectTrackingFrame include Google::Apis::Core::Hashable - # Normalized bounding box. - # The normalized vertex coordinates are relative to the original image. - # Range: [0, 1]. + # Normalized bounding box. The normalized vertex coordinates are relative to the + # original image. Range: [0, 1]. # Corresponds to the JSON property `normalizedBoundingBox` # @return [Google::Apis::VideointelligenceV1::GoogleCloudVideointelligenceV1p1beta1NormalizedBoundingBox] attr_accessor :normalized_bounding_box @@ -2980,10 +2893,10 @@ module Google # Output only. The confidence estimate between 0.0 and 1.0. A higher number # indicates an estimated greater likelihood that the recognized words are - # correct. This field is set only for the top alternative. - # This field is not guaranteed to be accurate and users should not rely on it - # to be always provided. - # The default of 0.0 is a sentinel value indicating `confidence` was not set. + # correct. This field is set only for the top alternative. This field is not + # guaranteed to be accurate and users should not rely on it to be always + # provided. The default of 0.0 is a sentinel value indicating `confidence` was + # not set. # Corresponds to the JSON property `confidence` # @return [Float] attr_accessor :confidence @@ -2994,8 +2907,8 @@ module Google attr_accessor :transcript # Output only. A list of word-specific information for each recognized word. - # Note: When `enable_speaker_diarization` is set to true, you will see all - # the words from the beginning of the audio. + # Note: When `enable_speaker_diarization` is set to true, you will see all the + # words from the beginning of the audio. # Corresponds to the JSON property `words` # @return [Array] attr_accessor :words @@ -3016,18 +2929,17 @@ module Google class GoogleCloudVideointelligenceV1p1beta1SpeechTranscription include Google::Apis::Core::Hashable - # May contain one or more recognition hypotheses (up to the maximum specified - # in `max_alternatives`). These alternatives are ordered in terms of - # accuracy, with the top (first) alternative being the most probable, as - # ranked by the recognizer. + # May contain one or more recognition hypotheses (up to the maximum specified in + # `max_alternatives`). These alternatives are ordered in terms of accuracy, with + # the top (first) alternative being the most probable, as ranked by the + # recognizer. # Corresponds to the JSON property `alternatives` # @return [Array] attr_accessor :alternatives # Output only. The [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) - # language tag of - # the language in this result. This language code was detected to have the - # most likelihood of being spoken in the audio. + # language tag of the language in this result. This language code was detected + # to have the most likelihood of being spoken in the audio. # Corresponds to the JSON property `languageCode` # @return [String] attr_accessor :language_code @@ -3076,27 +2988,19 @@ module Google end end - # Video frame level annotation results for text annotation (OCR). - # Contains information regarding timestamp and bounding box locations for the - # frames containing detected OCR text snippets. + # Video frame level annotation results for text annotation (OCR). Contains + # information regarding timestamp and bounding box locations for the frames + # containing detected OCR text snippets. class GoogleCloudVideointelligenceV1p1beta1TextFrame include Google::Apis::Core::Hashable # Normalized bounding polygon for text (that might not be aligned with axis). - # Contains list of the corner points in clockwise order starting from - # top-left corner. For example, for a rectangular bounding box: - # When the text is horizontal it might look like: - # 0----1 - # | | - # 3----2 - # When it's clockwise rotated 180 degrees around the top-left corner it - # becomes: - # 2----3 - # | | - # 1----0 - # and the vertex order will still be (0, 1, 2, 3). Note that values can be less - # than 0, or greater than 1 due to trignometric calculations for location of - # the box. + # Contains list of the corner points in clockwise order starting from top-left + # corner. For example, for a rectangular bounding box: When the text is + # horizontal it might look like: 0----1 | | 3----2 When it's clockwise rotated + # 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the + # vertex order will still be (0, 1, 2, 3). Note that values can be less than 0, + # or greater than 1 due to trignometric calculations for location of the box. # Corresponds to the JSON property `rotatedBoundingBox` # @return [Google::Apis::VideointelligenceV1::GoogleCloudVideointelligenceV1p1beta1NormalizedBoundingPoly] attr_accessor :rotated_bounding_box @@ -3149,9 +3053,8 @@ module Google end end - # For tracking related features. - # An object at time_offset with attributes, and located with - # normalized_bounding_box. + # For tracking related features. An object at time_offset with attributes, and + # located with normalized_bounding_box. class GoogleCloudVideointelligenceV1p1beta1TimestampedObject include Google::Apis::Core::Hashable @@ -3165,15 +3068,14 @@ module Google # @return [Array] attr_accessor :landmarks - # Normalized bounding box. - # The normalized vertex coordinates are relative to the original image. - # Range: [0, 1]. + # Normalized bounding box. The normalized vertex coordinates are relative to the + # original image. Range: [0, 1]. # Corresponds to the JSON property `normalizedBoundingBox` # @return [Google::Apis::VideointelligenceV1::GoogleCloudVideointelligenceV1p1beta1NormalizedBoundingBox] attr_accessor :normalized_bounding_box - # Time-offset, relative to the beginning of the video, - # corresponding to the video frame for this object. + # Time-offset, relative to the beginning of the video, corresponding to the + # video frame for this object. # Corresponds to the JSON property `timeOffset` # @return [String] attr_accessor :time_offset @@ -3232,20 +3134,19 @@ module Google class GoogleCloudVideointelligenceV1p1beta1VideoAnnotationProgress include Google::Apis::Core::Hashable - # Specifies which feature is being tracked if the request contains more than - # one feature. + # Specifies which feature is being tracked if the request contains more than one + # feature. # Corresponds to the JSON property `feature` # @return [String] attr_accessor :feature - # Video file location in - # [Cloud Storage](https://cloud.google.com/storage/). + # Video file location in [Cloud Storage](https://cloud.google.com/storage/). # Corresponds to the JSON property `inputUri` # @return [String] attr_accessor :input_uri - # Approximate percentage processed thus far. Guaranteed to be - # 100 when fully processed. + # Approximate percentage processed thus far. Guaranteed to be 100 when fully + # processed. # Corresponds to the JSON property `progressPercent` # @return [Fixnum] attr_accessor :progress_percent @@ -3284,31 +3185,30 @@ module Google class GoogleCloudVideointelligenceV1p1beta1VideoAnnotationResults include Google::Apis::Core::Hashable - # 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::VideointelligenceV1::GoogleRpcStatus] attr_accessor :error - # Explicit content annotation (based on per-frame visual signals only). - # If no explicit content has been detected in a frame, no annotations are - # present for that frame. + # Explicit content annotation (based on per-frame visual signals only). If no + # explicit content has been detected in a frame, no annotations are present for + # that frame. # Corresponds to the JSON property `explicitAnnotation` # @return [Google::Apis::VideointelligenceV1::GoogleCloudVideointelligenceV1p1beta1ExplicitContentAnnotation] attr_accessor :explicit_annotation - # Label annotations on frame level. - # There is exactly one element for each unique label. + # Label annotations on frame level. There is exactly one element for each unique + # label. # Corresponds to the JSON property `frameLabelAnnotations` # @return [Array] attr_accessor :frame_label_annotations - # Video file location in - # [Cloud Storage](https://cloud.google.com/storage/). + # Video file location in [Cloud Storage](https://cloud.google.com/storage/). # Corresponds to the JSON property `inputUri` # @return [String] attr_accessor :input_uri @@ -3335,11 +3235,11 @@ module Google attr_accessor :segment_label_annotations # Presence label annotations on video level or user-specified segment level. - # There is exactly one element for each unique label. Compared to the - # existing topical `segment_label_annotations`, this field presents more - # fine-grained, segment-level labels detected in video content and is made - # available only when the client sets `LabelDetectionConfig.model` to - # "builtin/latest" in the request. + # There is exactly one element for each unique label. Compared to the existing + # topical `segment_label_annotations`, this field presents more fine-grained, + # segment-level labels detected in video content and is made available only when + # the client sets `LabelDetectionConfig.model` to "builtin/latest" in the + # request. # Corresponds to the JSON property `segmentPresenceLabelAnnotations` # @return [Array] attr_accessor :segment_presence_label_annotations @@ -3349,17 +3249,17 @@ module Google # @return [Array] attr_accessor :shot_annotations - # Topical label annotations on shot level. - # There is exactly one element for each unique label. + # Topical label annotations on shot level. There is exactly one element for each + # unique label. # Corresponds to the JSON property `shotLabelAnnotations` # @return [Array] attr_accessor :shot_label_annotations # Presence label annotations on shot level. There is exactly one element for - # each unique label. Compared to the existing topical - # `shot_label_annotations`, this field presents more fine-grained, shot-level - # labels detected in video content and is made available only when the client - # sets `LabelDetectionConfig.model` to "builtin/latest" in the request. + # each unique label. Compared to the existing topical `shot_label_annotations`, + # this field presents more fine-grained, shot-level labels detected in video + # content and is made available only when the client sets `LabelDetectionConfig. + # model` to "builtin/latest" in the request. # Corresponds to the JSON property `shotPresenceLabelAnnotations` # @return [Array] attr_accessor :shot_presence_label_annotations @@ -3369,9 +3269,8 @@ module Google # @return [Array] attr_accessor :speech_transcriptions - # OCR text detection and tracking. - # Annotations for list of detected text snippets. Each will have list of - # frame information associated with it. + # OCR text detection and tracking. Annotations for list of detected text + # snippets. Each will have list of frame information associated with it. # Corresponds to the JSON property `textAnnotations` # @return [Array] attr_accessor :text_annotations @@ -3403,14 +3302,14 @@ module Google class GoogleCloudVideointelligenceV1p1beta1VideoSegment include Google::Apis::Core::Hashable - # Time-offset, relative to the beginning of the video, - # corresponding to the end of the segment (inclusive). + # Time-offset, relative to the beginning of the video, corresponding to the end + # of the segment (inclusive). # Corresponds to the JSON property `endTimeOffset` # @return [String] attr_accessor :end_time_offset - # Time-offset, relative to the beginning of the video, - # corresponding to the start of the segment (inclusive). + # Time-offset, relative to the beginning of the video, corresponding to the + # start of the segment (inclusive). # Corresponds to the JSON property `startTimeOffset` # @return [String] attr_accessor :start_time_offset @@ -3427,41 +3326,41 @@ module Google end # Word-specific information for recognized words. Word information is only - # included in the response when certain request parameters are set, such - # as `enable_word_time_offsets`. + # included in the response when certain request parameters are set, such as ` + # enable_word_time_offsets`. class GoogleCloudVideointelligenceV1p1beta1WordInfo include Google::Apis::Core::Hashable # Output only. The confidence estimate between 0.0 and 1.0. A higher number # indicates an estimated greater likelihood that the recognized words are - # correct. This field is set only for the top alternative. - # This field is not guaranteed to be accurate and users should not rely on it - # to be always provided. - # The default of 0.0 is a sentinel value indicating `confidence` was not set. + # correct. This field is set only for the top alternative. This field is not + # guaranteed to be accurate and users should not rely on it to be always + # provided. The default of 0.0 is a sentinel value indicating `confidence` was + # not set. # Corresponds to the JSON property `confidence` # @return [Float] attr_accessor :confidence - # Time offset relative to the beginning of the audio, and - # corresponding to the end of the spoken word. This field is only set if - # `enable_word_time_offsets=true` and only in the top hypothesis. This is an - # experimental feature and the accuracy of the time offset can vary. + # Time offset relative to the beginning of the audio, and corresponding to the + # end of the spoken word. This field is only set if `enable_word_time_offsets= + # true` and only in the top hypothesis. This is an experimental feature and the + # accuracy of the time offset can vary. # Corresponds to the JSON property `endTime` # @return [String] attr_accessor :end_time - # Output only. A distinct integer value is assigned for every speaker within - # the audio. This field specifies which one of those speakers was detected to - # have spoken this word. Value ranges from 1 up to diarization_speaker_count, - # and is only set if speaker diarization is enabled. + # Output only. A distinct integer value is assigned for every speaker within the + # audio. This field specifies which one of those speakers was detected to have + # spoken this word. Value ranges from 1 up to diarization_speaker_count, and is + # only set if speaker diarization is enabled. # Corresponds to the JSON property `speakerTag` # @return [Fixnum] attr_accessor :speaker_tag - # Time offset relative to the beginning of the audio, and - # corresponding to the start of the spoken word. This field is only set if - # `enable_word_time_offsets=true` and only in the top hypothesis. This is an - # experimental feature and the accuracy of the time offset can vary. + # Time offset relative to the beginning of the audio, and corresponding to the + # start of the spoken word. This field is only set if `enable_word_time_offsets= + # true` and only in the top hypothesis. This is an experimental feature and the + # accuracy of the time offset can vary. # Corresponds to the JSON property `startTime` # @return [String] attr_accessor :start_time @@ -3485,9 +3384,9 @@ module Google end end - # Video annotation progress. Included in the `metadata` - # field of the `Operation` returned by the `GetOperation` - # call of the `google::longrunning::Operations` service. + # Video annotation progress. Included in the `metadata` field of the `Operation` + # returned by the `GetOperation` call of the `google::longrunning::Operations` + # service. class GoogleCloudVideointelligenceV1p2beta1AnnotateVideoProgress include Google::Apis::Core::Hashable @@ -3506,9 +3405,9 @@ module Google end end - # Video annotation response. Included in the `response` - # field of the `Operation` returned by the `GetOperation` - # call of the `google::longrunning::Operations` service. + # Video annotation response. Included in the `response` field of the `Operation` + # returned by the `GetOperation` call of the `google::longrunning::Operations` + # service. class GoogleCloudVideointelligenceV1p2beta1AnnotateVideoResponse include Google::Apis::Core::Hashable @@ -3536,14 +3435,14 @@ module Google # @return [Float] attr_accessor :confidence - # The name of the attribute, for example, glasses, dark_glasses, mouth_open. - # A full list of supported type names will be provided in the document. + # The name of the attribute, for example, glasses, dark_glasses, mouth_open. A + # full list of supported type names will be provided in the document. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name - # Text value of the detection result. For example, the value for "HairColor" - # can be "black", "blonde", etc. + # Text value of the detection result. For example, the value for "HairColor" can + # be "black", "blonde", etc. # Corresponds to the JSON property `value` # @return [String] attr_accessor :value @@ -3575,9 +3474,8 @@ module Google # @return [String] attr_accessor :name - # A vertex represents a 2D point in the image. - # NOTE: the normalized vertex coordinates are relative to the original image - # and range from 0 to 1. + # A vertex represents a 2D point in the image. NOTE: the normalized vertex + # coordinates are relative to the original image and range from 0 to 1. # Corresponds to the JSON property `point` # @return [Google::Apis::VideointelligenceV1::GoogleCloudVideointelligenceV1p2beta1NormalizedVertex] attr_accessor :point @@ -3603,8 +3501,7 @@ module Google # @return [String] attr_accessor :description - # Opaque entity ID. Some IDs may be available in - # [Google Knowledge Graph Search + # Opaque entity ID. Some IDs may be available in [Google Knowledge Graph Search # API](https://developers.google.com/knowledge-graph/). # Corresponds to the JSON property `entityId` # @return [String] @@ -3627,9 +3524,9 @@ module Google end end - # Explicit content annotation (based on per-frame visual signals only). - # If no explicit content has been detected in a frame, no annotations are - # present for that frame. + # Explicit content annotation (based on per-frame visual signals only). If no + # explicit content has been detected in a frame, no annotations are present for + # that frame. class GoogleCloudVideointelligenceV1p2beta1ExplicitContentAnnotation include Google::Apis::Core::Hashable @@ -3684,10 +3581,9 @@ module Google class GoogleCloudVideointelligenceV1p2beta1LabelAnnotation include Google::Apis::Core::Hashable - # Common categories for the detected entity. - # For example, when the label is `Terrier`, the category is likely `dog`. And - # in some cases there might be more than one categories e.g., `Terrier` could - # also be a `pet`. + # Common categories for the detected entity. For example, when the label is ` + # Terrier`, the category is likely `dog`. And in some cases there might be more + # than one categories e.g., `Terrier` could also be a `pet`. # Corresponds to the JSON property `categoryEntities` # @return [Array] attr_accessor :category_entities @@ -3786,14 +3682,14 @@ module Google # @return [Google::Apis::VideointelligenceV1::GoogleCloudVideointelligenceV1p2beta1Entity] attr_accessor :entity - # All video segments where the recognized logo appears. There might be - # multiple instances of the same logo class appearing in one VideoSegment. + # All video segments where the recognized logo appears. There might be multiple + # instances of the same logo class appearing in one VideoSegment. # Corresponds to the JSON property `segments` # @return [Array] attr_accessor :segments - # All logo tracks where the recognized logo appears. Each track corresponds - # to one logo instance appearing in consecutive frames. + # All logo tracks where the recognized logo appears. Each track corresponds to + # one logo instance appearing in consecutive frames. # Corresponds to the JSON property `tracks` # @return [Array] attr_accessor :tracks @@ -3810,9 +3706,8 @@ module Google end end - # Normalized bounding box. - # The normalized vertex coordinates are relative to the original image. - # Range: [0, 1]. + # Normalized bounding box. The normalized vertex coordinates are relative to the + # original image. Range: [0, 1]. class GoogleCloudVideointelligenceV1p2beta1NormalizedBoundingBox include Google::Apis::Core::Hashable @@ -3850,20 +3745,12 @@ module Google end # Normalized bounding polygon for text (that might not be aligned with axis). - # Contains list of the corner points in clockwise order starting from - # top-left corner. For example, for a rectangular bounding box: - # When the text is horizontal it might look like: - # 0----1 - # | | - # 3----2 - # When it's clockwise rotated 180 degrees around the top-left corner it - # becomes: - # 2----3 - # | | - # 1----0 - # and the vertex order will still be (0, 1, 2, 3). Note that values can be less - # than 0, or greater than 1 due to trignometric calculations for location of - # the box. + # Contains list of the corner points in clockwise order starting from top-left + # corner. For example, for a rectangular bounding box: When the text is + # horizontal it might look like: 0----1 | | 3----2 When it's clockwise rotated + # 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the + # vertex order will still be (0, 1, 2, 3). Note that values can be less than 0, + # or greater than 1 due to trignometric calculations for location of the box. class GoogleCloudVideointelligenceV1p2beta1NormalizedBoundingPoly include Google::Apis::Core::Hashable @@ -3882,9 +3769,8 @@ module Google end end - # A vertex represents a 2D point in the image. - # NOTE: the normalized vertex coordinates are relative to the original image - # and range from 0 to 1. + # A vertex represents a 2D point in the image. NOTE: the normalized vertex + # coordinates are relative to the original image and range from 0 to 1. class GoogleCloudVideointelligenceV1p2beta1NormalizedVertex include Google::Apis::Core::Hashable @@ -3923,10 +3809,10 @@ module Google # @return [Google::Apis::VideointelligenceV1::GoogleCloudVideointelligenceV1p2beta1Entity] attr_accessor :entity - # Information corresponding to all frames where this object track appears. - # Non-streaming batch mode: it may be one or multiple ObjectTrackingFrame - # messages in frames. - # Streaming mode: it can only be one ObjectTrackingFrame message in frames. + # Information corresponding to all frames where this object track appears. Non- + # streaming batch mode: it may be one or multiple ObjectTrackingFrame messages + # in frames. Streaming mode: it can only be one ObjectTrackingFrame message in + # frames. # Corresponds to the JSON property `frames` # @return [Array] attr_accessor :frames @@ -3936,12 +3822,11 @@ module Google # @return [Google::Apis::VideointelligenceV1::GoogleCloudVideointelligenceV1p2beta1VideoSegment] attr_accessor :segment - # Streaming mode ONLY. - # In streaming mode, we do not know the end time of a tracked object - # before it is completed. Hence, there is no VideoSegment info returned. - # Instead, we provide a unique identifiable integer track_id so that - # the customers can correlate the results of the ongoing - # ObjectTrackAnnotation of the same track_id over time. + # Streaming mode ONLY. In streaming mode, we do not know the end time of a + # tracked object before it is completed. Hence, there is no VideoSegment info + # returned. Instead, we provide a unique identifiable integer track_id so that + # the customers can correlate the results of the ongoing ObjectTrackAnnotation + # of the same track_id over time. # Corresponds to the JSON property `trackId` # @return [Fixnum] attr_accessor :track_id @@ -3971,9 +3856,8 @@ module Google class GoogleCloudVideointelligenceV1p2beta1ObjectTrackingFrame include Google::Apis::Core::Hashable - # Normalized bounding box. - # The normalized vertex coordinates are relative to the original image. - # Range: [0, 1]. + # Normalized bounding box. The normalized vertex coordinates are relative to the + # original image. Range: [0, 1]. # Corresponds to the JSON property `normalizedBoundingBox` # @return [Google::Apis::VideointelligenceV1::GoogleCloudVideointelligenceV1p2beta1NormalizedBoundingBox] attr_accessor :normalized_bounding_box @@ -4000,10 +3884,10 @@ module Google # Output only. The confidence estimate between 0.0 and 1.0. A higher number # indicates an estimated greater likelihood that the recognized words are - # correct. This field is set only for the top alternative. - # This field is not guaranteed to be accurate and users should not rely on it - # to be always provided. - # The default of 0.0 is a sentinel value indicating `confidence` was not set. + # correct. This field is set only for the top alternative. This field is not + # guaranteed to be accurate and users should not rely on it to be always + # provided. The default of 0.0 is a sentinel value indicating `confidence` was + # not set. # Corresponds to the JSON property `confidence` # @return [Float] attr_accessor :confidence @@ -4014,8 +3898,8 @@ module Google attr_accessor :transcript # Output only. A list of word-specific information for each recognized word. - # Note: When `enable_speaker_diarization` is set to true, you will see all - # the words from the beginning of the audio. + # Note: When `enable_speaker_diarization` is set to true, you will see all the + # words from the beginning of the audio. # Corresponds to the JSON property `words` # @return [Array] attr_accessor :words @@ -4036,18 +3920,17 @@ module Google class GoogleCloudVideointelligenceV1p2beta1SpeechTranscription include Google::Apis::Core::Hashable - # May contain one or more recognition hypotheses (up to the maximum specified - # in `max_alternatives`). These alternatives are ordered in terms of - # accuracy, with the top (first) alternative being the most probable, as - # ranked by the recognizer. + # May contain one or more recognition hypotheses (up to the maximum specified in + # `max_alternatives`). These alternatives are ordered in terms of accuracy, with + # the top (first) alternative being the most probable, as ranked by the + # recognizer. # Corresponds to the JSON property `alternatives` # @return [Array] attr_accessor :alternatives # Output only. The [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) - # language tag of - # the language in this result. This language code was detected to have the - # most likelihood of being spoken in the audio. + # language tag of the language in this result. This language code was detected + # to have the most likelihood of being spoken in the audio. # Corresponds to the JSON property `languageCode` # @return [String] attr_accessor :language_code @@ -4096,27 +3979,19 @@ module Google end end - # Video frame level annotation results for text annotation (OCR). - # Contains information regarding timestamp and bounding box locations for the - # frames containing detected OCR text snippets. + # Video frame level annotation results for text annotation (OCR). Contains + # information regarding timestamp and bounding box locations for the frames + # containing detected OCR text snippets. class GoogleCloudVideointelligenceV1p2beta1TextFrame include Google::Apis::Core::Hashable # Normalized bounding polygon for text (that might not be aligned with axis). - # Contains list of the corner points in clockwise order starting from - # top-left corner. For example, for a rectangular bounding box: - # When the text is horizontal it might look like: - # 0----1 - # | | - # 3----2 - # When it's clockwise rotated 180 degrees around the top-left corner it - # becomes: - # 2----3 - # | | - # 1----0 - # and the vertex order will still be (0, 1, 2, 3). Note that values can be less - # than 0, or greater than 1 due to trignometric calculations for location of - # the box. + # Contains list of the corner points in clockwise order starting from top-left + # corner. For example, for a rectangular bounding box: When the text is + # horizontal it might look like: 0----1 | | 3----2 When it's clockwise rotated + # 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the + # vertex order will still be (0, 1, 2, 3). Note that values can be less than 0, + # or greater than 1 due to trignometric calculations for location of the box. # Corresponds to the JSON property `rotatedBoundingBox` # @return [Google::Apis::VideointelligenceV1::GoogleCloudVideointelligenceV1p2beta1NormalizedBoundingPoly] attr_accessor :rotated_bounding_box @@ -4169,9 +4044,8 @@ module Google end end - # For tracking related features. - # An object at time_offset with attributes, and located with - # normalized_bounding_box. + # For tracking related features. An object at time_offset with attributes, and + # located with normalized_bounding_box. class GoogleCloudVideointelligenceV1p2beta1TimestampedObject include Google::Apis::Core::Hashable @@ -4185,15 +4059,14 @@ module Google # @return [Array] attr_accessor :landmarks - # Normalized bounding box. - # The normalized vertex coordinates are relative to the original image. - # Range: [0, 1]. + # Normalized bounding box. The normalized vertex coordinates are relative to the + # original image. Range: [0, 1]. # Corresponds to the JSON property `normalizedBoundingBox` # @return [Google::Apis::VideointelligenceV1::GoogleCloudVideointelligenceV1p2beta1NormalizedBoundingBox] attr_accessor :normalized_bounding_box - # Time-offset, relative to the beginning of the video, - # corresponding to the video frame for this object. + # Time-offset, relative to the beginning of the video, corresponding to the + # video frame for this object. # Corresponds to the JSON property `timeOffset` # @return [String] attr_accessor :time_offset @@ -4252,20 +4125,19 @@ module Google class GoogleCloudVideointelligenceV1p2beta1VideoAnnotationProgress include Google::Apis::Core::Hashable - # Specifies which feature is being tracked if the request contains more than - # one feature. + # Specifies which feature is being tracked if the request contains more than one + # feature. # Corresponds to the JSON property `feature` # @return [String] attr_accessor :feature - # Video file location in - # [Cloud Storage](https://cloud.google.com/storage/). + # Video file location in [Cloud Storage](https://cloud.google.com/storage/). # Corresponds to the JSON property `inputUri` # @return [String] attr_accessor :input_uri - # Approximate percentage processed thus far. Guaranteed to be - # 100 when fully processed. + # Approximate percentage processed thus far. Guaranteed to be 100 when fully + # processed. # Corresponds to the JSON property `progressPercent` # @return [Fixnum] attr_accessor :progress_percent @@ -4304,31 +4176,30 @@ module Google class GoogleCloudVideointelligenceV1p2beta1VideoAnnotationResults include Google::Apis::Core::Hashable - # 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::VideointelligenceV1::GoogleRpcStatus] attr_accessor :error - # Explicit content annotation (based on per-frame visual signals only). - # If no explicit content has been detected in a frame, no annotations are - # present for that frame. + # Explicit content annotation (based on per-frame visual signals only). If no + # explicit content has been detected in a frame, no annotations are present for + # that frame. # Corresponds to the JSON property `explicitAnnotation` # @return [Google::Apis::VideointelligenceV1::GoogleCloudVideointelligenceV1p2beta1ExplicitContentAnnotation] attr_accessor :explicit_annotation - # Label annotations on frame level. - # There is exactly one element for each unique label. + # Label annotations on frame level. There is exactly one element for each unique + # label. # Corresponds to the JSON property `frameLabelAnnotations` # @return [Array] attr_accessor :frame_label_annotations - # Video file location in - # [Cloud Storage](https://cloud.google.com/storage/). + # Video file location in [Cloud Storage](https://cloud.google.com/storage/). # Corresponds to the JSON property `inputUri` # @return [String] attr_accessor :input_uri @@ -4355,11 +4226,11 @@ module Google attr_accessor :segment_label_annotations # Presence label annotations on video level or user-specified segment level. - # There is exactly one element for each unique label. Compared to the - # existing topical `segment_label_annotations`, this field presents more - # fine-grained, segment-level labels detected in video content and is made - # available only when the client sets `LabelDetectionConfig.model` to - # "builtin/latest" in the request. + # There is exactly one element for each unique label. Compared to the existing + # topical `segment_label_annotations`, this field presents more fine-grained, + # segment-level labels detected in video content and is made available only when + # the client sets `LabelDetectionConfig.model` to "builtin/latest" in the + # request. # Corresponds to the JSON property `segmentPresenceLabelAnnotations` # @return [Array] attr_accessor :segment_presence_label_annotations @@ -4369,17 +4240,17 @@ module Google # @return [Array] attr_accessor :shot_annotations - # Topical label annotations on shot level. - # There is exactly one element for each unique label. + # Topical label annotations on shot level. There is exactly one element for each + # unique label. # Corresponds to the JSON property `shotLabelAnnotations` # @return [Array] attr_accessor :shot_label_annotations # Presence label annotations on shot level. There is exactly one element for - # each unique label. Compared to the existing topical - # `shot_label_annotations`, this field presents more fine-grained, shot-level - # labels detected in video content and is made available only when the client - # sets `LabelDetectionConfig.model` to "builtin/latest" in the request. + # each unique label. Compared to the existing topical `shot_label_annotations`, + # this field presents more fine-grained, shot-level labels detected in video + # content and is made available only when the client sets `LabelDetectionConfig. + # model` to "builtin/latest" in the request. # Corresponds to the JSON property `shotPresenceLabelAnnotations` # @return [Array] attr_accessor :shot_presence_label_annotations @@ -4389,9 +4260,8 @@ module Google # @return [Array] attr_accessor :speech_transcriptions - # OCR text detection and tracking. - # Annotations for list of detected text snippets. Each will have list of - # frame information associated with it. + # OCR text detection and tracking. Annotations for list of detected text + # snippets. Each will have list of frame information associated with it. # Corresponds to the JSON property `textAnnotations` # @return [Array] attr_accessor :text_annotations @@ -4423,14 +4293,14 @@ module Google class GoogleCloudVideointelligenceV1p2beta1VideoSegment include Google::Apis::Core::Hashable - # Time-offset, relative to the beginning of the video, - # corresponding to the end of the segment (inclusive). + # Time-offset, relative to the beginning of the video, corresponding to the end + # of the segment (inclusive). # Corresponds to the JSON property `endTimeOffset` # @return [String] attr_accessor :end_time_offset - # Time-offset, relative to the beginning of the video, - # corresponding to the start of the segment (inclusive). + # Time-offset, relative to the beginning of the video, corresponding to the + # start of the segment (inclusive). # Corresponds to the JSON property `startTimeOffset` # @return [String] attr_accessor :start_time_offset @@ -4447,41 +4317,41 @@ module Google end # Word-specific information for recognized words. Word information is only - # included in the response when certain request parameters are set, such - # as `enable_word_time_offsets`. + # included in the response when certain request parameters are set, such as ` + # enable_word_time_offsets`. class GoogleCloudVideointelligenceV1p2beta1WordInfo include Google::Apis::Core::Hashable # Output only. The confidence estimate between 0.0 and 1.0. A higher number # indicates an estimated greater likelihood that the recognized words are - # correct. This field is set only for the top alternative. - # This field is not guaranteed to be accurate and users should not rely on it - # to be always provided. - # The default of 0.0 is a sentinel value indicating `confidence` was not set. + # correct. This field is set only for the top alternative. This field is not + # guaranteed to be accurate and users should not rely on it to be always + # provided. The default of 0.0 is a sentinel value indicating `confidence` was + # not set. # Corresponds to the JSON property `confidence` # @return [Float] attr_accessor :confidence - # Time offset relative to the beginning of the audio, and - # corresponding to the end of the spoken word. This field is only set if - # `enable_word_time_offsets=true` and only in the top hypothesis. This is an - # experimental feature and the accuracy of the time offset can vary. + # Time offset relative to the beginning of the audio, and corresponding to the + # end of the spoken word. This field is only set if `enable_word_time_offsets= + # true` and only in the top hypothesis. This is an experimental feature and the + # accuracy of the time offset can vary. # Corresponds to the JSON property `endTime` # @return [String] attr_accessor :end_time - # Output only. A distinct integer value is assigned for every speaker within - # the audio. This field specifies which one of those speakers was detected to - # have spoken this word. Value ranges from 1 up to diarization_speaker_count, - # and is only set if speaker diarization is enabled. + # Output only. A distinct integer value is assigned for every speaker within the + # audio. This field specifies which one of those speakers was detected to have + # spoken this word. Value ranges from 1 up to diarization_speaker_count, and is + # only set if speaker diarization is enabled. # Corresponds to the JSON property `speakerTag` # @return [Fixnum] attr_accessor :speaker_tag - # Time offset relative to the beginning of the audio, and - # corresponding to the start of the spoken word. This field is only set if - # `enable_word_time_offsets=true` and only in the top hypothesis. This is an - # experimental feature and the accuracy of the time offset can vary. + # Time offset relative to the beginning of the audio, and corresponding to the + # start of the spoken word. This field is only set if `enable_word_time_offsets= + # true` and only in the top hypothesis. This is an experimental feature and the + # accuracy of the time offset can vary. # Corresponds to the JSON property `startTime` # @return [String] attr_accessor :start_time @@ -4505,9 +4375,9 @@ module Google end end - # Video annotation progress. Included in the `metadata` - # field of the `Operation` returned by the `GetOperation` - # call of the `google::longrunning::Operations` service. + # Video annotation progress. Included in the `metadata` field of the `Operation` + # returned by the `GetOperation` call of the `google::longrunning::Operations` + # service. class GoogleCloudVideointelligenceV1p3beta1AnnotateVideoProgress include Google::Apis::Core::Hashable @@ -4526,9 +4396,9 @@ module Google end end - # Video annotation response. Included in the `response` - # field of the `Operation` returned by the `GetOperation` - # call of the `google::longrunning::Operations` service. + # Video annotation response. Included in the `response` field of the `Operation` + # returned by the `GetOperation` call of the `google::longrunning::Operations` + # service. class GoogleCloudVideointelligenceV1p3beta1AnnotateVideoResponse include Google::Apis::Core::Hashable @@ -4562,10 +4432,9 @@ module Google # @return [String] attr_accessor :display_name - # The resource name of the celebrity. Have the format - # `video-intelligence/kg-mid` indicates a celebrity from preloaded gallery. - # kg-mid is the id in Google knowledge graph, which is unique for the - # celebrity. + # The resource name of the celebrity. Have the format `video-intelligence/kg-mid` + # indicates a celebrity from preloaded gallery. kg-mid is the id in Google + # knowledge graph, which is unique for the celebrity. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name @@ -4586,8 +4455,8 @@ module Google class GoogleCloudVideointelligenceV1p3beta1CelebrityRecognitionAnnotation include Google::Apis::Core::Hashable - # The tracks detected from the input video, including recognized celebrities - # and other detected faces in the video. + # The tracks detected from the input video, including recognized celebrities and + # other detected faces in the video. # Corresponds to the JSON property `celebrityTracks` # @return [Array] attr_accessor :celebrity_tracks @@ -4643,14 +4512,14 @@ module Google # @return [Float] attr_accessor :confidence - # The name of the attribute, for example, glasses, dark_glasses, mouth_open. - # A full list of supported type names will be provided in the document. + # The name of the attribute, for example, glasses, dark_glasses, mouth_open. A + # full list of supported type names will be provided in the document. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name - # Text value of the detection result. For example, the value for "HairColor" - # can be "black", "blonde", etc. + # Text value of the detection result. For example, the value for "HairColor" can + # be "black", "blonde", etc. # Corresponds to the JSON property `value` # @return [String] attr_accessor :value @@ -4682,9 +4551,8 @@ module Google # @return [String] attr_accessor :name - # A vertex represents a 2D point in the image. - # NOTE: the normalized vertex coordinates are relative to the original image - # and range from 0 to 1. + # A vertex represents a 2D point in the image. NOTE: the normalized vertex + # coordinates are relative to the original image and range from 0 to 1. # Corresponds to the JSON property `point` # @return [Google::Apis::VideointelligenceV1::GoogleCloudVideointelligenceV1p3beta1NormalizedVertex] attr_accessor :point @@ -4710,8 +4578,7 @@ module Google # @return [String] attr_accessor :description - # Opaque entity ID. Some IDs may be available in - # [Google Knowledge Graph Search + # Opaque entity ID. Some IDs may be available in [Google Knowledge Graph Search # API](https://developers.google.com/knowledge-graph/). # Corresponds to the JSON property `entityId` # @return [String] @@ -4734,9 +4601,9 @@ module Google end end - # Explicit content annotation (based on per-frame visual signals only). - # If no explicit content has been detected in a frame, no annotations are - # present for that frame. + # Explicit content annotation (based on per-frame visual signals only). If no + # explicit content has been detected in a frame, no annotations are present for + # that frame. class GoogleCloudVideointelligenceV1p3beta1ExplicitContentAnnotation include Google::Apis::Core::Hashable @@ -4823,10 +4690,9 @@ module Google class GoogleCloudVideointelligenceV1p3beta1LabelAnnotation include Google::Apis::Core::Hashable - # Common categories for the detected entity. - # For example, when the label is `Terrier`, the category is likely `dog`. And - # in some cases there might be more than one categories e.g., `Terrier` could - # also be a `pet`. + # Common categories for the detected entity. For example, when the label is ` + # Terrier`, the category is likely `dog`. And in some cases there might be more + # than one categories e.g., `Terrier` could also be a `pet`. # Corresponds to the JSON property `categoryEntities` # @return [Array] attr_accessor :category_entities @@ -4925,14 +4791,14 @@ module Google # @return [Google::Apis::VideointelligenceV1::GoogleCloudVideointelligenceV1p3beta1Entity] attr_accessor :entity - # All video segments where the recognized logo appears. There might be - # multiple instances of the same logo class appearing in one VideoSegment. + # All video segments where the recognized logo appears. There might be multiple + # instances of the same logo class appearing in one VideoSegment. # Corresponds to the JSON property `segments` # @return [Array] attr_accessor :segments - # All logo tracks where the recognized logo appears. Each track corresponds - # to one logo instance appearing in consecutive frames. + # All logo tracks where the recognized logo appears. Each track corresponds to + # one logo instance appearing in consecutive frames. # Corresponds to the JSON property `tracks` # @return [Array] attr_accessor :tracks @@ -4949,9 +4815,8 @@ module Google end end - # Normalized bounding box. - # The normalized vertex coordinates are relative to the original image. - # Range: [0, 1]. + # Normalized bounding box. The normalized vertex coordinates are relative to the + # original image. Range: [0, 1]. class GoogleCloudVideointelligenceV1p3beta1NormalizedBoundingBox include Google::Apis::Core::Hashable @@ -4989,20 +4854,12 @@ module Google end # Normalized bounding polygon for text (that might not be aligned with axis). - # Contains list of the corner points in clockwise order starting from - # top-left corner. For example, for a rectangular bounding box: - # When the text is horizontal it might look like: - # 0----1 - # | | - # 3----2 - # When it's clockwise rotated 180 degrees around the top-left corner it - # becomes: - # 2----3 - # | | - # 1----0 - # and the vertex order will still be (0, 1, 2, 3). Note that values can be less - # than 0, or greater than 1 due to trignometric calculations for location of - # the box. + # Contains list of the corner points in clockwise order starting from top-left + # corner. For example, for a rectangular bounding box: When the text is + # horizontal it might look like: 0----1 | | 3----2 When it's clockwise rotated + # 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the + # vertex order will still be (0, 1, 2, 3). Note that values can be less than 0, + # or greater than 1 due to trignometric calculations for location of the box. class GoogleCloudVideointelligenceV1p3beta1NormalizedBoundingPoly include Google::Apis::Core::Hashable @@ -5021,9 +4878,8 @@ module Google end end - # A vertex represents a 2D point in the image. - # NOTE: the normalized vertex coordinates are relative to the original image - # and range from 0 to 1. + # A vertex represents a 2D point in the image. NOTE: the normalized vertex + # coordinates are relative to the original image and range from 0 to 1. class GoogleCloudVideointelligenceV1p3beta1NormalizedVertex include Google::Apis::Core::Hashable @@ -5062,10 +4918,10 @@ module Google # @return [Google::Apis::VideointelligenceV1::GoogleCloudVideointelligenceV1p3beta1Entity] attr_accessor :entity - # Information corresponding to all frames where this object track appears. - # Non-streaming batch mode: it may be one or multiple ObjectTrackingFrame - # messages in frames. - # Streaming mode: it can only be one ObjectTrackingFrame message in frames. + # Information corresponding to all frames where this object track appears. Non- + # streaming batch mode: it may be one or multiple ObjectTrackingFrame messages + # in frames. Streaming mode: it can only be one ObjectTrackingFrame message in + # frames. # Corresponds to the JSON property `frames` # @return [Array] attr_accessor :frames @@ -5075,12 +4931,11 @@ module Google # @return [Google::Apis::VideointelligenceV1::GoogleCloudVideointelligenceV1p3beta1VideoSegment] attr_accessor :segment - # Streaming mode ONLY. - # In streaming mode, we do not know the end time of a tracked object - # before it is completed. Hence, there is no VideoSegment info returned. - # Instead, we provide a unique identifiable integer track_id so that - # the customers can correlate the results of the ongoing - # ObjectTrackAnnotation of the same track_id over time. + # Streaming mode ONLY. In streaming mode, we do not know the end time of a + # tracked object before it is completed. Hence, there is no VideoSegment info + # returned. Instead, we provide a unique identifiable integer track_id so that + # the customers can correlate the results of the ongoing ObjectTrackAnnotation + # of the same track_id over time. # Corresponds to the JSON property `trackId` # @return [Fixnum] attr_accessor :track_id @@ -5110,9 +4965,8 @@ module Google class GoogleCloudVideointelligenceV1p3beta1ObjectTrackingFrame include Google::Apis::Core::Hashable - # Normalized bounding box. - # The normalized vertex coordinates are relative to the original image. - # Range: [0, 1]. + # Normalized bounding box. The normalized vertex coordinates are relative to the + # original image. Range: [0, 1]. # Corresponds to the JSON property `normalizedBoundingBox` # @return [Google::Apis::VideointelligenceV1::GoogleCloudVideointelligenceV1p3beta1NormalizedBoundingBox] attr_accessor :normalized_bounding_box @@ -5189,10 +5043,10 @@ module Google # Output only. The confidence estimate between 0.0 and 1.0. A higher number # indicates an estimated greater likelihood that the recognized words are - # correct. This field is set only for the top alternative. - # This field is not guaranteed to be accurate and users should not rely on it - # to be always provided. - # The default of 0.0 is a sentinel value indicating `confidence` was not set. + # correct. This field is set only for the top alternative. This field is not + # guaranteed to be accurate and users should not rely on it to be always + # provided. The default of 0.0 is a sentinel value indicating `confidence` was + # not set. # Corresponds to the JSON property `confidence` # @return [Float] attr_accessor :confidence @@ -5203,8 +5057,8 @@ module Google attr_accessor :transcript # Output only. A list of word-specific information for each recognized word. - # Note: When `enable_speaker_diarization` is set to true, you will see all - # the words from the beginning of the audio. + # Note: When `enable_speaker_diarization` is set to true, you will see all the + # words from the beginning of the audio. # Corresponds to the JSON property `words` # @return [Array] attr_accessor :words @@ -5225,18 +5079,17 @@ module Google class GoogleCloudVideointelligenceV1p3beta1SpeechTranscription include Google::Apis::Core::Hashable - # May contain one or more recognition hypotheses (up to the maximum specified - # in `max_alternatives`). These alternatives are ordered in terms of - # accuracy, with the top (first) alternative being the most probable, as - # ranked by the recognizer. + # May contain one or more recognition hypotheses (up to the maximum specified in + # `max_alternatives`). These alternatives are ordered in terms of accuracy, with + # the top (first) alternative being the most probable, as ranked by the + # recognizer. # Corresponds to the JSON property `alternatives` # @return [Array] attr_accessor :alternatives # Output only. The [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) - # language tag of - # the language in this result. This language code was detected to have the - # most likelihood of being spoken in the audio. + # language tag of the language in this result. This language code was detected + # to have the most likelihood of being spoken in the audio. # Corresponds to the JSON property `languageCode` # @return [String] attr_accessor :language_code @@ -5252,32 +5105,31 @@ module Google end end - # `StreamingAnnotateVideoResponse` is the only message returned to the client - # by `StreamingAnnotateVideo`. A series of zero or more - # `StreamingAnnotateVideoResponse` messages are streamed back to the client. + # `StreamingAnnotateVideoResponse` is the only message returned to the client by + # `StreamingAnnotateVideo`. A series of zero or more ` + # StreamingAnnotateVideoResponse` messages are streamed back to the client. class GoogleCloudVideointelligenceV1p3beta1StreamingAnnotateVideoResponse include Google::Apis::Core::Hashable - # Streaming annotation results corresponding to a portion of the video - # that is currently being processed. + # Streaming annotation results corresponding to a portion of the video that is + # currently being processed. # Corresponds to the JSON property `annotationResults` # @return [Google::Apis::VideointelligenceV1::GoogleCloudVideointelligenceV1p3beta1StreamingVideoAnnotationResults] attr_accessor :annotation_results - # Google Cloud Storage URI that stores annotation results of one - # streaming session in JSON format. - # It is the annotation_result_storage_directory - # from the request followed by '/cloud_project_number-session_id'. + # Google Cloud Storage URI that stores annotation results of one streaming + # session in JSON format. It is the annotation_result_storage_directory from the + # request followed by '/cloud_project_number-session_id'. # Corresponds to the JSON property `annotationResultsUri` # @return [String] attr_accessor :annotation_results_uri - # 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::VideointelligenceV1::GoogleRpcStatus] attr_accessor :error @@ -5294,14 +5146,14 @@ module Google end end - # Streaming annotation results corresponding to a portion of the video - # that is currently being processed. + # Streaming annotation results corresponding to a portion of the video that is + # currently being processed. class GoogleCloudVideointelligenceV1p3beta1StreamingVideoAnnotationResults include Google::Apis::Core::Hashable - # Explicit content annotation (based on per-frame visual signals only). - # If no explicit content has been detected in a frame, no annotations are - # present for that frame. + # Explicit content annotation (based on per-frame visual signals only). If no + # explicit content has been detected in a frame, no annotations are present for + # that frame. # Corresponds to the JSON property `explicitAnnotation` # @return [Google::Apis::VideointelligenceV1::GoogleCloudVideointelligenceV1p3beta1ExplicitContentAnnotation] attr_accessor :explicit_annotation @@ -5367,27 +5219,19 @@ module Google end end - # Video frame level annotation results for text annotation (OCR). - # Contains information regarding timestamp and bounding box locations for the - # frames containing detected OCR text snippets. + # Video frame level annotation results for text annotation (OCR). Contains + # information regarding timestamp and bounding box locations for the frames + # containing detected OCR text snippets. class GoogleCloudVideointelligenceV1p3beta1TextFrame include Google::Apis::Core::Hashable # Normalized bounding polygon for text (that might not be aligned with axis). - # Contains list of the corner points in clockwise order starting from - # top-left corner. For example, for a rectangular bounding box: - # When the text is horizontal it might look like: - # 0----1 - # | | - # 3----2 - # When it's clockwise rotated 180 degrees around the top-left corner it - # becomes: - # 2----3 - # | | - # 1----0 - # and the vertex order will still be (0, 1, 2, 3). Note that values can be less - # than 0, or greater than 1 due to trignometric calculations for location of - # the box. + # Contains list of the corner points in clockwise order starting from top-left + # corner. For example, for a rectangular bounding box: When the text is + # horizontal it might look like: 0----1 | | 3----2 When it's clockwise rotated + # 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the + # vertex order will still be (0, 1, 2, 3). Note that values can be less than 0, + # or greater than 1 due to trignometric calculations for location of the box. # Corresponds to the JSON property `rotatedBoundingBox` # @return [Google::Apis::VideointelligenceV1::GoogleCloudVideointelligenceV1p3beta1NormalizedBoundingPoly] attr_accessor :rotated_bounding_box @@ -5440,9 +5284,8 @@ module Google end end - # For tracking related features. - # An object at time_offset with attributes, and located with - # normalized_bounding_box. + # For tracking related features. An object at time_offset with attributes, and + # located with normalized_bounding_box. class GoogleCloudVideointelligenceV1p3beta1TimestampedObject include Google::Apis::Core::Hashable @@ -5456,15 +5299,14 @@ module Google # @return [Array] attr_accessor :landmarks - # Normalized bounding box. - # The normalized vertex coordinates are relative to the original image. - # Range: [0, 1]. + # Normalized bounding box. The normalized vertex coordinates are relative to the + # original image. Range: [0, 1]. # Corresponds to the JSON property `normalizedBoundingBox` # @return [Google::Apis::VideointelligenceV1::GoogleCloudVideointelligenceV1p3beta1NormalizedBoundingBox] attr_accessor :normalized_bounding_box - # Time-offset, relative to the beginning of the video, - # corresponding to the video frame for this object. + # Time-offset, relative to the beginning of the video, corresponding to the + # video frame for this object. # Corresponds to the JSON property `timeOffset` # @return [String] attr_accessor :time_offset @@ -5523,20 +5365,19 @@ module Google class GoogleCloudVideointelligenceV1p3beta1VideoAnnotationProgress include Google::Apis::Core::Hashable - # Specifies which feature is being tracked if the request contains more than - # one feature. + # Specifies which feature is being tracked if the request contains more than one + # feature. # Corresponds to the JSON property `feature` # @return [String] attr_accessor :feature - # Video file location in - # [Cloud Storage](https://cloud.google.com/storage/). + # Video file location in [Cloud Storage](https://cloud.google.com/storage/). # Corresponds to the JSON property `inputUri` # @return [String] attr_accessor :input_uri - # Approximate percentage processed thus far. Guaranteed to be - # 100 when fully processed. + # Approximate percentage processed thus far. Guaranteed to be 100 when fully + # processed. # Corresponds to the JSON property `progressPercent` # @return [Fixnum] attr_accessor :progress_percent @@ -5580,19 +5421,19 @@ module Google # @return [Google::Apis::VideointelligenceV1::GoogleCloudVideointelligenceV1p3beta1CelebrityRecognitionAnnotation] attr_accessor :celebrity_recognition_annotations - # 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::VideointelligenceV1::GoogleRpcStatus] attr_accessor :error - # Explicit content annotation (based on per-frame visual signals only). - # If no explicit content has been detected in a frame, no annotations are - # present for that frame. + # Explicit content annotation (based on per-frame visual signals only). If no + # explicit content has been detected in a frame, no annotations are present for + # that frame. # Corresponds to the JSON property `explicitAnnotation` # @return [Google::Apis::VideointelligenceV1::GoogleCloudVideointelligenceV1p3beta1ExplicitContentAnnotation] attr_accessor :explicit_annotation @@ -5602,14 +5443,13 @@ module Google # @return [Array] attr_accessor :face_detection_annotations - # Label annotations on frame level. - # There is exactly one element for each unique label. + # Label annotations on frame level. There is exactly one element for each unique + # label. # Corresponds to the JSON property `frameLabelAnnotations` # @return [Array] attr_accessor :frame_label_annotations - # Video file location in - # [Cloud Storage](https://cloud.google.com/storage/). + # Video file location in [Cloud Storage](https://cloud.google.com/storage/). # Corresponds to the JSON property `inputUri` # @return [String] attr_accessor :input_uri @@ -5641,11 +5481,11 @@ module Google attr_accessor :segment_label_annotations # Presence label annotations on video level or user-specified segment level. - # There is exactly one element for each unique label. Compared to the - # existing topical `segment_label_annotations`, this field presents more - # fine-grained, segment-level labels detected in video content and is made - # available only when the client sets `LabelDetectionConfig.model` to - # "builtin/latest" in the request. + # There is exactly one element for each unique label. Compared to the existing + # topical `segment_label_annotations`, this field presents more fine-grained, + # segment-level labels detected in video content and is made available only when + # the client sets `LabelDetectionConfig.model` to "builtin/latest" in the + # request. # Corresponds to the JSON property `segmentPresenceLabelAnnotations` # @return [Array] attr_accessor :segment_presence_label_annotations @@ -5655,17 +5495,17 @@ module Google # @return [Array] attr_accessor :shot_annotations - # Topical label annotations on shot level. - # There is exactly one element for each unique label. + # Topical label annotations on shot level. There is exactly one element for each + # unique label. # Corresponds to the JSON property `shotLabelAnnotations` # @return [Array] attr_accessor :shot_label_annotations # Presence label annotations on shot level. There is exactly one element for - # each unique label. Compared to the existing topical - # `shot_label_annotations`, this field presents more fine-grained, shot-level - # labels detected in video content and is made available only when the client - # sets `LabelDetectionConfig.model` to "builtin/latest" in the request. + # each unique label. Compared to the existing topical `shot_label_annotations`, + # this field presents more fine-grained, shot-level labels detected in video + # content and is made available only when the client sets `LabelDetectionConfig. + # model` to "builtin/latest" in the request. # Corresponds to the JSON property `shotPresenceLabelAnnotations` # @return [Array] attr_accessor :shot_presence_label_annotations @@ -5675,9 +5515,8 @@ module Google # @return [Array] attr_accessor :speech_transcriptions - # OCR text detection and tracking. - # Annotations for list of detected text snippets. Each will have list of - # frame information associated with it. + # OCR text detection and tracking. Annotations for list of detected text + # snippets. Each will have list of frame information associated with it. # Corresponds to the JSON property `textAnnotations` # @return [Array] attr_accessor :text_annotations @@ -5712,14 +5551,14 @@ module Google class GoogleCloudVideointelligenceV1p3beta1VideoSegment include Google::Apis::Core::Hashable - # Time-offset, relative to the beginning of the video, - # corresponding to the end of the segment (inclusive). + # Time-offset, relative to the beginning of the video, corresponding to the end + # of the segment (inclusive). # Corresponds to the JSON property `endTimeOffset` # @return [String] attr_accessor :end_time_offset - # Time-offset, relative to the beginning of the video, - # corresponding to the start of the segment (inclusive). + # Time-offset, relative to the beginning of the video, corresponding to the + # start of the segment (inclusive). # Corresponds to the JSON property `startTimeOffset` # @return [String] attr_accessor :start_time_offset @@ -5736,41 +5575,41 @@ module Google end # Word-specific information for recognized words. Word information is only - # included in the response when certain request parameters are set, such - # as `enable_word_time_offsets`. + # included in the response when certain request parameters are set, such as ` + # enable_word_time_offsets`. class GoogleCloudVideointelligenceV1p3beta1WordInfo include Google::Apis::Core::Hashable # Output only. The confidence estimate between 0.0 and 1.0. A higher number # indicates an estimated greater likelihood that the recognized words are - # correct. This field is set only for the top alternative. - # This field is not guaranteed to be accurate and users should not rely on it - # to be always provided. - # The default of 0.0 is a sentinel value indicating `confidence` was not set. + # correct. This field is set only for the top alternative. This field is not + # guaranteed to be accurate and users should not rely on it to be always + # provided. The default of 0.0 is a sentinel value indicating `confidence` was + # not set. # Corresponds to the JSON property `confidence` # @return [Float] attr_accessor :confidence - # Time offset relative to the beginning of the audio, and - # corresponding to the end of the spoken word. This field is only set if - # `enable_word_time_offsets=true` and only in the top hypothesis. This is an - # experimental feature and the accuracy of the time offset can vary. + # Time offset relative to the beginning of the audio, and corresponding to the + # end of the spoken word. This field is only set if `enable_word_time_offsets= + # true` and only in the top hypothesis. This is an experimental feature and the + # accuracy of the time offset can vary. # Corresponds to the JSON property `endTime` # @return [String] attr_accessor :end_time - # Output only. A distinct integer value is assigned for every speaker within - # the audio. This field specifies which one of those speakers was detected to - # have spoken this word. Value ranges from 1 up to diarization_speaker_count, - # and is only set if speaker diarization is enabled. + # Output only. A distinct integer value is assigned for every speaker within the + # audio. This field specifies which one of those speakers was detected to have + # spoken this word. Value ranges from 1 up to diarization_speaker_count, and is + # only set if speaker diarization is enabled. # Corresponds to the JSON property `speakerTag` # @return [Fixnum] attr_accessor :speaker_tag - # Time offset relative to the beginning of the audio, and - # corresponding to the start of the spoken word. This field is only set if - # `enable_word_time_offsets=true` and only in the top hypothesis. This is an - # experimental feature and the accuracy of the time offset can vary. + # Time offset relative to the beginning of the audio, and corresponding to the + # start of the spoken word. This field is only set if `enable_word_time_offsets= + # true` and only in the top hypothesis. This is an experimental feature and the + # accuracy of the time offset can vary. # Corresponds to the JSON property `startTime` # @return [String] attr_accessor :start_time @@ -5837,47 +5676,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::VideointelligenceV1::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 @@ -5896,13 +5733,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 @@ -5915,12 +5750,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 @@ -5929,15 +5764,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 diff --git a/generated/google/apis/videointelligence_v1/service.rb b/generated/google/apis/videointelligence_v1/service.rb index 3e0ac717e..c85012bd9 100644 --- a/generated/google/apis/videointelligence_v1/service.rb +++ b/generated/google/apis/videointelligence_v1/service.rb @@ -49,15 +49,13 @@ module Google @batch_path = 'batch' 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. @@ -88,10 +86,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 @@ -121,9 +119,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 @@ -153,9 +150,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 @@ -185,15 +181,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. @@ -227,10 +221,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 @@ -260,9 +254,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 @@ -292,15 +285,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 @@ -339,10 +331,10 @@ module Google execute_or_queue_command(command, &block) end - # Performs asynchronous video annotation. Progress and results can be - # retrieved through the `google.longrunning.Operations` interface. - # `Operation.metadata` contains `AnnotateVideoProgress` (progress). - # `Operation.response` contains `AnnotateVideoResponse` (results). + # Performs asynchronous video annotation. Progress and results can be retrieved + # through the `google.longrunning.Operations` interface. `Operation.metadata` + # contains `AnnotateVideoProgress` (progress). `Operation.response` contains ` + # AnnotateVideoResponse` (results). # @param [Google::Apis::VideointelligenceV1::GoogleCloudVideointelligenceV1AnnotateVideoRequest] google_cloud_videointelligence_v1_annotate_video_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. diff --git a/generated/google/apis/videointelligence_v1beta2.rb b/generated/google/apis/videointelligence_v1beta2.rb index 2fff1b6c1..1be2e0bf9 100644 --- a/generated/google/apis/videointelligence_v1beta2.rb +++ b/generated/google/apis/videointelligence_v1beta2.rb @@ -27,7 +27,7 @@ module Google # @see https://cloud.google.com/video-intelligence/docs/ module VideointelligenceV1beta2 VERSION = 'V1beta2' - REVISION = '20200602' + 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/videointelligence_v1beta2/classes.rb b/generated/google/apis/videointelligence_v1beta2/classes.rb index aa1953f78..f1713b7cc 100644 --- a/generated/google/apis/videointelligence_v1beta2/classes.rb +++ b/generated/google/apis/videointelligence_v1beta2/classes.rb @@ -22,9 +22,9 @@ module Google module Apis module VideointelligenceV1beta2 - # Video annotation progress. Included in the `metadata` - # field of the `Operation` returned by the `GetOperation` - # call of the `google::longrunning::Operations` service. + # Video annotation progress. Included in the `metadata` field of the `Operation` + # returned by the `GetOperation` call of the `google::longrunning::Operations` + # service. class GoogleCloudVideointelligenceV1AnnotateVideoProgress include Google::Apis::Core::Hashable @@ -43,9 +43,9 @@ module Google end end - # Video annotation response. Included in the `response` - # field of the `Operation` returned by the `GetOperation` - # call of the `google::longrunning::Operations` service. + # Video annotation response. Included in the `response` field of the `Operation` + # returned by the `GetOperation` call of the `google::longrunning::Operations` + # service. class GoogleCloudVideointelligenceV1AnnotateVideoResponse include Google::Apis::Core::Hashable @@ -73,14 +73,14 @@ module Google # @return [Float] attr_accessor :confidence - # The name of the attribute, for example, glasses, dark_glasses, mouth_open. - # A full list of supported type names will be provided in the document. + # The name of the attribute, for example, glasses, dark_glasses, mouth_open. A + # full list of supported type names will be provided in the document. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name - # Text value of the detection result. For example, the value for "HairColor" - # can be "black", "blonde", etc. + # Text value of the detection result. For example, the value for "HairColor" can + # be "black", "blonde", etc. # Corresponds to the JSON property `value` # @return [String] attr_accessor :value @@ -112,9 +112,8 @@ module Google # @return [String] attr_accessor :name - # A vertex represents a 2D point in the image. - # NOTE: the normalized vertex coordinates are relative to the original image - # and range from 0 to 1. + # A vertex represents a 2D point in the image. NOTE: the normalized vertex + # coordinates are relative to the original image and range from 0 to 1. # Corresponds to the JSON property `point` # @return [Google::Apis::VideointelligenceV1beta2::GoogleCloudVideointelligenceV1NormalizedVertex] attr_accessor :point @@ -140,8 +139,7 @@ module Google # @return [String] attr_accessor :description - # Opaque entity ID. Some IDs may be available in - # [Google Knowledge Graph Search + # Opaque entity ID. Some IDs may be available in [Google Knowledge Graph Search # API](https://developers.google.com/knowledge-graph/). # Corresponds to the JSON property `entityId` # @return [String] @@ -164,9 +162,9 @@ module Google end end - # Explicit content annotation (based on per-frame visual signals only). - # If no explicit content has been detected in a frame, no annotations are - # present for that frame. + # Explicit content annotation (based on per-frame visual signals only). If no + # explicit content has been detected in a frame, no annotations are present for + # that frame. class GoogleCloudVideointelligenceV1ExplicitContentAnnotation include Google::Apis::Core::Hashable @@ -221,10 +219,9 @@ module Google class GoogleCloudVideointelligenceV1LabelAnnotation include Google::Apis::Core::Hashable - # Common categories for the detected entity. - # For example, when the label is `Terrier`, the category is likely `dog`. And - # in some cases there might be more than one categories e.g., `Terrier` could - # also be a `pet`. + # Common categories for the detected entity. For example, when the label is ` + # Terrier`, the category is likely `dog`. And in some cases there might be more + # than one categories e.g., `Terrier` could also be a `pet`. # Corresponds to the JSON property `categoryEntities` # @return [Array] attr_accessor :category_entities @@ -323,14 +320,14 @@ module Google # @return [Google::Apis::VideointelligenceV1beta2::GoogleCloudVideointelligenceV1Entity] attr_accessor :entity - # All video segments where the recognized logo appears. There might be - # multiple instances of the same logo class appearing in one VideoSegment. + # All video segments where the recognized logo appears. There might be multiple + # instances of the same logo class appearing in one VideoSegment. # Corresponds to the JSON property `segments` # @return [Array] attr_accessor :segments - # All logo tracks where the recognized logo appears. Each track corresponds - # to one logo instance appearing in consecutive frames. + # All logo tracks where the recognized logo appears. Each track corresponds to + # one logo instance appearing in consecutive frames. # Corresponds to the JSON property `tracks` # @return [Array] attr_accessor :tracks @@ -347,9 +344,8 @@ module Google end end - # Normalized bounding box. - # The normalized vertex coordinates are relative to the original image. - # Range: [0, 1]. + # Normalized bounding box. The normalized vertex coordinates are relative to the + # original image. Range: [0, 1]. class GoogleCloudVideointelligenceV1NormalizedBoundingBox include Google::Apis::Core::Hashable @@ -387,20 +383,12 @@ module Google end # Normalized bounding polygon for text (that might not be aligned with axis). - # Contains list of the corner points in clockwise order starting from - # top-left corner. For example, for a rectangular bounding box: - # When the text is horizontal it might look like: - # 0----1 - # | | - # 3----2 - # When it's clockwise rotated 180 degrees around the top-left corner it - # becomes: - # 2----3 - # | | - # 1----0 - # and the vertex order will still be (0, 1, 2, 3). Note that values can be less - # than 0, or greater than 1 due to trignometric calculations for location of - # the box. + # Contains list of the corner points in clockwise order starting from top-left + # corner. For example, for a rectangular bounding box: When the text is + # horizontal it might look like: 0----1 | | 3----2 When it's clockwise rotated + # 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the + # vertex order will still be (0, 1, 2, 3). Note that values can be less than 0, + # or greater than 1 due to trignometric calculations for location of the box. class GoogleCloudVideointelligenceV1NormalizedBoundingPoly include Google::Apis::Core::Hashable @@ -419,9 +407,8 @@ module Google end end - # A vertex represents a 2D point in the image. - # NOTE: the normalized vertex coordinates are relative to the original image - # and range from 0 to 1. + # A vertex represents a 2D point in the image. NOTE: the normalized vertex + # coordinates are relative to the original image and range from 0 to 1. class GoogleCloudVideointelligenceV1NormalizedVertex include Google::Apis::Core::Hashable @@ -460,10 +447,10 @@ module Google # @return [Google::Apis::VideointelligenceV1beta2::GoogleCloudVideointelligenceV1Entity] attr_accessor :entity - # Information corresponding to all frames where this object track appears. - # Non-streaming batch mode: it may be one or multiple ObjectTrackingFrame - # messages in frames. - # Streaming mode: it can only be one ObjectTrackingFrame message in frames. + # Information corresponding to all frames where this object track appears. Non- + # streaming batch mode: it may be one or multiple ObjectTrackingFrame messages + # in frames. Streaming mode: it can only be one ObjectTrackingFrame message in + # frames. # Corresponds to the JSON property `frames` # @return [Array] attr_accessor :frames @@ -473,12 +460,11 @@ module Google # @return [Google::Apis::VideointelligenceV1beta2::GoogleCloudVideointelligenceV1VideoSegment] attr_accessor :segment - # Streaming mode ONLY. - # In streaming mode, we do not know the end time of a tracked object - # before it is completed. Hence, there is no VideoSegment info returned. - # Instead, we provide a unique identifiable integer track_id so that - # the customers can correlate the results of the ongoing - # ObjectTrackAnnotation of the same track_id over time. + # Streaming mode ONLY. In streaming mode, we do not know the end time of a + # tracked object before it is completed. Hence, there is no VideoSegment info + # returned. Instead, we provide a unique identifiable integer track_id so that + # the customers can correlate the results of the ongoing ObjectTrackAnnotation + # of the same track_id over time. # Corresponds to the JSON property `trackId` # @return [Fixnum] attr_accessor :track_id @@ -508,9 +494,8 @@ module Google class GoogleCloudVideointelligenceV1ObjectTrackingFrame include Google::Apis::Core::Hashable - # Normalized bounding box. - # The normalized vertex coordinates are relative to the original image. - # Range: [0, 1]. + # Normalized bounding box. The normalized vertex coordinates are relative to the + # original image. Range: [0, 1]. # Corresponds to the JSON property `normalizedBoundingBox` # @return [Google::Apis::VideointelligenceV1beta2::GoogleCloudVideointelligenceV1NormalizedBoundingBox] attr_accessor :normalized_bounding_box @@ -537,10 +522,10 @@ module Google # Output only. The confidence estimate between 0.0 and 1.0. A higher number # indicates an estimated greater likelihood that the recognized words are - # correct. This field is set only for the top alternative. - # This field is not guaranteed to be accurate and users should not rely on it - # to be always provided. - # The default of 0.0 is a sentinel value indicating `confidence` was not set. + # correct. This field is set only for the top alternative. This field is not + # guaranteed to be accurate and users should not rely on it to be always + # provided. The default of 0.0 is a sentinel value indicating `confidence` was + # not set. # Corresponds to the JSON property `confidence` # @return [Float] attr_accessor :confidence @@ -551,8 +536,8 @@ module Google attr_accessor :transcript # Output only. A list of word-specific information for each recognized word. - # Note: When `enable_speaker_diarization` is set to true, you will see all - # the words from the beginning of the audio. + # Note: When `enable_speaker_diarization` is set to true, you will see all the + # words from the beginning of the audio. # Corresponds to the JSON property `words` # @return [Array] attr_accessor :words @@ -573,18 +558,17 @@ module Google class GoogleCloudVideointelligenceV1SpeechTranscription include Google::Apis::Core::Hashable - # May contain one or more recognition hypotheses (up to the maximum specified - # in `max_alternatives`). These alternatives are ordered in terms of - # accuracy, with the top (first) alternative being the most probable, as - # ranked by the recognizer. + # May contain one or more recognition hypotheses (up to the maximum specified in + # `max_alternatives`). These alternatives are ordered in terms of accuracy, with + # the top (first) alternative being the most probable, as ranked by the + # recognizer. # Corresponds to the JSON property `alternatives` # @return [Array] attr_accessor :alternatives # Output only. The [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) - # language tag of - # the language in this result. This language code was detected to have the - # most likelihood of being spoken in the audio. + # language tag of the language in this result. This language code was detected + # to have the most likelihood of being spoken in the audio. # Corresponds to the JSON property `languageCode` # @return [String] attr_accessor :language_code @@ -633,27 +617,19 @@ module Google end end - # Video frame level annotation results for text annotation (OCR). - # Contains information regarding timestamp and bounding box locations for the - # frames containing detected OCR text snippets. + # Video frame level annotation results for text annotation (OCR). Contains + # information regarding timestamp and bounding box locations for the frames + # containing detected OCR text snippets. class GoogleCloudVideointelligenceV1TextFrame include Google::Apis::Core::Hashable # Normalized bounding polygon for text (that might not be aligned with axis). - # Contains list of the corner points in clockwise order starting from - # top-left corner. For example, for a rectangular bounding box: - # When the text is horizontal it might look like: - # 0----1 - # | | - # 3----2 - # When it's clockwise rotated 180 degrees around the top-left corner it - # becomes: - # 2----3 - # | | - # 1----0 - # and the vertex order will still be (0, 1, 2, 3). Note that values can be less - # than 0, or greater than 1 due to trignometric calculations for location of - # the box. + # Contains list of the corner points in clockwise order starting from top-left + # corner. For example, for a rectangular bounding box: When the text is + # horizontal it might look like: 0----1 | | 3----2 When it's clockwise rotated + # 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the + # vertex order will still be (0, 1, 2, 3). Note that values can be less than 0, + # or greater than 1 due to trignometric calculations for location of the box. # Corresponds to the JSON property `rotatedBoundingBox` # @return [Google::Apis::VideointelligenceV1beta2::GoogleCloudVideointelligenceV1NormalizedBoundingPoly] attr_accessor :rotated_bounding_box @@ -706,9 +682,8 @@ module Google end end - # For tracking related features. - # An object at time_offset with attributes, and located with - # normalized_bounding_box. + # For tracking related features. An object at time_offset with attributes, and + # located with normalized_bounding_box. class GoogleCloudVideointelligenceV1TimestampedObject include Google::Apis::Core::Hashable @@ -722,15 +697,14 @@ module Google # @return [Array] attr_accessor :landmarks - # Normalized bounding box. - # The normalized vertex coordinates are relative to the original image. - # Range: [0, 1]. + # Normalized bounding box. The normalized vertex coordinates are relative to the + # original image. Range: [0, 1]. # Corresponds to the JSON property `normalizedBoundingBox` # @return [Google::Apis::VideointelligenceV1beta2::GoogleCloudVideointelligenceV1NormalizedBoundingBox] attr_accessor :normalized_bounding_box - # Time-offset, relative to the beginning of the video, - # corresponding to the video frame for this object. + # Time-offset, relative to the beginning of the video, corresponding to the + # video frame for this object. # Corresponds to the JSON property `timeOffset` # @return [String] attr_accessor :time_offset @@ -789,20 +763,19 @@ module Google class GoogleCloudVideointelligenceV1VideoAnnotationProgress include Google::Apis::Core::Hashable - # Specifies which feature is being tracked if the request contains more than - # one feature. + # Specifies which feature is being tracked if the request contains more than one + # feature. # Corresponds to the JSON property `feature` # @return [String] attr_accessor :feature - # Video file location in - # [Cloud Storage](https://cloud.google.com/storage/). + # Video file location in [Cloud Storage](https://cloud.google.com/storage/). # Corresponds to the JSON property `inputUri` # @return [String] attr_accessor :input_uri - # Approximate percentage processed thus far. Guaranteed to be - # 100 when fully processed. + # Approximate percentage processed thus far. Guaranteed to be 100 when fully + # processed. # Corresponds to the JSON property `progressPercent` # @return [Fixnum] attr_accessor :progress_percent @@ -841,31 +814,30 @@ module Google class GoogleCloudVideointelligenceV1VideoAnnotationResults include Google::Apis::Core::Hashable - # 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::VideointelligenceV1beta2::GoogleRpcStatus] attr_accessor :error - # Explicit content annotation (based on per-frame visual signals only). - # If no explicit content has been detected in a frame, no annotations are - # present for that frame. + # Explicit content annotation (based on per-frame visual signals only). If no + # explicit content has been detected in a frame, no annotations are present for + # that frame. # Corresponds to the JSON property `explicitAnnotation` # @return [Google::Apis::VideointelligenceV1beta2::GoogleCloudVideointelligenceV1ExplicitContentAnnotation] attr_accessor :explicit_annotation - # Label annotations on frame level. - # There is exactly one element for each unique label. + # Label annotations on frame level. There is exactly one element for each unique + # label. # Corresponds to the JSON property `frameLabelAnnotations` # @return [Array] attr_accessor :frame_label_annotations - # Video file location in - # [Cloud Storage](https://cloud.google.com/storage/). + # Video file location in [Cloud Storage](https://cloud.google.com/storage/). # Corresponds to the JSON property `inputUri` # @return [String] attr_accessor :input_uri @@ -892,11 +864,11 @@ module Google attr_accessor :segment_label_annotations # Presence label annotations on video level or user-specified segment level. - # There is exactly one element for each unique label. Compared to the - # existing topical `segment_label_annotations`, this field presents more - # fine-grained, segment-level labels detected in video content and is made - # available only when the client sets `LabelDetectionConfig.model` to - # "builtin/latest" in the request. + # There is exactly one element for each unique label. Compared to the existing + # topical `segment_label_annotations`, this field presents more fine-grained, + # segment-level labels detected in video content and is made available only when + # the client sets `LabelDetectionConfig.model` to "builtin/latest" in the + # request. # Corresponds to the JSON property `segmentPresenceLabelAnnotations` # @return [Array] attr_accessor :segment_presence_label_annotations @@ -906,17 +878,17 @@ module Google # @return [Array] attr_accessor :shot_annotations - # Topical label annotations on shot level. - # There is exactly one element for each unique label. + # Topical label annotations on shot level. There is exactly one element for each + # unique label. # Corresponds to the JSON property `shotLabelAnnotations` # @return [Array] attr_accessor :shot_label_annotations # Presence label annotations on shot level. There is exactly one element for - # each unique label. Compared to the existing topical - # `shot_label_annotations`, this field presents more fine-grained, shot-level - # labels detected in video content and is made available only when the client - # sets `LabelDetectionConfig.model` to "builtin/latest" in the request. + # each unique label. Compared to the existing topical `shot_label_annotations`, + # this field presents more fine-grained, shot-level labels detected in video + # content and is made available only when the client sets `LabelDetectionConfig. + # model` to "builtin/latest" in the request. # Corresponds to the JSON property `shotPresenceLabelAnnotations` # @return [Array] attr_accessor :shot_presence_label_annotations @@ -926,9 +898,8 @@ module Google # @return [Array] attr_accessor :speech_transcriptions - # OCR text detection and tracking. - # Annotations for list of detected text snippets. Each will have list of - # frame information associated with it. + # OCR text detection and tracking. Annotations for list of detected text + # snippets. Each will have list of frame information associated with it. # Corresponds to the JSON property `textAnnotations` # @return [Array] attr_accessor :text_annotations @@ -960,14 +931,14 @@ module Google class GoogleCloudVideointelligenceV1VideoSegment include Google::Apis::Core::Hashable - # Time-offset, relative to the beginning of the video, - # corresponding to the end of the segment (inclusive). + # Time-offset, relative to the beginning of the video, corresponding to the end + # of the segment (inclusive). # Corresponds to the JSON property `endTimeOffset` # @return [String] attr_accessor :end_time_offset - # Time-offset, relative to the beginning of the video, - # corresponding to the start of the segment (inclusive). + # Time-offset, relative to the beginning of the video, corresponding to the + # start of the segment (inclusive). # Corresponds to the JSON property `startTimeOffset` # @return [String] attr_accessor :start_time_offset @@ -984,41 +955,41 @@ module Google end # Word-specific information for recognized words. Word information is only - # included in the response when certain request parameters are set, such - # as `enable_word_time_offsets`. + # included in the response when certain request parameters are set, such as ` + # enable_word_time_offsets`. class GoogleCloudVideointelligenceV1WordInfo include Google::Apis::Core::Hashable # Output only. The confidence estimate between 0.0 and 1.0. A higher number # indicates an estimated greater likelihood that the recognized words are - # correct. This field is set only for the top alternative. - # This field is not guaranteed to be accurate and users should not rely on it - # to be always provided. - # The default of 0.0 is a sentinel value indicating `confidence` was not set. + # correct. This field is set only for the top alternative. This field is not + # guaranteed to be accurate and users should not rely on it to be always + # provided. The default of 0.0 is a sentinel value indicating `confidence` was + # not set. # Corresponds to the JSON property `confidence` # @return [Float] attr_accessor :confidence - # Time offset relative to the beginning of the audio, and - # corresponding to the end of the spoken word. This field is only set if - # `enable_word_time_offsets=true` and only in the top hypothesis. This is an - # experimental feature and the accuracy of the time offset can vary. + # Time offset relative to the beginning of the audio, and corresponding to the + # end of the spoken word. This field is only set if `enable_word_time_offsets= + # true` and only in the top hypothesis. This is an experimental feature and the + # accuracy of the time offset can vary. # Corresponds to the JSON property `endTime` # @return [String] attr_accessor :end_time - # Output only. A distinct integer value is assigned for every speaker within - # the audio. This field specifies which one of those speakers was detected to - # have spoken this word. Value ranges from 1 up to diarization_speaker_count, - # and is only set if speaker diarization is enabled. + # Output only. A distinct integer value is assigned for every speaker within the + # audio. This field specifies which one of those speakers was detected to have + # spoken this word. Value ranges from 1 up to diarization_speaker_count, and is + # only set if speaker diarization is enabled. # Corresponds to the JSON property `speakerTag` # @return [Fixnum] attr_accessor :speaker_tag - # Time offset relative to the beginning of the audio, and - # corresponding to the start of the spoken word. This field is only set if - # `enable_word_time_offsets=true` and only in the top hypothesis. This is an - # experimental feature and the accuracy of the time offset can vary. + # Time offset relative to the beginning of the audio, and corresponding to the + # start of the spoken word. This field is only set if `enable_word_time_offsets= + # true` and only in the top hypothesis. This is an experimental feature and the + # accuracy of the time offset can vary. # Corresponds to the JSON property `startTime` # @return [String] attr_accessor :start_time @@ -1042,9 +1013,9 @@ module Google end end - # Video annotation progress. Included in the `metadata` - # field of the `Operation` returned by the `GetOperation` - # call of the `google::longrunning::Operations` service. + # Video annotation progress. Included in the `metadata` field of the `Operation` + # returned by the `GetOperation` call of the `google::longrunning::Operations` + # service. class GoogleCloudVideointelligenceV1beta2AnnotateVideoProgress include Google::Apis::Core::Hashable @@ -1072,24 +1043,22 @@ module Google # @return [Array] attr_accessor :features - # The video data bytes. - # If unset, the input video(s) should be specified via the `input_uri`. - # If set, `input_uri` must be unset. + # The video data bytes. If unset, the input video(s) should be specified via the + # `input_uri`. If set, `input_uri` must be unset. # Corresponds to the JSON property `inputContent` # NOTE: Values are automatically base64 encoded/decoded in the client library. # @return [String] attr_accessor :input_content - # Input video location. Currently, only - # [Cloud Storage](https://cloud.google.com/storage/) URIs are - # supported. URIs must be specified in the following format: - # `gs://bucket-id/object-id` (other URI formats return - # google.rpc.Code.INVALID_ARGUMENT). For more information, see - # [Request URIs](https://cloud.google.com/storage/docs/request-endpoints). - # To identify multiple videos, a video URI may include wildcards in the - # `object-id`. Supported wildcards: '*' to match 0 or more characters; - # '?' to match 1 character. If unset, the input video should be embedded - # in the request as `input_content`. If set, `input_content` must be unset. + # Input video location. Currently, only [Cloud Storage](https://cloud.google.com/ + # storage/) URIs are supported. URIs must be specified in the following format: ` + # gs://bucket-id/object-id` (other URI formats return google.rpc.Code. + # INVALID_ARGUMENT). For more information, see [Request URIs](https://cloud. + # google.com/storage/docs/request-endpoints). To identify multiple videos, a + # video URI may include wildcards in the `object-id`. Supported wildcards: '*' + # to match 0 or more characters; '?' to match 1 character. If unset, the input + # video should be embedded in the request as `input_content`. If set, ` + # input_content` must be unset. # Corresponds to the JSON property `inputUri` # @return [String] attr_accessor :input_uri @@ -1103,11 +1072,11 @@ module Google attr_accessor :location_id # Optional. Location where the output (in JSON format) should be stored. - # Currently, only [Cloud Storage](https://cloud.google.com/storage/) - # URIs are supported. These must be specified in the following format: - # `gs://bucket-id/object-id` (other URI formats return - # google.rpc.Code.INVALID_ARGUMENT). For more information, see - # [Request URIs](https://cloud.google.com/storage/docs/request-endpoints). + # Currently, only [Cloud Storage](https://cloud.google.com/storage/) URIs are + # supported. These must be specified in the following format: `gs://bucket-id/ + # object-id` (other URI formats return google.rpc.Code.INVALID_ARGUMENT). For + # more information, see [Request URIs](https://cloud.google.com/storage/docs/ + # request-endpoints). # Corresponds to the JSON property `outputUri` # @return [String] attr_accessor :output_uri @@ -1132,9 +1101,9 @@ module Google end end - # Video annotation response. Included in the `response` - # field of the `Operation` returned by the `GetOperation` - # call of the `google::longrunning::Operations` service. + # Video annotation response. Included in the `response` field of the `Operation` + # returned by the `GetOperation` call of the `google::longrunning::Operations` + # service. class GoogleCloudVideointelligenceV1beta2AnnotateVideoResponse include Google::Apis::Core::Hashable @@ -1162,14 +1131,14 @@ module Google # @return [Float] attr_accessor :confidence - # The name of the attribute, for example, glasses, dark_glasses, mouth_open. - # A full list of supported type names will be provided in the document. + # The name of the attribute, for example, glasses, dark_glasses, mouth_open. A + # full list of supported type names will be provided in the document. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name - # Text value of the detection result. For example, the value for "HairColor" - # can be "black", "blonde", etc. + # Text value of the detection result. For example, the value for "HairColor" can + # be "black", "blonde", etc. # Corresponds to the JSON property `value` # @return [String] attr_accessor :value @@ -1201,9 +1170,8 @@ module Google # @return [String] attr_accessor :name - # A vertex represents a 2D point in the image. - # NOTE: the normalized vertex coordinates are relative to the original image - # and range from 0 to 1. + # A vertex represents a 2D point in the image. NOTE: the normalized vertex + # coordinates are relative to the original image and range from 0 to 1. # Corresponds to the JSON property `point` # @return [Google::Apis::VideointelligenceV1beta2::GoogleCloudVideointelligenceV1beta2NormalizedVertex] attr_accessor :point @@ -1229,8 +1197,7 @@ module Google # @return [String] attr_accessor :description - # Opaque entity ID. Some IDs may be available in - # [Google Knowledge Graph Search + # Opaque entity ID. Some IDs may be available in [Google Knowledge Graph Search # API](https://developers.google.com/knowledge-graph/). # Corresponds to the JSON property `entityId` # @return [String] @@ -1253,9 +1220,9 @@ module Google end end - # Explicit content annotation (based on per-frame visual signals only). - # If no explicit content has been detected in a frame, no annotations are - # present for that frame. + # Explicit content annotation (based on per-frame visual signals only). If no + # explicit content has been detected in a frame, no annotations are present for + # that frame. class GoogleCloudVideointelligenceV1beta2ExplicitContentAnnotation include Google::Apis::Core::Hashable @@ -1284,9 +1251,8 @@ module Google class GoogleCloudVideointelligenceV1beta2ExplicitContentDetectionConfig include Google::Apis::Core::Hashable - # Model to use for explicit content detection. - # Supported values: "builtin/stable" (the default if unset) and - # "builtin/latest". + # Model to use for explicit content detection. Supported values: "builtin/stable" + # (the default if unset) and "builtin/latest". # Corresponds to the JSON property `model` # @return [String] attr_accessor :model @@ -1331,10 +1297,9 @@ module Google class GoogleCloudVideointelligenceV1beta2LabelAnnotation include Google::Apis::Core::Hashable - # Common categories for the detected entity. - # For example, when the label is `Terrier`, the category is likely `dog`. And - # in some cases there might be more than one categories e.g., `Terrier` could - # also be a `pet`. + # Common categories for the detected entity. For example, when the label is ` + # Terrier`, the category is likely `dog`. And in some cases there might be more + # than one categories e.g., `Terrier` could also be a `pet`. # Corresponds to the JSON property `categoryEntities` # @return [Array] attr_accessor :category_entities @@ -1377,44 +1342,40 @@ module Google class GoogleCloudVideointelligenceV1beta2LabelDetectionConfig include Google::Apis::Core::Hashable - # The confidence threshold we perform filtering on the labels from - # frame-level detection. If not set, it is set to 0.4 by default. The valid - # range for this threshold is [0.1, 0.9]. Any value set outside of this - # range will be clipped. - # Note: For best results, follow the default threshold. We will update - # the default threshold everytime when we release a new model. + # The confidence threshold we perform filtering on the labels from frame-level + # detection. If not set, it is set to 0.4 by default. The valid range for this + # threshold is [0.1, 0.9]. Any value set outside of this range will be clipped. + # Note: For best results, follow the default threshold. We will update the + # default threshold everytime when we release a new model. # Corresponds to the JSON property `frameConfidenceThreshold` # @return [Float] attr_accessor :frame_confidence_threshold - # What labels should be detected with LABEL_DETECTION, in addition to - # video-level labels or segment-level labels. - # If unspecified, defaults to `SHOT_MODE`. + # What labels should be detected with LABEL_DETECTION, in addition to video- + # level labels or segment-level labels. If unspecified, defaults to `SHOT_MODE`. # Corresponds to the JSON property `labelDetectionMode` # @return [String] attr_accessor :label_detection_mode - # Model to use for label detection. - # Supported values: "builtin/stable" (the default if unset) and - # "builtin/latest". + # Model to use for label detection. Supported values: "builtin/stable" (the + # default if unset) and "builtin/latest". # Corresponds to the JSON property `model` # @return [String] attr_accessor :model - # Whether the video has been shot from a stationary (i.e., non-moving) - # camera. When set to true, might improve detection accuracy for moving - # objects. Should be used with `SHOT_AND_FRAME_MODE` enabled. + # Whether the video has been shot from a stationary (i.e., non-moving) camera. + # When set to true, might improve detection accuracy for moving objects. Should + # be used with `SHOT_AND_FRAME_MODE` enabled. # Corresponds to the JSON property `stationaryCamera` # @return [Boolean] attr_accessor :stationary_camera alias_method :stationary_camera?, :stationary_camera - # The confidence threshold we perform filtering on the labels from - # video-level and shot-level detections. If not set, it's set to 0.3 by - # default. The valid range for this threshold is [0.1, 0.9]. Any value set - # outside of this range will be clipped. - # Note: For best results, follow the default threshold. We will update - # the default threshold everytime when we release a new model. + # The confidence threshold we perform filtering on the labels from video-level + # and shot-level detections. If not set, it's set to 0.3 by default. The valid + # range for this threshold is [0.1, 0.9]. Any value set outside of this range + # will be clipped. Note: For best results, follow the default threshold. We will + # update the default threshold everytime when we release a new model. # Corresponds to the JSON property `videoConfidenceThreshold` # @return [Float] attr_accessor :video_confidence_threshold @@ -1493,14 +1454,14 @@ module Google # @return [Google::Apis::VideointelligenceV1beta2::GoogleCloudVideointelligenceV1beta2Entity] attr_accessor :entity - # All video segments where the recognized logo appears. There might be - # multiple instances of the same logo class appearing in one VideoSegment. + # All video segments where the recognized logo appears. There might be multiple + # instances of the same logo class appearing in one VideoSegment. # Corresponds to the JSON property `segments` # @return [Array] attr_accessor :segments - # All logo tracks where the recognized logo appears. Each track corresponds - # to one logo instance appearing in consecutive frames. + # All logo tracks where the recognized logo appears. Each track corresponds to + # one logo instance appearing in consecutive frames. # Corresponds to the JSON property `tracks` # @return [Array] attr_accessor :tracks @@ -1517,9 +1478,8 @@ module Google end end - # Normalized bounding box. - # The normalized vertex coordinates are relative to the original image. - # Range: [0, 1]. + # Normalized bounding box. The normalized vertex coordinates are relative to the + # original image. Range: [0, 1]. class GoogleCloudVideointelligenceV1beta2NormalizedBoundingBox include Google::Apis::Core::Hashable @@ -1557,20 +1517,12 @@ module Google end # Normalized bounding polygon for text (that might not be aligned with axis). - # Contains list of the corner points in clockwise order starting from - # top-left corner. For example, for a rectangular bounding box: - # When the text is horizontal it might look like: - # 0----1 - # | | - # 3----2 - # When it's clockwise rotated 180 degrees around the top-left corner it - # becomes: - # 2----3 - # | | - # 1----0 - # and the vertex order will still be (0, 1, 2, 3). Note that values can be less - # than 0, or greater than 1 due to trignometric calculations for location of - # the box. + # Contains list of the corner points in clockwise order starting from top-left + # corner. For example, for a rectangular bounding box: When the text is + # horizontal it might look like: 0----1 | | 3----2 When it's clockwise rotated + # 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the + # vertex order will still be (0, 1, 2, 3). Note that values can be less than 0, + # or greater than 1 due to trignometric calculations for location of the box. class GoogleCloudVideointelligenceV1beta2NormalizedBoundingPoly include Google::Apis::Core::Hashable @@ -1589,9 +1541,8 @@ module Google end end - # A vertex represents a 2D point in the image. - # NOTE: the normalized vertex coordinates are relative to the original image - # and range from 0 to 1. + # A vertex represents a 2D point in the image. NOTE: the normalized vertex + # coordinates are relative to the original image and range from 0 to 1. class GoogleCloudVideointelligenceV1beta2NormalizedVertex include Google::Apis::Core::Hashable @@ -1630,10 +1581,10 @@ module Google # @return [Google::Apis::VideointelligenceV1beta2::GoogleCloudVideointelligenceV1beta2Entity] attr_accessor :entity - # Information corresponding to all frames where this object track appears. - # Non-streaming batch mode: it may be one or multiple ObjectTrackingFrame - # messages in frames. - # Streaming mode: it can only be one ObjectTrackingFrame message in frames. + # Information corresponding to all frames where this object track appears. Non- + # streaming batch mode: it may be one or multiple ObjectTrackingFrame messages + # in frames. Streaming mode: it can only be one ObjectTrackingFrame message in + # frames. # Corresponds to the JSON property `frames` # @return [Array] attr_accessor :frames @@ -1643,12 +1594,11 @@ module Google # @return [Google::Apis::VideointelligenceV1beta2::GoogleCloudVideointelligenceV1beta2VideoSegment] attr_accessor :segment - # Streaming mode ONLY. - # In streaming mode, we do not know the end time of a tracked object - # before it is completed. Hence, there is no VideoSegment info returned. - # Instead, we provide a unique identifiable integer track_id so that - # the customers can correlate the results of the ongoing - # ObjectTrackAnnotation of the same track_id over time. + # Streaming mode ONLY. In streaming mode, we do not know the end time of a + # tracked object before it is completed. Hence, there is no VideoSegment info + # returned. Instead, we provide a unique identifiable integer track_id so that + # the customers can correlate the results of the ongoing ObjectTrackAnnotation + # of the same track_id over time. # Corresponds to the JSON property `trackId` # @return [Fixnum] attr_accessor :track_id @@ -1677,9 +1627,8 @@ module Google class GoogleCloudVideointelligenceV1beta2ObjectTrackingConfig include Google::Apis::Core::Hashable - # Model to use for object tracking. - # Supported values: "builtin/stable" (the default if unset) and - # "builtin/latest". + # Model to use for object tracking. Supported values: "builtin/stable" (the + # default if unset) and "builtin/latest". # Corresponds to the JSON property `model` # @return [String] attr_accessor :model @@ -1699,9 +1648,8 @@ module Google class GoogleCloudVideointelligenceV1beta2ObjectTrackingFrame include Google::Apis::Core::Hashable - # Normalized bounding box. - # The normalized vertex coordinates are relative to the original image. - # Range: [0, 1]. + # Normalized bounding box. The normalized vertex coordinates are relative to the + # original image. Range: [0, 1]. # Corresponds to the JSON property `normalizedBoundingBox` # @return [Google::Apis::VideointelligenceV1beta2::GoogleCloudVideointelligenceV1beta2NormalizedBoundingBox] attr_accessor :normalized_bounding_box @@ -1726,9 +1674,8 @@ module Google class GoogleCloudVideointelligenceV1beta2ShotChangeDetectionConfig include Google::Apis::Core::Hashable - # Model to use for shot change detection. - # Supported values: "builtin/stable" (the default if unset) and - # "builtin/latest". + # Model to use for shot change detection. Supported values: "builtin/stable" ( + # the default if unset) and "builtin/latest". # Corresponds to the JSON property `model` # @return [String] attr_accessor :model @@ -1748,12 +1695,12 @@ module Google class GoogleCloudVideointelligenceV1beta2SpeechContext include Google::Apis::Core::Hashable - # Optional. A list of strings containing words and phrases "hints" so that - # the speech recognition is more likely to recognize them. This can be used - # to improve the accuracy for specific words and phrases, for example, if - # specific commands are typically spoken by the user. This can also be used - # to add additional words to the vocabulary of the recognizer. See - # [usage limits](https://cloud.google.com/speech/limits#content). + # Optional. A list of strings containing words and phrases "hints" so that the + # speech recognition is more likely to recognize them. This can be used to + # improve the accuracy for specific words and phrases, for example, if specific + # commands are typically spoken by the user. This can also be used to add + # additional words to the vocabulary of the recognizer. See [usage limits](https: + # //cloud.google.com/speech/limits#content). # Corresponds to the JSON property `phrases` # @return [Array] attr_accessor :phrases @@ -1774,10 +1721,10 @@ module Google # Output only. The confidence estimate between 0.0 and 1.0. A higher number # indicates an estimated greater likelihood that the recognized words are - # correct. This field is set only for the top alternative. - # This field is not guaranteed to be accurate and users should not rely on it - # to be always provided. - # The default of 0.0 is a sentinel value indicating `confidence` was not set. + # correct. This field is set only for the top alternative. This field is not + # guaranteed to be accurate and users should not rely on it to be always + # provided. The default of 0.0 is a sentinel value indicating `confidence` was + # not set. # Corresponds to the JSON property `confidence` # @return [Float] attr_accessor :confidence @@ -1788,8 +1735,8 @@ module Google attr_accessor :transcript # Output only. A list of word-specific information for each recognized word. - # Note: When `enable_speaker_diarization` is set to true, you will see all - # the words from the beginning of the audio. + # Note: When `enable_speaker_diarization` is set to true, you will see all the + # words from the beginning of the audio. # Corresponds to the JSON property `words` # @return [Array] attr_accessor :words @@ -1810,18 +1757,17 @@ module Google class GoogleCloudVideointelligenceV1beta2SpeechTranscription include Google::Apis::Core::Hashable - # May contain one or more recognition hypotheses (up to the maximum specified - # in `max_alternatives`). These alternatives are ordered in terms of - # accuracy, with the top (first) alternative being the most probable, as - # ranked by the recognizer. + # May contain one or more recognition hypotheses (up to the maximum specified in + # `max_alternatives`). These alternatives are ordered in terms of accuracy, with + # the top (first) alternative being the most probable, as ranked by the + # recognizer. # Corresponds to the JSON property `alternatives` # @return [Array] attr_accessor :alternatives # Output only. The [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) - # language tag of - # the language in this result. This language code was detected to have the - # most likelihood of being spoken in the audio. + # language tag of the language in this result. This language code was detected + # to have the most likelihood of being spoken in the audio. # Corresponds to the JSON property `languageCode` # @return [String] attr_accessor :language_code @@ -1848,66 +1794,62 @@ module Google attr_accessor :audio_tracks # Optional. If set, specifies the estimated number of speakers in the - # conversation. - # If not set, defaults to '2'. - # Ignored unless enable_speaker_diarization is set to true. + # conversation. If not set, defaults to '2'. Ignored unless + # enable_speaker_diarization is set to true. # Corresponds to the JSON property `diarizationSpeakerCount` # @return [Fixnum] attr_accessor :diarization_speaker_count - # Optional. If 'true', adds punctuation to recognition result hypotheses. - # This feature is only available in select languages. Setting this for - # requests in other languages has no effect at all. The default 'false' value - # does not add punctuation to result hypotheses. NOTE: "This is currently - # offered as an experimental service, complimentary to all users. In the - # future this may be exclusively available as a premium feature." + # Optional. If 'true', adds punctuation to recognition result hypotheses. This + # feature is only available in select languages. Setting this for requests in + # other languages has no effect at all. The default 'false' value does not add + # punctuation to result hypotheses. NOTE: "This is currently offered as an + # experimental service, complimentary to all users. In the future this may be + # exclusively available as a premium feature." # Corresponds to the JSON property `enableAutomaticPunctuation` # @return [Boolean] attr_accessor :enable_automatic_punctuation alias_method :enable_automatic_punctuation?, :enable_automatic_punctuation - # Optional. If 'true', enables speaker detection for each recognized word in - # the top alternative of the recognition result using a speaker_tag provided - # in the WordInfo. - # Note: When this is true, we send all the words from the beginning of the - # audio for the top alternative in every consecutive response. - # This is done in order to improve our speaker tags as our models learn to - # identify the speakers in the conversation over time. + # Optional. If 'true', enables speaker detection for each recognized word in the + # top alternative of the recognition result using a speaker_tag provided in the + # WordInfo. Note: When this is true, we send all the words from the beginning of + # the audio for the top alternative in every consecutive response. This is done + # in order to improve our speaker tags as our models learn to identify the + # speakers in the conversation over time. # Corresponds to the JSON property `enableSpeakerDiarization` # @return [Boolean] attr_accessor :enable_speaker_diarization alias_method :enable_speaker_diarization?, :enable_speaker_diarization # Optional. If `true`, the top result includes a list of words and the - # confidence for those words. If `false`, no word-level confidence - # information is returned. The default is `false`. + # confidence for those words. If `false`, no word-level confidence information + # is returned. The default is `false`. # Corresponds to the JSON property `enableWordConfidence` # @return [Boolean] attr_accessor :enable_word_confidence alias_method :enable_word_confidence?, :enable_word_confidence - # Optional. If set to `true`, the server will attempt to filter out - # profanities, replacing all but the initial character in each filtered word - # with asterisks, e.g. "f***". If set to `false` or omitted, profanities - # won't be filtered out. + # Optional. If set to `true`, the server will attempt to filter out profanities, + # replacing all but the initial character in each filtered word with asterisks, + # e.g. "f***". If set to `false` or omitted, profanities won't be filtered out. # Corresponds to the JSON property `filterProfanity` # @return [Boolean] attr_accessor :filter_profanity alias_method :filter_profanity?, :filter_profanity - # Required. *Required* The language of the supplied audio as a - # [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) language tag. - # Example: "en-US". - # See [Language Support](https://cloud.google.com/speech/docs/languages) - # for a list of the currently supported language codes. + # Required. *Required* The language of the supplied audio as a [BCP-47](https:// + # www.rfc-editor.org/rfc/bcp/bcp47.txt) language tag. Example: "en-US". See [ + # Language Support](https://cloud.google.com/speech/docs/languages) for a list + # of the currently supported language codes. # Corresponds to the JSON property `languageCode` # @return [String] attr_accessor :language_code # Optional. Maximum number of recognition hypotheses to be returned. # Specifically, the maximum number of `SpeechRecognitionAlternative` messages - # within each `SpeechTranscription`. The server may return fewer than - # `max_alternatives`. Valid values are `0`-`30`. A value of `0` or `1` will + # within each `SpeechTranscription`. The server may return fewer than ` + # max_alternatives`. Valid values are `0`-`30`. A value of `0` or `1` will # return a maximum of one. If omitted, will return a maximum of one. # Corresponds to the JSON property `maxAlternatives` # @return [Fixnum] @@ -1974,16 +1916,15 @@ module Google include Google::Apis::Core::Hashable # Language hint can be specified if the language to be detected is known a - # priori. It can increase the accuracy of the detection. Language hint must - # be language code in BCP-47 format. - # Automatic language detection is performed if no hint is provided. + # priori. It can increase the accuracy of the detection. Language hint must be + # language code in BCP-47 format. Automatic language detection is performed if + # no hint is provided. # Corresponds to the JSON property `languageHints` # @return [Array] attr_accessor :language_hints - # Model to use for text detection. - # Supported values: "builtin/stable" (the default if unset) and - # "builtin/latest". + # Model to use for text detection. Supported values: "builtin/stable" (the + # default if unset) and "builtin/latest". # Corresponds to the JSON property `model` # @return [String] attr_accessor :model @@ -1999,27 +1940,19 @@ module Google end end - # Video frame level annotation results for text annotation (OCR). - # Contains information regarding timestamp and bounding box locations for the - # frames containing detected OCR text snippets. + # Video frame level annotation results for text annotation (OCR). Contains + # information regarding timestamp and bounding box locations for the frames + # containing detected OCR text snippets. class GoogleCloudVideointelligenceV1beta2TextFrame include Google::Apis::Core::Hashable # Normalized bounding polygon for text (that might not be aligned with axis). - # Contains list of the corner points in clockwise order starting from - # top-left corner. For example, for a rectangular bounding box: - # When the text is horizontal it might look like: - # 0----1 - # | | - # 3----2 - # When it's clockwise rotated 180 degrees around the top-left corner it - # becomes: - # 2----3 - # | | - # 1----0 - # and the vertex order will still be (0, 1, 2, 3). Note that values can be less - # than 0, or greater than 1 due to trignometric calculations for location of - # the box. + # Contains list of the corner points in clockwise order starting from top-left + # corner. For example, for a rectangular bounding box: When the text is + # horizontal it might look like: 0----1 | | 3----2 When it's clockwise rotated + # 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the + # vertex order will still be (0, 1, 2, 3). Note that values can be less than 0, + # or greater than 1 due to trignometric calculations for location of the box. # Corresponds to the JSON property `rotatedBoundingBox` # @return [Google::Apis::VideointelligenceV1beta2::GoogleCloudVideointelligenceV1beta2NormalizedBoundingPoly] attr_accessor :rotated_bounding_box @@ -2072,9 +2005,8 @@ module Google end end - # For tracking related features. - # An object at time_offset with attributes, and located with - # normalized_bounding_box. + # For tracking related features. An object at time_offset with attributes, and + # located with normalized_bounding_box. class GoogleCloudVideointelligenceV1beta2TimestampedObject include Google::Apis::Core::Hashable @@ -2088,15 +2020,14 @@ module Google # @return [Array] attr_accessor :landmarks - # Normalized bounding box. - # The normalized vertex coordinates are relative to the original image. - # Range: [0, 1]. + # Normalized bounding box. The normalized vertex coordinates are relative to the + # original image. Range: [0, 1]. # Corresponds to the JSON property `normalizedBoundingBox` # @return [Google::Apis::VideointelligenceV1beta2::GoogleCloudVideointelligenceV1beta2NormalizedBoundingBox] attr_accessor :normalized_bounding_box - # Time-offset, relative to the beginning of the video, - # corresponding to the video frame for this object. + # Time-offset, relative to the beginning of the video, corresponding to the + # video frame for this object. # Corresponds to the JSON property `timeOffset` # @return [String] attr_accessor :time_offset @@ -2155,20 +2086,19 @@ module Google class GoogleCloudVideointelligenceV1beta2VideoAnnotationProgress include Google::Apis::Core::Hashable - # Specifies which feature is being tracked if the request contains more than - # one feature. + # Specifies which feature is being tracked if the request contains more than one + # feature. # Corresponds to the JSON property `feature` # @return [String] attr_accessor :feature - # Video file location in - # [Cloud Storage](https://cloud.google.com/storage/). + # Video file location in [Cloud Storage](https://cloud.google.com/storage/). # Corresponds to the JSON property `inputUri` # @return [String] attr_accessor :input_uri - # Approximate percentage processed thus far. Guaranteed to be - # 100 when fully processed. + # Approximate percentage processed thus far. Guaranteed to be 100 when fully + # processed. # Corresponds to the JSON property `progressPercent` # @return [Fixnum] attr_accessor :progress_percent @@ -2207,31 +2137,30 @@ module Google class GoogleCloudVideointelligenceV1beta2VideoAnnotationResults include Google::Apis::Core::Hashable - # 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::VideointelligenceV1beta2::GoogleRpcStatus] attr_accessor :error - # Explicit content annotation (based on per-frame visual signals only). - # If no explicit content has been detected in a frame, no annotations are - # present for that frame. + # Explicit content annotation (based on per-frame visual signals only). If no + # explicit content has been detected in a frame, no annotations are present for + # that frame. # Corresponds to the JSON property `explicitAnnotation` # @return [Google::Apis::VideointelligenceV1beta2::GoogleCloudVideointelligenceV1beta2ExplicitContentAnnotation] attr_accessor :explicit_annotation - # Label annotations on frame level. - # There is exactly one element for each unique label. + # Label annotations on frame level. There is exactly one element for each unique + # label. # Corresponds to the JSON property `frameLabelAnnotations` # @return [Array] attr_accessor :frame_label_annotations - # Video file location in - # [Cloud Storage](https://cloud.google.com/storage/). + # Video file location in [Cloud Storage](https://cloud.google.com/storage/). # Corresponds to the JSON property `inputUri` # @return [String] attr_accessor :input_uri @@ -2258,11 +2187,11 @@ module Google attr_accessor :segment_label_annotations # Presence label annotations on video level or user-specified segment level. - # There is exactly one element for each unique label. Compared to the - # existing topical `segment_label_annotations`, this field presents more - # fine-grained, segment-level labels detected in video content and is made - # available only when the client sets `LabelDetectionConfig.model` to - # "builtin/latest" in the request. + # There is exactly one element for each unique label. Compared to the existing + # topical `segment_label_annotations`, this field presents more fine-grained, + # segment-level labels detected in video content and is made available only when + # the client sets `LabelDetectionConfig.model` to "builtin/latest" in the + # request. # Corresponds to the JSON property `segmentPresenceLabelAnnotations` # @return [Array] attr_accessor :segment_presence_label_annotations @@ -2272,17 +2201,17 @@ module Google # @return [Array] attr_accessor :shot_annotations - # Topical label annotations on shot level. - # There is exactly one element for each unique label. + # Topical label annotations on shot level. There is exactly one element for each + # unique label. # Corresponds to the JSON property `shotLabelAnnotations` # @return [Array] attr_accessor :shot_label_annotations # Presence label annotations on shot level. There is exactly one element for - # each unique label. Compared to the existing topical - # `shot_label_annotations`, this field presents more fine-grained, shot-level - # labels detected in video content and is made available only when the client - # sets `LabelDetectionConfig.model` to "builtin/latest" in the request. + # each unique label. Compared to the existing topical `shot_label_annotations`, + # this field presents more fine-grained, shot-level labels detected in video + # content and is made available only when the client sets `LabelDetectionConfig. + # model` to "builtin/latest" in the request. # Corresponds to the JSON property `shotPresenceLabelAnnotations` # @return [Array] attr_accessor :shot_presence_label_annotations @@ -2292,9 +2221,8 @@ module Google # @return [Array] attr_accessor :speech_transcriptions - # OCR text detection and tracking. - # Annotations for list of detected text snippets. Each will have list of - # frame information associated with it. + # OCR text detection and tracking. Annotations for list of detected text + # snippets. Each will have list of frame information associated with it. # Corresponds to the JSON property `textAnnotations` # @return [Array] attr_accessor :text_annotations @@ -2341,9 +2269,9 @@ module Google # @return [Google::Apis::VideointelligenceV1beta2::GoogleCloudVideointelligenceV1beta2ObjectTrackingConfig] attr_accessor :object_tracking_config - # Video segments to annotate. The segments may overlap and are not required - # to be contiguous or span the whole video. If unspecified, each video is - # treated as a single segment. + # Video segments to annotate. The segments may overlap and are not required to + # be contiguous or span the whole video. If unspecified, each video is treated + # as a single segment. # Corresponds to the JSON property `segments` # @return [Array] attr_accessor :segments @@ -2383,14 +2311,14 @@ module Google class GoogleCloudVideointelligenceV1beta2VideoSegment include Google::Apis::Core::Hashable - # Time-offset, relative to the beginning of the video, - # corresponding to the end of the segment (inclusive). + # Time-offset, relative to the beginning of the video, corresponding to the end + # of the segment (inclusive). # Corresponds to the JSON property `endTimeOffset` # @return [String] attr_accessor :end_time_offset - # Time-offset, relative to the beginning of the video, - # corresponding to the start of the segment (inclusive). + # Time-offset, relative to the beginning of the video, corresponding to the + # start of the segment (inclusive). # Corresponds to the JSON property `startTimeOffset` # @return [String] attr_accessor :start_time_offset @@ -2407,41 +2335,41 @@ module Google end # Word-specific information for recognized words. Word information is only - # included in the response when certain request parameters are set, such - # as `enable_word_time_offsets`. + # included in the response when certain request parameters are set, such as ` + # enable_word_time_offsets`. class GoogleCloudVideointelligenceV1beta2WordInfo include Google::Apis::Core::Hashable # Output only. The confidence estimate between 0.0 and 1.0. A higher number # indicates an estimated greater likelihood that the recognized words are - # correct. This field is set only for the top alternative. - # This field is not guaranteed to be accurate and users should not rely on it - # to be always provided. - # The default of 0.0 is a sentinel value indicating `confidence` was not set. + # correct. This field is set only for the top alternative. This field is not + # guaranteed to be accurate and users should not rely on it to be always + # provided. The default of 0.0 is a sentinel value indicating `confidence` was + # not set. # Corresponds to the JSON property `confidence` # @return [Float] attr_accessor :confidence - # Time offset relative to the beginning of the audio, and - # corresponding to the end of the spoken word. This field is only set if - # `enable_word_time_offsets=true` and only in the top hypothesis. This is an - # experimental feature and the accuracy of the time offset can vary. + # Time offset relative to the beginning of the audio, and corresponding to the + # end of the spoken word. This field is only set if `enable_word_time_offsets= + # true` and only in the top hypothesis. This is an experimental feature and the + # accuracy of the time offset can vary. # Corresponds to the JSON property `endTime` # @return [String] attr_accessor :end_time - # Output only. A distinct integer value is assigned for every speaker within - # the audio. This field specifies which one of those speakers was detected to - # have spoken this word. Value ranges from 1 up to diarization_speaker_count, - # and is only set if speaker diarization is enabled. + # Output only. A distinct integer value is assigned for every speaker within the + # audio. This field specifies which one of those speakers was detected to have + # spoken this word. Value ranges from 1 up to diarization_speaker_count, and is + # only set if speaker diarization is enabled. # Corresponds to the JSON property `speakerTag` # @return [Fixnum] attr_accessor :speaker_tag - # Time offset relative to the beginning of the audio, and - # corresponding to the start of the spoken word. This field is only set if - # `enable_word_time_offsets=true` and only in the top hypothesis. This is an - # experimental feature and the accuracy of the time offset can vary. + # Time offset relative to the beginning of the audio, and corresponding to the + # start of the spoken word. This field is only set if `enable_word_time_offsets= + # true` and only in the top hypothesis. This is an experimental feature and the + # accuracy of the time offset can vary. # Corresponds to the JSON property `startTime` # @return [String] attr_accessor :start_time @@ -2465,9 +2393,9 @@ module Google end end - # Video annotation progress. Included in the `metadata` - # field of the `Operation` returned by the `GetOperation` - # call of the `google::longrunning::Operations` service. + # Video annotation progress. Included in the `metadata` field of the `Operation` + # returned by the `GetOperation` call of the `google::longrunning::Operations` + # service. class GoogleCloudVideointelligenceV1p1beta1AnnotateVideoProgress include Google::Apis::Core::Hashable @@ -2486,9 +2414,9 @@ module Google end end - # Video annotation response. Included in the `response` - # field of the `Operation` returned by the `GetOperation` - # call of the `google::longrunning::Operations` service. + # Video annotation response. Included in the `response` field of the `Operation` + # returned by the `GetOperation` call of the `google::longrunning::Operations` + # service. class GoogleCloudVideointelligenceV1p1beta1AnnotateVideoResponse include Google::Apis::Core::Hashable @@ -2516,14 +2444,14 @@ module Google # @return [Float] attr_accessor :confidence - # The name of the attribute, for example, glasses, dark_glasses, mouth_open. - # A full list of supported type names will be provided in the document. + # The name of the attribute, for example, glasses, dark_glasses, mouth_open. A + # full list of supported type names will be provided in the document. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name - # Text value of the detection result. For example, the value for "HairColor" - # can be "black", "blonde", etc. + # Text value of the detection result. For example, the value for "HairColor" can + # be "black", "blonde", etc. # Corresponds to the JSON property `value` # @return [String] attr_accessor :value @@ -2555,9 +2483,8 @@ module Google # @return [String] attr_accessor :name - # A vertex represents a 2D point in the image. - # NOTE: the normalized vertex coordinates are relative to the original image - # and range from 0 to 1. + # A vertex represents a 2D point in the image. NOTE: the normalized vertex + # coordinates are relative to the original image and range from 0 to 1. # Corresponds to the JSON property `point` # @return [Google::Apis::VideointelligenceV1beta2::GoogleCloudVideointelligenceV1p1beta1NormalizedVertex] attr_accessor :point @@ -2583,8 +2510,7 @@ module Google # @return [String] attr_accessor :description - # Opaque entity ID. Some IDs may be available in - # [Google Knowledge Graph Search + # Opaque entity ID. Some IDs may be available in [Google Knowledge Graph Search # API](https://developers.google.com/knowledge-graph/). # Corresponds to the JSON property `entityId` # @return [String] @@ -2607,9 +2533,9 @@ module Google end end - # Explicit content annotation (based on per-frame visual signals only). - # If no explicit content has been detected in a frame, no annotations are - # present for that frame. + # Explicit content annotation (based on per-frame visual signals only). If no + # explicit content has been detected in a frame, no annotations are present for + # that frame. class GoogleCloudVideointelligenceV1p1beta1ExplicitContentAnnotation include Google::Apis::Core::Hashable @@ -2664,10 +2590,9 @@ module Google class GoogleCloudVideointelligenceV1p1beta1LabelAnnotation include Google::Apis::Core::Hashable - # Common categories for the detected entity. - # For example, when the label is `Terrier`, the category is likely `dog`. And - # in some cases there might be more than one categories e.g., `Terrier` could - # also be a `pet`. + # Common categories for the detected entity. For example, when the label is ` + # Terrier`, the category is likely `dog`. And in some cases there might be more + # than one categories e.g., `Terrier` could also be a `pet`. # Corresponds to the JSON property `categoryEntities` # @return [Array] attr_accessor :category_entities @@ -2766,14 +2691,14 @@ module Google # @return [Google::Apis::VideointelligenceV1beta2::GoogleCloudVideointelligenceV1p1beta1Entity] attr_accessor :entity - # All video segments where the recognized logo appears. There might be - # multiple instances of the same logo class appearing in one VideoSegment. + # All video segments where the recognized logo appears. There might be multiple + # instances of the same logo class appearing in one VideoSegment. # Corresponds to the JSON property `segments` # @return [Array] attr_accessor :segments - # All logo tracks where the recognized logo appears. Each track corresponds - # to one logo instance appearing in consecutive frames. + # All logo tracks where the recognized logo appears. Each track corresponds to + # one logo instance appearing in consecutive frames. # Corresponds to the JSON property `tracks` # @return [Array] attr_accessor :tracks @@ -2790,9 +2715,8 @@ module Google end end - # Normalized bounding box. - # The normalized vertex coordinates are relative to the original image. - # Range: [0, 1]. + # Normalized bounding box. The normalized vertex coordinates are relative to the + # original image. Range: [0, 1]. class GoogleCloudVideointelligenceV1p1beta1NormalizedBoundingBox include Google::Apis::Core::Hashable @@ -2830,20 +2754,12 @@ module Google end # Normalized bounding polygon for text (that might not be aligned with axis). - # Contains list of the corner points in clockwise order starting from - # top-left corner. For example, for a rectangular bounding box: - # When the text is horizontal it might look like: - # 0----1 - # | | - # 3----2 - # When it's clockwise rotated 180 degrees around the top-left corner it - # becomes: - # 2----3 - # | | - # 1----0 - # and the vertex order will still be (0, 1, 2, 3). Note that values can be less - # than 0, or greater than 1 due to trignometric calculations for location of - # the box. + # Contains list of the corner points in clockwise order starting from top-left + # corner. For example, for a rectangular bounding box: When the text is + # horizontal it might look like: 0----1 | | 3----2 When it's clockwise rotated + # 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the + # vertex order will still be (0, 1, 2, 3). Note that values can be less than 0, + # or greater than 1 due to trignometric calculations for location of the box. class GoogleCloudVideointelligenceV1p1beta1NormalizedBoundingPoly include Google::Apis::Core::Hashable @@ -2862,9 +2778,8 @@ module Google end end - # A vertex represents a 2D point in the image. - # NOTE: the normalized vertex coordinates are relative to the original image - # and range from 0 to 1. + # A vertex represents a 2D point in the image. NOTE: the normalized vertex + # coordinates are relative to the original image and range from 0 to 1. class GoogleCloudVideointelligenceV1p1beta1NormalizedVertex include Google::Apis::Core::Hashable @@ -2903,10 +2818,10 @@ module Google # @return [Google::Apis::VideointelligenceV1beta2::GoogleCloudVideointelligenceV1p1beta1Entity] attr_accessor :entity - # Information corresponding to all frames where this object track appears. - # Non-streaming batch mode: it may be one or multiple ObjectTrackingFrame - # messages in frames. - # Streaming mode: it can only be one ObjectTrackingFrame message in frames. + # Information corresponding to all frames where this object track appears. Non- + # streaming batch mode: it may be one or multiple ObjectTrackingFrame messages + # in frames. Streaming mode: it can only be one ObjectTrackingFrame message in + # frames. # Corresponds to the JSON property `frames` # @return [Array] attr_accessor :frames @@ -2916,12 +2831,11 @@ module Google # @return [Google::Apis::VideointelligenceV1beta2::GoogleCloudVideointelligenceV1p1beta1VideoSegment] attr_accessor :segment - # Streaming mode ONLY. - # In streaming mode, we do not know the end time of a tracked object - # before it is completed. Hence, there is no VideoSegment info returned. - # Instead, we provide a unique identifiable integer track_id so that - # the customers can correlate the results of the ongoing - # ObjectTrackAnnotation of the same track_id over time. + # Streaming mode ONLY. In streaming mode, we do not know the end time of a + # tracked object before it is completed. Hence, there is no VideoSegment info + # returned. Instead, we provide a unique identifiable integer track_id so that + # the customers can correlate the results of the ongoing ObjectTrackAnnotation + # of the same track_id over time. # Corresponds to the JSON property `trackId` # @return [Fixnum] attr_accessor :track_id @@ -2951,9 +2865,8 @@ module Google class GoogleCloudVideointelligenceV1p1beta1ObjectTrackingFrame include Google::Apis::Core::Hashable - # Normalized bounding box. - # The normalized vertex coordinates are relative to the original image. - # Range: [0, 1]. + # Normalized bounding box. The normalized vertex coordinates are relative to the + # original image. Range: [0, 1]. # Corresponds to the JSON property `normalizedBoundingBox` # @return [Google::Apis::VideointelligenceV1beta2::GoogleCloudVideointelligenceV1p1beta1NormalizedBoundingBox] attr_accessor :normalized_bounding_box @@ -2980,10 +2893,10 @@ module Google # Output only. The confidence estimate between 0.0 and 1.0. A higher number # indicates an estimated greater likelihood that the recognized words are - # correct. This field is set only for the top alternative. - # This field is not guaranteed to be accurate and users should not rely on it - # to be always provided. - # The default of 0.0 is a sentinel value indicating `confidence` was not set. + # correct. This field is set only for the top alternative. This field is not + # guaranteed to be accurate and users should not rely on it to be always + # provided. The default of 0.0 is a sentinel value indicating `confidence` was + # not set. # Corresponds to the JSON property `confidence` # @return [Float] attr_accessor :confidence @@ -2994,8 +2907,8 @@ module Google attr_accessor :transcript # Output only. A list of word-specific information for each recognized word. - # Note: When `enable_speaker_diarization` is set to true, you will see all - # the words from the beginning of the audio. + # Note: When `enable_speaker_diarization` is set to true, you will see all the + # words from the beginning of the audio. # Corresponds to the JSON property `words` # @return [Array] attr_accessor :words @@ -3016,18 +2929,17 @@ module Google class GoogleCloudVideointelligenceV1p1beta1SpeechTranscription include Google::Apis::Core::Hashable - # May contain one or more recognition hypotheses (up to the maximum specified - # in `max_alternatives`). These alternatives are ordered in terms of - # accuracy, with the top (first) alternative being the most probable, as - # ranked by the recognizer. + # May contain one or more recognition hypotheses (up to the maximum specified in + # `max_alternatives`). These alternatives are ordered in terms of accuracy, with + # the top (first) alternative being the most probable, as ranked by the + # recognizer. # Corresponds to the JSON property `alternatives` # @return [Array] attr_accessor :alternatives # Output only. The [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) - # language tag of - # the language in this result. This language code was detected to have the - # most likelihood of being spoken in the audio. + # language tag of the language in this result. This language code was detected + # to have the most likelihood of being spoken in the audio. # Corresponds to the JSON property `languageCode` # @return [String] attr_accessor :language_code @@ -3076,27 +2988,19 @@ module Google end end - # Video frame level annotation results for text annotation (OCR). - # Contains information regarding timestamp and bounding box locations for the - # frames containing detected OCR text snippets. + # Video frame level annotation results for text annotation (OCR). Contains + # information regarding timestamp and bounding box locations for the frames + # containing detected OCR text snippets. class GoogleCloudVideointelligenceV1p1beta1TextFrame include Google::Apis::Core::Hashable # Normalized bounding polygon for text (that might not be aligned with axis). - # Contains list of the corner points in clockwise order starting from - # top-left corner. For example, for a rectangular bounding box: - # When the text is horizontal it might look like: - # 0----1 - # | | - # 3----2 - # When it's clockwise rotated 180 degrees around the top-left corner it - # becomes: - # 2----3 - # | | - # 1----0 - # and the vertex order will still be (0, 1, 2, 3). Note that values can be less - # than 0, or greater than 1 due to trignometric calculations for location of - # the box. + # Contains list of the corner points in clockwise order starting from top-left + # corner. For example, for a rectangular bounding box: When the text is + # horizontal it might look like: 0----1 | | 3----2 When it's clockwise rotated + # 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the + # vertex order will still be (0, 1, 2, 3). Note that values can be less than 0, + # or greater than 1 due to trignometric calculations for location of the box. # Corresponds to the JSON property `rotatedBoundingBox` # @return [Google::Apis::VideointelligenceV1beta2::GoogleCloudVideointelligenceV1p1beta1NormalizedBoundingPoly] attr_accessor :rotated_bounding_box @@ -3149,9 +3053,8 @@ module Google end end - # For tracking related features. - # An object at time_offset with attributes, and located with - # normalized_bounding_box. + # For tracking related features. An object at time_offset with attributes, and + # located with normalized_bounding_box. class GoogleCloudVideointelligenceV1p1beta1TimestampedObject include Google::Apis::Core::Hashable @@ -3165,15 +3068,14 @@ module Google # @return [Array] attr_accessor :landmarks - # Normalized bounding box. - # The normalized vertex coordinates are relative to the original image. - # Range: [0, 1]. + # Normalized bounding box. The normalized vertex coordinates are relative to the + # original image. Range: [0, 1]. # Corresponds to the JSON property `normalizedBoundingBox` # @return [Google::Apis::VideointelligenceV1beta2::GoogleCloudVideointelligenceV1p1beta1NormalizedBoundingBox] attr_accessor :normalized_bounding_box - # Time-offset, relative to the beginning of the video, - # corresponding to the video frame for this object. + # Time-offset, relative to the beginning of the video, corresponding to the + # video frame for this object. # Corresponds to the JSON property `timeOffset` # @return [String] attr_accessor :time_offset @@ -3232,20 +3134,19 @@ module Google class GoogleCloudVideointelligenceV1p1beta1VideoAnnotationProgress include Google::Apis::Core::Hashable - # Specifies which feature is being tracked if the request contains more than - # one feature. + # Specifies which feature is being tracked if the request contains more than one + # feature. # Corresponds to the JSON property `feature` # @return [String] attr_accessor :feature - # Video file location in - # [Cloud Storage](https://cloud.google.com/storage/). + # Video file location in [Cloud Storage](https://cloud.google.com/storage/). # Corresponds to the JSON property `inputUri` # @return [String] attr_accessor :input_uri - # Approximate percentage processed thus far. Guaranteed to be - # 100 when fully processed. + # Approximate percentage processed thus far. Guaranteed to be 100 when fully + # processed. # Corresponds to the JSON property `progressPercent` # @return [Fixnum] attr_accessor :progress_percent @@ -3284,31 +3185,30 @@ module Google class GoogleCloudVideointelligenceV1p1beta1VideoAnnotationResults include Google::Apis::Core::Hashable - # 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::VideointelligenceV1beta2::GoogleRpcStatus] attr_accessor :error - # Explicit content annotation (based on per-frame visual signals only). - # If no explicit content has been detected in a frame, no annotations are - # present for that frame. + # Explicit content annotation (based on per-frame visual signals only). If no + # explicit content has been detected in a frame, no annotations are present for + # that frame. # Corresponds to the JSON property `explicitAnnotation` # @return [Google::Apis::VideointelligenceV1beta2::GoogleCloudVideointelligenceV1p1beta1ExplicitContentAnnotation] attr_accessor :explicit_annotation - # Label annotations on frame level. - # There is exactly one element for each unique label. + # Label annotations on frame level. There is exactly one element for each unique + # label. # Corresponds to the JSON property `frameLabelAnnotations` # @return [Array] attr_accessor :frame_label_annotations - # Video file location in - # [Cloud Storage](https://cloud.google.com/storage/). + # Video file location in [Cloud Storage](https://cloud.google.com/storage/). # Corresponds to the JSON property `inputUri` # @return [String] attr_accessor :input_uri @@ -3335,11 +3235,11 @@ module Google attr_accessor :segment_label_annotations # Presence label annotations on video level or user-specified segment level. - # There is exactly one element for each unique label. Compared to the - # existing topical `segment_label_annotations`, this field presents more - # fine-grained, segment-level labels detected in video content and is made - # available only when the client sets `LabelDetectionConfig.model` to - # "builtin/latest" in the request. + # There is exactly one element for each unique label. Compared to the existing + # topical `segment_label_annotations`, this field presents more fine-grained, + # segment-level labels detected in video content and is made available only when + # the client sets `LabelDetectionConfig.model` to "builtin/latest" in the + # request. # Corresponds to the JSON property `segmentPresenceLabelAnnotations` # @return [Array] attr_accessor :segment_presence_label_annotations @@ -3349,17 +3249,17 @@ module Google # @return [Array] attr_accessor :shot_annotations - # Topical label annotations on shot level. - # There is exactly one element for each unique label. + # Topical label annotations on shot level. There is exactly one element for each + # unique label. # Corresponds to the JSON property `shotLabelAnnotations` # @return [Array] attr_accessor :shot_label_annotations # Presence label annotations on shot level. There is exactly one element for - # each unique label. Compared to the existing topical - # `shot_label_annotations`, this field presents more fine-grained, shot-level - # labels detected in video content and is made available only when the client - # sets `LabelDetectionConfig.model` to "builtin/latest" in the request. + # each unique label. Compared to the existing topical `shot_label_annotations`, + # this field presents more fine-grained, shot-level labels detected in video + # content and is made available only when the client sets `LabelDetectionConfig. + # model` to "builtin/latest" in the request. # Corresponds to the JSON property `shotPresenceLabelAnnotations` # @return [Array] attr_accessor :shot_presence_label_annotations @@ -3369,9 +3269,8 @@ module Google # @return [Array] attr_accessor :speech_transcriptions - # OCR text detection and tracking. - # Annotations for list of detected text snippets. Each will have list of - # frame information associated with it. + # OCR text detection and tracking. Annotations for list of detected text + # snippets. Each will have list of frame information associated with it. # Corresponds to the JSON property `textAnnotations` # @return [Array] attr_accessor :text_annotations @@ -3403,14 +3302,14 @@ module Google class GoogleCloudVideointelligenceV1p1beta1VideoSegment include Google::Apis::Core::Hashable - # Time-offset, relative to the beginning of the video, - # corresponding to the end of the segment (inclusive). + # Time-offset, relative to the beginning of the video, corresponding to the end + # of the segment (inclusive). # Corresponds to the JSON property `endTimeOffset` # @return [String] attr_accessor :end_time_offset - # Time-offset, relative to the beginning of the video, - # corresponding to the start of the segment (inclusive). + # Time-offset, relative to the beginning of the video, corresponding to the + # start of the segment (inclusive). # Corresponds to the JSON property `startTimeOffset` # @return [String] attr_accessor :start_time_offset @@ -3427,41 +3326,41 @@ module Google end # Word-specific information for recognized words. Word information is only - # included in the response when certain request parameters are set, such - # as `enable_word_time_offsets`. + # included in the response when certain request parameters are set, such as ` + # enable_word_time_offsets`. class GoogleCloudVideointelligenceV1p1beta1WordInfo include Google::Apis::Core::Hashable # Output only. The confidence estimate between 0.0 and 1.0. A higher number # indicates an estimated greater likelihood that the recognized words are - # correct. This field is set only for the top alternative. - # This field is not guaranteed to be accurate and users should not rely on it - # to be always provided. - # The default of 0.0 is a sentinel value indicating `confidence` was not set. + # correct. This field is set only for the top alternative. This field is not + # guaranteed to be accurate and users should not rely on it to be always + # provided. The default of 0.0 is a sentinel value indicating `confidence` was + # not set. # Corresponds to the JSON property `confidence` # @return [Float] attr_accessor :confidence - # Time offset relative to the beginning of the audio, and - # corresponding to the end of the spoken word. This field is only set if - # `enable_word_time_offsets=true` and only in the top hypothesis. This is an - # experimental feature and the accuracy of the time offset can vary. + # Time offset relative to the beginning of the audio, and corresponding to the + # end of the spoken word. This field is only set if `enable_word_time_offsets= + # true` and only in the top hypothesis. This is an experimental feature and the + # accuracy of the time offset can vary. # Corresponds to the JSON property `endTime` # @return [String] attr_accessor :end_time - # Output only. A distinct integer value is assigned for every speaker within - # the audio. This field specifies which one of those speakers was detected to - # have spoken this word. Value ranges from 1 up to diarization_speaker_count, - # and is only set if speaker diarization is enabled. + # Output only. A distinct integer value is assigned for every speaker within the + # audio. This field specifies which one of those speakers was detected to have + # spoken this word. Value ranges from 1 up to diarization_speaker_count, and is + # only set if speaker diarization is enabled. # Corresponds to the JSON property `speakerTag` # @return [Fixnum] attr_accessor :speaker_tag - # Time offset relative to the beginning of the audio, and - # corresponding to the start of the spoken word. This field is only set if - # `enable_word_time_offsets=true` and only in the top hypothesis. This is an - # experimental feature and the accuracy of the time offset can vary. + # Time offset relative to the beginning of the audio, and corresponding to the + # start of the spoken word. This field is only set if `enable_word_time_offsets= + # true` and only in the top hypothesis. This is an experimental feature and the + # accuracy of the time offset can vary. # Corresponds to the JSON property `startTime` # @return [String] attr_accessor :start_time @@ -3485,9 +3384,9 @@ module Google end end - # Video annotation progress. Included in the `metadata` - # field of the `Operation` returned by the `GetOperation` - # call of the `google::longrunning::Operations` service. + # Video annotation progress. Included in the `metadata` field of the `Operation` + # returned by the `GetOperation` call of the `google::longrunning::Operations` + # service. class GoogleCloudVideointelligenceV1p2beta1AnnotateVideoProgress include Google::Apis::Core::Hashable @@ -3506,9 +3405,9 @@ module Google end end - # Video annotation response. Included in the `response` - # field of the `Operation` returned by the `GetOperation` - # call of the `google::longrunning::Operations` service. + # Video annotation response. Included in the `response` field of the `Operation` + # returned by the `GetOperation` call of the `google::longrunning::Operations` + # service. class GoogleCloudVideointelligenceV1p2beta1AnnotateVideoResponse include Google::Apis::Core::Hashable @@ -3536,14 +3435,14 @@ module Google # @return [Float] attr_accessor :confidence - # The name of the attribute, for example, glasses, dark_glasses, mouth_open. - # A full list of supported type names will be provided in the document. + # The name of the attribute, for example, glasses, dark_glasses, mouth_open. A + # full list of supported type names will be provided in the document. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name - # Text value of the detection result. For example, the value for "HairColor" - # can be "black", "blonde", etc. + # Text value of the detection result. For example, the value for "HairColor" can + # be "black", "blonde", etc. # Corresponds to the JSON property `value` # @return [String] attr_accessor :value @@ -3575,9 +3474,8 @@ module Google # @return [String] attr_accessor :name - # A vertex represents a 2D point in the image. - # NOTE: the normalized vertex coordinates are relative to the original image - # and range from 0 to 1. + # A vertex represents a 2D point in the image. NOTE: the normalized vertex + # coordinates are relative to the original image and range from 0 to 1. # Corresponds to the JSON property `point` # @return [Google::Apis::VideointelligenceV1beta2::GoogleCloudVideointelligenceV1p2beta1NormalizedVertex] attr_accessor :point @@ -3603,8 +3501,7 @@ module Google # @return [String] attr_accessor :description - # Opaque entity ID. Some IDs may be available in - # [Google Knowledge Graph Search + # Opaque entity ID. Some IDs may be available in [Google Knowledge Graph Search # API](https://developers.google.com/knowledge-graph/). # Corresponds to the JSON property `entityId` # @return [String] @@ -3627,9 +3524,9 @@ module Google end end - # Explicit content annotation (based on per-frame visual signals only). - # If no explicit content has been detected in a frame, no annotations are - # present for that frame. + # Explicit content annotation (based on per-frame visual signals only). If no + # explicit content has been detected in a frame, no annotations are present for + # that frame. class GoogleCloudVideointelligenceV1p2beta1ExplicitContentAnnotation include Google::Apis::Core::Hashable @@ -3684,10 +3581,9 @@ module Google class GoogleCloudVideointelligenceV1p2beta1LabelAnnotation include Google::Apis::Core::Hashable - # Common categories for the detected entity. - # For example, when the label is `Terrier`, the category is likely `dog`. And - # in some cases there might be more than one categories e.g., `Terrier` could - # also be a `pet`. + # Common categories for the detected entity. For example, when the label is ` + # Terrier`, the category is likely `dog`. And in some cases there might be more + # than one categories e.g., `Terrier` could also be a `pet`. # Corresponds to the JSON property `categoryEntities` # @return [Array] attr_accessor :category_entities @@ -3786,14 +3682,14 @@ module Google # @return [Google::Apis::VideointelligenceV1beta2::GoogleCloudVideointelligenceV1p2beta1Entity] attr_accessor :entity - # All video segments where the recognized logo appears. There might be - # multiple instances of the same logo class appearing in one VideoSegment. + # All video segments where the recognized logo appears. There might be multiple + # instances of the same logo class appearing in one VideoSegment. # Corresponds to the JSON property `segments` # @return [Array] attr_accessor :segments - # All logo tracks where the recognized logo appears. Each track corresponds - # to one logo instance appearing in consecutive frames. + # All logo tracks where the recognized logo appears. Each track corresponds to + # one logo instance appearing in consecutive frames. # Corresponds to the JSON property `tracks` # @return [Array] attr_accessor :tracks @@ -3810,9 +3706,8 @@ module Google end end - # Normalized bounding box. - # The normalized vertex coordinates are relative to the original image. - # Range: [0, 1]. + # Normalized bounding box. The normalized vertex coordinates are relative to the + # original image. Range: [0, 1]. class GoogleCloudVideointelligenceV1p2beta1NormalizedBoundingBox include Google::Apis::Core::Hashable @@ -3850,20 +3745,12 @@ module Google end # Normalized bounding polygon for text (that might not be aligned with axis). - # Contains list of the corner points in clockwise order starting from - # top-left corner. For example, for a rectangular bounding box: - # When the text is horizontal it might look like: - # 0----1 - # | | - # 3----2 - # When it's clockwise rotated 180 degrees around the top-left corner it - # becomes: - # 2----3 - # | | - # 1----0 - # and the vertex order will still be (0, 1, 2, 3). Note that values can be less - # than 0, or greater than 1 due to trignometric calculations for location of - # the box. + # Contains list of the corner points in clockwise order starting from top-left + # corner. For example, for a rectangular bounding box: When the text is + # horizontal it might look like: 0----1 | | 3----2 When it's clockwise rotated + # 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the + # vertex order will still be (0, 1, 2, 3). Note that values can be less than 0, + # or greater than 1 due to trignometric calculations for location of the box. class GoogleCloudVideointelligenceV1p2beta1NormalizedBoundingPoly include Google::Apis::Core::Hashable @@ -3882,9 +3769,8 @@ module Google end end - # A vertex represents a 2D point in the image. - # NOTE: the normalized vertex coordinates are relative to the original image - # and range from 0 to 1. + # A vertex represents a 2D point in the image. NOTE: the normalized vertex + # coordinates are relative to the original image and range from 0 to 1. class GoogleCloudVideointelligenceV1p2beta1NormalizedVertex include Google::Apis::Core::Hashable @@ -3923,10 +3809,10 @@ module Google # @return [Google::Apis::VideointelligenceV1beta2::GoogleCloudVideointelligenceV1p2beta1Entity] attr_accessor :entity - # Information corresponding to all frames where this object track appears. - # Non-streaming batch mode: it may be one or multiple ObjectTrackingFrame - # messages in frames. - # Streaming mode: it can only be one ObjectTrackingFrame message in frames. + # Information corresponding to all frames where this object track appears. Non- + # streaming batch mode: it may be one or multiple ObjectTrackingFrame messages + # in frames. Streaming mode: it can only be one ObjectTrackingFrame message in + # frames. # Corresponds to the JSON property `frames` # @return [Array] attr_accessor :frames @@ -3936,12 +3822,11 @@ module Google # @return [Google::Apis::VideointelligenceV1beta2::GoogleCloudVideointelligenceV1p2beta1VideoSegment] attr_accessor :segment - # Streaming mode ONLY. - # In streaming mode, we do not know the end time of a tracked object - # before it is completed. Hence, there is no VideoSegment info returned. - # Instead, we provide a unique identifiable integer track_id so that - # the customers can correlate the results of the ongoing - # ObjectTrackAnnotation of the same track_id over time. + # Streaming mode ONLY. In streaming mode, we do not know the end time of a + # tracked object before it is completed. Hence, there is no VideoSegment info + # returned. Instead, we provide a unique identifiable integer track_id so that + # the customers can correlate the results of the ongoing ObjectTrackAnnotation + # of the same track_id over time. # Corresponds to the JSON property `trackId` # @return [Fixnum] attr_accessor :track_id @@ -3971,9 +3856,8 @@ module Google class GoogleCloudVideointelligenceV1p2beta1ObjectTrackingFrame include Google::Apis::Core::Hashable - # Normalized bounding box. - # The normalized vertex coordinates are relative to the original image. - # Range: [0, 1]. + # Normalized bounding box. The normalized vertex coordinates are relative to the + # original image. Range: [0, 1]. # Corresponds to the JSON property `normalizedBoundingBox` # @return [Google::Apis::VideointelligenceV1beta2::GoogleCloudVideointelligenceV1p2beta1NormalizedBoundingBox] attr_accessor :normalized_bounding_box @@ -4000,10 +3884,10 @@ module Google # Output only. The confidence estimate between 0.0 and 1.0. A higher number # indicates an estimated greater likelihood that the recognized words are - # correct. This field is set only for the top alternative. - # This field is not guaranteed to be accurate and users should not rely on it - # to be always provided. - # The default of 0.0 is a sentinel value indicating `confidence` was not set. + # correct. This field is set only for the top alternative. This field is not + # guaranteed to be accurate and users should not rely on it to be always + # provided. The default of 0.0 is a sentinel value indicating `confidence` was + # not set. # Corresponds to the JSON property `confidence` # @return [Float] attr_accessor :confidence @@ -4014,8 +3898,8 @@ module Google attr_accessor :transcript # Output only. A list of word-specific information for each recognized word. - # Note: When `enable_speaker_diarization` is set to true, you will see all - # the words from the beginning of the audio. + # Note: When `enable_speaker_diarization` is set to true, you will see all the + # words from the beginning of the audio. # Corresponds to the JSON property `words` # @return [Array] attr_accessor :words @@ -4036,18 +3920,17 @@ module Google class GoogleCloudVideointelligenceV1p2beta1SpeechTranscription include Google::Apis::Core::Hashable - # May contain one or more recognition hypotheses (up to the maximum specified - # in `max_alternatives`). These alternatives are ordered in terms of - # accuracy, with the top (first) alternative being the most probable, as - # ranked by the recognizer. + # May contain one or more recognition hypotheses (up to the maximum specified in + # `max_alternatives`). These alternatives are ordered in terms of accuracy, with + # the top (first) alternative being the most probable, as ranked by the + # recognizer. # Corresponds to the JSON property `alternatives` # @return [Array] attr_accessor :alternatives # Output only. The [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) - # language tag of - # the language in this result. This language code was detected to have the - # most likelihood of being spoken in the audio. + # language tag of the language in this result. This language code was detected + # to have the most likelihood of being spoken in the audio. # Corresponds to the JSON property `languageCode` # @return [String] attr_accessor :language_code @@ -4096,27 +3979,19 @@ module Google end end - # Video frame level annotation results for text annotation (OCR). - # Contains information regarding timestamp and bounding box locations for the - # frames containing detected OCR text snippets. + # Video frame level annotation results for text annotation (OCR). Contains + # information regarding timestamp and bounding box locations for the frames + # containing detected OCR text snippets. class GoogleCloudVideointelligenceV1p2beta1TextFrame include Google::Apis::Core::Hashable # Normalized bounding polygon for text (that might not be aligned with axis). - # Contains list of the corner points in clockwise order starting from - # top-left corner. For example, for a rectangular bounding box: - # When the text is horizontal it might look like: - # 0----1 - # | | - # 3----2 - # When it's clockwise rotated 180 degrees around the top-left corner it - # becomes: - # 2----3 - # | | - # 1----0 - # and the vertex order will still be (0, 1, 2, 3). Note that values can be less - # than 0, or greater than 1 due to trignometric calculations for location of - # the box. + # Contains list of the corner points in clockwise order starting from top-left + # corner. For example, for a rectangular bounding box: When the text is + # horizontal it might look like: 0----1 | | 3----2 When it's clockwise rotated + # 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the + # vertex order will still be (0, 1, 2, 3). Note that values can be less than 0, + # or greater than 1 due to trignometric calculations for location of the box. # Corresponds to the JSON property `rotatedBoundingBox` # @return [Google::Apis::VideointelligenceV1beta2::GoogleCloudVideointelligenceV1p2beta1NormalizedBoundingPoly] attr_accessor :rotated_bounding_box @@ -4169,9 +4044,8 @@ module Google end end - # For tracking related features. - # An object at time_offset with attributes, and located with - # normalized_bounding_box. + # For tracking related features. An object at time_offset with attributes, and + # located with normalized_bounding_box. class GoogleCloudVideointelligenceV1p2beta1TimestampedObject include Google::Apis::Core::Hashable @@ -4185,15 +4059,14 @@ module Google # @return [Array] attr_accessor :landmarks - # Normalized bounding box. - # The normalized vertex coordinates are relative to the original image. - # Range: [0, 1]. + # Normalized bounding box. The normalized vertex coordinates are relative to the + # original image. Range: [0, 1]. # Corresponds to the JSON property `normalizedBoundingBox` # @return [Google::Apis::VideointelligenceV1beta2::GoogleCloudVideointelligenceV1p2beta1NormalizedBoundingBox] attr_accessor :normalized_bounding_box - # Time-offset, relative to the beginning of the video, - # corresponding to the video frame for this object. + # Time-offset, relative to the beginning of the video, corresponding to the + # video frame for this object. # Corresponds to the JSON property `timeOffset` # @return [String] attr_accessor :time_offset @@ -4252,20 +4125,19 @@ module Google class GoogleCloudVideointelligenceV1p2beta1VideoAnnotationProgress include Google::Apis::Core::Hashable - # Specifies which feature is being tracked if the request contains more than - # one feature. + # Specifies which feature is being tracked if the request contains more than one + # feature. # Corresponds to the JSON property `feature` # @return [String] attr_accessor :feature - # Video file location in - # [Cloud Storage](https://cloud.google.com/storage/). + # Video file location in [Cloud Storage](https://cloud.google.com/storage/). # Corresponds to the JSON property `inputUri` # @return [String] attr_accessor :input_uri - # Approximate percentage processed thus far. Guaranteed to be - # 100 when fully processed. + # Approximate percentage processed thus far. Guaranteed to be 100 when fully + # processed. # Corresponds to the JSON property `progressPercent` # @return [Fixnum] attr_accessor :progress_percent @@ -4304,31 +4176,30 @@ module Google class GoogleCloudVideointelligenceV1p2beta1VideoAnnotationResults include Google::Apis::Core::Hashable - # 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::VideointelligenceV1beta2::GoogleRpcStatus] attr_accessor :error - # Explicit content annotation (based on per-frame visual signals only). - # If no explicit content has been detected in a frame, no annotations are - # present for that frame. + # Explicit content annotation (based on per-frame visual signals only). If no + # explicit content has been detected in a frame, no annotations are present for + # that frame. # Corresponds to the JSON property `explicitAnnotation` # @return [Google::Apis::VideointelligenceV1beta2::GoogleCloudVideointelligenceV1p2beta1ExplicitContentAnnotation] attr_accessor :explicit_annotation - # Label annotations on frame level. - # There is exactly one element for each unique label. + # Label annotations on frame level. There is exactly one element for each unique + # label. # Corresponds to the JSON property `frameLabelAnnotations` # @return [Array] attr_accessor :frame_label_annotations - # Video file location in - # [Cloud Storage](https://cloud.google.com/storage/). + # Video file location in [Cloud Storage](https://cloud.google.com/storage/). # Corresponds to the JSON property `inputUri` # @return [String] attr_accessor :input_uri @@ -4355,11 +4226,11 @@ module Google attr_accessor :segment_label_annotations # Presence label annotations on video level or user-specified segment level. - # There is exactly one element for each unique label. Compared to the - # existing topical `segment_label_annotations`, this field presents more - # fine-grained, segment-level labels detected in video content and is made - # available only when the client sets `LabelDetectionConfig.model` to - # "builtin/latest" in the request. + # There is exactly one element for each unique label. Compared to the existing + # topical `segment_label_annotations`, this field presents more fine-grained, + # segment-level labels detected in video content and is made available only when + # the client sets `LabelDetectionConfig.model` to "builtin/latest" in the + # request. # Corresponds to the JSON property `segmentPresenceLabelAnnotations` # @return [Array] attr_accessor :segment_presence_label_annotations @@ -4369,17 +4240,17 @@ module Google # @return [Array] attr_accessor :shot_annotations - # Topical label annotations on shot level. - # There is exactly one element for each unique label. + # Topical label annotations on shot level. There is exactly one element for each + # unique label. # Corresponds to the JSON property `shotLabelAnnotations` # @return [Array] attr_accessor :shot_label_annotations # Presence label annotations on shot level. There is exactly one element for - # each unique label. Compared to the existing topical - # `shot_label_annotations`, this field presents more fine-grained, shot-level - # labels detected in video content and is made available only when the client - # sets `LabelDetectionConfig.model` to "builtin/latest" in the request. + # each unique label. Compared to the existing topical `shot_label_annotations`, + # this field presents more fine-grained, shot-level labels detected in video + # content and is made available only when the client sets `LabelDetectionConfig. + # model` to "builtin/latest" in the request. # Corresponds to the JSON property `shotPresenceLabelAnnotations` # @return [Array] attr_accessor :shot_presence_label_annotations @@ -4389,9 +4260,8 @@ module Google # @return [Array] attr_accessor :speech_transcriptions - # OCR text detection and tracking. - # Annotations for list of detected text snippets. Each will have list of - # frame information associated with it. + # OCR text detection and tracking. Annotations for list of detected text + # snippets. Each will have list of frame information associated with it. # Corresponds to the JSON property `textAnnotations` # @return [Array] attr_accessor :text_annotations @@ -4423,14 +4293,14 @@ module Google class GoogleCloudVideointelligenceV1p2beta1VideoSegment include Google::Apis::Core::Hashable - # Time-offset, relative to the beginning of the video, - # corresponding to the end of the segment (inclusive). + # Time-offset, relative to the beginning of the video, corresponding to the end + # of the segment (inclusive). # Corresponds to the JSON property `endTimeOffset` # @return [String] attr_accessor :end_time_offset - # Time-offset, relative to the beginning of the video, - # corresponding to the start of the segment (inclusive). + # Time-offset, relative to the beginning of the video, corresponding to the + # start of the segment (inclusive). # Corresponds to the JSON property `startTimeOffset` # @return [String] attr_accessor :start_time_offset @@ -4447,41 +4317,41 @@ module Google end # Word-specific information for recognized words. Word information is only - # included in the response when certain request parameters are set, such - # as `enable_word_time_offsets`. + # included in the response when certain request parameters are set, such as ` + # enable_word_time_offsets`. class GoogleCloudVideointelligenceV1p2beta1WordInfo include Google::Apis::Core::Hashable # Output only. The confidence estimate between 0.0 and 1.0. A higher number # indicates an estimated greater likelihood that the recognized words are - # correct. This field is set only for the top alternative. - # This field is not guaranteed to be accurate and users should not rely on it - # to be always provided. - # The default of 0.0 is a sentinel value indicating `confidence` was not set. + # correct. This field is set only for the top alternative. This field is not + # guaranteed to be accurate and users should not rely on it to be always + # provided. The default of 0.0 is a sentinel value indicating `confidence` was + # not set. # Corresponds to the JSON property `confidence` # @return [Float] attr_accessor :confidence - # Time offset relative to the beginning of the audio, and - # corresponding to the end of the spoken word. This field is only set if - # `enable_word_time_offsets=true` and only in the top hypothesis. This is an - # experimental feature and the accuracy of the time offset can vary. + # Time offset relative to the beginning of the audio, and corresponding to the + # end of the spoken word. This field is only set if `enable_word_time_offsets= + # true` and only in the top hypothesis. This is an experimental feature and the + # accuracy of the time offset can vary. # Corresponds to the JSON property `endTime` # @return [String] attr_accessor :end_time - # Output only. A distinct integer value is assigned for every speaker within - # the audio. This field specifies which one of those speakers was detected to - # have spoken this word. Value ranges from 1 up to diarization_speaker_count, - # and is only set if speaker diarization is enabled. + # Output only. A distinct integer value is assigned for every speaker within the + # audio. This field specifies which one of those speakers was detected to have + # spoken this word. Value ranges from 1 up to diarization_speaker_count, and is + # only set if speaker diarization is enabled. # Corresponds to the JSON property `speakerTag` # @return [Fixnum] attr_accessor :speaker_tag - # Time offset relative to the beginning of the audio, and - # corresponding to the start of the spoken word. This field is only set if - # `enable_word_time_offsets=true` and only in the top hypothesis. This is an - # experimental feature and the accuracy of the time offset can vary. + # Time offset relative to the beginning of the audio, and corresponding to the + # start of the spoken word. This field is only set if `enable_word_time_offsets= + # true` and only in the top hypothesis. This is an experimental feature and the + # accuracy of the time offset can vary. # Corresponds to the JSON property `startTime` # @return [String] attr_accessor :start_time @@ -4505,9 +4375,9 @@ module Google end end - # Video annotation progress. Included in the `metadata` - # field of the `Operation` returned by the `GetOperation` - # call of the `google::longrunning::Operations` service. + # Video annotation progress. Included in the `metadata` field of the `Operation` + # returned by the `GetOperation` call of the `google::longrunning::Operations` + # service. class GoogleCloudVideointelligenceV1p3beta1AnnotateVideoProgress include Google::Apis::Core::Hashable @@ -4526,9 +4396,9 @@ module Google end end - # Video annotation response. Included in the `response` - # field of the `Operation` returned by the `GetOperation` - # call of the `google::longrunning::Operations` service. + # Video annotation response. Included in the `response` field of the `Operation` + # returned by the `GetOperation` call of the `google::longrunning::Operations` + # service. class GoogleCloudVideointelligenceV1p3beta1AnnotateVideoResponse include Google::Apis::Core::Hashable @@ -4562,10 +4432,9 @@ module Google # @return [String] attr_accessor :display_name - # The resource name of the celebrity. Have the format - # `video-intelligence/kg-mid` indicates a celebrity from preloaded gallery. - # kg-mid is the id in Google knowledge graph, which is unique for the - # celebrity. + # The resource name of the celebrity. Have the format `video-intelligence/kg-mid` + # indicates a celebrity from preloaded gallery. kg-mid is the id in Google + # knowledge graph, which is unique for the celebrity. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name @@ -4586,8 +4455,8 @@ module Google class GoogleCloudVideointelligenceV1p3beta1CelebrityRecognitionAnnotation include Google::Apis::Core::Hashable - # The tracks detected from the input video, including recognized celebrities - # and other detected faces in the video. + # The tracks detected from the input video, including recognized celebrities and + # other detected faces in the video. # Corresponds to the JSON property `celebrityTracks` # @return [Array] attr_accessor :celebrity_tracks @@ -4643,14 +4512,14 @@ module Google # @return [Float] attr_accessor :confidence - # The name of the attribute, for example, glasses, dark_glasses, mouth_open. - # A full list of supported type names will be provided in the document. + # The name of the attribute, for example, glasses, dark_glasses, mouth_open. A + # full list of supported type names will be provided in the document. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name - # Text value of the detection result. For example, the value for "HairColor" - # can be "black", "blonde", etc. + # Text value of the detection result. For example, the value for "HairColor" can + # be "black", "blonde", etc. # Corresponds to the JSON property `value` # @return [String] attr_accessor :value @@ -4682,9 +4551,8 @@ module Google # @return [String] attr_accessor :name - # A vertex represents a 2D point in the image. - # NOTE: the normalized vertex coordinates are relative to the original image - # and range from 0 to 1. + # A vertex represents a 2D point in the image. NOTE: the normalized vertex + # coordinates are relative to the original image and range from 0 to 1. # Corresponds to the JSON property `point` # @return [Google::Apis::VideointelligenceV1beta2::GoogleCloudVideointelligenceV1p3beta1NormalizedVertex] attr_accessor :point @@ -4710,8 +4578,7 @@ module Google # @return [String] attr_accessor :description - # Opaque entity ID. Some IDs may be available in - # [Google Knowledge Graph Search + # Opaque entity ID. Some IDs may be available in [Google Knowledge Graph Search # API](https://developers.google.com/knowledge-graph/). # Corresponds to the JSON property `entityId` # @return [String] @@ -4734,9 +4601,9 @@ module Google end end - # Explicit content annotation (based on per-frame visual signals only). - # If no explicit content has been detected in a frame, no annotations are - # present for that frame. + # Explicit content annotation (based on per-frame visual signals only). If no + # explicit content has been detected in a frame, no annotations are present for + # that frame. class GoogleCloudVideointelligenceV1p3beta1ExplicitContentAnnotation include Google::Apis::Core::Hashable @@ -4823,10 +4690,9 @@ module Google class GoogleCloudVideointelligenceV1p3beta1LabelAnnotation include Google::Apis::Core::Hashable - # Common categories for the detected entity. - # For example, when the label is `Terrier`, the category is likely `dog`. And - # in some cases there might be more than one categories e.g., `Terrier` could - # also be a `pet`. + # Common categories for the detected entity. For example, when the label is ` + # Terrier`, the category is likely `dog`. And in some cases there might be more + # than one categories e.g., `Terrier` could also be a `pet`. # Corresponds to the JSON property `categoryEntities` # @return [Array] attr_accessor :category_entities @@ -4925,14 +4791,14 @@ module Google # @return [Google::Apis::VideointelligenceV1beta2::GoogleCloudVideointelligenceV1p3beta1Entity] attr_accessor :entity - # All video segments where the recognized logo appears. There might be - # multiple instances of the same logo class appearing in one VideoSegment. + # All video segments where the recognized logo appears. There might be multiple + # instances of the same logo class appearing in one VideoSegment. # Corresponds to the JSON property `segments` # @return [Array] attr_accessor :segments - # All logo tracks where the recognized logo appears. Each track corresponds - # to one logo instance appearing in consecutive frames. + # All logo tracks where the recognized logo appears. Each track corresponds to + # one logo instance appearing in consecutive frames. # Corresponds to the JSON property `tracks` # @return [Array] attr_accessor :tracks @@ -4949,9 +4815,8 @@ module Google end end - # Normalized bounding box. - # The normalized vertex coordinates are relative to the original image. - # Range: [0, 1]. + # Normalized bounding box. The normalized vertex coordinates are relative to the + # original image. Range: [0, 1]. class GoogleCloudVideointelligenceV1p3beta1NormalizedBoundingBox include Google::Apis::Core::Hashable @@ -4989,20 +4854,12 @@ module Google end # Normalized bounding polygon for text (that might not be aligned with axis). - # Contains list of the corner points in clockwise order starting from - # top-left corner. For example, for a rectangular bounding box: - # When the text is horizontal it might look like: - # 0----1 - # | | - # 3----2 - # When it's clockwise rotated 180 degrees around the top-left corner it - # becomes: - # 2----3 - # | | - # 1----0 - # and the vertex order will still be (0, 1, 2, 3). Note that values can be less - # than 0, or greater than 1 due to trignometric calculations for location of - # the box. + # Contains list of the corner points in clockwise order starting from top-left + # corner. For example, for a rectangular bounding box: When the text is + # horizontal it might look like: 0----1 | | 3----2 When it's clockwise rotated + # 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the + # vertex order will still be (0, 1, 2, 3). Note that values can be less than 0, + # or greater than 1 due to trignometric calculations for location of the box. class GoogleCloudVideointelligenceV1p3beta1NormalizedBoundingPoly include Google::Apis::Core::Hashable @@ -5021,9 +4878,8 @@ module Google end end - # A vertex represents a 2D point in the image. - # NOTE: the normalized vertex coordinates are relative to the original image - # and range from 0 to 1. + # A vertex represents a 2D point in the image. NOTE: the normalized vertex + # coordinates are relative to the original image and range from 0 to 1. class GoogleCloudVideointelligenceV1p3beta1NormalizedVertex include Google::Apis::Core::Hashable @@ -5062,10 +4918,10 @@ module Google # @return [Google::Apis::VideointelligenceV1beta2::GoogleCloudVideointelligenceV1p3beta1Entity] attr_accessor :entity - # Information corresponding to all frames where this object track appears. - # Non-streaming batch mode: it may be one or multiple ObjectTrackingFrame - # messages in frames. - # Streaming mode: it can only be one ObjectTrackingFrame message in frames. + # Information corresponding to all frames where this object track appears. Non- + # streaming batch mode: it may be one or multiple ObjectTrackingFrame messages + # in frames. Streaming mode: it can only be one ObjectTrackingFrame message in + # frames. # Corresponds to the JSON property `frames` # @return [Array] attr_accessor :frames @@ -5075,12 +4931,11 @@ module Google # @return [Google::Apis::VideointelligenceV1beta2::GoogleCloudVideointelligenceV1p3beta1VideoSegment] attr_accessor :segment - # Streaming mode ONLY. - # In streaming mode, we do not know the end time of a tracked object - # before it is completed. Hence, there is no VideoSegment info returned. - # Instead, we provide a unique identifiable integer track_id so that - # the customers can correlate the results of the ongoing - # ObjectTrackAnnotation of the same track_id over time. + # Streaming mode ONLY. In streaming mode, we do not know the end time of a + # tracked object before it is completed. Hence, there is no VideoSegment info + # returned. Instead, we provide a unique identifiable integer track_id so that + # the customers can correlate the results of the ongoing ObjectTrackAnnotation + # of the same track_id over time. # Corresponds to the JSON property `trackId` # @return [Fixnum] attr_accessor :track_id @@ -5110,9 +4965,8 @@ module Google class GoogleCloudVideointelligenceV1p3beta1ObjectTrackingFrame include Google::Apis::Core::Hashable - # Normalized bounding box. - # The normalized vertex coordinates are relative to the original image. - # Range: [0, 1]. + # Normalized bounding box. The normalized vertex coordinates are relative to the + # original image. Range: [0, 1]. # Corresponds to the JSON property `normalizedBoundingBox` # @return [Google::Apis::VideointelligenceV1beta2::GoogleCloudVideointelligenceV1p3beta1NormalizedBoundingBox] attr_accessor :normalized_bounding_box @@ -5189,10 +5043,10 @@ module Google # Output only. The confidence estimate between 0.0 and 1.0. A higher number # indicates an estimated greater likelihood that the recognized words are - # correct. This field is set only for the top alternative. - # This field is not guaranteed to be accurate and users should not rely on it - # to be always provided. - # The default of 0.0 is a sentinel value indicating `confidence` was not set. + # correct. This field is set only for the top alternative. This field is not + # guaranteed to be accurate and users should not rely on it to be always + # provided. The default of 0.0 is a sentinel value indicating `confidence` was + # not set. # Corresponds to the JSON property `confidence` # @return [Float] attr_accessor :confidence @@ -5203,8 +5057,8 @@ module Google attr_accessor :transcript # Output only. A list of word-specific information for each recognized word. - # Note: When `enable_speaker_diarization` is set to true, you will see all - # the words from the beginning of the audio. + # Note: When `enable_speaker_diarization` is set to true, you will see all the + # words from the beginning of the audio. # Corresponds to the JSON property `words` # @return [Array] attr_accessor :words @@ -5225,18 +5079,17 @@ module Google class GoogleCloudVideointelligenceV1p3beta1SpeechTranscription include Google::Apis::Core::Hashable - # May contain one or more recognition hypotheses (up to the maximum specified - # in `max_alternatives`). These alternatives are ordered in terms of - # accuracy, with the top (first) alternative being the most probable, as - # ranked by the recognizer. + # May contain one or more recognition hypotheses (up to the maximum specified in + # `max_alternatives`). These alternatives are ordered in terms of accuracy, with + # the top (first) alternative being the most probable, as ranked by the + # recognizer. # Corresponds to the JSON property `alternatives` # @return [Array] attr_accessor :alternatives # Output only. The [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) - # language tag of - # the language in this result. This language code was detected to have the - # most likelihood of being spoken in the audio. + # language tag of the language in this result. This language code was detected + # to have the most likelihood of being spoken in the audio. # Corresponds to the JSON property `languageCode` # @return [String] attr_accessor :language_code @@ -5252,32 +5105,31 @@ module Google end end - # `StreamingAnnotateVideoResponse` is the only message returned to the client - # by `StreamingAnnotateVideo`. A series of zero or more - # `StreamingAnnotateVideoResponse` messages are streamed back to the client. + # `StreamingAnnotateVideoResponse` is the only message returned to the client by + # `StreamingAnnotateVideo`. A series of zero or more ` + # StreamingAnnotateVideoResponse` messages are streamed back to the client. class GoogleCloudVideointelligenceV1p3beta1StreamingAnnotateVideoResponse include Google::Apis::Core::Hashable - # Streaming annotation results corresponding to a portion of the video - # that is currently being processed. + # Streaming annotation results corresponding to a portion of the video that is + # currently being processed. # Corresponds to the JSON property `annotationResults` # @return [Google::Apis::VideointelligenceV1beta2::GoogleCloudVideointelligenceV1p3beta1StreamingVideoAnnotationResults] attr_accessor :annotation_results - # Google Cloud Storage URI that stores annotation results of one - # streaming session in JSON format. - # It is the annotation_result_storage_directory - # from the request followed by '/cloud_project_number-session_id'. + # Google Cloud Storage URI that stores annotation results of one streaming + # session in JSON format. It is the annotation_result_storage_directory from the + # request followed by '/cloud_project_number-session_id'. # Corresponds to the JSON property `annotationResultsUri` # @return [String] attr_accessor :annotation_results_uri - # 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::VideointelligenceV1beta2::GoogleRpcStatus] attr_accessor :error @@ -5294,14 +5146,14 @@ module Google end end - # Streaming annotation results corresponding to a portion of the video - # that is currently being processed. + # Streaming annotation results corresponding to a portion of the video that is + # currently being processed. class GoogleCloudVideointelligenceV1p3beta1StreamingVideoAnnotationResults include Google::Apis::Core::Hashable - # Explicit content annotation (based on per-frame visual signals only). - # If no explicit content has been detected in a frame, no annotations are - # present for that frame. + # Explicit content annotation (based on per-frame visual signals only). If no + # explicit content has been detected in a frame, no annotations are present for + # that frame. # Corresponds to the JSON property `explicitAnnotation` # @return [Google::Apis::VideointelligenceV1beta2::GoogleCloudVideointelligenceV1p3beta1ExplicitContentAnnotation] attr_accessor :explicit_annotation @@ -5367,27 +5219,19 @@ module Google end end - # Video frame level annotation results for text annotation (OCR). - # Contains information regarding timestamp and bounding box locations for the - # frames containing detected OCR text snippets. + # Video frame level annotation results for text annotation (OCR). Contains + # information regarding timestamp and bounding box locations for the frames + # containing detected OCR text snippets. class GoogleCloudVideointelligenceV1p3beta1TextFrame include Google::Apis::Core::Hashable # Normalized bounding polygon for text (that might not be aligned with axis). - # Contains list of the corner points in clockwise order starting from - # top-left corner. For example, for a rectangular bounding box: - # When the text is horizontal it might look like: - # 0----1 - # | | - # 3----2 - # When it's clockwise rotated 180 degrees around the top-left corner it - # becomes: - # 2----3 - # | | - # 1----0 - # and the vertex order will still be (0, 1, 2, 3). Note that values can be less - # than 0, or greater than 1 due to trignometric calculations for location of - # the box. + # Contains list of the corner points in clockwise order starting from top-left + # corner. For example, for a rectangular bounding box: When the text is + # horizontal it might look like: 0----1 | | 3----2 When it's clockwise rotated + # 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the + # vertex order will still be (0, 1, 2, 3). Note that values can be less than 0, + # or greater than 1 due to trignometric calculations for location of the box. # Corresponds to the JSON property `rotatedBoundingBox` # @return [Google::Apis::VideointelligenceV1beta2::GoogleCloudVideointelligenceV1p3beta1NormalizedBoundingPoly] attr_accessor :rotated_bounding_box @@ -5440,9 +5284,8 @@ module Google end end - # For tracking related features. - # An object at time_offset with attributes, and located with - # normalized_bounding_box. + # For tracking related features. An object at time_offset with attributes, and + # located with normalized_bounding_box. class GoogleCloudVideointelligenceV1p3beta1TimestampedObject include Google::Apis::Core::Hashable @@ -5456,15 +5299,14 @@ module Google # @return [Array] attr_accessor :landmarks - # Normalized bounding box. - # The normalized vertex coordinates are relative to the original image. - # Range: [0, 1]. + # Normalized bounding box. The normalized vertex coordinates are relative to the + # original image. Range: [0, 1]. # Corresponds to the JSON property `normalizedBoundingBox` # @return [Google::Apis::VideointelligenceV1beta2::GoogleCloudVideointelligenceV1p3beta1NormalizedBoundingBox] attr_accessor :normalized_bounding_box - # Time-offset, relative to the beginning of the video, - # corresponding to the video frame for this object. + # Time-offset, relative to the beginning of the video, corresponding to the + # video frame for this object. # Corresponds to the JSON property `timeOffset` # @return [String] attr_accessor :time_offset @@ -5523,20 +5365,19 @@ module Google class GoogleCloudVideointelligenceV1p3beta1VideoAnnotationProgress include Google::Apis::Core::Hashable - # Specifies which feature is being tracked if the request contains more than - # one feature. + # Specifies which feature is being tracked if the request contains more than one + # feature. # Corresponds to the JSON property `feature` # @return [String] attr_accessor :feature - # Video file location in - # [Cloud Storage](https://cloud.google.com/storage/). + # Video file location in [Cloud Storage](https://cloud.google.com/storage/). # Corresponds to the JSON property `inputUri` # @return [String] attr_accessor :input_uri - # Approximate percentage processed thus far. Guaranteed to be - # 100 when fully processed. + # Approximate percentage processed thus far. Guaranteed to be 100 when fully + # processed. # Corresponds to the JSON property `progressPercent` # @return [Fixnum] attr_accessor :progress_percent @@ -5580,19 +5421,19 @@ module Google # @return [Google::Apis::VideointelligenceV1beta2::GoogleCloudVideointelligenceV1p3beta1CelebrityRecognitionAnnotation] attr_accessor :celebrity_recognition_annotations - # 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::VideointelligenceV1beta2::GoogleRpcStatus] attr_accessor :error - # Explicit content annotation (based on per-frame visual signals only). - # If no explicit content has been detected in a frame, no annotations are - # present for that frame. + # Explicit content annotation (based on per-frame visual signals only). If no + # explicit content has been detected in a frame, no annotations are present for + # that frame. # Corresponds to the JSON property `explicitAnnotation` # @return [Google::Apis::VideointelligenceV1beta2::GoogleCloudVideointelligenceV1p3beta1ExplicitContentAnnotation] attr_accessor :explicit_annotation @@ -5602,14 +5443,13 @@ module Google # @return [Array] attr_accessor :face_detection_annotations - # Label annotations on frame level. - # There is exactly one element for each unique label. + # Label annotations on frame level. There is exactly one element for each unique + # label. # Corresponds to the JSON property `frameLabelAnnotations` # @return [Array] attr_accessor :frame_label_annotations - # Video file location in - # [Cloud Storage](https://cloud.google.com/storage/). + # Video file location in [Cloud Storage](https://cloud.google.com/storage/). # Corresponds to the JSON property `inputUri` # @return [String] attr_accessor :input_uri @@ -5641,11 +5481,11 @@ module Google attr_accessor :segment_label_annotations # Presence label annotations on video level or user-specified segment level. - # There is exactly one element for each unique label. Compared to the - # existing topical `segment_label_annotations`, this field presents more - # fine-grained, segment-level labels detected in video content and is made - # available only when the client sets `LabelDetectionConfig.model` to - # "builtin/latest" in the request. + # There is exactly one element for each unique label. Compared to the existing + # topical `segment_label_annotations`, this field presents more fine-grained, + # segment-level labels detected in video content and is made available only when + # the client sets `LabelDetectionConfig.model` to "builtin/latest" in the + # request. # Corresponds to the JSON property `segmentPresenceLabelAnnotations` # @return [Array] attr_accessor :segment_presence_label_annotations @@ -5655,17 +5495,17 @@ module Google # @return [Array] attr_accessor :shot_annotations - # Topical label annotations on shot level. - # There is exactly one element for each unique label. + # Topical label annotations on shot level. There is exactly one element for each + # unique label. # Corresponds to the JSON property `shotLabelAnnotations` # @return [Array] attr_accessor :shot_label_annotations # Presence label annotations on shot level. There is exactly one element for - # each unique label. Compared to the existing topical - # `shot_label_annotations`, this field presents more fine-grained, shot-level - # labels detected in video content and is made available only when the client - # sets `LabelDetectionConfig.model` to "builtin/latest" in the request. + # each unique label. Compared to the existing topical `shot_label_annotations`, + # this field presents more fine-grained, shot-level labels detected in video + # content and is made available only when the client sets `LabelDetectionConfig. + # model` to "builtin/latest" in the request. # Corresponds to the JSON property `shotPresenceLabelAnnotations` # @return [Array] attr_accessor :shot_presence_label_annotations @@ -5675,9 +5515,8 @@ module Google # @return [Array] attr_accessor :speech_transcriptions - # OCR text detection and tracking. - # Annotations for list of detected text snippets. Each will have list of - # frame information associated with it. + # OCR text detection and tracking. Annotations for list of detected text + # snippets. Each will have list of frame information associated with it. # Corresponds to the JSON property `textAnnotations` # @return [Array] attr_accessor :text_annotations @@ -5712,14 +5551,14 @@ module Google class GoogleCloudVideointelligenceV1p3beta1VideoSegment include Google::Apis::Core::Hashable - # Time-offset, relative to the beginning of the video, - # corresponding to the end of the segment (inclusive). + # Time-offset, relative to the beginning of the video, corresponding to the end + # of the segment (inclusive). # Corresponds to the JSON property `endTimeOffset` # @return [String] attr_accessor :end_time_offset - # Time-offset, relative to the beginning of the video, - # corresponding to the start of the segment (inclusive). + # Time-offset, relative to the beginning of the video, corresponding to the + # start of the segment (inclusive). # Corresponds to the JSON property `startTimeOffset` # @return [String] attr_accessor :start_time_offset @@ -5736,41 +5575,41 @@ module Google end # Word-specific information for recognized words. Word information is only - # included in the response when certain request parameters are set, such - # as `enable_word_time_offsets`. + # included in the response when certain request parameters are set, such as ` + # enable_word_time_offsets`. class GoogleCloudVideointelligenceV1p3beta1WordInfo include Google::Apis::Core::Hashable # Output only. The confidence estimate between 0.0 and 1.0. A higher number # indicates an estimated greater likelihood that the recognized words are - # correct. This field is set only for the top alternative. - # This field is not guaranteed to be accurate and users should not rely on it - # to be always provided. - # The default of 0.0 is a sentinel value indicating `confidence` was not set. + # correct. This field is set only for the top alternative. This field is not + # guaranteed to be accurate and users should not rely on it to be always + # provided. The default of 0.0 is a sentinel value indicating `confidence` was + # not set. # Corresponds to the JSON property `confidence` # @return [Float] attr_accessor :confidence - # Time offset relative to the beginning of the audio, and - # corresponding to the end of the spoken word. This field is only set if - # `enable_word_time_offsets=true` and only in the top hypothesis. This is an - # experimental feature and the accuracy of the time offset can vary. + # Time offset relative to the beginning of the audio, and corresponding to the + # end of the spoken word. This field is only set if `enable_word_time_offsets= + # true` and only in the top hypothesis. This is an experimental feature and the + # accuracy of the time offset can vary. # Corresponds to the JSON property `endTime` # @return [String] attr_accessor :end_time - # Output only. A distinct integer value is assigned for every speaker within - # the audio. This field specifies which one of those speakers was detected to - # have spoken this word. Value ranges from 1 up to diarization_speaker_count, - # and is only set if speaker diarization is enabled. + # Output only. A distinct integer value is assigned for every speaker within the + # audio. This field specifies which one of those speakers was detected to have + # spoken this word. Value ranges from 1 up to diarization_speaker_count, and is + # only set if speaker diarization is enabled. # Corresponds to the JSON property `speakerTag` # @return [Fixnum] attr_accessor :speaker_tag - # Time offset relative to the beginning of the audio, and - # corresponding to the start of the spoken word. This field is only set if - # `enable_word_time_offsets=true` and only in the top hypothesis. This is an - # experimental feature and the accuracy of the time offset can vary. + # Time offset relative to the beginning of the audio, and corresponding to the + # start of the spoken word. This field is only set if `enable_word_time_offsets= + # true` and only in the top hypothesis. This is an experimental feature and the + # accuracy of the time offset can vary. # Corresponds to the JSON property `startTime` # @return [String] attr_accessor :start_time @@ -5799,47 +5638,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::VideointelligenceV1beta2::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 @@ -5858,12 +5695,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 @@ -5872,15 +5709,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 diff --git a/generated/google/apis/videointelligence_v1beta2/service.rb b/generated/google/apis/videointelligence_v1beta2/service.rb index 99f5eb151..7ee11ac01 100644 --- a/generated/google/apis/videointelligence_v1beta2/service.rb +++ b/generated/google/apis/videointelligence_v1beta2/service.rb @@ -49,10 +49,10 @@ module Google @batch_path = 'batch' end - # Performs asynchronous video annotation. Progress and results can be - # retrieved through the `google.longrunning.Operations` interface. - # `Operation.metadata` contains `AnnotateVideoProgress` (progress). - # `Operation.response` contains `AnnotateVideoResponse` (results). + # Performs asynchronous video annotation. Progress and results can be retrieved + # through the `google.longrunning.Operations` interface. `Operation.metadata` + # contains `AnnotateVideoProgress` (progress). `Operation.response` contains ` + # AnnotateVideoResponse` (results). # @param [Google::Apis::VideointelligenceV1beta2::GoogleCloudVideointelligenceV1beta2AnnotateVideoRequest] google_cloud_videointelligence_v1beta2_annotate_video_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. diff --git a/generated/google/apis/videointelligence_v1p1beta1.rb b/generated/google/apis/videointelligence_v1p1beta1.rb index 9539c7537..984991fd2 100644 --- a/generated/google/apis/videointelligence_v1p1beta1.rb +++ b/generated/google/apis/videointelligence_v1p1beta1.rb @@ -27,7 +27,7 @@ module Google # @see https://cloud.google.com/video-intelligence/docs/ module VideointelligenceV1p1beta1 VERSION = 'V1p1beta1' - REVISION = '20200602' + 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/videointelligence_v1p1beta1/classes.rb b/generated/google/apis/videointelligence_v1p1beta1/classes.rb index e35f83ccb..ad9d7a82e 100644 --- a/generated/google/apis/videointelligence_v1p1beta1/classes.rb +++ b/generated/google/apis/videointelligence_v1p1beta1/classes.rb @@ -22,9 +22,9 @@ module Google module Apis module VideointelligenceV1p1beta1 - # Video annotation progress. Included in the `metadata` - # field of the `Operation` returned by the `GetOperation` - # call of the `google::longrunning::Operations` service. + # Video annotation progress. Included in the `metadata` field of the `Operation` + # returned by the `GetOperation` call of the `google::longrunning::Operations` + # service. class GoogleCloudVideointelligenceV1AnnotateVideoProgress include Google::Apis::Core::Hashable @@ -43,9 +43,9 @@ module Google end end - # Video annotation response. Included in the `response` - # field of the `Operation` returned by the `GetOperation` - # call of the `google::longrunning::Operations` service. + # Video annotation response. Included in the `response` field of the `Operation` + # returned by the `GetOperation` call of the `google::longrunning::Operations` + # service. class GoogleCloudVideointelligenceV1AnnotateVideoResponse include Google::Apis::Core::Hashable @@ -73,14 +73,14 @@ module Google # @return [Float] attr_accessor :confidence - # The name of the attribute, for example, glasses, dark_glasses, mouth_open. - # A full list of supported type names will be provided in the document. + # The name of the attribute, for example, glasses, dark_glasses, mouth_open. A + # full list of supported type names will be provided in the document. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name - # Text value of the detection result. For example, the value for "HairColor" - # can be "black", "blonde", etc. + # Text value of the detection result. For example, the value for "HairColor" can + # be "black", "blonde", etc. # Corresponds to the JSON property `value` # @return [String] attr_accessor :value @@ -112,9 +112,8 @@ module Google # @return [String] attr_accessor :name - # A vertex represents a 2D point in the image. - # NOTE: the normalized vertex coordinates are relative to the original image - # and range from 0 to 1. + # A vertex represents a 2D point in the image. NOTE: the normalized vertex + # coordinates are relative to the original image and range from 0 to 1. # Corresponds to the JSON property `point` # @return [Google::Apis::VideointelligenceV1p1beta1::GoogleCloudVideointelligenceV1NormalizedVertex] attr_accessor :point @@ -140,8 +139,7 @@ module Google # @return [String] attr_accessor :description - # Opaque entity ID. Some IDs may be available in - # [Google Knowledge Graph Search + # Opaque entity ID. Some IDs may be available in [Google Knowledge Graph Search # API](https://developers.google.com/knowledge-graph/). # Corresponds to the JSON property `entityId` # @return [String] @@ -164,9 +162,9 @@ module Google end end - # Explicit content annotation (based on per-frame visual signals only). - # If no explicit content has been detected in a frame, no annotations are - # present for that frame. + # Explicit content annotation (based on per-frame visual signals only). If no + # explicit content has been detected in a frame, no annotations are present for + # that frame. class GoogleCloudVideointelligenceV1ExplicitContentAnnotation include Google::Apis::Core::Hashable @@ -221,10 +219,9 @@ module Google class GoogleCloudVideointelligenceV1LabelAnnotation include Google::Apis::Core::Hashable - # Common categories for the detected entity. - # For example, when the label is `Terrier`, the category is likely `dog`. And - # in some cases there might be more than one categories e.g., `Terrier` could - # also be a `pet`. + # Common categories for the detected entity. For example, when the label is ` + # Terrier`, the category is likely `dog`. And in some cases there might be more + # than one categories e.g., `Terrier` could also be a `pet`. # Corresponds to the JSON property `categoryEntities` # @return [Array] attr_accessor :category_entities @@ -323,14 +320,14 @@ module Google # @return [Google::Apis::VideointelligenceV1p1beta1::GoogleCloudVideointelligenceV1Entity] attr_accessor :entity - # All video segments where the recognized logo appears. There might be - # multiple instances of the same logo class appearing in one VideoSegment. + # All video segments where the recognized logo appears. There might be multiple + # instances of the same logo class appearing in one VideoSegment. # Corresponds to the JSON property `segments` # @return [Array] attr_accessor :segments - # All logo tracks where the recognized logo appears. Each track corresponds - # to one logo instance appearing in consecutive frames. + # All logo tracks where the recognized logo appears. Each track corresponds to + # one logo instance appearing in consecutive frames. # Corresponds to the JSON property `tracks` # @return [Array] attr_accessor :tracks @@ -347,9 +344,8 @@ module Google end end - # Normalized bounding box. - # The normalized vertex coordinates are relative to the original image. - # Range: [0, 1]. + # Normalized bounding box. The normalized vertex coordinates are relative to the + # original image. Range: [0, 1]. class GoogleCloudVideointelligenceV1NormalizedBoundingBox include Google::Apis::Core::Hashable @@ -387,20 +383,12 @@ module Google end # Normalized bounding polygon for text (that might not be aligned with axis). - # Contains list of the corner points in clockwise order starting from - # top-left corner. For example, for a rectangular bounding box: - # When the text is horizontal it might look like: - # 0----1 - # | | - # 3----2 - # When it's clockwise rotated 180 degrees around the top-left corner it - # becomes: - # 2----3 - # | | - # 1----0 - # and the vertex order will still be (0, 1, 2, 3). Note that values can be less - # than 0, or greater than 1 due to trignometric calculations for location of - # the box. + # Contains list of the corner points in clockwise order starting from top-left + # corner. For example, for a rectangular bounding box: When the text is + # horizontal it might look like: 0----1 | | 3----2 When it's clockwise rotated + # 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the + # vertex order will still be (0, 1, 2, 3). Note that values can be less than 0, + # or greater than 1 due to trignometric calculations for location of the box. class GoogleCloudVideointelligenceV1NormalizedBoundingPoly include Google::Apis::Core::Hashable @@ -419,9 +407,8 @@ module Google end end - # A vertex represents a 2D point in the image. - # NOTE: the normalized vertex coordinates are relative to the original image - # and range from 0 to 1. + # A vertex represents a 2D point in the image. NOTE: the normalized vertex + # coordinates are relative to the original image and range from 0 to 1. class GoogleCloudVideointelligenceV1NormalizedVertex include Google::Apis::Core::Hashable @@ -460,10 +447,10 @@ module Google # @return [Google::Apis::VideointelligenceV1p1beta1::GoogleCloudVideointelligenceV1Entity] attr_accessor :entity - # Information corresponding to all frames where this object track appears. - # Non-streaming batch mode: it may be one or multiple ObjectTrackingFrame - # messages in frames. - # Streaming mode: it can only be one ObjectTrackingFrame message in frames. + # Information corresponding to all frames where this object track appears. Non- + # streaming batch mode: it may be one or multiple ObjectTrackingFrame messages + # in frames. Streaming mode: it can only be one ObjectTrackingFrame message in + # frames. # Corresponds to the JSON property `frames` # @return [Array] attr_accessor :frames @@ -473,12 +460,11 @@ module Google # @return [Google::Apis::VideointelligenceV1p1beta1::GoogleCloudVideointelligenceV1VideoSegment] attr_accessor :segment - # Streaming mode ONLY. - # In streaming mode, we do not know the end time of a tracked object - # before it is completed. Hence, there is no VideoSegment info returned. - # Instead, we provide a unique identifiable integer track_id so that - # the customers can correlate the results of the ongoing - # ObjectTrackAnnotation of the same track_id over time. + # Streaming mode ONLY. In streaming mode, we do not know the end time of a + # tracked object before it is completed. Hence, there is no VideoSegment info + # returned. Instead, we provide a unique identifiable integer track_id so that + # the customers can correlate the results of the ongoing ObjectTrackAnnotation + # of the same track_id over time. # Corresponds to the JSON property `trackId` # @return [Fixnum] attr_accessor :track_id @@ -508,9 +494,8 @@ module Google class GoogleCloudVideointelligenceV1ObjectTrackingFrame include Google::Apis::Core::Hashable - # Normalized bounding box. - # The normalized vertex coordinates are relative to the original image. - # Range: [0, 1]. + # Normalized bounding box. The normalized vertex coordinates are relative to the + # original image. Range: [0, 1]. # Corresponds to the JSON property `normalizedBoundingBox` # @return [Google::Apis::VideointelligenceV1p1beta1::GoogleCloudVideointelligenceV1NormalizedBoundingBox] attr_accessor :normalized_bounding_box @@ -537,10 +522,10 @@ module Google # Output only. The confidence estimate between 0.0 and 1.0. A higher number # indicates an estimated greater likelihood that the recognized words are - # correct. This field is set only for the top alternative. - # This field is not guaranteed to be accurate and users should not rely on it - # to be always provided. - # The default of 0.0 is a sentinel value indicating `confidence` was not set. + # correct. This field is set only for the top alternative. This field is not + # guaranteed to be accurate and users should not rely on it to be always + # provided. The default of 0.0 is a sentinel value indicating `confidence` was + # not set. # Corresponds to the JSON property `confidence` # @return [Float] attr_accessor :confidence @@ -551,8 +536,8 @@ module Google attr_accessor :transcript # Output only. A list of word-specific information for each recognized word. - # Note: When `enable_speaker_diarization` is set to true, you will see all - # the words from the beginning of the audio. + # Note: When `enable_speaker_diarization` is set to true, you will see all the + # words from the beginning of the audio. # Corresponds to the JSON property `words` # @return [Array] attr_accessor :words @@ -573,18 +558,17 @@ module Google class GoogleCloudVideointelligenceV1SpeechTranscription include Google::Apis::Core::Hashable - # May contain one or more recognition hypotheses (up to the maximum specified - # in `max_alternatives`). These alternatives are ordered in terms of - # accuracy, with the top (first) alternative being the most probable, as - # ranked by the recognizer. + # May contain one or more recognition hypotheses (up to the maximum specified in + # `max_alternatives`). These alternatives are ordered in terms of accuracy, with + # the top (first) alternative being the most probable, as ranked by the + # recognizer. # Corresponds to the JSON property `alternatives` # @return [Array] attr_accessor :alternatives # Output only. The [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) - # language tag of - # the language in this result. This language code was detected to have the - # most likelihood of being spoken in the audio. + # language tag of the language in this result. This language code was detected + # to have the most likelihood of being spoken in the audio. # Corresponds to the JSON property `languageCode` # @return [String] attr_accessor :language_code @@ -633,27 +617,19 @@ module Google end end - # Video frame level annotation results for text annotation (OCR). - # Contains information regarding timestamp and bounding box locations for the - # frames containing detected OCR text snippets. + # Video frame level annotation results for text annotation (OCR). Contains + # information regarding timestamp and bounding box locations for the frames + # containing detected OCR text snippets. class GoogleCloudVideointelligenceV1TextFrame include Google::Apis::Core::Hashable # Normalized bounding polygon for text (that might not be aligned with axis). - # Contains list of the corner points in clockwise order starting from - # top-left corner. For example, for a rectangular bounding box: - # When the text is horizontal it might look like: - # 0----1 - # | | - # 3----2 - # When it's clockwise rotated 180 degrees around the top-left corner it - # becomes: - # 2----3 - # | | - # 1----0 - # and the vertex order will still be (0, 1, 2, 3). Note that values can be less - # than 0, or greater than 1 due to trignometric calculations for location of - # the box. + # Contains list of the corner points in clockwise order starting from top-left + # corner. For example, for a rectangular bounding box: When the text is + # horizontal it might look like: 0----1 | | 3----2 When it's clockwise rotated + # 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the + # vertex order will still be (0, 1, 2, 3). Note that values can be less than 0, + # or greater than 1 due to trignometric calculations for location of the box. # Corresponds to the JSON property `rotatedBoundingBox` # @return [Google::Apis::VideointelligenceV1p1beta1::GoogleCloudVideointelligenceV1NormalizedBoundingPoly] attr_accessor :rotated_bounding_box @@ -706,9 +682,8 @@ module Google end end - # For tracking related features. - # An object at time_offset with attributes, and located with - # normalized_bounding_box. + # For tracking related features. An object at time_offset with attributes, and + # located with normalized_bounding_box. class GoogleCloudVideointelligenceV1TimestampedObject include Google::Apis::Core::Hashable @@ -722,15 +697,14 @@ module Google # @return [Array] attr_accessor :landmarks - # Normalized bounding box. - # The normalized vertex coordinates are relative to the original image. - # Range: [0, 1]. + # Normalized bounding box. The normalized vertex coordinates are relative to the + # original image. Range: [0, 1]. # Corresponds to the JSON property `normalizedBoundingBox` # @return [Google::Apis::VideointelligenceV1p1beta1::GoogleCloudVideointelligenceV1NormalizedBoundingBox] attr_accessor :normalized_bounding_box - # Time-offset, relative to the beginning of the video, - # corresponding to the video frame for this object. + # Time-offset, relative to the beginning of the video, corresponding to the + # video frame for this object. # Corresponds to the JSON property `timeOffset` # @return [String] attr_accessor :time_offset @@ -789,20 +763,19 @@ module Google class GoogleCloudVideointelligenceV1VideoAnnotationProgress include Google::Apis::Core::Hashable - # Specifies which feature is being tracked if the request contains more than - # one feature. + # Specifies which feature is being tracked if the request contains more than one + # feature. # Corresponds to the JSON property `feature` # @return [String] attr_accessor :feature - # Video file location in - # [Cloud Storage](https://cloud.google.com/storage/). + # Video file location in [Cloud Storage](https://cloud.google.com/storage/). # Corresponds to the JSON property `inputUri` # @return [String] attr_accessor :input_uri - # Approximate percentage processed thus far. Guaranteed to be - # 100 when fully processed. + # Approximate percentage processed thus far. Guaranteed to be 100 when fully + # processed. # Corresponds to the JSON property `progressPercent` # @return [Fixnum] attr_accessor :progress_percent @@ -841,31 +814,30 @@ module Google class GoogleCloudVideointelligenceV1VideoAnnotationResults include Google::Apis::Core::Hashable - # 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::VideointelligenceV1p1beta1::GoogleRpcStatus] attr_accessor :error - # Explicit content annotation (based on per-frame visual signals only). - # If no explicit content has been detected in a frame, no annotations are - # present for that frame. + # Explicit content annotation (based on per-frame visual signals only). If no + # explicit content has been detected in a frame, no annotations are present for + # that frame. # Corresponds to the JSON property `explicitAnnotation` # @return [Google::Apis::VideointelligenceV1p1beta1::GoogleCloudVideointelligenceV1ExplicitContentAnnotation] attr_accessor :explicit_annotation - # Label annotations on frame level. - # There is exactly one element for each unique label. + # Label annotations on frame level. There is exactly one element for each unique + # label. # Corresponds to the JSON property `frameLabelAnnotations` # @return [Array] attr_accessor :frame_label_annotations - # Video file location in - # [Cloud Storage](https://cloud.google.com/storage/). + # Video file location in [Cloud Storage](https://cloud.google.com/storage/). # Corresponds to the JSON property `inputUri` # @return [String] attr_accessor :input_uri @@ -892,11 +864,11 @@ module Google attr_accessor :segment_label_annotations # Presence label annotations on video level or user-specified segment level. - # There is exactly one element for each unique label. Compared to the - # existing topical `segment_label_annotations`, this field presents more - # fine-grained, segment-level labels detected in video content and is made - # available only when the client sets `LabelDetectionConfig.model` to - # "builtin/latest" in the request. + # There is exactly one element for each unique label. Compared to the existing + # topical `segment_label_annotations`, this field presents more fine-grained, + # segment-level labels detected in video content and is made available only when + # the client sets `LabelDetectionConfig.model` to "builtin/latest" in the + # request. # Corresponds to the JSON property `segmentPresenceLabelAnnotations` # @return [Array] attr_accessor :segment_presence_label_annotations @@ -906,17 +878,17 @@ module Google # @return [Array] attr_accessor :shot_annotations - # Topical label annotations on shot level. - # There is exactly one element for each unique label. + # Topical label annotations on shot level. There is exactly one element for each + # unique label. # Corresponds to the JSON property `shotLabelAnnotations` # @return [Array] attr_accessor :shot_label_annotations # Presence label annotations on shot level. There is exactly one element for - # each unique label. Compared to the existing topical - # `shot_label_annotations`, this field presents more fine-grained, shot-level - # labels detected in video content and is made available only when the client - # sets `LabelDetectionConfig.model` to "builtin/latest" in the request. + # each unique label. Compared to the existing topical `shot_label_annotations`, + # this field presents more fine-grained, shot-level labels detected in video + # content and is made available only when the client sets `LabelDetectionConfig. + # model` to "builtin/latest" in the request. # Corresponds to the JSON property `shotPresenceLabelAnnotations` # @return [Array] attr_accessor :shot_presence_label_annotations @@ -926,9 +898,8 @@ module Google # @return [Array] attr_accessor :speech_transcriptions - # OCR text detection and tracking. - # Annotations for list of detected text snippets. Each will have list of - # frame information associated with it. + # OCR text detection and tracking. Annotations for list of detected text + # snippets. Each will have list of frame information associated with it. # Corresponds to the JSON property `textAnnotations` # @return [Array] attr_accessor :text_annotations @@ -960,14 +931,14 @@ module Google class GoogleCloudVideointelligenceV1VideoSegment include Google::Apis::Core::Hashable - # Time-offset, relative to the beginning of the video, - # corresponding to the end of the segment (inclusive). + # Time-offset, relative to the beginning of the video, corresponding to the end + # of the segment (inclusive). # Corresponds to the JSON property `endTimeOffset` # @return [String] attr_accessor :end_time_offset - # Time-offset, relative to the beginning of the video, - # corresponding to the start of the segment (inclusive). + # Time-offset, relative to the beginning of the video, corresponding to the + # start of the segment (inclusive). # Corresponds to the JSON property `startTimeOffset` # @return [String] attr_accessor :start_time_offset @@ -984,41 +955,41 @@ module Google end # Word-specific information for recognized words. Word information is only - # included in the response when certain request parameters are set, such - # as `enable_word_time_offsets`. + # included in the response when certain request parameters are set, such as ` + # enable_word_time_offsets`. class GoogleCloudVideointelligenceV1WordInfo include Google::Apis::Core::Hashable # Output only. The confidence estimate between 0.0 and 1.0. A higher number # indicates an estimated greater likelihood that the recognized words are - # correct. This field is set only for the top alternative. - # This field is not guaranteed to be accurate and users should not rely on it - # to be always provided. - # The default of 0.0 is a sentinel value indicating `confidence` was not set. + # correct. This field is set only for the top alternative. This field is not + # guaranteed to be accurate and users should not rely on it to be always + # provided. The default of 0.0 is a sentinel value indicating `confidence` was + # not set. # Corresponds to the JSON property `confidence` # @return [Float] attr_accessor :confidence - # Time offset relative to the beginning of the audio, and - # corresponding to the end of the spoken word. This field is only set if - # `enable_word_time_offsets=true` and only in the top hypothesis. This is an - # experimental feature and the accuracy of the time offset can vary. + # Time offset relative to the beginning of the audio, and corresponding to the + # end of the spoken word. This field is only set if `enable_word_time_offsets= + # true` and only in the top hypothesis. This is an experimental feature and the + # accuracy of the time offset can vary. # Corresponds to the JSON property `endTime` # @return [String] attr_accessor :end_time - # Output only. A distinct integer value is assigned for every speaker within - # the audio. This field specifies which one of those speakers was detected to - # have spoken this word. Value ranges from 1 up to diarization_speaker_count, - # and is only set if speaker diarization is enabled. + # Output only. A distinct integer value is assigned for every speaker within the + # audio. This field specifies which one of those speakers was detected to have + # spoken this word. Value ranges from 1 up to diarization_speaker_count, and is + # only set if speaker diarization is enabled. # Corresponds to the JSON property `speakerTag` # @return [Fixnum] attr_accessor :speaker_tag - # Time offset relative to the beginning of the audio, and - # corresponding to the start of the spoken word. This field is only set if - # `enable_word_time_offsets=true` and only in the top hypothesis. This is an - # experimental feature and the accuracy of the time offset can vary. + # Time offset relative to the beginning of the audio, and corresponding to the + # start of the spoken word. This field is only set if `enable_word_time_offsets= + # true` and only in the top hypothesis. This is an experimental feature and the + # accuracy of the time offset can vary. # Corresponds to the JSON property `startTime` # @return [String] attr_accessor :start_time @@ -1042,9 +1013,9 @@ module Google end end - # Video annotation progress. Included in the `metadata` - # field of the `Operation` returned by the `GetOperation` - # call of the `google::longrunning::Operations` service. + # Video annotation progress. Included in the `metadata` field of the `Operation` + # returned by the `GetOperation` call of the `google::longrunning::Operations` + # service. class GoogleCloudVideointelligenceV1beta2AnnotateVideoProgress include Google::Apis::Core::Hashable @@ -1063,9 +1034,9 @@ module Google end end - # Video annotation response. Included in the `response` - # field of the `Operation` returned by the `GetOperation` - # call of the `google::longrunning::Operations` service. + # Video annotation response. Included in the `response` field of the `Operation` + # returned by the `GetOperation` call of the `google::longrunning::Operations` + # service. class GoogleCloudVideointelligenceV1beta2AnnotateVideoResponse include Google::Apis::Core::Hashable @@ -1093,14 +1064,14 @@ module Google # @return [Float] attr_accessor :confidence - # The name of the attribute, for example, glasses, dark_glasses, mouth_open. - # A full list of supported type names will be provided in the document. + # The name of the attribute, for example, glasses, dark_glasses, mouth_open. A + # full list of supported type names will be provided in the document. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name - # Text value of the detection result. For example, the value for "HairColor" - # can be "black", "blonde", etc. + # Text value of the detection result. For example, the value for "HairColor" can + # be "black", "blonde", etc. # Corresponds to the JSON property `value` # @return [String] attr_accessor :value @@ -1132,9 +1103,8 @@ module Google # @return [String] attr_accessor :name - # A vertex represents a 2D point in the image. - # NOTE: the normalized vertex coordinates are relative to the original image - # and range from 0 to 1. + # A vertex represents a 2D point in the image. NOTE: the normalized vertex + # coordinates are relative to the original image and range from 0 to 1. # Corresponds to the JSON property `point` # @return [Google::Apis::VideointelligenceV1p1beta1::GoogleCloudVideointelligenceV1beta2NormalizedVertex] attr_accessor :point @@ -1160,8 +1130,7 @@ module Google # @return [String] attr_accessor :description - # Opaque entity ID. Some IDs may be available in - # [Google Knowledge Graph Search + # Opaque entity ID. Some IDs may be available in [Google Knowledge Graph Search # API](https://developers.google.com/knowledge-graph/). # Corresponds to the JSON property `entityId` # @return [String] @@ -1184,9 +1153,9 @@ module Google end end - # Explicit content annotation (based on per-frame visual signals only). - # If no explicit content has been detected in a frame, no annotations are - # present for that frame. + # Explicit content annotation (based on per-frame visual signals only). If no + # explicit content has been detected in a frame, no annotations are present for + # that frame. class GoogleCloudVideointelligenceV1beta2ExplicitContentAnnotation include Google::Apis::Core::Hashable @@ -1241,10 +1210,9 @@ module Google class GoogleCloudVideointelligenceV1beta2LabelAnnotation include Google::Apis::Core::Hashable - # Common categories for the detected entity. - # For example, when the label is `Terrier`, the category is likely `dog`. And - # in some cases there might be more than one categories e.g., `Terrier` could - # also be a `pet`. + # Common categories for the detected entity. For example, when the label is ` + # Terrier`, the category is likely `dog`. And in some cases there might be more + # than one categories e.g., `Terrier` could also be a `pet`. # Corresponds to the JSON property `categoryEntities` # @return [Array] attr_accessor :category_entities @@ -1343,14 +1311,14 @@ module Google # @return [Google::Apis::VideointelligenceV1p1beta1::GoogleCloudVideointelligenceV1beta2Entity] attr_accessor :entity - # All video segments where the recognized logo appears. There might be - # multiple instances of the same logo class appearing in one VideoSegment. + # All video segments where the recognized logo appears. There might be multiple + # instances of the same logo class appearing in one VideoSegment. # Corresponds to the JSON property `segments` # @return [Array] attr_accessor :segments - # All logo tracks where the recognized logo appears. Each track corresponds - # to one logo instance appearing in consecutive frames. + # All logo tracks where the recognized logo appears. Each track corresponds to + # one logo instance appearing in consecutive frames. # Corresponds to the JSON property `tracks` # @return [Array] attr_accessor :tracks @@ -1367,9 +1335,8 @@ module Google end end - # Normalized bounding box. - # The normalized vertex coordinates are relative to the original image. - # Range: [0, 1]. + # Normalized bounding box. The normalized vertex coordinates are relative to the + # original image. Range: [0, 1]. class GoogleCloudVideointelligenceV1beta2NormalizedBoundingBox include Google::Apis::Core::Hashable @@ -1407,20 +1374,12 @@ module Google end # Normalized bounding polygon for text (that might not be aligned with axis). - # Contains list of the corner points in clockwise order starting from - # top-left corner. For example, for a rectangular bounding box: - # When the text is horizontal it might look like: - # 0----1 - # | | - # 3----2 - # When it's clockwise rotated 180 degrees around the top-left corner it - # becomes: - # 2----3 - # | | - # 1----0 - # and the vertex order will still be (0, 1, 2, 3). Note that values can be less - # than 0, or greater than 1 due to trignometric calculations for location of - # the box. + # Contains list of the corner points in clockwise order starting from top-left + # corner. For example, for a rectangular bounding box: When the text is + # horizontal it might look like: 0----1 | | 3----2 When it's clockwise rotated + # 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the + # vertex order will still be (0, 1, 2, 3). Note that values can be less than 0, + # or greater than 1 due to trignometric calculations for location of the box. class GoogleCloudVideointelligenceV1beta2NormalizedBoundingPoly include Google::Apis::Core::Hashable @@ -1439,9 +1398,8 @@ module Google end end - # A vertex represents a 2D point in the image. - # NOTE: the normalized vertex coordinates are relative to the original image - # and range from 0 to 1. + # A vertex represents a 2D point in the image. NOTE: the normalized vertex + # coordinates are relative to the original image and range from 0 to 1. class GoogleCloudVideointelligenceV1beta2NormalizedVertex include Google::Apis::Core::Hashable @@ -1480,10 +1438,10 @@ module Google # @return [Google::Apis::VideointelligenceV1p1beta1::GoogleCloudVideointelligenceV1beta2Entity] attr_accessor :entity - # Information corresponding to all frames where this object track appears. - # Non-streaming batch mode: it may be one or multiple ObjectTrackingFrame - # messages in frames. - # Streaming mode: it can only be one ObjectTrackingFrame message in frames. + # Information corresponding to all frames where this object track appears. Non- + # streaming batch mode: it may be one or multiple ObjectTrackingFrame messages + # in frames. Streaming mode: it can only be one ObjectTrackingFrame message in + # frames. # Corresponds to the JSON property `frames` # @return [Array] attr_accessor :frames @@ -1493,12 +1451,11 @@ module Google # @return [Google::Apis::VideointelligenceV1p1beta1::GoogleCloudVideointelligenceV1beta2VideoSegment] attr_accessor :segment - # Streaming mode ONLY. - # In streaming mode, we do not know the end time of a tracked object - # before it is completed. Hence, there is no VideoSegment info returned. - # Instead, we provide a unique identifiable integer track_id so that - # the customers can correlate the results of the ongoing - # ObjectTrackAnnotation of the same track_id over time. + # Streaming mode ONLY. In streaming mode, we do not know the end time of a + # tracked object before it is completed. Hence, there is no VideoSegment info + # returned. Instead, we provide a unique identifiable integer track_id so that + # the customers can correlate the results of the ongoing ObjectTrackAnnotation + # of the same track_id over time. # Corresponds to the JSON property `trackId` # @return [Fixnum] attr_accessor :track_id @@ -1528,9 +1485,8 @@ module Google class GoogleCloudVideointelligenceV1beta2ObjectTrackingFrame include Google::Apis::Core::Hashable - # Normalized bounding box. - # The normalized vertex coordinates are relative to the original image. - # Range: [0, 1]. + # Normalized bounding box. The normalized vertex coordinates are relative to the + # original image. Range: [0, 1]. # Corresponds to the JSON property `normalizedBoundingBox` # @return [Google::Apis::VideointelligenceV1p1beta1::GoogleCloudVideointelligenceV1beta2NormalizedBoundingBox] attr_accessor :normalized_bounding_box @@ -1557,10 +1513,10 @@ module Google # Output only. The confidence estimate between 0.0 and 1.0. A higher number # indicates an estimated greater likelihood that the recognized words are - # correct. This field is set only for the top alternative. - # This field is not guaranteed to be accurate and users should not rely on it - # to be always provided. - # The default of 0.0 is a sentinel value indicating `confidence` was not set. + # correct. This field is set only for the top alternative. This field is not + # guaranteed to be accurate and users should not rely on it to be always + # provided. The default of 0.0 is a sentinel value indicating `confidence` was + # not set. # Corresponds to the JSON property `confidence` # @return [Float] attr_accessor :confidence @@ -1571,8 +1527,8 @@ module Google attr_accessor :transcript # Output only. A list of word-specific information for each recognized word. - # Note: When `enable_speaker_diarization` is set to true, you will see all - # the words from the beginning of the audio. + # Note: When `enable_speaker_diarization` is set to true, you will see all the + # words from the beginning of the audio. # Corresponds to the JSON property `words` # @return [Array] attr_accessor :words @@ -1593,18 +1549,17 @@ module Google class GoogleCloudVideointelligenceV1beta2SpeechTranscription include Google::Apis::Core::Hashable - # May contain one or more recognition hypotheses (up to the maximum specified - # in `max_alternatives`). These alternatives are ordered in terms of - # accuracy, with the top (first) alternative being the most probable, as - # ranked by the recognizer. + # May contain one or more recognition hypotheses (up to the maximum specified in + # `max_alternatives`). These alternatives are ordered in terms of accuracy, with + # the top (first) alternative being the most probable, as ranked by the + # recognizer. # Corresponds to the JSON property `alternatives` # @return [Array] attr_accessor :alternatives # Output only. The [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) - # language tag of - # the language in this result. This language code was detected to have the - # most likelihood of being spoken in the audio. + # language tag of the language in this result. This language code was detected + # to have the most likelihood of being spoken in the audio. # Corresponds to the JSON property `languageCode` # @return [String] attr_accessor :language_code @@ -1653,27 +1608,19 @@ module Google end end - # Video frame level annotation results for text annotation (OCR). - # Contains information regarding timestamp and bounding box locations for the - # frames containing detected OCR text snippets. + # Video frame level annotation results for text annotation (OCR). Contains + # information regarding timestamp and bounding box locations for the frames + # containing detected OCR text snippets. class GoogleCloudVideointelligenceV1beta2TextFrame include Google::Apis::Core::Hashable # Normalized bounding polygon for text (that might not be aligned with axis). - # Contains list of the corner points in clockwise order starting from - # top-left corner. For example, for a rectangular bounding box: - # When the text is horizontal it might look like: - # 0----1 - # | | - # 3----2 - # When it's clockwise rotated 180 degrees around the top-left corner it - # becomes: - # 2----3 - # | | - # 1----0 - # and the vertex order will still be (0, 1, 2, 3). Note that values can be less - # than 0, or greater than 1 due to trignometric calculations for location of - # the box. + # Contains list of the corner points in clockwise order starting from top-left + # corner. For example, for a rectangular bounding box: When the text is + # horizontal it might look like: 0----1 | | 3----2 When it's clockwise rotated + # 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the + # vertex order will still be (0, 1, 2, 3). Note that values can be less than 0, + # or greater than 1 due to trignometric calculations for location of the box. # Corresponds to the JSON property `rotatedBoundingBox` # @return [Google::Apis::VideointelligenceV1p1beta1::GoogleCloudVideointelligenceV1beta2NormalizedBoundingPoly] attr_accessor :rotated_bounding_box @@ -1726,9 +1673,8 @@ module Google end end - # For tracking related features. - # An object at time_offset with attributes, and located with - # normalized_bounding_box. + # For tracking related features. An object at time_offset with attributes, and + # located with normalized_bounding_box. class GoogleCloudVideointelligenceV1beta2TimestampedObject include Google::Apis::Core::Hashable @@ -1742,15 +1688,14 @@ module Google # @return [Array] attr_accessor :landmarks - # Normalized bounding box. - # The normalized vertex coordinates are relative to the original image. - # Range: [0, 1]. + # Normalized bounding box. The normalized vertex coordinates are relative to the + # original image. Range: [0, 1]. # Corresponds to the JSON property `normalizedBoundingBox` # @return [Google::Apis::VideointelligenceV1p1beta1::GoogleCloudVideointelligenceV1beta2NormalizedBoundingBox] attr_accessor :normalized_bounding_box - # Time-offset, relative to the beginning of the video, - # corresponding to the video frame for this object. + # Time-offset, relative to the beginning of the video, corresponding to the + # video frame for this object. # Corresponds to the JSON property `timeOffset` # @return [String] attr_accessor :time_offset @@ -1809,20 +1754,19 @@ module Google class GoogleCloudVideointelligenceV1beta2VideoAnnotationProgress include Google::Apis::Core::Hashable - # Specifies which feature is being tracked if the request contains more than - # one feature. + # Specifies which feature is being tracked if the request contains more than one + # feature. # Corresponds to the JSON property `feature` # @return [String] attr_accessor :feature - # Video file location in - # [Cloud Storage](https://cloud.google.com/storage/). + # Video file location in [Cloud Storage](https://cloud.google.com/storage/). # Corresponds to the JSON property `inputUri` # @return [String] attr_accessor :input_uri - # Approximate percentage processed thus far. Guaranteed to be - # 100 when fully processed. + # Approximate percentage processed thus far. Guaranteed to be 100 when fully + # processed. # Corresponds to the JSON property `progressPercent` # @return [Fixnum] attr_accessor :progress_percent @@ -1861,31 +1805,30 @@ module Google class GoogleCloudVideointelligenceV1beta2VideoAnnotationResults include Google::Apis::Core::Hashable - # 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::VideointelligenceV1p1beta1::GoogleRpcStatus] attr_accessor :error - # Explicit content annotation (based on per-frame visual signals only). - # If no explicit content has been detected in a frame, no annotations are - # present for that frame. + # Explicit content annotation (based on per-frame visual signals only). If no + # explicit content has been detected in a frame, no annotations are present for + # that frame. # Corresponds to the JSON property `explicitAnnotation` # @return [Google::Apis::VideointelligenceV1p1beta1::GoogleCloudVideointelligenceV1beta2ExplicitContentAnnotation] attr_accessor :explicit_annotation - # Label annotations on frame level. - # There is exactly one element for each unique label. + # Label annotations on frame level. There is exactly one element for each unique + # label. # Corresponds to the JSON property `frameLabelAnnotations` # @return [Array] attr_accessor :frame_label_annotations - # Video file location in - # [Cloud Storage](https://cloud.google.com/storage/). + # Video file location in [Cloud Storage](https://cloud.google.com/storage/). # Corresponds to the JSON property `inputUri` # @return [String] attr_accessor :input_uri @@ -1912,11 +1855,11 @@ module Google attr_accessor :segment_label_annotations # Presence label annotations on video level or user-specified segment level. - # There is exactly one element for each unique label. Compared to the - # existing topical `segment_label_annotations`, this field presents more - # fine-grained, segment-level labels detected in video content and is made - # available only when the client sets `LabelDetectionConfig.model` to - # "builtin/latest" in the request. + # There is exactly one element for each unique label. Compared to the existing + # topical `segment_label_annotations`, this field presents more fine-grained, + # segment-level labels detected in video content and is made available only when + # the client sets `LabelDetectionConfig.model` to "builtin/latest" in the + # request. # Corresponds to the JSON property `segmentPresenceLabelAnnotations` # @return [Array] attr_accessor :segment_presence_label_annotations @@ -1926,17 +1869,17 @@ module Google # @return [Array] attr_accessor :shot_annotations - # Topical label annotations on shot level. - # There is exactly one element for each unique label. + # Topical label annotations on shot level. There is exactly one element for each + # unique label. # Corresponds to the JSON property `shotLabelAnnotations` # @return [Array] attr_accessor :shot_label_annotations # Presence label annotations on shot level. There is exactly one element for - # each unique label. Compared to the existing topical - # `shot_label_annotations`, this field presents more fine-grained, shot-level - # labels detected in video content and is made available only when the client - # sets `LabelDetectionConfig.model` to "builtin/latest" in the request. + # each unique label. Compared to the existing topical `shot_label_annotations`, + # this field presents more fine-grained, shot-level labels detected in video + # content and is made available only when the client sets `LabelDetectionConfig. + # model` to "builtin/latest" in the request. # Corresponds to the JSON property `shotPresenceLabelAnnotations` # @return [Array] attr_accessor :shot_presence_label_annotations @@ -1946,9 +1889,8 @@ module Google # @return [Array] attr_accessor :speech_transcriptions - # OCR text detection and tracking. - # Annotations for list of detected text snippets. Each will have list of - # frame information associated with it. + # OCR text detection and tracking. Annotations for list of detected text + # snippets. Each will have list of frame information associated with it. # Corresponds to the JSON property `textAnnotations` # @return [Array] attr_accessor :text_annotations @@ -1980,14 +1922,14 @@ module Google class GoogleCloudVideointelligenceV1beta2VideoSegment include Google::Apis::Core::Hashable - # Time-offset, relative to the beginning of the video, - # corresponding to the end of the segment (inclusive). + # Time-offset, relative to the beginning of the video, corresponding to the end + # of the segment (inclusive). # Corresponds to the JSON property `endTimeOffset` # @return [String] attr_accessor :end_time_offset - # Time-offset, relative to the beginning of the video, - # corresponding to the start of the segment (inclusive). + # Time-offset, relative to the beginning of the video, corresponding to the + # start of the segment (inclusive). # Corresponds to the JSON property `startTimeOffset` # @return [String] attr_accessor :start_time_offset @@ -2004,41 +1946,41 @@ module Google end # Word-specific information for recognized words. Word information is only - # included in the response when certain request parameters are set, such - # as `enable_word_time_offsets`. + # included in the response when certain request parameters are set, such as ` + # enable_word_time_offsets`. class GoogleCloudVideointelligenceV1beta2WordInfo include Google::Apis::Core::Hashable # Output only. The confidence estimate between 0.0 and 1.0. A higher number # indicates an estimated greater likelihood that the recognized words are - # correct. This field is set only for the top alternative. - # This field is not guaranteed to be accurate and users should not rely on it - # to be always provided. - # The default of 0.0 is a sentinel value indicating `confidence` was not set. + # correct. This field is set only for the top alternative. This field is not + # guaranteed to be accurate and users should not rely on it to be always + # provided. The default of 0.0 is a sentinel value indicating `confidence` was + # not set. # Corresponds to the JSON property `confidence` # @return [Float] attr_accessor :confidence - # Time offset relative to the beginning of the audio, and - # corresponding to the end of the spoken word. This field is only set if - # `enable_word_time_offsets=true` and only in the top hypothesis. This is an - # experimental feature and the accuracy of the time offset can vary. + # Time offset relative to the beginning of the audio, and corresponding to the + # end of the spoken word. This field is only set if `enable_word_time_offsets= + # true` and only in the top hypothesis. This is an experimental feature and the + # accuracy of the time offset can vary. # Corresponds to the JSON property `endTime` # @return [String] attr_accessor :end_time - # Output only. A distinct integer value is assigned for every speaker within - # the audio. This field specifies which one of those speakers was detected to - # have spoken this word. Value ranges from 1 up to diarization_speaker_count, - # and is only set if speaker diarization is enabled. + # Output only. A distinct integer value is assigned for every speaker within the + # audio. This field specifies which one of those speakers was detected to have + # spoken this word. Value ranges from 1 up to diarization_speaker_count, and is + # only set if speaker diarization is enabled. # Corresponds to the JSON property `speakerTag` # @return [Fixnum] attr_accessor :speaker_tag - # Time offset relative to the beginning of the audio, and - # corresponding to the start of the spoken word. This field is only set if - # `enable_word_time_offsets=true` and only in the top hypothesis. This is an - # experimental feature and the accuracy of the time offset can vary. + # Time offset relative to the beginning of the audio, and corresponding to the + # start of the spoken word. This field is only set if `enable_word_time_offsets= + # true` and only in the top hypothesis. This is an experimental feature and the + # accuracy of the time offset can vary. # Corresponds to the JSON property `startTime` # @return [String] attr_accessor :start_time @@ -2062,9 +2004,9 @@ module Google end end - # Video annotation progress. Included in the `metadata` - # field of the `Operation` returned by the `GetOperation` - # call of the `google::longrunning::Operations` service. + # Video annotation progress. Included in the `metadata` field of the `Operation` + # returned by the `GetOperation` call of the `google::longrunning::Operations` + # service. class GoogleCloudVideointelligenceV1p1beta1AnnotateVideoProgress include Google::Apis::Core::Hashable @@ -2092,24 +2034,22 @@ module Google # @return [Array] attr_accessor :features - # The video data bytes. - # If unset, the input video(s) should be specified via the `input_uri`. - # If set, `input_uri` must be unset. + # The video data bytes. If unset, the input video(s) should be specified via the + # `input_uri`. If set, `input_uri` must be unset. # Corresponds to the JSON property `inputContent` # NOTE: Values are automatically base64 encoded/decoded in the client library. # @return [String] attr_accessor :input_content - # Input video location. Currently, only - # [Cloud Storage](https://cloud.google.com/storage/) URIs are - # supported. URIs must be specified in the following format: - # `gs://bucket-id/object-id` (other URI formats return - # google.rpc.Code.INVALID_ARGUMENT). For more information, see - # [Request URIs](https://cloud.google.com/storage/docs/request-endpoints). - # To identify multiple videos, a video URI may include wildcards in the - # `object-id`. Supported wildcards: '*' to match 0 or more characters; - # '?' to match 1 character. If unset, the input video should be embedded - # in the request as `input_content`. If set, `input_content` must be unset. + # Input video location. Currently, only [Cloud Storage](https://cloud.google.com/ + # storage/) URIs are supported. URIs must be specified in the following format: ` + # gs://bucket-id/object-id` (other URI formats return google.rpc.Code. + # INVALID_ARGUMENT). For more information, see [Request URIs](https://cloud. + # google.com/storage/docs/request-endpoints). To identify multiple videos, a + # video URI may include wildcards in the `object-id`. Supported wildcards: '*' + # to match 0 or more characters; '?' to match 1 character. If unset, the input + # video should be embedded in the request as `input_content`. If set, ` + # input_content` must be unset. # Corresponds to the JSON property `inputUri` # @return [String] attr_accessor :input_uri @@ -2123,11 +2063,11 @@ module Google attr_accessor :location_id # Optional. Location where the output (in JSON format) should be stored. - # Currently, only [Cloud Storage](https://cloud.google.com/storage/) - # URIs are supported. These must be specified in the following format: - # `gs://bucket-id/object-id` (other URI formats return - # google.rpc.Code.INVALID_ARGUMENT). For more information, see - # [Request URIs](https://cloud.google.com/storage/docs/request-endpoints). + # Currently, only [Cloud Storage](https://cloud.google.com/storage/) URIs are + # supported. These must be specified in the following format: `gs://bucket-id/ + # object-id` (other URI formats return google.rpc.Code.INVALID_ARGUMENT). For + # more information, see [Request URIs](https://cloud.google.com/storage/docs/ + # request-endpoints). # Corresponds to the JSON property `outputUri` # @return [String] attr_accessor :output_uri @@ -2152,9 +2092,9 @@ module Google end end - # Video annotation response. Included in the `response` - # field of the `Operation` returned by the `GetOperation` - # call of the `google::longrunning::Operations` service. + # Video annotation response. Included in the `response` field of the `Operation` + # returned by the `GetOperation` call of the `google::longrunning::Operations` + # service. class GoogleCloudVideointelligenceV1p1beta1AnnotateVideoResponse include Google::Apis::Core::Hashable @@ -2182,14 +2122,14 @@ module Google # @return [Float] attr_accessor :confidence - # The name of the attribute, for example, glasses, dark_glasses, mouth_open. - # A full list of supported type names will be provided in the document. + # The name of the attribute, for example, glasses, dark_glasses, mouth_open. A + # full list of supported type names will be provided in the document. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name - # Text value of the detection result. For example, the value for "HairColor" - # can be "black", "blonde", etc. + # Text value of the detection result. For example, the value for "HairColor" can + # be "black", "blonde", etc. # Corresponds to the JSON property `value` # @return [String] attr_accessor :value @@ -2221,9 +2161,8 @@ module Google # @return [String] attr_accessor :name - # A vertex represents a 2D point in the image. - # NOTE: the normalized vertex coordinates are relative to the original image - # and range from 0 to 1. + # A vertex represents a 2D point in the image. NOTE: the normalized vertex + # coordinates are relative to the original image and range from 0 to 1. # Corresponds to the JSON property `point` # @return [Google::Apis::VideointelligenceV1p1beta1::GoogleCloudVideointelligenceV1p1beta1NormalizedVertex] attr_accessor :point @@ -2249,8 +2188,7 @@ module Google # @return [String] attr_accessor :description - # Opaque entity ID. Some IDs may be available in - # [Google Knowledge Graph Search + # Opaque entity ID. Some IDs may be available in [Google Knowledge Graph Search # API](https://developers.google.com/knowledge-graph/). # Corresponds to the JSON property `entityId` # @return [String] @@ -2273,9 +2211,9 @@ module Google end end - # Explicit content annotation (based on per-frame visual signals only). - # If no explicit content has been detected in a frame, no annotations are - # present for that frame. + # Explicit content annotation (based on per-frame visual signals only). If no + # explicit content has been detected in a frame, no annotations are present for + # that frame. class GoogleCloudVideointelligenceV1p1beta1ExplicitContentAnnotation include Google::Apis::Core::Hashable @@ -2304,9 +2242,8 @@ module Google class GoogleCloudVideointelligenceV1p1beta1ExplicitContentDetectionConfig include Google::Apis::Core::Hashable - # Model to use for explicit content detection. - # Supported values: "builtin/stable" (the default if unset) and - # "builtin/latest". + # Model to use for explicit content detection. Supported values: "builtin/stable" + # (the default if unset) and "builtin/latest". # Corresponds to the JSON property `model` # @return [String] attr_accessor :model @@ -2351,10 +2288,9 @@ module Google class GoogleCloudVideointelligenceV1p1beta1LabelAnnotation include Google::Apis::Core::Hashable - # Common categories for the detected entity. - # For example, when the label is `Terrier`, the category is likely `dog`. And - # in some cases there might be more than one categories e.g., `Terrier` could - # also be a `pet`. + # Common categories for the detected entity. For example, when the label is ` + # Terrier`, the category is likely `dog`. And in some cases there might be more + # than one categories e.g., `Terrier` could also be a `pet`. # Corresponds to the JSON property `categoryEntities` # @return [Array] attr_accessor :category_entities @@ -2397,44 +2333,40 @@ module Google class GoogleCloudVideointelligenceV1p1beta1LabelDetectionConfig include Google::Apis::Core::Hashable - # The confidence threshold we perform filtering on the labels from - # frame-level detection. If not set, it is set to 0.4 by default. The valid - # range for this threshold is [0.1, 0.9]. Any value set outside of this - # range will be clipped. - # Note: For best results, follow the default threshold. We will update - # the default threshold everytime when we release a new model. + # The confidence threshold we perform filtering on the labels from frame-level + # detection. If not set, it is set to 0.4 by default. The valid range for this + # threshold is [0.1, 0.9]. Any value set outside of this range will be clipped. + # Note: For best results, follow the default threshold. We will update the + # default threshold everytime when we release a new model. # Corresponds to the JSON property `frameConfidenceThreshold` # @return [Float] attr_accessor :frame_confidence_threshold - # What labels should be detected with LABEL_DETECTION, in addition to - # video-level labels or segment-level labels. - # If unspecified, defaults to `SHOT_MODE`. + # What labels should be detected with LABEL_DETECTION, in addition to video- + # level labels or segment-level labels. If unspecified, defaults to `SHOT_MODE`. # Corresponds to the JSON property `labelDetectionMode` # @return [String] attr_accessor :label_detection_mode - # Model to use for label detection. - # Supported values: "builtin/stable" (the default if unset) and - # "builtin/latest". + # Model to use for label detection. Supported values: "builtin/stable" (the + # default if unset) and "builtin/latest". # Corresponds to the JSON property `model` # @return [String] attr_accessor :model - # Whether the video has been shot from a stationary (i.e., non-moving) - # camera. When set to true, might improve detection accuracy for moving - # objects. Should be used with `SHOT_AND_FRAME_MODE` enabled. + # Whether the video has been shot from a stationary (i.e., non-moving) camera. + # When set to true, might improve detection accuracy for moving objects. Should + # be used with `SHOT_AND_FRAME_MODE` enabled. # Corresponds to the JSON property `stationaryCamera` # @return [Boolean] attr_accessor :stationary_camera alias_method :stationary_camera?, :stationary_camera - # The confidence threshold we perform filtering on the labels from - # video-level and shot-level detections. If not set, it's set to 0.3 by - # default. The valid range for this threshold is [0.1, 0.9]. Any value set - # outside of this range will be clipped. - # Note: For best results, follow the default threshold. We will update - # the default threshold everytime when we release a new model. + # The confidence threshold we perform filtering on the labels from video-level + # and shot-level detections. If not set, it's set to 0.3 by default. The valid + # range for this threshold is [0.1, 0.9]. Any value set outside of this range + # will be clipped. Note: For best results, follow the default threshold. We will + # update the default threshold everytime when we release a new model. # Corresponds to the JSON property `videoConfidenceThreshold` # @return [Float] attr_accessor :video_confidence_threshold @@ -2513,14 +2445,14 @@ module Google # @return [Google::Apis::VideointelligenceV1p1beta1::GoogleCloudVideointelligenceV1p1beta1Entity] attr_accessor :entity - # All video segments where the recognized logo appears. There might be - # multiple instances of the same logo class appearing in one VideoSegment. + # All video segments where the recognized logo appears. There might be multiple + # instances of the same logo class appearing in one VideoSegment. # Corresponds to the JSON property `segments` # @return [Array] attr_accessor :segments - # All logo tracks where the recognized logo appears. Each track corresponds - # to one logo instance appearing in consecutive frames. + # All logo tracks where the recognized logo appears. Each track corresponds to + # one logo instance appearing in consecutive frames. # Corresponds to the JSON property `tracks` # @return [Array] attr_accessor :tracks @@ -2537,9 +2469,8 @@ module Google end end - # Normalized bounding box. - # The normalized vertex coordinates are relative to the original image. - # Range: [0, 1]. + # Normalized bounding box. The normalized vertex coordinates are relative to the + # original image. Range: [0, 1]. class GoogleCloudVideointelligenceV1p1beta1NormalizedBoundingBox include Google::Apis::Core::Hashable @@ -2577,20 +2508,12 @@ module Google end # Normalized bounding polygon for text (that might not be aligned with axis). - # Contains list of the corner points in clockwise order starting from - # top-left corner. For example, for a rectangular bounding box: - # When the text is horizontal it might look like: - # 0----1 - # | | - # 3----2 - # When it's clockwise rotated 180 degrees around the top-left corner it - # becomes: - # 2----3 - # | | - # 1----0 - # and the vertex order will still be (0, 1, 2, 3). Note that values can be less - # than 0, or greater than 1 due to trignometric calculations for location of - # the box. + # Contains list of the corner points in clockwise order starting from top-left + # corner. For example, for a rectangular bounding box: When the text is + # horizontal it might look like: 0----1 | | 3----2 When it's clockwise rotated + # 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the + # vertex order will still be (0, 1, 2, 3). Note that values can be less than 0, + # or greater than 1 due to trignometric calculations for location of the box. class GoogleCloudVideointelligenceV1p1beta1NormalizedBoundingPoly include Google::Apis::Core::Hashable @@ -2609,9 +2532,8 @@ module Google end end - # A vertex represents a 2D point in the image. - # NOTE: the normalized vertex coordinates are relative to the original image - # and range from 0 to 1. + # A vertex represents a 2D point in the image. NOTE: the normalized vertex + # coordinates are relative to the original image and range from 0 to 1. class GoogleCloudVideointelligenceV1p1beta1NormalizedVertex include Google::Apis::Core::Hashable @@ -2650,10 +2572,10 @@ module Google # @return [Google::Apis::VideointelligenceV1p1beta1::GoogleCloudVideointelligenceV1p1beta1Entity] attr_accessor :entity - # Information corresponding to all frames where this object track appears. - # Non-streaming batch mode: it may be one or multiple ObjectTrackingFrame - # messages in frames. - # Streaming mode: it can only be one ObjectTrackingFrame message in frames. + # Information corresponding to all frames where this object track appears. Non- + # streaming batch mode: it may be one or multiple ObjectTrackingFrame messages + # in frames. Streaming mode: it can only be one ObjectTrackingFrame message in + # frames. # Corresponds to the JSON property `frames` # @return [Array] attr_accessor :frames @@ -2663,12 +2585,11 @@ module Google # @return [Google::Apis::VideointelligenceV1p1beta1::GoogleCloudVideointelligenceV1p1beta1VideoSegment] attr_accessor :segment - # Streaming mode ONLY. - # In streaming mode, we do not know the end time of a tracked object - # before it is completed. Hence, there is no VideoSegment info returned. - # Instead, we provide a unique identifiable integer track_id so that - # the customers can correlate the results of the ongoing - # ObjectTrackAnnotation of the same track_id over time. + # Streaming mode ONLY. In streaming mode, we do not know the end time of a + # tracked object before it is completed. Hence, there is no VideoSegment info + # returned. Instead, we provide a unique identifiable integer track_id so that + # the customers can correlate the results of the ongoing ObjectTrackAnnotation + # of the same track_id over time. # Corresponds to the JSON property `trackId` # @return [Fixnum] attr_accessor :track_id @@ -2697,9 +2618,8 @@ module Google class GoogleCloudVideointelligenceV1p1beta1ObjectTrackingConfig include Google::Apis::Core::Hashable - # Model to use for object tracking. - # Supported values: "builtin/stable" (the default if unset) and - # "builtin/latest". + # Model to use for object tracking. Supported values: "builtin/stable" (the + # default if unset) and "builtin/latest". # Corresponds to the JSON property `model` # @return [String] attr_accessor :model @@ -2719,9 +2639,8 @@ module Google class GoogleCloudVideointelligenceV1p1beta1ObjectTrackingFrame include Google::Apis::Core::Hashable - # Normalized bounding box. - # The normalized vertex coordinates are relative to the original image. - # Range: [0, 1]. + # Normalized bounding box. The normalized vertex coordinates are relative to the + # original image. Range: [0, 1]. # Corresponds to the JSON property `normalizedBoundingBox` # @return [Google::Apis::VideointelligenceV1p1beta1::GoogleCloudVideointelligenceV1p1beta1NormalizedBoundingBox] attr_accessor :normalized_bounding_box @@ -2746,9 +2665,8 @@ module Google class GoogleCloudVideointelligenceV1p1beta1ShotChangeDetectionConfig include Google::Apis::Core::Hashable - # Model to use for shot change detection. - # Supported values: "builtin/stable" (the default if unset) and - # "builtin/latest". + # Model to use for shot change detection. Supported values: "builtin/stable" ( + # the default if unset) and "builtin/latest". # Corresponds to the JSON property `model` # @return [String] attr_accessor :model @@ -2768,12 +2686,12 @@ module Google class GoogleCloudVideointelligenceV1p1beta1SpeechContext include Google::Apis::Core::Hashable - # Optional. A list of strings containing words and phrases "hints" so that - # the speech recognition is more likely to recognize them. This can be used - # to improve the accuracy for specific words and phrases, for example, if - # specific commands are typically spoken by the user. This can also be used - # to add additional words to the vocabulary of the recognizer. See - # [usage limits](https://cloud.google.com/speech/limits#content). + # Optional. A list of strings containing words and phrases "hints" so that the + # speech recognition is more likely to recognize them. This can be used to + # improve the accuracy for specific words and phrases, for example, if specific + # commands are typically spoken by the user. This can also be used to add + # additional words to the vocabulary of the recognizer. See [usage limits](https: + # //cloud.google.com/speech/limits#content). # Corresponds to the JSON property `phrases` # @return [Array] attr_accessor :phrases @@ -2794,10 +2712,10 @@ module Google # Output only. The confidence estimate between 0.0 and 1.0. A higher number # indicates an estimated greater likelihood that the recognized words are - # correct. This field is set only for the top alternative. - # This field is not guaranteed to be accurate and users should not rely on it - # to be always provided. - # The default of 0.0 is a sentinel value indicating `confidence` was not set. + # correct. This field is set only for the top alternative. This field is not + # guaranteed to be accurate and users should not rely on it to be always + # provided. The default of 0.0 is a sentinel value indicating `confidence` was + # not set. # Corresponds to the JSON property `confidence` # @return [Float] attr_accessor :confidence @@ -2808,8 +2726,8 @@ module Google attr_accessor :transcript # Output only. A list of word-specific information for each recognized word. - # Note: When `enable_speaker_diarization` is set to true, you will see all - # the words from the beginning of the audio. + # Note: When `enable_speaker_diarization` is set to true, you will see all the + # words from the beginning of the audio. # Corresponds to the JSON property `words` # @return [Array] attr_accessor :words @@ -2830,18 +2748,17 @@ module Google class GoogleCloudVideointelligenceV1p1beta1SpeechTranscription include Google::Apis::Core::Hashable - # May contain one or more recognition hypotheses (up to the maximum specified - # in `max_alternatives`). These alternatives are ordered in terms of - # accuracy, with the top (first) alternative being the most probable, as - # ranked by the recognizer. + # May contain one or more recognition hypotheses (up to the maximum specified in + # `max_alternatives`). These alternatives are ordered in terms of accuracy, with + # the top (first) alternative being the most probable, as ranked by the + # recognizer. # Corresponds to the JSON property `alternatives` # @return [Array] attr_accessor :alternatives # Output only. The [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) - # language tag of - # the language in this result. This language code was detected to have the - # most likelihood of being spoken in the audio. + # language tag of the language in this result. This language code was detected + # to have the most likelihood of being spoken in the audio. # Corresponds to the JSON property `languageCode` # @return [String] attr_accessor :language_code @@ -2868,66 +2785,62 @@ module Google attr_accessor :audio_tracks # Optional. If set, specifies the estimated number of speakers in the - # conversation. - # If not set, defaults to '2'. - # Ignored unless enable_speaker_diarization is set to true. + # conversation. If not set, defaults to '2'. Ignored unless + # enable_speaker_diarization is set to true. # Corresponds to the JSON property `diarizationSpeakerCount` # @return [Fixnum] attr_accessor :diarization_speaker_count - # Optional. If 'true', adds punctuation to recognition result hypotheses. - # This feature is only available in select languages. Setting this for - # requests in other languages has no effect at all. The default 'false' value - # does not add punctuation to result hypotheses. NOTE: "This is currently - # offered as an experimental service, complimentary to all users. In the - # future this may be exclusively available as a premium feature." + # Optional. If 'true', adds punctuation to recognition result hypotheses. This + # feature is only available in select languages. Setting this for requests in + # other languages has no effect at all. The default 'false' value does not add + # punctuation to result hypotheses. NOTE: "This is currently offered as an + # experimental service, complimentary to all users. In the future this may be + # exclusively available as a premium feature." # Corresponds to the JSON property `enableAutomaticPunctuation` # @return [Boolean] attr_accessor :enable_automatic_punctuation alias_method :enable_automatic_punctuation?, :enable_automatic_punctuation - # Optional. If 'true', enables speaker detection for each recognized word in - # the top alternative of the recognition result using a speaker_tag provided - # in the WordInfo. - # Note: When this is true, we send all the words from the beginning of the - # audio for the top alternative in every consecutive response. - # This is done in order to improve our speaker tags as our models learn to - # identify the speakers in the conversation over time. + # Optional. If 'true', enables speaker detection for each recognized word in the + # top alternative of the recognition result using a speaker_tag provided in the + # WordInfo. Note: When this is true, we send all the words from the beginning of + # the audio for the top alternative in every consecutive response. This is done + # in order to improve our speaker tags as our models learn to identify the + # speakers in the conversation over time. # Corresponds to the JSON property `enableSpeakerDiarization` # @return [Boolean] attr_accessor :enable_speaker_diarization alias_method :enable_speaker_diarization?, :enable_speaker_diarization # Optional. If `true`, the top result includes a list of words and the - # confidence for those words. If `false`, no word-level confidence - # information is returned. The default is `false`. + # confidence for those words. If `false`, no word-level confidence information + # is returned. The default is `false`. # Corresponds to the JSON property `enableWordConfidence` # @return [Boolean] attr_accessor :enable_word_confidence alias_method :enable_word_confidence?, :enable_word_confidence - # Optional. If set to `true`, the server will attempt to filter out - # profanities, replacing all but the initial character in each filtered word - # with asterisks, e.g. "f***". If set to `false` or omitted, profanities - # won't be filtered out. + # Optional. If set to `true`, the server will attempt to filter out profanities, + # replacing all but the initial character in each filtered word with asterisks, + # e.g. "f***". If set to `false` or omitted, profanities won't be filtered out. # Corresponds to the JSON property `filterProfanity` # @return [Boolean] attr_accessor :filter_profanity alias_method :filter_profanity?, :filter_profanity - # Required. *Required* The language of the supplied audio as a - # [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) language tag. - # Example: "en-US". - # See [Language Support](https://cloud.google.com/speech/docs/languages) - # for a list of the currently supported language codes. + # Required. *Required* The language of the supplied audio as a [BCP-47](https:// + # www.rfc-editor.org/rfc/bcp/bcp47.txt) language tag. Example: "en-US". See [ + # Language Support](https://cloud.google.com/speech/docs/languages) for a list + # of the currently supported language codes. # Corresponds to the JSON property `languageCode` # @return [String] attr_accessor :language_code # Optional. Maximum number of recognition hypotheses to be returned. # Specifically, the maximum number of `SpeechRecognitionAlternative` messages - # within each `SpeechTranscription`. The server may return fewer than - # `max_alternatives`. Valid values are `0`-`30`. A value of `0` or `1` will + # within each `SpeechTranscription`. The server may return fewer than ` + # max_alternatives`. Valid values are `0`-`30`. A value of `0` or `1` will # return a maximum of one. If omitted, will return a maximum of one. # Corresponds to the JSON property `maxAlternatives` # @return [Fixnum] @@ -2994,16 +2907,15 @@ module Google include Google::Apis::Core::Hashable # Language hint can be specified if the language to be detected is known a - # priori. It can increase the accuracy of the detection. Language hint must - # be language code in BCP-47 format. - # Automatic language detection is performed if no hint is provided. + # priori. It can increase the accuracy of the detection. Language hint must be + # language code in BCP-47 format. Automatic language detection is performed if + # no hint is provided. # Corresponds to the JSON property `languageHints` # @return [Array] attr_accessor :language_hints - # Model to use for text detection. - # Supported values: "builtin/stable" (the default if unset) and - # "builtin/latest". + # Model to use for text detection. Supported values: "builtin/stable" (the + # default if unset) and "builtin/latest". # Corresponds to the JSON property `model` # @return [String] attr_accessor :model @@ -3019,27 +2931,19 @@ module Google end end - # Video frame level annotation results for text annotation (OCR). - # Contains information regarding timestamp and bounding box locations for the - # frames containing detected OCR text snippets. + # Video frame level annotation results for text annotation (OCR). Contains + # information regarding timestamp and bounding box locations for the frames + # containing detected OCR text snippets. class GoogleCloudVideointelligenceV1p1beta1TextFrame include Google::Apis::Core::Hashable # Normalized bounding polygon for text (that might not be aligned with axis). - # Contains list of the corner points in clockwise order starting from - # top-left corner. For example, for a rectangular bounding box: - # When the text is horizontal it might look like: - # 0----1 - # | | - # 3----2 - # When it's clockwise rotated 180 degrees around the top-left corner it - # becomes: - # 2----3 - # | | - # 1----0 - # and the vertex order will still be (0, 1, 2, 3). Note that values can be less - # than 0, or greater than 1 due to trignometric calculations for location of - # the box. + # Contains list of the corner points in clockwise order starting from top-left + # corner. For example, for a rectangular bounding box: When the text is + # horizontal it might look like: 0----1 | | 3----2 When it's clockwise rotated + # 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the + # vertex order will still be (0, 1, 2, 3). Note that values can be less than 0, + # or greater than 1 due to trignometric calculations for location of the box. # Corresponds to the JSON property `rotatedBoundingBox` # @return [Google::Apis::VideointelligenceV1p1beta1::GoogleCloudVideointelligenceV1p1beta1NormalizedBoundingPoly] attr_accessor :rotated_bounding_box @@ -3092,9 +2996,8 @@ module Google end end - # For tracking related features. - # An object at time_offset with attributes, and located with - # normalized_bounding_box. + # For tracking related features. An object at time_offset with attributes, and + # located with normalized_bounding_box. class GoogleCloudVideointelligenceV1p1beta1TimestampedObject include Google::Apis::Core::Hashable @@ -3108,15 +3011,14 @@ module Google # @return [Array] attr_accessor :landmarks - # Normalized bounding box. - # The normalized vertex coordinates are relative to the original image. - # Range: [0, 1]. + # Normalized bounding box. The normalized vertex coordinates are relative to the + # original image. Range: [0, 1]. # Corresponds to the JSON property `normalizedBoundingBox` # @return [Google::Apis::VideointelligenceV1p1beta1::GoogleCloudVideointelligenceV1p1beta1NormalizedBoundingBox] attr_accessor :normalized_bounding_box - # Time-offset, relative to the beginning of the video, - # corresponding to the video frame for this object. + # Time-offset, relative to the beginning of the video, corresponding to the + # video frame for this object. # Corresponds to the JSON property `timeOffset` # @return [String] attr_accessor :time_offset @@ -3175,20 +3077,19 @@ module Google class GoogleCloudVideointelligenceV1p1beta1VideoAnnotationProgress include Google::Apis::Core::Hashable - # Specifies which feature is being tracked if the request contains more than - # one feature. + # Specifies which feature is being tracked if the request contains more than one + # feature. # Corresponds to the JSON property `feature` # @return [String] attr_accessor :feature - # Video file location in - # [Cloud Storage](https://cloud.google.com/storage/). + # Video file location in [Cloud Storage](https://cloud.google.com/storage/). # Corresponds to the JSON property `inputUri` # @return [String] attr_accessor :input_uri - # Approximate percentage processed thus far. Guaranteed to be - # 100 when fully processed. + # Approximate percentage processed thus far. Guaranteed to be 100 when fully + # processed. # Corresponds to the JSON property `progressPercent` # @return [Fixnum] attr_accessor :progress_percent @@ -3227,31 +3128,30 @@ module Google class GoogleCloudVideointelligenceV1p1beta1VideoAnnotationResults include Google::Apis::Core::Hashable - # 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::VideointelligenceV1p1beta1::GoogleRpcStatus] attr_accessor :error - # Explicit content annotation (based on per-frame visual signals only). - # If no explicit content has been detected in a frame, no annotations are - # present for that frame. + # Explicit content annotation (based on per-frame visual signals only). If no + # explicit content has been detected in a frame, no annotations are present for + # that frame. # Corresponds to the JSON property `explicitAnnotation` # @return [Google::Apis::VideointelligenceV1p1beta1::GoogleCloudVideointelligenceV1p1beta1ExplicitContentAnnotation] attr_accessor :explicit_annotation - # Label annotations on frame level. - # There is exactly one element for each unique label. + # Label annotations on frame level. There is exactly one element for each unique + # label. # Corresponds to the JSON property `frameLabelAnnotations` # @return [Array] attr_accessor :frame_label_annotations - # Video file location in - # [Cloud Storage](https://cloud.google.com/storage/). + # Video file location in [Cloud Storage](https://cloud.google.com/storage/). # Corresponds to the JSON property `inputUri` # @return [String] attr_accessor :input_uri @@ -3278,11 +3178,11 @@ module Google attr_accessor :segment_label_annotations # Presence label annotations on video level or user-specified segment level. - # There is exactly one element for each unique label. Compared to the - # existing topical `segment_label_annotations`, this field presents more - # fine-grained, segment-level labels detected in video content and is made - # available only when the client sets `LabelDetectionConfig.model` to - # "builtin/latest" in the request. + # There is exactly one element for each unique label. Compared to the existing + # topical `segment_label_annotations`, this field presents more fine-grained, + # segment-level labels detected in video content and is made available only when + # the client sets `LabelDetectionConfig.model` to "builtin/latest" in the + # request. # Corresponds to the JSON property `segmentPresenceLabelAnnotations` # @return [Array] attr_accessor :segment_presence_label_annotations @@ -3292,17 +3192,17 @@ module Google # @return [Array] attr_accessor :shot_annotations - # Topical label annotations on shot level. - # There is exactly one element for each unique label. + # Topical label annotations on shot level. There is exactly one element for each + # unique label. # Corresponds to the JSON property `shotLabelAnnotations` # @return [Array] attr_accessor :shot_label_annotations # Presence label annotations on shot level. There is exactly one element for - # each unique label. Compared to the existing topical - # `shot_label_annotations`, this field presents more fine-grained, shot-level - # labels detected in video content and is made available only when the client - # sets `LabelDetectionConfig.model` to "builtin/latest" in the request. + # each unique label. Compared to the existing topical `shot_label_annotations`, + # this field presents more fine-grained, shot-level labels detected in video + # content and is made available only when the client sets `LabelDetectionConfig. + # model` to "builtin/latest" in the request. # Corresponds to the JSON property `shotPresenceLabelAnnotations` # @return [Array] attr_accessor :shot_presence_label_annotations @@ -3312,9 +3212,8 @@ module Google # @return [Array] attr_accessor :speech_transcriptions - # OCR text detection and tracking. - # Annotations for list of detected text snippets. Each will have list of - # frame information associated with it. + # OCR text detection and tracking. Annotations for list of detected text + # snippets. Each will have list of frame information associated with it. # Corresponds to the JSON property `textAnnotations` # @return [Array] attr_accessor :text_annotations @@ -3361,9 +3260,9 @@ module Google # @return [Google::Apis::VideointelligenceV1p1beta1::GoogleCloudVideointelligenceV1p1beta1ObjectTrackingConfig] attr_accessor :object_tracking_config - # Video segments to annotate. The segments may overlap and are not required - # to be contiguous or span the whole video. If unspecified, each video is - # treated as a single segment. + # Video segments to annotate. The segments may overlap and are not required to + # be contiguous or span the whole video. If unspecified, each video is treated + # as a single segment. # Corresponds to the JSON property `segments` # @return [Array] attr_accessor :segments @@ -3403,14 +3302,14 @@ module Google class GoogleCloudVideointelligenceV1p1beta1VideoSegment include Google::Apis::Core::Hashable - # Time-offset, relative to the beginning of the video, - # corresponding to the end of the segment (inclusive). + # Time-offset, relative to the beginning of the video, corresponding to the end + # of the segment (inclusive). # Corresponds to the JSON property `endTimeOffset` # @return [String] attr_accessor :end_time_offset - # Time-offset, relative to the beginning of the video, - # corresponding to the start of the segment (inclusive). + # Time-offset, relative to the beginning of the video, corresponding to the + # start of the segment (inclusive). # Corresponds to the JSON property `startTimeOffset` # @return [String] attr_accessor :start_time_offset @@ -3427,41 +3326,41 @@ module Google end # Word-specific information for recognized words. Word information is only - # included in the response when certain request parameters are set, such - # as `enable_word_time_offsets`. + # included in the response when certain request parameters are set, such as ` + # enable_word_time_offsets`. class GoogleCloudVideointelligenceV1p1beta1WordInfo include Google::Apis::Core::Hashable # Output only. The confidence estimate between 0.0 and 1.0. A higher number # indicates an estimated greater likelihood that the recognized words are - # correct. This field is set only for the top alternative. - # This field is not guaranteed to be accurate and users should not rely on it - # to be always provided. - # The default of 0.0 is a sentinel value indicating `confidence` was not set. + # correct. This field is set only for the top alternative. This field is not + # guaranteed to be accurate and users should not rely on it to be always + # provided. The default of 0.0 is a sentinel value indicating `confidence` was + # not set. # Corresponds to the JSON property `confidence` # @return [Float] attr_accessor :confidence - # Time offset relative to the beginning of the audio, and - # corresponding to the end of the spoken word. This field is only set if - # `enable_word_time_offsets=true` and only in the top hypothesis. This is an - # experimental feature and the accuracy of the time offset can vary. + # Time offset relative to the beginning of the audio, and corresponding to the + # end of the spoken word. This field is only set if `enable_word_time_offsets= + # true` and only in the top hypothesis. This is an experimental feature and the + # accuracy of the time offset can vary. # Corresponds to the JSON property `endTime` # @return [String] attr_accessor :end_time - # Output only. A distinct integer value is assigned for every speaker within - # the audio. This field specifies which one of those speakers was detected to - # have spoken this word. Value ranges from 1 up to diarization_speaker_count, - # and is only set if speaker diarization is enabled. + # Output only. A distinct integer value is assigned for every speaker within the + # audio. This field specifies which one of those speakers was detected to have + # spoken this word. Value ranges from 1 up to diarization_speaker_count, and is + # only set if speaker diarization is enabled. # Corresponds to the JSON property `speakerTag` # @return [Fixnum] attr_accessor :speaker_tag - # Time offset relative to the beginning of the audio, and - # corresponding to the start of the spoken word. This field is only set if - # `enable_word_time_offsets=true` and only in the top hypothesis. This is an - # experimental feature and the accuracy of the time offset can vary. + # Time offset relative to the beginning of the audio, and corresponding to the + # start of the spoken word. This field is only set if `enable_word_time_offsets= + # true` and only in the top hypothesis. This is an experimental feature and the + # accuracy of the time offset can vary. # Corresponds to the JSON property `startTime` # @return [String] attr_accessor :start_time @@ -3485,9 +3384,9 @@ module Google end end - # Video annotation progress. Included in the `metadata` - # field of the `Operation` returned by the `GetOperation` - # call of the `google::longrunning::Operations` service. + # Video annotation progress. Included in the `metadata` field of the `Operation` + # returned by the `GetOperation` call of the `google::longrunning::Operations` + # service. class GoogleCloudVideointelligenceV1p2beta1AnnotateVideoProgress include Google::Apis::Core::Hashable @@ -3506,9 +3405,9 @@ module Google end end - # Video annotation response. Included in the `response` - # field of the `Operation` returned by the `GetOperation` - # call of the `google::longrunning::Operations` service. + # Video annotation response. Included in the `response` field of the `Operation` + # returned by the `GetOperation` call of the `google::longrunning::Operations` + # service. class GoogleCloudVideointelligenceV1p2beta1AnnotateVideoResponse include Google::Apis::Core::Hashable @@ -3536,14 +3435,14 @@ module Google # @return [Float] attr_accessor :confidence - # The name of the attribute, for example, glasses, dark_glasses, mouth_open. - # A full list of supported type names will be provided in the document. + # The name of the attribute, for example, glasses, dark_glasses, mouth_open. A + # full list of supported type names will be provided in the document. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name - # Text value of the detection result. For example, the value for "HairColor" - # can be "black", "blonde", etc. + # Text value of the detection result. For example, the value for "HairColor" can + # be "black", "blonde", etc. # Corresponds to the JSON property `value` # @return [String] attr_accessor :value @@ -3575,9 +3474,8 @@ module Google # @return [String] attr_accessor :name - # A vertex represents a 2D point in the image. - # NOTE: the normalized vertex coordinates are relative to the original image - # and range from 0 to 1. + # A vertex represents a 2D point in the image. NOTE: the normalized vertex + # coordinates are relative to the original image and range from 0 to 1. # Corresponds to the JSON property `point` # @return [Google::Apis::VideointelligenceV1p1beta1::GoogleCloudVideointelligenceV1p2beta1NormalizedVertex] attr_accessor :point @@ -3603,8 +3501,7 @@ module Google # @return [String] attr_accessor :description - # Opaque entity ID. Some IDs may be available in - # [Google Knowledge Graph Search + # Opaque entity ID. Some IDs may be available in [Google Knowledge Graph Search # API](https://developers.google.com/knowledge-graph/). # Corresponds to the JSON property `entityId` # @return [String] @@ -3627,9 +3524,9 @@ module Google end end - # Explicit content annotation (based on per-frame visual signals only). - # If no explicit content has been detected in a frame, no annotations are - # present for that frame. + # Explicit content annotation (based on per-frame visual signals only). If no + # explicit content has been detected in a frame, no annotations are present for + # that frame. class GoogleCloudVideointelligenceV1p2beta1ExplicitContentAnnotation include Google::Apis::Core::Hashable @@ -3684,10 +3581,9 @@ module Google class GoogleCloudVideointelligenceV1p2beta1LabelAnnotation include Google::Apis::Core::Hashable - # Common categories for the detected entity. - # For example, when the label is `Terrier`, the category is likely `dog`. And - # in some cases there might be more than one categories e.g., `Terrier` could - # also be a `pet`. + # Common categories for the detected entity. For example, when the label is ` + # Terrier`, the category is likely `dog`. And in some cases there might be more + # than one categories e.g., `Terrier` could also be a `pet`. # Corresponds to the JSON property `categoryEntities` # @return [Array] attr_accessor :category_entities @@ -3786,14 +3682,14 @@ module Google # @return [Google::Apis::VideointelligenceV1p1beta1::GoogleCloudVideointelligenceV1p2beta1Entity] attr_accessor :entity - # All video segments where the recognized logo appears. There might be - # multiple instances of the same logo class appearing in one VideoSegment. + # All video segments where the recognized logo appears. There might be multiple + # instances of the same logo class appearing in one VideoSegment. # Corresponds to the JSON property `segments` # @return [Array] attr_accessor :segments - # All logo tracks where the recognized logo appears. Each track corresponds - # to one logo instance appearing in consecutive frames. + # All logo tracks where the recognized logo appears. Each track corresponds to + # one logo instance appearing in consecutive frames. # Corresponds to the JSON property `tracks` # @return [Array] attr_accessor :tracks @@ -3810,9 +3706,8 @@ module Google end end - # Normalized bounding box. - # The normalized vertex coordinates are relative to the original image. - # Range: [0, 1]. + # Normalized bounding box. The normalized vertex coordinates are relative to the + # original image. Range: [0, 1]. class GoogleCloudVideointelligenceV1p2beta1NormalizedBoundingBox include Google::Apis::Core::Hashable @@ -3850,20 +3745,12 @@ module Google end # Normalized bounding polygon for text (that might not be aligned with axis). - # Contains list of the corner points in clockwise order starting from - # top-left corner. For example, for a rectangular bounding box: - # When the text is horizontal it might look like: - # 0----1 - # | | - # 3----2 - # When it's clockwise rotated 180 degrees around the top-left corner it - # becomes: - # 2----3 - # | | - # 1----0 - # and the vertex order will still be (0, 1, 2, 3). Note that values can be less - # than 0, or greater than 1 due to trignometric calculations for location of - # the box. + # Contains list of the corner points in clockwise order starting from top-left + # corner. For example, for a rectangular bounding box: When the text is + # horizontal it might look like: 0----1 | | 3----2 When it's clockwise rotated + # 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the + # vertex order will still be (0, 1, 2, 3). Note that values can be less than 0, + # or greater than 1 due to trignometric calculations for location of the box. class GoogleCloudVideointelligenceV1p2beta1NormalizedBoundingPoly include Google::Apis::Core::Hashable @@ -3882,9 +3769,8 @@ module Google end end - # A vertex represents a 2D point in the image. - # NOTE: the normalized vertex coordinates are relative to the original image - # and range from 0 to 1. + # A vertex represents a 2D point in the image. NOTE: the normalized vertex + # coordinates are relative to the original image and range from 0 to 1. class GoogleCloudVideointelligenceV1p2beta1NormalizedVertex include Google::Apis::Core::Hashable @@ -3923,10 +3809,10 @@ module Google # @return [Google::Apis::VideointelligenceV1p1beta1::GoogleCloudVideointelligenceV1p2beta1Entity] attr_accessor :entity - # Information corresponding to all frames where this object track appears. - # Non-streaming batch mode: it may be one or multiple ObjectTrackingFrame - # messages in frames. - # Streaming mode: it can only be one ObjectTrackingFrame message in frames. + # Information corresponding to all frames where this object track appears. Non- + # streaming batch mode: it may be one or multiple ObjectTrackingFrame messages + # in frames. Streaming mode: it can only be one ObjectTrackingFrame message in + # frames. # Corresponds to the JSON property `frames` # @return [Array] attr_accessor :frames @@ -3936,12 +3822,11 @@ module Google # @return [Google::Apis::VideointelligenceV1p1beta1::GoogleCloudVideointelligenceV1p2beta1VideoSegment] attr_accessor :segment - # Streaming mode ONLY. - # In streaming mode, we do not know the end time of a tracked object - # before it is completed. Hence, there is no VideoSegment info returned. - # Instead, we provide a unique identifiable integer track_id so that - # the customers can correlate the results of the ongoing - # ObjectTrackAnnotation of the same track_id over time. + # Streaming mode ONLY. In streaming mode, we do not know the end time of a + # tracked object before it is completed. Hence, there is no VideoSegment info + # returned. Instead, we provide a unique identifiable integer track_id so that + # the customers can correlate the results of the ongoing ObjectTrackAnnotation + # of the same track_id over time. # Corresponds to the JSON property `trackId` # @return [Fixnum] attr_accessor :track_id @@ -3971,9 +3856,8 @@ module Google class GoogleCloudVideointelligenceV1p2beta1ObjectTrackingFrame include Google::Apis::Core::Hashable - # Normalized bounding box. - # The normalized vertex coordinates are relative to the original image. - # Range: [0, 1]. + # Normalized bounding box. The normalized vertex coordinates are relative to the + # original image. Range: [0, 1]. # Corresponds to the JSON property `normalizedBoundingBox` # @return [Google::Apis::VideointelligenceV1p1beta1::GoogleCloudVideointelligenceV1p2beta1NormalizedBoundingBox] attr_accessor :normalized_bounding_box @@ -4000,10 +3884,10 @@ module Google # Output only. The confidence estimate between 0.0 and 1.0. A higher number # indicates an estimated greater likelihood that the recognized words are - # correct. This field is set only for the top alternative. - # This field is not guaranteed to be accurate and users should not rely on it - # to be always provided. - # The default of 0.0 is a sentinel value indicating `confidence` was not set. + # correct. This field is set only for the top alternative. This field is not + # guaranteed to be accurate and users should not rely on it to be always + # provided. The default of 0.0 is a sentinel value indicating `confidence` was + # not set. # Corresponds to the JSON property `confidence` # @return [Float] attr_accessor :confidence @@ -4014,8 +3898,8 @@ module Google attr_accessor :transcript # Output only. A list of word-specific information for each recognized word. - # Note: When `enable_speaker_diarization` is set to true, you will see all - # the words from the beginning of the audio. + # Note: When `enable_speaker_diarization` is set to true, you will see all the + # words from the beginning of the audio. # Corresponds to the JSON property `words` # @return [Array] attr_accessor :words @@ -4036,18 +3920,17 @@ module Google class GoogleCloudVideointelligenceV1p2beta1SpeechTranscription include Google::Apis::Core::Hashable - # May contain one or more recognition hypotheses (up to the maximum specified - # in `max_alternatives`). These alternatives are ordered in terms of - # accuracy, with the top (first) alternative being the most probable, as - # ranked by the recognizer. + # May contain one or more recognition hypotheses (up to the maximum specified in + # `max_alternatives`). These alternatives are ordered in terms of accuracy, with + # the top (first) alternative being the most probable, as ranked by the + # recognizer. # Corresponds to the JSON property `alternatives` # @return [Array] attr_accessor :alternatives # Output only. The [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) - # language tag of - # the language in this result. This language code was detected to have the - # most likelihood of being spoken in the audio. + # language tag of the language in this result. This language code was detected + # to have the most likelihood of being spoken in the audio. # Corresponds to the JSON property `languageCode` # @return [String] attr_accessor :language_code @@ -4096,27 +3979,19 @@ module Google end end - # Video frame level annotation results for text annotation (OCR). - # Contains information regarding timestamp and bounding box locations for the - # frames containing detected OCR text snippets. + # Video frame level annotation results for text annotation (OCR). Contains + # information regarding timestamp and bounding box locations for the frames + # containing detected OCR text snippets. class GoogleCloudVideointelligenceV1p2beta1TextFrame include Google::Apis::Core::Hashable # Normalized bounding polygon for text (that might not be aligned with axis). - # Contains list of the corner points in clockwise order starting from - # top-left corner. For example, for a rectangular bounding box: - # When the text is horizontal it might look like: - # 0----1 - # | | - # 3----2 - # When it's clockwise rotated 180 degrees around the top-left corner it - # becomes: - # 2----3 - # | | - # 1----0 - # and the vertex order will still be (0, 1, 2, 3). Note that values can be less - # than 0, or greater than 1 due to trignometric calculations for location of - # the box. + # Contains list of the corner points in clockwise order starting from top-left + # corner. For example, for a rectangular bounding box: When the text is + # horizontal it might look like: 0----1 | | 3----2 When it's clockwise rotated + # 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the + # vertex order will still be (0, 1, 2, 3). Note that values can be less than 0, + # or greater than 1 due to trignometric calculations for location of the box. # Corresponds to the JSON property `rotatedBoundingBox` # @return [Google::Apis::VideointelligenceV1p1beta1::GoogleCloudVideointelligenceV1p2beta1NormalizedBoundingPoly] attr_accessor :rotated_bounding_box @@ -4169,9 +4044,8 @@ module Google end end - # For tracking related features. - # An object at time_offset with attributes, and located with - # normalized_bounding_box. + # For tracking related features. An object at time_offset with attributes, and + # located with normalized_bounding_box. class GoogleCloudVideointelligenceV1p2beta1TimestampedObject include Google::Apis::Core::Hashable @@ -4185,15 +4059,14 @@ module Google # @return [Array] attr_accessor :landmarks - # Normalized bounding box. - # The normalized vertex coordinates are relative to the original image. - # Range: [0, 1]. + # Normalized bounding box. The normalized vertex coordinates are relative to the + # original image. Range: [0, 1]. # Corresponds to the JSON property `normalizedBoundingBox` # @return [Google::Apis::VideointelligenceV1p1beta1::GoogleCloudVideointelligenceV1p2beta1NormalizedBoundingBox] attr_accessor :normalized_bounding_box - # Time-offset, relative to the beginning of the video, - # corresponding to the video frame for this object. + # Time-offset, relative to the beginning of the video, corresponding to the + # video frame for this object. # Corresponds to the JSON property `timeOffset` # @return [String] attr_accessor :time_offset @@ -4252,20 +4125,19 @@ module Google class GoogleCloudVideointelligenceV1p2beta1VideoAnnotationProgress include Google::Apis::Core::Hashable - # Specifies which feature is being tracked if the request contains more than - # one feature. + # Specifies which feature is being tracked if the request contains more than one + # feature. # Corresponds to the JSON property `feature` # @return [String] attr_accessor :feature - # Video file location in - # [Cloud Storage](https://cloud.google.com/storage/). + # Video file location in [Cloud Storage](https://cloud.google.com/storage/). # Corresponds to the JSON property `inputUri` # @return [String] attr_accessor :input_uri - # Approximate percentage processed thus far. Guaranteed to be - # 100 when fully processed. + # Approximate percentage processed thus far. Guaranteed to be 100 when fully + # processed. # Corresponds to the JSON property `progressPercent` # @return [Fixnum] attr_accessor :progress_percent @@ -4304,31 +4176,30 @@ module Google class GoogleCloudVideointelligenceV1p2beta1VideoAnnotationResults include Google::Apis::Core::Hashable - # 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::VideointelligenceV1p1beta1::GoogleRpcStatus] attr_accessor :error - # Explicit content annotation (based on per-frame visual signals only). - # If no explicit content has been detected in a frame, no annotations are - # present for that frame. + # Explicit content annotation (based on per-frame visual signals only). If no + # explicit content has been detected in a frame, no annotations are present for + # that frame. # Corresponds to the JSON property `explicitAnnotation` # @return [Google::Apis::VideointelligenceV1p1beta1::GoogleCloudVideointelligenceV1p2beta1ExplicitContentAnnotation] attr_accessor :explicit_annotation - # Label annotations on frame level. - # There is exactly one element for each unique label. + # Label annotations on frame level. There is exactly one element for each unique + # label. # Corresponds to the JSON property `frameLabelAnnotations` # @return [Array] attr_accessor :frame_label_annotations - # Video file location in - # [Cloud Storage](https://cloud.google.com/storage/). + # Video file location in [Cloud Storage](https://cloud.google.com/storage/). # Corresponds to the JSON property `inputUri` # @return [String] attr_accessor :input_uri @@ -4355,11 +4226,11 @@ module Google attr_accessor :segment_label_annotations # Presence label annotations on video level or user-specified segment level. - # There is exactly one element for each unique label. Compared to the - # existing topical `segment_label_annotations`, this field presents more - # fine-grained, segment-level labels detected in video content and is made - # available only when the client sets `LabelDetectionConfig.model` to - # "builtin/latest" in the request. + # There is exactly one element for each unique label. Compared to the existing + # topical `segment_label_annotations`, this field presents more fine-grained, + # segment-level labels detected in video content and is made available only when + # the client sets `LabelDetectionConfig.model` to "builtin/latest" in the + # request. # Corresponds to the JSON property `segmentPresenceLabelAnnotations` # @return [Array] attr_accessor :segment_presence_label_annotations @@ -4369,17 +4240,17 @@ module Google # @return [Array] attr_accessor :shot_annotations - # Topical label annotations on shot level. - # There is exactly one element for each unique label. + # Topical label annotations on shot level. There is exactly one element for each + # unique label. # Corresponds to the JSON property `shotLabelAnnotations` # @return [Array] attr_accessor :shot_label_annotations # Presence label annotations on shot level. There is exactly one element for - # each unique label. Compared to the existing topical - # `shot_label_annotations`, this field presents more fine-grained, shot-level - # labels detected in video content and is made available only when the client - # sets `LabelDetectionConfig.model` to "builtin/latest" in the request. + # each unique label. Compared to the existing topical `shot_label_annotations`, + # this field presents more fine-grained, shot-level labels detected in video + # content and is made available only when the client sets `LabelDetectionConfig. + # model` to "builtin/latest" in the request. # Corresponds to the JSON property `shotPresenceLabelAnnotations` # @return [Array] attr_accessor :shot_presence_label_annotations @@ -4389,9 +4260,8 @@ module Google # @return [Array] attr_accessor :speech_transcriptions - # OCR text detection and tracking. - # Annotations for list of detected text snippets. Each will have list of - # frame information associated with it. + # OCR text detection and tracking. Annotations for list of detected text + # snippets. Each will have list of frame information associated with it. # Corresponds to the JSON property `textAnnotations` # @return [Array] attr_accessor :text_annotations @@ -4423,14 +4293,14 @@ module Google class GoogleCloudVideointelligenceV1p2beta1VideoSegment include Google::Apis::Core::Hashable - # Time-offset, relative to the beginning of the video, - # corresponding to the end of the segment (inclusive). + # Time-offset, relative to the beginning of the video, corresponding to the end + # of the segment (inclusive). # Corresponds to the JSON property `endTimeOffset` # @return [String] attr_accessor :end_time_offset - # Time-offset, relative to the beginning of the video, - # corresponding to the start of the segment (inclusive). + # Time-offset, relative to the beginning of the video, corresponding to the + # start of the segment (inclusive). # Corresponds to the JSON property `startTimeOffset` # @return [String] attr_accessor :start_time_offset @@ -4447,41 +4317,41 @@ module Google end # Word-specific information for recognized words. Word information is only - # included in the response when certain request parameters are set, such - # as `enable_word_time_offsets`. + # included in the response when certain request parameters are set, such as ` + # enable_word_time_offsets`. class GoogleCloudVideointelligenceV1p2beta1WordInfo include Google::Apis::Core::Hashable # Output only. The confidence estimate between 0.0 and 1.0. A higher number # indicates an estimated greater likelihood that the recognized words are - # correct. This field is set only for the top alternative. - # This field is not guaranteed to be accurate and users should not rely on it - # to be always provided. - # The default of 0.0 is a sentinel value indicating `confidence` was not set. + # correct. This field is set only for the top alternative. This field is not + # guaranteed to be accurate and users should not rely on it to be always + # provided. The default of 0.0 is a sentinel value indicating `confidence` was + # not set. # Corresponds to the JSON property `confidence` # @return [Float] attr_accessor :confidence - # Time offset relative to the beginning of the audio, and - # corresponding to the end of the spoken word. This field is only set if - # `enable_word_time_offsets=true` and only in the top hypothesis. This is an - # experimental feature and the accuracy of the time offset can vary. + # Time offset relative to the beginning of the audio, and corresponding to the + # end of the spoken word. This field is only set if `enable_word_time_offsets= + # true` and only in the top hypothesis. This is an experimental feature and the + # accuracy of the time offset can vary. # Corresponds to the JSON property `endTime` # @return [String] attr_accessor :end_time - # Output only. A distinct integer value is assigned for every speaker within - # the audio. This field specifies which one of those speakers was detected to - # have spoken this word. Value ranges from 1 up to diarization_speaker_count, - # and is only set if speaker diarization is enabled. + # Output only. A distinct integer value is assigned for every speaker within the + # audio. This field specifies which one of those speakers was detected to have + # spoken this word. Value ranges from 1 up to diarization_speaker_count, and is + # only set if speaker diarization is enabled. # Corresponds to the JSON property `speakerTag` # @return [Fixnum] attr_accessor :speaker_tag - # Time offset relative to the beginning of the audio, and - # corresponding to the start of the spoken word. This field is only set if - # `enable_word_time_offsets=true` and only in the top hypothesis. This is an - # experimental feature and the accuracy of the time offset can vary. + # Time offset relative to the beginning of the audio, and corresponding to the + # start of the spoken word. This field is only set if `enable_word_time_offsets= + # true` and only in the top hypothesis. This is an experimental feature and the + # accuracy of the time offset can vary. # Corresponds to the JSON property `startTime` # @return [String] attr_accessor :start_time @@ -4505,9 +4375,9 @@ module Google end end - # Video annotation progress. Included in the `metadata` - # field of the `Operation` returned by the `GetOperation` - # call of the `google::longrunning::Operations` service. + # Video annotation progress. Included in the `metadata` field of the `Operation` + # returned by the `GetOperation` call of the `google::longrunning::Operations` + # service. class GoogleCloudVideointelligenceV1p3beta1AnnotateVideoProgress include Google::Apis::Core::Hashable @@ -4526,9 +4396,9 @@ module Google end end - # Video annotation response. Included in the `response` - # field of the `Operation` returned by the `GetOperation` - # call of the `google::longrunning::Operations` service. + # Video annotation response. Included in the `response` field of the `Operation` + # returned by the `GetOperation` call of the `google::longrunning::Operations` + # service. class GoogleCloudVideointelligenceV1p3beta1AnnotateVideoResponse include Google::Apis::Core::Hashable @@ -4562,10 +4432,9 @@ module Google # @return [String] attr_accessor :display_name - # The resource name of the celebrity. Have the format - # `video-intelligence/kg-mid` indicates a celebrity from preloaded gallery. - # kg-mid is the id in Google knowledge graph, which is unique for the - # celebrity. + # The resource name of the celebrity. Have the format `video-intelligence/kg-mid` + # indicates a celebrity from preloaded gallery. kg-mid is the id in Google + # knowledge graph, which is unique for the celebrity. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name @@ -4586,8 +4455,8 @@ module Google class GoogleCloudVideointelligenceV1p3beta1CelebrityRecognitionAnnotation include Google::Apis::Core::Hashable - # The tracks detected from the input video, including recognized celebrities - # and other detected faces in the video. + # The tracks detected from the input video, including recognized celebrities and + # other detected faces in the video. # Corresponds to the JSON property `celebrityTracks` # @return [Array] attr_accessor :celebrity_tracks @@ -4643,14 +4512,14 @@ module Google # @return [Float] attr_accessor :confidence - # The name of the attribute, for example, glasses, dark_glasses, mouth_open. - # A full list of supported type names will be provided in the document. + # The name of the attribute, for example, glasses, dark_glasses, mouth_open. A + # full list of supported type names will be provided in the document. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name - # Text value of the detection result. For example, the value for "HairColor" - # can be "black", "blonde", etc. + # Text value of the detection result. For example, the value for "HairColor" can + # be "black", "blonde", etc. # Corresponds to the JSON property `value` # @return [String] attr_accessor :value @@ -4682,9 +4551,8 @@ module Google # @return [String] attr_accessor :name - # A vertex represents a 2D point in the image. - # NOTE: the normalized vertex coordinates are relative to the original image - # and range from 0 to 1. + # A vertex represents a 2D point in the image. NOTE: the normalized vertex + # coordinates are relative to the original image and range from 0 to 1. # Corresponds to the JSON property `point` # @return [Google::Apis::VideointelligenceV1p1beta1::GoogleCloudVideointelligenceV1p3beta1NormalizedVertex] attr_accessor :point @@ -4710,8 +4578,7 @@ module Google # @return [String] attr_accessor :description - # Opaque entity ID. Some IDs may be available in - # [Google Knowledge Graph Search + # Opaque entity ID. Some IDs may be available in [Google Knowledge Graph Search # API](https://developers.google.com/knowledge-graph/). # Corresponds to the JSON property `entityId` # @return [String] @@ -4734,9 +4601,9 @@ module Google end end - # Explicit content annotation (based on per-frame visual signals only). - # If no explicit content has been detected in a frame, no annotations are - # present for that frame. + # Explicit content annotation (based on per-frame visual signals only). If no + # explicit content has been detected in a frame, no annotations are present for + # that frame. class GoogleCloudVideointelligenceV1p3beta1ExplicitContentAnnotation include Google::Apis::Core::Hashable @@ -4823,10 +4690,9 @@ module Google class GoogleCloudVideointelligenceV1p3beta1LabelAnnotation include Google::Apis::Core::Hashable - # Common categories for the detected entity. - # For example, when the label is `Terrier`, the category is likely `dog`. And - # in some cases there might be more than one categories e.g., `Terrier` could - # also be a `pet`. + # Common categories for the detected entity. For example, when the label is ` + # Terrier`, the category is likely `dog`. And in some cases there might be more + # than one categories e.g., `Terrier` could also be a `pet`. # Corresponds to the JSON property `categoryEntities` # @return [Array] attr_accessor :category_entities @@ -4925,14 +4791,14 @@ module Google # @return [Google::Apis::VideointelligenceV1p1beta1::GoogleCloudVideointelligenceV1p3beta1Entity] attr_accessor :entity - # All video segments where the recognized logo appears. There might be - # multiple instances of the same logo class appearing in one VideoSegment. + # All video segments where the recognized logo appears. There might be multiple + # instances of the same logo class appearing in one VideoSegment. # Corresponds to the JSON property `segments` # @return [Array] attr_accessor :segments - # All logo tracks where the recognized logo appears. Each track corresponds - # to one logo instance appearing in consecutive frames. + # All logo tracks where the recognized logo appears. Each track corresponds to + # one logo instance appearing in consecutive frames. # Corresponds to the JSON property `tracks` # @return [Array] attr_accessor :tracks @@ -4949,9 +4815,8 @@ module Google end end - # Normalized bounding box. - # The normalized vertex coordinates are relative to the original image. - # Range: [0, 1]. + # Normalized bounding box. The normalized vertex coordinates are relative to the + # original image. Range: [0, 1]. class GoogleCloudVideointelligenceV1p3beta1NormalizedBoundingBox include Google::Apis::Core::Hashable @@ -4989,20 +4854,12 @@ module Google end # Normalized bounding polygon for text (that might not be aligned with axis). - # Contains list of the corner points in clockwise order starting from - # top-left corner. For example, for a rectangular bounding box: - # When the text is horizontal it might look like: - # 0----1 - # | | - # 3----2 - # When it's clockwise rotated 180 degrees around the top-left corner it - # becomes: - # 2----3 - # | | - # 1----0 - # and the vertex order will still be (0, 1, 2, 3). Note that values can be less - # than 0, or greater than 1 due to trignometric calculations for location of - # the box. + # Contains list of the corner points in clockwise order starting from top-left + # corner. For example, for a rectangular bounding box: When the text is + # horizontal it might look like: 0----1 | | 3----2 When it's clockwise rotated + # 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the + # vertex order will still be (0, 1, 2, 3). Note that values can be less than 0, + # or greater than 1 due to trignometric calculations for location of the box. class GoogleCloudVideointelligenceV1p3beta1NormalizedBoundingPoly include Google::Apis::Core::Hashable @@ -5021,9 +4878,8 @@ module Google end end - # A vertex represents a 2D point in the image. - # NOTE: the normalized vertex coordinates are relative to the original image - # and range from 0 to 1. + # A vertex represents a 2D point in the image. NOTE: the normalized vertex + # coordinates are relative to the original image and range from 0 to 1. class GoogleCloudVideointelligenceV1p3beta1NormalizedVertex include Google::Apis::Core::Hashable @@ -5062,10 +4918,10 @@ module Google # @return [Google::Apis::VideointelligenceV1p1beta1::GoogleCloudVideointelligenceV1p3beta1Entity] attr_accessor :entity - # Information corresponding to all frames where this object track appears. - # Non-streaming batch mode: it may be one or multiple ObjectTrackingFrame - # messages in frames. - # Streaming mode: it can only be one ObjectTrackingFrame message in frames. + # Information corresponding to all frames where this object track appears. Non- + # streaming batch mode: it may be one or multiple ObjectTrackingFrame messages + # in frames. Streaming mode: it can only be one ObjectTrackingFrame message in + # frames. # Corresponds to the JSON property `frames` # @return [Array] attr_accessor :frames @@ -5075,12 +4931,11 @@ module Google # @return [Google::Apis::VideointelligenceV1p1beta1::GoogleCloudVideointelligenceV1p3beta1VideoSegment] attr_accessor :segment - # Streaming mode ONLY. - # In streaming mode, we do not know the end time of a tracked object - # before it is completed. Hence, there is no VideoSegment info returned. - # Instead, we provide a unique identifiable integer track_id so that - # the customers can correlate the results of the ongoing - # ObjectTrackAnnotation of the same track_id over time. + # Streaming mode ONLY. In streaming mode, we do not know the end time of a + # tracked object before it is completed. Hence, there is no VideoSegment info + # returned. Instead, we provide a unique identifiable integer track_id so that + # the customers can correlate the results of the ongoing ObjectTrackAnnotation + # of the same track_id over time. # Corresponds to the JSON property `trackId` # @return [Fixnum] attr_accessor :track_id @@ -5110,9 +4965,8 @@ module Google class GoogleCloudVideointelligenceV1p3beta1ObjectTrackingFrame include Google::Apis::Core::Hashable - # Normalized bounding box. - # The normalized vertex coordinates are relative to the original image. - # Range: [0, 1]. + # Normalized bounding box. The normalized vertex coordinates are relative to the + # original image. Range: [0, 1]. # Corresponds to the JSON property `normalizedBoundingBox` # @return [Google::Apis::VideointelligenceV1p1beta1::GoogleCloudVideointelligenceV1p3beta1NormalizedBoundingBox] attr_accessor :normalized_bounding_box @@ -5189,10 +5043,10 @@ module Google # Output only. The confidence estimate between 0.0 and 1.0. A higher number # indicates an estimated greater likelihood that the recognized words are - # correct. This field is set only for the top alternative. - # This field is not guaranteed to be accurate and users should not rely on it - # to be always provided. - # The default of 0.0 is a sentinel value indicating `confidence` was not set. + # correct. This field is set only for the top alternative. This field is not + # guaranteed to be accurate and users should not rely on it to be always + # provided. The default of 0.0 is a sentinel value indicating `confidence` was + # not set. # Corresponds to the JSON property `confidence` # @return [Float] attr_accessor :confidence @@ -5203,8 +5057,8 @@ module Google attr_accessor :transcript # Output only. A list of word-specific information for each recognized word. - # Note: When `enable_speaker_diarization` is set to true, you will see all - # the words from the beginning of the audio. + # Note: When `enable_speaker_diarization` is set to true, you will see all the + # words from the beginning of the audio. # Corresponds to the JSON property `words` # @return [Array] attr_accessor :words @@ -5225,18 +5079,17 @@ module Google class GoogleCloudVideointelligenceV1p3beta1SpeechTranscription include Google::Apis::Core::Hashable - # May contain one or more recognition hypotheses (up to the maximum specified - # in `max_alternatives`). These alternatives are ordered in terms of - # accuracy, with the top (first) alternative being the most probable, as - # ranked by the recognizer. + # May contain one or more recognition hypotheses (up to the maximum specified in + # `max_alternatives`). These alternatives are ordered in terms of accuracy, with + # the top (first) alternative being the most probable, as ranked by the + # recognizer. # Corresponds to the JSON property `alternatives` # @return [Array] attr_accessor :alternatives # Output only. The [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) - # language tag of - # the language in this result. This language code was detected to have the - # most likelihood of being spoken in the audio. + # language tag of the language in this result. This language code was detected + # to have the most likelihood of being spoken in the audio. # Corresponds to the JSON property `languageCode` # @return [String] attr_accessor :language_code @@ -5252,32 +5105,31 @@ module Google end end - # `StreamingAnnotateVideoResponse` is the only message returned to the client - # by `StreamingAnnotateVideo`. A series of zero or more - # `StreamingAnnotateVideoResponse` messages are streamed back to the client. + # `StreamingAnnotateVideoResponse` is the only message returned to the client by + # `StreamingAnnotateVideo`. A series of zero or more ` + # StreamingAnnotateVideoResponse` messages are streamed back to the client. class GoogleCloudVideointelligenceV1p3beta1StreamingAnnotateVideoResponse include Google::Apis::Core::Hashable - # Streaming annotation results corresponding to a portion of the video - # that is currently being processed. + # Streaming annotation results corresponding to a portion of the video that is + # currently being processed. # Corresponds to the JSON property `annotationResults` # @return [Google::Apis::VideointelligenceV1p1beta1::GoogleCloudVideointelligenceV1p3beta1StreamingVideoAnnotationResults] attr_accessor :annotation_results - # Google Cloud Storage URI that stores annotation results of one - # streaming session in JSON format. - # It is the annotation_result_storage_directory - # from the request followed by '/cloud_project_number-session_id'. + # Google Cloud Storage URI that stores annotation results of one streaming + # session in JSON format. It is the annotation_result_storage_directory from the + # request followed by '/cloud_project_number-session_id'. # Corresponds to the JSON property `annotationResultsUri` # @return [String] attr_accessor :annotation_results_uri - # 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::VideointelligenceV1p1beta1::GoogleRpcStatus] attr_accessor :error @@ -5294,14 +5146,14 @@ module Google end end - # Streaming annotation results corresponding to a portion of the video - # that is currently being processed. + # Streaming annotation results corresponding to a portion of the video that is + # currently being processed. class GoogleCloudVideointelligenceV1p3beta1StreamingVideoAnnotationResults include Google::Apis::Core::Hashable - # Explicit content annotation (based on per-frame visual signals only). - # If no explicit content has been detected in a frame, no annotations are - # present for that frame. + # Explicit content annotation (based on per-frame visual signals only). If no + # explicit content has been detected in a frame, no annotations are present for + # that frame. # Corresponds to the JSON property `explicitAnnotation` # @return [Google::Apis::VideointelligenceV1p1beta1::GoogleCloudVideointelligenceV1p3beta1ExplicitContentAnnotation] attr_accessor :explicit_annotation @@ -5367,27 +5219,19 @@ module Google end end - # Video frame level annotation results for text annotation (OCR). - # Contains information regarding timestamp and bounding box locations for the - # frames containing detected OCR text snippets. + # Video frame level annotation results for text annotation (OCR). Contains + # information regarding timestamp and bounding box locations for the frames + # containing detected OCR text snippets. class GoogleCloudVideointelligenceV1p3beta1TextFrame include Google::Apis::Core::Hashable # Normalized bounding polygon for text (that might not be aligned with axis). - # Contains list of the corner points in clockwise order starting from - # top-left corner. For example, for a rectangular bounding box: - # When the text is horizontal it might look like: - # 0----1 - # | | - # 3----2 - # When it's clockwise rotated 180 degrees around the top-left corner it - # becomes: - # 2----3 - # | | - # 1----0 - # and the vertex order will still be (0, 1, 2, 3). Note that values can be less - # than 0, or greater than 1 due to trignometric calculations for location of - # the box. + # Contains list of the corner points in clockwise order starting from top-left + # corner. For example, for a rectangular bounding box: When the text is + # horizontal it might look like: 0----1 | | 3----2 When it's clockwise rotated + # 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the + # vertex order will still be (0, 1, 2, 3). Note that values can be less than 0, + # or greater than 1 due to trignometric calculations for location of the box. # Corresponds to the JSON property `rotatedBoundingBox` # @return [Google::Apis::VideointelligenceV1p1beta1::GoogleCloudVideointelligenceV1p3beta1NormalizedBoundingPoly] attr_accessor :rotated_bounding_box @@ -5440,9 +5284,8 @@ module Google end end - # For tracking related features. - # An object at time_offset with attributes, and located with - # normalized_bounding_box. + # For tracking related features. An object at time_offset with attributes, and + # located with normalized_bounding_box. class GoogleCloudVideointelligenceV1p3beta1TimestampedObject include Google::Apis::Core::Hashable @@ -5456,15 +5299,14 @@ module Google # @return [Array] attr_accessor :landmarks - # Normalized bounding box. - # The normalized vertex coordinates are relative to the original image. - # Range: [0, 1]. + # Normalized bounding box. The normalized vertex coordinates are relative to the + # original image. Range: [0, 1]. # Corresponds to the JSON property `normalizedBoundingBox` # @return [Google::Apis::VideointelligenceV1p1beta1::GoogleCloudVideointelligenceV1p3beta1NormalizedBoundingBox] attr_accessor :normalized_bounding_box - # Time-offset, relative to the beginning of the video, - # corresponding to the video frame for this object. + # Time-offset, relative to the beginning of the video, corresponding to the + # video frame for this object. # Corresponds to the JSON property `timeOffset` # @return [String] attr_accessor :time_offset @@ -5523,20 +5365,19 @@ module Google class GoogleCloudVideointelligenceV1p3beta1VideoAnnotationProgress include Google::Apis::Core::Hashable - # Specifies which feature is being tracked if the request contains more than - # one feature. + # Specifies which feature is being tracked if the request contains more than one + # feature. # Corresponds to the JSON property `feature` # @return [String] attr_accessor :feature - # Video file location in - # [Cloud Storage](https://cloud.google.com/storage/). + # Video file location in [Cloud Storage](https://cloud.google.com/storage/). # Corresponds to the JSON property `inputUri` # @return [String] attr_accessor :input_uri - # Approximate percentage processed thus far. Guaranteed to be - # 100 when fully processed. + # Approximate percentage processed thus far. Guaranteed to be 100 when fully + # processed. # Corresponds to the JSON property `progressPercent` # @return [Fixnum] attr_accessor :progress_percent @@ -5580,19 +5421,19 @@ module Google # @return [Google::Apis::VideointelligenceV1p1beta1::GoogleCloudVideointelligenceV1p3beta1CelebrityRecognitionAnnotation] attr_accessor :celebrity_recognition_annotations - # 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::VideointelligenceV1p1beta1::GoogleRpcStatus] attr_accessor :error - # Explicit content annotation (based on per-frame visual signals only). - # If no explicit content has been detected in a frame, no annotations are - # present for that frame. + # Explicit content annotation (based on per-frame visual signals only). If no + # explicit content has been detected in a frame, no annotations are present for + # that frame. # Corresponds to the JSON property `explicitAnnotation` # @return [Google::Apis::VideointelligenceV1p1beta1::GoogleCloudVideointelligenceV1p3beta1ExplicitContentAnnotation] attr_accessor :explicit_annotation @@ -5602,14 +5443,13 @@ module Google # @return [Array] attr_accessor :face_detection_annotations - # Label annotations on frame level. - # There is exactly one element for each unique label. + # Label annotations on frame level. There is exactly one element for each unique + # label. # Corresponds to the JSON property `frameLabelAnnotations` # @return [Array] attr_accessor :frame_label_annotations - # Video file location in - # [Cloud Storage](https://cloud.google.com/storage/). + # Video file location in [Cloud Storage](https://cloud.google.com/storage/). # Corresponds to the JSON property `inputUri` # @return [String] attr_accessor :input_uri @@ -5641,11 +5481,11 @@ module Google attr_accessor :segment_label_annotations # Presence label annotations on video level or user-specified segment level. - # There is exactly one element for each unique label. Compared to the - # existing topical `segment_label_annotations`, this field presents more - # fine-grained, segment-level labels detected in video content and is made - # available only when the client sets `LabelDetectionConfig.model` to - # "builtin/latest" in the request. + # There is exactly one element for each unique label. Compared to the existing + # topical `segment_label_annotations`, this field presents more fine-grained, + # segment-level labels detected in video content and is made available only when + # the client sets `LabelDetectionConfig.model` to "builtin/latest" in the + # request. # Corresponds to the JSON property `segmentPresenceLabelAnnotations` # @return [Array] attr_accessor :segment_presence_label_annotations @@ -5655,17 +5495,17 @@ module Google # @return [Array] attr_accessor :shot_annotations - # Topical label annotations on shot level. - # There is exactly one element for each unique label. + # Topical label annotations on shot level. There is exactly one element for each + # unique label. # Corresponds to the JSON property `shotLabelAnnotations` # @return [Array] attr_accessor :shot_label_annotations # Presence label annotations on shot level. There is exactly one element for - # each unique label. Compared to the existing topical - # `shot_label_annotations`, this field presents more fine-grained, shot-level - # labels detected in video content and is made available only when the client - # sets `LabelDetectionConfig.model` to "builtin/latest" in the request. + # each unique label. Compared to the existing topical `shot_label_annotations`, + # this field presents more fine-grained, shot-level labels detected in video + # content and is made available only when the client sets `LabelDetectionConfig. + # model` to "builtin/latest" in the request. # Corresponds to the JSON property `shotPresenceLabelAnnotations` # @return [Array] attr_accessor :shot_presence_label_annotations @@ -5675,9 +5515,8 @@ module Google # @return [Array] attr_accessor :speech_transcriptions - # OCR text detection and tracking. - # Annotations for list of detected text snippets. Each will have list of - # frame information associated with it. + # OCR text detection and tracking. Annotations for list of detected text + # snippets. Each will have list of frame information associated with it. # Corresponds to the JSON property `textAnnotations` # @return [Array] attr_accessor :text_annotations @@ -5712,14 +5551,14 @@ module Google class GoogleCloudVideointelligenceV1p3beta1VideoSegment include Google::Apis::Core::Hashable - # Time-offset, relative to the beginning of the video, - # corresponding to the end of the segment (inclusive). + # Time-offset, relative to the beginning of the video, corresponding to the end + # of the segment (inclusive). # Corresponds to the JSON property `endTimeOffset` # @return [String] attr_accessor :end_time_offset - # Time-offset, relative to the beginning of the video, - # corresponding to the start of the segment (inclusive). + # Time-offset, relative to the beginning of the video, corresponding to the + # start of the segment (inclusive). # Corresponds to the JSON property `startTimeOffset` # @return [String] attr_accessor :start_time_offset @@ -5736,41 +5575,41 @@ module Google end # Word-specific information for recognized words. Word information is only - # included in the response when certain request parameters are set, such - # as `enable_word_time_offsets`. + # included in the response when certain request parameters are set, such as ` + # enable_word_time_offsets`. class GoogleCloudVideointelligenceV1p3beta1WordInfo include Google::Apis::Core::Hashable # Output only. The confidence estimate between 0.0 and 1.0. A higher number # indicates an estimated greater likelihood that the recognized words are - # correct. This field is set only for the top alternative. - # This field is not guaranteed to be accurate and users should not rely on it - # to be always provided. - # The default of 0.0 is a sentinel value indicating `confidence` was not set. + # correct. This field is set only for the top alternative. This field is not + # guaranteed to be accurate and users should not rely on it to be always + # provided. The default of 0.0 is a sentinel value indicating `confidence` was + # not set. # Corresponds to the JSON property `confidence` # @return [Float] attr_accessor :confidence - # Time offset relative to the beginning of the audio, and - # corresponding to the end of the spoken word. This field is only set if - # `enable_word_time_offsets=true` and only in the top hypothesis. This is an - # experimental feature and the accuracy of the time offset can vary. + # Time offset relative to the beginning of the audio, and corresponding to the + # end of the spoken word. This field is only set if `enable_word_time_offsets= + # true` and only in the top hypothesis. This is an experimental feature and the + # accuracy of the time offset can vary. # Corresponds to the JSON property `endTime` # @return [String] attr_accessor :end_time - # Output only. A distinct integer value is assigned for every speaker within - # the audio. This field specifies which one of those speakers was detected to - # have spoken this word. Value ranges from 1 up to diarization_speaker_count, - # and is only set if speaker diarization is enabled. + # Output only. A distinct integer value is assigned for every speaker within the + # audio. This field specifies which one of those speakers was detected to have + # spoken this word. Value ranges from 1 up to diarization_speaker_count, and is + # only set if speaker diarization is enabled. # Corresponds to the JSON property `speakerTag` # @return [Fixnum] attr_accessor :speaker_tag - # Time offset relative to the beginning of the audio, and - # corresponding to the start of the spoken word. This field is only set if - # `enable_word_time_offsets=true` and only in the top hypothesis. This is an - # experimental feature and the accuracy of the time offset can vary. + # Time offset relative to the beginning of the audio, and corresponding to the + # start of the spoken word. This field is only set if `enable_word_time_offsets= + # true` and only in the top hypothesis. This is an experimental feature and the + # accuracy of the time offset can vary. # Corresponds to the JSON property `startTime` # @return [String] attr_accessor :start_time @@ -5799,47 +5638,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::VideointelligenceV1p1beta1::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 @@ -5858,12 +5695,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 @@ -5872,15 +5709,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 diff --git a/generated/google/apis/videointelligence_v1p1beta1/service.rb b/generated/google/apis/videointelligence_v1p1beta1/service.rb index 5fcef7f87..ad5a11a5b 100644 --- a/generated/google/apis/videointelligence_v1p1beta1/service.rb +++ b/generated/google/apis/videointelligence_v1p1beta1/service.rb @@ -49,10 +49,10 @@ module Google @batch_path = 'batch' end - # Performs asynchronous video annotation. Progress and results can be - # retrieved through the `google.longrunning.Operations` interface. - # `Operation.metadata` contains `AnnotateVideoProgress` (progress). - # `Operation.response` contains `AnnotateVideoResponse` (results). + # Performs asynchronous video annotation. Progress and results can be retrieved + # through the `google.longrunning.Operations` interface. `Operation.metadata` + # contains `AnnotateVideoProgress` (progress). `Operation.response` contains ` + # AnnotateVideoResponse` (results). # @param [Google::Apis::VideointelligenceV1p1beta1::GoogleCloudVideointelligenceV1p1beta1AnnotateVideoRequest] google_cloud_videointelligence_v1p1beta1_annotate_video_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. diff --git a/generated/google/apis/videointelligence_v1p2beta1.rb b/generated/google/apis/videointelligence_v1p2beta1.rb index 2fd7c19ec..5e773dfa6 100644 --- a/generated/google/apis/videointelligence_v1p2beta1.rb +++ b/generated/google/apis/videointelligence_v1p2beta1.rb @@ -27,7 +27,7 @@ module Google # @see https://cloud.google.com/video-intelligence/docs/ module VideointelligenceV1p2beta1 VERSION = 'V1p2beta1' - REVISION = '20200602' + 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/videointelligence_v1p2beta1/classes.rb b/generated/google/apis/videointelligence_v1p2beta1/classes.rb index cc791467f..803881c24 100644 --- a/generated/google/apis/videointelligence_v1p2beta1/classes.rb +++ b/generated/google/apis/videointelligence_v1p2beta1/classes.rb @@ -22,9 +22,9 @@ module Google module Apis module VideointelligenceV1p2beta1 - # Video annotation progress. Included in the `metadata` - # field of the `Operation` returned by the `GetOperation` - # call of the `google::longrunning::Operations` service. + # Video annotation progress. Included in the `metadata` field of the `Operation` + # returned by the `GetOperation` call of the `google::longrunning::Operations` + # service. class GoogleCloudVideointelligenceV1AnnotateVideoProgress include Google::Apis::Core::Hashable @@ -43,9 +43,9 @@ module Google end end - # Video annotation response. Included in the `response` - # field of the `Operation` returned by the `GetOperation` - # call of the `google::longrunning::Operations` service. + # Video annotation response. Included in the `response` field of the `Operation` + # returned by the `GetOperation` call of the `google::longrunning::Operations` + # service. class GoogleCloudVideointelligenceV1AnnotateVideoResponse include Google::Apis::Core::Hashable @@ -73,14 +73,14 @@ module Google # @return [Float] attr_accessor :confidence - # The name of the attribute, for example, glasses, dark_glasses, mouth_open. - # A full list of supported type names will be provided in the document. + # The name of the attribute, for example, glasses, dark_glasses, mouth_open. A + # full list of supported type names will be provided in the document. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name - # Text value of the detection result. For example, the value for "HairColor" - # can be "black", "blonde", etc. + # Text value of the detection result. For example, the value for "HairColor" can + # be "black", "blonde", etc. # Corresponds to the JSON property `value` # @return [String] attr_accessor :value @@ -112,9 +112,8 @@ module Google # @return [String] attr_accessor :name - # A vertex represents a 2D point in the image. - # NOTE: the normalized vertex coordinates are relative to the original image - # and range from 0 to 1. + # A vertex represents a 2D point in the image. NOTE: the normalized vertex + # coordinates are relative to the original image and range from 0 to 1. # Corresponds to the JSON property `point` # @return [Google::Apis::VideointelligenceV1p2beta1::GoogleCloudVideointelligenceV1NormalizedVertex] attr_accessor :point @@ -140,8 +139,7 @@ module Google # @return [String] attr_accessor :description - # Opaque entity ID. Some IDs may be available in - # [Google Knowledge Graph Search + # Opaque entity ID. Some IDs may be available in [Google Knowledge Graph Search # API](https://developers.google.com/knowledge-graph/). # Corresponds to the JSON property `entityId` # @return [String] @@ -164,9 +162,9 @@ module Google end end - # Explicit content annotation (based on per-frame visual signals only). - # If no explicit content has been detected in a frame, no annotations are - # present for that frame. + # Explicit content annotation (based on per-frame visual signals only). If no + # explicit content has been detected in a frame, no annotations are present for + # that frame. class GoogleCloudVideointelligenceV1ExplicitContentAnnotation include Google::Apis::Core::Hashable @@ -221,10 +219,9 @@ module Google class GoogleCloudVideointelligenceV1LabelAnnotation include Google::Apis::Core::Hashable - # Common categories for the detected entity. - # For example, when the label is `Terrier`, the category is likely `dog`. And - # in some cases there might be more than one categories e.g., `Terrier` could - # also be a `pet`. + # Common categories for the detected entity. For example, when the label is ` + # Terrier`, the category is likely `dog`. And in some cases there might be more + # than one categories e.g., `Terrier` could also be a `pet`. # Corresponds to the JSON property `categoryEntities` # @return [Array] attr_accessor :category_entities @@ -323,14 +320,14 @@ module Google # @return [Google::Apis::VideointelligenceV1p2beta1::GoogleCloudVideointelligenceV1Entity] attr_accessor :entity - # All video segments where the recognized logo appears. There might be - # multiple instances of the same logo class appearing in one VideoSegment. + # All video segments where the recognized logo appears. There might be multiple + # instances of the same logo class appearing in one VideoSegment. # Corresponds to the JSON property `segments` # @return [Array] attr_accessor :segments - # All logo tracks where the recognized logo appears. Each track corresponds - # to one logo instance appearing in consecutive frames. + # All logo tracks where the recognized logo appears. Each track corresponds to + # one logo instance appearing in consecutive frames. # Corresponds to the JSON property `tracks` # @return [Array] attr_accessor :tracks @@ -347,9 +344,8 @@ module Google end end - # Normalized bounding box. - # The normalized vertex coordinates are relative to the original image. - # Range: [0, 1]. + # Normalized bounding box. The normalized vertex coordinates are relative to the + # original image. Range: [0, 1]. class GoogleCloudVideointelligenceV1NormalizedBoundingBox include Google::Apis::Core::Hashable @@ -387,20 +383,12 @@ module Google end # Normalized bounding polygon for text (that might not be aligned with axis). - # Contains list of the corner points in clockwise order starting from - # top-left corner. For example, for a rectangular bounding box: - # When the text is horizontal it might look like: - # 0----1 - # | | - # 3----2 - # When it's clockwise rotated 180 degrees around the top-left corner it - # becomes: - # 2----3 - # | | - # 1----0 - # and the vertex order will still be (0, 1, 2, 3). Note that values can be less - # than 0, or greater than 1 due to trignometric calculations for location of - # the box. + # Contains list of the corner points in clockwise order starting from top-left + # corner. For example, for a rectangular bounding box: When the text is + # horizontal it might look like: 0----1 | | 3----2 When it's clockwise rotated + # 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the + # vertex order will still be (0, 1, 2, 3). Note that values can be less than 0, + # or greater than 1 due to trignometric calculations for location of the box. class GoogleCloudVideointelligenceV1NormalizedBoundingPoly include Google::Apis::Core::Hashable @@ -419,9 +407,8 @@ module Google end end - # A vertex represents a 2D point in the image. - # NOTE: the normalized vertex coordinates are relative to the original image - # and range from 0 to 1. + # A vertex represents a 2D point in the image. NOTE: the normalized vertex + # coordinates are relative to the original image and range from 0 to 1. class GoogleCloudVideointelligenceV1NormalizedVertex include Google::Apis::Core::Hashable @@ -460,10 +447,10 @@ module Google # @return [Google::Apis::VideointelligenceV1p2beta1::GoogleCloudVideointelligenceV1Entity] attr_accessor :entity - # Information corresponding to all frames where this object track appears. - # Non-streaming batch mode: it may be one or multiple ObjectTrackingFrame - # messages in frames. - # Streaming mode: it can only be one ObjectTrackingFrame message in frames. + # Information corresponding to all frames where this object track appears. Non- + # streaming batch mode: it may be one or multiple ObjectTrackingFrame messages + # in frames. Streaming mode: it can only be one ObjectTrackingFrame message in + # frames. # Corresponds to the JSON property `frames` # @return [Array] attr_accessor :frames @@ -473,12 +460,11 @@ module Google # @return [Google::Apis::VideointelligenceV1p2beta1::GoogleCloudVideointelligenceV1VideoSegment] attr_accessor :segment - # Streaming mode ONLY. - # In streaming mode, we do not know the end time of a tracked object - # before it is completed. Hence, there is no VideoSegment info returned. - # Instead, we provide a unique identifiable integer track_id so that - # the customers can correlate the results of the ongoing - # ObjectTrackAnnotation of the same track_id over time. + # Streaming mode ONLY. In streaming mode, we do not know the end time of a + # tracked object before it is completed. Hence, there is no VideoSegment info + # returned. Instead, we provide a unique identifiable integer track_id so that + # the customers can correlate the results of the ongoing ObjectTrackAnnotation + # of the same track_id over time. # Corresponds to the JSON property `trackId` # @return [Fixnum] attr_accessor :track_id @@ -508,9 +494,8 @@ module Google class GoogleCloudVideointelligenceV1ObjectTrackingFrame include Google::Apis::Core::Hashable - # Normalized bounding box. - # The normalized vertex coordinates are relative to the original image. - # Range: [0, 1]. + # Normalized bounding box. The normalized vertex coordinates are relative to the + # original image. Range: [0, 1]. # Corresponds to the JSON property `normalizedBoundingBox` # @return [Google::Apis::VideointelligenceV1p2beta1::GoogleCloudVideointelligenceV1NormalizedBoundingBox] attr_accessor :normalized_bounding_box @@ -537,10 +522,10 @@ module Google # Output only. The confidence estimate between 0.0 and 1.0. A higher number # indicates an estimated greater likelihood that the recognized words are - # correct. This field is set only for the top alternative. - # This field is not guaranteed to be accurate and users should not rely on it - # to be always provided. - # The default of 0.0 is a sentinel value indicating `confidence` was not set. + # correct. This field is set only for the top alternative. This field is not + # guaranteed to be accurate and users should not rely on it to be always + # provided. The default of 0.0 is a sentinel value indicating `confidence` was + # not set. # Corresponds to the JSON property `confidence` # @return [Float] attr_accessor :confidence @@ -551,8 +536,8 @@ module Google attr_accessor :transcript # Output only. A list of word-specific information for each recognized word. - # Note: When `enable_speaker_diarization` is set to true, you will see all - # the words from the beginning of the audio. + # Note: When `enable_speaker_diarization` is set to true, you will see all the + # words from the beginning of the audio. # Corresponds to the JSON property `words` # @return [Array] attr_accessor :words @@ -573,18 +558,17 @@ module Google class GoogleCloudVideointelligenceV1SpeechTranscription include Google::Apis::Core::Hashable - # May contain one or more recognition hypotheses (up to the maximum specified - # in `max_alternatives`). These alternatives are ordered in terms of - # accuracy, with the top (first) alternative being the most probable, as - # ranked by the recognizer. + # May contain one or more recognition hypotheses (up to the maximum specified in + # `max_alternatives`). These alternatives are ordered in terms of accuracy, with + # the top (first) alternative being the most probable, as ranked by the + # recognizer. # Corresponds to the JSON property `alternatives` # @return [Array] attr_accessor :alternatives # Output only. The [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) - # language tag of - # the language in this result. This language code was detected to have the - # most likelihood of being spoken in the audio. + # language tag of the language in this result. This language code was detected + # to have the most likelihood of being spoken in the audio. # Corresponds to the JSON property `languageCode` # @return [String] attr_accessor :language_code @@ -633,27 +617,19 @@ module Google end end - # Video frame level annotation results for text annotation (OCR). - # Contains information regarding timestamp and bounding box locations for the - # frames containing detected OCR text snippets. + # Video frame level annotation results for text annotation (OCR). Contains + # information regarding timestamp and bounding box locations for the frames + # containing detected OCR text snippets. class GoogleCloudVideointelligenceV1TextFrame include Google::Apis::Core::Hashable # Normalized bounding polygon for text (that might not be aligned with axis). - # Contains list of the corner points in clockwise order starting from - # top-left corner. For example, for a rectangular bounding box: - # When the text is horizontal it might look like: - # 0----1 - # | | - # 3----2 - # When it's clockwise rotated 180 degrees around the top-left corner it - # becomes: - # 2----3 - # | | - # 1----0 - # and the vertex order will still be (0, 1, 2, 3). Note that values can be less - # than 0, or greater than 1 due to trignometric calculations for location of - # the box. + # Contains list of the corner points in clockwise order starting from top-left + # corner. For example, for a rectangular bounding box: When the text is + # horizontal it might look like: 0----1 | | 3----2 When it's clockwise rotated + # 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the + # vertex order will still be (0, 1, 2, 3). Note that values can be less than 0, + # or greater than 1 due to trignometric calculations for location of the box. # Corresponds to the JSON property `rotatedBoundingBox` # @return [Google::Apis::VideointelligenceV1p2beta1::GoogleCloudVideointelligenceV1NormalizedBoundingPoly] attr_accessor :rotated_bounding_box @@ -706,9 +682,8 @@ module Google end end - # For tracking related features. - # An object at time_offset with attributes, and located with - # normalized_bounding_box. + # For tracking related features. An object at time_offset with attributes, and + # located with normalized_bounding_box. class GoogleCloudVideointelligenceV1TimestampedObject include Google::Apis::Core::Hashable @@ -722,15 +697,14 @@ module Google # @return [Array] attr_accessor :landmarks - # Normalized bounding box. - # The normalized vertex coordinates are relative to the original image. - # Range: [0, 1]. + # Normalized bounding box. The normalized vertex coordinates are relative to the + # original image. Range: [0, 1]. # Corresponds to the JSON property `normalizedBoundingBox` # @return [Google::Apis::VideointelligenceV1p2beta1::GoogleCloudVideointelligenceV1NormalizedBoundingBox] attr_accessor :normalized_bounding_box - # Time-offset, relative to the beginning of the video, - # corresponding to the video frame for this object. + # Time-offset, relative to the beginning of the video, corresponding to the + # video frame for this object. # Corresponds to the JSON property `timeOffset` # @return [String] attr_accessor :time_offset @@ -789,20 +763,19 @@ module Google class GoogleCloudVideointelligenceV1VideoAnnotationProgress include Google::Apis::Core::Hashable - # Specifies which feature is being tracked if the request contains more than - # one feature. + # Specifies which feature is being tracked if the request contains more than one + # feature. # Corresponds to the JSON property `feature` # @return [String] attr_accessor :feature - # Video file location in - # [Cloud Storage](https://cloud.google.com/storage/). + # Video file location in [Cloud Storage](https://cloud.google.com/storage/). # Corresponds to the JSON property `inputUri` # @return [String] attr_accessor :input_uri - # Approximate percentage processed thus far. Guaranteed to be - # 100 when fully processed. + # Approximate percentage processed thus far. Guaranteed to be 100 when fully + # processed. # Corresponds to the JSON property `progressPercent` # @return [Fixnum] attr_accessor :progress_percent @@ -841,31 +814,30 @@ module Google class GoogleCloudVideointelligenceV1VideoAnnotationResults include Google::Apis::Core::Hashable - # 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::VideointelligenceV1p2beta1::GoogleRpcStatus] attr_accessor :error - # Explicit content annotation (based on per-frame visual signals only). - # If no explicit content has been detected in a frame, no annotations are - # present for that frame. + # Explicit content annotation (based on per-frame visual signals only). If no + # explicit content has been detected in a frame, no annotations are present for + # that frame. # Corresponds to the JSON property `explicitAnnotation` # @return [Google::Apis::VideointelligenceV1p2beta1::GoogleCloudVideointelligenceV1ExplicitContentAnnotation] attr_accessor :explicit_annotation - # Label annotations on frame level. - # There is exactly one element for each unique label. + # Label annotations on frame level. There is exactly one element for each unique + # label. # Corresponds to the JSON property `frameLabelAnnotations` # @return [Array] attr_accessor :frame_label_annotations - # Video file location in - # [Cloud Storage](https://cloud.google.com/storage/). + # Video file location in [Cloud Storage](https://cloud.google.com/storage/). # Corresponds to the JSON property `inputUri` # @return [String] attr_accessor :input_uri @@ -892,11 +864,11 @@ module Google attr_accessor :segment_label_annotations # Presence label annotations on video level or user-specified segment level. - # There is exactly one element for each unique label. Compared to the - # existing topical `segment_label_annotations`, this field presents more - # fine-grained, segment-level labels detected in video content and is made - # available only when the client sets `LabelDetectionConfig.model` to - # "builtin/latest" in the request. + # There is exactly one element for each unique label. Compared to the existing + # topical `segment_label_annotations`, this field presents more fine-grained, + # segment-level labels detected in video content and is made available only when + # the client sets `LabelDetectionConfig.model` to "builtin/latest" in the + # request. # Corresponds to the JSON property `segmentPresenceLabelAnnotations` # @return [Array] attr_accessor :segment_presence_label_annotations @@ -906,17 +878,17 @@ module Google # @return [Array] attr_accessor :shot_annotations - # Topical label annotations on shot level. - # There is exactly one element for each unique label. + # Topical label annotations on shot level. There is exactly one element for each + # unique label. # Corresponds to the JSON property `shotLabelAnnotations` # @return [Array] attr_accessor :shot_label_annotations # Presence label annotations on shot level. There is exactly one element for - # each unique label. Compared to the existing topical - # `shot_label_annotations`, this field presents more fine-grained, shot-level - # labels detected in video content and is made available only when the client - # sets `LabelDetectionConfig.model` to "builtin/latest" in the request. + # each unique label. Compared to the existing topical `shot_label_annotations`, + # this field presents more fine-grained, shot-level labels detected in video + # content and is made available only when the client sets `LabelDetectionConfig. + # model` to "builtin/latest" in the request. # Corresponds to the JSON property `shotPresenceLabelAnnotations` # @return [Array] attr_accessor :shot_presence_label_annotations @@ -926,9 +898,8 @@ module Google # @return [Array] attr_accessor :speech_transcriptions - # OCR text detection and tracking. - # Annotations for list of detected text snippets. Each will have list of - # frame information associated with it. + # OCR text detection and tracking. Annotations for list of detected text + # snippets. Each will have list of frame information associated with it. # Corresponds to the JSON property `textAnnotations` # @return [Array] attr_accessor :text_annotations @@ -960,14 +931,14 @@ module Google class GoogleCloudVideointelligenceV1VideoSegment include Google::Apis::Core::Hashable - # Time-offset, relative to the beginning of the video, - # corresponding to the end of the segment (inclusive). + # Time-offset, relative to the beginning of the video, corresponding to the end + # of the segment (inclusive). # Corresponds to the JSON property `endTimeOffset` # @return [String] attr_accessor :end_time_offset - # Time-offset, relative to the beginning of the video, - # corresponding to the start of the segment (inclusive). + # Time-offset, relative to the beginning of the video, corresponding to the + # start of the segment (inclusive). # Corresponds to the JSON property `startTimeOffset` # @return [String] attr_accessor :start_time_offset @@ -984,41 +955,41 @@ module Google end # Word-specific information for recognized words. Word information is only - # included in the response when certain request parameters are set, such - # as `enable_word_time_offsets`. + # included in the response when certain request parameters are set, such as ` + # enable_word_time_offsets`. class GoogleCloudVideointelligenceV1WordInfo include Google::Apis::Core::Hashable # Output only. The confidence estimate between 0.0 and 1.0. A higher number # indicates an estimated greater likelihood that the recognized words are - # correct. This field is set only for the top alternative. - # This field is not guaranteed to be accurate and users should not rely on it - # to be always provided. - # The default of 0.0 is a sentinel value indicating `confidence` was not set. + # correct. This field is set only for the top alternative. This field is not + # guaranteed to be accurate and users should not rely on it to be always + # provided. The default of 0.0 is a sentinel value indicating `confidence` was + # not set. # Corresponds to the JSON property `confidence` # @return [Float] attr_accessor :confidence - # Time offset relative to the beginning of the audio, and - # corresponding to the end of the spoken word. This field is only set if - # `enable_word_time_offsets=true` and only in the top hypothesis. This is an - # experimental feature and the accuracy of the time offset can vary. + # Time offset relative to the beginning of the audio, and corresponding to the + # end of the spoken word. This field is only set if `enable_word_time_offsets= + # true` and only in the top hypothesis. This is an experimental feature and the + # accuracy of the time offset can vary. # Corresponds to the JSON property `endTime` # @return [String] attr_accessor :end_time - # Output only. A distinct integer value is assigned for every speaker within - # the audio. This field specifies which one of those speakers was detected to - # have spoken this word. Value ranges from 1 up to diarization_speaker_count, - # and is only set if speaker diarization is enabled. + # Output only. A distinct integer value is assigned for every speaker within the + # audio. This field specifies which one of those speakers was detected to have + # spoken this word. Value ranges from 1 up to diarization_speaker_count, and is + # only set if speaker diarization is enabled. # Corresponds to the JSON property `speakerTag` # @return [Fixnum] attr_accessor :speaker_tag - # Time offset relative to the beginning of the audio, and - # corresponding to the start of the spoken word. This field is only set if - # `enable_word_time_offsets=true` and only in the top hypothesis. This is an - # experimental feature and the accuracy of the time offset can vary. + # Time offset relative to the beginning of the audio, and corresponding to the + # start of the spoken word. This field is only set if `enable_word_time_offsets= + # true` and only in the top hypothesis. This is an experimental feature and the + # accuracy of the time offset can vary. # Corresponds to the JSON property `startTime` # @return [String] attr_accessor :start_time @@ -1042,9 +1013,9 @@ module Google end end - # Video annotation progress. Included in the `metadata` - # field of the `Operation` returned by the `GetOperation` - # call of the `google::longrunning::Operations` service. + # Video annotation progress. Included in the `metadata` field of the `Operation` + # returned by the `GetOperation` call of the `google::longrunning::Operations` + # service. class GoogleCloudVideointelligenceV1beta2AnnotateVideoProgress include Google::Apis::Core::Hashable @@ -1063,9 +1034,9 @@ module Google end end - # Video annotation response. Included in the `response` - # field of the `Operation` returned by the `GetOperation` - # call of the `google::longrunning::Operations` service. + # Video annotation response. Included in the `response` field of the `Operation` + # returned by the `GetOperation` call of the `google::longrunning::Operations` + # service. class GoogleCloudVideointelligenceV1beta2AnnotateVideoResponse include Google::Apis::Core::Hashable @@ -1093,14 +1064,14 @@ module Google # @return [Float] attr_accessor :confidence - # The name of the attribute, for example, glasses, dark_glasses, mouth_open. - # A full list of supported type names will be provided in the document. + # The name of the attribute, for example, glasses, dark_glasses, mouth_open. A + # full list of supported type names will be provided in the document. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name - # Text value of the detection result. For example, the value for "HairColor" - # can be "black", "blonde", etc. + # Text value of the detection result. For example, the value for "HairColor" can + # be "black", "blonde", etc. # Corresponds to the JSON property `value` # @return [String] attr_accessor :value @@ -1132,9 +1103,8 @@ module Google # @return [String] attr_accessor :name - # A vertex represents a 2D point in the image. - # NOTE: the normalized vertex coordinates are relative to the original image - # and range from 0 to 1. + # A vertex represents a 2D point in the image. NOTE: the normalized vertex + # coordinates are relative to the original image and range from 0 to 1. # Corresponds to the JSON property `point` # @return [Google::Apis::VideointelligenceV1p2beta1::GoogleCloudVideointelligenceV1beta2NormalizedVertex] attr_accessor :point @@ -1160,8 +1130,7 @@ module Google # @return [String] attr_accessor :description - # Opaque entity ID. Some IDs may be available in - # [Google Knowledge Graph Search + # Opaque entity ID. Some IDs may be available in [Google Knowledge Graph Search # API](https://developers.google.com/knowledge-graph/). # Corresponds to the JSON property `entityId` # @return [String] @@ -1184,9 +1153,9 @@ module Google end end - # Explicit content annotation (based on per-frame visual signals only). - # If no explicit content has been detected in a frame, no annotations are - # present for that frame. + # Explicit content annotation (based on per-frame visual signals only). If no + # explicit content has been detected in a frame, no annotations are present for + # that frame. class GoogleCloudVideointelligenceV1beta2ExplicitContentAnnotation include Google::Apis::Core::Hashable @@ -1241,10 +1210,9 @@ module Google class GoogleCloudVideointelligenceV1beta2LabelAnnotation include Google::Apis::Core::Hashable - # Common categories for the detected entity. - # For example, when the label is `Terrier`, the category is likely `dog`. And - # in some cases there might be more than one categories e.g., `Terrier` could - # also be a `pet`. + # Common categories for the detected entity. For example, when the label is ` + # Terrier`, the category is likely `dog`. And in some cases there might be more + # than one categories e.g., `Terrier` could also be a `pet`. # Corresponds to the JSON property `categoryEntities` # @return [Array] attr_accessor :category_entities @@ -1343,14 +1311,14 @@ module Google # @return [Google::Apis::VideointelligenceV1p2beta1::GoogleCloudVideointelligenceV1beta2Entity] attr_accessor :entity - # All video segments where the recognized logo appears. There might be - # multiple instances of the same logo class appearing in one VideoSegment. + # All video segments where the recognized logo appears. There might be multiple + # instances of the same logo class appearing in one VideoSegment. # Corresponds to the JSON property `segments` # @return [Array] attr_accessor :segments - # All logo tracks where the recognized logo appears. Each track corresponds - # to one logo instance appearing in consecutive frames. + # All logo tracks where the recognized logo appears. Each track corresponds to + # one logo instance appearing in consecutive frames. # Corresponds to the JSON property `tracks` # @return [Array] attr_accessor :tracks @@ -1367,9 +1335,8 @@ module Google end end - # Normalized bounding box. - # The normalized vertex coordinates are relative to the original image. - # Range: [0, 1]. + # Normalized bounding box. The normalized vertex coordinates are relative to the + # original image. Range: [0, 1]. class GoogleCloudVideointelligenceV1beta2NormalizedBoundingBox include Google::Apis::Core::Hashable @@ -1407,20 +1374,12 @@ module Google end # Normalized bounding polygon for text (that might not be aligned with axis). - # Contains list of the corner points in clockwise order starting from - # top-left corner. For example, for a rectangular bounding box: - # When the text is horizontal it might look like: - # 0----1 - # | | - # 3----2 - # When it's clockwise rotated 180 degrees around the top-left corner it - # becomes: - # 2----3 - # | | - # 1----0 - # and the vertex order will still be (0, 1, 2, 3). Note that values can be less - # than 0, or greater than 1 due to trignometric calculations for location of - # the box. + # Contains list of the corner points in clockwise order starting from top-left + # corner. For example, for a rectangular bounding box: When the text is + # horizontal it might look like: 0----1 | | 3----2 When it's clockwise rotated + # 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the + # vertex order will still be (0, 1, 2, 3). Note that values can be less than 0, + # or greater than 1 due to trignometric calculations for location of the box. class GoogleCloudVideointelligenceV1beta2NormalizedBoundingPoly include Google::Apis::Core::Hashable @@ -1439,9 +1398,8 @@ module Google end end - # A vertex represents a 2D point in the image. - # NOTE: the normalized vertex coordinates are relative to the original image - # and range from 0 to 1. + # A vertex represents a 2D point in the image. NOTE: the normalized vertex + # coordinates are relative to the original image and range from 0 to 1. class GoogleCloudVideointelligenceV1beta2NormalizedVertex include Google::Apis::Core::Hashable @@ -1480,10 +1438,10 @@ module Google # @return [Google::Apis::VideointelligenceV1p2beta1::GoogleCloudVideointelligenceV1beta2Entity] attr_accessor :entity - # Information corresponding to all frames where this object track appears. - # Non-streaming batch mode: it may be one or multiple ObjectTrackingFrame - # messages in frames. - # Streaming mode: it can only be one ObjectTrackingFrame message in frames. + # Information corresponding to all frames where this object track appears. Non- + # streaming batch mode: it may be one or multiple ObjectTrackingFrame messages + # in frames. Streaming mode: it can only be one ObjectTrackingFrame message in + # frames. # Corresponds to the JSON property `frames` # @return [Array] attr_accessor :frames @@ -1493,12 +1451,11 @@ module Google # @return [Google::Apis::VideointelligenceV1p2beta1::GoogleCloudVideointelligenceV1beta2VideoSegment] attr_accessor :segment - # Streaming mode ONLY. - # In streaming mode, we do not know the end time of a tracked object - # before it is completed. Hence, there is no VideoSegment info returned. - # Instead, we provide a unique identifiable integer track_id so that - # the customers can correlate the results of the ongoing - # ObjectTrackAnnotation of the same track_id over time. + # Streaming mode ONLY. In streaming mode, we do not know the end time of a + # tracked object before it is completed. Hence, there is no VideoSegment info + # returned. Instead, we provide a unique identifiable integer track_id so that + # the customers can correlate the results of the ongoing ObjectTrackAnnotation + # of the same track_id over time. # Corresponds to the JSON property `trackId` # @return [Fixnum] attr_accessor :track_id @@ -1528,9 +1485,8 @@ module Google class GoogleCloudVideointelligenceV1beta2ObjectTrackingFrame include Google::Apis::Core::Hashable - # Normalized bounding box. - # The normalized vertex coordinates are relative to the original image. - # Range: [0, 1]. + # Normalized bounding box. The normalized vertex coordinates are relative to the + # original image. Range: [0, 1]. # Corresponds to the JSON property `normalizedBoundingBox` # @return [Google::Apis::VideointelligenceV1p2beta1::GoogleCloudVideointelligenceV1beta2NormalizedBoundingBox] attr_accessor :normalized_bounding_box @@ -1557,10 +1513,10 @@ module Google # Output only. The confidence estimate between 0.0 and 1.0. A higher number # indicates an estimated greater likelihood that the recognized words are - # correct. This field is set only for the top alternative. - # This field is not guaranteed to be accurate and users should not rely on it - # to be always provided. - # The default of 0.0 is a sentinel value indicating `confidence` was not set. + # correct. This field is set only for the top alternative. This field is not + # guaranteed to be accurate and users should not rely on it to be always + # provided. The default of 0.0 is a sentinel value indicating `confidence` was + # not set. # Corresponds to the JSON property `confidence` # @return [Float] attr_accessor :confidence @@ -1571,8 +1527,8 @@ module Google attr_accessor :transcript # Output only. A list of word-specific information for each recognized word. - # Note: When `enable_speaker_diarization` is set to true, you will see all - # the words from the beginning of the audio. + # Note: When `enable_speaker_diarization` is set to true, you will see all the + # words from the beginning of the audio. # Corresponds to the JSON property `words` # @return [Array] attr_accessor :words @@ -1593,18 +1549,17 @@ module Google class GoogleCloudVideointelligenceV1beta2SpeechTranscription include Google::Apis::Core::Hashable - # May contain one or more recognition hypotheses (up to the maximum specified - # in `max_alternatives`). These alternatives are ordered in terms of - # accuracy, with the top (first) alternative being the most probable, as - # ranked by the recognizer. + # May contain one or more recognition hypotheses (up to the maximum specified in + # `max_alternatives`). These alternatives are ordered in terms of accuracy, with + # the top (first) alternative being the most probable, as ranked by the + # recognizer. # Corresponds to the JSON property `alternatives` # @return [Array] attr_accessor :alternatives # Output only. The [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) - # language tag of - # the language in this result. This language code was detected to have the - # most likelihood of being spoken in the audio. + # language tag of the language in this result. This language code was detected + # to have the most likelihood of being spoken in the audio. # Corresponds to the JSON property `languageCode` # @return [String] attr_accessor :language_code @@ -1653,27 +1608,19 @@ module Google end end - # Video frame level annotation results for text annotation (OCR). - # Contains information regarding timestamp and bounding box locations for the - # frames containing detected OCR text snippets. + # Video frame level annotation results for text annotation (OCR). Contains + # information regarding timestamp and bounding box locations for the frames + # containing detected OCR text snippets. class GoogleCloudVideointelligenceV1beta2TextFrame include Google::Apis::Core::Hashable # Normalized bounding polygon for text (that might not be aligned with axis). - # Contains list of the corner points in clockwise order starting from - # top-left corner. For example, for a rectangular bounding box: - # When the text is horizontal it might look like: - # 0----1 - # | | - # 3----2 - # When it's clockwise rotated 180 degrees around the top-left corner it - # becomes: - # 2----3 - # | | - # 1----0 - # and the vertex order will still be (0, 1, 2, 3). Note that values can be less - # than 0, or greater than 1 due to trignometric calculations for location of - # the box. + # Contains list of the corner points in clockwise order starting from top-left + # corner. For example, for a rectangular bounding box: When the text is + # horizontal it might look like: 0----1 | | 3----2 When it's clockwise rotated + # 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the + # vertex order will still be (0, 1, 2, 3). Note that values can be less than 0, + # or greater than 1 due to trignometric calculations for location of the box. # Corresponds to the JSON property `rotatedBoundingBox` # @return [Google::Apis::VideointelligenceV1p2beta1::GoogleCloudVideointelligenceV1beta2NormalizedBoundingPoly] attr_accessor :rotated_bounding_box @@ -1726,9 +1673,8 @@ module Google end end - # For tracking related features. - # An object at time_offset with attributes, and located with - # normalized_bounding_box. + # For tracking related features. An object at time_offset with attributes, and + # located with normalized_bounding_box. class GoogleCloudVideointelligenceV1beta2TimestampedObject include Google::Apis::Core::Hashable @@ -1742,15 +1688,14 @@ module Google # @return [Array] attr_accessor :landmarks - # Normalized bounding box. - # The normalized vertex coordinates are relative to the original image. - # Range: [0, 1]. + # Normalized bounding box. The normalized vertex coordinates are relative to the + # original image. Range: [0, 1]. # Corresponds to the JSON property `normalizedBoundingBox` # @return [Google::Apis::VideointelligenceV1p2beta1::GoogleCloudVideointelligenceV1beta2NormalizedBoundingBox] attr_accessor :normalized_bounding_box - # Time-offset, relative to the beginning of the video, - # corresponding to the video frame for this object. + # Time-offset, relative to the beginning of the video, corresponding to the + # video frame for this object. # Corresponds to the JSON property `timeOffset` # @return [String] attr_accessor :time_offset @@ -1809,20 +1754,19 @@ module Google class GoogleCloudVideointelligenceV1beta2VideoAnnotationProgress include Google::Apis::Core::Hashable - # Specifies which feature is being tracked if the request contains more than - # one feature. + # Specifies which feature is being tracked if the request contains more than one + # feature. # Corresponds to the JSON property `feature` # @return [String] attr_accessor :feature - # Video file location in - # [Cloud Storage](https://cloud.google.com/storage/). + # Video file location in [Cloud Storage](https://cloud.google.com/storage/). # Corresponds to the JSON property `inputUri` # @return [String] attr_accessor :input_uri - # Approximate percentage processed thus far. Guaranteed to be - # 100 when fully processed. + # Approximate percentage processed thus far. Guaranteed to be 100 when fully + # processed. # Corresponds to the JSON property `progressPercent` # @return [Fixnum] attr_accessor :progress_percent @@ -1861,31 +1805,30 @@ module Google class GoogleCloudVideointelligenceV1beta2VideoAnnotationResults include Google::Apis::Core::Hashable - # 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::VideointelligenceV1p2beta1::GoogleRpcStatus] attr_accessor :error - # Explicit content annotation (based on per-frame visual signals only). - # If no explicit content has been detected in a frame, no annotations are - # present for that frame. + # Explicit content annotation (based on per-frame visual signals only). If no + # explicit content has been detected in a frame, no annotations are present for + # that frame. # Corresponds to the JSON property `explicitAnnotation` # @return [Google::Apis::VideointelligenceV1p2beta1::GoogleCloudVideointelligenceV1beta2ExplicitContentAnnotation] attr_accessor :explicit_annotation - # Label annotations on frame level. - # There is exactly one element for each unique label. + # Label annotations on frame level. There is exactly one element for each unique + # label. # Corresponds to the JSON property `frameLabelAnnotations` # @return [Array] attr_accessor :frame_label_annotations - # Video file location in - # [Cloud Storage](https://cloud.google.com/storage/). + # Video file location in [Cloud Storage](https://cloud.google.com/storage/). # Corresponds to the JSON property `inputUri` # @return [String] attr_accessor :input_uri @@ -1912,11 +1855,11 @@ module Google attr_accessor :segment_label_annotations # Presence label annotations on video level or user-specified segment level. - # There is exactly one element for each unique label. Compared to the - # existing topical `segment_label_annotations`, this field presents more - # fine-grained, segment-level labels detected in video content and is made - # available only when the client sets `LabelDetectionConfig.model` to - # "builtin/latest" in the request. + # There is exactly one element for each unique label. Compared to the existing + # topical `segment_label_annotations`, this field presents more fine-grained, + # segment-level labels detected in video content and is made available only when + # the client sets `LabelDetectionConfig.model` to "builtin/latest" in the + # request. # Corresponds to the JSON property `segmentPresenceLabelAnnotations` # @return [Array] attr_accessor :segment_presence_label_annotations @@ -1926,17 +1869,17 @@ module Google # @return [Array] attr_accessor :shot_annotations - # Topical label annotations on shot level. - # There is exactly one element for each unique label. + # Topical label annotations on shot level. There is exactly one element for each + # unique label. # Corresponds to the JSON property `shotLabelAnnotations` # @return [Array] attr_accessor :shot_label_annotations # Presence label annotations on shot level. There is exactly one element for - # each unique label. Compared to the existing topical - # `shot_label_annotations`, this field presents more fine-grained, shot-level - # labels detected in video content and is made available only when the client - # sets `LabelDetectionConfig.model` to "builtin/latest" in the request. + # each unique label. Compared to the existing topical `shot_label_annotations`, + # this field presents more fine-grained, shot-level labels detected in video + # content and is made available only when the client sets `LabelDetectionConfig. + # model` to "builtin/latest" in the request. # Corresponds to the JSON property `shotPresenceLabelAnnotations` # @return [Array] attr_accessor :shot_presence_label_annotations @@ -1946,9 +1889,8 @@ module Google # @return [Array] attr_accessor :speech_transcriptions - # OCR text detection and tracking. - # Annotations for list of detected text snippets. Each will have list of - # frame information associated with it. + # OCR text detection and tracking. Annotations for list of detected text + # snippets. Each will have list of frame information associated with it. # Corresponds to the JSON property `textAnnotations` # @return [Array] attr_accessor :text_annotations @@ -1980,14 +1922,14 @@ module Google class GoogleCloudVideointelligenceV1beta2VideoSegment include Google::Apis::Core::Hashable - # Time-offset, relative to the beginning of the video, - # corresponding to the end of the segment (inclusive). + # Time-offset, relative to the beginning of the video, corresponding to the end + # of the segment (inclusive). # Corresponds to the JSON property `endTimeOffset` # @return [String] attr_accessor :end_time_offset - # Time-offset, relative to the beginning of the video, - # corresponding to the start of the segment (inclusive). + # Time-offset, relative to the beginning of the video, corresponding to the + # start of the segment (inclusive). # Corresponds to the JSON property `startTimeOffset` # @return [String] attr_accessor :start_time_offset @@ -2004,41 +1946,41 @@ module Google end # Word-specific information for recognized words. Word information is only - # included in the response when certain request parameters are set, such - # as `enable_word_time_offsets`. + # included in the response when certain request parameters are set, such as ` + # enable_word_time_offsets`. class GoogleCloudVideointelligenceV1beta2WordInfo include Google::Apis::Core::Hashable # Output only. The confidence estimate between 0.0 and 1.0. A higher number # indicates an estimated greater likelihood that the recognized words are - # correct. This field is set only for the top alternative. - # This field is not guaranteed to be accurate and users should not rely on it - # to be always provided. - # The default of 0.0 is a sentinel value indicating `confidence` was not set. + # correct. This field is set only for the top alternative. This field is not + # guaranteed to be accurate and users should not rely on it to be always + # provided. The default of 0.0 is a sentinel value indicating `confidence` was + # not set. # Corresponds to the JSON property `confidence` # @return [Float] attr_accessor :confidence - # Time offset relative to the beginning of the audio, and - # corresponding to the end of the spoken word. This field is only set if - # `enable_word_time_offsets=true` and only in the top hypothesis. This is an - # experimental feature and the accuracy of the time offset can vary. + # Time offset relative to the beginning of the audio, and corresponding to the + # end of the spoken word. This field is only set if `enable_word_time_offsets= + # true` and only in the top hypothesis. This is an experimental feature and the + # accuracy of the time offset can vary. # Corresponds to the JSON property `endTime` # @return [String] attr_accessor :end_time - # Output only. A distinct integer value is assigned for every speaker within - # the audio. This field specifies which one of those speakers was detected to - # have spoken this word. Value ranges from 1 up to diarization_speaker_count, - # and is only set if speaker diarization is enabled. + # Output only. A distinct integer value is assigned for every speaker within the + # audio. This field specifies which one of those speakers was detected to have + # spoken this word. Value ranges from 1 up to diarization_speaker_count, and is + # only set if speaker diarization is enabled. # Corresponds to the JSON property `speakerTag` # @return [Fixnum] attr_accessor :speaker_tag - # Time offset relative to the beginning of the audio, and - # corresponding to the start of the spoken word. This field is only set if - # `enable_word_time_offsets=true` and only in the top hypothesis. This is an - # experimental feature and the accuracy of the time offset can vary. + # Time offset relative to the beginning of the audio, and corresponding to the + # start of the spoken word. This field is only set if `enable_word_time_offsets= + # true` and only in the top hypothesis. This is an experimental feature and the + # accuracy of the time offset can vary. # Corresponds to the JSON property `startTime` # @return [String] attr_accessor :start_time @@ -2062,9 +2004,9 @@ module Google end end - # Video annotation progress. Included in the `metadata` - # field of the `Operation` returned by the `GetOperation` - # call of the `google::longrunning::Operations` service. + # Video annotation progress. Included in the `metadata` field of the `Operation` + # returned by the `GetOperation` call of the `google::longrunning::Operations` + # service. class GoogleCloudVideointelligenceV1p1beta1AnnotateVideoProgress include Google::Apis::Core::Hashable @@ -2083,9 +2025,9 @@ module Google end end - # Video annotation response. Included in the `response` - # field of the `Operation` returned by the `GetOperation` - # call of the `google::longrunning::Operations` service. + # Video annotation response. Included in the `response` field of the `Operation` + # returned by the `GetOperation` call of the `google::longrunning::Operations` + # service. class GoogleCloudVideointelligenceV1p1beta1AnnotateVideoResponse include Google::Apis::Core::Hashable @@ -2113,14 +2055,14 @@ module Google # @return [Float] attr_accessor :confidence - # The name of the attribute, for example, glasses, dark_glasses, mouth_open. - # A full list of supported type names will be provided in the document. + # The name of the attribute, for example, glasses, dark_glasses, mouth_open. A + # full list of supported type names will be provided in the document. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name - # Text value of the detection result. For example, the value for "HairColor" - # can be "black", "blonde", etc. + # Text value of the detection result. For example, the value for "HairColor" can + # be "black", "blonde", etc. # Corresponds to the JSON property `value` # @return [String] attr_accessor :value @@ -2152,9 +2094,8 @@ module Google # @return [String] attr_accessor :name - # A vertex represents a 2D point in the image. - # NOTE: the normalized vertex coordinates are relative to the original image - # and range from 0 to 1. + # A vertex represents a 2D point in the image. NOTE: the normalized vertex + # coordinates are relative to the original image and range from 0 to 1. # Corresponds to the JSON property `point` # @return [Google::Apis::VideointelligenceV1p2beta1::GoogleCloudVideointelligenceV1p1beta1NormalizedVertex] attr_accessor :point @@ -2180,8 +2121,7 @@ module Google # @return [String] attr_accessor :description - # Opaque entity ID. Some IDs may be available in - # [Google Knowledge Graph Search + # Opaque entity ID. Some IDs may be available in [Google Knowledge Graph Search # API](https://developers.google.com/knowledge-graph/). # Corresponds to the JSON property `entityId` # @return [String] @@ -2204,9 +2144,9 @@ module Google end end - # Explicit content annotation (based on per-frame visual signals only). - # If no explicit content has been detected in a frame, no annotations are - # present for that frame. + # Explicit content annotation (based on per-frame visual signals only). If no + # explicit content has been detected in a frame, no annotations are present for + # that frame. class GoogleCloudVideointelligenceV1p1beta1ExplicitContentAnnotation include Google::Apis::Core::Hashable @@ -2261,10 +2201,9 @@ module Google class GoogleCloudVideointelligenceV1p1beta1LabelAnnotation include Google::Apis::Core::Hashable - # Common categories for the detected entity. - # For example, when the label is `Terrier`, the category is likely `dog`. And - # in some cases there might be more than one categories e.g., `Terrier` could - # also be a `pet`. + # Common categories for the detected entity. For example, when the label is ` + # Terrier`, the category is likely `dog`. And in some cases there might be more + # than one categories e.g., `Terrier` could also be a `pet`. # Corresponds to the JSON property `categoryEntities` # @return [Array] attr_accessor :category_entities @@ -2363,14 +2302,14 @@ module Google # @return [Google::Apis::VideointelligenceV1p2beta1::GoogleCloudVideointelligenceV1p1beta1Entity] attr_accessor :entity - # All video segments where the recognized logo appears. There might be - # multiple instances of the same logo class appearing in one VideoSegment. + # All video segments where the recognized logo appears. There might be multiple + # instances of the same logo class appearing in one VideoSegment. # Corresponds to the JSON property `segments` # @return [Array] attr_accessor :segments - # All logo tracks where the recognized logo appears. Each track corresponds - # to one logo instance appearing in consecutive frames. + # All logo tracks where the recognized logo appears. Each track corresponds to + # one logo instance appearing in consecutive frames. # Corresponds to the JSON property `tracks` # @return [Array] attr_accessor :tracks @@ -2387,9 +2326,8 @@ module Google end end - # Normalized bounding box. - # The normalized vertex coordinates are relative to the original image. - # Range: [0, 1]. + # Normalized bounding box. The normalized vertex coordinates are relative to the + # original image. Range: [0, 1]. class GoogleCloudVideointelligenceV1p1beta1NormalizedBoundingBox include Google::Apis::Core::Hashable @@ -2427,20 +2365,12 @@ module Google end # Normalized bounding polygon for text (that might not be aligned with axis). - # Contains list of the corner points in clockwise order starting from - # top-left corner. For example, for a rectangular bounding box: - # When the text is horizontal it might look like: - # 0----1 - # | | - # 3----2 - # When it's clockwise rotated 180 degrees around the top-left corner it - # becomes: - # 2----3 - # | | - # 1----0 - # and the vertex order will still be (0, 1, 2, 3). Note that values can be less - # than 0, or greater than 1 due to trignometric calculations for location of - # the box. + # Contains list of the corner points in clockwise order starting from top-left + # corner. For example, for a rectangular bounding box: When the text is + # horizontal it might look like: 0----1 | | 3----2 When it's clockwise rotated + # 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the + # vertex order will still be (0, 1, 2, 3). Note that values can be less than 0, + # or greater than 1 due to trignometric calculations for location of the box. class GoogleCloudVideointelligenceV1p1beta1NormalizedBoundingPoly include Google::Apis::Core::Hashable @@ -2459,9 +2389,8 @@ module Google end end - # A vertex represents a 2D point in the image. - # NOTE: the normalized vertex coordinates are relative to the original image - # and range from 0 to 1. + # A vertex represents a 2D point in the image. NOTE: the normalized vertex + # coordinates are relative to the original image and range from 0 to 1. class GoogleCloudVideointelligenceV1p1beta1NormalizedVertex include Google::Apis::Core::Hashable @@ -2500,10 +2429,10 @@ module Google # @return [Google::Apis::VideointelligenceV1p2beta1::GoogleCloudVideointelligenceV1p1beta1Entity] attr_accessor :entity - # Information corresponding to all frames where this object track appears. - # Non-streaming batch mode: it may be one or multiple ObjectTrackingFrame - # messages in frames. - # Streaming mode: it can only be one ObjectTrackingFrame message in frames. + # Information corresponding to all frames where this object track appears. Non- + # streaming batch mode: it may be one or multiple ObjectTrackingFrame messages + # in frames. Streaming mode: it can only be one ObjectTrackingFrame message in + # frames. # Corresponds to the JSON property `frames` # @return [Array] attr_accessor :frames @@ -2513,12 +2442,11 @@ module Google # @return [Google::Apis::VideointelligenceV1p2beta1::GoogleCloudVideointelligenceV1p1beta1VideoSegment] attr_accessor :segment - # Streaming mode ONLY. - # In streaming mode, we do not know the end time of a tracked object - # before it is completed. Hence, there is no VideoSegment info returned. - # Instead, we provide a unique identifiable integer track_id so that - # the customers can correlate the results of the ongoing - # ObjectTrackAnnotation of the same track_id over time. + # Streaming mode ONLY. In streaming mode, we do not know the end time of a + # tracked object before it is completed. Hence, there is no VideoSegment info + # returned. Instead, we provide a unique identifiable integer track_id so that + # the customers can correlate the results of the ongoing ObjectTrackAnnotation + # of the same track_id over time. # Corresponds to the JSON property `trackId` # @return [Fixnum] attr_accessor :track_id @@ -2548,9 +2476,8 @@ module Google class GoogleCloudVideointelligenceV1p1beta1ObjectTrackingFrame include Google::Apis::Core::Hashable - # Normalized bounding box. - # The normalized vertex coordinates are relative to the original image. - # Range: [0, 1]. + # Normalized bounding box. The normalized vertex coordinates are relative to the + # original image. Range: [0, 1]. # Corresponds to the JSON property `normalizedBoundingBox` # @return [Google::Apis::VideointelligenceV1p2beta1::GoogleCloudVideointelligenceV1p1beta1NormalizedBoundingBox] attr_accessor :normalized_bounding_box @@ -2577,10 +2504,10 @@ module Google # Output only. The confidence estimate between 0.0 and 1.0. A higher number # indicates an estimated greater likelihood that the recognized words are - # correct. This field is set only for the top alternative. - # This field is not guaranteed to be accurate and users should not rely on it - # to be always provided. - # The default of 0.0 is a sentinel value indicating `confidence` was not set. + # correct. This field is set only for the top alternative. This field is not + # guaranteed to be accurate and users should not rely on it to be always + # provided. The default of 0.0 is a sentinel value indicating `confidence` was + # not set. # Corresponds to the JSON property `confidence` # @return [Float] attr_accessor :confidence @@ -2591,8 +2518,8 @@ module Google attr_accessor :transcript # Output only. A list of word-specific information for each recognized word. - # Note: When `enable_speaker_diarization` is set to true, you will see all - # the words from the beginning of the audio. + # Note: When `enable_speaker_diarization` is set to true, you will see all the + # words from the beginning of the audio. # Corresponds to the JSON property `words` # @return [Array] attr_accessor :words @@ -2613,18 +2540,17 @@ module Google class GoogleCloudVideointelligenceV1p1beta1SpeechTranscription include Google::Apis::Core::Hashable - # May contain one or more recognition hypotheses (up to the maximum specified - # in `max_alternatives`). These alternatives are ordered in terms of - # accuracy, with the top (first) alternative being the most probable, as - # ranked by the recognizer. + # May contain one or more recognition hypotheses (up to the maximum specified in + # `max_alternatives`). These alternatives are ordered in terms of accuracy, with + # the top (first) alternative being the most probable, as ranked by the + # recognizer. # Corresponds to the JSON property `alternatives` # @return [Array] attr_accessor :alternatives # Output only. The [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) - # language tag of - # the language in this result. This language code was detected to have the - # most likelihood of being spoken in the audio. + # language tag of the language in this result. This language code was detected + # to have the most likelihood of being spoken in the audio. # Corresponds to the JSON property `languageCode` # @return [String] attr_accessor :language_code @@ -2673,27 +2599,19 @@ module Google end end - # Video frame level annotation results for text annotation (OCR). - # Contains information regarding timestamp and bounding box locations for the - # frames containing detected OCR text snippets. + # Video frame level annotation results for text annotation (OCR). Contains + # information regarding timestamp and bounding box locations for the frames + # containing detected OCR text snippets. class GoogleCloudVideointelligenceV1p1beta1TextFrame include Google::Apis::Core::Hashable # Normalized bounding polygon for text (that might not be aligned with axis). - # Contains list of the corner points in clockwise order starting from - # top-left corner. For example, for a rectangular bounding box: - # When the text is horizontal it might look like: - # 0----1 - # | | - # 3----2 - # When it's clockwise rotated 180 degrees around the top-left corner it - # becomes: - # 2----3 - # | | - # 1----0 - # and the vertex order will still be (0, 1, 2, 3). Note that values can be less - # than 0, or greater than 1 due to trignometric calculations for location of - # the box. + # Contains list of the corner points in clockwise order starting from top-left + # corner. For example, for a rectangular bounding box: When the text is + # horizontal it might look like: 0----1 | | 3----2 When it's clockwise rotated + # 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the + # vertex order will still be (0, 1, 2, 3). Note that values can be less than 0, + # or greater than 1 due to trignometric calculations for location of the box. # Corresponds to the JSON property `rotatedBoundingBox` # @return [Google::Apis::VideointelligenceV1p2beta1::GoogleCloudVideointelligenceV1p1beta1NormalizedBoundingPoly] attr_accessor :rotated_bounding_box @@ -2746,9 +2664,8 @@ module Google end end - # For tracking related features. - # An object at time_offset with attributes, and located with - # normalized_bounding_box. + # For tracking related features. An object at time_offset with attributes, and + # located with normalized_bounding_box. class GoogleCloudVideointelligenceV1p1beta1TimestampedObject include Google::Apis::Core::Hashable @@ -2762,15 +2679,14 @@ module Google # @return [Array] attr_accessor :landmarks - # Normalized bounding box. - # The normalized vertex coordinates are relative to the original image. - # Range: [0, 1]. + # Normalized bounding box. The normalized vertex coordinates are relative to the + # original image. Range: [0, 1]. # Corresponds to the JSON property `normalizedBoundingBox` # @return [Google::Apis::VideointelligenceV1p2beta1::GoogleCloudVideointelligenceV1p1beta1NormalizedBoundingBox] attr_accessor :normalized_bounding_box - # Time-offset, relative to the beginning of the video, - # corresponding to the video frame for this object. + # Time-offset, relative to the beginning of the video, corresponding to the + # video frame for this object. # Corresponds to the JSON property `timeOffset` # @return [String] attr_accessor :time_offset @@ -2829,20 +2745,19 @@ module Google class GoogleCloudVideointelligenceV1p1beta1VideoAnnotationProgress include Google::Apis::Core::Hashable - # Specifies which feature is being tracked if the request contains more than - # one feature. + # Specifies which feature is being tracked if the request contains more than one + # feature. # Corresponds to the JSON property `feature` # @return [String] attr_accessor :feature - # Video file location in - # [Cloud Storage](https://cloud.google.com/storage/). + # Video file location in [Cloud Storage](https://cloud.google.com/storage/). # Corresponds to the JSON property `inputUri` # @return [String] attr_accessor :input_uri - # Approximate percentage processed thus far. Guaranteed to be - # 100 when fully processed. + # Approximate percentage processed thus far. Guaranteed to be 100 when fully + # processed. # Corresponds to the JSON property `progressPercent` # @return [Fixnum] attr_accessor :progress_percent @@ -2881,31 +2796,30 @@ module Google class GoogleCloudVideointelligenceV1p1beta1VideoAnnotationResults include Google::Apis::Core::Hashable - # 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::VideointelligenceV1p2beta1::GoogleRpcStatus] attr_accessor :error - # Explicit content annotation (based on per-frame visual signals only). - # If no explicit content has been detected in a frame, no annotations are - # present for that frame. + # Explicit content annotation (based on per-frame visual signals only). If no + # explicit content has been detected in a frame, no annotations are present for + # that frame. # Corresponds to the JSON property `explicitAnnotation` # @return [Google::Apis::VideointelligenceV1p2beta1::GoogleCloudVideointelligenceV1p1beta1ExplicitContentAnnotation] attr_accessor :explicit_annotation - # Label annotations on frame level. - # There is exactly one element for each unique label. + # Label annotations on frame level. There is exactly one element for each unique + # label. # Corresponds to the JSON property `frameLabelAnnotations` # @return [Array] attr_accessor :frame_label_annotations - # Video file location in - # [Cloud Storage](https://cloud.google.com/storage/). + # Video file location in [Cloud Storage](https://cloud.google.com/storage/). # Corresponds to the JSON property `inputUri` # @return [String] attr_accessor :input_uri @@ -2932,11 +2846,11 @@ module Google attr_accessor :segment_label_annotations # Presence label annotations on video level or user-specified segment level. - # There is exactly one element for each unique label. Compared to the - # existing topical `segment_label_annotations`, this field presents more - # fine-grained, segment-level labels detected in video content and is made - # available only when the client sets `LabelDetectionConfig.model` to - # "builtin/latest" in the request. + # There is exactly one element for each unique label. Compared to the existing + # topical `segment_label_annotations`, this field presents more fine-grained, + # segment-level labels detected in video content and is made available only when + # the client sets `LabelDetectionConfig.model` to "builtin/latest" in the + # request. # Corresponds to the JSON property `segmentPresenceLabelAnnotations` # @return [Array] attr_accessor :segment_presence_label_annotations @@ -2946,17 +2860,17 @@ module Google # @return [Array] attr_accessor :shot_annotations - # Topical label annotations on shot level. - # There is exactly one element for each unique label. + # Topical label annotations on shot level. There is exactly one element for each + # unique label. # Corresponds to the JSON property `shotLabelAnnotations` # @return [Array] attr_accessor :shot_label_annotations # Presence label annotations on shot level. There is exactly one element for - # each unique label. Compared to the existing topical - # `shot_label_annotations`, this field presents more fine-grained, shot-level - # labels detected in video content and is made available only when the client - # sets `LabelDetectionConfig.model` to "builtin/latest" in the request. + # each unique label. Compared to the existing topical `shot_label_annotations`, + # this field presents more fine-grained, shot-level labels detected in video + # content and is made available only when the client sets `LabelDetectionConfig. + # model` to "builtin/latest" in the request. # Corresponds to the JSON property `shotPresenceLabelAnnotations` # @return [Array] attr_accessor :shot_presence_label_annotations @@ -2966,9 +2880,8 @@ module Google # @return [Array] attr_accessor :speech_transcriptions - # OCR text detection and tracking. - # Annotations for list of detected text snippets. Each will have list of - # frame information associated with it. + # OCR text detection and tracking. Annotations for list of detected text + # snippets. Each will have list of frame information associated with it. # Corresponds to the JSON property `textAnnotations` # @return [Array] attr_accessor :text_annotations @@ -3000,14 +2913,14 @@ module Google class GoogleCloudVideointelligenceV1p1beta1VideoSegment include Google::Apis::Core::Hashable - # Time-offset, relative to the beginning of the video, - # corresponding to the end of the segment (inclusive). + # Time-offset, relative to the beginning of the video, corresponding to the end + # of the segment (inclusive). # Corresponds to the JSON property `endTimeOffset` # @return [String] attr_accessor :end_time_offset - # Time-offset, relative to the beginning of the video, - # corresponding to the start of the segment (inclusive). + # Time-offset, relative to the beginning of the video, corresponding to the + # start of the segment (inclusive). # Corresponds to the JSON property `startTimeOffset` # @return [String] attr_accessor :start_time_offset @@ -3024,41 +2937,41 @@ module Google end # Word-specific information for recognized words. Word information is only - # included in the response when certain request parameters are set, such - # as `enable_word_time_offsets`. + # included in the response when certain request parameters are set, such as ` + # enable_word_time_offsets`. class GoogleCloudVideointelligenceV1p1beta1WordInfo include Google::Apis::Core::Hashable # Output only. The confidence estimate between 0.0 and 1.0. A higher number # indicates an estimated greater likelihood that the recognized words are - # correct. This field is set only for the top alternative. - # This field is not guaranteed to be accurate and users should not rely on it - # to be always provided. - # The default of 0.0 is a sentinel value indicating `confidence` was not set. + # correct. This field is set only for the top alternative. This field is not + # guaranteed to be accurate and users should not rely on it to be always + # provided. The default of 0.0 is a sentinel value indicating `confidence` was + # not set. # Corresponds to the JSON property `confidence` # @return [Float] attr_accessor :confidence - # Time offset relative to the beginning of the audio, and - # corresponding to the end of the spoken word. This field is only set if - # `enable_word_time_offsets=true` and only in the top hypothesis. This is an - # experimental feature and the accuracy of the time offset can vary. + # Time offset relative to the beginning of the audio, and corresponding to the + # end of the spoken word. This field is only set if `enable_word_time_offsets= + # true` and only in the top hypothesis. This is an experimental feature and the + # accuracy of the time offset can vary. # Corresponds to the JSON property `endTime` # @return [String] attr_accessor :end_time - # Output only. A distinct integer value is assigned for every speaker within - # the audio. This field specifies which one of those speakers was detected to - # have spoken this word. Value ranges from 1 up to diarization_speaker_count, - # and is only set if speaker diarization is enabled. + # Output only. A distinct integer value is assigned for every speaker within the + # audio. This field specifies which one of those speakers was detected to have + # spoken this word. Value ranges from 1 up to diarization_speaker_count, and is + # only set if speaker diarization is enabled. # Corresponds to the JSON property `speakerTag` # @return [Fixnum] attr_accessor :speaker_tag - # Time offset relative to the beginning of the audio, and - # corresponding to the start of the spoken word. This field is only set if - # `enable_word_time_offsets=true` and only in the top hypothesis. This is an - # experimental feature and the accuracy of the time offset can vary. + # Time offset relative to the beginning of the audio, and corresponding to the + # start of the spoken word. This field is only set if `enable_word_time_offsets= + # true` and only in the top hypothesis. This is an experimental feature and the + # accuracy of the time offset can vary. # Corresponds to the JSON property `startTime` # @return [String] attr_accessor :start_time @@ -3082,9 +2995,9 @@ module Google end end - # Video annotation progress. Included in the `metadata` - # field of the `Operation` returned by the `GetOperation` - # call of the `google::longrunning::Operations` service. + # Video annotation progress. Included in the `metadata` field of the `Operation` + # returned by the `GetOperation` call of the `google::longrunning::Operations` + # service. class GoogleCloudVideointelligenceV1p2beta1AnnotateVideoProgress include Google::Apis::Core::Hashable @@ -3112,24 +3025,22 @@ module Google # @return [Array] attr_accessor :features - # The video data bytes. - # If unset, the input video(s) should be specified via the `input_uri`. - # If set, `input_uri` must be unset. + # The video data bytes. If unset, the input video(s) should be specified via the + # `input_uri`. If set, `input_uri` must be unset. # Corresponds to the JSON property `inputContent` # NOTE: Values are automatically base64 encoded/decoded in the client library. # @return [String] attr_accessor :input_content - # Input video location. Currently, only - # [Cloud Storage](https://cloud.google.com/storage/) URIs are - # supported. URIs must be specified in the following format: - # `gs://bucket-id/object-id` (other URI formats return - # google.rpc.Code.INVALID_ARGUMENT). For more information, see - # [Request URIs](https://cloud.google.com/storage/docs/request-endpoints). - # To identify multiple videos, a video URI may include wildcards in the - # `object-id`. Supported wildcards: '*' to match 0 or more characters; - # '?' to match 1 character. If unset, the input video should be embedded - # in the request as `input_content`. If set, `input_content` must be unset. + # Input video location. Currently, only [Cloud Storage](https://cloud.google.com/ + # storage/) URIs are supported. URIs must be specified in the following format: ` + # gs://bucket-id/object-id` (other URI formats return google.rpc.Code. + # INVALID_ARGUMENT). For more information, see [Request URIs](https://cloud. + # google.com/storage/docs/request-endpoints). To identify multiple videos, a + # video URI may include wildcards in the `object-id`. Supported wildcards: '*' + # to match 0 or more characters; '?' to match 1 character. If unset, the input + # video should be embedded in the request as `input_content`. If set, ` + # input_content` must be unset. # Corresponds to the JSON property `inputUri` # @return [String] attr_accessor :input_uri @@ -3143,11 +3054,11 @@ module Google attr_accessor :location_id # Optional. Location where the output (in JSON format) should be stored. - # Currently, only [Cloud Storage](https://cloud.google.com/storage/) - # URIs are supported. These must be specified in the following format: - # `gs://bucket-id/object-id` (other URI formats return - # google.rpc.Code.INVALID_ARGUMENT). For more information, see - # [Request URIs](https://cloud.google.com/storage/docs/request-endpoints). + # Currently, only [Cloud Storage](https://cloud.google.com/storage/) URIs are + # supported. These must be specified in the following format: `gs://bucket-id/ + # object-id` (other URI formats return google.rpc.Code.INVALID_ARGUMENT). For + # more information, see [Request URIs](https://cloud.google.com/storage/docs/ + # request-endpoints). # Corresponds to the JSON property `outputUri` # @return [String] attr_accessor :output_uri @@ -3172,9 +3083,9 @@ module Google end end - # Video annotation response. Included in the `response` - # field of the `Operation` returned by the `GetOperation` - # call of the `google::longrunning::Operations` service. + # Video annotation response. Included in the `response` field of the `Operation` + # returned by the `GetOperation` call of the `google::longrunning::Operations` + # service. class GoogleCloudVideointelligenceV1p2beta1AnnotateVideoResponse include Google::Apis::Core::Hashable @@ -3202,14 +3113,14 @@ module Google # @return [Float] attr_accessor :confidence - # The name of the attribute, for example, glasses, dark_glasses, mouth_open. - # A full list of supported type names will be provided in the document. + # The name of the attribute, for example, glasses, dark_glasses, mouth_open. A + # full list of supported type names will be provided in the document. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name - # Text value of the detection result. For example, the value for "HairColor" - # can be "black", "blonde", etc. + # Text value of the detection result. For example, the value for "HairColor" can + # be "black", "blonde", etc. # Corresponds to the JSON property `value` # @return [String] attr_accessor :value @@ -3241,9 +3152,8 @@ module Google # @return [String] attr_accessor :name - # A vertex represents a 2D point in the image. - # NOTE: the normalized vertex coordinates are relative to the original image - # and range from 0 to 1. + # A vertex represents a 2D point in the image. NOTE: the normalized vertex + # coordinates are relative to the original image and range from 0 to 1. # Corresponds to the JSON property `point` # @return [Google::Apis::VideointelligenceV1p2beta1::GoogleCloudVideointelligenceV1p2beta1NormalizedVertex] attr_accessor :point @@ -3269,8 +3179,7 @@ module Google # @return [String] attr_accessor :description - # Opaque entity ID. Some IDs may be available in - # [Google Knowledge Graph Search + # Opaque entity ID. Some IDs may be available in [Google Knowledge Graph Search # API](https://developers.google.com/knowledge-graph/). # Corresponds to the JSON property `entityId` # @return [String] @@ -3293,9 +3202,9 @@ module Google end end - # Explicit content annotation (based on per-frame visual signals only). - # If no explicit content has been detected in a frame, no annotations are - # present for that frame. + # Explicit content annotation (based on per-frame visual signals only). If no + # explicit content has been detected in a frame, no annotations are present for + # that frame. class GoogleCloudVideointelligenceV1p2beta1ExplicitContentAnnotation include Google::Apis::Core::Hashable @@ -3324,9 +3233,8 @@ module Google class GoogleCloudVideointelligenceV1p2beta1ExplicitContentDetectionConfig include Google::Apis::Core::Hashable - # Model to use for explicit content detection. - # Supported values: "builtin/stable" (the default if unset) and - # "builtin/latest". + # Model to use for explicit content detection. Supported values: "builtin/stable" + # (the default if unset) and "builtin/latest". # Corresponds to the JSON property `model` # @return [String] attr_accessor :model @@ -3371,10 +3279,9 @@ module Google class GoogleCloudVideointelligenceV1p2beta1LabelAnnotation include Google::Apis::Core::Hashable - # Common categories for the detected entity. - # For example, when the label is `Terrier`, the category is likely `dog`. And - # in some cases there might be more than one categories e.g., `Terrier` could - # also be a `pet`. + # Common categories for the detected entity. For example, when the label is ` + # Terrier`, the category is likely `dog`. And in some cases there might be more + # than one categories e.g., `Terrier` could also be a `pet`. # Corresponds to the JSON property `categoryEntities` # @return [Array] attr_accessor :category_entities @@ -3417,44 +3324,40 @@ module Google class GoogleCloudVideointelligenceV1p2beta1LabelDetectionConfig include Google::Apis::Core::Hashable - # The confidence threshold we perform filtering on the labels from - # frame-level detection. If not set, it is set to 0.4 by default. The valid - # range for this threshold is [0.1, 0.9]. Any value set outside of this - # range will be clipped. - # Note: For best results, follow the default threshold. We will update - # the default threshold everytime when we release a new model. + # The confidence threshold we perform filtering on the labels from frame-level + # detection. If not set, it is set to 0.4 by default. The valid range for this + # threshold is [0.1, 0.9]. Any value set outside of this range will be clipped. + # Note: For best results, follow the default threshold. We will update the + # default threshold everytime when we release a new model. # Corresponds to the JSON property `frameConfidenceThreshold` # @return [Float] attr_accessor :frame_confidence_threshold - # What labels should be detected with LABEL_DETECTION, in addition to - # video-level labels or segment-level labels. - # If unspecified, defaults to `SHOT_MODE`. + # What labels should be detected with LABEL_DETECTION, in addition to video- + # level labels or segment-level labels. If unspecified, defaults to `SHOT_MODE`. # Corresponds to the JSON property `labelDetectionMode` # @return [String] attr_accessor :label_detection_mode - # Model to use for label detection. - # Supported values: "builtin/stable" (the default if unset) and - # "builtin/latest". + # Model to use for label detection. Supported values: "builtin/stable" (the + # default if unset) and "builtin/latest". # Corresponds to the JSON property `model` # @return [String] attr_accessor :model - # Whether the video has been shot from a stationary (i.e., non-moving) - # camera. When set to true, might improve detection accuracy for moving - # objects. Should be used with `SHOT_AND_FRAME_MODE` enabled. + # Whether the video has been shot from a stationary (i.e., non-moving) camera. + # When set to true, might improve detection accuracy for moving objects. Should + # be used with `SHOT_AND_FRAME_MODE` enabled. # Corresponds to the JSON property `stationaryCamera` # @return [Boolean] attr_accessor :stationary_camera alias_method :stationary_camera?, :stationary_camera - # The confidence threshold we perform filtering on the labels from - # video-level and shot-level detections. If not set, it's set to 0.3 by - # default. The valid range for this threshold is [0.1, 0.9]. Any value set - # outside of this range will be clipped. - # Note: For best results, follow the default threshold. We will update - # the default threshold everytime when we release a new model. + # The confidence threshold we perform filtering on the labels from video-level + # and shot-level detections. If not set, it's set to 0.3 by default. The valid + # range for this threshold is [0.1, 0.9]. Any value set outside of this range + # will be clipped. Note: For best results, follow the default threshold. We will + # update the default threshold everytime when we release a new model. # Corresponds to the JSON property `videoConfidenceThreshold` # @return [Float] attr_accessor :video_confidence_threshold @@ -3533,14 +3436,14 @@ module Google # @return [Google::Apis::VideointelligenceV1p2beta1::GoogleCloudVideointelligenceV1p2beta1Entity] attr_accessor :entity - # All video segments where the recognized logo appears. There might be - # multiple instances of the same logo class appearing in one VideoSegment. + # All video segments where the recognized logo appears. There might be multiple + # instances of the same logo class appearing in one VideoSegment. # Corresponds to the JSON property `segments` # @return [Array] attr_accessor :segments - # All logo tracks where the recognized logo appears. Each track corresponds - # to one logo instance appearing in consecutive frames. + # All logo tracks where the recognized logo appears. Each track corresponds to + # one logo instance appearing in consecutive frames. # Corresponds to the JSON property `tracks` # @return [Array] attr_accessor :tracks @@ -3557,9 +3460,8 @@ module Google end end - # Normalized bounding box. - # The normalized vertex coordinates are relative to the original image. - # Range: [0, 1]. + # Normalized bounding box. The normalized vertex coordinates are relative to the + # original image. Range: [0, 1]. class GoogleCloudVideointelligenceV1p2beta1NormalizedBoundingBox include Google::Apis::Core::Hashable @@ -3597,20 +3499,12 @@ module Google end # Normalized bounding polygon for text (that might not be aligned with axis). - # Contains list of the corner points in clockwise order starting from - # top-left corner. For example, for a rectangular bounding box: - # When the text is horizontal it might look like: - # 0----1 - # | | - # 3----2 - # When it's clockwise rotated 180 degrees around the top-left corner it - # becomes: - # 2----3 - # | | - # 1----0 - # and the vertex order will still be (0, 1, 2, 3). Note that values can be less - # than 0, or greater than 1 due to trignometric calculations for location of - # the box. + # Contains list of the corner points in clockwise order starting from top-left + # corner. For example, for a rectangular bounding box: When the text is + # horizontal it might look like: 0----1 | | 3----2 When it's clockwise rotated + # 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the + # vertex order will still be (0, 1, 2, 3). Note that values can be less than 0, + # or greater than 1 due to trignometric calculations for location of the box. class GoogleCloudVideointelligenceV1p2beta1NormalizedBoundingPoly include Google::Apis::Core::Hashable @@ -3629,9 +3523,8 @@ module Google end end - # A vertex represents a 2D point in the image. - # NOTE: the normalized vertex coordinates are relative to the original image - # and range from 0 to 1. + # A vertex represents a 2D point in the image. NOTE: the normalized vertex + # coordinates are relative to the original image and range from 0 to 1. class GoogleCloudVideointelligenceV1p2beta1NormalizedVertex include Google::Apis::Core::Hashable @@ -3670,10 +3563,10 @@ module Google # @return [Google::Apis::VideointelligenceV1p2beta1::GoogleCloudVideointelligenceV1p2beta1Entity] attr_accessor :entity - # Information corresponding to all frames where this object track appears. - # Non-streaming batch mode: it may be one or multiple ObjectTrackingFrame - # messages in frames. - # Streaming mode: it can only be one ObjectTrackingFrame message in frames. + # Information corresponding to all frames where this object track appears. Non- + # streaming batch mode: it may be one or multiple ObjectTrackingFrame messages + # in frames. Streaming mode: it can only be one ObjectTrackingFrame message in + # frames. # Corresponds to the JSON property `frames` # @return [Array] attr_accessor :frames @@ -3683,12 +3576,11 @@ module Google # @return [Google::Apis::VideointelligenceV1p2beta1::GoogleCloudVideointelligenceV1p2beta1VideoSegment] attr_accessor :segment - # Streaming mode ONLY. - # In streaming mode, we do not know the end time of a tracked object - # before it is completed. Hence, there is no VideoSegment info returned. - # Instead, we provide a unique identifiable integer track_id so that - # the customers can correlate the results of the ongoing - # ObjectTrackAnnotation of the same track_id over time. + # Streaming mode ONLY. In streaming mode, we do not know the end time of a + # tracked object before it is completed. Hence, there is no VideoSegment info + # returned. Instead, we provide a unique identifiable integer track_id so that + # the customers can correlate the results of the ongoing ObjectTrackAnnotation + # of the same track_id over time. # Corresponds to the JSON property `trackId` # @return [Fixnum] attr_accessor :track_id @@ -3717,9 +3609,8 @@ module Google class GoogleCloudVideointelligenceV1p2beta1ObjectTrackingConfig include Google::Apis::Core::Hashable - # Model to use for object tracking. - # Supported values: "builtin/stable" (the default if unset) and - # "builtin/latest". + # Model to use for object tracking. Supported values: "builtin/stable" (the + # default if unset) and "builtin/latest". # Corresponds to the JSON property `model` # @return [String] attr_accessor :model @@ -3739,9 +3630,8 @@ module Google class GoogleCloudVideointelligenceV1p2beta1ObjectTrackingFrame include Google::Apis::Core::Hashable - # Normalized bounding box. - # The normalized vertex coordinates are relative to the original image. - # Range: [0, 1]. + # Normalized bounding box. The normalized vertex coordinates are relative to the + # original image. Range: [0, 1]. # Corresponds to the JSON property `normalizedBoundingBox` # @return [Google::Apis::VideointelligenceV1p2beta1::GoogleCloudVideointelligenceV1p2beta1NormalizedBoundingBox] attr_accessor :normalized_bounding_box @@ -3766,9 +3656,8 @@ module Google class GoogleCloudVideointelligenceV1p2beta1ShotChangeDetectionConfig include Google::Apis::Core::Hashable - # Model to use for shot change detection. - # Supported values: "builtin/stable" (the default if unset) and - # "builtin/latest". + # Model to use for shot change detection. Supported values: "builtin/stable" ( + # the default if unset) and "builtin/latest". # Corresponds to the JSON property `model` # @return [String] attr_accessor :model @@ -3788,12 +3677,12 @@ module Google class GoogleCloudVideointelligenceV1p2beta1SpeechContext include Google::Apis::Core::Hashable - # Optional. A list of strings containing words and phrases "hints" so that - # the speech recognition is more likely to recognize them. This can be used - # to improve the accuracy for specific words and phrases, for example, if - # specific commands are typically spoken by the user. This can also be used - # to add additional words to the vocabulary of the recognizer. See - # [usage limits](https://cloud.google.com/speech/limits#content). + # Optional. A list of strings containing words and phrases "hints" so that the + # speech recognition is more likely to recognize them. This can be used to + # improve the accuracy for specific words and phrases, for example, if specific + # commands are typically spoken by the user. This can also be used to add + # additional words to the vocabulary of the recognizer. See [usage limits](https: + # //cloud.google.com/speech/limits#content). # Corresponds to the JSON property `phrases` # @return [Array] attr_accessor :phrases @@ -3814,10 +3703,10 @@ module Google # Output only. The confidence estimate between 0.0 and 1.0. A higher number # indicates an estimated greater likelihood that the recognized words are - # correct. This field is set only for the top alternative. - # This field is not guaranteed to be accurate and users should not rely on it - # to be always provided. - # The default of 0.0 is a sentinel value indicating `confidence` was not set. + # correct. This field is set only for the top alternative. This field is not + # guaranteed to be accurate and users should not rely on it to be always + # provided. The default of 0.0 is a sentinel value indicating `confidence` was + # not set. # Corresponds to the JSON property `confidence` # @return [Float] attr_accessor :confidence @@ -3828,8 +3717,8 @@ module Google attr_accessor :transcript # Output only. A list of word-specific information for each recognized word. - # Note: When `enable_speaker_diarization` is set to true, you will see all - # the words from the beginning of the audio. + # Note: When `enable_speaker_diarization` is set to true, you will see all the + # words from the beginning of the audio. # Corresponds to the JSON property `words` # @return [Array] attr_accessor :words @@ -3850,18 +3739,17 @@ module Google class GoogleCloudVideointelligenceV1p2beta1SpeechTranscription include Google::Apis::Core::Hashable - # May contain one or more recognition hypotheses (up to the maximum specified - # in `max_alternatives`). These alternatives are ordered in terms of - # accuracy, with the top (first) alternative being the most probable, as - # ranked by the recognizer. + # May contain one or more recognition hypotheses (up to the maximum specified in + # `max_alternatives`). These alternatives are ordered in terms of accuracy, with + # the top (first) alternative being the most probable, as ranked by the + # recognizer. # Corresponds to the JSON property `alternatives` # @return [Array] attr_accessor :alternatives # Output only. The [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) - # language tag of - # the language in this result. This language code was detected to have the - # most likelihood of being spoken in the audio. + # language tag of the language in this result. This language code was detected + # to have the most likelihood of being spoken in the audio. # Corresponds to the JSON property `languageCode` # @return [String] attr_accessor :language_code @@ -3888,66 +3776,62 @@ module Google attr_accessor :audio_tracks # Optional. If set, specifies the estimated number of speakers in the - # conversation. - # If not set, defaults to '2'. - # Ignored unless enable_speaker_diarization is set to true. + # conversation. If not set, defaults to '2'. Ignored unless + # enable_speaker_diarization is set to true. # Corresponds to the JSON property `diarizationSpeakerCount` # @return [Fixnum] attr_accessor :diarization_speaker_count - # Optional. If 'true', adds punctuation to recognition result hypotheses. - # This feature is only available in select languages. Setting this for - # requests in other languages has no effect at all. The default 'false' value - # does not add punctuation to result hypotheses. NOTE: "This is currently - # offered as an experimental service, complimentary to all users. In the - # future this may be exclusively available as a premium feature." + # Optional. If 'true', adds punctuation to recognition result hypotheses. This + # feature is only available in select languages. Setting this for requests in + # other languages has no effect at all. The default 'false' value does not add + # punctuation to result hypotheses. NOTE: "This is currently offered as an + # experimental service, complimentary to all users. In the future this may be + # exclusively available as a premium feature." # Corresponds to the JSON property `enableAutomaticPunctuation` # @return [Boolean] attr_accessor :enable_automatic_punctuation alias_method :enable_automatic_punctuation?, :enable_automatic_punctuation - # Optional. If 'true', enables speaker detection for each recognized word in - # the top alternative of the recognition result using a speaker_tag provided - # in the WordInfo. - # Note: When this is true, we send all the words from the beginning of the - # audio for the top alternative in every consecutive response. - # This is done in order to improve our speaker tags as our models learn to - # identify the speakers in the conversation over time. + # Optional. If 'true', enables speaker detection for each recognized word in the + # top alternative of the recognition result using a speaker_tag provided in the + # WordInfo. Note: When this is true, we send all the words from the beginning of + # the audio for the top alternative in every consecutive response. This is done + # in order to improve our speaker tags as our models learn to identify the + # speakers in the conversation over time. # Corresponds to the JSON property `enableSpeakerDiarization` # @return [Boolean] attr_accessor :enable_speaker_diarization alias_method :enable_speaker_diarization?, :enable_speaker_diarization # Optional. If `true`, the top result includes a list of words and the - # confidence for those words. If `false`, no word-level confidence - # information is returned. The default is `false`. + # confidence for those words. If `false`, no word-level confidence information + # is returned. The default is `false`. # Corresponds to the JSON property `enableWordConfidence` # @return [Boolean] attr_accessor :enable_word_confidence alias_method :enable_word_confidence?, :enable_word_confidence - # Optional. If set to `true`, the server will attempt to filter out - # profanities, replacing all but the initial character in each filtered word - # with asterisks, e.g. "f***". If set to `false` or omitted, profanities - # won't be filtered out. + # Optional. If set to `true`, the server will attempt to filter out profanities, + # replacing all but the initial character in each filtered word with asterisks, + # e.g. "f***". If set to `false` or omitted, profanities won't be filtered out. # Corresponds to the JSON property `filterProfanity` # @return [Boolean] attr_accessor :filter_profanity alias_method :filter_profanity?, :filter_profanity - # Required. *Required* The language of the supplied audio as a - # [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) language tag. - # Example: "en-US". - # See [Language Support](https://cloud.google.com/speech/docs/languages) - # for a list of the currently supported language codes. + # Required. *Required* The language of the supplied audio as a [BCP-47](https:// + # www.rfc-editor.org/rfc/bcp/bcp47.txt) language tag. Example: "en-US". See [ + # Language Support](https://cloud.google.com/speech/docs/languages) for a list + # of the currently supported language codes. # Corresponds to the JSON property `languageCode` # @return [String] attr_accessor :language_code # Optional. Maximum number of recognition hypotheses to be returned. # Specifically, the maximum number of `SpeechRecognitionAlternative` messages - # within each `SpeechTranscription`. The server may return fewer than - # `max_alternatives`. Valid values are `0`-`30`. A value of `0` or `1` will + # within each `SpeechTranscription`. The server may return fewer than ` + # max_alternatives`. Valid values are `0`-`30`. A value of `0` or `1` will # return a maximum of one. If omitted, will return a maximum of one. # Corresponds to the JSON property `maxAlternatives` # @return [Fixnum] @@ -4014,16 +3898,15 @@ module Google include Google::Apis::Core::Hashable # Language hint can be specified if the language to be detected is known a - # priori. It can increase the accuracy of the detection. Language hint must - # be language code in BCP-47 format. - # Automatic language detection is performed if no hint is provided. + # priori. It can increase the accuracy of the detection. Language hint must be + # language code in BCP-47 format. Automatic language detection is performed if + # no hint is provided. # Corresponds to the JSON property `languageHints` # @return [Array] attr_accessor :language_hints - # Model to use for text detection. - # Supported values: "builtin/stable" (the default if unset) and - # "builtin/latest". + # Model to use for text detection. Supported values: "builtin/stable" (the + # default if unset) and "builtin/latest". # Corresponds to the JSON property `model` # @return [String] attr_accessor :model @@ -4039,27 +3922,19 @@ module Google end end - # Video frame level annotation results for text annotation (OCR). - # Contains information regarding timestamp and bounding box locations for the - # frames containing detected OCR text snippets. + # Video frame level annotation results for text annotation (OCR). Contains + # information regarding timestamp and bounding box locations for the frames + # containing detected OCR text snippets. class GoogleCloudVideointelligenceV1p2beta1TextFrame include Google::Apis::Core::Hashable # Normalized bounding polygon for text (that might not be aligned with axis). - # Contains list of the corner points in clockwise order starting from - # top-left corner. For example, for a rectangular bounding box: - # When the text is horizontal it might look like: - # 0----1 - # | | - # 3----2 - # When it's clockwise rotated 180 degrees around the top-left corner it - # becomes: - # 2----3 - # | | - # 1----0 - # and the vertex order will still be (0, 1, 2, 3). Note that values can be less - # than 0, or greater than 1 due to trignometric calculations for location of - # the box. + # Contains list of the corner points in clockwise order starting from top-left + # corner. For example, for a rectangular bounding box: When the text is + # horizontal it might look like: 0----1 | | 3----2 When it's clockwise rotated + # 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the + # vertex order will still be (0, 1, 2, 3). Note that values can be less than 0, + # or greater than 1 due to trignometric calculations for location of the box. # Corresponds to the JSON property `rotatedBoundingBox` # @return [Google::Apis::VideointelligenceV1p2beta1::GoogleCloudVideointelligenceV1p2beta1NormalizedBoundingPoly] attr_accessor :rotated_bounding_box @@ -4112,9 +3987,8 @@ module Google end end - # For tracking related features. - # An object at time_offset with attributes, and located with - # normalized_bounding_box. + # For tracking related features. An object at time_offset with attributes, and + # located with normalized_bounding_box. class GoogleCloudVideointelligenceV1p2beta1TimestampedObject include Google::Apis::Core::Hashable @@ -4128,15 +4002,14 @@ module Google # @return [Array] attr_accessor :landmarks - # Normalized bounding box. - # The normalized vertex coordinates are relative to the original image. - # Range: [0, 1]. + # Normalized bounding box. The normalized vertex coordinates are relative to the + # original image. Range: [0, 1]. # Corresponds to the JSON property `normalizedBoundingBox` # @return [Google::Apis::VideointelligenceV1p2beta1::GoogleCloudVideointelligenceV1p2beta1NormalizedBoundingBox] attr_accessor :normalized_bounding_box - # Time-offset, relative to the beginning of the video, - # corresponding to the video frame for this object. + # Time-offset, relative to the beginning of the video, corresponding to the + # video frame for this object. # Corresponds to the JSON property `timeOffset` # @return [String] attr_accessor :time_offset @@ -4195,20 +4068,19 @@ module Google class GoogleCloudVideointelligenceV1p2beta1VideoAnnotationProgress include Google::Apis::Core::Hashable - # Specifies which feature is being tracked if the request contains more than - # one feature. + # Specifies which feature is being tracked if the request contains more than one + # feature. # Corresponds to the JSON property `feature` # @return [String] attr_accessor :feature - # Video file location in - # [Cloud Storage](https://cloud.google.com/storage/). + # Video file location in [Cloud Storage](https://cloud.google.com/storage/). # Corresponds to the JSON property `inputUri` # @return [String] attr_accessor :input_uri - # Approximate percentage processed thus far. Guaranteed to be - # 100 when fully processed. + # Approximate percentage processed thus far. Guaranteed to be 100 when fully + # processed. # Corresponds to the JSON property `progressPercent` # @return [Fixnum] attr_accessor :progress_percent @@ -4247,31 +4119,30 @@ module Google class GoogleCloudVideointelligenceV1p2beta1VideoAnnotationResults include Google::Apis::Core::Hashable - # 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::VideointelligenceV1p2beta1::GoogleRpcStatus] attr_accessor :error - # Explicit content annotation (based on per-frame visual signals only). - # If no explicit content has been detected in a frame, no annotations are - # present for that frame. + # Explicit content annotation (based on per-frame visual signals only). If no + # explicit content has been detected in a frame, no annotations are present for + # that frame. # Corresponds to the JSON property `explicitAnnotation` # @return [Google::Apis::VideointelligenceV1p2beta1::GoogleCloudVideointelligenceV1p2beta1ExplicitContentAnnotation] attr_accessor :explicit_annotation - # Label annotations on frame level. - # There is exactly one element for each unique label. + # Label annotations on frame level. There is exactly one element for each unique + # label. # Corresponds to the JSON property `frameLabelAnnotations` # @return [Array] attr_accessor :frame_label_annotations - # Video file location in - # [Cloud Storage](https://cloud.google.com/storage/). + # Video file location in [Cloud Storage](https://cloud.google.com/storage/). # Corresponds to the JSON property `inputUri` # @return [String] attr_accessor :input_uri @@ -4298,11 +4169,11 @@ module Google attr_accessor :segment_label_annotations # Presence label annotations on video level or user-specified segment level. - # There is exactly one element for each unique label. Compared to the - # existing topical `segment_label_annotations`, this field presents more - # fine-grained, segment-level labels detected in video content and is made - # available only when the client sets `LabelDetectionConfig.model` to - # "builtin/latest" in the request. + # There is exactly one element for each unique label. Compared to the existing + # topical `segment_label_annotations`, this field presents more fine-grained, + # segment-level labels detected in video content and is made available only when + # the client sets `LabelDetectionConfig.model` to "builtin/latest" in the + # request. # Corresponds to the JSON property `segmentPresenceLabelAnnotations` # @return [Array] attr_accessor :segment_presence_label_annotations @@ -4312,17 +4183,17 @@ module Google # @return [Array] attr_accessor :shot_annotations - # Topical label annotations on shot level. - # There is exactly one element for each unique label. + # Topical label annotations on shot level. There is exactly one element for each + # unique label. # Corresponds to the JSON property `shotLabelAnnotations` # @return [Array] attr_accessor :shot_label_annotations # Presence label annotations on shot level. There is exactly one element for - # each unique label. Compared to the existing topical - # `shot_label_annotations`, this field presents more fine-grained, shot-level - # labels detected in video content and is made available only when the client - # sets `LabelDetectionConfig.model` to "builtin/latest" in the request. + # each unique label. Compared to the existing topical `shot_label_annotations`, + # this field presents more fine-grained, shot-level labels detected in video + # content and is made available only when the client sets `LabelDetectionConfig. + # model` to "builtin/latest" in the request. # Corresponds to the JSON property `shotPresenceLabelAnnotations` # @return [Array] attr_accessor :shot_presence_label_annotations @@ -4332,9 +4203,8 @@ module Google # @return [Array] attr_accessor :speech_transcriptions - # OCR text detection and tracking. - # Annotations for list of detected text snippets. Each will have list of - # frame information associated with it. + # OCR text detection and tracking. Annotations for list of detected text + # snippets. Each will have list of frame information associated with it. # Corresponds to the JSON property `textAnnotations` # @return [Array] attr_accessor :text_annotations @@ -4381,9 +4251,9 @@ module Google # @return [Google::Apis::VideointelligenceV1p2beta1::GoogleCloudVideointelligenceV1p2beta1ObjectTrackingConfig] attr_accessor :object_tracking_config - # Video segments to annotate. The segments may overlap and are not required - # to be contiguous or span the whole video. If unspecified, each video is - # treated as a single segment. + # Video segments to annotate. The segments may overlap and are not required to + # be contiguous or span the whole video. If unspecified, each video is treated + # as a single segment. # Corresponds to the JSON property `segments` # @return [Array] attr_accessor :segments @@ -4423,14 +4293,14 @@ module Google class GoogleCloudVideointelligenceV1p2beta1VideoSegment include Google::Apis::Core::Hashable - # Time-offset, relative to the beginning of the video, - # corresponding to the end of the segment (inclusive). + # Time-offset, relative to the beginning of the video, corresponding to the end + # of the segment (inclusive). # Corresponds to the JSON property `endTimeOffset` # @return [String] attr_accessor :end_time_offset - # Time-offset, relative to the beginning of the video, - # corresponding to the start of the segment (inclusive). + # Time-offset, relative to the beginning of the video, corresponding to the + # start of the segment (inclusive). # Corresponds to the JSON property `startTimeOffset` # @return [String] attr_accessor :start_time_offset @@ -4447,41 +4317,41 @@ module Google end # Word-specific information for recognized words. Word information is only - # included in the response when certain request parameters are set, such - # as `enable_word_time_offsets`. + # included in the response when certain request parameters are set, such as ` + # enable_word_time_offsets`. class GoogleCloudVideointelligenceV1p2beta1WordInfo include Google::Apis::Core::Hashable # Output only. The confidence estimate between 0.0 and 1.0. A higher number # indicates an estimated greater likelihood that the recognized words are - # correct. This field is set only for the top alternative. - # This field is not guaranteed to be accurate and users should not rely on it - # to be always provided. - # The default of 0.0 is a sentinel value indicating `confidence` was not set. + # correct. This field is set only for the top alternative. This field is not + # guaranteed to be accurate and users should not rely on it to be always + # provided. The default of 0.0 is a sentinel value indicating `confidence` was + # not set. # Corresponds to the JSON property `confidence` # @return [Float] attr_accessor :confidence - # Time offset relative to the beginning of the audio, and - # corresponding to the end of the spoken word. This field is only set if - # `enable_word_time_offsets=true` and only in the top hypothesis. This is an - # experimental feature and the accuracy of the time offset can vary. + # Time offset relative to the beginning of the audio, and corresponding to the + # end of the spoken word. This field is only set if `enable_word_time_offsets= + # true` and only in the top hypothesis. This is an experimental feature and the + # accuracy of the time offset can vary. # Corresponds to the JSON property `endTime` # @return [String] attr_accessor :end_time - # Output only. A distinct integer value is assigned for every speaker within - # the audio. This field specifies which one of those speakers was detected to - # have spoken this word. Value ranges from 1 up to diarization_speaker_count, - # and is only set if speaker diarization is enabled. + # Output only. A distinct integer value is assigned for every speaker within the + # audio. This field specifies which one of those speakers was detected to have + # spoken this word. Value ranges from 1 up to diarization_speaker_count, and is + # only set if speaker diarization is enabled. # Corresponds to the JSON property `speakerTag` # @return [Fixnum] attr_accessor :speaker_tag - # Time offset relative to the beginning of the audio, and - # corresponding to the start of the spoken word. This field is only set if - # `enable_word_time_offsets=true` and only in the top hypothesis. This is an - # experimental feature and the accuracy of the time offset can vary. + # Time offset relative to the beginning of the audio, and corresponding to the + # start of the spoken word. This field is only set if `enable_word_time_offsets= + # true` and only in the top hypothesis. This is an experimental feature and the + # accuracy of the time offset can vary. # Corresponds to the JSON property `startTime` # @return [String] attr_accessor :start_time @@ -4505,9 +4375,9 @@ module Google end end - # Video annotation progress. Included in the `metadata` - # field of the `Operation` returned by the `GetOperation` - # call of the `google::longrunning::Operations` service. + # Video annotation progress. Included in the `metadata` field of the `Operation` + # returned by the `GetOperation` call of the `google::longrunning::Operations` + # service. class GoogleCloudVideointelligenceV1p3beta1AnnotateVideoProgress include Google::Apis::Core::Hashable @@ -4526,9 +4396,9 @@ module Google end end - # Video annotation response. Included in the `response` - # field of the `Operation` returned by the `GetOperation` - # call of the `google::longrunning::Operations` service. + # Video annotation response. Included in the `response` field of the `Operation` + # returned by the `GetOperation` call of the `google::longrunning::Operations` + # service. class GoogleCloudVideointelligenceV1p3beta1AnnotateVideoResponse include Google::Apis::Core::Hashable @@ -4562,10 +4432,9 @@ module Google # @return [String] attr_accessor :display_name - # The resource name of the celebrity. Have the format - # `video-intelligence/kg-mid` indicates a celebrity from preloaded gallery. - # kg-mid is the id in Google knowledge graph, which is unique for the - # celebrity. + # The resource name of the celebrity. Have the format `video-intelligence/kg-mid` + # indicates a celebrity from preloaded gallery. kg-mid is the id in Google + # knowledge graph, which is unique for the celebrity. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name @@ -4586,8 +4455,8 @@ module Google class GoogleCloudVideointelligenceV1p3beta1CelebrityRecognitionAnnotation include Google::Apis::Core::Hashable - # The tracks detected from the input video, including recognized celebrities - # and other detected faces in the video. + # The tracks detected from the input video, including recognized celebrities and + # other detected faces in the video. # Corresponds to the JSON property `celebrityTracks` # @return [Array] attr_accessor :celebrity_tracks @@ -4643,14 +4512,14 @@ module Google # @return [Float] attr_accessor :confidence - # The name of the attribute, for example, glasses, dark_glasses, mouth_open. - # A full list of supported type names will be provided in the document. + # The name of the attribute, for example, glasses, dark_glasses, mouth_open. A + # full list of supported type names will be provided in the document. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name - # Text value of the detection result. For example, the value for "HairColor" - # can be "black", "blonde", etc. + # Text value of the detection result. For example, the value for "HairColor" can + # be "black", "blonde", etc. # Corresponds to the JSON property `value` # @return [String] attr_accessor :value @@ -4682,9 +4551,8 @@ module Google # @return [String] attr_accessor :name - # A vertex represents a 2D point in the image. - # NOTE: the normalized vertex coordinates are relative to the original image - # and range from 0 to 1. + # A vertex represents a 2D point in the image. NOTE: the normalized vertex + # coordinates are relative to the original image and range from 0 to 1. # Corresponds to the JSON property `point` # @return [Google::Apis::VideointelligenceV1p2beta1::GoogleCloudVideointelligenceV1p3beta1NormalizedVertex] attr_accessor :point @@ -4710,8 +4578,7 @@ module Google # @return [String] attr_accessor :description - # Opaque entity ID. Some IDs may be available in - # [Google Knowledge Graph Search + # Opaque entity ID. Some IDs may be available in [Google Knowledge Graph Search # API](https://developers.google.com/knowledge-graph/). # Corresponds to the JSON property `entityId` # @return [String] @@ -4734,9 +4601,9 @@ module Google end end - # Explicit content annotation (based on per-frame visual signals only). - # If no explicit content has been detected in a frame, no annotations are - # present for that frame. + # Explicit content annotation (based on per-frame visual signals only). If no + # explicit content has been detected in a frame, no annotations are present for + # that frame. class GoogleCloudVideointelligenceV1p3beta1ExplicitContentAnnotation include Google::Apis::Core::Hashable @@ -4823,10 +4690,9 @@ module Google class GoogleCloudVideointelligenceV1p3beta1LabelAnnotation include Google::Apis::Core::Hashable - # Common categories for the detected entity. - # For example, when the label is `Terrier`, the category is likely `dog`. And - # in some cases there might be more than one categories e.g., `Terrier` could - # also be a `pet`. + # Common categories for the detected entity. For example, when the label is ` + # Terrier`, the category is likely `dog`. And in some cases there might be more + # than one categories e.g., `Terrier` could also be a `pet`. # Corresponds to the JSON property `categoryEntities` # @return [Array] attr_accessor :category_entities @@ -4925,14 +4791,14 @@ module Google # @return [Google::Apis::VideointelligenceV1p2beta1::GoogleCloudVideointelligenceV1p3beta1Entity] attr_accessor :entity - # All video segments where the recognized logo appears. There might be - # multiple instances of the same logo class appearing in one VideoSegment. + # All video segments where the recognized logo appears. There might be multiple + # instances of the same logo class appearing in one VideoSegment. # Corresponds to the JSON property `segments` # @return [Array] attr_accessor :segments - # All logo tracks where the recognized logo appears. Each track corresponds - # to one logo instance appearing in consecutive frames. + # All logo tracks where the recognized logo appears. Each track corresponds to + # one logo instance appearing in consecutive frames. # Corresponds to the JSON property `tracks` # @return [Array] attr_accessor :tracks @@ -4949,9 +4815,8 @@ module Google end end - # Normalized bounding box. - # The normalized vertex coordinates are relative to the original image. - # Range: [0, 1]. + # Normalized bounding box. The normalized vertex coordinates are relative to the + # original image. Range: [0, 1]. class GoogleCloudVideointelligenceV1p3beta1NormalizedBoundingBox include Google::Apis::Core::Hashable @@ -4989,20 +4854,12 @@ module Google end # Normalized bounding polygon for text (that might not be aligned with axis). - # Contains list of the corner points in clockwise order starting from - # top-left corner. For example, for a rectangular bounding box: - # When the text is horizontal it might look like: - # 0----1 - # | | - # 3----2 - # When it's clockwise rotated 180 degrees around the top-left corner it - # becomes: - # 2----3 - # | | - # 1----0 - # and the vertex order will still be (0, 1, 2, 3). Note that values can be less - # than 0, or greater than 1 due to trignometric calculations for location of - # the box. + # Contains list of the corner points in clockwise order starting from top-left + # corner. For example, for a rectangular bounding box: When the text is + # horizontal it might look like: 0----1 | | 3----2 When it's clockwise rotated + # 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the + # vertex order will still be (0, 1, 2, 3). Note that values can be less than 0, + # or greater than 1 due to trignometric calculations for location of the box. class GoogleCloudVideointelligenceV1p3beta1NormalizedBoundingPoly include Google::Apis::Core::Hashable @@ -5021,9 +4878,8 @@ module Google end end - # A vertex represents a 2D point in the image. - # NOTE: the normalized vertex coordinates are relative to the original image - # and range from 0 to 1. + # A vertex represents a 2D point in the image. NOTE: the normalized vertex + # coordinates are relative to the original image and range from 0 to 1. class GoogleCloudVideointelligenceV1p3beta1NormalizedVertex include Google::Apis::Core::Hashable @@ -5062,10 +4918,10 @@ module Google # @return [Google::Apis::VideointelligenceV1p2beta1::GoogleCloudVideointelligenceV1p3beta1Entity] attr_accessor :entity - # Information corresponding to all frames where this object track appears. - # Non-streaming batch mode: it may be one or multiple ObjectTrackingFrame - # messages in frames. - # Streaming mode: it can only be one ObjectTrackingFrame message in frames. + # Information corresponding to all frames where this object track appears. Non- + # streaming batch mode: it may be one or multiple ObjectTrackingFrame messages + # in frames. Streaming mode: it can only be one ObjectTrackingFrame message in + # frames. # Corresponds to the JSON property `frames` # @return [Array] attr_accessor :frames @@ -5075,12 +4931,11 @@ module Google # @return [Google::Apis::VideointelligenceV1p2beta1::GoogleCloudVideointelligenceV1p3beta1VideoSegment] attr_accessor :segment - # Streaming mode ONLY. - # In streaming mode, we do not know the end time of a tracked object - # before it is completed. Hence, there is no VideoSegment info returned. - # Instead, we provide a unique identifiable integer track_id so that - # the customers can correlate the results of the ongoing - # ObjectTrackAnnotation of the same track_id over time. + # Streaming mode ONLY. In streaming mode, we do not know the end time of a + # tracked object before it is completed. Hence, there is no VideoSegment info + # returned. Instead, we provide a unique identifiable integer track_id so that + # the customers can correlate the results of the ongoing ObjectTrackAnnotation + # of the same track_id over time. # Corresponds to the JSON property `trackId` # @return [Fixnum] attr_accessor :track_id @@ -5110,9 +4965,8 @@ module Google class GoogleCloudVideointelligenceV1p3beta1ObjectTrackingFrame include Google::Apis::Core::Hashable - # Normalized bounding box. - # The normalized vertex coordinates are relative to the original image. - # Range: [0, 1]. + # Normalized bounding box. The normalized vertex coordinates are relative to the + # original image. Range: [0, 1]. # Corresponds to the JSON property `normalizedBoundingBox` # @return [Google::Apis::VideointelligenceV1p2beta1::GoogleCloudVideointelligenceV1p3beta1NormalizedBoundingBox] attr_accessor :normalized_bounding_box @@ -5189,10 +5043,10 @@ module Google # Output only. The confidence estimate between 0.0 and 1.0. A higher number # indicates an estimated greater likelihood that the recognized words are - # correct. This field is set only for the top alternative. - # This field is not guaranteed to be accurate and users should not rely on it - # to be always provided. - # The default of 0.0 is a sentinel value indicating `confidence` was not set. + # correct. This field is set only for the top alternative. This field is not + # guaranteed to be accurate and users should not rely on it to be always + # provided. The default of 0.0 is a sentinel value indicating `confidence` was + # not set. # Corresponds to the JSON property `confidence` # @return [Float] attr_accessor :confidence @@ -5203,8 +5057,8 @@ module Google attr_accessor :transcript # Output only. A list of word-specific information for each recognized word. - # Note: When `enable_speaker_diarization` is set to true, you will see all - # the words from the beginning of the audio. + # Note: When `enable_speaker_diarization` is set to true, you will see all the + # words from the beginning of the audio. # Corresponds to the JSON property `words` # @return [Array] attr_accessor :words @@ -5225,18 +5079,17 @@ module Google class GoogleCloudVideointelligenceV1p3beta1SpeechTranscription include Google::Apis::Core::Hashable - # May contain one or more recognition hypotheses (up to the maximum specified - # in `max_alternatives`). These alternatives are ordered in terms of - # accuracy, with the top (first) alternative being the most probable, as - # ranked by the recognizer. + # May contain one or more recognition hypotheses (up to the maximum specified in + # `max_alternatives`). These alternatives are ordered in terms of accuracy, with + # the top (first) alternative being the most probable, as ranked by the + # recognizer. # Corresponds to the JSON property `alternatives` # @return [Array] attr_accessor :alternatives # Output only. The [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) - # language tag of - # the language in this result. This language code was detected to have the - # most likelihood of being spoken in the audio. + # language tag of the language in this result. This language code was detected + # to have the most likelihood of being spoken in the audio. # Corresponds to the JSON property `languageCode` # @return [String] attr_accessor :language_code @@ -5252,32 +5105,31 @@ module Google end end - # `StreamingAnnotateVideoResponse` is the only message returned to the client - # by `StreamingAnnotateVideo`. A series of zero or more - # `StreamingAnnotateVideoResponse` messages are streamed back to the client. + # `StreamingAnnotateVideoResponse` is the only message returned to the client by + # `StreamingAnnotateVideo`. A series of zero or more ` + # StreamingAnnotateVideoResponse` messages are streamed back to the client. class GoogleCloudVideointelligenceV1p3beta1StreamingAnnotateVideoResponse include Google::Apis::Core::Hashable - # Streaming annotation results corresponding to a portion of the video - # that is currently being processed. + # Streaming annotation results corresponding to a portion of the video that is + # currently being processed. # Corresponds to the JSON property `annotationResults` # @return [Google::Apis::VideointelligenceV1p2beta1::GoogleCloudVideointelligenceV1p3beta1StreamingVideoAnnotationResults] attr_accessor :annotation_results - # Google Cloud Storage URI that stores annotation results of one - # streaming session in JSON format. - # It is the annotation_result_storage_directory - # from the request followed by '/cloud_project_number-session_id'. + # Google Cloud Storage URI that stores annotation results of one streaming + # session in JSON format. It is the annotation_result_storage_directory from the + # request followed by '/cloud_project_number-session_id'. # Corresponds to the JSON property `annotationResultsUri` # @return [String] attr_accessor :annotation_results_uri - # 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::VideointelligenceV1p2beta1::GoogleRpcStatus] attr_accessor :error @@ -5294,14 +5146,14 @@ module Google end end - # Streaming annotation results corresponding to a portion of the video - # that is currently being processed. + # Streaming annotation results corresponding to a portion of the video that is + # currently being processed. class GoogleCloudVideointelligenceV1p3beta1StreamingVideoAnnotationResults include Google::Apis::Core::Hashable - # Explicit content annotation (based on per-frame visual signals only). - # If no explicit content has been detected in a frame, no annotations are - # present for that frame. + # Explicit content annotation (based on per-frame visual signals only). If no + # explicit content has been detected in a frame, no annotations are present for + # that frame. # Corresponds to the JSON property `explicitAnnotation` # @return [Google::Apis::VideointelligenceV1p2beta1::GoogleCloudVideointelligenceV1p3beta1ExplicitContentAnnotation] attr_accessor :explicit_annotation @@ -5367,27 +5219,19 @@ module Google end end - # Video frame level annotation results for text annotation (OCR). - # Contains information regarding timestamp and bounding box locations for the - # frames containing detected OCR text snippets. + # Video frame level annotation results for text annotation (OCR). Contains + # information regarding timestamp and bounding box locations for the frames + # containing detected OCR text snippets. class GoogleCloudVideointelligenceV1p3beta1TextFrame include Google::Apis::Core::Hashable # Normalized bounding polygon for text (that might not be aligned with axis). - # Contains list of the corner points in clockwise order starting from - # top-left corner. For example, for a rectangular bounding box: - # When the text is horizontal it might look like: - # 0----1 - # | | - # 3----2 - # When it's clockwise rotated 180 degrees around the top-left corner it - # becomes: - # 2----3 - # | | - # 1----0 - # and the vertex order will still be (0, 1, 2, 3). Note that values can be less - # than 0, or greater than 1 due to trignometric calculations for location of - # the box. + # Contains list of the corner points in clockwise order starting from top-left + # corner. For example, for a rectangular bounding box: When the text is + # horizontal it might look like: 0----1 | | 3----2 When it's clockwise rotated + # 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the + # vertex order will still be (0, 1, 2, 3). Note that values can be less than 0, + # or greater than 1 due to trignometric calculations for location of the box. # Corresponds to the JSON property `rotatedBoundingBox` # @return [Google::Apis::VideointelligenceV1p2beta1::GoogleCloudVideointelligenceV1p3beta1NormalizedBoundingPoly] attr_accessor :rotated_bounding_box @@ -5440,9 +5284,8 @@ module Google end end - # For tracking related features. - # An object at time_offset with attributes, and located with - # normalized_bounding_box. + # For tracking related features. An object at time_offset with attributes, and + # located with normalized_bounding_box. class GoogleCloudVideointelligenceV1p3beta1TimestampedObject include Google::Apis::Core::Hashable @@ -5456,15 +5299,14 @@ module Google # @return [Array] attr_accessor :landmarks - # Normalized bounding box. - # The normalized vertex coordinates are relative to the original image. - # Range: [0, 1]. + # Normalized bounding box. The normalized vertex coordinates are relative to the + # original image. Range: [0, 1]. # Corresponds to the JSON property `normalizedBoundingBox` # @return [Google::Apis::VideointelligenceV1p2beta1::GoogleCloudVideointelligenceV1p3beta1NormalizedBoundingBox] attr_accessor :normalized_bounding_box - # Time-offset, relative to the beginning of the video, - # corresponding to the video frame for this object. + # Time-offset, relative to the beginning of the video, corresponding to the + # video frame for this object. # Corresponds to the JSON property `timeOffset` # @return [String] attr_accessor :time_offset @@ -5523,20 +5365,19 @@ module Google class GoogleCloudVideointelligenceV1p3beta1VideoAnnotationProgress include Google::Apis::Core::Hashable - # Specifies which feature is being tracked if the request contains more than - # one feature. + # Specifies which feature is being tracked if the request contains more than one + # feature. # Corresponds to the JSON property `feature` # @return [String] attr_accessor :feature - # Video file location in - # [Cloud Storage](https://cloud.google.com/storage/). + # Video file location in [Cloud Storage](https://cloud.google.com/storage/). # Corresponds to the JSON property `inputUri` # @return [String] attr_accessor :input_uri - # Approximate percentage processed thus far. Guaranteed to be - # 100 when fully processed. + # Approximate percentage processed thus far. Guaranteed to be 100 when fully + # processed. # Corresponds to the JSON property `progressPercent` # @return [Fixnum] attr_accessor :progress_percent @@ -5580,19 +5421,19 @@ module Google # @return [Google::Apis::VideointelligenceV1p2beta1::GoogleCloudVideointelligenceV1p3beta1CelebrityRecognitionAnnotation] attr_accessor :celebrity_recognition_annotations - # 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::VideointelligenceV1p2beta1::GoogleRpcStatus] attr_accessor :error - # Explicit content annotation (based on per-frame visual signals only). - # If no explicit content has been detected in a frame, no annotations are - # present for that frame. + # Explicit content annotation (based on per-frame visual signals only). If no + # explicit content has been detected in a frame, no annotations are present for + # that frame. # Corresponds to the JSON property `explicitAnnotation` # @return [Google::Apis::VideointelligenceV1p2beta1::GoogleCloudVideointelligenceV1p3beta1ExplicitContentAnnotation] attr_accessor :explicit_annotation @@ -5602,14 +5443,13 @@ module Google # @return [Array] attr_accessor :face_detection_annotations - # Label annotations on frame level. - # There is exactly one element for each unique label. + # Label annotations on frame level. There is exactly one element for each unique + # label. # Corresponds to the JSON property `frameLabelAnnotations` # @return [Array] attr_accessor :frame_label_annotations - # Video file location in - # [Cloud Storage](https://cloud.google.com/storage/). + # Video file location in [Cloud Storage](https://cloud.google.com/storage/). # Corresponds to the JSON property `inputUri` # @return [String] attr_accessor :input_uri @@ -5641,11 +5481,11 @@ module Google attr_accessor :segment_label_annotations # Presence label annotations on video level or user-specified segment level. - # There is exactly one element for each unique label. Compared to the - # existing topical `segment_label_annotations`, this field presents more - # fine-grained, segment-level labels detected in video content and is made - # available only when the client sets `LabelDetectionConfig.model` to - # "builtin/latest" in the request. + # There is exactly one element for each unique label. Compared to the existing + # topical `segment_label_annotations`, this field presents more fine-grained, + # segment-level labels detected in video content and is made available only when + # the client sets `LabelDetectionConfig.model` to "builtin/latest" in the + # request. # Corresponds to the JSON property `segmentPresenceLabelAnnotations` # @return [Array] attr_accessor :segment_presence_label_annotations @@ -5655,17 +5495,17 @@ module Google # @return [Array] attr_accessor :shot_annotations - # Topical label annotations on shot level. - # There is exactly one element for each unique label. + # Topical label annotations on shot level. There is exactly one element for each + # unique label. # Corresponds to the JSON property `shotLabelAnnotations` # @return [Array] attr_accessor :shot_label_annotations # Presence label annotations on shot level. There is exactly one element for - # each unique label. Compared to the existing topical - # `shot_label_annotations`, this field presents more fine-grained, shot-level - # labels detected in video content and is made available only when the client - # sets `LabelDetectionConfig.model` to "builtin/latest" in the request. + # each unique label. Compared to the existing topical `shot_label_annotations`, + # this field presents more fine-grained, shot-level labels detected in video + # content and is made available only when the client sets `LabelDetectionConfig. + # model` to "builtin/latest" in the request. # Corresponds to the JSON property `shotPresenceLabelAnnotations` # @return [Array] attr_accessor :shot_presence_label_annotations @@ -5675,9 +5515,8 @@ module Google # @return [Array] attr_accessor :speech_transcriptions - # OCR text detection and tracking. - # Annotations for list of detected text snippets. Each will have list of - # frame information associated with it. + # OCR text detection and tracking. Annotations for list of detected text + # snippets. Each will have list of frame information associated with it. # Corresponds to the JSON property `textAnnotations` # @return [Array] attr_accessor :text_annotations @@ -5712,14 +5551,14 @@ module Google class GoogleCloudVideointelligenceV1p3beta1VideoSegment include Google::Apis::Core::Hashable - # Time-offset, relative to the beginning of the video, - # corresponding to the end of the segment (inclusive). + # Time-offset, relative to the beginning of the video, corresponding to the end + # of the segment (inclusive). # Corresponds to the JSON property `endTimeOffset` # @return [String] attr_accessor :end_time_offset - # Time-offset, relative to the beginning of the video, - # corresponding to the start of the segment (inclusive). + # Time-offset, relative to the beginning of the video, corresponding to the + # start of the segment (inclusive). # Corresponds to the JSON property `startTimeOffset` # @return [String] attr_accessor :start_time_offset @@ -5736,41 +5575,41 @@ module Google end # Word-specific information for recognized words. Word information is only - # included in the response when certain request parameters are set, such - # as `enable_word_time_offsets`. + # included in the response when certain request parameters are set, such as ` + # enable_word_time_offsets`. class GoogleCloudVideointelligenceV1p3beta1WordInfo include Google::Apis::Core::Hashable # Output only. The confidence estimate between 0.0 and 1.0. A higher number # indicates an estimated greater likelihood that the recognized words are - # correct. This field is set only for the top alternative. - # This field is not guaranteed to be accurate and users should not rely on it - # to be always provided. - # The default of 0.0 is a sentinel value indicating `confidence` was not set. + # correct. This field is set only for the top alternative. This field is not + # guaranteed to be accurate and users should not rely on it to be always + # provided. The default of 0.0 is a sentinel value indicating `confidence` was + # not set. # Corresponds to the JSON property `confidence` # @return [Float] attr_accessor :confidence - # Time offset relative to the beginning of the audio, and - # corresponding to the end of the spoken word. This field is only set if - # `enable_word_time_offsets=true` and only in the top hypothesis. This is an - # experimental feature and the accuracy of the time offset can vary. + # Time offset relative to the beginning of the audio, and corresponding to the + # end of the spoken word. This field is only set if `enable_word_time_offsets= + # true` and only in the top hypothesis. This is an experimental feature and the + # accuracy of the time offset can vary. # Corresponds to the JSON property `endTime` # @return [String] attr_accessor :end_time - # Output only. A distinct integer value is assigned for every speaker within - # the audio. This field specifies which one of those speakers was detected to - # have spoken this word. Value ranges from 1 up to diarization_speaker_count, - # and is only set if speaker diarization is enabled. + # Output only. A distinct integer value is assigned for every speaker within the + # audio. This field specifies which one of those speakers was detected to have + # spoken this word. Value ranges from 1 up to diarization_speaker_count, and is + # only set if speaker diarization is enabled. # Corresponds to the JSON property `speakerTag` # @return [Fixnum] attr_accessor :speaker_tag - # Time offset relative to the beginning of the audio, and - # corresponding to the start of the spoken word. This field is only set if - # `enable_word_time_offsets=true` and only in the top hypothesis. This is an - # experimental feature and the accuracy of the time offset can vary. + # Time offset relative to the beginning of the audio, and corresponding to the + # start of the spoken word. This field is only set if `enable_word_time_offsets= + # true` and only in the top hypothesis. This is an experimental feature and the + # accuracy of the time offset can vary. # Corresponds to the JSON property `startTime` # @return [String] attr_accessor :start_time @@ -5799,47 +5638,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::VideointelligenceV1p2beta1::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 @@ -5858,12 +5695,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 @@ -5872,15 +5709,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 diff --git a/generated/google/apis/videointelligence_v1p2beta1/service.rb b/generated/google/apis/videointelligence_v1p2beta1/service.rb index ffdceca29..b1663d6bb 100644 --- a/generated/google/apis/videointelligence_v1p2beta1/service.rb +++ b/generated/google/apis/videointelligence_v1p2beta1/service.rb @@ -49,10 +49,10 @@ module Google @batch_path = 'batch' end - # Performs asynchronous video annotation. Progress and results can be - # retrieved through the `google.longrunning.Operations` interface. - # `Operation.metadata` contains `AnnotateVideoProgress` (progress). - # `Operation.response` contains `AnnotateVideoResponse` (results). + # Performs asynchronous video annotation. Progress and results can be retrieved + # through the `google.longrunning.Operations` interface. `Operation.metadata` + # contains `AnnotateVideoProgress` (progress). `Operation.response` contains ` + # AnnotateVideoResponse` (results). # @param [Google::Apis::VideointelligenceV1p2beta1::GoogleCloudVideointelligenceV1p2beta1AnnotateVideoRequest] google_cloud_videointelligence_v1p2beta1_annotate_video_request_object # @param [String] fields # Selector specifying which fields to include in a partial response.