Dialogflow V2 API - Class Google::Cloud::Dialogflow::V2::Environments::Rest::Client (v0.29.0)

Reference documentation and code samples for the Dialogflow V2 API class Google::Cloud::Dialogflow::V2::Environments::Rest::Client.

REST client for the Environments service.

Service for managing Environments.

Inherits

  • Object

Includes

Methods

.configure

def self.configure() { |config| ... } -> Client::Configuration

Configure the Environments Client class.

See Configuration for a description of the configuration fields.

Yields
  • (config) — Configure the Client client.
Yield Parameter
Returns
Example 
# Modify the configuration for all Environments clients
::Google::Cloud::Dialogflow::V2::Environments::Rest::Client.configure do |config|
  config.timeout = 10.0
end

#configure

def configure() { |config| ... } -> Client::Configuration

Configure the Environments 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 Configuration for a description of the configuration fields.

Yields
  • (config) — Configure the Client client.
Yield Parameter
Returns

#create_environment

def create_environment(request, options = nil) -> ::Google::Cloud::Dialogflow::V2::Environment
def create_environment(parent: nil, environment: nil, environment_id: nil) -> ::Google::Cloud::Dialogflow::V2::Environment

Creates an agent environment.

Overloads 
def create_environment(request, options = nil) -> ::Google::Cloud::Dialogflow::V2::Environment
Pass arguments to create_environment via a request object, either of type CreateEnvironmentRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Dialogflow::V2::CreateEnvironmentRequest, ::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.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional. 
def create_environment(parent: nil, environment: nil, environment_id: nil) -> ::Google::Cloud::Dialogflow::V2::Environment
Pass arguments to create_environment 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).
Parameters
  • parent (::String) —

    Required. The agent to create an environment for. Supported formats:

    • projects/<Project ID>/agent
    • projects/<Project ID>/locations/<Location ID>/agent
  • environment (::Google::Cloud::Dialogflow::V2::Environment, ::Hash) — Required. The environment to create.
  • environment_id (::String) — Required. The unique id of the new environment.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.
Example

Basic example

require "google/cloud/dialogflow/v2"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Dialogflow::V2::Environments::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Dialogflow::V2::CreateEnvironmentRequest.new

# Call the create_environment method.
result = client.create_environment request

# The returned object is of type Google::Cloud::Dialogflow::V2::Environment.
p result

#delete_environment

def delete_environment(request, options = nil) -> ::Google::Protobuf::Empty
def delete_environment(name: nil) -> ::Google::Protobuf::Empty

Deletes the specified agent environment.

Overloads 
def delete_environment(request, options = nil) -> ::Google::Protobuf::Empty
Pass arguments to delete_environment via a request object, either of type DeleteEnvironmentRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Dialogflow::V2::DeleteEnvironmentRequest, ::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.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional. 
def delete_environment(name: nil) -> ::Google::Protobuf::Empty
Pass arguments to delete_environment 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).
Parameter
  • name (::String) — Required. The name of the environment to delete. / Format:

    • projects/<Project ID>/agent/environments/<Environment ID>
    • projects/<Project ID>/locations/<Location ID>/agent/environments/<Environment ID>

    The environment ID for the default environment is -.

Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.
Example

Basic example

require "google/cloud/dialogflow/v2"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Dialogflow::V2::Environments::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Dialogflow::V2::DeleteEnvironmentRequest.new

# Call the delete_environment method.
result = client.delete_environment request

# The returned object is of type Google::Protobuf::Empty.
p result

#get_environment

def get_environment(request, options = nil) -> ::Google::Cloud::Dialogflow::V2::Environment
def get_environment(name: nil) -> ::Google::Cloud::Dialogflow::V2::Environment

Retrieves the specified agent environment.

Overloads 
def get_environment(request, options = nil) -> ::Google::Cloud::Dialogflow::V2::Environment
Pass arguments to get_environment via a request object, either of type GetEnvironmentRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Dialogflow::V2::GetEnvironmentRequest, ::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.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional. 
def get_environment(name: nil) -> ::Google::Cloud::Dialogflow::V2::Environment
Pass arguments to get_environment 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).
Parameter
  • name (::String) — Required. The name of the environment. Supported formats:

    • projects/<Project ID>/agent/environments/<Environment ID>
    • projects/<Project ID>/locations/<Location ID>/agent/environments/<Environment ID>

    The environment ID for the default environment is -.

Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.
Example

Basic example

require "google/cloud/dialogflow/v2"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Dialogflow::V2::Environments::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Dialogflow::V2::GetEnvironmentRequest.new

# Call the get_environment method.
result = client.get_environment request

# The returned object is of type Google::Cloud::Dialogflow::V2::Environment.
p result

#get_environment_history

def get_environment_history(request, options = nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::Dialogflow::V2::EnvironmentHistory::Entry>
def get_environment_history(parent: nil, page_size: nil, page_token: nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::Dialogflow::V2::EnvironmentHistory::Entry>

Gets the history of the specified environment.

Overloads 
def get_environment_history(request, options = nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::Dialogflow::V2::EnvironmentHistory::Entry>
Pass arguments to get_environment_history via a request object, either of type GetEnvironmentHistoryRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Dialogflow::V2::GetEnvironmentHistoryRequest, ::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.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional. 
def get_environment_history(parent: nil, page_size: nil, page_token: nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::Dialogflow::V2::EnvironmentHistory::Entry>
Pass arguments to get_environment_history 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).
Parameters
  • parent (::String) — Required. The name of the environment to retrieve history for. Supported formats:

    • projects/<Project ID>/agent/environments/<Environment ID>
    • projects/<Project ID>/locations/<Location ID>/agent/environments/<Environment ID>

    The environment ID for the default environment is -.

  • page_size (::Integer) — Optional. The maximum number of items to return in a single page. By default 100 and at most 1000.
  • page_token (::String) — Optional. The next_page_token value returned from a previous list request.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.
Example

Basic example

require "google/cloud/dialogflow/v2"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Dialogflow::V2::Environments::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Dialogflow::V2::GetEnvironmentHistoryRequest.new

# Call the get_environment_history method.
result = client.get_environment_history request

# The returned object is of type Gapic::PagedEnumerable. You can iterate
# over elements, and API calls will be issued to fetch pages as needed.
result.each do |item|
  # Each element is of type ::Google::Cloud::Dialogflow::V2::EnvironmentHistory::Entry.
  p item
end

#initialize

def initialize() { |config| ... } -> Client

Create a new Environments REST client object.

Yields
  • (config) — Configure the Environments client.
Yield Parameter
Returns
  • (Client) — a new instance of Client
Example 
# Create a client using the default configuration
client = ::Google::Cloud::Dialogflow::V2::Environments::Rest::Client.new

# Create a client using a custom configuration
client = ::Google::Cloud::Dialogflow::V2::Environments::Rest::Client.new do |config|
  config.timeout = 10.0
end

#list_environments

def list_environments(request, options = nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::Dialogflow::V2::Environment>
def list_environments(parent: nil, page_size: nil, page_token: nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::Dialogflow::V2::Environment>

Returns the list of all non-default environments of the specified agent.

Overloads 
def list_environments(request, options = nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::Dialogflow::V2::Environment>
Pass arguments to list_environments via a request object, either of type ListEnvironmentsRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Dialogflow::V2::ListEnvironmentsRequest, ::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.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional. 
def list_environments(parent: nil, page_size: nil, page_token: nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::Dialogflow::V2::Environment>
Pass arguments to list_environments 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).
Parameters
  • parent (::String) —

    Required. The agent to list all environments from. Format:

    • projects/<Project ID>/agent
    • projects/<Project ID>/locations/<Location ID>/agent
  • page_size (::Integer) — Optional. The maximum number of items to return in a single page. By default 100 and at most 1000.
  • page_token (::String) — Optional. The next_page_token value returned from a previous list request.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.
Example

Basic example

require "google/cloud/dialogflow/v2"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Dialogflow::V2::Environments::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Dialogflow::V2::ListEnvironmentsRequest.new

# Call the list_environments method.
result = client.list_environments request

# The returned object is of type Gapic::PagedEnumerable. You can iterate
# over elements, and API calls will be issued to fetch pages as needed.
result.each do |item|
  # Each element is of type ::Google::Cloud::Dialogflow::V2::Environment.
  p item
end

#location_client

def location_client() -> Google::Cloud::Location::Locations::Rest::Client

Get the associated client for mix-in of the Locations.

Returns
  • (Google::Cloud::Location::Locations::Rest::Client)

#update_environment

def update_environment(request, options = nil) -> ::Google::Cloud::Dialogflow::V2::Environment
def update_environment(environment: nil, update_mask: nil, allow_load_to_draft_and_discard_changes: nil) -> ::Google::Cloud::Dialogflow::V2::Environment

Updates the specified agent environment.

This method allows you to deploy new agent versions into the environment. When an environment is pointed to a new agent version by setting environment.agent_version, the environment is temporarily set to the LOADING state. During that time, the environment continues serving the previous version of the agent. After the new agent version is done loading, the environment is set back to the RUNNING state. You can use "-" as Environment ID in environment name to update an agent version in the default environment. WARNING: this will negate all recent changes to the draft agent and can't be undone. You may want to save the draft agent to a version before calling this method.

Overloads 
def update_environment(request, options = nil) -> ::Google::Cloud::Dialogflow::V2::Environment
Pass arguments to update_environment via a request object, either of type UpdateEnvironmentRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Dialogflow::V2::UpdateEnvironmentRequest, ::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.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional. 
def update_environment(environment: nil, update_mask: nil, allow_load_to_draft_and_discard_changes: nil) -> ::Google::Cloud::Dialogflow::V2::Environment
Pass arguments to update_environment 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).
Parameters
  • environment (::Google::Cloud::Dialogflow::V2::Environment, ::Hash) — Required. The environment to update.
  • update_mask (::Google::Protobuf::FieldMask, ::Hash) — Required. The mask to control which fields get updated.
  • allow_load_to_draft_and_discard_changes (::Boolean) — Optional. This field is used to prevent accidental overwrite of the default environment, which is an operation that cannot be undone. To confirm that the caller desires this overwrite, this field must be explicitly set to true when updating the default environment (environment ID = -).
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.
Example

Basic example

require "google/cloud/dialogflow/v2"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Dialogflow::V2::Environments::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Dialogflow::V2::UpdateEnvironmentRequest.new

# Call the update_environment method.
result = client.update_environment request

# The returned object is of type Google::Cloud::Dialogflow::V2::Environment.
p result