diff --git a/api_names_out.yaml b/api_names_out.yaml index e9d801e78..d18bd3683 100644 --- a/api_names_out.yaml +++ b/api_names_out.yaml @@ -50015,6 +50015,7 @@ "/container:v1/ClusterUpdate/desiredBinaryAuthorization": desired_binary_authorization "/container:v1/ClusterUpdate/desiredClusterAutoscaling": desired_cluster_autoscaling "/container:v1/ClusterUpdate/desiredDatabaseEncryption": desired_database_encryption +"/container:v1/ClusterUpdate/desiredDefaultSnatStatus": desired_default_snat_status "/container:v1/ClusterUpdate/desiredImageType": desired_image_type "/container:v1/ClusterUpdate/desiredIntraNodeVisibilityConfig": desired_intra_node_visibility_config "/container:v1/ClusterUpdate/desiredLocations": desired_locations @@ -50026,6 +50027,7 @@ "/container:v1/ClusterUpdate/desiredNodePoolAutoscaling": desired_node_pool_autoscaling "/container:v1/ClusterUpdate/desiredNodePoolId": desired_node_pool_id "/container:v1/ClusterUpdate/desiredNodeVersion": desired_node_version +"/container:v1/ClusterUpdate/desiredPrivateClusterConfig": desired_private_cluster_config "/container:v1/ClusterUpdate/desiredReleaseChannel": desired_release_channel "/container:v1/ClusterUpdate/desiredResourceUsageExportConfig": desired_resource_usage_export_config "/container:v1/ClusterUpdate/desiredShieldedNodes": desired_shielded_nodes @@ -50057,6 +50059,8 @@ "/container:v1/DatabaseEncryption": database_encryption "/container:v1/DatabaseEncryption/keyName": key_name "/container:v1/DatabaseEncryption/state": state +"/container:v1/DefaultSnatStatus": default_snat_status +"/container:v1/DefaultSnatStatus/disabled": disabled "/container:v1/DnsCacheConfig": dns_cache_config "/container:v1/DnsCacheConfig/enabled": enabled "/container:v1/Empty": empty @@ -50099,6 +50103,7 @@ "/container:v1/IPAllocationPolicy/subnetworkName": subnetwork_name "/container:v1/IPAllocationPolicy/tpuIpv4CidrBlock": tpu_ipv4_cidr_block "/container:v1/IPAllocationPolicy/useIpAliases": use_ip_aliases +"/container:v1/IPAllocationPolicy/useRoutes": use_routes "/container:v1/IntraNodeVisibilityConfig": intra_node_visibility_config "/container:v1/IntraNodeVisibilityConfig/enabled": enabled "/container:v1/Jwk": jwk @@ -50159,6 +50164,7 @@ "/container:v1/Metric/name": name "/container:v1/Metric/stringValue": string_value "/container:v1/NetworkConfig": network_config +"/container:v1/NetworkConfig/defaultSnatStatus": default_snat_status "/container:v1/NetworkConfig/enableIntraNodeVisibility": enable_intra_node_visibility "/container:v1/NetworkConfig/network": network "/container:v1/NetworkConfig/subnetwork": subnetwork @@ -50253,10 +50259,13 @@ "/container:v1/PrivateClusterConfig": private_cluster_config "/container:v1/PrivateClusterConfig/enablePrivateEndpoint": enable_private_endpoint "/container:v1/PrivateClusterConfig/enablePrivateNodes": enable_private_nodes +"/container:v1/PrivateClusterConfig/masterGlobalAccessConfig": master_global_access_config "/container:v1/PrivateClusterConfig/masterIpv4CidrBlock": master_ipv4_cidr_block "/container:v1/PrivateClusterConfig/peeringName": peering_name "/container:v1/PrivateClusterConfig/privateEndpoint": private_endpoint "/container:v1/PrivateClusterConfig/publicEndpoint": public_endpoint +"/container:v1/PrivateClusterMasterGlobalAccessConfig": private_cluster_master_global_access_config +"/container:v1/PrivateClusterMasterGlobalAccessConfig/enabled": enabled "/container:v1/RecurringTimeWindow": recurring_time_window "/container:v1/RecurringTimeWindow/recurrence": recurrence "/container:v1/RecurringTimeWindow/window": window @@ -50419,6 +50428,13 @@ "/container:v1/UpdateNodePoolRequest/upgradeSettings": upgrade_settings "/container:v1/UpdateNodePoolRequest/workloadMetadataConfig": workload_metadata_config "/container:v1/UpdateNodePoolRequest/zone": zone +"/container:v1/UpgradeEvent": upgrade_event +"/container:v1/UpgradeEvent/currentVersion": current_version +"/container:v1/UpgradeEvent/operation": operation +"/container:v1/UpgradeEvent/operationStartTime": operation_start_time +"/container:v1/UpgradeEvent/resource": resource +"/container:v1/UpgradeEvent/resourceType": resource_type +"/container:v1/UpgradeEvent/targetVersion": target_version "/container:v1/UpgradeSettings": upgrade_settings "/container:v1/UpgradeSettings/maxSurge": max_surge "/container:v1/UpgradeSettings/maxUnavailable": max_unavailable @@ -58273,6 +58289,9 @@ "/dataflow:v1b3/Job/transformNameMapping": transform_name_mapping "/dataflow:v1b3/Job/transformNameMapping/transform_name_mapping": transform_name_mapping "/dataflow:v1b3/Job/type": type +"/dataflow:v1b3/JobExecutionDetails": job_execution_details +"/dataflow:v1b3/JobExecutionDetails/stages": stages +"/dataflow:v1b3/JobExecutionDetails/stages/stage": stage "/dataflow:v1b3/JobExecutionInfo": job_execution_info "/dataflow:v1b3/JobExecutionInfo/stages": stages "/dataflow:v1b3/JobExecutionInfo/stages/stage": stage @@ -58475,6 +58494,9 @@ "/dataflow:v1b3/PipelineDescription/executionPipelineStage/execution_pipeline_stage": execution_pipeline_stage "/dataflow:v1b3/PipelineDescription/originalPipelineTransform": original_pipeline_transform "/dataflow:v1b3/PipelineDescription/originalPipelineTransform/original_pipeline_transform": original_pipeline_transform +"/dataflow:v1b3/Point": point +"/dataflow:v1b3/Point/time": time +"/dataflow:v1b3/Point/value": value "/dataflow:v1b3/Position": position "/dataflow:v1b3/Position/byteOffset": byte_offset "/dataflow:v1b3/Position/concatPosition": concat_position @@ -58482,6 +58504,10 @@ "/dataflow:v1b3/Position/key": key "/dataflow:v1b3/Position/recordIndex": record_index "/dataflow:v1b3/Position/shufflePosition": shuffle_position +"/dataflow:v1b3/ProgressTimeseries": progress_timeseries +"/dataflow:v1b3/ProgressTimeseries/currentProgress": current_progress +"/dataflow:v1b3/ProgressTimeseries/dataPoints": data_points +"/dataflow:v1b3/ProgressTimeseries/dataPoints/data_point": data_point "/dataflow:v1b3/PubSubIODetails": pub_sub_io_details "/dataflow:v1b3/PubSubIODetails/subscription": subscription "/dataflow:v1b3/PubSubIODetails/topic": topic @@ -58532,6 +58558,7 @@ "/dataflow:v1b3/RuntimeEnvironment/additionalUserLabels": additional_user_labels "/dataflow:v1b3/RuntimeEnvironment/additionalUserLabels/additional_user_label": additional_user_label "/dataflow:v1b3/RuntimeEnvironment/bypassTempDirValidation": bypass_temp_dir_validation +"/dataflow:v1b3/RuntimeEnvironment/enableStreamingEngine": enable_streaming_engine "/dataflow:v1b3/RuntimeEnvironment/ipConfiguration": ip_configuration "/dataflow:v1b3/RuntimeEnvironment/kmsKeyName": kms_key_name "/dataflow:v1b3/RuntimeEnvironment/machineType": machine_type @@ -58672,11 +58699,23 @@ "/dataflow:v1b3/SplitInt64": split_int64 "/dataflow:v1b3/SplitInt64/highBits": high_bits "/dataflow:v1b3/SplitInt64/lowBits": low_bits +"/dataflow:v1b3/StageExecutionDetails": stage_execution_details +"/dataflow:v1b3/StageExecutionDetails/nextPageToken": next_page_token +"/dataflow:v1b3/StageExecutionDetails/workers": workers +"/dataflow:v1b3/StageExecutionDetails/workers/worker": worker "/dataflow:v1b3/StageSource": stage_source "/dataflow:v1b3/StageSource/name": name "/dataflow:v1b3/StageSource/originalTransformOrCollection": original_transform_or_collection "/dataflow:v1b3/StageSource/sizeBytes": size_bytes "/dataflow:v1b3/StageSource/userName": user_name +"/dataflow:v1b3/StageSummary": stage_summary +"/dataflow:v1b3/StageSummary/endTime": end_time +"/dataflow:v1b3/StageSummary/metrics": metrics +"/dataflow:v1b3/StageSummary/metrics/metric": metric +"/dataflow:v1b3/StageSummary/progress": progress +"/dataflow:v1b3/StageSummary/stageId": stage_id +"/dataflow:v1b3/StageSummary/startTime": start_time +"/dataflow:v1b3/StageSummary/state": state "/dataflow:v1b3/StateFamilyConfig": state_family_config "/dataflow:v1b3/StateFamilyConfig/isRead": is_read "/dataflow:v1b3/StateFamilyConfig/stateFamily": state_family @@ -58823,6 +58862,15 @@ "/dataflow:v1b3/WorkItem/streamingComputationTask": streaming_computation_task "/dataflow:v1b3/WorkItem/streamingConfigTask": streaming_config_task "/dataflow:v1b3/WorkItem/streamingSetupTask": streaming_setup_task +"/dataflow:v1b3/WorkItemDetails": work_item_details +"/dataflow:v1b3/WorkItemDetails/attemptId": attempt_id +"/dataflow:v1b3/WorkItemDetails/endTime": end_time +"/dataflow:v1b3/WorkItemDetails/metrics": metrics +"/dataflow:v1b3/WorkItemDetails/metrics/metric": metric +"/dataflow:v1b3/WorkItemDetails/progress": progress +"/dataflow:v1b3/WorkItemDetails/startTime": start_time +"/dataflow:v1b3/WorkItemDetails/state": state +"/dataflow:v1b3/WorkItemDetails/taskId": task_id "/dataflow:v1b3/WorkItemServiceState": work_item_service_state "/dataflow:v1b3/WorkItemServiceState/completeWorkStatus": complete_work_status "/dataflow:v1b3/WorkItemServiceState/harnessData": harness_data @@ -58854,6 +58902,10 @@ "/dataflow:v1b3/WorkItemStatus/stopPosition": stop_position "/dataflow:v1b3/WorkItemStatus/totalThrottlerWaitTimeSeconds": total_throttler_wait_time_seconds "/dataflow:v1b3/WorkItemStatus/workItemId": work_item_id +"/dataflow:v1b3/WorkerDetails": worker_details +"/dataflow:v1b3/WorkerDetails/workItems": work_items +"/dataflow:v1b3/WorkerDetails/workItems/work_item": work_item +"/dataflow:v1b3/WorkerDetails/workerName": worker_name "/dataflow:v1b3/WorkerHealthReport": worker_health_report "/dataflow:v1b3/WorkerHealthReport/msg": msg "/dataflow:v1b3/WorkerHealthReport/pods": pods @@ -59022,6 +59074,10 @@ "/dataflow:v1b3/dataflow.projects.locations.jobs.get/location": location "/dataflow:v1b3/dataflow.projects.locations.jobs.get/projectId": project_id "/dataflow:v1b3/dataflow.projects.locations.jobs.get/view": view +"/dataflow:v1b3/dataflow.projects.locations.jobs.getExecutionDetails": get_project_location_job_execution_details +"/dataflow:v1b3/dataflow.projects.locations.jobs.getExecutionDetails/jobId": job_id +"/dataflow:v1b3/dataflow.projects.locations.jobs.getExecutionDetails/location": location +"/dataflow:v1b3/dataflow.projects.locations.jobs.getExecutionDetails/projectId": project_id "/dataflow:v1b3/dataflow.projects.locations.jobs.getMetrics": get_project_location_job_metrics "/dataflow:v1b3/dataflow.projects.locations.jobs.getMetrics/jobId": job_id "/dataflow:v1b3/dataflow.projects.locations.jobs.getMetrics/location": location @@ -59051,6 +59107,15 @@ "/dataflow:v1b3/dataflow.projects.locations.jobs.snapshots.list/jobId": job_id "/dataflow:v1b3/dataflow.projects.locations.jobs.snapshots.list/location": location "/dataflow:v1b3/dataflow.projects.locations.jobs.snapshots.list/projectId": project_id +"/dataflow:v1b3/dataflow.projects.locations.jobs.stages.getExecutionDetails": get_project_location_job_stage_execution_details +"/dataflow:v1b3/dataflow.projects.locations.jobs.stages.getExecutionDetails/endTime": end_time +"/dataflow:v1b3/dataflow.projects.locations.jobs.stages.getExecutionDetails/jobId": job_id +"/dataflow:v1b3/dataflow.projects.locations.jobs.stages.getExecutionDetails/location": location +"/dataflow:v1b3/dataflow.projects.locations.jobs.stages.getExecutionDetails/pageSize": page_size +"/dataflow:v1b3/dataflow.projects.locations.jobs.stages.getExecutionDetails/pageToken": page_token +"/dataflow:v1b3/dataflow.projects.locations.jobs.stages.getExecutionDetails/projectId": project_id +"/dataflow:v1b3/dataflow.projects.locations.jobs.stages.getExecutionDetails/stageId": stage_id +"/dataflow:v1b3/dataflow.projects.locations.jobs.stages.getExecutionDetails/startTime": start_time "/dataflow:v1b3/dataflow.projects.locations.jobs.update": update_project_location_job "/dataflow:v1b3/dataflow.projects.locations.jobs.update/jobId": job_id "/dataflow:v1b3/dataflow.projects.locations.jobs.update/location": location @@ -118844,6 +118909,7 @@ "/run:v1/EnvVarSource/secretKeyRef": secret_key_ref "/run:v1/ExecAction": exec_action "/run:v1/ExecAction/command": command +"/run:v1/ExecAction/command/command": command "/run:v1/Expr": expr "/run:v1/Expr/description": description "/run:v1/Expr/expression": expression @@ -119558,6 +119624,7 @@ "/run:v1alpha1/EnvVarSource/secretKeyRef": secret_key_ref "/run:v1alpha1/ExecAction": exec_action "/run:v1alpha1/ExecAction/command": command +"/run:v1alpha1/ExecAction/command/command": command "/run:v1alpha1/Expr": expr "/run:v1alpha1/Expr/description": description "/run:v1alpha1/Expr/expression": expression diff --git a/generated/google/apis/container_v1.rb b/generated/google/apis/container_v1.rb index 14073e23e..17b649ff4 100644 --- a/generated/google/apis/container_v1.rb +++ b/generated/google/apis/container_v1.rb @@ -26,7 +26,7 @@ module Google # @see https://cloud.google.com/container-engine/ module ContainerV1 VERSION = 'V1' - REVISION = '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_v1/classes.rb b/generated/google/apis/container_v1/classes.rb index 9a830dca3..d5689cff3 100644 --- a/generated/google/apis/container_v1/classes.rb +++ b/generated/google/apis/container_v1/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 @@ -69,14 +69,14 @@ module Google attr_accessor :dns_cache_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::ContainerV1::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::ContainerV1::HttpLoadBalancing] attr_accessor :http_load_balancing @@ -86,9 +86,9 @@ module Google # @return [Google::Apis::ContainerV1::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::ContainerV1::NetworkPolicyConfig] attr_accessor :network_policy_config @@ -113,15 +113,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 @@ -137,20 +137,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 @@ -166,8 +166,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 @@ -188,23 +188,19 @@ module Google 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::ContainerV1::UpgradeSettings] attr_accessor :upgrade_settings @@ -245,8 +241,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 Binary Authorization. + # Enable Binary Authorization for this cluster. If enabled, all container images + # will be validated by Binary Authorization. # Corresponds to the JSON property `enabled` # @return [Boolean] attr_accessor :enabled @@ -272,23 +268,22 @@ module Google # @return [String] attr_accessor :name - # Deprecated. The server-assigned `name` of the operation. - # This field has been deprecated and replaced by the name field. + # 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 - # 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. + # 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. # Corresponds to the JSON property `projectId` # @return [String] attr_accessor :project_id - # 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. + # 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 @@ -375,8 +370,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::ContainerV1::AddonsConfig] attr_accessor :addons_config @@ -386,10 +381,9 @@ module Google # @return [Google::Apis::ContainerV1::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::ContainerV1::ClusterAutoscaling] attr_accessor :autoscaling @@ -399,10 +393,10 @@ module Google # @return [Google::Apis::ContainerV1::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 @@ -412,8 +406,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 @@ -423,15 +417,14 @@ 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 - # [NodePools.version](https://cloud.google.com/kubernetes-engine/docs/reference/ - # rest/v1/projects.locations.clusters.nodePools) + # [Output only] Deprecated, use [NodePools.version](https://cloud.google.com/ + # kubernetes-engine/docs/reference/rest/v1/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. @@ -454,12 +447,11 @@ module Google # @return [String] attr_accessor :description - # Kubernetes alpha features are enabled on this cluster. This includes alpha - # API groups (e.g. v1alpha1) 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. v1alpha1) 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 @@ -471,45 +463,41 @@ module Google 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 @@ -529,39 +517,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::ContainerV1::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 @@ -572,8 +553,7 @@ module Google attr_accessor :maintenance_policy # 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::ContainerV1::MasterAuth] attr_accessor :master_auth @@ -586,34 +566,28 @@ module Google # @return [Google::Apis::ContainerV1::MasterAuthorizedNetworksConfig] attr_accessor :master_authorized_networks_config - # 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. + # 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. # Corresponds to the JSON property `network` # @return [String] attr_accessor :network @@ -623,8 +597,8 @@ module Google # @return [Google::Apis::ContainerV1::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::ContainerV1::NetworkPolicy] attr_accessor :network_policy @@ -635,16 +609,14 @@ 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 @@ -654,17 +626,16 @@ module Google # @return [Google::Apis::ContainerV1::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::ContainerV1::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 @@ -679,11 +650,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 @@ -698,42 +668,40 @@ 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. + # The name of the Google Compute Engine [subnetwork](https://cloud.google.com/ + # compute/docs/subnetworks) to which the cluster is connected. # Corresponds to the JSON property `subnetwork` # @return [String] attr_accessor :subnetwork - # [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::ContainerV1::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::ContainerV1::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 @@ -798,22 +766,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::ContainerV1::AutoprovisioningNodePoolDefaults] attr_accessor :autoprovisioning_node_pool_defaults @@ -824,8 +790,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 @@ -843,14 +809,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::ContainerV1::AddonsConfig] attr_accessor :desired_addons_config @@ -860,10 +825,9 @@ module Google # @return [Google::Apis::ContainerV1::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::ContainerV1::ClusterAutoscaling] attr_accessor :desired_cluster_autoscaling @@ -873,8 +837,14 @@ module Google # @return [Google::Apis::ContainerV1::DatabaseEncryption] attr_accessor :desired_database_encryption - # The desired image type for the node pool. - # NOTE: Set the "desired_node_pool" field as well. + # DefaultSnatStatus contains the desired state of whether default sNAT should be + # disabled on the cluster. + # Corresponds to the JSON property `desiredDefaultSnatStatus` + # @return [Google::Apis::ContainerV1::DefaultSnatStatus] + attr_accessor :desired_default_snat_status + + # 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 @@ -885,25 +855,22 @@ module Google # @return [Google::Apis::ContainerV1::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 @@ -916,27 +883,24 @@ module Google # @return [Google::Apis::ContainerV1::MasterAuthorizedNetworksConfig] attr_accessor :desired_master_authorized_networks_config - # 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 + # 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 `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 @@ -947,32 +911,33 @@ module Google # @return [Google::Apis::ContainerV1::NodePoolAutoscaling] attr_accessor :desired_node_pool_autoscaling - # The node pool to be upgraded. This field is mandatory if - # "desired_node_version", "desired_image_family" or - # "desired_node_pool_autoscaling" 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" or "desired_node_pool_autoscaling" 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 - # 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. + # Configuration options for private clusters. + # Corresponds to the JSON property `desiredPrivateClusterConfig` + # @return [Google::Apis::ContainerV1::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. # Corresponds to the JSON property `desiredReleaseChannel` # @return [Google::Apis::ContainerV1::ReleaseChannel] attr_accessor :desired_release_channel @@ -987,15 +952,14 @@ module Google # @return [Google::Apis::ContainerV1::ShieldedNodes] attr_accessor :desired_shielded_nodes - # 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::ContainerV1::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::ContainerV1::WorkloadIdentityConfig] attr_accessor :desired_workload_identity_config @@ -1010,6 +974,7 @@ module Google @desired_binary_authorization = args[:desired_binary_authorization] if args.key?(:desired_binary_authorization) @desired_cluster_autoscaling = args[:desired_cluster_autoscaling] if args.key?(:desired_cluster_autoscaling) @desired_database_encryption = args[:desired_database_encryption] if args.key?(:desired_database_encryption) + @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) @desired_locations = args[:desired_locations] if args.key?(:desired_locations) @@ -1020,6 +985,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_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) @desired_resource_usage_export_config = args[:desired_resource_usage_export_config] if args.key?(:desired_resource_usage_export_config) @desired_shielded_nodes = args[:desired_shielded_nodes] if args.key?(:desired_shielded_nodes) @@ -1032,8 +998,8 @@ module Google class CompleteIpRotationRequest include Google::Apis::Core::Hashable - # Deprecated. The name of the cluster. - # This field has been deprecated and replaced by the name field. + # 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 @@ -1044,17 +1010,16 @@ module Google # @return [String] attr_accessor :name - # 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. + # 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. # Corresponds to the JSON property `projectId` # @return [String] attr_accessor :project_id - # 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. + # 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 @@ -1096,9 +1061,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 @@ -1123,23 +1087,22 @@ module Google # @return [Google::Apis::ContainerV1::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 - # 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. + # 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. # Corresponds to the JSON property `projectId` # @return [String] attr_accessor :project_id - # 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. + # 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 @@ -1161,40 +1124,38 @@ module Google class CreateNodePoolRequest include Google::Apis::Core::Hashable - # Deprecated. The name of the cluster. - # This field has been deprecated and replaced by the parent field. + # 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::ContainerV1::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 - # 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. + # 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. # Corresponds to the JSON property `projectId` # @return [String] attr_accessor :project_id - # 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. + # 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 @@ -1217,17 +1178,16 @@ 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. - # Duration will be in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) - # format "PTnHnMnS". + # [Output only] Duration of the time window, automatically chosen to be smallest + # possible in the given scenario. Duration will be in [RFC3339](https://www.ietf. + # org/rfc/rfc3339.txt) format "PTnHnMnS". # Corresponds to the JSON property `duration` # @return [String] attr_accessor :duration - # Time within the maintenance window to start the maintenance operations. - # Time format should be in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) - # format "HH:MM", where HH : [00-23] and MM : [00-59] GMT. + # Time within the maintenance window to start the maintenance operations. Time + # format should be in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) format "HH: + # MM", where HH : [00-23] and MM : [00-59] GMT. # Corresponds to the JSON property `startTime` # @return [String] attr_accessor :start_time @@ -1247,8 +1207,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 @@ -1269,6 +1229,27 @@ module Google end end + # DefaultSnatStatus contains the desired state of whether default sNAT should be + # disabled on the cluster. + class DefaultSnatStatus + include Google::Apis::Core::Hashable + + # Disables cluster default sNAT rules. + # Corresponds to the JSON property `disabled` + # @return [Boolean] + attr_accessor :disabled + alias_method :disabled?, :disabled + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @disabled = args[:disabled] if args.key?(:disabled) + end + end + # Configuration for NodeLocal DNSCache class DnsCacheConfig include Google::Apis::Core::Hashable @@ -1289,13 +1270,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 @@ -1317,8 +1296,7 @@ module Google # @return [Google::Apis::ContainerV1::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 @@ -1334,8 +1312,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 @@ -1397,14 +1375,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 @@ -1451,14 +1428,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 @@ -1483,33 +1459,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 is true 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 is true 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 @@ -1520,16 +1491,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 @@ -1540,58 +1508,61 @@ 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 is true 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 is true 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. + # 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. # 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. + # 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 + # Corresponds to the JSON property `useRoutes` + # @return [Boolean] + attr_accessor :use_routes + alias_method :use_routes?, :use_routes + def initialize(**args) update!(**args) end @@ -1610,6 +1581,7 @@ module Google @subnetwork_name = args[:subnetwork_name] if args.key?(:subnetwork_name) @tpu_ipv4_cidr_block = args[:tpu_ipv4_cidr_block] if args.key?(:tpu_ipv4_cidr_block) @use_ip_aliases = args[:use_ip_aliases] if args.key?(:use_ip_aliases) + @use_routes = args[:use_routes] if args.key?(:use_routes) end end @@ -1721,15 +1693,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 @@ -1749,14 +1720,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 @@ -1795,8 +1765,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 @@ -1817,15 +1787,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 @@ -1851,10 +1820,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 @@ -1884,8 +1853,8 @@ module Google # @return [Google::Apis::ContainerV1::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 @@ -1908,8 +1877,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 @@ -1924,29 +1892,29 @@ module Google # @return [Google::Apis::ContainerV1::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 - # [Output only] Base64-encoded public certificate that is the root of - # trust for the cluster. + # [Output only] Base64-encoded public certificate that is the root of trust for + # the cluster. # Corresponds to the JSON property `clusterCaCertificate` # @return [String] attr_accessor :cluster_ca_certificate # 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 @@ -1973,8 +1941,8 @@ module Google class MasterAuthorizedNetworksConfig include Google::Apis::Core::Hashable - # cidr_blocks define up to 50 external networks that could access - # Kubernetes master through HTTPS. + # cidr_blocks define up to 50 external networks that could access Kubernetes + # master through HTTPS. # Corresponds to the JSON property `cidrBlocks` # @return [Array] attr_accessor :cidr_blocks @@ -2056,25 +2024,29 @@ module Google class NetworkConfig include Google::Apis::Core::Hashable - # Whether Intra-node visibility is enabled for this cluster. - # This makes same node pod to pod traffic visible for VPC network. + # DefaultSnatStatus contains the desired state of whether default sNAT should be + # disabled on the cluster. + # Corresponds to the JSON property `defaultSnatStatus` + # @return [Google::Apis::ContainerV1::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. # 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 @@ -2085,14 +2057,15 @@ module Google # Update properties of this object def update!(**args) + @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) @subnetwork = args[:subnetwork] if args.key?(:subnetwork) 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 @@ -2118,9 +2091,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 @@ -2144,154 +2117,124 @@ 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 # 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 - # 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-os-login" - # - "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-os-login" + # - "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 - # information about preemptible VM instances. + # Whether the nodes are created as preemptible VM instances. See: https://cloud. + # google.com/compute/docs/instances/preemptible for more information 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::ContainerV1::ReservationAffinity] attr_accessor :reservation_affinity @@ -2301,9 +2244,9 @@ module Google # @return [Google::Apis::ContainerV1::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 @@ -2314,16 +2257,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 @@ -2369,24 +2312,24 @@ module Google include Google::Apis::Core::Hashable # A flag that specifies whether the node auto-repair is enabled for the node - # pool. If enabled, the nodes in this node pool will be monitored and, if - # they fail health checks too many times, an automatic repair action will be + # pool. If enabled, the nodes in this node pool will be monitored and, if they + # fail health checks too many times, an automatic repair action will be # triggered. # Corresponds to the JSON property `autoRepair` # @return [Boolean] attr_accessor :auto_repair alias_method :auto_repair?, :auto_repair - # A flag that specifies whether node auto-upgrade is enabled for the node - # pool. If enabled, node auto-upgrade helps keep the nodes in your node pool - # up to date with the latest release version of Kubernetes. + # A flag that specifies whether node auto-upgrade is enabled for the node pool. + # If enabled, node auto-upgrade helps keep the nodes in your node pool up to + # date with the latest release version of Kubernetes. # Corresponds to the JSON property `autoUpgrade` # @return [Boolean] 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::ContainerV1::AutoUpgradeOptions] attr_accessor :upgrade_options @@ -2403,12 +2346,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 @@ -2428,25 +2371,23 @@ module Google # @return [Google::Apis::ContainerV1::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 @@ -2482,30 +2423,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::ContainerV1::UpgradeSettings] attr_accessor :upgrade_settings @@ -2556,14 +2493,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 @@ -2582,8 +2518,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 @@ -2631,18 +2566,15 @@ 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) + # [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] @@ -2673,8 +2605,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 @@ -2694,9 +2626,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 @@ -2728,18 +2660,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 @@ -2749,8 +2678,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 @@ -2778,18 +2706,23 @@ 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 alias_method :enable_private_nodes?, :enable_private_nodes - # 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. + # Configuration for controlling master global access settings. + # Corresponds to the JSON property `masterGlobalAccessConfig` + # @return [Google::Apis::ContainerV1::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. # Corresponds to the JSON property `masterIpv4CidrBlock` # @return [String] attr_accessor :master_ipv4_cidr_block @@ -2817,6 +2750,7 @@ module Google def update!(**args) @enable_private_endpoint = args[:enable_private_endpoint] if args.key?(:enable_private_endpoint) @enable_private_nodes = args[:enable_private_nodes] if args.key?(:enable_private_nodes) + @master_global_access_config = args[:master_global_access_config] if args.key?(:master_global_access_config) @master_ipv4_cidr_block = args[:master_ipv4_cidr_block] if args.key?(:master_ipv4_cidr_block) @peering_name = args[:peering_name] if args.key?(:peering_name) @private_endpoint = args[:private_endpoint] if args.key?(:private_endpoint) @@ -2824,36 +2758,45 @@ module Google end end + # Configuration for controlling master global access settings. + class PrivateClusterMasterGlobalAccessConfig + include Google::Apis::Core::Hashable + + # Whenever master is accessible globally or not. + # Corresponds to the JSON property `enabled` + # @return [Boolean] + attr_accessor :enabled + alias_method :enabled?, :enabled + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @enabled = args[:enabled] if args.key?(:enabled) + 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 @@ -2874,11 +2817,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 @@ -2929,9 +2871,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 @@ -2941,8 +2882,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 @@ -2964,8 +2905,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 @@ -3035,36 +2976,35 @@ module Google class RollbackNodePoolUpgradeRequest include Google::Apis::Core::Hashable - # Deprecated. The name of the cluster to rollback. - # This field has been deprecated and replaced by the name field. + # 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 - # Deprecated. The name of the node pool to rollback. - # This field has been deprecated and replaced by the name field. + # 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 - # 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. + # 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. # Corresponds to the JSON property `projectId` # @return [String] attr_accessor :project_id - # 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. + # 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 @@ -3155,35 +3095,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::ContainerV1::AddonsConfig] attr_accessor :addons_config - # Deprecated. The name of the cluster to upgrade. - # This field has been deprecated and replaced by the name field. + # 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 - # 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. + # 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. # Corresponds to the JSON property `projectId` # @return [String] attr_accessor :project_id - # 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. + # 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 @@ -3208,18 +3147,17 @@ module Google class SetLabelsRequest include Google::Apis::Core::Hashable - # Deprecated. The name of the cluster. - # This field has been deprecated and replaced by the name field. + # 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 @@ -3230,9 +3168,9 @@ module Google # @return [String] attr_accessor :name - # 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. + # 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. # Corresponds to the JSON property `projectId` # @return [String] attr_accessor :project_id @@ -3242,10 +3180,9 @@ module Google # @return [Hash] attr_accessor :resource_labels - # 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. + # 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 @@ -3270,8 +3207,8 @@ module Google class SetLegacyAbacRequest include Google::Apis::Core::Hashable - # Deprecated. The name of the cluster to update. - # This field has been deprecated and replaced by the name field. + # 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 @@ -3288,17 +3225,16 @@ module Google # @return [String] attr_accessor :name - # 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. + # 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. # Corresponds to the JSON property `projectId` # @return [String] attr_accessor :project_id - # 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. + # 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 @@ -3321,18 +3257,18 @@ module Google class SetLocationsRequest include Google::Apis::Core::Hashable - # Deprecated. The name of the cluster to upgrade. - # This field has been deprecated and replaced by the name field. + # 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 @@ -3343,17 +3279,16 @@ module Google # @return [String] attr_accessor :name - # 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. + # 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. # Corresponds to the JSON property `projectId` # @return [String] attr_accessor :project_id - # 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. + # 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 @@ -3376,42 +3311,39 @@ module Google class SetLoggingServiceRequest include Google::Apis::Core::Hashable - # Deprecated. The name of the cluster to upgrade. - # This field has been deprecated and replaced by the name field. + # 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 - # 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. + # 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. # Corresponds to the JSON property `projectId` # @return [String] attr_accessor :project_id - # 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. + # 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 @@ -3445,21 +3377,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 @@ -3487,36 +3417,34 @@ module Google # @return [String] attr_accessor :action - # Deprecated. The name of the cluster to upgrade. - # This field has been deprecated and replaced by the name field. + # 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 - # 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. + # 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. # 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::ContainerV1::MasterAuth] attr_accessor :update - # 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. + # 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 @@ -3540,21 +3468,19 @@ module Google class SetMonitoringServiceRequest include Google::Apis::Core::Hashable - # Deprecated. The name of the cluster to upgrade. - # This field has been deprecated and replaced by the name field. + # 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 @@ -3565,17 +3491,16 @@ module Google # @return [String] attr_accessor :name - # 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. + # 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. # Corresponds to the JSON property `projectId` # @return [String] attr_accessor :project_id - # 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. + # 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 @@ -3598,8 +3523,8 @@ module Google class SetNetworkPolicyRequest include Google::Apis::Core::Hashable - # Deprecated. The name of the cluster. - # This field has been deprecated and replaced by the name field. + # 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 @@ -3610,23 +3535,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::ContainerV1::NetworkPolicy] attr_accessor :network_policy - # 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. + # 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. # Corresponds to the JSON property `projectId` # @return [String] attr_accessor :project_id - # 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. + # 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 @@ -3655,36 +3579,35 @@ module Google # @return [Google::Apis::ContainerV1::NodePoolAutoscaling] attr_accessor :autoscaling - # Deprecated. The name of the cluster to upgrade. - # This field has been deprecated and replaced by the name field. + # 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 - # Deprecated. The name of the node pool to upgrade. - # This field has been deprecated and replaced by the name field. + # 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 - # 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. + # 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. # Corresponds to the JSON property `projectId` # @return [String] attr_accessor :project_id - # 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. + # 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 @@ -3709,8 +3632,8 @@ module Google class SetNodePoolManagementRequest include Google::Apis::Core::Hashable - # Deprecated. The name of the cluster to update. - # This field has been deprecated and replaced by the name field. + # 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 @@ -3722,29 +3645,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 - # Deprecated. The name of the node pool to update. - # This field has been deprecated and replaced by the name field. + # 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 - # 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. + # 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. # Corresponds to the JSON property `projectId` # @return [String] attr_accessor :project_id - # 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. + # 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 @@ -3764,20 +3686,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 - # Deprecated. The name of the cluster to update. - # This field has been deprecated and replaced by the name field. + # 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 @@ -3787,23 +3707,22 @@ module Google # @return [Fixnum] attr_accessor :node_count - # Deprecated. The name of the node pool to update. - # This field has been deprecated and replaced by the name field. + # 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 - # 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. + # 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. # Corresponds to the JSON property `projectId` # @return [String] attr_accessor :project_id - # 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. + # 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 @@ -3827,20 +3746,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 @@ -3877,26 +3796,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 - # Deprecated. The name of the cluster. - # This field has been deprecated and replaced by the name field. + # 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 - # 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. + # 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. # Corresponds to the JSON property `projectId` # @return [String] attr_accessor :project_id @@ -3907,10 +3826,9 @@ module Google attr_accessor :rotate_credentials alias_method :rotate_credentials?, :rotate_credentials - # 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. + # 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 @@ -3929,8 +3847,8 @@ module Google end end - # StatusCondition describes why a cluster or a node pool has a certain status - # (e.g., ERROR or DEGRADED). + # 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 @@ -3959,8 +3877,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 @@ -3985,36 +3903,34 @@ module Google class UpdateClusterRequest include Google::Apis::Core::Hashable - # Deprecated. The name of the cluster to upgrade. - # This field has been deprecated and replaced by the name field. + # 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 - # 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. + # 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. # 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::ContainerV1::ClusterUpdate] attr_accessor :update - # 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. + # 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 @@ -4037,41 +3953,39 @@ module Google class UpdateMasterRequest include Google::Apis::Core::Hashable - # Deprecated. The name of the cluster to upgrade. - # This field has been deprecated and replaced by the name field. + # 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 - # 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. + # 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. # Corresponds to the JSON property `projectId` # @return [String] attr_accessor :project_id - # 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. + # 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 @@ -4094,8 +4008,8 @@ module Google class UpdateNodePoolRequest include Google::Apis::Core::Hashable - # Deprecated. The name of the cluster to upgrade. - # This field has been deprecated and replaced by the name field. + # 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 @@ -4105,66 +4019,59 @@ module Google # @return [String] attr_accessor :image_type - # 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 - # Deprecated. The name of the node pool to upgrade. - # This field has been deprecated and replaced by the name field. + # 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 - # 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. + # 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. # 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::ContainerV1::UpgradeSettings] attr_accessor :upgrade_settings @@ -4175,10 +4082,9 @@ module Google # @return [Google::Apis::ContainerV1::WorkloadMetadataConfig] attr_accessor :workload_metadata_config - # 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. + # 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 @@ -4202,36 +4108,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 @@ -4257,8 +4209,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 @@ -4268,16 +4219,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 @@ -4305,8 +4256,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 @@ -4328,9 +4279,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 @@ -4350,8 +4301,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 @@ -4375,8 +4325,8 @@ 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 diff --git a/generated/google/apis/container_v1/representations.rb b/generated/google/apis/container_v1/representations.rb index 9f6cae65e..0539fe493 100644 --- a/generated/google/apis/container_v1/representations.rb +++ b/generated/google/apis/container_v1/representations.rb @@ -148,6 +148,12 @@ module Google include Google::Apis::Core::JsonObjectSupport end + class DefaultSnatStatus + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class DnsCacheConfig class Representation < Google::Apis::Core::JsonRepresentation; end @@ -346,6 +352,12 @@ module Google include Google::Apis::Core::JsonObjectSupport end + class PrivateClusterMasterGlobalAccessConfig + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class RecurringTimeWindow class Representation < Google::Apis::Core::JsonRepresentation; end @@ -520,6 +532,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 @@ -760,6 +778,8 @@ module Google property :desired_database_encryption, as: 'desiredDatabaseEncryption', class: Google::Apis::ContainerV1::DatabaseEncryption, decorator: Google::Apis::ContainerV1::DatabaseEncryption::Representation + property :desired_default_snat_status, as: 'desiredDefaultSnatStatus', class: Google::Apis::ContainerV1::DefaultSnatStatus, decorator: Google::Apis::ContainerV1::DefaultSnatStatus::Representation + property :desired_image_type, as: 'desiredImageType' property :desired_intra_node_visibility_config, as: 'desiredIntraNodeVisibilityConfig', class: Google::Apis::ContainerV1::IntraNodeVisibilityConfig, decorator: Google::Apis::ContainerV1::IntraNodeVisibilityConfig::Representation @@ -773,6 +793,8 @@ module Google property :desired_node_pool_id, as: 'desiredNodePoolId' property :desired_node_version, as: 'desiredNodeVersion' + property :desired_private_cluster_config, as: 'desiredPrivateClusterConfig', class: Google::Apis::ContainerV1::PrivateClusterConfig, decorator: Google::Apis::ContainerV1::PrivateClusterConfig::Representation + property :desired_release_channel, as: 'desiredReleaseChannel', class: Google::Apis::ContainerV1::ReleaseChannel, decorator: Google::Apis::ContainerV1::ReleaseChannel::Representation property :desired_resource_usage_export_config, as: 'desiredResourceUsageExportConfig', class: Google::Apis::ContainerV1::ResourceUsageExportConfig, decorator: Google::Apis::ContainerV1::ResourceUsageExportConfig::Representation @@ -849,6 +871,13 @@ module Google end end + class DefaultSnatStatus + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :disabled, as: 'disabled' + end + end + class DnsCacheConfig # @private class Representation < Google::Apis::Core::JsonRepresentation @@ -925,6 +954,7 @@ module Google property :subnetwork_name, as: 'subnetworkName' property :tpu_ipv4_cidr_block, as: 'tpuIpv4CidrBlock' property :use_ip_aliases, as: 'useIpAliases' + property :use_routes, as: 'useRoutes' end end @@ -1062,6 +1092,8 @@ module Google class NetworkConfig # @private class Representation < Google::Apis::Core::JsonRepresentation + property :default_snat_status, as: 'defaultSnatStatus', class: Google::Apis::ContainerV1::DefaultSnatStatus, decorator: Google::Apis::ContainerV1::DefaultSnatStatus::Representation + property :enable_intra_node_visibility, as: 'enableIntraNodeVisibility' property :network, as: 'network' property :subnetwork, as: 'subnetwork' @@ -1211,6 +1243,8 @@ module Google class Representation < Google::Apis::Core::JsonRepresentation property :enable_private_endpoint, as: 'enablePrivateEndpoint' property :enable_private_nodes, as: 'enablePrivateNodes' + property :master_global_access_config, as: 'masterGlobalAccessConfig', class: Google::Apis::ContainerV1::PrivateClusterMasterGlobalAccessConfig, decorator: Google::Apis::ContainerV1::PrivateClusterMasterGlobalAccessConfig::Representation + property :master_ipv4_cidr_block, as: 'masterIpv4CidrBlock' property :peering_name, as: 'peeringName' property :private_endpoint, as: 'privateEndpoint' @@ -1218,6 +1252,13 @@ module Google end end + class PrivateClusterMasterGlobalAccessConfig + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :enabled, as: 'enabled' + end + end + class RecurringTimeWindow # @private class Representation < Google::Apis::Core::JsonRepresentation @@ -1529,6 +1570,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_v1/service.rb b/generated/google/apis/container_v1/service.rb index 3af0581c9..a8729c58b 100644 --- a/generated/google/apis/container_v1/service.rb +++ b/generated/google/apis/container_v1/service.rb @@ -50,18 +50,18 @@ module Google # Lists subnetworks that are usable for creating clusters in a project. # @param [String] parent - # The parent project where subnetworks are usable. - # Specified in the format `projects/*`. + # 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 - # 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. + # 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. # @param [String] zone - # 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. + # 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 @@ -172,20 +171,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::ContainerV1::CreateClusterRequest] create_cluster_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -216,28 +211,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 - # Deprecated. The name of the cluster to delete. - # This field has been deprecated and replaced by the name field. + # Deprecated. The name of the cluster to delete. This field has been deprecated + # and replaced by the name field. # @param [String] project_id - # 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. + # 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. # @param [String] zone - # 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. + # 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 @@ -270,20 +262,19 @@ module Google # Gets the details of 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 - # Deprecated. The name of the cluster to retrieve. - # This field has been deprecated and replaced by the name field. + # Deprecated. The name of the cluster to retrieve. This field has been + # deprecated and replaced by the name field. # @param [String] project_id - # 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. + # 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. # @param [String] zone - # 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. + # 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 @@ -314,13 +305,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 @@ -351,18 +341,17 @@ 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 - # 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. - # @param [String] zone - # 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 + # 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. + # @param [String] zone + # 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 @@ -394,8 +383,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::ContainerV1::SetAddonsConfigRequest] set_addons_config_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -460,11 +449,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/v1/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/v1/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/*`. @@ -500,8 +487,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::ContainerV1::SetLoggingServiceRequest] set_logging_service_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -535,8 +522,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::ContainerV1::SetMaintenancePolicyRequest] set_maintenance_policy_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -567,12 +553,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::ContainerV1::SetMasterAuthRequest] set_master_auth_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -707,8 +693,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::ContainerV1::StartIpRotationRequest] start_ip_rotation_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -741,8 +727,8 @@ module Google # Updates the settings of 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::ContainerV1::UpdateClusterRequest] update_cluster_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -775,8 +761,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::ContainerV1::UpdateMasterRequest] update_master_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -809,9 +795,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::ContainerV1::CreateNodePoolRequest] create_node_pool_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -844,24 +829,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 - # Deprecated. The name of the cluster. - # This field has been deprecated and replaced by the name field. + # Deprecated. The name of the cluster. This field has been deprecated and + # replaced by the name field. # @param [String] node_pool_id - # Deprecated. The name of the node pool to delete. - # This field has been deprecated and replaced by the name field. + # Deprecated. The name of the node pool to delete. This field has been + # deprecated and replaced by the name field. # @param [String] project_id - # 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. + # 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. # @param [String] zone - # 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. + # 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 @@ -895,24 +878,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 - # Deprecated. The name of the cluster. - # This field has been deprecated and replaced by the name field. + # Deprecated. The name of the cluster. This field has been deprecated and + # replaced by the name field. # @param [String] node_pool_id - # Deprecated. The name of the node pool. - # This field has been deprecated and replaced by the name field. + # Deprecated. The name of the node pool. This field has been deprecated and + # replaced by the name field. # @param [String] project_id - # 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. + # 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. # @param [String] zone - # 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. + # 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 @@ -946,20 +927,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 - # Deprecated. The name of the cluster. - # This field has been deprecated and replaced by the parent field. + # Deprecated. The name of the cluster. This field has been deprecated and + # replaced by the parent field. # @param [String] project_id - # 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. + # 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. # @param [String] zone - # 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. + # 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 @@ -990,12 +970,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::ContainerV1::RollbackNodePoolUpgradeRequest] rollback_node_pool_upgrade_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -1029,8 +1009,8 @@ module Google # Sets the autoscaling settings for the specified 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::ContainerV1::SetNodePoolAutoscalingRequest] set_node_pool_autoscaling_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -1064,8 +1044,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::ContainerV1::SetNodePoolManagementRequest] set_node_pool_management_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -1099,8 +1079,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::ContainerV1::SetNodePoolSizeRequest] set_node_pool_size_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -1133,9 +1112,8 @@ module Google # Updates the version and/or image type for the specified 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::ContainerV1::UpdateNodePoolRequest] update_node_pool_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -1166,16 +1144,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 @@ -1239,20 +1214,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 - # Deprecated. The server-assigned `name` of the operation. - # This field has been deprecated and replaced by the name field. + # Deprecated. The server-assigned `name` of the operation. This field has been + # deprecated and replaced by the name field. # @param [String] project_id - # 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. + # 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. # @param [String] zone - # 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. + # 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 @@ -1286,17 +1260,16 @@ module Google # Lists all operations in a project in a specific 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 - # 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. - # @param [String] zone - # 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 + # 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. + # @param [String] zone + # 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 @@ -1328,17 +1301,16 @@ module Google # Returns configuration info about the Google Kubernetes Engine service. # @param [String] project_id - # 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. + # 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. # @param [String] zone - # 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. + # 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 @@ -1370,17 +1342,16 @@ module Google # Sets the addons for a specific cluster. # @param [String] project_id - # 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. + # 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. # @param [String] zone - # 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. + # 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 - # Deprecated. The name of the cluster to upgrade. - # This field has been deprecated and replaced by the name field. + # Deprecated. The name of the cluster to upgrade. This field has been deprecated + # and replaced by the name field. # @param [Google::Apis::ContainerV1::SetAddonsConfigRequest] set_addons_config_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -1415,17 +1386,16 @@ module Google # Completes master IP rotation. # @param [String] project_id - # 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. + # 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. # @param [String] zone - # 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. + # 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 - # Deprecated. The name of the cluster. - # This field has been deprecated and replaced by the name field. + # Deprecated. The name of the cluster. This field has been deprecated and + # replaced by the name field. # @param [Google::Apis::ContainerV1::CompleteIpRotationRequest] complete_ip_rotation_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -1459,26 +1429,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 - # 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. + # 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. # @param [String] zone - # 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. + # 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::ContainerV1::CreateClusterRequest] create_cluster_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -1510,28 +1475,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 - # 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. + # 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. # @param [String] zone - # 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. + # 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 - # Deprecated. The name of the cluster to delete. - # This field has been deprecated and replaced by the name field. + # 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 @@ -1564,20 +1526,19 @@ module Google # Gets the details of a specific cluster. # @param [String] project_id - # 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. + # 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. # @param [String] zone - # 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. + # 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 - # Deprecated. The name of the cluster to retrieve. - # This field has been deprecated and replaced by the name field. + # 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 @@ -1610,17 +1571,16 @@ module Google # Enables or disables the ABAC authorization mechanism on a cluster. # @param [String] project_id - # 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. + # 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. # @param [String] zone - # 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. + # 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 - # Deprecated. The name of the cluster to update. - # This field has been deprecated and replaced by the name field. + # Deprecated. The name of the cluster to update. This field has been deprecated + # and replaced by the name field. # @param [Google::Apis::ContainerV1::SetLegacyAbacRequest] set_legacy_abac_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -1656,18 +1616,17 @@ module Google # Lists all clusters owned by a project in either the specified zone or all # zones. # @param [String] project_id - # 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. - # @param [String] zone - # 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 + # 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. + # @param [String] zone + # 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 @@ -1697,23 +1656,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/v1/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/v1/projects.locations.clusters/update) instead. # @param [String] project_id - # 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. + # 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. # @param [String] zone - # 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. + # 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 - # Deprecated. The name of the cluster to upgrade. - # This field has been deprecated and replaced by the name field. + # Deprecated. The name of the cluster to upgrade. This field has been deprecated + # and replaced by the name field. # @param [Google::Apis::ContainerV1::SetLocationsRequest] set_locations_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -1748,17 +1704,16 @@ module Google # Sets the logging service for a specific cluster. # @param [String] project_id - # 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. + # 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. # @param [String] zone - # 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. + # 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 - # Deprecated. The name of the cluster to upgrade. - # This field has been deprecated and replaced by the name field. + # Deprecated. The name of the cluster to upgrade. This field has been deprecated + # and replaced by the name field. # @param [Google::Apis::ContainerV1::SetLoggingServiceRequest] set_logging_service_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -1793,17 +1748,16 @@ module Google # Updates the master for a specific cluster. # @param [String] project_id - # 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. + # 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. # @param [String] zone - # 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. + # 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 - # Deprecated. The name of the cluster to upgrade. - # This field has been deprecated and replaced by the name field. + # Deprecated. The name of the cluster to upgrade. This field has been deprecated + # and replaced by the name field. # @param [Google::Apis::ContainerV1::UpdateMasterRequest] update_master_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -1838,17 +1792,16 @@ module Google # Sets the monitoring service for a specific cluster. # @param [String] project_id - # 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. + # 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. # @param [String] zone - # 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. + # 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 - # Deprecated. The name of the cluster to upgrade. - # This field has been deprecated and replaced by the name field. + # Deprecated. The name of the cluster to upgrade. This field has been deprecated + # and replaced by the name field. # @param [Google::Apis::ContainerV1::SetMonitoringServiceRequest] set_monitoring_service_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -1883,17 +1836,16 @@ module Google # Sets labels on a cluster. # @param [String] project_id - # 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. + # 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. # @param [String] zone - # 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. + # 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 - # Deprecated. The name of the cluster. - # This field has been deprecated and replaced by the name field. + # Deprecated. The name of the cluster. This field has been deprecated and + # replaced by the name field. # @param [Google::Apis::ContainerV1::SetLabelsRequest] set_labels_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -1928,12 +1880,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::ContainerV1::SetMaintenancePolicyRequest] set_maintenance_policy_request_object @@ -1968,21 +1919,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 - # 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. + # 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. # @param [String] zone - # 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. + # 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 - # Deprecated. The name of the cluster to upgrade. - # This field has been deprecated and replaced by the name field. + # Deprecated. The name of the cluster to upgrade. This field has been deprecated + # and replaced by the name field. # @param [Google::Apis::ContainerV1::SetMasterAuthRequest] set_master_auth_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -2017,17 +1967,16 @@ module Google # Enables or disables Network Policy for a cluster. # @param [String] project_id - # 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. + # 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. # @param [String] zone - # 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. + # 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 - # Deprecated. The name of the cluster. - # This field has been deprecated and replaced by the name field. + # Deprecated. The name of the cluster. This field has been deprecated and + # replaced by the name field. # @param [Google::Apis::ContainerV1::SetNetworkPolicyRequest] set_network_policy_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -2062,17 +2011,16 @@ module Google # Starts master IP rotation. # @param [String] project_id - # 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. + # 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. # @param [String] zone - # 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. + # 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 - # Deprecated. The name of the cluster. - # This field has been deprecated and replaced by the name field. + # Deprecated. The name of the cluster. This field has been deprecated and + # replaced by the name field. # @param [Google::Apis::ContainerV1::StartIpRotationRequest] start_ip_rotation_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -2107,17 +2055,16 @@ module Google # Updates the settings of a specific cluster. # @param [String] project_id - # 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. + # 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. # @param [String] zone - # 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. + # 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 - # Deprecated. The name of the cluster to upgrade. - # This field has been deprecated and replaced by the name field. + # Deprecated. The name of the cluster to upgrade. This field has been deprecated + # and replaced by the name field. # @param [Google::Apis::ContainerV1::UpdateClusterRequest] update_cluster_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -2152,20 +2099,19 @@ module Google # Sets the autoscaling settings for the specified node pool. # @param [String] project_id - # 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. + # 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. # @param [String] zone - # 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. + # 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 - # Deprecated. The name of the cluster to upgrade. - # This field has been deprecated and replaced by the name field. + # Deprecated. The name of the cluster to upgrade. This field has been deprecated + # and replaced by the name field. # @param [String] node_pool_id - # Deprecated. The name of the node pool to upgrade. - # This field has been deprecated and replaced by the name field. + # Deprecated. The name of the node pool to upgrade. This field has been + # deprecated and replaced by the name field. # @param [Google::Apis::ContainerV1::SetNodePoolAutoscalingRequest] set_node_pool_autoscaling_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -2201,17 +2147,16 @@ module Google # Creates a node pool for a cluster. # @param [String] project_id - # 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. + # 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. # @param [String] zone - # 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. + # 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 - # Deprecated. The name of the cluster. - # This field has been deprecated and replaced by the parent field. + # Deprecated. The name of the cluster. This field has been deprecated and + # replaced by the parent field. # @param [Google::Apis::ContainerV1::CreateNodePoolRequest] create_node_pool_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -2246,24 +2191,22 @@ module Google # Deletes a node pool from a cluster. # @param [String] project_id - # 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. + # 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. # @param [String] zone - # 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. + # 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 - # Deprecated. The name of the cluster. - # This field has been deprecated and replaced by the name field. + # Deprecated. The name of the cluster. This field has been deprecated and + # replaced by the name field. # @param [String] node_pool_id - # Deprecated. The name of the node pool to delete. - # This field has been deprecated and replaced by the name field. + # 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 @@ -2297,24 +2240,22 @@ module Google # Retrieves the requested node pool. # @param [String] project_id - # 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. + # 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. # @param [String] zone - # 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. + # 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 - # Deprecated. The name of the cluster. - # This field has been deprecated and replaced by the name field. + # Deprecated. The name of the cluster. This field has been deprecated and + # replaced by the name field. # @param [String] node_pool_id - # Deprecated. The name of the node pool. - # This field has been deprecated and replaced by the name field. + # 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 @@ -2348,20 +2289,19 @@ module Google # Lists the node pools for a cluster. # @param [String] project_id - # 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. + # 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. # @param [String] zone - # 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. + # 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 - # Deprecated. The name of the cluster. - # This field has been deprecated and replaced by the parent field. + # 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 @@ -2392,23 +2332,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 - # 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. + # 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. # @param [String] zone - # 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. + # 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 - # Deprecated. The name of the cluster to rollback. - # This field has been deprecated and replaced by the name field. + # Deprecated. The name of the cluster to rollback. This field has been + # deprecated and replaced by the name field. # @param [String] node_pool_id - # Deprecated. The name of the node pool to rollback. - # This field has been deprecated and replaced by the name field. + # Deprecated. The name of the node pool to rollback. This field has been + # deprecated and replaced by the name field. # @param [Google::Apis::ContainerV1::RollbackNodePoolUpgradeRequest] rollback_node_pool_upgrade_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -2444,20 +2383,19 @@ module Google # Sets the NodeManagement options for a node pool. # @param [String] project_id - # 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. + # 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. # @param [String] zone - # 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. + # 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 - # Deprecated. The name of the cluster to update. - # This field has been deprecated and replaced by the name field. + # Deprecated. The name of the cluster to update. This field has been deprecated + # and replaced by the name field. # @param [String] node_pool_id - # Deprecated. The name of the node pool to update. - # This field has been deprecated and replaced by the name field. + # Deprecated. The name of the node pool to update. This field has been + # deprecated and replaced by the name field. # @param [Google::Apis::ContainerV1::SetNodePoolManagementRequest] set_node_pool_management_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -2493,20 +2431,19 @@ module Google # Sets the size for a specific node pool. # @param [String] project_id - # 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. + # 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. # @param [String] zone - # 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. + # 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 - # Deprecated. The name of the cluster to update. - # This field has been deprecated and replaced by the name field. + # Deprecated. The name of the cluster to update. This field has been deprecated + # and replaced by the name field. # @param [String] node_pool_id - # Deprecated. The name of the node pool to update. - # This field has been deprecated and replaced by the name field. + # Deprecated. The name of the node pool to update. This field has been + # deprecated and replaced by the name field. # @param [Google::Apis::ContainerV1::SetNodePoolSizeRequest] set_node_pool_size_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -2542,20 +2479,19 @@ module Google # Updates the version and/or image type for the specified node pool. # @param [String] project_id - # 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. + # 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. # @param [String] zone - # 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. + # 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 - # Deprecated. The name of the cluster to upgrade. - # This field has been deprecated and replaced by the name field. + # Deprecated. The name of the cluster to upgrade. This field has been deprecated + # and replaced by the name field. # @param [String] node_pool_id - # Deprecated. The name of the node pool to upgrade. - # This field has been deprecated and replaced by the name field. + # Deprecated. The name of the node pool to upgrade. This field has been + # deprecated and replaced by the name field. # @param [Google::Apis::ContainerV1::UpdateNodePoolRequest] update_node_pool_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -2591,17 +2527,16 @@ module Google # Cancels the specified operation. # @param [String] project_id - # 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. + # 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. # @param [String] zone - # 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. + # 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 - # Deprecated. The server-assigned `name` of the operation. - # This field has been deprecated and replaced by the name field. + # Deprecated. The server-assigned `name` of the operation. This field has been + # deprecated and replaced by the name field. # @param [Google::Apis::ContainerV1::CancelOperationRequest] cancel_operation_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -2636,20 +2571,19 @@ module Google # Gets the specified operation. # @param [String] project_id - # 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. + # 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. # @param [String] zone - # 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. + # 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 - # Deprecated. The server-assigned `name` of the operation. - # This field has been deprecated and replaced by the name field. + # 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 @@ -2682,18 +2616,17 @@ module Google # Lists all operations in a project in a specific zone or all zones. # @param [String] project_id - # 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. - # @param [String] zone - # 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 + # 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. + # @param [String] zone + # 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/dataflow_v1b3.rb b/generated/google/apis/dataflow_v1b3.rb index 88f581b1b..b6beea63d 100644 --- a/generated/google/apis/dataflow_v1b3.rb +++ b/generated/google/apis/dataflow_v1b3.rb @@ -25,7 +25,7 @@ module Google # @see https://cloud.google.com/dataflow module DataflowV1b3 VERSION = 'V1b3' - REVISION = '20200713' + 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/dataflow_v1b3/classes.rb b/generated/google/apis/dataflow_v1b3/classes.rb index 64136dc77..7f7f8186c 100644 --- a/generated/google/apis/dataflow_v1b3/classes.rb +++ b/generated/google/apis/dataflow_v1b3/classes.rb @@ -31,9 +31,9 @@ module Google # @return [Float] attr_accessor :percent_complete - # Position defines a position within a collection of data. The value - # can be either the end position, a key (used with ordered - # collections), a byte offset, or a record index. + # Position defines a position within a collection of data. The value can be + # either the end position, a key (used with ordered collections), a byte offset, + # or a record index. # Corresponds to the JSON property `position` # @return [Google::Apis::DataflowV1b3::Position] attr_accessor :position @@ -59,8 +59,8 @@ module Google class ApproximateReportedProgress include Google::Apis::Core::Hashable - # Represents the level of parallelism in a WorkItem's input, - # reported by the worker. + # Represents the level of parallelism in a WorkItem's input, reported by the + # worker. # Corresponds to the JSON property `consumedParallelism` # @return [Google::Apis::DataflowV1b3::ReportedParallelism] attr_accessor :consumed_parallelism @@ -71,15 +71,15 @@ module Google # @return [Float] attr_accessor :fraction_consumed - # Position defines a position within a collection of data. The value - # can be either the end position, a key (used with ordered - # collections), a byte offset, or a record index. + # Position defines a position within a collection of data. The value can be + # either the end position, a key (used with ordered collections), a byte offset, + # or a record index. # Corresponds to the JSON property `position` # @return [Google::Apis::DataflowV1b3::Position] attr_accessor :position - # Represents the level of parallelism in a WorkItem's input, - # reported by the worker. + # Represents the level of parallelism in a WorkItem's input, reported by the + # worker. # Corresponds to the JSON property `remainingParallelism` # @return [Google::Apis::DataflowV1b3::ReportedParallelism] attr_accessor :remaining_parallelism @@ -101,21 +101,21 @@ module Google class ApproximateSplitRequest include Google::Apis::Core::Hashable - # A fraction at which to split the work item, from 0.0 (beginning of the - # input) to 1.0 (end of the input). + # A fraction at which to split the work item, from 0.0 (beginning of the input) + # to 1.0 (end of the input). # Corresponds to the JSON property `fractionConsumed` # @return [Float] attr_accessor :fraction_consumed - # The fraction of the remainder of work to split the work item at, from 0.0 - # (split at the current position) to 1.0 (end of the input). + # The fraction of the remainder of work to split the work item at, from 0.0 ( + # split at the current position) to 1.0 (end of the input). # Corresponds to the JSON property `fractionOfRemainder` # @return [Float] attr_accessor :fraction_of_remainder - # Position defines a position within a collection of data. The value - # can be either the end position, a key (used with ordered - # collections), a byte offset, or a record index. + # Position defines a position within a collection of data. The value can be + # either the end position, a key (used with ordered collections), a byte offset, + # or a record index. # Corresponds to the JSON property `position` # @return [Google::Apis::DataflowV1b3::Position] attr_accessor :position @@ -196,8 +196,8 @@ module Google # @return [String] attr_accessor :time - # A short and friendly name for the worker pool this event refers to, - # populated from the value of PoolStageRelation::user_pool_name. + # A short and friendly name for the worker pool this event refers to, populated + # from the value of PoolStageRelation::user_pool_name. # Corresponds to the JSON property `workerPool` # @return [String] attr_accessor :worker_pool @@ -314,8 +314,7 @@ module Google class CpuTime include Google::Apis::Core::Hashable - # Average CPU utilization rate (% non-idle cpu / second) since previous - # sample. + # Average CPU utilization rate (% non-idle cpu / second) since previous sample. # Corresponds to the JSON property `rate` # @return [Float] attr_accessor :rate @@ -325,8 +324,8 @@ module Google # @return [String] attr_accessor :timestamp - # Total active CPU time across all cores (ie., non-idle) in milliseconds - # since start-up. + # Total active CPU time across all cores (ie., non-idle) in milliseconds since + # start-up. # Corresponds to the JSON property `totalMs` # @return [Fixnum] attr_accessor :total_ms @@ -347,15 +346,14 @@ module Google class CommitTemplateVersionRequest include Google::Apis::Core::Hashable - # ///////////////////////////////////////////////////////////////////////////// - # //// Template Catalog is used to organize user TemplateVersions. - # //// TemplateVersions that have the same project_id and display_name are - # //// belong to the same Template. - # //// Templates with the same project_id belong to the same Project. - # //// TemplateVersion may have labels and multiple labels are allowed. - # //// Duplicated labels in the same `TemplateVersion` are not allowed. - # //// TemplateVersion may have tags and multiple tags are allowed. Duplicated - # //// tags in the same `Template` are not allowed! + # ///////////////////////////////////////////////////////////////////////////// / + # /// Template Catalog is used to organize user TemplateVersions. //// + # TemplateVersions that have the same project_id and display_name are //// + # belong to the same Template. //// Templates with the same project_id belong to + # the same Project. //// TemplateVersion may have labels and multiple labels are + # allowed. //// Duplicated labels in the same `TemplateVersion` are not allowed. + # //// TemplateVersion may have tags and multiple tags are allowed. Duplicated // + # // tags in the same `Template` are not allowed! # Corresponds to the JSON property `templateVersion` # @return [Google::Apis::DataflowV1b3::TemplateVersion] attr_accessor :template_version @@ -370,8 +368,7 @@ module Google end end - # Description of an interstitial value between transforms in an execution - # stage. + # Description of an interstitial value between transforms in an execution stage. class ComponentSource include Google::Apis::Core::Hashable @@ -380,8 +377,8 @@ module Google # @return [String] attr_accessor :name - # User name for the original user transform or collection with which this - # source is most closely associated. + # User name for the original user transform or collection with which this source + # is most closely associated. # Corresponds to the JSON property `originalTransformOrCollection` # @return [String] attr_accessor :original_transform_or_collection @@ -412,8 +409,8 @@ module Google # @return [String] attr_accessor :name - # User name for the original user transform with which this transform is - # most closely associated. + # User name for the original user transform with which this transform is most + # closely associated. # Corresponds to the JSON property `originalTransform` # @return [String] attr_accessor :original_transform @@ -495,9 +492,9 @@ module Google # @return [Fixnum] attr_accessor :index - # Position defines a position within a collection of data. The value - # can be either the end position, a key (used with ordered - # collections), a byte offset, or a record index. + # Position defines a position within a collection of data. The value can be + # either the end position, a key (used with ordered collections), a byte offset, + # or a record index. # Corresponds to the JSON property `position` # @return [Google::Apis::DataflowV1b3::Position] attr_accessor :position @@ -596,19 +593,17 @@ module Google # @return [String] attr_accessor :execution_step_name - # Index of an input collection that's being read from/written to as a side - # input. - # The index identifies a step's side inputs starting by 1 (e.g. the first - # side input has input_index 1, the third has input_index 3). - # Side inputs are identified by a pair of (original_step_name, input_index). - # This field helps uniquely identify them. + # Index of an input collection that's being read from/written to as a side input. + # The index identifies a step's side inputs starting by 1 (e.g. the first side + # input has input_index 1, the third has input_index 3). Side inputs are + # identified by a pair of (original_step_name, input_index). This field helps + # uniquely identify them. # Corresponds to the JSON property `inputIndex` # @return [Fixnum] attr_accessor :input_index - # Counter name. Not necessarily globally-unique, but unique within the - # context of the other fields. - # Required. + # Counter name. Not necessarily globally-unique, but unique within the context + # of the other fields. Required. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name @@ -623,9 +618,8 @@ module Google # @return [String] attr_accessor :origin_namespace - # The step name requesting an operation, such as GBK. - # I.e. the ParDo causing a read/write from shuffle to occur, or a - # read from side inputs. + # The step name requesting an operation, such as GBK. I.e. the ParDo causing a + # read/write from shuffle to occur, or a read from side inputs. # Corresponds to the JSON property `originalRequestingStepName` # @return [String] attr_accessor :original_requesting_step_name @@ -702,10 +696,9 @@ module Google attr_accessor :boolean alias_method :boolean?, :boolean - # True if this counter is reported as the total cumulative aggregate - # value accumulated since the worker started working on this WorkItem. - # By default this is false, indicating that this counter is reported - # as a delta. + # True if this counter is reported as the total cumulative aggregate value + # accumulated since the worker started working on this WorkItem. By default this + # is false, indicating that this counter is reported as a delta. # Corresponds to the JSON property `cumulative` # @return [Boolean] attr_accessor :cumulative @@ -731,8 +724,8 @@ module Google # @return [Google::Apis::DataflowV1b3::FloatingPointMean] attr_accessor :floating_point_mean - # A representation of an int64, n, that is immune to precision loss when - # encoded in JSON. + # A representation of an int64, n, that is immune to precision loss when encoded + # in JSON. # Corresponds to the JSON property `integer` # @return [Google::Apis::DataflowV1b3::SplitInt64] attr_accessor :integer @@ -762,9 +755,8 @@ module Google # @return [Google::Apis::DataflowV1b3::NameAndKind] attr_accessor :name_and_kind - # The service-generated short identifier for this counter. - # The short_id -> (name, metadata) mapping is constant for the lifetime of - # a job. + # The service-generated short identifier for this counter. The short_id -> (name, + # metadata) mapping is constant for the lifetime of a job. # Corresponds to the JSON property `shortId` # @return [Fixnum] attr_accessor :short_id @@ -813,8 +805,7 @@ module Google # @return [Google::Apis::DataflowV1b3::RuntimeEnvironment] attr_accessor :environment - # Required. A Cloud Storage path to the template from which to - # create the job. + # Required. A Cloud Storage path to the template from which to create the job. # Must be a valid Cloud Storage URL, beginning with `gs://`. # Corresponds to the JSON property `gcsPath` # @return [String] @@ -825,9 +816,8 @@ module Google # @return [String] attr_accessor :job_name - # The [regional endpoint] - # (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) to - # which to direct the request. + # The [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/ + # regional-endpoints) to which to direct the request. # Corresponds to the JSON property `location` # @return [String] attr_accessor :location @@ -855,15 +845,14 @@ module Google class CreateTemplateVersionRequest include Google::Apis::Core::Hashable - # ///////////////////////////////////////////////////////////////////////////// - # //// Template Catalog is used to organize user TemplateVersions. - # //// TemplateVersions that have the same project_id and display_name are - # //// belong to the same Template. - # //// Templates with the same project_id belong to the same Project. - # //// TemplateVersion may have labels and multiple labels are allowed. - # //// Duplicated labels in the same `TemplateVersion` are not allowed. - # //// TemplateVersion may have tags and multiple tags are allowed. Duplicated - # //// tags in the same `Template` are not allowed! + # ///////////////////////////////////////////////////////////////////////////// / + # /// Template Catalog is used to organize user TemplateVersions. //// + # TemplateVersions that have the same project_id and display_name are //// + # belong to the same Template. //// Templates with the same project_id belong to + # the same Project. //// TemplateVersion may have labels and multiple labels are + # allowed. //// Duplicated labels in the same `TemplateVersion` are not allowed. + # //// TemplateVersion may have tags and multiple tags are allowed. Duplicated // + # // tags in the same `Template` are not allowed! # Corresponds to the JSON property `templateVersion` # @return [Google::Apis::DataflowV1b3::TemplateVersion] attr_accessor :template_version @@ -902,16 +891,16 @@ module Google class DataDiskAssignment include Google::Apis::Core::Hashable - # Mounted data disks. The order is important a data disk's 0-based index in - # this list defines which persistent directory the disk is mounted to, for - # example the list of ` "myproject-1014-104817-4c2-harness-0-disk-0" `, - # ` "myproject-1014-104817-4c2-harness-0-disk-1" `. + # Mounted data disks. The order is important a data disk's 0-based index in this + # list defines which persistent directory the disk is mounted to, for example + # the list of ` "myproject-1014-104817-4c2-harness-0-disk-0" `, ` "myproject- + # 1014-104817-4c2-harness-0-disk-1" `. # Corresponds to the JSON property `dataDisks` # @return [Array] attr_accessor :data_disks - # VM instance name the data disks mounted to, for example - # "myproject-1014-104817-4c2-harness-0". + # VM instance name the data disks mounted to, for example "myproject-1014-104817- + # 4c2-harness-0". # Corresponds to the JSON property `vmInstance` # @return [String] attr_accessor :vm_instance @@ -965,10 +954,9 @@ module Google end end - # Specification of one of the bundles produced as a result of splitting - # a Source (e.g. when executing a SourceSplitRequest, or when - # splitting an active task using WorkItemStatus.dynamic_source_split), - # relative to the source being split. + # Specification of one of the bundles produced as a result of splitting a Source + # (e.g. when executing a SourceSplitRequest, or when splitting an active task + # using WorkItemStatus.dynamic_source_split), relative to the source being split. class DerivedSource include Google::Apis::Core::Hashable @@ -997,20 +985,17 @@ module Google class Disk include Google::Apis::Core::Hashable - # Disk storage type, as defined by Google Compute Engine. This - # must be a disk type appropriate to the project and zone in which - # the workers will run. If unknown or unspecified, the service - # will attempt to choose a reasonable default. - # For example, the standard persistent disk type is a resource name - # typically ending in "pd-standard". If SSD persistent disks are - # available, the resource name typically ends with "pd-ssd". The - # actual valid values are defined the Google Compute Engine API, - # not by the Cloud Dataflow API; consult the Google Compute Engine - # documentation for more information about determining the set of - # available disk types for a particular project and zone. - # Google Compute Engine Disk types are local to a particular - # project in a particular zone, and so the resource name will - # typically look something like this: + # Disk storage type, as defined by Google Compute Engine. This must be a disk + # type appropriate to the project and zone in which the workers will run. If + # unknown or unspecified, the service will attempt to choose a reasonable + # default. For example, the standard persistent disk type is a resource name + # typically ending in "pd-standard". If SSD persistent disks are available, the + # resource name typically ends with "pd-ssd". The actual valid values are + # defined the Google Compute Engine API, not by the Cloud Dataflow API; consult + # the Google Compute Engine documentation for more information about determining + # the set of available disk types for a particular project and zone. Google + # Compute Engine Disk types are local to a particular project in a particular + # zone, and so the resource name will typically look something like this: # compute.googleapis.com/projects/project-id/zones/zone/diskTypes/pd-standard # Corresponds to the JSON property `diskType` # @return [String] @@ -1021,8 +1006,8 @@ module Google # @return [String] attr_accessor :mount_point - # Size of disk in GB. If zero or unspecified, the service will - # attempt to choose a reasonable default. + # Size of disk in GB. If zero or unspecified, the service will attempt to choose + # a reasonable default. # Corresponds to the JSON property `sizeGb` # @return [Fixnum] attr_accessor :size_gb @@ -1069,9 +1054,8 @@ module Google # @return [String] attr_accessor :java_class_value - # The key identifying the display data. - # This is intended to be used as a label for the display data - # when viewed in a dax monitoring system. + # The key identifying the display data. This is intended to be used as a label + # for the display data when viewed in a dax monitoring system. # Corresponds to the JSON property `key` # @return [String] attr_accessor :key @@ -1082,19 +1066,18 @@ module Google attr_accessor :label # The namespace for the key. This is usually a class name or programming - # language namespace (i.e. python module) which defines the display data. - # This allows a dax monitoring system to specially handle the data - # and perform custom rendering. + # language namespace (i.e. python module) which defines the display data. This + # allows a dax monitoring system to specially handle the data and perform custom + # rendering. # Corresponds to the JSON property `namespace` # @return [String] attr_accessor :namespace - # A possible additional shorter value to display. - # For example a java_class_name_value of com.mypackage.MyDoFn - # will be stored with MyDoFn as the short_str_value and - # com.mypackage.MyDoFn as the java_class_name value. - # short_str_value can be displayed and java_class_name_value - # will be displayed as a tooltip. + # A possible additional shorter value to display. For example a + # java_class_name_value of com.mypackage.MyDoFn will be stored with MyDoFn as + # the short_str_value and com.mypackage.MyDoFn as the java_class_name value. + # short_str_value can be displayed and java_class_name_value will be displayed + # as a tooltip. # Corresponds to the JSON property `shortStrValue` # @return [String] attr_accessor :short_str_value @@ -1139,36 +1122,35 @@ module Google class DistributionUpdate include Google::Apis::Core::Hashable - # A representation of an int64, n, that is immune to precision loss when - # encoded in JSON. + # A representation of an int64, n, that is immune to precision loss when encoded + # in JSON. # Corresponds to the JSON property `count` # @return [Google::Apis::DataflowV1b3::SplitInt64] attr_accessor :count - # Histogram of value counts for a distribution. - # Buckets have an inclusive lower bound and exclusive upper bound and use - # "1,2,5 bucketing": The first bucket range is from [0,1) and all subsequent - # bucket boundaries are powers of ten multiplied by 1, 2, or 5. Thus, bucket - # boundaries are 0, 1, 2, 5, 10, 20, 50, 100, 200, 500, 1000, ... - # Negative values are not supported. + # Histogram of value counts for a distribution. Buckets have an inclusive lower + # bound and exclusive upper bound and use "1,2,5 bucketing": The first bucket + # range is from [0,1) and all subsequent bucket boundaries are powers of ten + # multiplied by 1, 2, or 5. Thus, bucket boundaries are 0, 1, 2, 5, 10, 20, 50, + # 100, 200, 500, 1000, ... Negative values are not supported. # Corresponds to the JSON property `histogram` # @return [Google::Apis::DataflowV1b3::Histogram] attr_accessor :histogram - # A representation of an int64, n, that is immune to precision loss when - # encoded in JSON. + # A representation of an int64, n, that is immune to precision loss when encoded + # in JSON. # Corresponds to the JSON property `max` # @return [Google::Apis::DataflowV1b3::SplitInt64] attr_accessor :max - # A representation of an int64, n, that is immune to precision loss when - # encoded in JSON. + # A representation of an int64, n, that is immune to precision loss when encoded + # in JSON. # Corresponds to the JSON property `min` # @return [Google::Apis::DataflowV1b3::SplitInt64] attr_accessor :min - # A representation of an int64, n, that is immune to precision loss when - # encoded in JSON. + # A representation of an int64, n, that is immune to precision loss when encoded + # in JSON. # Corresponds to the JSON property `sum` # @return [Google::Apis::DataflowV1b3::SplitInt64] attr_accessor :sum @@ -1193,24 +1175,22 @@ module Google end end - # When a task splits using WorkItemStatus.dynamic_source_split, this - # message describes the two parts of the split relative to the - # description of the current task's input. + # When a task splits using WorkItemStatus.dynamic_source_split, this message + # describes the two parts of the split relative to the description of the + # current task's input. class DynamicSourceSplit include Google::Apis::Core::Hashable - # Specification of one of the bundles produced as a result of splitting - # a Source (e.g. when executing a SourceSplitRequest, or when - # splitting an active task using WorkItemStatus.dynamic_source_split), - # relative to the source being split. + # Specification of one of the bundles produced as a result of splitting a Source + # (e.g. when executing a SourceSplitRequest, or when splitting an active task + # using WorkItemStatus.dynamic_source_split), relative to the source being split. # Corresponds to the JSON property `primary` # @return [Google::Apis::DataflowV1b3::DerivedSource] attr_accessor :primary - # Specification of one of the bundles produced as a result of splitting - # a Source (e.g. when executing a SourceSplitRequest, or when - # splitting an active task using WorkItemStatus.dynamic_source_split), - # relative to the source being split. + # Specification of one of the bundles produced as a result of splitting a Source + # (e.g. when executing a SourceSplitRequest, or when splitting an active task + # using WorkItemStatus.dynamic_source_split), relative to the source being split. # Corresponds to the JSON property `residual` # @return [Google::Apis::DataflowV1b3::DerivedSource] attr_accessor :residual @@ -1226,13 +1206,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 @@ -1249,19 +1227,16 @@ module Google class Environment include Google::Apis::Core::Hashable - # The type of cluster manager API to use. If unknown or - # unspecified, the service will attempt to choose a reasonable - # default. This should be in the form of the API service name, - # e.g. "compute.googleapis.com". + # The type of cluster manager API to use. If unknown or unspecified, the service + # will attempt to choose a reasonable default. This should be in the form of the + # API service name, e.g. "compute.googleapis.com". # Corresponds to the JSON property `clusterManagerApiService` # @return [String] attr_accessor :cluster_manager_api_service - # The dataset for the current project where various workflow - # related tables are stored. - # The supported resource type is: - # Google BigQuery: - # bigquery.googleapis.com/`dataset` + # The dataset for the current project where various workflow related tables are + # stored. The supported resource type is: Google BigQuery: bigquery.googleapis. + # com/`dataset` # Corresponds to the JSON property `dataset` # @return [String] attr_accessor :dataset @@ -1281,10 +1256,9 @@ module Google # @return [Hash] attr_accessor :internal_experiments - # The Cloud Dataflow SDK pipeline options specified by the user. These - # options are passed through the service and are used to recreate the - # SDK pipeline options on the worker in a language agnostic and platform - # independent way. + # The Cloud Dataflow SDK pipeline options specified by the user. These options + # are passed through the service and are used to recreate the SDK pipeline + # options on the worker in a language agnostic and platform independent way. # Corresponds to the JSON property `sdkPipelineOptions` # @return [Hash] attr_accessor :sdk_pipeline_options @@ -1294,25 +1268,20 @@ module Google # @return [String] attr_accessor :service_account_email - # If set, contains the Cloud KMS key identifier used to encrypt data - # at rest, AKA a Customer Managed Encryption Key (CMEK). - # Format: - # projects/PROJECT_ID/locations/LOCATION/keyRings/KEY_RING/cryptoKeys/KEY + # If set, contains the Cloud KMS key identifier used to encrypt data at rest, + # AKA a Customer Managed Encryption Key (CMEK). Format: projects/PROJECT_ID/ + # locations/LOCATION/keyRings/KEY_RING/cryptoKeys/KEY # Corresponds to the JSON property `serviceKmsKeyName` # @return [String] attr_accessor :service_kms_key_name - # The prefix of the resources the system should use for temporary - # storage. The system will append the suffix "/temp-`JOBNAME` to - # this resource prefix, where `JOBNAME` is the value of the - # job_name field. The resulting bucket and object prefix is used - # as the prefix of the resources used to store temporary data - # needed during the job execution. NOTE: This will override the - # value in taskrunner_settings. - # The supported resource type is: - # Google Cloud Storage: - # storage.googleapis.com/`bucket`/`object` - # bucket.storage.googleapis.com/`object` + # The prefix of the resources the system should use for temporary storage. The + # system will append the suffix "/temp-`JOBNAME` to this resource prefix, where ` + # JOBNAME` is the value of the job_name field. The resulting bucket and object + # prefix is used as the prefix of the resources used to store temporary data + # needed during the job execution. NOTE: This will override the value in + # taskrunner_settings. The supported resource type is: Google Cloud Storage: + # storage.googleapis.com/`bucket`/`object` bucket.storage.googleapis.com/`object` # Corresponds to the JSON property `tempStoragePrefix` # @return [String] attr_accessor :temp_storage_prefix @@ -1322,32 +1291,31 @@ module Google # @return [Hash] attr_accessor :user_agent - # A structure describing which components and their versions of the service - # are required in order to run the job. + # A structure describing which components and their versions of the service are + # required in order to run the job. # Corresponds to the JSON property `version` # @return [Hash] attr_accessor :version - # The worker pools. At least one "harness" worker pool must be - # specified in order for the job to have workers. + # The worker pools. At least one "harness" worker pool must be specified in + # order for the job to have workers. # Corresponds to the JSON property `workerPools` # @return [Array] attr_accessor :worker_pools - # The Compute Engine region - # (https://cloud.google.com/compute/docs/regions-zones/regions-zones) in - # which worker processing should occur, e.g. "us-west1". Mutually exclusive - # with worker_zone. If neither worker_region nor worker_zone is specified, - # default to the control plane's region. + # The Compute Engine region (https://cloud.google.com/compute/docs/regions-zones/ + # regions-zones) in which worker processing should occur, e.g. "us-west1". + # Mutually exclusive with worker_zone. If neither worker_region nor worker_zone + # is specified, default to the control plane's region. # Corresponds to the JSON property `workerRegion` # @return [String] attr_accessor :worker_region - # The Compute Engine zone - # (https://cloud.google.com/compute/docs/regions-zones/regions-zones) in - # which worker processing should occur, e.g. "us-west1-a". Mutually exclusive - # with worker_region. If neither worker_region nor worker_zone is specified, - # a zone in the control plane's region is chosen based on available capacity. + # The Compute Engine zone (https://cloud.google.com/compute/docs/regions-zones/ + # regions-zones) in which worker processing should occur, e.g. "us-west1-a". + # Mutually exclusive with worker_region. If neither worker_region nor + # worker_zone is specified, a zone in the control plane's region is chosen based + # on available capacity. # Corresponds to the JSON property `workerZone` # @return [String] attr_accessor :worker_zone @@ -1407,7 +1375,7 @@ module Google end # Description of the composing transforms, names/ids, and input/outputs of a - # stage of execution. Some composing transforms and sources may have been + # stage of execution. Some composing transforms and sources may have been # generated by the Dataflow service during execution planning. class ExecutionStageSummary include Google::Apis::Core::Hashable @@ -1463,15 +1431,13 @@ module Google end end - # Indicates which [regional endpoint] - # (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) failed - # to respond to a request for data. + # Indicates which [regional endpoint] (https://cloud.google.com/dataflow/docs/ + # concepts/regional-endpoints) failed to respond to a request for data. class FailedLocation include Google::Apis::Core::Hashable - # The name of the [regional endpoint] - # (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) that - # failed to respond. + # The name of the [regional endpoint] (https://cloud.google.com/dataflow/docs/ + # concepts/regional-endpoints) that failed to respond. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name @@ -1547,8 +1513,8 @@ module Google class FloatingPointMean include Google::Apis::Core::Hashable - # A representation of an int64, n, that is immune to precision loss when - # encoded in JSON. + # A representation of an int64, n, that is immune to precision loss when encoded + # in JSON. # Corresponds to the JSON property `count` # @return [Google::Apis::DataflowV1b3::SplitInt64] attr_accessor :count @@ -1573,15 +1539,13 @@ module Google class GetDebugConfigRequest include Google::Apis::Core::Hashable - # The internal component id for which debug configuration is - # requested. + # The internal component id for which debug configuration is requested. # Corresponds to the JSON property `componentId` # @return [String] attr_accessor :component_id - # The [regional endpoint] - # (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) that - # contains the job specified by job_id. + # The [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/ + # regional-endpoints) that contains the job specified by job_id. # Corresponds to the JSON property `location` # @return [String] attr_accessor :location @@ -1636,12 +1600,12 @@ module Google # @return [Google::Apis::DataflowV1b3::RuntimeMetadata] attr_accessor :runtime_metadata - # 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::DataflowV1b3::Status] attr_accessor :status @@ -1664,26 +1628,25 @@ module Google end end - # Histogram of value counts for a distribution. - # Buckets have an inclusive lower bound and exclusive upper bound and use - # "1,2,5 bucketing": The first bucket range is from [0,1) and all subsequent - # bucket boundaries are powers of ten multiplied by 1, 2, or 5. Thus, bucket - # boundaries are 0, 1, 2, 5, 10, 20, 50, 100, 200, 500, 1000, ... - # Negative values are not supported. + # Histogram of value counts for a distribution. Buckets have an inclusive lower + # bound and exclusive upper bound and use "1,2,5 bucketing": The first bucket + # range is from [0,1) and all subsequent bucket boundaries are powers of ten + # multiplied by 1, 2, or 5. Thus, bucket boundaries are 0, 1, 2, 5, 10, 20, 50, + # 100, 200, 500, 1000, ... Negative values are not supported. class Histogram include Google::Apis::Core::Hashable - # Counts of values in each bucket. For efficiency, prefix and trailing - # buckets with count = 0 are elided. Buckets can store the full range of - # values of an unsigned long, with ULLONG_MAX falling into the 59th bucket - # with range [1e19, 2e19). + # Counts of values in each bucket. For efficiency, prefix and trailing buckets + # with count = 0 are elided. Buckets can store the full range of values of an + # unsigned long, with ULLONG_MAX falling into the 59th bucket with range [1e19, + # 2e19). # Corresponds to the JSON property `bucketCounts` # @return [Array] attr_accessor :bucket_counts - # Starting index of first stored bucket. The non-inclusive upper-bound of - # the ith bucket is given by: - # pow(10,(i-first_bucket_offset)/3) * (1,2,5)[(i-first_bucket_offset)%3] + # Starting index of first stored bucket. The non-inclusive upper-bound of the + # ith bucket is given by: pow(10,(i-first_bucket_offset)/3) * (1,2,5)[(i- + # first_bucket_offset)%3] # Corresponds to the JSON property `firstBucketOffset` # @return [Fixnum] attr_accessor :first_bucket_offset @@ -1708,8 +1671,8 @@ module Google # @return [String] attr_accessor :hot_key_age - # System-defined name of the step containing this hot key. - # Unique across the workflow. + # System-defined name of the step containing this hot key. Unique across the + # workflow. # Corresponds to the JSON property `systemName` # @return [String] attr_accessor :system_name @@ -1731,8 +1694,8 @@ module Google end end - # An input of an instruction, as a reference to an output of a - # producer instruction. + # An input of an instruction, as a reference to an output of a producer + # instruction. class InstructionInput include Google::Apis::Core::Hashable @@ -1741,10 +1704,9 @@ module Google # @return [Fixnum] attr_accessor :output_num - # The index (origin zero) of the parallel instruction that produces - # the output to be consumed by this input. This index is relative - # to the list of instructions in this input's instruction's - # containing MapTask. + # The index (origin zero) of the parallel instruction that produces the output + # to be consumed by this input. This index is relative to the list of + # instructions in this input's instruction's containing MapTask. # Corresponds to the JSON property `producerInstructionIndex` # @return [Fixnum] attr_accessor :producer_instruction_index @@ -1774,28 +1736,27 @@ module Google # @return [String] attr_accessor :name - # For system-generated byte and mean byte metrics, certain instructions - # should only report the key size. + # For system-generated byte and mean byte metrics, certain instructions should + # only report the key size. # Corresponds to the JSON property `onlyCountKeyBytes` # @return [Boolean] attr_accessor :only_count_key_bytes alias_method :only_count_key_bytes?, :only_count_key_bytes - # For system-generated byte and mean byte metrics, certain instructions - # should only report the value size. + # For system-generated byte and mean byte metrics, certain instructions should + # only report the value size. # Corresponds to the JSON property `onlyCountValueBytes` # @return [Boolean] attr_accessor :only_count_value_bytes alias_method :only_count_value_bytes?, :only_count_value_bytes - # System-defined name for this output in the original workflow graph. - # Outputs that do not contribute to an original instruction do not set this. + # System-defined name for this output in the original workflow graph. Outputs + # that do not contribute to an original instruction do not set this. # Corresponds to the JSON property `originalName` # @return [String] attr_accessor :original_name - # System-defined name of this output. - # Unique across the workflow. + # System-defined name of this output. Unique across the workflow. # Corresponds to the JSON property `systemName` # @return [String] attr_accessor :system_name @@ -1824,8 +1785,8 @@ module Google # @return [String] attr_accessor :timestamp - # A representation of an int64, n, that is immune to precision loss when - # encoded in JSON. + # A representation of an int64, n, that is immune to precision loss when encoded + # in JSON. # Corresponds to the JSON property `value` # @return [Google::Apis::DataflowV1b3::SplitInt64] attr_accessor :value @@ -1864,14 +1825,14 @@ module Google class IntegerMean include Google::Apis::Core::Hashable - # A representation of an int64, n, that is immune to precision loss when - # encoded in JSON. + # A representation of an int64, n, that is immune to precision loss when encoded + # in JSON. # Corresponds to the JSON property `count` # @return [Google::Apis::DataflowV1b3::SplitInt64] attr_accessor :count - # A representation of an int64, n, that is immune to precision loss when - # encoded in JSON. + # A representation of an int64, n, that is immune to precision loss when encoded + # in JSON. # Corresponds to the JSON property `sum` # @return [Google::Apis::DataflowV1b3::SplitInt64] attr_accessor :sum @@ -1891,13 +1852,12 @@ module Google class Job include Google::Apis::Core::Hashable - # The client's unique identifier of the job, re-used across retried attempts. - # If this field is set, the service will ensure its uniqueness. - # The request to create a job will fail if the service has knowledge of a - # previously submitted job with the same client's ID and job name. - # The caller may use this field to ensure idempotence of job - # creation across retried attempts to create a job. - # By default, the field is empty and, in that case, the service ignores it. + # The client's unique identifier of the job, re-used across retried attempts. If + # this field is set, the service will ensure its uniqueness. The request to + # create a job will fail if the service has knowledge of a previously submitted + # job with the same client's ID and job name. The caller may use this field to + # ensure idempotence of job creation across retried attempts to create a job. By + # default, the field is empty and, in that case, the service ignores it. # Corresponds to the JSON property `clientRequestId` # @return [String] attr_accessor :client_request_id @@ -1914,14 +1874,11 @@ module Google # @return [String] attr_accessor :created_from_snapshot_id - # The current state of the job. - # Jobs are created in the `JOB_STATE_STOPPED` state unless otherwise - # specified. - # A job in the `JOB_STATE_RUNNING` state may asynchronously enter a - # terminal state. After a job has reached a terminal state, no - # further state updates may be made. - # This field may be mutated by the Cloud Dataflow service; - # callers cannot mutate it. + # The current state of the job. Jobs are created in the `JOB_STATE_STOPPED` + # state unless otherwise specified. A job in the `JOB_STATE_RUNNING` state may + # asynchronously enter a terminal state. After a job has reached a terminal + # state, no further state updates may be made. This field may be mutated by the + # Cloud Dataflow service; callers cannot mutate it. # Corresponds to the JSON property `currentState` # @return [String] attr_accessor :current_state @@ -1942,9 +1899,8 @@ module Google # @return [Google::Apis::DataflowV1b3::JobExecutionInfo] attr_accessor :execution_info - # The unique ID of this job. - # This field is set by the Cloud Dataflow service when the Job is - # created, and is immutable for the life of the job. + # The unique ID of this job. This field is set by the Cloud Dataflow service + # when the Job is created, and is immutable for the life of the job. # Corresponds to the JSON property `id` # @return [String] attr_accessor :id @@ -1955,37 +1911,32 @@ module Google # @return [Google::Apis::DataflowV1b3::JobMetadata] attr_accessor :job_metadata - # User-defined labels for this job. - # The labels map can contain no more than 64 entries. Entries of the labels - # map are UTF8 strings that comply with the following restrictions: - # * Keys must conform to regexp: \p`Ll`\p`Lo``0,62` - # * Values must conform to regexp: [\p`Ll`\p`Lo`\p`N`_-]`0,63` - # * Both keys and values are additionally constrained to be <= 128 bytes in - # size. + # User-defined labels for this job. The labels map can contain no more than 64 + # entries. Entries of the labels map are UTF8 strings that comply with the + # following restrictions: * Keys must conform to regexp: \p`Ll`\p`Lo``0,62` * + # Values must conform to regexp: [\p`Ll`\p`Lo`\p`N`_-]`0,63` * Both keys and + # values are additionally constrained to be <= 128 bytes in size. # Corresponds to the JSON property `labels` # @return [Hash] attr_accessor :labels - # The [regional endpoint] - # (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) that - # contains this job. + # The [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/ + # regional-endpoints) that contains this job. # Corresponds to the JSON property `location` # @return [String] attr_accessor :location - # The user-specified Cloud Dataflow job name. - # Only one Job with a given name may exist in a project at any - # given time. If a caller attempts to create a Job with the same - # name as an already-existing Job, the attempt returns the - # existing Job. - # The name must match the regular expression - # `[a-z]([-a-z0-9]`0,38`[a-z0-9])?` + # The user-specified Cloud Dataflow job name. Only one Job with a given name may + # exist in a project at any given time. If a caller attempts to create a Job + # with the same name as an already-existing Job, the attempt returns the + # existing Job. The name must match the regular expression `[a-z]([-a-z0-9]`0,38` + # [a-z0-9])?` # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # A descriptive representation of submitted pipeline as well as the executed - # form. This data is provided by the Dataflow service for ease of visualizing + # form. This data is provided by the Dataflow service for ease of visualizing # the pipeline and interpreting Dataflow provided metrics. # Corresponds to the JSON property `pipelineDescription` # @return [Google::Apis::DataflowV1b3::PipelineDescription] @@ -1996,50 +1947,46 @@ module Google # @return [String] attr_accessor :project_id - # If this job is an update of an existing job, this field is the job ID - # of the job it replaced. - # When sending a `CreateJobRequest`, you can update a job by specifying it - # here. The job named here is stopped, and its intermediate state is - # transferred to this job. + # If this job is an update of an existing job, this field is the job ID of the + # job it replaced. When sending a `CreateJobRequest`, you can update a job by + # specifying it here. The job named here is stopped, and its intermediate state + # is transferred to this job. # Corresponds to the JSON property `replaceJobId` # @return [String] attr_accessor :replace_job_id - # If another job is an update of this job (and thus, this job is in - # `JOB_STATE_UPDATED`), this field contains the ID of that job. + # If another job is an update of this job (and thus, this job is in ` + # JOB_STATE_UPDATED`), this field contains the ID of that job. # Corresponds to the JSON property `replacedByJobId` # @return [String] attr_accessor :replaced_by_job_id - # The job's requested state. - # `UpdateJob` may be used to switch between the `JOB_STATE_STOPPED` and - # `JOB_STATE_RUNNING` states, by setting requested_state. `UpdateJob` may - # also be used to directly set a job's requested state to - # `JOB_STATE_CANCELLED` or `JOB_STATE_DONE`, irrevocably terminating the - # job if it has not already reached a terminal state. + # The job's requested state. `UpdateJob` may be used to switch between the ` + # JOB_STATE_STOPPED` and `JOB_STATE_RUNNING` states, by setting requested_state. + # `UpdateJob` may also be used to directly set a job's requested state to ` + # JOB_STATE_CANCELLED` or `JOB_STATE_DONE`, irrevocably terminating the job if + # it has not already reached a terminal state. # Corresponds to the JSON property `requestedState` # @return [String] attr_accessor :requested_state - # This field may be mutated by the Cloud Dataflow service; - # callers cannot mutate it. + # This field may be mutated by the Cloud Dataflow service; callers cannot mutate + # it. # Corresponds to the JSON property `stageStates` # @return [Array] attr_accessor :stage_states # The timestamp when the job was started (transitioned to JOB_STATE_PENDING). # Flexible resource scheduling jobs are started with some delay after job - # creation, so start_time is unset before start and is updated when the - # job is started by the Cloud Dataflow service. For other jobs, start_time - # always equals to create_time and is immutable and set by the Cloud Dataflow - # service. + # creation, so start_time is unset before start and is updated when the job is + # started by the Cloud Dataflow service. For other jobs, start_time always + # equals to create_time and is immutable and set by the Cloud Dataflow service. # Corresponds to the JSON property `startTime` # @return [String] attr_accessor :start_time - # Exactly one of step or steps_location should be specified. - # The top-level steps that constitute the entire job. Only retrieved with - # JOB_VIEW_ALL. + # Exactly one of step or steps_location should be specified. The top-level steps + # that constitute the entire job. Only retrieved with JOB_VIEW_ALL. # Corresponds to the JSON property `steps` # @return [Array] attr_accessor :steps @@ -2049,15 +1996,11 @@ module Google # @return [String] attr_accessor :steps_location - # A set of files the system should be aware of that are used - # for temporary storage. These temporary files will be - # removed on job completion. - # No duplicates are allowed. - # No file patterns are supported. - # The supported files are: - # Google Cloud Storage: - # storage.googleapis.com/`bucket`/`object` - # bucket.storage.googleapis.com/`object` + # A set of files the system should be aware of that are used for temporary + # storage. These temporary files will be removed on job completion. No + # duplicates are allowed. No file patterns are supported. The supported files + # are: Google Cloud Storage: storage.googleapis.com/`bucket`/`object` bucket. + # storage.googleapis.com/`object` # Corresponds to the JSON property `tempFiles` # @return [Array] attr_accessor :temp_files @@ -2106,6 +2049,25 @@ module Google end end + # Information about the execution of a job. + class JobExecutionDetails + include Google::Apis::Core::Hashable + + # The stages of the job execution. + # Corresponds to the JSON property `stages` + # @return [Array] + attr_accessor :stages + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @stages = args[:stages] if args.key?(:stages) + end + end + # Additional information about how a Cloud Dataflow job will be executed that # isn't contained in the submitted job. class JobExecutionInfo @@ -2126,14 +2088,13 @@ module Google end end - # Contains information about how a particular - # google.dataflow.v1beta3.Step will be executed. + # Contains information about how a particular google.dataflow.v1beta3.Step will + # be executed. class JobExecutionStageInfo include Google::Apis::Core::Hashable - # The steps associated with the execution stage. - # Note that stages may have several steps, and that a given step - # might be run by more than one stage. + # The steps associated with the execution stage. Note that stages may have + # several steps, and that a given step might be run by more than one stage. # Corresponds to the JSON property `stepName` # @return [Array] attr_accessor :step_name @@ -2243,9 +2204,8 @@ module Google # JobMetrics contains a collection of metrics describing the detailed progress # of a Dataflow job. Metrics correspond to user-defined and system-defined - # metrics in the job. - # This resource captures only the most recent values of each metric; - # time-series data can be queried for them (under the same metric names) + # metrics in the job. This resource captures only the most recent values of each + # metric; time-series data can be queried for them (under the same metric names) # from Cloud Monitoring. class JobMetrics include Google::Apis::Core::Hashable @@ -2272,16 +2232,14 @@ module Google end # Data disk assignment information for a specific key-range of a sharded - # computation. - # Currently we only support UTF-8 character splits to simplify encoding into - # JSON. + # computation. Currently we only support UTF-8 character splits to simplify + # encoding into JSON. class KeyRangeDataDiskAssignment include Google::Apis::Core::Hashable - # The name of the data disk where data for this range is stored. - # This name is local to the Google Cloud Platform project and uniquely - # identifies the disk within that project, for example - # "myproject-1014-104817-4c2-harness-0-disk-1". + # The name of the data disk where data for this range is stored. This name is + # local to the Google Cloud Platform project and uniquely identifies the disk + # within that project, for example "myproject-1014-104817-4c2-harness-0-disk-1". # Corresponds to the JSON property `dataDisk` # @return [String] attr_accessor :data_disk @@ -2314,16 +2272,15 @@ module Google class KeyRangeLocation include Google::Apis::Core::Hashable - # The name of the data disk where data for this range is stored. - # This name is local to the Google Cloud Platform project and uniquely - # identifies the disk within that project, for example - # "myproject-1014-104817-4c2-harness-0-disk-1". + # The name of the data disk where data for this range is stored. This name is + # local to the Google Cloud Platform project and uniquely identifies the disk + # within that project, for example "myproject-1014-104817-4c2-harness-0-disk-1". # Corresponds to the JSON property `dataDisk` # @return [String] attr_accessor :data_disk - # The physical location of this range assignment to be used for - # streaming computation cross-worker message delivery. + # The physical location of this range assignment to be used for streaming + # computation cross-worker message delivery. # Corresponds to the JSON property `deliveryEndpoint` # @return [String] attr_accessor :delivery_endpoint @@ -2378,14 +2335,12 @@ module Google attr_accessor :job_name # Launch options for this flex template job. This is a common set of options - # across languages and templates. This should not be used to pass job - # parameters. + # across languages and templates. This should not be used to pass job parameters. # Corresponds to the JSON property `launchOptions` # @return [Hash] attr_accessor :launch_options - # The parameters for FlexTemplate. - # Ex. `"num_workers":"5"` + # The parameters for FlexTemplate. Ex. `"num_workers":"5"` # Corresponds to the JSON property `parameters` # @return [Hash] attr_accessor :parameters @@ -2413,8 +2368,7 @@ module Google # @return [Google::Apis::DataflowV1b3::LaunchFlexTemplateParameter] attr_accessor :launch_parameter - # If true, the request is validated but not actually executed. - # Defaults to false. + # If true, the request is validated but not actually executed. Defaults to false. # Corresponds to the JSON property `validateOnly` # @return [Boolean] attr_accessor :validate_only @@ -2475,8 +2429,8 @@ module Google # @return [Hash] attr_accessor :transform_name_mapping - # If set, replace the existing pipeline with the name specified by jobName - # with this pipeline, preserving state. + # If set, replace the existing pipeline with the name specified by jobName with + # this pipeline, preserving state. # Corresponds to the JSON property `update` # @return [Boolean] attr_accessor :update @@ -2524,9 +2478,8 @@ module Google # @return [String] attr_accessor :current_worker_time - # The [regional endpoint] - # (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) that - # contains the WorkItem's job. + # The [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/ + # regional-endpoints) that contains the WorkItem's job. # Corresponds to the JSON property `location` # @return [String] attr_accessor :location @@ -2552,8 +2505,8 @@ module Google # @return [Array] attr_accessor :worker_capabilities - # Identifies the worker leasing work -- typically the ID of the - # virtual machine running the worker. + # Identifies the worker leasing work -- typically the ID of the virtual machine + # running the worker. # Corresponds to the JSON property `workerId` # @return [String] attr_accessor :worker_id @@ -2630,17 +2583,15 @@ module Google end end - # Response to a request to list Cloud Dataflow jobs in a project. This might - # be a partial response, depending on the page size in the ListJobsRequest. - # However, if the project does not have any jobs, an instance of - # ListJobsResponse is not returned and the requests's response - # body is empty ``. + # Response to a request to list Cloud Dataflow jobs in a project. This might be + # a partial response, depending on the page size in the ListJobsRequest. However, + # if the project does not have any jobs, an instance of ListJobsResponse is not + # returned and the requests's response body is empty ``. class ListJobsResponse include Google::Apis::Core::Hashable - # Zero or more messages describing the [regional endpoints] - # (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) that - # failed to respond. + # Zero or more messages describing the [regional endpoints] (https://cloud. + # google.com/dataflow/docs/concepts/regional-endpoints) that failed to respond. # Corresponds to the JSON property `failedLocation` # @return [Array] attr_accessor :failed_location @@ -2690,8 +2641,8 @@ module Google class ListTemplateVersionsResponse include Google::Apis::Core::Hashable - # A token that can be sent as `page_token` to retrieve the next page. - # If this field is omitted, there are no subsequent pages. + # A token that can be sent as `page_token` to retrieve the next page. If this + # field is omitted, there are no subsequent pages. # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token @@ -2712,11 +2663,10 @@ module Google end end - # MapTask consists of an ordered set of instructions, each of which - # describes one particular low-level operation for the worker to - # perform in order to accomplish the MapTask's WorkItem. - # Each instruction must appear in the list before any instructions which - # depends on its output. + # MapTask consists of an ordered set of instructions, each of which describes + # one particular low-level operation for the worker to perform in order to + # accomplish the MapTask's WorkItem. Each instruction must appear in the list + # before any instructions which depends on its output. class MapTask include Google::Apis::Core::Hashable @@ -2731,14 +2681,13 @@ module Google # @return [Array] attr_accessor :instructions - # System-defined name of the stage containing this MapTask. - # Unique across the workflow. + # System-defined name of the stage containing this MapTask. Unique across the + # workflow. # Corresponds to the JSON property `stageName` # @return [String] attr_accessor :stage_name - # System-defined name of this MapTask. - # Unique across the workflow. + # System-defined name of this MapTask. Unique across the workflow. # Corresponds to the JSON property `systemName` # @return [String] attr_accessor :system_name @@ -2756,8 +2705,7 @@ module Google end end - # Information about the memory usage of a worker or a container within a - # worker. + # Information about the memory usage of a worker or a container within a worker. class MemInfo include Google::Apis::Core::Hashable @@ -2799,8 +2747,8 @@ module Google class MetricShortId include Google::Apis::Core::Hashable - # The index of the corresponding metric in - # the ReportWorkItemStatusRequest. Required. + # The index of the corresponding metric in the ReportWorkItemStatusRequest. + # Required. # Corresponds to the JSON property `metricIndex` # @return [Fixnum] attr_accessor :metric_index @@ -2821,16 +2769,14 @@ module Google end end - # Identifies a metric, by describing the source which generated the - # metric. + # Identifies a metric, by describing the source which generated the metric. class MetricStructuredName include Google::Apis::Core::Hashable - # Zero or more labeled fields which identify the part of the job this - # metric is associated with, such as the name of a step or collection. - # For example, built-in counters associated with steps will have - # context['step'] = . Counters associated with PCollections - # in the SDK will have context['pcollection'] = . + # Zero or more labeled fields which identify the part of the job this metric is + # associated with, such as the name of a step or collection. For example, built- + # in counters associated with steps will have context['step'] = . Counters + # associated with PCollections in the SDK will have context['pcollection'] = . # Corresponds to the JSON property `context` # @return [Hash] attr_accessor :context @@ -2840,8 +2786,8 @@ module Google # @return [String] attr_accessor :name - # Origin (namespace) of metric name. May be blank for user-define metrics; - # will be "dataflow" for metrics defined by the Dataflow service or SDK. + # Origin (namespace) of metric name. May be blank for user-define metrics; will + # be "dataflow" for metrics defined by the Dataflow service or SDK. # Corresponds to the JSON property `origin` # @return [String] attr_accessor :origin @@ -2862,10 +2808,10 @@ module Google class MetricUpdate include Google::Apis::Core::Hashable - # True if this metric is reported as the total cumulative aggregate - # value accumulated since the worker started working on this WorkItem. - # By default this is false, indicating that this metric is reported - # as a delta that is not associated with any WorkItem. + # True if this metric is reported as the total cumulative aggregate value + # accumulated since the worker started working on this WorkItem. By default this + # is false, indicating that this metric is reported as a delta that is not + # associated with any WorkItem. # Corresponds to the JSON property `cumulative` # @return [Boolean] attr_accessor :cumulative @@ -2876,67 +2822,62 @@ module Google # @return [Object] attr_accessor :distribution - # A struct value describing properties of a Gauge. - # Metrics of gauge type show the value of a metric across time, and is - # aggregated based on the newest value. + # A struct value describing properties of a Gauge. Metrics of gauge type show + # the value of a metric across time, and is aggregated based on the newest value. # Corresponds to the JSON property `gauge` # @return [Object] attr_accessor :gauge - # Worker-computed aggregate value for internal use by the Dataflow - # service. + # Worker-computed aggregate value for internal use by the Dataflow service. # Corresponds to the JSON property `internal` # @return [Object] attr_accessor :internal - # Metric aggregation kind. The possible metric aggregation kinds are - # "Sum", "Max", "Min", "Mean", "Set", "And", "Or", and "Distribution". - # The specified aggregation kind is case-insensitive. - # If omitted, this is not an aggregated value but instead - # a single metric sample value. + # Metric aggregation kind. The possible metric aggregation kinds are "Sum", "Max" + # , "Min", "Mean", "Set", "And", "Or", and "Distribution". The specified + # aggregation kind is case-insensitive. If omitted, this is not an aggregated + # value but instead a single metric sample value. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind - # Worker-computed aggregate value for the "Mean" aggregation kind. - # This holds the count of the aggregated values and is used in combination - # with mean_sum above to obtain the actual mean aggregate value. - # The only possible value type is Long. + # Worker-computed aggregate value for the "Mean" aggregation kind. This holds + # the count of the aggregated values and is used in combination with mean_sum + # above to obtain the actual mean aggregate value. The only possible value type + # is Long. # Corresponds to the JSON property `meanCount` # @return [Object] attr_accessor :mean_count - # Worker-computed aggregate value for the "Mean" aggregation kind. - # This holds the sum of the aggregated values and is used in combination - # with mean_count below to obtain the actual mean aggregate value. - # The only possible value types are Long and Double. + # Worker-computed aggregate value for the "Mean" aggregation kind. This holds + # the sum of the aggregated values and is used in combination with mean_count + # below to obtain the actual mean aggregate value. The only possible value types + # are Long and Double. # Corresponds to the JSON property `meanSum` # @return [Object] attr_accessor :mean_sum - # Identifies a metric, by describing the source which generated the - # metric. + # Identifies a metric, by describing the source which generated the metric. # Corresponds to the JSON property `name` # @return [Google::Apis::DataflowV1b3::MetricStructuredName] attr_accessor :name - # Worker-computed aggregate value for aggregation kinds "Sum", "Max", "Min", - # "And", and "Or". The possible value types are Long, Double, and Boolean. + # Worker-computed aggregate value for aggregation kinds "Sum", "Max", "Min", " + # And", and "Or". The possible value types are Long, Double, and Boolean. # Corresponds to the JSON property `scalar` # @return [Object] attr_accessor :scalar - # Worker-computed aggregate value for the "Set" aggregation kind. The only - # possible value type is a list of Values whose type can be Long, Double, - # or String, according to the metric's type. All Values in the list must - # be of the same type. + # Worker-computed aggregate value for the "Set" aggregation kind. The only + # possible value type is a list of Values whose type can be Long, Double, or + # String, according to the metric's type. All Values in the list must be of the + # same type. # Corresponds to the JSON property `set` # @return [Object] attr_accessor :set # Timestamp associated with the metric value. Optional when workers are - # reporting work progress; it will be filled in responses from the - # metrics API. + # reporting work progress; it will be filled in responses from the metrics API. # Corresponds to the JSON property `updateTime` # @return [String] attr_accessor :update_time @@ -2961,8 +2902,7 @@ module Google end end - # Either add the label to TemplateVersion or remove it from the - # TemplateVersion. + # Either add the label to TemplateVersion or remove it from the TemplateVersion. class ModifyTemplateVersionLabelRequest include Google::Apis::Core::Hashable @@ -2971,8 +2911,7 @@ module Google # @return [String] attr_accessor :key - # Requests for add label to TemplateVersion or remove label from - # TemplateVersion. + # Requests for add label to TemplateVersion or remove label from TemplateVersion. # Corresponds to the JSON property `op` # @return [String] attr_accessor :op @@ -3066,10 +3005,9 @@ module Google class MountedDataDisk include Google::Apis::Core::Hashable - # The name of the data disk. - # This name is local to the Google Cloud Platform project and uniquely - # identifies the disk within that project, for example - # "myproject-1014-104817-4c2-harness-0-disk-1". + # The name of the data disk. This name is local to the Google Cloud Platform + # project and uniquely identifies the disk within that project, for example " + # myproject-1014-104817-4c2-harness-0-disk-1". # Corresponds to the JSON property `dataDisk` # @return [String] attr_accessor :data_disk @@ -3088,8 +3026,8 @@ module Google class MultiOutputInfo include Google::Apis::Core::Hashable - # The id of the tag the user code will emit to this output by; this - # should correspond to the tag of some SideInputInfo. + # The id of the tag the user code will emit to this output by; this should + # correspond to the tag of some SideInputInfo. # Corresponds to the JSON property `tag` # @return [String] attr_accessor :tag @@ -3129,21 +3067,17 @@ module Google end end - # The packages that must be installed in order for a worker to run the - # steps of the Cloud Dataflow job that will be assigned to its worker - # pool. - # This is the mechanism by which the Cloud Dataflow SDK causes code to - # be loaded onto the workers. For example, the Cloud Dataflow Java SDK - # might use this to install jars containing the user's code and all of the - # various dependencies (libraries, data files, etc.) required in order - # for that code to run. + # The packages that must be installed in order for a worker to run the steps of + # the Cloud Dataflow job that will be assigned to its worker pool. This is the + # mechanism by which the Cloud Dataflow SDK causes code to be loaded onto the + # workers. For example, the Cloud Dataflow Java SDK might use this to install + # jars containing the user's code and all of the various dependencies (libraries, + # data files, etc.) required in order for that code to run. class Package include Google::Apis::Core::Hashable - # The resource to read the package from. The supported resource type is: - # Google Cloud Storage: - # storage.googleapis.com/`bucket` - # bucket.storage.googleapis.com/ + # The resource to read the package from. The supported resource type is: Google + # Cloud Storage: storage.googleapis.com/`bucket` bucket.storage.googleapis.com/ # Corresponds to the JSON property `location` # @return [String] attr_accessor :location @@ -3164,20 +3098,18 @@ module Google end end - # An instruction that does a ParDo operation. - # Takes one main input and zero or more side inputs, and produces - # zero or more outputs. - # Runs user code. + # An instruction that does a ParDo operation. Takes one main input and zero or + # more side inputs, and produces zero or more outputs. Runs user code. class ParDoInstruction include Google::Apis::Core::Hashable - # An input of an instruction, as a reference to an output of a - # producer instruction. + # An input of an instruction, as a reference to an output of a producer + # instruction. # Corresponds to the JSON property `input` # @return [Google::Apis::DataflowV1b3::InstructionInput] attr_accessor :input - # Information about each of the outputs, if user_fn is a MultiDoFn. + # Information about each of the outputs, if user_fn is a MultiDoFn. # Corresponds to the JSON property `multiOutputInfos` # @return [Array] attr_accessor :multi_output_infos @@ -3235,34 +3167,28 @@ module Google # @return [Array] attr_accessor :outputs - # An instruction that does a ParDo operation. - # Takes one main input and zero or more side inputs, and produces - # zero or more outputs. - # Runs user code. + # An instruction that does a ParDo operation. Takes one main input and zero or + # more side inputs, and produces zero or more outputs. Runs user code. # Corresponds to the JSON property `parDo` # @return [Google::Apis::DataflowV1b3::ParDoInstruction] attr_accessor :par_do - # An instruction that does a partial group-by-key. - # One input and one output. + # An instruction that does a partial group-by-key. One input and one output. # Corresponds to the JSON property `partialGroupByKey` # @return [Google::Apis::DataflowV1b3::PartialGroupByKeyInstruction] attr_accessor :partial_group_by_key - # An instruction that reads records. - # Takes no inputs, produces one output. + # An instruction that reads records. Takes no inputs, produces one output. # Corresponds to the JSON property `read` # @return [Google::Apis::DataflowV1b3::ReadInstruction] attr_accessor :read - # System-defined name of this operation. - # Unique across the workflow. + # System-defined name of this operation. Unique across the workflow. # Corresponds to the JSON property `systemName` # @return [String] attr_accessor :system_name - # An instruction that writes records. - # Takes one input, produces no outputs. + # An instruction that writes records. Takes one input, produces no outputs. # Corresponds to the JSON property `write` # @return [Google::Apis::DataflowV1b3::WriteInstruction] attr_accessor :write @@ -3335,8 +3261,7 @@ module Google # @return [String] attr_accessor :name - # Optional. The type of the parameter. - # Used for selecting input picker. + # Optional. The type of the parameter. Used for selecting input picker. # Corresponds to the JSON property `paramType` # @return [String] attr_accessor :param_type @@ -3361,13 +3286,12 @@ module Google end end - # An instruction that does a partial group-by-key. - # One input and one output. + # An instruction that does a partial group-by-key. One input and one output. class PartialGroupByKeyInstruction include Google::Apis::Core::Hashable - # An input of an instruction, as a reference to an output of a - # producer instruction. + # An input of an instruction, as a reference to an output of a producer + # instruction. # Corresponds to the JSON property `input` # @return [Google::Apis::DataflowV1b3::InstructionInput] attr_accessor :input @@ -3415,7 +3339,7 @@ module Google end # A descriptive representation of submitted pipeline as well as the executed - # form. This data is provided by the Dataflow service for ease of visualizing + # form. This data is provided by the Dataflow service for ease of visualizing # the pipeline and interpreting Dataflow provided metrics. class PipelineDescription include Google::Apis::Core::Hashable @@ -3447,9 +3371,34 @@ module Google end end - # Position defines a position within a collection of data. The value - # can be either the end position, a key (used with ordered - # collections), a byte offset, or a record index. + # A point in the timeseries. + class Point + include Google::Apis::Core::Hashable + + # The timestamp of the point. + # Corresponds to the JSON property `time` + # @return [String] + attr_accessor :time + + # The value of the point. + # Corresponds to the JSON property `value` + # @return [Float] + attr_accessor :value + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @time = args[:time] if args.key?(:time) + @value = args[:value] if args.key?(:value) + end + end + + # Position defines a position within a collection of data. The value can be + # either the end position, a key (used with ordered collections), a byte offset, + # or a record index. class Position include Google::Apis::Core::Hashable @@ -3465,8 +3414,8 @@ module Google # @return [Google::Apis::DataflowV1b3::ConcatPosition] attr_accessor :concat_position - # Position is past all other positions. Also useful for the end - # position of an unbounded range. + # Position is past all other positions. Also useful for the end position of an + # unbounded range. # Corresponds to the JSON property `end` # @return [Boolean] attr_accessor :end @@ -3482,8 +3431,7 @@ module Google # @return [Fixnum] attr_accessor :record_index - # CloudPosition is a base64 encoded BatchShufflePosition (with FIXED - # sharding). + # CloudPosition is a base64 encoded BatchShufflePosition (with FIXED sharding). # Corresponds to the JSON property `shufflePosition` # @return [String] attr_accessor :shuffle_position @@ -3503,6 +3451,31 @@ module Google end end + # Information about the progress of some component of job execution. + class ProgressTimeseries + include Google::Apis::Core::Hashable + + # The current progress of the component, in the range [0,1]. + # Corresponds to the JSON property `currentProgress` + # @return [Float] + attr_accessor :current_progress + + # History of progress for the component. Points are sorted by time. + # Corresponds to the JSON property `dataPoints` + # @return [Array] + attr_accessor :data_points + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @current_progress = args[:current_progress] if args.key?(:current_progress) + @data_points = args[:data_points] if args.key?(:data_points) + end + end + # Metadata for a PubSub connector used by the job. class PubSubIoDetails include Google::Apis::Core::Hashable @@ -3528,8 +3501,8 @@ module Google end end - # Identifies a pubsub location to use for transferring data into or - # out of a streaming Dataflow job. + # Identifies a pubsub location to use for transferring data into or out of a + # streaming Dataflow job. class PubsubLocation include Google::Apis::Core::Hashable @@ -3539,26 +3512,24 @@ module Google attr_accessor :drop_late_data alias_method :drop_late_data?, :drop_late_data - # If set, contains a pubsub label from which to extract record ids. - # If left empty, record deduplication will be strictly best effort. + # If set, contains a pubsub label from which to extract record ids. If left + # empty, record deduplication will be strictly best effort. # Corresponds to the JSON property `idLabel` # @return [String] attr_accessor :id_label - # A pubsub subscription, in the form of - # "pubsub.googleapis.com/subscriptions//" + # A pubsub subscription, in the form of "pubsub.googleapis.com/subscriptions//" # Corresponds to the JSON property `subscription` # @return [String] attr_accessor :subscription - # If set, contains a pubsub label from which to extract record timestamps. - # If left empty, record timestamps will be generated upon arrival. + # If set, contains a pubsub label from which to extract record timestamps. If + # left empty, record timestamps will be generated upon arrival. # Corresponds to the JSON property `timestampLabel` # @return [String] attr_accessor :timestamp_label - # A pubsub topic, in the form of - # "pubsub.googleapis.com/topics//" + # A pubsub topic, in the form of "pubsub.googleapis.com/topics//" # Corresponds to the JSON property `topic` # @return [String] attr_accessor :topic @@ -3641,8 +3612,7 @@ module Google end end - # An instruction that reads records. - # Takes no inputs, produces one output. + # An instruction that reads records. Takes no inputs, produces one output. class ReadInstruction include Google::Apis::Core::Hashable @@ -3670,9 +3640,8 @@ module Google # @return [String] attr_accessor :current_worker_time - # The [regional endpoint] - # (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) that - # contains the WorkItem's job. + # The [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/ + # regional-endpoints) that contains the WorkItem's job. # Corresponds to the JSON property `location` # @return [String] attr_accessor :location @@ -3682,17 +3651,16 @@ module Google # @return [Hash] attr_accessor :unified_worker_request - # The order is unimportant, except that the order of the - # WorkItemServiceState messages in the ReportWorkItemStatusResponse - # corresponds to the order of WorkItemStatus messages here. + # The order is unimportant, except that the order of the WorkItemServiceState + # messages in the ReportWorkItemStatusResponse corresponds to the order of + # WorkItemStatus messages here. # Corresponds to the JSON property `workItemStatuses` # @return [Array] attr_accessor :work_item_statuses - # The ID of the worker reporting the WorkItem status. If this - # does not match the ID of the worker which the Dataflow service - # believes currently has the lease on the WorkItem, the report - # will be dropped (with an error response). + # The ID of the worker reporting the WorkItem status. If this does not match the + # ID of the worker which the Dataflow service believes currently has the lease + # on the WorkItem, the report will be dropped (with an error response). # Corresponds to the JSON property `workerId` # @return [String] attr_accessor :worker_id @@ -3720,10 +3688,9 @@ module Google # @return [Hash] attr_accessor :unified_worker_response - # A set of messages indicating the service-side state for each - # WorkItem whose status was reported, in the same order as the - # WorkItemStatus messages in the ReportWorkItemStatusRequest which - # resulting in this response. + # A set of messages indicating the service-side state for each WorkItem whose + # status was reported, in the same order as the WorkItemStatus messages in the + # ReportWorkItemStatusRequest which resulting in this response. # Corresponds to the JSON property `workItemServiceStates` # @return [Array] attr_accessor :work_item_service_states @@ -3739,17 +3706,16 @@ module Google end end - # Represents the level of parallelism in a WorkItem's input, - # reported by the worker. + # Represents the level of parallelism in a WorkItem's input, reported by the + # worker. class ReportedParallelism include Google::Apis::Core::Hashable - # Specifies whether the parallelism is infinite. If true, "value" is - # ignored. - # Infinite parallelism means the service will assume that the work item - # can always be split into more non-empty work items by dynamic splitting. - # This is a work-around for lack of support for infinity by the current - # JSON-based Java RPC stack. + # Specifies whether the parallelism is infinite. If true, "value" is ignored. + # Infinite parallelism means the service will assume that the work item can + # always be split into more non-empty work items by dynamic splitting. This is a + # work-around for lack of support for infinity by the current JSON-based Java + # RPC stack. # Corresponds to the JSON property `isInfinite` # @return [Boolean] attr_accessor :is_infinite @@ -3772,13 +3738,12 @@ module Google end # Worker metrics exported from workers. This contains resource utilization - # metrics accumulated from a variety of sources. For more information, see - # go/df-resource-signals. + # metrics accumulated from a variety of sources. For more information, see go/df- + # resource-signals. class ResourceUtilizationReport include Google::Apis::Core::Hashable - # Per container information. - # Key: container name. + # Per container information. Key: container name. # Corresponds to the JSON property `containers` # @return [Hash] attr_accessor :containers @@ -3827,48 +3792,51 @@ module Google # @return [Array] attr_accessor :additional_experiments - # Additional user labels to be specified for the job. - # Keys and values should follow the restrictions specified in the [labeling - # restrictions](https://cloud.google.com/compute/docs/labeling-resources# - # restrictions) - # page. + # Additional user labels to be specified for the job. Keys and values should + # follow the restrictions specified in the [labeling restrictions](https://cloud. + # google.com/compute/docs/labeling-resources#restrictions) page. # Corresponds to the JSON property `additionalUserLabels` # @return [Hash] attr_accessor :additional_user_labels - # Whether to bypass the safety checks for the job's temporary directory. - # Use with caution. + # Whether to bypass the safety checks for the job's temporary directory. Use + # with caution. # Corresponds to the JSON property `bypassTempDirValidation` # @return [Boolean] attr_accessor :bypass_temp_dir_validation alias_method :bypass_temp_dir_validation?, :bypass_temp_dir_validation + # Whether to enable Streaming Engine for the job. + # Corresponds to the JSON property `enableStreamingEngine` + # @return [Boolean] + attr_accessor :enable_streaming_engine + alias_method :enable_streaming_engine?, :enable_streaming_engine + # Configuration for VM IPs. # Corresponds to the JSON property `ipConfiguration` # @return [String] attr_accessor :ip_configuration - # Optional. Name for the Cloud KMS key for the job. - # Key format is: - # projects//locations//keyRings//cryptoKeys/ + # Optional. Name for the Cloud KMS key for the job. Key format is: projects// + # locations//keyRings//cryptoKeys/ # Corresponds to the JSON property `kmsKeyName` # @return [String] attr_accessor :kms_key_name - # The machine type to use for the job. Defaults to the value from the - # template if not specified. + # The machine type to use for the job. Defaults to the value from the template + # if not specified. # Corresponds to the JSON property `machineType` # @return [String] attr_accessor :machine_type - # The maximum number of Google Compute Engine instances to be made - # available to your pipeline during execution, from 1 to 1000. + # The maximum number of Google Compute Engine instances to be made available to + # your pipeline during execution, from 1 to 1000. # Corresponds to the JSON property `maxWorkers` # @return [Fixnum] attr_accessor :max_workers - # Network to which VMs will be assigned. If empty or unspecified, - # the service will use the network "default". + # Network to which VMs will be assigned. If empty or unspecified, the service + # will use the network "default". # Corresponds to the JSON property `network` # @return [String] attr_accessor :network @@ -3883,41 +3851,39 @@ module Google # @return [String] attr_accessor :service_account_email - # Subnetwork to which VMs will be assigned, if desired. Expected to be of - # the form "regions/REGION/subnetworks/SUBNETWORK". + # Subnetwork to which VMs will be assigned, if desired. Expected to be of the + # form "regions/REGION/subnetworks/SUBNETWORK". # Corresponds to the JSON property `subnetwork` # @return [String] attr_accessor :subnetwork - # The Cloud Storage path to use for temporary files. - # Must be a valid Cloud Storage URL, beginning with `gs://`. + # The Cloud Storage path to use for temporary files. Must be a valid Cloud + # Storage URL, beginning with `gs://`. # Corresponds to the JSON property `tempLocation` # @return [String] attr_accessor :temp_location - # The Compute Engine region - # (https://cloud.google.com/compute/docs/regions-zones/regions-zones) in - # which worker processing should occur, e.g. "us-west1". Mutually exclusive - # with worker_zone. If neither worker_region nor worker_zone is specified, - # default to the control plane's region. + # The Compute Engine region (https://cloud.google.com/compute/docs/regions-zones/ + # regions-zones) in which worker processing should occur, e.g. "us-west1". + # Mutually exclusive with worker_zone. If neither worker_region nor worker_zone + # is specified, default to the control plane's region. # Corresponds to the JSON property `workerRegion` # @return [String] attr_accessor :worker_region - # The Compute Engine zone - # (https://cloud.google.com/compute/docs/regions-zones/regions-zones) in - # which worker processing should occur, e.g. "us-west1-a". Mutually exclusive - # with worker_region. If neither worker_region nor worker_zone is specified, - # a zone in the control plane's region is chosen based on available capacity. - # If both `worker_zone` and `zone` are set, `worker_zone` takes precedence. + # The Compute Engine zone (https://cloud.google.com/compute/docs/regions-zones/ + # regions-zones) in which worker processing should occur, e.g. "us-west1-a". + # Mutually exclusive with worker_region. If neither worker_region nor + # worker_zone is specified, a zone in the control plane's region is chosen based + # on available capacity. If both `worker_zone` and `zone` are set, `worker_zone` + # takes precedence. # Corresponds to the JSON property `workerZone` # @return [String] attr_accessor :worker_zone - # The Compute Engine [availability - # zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones) - # for launching worker instances to run your pipeline. - # In the future, worker_zone will take precedence. + # The Compute Engine [availability zone](https://cloud.google.com/compute/docs/ + # regions-zones/regions-zones) for launching worker instances to run your + # pipeline. In the future, worker_zone will take precedence. # Corresponds to the JSON property `zone` # @return [String] attr_accessor :zone @@ -3931,6 +3897,7 @@ module Google @additional_experiments = args[:additional_experiments] if args.key?(:additional_experiments) @additional_user_labels = args[:additional_user_labels] if args.key?(:additional_user_labels) @bypass_temp_dir_validation = args[:bypass_temp_dir_validation] if args.key?(:bypass_temp_dir_validation) + @enable_streaming_engine = args[:enable_streaming_engine] if args.key?(:enable_streaming_engine) @ip_configuration = args[:ip_configuration] if args.key?(:ip_configuration) @kms_key_name = args[:kms_key_name] if args.key?(:kms_key_name) @machine_type = args[:machine_type] if args.key?(:machine_type) @@ -4006,10 +3973,9 @@ module Google attr_accessor :container_image # If true, recommends the Dataflow service to use only one core per SDK - # container instance with this image. If false (or unset) recommends using - # more than one core per SDK container instance with this image for - # efficiency. Note that Dataflow service may choose to override this property - # if needed. + # container instance with this image. If false (or unset) recommends using more + # than one core per SDK container instance with this image for efficiency. Note + # that Dataflow service may choose to override this property if needed. # Corresponds to the JSON property `useSingleCorePerContainer` # @return [Boolean] attr_accessor :use_single_core_per_container @@ -4071,9 +4037,8 @@ module Google # @return [String] attr_accessor :data - # The [regional endpoint] - # (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) that - # contains the job specified by job_id. + # The [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/ + # regional-endpoints) that contains the job specified by job_id. # Corresponds to the JSON property `location` # @return [String] attr_accessor :location @@ -4096,8 +4061,7 @@ module Google end end - # Response to a send capture request. - # nothing + # Response to a send capture request. nothing class SendDebugCaptureResponse include Google::Apis::Core::Hashable @@ -4114,9 +4078,8 @@ module Google class SendWorkerMessagesRequest include Google::Apis::Core::Hashable - # The [regional endpoint] - # (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) that - # contains the job. + # The [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/ + # regional-endpoints) that contains the job. # Corresponds to the JSON property `location` # @return [String] attr_accessor :location @@ -4175,14 +4138,13 @@ module Google # @return [Array] attr_accessor :output_infos - # System-defined name of the stage containing the SeqDo operation. - # Unique across the workflow. + # System-defined name of the stage containing the SeqDo operation. Unique across + # the workflow. # Corresponds to the JSON property `stageName` # @return [String] attr_accessor :stage_name - # System-defined name of the SeqDo operation. - # Unique across the workflow. + # System-defined name of the SeqDo operation. Unique across the workflow. # Corresponds to the JSON property `systemName` # @return [String] attr_accessor :system_name @@ -4266,16 +4228,15 @@ module Google # @return [Hash] attr_accessor :kind - # The source(s) to read element(s) from to get the value of this side input. - # If more than one source, then the elements are taken from the - # sources, in the specified order if order matters. - # At least one source is required. + # The source(s) to read element(s) from to get the value of this side input. If + # more than one source, then the elements are taken from the sources, in the + # specified order if order matters. At least one source is required. # Corresponds to the JSON property `sources` # @return [Array] attr_accessor :sources - # The id of the tag the user code will access this side input by; - # this should correspond to the tag of some MultiOutputInfo. + # The id of the tag the user code will access this side input by; this should + # correspond to the tag of some MultiOutputInfo. # Corresponds to the JSON property `tag` # @return [String] attr_accessor :tag @@ -4427,13 +4388,12 @@ module Google class Source include Google::Apis::Core::Hashable - # While splitting, sources may specify the produced bundles - # as differences against another source, in order to save backend-side - # memory and allow bigger jobs. For details, see SourceSplitRequest. - # To support this use case, the full set of parameters of the source - # is logically obtained by taking the latest explicitly specified value - # of each parameter in the order: - # base_specs (later items win), spec (overrides anything in base_specs). + # While splitting, sources may specify the produced bundles as differences + # against another source, in order to save backend-side memory and allow bigger + # jobs. For details, see SourceSplitRequest. To support this use case, the full + # set of parameters of the source is logically obtained by taking the latest + # explicitly specified value of each parameter in the order: base_specs (later + # items win), spec (overrides anything in base_specs). # Corresponds to the JSON property `baseSpecs` # @return [Array>] attr_accessor :base_specs @@ -4443,27 +4403,24 @@ module Google # @return [Hash] attr_accessor :codec - # Setting this value to true hints to the framework that the source - # doesn't need splitting, and using SourceSplitRequest on it would - # yield SOURCE_SPLIT_OUTCOME_USE_CURRENT. - # E.g. a file splitter may set this to true when splitting a single file - # into a set of byte ranges of appropriate size, and set this - # to false when splitting a filepattern into individual files. - # However, for efficiency, a file splitter may decide to produce - # file subranges directly from the filepattern to avoid a splitting - # round-trip. - # See SourceSplitRequest for an overview of the splitting process. - # This field is meaningful only in the Source objects populated - # by the user (e.g. when filling in a DerivedSource). - # Source objects supplied by the framework to the user don't have - # this field populated. + # Setting this value to true hints to the framework that the source doesn't need + # splitting, and using SourceSplitRequest on it would yield + # SOURCE_SPLIT_OUTCOME_USE_CURRENT. E.g. a file splitter may set this to true + # when splitting a single file into a set of byte ranges of appropriate size, + # and set this to false when splitting a filepattern into individual files. + # However, for efficiency, a file splitter may decide to produce file subranges + # directly from the filepattern to avoid a splitting round-trip. See + # SourceSplitRequest for an overview of the splitting process. This field is + # meaningful only in the Source objects populated by the user (e.g. when filling + # in a DerivedSource). Source objects supplied by the framework to the user don' + # t have this field populated. # Corresponds to the JSON property `doesNotNeedSplitting` # @return [Boolean] attr_accessor :does_not_need_splitting alias_method :does_not_need_splitting?, :does_not_need_splitting - # Metadata about a Source useful for automatically optimizing - # and tuning the pipeline, etc. + # Metadata about a Source useful for automatically optimizing and tuning the + # pipeline, etc. # Corresponds to the JSON property `metadata` # @return [Google::Apis::DataflowV1b3::SourceMetadata] attr_accessor :metadata @@ -4496,10 +4453,9 @@ module Google # @return [Google::Apis::DataflowV1b3::SourceSplitShard] attr_accessor :primary - # Specification of one of the bundles produced as a result of splitting - # a Source (e.g. when executing a SourceSplitRequest, or when - # splitting an active task using WorkItemStatus.dynamic_source_split), - # relative to the source being split. + # Specification of one of the bundles produced as a result of splitting a Source + # (e.g. when executing a SourceSplitRequest, or when splitting an active task + # using WorkItemStatus.dynamic_source_split), relative to the source being split. # Corresponds to the JSON property `primarySource` # @return [Google::Apis::DataflowV1b3::DerivedSource] attr_accessor :primary_source @@ -4509,10 +4465,9 @@ module Google # @return [Google::Apis::DataflowV1b3::SourceSplitShard] attr_accessor :residual - # Specification of one of the bundles produced as a result of splitting - # a Source (e.g. when executing a SourceSplitRequest, or when - # splitting an active task using WorkItemStatus.dynamic_source_split), - # relative to the source being split. + # Specification of one of the bundles produced as a result of splitting a Source + # (e.g. when executing a SourceSplitRequest, or when splitting an active task + # using WorkItemStatus.dynamic_source_split), relative to the source being split. # Corresponds to the JSON property `residualSource` # @return [Google::Apis::DataflowV1b3::DerivedSource] attr_accessor :residual_source @@ -4553,8 +4508,8 @@ module Google class SourceGetMetadataResponse include Google::Apis::Core::Hashable - # Metadata about a Source useful for automatically optimizing - # and tuning the pipeline, etc. + # Metadata about a Source useful for automatically optimizing and tuning the + # pipeline, etc. # Corresponds to the JSON property `metadata` # @return [Google::Apis::DataflowV1b3::SourceMetadata] attr_accessor :metadata @@ -4569,27 +4524,27 @@ module Google end end - # Metadata about a Source useful for automatically optimizing - # and tuning the pipeline, etc. + # Metadata about a Source useful for automatically optimizing and tuning the + # pipeline, etc. class SourceMetadata include Google::Apis::Core::Hashable - # An estimate of the total size (in bytes) of the data that would be - # read from this source. This estimate is in terms of external storage - # size, before any decompression or other processing done by the reader. + # An estimate of the total size (in bytes) of the data that would be read from + # this source. This estimate is in terms of external storage size, before any + # decompression or other processing done by the reader. # Corresponds to the JSON property `estimatedSizeBytes` # @return [Fixnum] attr_accessor :estimated_size_bytes - # Specifies that the size of this source is known to be infinite - # (this is a streaming source). + # Specifies that the size of this source is known to be infinite (this is a + # streaming source). # Corresponds to the JSON property `infinite` # @return [Boolean] attr_accessor :infinite alias_method :infinite?, :infinite - # Whether this source is known to produce key/value pairs with - # the (encoded) keys in lexicographically sorted order. + # Whether this source is known to produce key/value pairs with the (encoded) + # keys in lexicographically sorted order. # Corresponds to the JSON property `producesSortedKeys` # @return [Boolean] attr_accessor :produces_sorted_keys @@ -4607,8 +4562,8 @@ module Google end end - # A work item that represents the different operations that can be - # performed on a user-defined Source specification. + # A work item that represents the different operations that can be performed on + # a user-defined Source specification. class SourceOperationRequest include Google::Apis::Core::Hashable @@ -4622,36 +4577,34 @@ module Google # @return [String] attr_accessor :name - # System-defined name for the Read instruction for this source - # in the original workflow graph. + # System-defined name for the Read instruction for this source in the original + # workflow graph. # Corresponds to the JSON property `originalName` # @return [String] attr_accessor :original_name - # Represents the operation to split a high-level Source specification - # into bundles (parts for parallel processing). - # At a high level, splitting of a source into bundles happens as follows: - # SourceSplitRequest is applied to the source. If it returns - # SOURCE_SPLIT_OUTCOME_USE_CURRENT, no further splitting happens and the source - # is used "as is". Otherwise, splitting is applied recursively to each - # produced DerivedSource. - # As an optimization, for any Source, if its does_not_need_splitting is - # true, the framework assumes that splitting this source would return - # SOURCE_SPLIT_OUTCOME_USE_CURRENT, and doesn't initiate a SourceSplitRequest. - # This applies both to the initial source being split and to bundles - # produced from it. + # Represents the operation to split a high-level Source specification into + # bundles (parts for parallel processing). At a high level, splitting of a + # source into bundles happens as follows: SourceSplitRequest is applied to the + # source. If it returns SOURCE_SPLIT_OUTCOME_USE_CURRENT, no further splitting + # happens and the source is used "as is". Otherwise, splitting is applied + # recursively to each produced DerivedSource. As an optimization, for any Source, + # if its does_not_need_splitting is true, the framework assumes that splitting + # this source would return SOURCE_SPLIT_OUTCOME_USE_CURRENT, and doesn't + # initiate a SourceSplitRequest. This applies both to the initial source being + # split and to bundles produced from it. # Corresponds to the JSON property `split` # @return [Google::Apis::DataflowV1b3::SourceSplitRequest] attr_accessor :split - # System-defined name of the stage containing the source operation. - # Unique across the workflow. + # System-defined name of the stage containing the source operation. Unique + # across the workflow. # Corresponds to the JSON property `stageName` # @return [String] attr_accessor :stage_name - # System-defined name of the Read instruction for this source. - # Unique across the workflow. + # System-defined name of the Read instruction for this source. Unique across the + # workflow. # Corresponds to the JSON property `systemName` # @return [String] attr_accessor :system_name @@ -4672,8 +4625,7 @@ module Google end # The result of a SourceOperationRequest, specified in - # ReportWorkItemStatusRequest.source_operation when the work item - # is completed. + # ReportWorkItemStatusRequest.source_operation when the work item is completed. class SourceOperationResponse include Google::Apis::Core::Hashable @@ -4698,13 +4650,13 @@ module Google end end - # Hints for splitting a Source into bundles (parts for parallel - # processing) using SourceSplitRequest. + # Hints for splitting a Source into bundles (parts for parallel processing) + # using SourceSplitRequest. class SourceSplitOptions include Google::Apis::Core::Hashable - # The source should be split into a set of bundles where the estimated size - # of each is approximately this many bytes. + # The source should be split into a set of bundles where the estimated size of + # each is approximately this many bytes. # Corresponds to the JSON property `desiredBundleSizeBytes` # @return [Fixnum] attr_accessor :desired_bundle_size_bytes @@ -4725,23 +4677,21 @@ module Google end end - # Represents the operation to split a high-level Source specification - # into bundles (parts for parallel processing). - # At a high level, splitting of a source into bundles happens as follows: - # SourceSplitRequest is applied to the source. If it returns - # SOURCE_SPLIT_OUTCOME_USE_CURRENT, no further splitting happens and the source - # is used "as is". Otherwise, splitting is applied recursively to each - # produced DerivedSource. - # As an optimization, for any Source, if its does_not_need_splitting is - # true, the framework assumes that splitting this source would return - # SOURCE_SPLIT_OUTCOME_USE_CURRENT, and doesn't initiate a SourceSplitRequest. - # This applies both to the initial source being split and to bundles - # produced from it. + # Represents the operation to split a high-level Source specification into + # bundles (parts for parallel processing). At a high level, splitting of a + # source into bundles happens as follows: SourceSplitRequest is applied to the + # source. If it returns SOURCE_SPLIT_OUTCOME_USE_CURRENT, no further splitting + # happens and the source is used "as is". Otherwise, splitting is applied + # recursively to each produced DerivedSource. As an optimization, for any Source, + # if its does_not_need_splitting is true, the framework assumes that splitting + # this source would return SOURCE_SPLIT_OUTCOME_USE_CURRENT, and doesn't + # initiate a SourceSplitRequest. This applies both to the initial source being + # split and to bundles produced from it. class SourceSplitRequest include Google::Apis::Core::Hashable - # Hints for splitting a Source into bundles (parts for parallel - # processing) using SourceSplitRequest. + # Hints for splitting a Source into bundles (parts for parallel processing) + # using SourceSplitRequest. # Corresponds to the JSON property `options` # @return [Google::Apis::DataflowV1b3::SourceSplitOptions] attr_accessor :options @@ -4766,18 +4716,18 @@ module Google class SourceSplitResponse include Google::Apis::Core::Hashable - # If outcome is SPLITTING_HAPPENED, then this is a list of bundles - # into which the source was split. Otherwise this field is ignored. - # This list can be empty, which means the source represents an empty input. + # If outcome is SPLITTING_HAPPENED, then this is a list of bundles into which + # the source was split. Otherwise this field is ignored. This list can be empty, + # which means the source represents an empty input. # Corresponds to the JSON property `bundles` # @return [Array] attr_accessor :bundles - # Indicates whether splitting happened and produced a list of bundles. - # If this is USE_CURRENT_SOURCE_AS_IS, the current source should - # be processed "as is" without splitting. "bundles" is ignored in this case. - # If this is SPLITTING_HAPPENED, then "bundles" contains a list of - # bundles into which the source was split. + # Indicates whether splitting happened and produced a list of bundles. If this + # is USE_CURRENT_SOURCE_AS_IS, the current source should be processed "as is" + # without splitting. "bundles" is ignored in this case. If this is + # SPLITTING_HAPPENED, then "bundles" contains a list of bundles into which the + # source was split. # Corresponds to the JSON property `outcome` # @return [String] attr_accessor :outcome @@ -4855,8 +4805,8 @@ module Google end end - # A representation of an int64, n, that is immune to precision loss when - # encoded in JSON. + # A representation of an int64, n, that is immune to precision loss when encoded + # in JSON. class SplitInt64 include Google::Apis::Core::Hashable @@ -4881,6 +4831,32 @@ module Google end end + # Information about the workers and work items within a stage. + class StageExecutionDetails + include Google::Apis::Core::Hashable + + # If present, this response does not contain all requested tasks. To obtain the + # next page of results, repeat the request with page_token set to this value. + # Corresponds to the JSON property `nextPageToken` + # @return [String] + attr_accessor :next_page_token + + # Workers that have done work on the stage. + # Corresponds to the JSON property `workers` + # @return [Array] + attr_accessor :workers + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @next_page_token = args[:next_page_token] if args.key?(:next_page_token) + @workers = args[:workers] if args.key?(:workers) + end + end + # Description of an input or output of an execution stage. class StageSource include Google::Apis::Core::Hashable @@ -4890,8 +4866,8 @@ module Google # @return [String] attr_accessor :name - # User name for the original user transform or collection with which this - # source is most closely associated. + # User name for the original user transform or collection with which this source + # is most closely associated. # Corresponds to the JSON property `originalTransformOrCollection` # @return [String] attr_accessor :original_transform_or_collection @@ -4919,6 +4895,56 @@ module Google end end + # Information about a particular execution stage of a job. + class StageSummary + include Google::Apis::Core::Hashable + + # End time of this stage. If the work item is completed, this is the actual end + # time of the stage. Otherwise, it is the predicted end time. + # Corresponds to the JSON property `endTime` + # @return [String] + attr_accessor :end_time + + # Metrics for this stage. + # Corresponds to the JSON property `metrics` + # @return [Array] + attr_accessor :metrics + + # Information about the progress of some component of job execution. + # Corresponds to the JSON property `progress` + # @return [Google::Apis::DataflowV1b3::ProgressTimeseries] + attr_accessor :progress + + # ID of this stage + # Corresponds to the JSON property `stageId` + # @return [String] + attr_accessor :stage_id + + # Start time of this stage. + # Corresponds to the JSON property `startTime` + # @return [String] + attr_accessor :start_time + + # State of this stage. + # 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) + @end_time = args[:end_time] if args.key?(:end_time) + @metrics = args[:metrics] if args.key?(:metrics) + @progress = args[:progress] if args.key?(:progress) + @stage_id = args[:stage_id] if args.key?(:stage_id) + @start_time = args[:start_time] if args.key?(:start_time) + @state = args[:state] if args.key?(:state) + end + end + # State family configuration. class StateFamilyConfig include Google::Apis::Core::Hashable @@ -4945,12 +4971,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 @@ -4959,15 +4985,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 @@ -4984,23 +5010,17 @@ module Google end end - # Defines a particular step within a Cloud Dataflow job. - # A job consists of multiple steps, each of which performs some - # specific operation as part of the overall job. Data is typically - # passed from one step to another as part of the job. - # Here's an example of a sequence of steps which together implement a - # Map-Reduce job: - # * Read a collection of data from some source, parsing the - # collection's elements. - # * Validate the elements. - # * Apply a user-defined function to map each element to some value - # and extract an element-specific key value. - # * Group elements with the same key into a single element with - # that key, transforming a multiply-keyed collection into a - # uniquely-keyed collection. - # * Write the elements out to some data sink. - # Note that the Cloud Dataflow service may be used to run many different - # types of jobs, not just Map-Reduce. + # Defines a particular step within a Cloud Dataflow job. A job consists of + # multiple steps, each of which performs some specific operation as part of the + # overall job. Data is typically passed from one step to another as part of the + # job. Here's an example of a sequence of steps which together implement a Map- + # Reduce job: * Read a collection of data from some source, parsing the + # collection's elements. * Validate the elements. * Apply a user-defined + # function to map each element to some value and extract an element-specific key + # value. * Group elements with the same key into a single element with that key, + # transforming a multiply-keyed collection into a uniquely-keyed collection. * + # Write the elements out to some data sink. Note that the Cloud Dataflow service + # may be used to run many different types of jobs, not just Map-Reduce. class Step include Google::Apis::Core::Hashable @@ -5009,15 +5029,15 @@ module Google # @return [String] attr_accessor :kind - # The name that identifies the step. This must be unique for each - # step with respect to all other steps in the Cloud Dataflow job. + # The name that identifies the step. This must be unique for each step with + # respect to all other steps in the Cloud Dataflow job. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name - # Named properties associated with the step. Each kind of - # predefined step has its own required set of properties. - # Must be provided on Create. Only retrieved with JOB_VIEW_ALL. + # Named properties associated with the step. Each kind of predefined step has + # its own required set of properties. Must be provided on Create. Only retrieved + # with JOB_VIEW_ALL. # Corresponds to the JSON property `properties` # @return [Hash] attr_accessor :properties @@ -5034,8 +5054,8 @@ module Google end end - # Describes a stream of data, either as input to be processed or as - # output of a streaming Dataflow job. + # Describes a stream of data, either as input to be processed or as output of a + # streaming Dataflow job. class StreamLocation include Google::Apis::Core::Hashable @@ -5044,8 +5064,8 @@ module Google # @return [Google::Apis::DataflowV1b3::CustomSourceLocation] attr_accessor :custom_source_location - # Identifies a pubsub location to use for transferring data into or - # out of a streaming Dataflow job. + # Identifies a pubsub location to use for transferring data into or out of a + # streaming Dataflow job. # Corresponds to the JSON property `pubsubLocation` # @return [Google::Apis::DataflowV1b3::PubsubLocation] attr_accessor :pubsub_location @@ -5055,8 +5075,8 @@ module Google # @return [Google::Apis::DataflowV1b3::StreamingSideInputLocation] attr_accessor :side_input_location - # Identifies the location of a streaming computation stage, for - # stage-to-stage communication. + # Identifies the location of a streaming computation stage, for stage-to-stage + # communication. # Corresponds to the JSON property `streamingStageLocation` # @return [Google::Apis::DataflowV1b3::StreamingStageLocation] attr_accessor :streaming_stage_location @@ -5123,8 +5143,7 @@ module Google # @return [String] attr_accessor :system_name - # Map from user name of stateful transforms in this stage to their state - # family. + # Map from user name of stateful transforms in this stage to their state family. # Corresponds to the JSON property `transformUserNameToStateFamily` # @return [Hash] attr_accessor :transform_user_name_to_state_family @@ -5237,9 +5256,8 @@ module Google # @return [String] attr_accessor :windmill_service_endpoint - # If present, the worker must use this port to communicate with Windmill - # Service dispatchers. Only applicable when windmill_service_endpoint is - # specified. + # If present, the worker must use this port to communicate with Windmill Service + # dispatchers. Only applicable when windmill_service_endpoint is specified. # Corresponds to the JSON property `windmillServicePort` # @return [Fixnum] attr_accessor :windmill_service_port @@ -5270,8 +5288,8 @@ module Google attr_accessor :drain alias_method :drain?, :drain - # The TCP port on which the worker should listen for messages from - # other streaming computation workers. + # The TCP port on which the worker should listen for messages from other + # streaming computation workers. # Corresponds to the JSON property `receiveWorkPort` # @return [Fixnum] attr_accessor :receive_work_port @@ -5281,14 +5299,14 @@ module Google # @return [Google::Apis::DataflowV1b3::StreamingApplianceSnapshotConfig] attr_accessor :snapshot_config - # Global topology of the streaming Dataflow job, including all - # computations and their sharded locations. + # Global topology of the streaming Dataflow job, including all computations and + # their sharded locations. # Corresponds to the JSON property `streamingComputationTopology` # @return [Google::Apis::DataflowV1b3::TopologyConfig] attr_accessor :streaming_computation_topology - # The TCP port used by the worker to communicate with the Dataflow - # worker harness. + # The TCP port used by the worker to communicate with the Dataflow worker + # harness. # Corresponds to the JSON property `workerHarnessPort` # @return [Fixnum] attr_accessor :worker_harness_port @@ -5332,13 +5350,12 @@ module Google end end - # Identifies the location of a streaming computation stage, for - # stage-to-stage communication. + # Identifies the location of a streaming computation stage, for stage-to-stage + # communication. class StreamingStageLocation include Google::Apis::Core::Hashable - # Identifies the particular stream within the streaming Dataflow - # job. + # Identifies the particular stream within the streaming Dataflow job. # Corresponds to the JSON property `streamId` # @return [String] attr_accessor :stream_id @@ -5378,8 +5395,8 @@ module Google class StructuredMessage include Google::Apis::Core::Hashable - # Identifier for this message type. Used by external systems to - # internationalize or personalize message. + # Identifier for this message type. Used by external systems to internationalize + # or personalize message. # Corresponds to the JSON property `messageKey` # @return [String] attr_accessor :message_key @@ -5421,13 +5438,12 @@ module Google # @return [String] attr_accessor :base_task_dir - # The base URL for the taskrunner to use when accessing Google Cloud APIs. - # When workers access Google Cloud APIs, they logically do so via - # relative URLs. If this field is specified, it supplies the base - # URL to use for resolving these relative URLs. The normative - # algorithm used is defined by RFC 1808, "Relative Uniform Resource - # Locators". - # If not specified, the default value is "http://www.googleapis.com/" + # The base URL for the taskrunner to use when accessing Google Cloud APIs. When + # workers access Google Cloud APIs, they logically do so via relative URLs. If + # this field is specified, it supplies the base URL to use for resolving these + # relative URLs. The normative algorithm used is defined by RFC 1808, "Relative + # Uniform Resource Locators". If not specified, the default value is "http://www. + # googleapis.com/" # Corresponds to the JSON property `baseUrl` # @return [String] attr_accessor :base_url @@ -5463,25 +5479,21 @@ module Google # @return [String] attr_accessor :log_dir - # Whether to send taskrunner log info to Google Compute Engine VM serial - # console. + # Whether to send taskrunner log info to Google Compute Engine VM serial console. # Corresponds to the JSON property `logToSerialconsole` # @return [Boolean] attr_accessor :log_to_serialconsole alias_method :log_to_serialconsole?, :log_to_serialconsole - # Indicates where to put logs. If this is not specified, the logs - # will not be uploaded. - # The supported resource type is: - # Google Cloud Storage: - # storage.googleapis.com/`bucket`/`object` - # bucket.storage.googleapis.com/`object` + # Indicates where to put logs. If this is not specified, the logs will not be + # uploaded. The supported resource type is: Google Cloud Storage: storage. + # googleapis.com/`bucket`/`object` bucket.storage.googleapis.com/`object` # Corresponds to the JSON property `logUploadLocation` # @return [String] attr_accessor :log_upload_location - # The OAuth2 scopes to be requested by the taskrunner in order to - # access the Cloud Dataflow API. + # The OAuth2 scopes to be requested by the taskrunner in order to access the + # Cloud Dataflow API. # Corresponds to the JSON property `oauthScopes` # @return [Array] attr_accessor :oauth_scopes @@ -5496,24 +5508,21 @@ module Google # @return [String] attr_accessor :streaming_worker_main_class - # The UNIX group ID on the worker VM to use for tasks launched by - # taskrunner; e.g. "wheel". + # The UNIX group ID on the worker VM to use for tasks launched by taskrunner; e. + # g. "wheel". # Corresponds to the JSON property `taskGroup` # @return [String] attr_accessor :task_group - # The UNIX user ID on the worker VM to use for tasks launched by - # taskrunner; e.g. "root". + # The UNIX user ID on the worker VM to use for tasks launched by taskrunner; e.g. + # "root". # Corresponds to the JSON property `taskUser` # @return [String] attr_accessor :task_user - # The prefix of the resources the taskrunner should use for - # temporary storage. - # The supported resource type is: - # Google Cloud Storage: - # storage.googleapis.com/`bucket`/`object` - # bucket.storage.googleapis.com/`object` + # The prefix of the resources the taskrunner should use for temporary storage. + # The supported resource type is: Google Cloud Storage: storage.googleapis.com/` + # bucket`/`object` bucket.storage.googleapis.com/`object` # Corresponds to the JSON property `tempStoragePrefix` # @return [String] attr_accessor :temp_storage_prefix @@ -5587,15 +5596,14 @@ module Google end end - # ///////////////////////////////////////////////////////////////////////////// - # //// Template Catalog is used to organize user TemplateVersions. - # //// TemplateVersions that have the same project_id and display_name are - # //// belong to the same Template. - # //// Templates with the same project_id belong to the same Project. - # //// TemplateVersion may have labels and multiple labels are allowed. - # //// Duplicated labels in the same `TemplateVersion` are not allowed. - # //// TemplateVersion may have tags and multiple tags are allowed. Duplicated - # //// tags in the same `Template` are not allowed! + # ///////////////////////////////////////////////////////////////////////////// / + # /// Template Catalog is used to organize user TemplateVersions. //// + # TemplateVersions that have the same project_id and display_name are //// + # belong to the same Template. //// Templates with the same project_id belong to + # the same Project. //// TemplateVersion may have labels and multiple labels are + # allowed. //// Duplicated labels in the same `TemplateVersion` are not allowed. + # //// TemplateVersion may have tags and multiple tags are allowed. Duplicated // + # // tags in the same `Template` are not allowed! class TemplateVersion include Google::Apis::Core::Hashable @@ -5662,8 +5670,8 @@ module Google end end - # Global topology of the streaming Dataflow job, including all - # computations and their sharded locations. + # Global topology of the streaming Dataflow job, including all computations and + # their sharded locations. class TopologyConfig include Google::Apis::Core::Hashable @@ -5735,7 +5743,7 @@ module Google # @return [String] attr_accessor :name - # User names for all collection outputs to this transform. + # User names for all collection outputs to this transform. # Corresponds to the JSON property `outputCollectionName` # @return [Array] attr_accessor :output_collection_name @@ -5780,8 +5788,8 @@ module Google end end - # WorkItem represents basic information about a WorkItem to be executed - # in the cloud. + # WorkItem represents basic information about a WorkItem to be executed in the + # cloud. class WorkItem include Google::Apis::Core::Hashable @@ -5810,17 +5818,16 @@ module Google # @return [String] attr_accessor :lease_expire_time - # MapTask consists of an ordered set of instructions, each of which - # describes one particular low-level operation for the worker to - # perform in order to accomplish the MapTask's WorkItem. - # Each instruction must appear in the list before any instructions which - # depends on its output. + # MapTask consists of an ordered set of instructions, each of which describes + # one particular low-level operation for the worker to perform in order to + # accomplish the MapTask's WorkItem. Each instruction must appear in the list + # before any instructions which depends on its output. # Corresponds to the JSON property `mapTask` # @return [Google::Apis::DataflowV1b3::MapTask] attr_accessor :map_task - # Any required packages that need to be fetched in order to execute - # this WorkItem. + # Any required packages that need to be fetched in order to execute this + # WorkItem. # Corresponds to the JSON property `packages` # @return [Array] attr_accessor :packages @@ -5845,8 +5852,8 @@ module Google # @return [Google::Apis::DataflowV1b3::ShellTask] attr_accessor :shell_task - # A work item that represents the different operations that can be - # performed on a user-defined Source specification. + # A work item that represents the different operations that can be performed on + # a user-defined Source specification. # Corresponds to the JSON property `sourceOperationTask` # @return [Google::Apis::DataflowV1b3::SourceOperationRequest] attr_accessor :source_operation_task @@ -5891,23 +5898,78 @@ module Google end end - # The Dataflow service's idea of the current state of a WorkItem - # being processed by a worker. + # Information about an individual work item execution. + class WorkItemDetails + include Google::Apis::Core::Hashable + + # Attempt ID of this work item + # Corresponds to the JSON property `attemptId` + # @return [String] + attr_accessor :attempt_id + + # End time of this work item attempt. If the work item is completed, this is the + # actual end time of the work item. Otherwise, it is the predicted end time. + # Corresponds to the JSON property `endTime` + # @return [String] + attr_accessor :end_time + + # Metrics for this work item. + # Corresponds to the JSON property `metrics` + # @return [Array] + attr_accessor :metrics + + # Information about the progress of some component of job execution. + # Corresponds to the JSON property `progress` + # @return [Google::Apis::DataflowV1b3::ProgressTimeseries] + attr_accessor :progress + + # Start time of this work item attempt. + # Corresponds to the JSON property `startTime` + # @return [String] + attr_accessor :start_time + + # State of this work item. + # Corresponds to the JSON property `state` + # @return [String] + attr_accessor :state + + # Name of this work item. + # Corresponds to the JSON property `taskId` + # @return [String] + attr_accessor :task_id + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @attempt_id = args[:attempt_id] if args.key?(:attempt_id) + @end_time = args[:end_time] if args.key?(:end_time) + @metrics = args[:metrics] if args.key?(:metrics) + @progress = args[:progress] if args.key?(:progress) + @start_time = args[:start_time] if args.key?(:start_time) + @state = args[:state] if args.key?(:state) + @task_id = args[:task_id] if args.key?(:task_id) + end + end + + # The Dataflow service's idea of the current state of a WorkItem being processed + # by a worker. class WorkItemServiceState 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 `completeWorkStatus` # @return [Google::Apis::DataflowV1b3::Status] attr_accessor :complete_work_status - # Other data returned by the service, specific to the particular - # worker harness. + # Other data returned by the service, specific to the particular worker harness. # Corresponds to the JSON property `harnessData` # @return [Hash] attr_accessor :harness_data @@ -5922,19 +5984,18 @@ module Google # @return [String] attr_accessor :lease_expire_time - # The short ids that workers should use in subsequent metric updates. - # Workers should strive to use short ids whenever possible, but it is ok - # to request the short_id again if a worker lost track of it - # (e.g. if the worker is recovering from a crash). - # NOTE: it is possible that the response may have short ids for a subset - # of the metrics. + # The short ids that workers should use in subsequent metric updates. Workers + # should strive to use short ids whenever possible, but it is ok to request the + # short_id again if a worker lost track of it (e.g. if the worker is recovering + # from a crash). NOTE: it is possible that the response may have short ids for a + # subset of the metrics. # Corresponds to the JSON property `metricShortId` # @return [Array] attr_accessor :metric_short_id - # The index value to use for the next report sent by the worker. - # Note: If the report call fails for whatever reason, the worker should - # reuse this index for subsequent report attempts. + # The index value to use for the next report sent by the worker. Note: If the + # report call fails for whatever reason, the worker should reuse this index for + # subsequent report attempts. # Corresponds to the JSON property `nextReportIndex` # @return [Fixnum] attr_accessor :next_report_index @@ -5954,9 +6015,9 @@ module Google # @return [Google::Apis::DataflowV1b3::ApproximateProgress] attr_accessor :suggested_stop_point - # Position defines a position within a collection of data. The value - # can be either the end position, a key (used with ordered - # collections), a byte offset, or a record index. + # Position defines a position within a collection of data. The value can be + # either the end position, a key (used with ordered collections), a byte offset, + # or a record index. # Corresponds to the JSON property `suggestedStopPosition` # @return [Google::Apis::DataflowV1b3::Position] attr_accessor :suggested_stop_position @@ -5995,16 +6056,15 @@ module Google # @return [Array] attr_accessor :counter_updates - # When a task splits using WorkItemStatus.dynamic_source_split, this - # message describes the two parts of the split relative to the - # description of the current task's input. + # When a task splits using WorkItemStatus.dynamic_source_split, this message + # describes the two parts of the split relative to the description of the + # current task's input. # Corresponds to the JSON property `dynamicSourceSplit` # @return [Google::Apis::DataflowV1b3::DynamicSourceSplit] attr_accessor :dynamic_source_split - # Specifies errors which occurred during processing. If errors are - # provided, and completed = true, then the WorkItem is considered - # to have failed. + # Specifies errors which occurred during processing. If errors are provided, and + # completed = true, then the WorkItem is considered to have failed. # Corresponds to the JSON property `errors` # @return [Array] attr_accessor :errors @@ -6019,16 +6079,14 @@ module Google # @return [Google::Apis::DataflowV1b3::ApproximateProgress] attr_accessor :progress - # The report index. When a WorkItem is leased, the lease will - # contain an initial report index. When a WorkItem's status is - # reported to the system, the report should be sent with - # that report index, and the response will contain the index the - # worker should use for the next report. Reports received with - # unexpected index values will be rejected by the service. - # In order to preserve idempotency, the worker should not alter the - # contents of a report, even if the worker must submit the same - # report multiple times before getting back a response. The worker - # should not submit a subsequent report until the response for the + # The report index. When a WorkItem is leased, the lease will contain an initial + # report index. When a WorkItem's status is reported to the system, the report + # should be sent with that report index, and the response will contain the index + # the worker should use for the next report. Reports received with unexpected + # index values will be rejected by the service. In order to preserve idempotency, + # the worker should not alter the contents of a report, even if the worker must + # submit the same report multiple times before getting back a response. The + # worker should not submit a subsequent report until the response for the # previous report had been received from the service. # Corresponds to the JSON property `reportIndex` # @return [Fixnum] @@ -6050,15 +6108,14 @@ module Google attr_accessor :source_fork # The result of a SourceOperationRequest, specified in - # ReportWorkItemStatusRequest.source_operation when the work item - # is completed. + # ReportWorkItemStatusRequest.source_operation when the work item is completed. # Corresponds to the JSON property `sourceOperationResponse` # @return [Google::Apis::DataflowV1b3::SourceOperationResponse] attr_accessor :source_operation_response - # Position defines a position within a collection of data. The value - # can be either the end position, a key (used with ordered - # collections), a byte offset, or a record index. + # Position defines a position within a collection of data. The value can be + # either the end position, a key (used with ordered collections), a byte offset, + # or a record index. # Corresponds to the JSON property `stopPosition` # @return [Google::Apis::DataflowV1b3::Position] attr_accessor :stop_position @@ -6096,9 +6153,34 @@ module Google end end - # WorkerHealthReport contains information about the health of a worker. - # The VM should be identified by the labels attached to the WorkerMessage that - # this health ping belongs to. + # Information about a worker + class WorkerDetails + include Google::Apis::Core::Hashable + + # Work items processed by this worker, sorted by time. + # Corresponds to the JSON property `workItems` + # @return [Array] + attr_accessor :work_items + + # Name of this worker + # Corresponds to the JSON property `workerName` + # @return [String] + attr_accessor :worker_name + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @work_items = args[:work_items] if args.key?(:work_items) + @worker_name = args[:worker_name] if args.key?(:worker_name) + end + end + + # WorkerHealthReport contains information about the health of a worker. The VM + # should be identified by the labels attached to the WorkerMessage that this + # health ping belongs to. class WorkerHealthReport include Google::Apis::Core::Hashable @@ -6107,24 +6189,22 @@ module Google # @return [String] attr_accessor :msg - # The pods running on the worker. See: - # http://kubernetes.io/v1.1/docs/api-reference/v1/definitions.html#_v1_pod - # This field is used by the worker to send the status of the indvidual - # containers running on each worker. + # The pods running on the worker. See: http://kubernetes.io/v1.1/docs/api- + # reference/v1/definitions.html#_v1_pod This field is used by the worker to send + # the status of the indvidual containers running on each worker. # Corresponds to the JSON property `pods` # @return [Array>] attr_accessor :pods - # The interval at which the worker is sending health reports. - # The default value of 0 should be interpreted as the field is not being - # explicitly set by the worker. + # The interval at which the worker is sending health reports. The default value + # of 0 should be interpreted as the field is not being explicitly set by the + # worker. # Corresponds to the JSON property `reportInterval` # @return [String] attr_accessor :report_interval - # Whether the VM is in a permanently broken state. - # Broken VMs should be abandoned or deleted ASAP to avoid assigning or - # completing any work. + # Whether the VM is in a permanently broken state. Broken VMs should be + # abandoned or deleted ASAP to avoid assigning or completing any work. # Corresponds to the JSON property `vmIsBroken` # @return [Boolean] attr_accessor :vm_is_broken @@ -6156,15 +6236,14 @@ module Google end end - # WorkerHealthReportResponse contains information returned to the worker - # in response to a health ping. + # WorkerHealthReportResponse contains information returned to the worker in + # response to a health ping. class WorkerHealthReportResponse include Google::Apis::Core::Hashable - # A positive value indicates the worker should change its reporting interval - # to the specified value. - # The default value of zero means no change in report rate is requested by - # the server. + # A positive value indicates the worker should change its reporting interval to + # the specified value. The default value of zero means no change in report rate + # is requested by the server. # Corresponds to the JSON property `reportInterval` # @return [String] attr_accessor :report_interval @@ -6179,17 +6258,16 @@ module Google end end - # A report of an event in a worker's lifecycle. - # The proto contains one event, because the worker is expected to - # asynchronously send each message immediately after the event. - # Due to this asynchrony, messages may arrive out of order (or missing), and it - # is up to the consumer to interpret. - # The timestamp of the event is in the enclosing WorkerMessage proto. + # A report of an event in a worker's lifecycle. The proto contains one event, + # because the worker is expected to asynchronously send each message immediately + # after the event. Due to this asynchrony, messages may arrive out of order (or + # missing), and it is up to the consumer to interpret. The timestamp of the + # event is in the enclosing WorkerMessage proto. class WorkerLifecycleEvent include Google::Apis::Core::Hashable - # The start time of this container. All events will report this so that - # events can be grouped together across container/VM restarts. + # The start time of this container. All events will report this so that events + # can be grouped together across container/VM restarts. # Corresponds to the JSON property `containerStartTime` # @return [String] attr_accessor :container_start_time @@ -6199,8 +6277,7 @@ module Google # @return [String] attr_accessor :event - # Other stats that can accompany an event. E.g. - # ` "downloaded_bytes" : "123456" ` + # Other stats that can accompany an event. E.g. ` "downloaded_bytes" : "123456" ` # Corresponds to the JSON property `metadata` # @return [Hash] attr_accessor :metadata @@ -6221,16 +6298,12 @@ module Google class WorkerMessage include Google::Apis::Core::Hashable - # Labels are used to group WorkerMessages. - # For example, a worker_message about a particular container - # might have the labels: - # ` "JOB_ID": "2015-04-22", - # "WORKER_ID": "wordcount-vm-2015…" - # "CONTAINER_TYPE": "worker", - # "CONTAINER_ID": "ac1234def"` - # Label tags typically correspond to Label enum values. However, for ease - # of development other strings can be used as tags. LABEL_UNSPECIFIED should - # not be used here. + # Labels are used to group WorkerMessages. For example, a worker_message about a + # particular container might have the labels: ` "JOB_ID": "2015-04-22", " + # WORKER_ID": "wordcount-vm-2015…" "CONTAINER_TYPE": "worker", "CONTAINER_ID": " + # ac1234def"` Label tags typically correspond to Label enum values. However, for + # ease of development other strings can be used as tags. LABEL_UNSPECIFIED + # should not be used here. # Corresponds to the JSON property `labels` # @return [Hash] attr_accessor :labels @@ -6240,45 +6313,40 @@ module Google # @return [String] attr_accessor :time - # WorkerHealthReport contains information about the health of a worker. - # The VM should be identified by the labels attached to the WorkerMessage that - # this health ping belongs to. + # WorkerHealthReport contains information about the health of a worker. The VM + # should be identified by the labels attached to the WorkerMessage that this + # health ping belongs to. # Corresponds to the JSON property `workerHealthReport` # @return [Google::Apis::DataflowV1b3::WorkerHealthReport] attr_accessor :worker_health_report - # A report of an event in a worker's lifecycle. - # The proto contains one event, because the worker is expected to - # asynchronously send each message immediately after the event. - # Due to this asynchrony, messages may arrive out of order (or missing), and it - # is up to the consumer to interpret. - # The timestamp of the event is in the enclosing WorkerMessage proto. + # A report of an event in a worker's lifecycle. The proto contains one event, + # because the worker is expected to asynchronously send each message immediately + # after the event. Due to this asynchrony, messages may arrive out of order (or + # missing), and it is up to the consumer to interpret. The timestamp of the + # event is in the enclosing WorkerMessage proto. # Corresponds to the JSON property `workerLifecycleEvent` # @return [Google::Apis::DataflowV1b3::WorkerLifecycleEvent] attr_accessor :worker_lifecycle_event - # A message code is used to report status and error messages to the service. - # The message codes are intended to be machine readable. The service will - # take care of translating these into user understandable messages if - # necessary. - # Example use cases: - # 1. Worker processes reporting successful startup. - # 2. Worker processes reporting specific errors (e.g. package staging - # failure). + # A message code is used to report status and error messages to the service. The + # message codes are intended to be machine readable. The service will take care + # of translating these into user understandable messages if necessary. Example + # use cases: 1. Worker processes reporting successful startup. 2. Worker + # processes reporting specific errors (e.g. package staging failure). # Corresponds to the JSON property `workerMessageCode` # @return [Google::Apis::DataflowV1b3::WorkerMessageCode] attr_accessor :worker_message_code # Worker metrics exported from workers. This contains resource utilization - # metrics accumulated from a variety of sources. For more information, see - # go/df-resource-signals. + # metrics accumulated from a variety of sources. For more information, see go/df- + # resource-signals. # Corresponds to the JSON property `workerMetrics` # @return [Google::Apis::DataflowV1b3::ResourceUtilizationReport] attr_accessor :worker_metrics - # Shutdown notification from workers. This is to be sent by the shutdown - # script of the worker VM so that the backend knows that the VM is being - # shut down. + # Shutdown notification from workers. This is to be sent by the shutdown script + # of the worker VM so that the backend knows that the VM is being shut down. # Corresponds to the JSON property `workerShutdownNotice` # @return [Google::Apis::DataflowV1b3::WorkerShutdownNotice] attr_accessor :worker_shutdown_notice @@ -6299,46 +6367,35 @@ module Google end end - # A message code is used to report status and error messages to the service. - # The message codes are intended to be machine readable. The service will - # take care of translating these into user understandable messages if - # necessary. - # Example use cases: - # 1. Worker processes reporting successful startup. - # 2. Worker processes reporting specific errors (e.g. package staging - # failure). + # A message code is used to report status and error messages to the service. The + # message codes are intended to be machine readable. The service will take care + # of translating these into user understandable messages if necessary. Example + # use cases: 1. Worker processes reporting successful startup. 2. Worker + # processes reporting specific errors (e.g. package staging failure). class WorkerMessageCode include Google::Apis::Core::Hashable - # The code is a string intended for consumption by a machine that identifies - # the type of message being sent. - # Examples: - # 1. "HARNESS_STARTED" might be used to indicate the worker harness has - # started. - # 2. "GCS_DOWNLOAD_ERROR" might be used to indicate an error downloading - # a GCS file as part of the boot process of one of the worker containers. - # This is a string and not an enum to make it easy to add new codes without - # waiting for an API change. + # The code is a string intended for consumption by a machine that identifies the + # type of message being sent. Examples: 1. "HARNESS_STARTED" might be used to + # indicate the worker harness has started. 2. "GCS_DOWNLOAD_ERROR" might be used + # to indicate an error downloading a GCS file as part of the boot process of one + # of the worker containers. This is a string and not an enum to make it easy to + # add new codes without waiting for an API change. # Corresponds to the JSON property `code` # @return [String] attr_accessor :code - # Parameters contains specific information about the code. - # This is a struct to allow parameters of different types. - # Examples: - # 1. For a "HARNESS_STARTED" message parameters might provide the name - # of the worker and additional data like timing information. - # 2. For a "GCS_DOWNLOAD_ERROR" parameters might contain fields listing - # the GCS objects being downloaded and fields containing errors. - # In general complex data structures should be avoided. If a worker - # needs to send a specific and complicated data structure then please - # consider defining a new proto and adding it to the data oneof in - # WorkerMessageResponse. - # Conventions: - # Parameters should only be used for information that isn't typically passed - # as a label. - # hostname and other worker identifiers should almost always be passed - # as labels since they will be included on most messages. + # Parameters contains specific information about the code. This is a struct to + # allow parameters of different types. Examples: 1. For a "HARNESS_STARTED" + # message parameters might provide the name of the worker and additional data + # like timing information. 2. For a "GCS_DOWNLOAD_ERROR" parameters might + # contain fields listing the GCS objects being downloaded and fields containing + # errors. In general complex data structures should be avoided. If a worker + # needs to send a specific and complicated data structure then please consider + # defining a new proto and adding it to the data oneof in WorkerMessageResponse. + # Conventions: Parameters should only be used for information that isn't + # typically passed as a label. hostname and other worker identifiers should + # almost always be passed as labels since they will be included on most messages. # Corresponds to the JSON property `parameters` # @return [Hash] attr_accessor :parameters @@ -6354,13 +6411,12 @@ module Google end end - # A worker_message response allows the server to pass information to the - # sender. + # A worker_message response allows the server to pass information to the sender. class WorkerMessageResponse include Google::Apis::Core::Hashable - # WorkerHealthReportResponse contains information returned to the worker - # in response to a health ping. + # WorkerHealthReportResponse contains information returned to the worker in + # response to a health ping. # Corresponds to the JSON property `workerHealthReportResponse` # @return [Google::Apis::DataflowV1b3::WorkerHealthReportResponse] attr_accessor :worker_health_report_response @@ -6387,11 +6443,10 @@ module Google end end - # Describes one particular pool of Cloud Dataflow workers to be - # instantiated by the Cloud Dataflow service in order to perform the - # computations required by a job. Note that a workflow job may use - # multiple pools, in order to match the various computational - # requirements of the various stages of the job. + # Describes one particular pool of Cloud Dataflow workers to be instantiated by + # the Cloud Dataflow service in order to perform the computations required by a + # job. Note that a workflow job may use multiple pools, in order to match the + # various computational requirements of the various stages of the job. class WorkerPool include Google::Apis::Core::Hashable @@ -6405,14 +6460,14 @@ module Google # @return [Array] attr_accessor :data_disks - # The default package set to install. This allows the service to - # select a default set of packages which are useful to worker - # harnesses written in a particular language. + # The default package set to install. This allows the service to select a + # default set of packages which are useful to worker harnesses written in a + # particular language. # Corresponds to the JSON property `defaultPackageSet` # @return [String] attr_accessor :default_package_set - # Size of root disk for VMs, in GB. If zero or unspecified, the service will + # Size of root disk for VMs, in GB. If zero or unspecified, the service will # attempt to choose a reasonable default. # Corresponds to the JSON property `diskSizeGb` # @return [Fixnum] @@ -6423,8 +6478,8 @@ module Google # @return [String] attr_accessor :disk_source_image - # Type of root disk for VMs. If empty or unspecified, the service will - # attempt to choose a reasonable default. + # Type of root disk for VMs. If empty or unspecified, the service will attempt + # to choose a reasonable default. # Corresponds to the JSON property `diskType` # @return [String] attr_accessor :disk_type @@ -6434,14 +6489,14 @@ module Google # @return [String] attr_accessor :ip_configuration - # The kind of the worker pool; currently only `harness` and `shuffle` - # are supported. + # The kind of the worker pool; currently only `harness` and `shuffle` are + # supported. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind - # Machine type (e.g. "n1-standard-1"). If empty or unspecified, the - # service will attempt to choose a reasonable default. + # Machine type (e.g. "n1-standard-1"). If empty or unspecified, the service will + # attempt to choose a reasonable default. # Corresponds to the JSON property `machineType` # @return [String] attr_accessor :machine_type @@ -6451,28 +6506,28 @@ module Google # @return [Hash] attr_accessor :metadata - # Network to which VMs will be assigned. If empty or unspecified, - # the service will use the network "default". + # Network to which VMs will be assigned. If empty or unspecified, the service + # will use the network "default". # Corresponds to the JSON property `network` # @return [String] attr_accessor :network - # The number of threads per worker harness. If empty or unspecified, the - # service will choose a number of threads (according to the number of cores - # on the selected machine type for batch, or 1 by convention for streaming). + # The number of threads per worker harness. If empty or unspecified, the service + # will choose a number of threads (according to the number of cores on the + # selected machine type for batch, or 1 by convention for streaming). # Corresponds to the JSON property `numThreadsPerWorker` # @return [Fixnum] attr_accessor :num_threads_per_worker - # Number of Google Compute Engine workers in this pool needed to - # execute the job. If zero or unspecified, the service will - # attempt to choose a reasonable default. + # Number of Google Compute Engine workers in this pool needed to execute the job. + # If zero or unspecified, the service will attempt to choose a reasonable + # default. # Corresponds to the JSON property `numWorkers` # @return [Fixnum] attr_accessor :num_workers - # The action to take on host maintenance, as defined by the Google - # Compute Engine API. + # The action to take on host maintenance, as defined by the Google Compute + # Engine API. # Corresponds to the JSON property `onHostMaintenance` # @return [String] attr_accessor :on_host_maintenance @@ -6487,16 +6542,15 @@ module Google # @return [Hash] attr_accessor :pool_args - # Set of SDK harness containers needed to execute this pipeline. This will - # only be set in the Fn API path. For non-cross-language pipelines this - # should have only one entry. Cross-language pipelines will have two or more - # entries. + # Set of SDK harness containers needed to execute this pipeline. This will only + # be set in the Fn API path. For non-cross-language pipelines this should have + # only one entry. Cross-language pipelines will have two or more entries. # Corresponds to the JSON property `sdkHarnessContainerImages` # @return [Array] attr_accessor :sdk_harness_container_images - # Subnetwork to which VMs will be assigned, if desired. Expected to be of - # the form "regions/REGION/subnetworks/SUBNETWORK". + # Subnetwork to which VMs will be assigned, if desired. Expected to be of the + # form "regions/REGION/subnetworks/SUBNETWORK". # Corresponds to the JSON property `subnetwork` # @return [String] attr_accessor :subnetwork @@ -6506,18 +6560,15 @@ module Google # @return [Google::Apis::DataflowV1b3::TaskRunnerSettings] attr_accessor :taskrunner_settings - # Sets the policy for determining when to turndown worker pool. - # Allowed values are: `TEARDOWN_ALWAYS`, `TEARDOWN_ON_SUCCESS`, and - # `TEARDOWN_NEVER`. - # `TEARDOWN_ALWAYS` means workers are always torn down regardless of whether - # the job succeeds. `TEARDOWN_ON_SUCCESS` means workers are torn down - # if the job succeeds. `TEARDOWN_NEVER` means the workers are never torn - # down. - # If the workers are not torn down by the service, they will - # continue to run and use Google Compute Engine VM resources in the - # user's project until they are explicitly terminated by the user. - # Because of this, Google recommends using the `TEARDOWN_ALWAYS` - # policy except for small, manually supervised test jobs. + # Sets the policy for determining when to turndown worker pool. Allowed values + # are: `TEARDOWN_ALWAYS`, `TEARDOWN_ON_SUCCESS`, and `TEARDOWN_NEVER`. ` + # TEARDOWN_ALWAYS` means workers are always torn down regardless of whether the + # job succeeds. `TEARDOWN_ON_SUCCESS` means workers are torn down if the job + # succeeds. `TEARDOWN_NEVER` means the workers are never torn down. If the + # workers are not torn down by the service, they will continue to run and use + # Google Compute Engine VM resources in the user's project until they are + # explicitly terminated by the user. Because of this, Google recommends using + # the `TEARDOWN_ALWAYS` policy except for small, manually supervised test jobs. # If unknown or unspecified, the service will attempt to choose a reasonable # default. # Corresponds to the JSON property `teardownPolicy` @@ -6525,14 +6576,14 @@ module Google attr_accessor :teardown_policy # Required. Docker container image that executes the Cloud Dataflow worker - # harness, residing in Google Container Registry. - # Deprecated for the Fn API path. Use sdk_harness_container_images instead. + # harness, residing in Google Container Registry. Deprecated for the Fn API path. + # Use sdk_harness_container_images instead. # Corresponds to the JSON property `workerHarnessContainerImage` # @return [String] attr_accessor :worker_harness_container_image - # Zone to run the worker pools in. If empty or unspecified, the service - # will attempt to choose a reasonable default. + # Zone to run the worker pools in. If empty or unspecified, the service will + # attempt to choose a reasonable default. # Corresponds to the JSON property `zone` # @return [String] attr_accessor :zone @@ -6572,12 +6623,10 @@ module Google class WorkerSettings include Google::Apis::Core::Hashable - # The base URL for accessing Google Cloud APIs. - # When workers access Google Cloud APIs, they logically do so via - # relative URLs. If this field is specified, it supplies the base - # URL to use for resolving these relative URLs. The normative - # algorithm used is defined by RFC 1808, "Relative Uniform Resource - # Locators". + # The base URL for accessing Google Cloud APIs. When workers access Google Cloud + # APIs, they logically do so via relative URLs. If this field is specified, it + # supplies the base URL to use for resolving these relative URLs. The normative + # algorithm used is defined by RFC 1808, "Relative Uniform Resource Locators". # If not specified, the default value is "http://www.googleapis.com/" # Corresponds to the JSON property `baseUrl` # @return [String] @@ -6589,24 +6638,21 @@ module Google attr_accessor :reporting_enabled alias_method :reporting_enabled?, :reporting_enabled - # The Cloud Dataflow service path relative to the root URL, for example, - # "dataflow/v1b3/projects". + # The Cloud Dataflow service path relative to the root URL, for example, " + # dataflow/v1b3/projects". # Corresponds to the JSON property `servicePath` # @return [String] attr_accessor :service_path - # The Shuffle service path relative to the root URL, for example, - # "shuffle/v1beta1". + # The Shuffle service path relative to the root URL, for example, "shuffle/ + # v1beta1". # Corresponds to the JSON property `shuffleServicePath` # @return [String] attr_accessor :shuffle_service_path - # The prefix of the resources the system should use for temporary - # storage. - # The supported resource type is: - # Google Cloud Storage: - # storage.googleapis.com/`bucket`/`object` - # bucket.storage.googleapis.com/`object` + # The prefix of the resources the system should use for temporary storage. The + # supported resource type is: Google Cloud Storage: storage.googleapis.com/` + # bucket`/`object` bucket.storage.googleapis.com/`object` # Corresponds to the JSON property `tempStoragePrefix` # @return [String] attr_accessor :temp_storage_prefix @@ -6631,17 +6677,14 @@ module Google end end - # Shutdown notification from workers. This is to be sent by the shutdown - # script of the worker VM so that the backend knows that the VM is being - # shut down. + # Shutdown notification from workers. This is to be sent by the shutdown script + # of the worker VM so that the backend knows that the VM is being shut down. class WorkerShutdownNotice include Google::Apis::Core::Hashable - # The reason for the worker shutdown. - # Current possible values are: - # "UNKNOWN": shutdown reason is unknown. - # "PREEMPTION": shutdown reason is preemption. - # Other possible reasons may be added in the future. + # The reason for the worker shutdown. Current possible values are: "UNKNOWN": + # shutdown reason is unknown. "PREEMPTION": shutdown reason is preemption. Other + # possible reasons may be added in the future. # Corresponds to the JSON property `reason` # @return [String] attr_accessor :reason @@ -6669,13 +6712,12 @@ module Google end end - # An instruction that writes records. - # Takes one input, produces no outputs. + # An instruction that writes records. Takes one input, produces no outputs. class WriteInstruction include Google::Apis::Core::Hashable - # An input of an instruction, as a reference to an output of a - # producer instruction. + # An input of an instruction, as a reference to an output of a producer + # instruction. # Corresponds to the JSON property `input` # @return [Google::Apis::DataflowV1b3::InstructionInput] attr_accessor :input diff --git a/generated/google/apis/dataflow_v1b3/representations.rb b/generated/google/apis/dataflow_v1b3/representations.rb index b62ecb389..a0578c07b 100644 --- a/generated/google/apis/dataflow_v1b3/representations.rb +++ b/generated/google/apis/dataflow_v1b3/representations.rb @@ -322,6 +322,12 @@ module Google include Google::Apis::Core::JsonObjectSupport end + class JobExecutionDetails + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class JobExecutionInfo class Representation < Google::Apis::Core::JsonRepresentation; end @@ -544,12 +550,24 @@ module Google include Google::Apis::Core::JsonObjectSupport end + class Point + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class Position class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end + class ProgressTimeseries + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class PubSubIoDetails class Representation < Google::Apis::Core::JsonRepresentation; end @@ -784,12 +802,24 @@ module Google include Google::Apis::Core::JsonObjectSupport end + class StageExecutionDetails + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class StageSource class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end + class StageSummary + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class StateFamilyConfig class Representation < Google::Apis::Core::JsonRepresentation; end @@ -916,6 +946,12 @@ module Google include Google::Apis::Core::JsonObjectSupport end + class WorkItemDetails + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class WorkItemServiceState class Representation < Google::Apis::Core::JsonRepresentation; end @@ -928,6 +964,12 @@ module Google include Google::Apis::Core::JsonObjectSupport end + class WorkerDetails + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class WorkerHealthReport class Representation < Google::Apis::Core::JsonRepresentation; end @@ -1548,6 +1590,14 @@ module Google end end + class JobExecutionDetails + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :stages, as: 'stages', class: Google::Apis::DataflowV1b3::StageSummary, decorator: Google::Apis::DataflowV1b3::StageSummary::Representation + + end + end + class JobExecutionInfo # @private class Representation < Google::Apis::Core::JsonRepresentation @@ -1930,6 +1980,14 @@ module Google end end + class Point + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :time, as: 'time' + property :value, as: 'value' + end + end + class Position # @private class Representation < Google::Apis::Core::JsonRepresentation @@ -1943,6 +2001,15 @@ module Google end end + class ProgressTimeseries + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :current_progress, as: 'currentProgress' + collection :data_points, as: 'dataPoints', class: Google::Apis::DataflowV1b3::Point, decorator: Google::Apis::DataflowV1b3::Point::Representation + + end + end + class PubSubIoDetails # @private class Representation < Google::Apis::Core::JsonRepresentation @@ -2041,6 +2108,7 @@ module Google collection :additional_experiments, as: 'additionalExperiments' hash :additional_user_labels, as: 'additionalUserLabels' property :bypass_temp_dir_validation, as: 'bypassTempDirValidation' + property :enable_streaming_engine, as: 'enableStreamingEngine' property :ip_configuration, as: 'ipConfiguration' property :kms_key_name, as: 'kmsKeyName' property :machine_type, as: 'machineType' @@ -2329,6 +2397,15 @@ module Google end end + class StageExecutionDetails + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :next_page_token, as: 'nextPageToken' + collection :workers, as: 'workers', class: Google::Apis::DataflowV1b3::WorkerDetails, decorator: Google::Apis::DataflowV1b3::WorkerDetails::Representation + + end + end + class StageSource # @private class Representation < Google::Apis::Core::JsonRepresentation @@ -2339,6 +2416,20 @@ module Google end end + class StageSummary + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :end_time, as: 'endTime' + collection :metrics, as: 'metrics', class: Google::Apis::DataflowV1b3::MetricUpdate, decorator: Google::Apis::DataflowV1b3::MetricUpdate::Representation + + property :progress, as: 'progress', class: Google::Apis::DataflowV1b3::ProgressTimeseries, decorator: Google::Apis::DataflowV1b3::ProgressTimeseries::Representation + + property :stage_id, as: 'stageId' + property :start_time, as: 'startTime' + property :state, as: 'state' + end + end + class StateFamilyConfig # @private class Representation < Google::Apis::Core::JsonRepresentation @@ -2594,6 +2685,21 @@ module Google end end + class WorkItemDetails + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :attempt_id, as: 'attemptId' + property :end_time, as: 'endTime' + collection :metrics, as: 'metrics', class: Google::Apis::DataflowV1b3::MetricUpdate, decorator: Google::Apis::DataflowV1b3::MetricUpdate::Representation + + property :progress, as: 'progress', class: Google::Apis::DataflowV1b3::ProgressTimeseries, decorator: Google::Apis::DataflowV1b3::ProgressTimeseries::Representation + + property :start_time, as: 'startTime' + property :state, as: 'state' + property :task_id, as: 'taskId' + end + end + class WorkItemServiceState # @private class Representation < Google::Apis::Core::JsonRepresentation @@ -2645,6 +2751,15 @@ module Google end end + class WorkerDetails + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :work_items, as: 'workItems', class: Google::Apis::DataflowV1b3::WorkItemDetails, decorator: Google::Apis::DataflowV1b3::WorkItemDetails::Representation + + property :worker_name, as: 'workerName' + end + end + class WorkerHealthReport # @private class Representation < Google::Apis::Core::JsonRepresentation diff --git a/generated/google/apis/dataflow_v1b3/service.rb b/generated/google/apis/dataflow_v1b3/service.rb index 71816adce..7b8b3b34d 100644 --- a/generated/google/apis/dataflow_v1b3/service.rb +++ b/generated/google/apis/dataflow_v1b3/service.rb @@ -120,8 +120,8 @@ module Google # spanner table. Requires project_id and display_name (template). # @param [String] name # The location of the template, name includes project_id and display_name. - # Commit using project_id(pid1) and display_name(tid1). - # Format: projects/`pid1`/catalogTemplates/`tid1` + # Commit using project_id(pid1) and display_name(tid1). Format: projects/`pid1`/ + # catalogTemplates/`tid1` # @param [Google::Apis::DataflowV1b3::CommitTemplateVersionRequest] commit_template_version_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -154,9 +154,8 @@ module Google # Deletes an existing Template. Do nothing if Template does not exist. # @param [String] name - # name includes project_id and display_name. - # Delete by project_id(pid1) and display_name(tid1). - # Format: projects/`pid1`/catalogTemplates/`tid1` + # name includes project_id and display_name. Delete by project_id(pid1) and + # display_name(tid1). Format: projects/`pid1`/catalogTemplates/`tid1` # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -185,15 +184,14 @@ module Google end # Get TemplateVersion using project_id and display_name with an optional - # version_id field. Get latest (has tag "latest") TemplateVersion if - # version_id not set. + # version_id field. Get latest (has tag "latest") TemplateVersion if version_id + # not set. # @param [String] name # Resource name includes project_id and display_name. version_id is optional. - # Get the latest TemplateVersion if version_id not set. - # Get by project_id(pid1) and display_name(tid1): - # Format: projects/`pid1`/catalogTemplates/`tid1` - # Get by project_id(pid1), display_name(tid1), and version_id(vid1): - # Format: projects/`pid1`/catalogTemplates/`tid1@vid` + # Get the latest TemplateVersion if version_id not set. Get by project_id(pid1) + # and display_name(tid1): Format: projects/`pid1`/catalogTemplates/`tid1` Get by + # project_id(pid1), display_name(tid1), and version_id(vid1): Format: projects/` + # pid1`/catalogTemplates/`tid1@vid` # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -221,12 +219,12 @@ module Google execute_or_queue_command(command, &block) end - # Updates the label of the TemplateVersion. Label can be duplicated in - # Template, so either add or remove the label in the TemplateVersion. + # Updates the label of the TemplateVersion. Label can be duplicated in Template, + # so either add or remove the label in the TemplateVersion. # @param [String] name - # Resource name includes project_id, display_name, and version_id. - # Updates by project_id(pid1), display_name(tid1), and version_id(vid1): - # Format: projects/`pid1`/catalogTemplates/`tid1@vid` + # Resource name includes project_id, display_name, and version_id. Updates by + # project_id(pid1), display_name(tid1), and version_id(vid1): Format: projects/` + # pid1`/catalogTemplates/`tid1@vid` # @param [Google::Apis::DataflowV1b3::ModifyTemplateVersionLabelRequest] modify_template_version_label_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -257,15 +255,15 @@ module Google execute_or_queue_command(command, &block) end - # Updates the tag of the TemplateVersion, and tag is unique in Template. - # If tag exists in another TemplateVersion in the Template, updates the tag - # to this TemplateVersion will remove it from the old TemplateVersion and add - # it to this TemplateVersion. If request is remove_only (remove_only = true), - # remove the tag from this TemplateVersion. + # Updates the tag of the TemplateVersion, and tag is unique in Template. If tag + # exists in another TemplateVersion in the Template, updates the tag to this + # TemplateVersion will remove it from the old TemplateVersion and add it to this + # TemplateVersion. If request is remove_only (remove_only = true), remove the + # tag from this TemplateVersion. # @param [String] name - # Resource name includes project_id, display_name, and version_id. - # Updates by project_id(pid1), display_name(tid1), and version_id(vid1): - # Format: projects/`pid1`/catalogTemplates/`tid1@vid` + # Resource name includes project_id, display_name, and version_id. Updates by + # project_id(pid1), display_name(tid1), and version_id(vid1): Format: projects/` + # pid1`/catalogTemplates/`tid1@vid` # @param [Google::Apis::DataflowV1b3::ModifyTemplateVersionTagRequest] modify_template_version_tag_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -296,14 +294,13 @@ module Google execute_or_queue_command(command, &block) end - # Creates a new Template with TemplateVersion. Requires - # project_id(projects) and template display_name(catalogTemplates). - # The template display_name is set by the user. + # Creates a new Template with TemplateVersion. Requires project_id(projects) and + # template display_name(catalogTemplates). The template display_name is set by + # the user. # @param [String] parent - # The parent project and template that the TemplateVersion will be created - # under. - # Create using project_id(pid1) and display_name(tid1). - # Format: projects/`pid1`/catalogTemplates/`tid1` + # The parent project and template that the TemplateVersion will be created under. + # Create using project_id(pid1) and display_name(tid1). Format: projects/`pid1`/ + # catalogTemplates/`tid1` # @param [Google::Apis::DataflowV1b3::CreateTemplateVersionRequest] create_template_version_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -340,16 +337,15 @@ module Google # @param [String] filter # The kind of filter to use. # @param [String] location - # The [regional endpoint] - # (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) that - # contains this job. + # The [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/ + # regional-endpoints) that contains this job. # @param [Fixnum] page_size - # If there are many jobs, limit response to at most this many. - # The actual number of jobs returned will be the lesser of max_responses - # and an unspecified server-defined limit. + # If there are many jobs, limit response to at most this many. The actual number + # of jobs returned will be the lesser of max_responses and an unspecified server- + # defined limit. # @param [String] page_token - # Set this to the 'next_page_token' field of a previous response - # to request additional results in a long list. + # Set this to the 'next_page_token' field of a previous response to request + # additional results in a long list. # @param [String] view # Level of information requested in response. Default is `JOB_VIEW_SUMMARY`. # @param [String] fields @@ -384,19 +380,16 @@ module Google execute_or_queue_command(command, &block) end - # Creates a Cloud Dataflow job. - # To create a job, we recommend using `projects.locations.jobs.create` with a - # [regional endpoint] - # (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints). Using - # `projects.jobs.create` is not recommended, as your job will always start - # in `us-central1`. + # Creates a Cloud Dataflow job. To create a job, we recommend using `projects. + # locations.jobs.create` with a [regional endpoint] (https://cloud.google.com/ + # dataflow/docs/concepts/regional-endpoints). Using `projects.jobs.create` is + # not recommended, as your job will always start in `us-central1`. # @param [String] project_id # The ID of the Cloud Platform project that the job belongs to. # @param [Google::Apis::DataflowV1b3::Job] job_object # @param [String] location - # The [regional endpoint] - # (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) that - # contains this job. + # The [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/ + # regional-endpoints) that contains this job. # @param [String] replace_job_id # Deprecated. This field is now in the Job message. # @param [String] view @@ -433,20 +426,18 @@ module Google execute_or_queue_command(command, &block) end - # Gets the state of the specified Cloud Dataflow job. - # To get the state of a job, we recommend using `projects.locations.jobs.get` - # with a [regional endpoint] - # (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints). Using - # `projects.jobs.get` is not recommended, as you can only get the state of - # jobs that are running in `us-central1`. + # Gets the state of the specified Cloud Dataflow job. To get the state of a job, + # we recommend using `projects.locations.jobs.get` with a [regional endpoint] ( + # https://cloud.google.com/dataflow/docs/concepts/regional-endpoints). Using ` + # projects.jobs.get` is not recommended, as you can only get the state of jobs + # that are running in `us-central1`. # @param [String] project_id # The ID of the Cloud Platform project that the job belongs to. # @param [String] job_id # The job ID. # @param [String] location - # The [regional endpoint] - # (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) that - # contains this job. + # The [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/ + # regional-endpoints) that contains this job. # @param [String] view # The level of information requested in response. # @param [String] fields @@ -479,23 +470,21 @@ module Google execute_or_queue_command(command, &block) end - # Request the job status. - # To request the status of a job, we recommend using - # `projects.locations.jobs.getMetrics` with a [regional endpoint] - # (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints). Using - # `projects.jobs.getMetrics` is not recommended, as you can only request the - # status of jobs that are running in `us-central1`. + # Request the job status. To request the status of a job, we recommend using ` + # projects.locations.jobs.getMetrics` with a [regional endpoint] (https://cloud. + # google.com/dataflow/docs/concepts/regional-endpoints). Using `projects.jobs. + # getMetrics` is not recommended, as you can only request the status of jobs + # that are running in `us-central1`. # @param [String] project_id # A project id. # @param [String] job_id - # The job to get messages for. + # The job to get metrics for. # @param [String] location - # The [regional endpoint] - # (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) that - # contains the job specified by job_id. + # The [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/ + # regional-endpoints) that contains the job specified by job_id. # @param [String] start_time - # Return only metric data that has changed since this time. - # Default is to return all information about all metrics for the job. + # Return only metric data that has changed since this time. Default is to return + # all information about all metrics for the job. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -526,28 +515,26 @@ module Google execute_or_queue_command(command, &block) end - # List the jobs of a project. - # To list the jobs of a project in a region, we recommend using - # `projects.locations.jobs.list` with a [regional endpoint] - # (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints). To - # list the all jobs across all regions, use `projects.jobs.aggregated`. Using - # `projects.jobs.list` is not recommended, as you can only get the list of - # jobs that are running in `us-central1`. + # List the jobs of a project. To list the jobs of a project in a region, we + # recommend using `projects.locations.jobs.list` with a [regional endpoint] ( + # https://cloud.google.com/dataflow/docs/concepts/regional-endpoints). To list + # the all jobs across all regions, use `projects.jobs.aggregated`. Using ` + # projects.jobs.list` is not recommended, as you can only get the list of jobs + # that are running in `us-central1`. # @param [String] project_id # The project which owns the jobs. # @param [String] filter # The kind of filter to use. # @param [String] location - # The [regional endpoint] - # (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) that - # contains this job. + # The [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/ + # regional-endpoints) that contains this job. # @param [Fixnum] page_size - # If there are many jobs, limit response to at most this many. - # The actual number of jobs returned will be the lesser of max_responses - # and an unspecified server-defined limit. + # If there are many jobs, limit response to at most this many. The actual number + # of jobs returned will be the lesser of max_responses and an unspecified server- + # defined limit. # @param [String] page_token - # Set this to the 'next_page_token' field of a previous response - # to request additional results in a long list. + # Set this to the 'next_page_token' field of a previous response to request + # additional results in a long list. # @param [String] view # Level of information requested in response. Default is `JOB_VIEW_SUMMARY`. # @param [String] fields @@ -618,21 +605,19 @@ module Google execute_or_queue_command(command, &block) end - # Updates the state of an existing Cloud Dataflow job. - # To update the state of an existing job, we recommend using - # `projects.locations.jobs.update` with a [regional endpoint] - # (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints). Using - # `projects.jobs.update` is not recommended, as you can only update the state - # of jobs that are running in `us-central1`. + # Updates the state of an existing Cloud Dataflow job. To update the state of an + # existing job, we recommend using `projects.locations.jobs.update` with a [ + # regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional- + # endpoints). Using `projects.jobs.update` is not recommended, as you can only + # update the state of jobs that are running in `us-central1`. # @param [String] project_id # The ID of the Cloud Platform project that the job belongs to. # @param [String] job_id # The job ID. # @param [Google::Apis::DataflowV1b3::Job] job_object # @param [String] location - # The [regional endpoint] - # (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) that - # contains this job. + # The [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/ + # regional-endpoints) that contains this job. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -736,36 +721,33 @@ module Google execute_or_queue_command(command, &block) end - # Request the job status. - # To request the status of a job, we recommend using - # `projects.locations.jobs.messages.list` with a [regional endpoint] - # (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints). Using - # `projects.jobs.messages.list` is not recommended, as you can only request - # the status of jobs that are running in `us-central1`. + # Request the job status. To request the status of a job, we recommend using ` + # projects.locations.jobs.messages.list` with a [regional endpoint] (https:// + # cloud.google.com/dataflow/docs/concepts/regional-endpoints). Using `projects. + # jobs.messages.list` is not recommended, as you can only request the status of + # jobs that are running in `us-central1`. # @param [String] project_id # A project id. # @param [String] job_id # The job to get messages about. # @param [String] end_time - # Return only messages with timestamps < end_time. The default is now - # (i.e. return up to the latest messages available). + # Return only messages with timestamps < end_time. The default is now (i.e. + # return up to the latest messages available). # @param [String] location - # The [regional endpoint] - # (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) that - # contains the job specified by job_id. + # The [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/ + # regional-endpoints) that contains the job specified by job_id. # @param [String] minimum_importance # Filter to only get messages with importance >= level # @param [Fixnum] page_size - # If specified, determines the maximum number of messages to - # return. If unspecified, the service may choose an appropriate - # default, or may return an arbitrarily large number of results. + # If specified, determines the maximum number of messages to return. If + # unspecified, the service may choose an appropriate default, or may return an + # arbitrarily large number of results. # @param [String] page_token - # If supplied, this should be the value of next_page_token returned - # by an earlier call. This will cause the next page of results to - # be returned. + # If supplied, this should be the value of next_page_token returned by an + # earlier call. This will cause the next page of results to be returned. # @param [String] start_time - # If specified, return only messages with timestamps >= start_time. - # The default is the job creation time (i.e. beginning of messages). + # If specified, return only messages with timestamps >= start_time. The default + # is the job creation time (i.e. beginning of messages). # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -876,9 +858,8 @@ module Google # @param [String] project_id # The project to send the WorkerMessages to. # @param [String] location - # The [regional endpoint] - # (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) that - # contains the job. + # The [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/ + # regional-endpoints) that contains the job. # @param [Google::Apis::DataflowV1b3::SendWorkerMessagesRequest] send_worker_messages_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -914,9 +895,9 @@ module Google # @param [String] project_id # Required. The ID of the Cloud Platform project that the job belongs to. # @param [String] location - # Required. The [regional endpoint] - # (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) to - # which to direct the request. E.g., us-central1, us-west1. + # Required. The [regional endpoint] (https://cloud.google.com/dataflow/docs/ + # concepts/regional-endpoints) to which to direct the request. E.g., us-central1, + # us-west1. # @param [Google::Apis::DataflowV1b3::LaunchFlexTemplateRequest] launch_flex_template_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -948,18 +929,15 @@ module Google execute_or_queue_command(command, &block) end - # Creates a Cloud Dataflow job. - # To create a job, we recommend using `projects.locations.jobs.create` with a - # [regional endpoint] - # (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints). Using - # `projects.jobs.create` is not recommended, as your job will always start - # in `us-central1`. + # Creates a Cloud Dataflow job. To create a job, we recommend using `projects. + # locations.jobs.create` with a [regional endpoint] (https://cloud.google.com/ + # dataflow/docs/concepts/regional-endpoints). Using `projects.jobs.create` is + # not recommended, as your job will always start in `us-central1`. # @param [String] project_id # The ID of the Cloud Platform project that the job belongs to. # @param [String] location - # The [regional endpoint] - # (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) that - # contains this job. + # The [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/ + # regional-endpoints) that contains this job. # @param [Google::Apis::DataflowV1b3::Job] job_object # @param [String] replace_job_id # Deprecated. This field is now in the Job message. @@ -997,18 +975,16 @@ module Google execute_or_queue_command(command, &block) end - # Gets the state of the specified Cloud Dataflow job. - # To get the state of a job, we recommend using `projects.locations.jobs.get` - # with a [regional endpoint] - # (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints). Using - # `projects.jobs.get` is not recommended, as you can only get the state of - # jobs that are running in `us-central1`. + # Gets the state of the specified Cloud Dataflow job. To get the state of a job, + # we recommend using `projects.locations.jobs.get` with a [regional endpoint] ( + # https://cloud.google.com/dataflow/docs/concepts/regional-endpoints). Using ` + # projects.jobs.get` is not recommended, as you can only get the state of jobs + # that are running in `us-central1`. # @param [String] project_id # The ID of the Cloud Platform project that the job belongs to. # @param [String] location - # The [regional endpoint] - # (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) that - # contains this job. + # The [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/ + # regional-endpoints) that contains this job. # @param [String] job_id # The job ID. # @param [String] view @@ -1043,23 +1019,59 @@ module Google execute_or_queue_command(command, &block) end - # Request the job status. - # To request the status of a job, we recommend using - # `projects.locations.jobs.getMetrics` with a [regional endpoint] - # (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints). Using - # `projects.jobs.getMetrics` is not recommended, as you can only request the - # status of jobs that are running in `us-central1`. + # Request detailed information about the execution status of the job. + # EXPERIMENTAL. This API is subject to change or removal without notice. # @param [String] project_id # A project id. # @param [String] location - # The [regional endpoint] - # (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) that - # contains the job specified by job_id. + # The [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/ + # regional-endpoints) that contains the job specified by job_id. # @param [String] job_id - # The job to get messages for. + # The job to get execution details for. + # @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::DataflowV1b3::JobExecutionDetails] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DataflowV1b3::JobExecutionDetails] + # + # @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_location_job_execution_details(project_id, location, job_id, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v1b3/projects/{projectId}/locations/{location}/jobs/{jobId}/executionDetails', options) + command.response_representation = Google::Apis::DataflowV1b3::JobExecutionDetails::Representation + command.response_class = Google::Apis::DataflowV1b3::JobExecutionDetails + command.params['projectId'] = project_id unless project_id.nil? + command.params['location'] = location unless location.nil? + command.params['jobId'] = job_id unless job_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 + + # Request the job status. To request the status of a job, we recommend using ` + # projects.locations.jobs.getMetrics` with a [regional endpoint] (https://cloud. + # google.com/dataflow/docs/concepts/regional-endpoints). Using `projects.jobs. + # getMetrics` is not recommended, as you can only request the status of jobs + # that are running in `us-central1`. + # @param [String] project_id + # A project id. + # @param [String] location + # The [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/ + # regional-endpoints) that contains the job specified by job_id. + # @param [String] job_id + # The job to get metrics for. # @param [String] start_time - # Return only metric data that has changed since this time. - # Default is to return all information about all metrics for the job. + # Return only metric data that has changed since this time. Default is to return + # all information about all metrics for the job. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -1090,28 +1102,26 @@ module Google execute_or_queue_command(command, &block) end - # List the jobs of a project. - # To list the jobs of a project in a region, we recommend using - # `projects.locations.jobs.list` with a [regional endpoint] - # (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints). To - # list the all jobs across all regions, use `projects.jobs.aggregated`. Using - # `projects.jobs.list` is not recommended, as you can only get the list of - # jobs that are running in `us-central1`. + # List the jobs of a project. To list the jobs of a project in a region, we + # recommend using `projects.locations.jobs.list` with a [regional endpoint] ( + # https://cloud.google.com/dataflow/docs/concepts/regional-endpoints). To list + # the all jobs across all regions, use `projects.jobs.aggregated`. Using ` + # projects.jobs.list` is not recommended, as you can only get the list of jobs + # that are running in `us-central1`. # @param [String] project_id # The project which owns the jobs. # @param [String] location - # The [regional endpoint] - # (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) that - # contains this job. + # The [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/ + # regional-endpoints) that contains this job. # @param [String] filter # The kind of filter to use. # @param [Fixnum] page_size - # If there are many jobs, limit response to at most this many. - # The actual number of jobs returned will be the lesser of max_responses - # and an unspecified server-defined limit. + # If there are many jobs, limit response to at most this many. The actual number + # of jobs returned will be the lesser of max_responses and an unspecified server- + # defined limit. # @param [String] page_token - # Set this to the 'next_page_token' field of a previous response - # to request additional results in a long list. + # Set this to the 'next_page_token' field of a previous response to request + # additional results in a long list. # @param [String] view # Level of information requested in response. Default is `JOB_VIEW_SUMMARY`. # @param [String] fields @@ -1185,18 +1195,16 @@ module Google execute_or_queue_command(command, &block) end - # Updates the state of an existing Cloud Dataflow job. - # To update the state of an existing job, we recommend using - # `projects.locations.jobs.update` with a [regional endpoint] - # (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints). Using - # `projects.jobs.update` is not recommended, as you can only update the state - # of jobs that are running in `us-central1`. + # Updates the state of an existing Cloud Dataflow job. To update the state of an + # existing job, we recommend using `projects.locations.jobs.update` with a [ + # regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional- + # endpoints). Using `projects.jobs.update` is not recommended, as you can only + # update the state of jobs that are running in `us-central1`. # @param [String] project_id # The ID of the Cloud Platform project that the job belongs to. # @param [String] location - # The [regional endpoint] - # (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) that - # contains this job. + # The [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/ + # regional-endpoints) that contains this job. # @param [String] job_id # The job ID. # @param [Google::Apis::DataflowV1b3::Job] job_object @@ -1235,9 +1243,8 @@ module Google # @param [String] project_id # The project id. # @param [String] location - # The [regional endpoint] - # (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) that - # contains the job specified by job_id. + # The [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/ + # regional-endpoints) that contains the job specified by job_id. # @param [String] job_id # The job id. # @param [Google::Apis::DataflowV1b3::GetDebugConfigRequest] get_debug_config_request_object @@ -1276,9 +1283,8 @@ module Google # @param [String] project_id # The project id. # @param [String] location - # The [regional endpoint] - # (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) that - # contains the job specified by job_id. + # The [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/ + # regional-endpoints) that contains the job specified by job_id. # @param [String] job_id # The job id. # @param [Google::Apis::DataflowV1b3::SendDebugCaptureRequest] send_debug_capture_request_object @@ -1313,36 +1319,33 @@ module Google execute_or_queue_command(command, &block) end - # Request the job status. - # To request the status of a job, we recommend using - # `projects.locations.jobs.messages.list` with a [regional endpoint] - # (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints). Using - # `projects.jobs.messages.list` is not recommended, as you can only request - # the status of jobs that are running in `us-central1`. + # Request the job status. To request the status of a job, we recommend using ` + # projects.locations.jobs.messages.list` with a [regional endpoint] (https:// + # cloud.google.com/dataflow/docs/concepts/regional-endpoints). Using `projects. + # jobs.messages.list` is not recommended, as you can only request the status of + # jobs that are running in `us-central1`. # @param [String] project_id # A project id. # @param [String] location - # The [regional endpoint] - # (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) that - # contains the job specified by job_id. + # The [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/ + # regional-endpoints) that contains the job specified by job_id. # @param [String] job_id # The job to get messages about. # @param [String] end_time - # Return only messages with timestamps < end_time. The default is now - # (i.e. return up to the latest messages available). + # Return only messages with timestamps < end_time. The default is now (i.e. + # return up to the latest messages available). # @param [String] minimum_importance # Filter to only get messages with importance >= level # @param [Fixnum] page_size - # If specified, determines the maximum number of messages to - # return. If unspecified, the service may choose an appropriate - # default, or may return an arbitrarily large number of results. + # If specified, determines the maximum number of messages to return. If + # unspecified, the service may choose an appropriate default, or may return an + # arbitrarily large number of results. # @param [String] page_token - # If supplied, this should be the value of next_page_token returned - # by an earlier call. This will cause the next page of results to - # be returned. + # If supplied, this should be the value of next_page_token returned by an + # earlier call. This will cause the next page of results to be returned. # @param [String] start_time - # If specified, return only messages with timestamps >= start_time. - # The default is the job creation time (i.e. beginning of messages). + # If specified, return only messages with timestamps >= start_time. The default + # is the job creation time (i.e. beginning of messages). # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -1413,13 +1416,68 @@ module Google execute_or_queue_command(command, &block) end + # Request detailed information about the execution status of a stage of the job. + # EXPERIMENTAL. This API is subject to change or removal without notice. + # @param [String] project_id + # A project id. + # @param [String] location + # The [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/ + # regional-endpoints) that contains the job specified by job_id. + # @param [String] job_id + # The job to get execution details for. + # @param [String] stage_id + # The stage for which to fetch information. + # @param [String] end_time + # Upper time bound of work items to include, by start time. + # @param [Fixnum] page_size + # If specified, determines the maximum number of work items to return. If + # unspecified, the service may choose an appropriate default, or may return an + # arbitrarily large number of results. + # @param [String] page_token + # If supplied, this should be the value of next_page_token returned by an + # earlier call. This will cause the next page of results to be returned. + # @param [String] start_time + # Lower time bound of work items to include, by start time. + # @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::DataflowV1b3::StageExecutionDetails] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DataflowV1b3::StageExecutionDetails] + # + # @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_location_job_stage_execution_details(project_id, location, job_id, stage_id, end_time: nil, page_size: nil, page_token: nil, start_time: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v1b3/projects/{projectId}/locations/{location}/jobs/{jobId}/stages/{stageId}/executionDetails', options) + command.response_representation = Google::Apis::DataflowV1b3::StageExecutionDetails::Representation + command.response_class = Google::Apis::DataflowV1b3::StageExecutionDetails + command.params['projectId'] = project_id unless project_id.nil? + command.params['location'] = location unless location.nil? + command.params['jobId'] = job_id unless job_id.nil? + command.params['stageId'] = stage_id unless stage_id.nil? + command.query['endTime'] = end_time unless end_time.nil? + command.query['pageSize'] = page_size unless page_size.nil? + command.query['pageToken'] = page_token unless page_token.nil? + command.query['startTime'] = start_time unless start_time.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + # Leases a dataflow WorkItem to run. # @param [String] project_id # Identifies the project this worker belongs to. # @param [String] location - # The [regional endpoint] - # (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) that - # contains the WorkItem's job. + # The [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/ + # regional-endpoints) that contains the WorkItem's job. # @param [String] job_id # Identifies the workflow job this worker belongs to. # @param [Google::Apis::DataflowV1b3::LeaseWorkItemRequest] lease_work_item_request_object @@ -1458,9 +1516,8 @@ module Google # @param [String] project_id # The project which owns the WorkItem's job. # @param [String] location - # The [regional endpoint] - # (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) that - # contains the WorkItem's job. + # The [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/ + # regional-endpoints) that contains the WorkItem's job. # @param [String] job_id # The job which the WorkItem is part of. # @param [Google::Apis::DataflowV1b3::ReportWorkItemStatusRequest] report_work_item_status_request_object @@ -1603,16 +1660,14 @@ module Google execute_or_queue_command(command, &block) end - # Validates a GoogleSQL query for Cloud Dataflow syntax. Will always - # confirm the given query parses correctly, and if able to look up - # schema information from DataCatalog, will validate that the query - # analyzes properly as well. + # Validates a GoogleSQL query for Cloud Dataflow syntax. Will always confirm the + # given query parses correctly, and if able to look up schema information from + # DataCatalog, will validate that the query analyzes properly as well. # @param [String] project_id # Required. The ID of the Cloud Platform project that the job belongs to. # @param [String] location - # The [regional endpoint] - # (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) to - # which to direct the request. + # The [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/ + # regional-endpoints) to which to direct the request. # @param [String] query # The sql query to validate. # @param [String] fields @@ -1648,9 +1703,8 @@ module Google # @param [String] project_id # Required. The ID of the Cloud Platform project that the job belongs to. # @param [String] location - # The [regional endpoint] - # (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) to - # which to direct the request. + # The [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/ + # regional-endpoints) to which to direct the request. # @param [Google::Apis::DataflowV1b3::CreateJobFromTemplateRequest] create_job_from_template_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -1686,12 +1740,10 @@ module Google # @param [String] project_id # Required. The ID of the Cloud Platform project that the job belongs to. # @param [String] location - # The [regional endpoint] - # (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) to - # which to direct the request. + # The [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/ + # regional-endpoints) to which to direct the request. # @param [String] gcs_path - # Required. A Cloud Storage path to the template from which to - # create the job. + # Required. A Cloud Storage path to the template from which to create the job. # Must be valid Cloud Storage URL, beginning with 'gs://'. # @param [String] view # The view to retrieve. Defaults to METADATA_ONLY. @@ -1729,23 +1781,20 @@ module Google # @param [String] project_id # Required. The ID of the Cloud Platform project that the job belongs to. # @param [String] location - # The [regional endpoint] - # (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) to - # which to direct the request. + # The [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/ + # regional-endpoints) to which to direct the request. # @param [Google::Apis::DataflowV1b3::LaunchTemplateParameters] launch_template_parameters_object # @param [String] dynamic_template_gcs_path - # Path to dynamic template spec file on GCS. - # The file must be a Json serialized DynamicTemplateFieSpec object. + # Path to dynamic template spec file on GCS. The file must be a Json serialized + # DynamicTemplateFieSpec object. # @param [String] dynamic_template_staging_location - # Cloud Storage path for staging dependencies. - # Must be a valid Cloud Storage URL, beginning with `gs://`. + # Cloud Storage path for staging dependencies. Must be a valid Cloud Storage URL, + # beginning with `gs://`. # @param [String] gcs_path - # A Cloud Storage path to the template from which to create - # the job. - # Must be valid Cloud Storage URL, beginning with 'gs://'. + # A Cloud Storage path to the template from which to create the job. Must be + # valid Cloud Storage URL, beginning with 'gs://'. # @param [Boolean] validate_only - # If true, the request is validated but not actually executed. - # Defaults to false. + # If true, the request is validated but not actually executed. Defaults to false. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -1853,19 +1902,17 @@ module Google end # List TemplateVersions using project_id and an optional display_name field. - # List all the TemplateVersions in the Template if display set. - # List all the TemplateVersions in the Project if display_name not set. + # List all the TemplateVersions in the Template if display set. List all the + # TemplateVersions in the Project if display_name not set. # @param [String] parent - # parent includes project_id, and display_name is optional. - # List by project_id(pid1) and display_name(tid1). - # Format: projects/`pid1`/catalogTemplates/`tid1` - # List by project_id(pid1). - # Format: projects/`pid1` + # parent includes project_id, and display_name is optional. List by project_id( + # pid1) and display_name(tid1). Format: projects/`pid1`/catalogTemplates/`tid1` + # List by project_id(pid1). Format: projects/`pid1` # @param [Fixnum] page_size # The maximum number of TemplateVersions to return per page. # @param [String] page_token - # The page token, received from a previous ListTemplateVersions call. - # Provide this to retrieve the subsequent page. + # The page token, received from a previous ListTemplateVersions call. Provide + # this to retrieve the subsequent page. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -1932,13 +1979,11 @@ module Google # @param [String] project_id # Required. The ID of the Cloud Platform project that the job belongs to. # @param [String] gcs_path - # Required. A Cloud Storage path to the template from which to - # create the job. + # Required. A Cloud Storage path to the template from which to create the job. # Must be valid Cloud Storage URL, beginning with 'gs://'. # @param [String] location - # The [regional endpoint] - # (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) to - # which to direct the request. + # The [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/ + # regional-endpoints) to which to direct the request. # @param [String] view # The view to retrieve. Defaults to METADATA_ONLY. # @param [String] fields @@ -1976,22 +2021,19 @@ module Google # Required. The ID of the Cloud Platform project that the job belongs to. # @param [Google::Apis::DataflowV1b3::LaunchTemplateParameters] launch_template_parameters_object # @param [String] dynamic_template_gcs_path - # Path to dynamic template spec file on GCS. - # The file must be a Json serialized DynamicTemplateFieSpec object. + # Path to dynamic template spec file on GCS. The file must be a Json serialized + # DynamicTemplateFieSpec object. # @param [String] dynamic_template_staging_location - # Cloud Storage path for staging dependencies. - # Must be a valid Cloud Storage URL, beginning with `gs://`. + # Cloud Storage path for staging dependencies. Must be a valid Cloud Storage URL, + # beginning with `gs://`. # @param [String] gcs_path - # A Cloud Storage path to the template from which to create - # the job. - # Must be valid Cloud Storage URL, beginning with 'gs://'. + # A Cloud Storage path to the template from which to create the job. Must be + # valid Cloud Storage URL, beginning with 'gs://'. # @param [String] location - # The [regional endpoint] - # (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) to - # which to direct the request. + # The [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/ + # regional-endpoints) to which to direct the request. # @param [Boolean] validate_only - # If true, the request is validated but not actually executed. - # Defaults to false. + # If true, the request is validated but not actually executed. Defaults to false. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user diff --git a/generated/google/apis/run_v1.rb b/generated/google/apis/run_v1.rb index a8430b960..62568f888 100644 --- a/generated/google/apis/run_v1.rb +++ b/generated/google/apis/run_v1.rb @@ -26,7 +26,7 @@ module Google # @see https://cloud.google.com/run/ module RunV1 VERSION = 'V1' - REVISION = '20200727' + REVISION = '20200814' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' diff --git a/generated/google/apis/run_v1/classes.rb b/generated/google/apis/run_v1/classes.rb index 7dfc3cd1f..ed8e90ac1 100644 --- a/generated/google/apis/run_v1/classes.rb +++ b/generated/google/apis/run_v1/classes.rb @@ -908,7 +908,7 @@ module Google # explicitly call out to that shell. Exit status of 0 is treated as live/healthy # and non-zero is unhealthy. # Corresponds to the JSON property `command` - # @return [String] + # @return [Array] attr_accessor :command def initialize(**args) @@ -1740,8 +1740,9 @@ module Google # a resource or set of resources. Clients must treat these values as opaque and # passed unmodified back to the server. They may only be valid for a particular # resource or set of resources. Populated by the system. Read-only. Value must - # be treated as opaque by clients and . More info: https://git.k8s.io/community/ - # contributors/devel/api-conventions.md#concurrency-control-and-consistency + # be treated as opaque by clients. More info: https://git.k8s.io/community/ + # contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and- + # consistency # Corresponds to the JSON property `resourceVersion` # @return [String] attr_accessor :resource_version diff --git a/generated/google/apis/run_v1/representations.rb b/generated/google/apis/run_v1/representations.rb index c0c1f2c51..7673929fb 100644 --- a/generated/google/apis/run_v1/representations.rb +++ b/generated/google/apis/run_v1/representations.rb @@ -652,7 +652,7 @@ module Google class ExecAction # @private class Representation < Google::Apis::Core::JsonRepresentation - property :command, as: 'command' + collection :command, as: 'command' end end diff --git a/generated/google/apis/run_v1alpha1.rb b/generated/google/apis/run_v1alpha1.rb index 2d3979c3d..5e4eebeca 100644 --- a/generated/google/apis/run_v1alpha1.rb +++ b/generated/google/apis/run_v1alpha1.rb @@ -26,7 +26,7 @@ module Google # @see https://cloud.google.com/run/ module RunV1alpha1 VERSION = 'V1alpha1' - REVISION = '20200720' + REVISION = '20200814' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' diff --git a/generated/google/apis/run_v1alpha1/classes.rb b/generated/google/apis/run_v1alpha1/classes.rb index 7571b8c94..c2aa4056d 100644 --- a/generated/google/apis/run_v1alpha1/classes.rb +++ b/generated/google/apis/run_v1alpha1/classes.rb @@ -1827,7 +1827,7 @@ module Google # call out to that shell. Exit status of 0 is treated as live/healthy and non- # zero is unhealthy. +optional # Corresponds to the JSON property `command` - # @return [String] + # @return [Array] attr_accessor :command def initialize(**args) diff --git a/generated/google/apis/run_v1alpha1/representations.rb b/generated/google/apis/run_v1alpha1/representations.rb index 17da28f18..9e46e4d3b 100644 --- a/generated/google/apis/run_v1alpha1/representations.rb +++ b/generated/google/apis/run_v1alpha1/representations.rb @@ -1108,7 +1108,7 @@ module Google class ExecAction # @private class Representation < Google::Apis::Core::JsonRepresentation - property :command, as: 'command' + collection :command, as: 'command' end end diff --git a/generated/google/apis/run_v1beta1.rb b/generated/google/apis/run_v1beta1.rb index 93f320c4d..e4fd8a0b9 100644 --- a/generated/google/apis/run_v1beta1.rb +++ b/generated/google/apis/run_v1beta1.rb @@ -26,7 +26,7 @@ module Google # @see https://cloud.google.com/run/ module RunV1beta1 VERSION = 'V1beta1' - REVISION = '20200720' + REVISION = '20200814' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' diff --git a/generated/google/apis/run_v1beta1/classes.rb b/generated/google/apis/run_v1beta1/classes.rb index e3ff60ca5..1e311fc46 100644 --- a/generated/google/apis/run_v1beta1/classes.rb +++ b/generated/google/apis/run_v1beta1/classes.rb @@ -996,8 +996,9 @@ module Google # a resource or set of resources. Clients must treat these values as opaque and # passed unmodified back to the server. They may only be valid for a particular # resource or set of resources. Populated by the system. Read-only. Value must - # be treated as opaque by clients and . More info: https://git.k8s.io/community/ - # contributors/devel/api-conventions.md#concurrency-control-and-consistency + # be treated as opaque by clients. More info: https://git.k8s.io/community/ + # contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and- + # consistency # Corresponds to the JSON property `resourceVersion` # @return [String] attr_accessor :resource_version diff --git a/generated/google/apis/serviceusage_v1.rb b/generated/google/apis/serviceusage_v1.rb index fb22edc7b..e7e23f46f 100644 --- a/generated/google/apis/serviceusage_v1.rb +++ b/generated/google/apis/serviceusage_v1.rb @@ -27,7 +27,7 @@ module Google # @see https://cloud.google.com/service-usage/ module ServiceusageV1 VERSION = 'V1' - REVISION = '20200804' + REVISION = '20200813' # 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/serviceusage_v1/service.rb b/generated/google/apis/serviceusage_v1/service.rb index 8c9dbfdf9..cd4cc03c6 100644 --- a/generated/google/apis/serviceusage_v1/service.rb +++ b/generated/google/apis/serviceusage_v1/service.rb @@ -389,7 +389,11 @@ module Google # services, all services for which the calling user has the `servicemanagement. # services.bind` permission, and all services that have already been enabled on # the project. The list can be filtered to only include services in a specific - # state, for example to only include services enabled on the project. + # state, for example to only include services enabled on the project. WARNING: + # If you need to query enabled services frequently or across an organization, + # you should use [Cloud Asset Inventory API](https://cloud.google.com/asset- + # inventory/docs/apis), which provides higher throughput and richer filtering + # capability. # @param [String] parent # Parent to search for services on. An example name would be: `projects/123` # where `123` is the project number. diff --git a/generated/google/apis/videointelligence_v1p3beta1.rb b/generated/google/apis/videointelligence_v1p3beta1.rb index d2055c0b8..47db9346e 100644 --- a/generated/google/apis/videointelligence_v1p3beta1.rb +++ b/generated/google/apis/videointelligence_v1p3beta1.rb @@ -27,7 +27,7 @@ module Google # @see https://cloud.google.com/video-intelligence/docs/ module VideointelligenceV1p3beta1 VERSION = 'V1p3beta1' - 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_v1p3beta1/classes.rb b/generated/google/apis/videointelligence_v1p3beta1/classes.rb index 9236cc919..ccddc9498 100644 --- a/generated/google/apis/videointelligence_v1p3beta1/classes.rb +++ b/generated/google/apis/videointelligence_v1p3beta1/classes.rb @@ -22,9 +22,9 @@ module Google module Apis module VideointelligenceV1p3beta1 - # 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::VideointelligenceV1p3beta1::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::VideointelligenceV1p3beta1::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::VideointelligenceV1p3beta1::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::VideointelligenceV1p3beta1::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::VideointelligenceV1p3beta1::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::VideointelligenceV1p3beta1::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::VideointelligenceV1p3beta1::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::VideointelligenceV1p3beta1::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::VideointelligenceV1p3beta1::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::VideointelligenceV1p3beta1::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::VideointelligenceV1p3beta1::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::VideointelligenceV1p3beta1::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::VideointelligenceV1p3beta1::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::VideointelligenceV1p3beta1::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::VideointelligenceV1p3beta1::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::VideointelligenceV1p3beta1::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::VideointelligenceV1p3beta1::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::VideointelligenceV1p3beta1::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::VideointelligenceV1p3beta1::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::VideointelligenceV1p3beta1::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::VideointelligenceV1p3beta1::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::VideointelligenceV1p3beta1::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::VideointelligenceV1p3beta1::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::VideointelligenceV1p3beta1::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::VideointelligenceV1p3beta1::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::VideointelligenceV1p3beta1::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::VideointelligenceV1p3beta1::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 @@ -3103,9 +3016,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 @@ -3133,14 +3046,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 @@ -3172,9 +3085,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::VideointelligenceV1p3beta1::GoogleCloudVideointelligenceV1p2beta1NormalizedVertex] attr_accessor :point @@ -3200,8 +3112,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] @@ -3224,9 +3135,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 @@ -3281,10 +3192,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 @@ -3383,14 +3293,14 @@ module Google # @return [Google::Apis::VideointelligenceV1p3beta1::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 @@ -3407,9 +3317,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 @@ -3447,20 +3356,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 @@ -3479,9 +3380,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 @@ -3520,10 +3420,10 @@ module Google # @return [Google::Apis::VideointelligenceV1p3beta1::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 @@ -3533,12 +3433,11 @@ module Google # @return [Google::Apis::VideointelligenceV1p3beta1::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 @@ -3568,9 +3467,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::VideointelligenceV1p3beta1::GoogleCloudVideointelligenceV1p2beta1NormalizedBoundingBox] attr_accessor :normalized_bounding_box @@ -3597,10 +3495,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 @@ -3611,8 +3509,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 @@ -3633,18 +3531,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 @@ -3693,27 +3590,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::VideointelligenceV1p3beta1::GoogleCloudVideointelligenceV1p2beta1NormalizedBoundingPoly] attr_accessor :rotated_bounding_box @@ -3766,9 +3655,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 @@ -3782,15 +3670,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::VideointelligenceV1p3beta1::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 @@ -3849,20 +3736,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 @@ -3901,31 +3787,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::VideointelligenceV1p3beta1::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::VideointelligenceV1p3beta1::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 @@ -3952,11 +3837,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 @@ -3966,17 +3851,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 @@ -3986,9 +3871,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 @@ -4020,14 +3904,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 @@ -4044,41 +3928,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 @@ -4102,9 +3986,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 @@ -4132,24 +4016,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 @@ -4163,11 +4045,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 @@ -4192,9 +4074,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 @@ -4228,10 +4110,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 @@ -4252,8 +4133,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 @@ -4309,14 +4190,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 @@ -4348,9 +4229,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::VideointelligenceV1p3beta1::GoogleCloudVideointelligenceV1p3beta1NormalizedVertex] attr_accessor :point @@ -4376,8 +4256,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] @@ -4400,9 +4279,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 @@ -4431,9 +4310,8 @@ module Google class GoogleCloudVideointelligenceV1p3beta1ExplicitContentDetectionConfig 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 @@ -4523,9 +4401,8 @@ module Google attr_accessor :include_bounding_boxes alias_method :include_bounding_boxes?, :include_bounding_boxes - # Model to use for face detection. - # Supported values: "builtin/stable" (the default if unset) and - # "builtin/latest". + # Model to use for face detection. Supported values: "builtin/stable" (the + # default if unset) and "builtin/latest". # Corresponds to the JSON property `model` # @return [String] attr_accessor :model @@ -4546,10 +4423,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 @@ -4592,44 +4468,40 @@ module Google class GoogleCloudVideointelligenceV1p3beta1LabelDetectionConfig 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 @@ -4708,14 +4580,14 @@ module Google # @return [Google::Apis::VideointelligenceV1p3beta1::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 @@ -4732,9 +4604,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 @@ -4772,20 +4643,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 @@ -4804,9 +4667,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 @@ -4845,10 +4707,10 @@ module Google # @return [Google::Apis::VideointelligenceV1p3beta1::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 @@ -4858,12 +4720,11 @@ module Google # @return [Google::Apis::VideointelligenceV1p3beta1::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 @@ -4892,9 +4753,8 @@ module Google class GoogleCloudVideointelligenceV1p3beta1ObjectTrackingConfig 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 @@ -4914,9 +4774,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::VideointelligenceV1p3beta1::GoogleCloudVideointelligenceV1p3beta1NormalizedBoundingBox] attr_accessor :normalized_bounding_box @@ -4967,23 +4826,21 @@ module Google include Google::Apis::Core::Hashable # Whether to enable person attributes detection, such as cloth color (black, - # blue, etc), type (coat, dress, etc), pattern (plain, floral, etc), hair, - # etc. + # blue, etc), type (coat, dress, etc), pattern (plain, floral, etc), hair, etc. # Ignored if 'include_bounding_boxes' is set to false. # Corresponds to the JSON property `includeAttributes` # @return [Boolean] attr_accessor :include_attributes alias_method :include_attributes?, :include_attributes - # Whether bounding boxes are included in the person detection annotation - # output. + # Whether bounding boxes are included in the person detection annotation output. # Corresponds to the JSON property `includeBoundingBoxes` # @return [Boolean] attr_accessor :include_bounding_boxes alias_method :include_bounding_boxes?, :include_bounding_boxes - # Whether to enable pose landmarks detection. Ignored if - # 'include_bounding_boxes' is set to false. + # Whether to enable pose landmarks detection. Ignored if 'include_bounding_boxes' + # is set to false. # Corresponds to the JSON property `includePoseLandmarks` # @return [Boolean] attr_accessor :include_pose_landmarks @@ -5030,9 +4887,8 @@ module Google class GoogleCloudVideointelligenceV1p3beta1ShotChangeDetectionConfig 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 @@ -5052,12 +4908,12 @@ module Google class GoogleCloudVideointelligenceV1p3beta1SpeechContext 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 @@ -5078,10 +4934,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 @@ -5092,8 +4948,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 @@ -5114,18 +4970,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 @@ -5152,66 +5007,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] @@ -5240,32 +5091,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::VideointelligenceV1p3beta1::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::VideointelligenceV1p3beta1::GoogleRpcStatus] attr_accessor :error @@ -5282,14 +5132,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::VideointelligenceV1p3beta1::GoogleCloudVideointelligenceV1p3beta1ExplicitContentAnnotation] attr_accessor :explicit_annotation @@ -5360,16 +5210,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 @@ -5385,27 +5234,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::VideointelligenceV1p3beta1::GoogleCloudVideointelligenceV1p3beta1NormalizedBoundingPoly] attr_accessor :rotated_bounding_box @@ -5458,9 +5299,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 @@ -5474,15 +5314,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::VideointelligenceV1p3beta1::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 @@ -5541,20 +5380,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 @@ -5598,19 +5436,19 @@ module Google # @return [Google::Apis::VideointelligenceV1p3beta1::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::VideointelligenceV1p3beta1::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::VideointelligenceV1p3beta1::GoogleCloudVideointelligenceV1p3beta1ExplicitContentAnnotation] attr_accessor :explicit_annotation @@ -5620,14 +5458,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 @@ -5659,11 +5496,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 @@ -5673,17 +5510,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 @@ -5693,9 +5530,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 @@ -5755,9 +5591,9 @@ module Google # @return [Google::Apis::VideointelligenceV1p3beta1::GoogleCloudVideointelligenceV1p3beta1PersonDetectionConfig] attr_accessor :person_detection_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 @@ -5799,14 +5635,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 @@ -5823,41 +5659,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 @@ -5886,47 +5722,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::VideointelligenceV1p3beta1::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 @@ -5945,12 +5779,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 @@ -5959,15 +5793,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_v1p3beta1/service.rb b/generated/google/apis/videointelligence_v1p3beta1/service.rb index 1652331d6..aabc56813 100644 --- a/generated/google/apis/videointelligence_v1p3beta1/service.rb +++ b/generated/google/apis/videointelligence_v1p3beta1/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::VideointelligenceV1p3beta1::GoogleCloudVideointelligenceV1p3beta1AnnotateVideoRequest] google_cloud_videointelligence_v1p3beta1_annotate_video_request_object # @param [String] fields # Selector specifying which fields to include in a partial response.