class Google::Cloud::Dialogflow::CX::V3::Pages::Client

Client for the Pages service.

Service for managing {::Google::Cloud::Dialogflow::CX::V3::Page Pages}.

Attributes

pages_stub[R]

@private

Public Class Methods

configure() { |configure| ... } click to toggle source

Configure the Pages Client class.

See {::Google::Cloud::Dialogflow::CX::V3::Pages::Client::Configuration} for a description of the configuration fields.

@example

# Modify the configuration for all Pages clients
::Google::Cloud::Dialogflow::CX::V3::Pages::Client.configure do |config|
  config.timeout = 10.0
end

@yield [config] Configure the Client client. @yieldparam config [Client::Configuration]

@return [Client::Configuration]

# File lib/google/cloud/dialogflow/cx/v3/pages/client.rb, line 57
def self.configure
  @configure ||= begin
    namespace = ["Google", "Cloud", "Dialogflow", "CX", "V3"]
    parent_config = while namespace.any?
                      parent_name = namespace.join "::"
                      parent_const = const_get parent_name
                      break parent_const.configure if parent_const.respond_to? :configure
                      namespace.pop
                    end
    default_config = Client::Configuration.new parent_config

    default_config.timeout = 60.0
    default_config.retry_policy = {
      initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [14]
    }

    default_config
  end
  yield @configure if block_given?
  @configure
end
new() { |config| ... } click to toggle source

Create a new Pages client object.

@example

# Create a client using the default configuration
client = ::Google::Cloud::Dialogflow::CX::V3::Pages::Client.new

# Create a client using a custom configuration
client = ::Google::Cloud::Dialogflow::CX::V3::Pages::Client.new do |config|
  config.timeout = 10.0
end

@yield [config] Configure the Pages client. @yieldparam config [Client::Configuration]

# File lib/google/cloud/dialogflow/cx/v3/pages/client.rb, line 115
def initialize
  # These require statements are intentionally placed here to initialize
  # the gRPC module only when it's required.
  # See https://github.com/googleapis/toolkit/issues/446
  require "gapic/grpc"
  require "google/cloud/dialogflow/cx/v3/page_services_pb"

  # Create the configuration object
  @config = Configuration.new Client.configure

  # Yield the configuration if needed
  yield @config if block_given?

  # Create credentials
  credentials = @config.credentials
  # Use self-signed JWT if the endpoint is unchanged from default,
  # but only if the default endpoint does not have a region prefix.
  enable_self_signed_jwt = @config.endpoint == Client.configure.endpoint &&
                           !@config.endpoint.split(".").first.include?("-")
  credentials ||= Credentials.default scope: @config.scope,
                                      enable_self_signed_jwt: enable_self_signed_jwt
  if credentials.is_a?(::String) || credentials.is_a?(::Hash)
    credentials = Credentials.new credentials, scope: @config.scope
  end
  @quota_project_id = @config.quota_project
  @quota_project_id ||= credentials.quota_project_id if credentials.respond_to? :quota_project_id

  @pages_stub = ::Gapic::ServiceStub.new(
    ::Google::Cloud::Dialogflow::CX::V3::Pages::Stub,
    credentials:  credentials,
    endpoint:     @config.endpoint,
    channel_args: @config.channel_args,
    interceptors: @config.interceptors
  )
end

Public Instance Methods

configure() { |config| ... } click to toggle source

Configure the Pages Client instance.

The configuration is set to the derived mode, meaning that values can be changed, but structural changes (adding new fields, etc.) are not allowed. Structural changes should be made on {Client.configure}.

See {::Google::Cloud::Dialogflow::CX::V3::Pages::Client::Configuration} for a description of the configuration fields.

@yield [config] Configure the Client client. @yieldparam config [Client::Configuration]

@return [Client::Configuration]

# File lib/google/cloud/dialogflow/cx/v3/pages/client.rb, line 94
def configure
  yield @config if block_given?
  @config
end
create_page(request, options = nil) { |response, operation| ... } click to toggle source

Creates a page in the specified flow.

Note: You should always train a flow prior to sending it queries. See the [training documentation](cloud.google.com/dialogflow/cx/docs/concept/training).

@overload create_page(request, options = nil)

Pass arguments to `create_page` via a request object, either of type
{::Google::Cloud::Dialogflow::CX::V3::CreatePageRequest} or an equivalent Hash.

@param request [::Google::Cloud::Dialogflow::CX::V3::CreatePageRequest, ::Hash]
  A request object representing the call parameters. Required. To specify no
  parameters, or to keep all the default parameter values, pass an empty Hash.
@param options [::Gapic::CallOptions, ::Hash]
  Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

@overload create_page(parent: nil, page: nil, language_code: nil)

Pass arguments to `create_page` via keyword arguments. Note that at
least one keyword argument is required. To specify no parameters, or to keep all
the default parameter values, pass an empty Hash as a request object (see above).

@param parent [::String]
  Required. The flow to create a page for.
  Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
  ID>/flows/<Flow ID>`.
@param page [::Google::Cloud::Dialogflow::CX::V3::Page, ::Hash]
  Required. The page to create.
@param language_code [::String]
  The language of the following fields in `page`:

  *  `Page.entry_fulfillment.messages`
  *  `Page.entry_fulfillment.conditional_cases`
  *  `Page.event_handlers.trigger_fulfillment.messages`
  *  `Page.event_handlers.trigger_fulfillment.conditional_cases`
  *  `Page.form.parameters.fill_behavior.initial_prompt_fulfillment.messages`
  *
  `Page.form.parameters.fill_behavior.initial_prompt_fulfillment.conditional_cases`
  *  `Page.form.parameters.fill_behavior.reprompt_event_handlers.messages`
  *
  `Page.form.parameters.fill_behavior.reprompt_event_handlers.conditional_cases`
  *  `Page.transition_routes.trigger_fulfillment.messages`
  *  `Page.transition_routes.trigger_fulfillment.conditional_cases`

  If not specified, the agent's default language is used.
  [Many
  languages](https://cloud.google.com/dialogflow/cx/docs/reference/language)
  are supported.
  Note: languages must be enabled in the agent before they can be used.

@yield [response, operation] Access the result along with the RPC operation @yieldparam response [::Google::Cloud::Dialogflow::CX::V3::Page] @yieldparam operation [::GRPC::ActiveCall::Operation]

@return [::Google::Cloud::Dialogflow::CX::V3::Page]

@raise [::Google::Cloud::Error] if the RPC is aborted.

# File lib/google/cloud/dialogflow/cx/v3/pages/client.rb, line 401
def create_page request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dialogflow::CX::V3::CreatePageRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.create_page.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Dialogflow::CX::V3::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {
    "parent" => request.parent
  }
  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.create_page.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.create_page.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @pages_stub.call_rpc :create_page, request, options: options do |response, operation|
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end
delete_page(request, options = nil) { |response, operation| ... } click to toggle source

Deletes the specified page.

Note: You should always train a flow prior to sending it queries. See the [training documentation](cloud.google.com/dialogflow/cx/docs/concept/training).

@overload delete_page(request, options = nil)

Pass arguments to `delete_page` via a request object, either of type
{::Google::Cloud::Dialogflow::CX::V3::DeletePageRequest} or an equivalent Hash.

@param request [::Google::Cloud::Dialogflow::CX::V3::DeletePageRequest, ::Hash]
  A request object representing the call parameters. Required. To specify no
  parameters, or to keep all the default parameter values, pass an empty Hash.
@param options [::Gapic::CallOptions, ::Hash]
  Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

@overload delete_page(name: nil, force: nil)

Pass arguments to `delete_page` via keyword arguments. Note that at
least one keyword argument is required. To specify no parameters, or to keep all
the default parameter values, pass an empty Hash as a request object (see above).

@param name [::String]
  Required. The name of the page to delete.
  Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
  ID>/Flows/<flow ID>/pages/<Page ID>`.
@param force [::Boolean]
  This field has no effect for pages with no incoming transitions.
  For pages with incoming transitions:

  *  If `force` is set to false, an error will be returned with message
     indicating the incoming transitions.
  *  If `force` is set to true, Dialogflow will remove the page, as well as
     any transitions to the page (i.e. [Target
     page][EventHandler.target_page] in event handlers or [Target
     page][TransitionRoute.target_page] in transition routes that point to
     this page will be cleared).

@yield [response, operation] Access the result along with the RPC operation @yieldparam response [::Google::Protobuf::Empty] @yieldparam operation [::GRPC::ActiveCall::Operation]

@return [::Google::Protobuf::Empty]

@raise [::Google::Cloud::Error] if the RPC is aborted.

# File lib/google/cloud/dialogflow/cx/v3/pages/client.rb, line 582
def delete_page request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dialogflow::CX::V3::DeletePageRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.delete_page.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Dialogflow::CX::V3::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {
    "name" => request.name
  }
  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.delete_page.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.delete_page.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @pages_stub.call_rpc :delete_page, request, options: options do |response, operation|
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end
get_page(request, options = nil) { |response, operation| ... } click to toggle source

Retrieves the specified page.

@overload get_page(request, options = nil)

Pass arguments to `get_page` via a request object, either of type
{::Google::Cloud::Dialogflow::CX::V3::GetPageRequest} or an equivalent Hash.

@param request [::Google::Cloud::Dialogflow::CX::V3::GetPageRequest, ::Hash]
  A request object representing the call parameters. Required. To specify no
  parameters, or to keep all the default parameter values, pass an empty Hash.
@param options [::Gapic::CallOptions, ::Hash]
  Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

@overload get_page(name: nil, language_code: nil)

Pass arguments to `get_page` via keyword arguments. Note that at
least one keyword argument is required. To specify no parameters, or to keep all
the default parameter values, pass an empty Hash as a request object (see above).

@param name [::String]
  Required. The name of the page.
  Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
  ID>/flows/<Flow ID>/pages/<Page ID>`.
@param language_code [::String]
  The language to retrieve the page for. The following fields are language
  dependent:

  *  `Page.entry_fulfillment.messages`
  *  `Page.entry_fulfillment.conditional_cases`
  *  `Page.event_handlers.trigger_fulfillment.messages`
  *  `Page.event_handlers.trigger_fulfillment.conditional_cases`
  *  `Page.form.parameters.fill_behavior.initial_prompt_fulfillment.messages`
  *
  `Page.form.parameters.fill_behavior.initial_prompt_fulfillment.conditional_cases`
  *  `Page.form.parameters.fill_behavior.reprompt_event_handlers.messages`
  *
  `Page.form.parameters.fill_behavior.reprompt_event_handlers.conditional_cases`
  *  `Page.transition_routes.trigger_fulfillment.messages`
  *  `Page.transition_routes.trigger_fulfillment.conditional_cases`

  If not specified, the agent's default language is used.
  [Many
  languages](https://cloud.google.com/dialogflow/cx/docs/reference/language)
  are supported.
  Note: languages must be enabled in the agent before they can be used.

@yield [response, operation] Access the result along with the RPC operation @yieldparam response [::Google::Cloud::Dialogflow::CX::V3::Page] @yieldparam operation [::GRPC::ActiveCall::Operation]

@return [::Google::Cloud::Dialogflow::CX::V3::Page]

@raise [::Google::Cloud::Error] if the RPC is aborted.

# File lib/google/cloud/dialogflow/cx/v3/pages/client.rb, line 304
def get_page request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dialogflow::CX::V3::GetPageRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.get_page.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Dialogflow::CX::V3::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {
    "name" => request.name
  }
  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.get_page.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.get_page.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @pages_stub.call_rpc :get_page, request, options: options do |response, operation|
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end
list_pages(request, options = nil) { |response, operation| ... } click to toggle source

Returns the list of all pages in the specified flow.

@overload list_pages(request, options = nil)

Pass arguments to `list_pages` via a request object, either of type
{::Google::Cloud::Dialogflow::CX::V3::ListPagesRequest} or an equivalent Hash.

@param request [::Google::Cloud::Dialogflow::CX::V3::ListPagesRequest, ::Hash]
  A request object representing the call parameters. Required. To specify no
  parameters, or to keep all the default parameter values, pass an empty Hash.
@param options [::Gapic::CallOptions, ::Hash]
  Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

@overload list_pages(parent: nil, language_code: nil, page_size: nil, page_token: nil)

Pass arguments to `list_pages` via keyword arguments. Note that at
least one keyword argument is required. To specify no parameters, or to keep all
the default parameter values, pass an empty Hash as a request object (see above).

@param parent [::String]
  Required. The flow to list all pages for.
  Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
  ID>/flows/<Flow ID>`.
@param language_code [::String]
  The language to list pages for. The following fields are language
  dependent:

  *  `Page.entry_fulfillment.messages`
  *  `Page.entry_fulfillment.conditional_cases`
  *  `Page.event_handlers.trigger_fulfillment.messages`
  *  `Page.event_handlers.trigger_fulfillment.conditional_cases`
  *  `Page.form.parameters.fill_behavior.initial_prompt_fulfillment.messages`
  *
  `Page.form.parameters.fill_behavior.initial_prompt_fulfillment.conditional_cases`
  *  `Page.form.parameters.fill_behavior.reprompt_event_handlers.messages`
  *
  `Page.form.parameters.fill_behavior.reprompt_event_handlers.conditional_cases`
  *  `Page.transition_routes.trigger_fulfillment.messages`
  *  `Page.transition_routes.trigger_fulfillment.conditional_cases`

  If not specified, the agent's default language is used.
  [Many
  languages](https://cloud.google.com/dialogflow/cx/docs/reference/language)
  are supported.
  Note: languages must be enabled in the agent before they can be used.
@param page_size [::Integer]
  The maximum number of items to return in a single page. By default 100 and
  at most 1000.
@param page_token [::String]
  The next_page_token value returned from a previous list request.

@yield [response, operation] Access the result along with the RPC operation @yieldparam response [::Gapic::PagedEnumerable<::Google::Cloud::Dialogflow::CX::V3::Page>] @yieldparam operation [::GRPC::ActiveCall::Operation]

@return [::Gapic::PagedEnumerable<::Google::Cloud::Dialogflow::CX::V3::Page>]

@raise [::Google::Cloud::Error] if the RPC is aborted.

# File lib/google/cloud/dialogflow/cx/v3/pages/client.rb, line 211
def list_pages request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dialogflow::CX::V3::ListPagesRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.list_pages.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Dialogflow::CX::V3::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {
    "parent" => request.parent
  }
  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.list_pages.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.list_pages.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @pages_stub.call_rpc :list_pages, request, options: options do |response, operation|
    response = ::Gapic::PagedEnumerable.new @pages_stub, :list_pages, request, response, operation, options
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end
update_page(request, options = nil) { |response, operation| ... } click to toggle source

Updates the specified page.

Note: You should always train a flow prior to sending it queries. See the [training documentation](cloud.google.com/dialogflow/cx/docs/concept/training).

@overload update_page(request, options = nil)

Pass arguments to `update_page` via a request object, either of type
{::Google::Cloud::Dialogflow::CX::V3::UpdatePageRequest} or an equivalent Hash.

@param request [::Google::Cloud::Dialogflow::CX::V3::UpdatePageRequest, ::Hash]
  A request object representing the call parameters. Required. To specify no
  parameters, or to keep all the default parameter values, pass an empty Hash.
@param options [::Gapic::CallOptions, ::Hash]
  Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

@overload update_page(page: nil, language_code: nil, update_mask: nil)

Pass arguments to `update_page` via keyword arguments. Note that at
least one keyword argument is required. To specify no parameters, or to keep all
the default parameter values, pass an empty Hash as a request object (see above).

@param page [::Google::Cloud::Dialogflow::CX::V3::Page, ::Hash]
  Required. The page to update.
@param language_code [::String]
  The language of the following fields in `page`:

  *  `Page.entry_fulfillment.messages`
  *  `Page.entry_fulfillment.conditional_cases`
  *  `Page.event_handlers.trigger_fulfillment.messages`
  *  `Page.event_handlers.trigger_fulfillment.conditional_cases`
  *  `Page.form.parameters.fill_behavior.initial_prompt_fulfillment.messages`
  *
  `Page.form.parameters.fill_behavior.initial_prompt_fulfillment.conditional_cases`
  *  `Page.form.parameters.fill_behavior.reprompt_event_handlers.messages`
  *
  `Page.form.parameters.fill_behavior.reprompt_event_handlers.conditional_cases`
  *  `Page.transition_routes.trigger_fulfillment.messages`
  *  `Page.transition_routes.trigger_fulfillment.conditional_cases`

  If not specified, the agent's default language is used.
  [Many
  languages](https://cloud.google.com/dialogflow/cx/docs/reference/language)
  are supported.
  Note: languages must be enabled in the agent before they can be used.
@param update_mask [::Google::Protobuf::FieldMask, ::Hash]
  The mask to control which fields get updated. If the mask is not present,
  all fields will be updated.

@yield [response, operation] Access the result along with the RPC operation @yieldparam response [::Google::Cloud::Dialogflow::CX::V3::Page] @yieldparam operation [::GRPC::ActiveCall::Operation]

@return [::Google::Cloud::Dialogflow::CX::V3::Page]

@raise [::Google::Cloud::Error] if the RPC is aborted.

# File lib/google/cloud/dialogflow/cx/v3/pages/client.rb, line 497
def update_page request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dialogflow::CX::V3::UpdatePageRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.update_page.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Dialogflow::CX::V3::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {
    "page.name" => request.page.name
  }
  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.update_page.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.update_page.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @pages_stub.call_rpc :update_page, request, options: options do |response, operation|
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end