Autogenerated update (2020-05-29)

Update:
- bigquery_v2
- cloudkms_v1
- dialogflow_v2
- dialogflow_v2beta1
- dialogflow_v3alpha1
- displayvideo_v1
- tpu_v1
- tpu_v1alpha1
- youtube_v3
This commit is contained in:
Google APIs 2020-05-29 00:38:38 +00:00
parent df8aa8bfbe
commit 2e9dc033a9
29 changed files with 3381 additions and 40 deletions

View File

@ -25,7 +25,7 @@ module Google
# @see https://cloud.google.com/bigquery/ # @see https://cloud.google.com/bigquery/
module BigqueryV2 module BigqueryV2
VERSION = 'V2' VERSION = 'V2'
REVISION = '20200514' REVISION = '20200523'
# View and manage your data in Google BigQuery # View and manage your data in Google BigQuery
AUTH_BIGQUERY = 'https://www.googleapis.com/auth/bigquery' AUTH_BIGQUERY = 'https://www.googleapis.com/auth/bigquery'

View File

@ -4684,6 +4684,15 @@ module Google
# @return [String] # @return [String]
attr_accessor :kind attr_accessor :kind
# The labels associated with this job. You can use these to organize and group
# your jobs. Label keys and values can be no longer than 63 characters, can only
# contain lowercase letters, numeric characters, underscores and dashes.
# International characters are allowed. Label values are optional. Label keys
# must start with a letter and each label in the list must have a different key.
# Corresponds to the JSON property `labels`
# @return [Hash<String,String>]
attr_accessor :labels
# The geographic location where the job should run. See details at https://cloud. # The geographic location where the job should run. See details at https://cloud.
# google.com/bigquery/docs/locations#specifying_your_location. # google.com/bigquery/docs/locations#specifying_your_location.
# Corresponds to the JSON property `location` # Corresponds to the JSON property `location`
@ -4699,6 +4708,13 @@ module Google
# @return [Fixnum] # @return [Fixnum]
attr_accessor :max_results attr_accessor :max_results
# [Optional] Limits the bytes billed for this job. Queries that will have bytes
# billed beyond this limit will fail (without incurring a charge). If
# unspecified, this will be set to your project default.
# Corresponds to the JSON property `maximumBytesBilled`
# @return [Fixnum]
attr_accessor :maximum_bytes_billed
# Standard SQL only. Set to POSITIONAL to use positional (?) query parameters or # Standard SQL only. Set to POSITIONAL to use positional (?) query parameters or
# to NAMED to use named (@myparam) query parameters in this query. # to NAMED to use named (@myparam) query parameters in this query.
# Corresponds to the JSON property `parameterMode` # Corresponds to the JSON property `parameterMode`
@ -4723,6 +4739,21 @@ module Google
# @return [Array<Google::Apis::BigqueryV2::QueryParameter>] # @return [Array<Google::Apis::BigqueryV2::QueryParameter>]
attr_accessor :query_parameters attr_accessor :query_parameters
# A unique user provided identifier to ensure idempotent behavior for queries.
# Note that this is different from the job_id. It has the following properties:
# 1. It is case-sensitive, limited to up to 36 ASCII characters. A UUID is
# recommended. 2. Read only queries can ignore this token since they are
# nullipotent by definition. 3. When a duplicate mutating query request is
# detected (i.e. having the same request_id as an earlier query), it returns: a.
# the results of the mutation if it completes successfully within the timeout. b.
# the running operation if it is still in progress at the end of the timeout. 4.
# Its lifetime is limited to 15 minutes. In other words, if two requests are
# sent with the same request_id, but more than 15 minutes apart, idempotency is
# not guaranteed.
# Corresponds to the JSON property `requestId`
# @return [String]
attr_accessor :request_id
# [Optional] How long to wait for the query to complete, in milliseconds, before # [Optional] How long to wait for the query to complete, in milliseconds, before
# the request times out and returns. Note that this is only a timeout for the # the request times out and returns. Note that this is only a timeout for the
# request, not the query. If the query takes longer to run than the timeout # request, not the query. If the query takes longer to run than the timeout
@ -4761,12 +4792,15 @@ module Google
@default_dataset = args[:default_dataset] if args.key?(:default_dataset) @default_dataset = args[:default_dataset] if args.key?(:default_dataset)
@dry_run = args[:dry_run] if args.key?(:dry_run) @dry_run = args[:dry_run] if args.key?(:dry_run)
@kind = args[:kind] if args.key?(:kind) @kind = args[:kind] if args.key?(:kind)
@labels = args[:labels] if args.key?(:labels)
@location = args[:location] if args.key?(:location) @location = args[:location] if args.key?(:location)
@max_results = args[:max_results] if args.key?(:max_results) @max_results = args[:max_results] if args.key?(:max_results)
@maximum_bytes_billed = args[:maximum_bytes_billed] if args.key?(:maximum_bytes_billed)
@parameter_mode = args[:parameter_mode] if args.key?(:parameter_mode) @parameter_mode = args[:parameter_mode] if args.key?(:parameter_mode)
@preserve_nulls = args[:preserve_nulls] if args.key?(:preserve_nulls) @preserve_nulls = args[:preserve_nulls] if args.key?(:preserve_nulls)
@query = args[:query] if args.key?(:query) @query = args[:query] if args.key?(:query)
@query_parameters = args[:query_parameters] if args.key?(:query_parameters) @query_parameters = args[:query_parameters] if args.key?(:query_parameters)
@request_id = args[:request_id] if args.key?(:request_id)
@timeout_ms = args[:timeout_ms] if args.key?(:timeout_ms) @timeout_ms = args[:timeout_ms] if args.key?(:timeout_ms)
@use_legacy_sql = args[:use_legacy_sql] if args.key?(:use_legacy_sql) @use_legacy_sql = args[:use_legacy_sql] if args.key?(:use_legacy_sql)
@use_query_cache = args[:use_query_cache] if args.key?(:use_query_cache) @use_query_cache = args[:use_query_cache] if args.key?(:use_query_cache)

View File

@ -1877,13 +1877,16 @@ module Google
property :dry_run, as: 'dryRun' property :dry_run, as: 'dryRun'
property :kind, as: 'kind' property :kind, as: 'kind'
hash :labels, as: 'labels'
property :location, as: 'location' property :location, as: 'location'
property :max_results, as: 'maxResults' property :max_results, as: 'maxResults'
property :maximum_bytes_billed, :numeric_string => true, as: 'maximumBytesBilled'
property :parameter_mode, as: 'parameterMode' property :parameter_mode, as: 'parameterMode'
property :preserve_nulls, as: 'preserveNulls' property :preserve_nulls, as: 'preserveNulls'
property :query, as: 'query' property :query, as: 'query'
collection :query_parameters, as: 'queryParameters', class: Google::Apis::BigqueryV2::QueryParameter, decorator: Google::Apis::BigqueryV2::QueryParameter::Representation collection :query_parameters, as: 'queryParameters', class: Google::Apis::BigqueryV2::QueryParameter, decorator: Google::Apis::BigqueryV2::QueryParameter::Representation
property :request_id, as: 'requestId'
property :timeout_ms, as: 'timeoutMs' property :timeout_ms, as: 'timeoutMs'
property :use_legacy_sql, as: 'useLegacySql' property :use_legacy_sql, as: 'useLegacySql'
property :use_query_cache, as: 'useQueryCache' property :use_query_cache, as: 'useQueryCache'

View File

@ -0,0 +1,32 @@
# Copyright 2015 Google Inc.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
require 'google/apis/chromeuxreport_v1/service.rb'
require 'google/apis/chromeuxreport_v1/classes.rb'
require 'google/apis/chromeuxreport_v1/representations.rb'
module Google
module Apis
# Chrome UX Report API
#
# The Chrome UX Report API lets you view real user experience data for millions
# of websites.
#
# @see https://developers.google.com/web/tools/chrome-user-experience-report/api/reference
module ChromeuxreportV1
VERSION = 'V1'
REVISION = '20200528'
end
end
end

View File

@ -0,0 +1,297 @@
# Copyright 2015 Google Inc.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
require 'date'
require 'google/apis/core/base_service'
require 'google/apis/core/json_representation'
require 'google/apis/core/hashable'
require 'google/apis/errors'
module Google
module Apis
module ChromeuxreportV1
# A bin is a discrete portion of data spanning from start to end, or if no
# end is given, then from start to +inf.
# A bin's start and end values are given in the value type of the metric it
# represents. For example, "first contentful paint" is measured in
# milliseconds and exposed as ints, therefore its metric bins will use int32s
# for its start and end types. However, "cumulative layout shift" is measured
# in unitless decimals and is exposed as a decimal encoded as a string,
# therefore its metric bins will use strings for its value type.
class Bin
include Google::Apis::Core::Hashable
# The proportion of users that experienced this bin's value for the given
# metric.
# Corresponds to the JSON property `density`
# @return [Float]
attr_accessor :density
# End is the end of the data bin. If end is not populated, then the bin has
# no end and is valid from start to +inf.
# Corresponds to the JSON property `end`
# @return [Object]
attr_accessor :end
# Start is the beginning of the data bin.
# Corresponds to the JSON property `start`
# @return [Object]
attr_accessor :start
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@density = args[:density] if args.key?(:density)
@end = args[:end] if args.key?(:end)
@start = args[:start] if args.key?(:start)
end
end
# Key defines all the dimensions that identify this record as unique.
class Key
include Google::Apis::Core::Hashable
# The form factor is the device class that all users used to access the
# site for this record.
# If the form factor is unspecified, then aggregated data over all form
# factors will be returned.
# Corresponds to the JSON property `formFactor`
# @return [String]
attr_accessor :form_factor
# Origin specifies the origin that this record is for.
# Note: When specifying an origin, data for loads under this origin over
# all pages are aggregated into origin level user experience data.
# Corresponds to the JSON property `origin`
# @return [String]
attr_accessor :origin
# Url specifies a specific url that this record is for.
# Note: When specifying a "url" only data for that specific url will be
# aggregated.
# Corresponds to the JSON property `url`
# @return [String]
attr_accessor :url
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@form_factor = args[:form_factor] if args.key?(:form_factor)
@origin = args[:origin] if args.key?(:origin)
@url = args[:url] if args.key?(:url)
end
end
# A `metric` is a set of user experience data for a single web performance
# metric, like "first contentful paint". It contains a summary histogram of
# real world Chrome usage as a series of `bins`.
class Metric
include Google::Apis::Core::Hashable
# The histogram of user experiences for a metric. The histogram will have at
# least one bin and the densities of all bins will add up to ~1.
# Corresponds to the JSON property `histogram`
# @return [Array<Google::Apis::ChromeuxreportV1::Bin>]
attr_accessor :histogram
# Percentiles contains synthetic values of a metric at a given statistical
# percentile. These are used for estimating a metric's value as experienced
# by a percentage of users out of the total number of users.
# Corresponds to the JSON property `percentiles`
# @return [Google::Apis::ChromeuxreportV1::Percentiles]
attr_accessor :percentiles
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@histogram = args[:histogram] if args.key?(:histogram)
@percentiles = args[:percentiles] if args.key?(:percentiles)
end
end
# Percentiles contains synthetic values of a metric at a given statistical
# percentile. These are used for estimating a metric's value as experienced
# by a percentage of users out of the total number of users.
class Percentiles
include Google::Apis::Core::Hashable
# 75% of users experienced the given metric at or below this value.
# Corresponds to the JSON property `p75`
# @return [Object]
attr_accessor :p75
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@p75 = args[:p75] if args.key?(:p75)
end
end
# Request payload sent by a physical web client.
# This request includes all necessary context to load a particular
# user experience record.
class QueryRequest
include Google::Apis::Core::Hashable
# The form factor is a query dimension that specifies the device class that
# the record's data should belong to.
# Note: If no form factor is specified, then a special record with
# aggregated data over all form factors will be returned.
# Corresponds to the JSON property `formFactor`
# @return [String]
attr_accessor :form_factor
# The metrics that should be included in the response.
# If none are specified then any metrics found will be returned.
# Allowed values: ["first_contentful_paint",
# "first_input_delay", "largest_contentful_paint",
# "cumulative_layout_shift"]
# Corresponds to the JSON property `metrics`
# @return [Array<String>]
attr_accessor :metrics
# The url pattern "origin" refers to a url pattern that is the origin of
# a website.
# Examples: "https://example.com", "https://cloud.google.com"
# Corresponds to the JSON property `origin`
# @return [String]
attr_accessor :origin
# The url pattern "url" refers to a url pattern that is any arbitrary url.
# Examples: "https://example.com/",
# "https://cloud.google.com/why-google-cloud/"
# Corresponds to the JSON property `url`
# @return [String]
attr_accessor :url
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@form_factor = args[:form_factor] if args.key?(:form_factor)
@metrics = args[:metrics] if args.key?(:metrics)
@origin = args[:origin] if args.key?(:origin)
@url = args[:url] if args.key?(:url)
end
end
# Response payload sent back to a physical web client.
# This response contains the record found based on the identiers present in a
# `QueryRequest`. The returned response will have a record, and sometimes
# details on normalization actions taken on the request that were necessary to
# make the request successful.
class QueryResponse
include Google::Apis::Core::Hashable
# Record is a single Chrome UX report data record. It contains use experience
# statistics for a single url pattern and set of dimensions.
# Corresponds to the JSON property `record`
# @return [Google::Apis::ChromeuxreportV1::Record]
attr_accessor :record
# Object representing the normalization actions taken to normalize a url to
# achieve a higher chance of successful lookup. These are simple automated
# changes that are taken when looking up the provided `url_patten` would be
# known to fail. Complex actions like following redirects are not handled.
# Corresponds to the JSON property `urlNormalizationDetails`
# @return [Google::Apis::ChromeuxreportV1::UrlNormalization]
attr_accessor :url_normalization_details
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@record = args[:record] if args.key?(:record)
@url_normalization_details = args[:url_normalization_details] if args.key?(:url_normalization_details)
end
end
# Record is a single Chrome UX report data record. It contains use experience
# statistics for a single url pattern and set of dimensions.
class Record
include Google::Apis::Core::Hashable
# Key defines all the dimensions that identify this record as unique.
# Corresponds to the JSON property `key`
# @return [Google::Apis::ChromeuxreportV1::Key]
attr_accessor :key
# Metrics is the map of user experience data available for the record defined
# in the key field. Metrics are keyed on the metric name.
# Allowed key values: ["first_contentful_paint",
# "first_input_delay", "largest_contentful_paint",
# "cumulative_layout_shift"]
# Corresponds to the JSON property `metrics`
# @return [Hash<String,Google::Apis::ChromeuxreportV1::Metric>]
attr_accessor :metrics
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@key = args[:key] if args.key?(:key)
@metrics = args[:metrics] if args.key?(:metrics)
end
end
# Object representing the normalization actions taken to normalize a url to
# achieve a higher chance of successful lookup. These are simple automated
# changes that are taken when looking up the provided `url_patten` would be
# known to fail. Complex actions like following redirects are not handled.
class UrlNormalization
include Google::Apis::Core::Hashable
# The URL after any normalization actions. This is a valid user experience
# URL that could reasonably be looked up.
# Corresponds to the JSON property `normalizedUrl`
# @return [String]
attr_accessor :normalized_url
# The original requested URL prior to any normalization actions.
# Corresponds to the JSON property `originalUrl`
# @return [String]
attr_accessor :original_url
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@normalized_url = args[:normalized_url] if args.key?(:normalized_url)
@original_url = args[:original_url] if args.key?(:original_url)
end
end
end
end
end

View File

@ -0,0 +1,147 @@
# Copyright 2015 Google Inc.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
require 'date'
require 'google/apis/core/base_service'
require 'google/apis/core/json_representation'
require 'google/apis/core/hashable'
require 'google/apis/errors'
module Google
module Apis
module ChromeuxreportV1
class Bin
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class Key
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class Metric
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class Percentiles
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class QueryRequest
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class QueryResponse
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class Record
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class UrlNormalization
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class Bin
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :density, as: 'density'
property :end, as: 'end'
property :start, as: 'start'
end
end
class Key
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :form_factor, as: 'formFactor'
property :origin, as: 'origin'
property :url, as: 'url'
end
end
class Metric
# @private
class Representation < Google::Apis::Core::JsonRepresentation
collection :histogram, as: 'histogram', class: Google::Apis::ChromeuxreportV1::Bin, decorator: Google::Apis::ChromeuxreportV1::Bin::Representation
property :percentiles, as: 'percentiles', class: Google::Apis::ChromeuxreportV1::Percentiles, decorator: Google::Apis::ChromeuxreportV1::Percentiles::Representation
end
end
class Percentiles
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :p75, as: 'p75'
end
end
class QueryRequest
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :form_factor, as: 'formFactor'
collection :metrics, as: 'metrics'
property :origin, as: 'origin'
property :url, as: 'url'
end
end
class QueryResponse
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :record, as: 'record', class: Google::Apis::ChromeuxreportV1::Record, decorator: Google::Apis::ChromeuxreportV1::Record::Representation
property :url_normalization_details, as: 'urlNormalizationDetails', class: Google::Apis::ChromeuxreportV1::UrlNormalization, decorator: Google::Apis::ChromeuxreportV1::UrlNormalization::Representation
end
end
class Record
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :key, as: 'key', class: Google::Apis::ChromeuxreportV1::Key, decorator: Google::Apis::ChromeuxreportV1::Key::Representation
hash :metrics, as: 'metrics', class: Google::Apis::ChromeuxreportV1::Metric, decorator: Google::Apis::ChromeuxreportV1::Metric::Representation
end
end
class UrlNormalization
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :normalized_url, as: 'normalizedUrl'
property :original_url, as: 'originalUrl'
end
end
end
end
end

View File

@ -0,0 +1,92 @@
# Copyright 2015 Google Inc.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
require 'google/apis/core/base_service'
require 'google/apis/core/json_representation'
require 'google/apis/core/hashable'
require 'google/apis/errors'
module Google
module Apis
module ChromeuxreportV1
# Chrome UX Report API
#
# The Chrome UX Report API lets you view real user experience data for millions
# of websites.
#
# @example
# require 'google/apis/chromeuxreport_v1'
#
# Chromeuxreport = Google::Apis::ChromeuxreportV1 # Alias the module
# service = Chromeuxreport::ChromeUXReportService.new
#
# @see https://developers.google.com/web/tools/chrome-user-experience-report/api/reference
class ChromeUXReportService < Google::Apis::Core::BaseService
# @return [String]
# API key. Your API key identifies your project and provides you with API access,
# quota, and reports. Required unless you provide an OAuth 2.0 token.
attr_accessor :key
# @return [String]
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
attr_accessor :quota_user
def initialize
super('https://chromeuxreport.googleapis.com/', '')
@batch_path = 'batch'
end
# Queries the Chrome User Experience for a single `record` for a given site.
# Returns a `record` that contains one or more `metrics` corresponding to
# performance data about the requested site.
# @param [Google::Apis::ChromeuxreportV1::QueryRequest] query_request_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::ChromeuxreportV1::QueryResponse] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::ChromeuxreportV1::QueryResponse]
#
# @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 query_record_record(query_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:post, 'v1/records:queryRecord', options)
command.request_representation = Google::Apis::ChromeuxreportV1::QueryRequest::Representation
command.request_object = query_request_object
command.response_representation = Google::Apis::ChromeuxreportV1::QueryResponse::Representation
command.response_class = Google::Apis::ChromeuxreportV1::QueryResponse
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
protected
def apply_command_defaults(command)
command.query['key'] = key unless key.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
end
end
end
end
end

View File

@ -26,7 +26,7 @@ module Google
# @see https://cloud.google.com/kms/ # @see https://cloud.google.com/kms/
module CloudkmsV1 module CloudkmsV1
VERSION = 'V1' VERSION = 'V1'
REVISION = '20200509' REVISION = '20200522'
# View and manage your data across Google Cloud Platform services # View and manage your data across Google Cloud Platform services
AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform'

View File

@ -33,6 +33,25 @@ module Google
# @return [String] # @return [String]
attr_accessor :ciphertext attr_accessor :ciphertext
# Optional. An optional CRC32C checksum of the AsymmetricDecryptRequest.
# ciphertext.
# If specified, KeyManagementService will verify the integrity of the
# received AsymmetricDecryptRequest.ciphertext using this checksum.
# KeyManagementService will report an error if the checksum verification
# fails. If you receive a checksum error, your client should verify that
# CRC32C(AsymmetricDecryptRequest.ciphertext) is equal to
# AsymmetricDecryptRequest.ciphertext_crc32c, and if so, perform a
# limited number of retries. A persistent mismatch may indicate an issue in
# your computation of the CRC32C checksum.
# Note: This field is defined as int64 for reasons of compatibility across
# different languages. However, it is a non-negative integer, which will
# never exceed 2^32-1, and can be safely downconverted to uint32 in languages
# that support this type.
# NOTE: This field is in Beta.
# Corresponds to the JSON property `ciphertextCrc32c`
# @return [Fixnum]
attr_accessor :ciphertext_crc32c
def initialize(**args) def initialize(**args)
update!(**args) update!(**args)
end end
@ -40,6 +59,7 @@ module Google
# Update properties of this object # Update properties of this object
def update!(**args) def update!(**args)
@ciphertext = args[:ciphertext] if args.key?(:ciphertext) @ciphertext = args[:ciphertext] if args.key?(:ciphertext)
@ciphertext_crc32c = args[:ciphertext_crc32c] if args.key?(:ciphertext_crc32c)
end end
end end
@ -53,6 +73,36 @@ module Google
# @return [String] # @return [String]
attr_accessor :plaintext attr_accessor :plaintext
# Integrity verification field. A CRC32C checksum of the returned
# AsymmetricDecryptResponse.plaintext. An integrity check of
# AsymmetricDecryptResponse.plaintext can be performed by computing the
# CRC32C checksum of AsymmetricDecryptResponse.plaintext and comparing
# your results to this field. Discard the response in case of non-matching
# checksum values, and perform a limited number of retries. A persistent
# mismatch may indicate an issue in your computation of the CRC32C checksum.
# Note: This field is defined as int64 for reasons of compatibility across
# different languages. However, it is a non-negative integer, which will
# never exceed 2^32-1, and can be safely downconverted to uint32 in languages
# that support this type.
# NOTE: This field is in Beta.
# Corresponds to the JSON property `plaintextCrc32c`
# @return [Fixnum]
attr_accessor :plaintext_crc32c
# Integrity verification field. A flag indicating whether
# AsymmetricDecryptRequest.ciphertext_crc32c was received by
# KeyManagementService and used for the integrity verification of the
# ciphertext. A false value of this
# field indicates either that AsymmetricDecryptRequest.ciphertext_crc32c
# was left unset or that it was not delivered to KeyManagementService. If
# you've set AsymmetricDecryptRequest.ciphertext_crc32c but this field is
# still false, discard the response and perform a limited number of retries.
# NOTE: This field is in Beta.
# Corresponds to the JSON property `verifiedCiphertextCrc32c`
# @return [Boolean]
attr_accessor :verified_ciphertext_crc32c
alias_method :verified_ciphertext_crc32c?, :verified_ciphertext_crc32c
def initialize(**args) def initialize(**args)
update!(**args) update!(**args)
end end
@ -60,6 +110,8 @@ module Google
# Update properties of this object # Update properties of this object
def update!(**args) def update!(**args)
@plaintext = args[:plaintext] if args.key?(:plaintext) @plaintext = args[:plaintext] if args.key?(:plaintext)
@plaintext_crc32c = args[:plaintext_crc32c] if args.key?(:plaintext_crc32c)
@verified_ciphertext_crc32c = args[:verified_ciphertext_crc32c] if args.key?(:verified_ciphertext_crc32c)
end end
end end
@ -72,6 +124,24 @@ module Google
# @return [Google::Apis::CloudkmsV1::Digest] # @return [Google::Apis::CloudkmsV1::Digest]
attr_accessor :digest attr_accessor :digest
# Optional. An optional CRC32C checksum of the AsymmetricSignRequest.digest. If
# specified, KeyManagementService will verify the integrity of the
# received AsymmetricSignRequest.digest using this checksum.
# KeyManagementService will report an error if the checksum verification
# fails. If you receive a checksum error, your client should verify that
# CRC32C(AsymmetricSignRequest.digest) is equal to
# AsymmetricSignRequest.digest_crc32c, and if so, perform a limited
# number of retries. A persistent mismatch may indicate an issue in your
# computation of the CRC32C checksum.
# Note: This field is defined as int64 for reasons of compatibility across
# different languages. However, it is a non-negative integer, which will
# never exceed 2^32-1, and can be safely downconverted to uint32 in languages
# that support this type.
# NOTE: This field is in Beta.
# Corresponds to the JSON property `digestCrc32c`
# @return [Fixnum]
attr_accessor :digest_crc32c
def initialize(**args) def initialize(**args)
update!(**args) update!(**args)
end end
@ -79,6 +149,7 @@ module Google
# Update properties of this object # Update properties of this object
def update!(**args) def update!(**args)
@digest = args[:digest] if args.key?(:digest) @digest = args[:digest] if args.key?(:digest)
@digest_crc32c = args[:digest_crc32c] if args.key?(:digest_crc32c)
end end
end end
@ -86,19 +157,59 @@ module Google
class AsymmetricSignResponse class AsymmetricSignResponse
include Google::Apis::Core::Hashable include Google::Apis::Core::Hashable
# The resource name of the CryptoKeyVersion used for signing. Check
# this field to verify that the intended resource was used for signing.
# NOTE: This field is in Beta.
# Corresponds to the JSON property `name`
# @return [String]
attr_accessor :name
# The created signature. # The created signature.
# Corresponds to the JSON property `signature` # Corresponds to the JSON property `signature`
# NOTE: Values are automatically base64 encoded/decoded in the client library. # NOTE: Values are automatically base64 encoded/decoded in the client library.
# @return [String] # @return [String]
attr_accessor :signature attr_accessor :signature
# Integrity verification field. A CRC32C checksum of the returned
# AsymmetricSignResponse.signature. An integrity check of
# AsymmetricSignResponse.signature can be performed by computing the
# CRC32C checksum of AsymmetricSignResponse.signature and comparing your
# results to this field. Discard the response in case of non-matching
# checksum values, and perform a limited number of retries. A persistent
# mismatch may indicate an issue in your computation of the CRC32C checksum.
# Note: This field is defined as int64 for reasons of compatibility across
# different languages. However, it is a non-negative integer, which will
# never exceed 2^32-1, and can be safely downconverted to uint32 in languages
# that support this type.
# NOTE: This field is in Beta.
# Corresponds to the JSON property `signatureCrc32c`
# @return [Fixnum]
attr_accessor :signature_crc32c
# Integrity verification field. A flag indicating whether
# AsymmetricSignRequest.digest_crc32c was received by
# KeyManagementService and used for the integrity verification of the
# digest. A false value of this field
# indicates either that AsymmetricSignRequest.digest_crc32c was left
# unset or that it was not delivered to KeyManagementService. If you've
# set AsymmetricSignRequest.digest_crc32c but this field is still false,
# discard the response and perform a limited number of retries.
# NOTE: This field is in Beta.
# Corresponds to the JSON property `verifiedDigestCrc32c`
# @return [Boolean]
attr_accessor :verified_digest_crc32c
alias_method :verified_digest_crc32c?, :verified_digest_crc32c
def initialize(**args) def initialize(**args)
update!(**args) update!(**args)
end end
# Update properties of this object # Update properties of this object
def update!(**args) def update!(**args)
@name = args[:name] if args.key?(:name)
@signature = args[:signature] if args.key?(:signature) @signature = args[:signature] if args.key?(:signature)
@signature_crc32c = args[:signature_crc32c] if args.key?(:signature_crc32c)
@verified_digest_crc32c = args[:verified_digest_crc32c] if args.key?(:verified_digest_crc32c)
end end
end end
@ -551,6 +662,25 @@ module Google
# @return [String] # @return [String]
attr_accessor :additional_authenticated_data attr_accessor :additional_authenticated_data
# Optional. An optional CRC32C checksum of the
# DecryptRequest.additional_authenticated_data. If specified,
# KeyManagementService will verify the integrity of the received
# DecryptRequest.additional_authenticated_data using this checksum.
# KeyManagementService will report an error if the checksum verification
# fails. If you receive a checksum error, your client should verify that
# CRC32C(DecryptRequest.additional_authenticated_data) is equal to
# DecryptRequest.additional_authenticated_data_crc32c, and if so, perform
# a limited number of retries. A persistent mismatch may indicate an issue in
# your computation of the CRC32C checksum.
# Note: This field is defined as int64 for reasons of compatibility across
# different languages. However, it is a non-negative integer, which will
# never exceed 2^32-1, and can be safely downconverted to uint32 in languages
# that support this type.
# NOTE: This field is in Beta.
# Corresponds to the JSON property `additionalAuthenticatedDataCrc32c`
# @return [Fixnum]
attr_accessor :additional_authenticated_data_crc32c
# Required. The encrypted data originally returned in # Required. The encrypted data originally returned in
# EncryptResponse.ciphertext. # EncryptResponse.ciphertext.
# Corresponds to the JSON property `ciphertext` # Corresponds to the JSON property `ciphertext`
@ -558,6 +688,24 @@ module Google
# @return [String] # @return [String]
attr_accessor :ciphertext attr_accessor :ciphertext
# Optional. An optional CRC32C checksum of the DecryptRequest.ciphertext. If
# specified, KeyManagementService will verify the integrity of the
# received DecryptRequest.ciphertext using this checksum.
# KeyManagementService will report an error if the checksum verification
# fails. If you receive a checksum error, your client should verify that
# CRC32C(DecryptRequest.ciphertext) is equal to
# DecryptRequest.ciphertext_crc32c, and if so, perform a limited number
# of retries. A persistent mismatch may indicate an issue in your computation
# of the CRC32C checksum.
# Note: This field is defined as int64 for reasons of compatibility across
# different languages. However, it is a non-negative integer, which will
# never exceed 2^32-1, and can be safely downconverted to uint32 in languages
# that support this type.
# NOTE: This field is in Beta.
# Corresponds to the JSON property `ciphertextCrc32c`
# @return [Fixnum]
attr_accessor :ciphertext_crc32c
def initialize(**args) def initialize(**args)
update!(**args) update!(**args)
end end
@ -565,7 +713,9 @@ module Google
# Update properties of this object # Update properties of this object
def update!(**args) def update!(**args)
@additional_authenticated_data = args[:additional_authenticated_data] if args.key?(:additional_authenticated_data) @additional_authenticated_data = args[:additional_authenticated_data] if args.key?(:additional_authenticated_data)
@additional_authenticated_data_crc32c = args[:additional_authenticated_data_crc32c] if args.key?(:additional_authenticated_data_crc32c)
@ciphertext = args[:ciphertext] if args.key?(:ciphertext) @ciphertext = args[:ciphertext] if args.key?(:ciphertext)
@ciphertext_crc32c = args[:ciphertext_crc32c] if args.key?(:ciphertext_crc32c)
end end
end end
@ -579,6 +729,24 @@ module Google
# @return [String] # @return [String]
attr_accessor :plaintext attr_accessor :plaintext
# Integrity verification field. A CRC32C checksum of the returned
# DecryptResponse.plaintext. An integrity check of
# DecryptResponse.plaintext can be performed by computing the CRC32C
# checksum of DecryptResponse.plaintext and comparing your results to
# this field. Discard the response in case of non-matching checksum values,
# and perform a limited number of retries. A persistent mismatch may indicate
# an issue in your computation of the CRC32C checksum. Note: receiving this
# response message indicates that KeyManagementService is able to
# successfully decrypt the ciphertext.
# Note: This field is defined as int64 for reasons of compatibility across
# different languages. However, it is a non-negative integer, which will
# never exceed 2^32-1, and can be safely downconverted to uint32 in languages
# that support this type.
# NOTE: This field is in Beta.
# Corresponds to the JSON property `plaintextCrc32c`
# @return [Fixnum]
attr_accessor :plaintext_crc32c
def initialize(**args) def initialize(**args)
update!(**args) update!(**args)
end end
@ -586,6 +754,7 @@ module Google
# Update properties of this object # Update properties of this object
def update!(**args) def update!(**args)
@plaintext = args[:plaintext] if args.key?(:plaintext) @plaintext = args[:plaintext] if args.key?(:plaintext)
@plaintext_crc32c = args[:plaintext_crc32c] if args.key?(:plaintext_crc32c)
end end
end end
@ -654,6 +823,25 @@ module Google
# @return [String] # @return [String]
attr_accessor :additional_authenticated_data attr_accessor :additional_authenticated_data
# Optional. An optional CRC32C checksum of the
# EncryptRequest.additional_authenticated_data. If specified,
# KeyManagementService will verify the integrity of the received
# EncryptRequest.additional_authenticated_data using this checksum.
# KeyManagementService will report an error if the checksum verification
# fails. If you receive a checksum error, your client should verify that
# CRC32C(EncryptRequest.additional_authenticated_data) is equal to
# EncryptRequest.additional_authenticated_data_crc32c, and if so, perform
# a limited number of retries. A persistent mismatch may indicate an issue in
# your computation of the CRC32C checksum.
# Note: This field is defined as int64 for reasons of compatibility across
# different languages. However, it is a non-negative integer, which will
# never exceed 2^32-1, and can be safely downconverted to uint32 in languages
# that support this type.
# NOTE: This field is in Beta.
# Corresponds to the JSON property `additionalAuthenticatedDataCrc32c`
# @return [Fixnum]
attr_accessor :additional_authenticated_data_crc32c
# Required. The data to encrypt. Must be no larger than 64KiB. # Required. The data to encrypt. Must be no larger than 64KiB.
# The maximum size depends on the key version's # The maximum size depends on the key version's
# protection_level. For # protection_level. For
@ -666,6 +854,24 @@ module Google
# @return [String] # @return [String]
attr_accessor :plaintext attr_accessor :plaintext
# Optional. An optional CRC32C checksum of the EncryptRequest.plaintext. If
# specified, KeyManagementService will verify the integrity of the
# received EncryptRequest.plaintext using this checksum.
# KeyManagementService will report an error if the checksum verification
# fails. If you receive a checksum error, your client should verify that
# CRC32C(EncryptRequest.plaintext) is equal to
# EncryptRequest.plaintext_crc32c, and if so, perform a limited number of
# retries. A persistent mismatch may indicate an issue in your computation of
# the CRC32C checksum.
# Note: This field is defined as int64 for reasons of compatibility across
# different languages. However, it is a non-negative integer, which will
# never exceed 2^32-1, and can be safely downconverted to uint32 in languages
# that support this type.
# NOTE: This field is in Beta.
# Corresponds to the JSON property `plaintextCrc32c`
# @return [Fixnum]
attr_accessor :plaintext_crc32c
def initialize(**args) def initialize(**args)
update!(**args) update!(**args)
end end
@ -673,7 +879,9 @@ module Google
# Update properties of this object # Update properties of this object
def update!(**args) def update!(**args)
@additional_authenticated_data = args[:additional_authenticated_data] if args.key?(:additional_authenticated_data) @additional_authenticated_data = args[:additional_authenticated_data] if args.key?(:additional_authenticated_data)
@additional_authenticated_data_crc32c = args[:additional_authenticated_data_crc32c] if args.key?(:additional_authenticated_data_crc32c)
@plaintext = args[:plaintext] if args.key?(:plaintext) @plaintext = args[:plaintext] if args.key?(:plaintext)
@plaintext_crc32c = args[:plaintext_crc32c] if args.key?(:plaintext_crc32c)
end end
end end
@ -687,12 +895,57 @@ module Google
# @return [String] # @return [String]
attr_accessor :ciphertext attr_accessor :ciphertext
# Integrity verification field. A CRC32C checksum of the returned
# EncryptResponse.ciphertext. An integrity check of
# EncryptResponse.ciphertext can be performed by computing the CRC32C
# checksum of EncryptResponse.ciphertext and comparing your results to
# this field. Discard the response in case of non-matching checksum values,
# and perform a limited number of retries. A persistent mismatch may indicate
# an issue in your computation of the CRC32C checksum.
# Note: This field is defined as int64 for reasons of compatibility across
# different languages. However, it is a non-negative integer, which will
# never exceed 2^32-1, and can be safely downconverted to uint32 in languages
# that support this type.
# NOTE: This field is in Beta.
# Corresponds to the JSON property `ciphertextCrc32c`
# @return [Fixnum]
attr_accessor :ciphertext_crc32c
# The resource name of the CryptoKeyVersion used in encryption. Check # The resource name of the CryptoKeyVersion used in encryption. Check
# this field to verify that the intended resource was used for encryption. # this field to verify that the intended resource was used for encryption.
# Corresponds to the JSON property `name` # Corresponds to the JSON property `name`
# @return [String] # @return [String]
attr_accessor :name attr_accessor :name
# Integrity verification field. A flag indicating whether
# EncryptRequest.additional_authenticated_data_crc32c was received by
# KeyManagementService and used for the integrity verification of the
# AAD. A false value of this
# field indicates either that
# EncryptRequest.additional_authenticated_data_crc32c was left unset or
# that it was not delivered to KeyManagementService. If you've set
# EncryptRequest.additional_authenticated_data_crc32c but this field is
# still false, discard the response and perform a limited number of retries.
# NOTE: This field is in Beta.
# Corresponds to the JSON property `verifiedAdditionalAuthenticatedDataCrc32c`
# @return [Boolean]
attr_accessor :verified_additional_authenticated_data_crc32c
alias_method :verified_additional_authenticated_data_crc32c?, :verified_additional_authenticated_data_crc32c
# Integrity verification field. A flag indicating whether
# EncryptRequest.plaintext_crc32c was received by
# KeyManagementService and used for the integrity verification of the
# plaintext. A false value of this field
# indicates either that EncryptRequest.plaintext_crc32c was left unset or
# that it was not delivered to KeyManagementService. If you've set
# EncryptRequest.plaintext_crc32c but this field is still false, discard
# the response and perform a limited number of retries.
# NOTE: This field is in Beta.
# Corresponds to the JSON property `verifiedPlaintextCrc32c`
# @return [Boolean]
attr_accessor :verified_plaintext_crc32c
alias_method :verified_plaintext_crc32c?, :verified_plaintext_crc32c
def initialize(**args) def initialize(**args)
update!(**args) update!(**args)
end end
@ -700,7 +953,10 @@ module Google
# Update properties of this object # Update properties of this object
def update!(**args) def update!(**args)
@ciphertext = args[:ciphertext] if args.key?(:ciphertext) @ciphertext = args[:ciphertext] if args.key?(:ciphertext)
@ciphertext_crc32c = args[:ciphertext_crc32c] if args.key?(:ciphertext_crc32c)
@name = args[:name] if args.key?(:name) @name = args[:name] if args.key?(:name)
@verified_additional_authenticated_data_crc32c = args[:verified_additional_authenticated_data_crc32c] if args.key?(:verified_additional_authenticated_data_crc32c)
@verified_plaintext_crc32c = args[:verified_plaintext_crc32c] if args.key?(:verified_plaintext_crc32c)
end end
end end
@ -1376,6 +1632,13 @@ module Google
# @return [String] # @return [String]
attr_accessor :algorithm attr_accessor :algorithm
# The name of the CryptoKeyVersion public key.
# Provided here for verification.
# NOTE: This field is in Beta.
# Corresponds to the JSON property `name`
# @return [String]
attr_accessor :name
# The public key, encoded in PEM format. For more information, see the # The public key, encoded in PEM format. For more information, see the
# [RFC 7468](https://tools.ietf.org/html/rfc7468) sections for # [RFC 7468](https://tools.ietf.org/html/rfc7468) sections for
# [General Considerations](https://tools.ietf.org/html/rfc7468#section-2) and # [General Considerations](https://tools.ietf.org/html/rfc7468#section-2) and
@ -1385,6 +1648,22 @@ module Google
# @return [String] # @return [String]
attr_accessor :pem attr_accessor :pem
# Integrity verification field. A CRC32C checksum of the returned
# PublicKey.pem. An integrity check of PublicKey.pem can be performed
# by computing the CRC32C checksum of PublicKey.pem and
# comparing your results to this field. Discard the response in case of
# non-matching checksum values, and perform a limited number of retries. A
# persistent mismatch may indicate an issue in your computation of the CRC32C
# checksum.
# Note: This field is defined as int64 for reasons of compatibility across
# different languages. However, it is a non-negative integer, which will
# never exceed 2^32-1, and can be safely downconverted to uint32 in languages
# that support this type.
# NOTE: This field is in Beta.
# Corresponds to the JSON property `pemCrc32c`
# @return [Fixnum]
attr_accessor :pem_crc32c
def initialize(**args) def initialize(**args)
update!(**args) update!(**args)
end end
@ -1392,7 +1671,9 @@ module Google
# Update properties of this object # Update properties of this object
def update!(**args) def update!(**args)
@algorithm = args[:algorithm] if args.key?(:algorithm) @algorithm = args[:algorithm] if args.key?(:algorithm)
@name = args[:name] if args.key?(:name)
@pem = args[:pem] if args.key?(:pem) @pem = args[:pem] if args.key?(:pem)
@pem_crc32c = args[:pem_crc32c] if args.key?(:pem_crc32c)
end end
end end

View File

@ -248,6 +248,7 @@ module Google
# @private # @private
class Representation < Google::Apis::Core::JsonRepresentation class Representation < Google::Apis::Core::JsonRepresentation
property :ciphertext, :base64 => true, as: 'ciphertext' property :ciphertext, :base64 => true, as: 'ciphertext'
property :ciphertext_crc32c, :numeric_string => true, as: 'ciphertextCrc32c'
end end
end end
@ -255,6 +256,8 @@ module Google
# @private # @private
class Representation < Google::Apis::Core::JsonRepresentation class Representation < Google::Apis::Core::JsonRepresentation
property :plaintext, :base64 => true, as: 'plaintext' property :plaintext, :base64 => true, as: 'plaintext'
property :plaintext_crc32c, :numeric_string => true, as: 'plaintextCrc32c'
property :verified_ciphertext_crc32c, as: 'verifiedCiphertextCrc32c'
end end
end end
@ -263,13 +266,17 @@ module Google
class Representation < Google::Apis::Core::JsonRepresentation class Representation < Google::Apis::Core::JsonRepresentation
property :digest, as: 'digest', class: Google::Apis::CloudkmsV1::Digest, decorator: Google::Apis::CloudkmsV1::Digest::Representation property :digest, as: 'digest', class: Google::Apis::CloudkmsV1::Digest, decorator: Google::Apis::CloudkmsV1::Digest::Representation
property :digest_crc32c, :numeric_string => true, as: 'digestCrc32c'
end end
end end
class AsymmetricSignResponse class AsymmetricSignResponse
# @private # @private
class Representation < Google::Apis::Core::JsonRepresentation class Representation < Google::Apis::Core::JsonRepresentation
property :name, as: 'name'
property :signature, :base64 => true, as: 'signature' property :signature, :base64 => true, as: 'signature'
property :signature_crc32c, :numeric_string => true, as: 'signatureCrc32c'
property :verified_digest_crc32c, as: 'verifiedDigestCrc32c'
end end
end end
@ -349,7 +356,9 @@ module Google
# @private # @private
class Representation < Google::Apis::Core::JsonRepresentation class Representation < Google::Apis::Core::JsonRepresentation
property :additional_authenticated_data, :base64 => true, as: 'additionalAuthenticatedData' property :additional_authenticated_data, :base64 => true, as: 'additionalAuthenticatedData'
property :additional_authenticated_data_crc32c, :numeric_string => true, as: 'additionalAuthenticatedDataCrc32c'
property :ciphertext, :base64 => true, as: 'ciphertext' property :ciphertext, :base64 => true, as: 'ciphertext'
property :ciphertext_crc32c, :numeric_string => true, as: 'ciphertextCrc32c'
end end
end end
@ -357,6 +366,7 @@ module Google
# @private # @private
class Representation < Google::Apis::Core::JsonRepresentation class Representation < Google::Apis::Core::JsonRepresentation
property :plaintext, :base64 => true, as: 'plaintext' property :plaintext, :base64 => true, as: 'plaintext'
property :plaintext_crc32c, :numeric_string => true, as: 'plaintextCrc32c'
end end
end end
@ -379,7 +389,9 @@ module Google
# @private # @private
class Representation < Google::Apis::Core::JsonRepresentation class Representation < Google::Apis::Core::JsonRepresentation
property :additional_authenticated_data, :base64 => true, as: 'additionalAuthenticatedData' property :additional_authenticated_data, :base64 => true, as: 'additionalAuthenticatedData'
property :additional_authenticated_data_crc32c, :numeric_string => true, as: 'additionalAuthenticatedDataCrc32c'
property :plaintext, :base64 => true, as: 'plaintext' property :plaintext, :base64 => true, as: 'plaintext'
property :plaintext_crc32c, :numeric_string => true, as: 'plaintextCrc32c'
end end
end end
@ -387,7 +399,10 @@ module Google
# @private # @private
class Representation < Google::Apis::Core::JsonRepresentation class Representation < Google::Apis::Core::JsonRepresentation
property :ciphertext, :base64 => true, as: 'ciphertext' property :ciphertext, :base64 => true, as: 'ciphertext'
property :ciphertext_crc32c, :numeric_string => true, as: 'ciphertextCrc32c'
property :name, as: 'name' property :name, as: 'name'
property :verified_additional_authenticated_data_crc32c, as: 'verifiedAdditionalAuthenticatedDataCrc32c'
property :verified_plaintext_crc32c, as: 'verifiedPlaintextCrc32c'
end end
end end
@ -535,7 +550,9 @@ module Google
# @private # @private
class Representation < Google::Apis::Core::JsonRepresentation class Representation < Google::Apis::Core::JsonRepresentation
property :algorithm, as: 'algorithm' property :algorithm, as: 'algorithm'
property :name, as: 'name'
property :pem, as: 'pem' property :pem, as: 'pem'
property :pem_crc32c, :numeric_string => true, as: 'pemCrc32c'
end end
end end

View File

@ -26,7 +26,7 @@ module Google
# @see https://cloud.google.com/dialogflow/ # @see https://cloud.google.com/dialogflow/
module DialogflowV2 module DialogflowV2
VERSION = 'V2' VERSION = 'V2'
REVISION = '20200518' REVISION = '20200526'
# View and manage your data across Google Cloud Platform services # View and manage your data across Google Cloud Platform services
AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform'

View File

@ -22,6 +22,563 @@ module Google
module Apis module Apis
module DialogflowV2 module DialogflowV2
# The response message for Agents.ExportAgent.
class GoogleCloudDialogflowCxV3beta1ExportAgentResponse
include Google::Apis::Core::Hashable
# Uncompressed raw byte content for agent.
# Corresponds to the JSON property `agentContent`
# NOTE: Values are automatically base64 encoded/decoded in the client library.
# @return [String]
attr_accessor :agent_content
# The URI to a file containing the exported agent. This field is populated
# only if `agent_uri` is specified in ExportAgentRequest.
# Corresponds to the JSON property `agentUri`
# @return [String]
attr_accessor :agent_uri
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@agent_content = args[:agent_content] if args.key?(:agent_content)
@agent_uri = args[:agent_uri] if args.key?(:agent_uri)
end
end
# Represents page information communicated to and from the webhook.
class GoogleCloudDialogflowCxV3beta1PageInfo
include Google::Apis::Core::Hashable
# Always present for WebhookRequest. Ignored for WebhookResponse.
# The unique identifier of the current page.
# Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
# ID>/flows/<Flow ID>/pages/<Page ID>`.
# Corresponds to the JSON property `currentPage`
# @return [String]
attr_accessor :current_page
# Represents form information.
# Corresponds to the JSON property `formInfo`
# @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowCxV3beta1PageInfoFormInfo]
attr_accessor :form_info
# Deprecated. Please use WebhookResponse.target_page or
# WebhookResponse.target_flow instead.
# Optional for WebhookResponse.
# The unique identifier of the next page. This field can be set by the
# webhook to immediately transition to a page different from `current_page`.
# Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
# ID>/flows/<Flow ID>/pages/<Page ID>`.
# Corresponds to the JSON property `nextPage`
# @return [String]
attr_accessor :next_page
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@current_page = args[:current_page] if args.key?(:current_page)
@form_info = args[:form_info] if args.key?(:form_info)
@next_page = args[:next_page] if args.key?(:next_page)
end
end
# Represents form information.
class GoogleCloudDialogflowCxV3beta1PageInfoFormInfo
include Google::Apis::Core::Hashable
# Optional for both WebhookRequest and WebhookResponse.
# The parameters contained in the form. Note that the webhook cannot add
# or remove any form parameter.
# Corresponds to the JSON property `parameterInfo`
# @return [Array<Google::Apis::DialogflowV2::GoogleCloudDialogflowCxV3beta1PageInfoFormInfoParameterInfo>]
attr_accessor :parameter_info
# Always present for WebhookRequest. Ignored for WebhookResponse.
# The current state of the form.
# 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)
@parameter_info = args[:parameter_info] if args.key?(:parameter_info)
@state = args[:state] if args.key?(:state)
end
end
# Represents parameter information.
class GoogleCloudDialogflowCxV3beta1PageInfoFormInfoParameterInfo
include Google::Apis::Core::Hashable
# Always present for WebhookRequest. Required for
# WebhookResponse.
# The human-readable name of the parameter, unique within the form. This
# field cannot be modified by the webhook.
# Corresponds to the JSON property `displayName`
# @return [String]
attr_accessor :display_name
# Optional for WebhookRequest. Ignored for WebhookResponse.
# Indicates if the parameter value was just collected on the last
# conversation turn.
# Corresponds to the JSON property `justCollected`
# @return [Boolean]
attr_accessor :just_collected
alias_method :just_collected?, :just_collected
# Not set for WebhookRequest. Optional for WebhookResponse.
# The prompt to send to the user to fill a required form parameter. This
# field can be set by the webhook. If set, this field overrides the
# prompt defined for the form parameter.
# Corresponds to the JSON property `prompt`
# @return [Array<Google::Apis::DialogflowV2::GoogleCloudDialogflowCxV3beta1ResponseMessage>]
attr_accessor :prompt
# Optional for both WebhookRequest and WebhookResponse.
# Indicates whether the parameter is required. Optional parameters will
# not trigger prompts; however, they are filled if the user specifies
# them. Required parameters must be filled before form filling concludes.
# Corresponds to the JSON property `required`
# @return [Boolean]
attr_accessor :required
alias_method :required?, :required
# Always present for WebhookRequest. Required for
# WebhookResponse. The state of the parameter. This field can be set
# to INVALID by
# the webhook to invalidate the parameter; other values set by the
# webhook will be ignored.
# Corresponds to the JSON property `state`
# @return [String]
attr_accessor :state
# Optional for both WebhookRequest and WebhookResponse.
# The value of the parameter. This field can be set by the webhook to
# change the parameter value.
# Corresponds to the JSON property `value`
# @return [Object]
attr_accessor :value
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@display_name = args[:display_name] if args.key?(:display_name)
@just_collected = args[:just_collected] if args.key?(:just_collected)
@prompt = args[:prompt] if args.key?(:prompt)
@required = args[:required] if args.key?(:required)
@state = args[:state] if args.key?(:state)
@value = args[:value] if args.key?(:value)
end
end
# Represents a response message that can be returned by a conversational agent.
# Response messages are also used for output audio synthesis. The approach is
# as follows:
# * If at least one OutputAudioText response is present, then all
# OutputAudioText responses are linearly concatenated, and the result is used
# for output audio synthesis.
# * If the OutputAudioText responses are a mixture of text and SSML, then the
# concatenated result is treated as SSML; otherwise, the result is treated as
# either text or SSML as appropriate. The agent designer should ideally use
# either text or SSML consistently throughout the bot design.
# * Otherwise, all Text responses are linearly concatenated, and the result is
# used for output audio synthesis.
# This approach allows for more sophisticated user experience scenarios, where
# the text displayed to the user may differ from what is heard.
class GoogleCloudDialogflowCxV3beta1ResponseMessage
include Google::Apis::Core::Hashable
# Indicates that the conversation succeeded, i.e., the bot handled the issue
# that the customer talked to it about.
# Dialogflow only uses this to determine which conversations should be
# counted as successful and doesn't process the metadata in this message in
# any way. Note that Dialogflow also considers conversations that get to the
# conversation end page as successful even if they don't return
# ConversationSuccess.
# You may set this, for example:
# * In the entry_fulfillment of a Page if
# entering the page indicates that the conversation succeeded.
# * In a webhook response when you determine that you handled the customer
# issue.
# Corresponds to the JSON property `conversationSuccess`
# @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowCxV3beta1ResponseMessageConversationSuccess]
attr_accessor :conversation_success
# Indicates that the conversation should be handed off to a human agent.
# Dialogflow only uses this to determine which conversations were handed off
# to a human agent for measurement purposes. What else to do with this signal
# is up to you and your handoff procedures.
# You may set this, for example:
# * In the entry_fulfillment of a Page if
# entering the page indicates something went extremely wrong in the
# conversation.
# * In a webhook response when you determine that the customer issue can only
# be handled by a human.
# Corresponds to the JSON property `humanAgentHandoff`
# @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowCxV3beta1ResponseMessageHumanAgentHandoff]
attr_accessor :human_agent_handoff
# Returns a response containing a custom, platform-specific payload.
# Corresponds to the JSON property `payload`
# @return [Hash<String,Object>]
attr_accessor :payload
# The text response message.
# Corresponds to the JSON property `text`
# @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowCxV3beta1ResponseMessageText]
attr_accessor :text
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@conversation_success = args[:conversation_success] if args.key?(:conversation_success)
@human_agent_handoff = args[:human_agent_handoff] if args.key?(:human_agent_handoff)
@payload = args[:payload] if args.key?(:payload)
@text = args[:text] if args.key?(:text)
end
end
# Indicates that the conversation succeeded, i.e., the bot handled the issue
# that the customer talked to it about.
# Dialogflow only uses this to determine which conversations should be
# counted as successful and doesn't process the metadata in this message in
# any way. Note that Dialogflow also considers conversations that get to the
# conversation end page as successful even if they don't return
# ConversationSuccess.
# You may set this, for example:
# * In the entry_fulfillment of a Page if
# entering the page indicates that the conversation succeeded.
# * In a webhook response when you determine that you handled the customer
# issue.
class GoogleCloudDialogflowCxV3beta1ResponseMessageConversationSuccess
include Google::Apis::Core::Hashable
# Custom metadata. Dialogflow doesn't impose any structure on this.
# Corresponds to the JSON property `metadata`
# @return [Hash<String,Object>]
attr_accessor :metadata
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@metadata = args[:metadata] if args.key?(:metadata)
end
end
# Indicates that the conversation should be handed off to a human agent.
# Dialogflow only uses this to determine which conversations were handed off
# to a human agent for measurement purposes. What else to do with this signal
# is up to you and your handoff procedures.
# You may set this, for example:
# * In the entry_fulfillment of a Page if
# entering the page indicates something went extremely wrong in the
# conversation.
# * In a webhook response when you determine that the customer issue can only
# be handled by a human.
class GoogleCloudDialogflowCxV3beta1ResponseMessageHumanAgentHandoff
include Google::Apis::Core::Hashable
# Custom metadata for your handoff procedure. Dialogflow doesn't impose
# any structure on this.
# Corresponds to the JSON property `metadata`
# @return [Hash<String,Object>]
attr_accessor :metadata
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@metadata = args[:metadata] if args.key?(:metadata)
end
end
# The text response message.
class GoogleCloudDialogflowCxV3beta1ResponseMessageText
include Google::Apis::Core::Hashable
# A collection of text responses.
# Corresponds to the JSON property `text`
# @return [Array<String>]
attr_accessor :text
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@text = args[:text] if args.key?(:text)
end
end
# Represents session information communicated to and from the webhook.
class GoogleCloudDialogflowCxV3beta1SessionInfo
include Google::Apis::Core::Hashable
# Optional for WebhookRequest. Optional for WebhookResponse.
# All parameters collected from forms and intents during the session.
# Parameters can be created, updated, or removed by the webhook. To remove a
# parameter from the session, the webhook should explicitly set the parameter
# value to null in WebhookResponse. The map is keyed by parameters'
# display names.
# Corresponds to the JSON property `parameters`
# @return [Hash<String,Object>]
attr_accessor :parameters
# Always present for WebhookRequest. Ignored for WebhookResponse.
# The unique identifier of the session. This
# field can be used by the webhook to identify a user.
# Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
# ID>/sessions/<Session ID>`.
# Corresponds to the JSON property `session`
# @return [String]
attr_accessor :session
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@parameters = args[:parameters] if args.key?(:parameters)
@session = args[:session] if args.key?(:session)
end
end
# The request message for a webhook call.
class GoogleCloudDialogflowCxV3beta1WebhookRequest
include Google::Apis::Core::Hashable
# Always present. The unique identifier of the DetectIntentResponse that
# will be returned to the API caller.
# Corresponds to the JSON property `detectIntentResponseId`
# @return [String]
attr_accessor :detect_intent_response_id
# Represents fulfillment information communicated to the webhook.
# Corresponds to the JSON property `fulfillmentInfo`
# @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowCxV3beta1WebhookRequestFulfillmentInfo]
attr_accessor :fulfillment_info
# Represents intent information communicated to the webhook.
# Corresponds to the JSON property `intentInfo`
# @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowCxV3beta1WebhookRequestIntentInfo]
attr_accessor :intent_info
# The list of rich message responses to present to the user. Webhook can
# choose to append or replace this list in
# WebhookResponse.fulfillment_response;
# Corresponds to the JSON property `messages`
# @return [Array<Google::Apis::DialogflowV2::GoogleCloudDialogflowCxV3beta1ResponseMessage>]
attr_accessor :messages
# Represents page information communicated to and from the webhook.
# Corresponds to the JSON property `pageInfo`
# @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowCxV3beta1PageInfo]
attr_accessor :page_info
# Custom data set in QueryParameters.payload.
# Corresponds to the JSON property `payload`
# @return [Hash<String,Object>]
attr_accessor :payload
# Represents session information communicated to and from the webhook.
# Corresponds to the JSON property `sessionInfo`
# @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowCxV3beta1SessionInfo]
attr_accessor :session_info
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@detect_intent_response_id = args[:detect_intent_response_id] if args.key?(:detect_intent_response_id)
@fulfillment_info = args[:fulfillment_info] if args.key?(:fulfillment_info)
@intent_info = args[:intent_info] if args.key?(:intent_info)
@messages = args[:messages] if args.key?(:messages)
@page_info = args[:page_info] if args.key?(:page_info)
@payload = args[:payload] if args.key?(:payload)
@session_info = args[:session_info] if args.key?(:session_info)
end
end
# Represents fulfillment information communicated to the webhook.
class GoogleCloudDialogflowCxV3beta1WebhookRequestFulfillmentInfo
include Google::Apis::Core::Hashable
# Always present. The tag used to identify which fulfillment is being
# called.
# Corresponds to the JSON property `tag`
# @return [String]
attr_accessor :tag
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@tag = args[:tag] if args.key?(:tag)
end
end
# Represents intent information communicated to the webhook.
class GoogleCloudDialogflowCxV3beta1WebhookRequestIntentInfo
include Google::Apis::Core::Hashable
# Always present. The unique identifier of the last matched
# intent. Format: `projects/<Project ID>/locations/<Location
# ID>/agents/<Agent ID>/intents/<Intent ID>`.
# Corresponds to the JSON property `lastMatchedIntent`
# @return [String]
attr_accessor :last_matched_intent
# Parameters identified as a result of intent matching. This is a map of
# the name of the identified parameter to the value of the parameter
# identified from the user's utterance. All parameters defined in the
# matched intent that are identified will be surfaced here.
# Corresponds to the JSON property `parameters`
# @return [Hash<String,Google::Apis::DialogflowV2::GoogleCloudDialogflowCxV3beta1WebhookRequestIntentInfoIntentParameterValue>]
attr_accessor :parameters
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@last_matched_intent = args[:last_matched_intent] if args.key?(:last_matched_intent)
@parameters = args[:parameters] if args.key?(:parameters)
end
end
# Represents a value for an intent parameter.
class GoogleCloudDialogflowCxV3beta1WebhookRequestIntentInfoIntentParameterValue
include Google::Apis::Core::Hashable
# Always present. Original text value extracted from user utterance.
# Corresponds to the JSON property `originalValue`
# @return [String]
attr_accessor :original_value
# Always present. Structured value for the parameter extracted from user
# utterance.
# Corresponds to the JSON property `resolvedValue`
# @return [Object]
attr_accessor :resolved_value
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@original_value = args[:original_value] if args.key?(:original_value)
@resolved_value = args[:resolved_value] if args.key?(:resolved_value)
end
end
# The response message for a webhook call.
class GoogleCloudDialogflowCxV3beta1WebhookResponse
include Google::Apis::Core::Hashable
# Represents a fulfillment response to the user.
# Corresponds to the JSON property `fulfillmentResponse`
# @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowCxV3beta1WebhookResponseFulfillmentResponse]
attr_accessor :fulfillment_response
# Represents page information communicated to and from the webhook.
# Corresponds to the JSON property `pageInfo`
# @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowCxV3beta1PageInfo]
attr_accessor :page_info
# Value to append directly to QueryResult.webhook_payloads.
# Corresponds to the JSON property `payload`
# @return [Hash<String,Object>]
attr_accessor :payload
# Represents session information communicated to and from the webhook.
# Corresponds to the JSON property `sessionInfo`
# @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowCxV3beta1SessionInfo]
attr_accessor :session_info
# The target flow to transition to.
# Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
# ID>/flows/<Flow ID>`.
# Corresponds to the JSON property `targetFlow`
# @return [String]
attr_accessor :target_flow
# The target page to transition to.
# Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
# ID>/flows/<Flow ID>/pages/<Page ID>`.
# Corresponds to the JSON property `targetPage`
# @return [String]
attr_accessor :target_page
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@fulfillment_response = args[:fulfillment_response] if args.key?(:fulfillment_response)
@page_info = args[:page_info] if args.key?(:page_info)
@payload = args[:payload] if args.key?(:payload)
@session_info = args[:session_info] if args.key?(:session_info)
@target_flow = args[:target_flow] if args.key?(:target_flow)
@target_page = args[:target_page] if args.key?(:target_page)
end
end
# Represents a fulfillment response to the user.
class GoogleCloudDialogflowCxV3beta1WebhookResponseFulfillmentResponse
include Google::Apis::Core::Hashable
# Merge behavior for `messages`.
# Corresponds to the JSON property `mergeBehavior`
# @return [String]
attr_accessor :merge_behavior
# The list of rich message responses to present to the user.
# Corresponds to the JSON property `messages`
# @return [Array<Google::Apis::DialogflowV2::GoogleCloudDialogflowCxV3beta1ResponseMessage>]
attr_accessor :messages
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@merge_behavior = args[:merge_behavior] if args.key?(:merge_behavior)
@messages = args[:messages] if args.key?(:messages)
end
end
# Represents a conversational agent. # Represents a conversational agent.
class GoogleCloudDialogflowV2Agent class GoogleCloudDialogflowV2Agent
include Google::Apis::Core::Hashable include Google::Apis::Core::Hashable
@ -4185,8 +4742,8 @@ module Google
# Rich cards allow you to respond to users with more vivid content, e.g. # Rich cards allow you to respond to users with more vivid content, e.g.
# with media and suggestions. # with media and suggestions.
# For more details about RBM rich cards, please see: # For more details about RBM rich cards, please see:
# https://developers.google.com/rcs-business-messaging/rbm/guides/build/send- # https://developers.google.com/business-communications/rcs-business-messaging/
# messages#rich-cards. # guides/build/messages/send#rich-cards
# If you want to show a single card with more control over the layout, # If you want to show a single card with more control over the layout,
# please use RbmStandaloneCard instead. # please use RbmStandaloneCard instead.
# Corresponds to the JSON property `rbmCarouselRichCard` # Corresponds to the JSON property `rbmCarouselRichCard`
@ -4197,8 +4754,8 @@ module Google
# Rich cards allow you to respond to users with more vivid content, e.g. # Rich cards allow you to respond to users with more vivid content, e.g.
# with media and suggestions. # with media and suggestions.
# For more details about RBM rich cards, please see: # For more details about RBM rich cards, please see:
# https://developers.google.com/rcs-business-messaging/rbm/guides/build/send- # https://developers.google.com/business-communications/rcs-business-messaging/
# messages#rich-cards. # guides/build/messages/send#rich-cards
# You can group multiple rich cards into one using RbmCarouselCard but # You can group multiple rich cards into one using RbmCarouselCard but
# carousel cards will give you less control over the card layout. # carousel cards will give you less control over the card layout.
# Corresponds to the JSON property `rbmStandaloneRichCard` # Corresponds to the JSON property `rbmStandaloneRichCard`
@ -4938,8 +5495,8 @@ module Google
# Rich cards allow you to respond to users with more vivid content, e.g. # Rich cards allow you to respond to users with more vivid content, e.g.
# with media and suggestions. # with media and suggestions.
# For more details about RBM rich cards, please see: # For more details about RBM rich cards, please see:
# https://developers.google.com/rcs-business-messaging/rbm/guides/build/send- # https://developers.google.com/business-communications/rcs-business-messaging/
# messages#rich-cards. # guides/build/messages/send#rich-cards
# If you want to show a single card with more control over the layout, # If you want to show a single card with more control over the layout,
# please use RbmStandaloneCard instead. # please use RbmStandaloneCard instead.
class GoogleCloudDialogflowV2beta1IntentMessageRbmCarouselCard class GoogleCloudDialogflowV2beta1IntentMessageRbmCarouselCard
@ -4971,8 +5528,8 @@ module Google
# Rich cards allow you to respond to users with more vivid content, e.g. # Rich cards allow you to respond to users with more vivid content, e.g.
# with media and suggestions. # with media and suggestions.
# For more details about RBM rich cards, please see: # For more details about RBM rich cards, please see:
# https://developers.google.com/rcs-business-messaging/rbm/guides/build/send- # https://developers.google.com/business-communications/rcs-business-messaging/
# messages#rich-cards. # guides/build/messages/send#rich-cards
# You can group multiple rich cards into one using RbmCarouselCard but # You can group multiple rich cards into one using RbmCarouselCard but
# carousel cards will give you less control over the card layout. # carousel cards will give you less control over the card layout.
class GoogleCloudDialogflowV2beta1IntentMessageRbmStandaloneCard class GoogleCloudDialogflowV2beta1IntentMessageRbmStandaloneCard

View File

@ -22,6 +22,96 @@ module Google
module Apis module Apis
module DialogflowV2 module DialogflowV2
class GoogleCloudDialogflowCxV3beta1ExportAgentResponse
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class GoogleCloudDialogflowCxV3beta1PageInfo
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class GoogleCloudDialogflowCxV3beta1PageInfoFormInfo
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class GoogleCloudDialogflowCxV3beta1PageInfoFormInfoParameterInfo
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class GoogleCloudDialogflowCxV3beta1ResponseMessage
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class GoogleCloudDialogflowCxV3beta1ResponseMessageConversationSuccess
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class GoogleCloudDialogflowCxV3beta1ResponseMessageHumanAgentHandoff
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class GoogleCloudDialogflowCxV3beta1ResponseMessageText
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class GoogleCloudDialogflowCxV3beta1SessionInfo
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class GoogleCloudDialogflowCxV3beta1WebhookRequest
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class GoogleCloudDialogflowCxV3beta1WebhookRequestFulfillmentInfo
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class GoogleCloudDialogflowCxV3beta1WebhookRequestIntentInfo
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class GoogleCloudDialogflowCxV3beta1WebhookRequestIntentInfoIntentParameterValue
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class GoogleCloudDialogflowCxV3beta1WebhookResponse
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class GoogleCloudDialogflowCxV3beta1WebhookResponseFulfillmentResponse
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class GoogleCloudDialogflowV2Agent class GoogleCloudDialogflowV2Agent
class Representation < Google::Apis::Core::JsonRepresentation; end class Representation < Google::Apis::Core::JsonRepresentation; end
@ -982,6 +1072,154 @@ module Google
include Google::Apis::Core::JsonObjectSupport include Google::Apis::Core::JsonObjectSupport
end end
class GoogleCloudDialogflowCxV3beta1ExportAgentResponse
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :agent_content, :base64 => true, as: 'agentContent'
property :agent_uri, as: 'agentUri'
end
end
class GoogleCloudDialogflowCxV3beta1PageInfo
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :current_page, as: 'currentPage'
property :form_info, as: 'formInfo', class: Google::Apis::DialogflowV2::GoogleCloudDialogflowCxV3beta1PageInfoFormInfo, decorator: Google::Apis::DialogflowV2::GoogleCloudDialogflowCxV3beta1PageInfoFormInfo::Representation
property :next_page, as: 'nextPage'
end
end
class GoogleCloudDialogflowCxV3beta1PageInfoFormInfo
# @private
class Representation < Google::Apis::Core::JsonRepresentation
collection :parameter_info, as: 'parameterInfo', class: Google::Apis::DialogflowV2::GoogleCloudDialogflowCxV3beta1PageInfoFormInfoParameterInfo, decorator: Google::Apis::DialogflowV2::GoogleCloudDialogflowCxV3beta1PageInfoFormInfoParameterInfo::Representation
property :state, as: 'state'
end
end
class GoogleCloudDialogflowCxV3beta1PageInfoFormInfoParameterInfo
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :display_name, as: 'displayName'
property :just_collected, as: 'justCollected'
collection :prompt, as: 'prompt', class: Google::Apis::DialogflowV2::GoogleCloudDialogflowCxV3beta1ResponseMessage, decorator: Google::Apis::DialogflowV2::GoogleCloudDialogflowCxV3beta1ResponseMessage::Representation
property :required, as: 'required'
property :state, as: 'state'
property :value, as: 'value'
end
end
class GoogleCloudDialogflowCxV3beta1ResponseMessage
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :conversation_success, as: 'conversationSuccess', class: Google::Apis::DialogflowV2::GoogleCloudDialogflowCxV3beta1ResponseMessageConversationSuccess, decorator: Google::Apis::DialogflowV2::GoogleCloudDialogflowCxV3beta1ResponseMessageConversationSuccess::Representation
property :human_agent_handoff, as: 'humanAgentHandoff', class: Google::Apis::DialogflowV2::GoogleCloudDialogflowCxV3beta1ResponseMessageHumanAgentHandoff, decorator: Google::Apis::DialogflowV2::GoogleCloudDialogflowCxV3beta1ResponseMessageHumanAgentHandoff::Representation
hash :payload, as: 'payload'
property :text, as: 'text', class: Google::Apis::DialogflowV2::GoogleCloudDialogflowCxV3beta1ResponseMessageText, decorator: Google::Apis::DialogflowV2::GoogleCloudDialogflowCxV3beta1ResponseMessageText::Representation
end
end
class GoogleCloudDialogflowCxV3beta1ResponseMessageConversationSuccess
# @private
class Representation < Google::Apis::Core::JsonRepresentation
hash :metadata, as: 'metadata'
end
end
class GoogleCloudDialogflowCxV3beta1ResponseMessageHumanAgentHandoff
# @private
class Representation < Google::Apis::Core::JsonRepresentation
hash :metadata, as: 'metadata'
end
end
class GoogleCloudDialogflowCxV3beta1ResponseMessageText
# @private
class Representation < Google::Apis::Core::JsonRepresentation
collection :text, as: 'text'
end
end
class GoogleCloudDialogflowCxV3beta1SessionInfo
# @private
class Representation < Google::Apis::Core::JsonRepresentation
hash :parameters, as: 'parameters'
property :session, as: 'session'
end
end
class GoogleCloudDialogflowCxV3beta1WebhookRequest
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :detect_intent_response_id, as: 'detectIntentResponseId'
property :fulfillment_info, as: 'fulfillmentInfo', class: Google::Apis::DialogflowV2::GoogleCloudDialogflowCxV3beta1WebhookRequestFulfillmentInfo, decorator: Google::Apis::DialogflowV2::GoogleCloudDialogflowCxV3beta1WebhookRequestFulfillmentInfo::Representation
property :intent_info, as: 'intentInfo', class: Google::Apis::DialogflowV2::GoogleCloudDialogflowCxV3beta1WebhookRequestIntentInfo, decorator: Google::Apis::DialogflowV2::GoogleCloudDialogflowCxV3beta1WebhookRequestIntentInfo::Representation
collection :messages, as: 'messages', class: Google::Apis::DialogflowV2::GoogleCloudDialogflowCxV3beta1ResponseMessage, decorator: Google::Apis::DialogflowV2::GoogleCloudDialogflowCxV3beta1ResponseMessage::Representation
property :page_info, as: 'pageInfo', class: Google::Apis::DialogflowV2::GoogleCloudDialogflowCxV3beta1PageInfo, decorator: Google::Apis::DialogflowV2::GoogleCloudDialogflowCxV3beta1PageInfo::Representation
hash :payload, as: 'payload'
property :session_info, as: 'sessionInfo', class: Google::Apis::DialogflowV2::GoogleCloudDialogflowCxV3beta1SessionInfo, decorator: Google::Apis::DialogflowV2::GoogleCloudDialogflowCxV3beta1SessionInfo::Representation
end
end
class GoogleCloudDialogflowCxV3beta1WebhookRequestFulfillmentInfo
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :tag, as: 'tag'
end
end
class GoogleCloudDialogflowCxV3beta1WebhookRequestIntentInfo
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :last_matched_intent, as: 'lastMatchedIntent'
hash :parameters, as: 'parameters', class: Google::Apis::DialogflowV2::GoogleCloudDialogflowCxV3beta1WebhookRequestIntentInfoIntentParameterValue, decorator: Google::Apis::DialogflowV2::GoogleCloudDialogflowCxV3beta1WebhookRequestIntentInfoIntentParameterValue::Representation
end
end
class GoogleCloudDialogflowCxV3beta1WebhookRequestIntentInfoIntentParameterValue
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :original_value, as: 'originalValue'
property :resolved_value, as: 'resolvedValue'
end
end
class GoogleCloudDialogflowCxV3beta1WebhookResponse
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :fulfillment_response, as: 'fulfillmentResponse', class: Google::Apis::DialogflowV2::GoogleCloudDialogflowCxV3beta1WebhookResponseFulfillmentResponse, decorator: Google::Apis::DialogflowV2::GoogleCloudDialogflowCxV3beta1WebhookResponseFulfillmentResponse::Representation
property :page_info, as: 'pageInfo', class: Google::Apis::DialogflowV2::GoogleCloudDialogflowCxV3beta1PageInfo, decorator: Google::Apis::DialogflowV2::GoogleCloudDialogflowCxV3beta1PageInfo::Representation
hash :payload, as: 'payload'
property :session_info, as: 'sessionInfo', class: Google::Apis::DialogflowV2::GoogleCloudDialogflowCxV3beta1SessionInfo, decorator: Google::Apis::DialogflowV2::GoogleCloudDialogflowCxV3beta1SessionInfo::Representation
property :target_flow, as: 'targetFlow'
property :target_page, as: 'targetPage'
end
end
class GoogleCloudDialogflowCxV3beta1WebhookResponseFulfillmentResponse
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :merge_behavior, as: 'mergeBehavior'
collection :messages, as: 'messages', class: Google::Apis::DialogflowV2::GoogleCloudDialogflowCxV3beta1ResponseMessage, decorator: Google::Apis::DialogflowV2::GoogleCloudDialogflowCxV3beta1ResponseMessage::Representation
end
end
class GoogleCloudDialogflowV2Agent class GoogleCloudDialogflowV2Agent
# @private # @private
class Representation < Google::Apis::Core::JsonRepresentation class Representation < Google::Apis::Core::JsonRepresentation

View File

@ -26,7 +26,7 @@ module Google
# @see https://cloud.google.com/dialogflow/ # @see https://cloud.google.com/dialogflow/
module DialogflowV2beta1 module DialogflowV2beta1
VERSION = 'V2beta1' VERSION = 'V2beta1'
REVISION = '20200518' REVISION = '20200526'
# View and manage your data across Google Cloud Platform services # View and manage your data across Google Cloud Platform services
AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform'

View File

@ -22,6 +22,563 @@ module Google
module Apis module Apis
module DialogflowV2beta1 module DialogflowV2beta1
# The response message for Agents.ExportAgent.
class GoogleCloudDialogflowCxV3beta1ExportAgentResponse
include Google::Apis::Core::Hashable
# Uncompressed raw byte content for agent.
# Corresponds to the JSON property `agentContent`
# NOTE: Values are automatically base64 encoded/decoded in the client library.
# @return [String]
attr_accessor :agent_content
# The URI to a file containing the exported agent. This field is populated
# only if `agent_uri` is specified in ExportAgentRequest.
# Corresponds to the JSON property `agentUri`
# @return [String]
attr_accessor :agent_uri
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@agent_content = args[:agent_content] if args.key?(:agent_content)
@agent_uri = args[:agent_uri] if args.key?(:agent_uri)
end
end
# Represents page information communicated to and from the webhook.
class GoogleCloudDialogflowCxV3beta1PageInfo
include Google::Apis::Core::Hashable
# Always present for WebhookRequest. Ignored for WebhookResponse.
# The unique identifier of the current page.
# Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
# ID>/flows/<Flow ID>/pages/<Page ID>`.
# Corresponds to the JSON property `currentPage`
# @return [String]
attr_accessor :current_page
# Represents form information.
# Corresponds to the JSON property `formInfo`
# @return [Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowCxV3beta1PageInfoFormInfo]
attr_accessor :form_info
# Deprecated. Please use WebhookResponse.target_page or
# WebhookResponse.target_flow instead.
# Optional for WebhookResponse.
# The unique identifier of the next page. This field can be set by the
# webhook to immediately transition to a page different from `current_page`.
# Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
# ID>/flows/<Flow ID>/pages/<Page ID>`.
# Corresponds to the JSON property `nextPage`
# @return [String]
attr_accessor :next_page
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@current_page = args[:current_page] if args.key?(:current_page)
@form_info = args[:form_info] if args.key?(:form_info)
@next_page = args[:next_page] if args.key?(:next_page)
end
end
# Represents form information.
class GoogleCloudDialogflowCxV3beta1PageInfoFormInfo
include Google::Apis::Core::Hashable
# Optional for both WebhookRequest and WebhookResponse.
# The parameters contained in the form. Note that the webhook cannot add
# or remove any form parameter.
# Corresponds to the JSON property `parameterInfo`
# @return [Array<Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowCxV3beta1PageInfoFormInfoParameterInfo>]
attr_accessor :parameter_info
# Always present for WebhookRequest. Ignored for WebhookResponse.
# The current state of the form.
# 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)
@parameter_info = args[:parameter_info] if args.key?(:parameter_info)
@state = args[:state] if args.key?(:state)
end
end
# Represents parameter information.
class GoogleCloudDialogflowCxV3beta1PageInfoFormInfoParameterInfo
include Google::Apis::Core::Hashable
# Always present for WebhookRequest. Required for
# WebhookResponse.
# The human-readable name of the parameter, unique within the form. This
# field cannot be modified by the webhook.
# Corresponds to the JSON property `displayName`
# @return [String]
attr_accessor :display_name
# Optional for WebhookRequest. Ignored for WebhookResponse.
# Indicates if the parameter value was just collected on the last
# conversation turn.
# Corresponds to the JSON property `justCollected`
# @return [Boolean]
attr_accessor :just_collected
alias_method :just_collected?, :just_collected
# Not set for WebhookRequest. Optional for WebhookResponse.
# The prompt to send to the user to fill a required form parameter. This
# field can be set by the webhook. If set, this field overrides the
# prompt defined for the form parameter.
# Corresponds to the JSON property `prompt`
# @return [Array<Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowCxV3beta1ResponseMessage>]
attr_accessor :prompt
# Optional for both WebhookRequest and WebhookResponse.
# Indicates whether the parameter is required. Optional parameters will
# not trigger prompts; however, they are filled if the user specifies
# them. Required parameters must be filled before form filling concludes.
# Corresponds to the JSON property `required`
# @return [Boolean]
attr_accessor :required
alias_method :required?, :required
# Always present for WebhookRequest. Required for
# WebhookResponse. The state of the parameter. This field can be set
# to INVALID by
# the webhook to invalidate the parameter; other values set by the
# webhook will be ignored.
# Corresponds to the JSON property `state`
# @return [String]
attr_accessor :state
# Optional for both WebhookRequest and WebhookResponse.
# The value of the parameter. This field can be set by the webhook to
# change the parameter value.
# Corresponds to the JSON property `value`
# @return [Object]
attr_accessor :value
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@display_name = args[:display_name] if args.key?(:display_name)
@just_collected = args[:just_collected] if args.key?(:just_collected)
@prompt = args[:prompt] if args.key?(:prompt)
@required = args[:required] if args.key?(:required)
@state = args[:state] if args.key?(:state)
@value = args[:value] if args.key?(:value)
end
end
# Represents a response message that can be returned by a conversational agent.
# Response messages are also used for output audio synthesis. The approach is
# as follows:
# * If at least one OutputAudioText response is present, then all
# OutputAudioText responses are linearly concatenated, and the result is used
# for output audio synthesis.
# * If the OutputAudioText responses are a mixture of text and SSML, then the
# concatenated result is treated as SSML; otherwise, the result is treated as
# either text or SSML as appropriate. The agent designer should ideally use
# either text or SSML consistently throughout the bot design.
# * Otherwise, all Text responses are linearly concatenated, and the result is
# used for output audio synthesis.
# This approach allows for more sophisticated user experience scenarios, where
# the text displayed to the user may differ from what is heard.
class GoogleCloudDialogflowCxV3beta1ResponseMessage
include Google::Apis::Core::Hashable
# Indicates that the conversation succeeded, i.e., the bot handled the issue
# that the customer talked to it about.
# Dialogflow only uses this to determine which conversations should be
# counted as successful and doesn't process the metadata in this message in
# any way. Note that Dialogflow also considers conversations that get to the
# conversation end page as successful even if they don't return
# ConversationSuccess.
# You may set this, for example:
# * In the entry_fulfillment of a Page if
# entering the page indicates that the conversation succeeded.
# * In a webhook response when you determine that you handled the customer
# issue.
# Corresponds to the JSON property `conversationSuccess`
# @return [Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowCxV3beta1ResponseMessageConversationSuccess]
attr_accessor :conversation_success
# Indicates that the conversation should be handed off to a human agent.
# Dialogflow only uses this to determine which conversations were handed off
# to a human agent for measurement purposes. What else to do with this signal
# is up to you and your handoff procedures.
# You may set this, for example:
# * In the entry_fulfillment of a Page if
# entering the page indicates something went extremely wrong in the
# conversation.
# * In a webhook response when you determine that the customer issue can only
# be handled by a human.
# Corresponds to the JSON property `humanAgentHandoff`
# @return [Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowCxV3beta1ResponseMessageHumanAgentHandoff]
attr_accessor :human_agent_handoff
# Returns a response containing a custom, platform-specific payload.
# Corresponds to the JSON property `payload`
# @return [Hash<String,Object>]
attr_accessor :payload
# The text response message.
# Corresponds to the JSON property `text`
# @return [Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowCxV3beta1ResponseMessageText]
attr_accessor :text
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@conversation_success = args[:conversation_success] if args.key?(:conversation_success)
@human_agent_handoff = args[:human_agent_handoff] if args.key?(:human_agent_handoff)
@payload = args[:payload] if args.key?(:payload)
@text = args[:text] if args.key?(:text)
end
end
# Indicates that the conversation succeeded, i.e., the bot handled the issue
# that the customer talked to it about.
# Dialogflow only uses this to determine which conversations should be
# counted as successful and doesn't process the metadata in this message in
# any way. Note that Dialogflow also considers conversations that get to the
# conversation end page as successful even if they don't return
# ConversationSuccess.
# You may set this, for example:
# * In the entry_fulfillment of a Page if
# entering the page indicates that the conversation succeeded.
# * In a webhook response when you determine that you handled the customer
# issue.
class GoogleCloudDialogflowCxV3beta1ResponseMessageConversationSuccess
include Google::Apis::Core::Hashable
# Custom metadata. Dialogflow doesn't impose any structure on this.
# Corresponds to the JSON property `metadata`
# @return [Hash<String,Object>]
attr_accessor :metadata
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@metadata = args[:metadata] if args.key?(:metadata)
end
end
# Indicates that the conversation should be handed off to a human agent.
# Dialogflow only uses this to determine which conversations were handed off
# to a human agent for measurement purposes. What else to do with this signal
# is up to you and your handoff procedures.
# You may set this, for example:
# * In the entry_fulfillment of a Page if
# entering the page indicates something went extremely wrong in the
# conversation.
# * In a webhook response when you determine that the customer issue can only
# be handled by a human.
class GoogleCloudDialogflowCxV3beta1ResponseMessageHumanAgentHandoff
include Google::Apis::Core::Hashable
# Custom metadata for your handoff procedure. Dialogflow doesn't impose
# any structure on this.
# Corresponds to the JSON property `metadata`
# @return [Hash<String,Object>]
attr_accessor :metadata
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@metadata = args[:metadata] if args.key?(:metadata)
end
end
# The text response message.
class GoogleCloudDialogflowCxV3beta1ResponseMessageText
include Google::Apis::Core::Hashable
# A collection of text responses.
# Corresponds to the JSON property `text`
# @return [Array<String>]
attr_accessor :text
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@text = args[:text] if args.key?(:text)
end
end
# Represents session information communicated to and from the webhook.
class GoogleCloudDialogflowCxV3beta1SessionInfo
include Google::Apis::Core::Hashable
# Optional for WebhookRequest. Optional for WebhookResponse.
# All parameters collected from forms and intents during the session.
# Parameters can be created, updated, or removed by the webhook. To remove a
# parameter from the session, the webhook should explicitly set the parameter
# value to null in WebhookResponse. The map is keyed by parameters'
# display names.
# Corresponds to the JSON property `parameters`
# @return [Hash<String,Object>]
attr_accessor :parameters
# Always present for WebhookRequest. Ignored for WebhookResponse.
# The unique identifier of the session. This
# field can be used by the webhook to identify a user.
# Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
# ID>/sessions/<Session ID>`.
# Corresponds to the JSON property `session`
# @return [String]
attr_accessor :session
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@parameters = args[:parameters] if args.key?(:parameters)
@session = args[:session] if args.key?(:session)
end
end
# The request message for a webhook call.
class GoogleCloudDialogflowCxV3beta1WebhookRequest
include Google::Apis::Core::Hashable
# Always present. The unique identifier of the DetectIntentResponse that
# will be returned to the API caller.
# Corresponds to the JSON property `detectIntentResponseId`
# @return [String]
attr_accessor :detect_intent_response_id
# Represents fulfillment information communicated to the webhook.
# Corresponds to the JSON property `fulfillmentInfo`
# @return [Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowCxV3beta1WebhookRequestFulfillmentInfo]
attr_accessor :fulfillment_info
# Represents intent information communicated to the webhook.
# Corresponds to the JSON property `intentInfo`
# @return [Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowCxV3beta1WebhookRequestIntentInfo]
attr_accessor :intent_info
# The list of rich message responses to present to the user. Webhook can
# choose to append or replace this list in
# WebhookResponse.fulfillment_response;
# Corresponds to the JSON property `messages`
# @return [Array<Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowCxV3beta1ResponseMessage>]
attr_accessor :messages
# Represents page information communicated to and from the webhook.
# Corresponds to the JSON property `pageInfo`
# @return [Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowCxV3beta1PageInfo]
attr_accessor :page_info
# Custom data set in QueryParameters.payload.
# Corresponds to the JSON property `payload`
# @return [Hash<String,Object>]
attr_accessor :payload
# Represents session information communicated to and from the webhook.
# Corresponds to the JSON property `sessionInfo`
# @return [Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowCxV3beta1SessionInfo]
attr_accessor :session_info
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@detect_intent_response_id = args[:detect_intent_response_id] if args.key?(:detect_intent_response_id)
@fulfillment_info = args[:fulfillment_info] if args.key?(:fulfillment_info)
@intent_info = args[:intent_info] if args.key?(:intent_info)
@messages = args[:messages] if args.key?(:messages)
@page_info = args[:page_info] if args.key?(:page_info)
@payload = args[:payload] if args.key?(:payload)
@session_info = args[:session_info] if args.key?(:session_info)
end
end
# Represents fulfillment information communicated to the webhook.
class GoogleCloudDialogflowCxV3beta1WebhookRequestFulfillmentInfo
include Google::Apis::Core::Hashable
# Always present. The tag used to identify which fulfillment is being
# called.
# Corresponds to the JSON property `tag`
# @return [String]
attr_accessor :tag
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@tag = args[:tag] if args.key?(:tag)
end
end
# Represents intent information communicated to the webhook.
class GoogleCloudDialogflowCxV3beta1WebhookRequestIntentInfo
include Google::Apis::Core::Hashable
# Always present. The unique identifier of the last matched
# intent. Format: `projects/<Project ID>/locations/<Location
# ID>/agents/<Agent ID>/intents/<Intent ID>`.
# Corresponds to the JSON property `lastMatchedIntent`
# @return [String]
attr_accessor :last_matched_intent
# Parameters identified as a result of intent matching. This is a map of
# the name of the identified parameter to the value of the parameter
# identified from the user's utterance. All parameters defined in the
# matched intent that are identified will be surfaced here.
# Corresponds to the JSON property `parameters`
# @return [Hash<String,Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowCxV3beta1WebhookRequestIntentInfoIntentParameterValue>]
attr_accessor :parameters
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@last_matched_intent = args[:last_matched_intent] if args.key?(:last_matched_intent)
@parameters = args[:parameters] if args.key?(:parameters)
end
end
# Represents a value for an intent parameter.
class GoogleCloudDialogflowCxV3beta1WebhookRequestIntentInfoIntentParameterValue
include Google::Apis::Core::Hashable
# Always present. Original text value extracted from user utterance.
# Corresponds to the JSON property `originalValue`
# @return [String]
attr_accessor :original_value
# Always present. Structured value for the parameter extracted from user
# utterance.
# Corresponds to the JSON property `resolvedValue`
# @return [Object]
attr_accessor :resolved_value
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@original_value = args[:original_value] if args.key?(:original_value)
@resolved_value = args[:resolved_value] if args.key?(:resolved_value)
end
end
# The response message for a webhook call.
class GoogleCloudDialogflowCxV3beta1WebhookResponse
include Google::Apis::Core::Hashable
# Represents a fulfillment response to the user.
# Corresponds to the JSON property `fulfillmentResponse`
# @return [Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowCxV3beta1WebhookResponseFulfillmentResponse]
attr_accessor :fulfillment_response
# Represents page information communicated to and from the webhook.
# Corresponds to the JSON property `pageInfo`
# @return [Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowCxV3beta1PageInfo]
attr_accessor :page_info
# Value to append directly to QueryResult.webhook_payloads.
# Corresponds to the JSON property `payload`
# @return [Hash<String,Object>]
attr_accessor :payload
# Represents session information communicated to and from the webhook.
# Corresponds to the JSON property `sessionInfo`
# @return [Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowCxV3beta1SessionInfo]
attr_accessor :session_info
# The target flow to transition to.
# Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
# ID>/flows/<Flow ID>`.
# Corresponds to the JSON property `targetFlow`
# @return [String]
attr_accessor :target_flow
# The target page to transition to.
# Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
# ID>/flows/<Flow ID>/pages/<Page ID>`.
# Corresponds to the JSON property `targetPage`
# @return [String]
attr_accessor :target_page
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@fulfillment_response = args[:fulfillment_response] if args.key?(:fulfillment_response)
@page_info = args[:page_info] if args.key?(:page_info)
@payload = args[:payload] if args.key?(:payload)
@session_info = args[:session_info] if args.key?(:session_info)
@target_flow = args[:target_flow] if args.key?(:target_flow)
@target_page = args[:target_page] if args.key?(:target_page)
end
end
# Represents a fulfillment response to the user.
class GoogleCloudDialogflowCxV3beta1WebhookResponseFulfillmentResponse
include Google::Apis::Core::Hashable
# Merge behavior for `messages`.
# Corresponds to the JSON property `mergeBehavior`
# @return [String]
attr_accessor :merge_behavior
# The list of rich message responses to present to the user.
# Corresponds to the JSON property `messages`
# @return [Array<Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowCxV3beta1ResponseMessage>]
attr_accessor :messages
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@merge_behavior = args[:merge_behavior] if args.key?(:merge_behavior)
@messages = args[:messages] if args.key?(:messages)
end
end
# Represents a part of a message possibly annotated with an entity. The part # Represents a part of a message possibly annotated with an entity. The part
# can be an entity or purely a part of the message between two entities or # can be an entity or purely a part of the message between two entities or
# message start/end. # message start/end.
@ -3759,8 +4316,8 @@ module Google
# Rich cards allow you to respond to users with more vivid content, e.g. # Rich cards allow you to respond to users with more vivid content, e.g.
# with media and suggestions. # with media and suggestions.
# For more details about RBM rich cards, please see: # For more details about RBM rich cards, please see:
# https://developers.google.com/rcs-business-messaging/rbm/guides/build/send- # https://developers.google.com/business-communications/rcs-business-messaging/
# messages#rich-cards. # guides/build/messages/send#rich-cards
# If you want to show a single card with more control over the layout, # If you want to show a single card with more control over the layout,
# please use RbmStandaloneCard instead. # please use RbmStandaloneCard instead.
# Corresponds to the JSON property `rbmCarouselRichCard` # Corresponds to the JSON property `rbmCarouselRichCard`
@ -3771,8 +4328,8 @@ module Google
# Rich cards allow you to respond to users with more vivid content, e.g. # Rich cards allow you to respond to users with more vivid content, e.g.
# with media and suggestions. # with media and suggestions.
# For more details about RBM rich cards, please see: # For more details about RBM rich cards, please see:
# https://developers.google.com/rcs-business-messaging/rbm/guides/build/send- # https://developers.google.com/business-communications/rcs-business-messaging/
# messages#rich-cards. # guides/build/messages/send#rich-cards
# You can group multiple rich cards into one using RbmCarouselCard but # You can group multiple rich cards into one using RbmCarouselCard but
# carousel cards will give you less control over the card layout. # carousel cards will give you less control over the card layout.
# Corresponds to the JSON property `rbmStandaloneRichCard` # Corresponds to the JSON property `rbmStandaloneRichCard`
@ -4512,8 +5069,8 @@ module Google
# Rich cards allow you to respond to users with more vivid content, e.g. # Rich cards allow you to respond to users with more vivid content, e.g.
# with media and suggestions. # with media and suggestions.
# For more details about RBM rich cards, please see: # For more details about RBM rich cards, please see:
# https://developers.google.com/rcs-business-messaging/rbm/guides/build/send- # https://developers.google.com/business-communications/rcs-business-messaging/
# messages#rich-cards. # guides/build/messages/send#rich-cards
# If you want to show a single card with more control over the layout, # If you want to show a single card with more control over the layout,
# please use RbmStandaloneCard instead. # please use RbmStandaloneCard instead.
class GoogleCloudDialogflowV2beta1IntentMessageRbmCarouselCard class GoogleCloudDialogflowV2beta1IntentMessageRbmCarouselCard
@ -4545,8 +5102,8 @@ module Google
# Rich cards allow you to respond to users with more vivid content, e.g. # Rich cards allow you to respond to users with more vivid content, e.g.
# with media and suggestions. # with media and suggestions.
# For more details about RBM rich cards, please see: # For more details about RBM rich cards, please see:
# https://developers.google.com/rcs-business-messaging/rbm/guides/build/send- # https://developers.google.com/business-communications/rcs-business-messaging/
# messages#rich-cards. # guides/build/messages/send#rich-cards
# You can group multiple rich cards into one using RbmCarouselCard but # You can group multiple rich cards into one using RbmCarouselCard but
# carousel cards will give you less control over the card layout. # carousel cards will give you less control over the card layout.
class GoogleCloudDialogflowV2beta1IntentMessageRbmStandaloneCard class GoogleCloudDialogflowV2beta1IntentMessageRbmStandaloneCard

View File

@ -22,6 +22,96 @@ module Google
module Apis module Apis
module DialogflowV2beta1 module DialogflowV2beta1
class GoogleCloudDialogflowCxV3beta1ExportAgentResponse
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class GoogleCloudDialogflowCxV3beta1PageInfo
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class GoogleCloudDialogflowCxV3beta1PageInfoFormInfo
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class GoogleCloudDialogflowCxV3beta1PageInfoFormInfoParameterInfo
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class GoogleCloudDialogflowCxV3beta1ResponseMessage
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class GoogleCloudDialogflowCxV3beta1ResponseMessageConversationSuccess
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class GoogleCloudDialogflowCxV3beta1ResponseMessageHumanAgentHandoff
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class GoogleCloudDialogflowCxV3beta1ResponseMessageText
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class GoogleCloudDialogflowCxV3beta1SessionInfo
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class GoogleCloudDialogflowCxV3beta1WebhookRequest
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class GoogleCloudDialogflowCxV3beta1WebhookRequestFulfillmentInfo
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class GoogleCloudDialogflowCxV3beta1WebhookRequestIntentInfo
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class GoogleCloudDialogflowCxV3beta1WebhookRequestIntentInfoIntentParameterValue
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class GoogleCloudDialogflowCxV3beta1WebhookResponse
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class GoogleCloudDialogflowCxV3beta1WebhookResponseFulfillmentResponse
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class GoogleCloudDialogflowV2AnnotatedMessagePart class GoogleCloudDialogflowV2AnnotatedMessagePart
class Representation < Google::Apis::Core::JsonRepresentation; end class Representation < Google::Apis::Core::JsonRepresentation; end
@ -1030,6 +1120,154 @@ module Google
include Google::Apis::Core::JsonObjectSupport include Google::Apis::Core::JsonObjectSupport
end end
class GoogleCloudDialogflowCxV3beta1ExportAgentResponse
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :agent_content, :base64 => true, as: 'agentContent'
property :agent_uri, as: 'agentUri'
end
end
class GoogleCloudDialogflowCxV3beta1PageInfo
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :current_page, as: 'currentPage'
property :form_info, as: 'formInfo', class: Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowCxV3beta1PageInfoFormInfo, decorator: Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowCxV3beta1PageInfoFormInfo::Representation
property :next_page, as: 'nextPage'
end
end
class GoogleCloudDialogflowCxV3beta1PageInfoFormInfo
# @private
class Representation < Google::Apis::Core::JsonRepresentation
collection :parameter_info, as: 'parameterInfo', class: Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowCxV3beta1PageInfoFormInfoParameterInfo, decorator: Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowCxV3beta1PageInfoFormInfoParameterInfo::Representation
property :state, as: 'state'
end
end
class GoogleCloudDialogflowCxV3beta1PageInfoFormInfoParameterInfo
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :display_name, as: 'displayName'
property :just_collected, as: 'justCollected'
collection :prompt, as: 'prompt', class: Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowCxV3beta1ResponseMessage, decorator: Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowCxV3beta1ResponseMessage::Representation
property :required, as: 'required'
property :state, as: 'state'
property :value, as: 'value'
end
end
class GoogleCloudDialogflowCxV3beta1ResponseMessage
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :conversation_success, as: 'conversationSuccess', class: Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowCxV3beta1ResponseMessageConversationSuccess, decorator: Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowCxV3beta1ResponseMessageConversationSuccess::Representation
property :human_agent_handoff, as: 'humanAgentHandoff', class: Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowCxV3beta1ResponseMessageHumanAgentHandoff, decorator: Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowCxV3beta1ResponseMessageHumanAgentHandoff::Representation
hash :payload, as: 'payload'
property :text, as: 'text', class: Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowCxV3beta1ResponseMessageText, decorator: Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowCxV3beta1ResponseMessageText::Representation
end
end
class GoogleCloudDialogflowCxV3beta1ResponseMessageConversationSuccess
# @private
class Representation < Google::Apis::Core::JsonRepresentation
hash :metadata, as: 'metadata'
end
end
class GoogleCloudDialogflowCxV3beta1ResponseMessageHumanAgentHandoff
# @private
class Representation < Google::Apis::Core::JsonRepresentation
hash :metadata, as: 'metadata'
end
end
class GoogleCloudDialogflowCxV3beta1ResponseMessageText
# @private
class Representation < Google::Apis::Core::JsonRepresentation
collection :text, as: 'text'
end
end
class GoogleCloudDialogflowCxV3beta1SessionInfo
# @private
class Representation < Google::Apis::Core::JsonRepresentation
hash :parameters, as: 'parameters'
property :session, as: 'session'
end
end
class GoogleCloudDialogflowCxV3beta1WebhookRequest
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :detect_intent_response_id, as: 'detectIntentResponseId'
property :fulfillment_info, as: 'fulfillmentInfo', class: Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowCxV3beta1WebhookRequestFulfillmentInfo, decorator: Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowCxV3beta1WebhookRequestFulfillmentInfo::Representation
property :intent_info, as: 'intentInfo', class: Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowCxV3beta1WebhookRequestIntentInfo, decorator: Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowCxV3beta1WebhookRequestIntentInfo::Representation
collection :messages, as: 'messages', class: Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowCxV3beta1ResponseMessage, decorator: Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowCxV3beta1ResponseMessage::Representation
property :page_info, as: 'pageInfo', class: Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowCxV3beta1PageInfo, decorator: Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowCxV3beta1PageInfo::Representation
hash :payload, as: 'payload'
property :session_info, as: 'sessionInfo', class: Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowCxV3beta1SessionInfo, decorator: Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowCxV3beta1SessionInfo::Representation
end
end
class GoogleCloudDialogflowCxV3beta1WebhookRequestFulfillmentInfo
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :tag, as: 'tag'
end
end
class GoogleCloudDialogflowCxV3beta1WebhookRequestIntentInfo
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :last_matched_intent, as: 'lastMatchedIntent'
hash :parameters, as: 'parameters', class: Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowCxV3beta1WebhookRequestIntentInfoIntentParameterValue, decorator: Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowCxV3beta1WebhookRequestIntentInfoIntentParameterValue::Representation
end
end
class GoogleCloudDialogflowCxV3beta1WebhookRequestIntentInfoIntentParameterValue
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :original_value, as: 'originalValue'
property :resolved_value, as: 'resolvedValue'
end
end
class GoogleCloudDialogflowCxV3beta1WebhookResponse
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :fulfillment_response, as: 'fulfillmentResponse', class: Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowCxV3beta1WebhookResponseFulfillmentResponse, decorator: Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowCxV3beta1WebhookResponseFulfillmentResponse::Representation
property :page_info, as: 'pageInfo', class: Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowCxV3beta1PageInfo, decorator: Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowCxV3beta1PageInfo::Representation
hash :payload, as: 'payload'
property :session_info, as: 'sessionInfo', class: Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowCxV3beta1SessionInfo, decorator: Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowCxV3beta1SessionInfo::Representation
property :target_flow, as: 'targetFlow'
property :target_page, as: 'targetPage'
end
end
class GoogleCloudDialogflowCxV3beta1WebhookResponseFulfillmentResponse
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :merge_behavior, as: 'mergeBehavior'
collection :messages, as: 'messages', class: Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowCxV3beta1ResponseMessage, decorator: Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowCxV3beta1ResponseMessage::Representation
end
end
class GoogleCloudDialogflowV2AnnotatedMessagePart class GoogleCloudDialogflowV2AnnotatedMessagePart
# @private # @private
class Representation < Google::Apis::Core::JsonRepresentation class Representation < Google::Apis::Core::JsonRepresentation

View File

@ -3237,6 +3237,50 @@ module Google
execute_or_queue_command(command, &block) execute_or_queue_command(command, &block)
end end
# Returns the list of agents.
# Since there is at most one conversational agent per project, this method is
# useful primarily for listing all agents across projects the caller has
# access to. One can achieve that with a wildcard project collection id "-".
# Refer to [List
# Sub-Collections](https://cloud.google.com/apis/design/design_patterns#list_sub-
# collections).
# @param [String] parent
# Required. The project to list agents from.
# Format: `projects/<Project ID or '-'>`.
# @param [Fixnum] page_size
# Optional. The maximum number of items to return in a single page. By
# default 100 and at most 1000.
# @param [String] page_token
# Optional. The next_page_token value returned from a previous list request.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1SearchAgentsResponse] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1SearchAgentsResponse]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def search_project_location_agents(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'v2beta1/{+parent}/agent:search', options)
command.response_representation = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1SearchAgentsResponse::Representation
command.response_class = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1SearchAgentsResponse
command.params['parent'] = parent unless parent.nil?
command.query['pageSize'] = page_size unless page_size.nil?
command.query['pageToken'] = page_token unless page_token.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Trains the specified agent. # Trains the specified agent.
# Operation <response: google.protobuf.Empty> # Operation <response: google.protobuf.Empty>
# @param [String] parent # @param [String] parent

View File

@ -26,7 +26,7 @@ module Google
# @see https://cloud.google.com/dialogflow/ # @see https://cloud.google.com/dialogflow/
module DialogflowV3alpha1 module DialogflowV3alpha1
VERSION = 'V3alpha1' VERSION = 'V3alpha1'
REVISION = '20200518' REVISION = '20200526'
# View and manage your data across Google Cloud Platform services # View and manage your data across Google Cloud Platform services
AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform'

View File

@ -22,6 +22,563 @@ module Google
module Apis module Apis
module DialogflowV3alpha1 module DialogflowV3alpha1
# The response message for Agents.ExportAgent.
class GoogleCloudDialogflowCxV3beta1ExportAgentResponse
include Google::Apis::Core::Hashable
# Uncompressed raw byte content for agent.
# Corresponds to the JSON property `agentContent`
# NOTE: Values are automatically base64 encoded/decoded in the client library.
# @return [String]
attr_accessor :agent_content
# The URI to a file containing the exported agent. This field is populated
# only if `agent_uri` is specified in ExportAgentRequest.
# Corresponds to the JSON property `agentUri`
# @return [String]
attr_accessor :agent_uri
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@agent_content = args[:agent_content] if args.key?(:agent_content)
@agent_uri = args[:agent_uri] if args.key?(:agent_uri)
end
end
# Represents page information communicated to and from the webhook.
class GoogleCloudDialogflowCxV3beta1PageInfo
include Google::Apis::Core::Hashable
# Always present for WebhookRequest. Ignored for WebhookResponse.
# The unique identifier of the current page.
# Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
# ID>/flows/<Flow ID>/pages/<Page ID>`.
# Corresponds to the JSON property `currentPage`
# @return [String]
attr_accessor :current_page
# Represents form information.
# Corresponds to the JSON property `formInfo`
# @return [Google::Apis::DialogflowV3alpha1::GoogleCloudDialogflowCxV3beta1PageInfoFormInfo]
attr_accessor :form_info
# Deprecated. Please use WebhookResponse.target_page or
# WebhookResponse.target_flow instead.
# Optional for WebhookResponse.
# The unique identifier of the next page. This field can be set by the
# webhook to immediately transition to a page different from `current_page`.
# Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
# ID>/flows/<Flow ID>/pages/<Page ID>`.
# Corresponds to the JSON property `nextPage`
# @return [String]
attr_accessor :next_page
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@current_page = args[:current_page] if args.key?(:current_page)
@form_info = args[:form_info] if args.key?(:form_info)
@next_page = args[:next_page] if args.key?(:next_page)
end
end
# Represents form information.
class GoogleCloudDialogflowCxV3beta1PageInfoFormInfo
include Google::Apis::Core::Hashable
# Optional for both WebhookRequest and WebhookResponse.
# The parameters contained in the form. Note that the webhook cannot add
# or remove any form parameter.
# Corresponds to the JSON property `parameterInfo`
# @return [Array<Google::Apis::DialogflowV3alpha1::GoogleCloudDialogflowCxV3beta1PageInfoFormInfoParameterInfo>]
attr_accessor :parameter_info
# Always present for WebhookRequest. Ignored for WebhookResponse.
# The current state of the form.
# 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)
@parameter_info = args[:parameter_info] if args.key?(:parameter_info)
@state = args[:state] if args.key?(:state)
end
end
# Represents parameter information.
class GoogleCloudDialogflowCxV3beta1PageInfoFormInfoParameterInfo
include Google::Apis::Core::Hashable
# Always present for WebhookRequest. Required for
# WebhookResponse.
# The human-readable name of the parameter, unique within the form. This
# field cannot be modified by the webhook.
# Corresponds to the JSON property `displayName`
# @return [String]
attr_accessor :display_name
# Optional for WebhookRequest. Ignored for WebhookResponse.
# Indicates if the parameter value was just collected on the last
# conversation turn.
# Corresponds to the JSON property `justCollected`
# @return [Boolean]
attr_accessor :just_collected
alias_method :just_collected?, :just_collected
# Not set for WebhookRequest. Optional for WebhookResponse.
# The prompt to send to the user to fill a required form parameter. This
# field can be set by the webhook. If set, this field overrides the
# prompt defined for the form parameter.
# Corresponds to the JSON property `prompt`
# @return [Array<Google::Apis::DialogflowV3alpha1::GoogleCloudDialogflowCxV3beta1ResponseMessage>]
attr_accessor :prompt
# Optional for both WebhookRequest and WebhookResponse.
# Indicates whether the parameter is required. Optional parameters will
# not trigger prompts; however, they are filled if the user specifies
# them. Required parameters must be filled before form filling concludes.
# Corresponds to the JSON property `required`
# @return [Boolean]
attr_accessor :required
alias_method :required?, :required
# Always present for WebhookRequest. Required for
# WebhookResponse. The state of the parameter. This field can be set
# to INVALID by
# the webhook to invalidate the parameter; other values set by the
# webhook will be ignored.
# Corresponds to the JSON property `state`
# @return [String]
attr_accessor :state
# Optional for both WebhookRequest and WebhookResponse.
# The value of the parameter. This field can be set by the webhook to
# change the parameter value.
# Corresponds to the JSON property `value`
# @return [Object]
attr_accessor :value
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@display_name = args[:display_name] if args.key?(:display_name)
@just_collected = args[:just_collected] if args.key?(:just_collected)
@prompt = args[:prompt] if args.key?(:prompt)
@required = args[:required] if args.key?(:required)
@state = args[:state] if args.key?(:state)
@value = args[:value] if args.key?(:value)
end
end
# Represents a response message that can be returned by a conversational agent.
# Response messages are also used for output audio synthesis. The approach is
# as follows:
# * If at least one OutputAudioText response is present, then all
# OutputAudioText responses are linearly concatenated, and the result is used
# for output audio synthesis.
# * If the OutputAudioText responses are a mixture of text and SSML, then the
# concatenated result is treated as SSML; otherwise, the result is treated as
# either text or SSML as appropriate. The agent designer should ideally use
# either text or SSML consistently throughout the bot design.
# * Otherwise, all Text responses are linearly concatenated, and the result is
# used for output audio synthesis.
# This approach allows for more sophisticated user experience scenarios, where
# the text displayed to the user may differ from what is heard.
class GoogleCloudDialogflowCxV3beta1ResponseMessage
include Google::Apis::Core::Hashable
# Indicates that the conversation succeeded, i.e., the bot handled the issue
# that the customer talked to it about.
# Dialogflow only uses this to determine which conversations should be
# counted as successful and doesn't process the metadata in this message in
# any way. Note that Dialogflow also considers conversations that get to the
# conversation end page as successful even if they don't return
# ConversationSuccess.
# You may set this, for example:
# * In the entry_fulfillment of a Page if
# entering the page indicates that the conversation succeeded.
# * In a webhook response when you determine that you handled the customer
# issue.
# Corresponds to the JSON property `conversationSuccess`
# @return [Google::Apis::DialogflowV3alpha1::GoogleCloudDialogflowCxV3beta1ResponseMessageConversationSuccess]
attr_accessor :conversation_success
# Indicates that the conversation should be handed off to a human agent.
# Dialogflow only uses this to determine which conversations were handed off
# to a human agent for measurement purposes. What else to do with this signal
# is up to you and your handoff procedures.
# You may set this, for example:
# * In the entry_fulfillment of a Page if
# entering the page indicates something went extremely wrong in the
# conversation.
# * In a webhook response when you determine that the customer issue can only
# be handled by a human.
# Corresponds to the JSON property `humanAgentHandoff`
# @return [Google::Apis::DialogflowV3alpha1::GoogleCloudDialogflowCxV3beta1ResponseMessageHumanAgentHandoff]
attr_accessor :human_agent_handoff
# Returns a response containing a custom, platform-specific payload.
# Corresponds to the JSON property `payload`
# @return [Hash<String,Object>]
attr_accessor :payload
# The text response message.
# Corresponds to the JSON property `text`
# @return [Google::Apis::DialogflowV3alpha1::GoogleCloudDialogflowCxV3beta1ResponseMessageText]
attr_accessor :text
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@conversation_success = args[:conversation_success] if args.key?(:conversation_success)
@human_agent_handoff = args[:human_agent_handoff] if args.key?(:human_agent_handoff)
@payload = args[:payload] if args.key?(:payload)
@text = args[:text] if args.key?(:text)
end
end
# Indicates that the conversation succeeded, i.e., the bot handled the issue
# that the customer talked to it about.
# Dialogflow only uses this to determine which conversations should be
# counted as successful and doesn't process the metadata in this message in
# any way. Note that Dialogflow also considers conversations that get to the
# conversation end page as successful even if they don't return
# ConversationSuccess.
# You may set this, for example:
# * In the entry_fulfillment of a Page if
# entering the page indicates that the conversation succeeded.
# * In a webhook response when you determine that you handled the customer
# issue.
class GoogleCloudDialogflowCxV3beta1ResponseMessageConversationSuccess
include Google::Apis::Core::Hashable
# Custom metadata. Dialogflow doesn't impose any structure on this.
# Corresponds to the JSON property `metadata`
# @return [Hash<String,Object>]
attr_accessor :metadata
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@metadata = args[:metadata] if args.key?(:metadata)
end
end
# Indicates that the conversation should be handed off to a human agent.
# Dialogflow only uses this to determine which conversations were handed off
# to a human agent for measurement purposes. What else to do with this signal
# is up to you and your handoff procedures.
# You may set this, for example:
# * In the entry_fulfillment of a Page if
# entering the page indicates something went extremely wrong in the
# conversation.
# * In a webhook response when you determine that the customer issue can only
# be handled by a human.
class GoogleCloudDialogflowCxV3beta1ResponseMessageHumanAgentHandoff
include Google::Apis::Core::Hashable
# Custom metadata for your handoff procedure. Dialogflow doesn't impose
# any structure on this.
# Corresponds to the JSON property `metadata`
# @return [Hash<String,Object>]
attr_accessor :metadata
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@metadata = args[:metadata] if args.key?(:metadata)
end
end
# The text response message.
class GoogleCloudDialogflowCxV3beta1ResponseMessageText
include Google::Apis::Core::Hashable
# A collection of text responses.
# Corresponds to the JSON property `text`
# @return [Array<String>]
attr_accessor :text
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@text = args[:text] if args.key?(:text)
end
end
# Represents session information communicated to and from the webhook.
class GoogleCloudDialogflowCxV3beta1SessionInfo
include Google::Apis::Core::Hashable
# Optional for WebhookRequest. Optional for WebhookResponse.
# All parameters collected from forms and intents during the session.
# Parameters can be created, updated, or removed by the webhook. To remove a
# parameter from the session, the webhook should explicitly set the parameter
# value to null in WebhookResponse. The map is keyed by parameters'
# display names.
# Corresponds to the JSON property `parameters`
# @return [Hash<String,Object>]
attr_accessor :parameters
# Always present for WebhookRequest. Ignored for WebhookResponse.
# The unique identifier of the session. This
# field can be used by the webhook to identify a user.
# Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
# ID>/sessions/<Session ID>`.
# Corresponds to the JSON property `session`
# @return [String]
attr_accessor :session
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@parameters = args[:parameters] if args.key?(:parameters)
@session = args[:session] if args.key?(:session)
end
end
# The request message for a webhook call.
class GoogleCloudDialogflowCxV3beta1WebhookRequest
include Google::Apis::Core::Hashable
# Always present. The unique identifier of the DetectIntentResponse that
# will be returned to the API caller.
# Corresponds to the JSON property `detectIntentResponseId`
# @return [String]
attr_accessor :detect_intent_response_id
# Represents fulfillment information communicated to the webhook.
# Corresponds to the JSON property `fulfillmentInfo`
# @return [Google::Apis::DialogflowV3alpha1::GoogleCloudDialogflowCxV3beta1WebhookRequestFulfillmentInfo]
attr_accessor :fulfillment_info
# Represents intent information communicated to the webhook.
# Corresponds to the JSON property `intentInfo`
# @return [Google::Apis::DialogflowV3alpha1::GoogleCloudDialogflowCxV3beta1WebhookRequestIntentInfo]
attr_accessor :intent_info
# The list of rich message responses to present to the user. Webhook can
# choose to append or replace this list in
# WebhookResponse.fulfillment_response;
# Corresponds to the JSON property `messages`
# @return [Array<Google::Apis::DialogflowV3alpha1::GoogleCloudDialogflowCxV3beta1ResponseMessage>]
attr_accessor :messages
# Represents page information communicated to and from the webhook.
# Corresponds to the JSON property `pageInfo`
# @return [Google::Apis::DialogflowV3alpha1::GoogleCloudDialogflowCxV3beta1PageInfo]
attr_accessor :page_info
# Custom data set in QueryParameters.payload.
# Corresponds to the JSON property `payload`
# @return [Hash<String,Object>]
attr_accessor :payload
# Represents session information communicated to and from the webhook.
# Corresponds to the JSON property `sessionInfo`
# @return [Google::Apis::DialogflowV3alpha1::GoogleCloudDialogflowCxV3beta1SessionInfo]
attr_accessor :session_info
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@detect_intent_response_id = args[:detect_intent_response_id] if args.key?(:detect_intent_response_id)
@fulfillment_info = args[:fulfillment_info] if args.key?(:fulfillment_info)
@intent_info = args[:intent_info] if args.key?(:intent_info)
@messages = args[:messages] if args.key?(:messages)
@page_info = args[:page_info] if args.key?(:page_info)
@payload = args[:payload] if args.key?(:payload)
@session_info = args[:session_info] if args.key?(:session_info)
end
end
# Represents fulfillment information communicated to the webhook.
class GoogleCloudDialogflowCxV3beta1WebhookRequestFulfillmentInfo
include Google::Apis::Core::Hashable
# Always present. The tag used to identify which fulfillment is being
# called.
# Corresponds to the JSON property `tag`
# @return [String]
attr_accessor :tag
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@tag = args[:tag] if args.key?(:tag)
end
end
# Represents intent information communicated to the webhook.
class GoogleCloudDialogflowCxV3beta1WebhookRequestIntentInfo
include Google::Apis::Core::Hashable
# Always present. The unique identifier of the last matched
# intent. Format: `projects/<Project ID>/locations/<Location
# ID>/agents/<Agent ID>/intents/<Intent ID>`.
# Corresponds to the JSON property `lastMatchedIntent`
# @return [String]
attr_accessor :last_matched_intent
# Parameters identified as a result of intent matching. This is a map of
# the name of the identified parameter to the value of the parameter
# identified from the user's utterance. All parameters defined in the
# matched intent that are identified will be surfaced here.
# Corresponds to the JSON property `parameters`
# @return [Hash<String,Google::Apis::DialogflowV3alpha1::GoogleCloudDialogflowCxV3beta1WebhookRequestIntentInfoIntentParameterValue>]
attr_accessor :parameters
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@last_matched_intent = args[:last_matched_intent] if args.key?(:last_matched_intent)
@parameters = args[:parameters] if args.key?(:parameters)
end
end
# Represents a value for an intent parameter.
class GoogleCloudDialogflowCxV3beta1WebhookRequestIntentInfoIntentParameterValue
include Google::Apis::Core::Hashable
# Always present. Original text value extracted from user utterance.
# Corresponds to the JSON property `originalValue`
# @return [String]
attr_accessor :original_value
# Always present. Structured value for the parameter extracted from user
# utterance.
# Corresponds to the JSON property `resolvedValue`
# @return [Object]
attr_accessor :resolved_value
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@original_value = args[:original_value] if args.key?(:original_value)
@resolved_value = args[:resolved_value] if args.key?(:resolved_value)
end
end
# The response message for a webhook call.
class GoogleCloudDialogflowCxV3beta1WebhookResponse
include Google::Apis::Core::Hashable
# Represents a fulfillment response to the user.
# Corresponds to the JSON property `fulfillmentResponse`
# @return [Google::Apis::DialogflowV3alpha1::GoogleCloudDialogflowCxV3beta1WebhookResponseFulfillmentResponse]
attr_accessor :fulfillment_response
# Represents page information communicated to and from the webhook.
# Corresponds to the JSON property `pageInfo`
# @return [Google::Apis::DialogflowV3alpha1::GoogleCloudDialogflowCxV3beta1PageInfo]
attr_accessor :page_info
# Value to append directly to QueryResult.webhook_payloads.
# Corresponds to the JSON property `payload`
# @return [Hash<String,Object>]
attr_accessor :payload
# Represents session information communicated to and from the webhook.
# Corresponds to the JSON property `sessionInfo`
# @return [Google::Apis::DialogflowV3alpha1::GoogleCloudDialogflowCxV3beta1SessionInfo]
attr_accessor :session_info
# The target flow to transition to.
# Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
# ID>/flows/<Flow ID>`.
# Corresponds to the JSON property `targetFlow`
# @return [String]
attr_accessor :target_flow
# The target page to transition to.
# Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
# ID>/flows/<Flow ID>/pages/<Page ID>`.
# Corresponds to the JSON property `targetPage`
# @return [String]
attr_accessor :target_page
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@fulfillment_response = args[:fulfillment_response] if args.key?(:fulfillment_response)
@page_info = args[:page_info] if args.key?(:page_info)
@payload = args[:payload] if args.key?(:payload)
@session_info = args[:session_info] if args.key?(:session_info)
@target_flow = args[:target_flow] if args.key?(:target_flow)
@target_page = args[:target_page] if args.key?(:target_page)
end
end
# Represents a fulfillment response to the user.
class GoogleCloudDialogflowCxV3beta1WebhookResponseFulfillmentResponse
include Google::Apis::Core::Hashable
# Merge behavior for `messages`.
# Corresponds to the JSON property `mergeBehavior`
# @return [String]
attr_accessor :merge_behavior
# The list of rich message responses to present to the user.
# Corresponds to the JSON property `messages`
# @return [Array<Google::Apis::DialogflowV3alpha1::GoogleCloudDialogflowCxV3beta1ResponseMessage>]
attr_accessor :messages
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@merge_behavior = args[:merge_behavior] if args.key?(:merge_behavior)
@messages = args[:messages] if args.key?(:messages)
end
end
# Represents a part of a message possibly annotated with an entity. The part # Represents a part of a message possibly annotated with an entity. The part
# can be an entity or purely a part of the message between two entities or # can be an entity or purely a part of the message between two entities or
# message start/end. # message start/end.
@ -2766,8 +3323,8 @@ module Google
# Rich cards allow you to respond to users with more vivid content, e.g. # Rich cards allow you to respond to users with more vivid content, e.g.
# with media and suggestions. # with media and suggestions.
# For more details about RBM rich cards, please see: # For more details about RBM rich cards, please see:
# https://developers.google.com/rcs-business-messaging/rbm/guides/build/send- # https://developers.google.com/business-communications/rcs-business-messaging/
# messages#rich-cards. # guides/build/messages/send#rich-cards
# If you want to show a single card with more control over the layout, # If you want to show a single card with more control over the layout,
# please use RbmStandaloneCard instead. # please use RbmStandaloneCard instead.
# Corresponds to the JSON property `rbmCarouselRichCard` # Corresponds to the JSON property `rbmCarouselRichCard`
@ -2778,8 +3335,8 @@ module Google
# Rich cards allow you to respond to users with more vivid content, e.g. # Rich cards allow you to respond to users with more vivid content, e.g.
# with media and suggestions. # with media and suggestions.
# For more details about RBM rich cards, please see: # For more details about RBM rich cards, please see:
# https://developers.google.com/rcs-business-messaging/rbm/guides/build/send- # https://developers.google.com/business-communications/rcs-business-messaging/
# messages#rich-cards. # guides/build/messages/send#rich-cards
# You can group multiple rich cards into one using RbmCarouselCard but # You can group multiple rich cards into one using RbmCarouselCard but
# carousel cards will give you less control over the card layout. # carousel cards will give you less control over the card layout.
# Corresponds to the JSON property `rbmStandaloneRichCard` # Corresponds to the JSON property `rbmStandaloneRichCard`
@ -3519,8 +4076,8 @@ module Google
# Rich cards allow you to respond to users with more vivid content, e.g. # Rich cards allow you to respond to users with more vivid content, e.g.
# with media and suggestions. # with media and suggestions.
# For more details about RBM rich cards, please see: # For more details about RBM rich cards, please see:
# https://developers.google.com/rcs-business-messaging/rbm/guides/build/send- # https://developers.google.com/business-communications/rcs-business-messaging/
# messages#rich-cards. # guides/build/messages/send#rich-cards
# If you want to show a single card with more control over the layout, # If you want to show a single card with more control over the layout,
# please use RbmStandaloneCard instead. # please use RbmStandaloneCard instead.
class GoogleCloudDialogflowV2beta1IntentMessageRbmCarouselCard class GoogleCloudDialogflowV2beta1IntentMessageRbmCarouselCard
@ -3552,8 +4109,8 @@ module Google
# Rich cards allow you to respond to users with more vivid content, e.g. # Rich cards allow you to respond to users with more vivid content, e.g.
# with media and suggestions. # with media and suggestions.
# For more details about RBM rich cards, please see: # For more details about RBM rich cards, please see:
# https://developers.google.com/rcs-business-messaging/rbm/guides/build/send- # https://developers.google.com/business-communications/rcs-business-messaging/
# messages#rich-cards. # guides/build/messages/send#rich-cards
# You can group multiple rich cards into one using RbmCarouselCard but # You can group multiple rich cards into one using RbmCarouselCard but
# carousel cards will give you less control over the card layout. # carousel cards will give you less control over the card layout.
class GoogleCloudDialogflowV2beta1IntentMessageRbmStandaloneCard class GoogleCloudDialogflowV2beta1IntentMessageRbmStandaloneCard

View File

@ -22,6 +22,96 @@ module Google
module Apis module Apis
module DialogflowV3alpha1 module DialogflowV3alpha1
class GoogleCloudDialogflowCxV3beta1ExportAgentResponse
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class GoogleCloudDialogflowCxV3beta1PageInfo
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class GoogleCloudDialogflowCxV3beta1PageInfoFormInfo
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class GoogleCloudDialogflowCxV3beta1PageInfoFormInfoParameterInfo
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class GoogleCloudDialogflowCxV3beta1ResponseMessage
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class GoogleCloudDialogflowCxV3beta1ResponseMessageConversationSuccess
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class GoogleCloudDialogflowCxV3beta1ResponseMessageHumanAgentHandoff
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class GoogleCloudDialogflowCxV3beta1ResponseMessageText
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class GoogleCloudDialogflowCxV3beta1SessionInfo
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class GoogleCloudDialogflowCxV3beta1WebhookRequest
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class GoogleCloudDialogflowCxV3beta1WebhookRequestFulfillmentInfo
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class GoogleCloudDialogflowCxV3beta1WebhookRequestIntentInfo
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class GoogleCloudDialogflowCxV3beta1WebhookRequestIntentInfoIntentParameterValue
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class GoogleCloudDialogflowCxV3beta1WebhookResponse
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class GoogleCloudDialogflowCxV3beta1WebhookResponseFulfillmentResponse
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class GoogleCloudDialogflowV2AnnotatedMessagePart class GoogleCloudDialogflowV2AnnotatedMessagePart
class Representation < Google::Apis::Core::JsonRepresentation; end class Representation < Google::Apis::Core::JsonRepresentation; end
@ -754,6 +844,154 @@ module Google
include Google::Apis::Core::JsonObjectSupport include Google::Apis::Core::JsonObjectSupport
end end
class GoogleCloudDialogflowCxV3beta1ExportAgentResponse
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :agent_content, :base64 => true, as: 'agentContent'
property :agent_uri, as: 'agentUri'
end
end
class GoogleCloudDialogflowCxV3beta1PageInfo
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :current_page, as: 'currentPage'
property :form_info, as: 'formInfo', class: Google::Apis::DialogflowV3alpha1::GoogleCloudDialogflowCxV3beta1PageInfoFormInfo, decorator: Google::Apis::DialogflowV3alpha1::GoogleCloudDialogflowCxV3beta1PageInfoFormInfo::Representation
property :next_page, as: 'nextPage'
end
end
class GoogleCloudDialogflowCxV3beta1PageInfoFormInfo
# @private
class Representation < Google::Apis::Core::JsonRepresentation
collection :parameter_info, as: 'parameterInfo', class: Google::Apis::DialogflowV3alpha1::GoogleCloudDialogflowCxV3beta1PageInfoFormInfoParameterInfo, decorator: Google::Apis::DialogflowV3alpha1::GoogleCloudDialogflowCxV3beta1PageInfoFormInfoParameterInfo::Representation
property :state, as: 'state'
end
end
class GoogleCloudDialogflowCxV3beta1PageInfoFormInfoParameterInfo
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :display_name, as: 'displayName'
property :just_collected, as: 'justCollected'
collection :prompt, as: 'prompt', class: Google::Apis::DialogflowV3alpha1::GoogleCloudDialogflowCxV3beta1ResponseMessage, decorator: Google::Apis::DialogflowV3alpha1::GoogleCloudDialogflowCxV3beta1ResponseMessage::Representation
property :required, as: 'required'
property :state, as: 'state'
property :value, as: 'value'
end
end
class GoogleCloudDialogflowCxV3beta1ResponseMessage
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :conversation_success, as: 'conversationSuccess', class: Google::Apis::DialogflowV3alpha1::GoogleCloudDialogflowCxV3beta1ResponseMessageConversationSuccess, decorator: Google::Apis::DialogflowV3alpha1::GoogleCloudDialogflowCxV3beta1ResponseMessageConversationSuccess::Representation
property :human_agent_handoff, as: 'humanAgentHandoff', class: Google::Apis::DialogflowV3alpha1::GoogleCloudDialogflowCxV3beta1ResponseMessageHumanAgentHandoff, decorator: Google::Apis::DialogflowV3alpha1::GoogleCloudDialogflowCxV3beta1ResponseMessageHumanAgentHandoff::Representation
hash :payload, as: 'payload'
property :text, as: 'text', class: Google::Apis::DialogflowV3alpha1::GoogleCloudDialogflowCxV3beta1ResponseMessageText, decorator: Google::Apis::DialogflowV3alpha1::GoogleCloudDialogflowCxV3beta1ResponseMessageText::Representation
end
end
class GoogleCloudDialogflowCxV3beta1ResponseMessageConversationSuccess
# @private
class Representation < Google::Apis::Core::JsonRepresentation
hash :metadata, as: 'metadata'
end
end
class GoogleCloudDialogflowCxV3beta1ResponseMessageHumanAgentHandoff
# @private
class Representation < Google::Apis::Core::JsonRepresentation
hash :metadata, as: 'metadata'
end
end
class GoogleCloudDialogflowCxV3beta1ResponseMessageText
# @private
class Representation < Google::Apis::Core::JsonRepresentation
collection :text, as: 'text'
end
end
class GoogleCloudDialogflowCxV3beta1SessionInfo
# @private
class Representation < Google::Apis::Core::JsonRepresentation
hash :parameters, as: 'parameters'
property :session, as: 'session'
end
end
class GoogleCloudDialogflowCxV3beta1WebhookRequest
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :detect_intent_response_id, as: 'detectIntentResponseId'
property :fulfillment_info, as: 'fulfillmentInfo', class: Google::Apis::DialogflowV3alpha1::GoogleCloudDialogflowCxV3beta1WebhookRequestFulfillmentInfo, decorator: Google::Apis::DialogflowV3alpha1::GoogleCloudDialogflowCxV3beta1WebhookRequestFulfillmentInfo::Representation
property :intent_info, as: 'intentInfo', class: Google::Apis::DialogflowV3alpha1::GoogleCloudDialogflowCxV3beta1WebhookRequestIntentInfo, decorator: Google::Apis::DialogflowV3alpha1::GoogleCloudDialogflowCxV3beta1WebhookRequestIntentInfo::Representation
collection :messages, as: 'messages', class: Google::Apis::DialogflowV3alpha1::GoogleCloudDialogflowCxV3beta1ResponseMessage, decorator: Google::Apis::DialogflowV3alpha1::GoogleCloudDialogflowCxV3beta1ResponseMessage::Representation
property :page_info, as: 'pageInfo', class: Google::Apis::DialogflowV3alpha1::GoogleCloudDialogflowCxV3beta1PageInfo, decorator: Google::Apis::DialogflowV3alpha1::GoogleCloudDialogflowCxV3beta1PageInfo::Representation
hash :payload, as: 'payload'
property :session_info, as: 'sessionInfo', class: Google::Apis::DialogflowV3alpha1::GoogleCloudDialogflowCxV3beta1SessionInfo, decorator: Google::Apis::DialogflowV3alpha1::GoogleCloudDialogflowCxV3beta1SessionInfo::Representation
end
end
class GoogleCloudDialogflowCxV3beta1WebhookRequestFulfillmentInfo
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :tag, as: 'tag'
end
end
class GoogleCloudDialogflowCxV3beta1WebhookRequestIntentInfo
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :last_matched_intent, as: 'lastMatchedIntent'
hash :parameters, as: 'parameters', class: Google::Apis::DialogflowV3alpha1::GoogleCloudDialogflowCxV3beta1WebhookRequestIntentInfoIntentParameterValue, decorator: Google::Apis::DialogflowV3alpha1::GoogleCloudDialogflowCxV3beta1WebhookRequestIntentInfoIntentParameterValue::Representation
end
end
class GoogleCloudDialogflowCxV3beta1WebhookRequestIntentInfoIntentParameterValue
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :original_value, as: 'originalValue'
property :resolved_value, as: 'resolvedValue'
end
end
class GoogleCloudDialogflowCxV3beta1WebhookResponse
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :fulfillment_response, as: 'fulfillmentResponse', class: Google::Apis::DialogflowV3alpha1::GoogleCloudDialogflowCxV3beta1WebhookResponseFulfillmentResponse, decorator: Google::Apis::DialogflowV3alpha1::GoogleCloudDialogflowCxV3beta1WebhookResponseFulfillmentResponse::Representation
property :page_info, as: 'pageInfo', class: Google::Apis::DialogflowV3alpha1::GoogleCloudDialogflowCxV3beta1PageInfo, decorator: Google::Apis::DialogflowV3alpha1::GoogleCloudDialogflowCxV3beta1PageInfo::Representation
hash :payload, as: 'payload'
property :session_info, as: 'sessionInfo', class: Google::Apis::DialogflowV3alpha1::GoogleCloudDialogflowCxV3beta1SessionInfo, decorator: Google::Apis::DialogflowV3alpha1::GoogleCloudDialogflowCxV3beta1SessionInfo::Representation
property :target_flow, as: 'targetFlow'
property :target_page, as: 'targetPage'
end
end
class GoogleCloudDialogflowCxV3beta1WebhookResponseFulfillmentResponse
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :merge_behavior, as: 'mergeBehavior'
collection :messages, as: 'messages', class: Google::Apis::DialogflowV3alpha1::GoogleCloudDialogflowCxV3beta1ResponseMessage, decorator: Google::Apis::DialogflowV3alpha1::GoogleCloudDialogflowCxV3beta1ResponseMessage::Representation
end
end
class GoogleCloudDialogflowV2AnnotatedMessagePart class GoogleCloudDialogflowV2AnnotatedMessagePart
# @private # @private
class Representation < Google::Apis::Core::JsonRepresentation class Representation < Google::Apis::Core::JsonRepresentation

View File

@ -26,7 +26,7 @@ module Google
# @see https://developers.google.com/display-video/ # @see https://developers.google.com/display-video/
module DisplayvideoV1 module DisplayvideoV1
VERSION = 'V1' VERSION = 'V1'
REVISION = '20200526' REVISION = '20200528'
# Create, see, edit, and permanently delete your Display & Video 360 entities and reports # Create, see, edit, and permanently delete your Display & Video 360 entities and reports
AUTH_DISPLAY_VIDEO = 'https://www.googleapis.com/auth/display-video' AUTH_DISPLAY_VIDEO = 'https://www.googleapis.com/auth/display-video'

View File

@ -2428,6 +2428,13 @@ module Google
# @return [String] # @return [String]
attr_accessor :js_tracker_url attr_accessor :js_tracker_url
# Output only. The IDs of the line items this creative associated with.
# To associate a creative to a line item, use
# LineItem.creative_ids instead.
# Corresponds to the JSON property `lineItemIds`
# @return [Array<Fixnum>]
attr_accessor :line_item_ids
# Output only. Media duration of the creative. # Output only. Media duration of the creative.
# Applicable when creative_type # Applicable when creative_type
# is one of: # is one of:
@ -2664,6 +2671,7 @@ module Google
@ias_campaign_monitoring = args[:ias_campaign_monitoring] if args.key?(:ias_campaign_monitoring) @ias_campaign_monitoring = args[:ias_campaign_monitoring] if args.key?(:ias_campaign_monitoring)
@integration_code = args[:integration_code] if args.key?(:integration_code) @integration_code = args[:integration_code] if args.key?(:integration_code)
@js_tracker_url = args[:js_tracker_url] if args.key?(:js_tracker_url) @js_tracker_url = args[:js_tracker_url] if args.key?(:js_tracker_url)
@line_item_ids = args[:line_item_ids] if args.key?(:line_item_ids)
@media_duration = args[:media_duration] if args.key?(:media_duration) @media_duration = args[:media_duration] if args.key?(:media_duration)
@name = args[:name] if args.key?(:name) @name = args[:name] if args.key?(:name)
@notes = args[:notes] if args.key?(:notes) @notes = args[:notes] if args.key?(:notes)

View File

@ -1743,6 +1743,7 @@ module Google
property :ias_campaign_monitoring, as: 'iasCampaignMonitoring' property :ias_campaign_monitoring, as: 'iasCampaignMonitoring'
property :integration_code, as: 'integrationCode' property :integration_code, as: 'integrationCode'
property :js_tracker_url, as: 'jsTrackerUrl' property :js_tracker_url, as: 'jsTrackerUrl'
collection :line_item_ids, as: 'lineItemIds'
property :media_duration, as: 'mediaDuration' property :media_duration, as: 'mediaDuration'
property :name, as: 'name' property :name, as: 'name'
property :notes, as: 'notes' property :notes, as: 'notes'

View File

@ -25,7 +25,7 @@ module Google
# @see https://cloud.google.com/tpu/ # @see https://cloud.google.com/tpu/
module TpuV1 module TpuV1
VERSION = 'V1' VERSION = 'V1'
REVISION = '20200309' REVISION = '20200527'
# View and manage your data across Google Cloud Platform services # View and manage your data across Google Cloud Platform services
AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform'

View File

@ -362,7 +362,7 @@ module Google
# @return [String] # @return [String]
attr_accessor :port attr_accessor :port
# # Sets the scheduling options for this node.
# Corresponds to the JSON property `schedulingConfig` # Corresponds to the JSON property `schedulingConfig`
# @return [Google::Apis::TpuV1::SchedulingConfig] # @return [Google::Apis::TpuV1::SchedulingConfig]
attr_accessor :scheduling_config attr_accessor :scheduling_config
@ -554,11 +554,11 @@ module Google
end end
end end
# # Sets the scheduling options for this node.
class SchedulingConfig class SchedulingConfig
include Google::Apis::Core::Hashable include Google::Apis::Core::Hashable
# # Defines whether the node is preemptible.
# Corresponds to the JSON property `preemptible` # Corresponds to the JSON property `preemptible`
# @return [Boolean] # @return [Boolean]
attr_accessor :preemptible attr_accessor :preemptible

View File

@ -25,7 +25,7 @@ module Google
# @see https://cloud.google.com/tpu/ # @see https://cloud.google.com/tpu/
module TpuV1alpha1 module TpuV1alpha1
VERSION = 'V1alpha1' VERSION = 'V1alpha1'
REVISION = '20200309' REVISION = '20200527'
# View and manage your data across Google Cloud Platform services # View and manage your data across Google Cloud Platform services
AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform'

View File

@ -362,7 +362,7 @@ module Google
# @return [String] # @return [String]
attr_accessor :port attr_accessor :port
# # Sets the scheduling options for this node.
# Corresponds to the JSON property `schedulingConfig` # Corresponds to the JSON property `schedulingConfig`
# @return [Google::Apis::TpuV1alpha1::SchedulingConfig] # @return [Google::Apis::TpuV1alpha1::SchedulingConfig]
attr_accessor :scheduling_config attr_accessor :scheduling_config
@ -554,11 +554,11 @@ module Google
end end
end end
# # Sets the scheduling options for this node.
class SchedulingConfig class SchedulingConfig
include Google::Apis::Core::Hashable include Google::Apis::Core::Hashable
# # Defines whether the node is preemptible.
# Corresponds to the JSON property `preemptible` # Corresponds to the JSON property `preemptible`
# @return [Boolean] # @return [Boolean]
attr_accessor :preemptible attr_accessor :preemptible

View File

@ -26,7 +26,7 @@ module Google
# @see https://developers.google.com/youtube/ # @see https://developers.google.com/youtube/
module YoutubeV3 module YoutubeV3
VERSION = 'V3' VERSION = 'V3'
REVISION = '20200522' REVISION = '20200526'
# Manage your YouTube account # Manage your YouTube account
AUTH_YOUTUBE = 'https://www.googleapis.com/auth/youtube' AUTH_YOUTUBE = 'https://www.googleapis.com/auth/youtube'

View File

@ -45,7 +45,7 @@ module Google
def initialize def initialize
super('https://www.googleapis.com/', '') super('https://www.googleapis.com/', '')
@batch_path = 'batch/youtube/v3' @batch_path = 'batch/youtube'
end end
# Retrieves a list of resources, possibly filtered. # Retrieves a list of resources, possibly filtered.