# Dialogflow CX V3 API - Class Google::Cloud::Dialogflow::CX::V3::Agents::Rest::ServiceStub (v1.12.1)

1.12.1 (latest) 1.12.0 1.11.0 1.10.1 1.9.0 1.8.0 1.7.0 1.6.1 1.5.0 1.4.0 1.3.0 1.2.0 1.1.1 1.0.0 0.26.0 0.25.0 0.24.2 0.23.0 0.22.0 0.21.0 0.20.0 0.19.0 0.18.0 0.17.0 0.16.0 0.15.1 0.14.0 0.13.0 0.12.0 0.11.0 0.10.2 0.9.0 0.8.1 0.7.1 0.6.0 0.5.0 0.4.0 Reference documentation and code samples for the Dialogflow CX V3 API class Google::Cloud::Dialogflow::CX::V3::Agents::Rest::ServiceStub.

REST service stub for the Agents service.
Service stub contains baseline method implementations
including transcoding, making the REST call, and deserialing the response.

## Inherits

- Object

## Methods

### #create_agent

    def create_agent(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::Dialogflow::CX::V3::Agent

Baseline implementation for the create_agent REST call
**Parameters**

- **request_pb** ([::Google::Cloud::Dialogflow::CX::V3::CreateAgentRequest](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-dialogflow-cx-v3/latest/Google-Cloud-Dialogflow-CX-V3-CreateAgentRequest)) --- A request object representing the call parameters. Required.
- **options** (::Gapic::CallOptions) --- Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
**Yields**

- (result, operation) --- Access the result along with the TransportOperation object
**Yield Parameters**

- **result** ([::Google::Cloud::Dialogflow::CX::V3::Agent](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-dialogflow-cx-v3/latest/Google-Cloud-Dialogflow-CX-V3-Agent))
- **operation** (::Gapic::Rest::TransportOperation)
**Returns**

- ([::Google::Cloud::Dialogflow::CX::V3::Agent](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-dialogflow-cx-v3/latest/Google-Cloud-Dialogflow-CX-V3-Agent)) --- A result object deserialized from the server's reply
**Raises**

- (::ArgumentError)

### #delete_agent

    def delete_agent(request_pb, options = nil) { |result, operation| ... } -> ::Google::Protobuf::Empty

Baseline implementation for the delete_agent REST call
**Parameters**

- **request_pb** ([::Google::Cloud::Dialogflow::CX::V3::DeleteAgentRequest](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-dialogflow-cx-v3/latest/Google-Cloud-Dialogflow-CX-V3-DeleteAgentRequest)) --- A request object representing the call parameters. Required.
- **options** (::Gapic::CallOptions) --- Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
**Yields**

- (result, operation) --- Access the result along with the TransportOperation object
**Yield Parameters**

- **result** ([::Google::Protobuf::Empty](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-dialogflow-cx-v3/latest/Google-Protobuf-Empty))
- **operation** (::Gapic::Rest::TransportOperation)
**Returns**

- ([::Google::Protobuf::Empty](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-dialogflow-cx-v3/latest/Google-Protobuf-Empty)) --- A result object deserialized from the server's reply
**Raises**

- (::ArgumentError)

### #endpoint

    def endpoint() -> String

The effective endpoint
**Returns**

- (String)

### #export_agent

    def export_agent(request_pb, options = nil) { |result, operation| ... } -> ::Google::Longrunning::Operation

Baseline implementation for the export_agent REST call
**Parameters**

- **request_pb** ([::Google::Cloud::Dialogflow::CX::V3::ExportAgentRequest](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-dialogflow-cx-v3/latest/Google-Cloud-Dialogflow-CX-V3-ExportAgentRequest)) --- A request object representing the call parameters. Required.
- **options** (::Gapic::CallOptions) --- Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
**Yields**

- (result, operation) --- Access the result along with the TransportOperation object
**Yield Parameters**

- **result** ([::Google::Longrunning::Operation](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-dialogflow-cx-v3/latest/Google-Longrunning-Operation))
- **operation** (::Gapic::Rest::TransportOperation)
**Returns**

- ([::Google::Longrunning::Operation](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-dialogflow-cx-v3/latest/Google-Longrunning-Operation)) --- A result object deserialized from the server's reply
**Raises**

- (::ArgumentError)

### #get_agent

    def get_agent(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::Dialogflow::CX::V3::Agent

Baseline implementation for the get_agent REST call
**Parameters**

- **request_pb** ([::Google::Cloud::Dialogflow::CX::V3::GetAgentRequest](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-dialogflow-cx-v3/latest/Google-Cloud-Dialogflow-CX-V3-GetAgentRequest)) --- A request object representing the call parameters. Required.
- **options** (::Gapic::CallOptions) --- Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
**Yields**

- (result, operation) --- Access the result along with the TransportOperation object
**Yield Parameters**

- **result** ([::Google::Cloud::Dialogflow::CX::V3::Agent](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-dialogflow-cx-v3/latest/Google-Cloud-Dialogflow-CX-V3-Agent))
- **operation** (::Gapic::Rest::TransportOperation)
**Returns**

- ([::Google::Cloud::Dialogflow::CX::V3::Agent](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-dialogflow-cx-v3/latest/Google-Cloud-Dialogflow-CX-V3-Agent)) --- A result object deserialized from the server's reply
**Raises**

- (::ArgumentError)

### #get_agent_validation_result

    def get_agent_validation_result(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::Dialogflow::CX::V3::AgentValidationResult

Baseline implementation for the get_agent_validation_result REST call
**Parameters**

- **request_pb** ([::Google::Cloud::Dialogflow::CX::V3::GetAgentValidationResultRequest](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-dialogflow-cx-v3/latest/Google-Cloud-Dialogflow-CX-V3-GetAgentValidationResultRequest)) --- A request object representing the call parameters. Required.
- **options** (::Gapic::CallOptions) --- Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
**Yields**

- (result, operation) --- Access the result along with the TransportOperation object
**Yield Parameters**

- **result** ([::Google::Cloud::Dialogflow::CX::V3::AgentValidationResult](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-dialogflow-cx-v3/latest/Google-Cloud-Dialogflow-CX-V3-AgentValidationResult))
- **operation** (::Gapic::Rest::TransportOperation)
**Returns**

- ([::Google::Cloud::Dialogflow::CX::V3::AgentValidationResult](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-dialogflow-cx-v3/latest/Google-Cloud-Dialogflow-CX-V3-AgentValidationResult)) --- A result object deserialized from the server's reply
**Raises**

- (::ArgumentError)

### #get_generative_settings

    def get_generative_settings(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::Dialogflow::CX::V3::GenerativeSettings

Baseline implementation for the get_generative_settings REST call
**Parameters**

- **request_pb** ([::Google::Cloud::Dialogflow::CX::V3::GetGenerativeSettingsRequest](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-dialogflow-cx-v3/latest/Google-Cloud-Dialogflow-CX-V3-GetGenerativeSettingsRequest)) --- A request object representing the call parameters. Required.
- **options** (::Gapic::CallOptions) --- Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
**Yields**

- (result, operation) --- Access the result along with the TransportOperation object
**Yield Parameters**

- **result** ([::Google::Cloud::Dialogflow::CX::V3::GenerativeSettings](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-dialogflow-cx-v3/latest/Google-Cloud-Dialogflow-CX-V3-GenerativeSettings))
- **operation** (::Gapic::Rest::TransportOperation)
**Returns**

- ([::Google::Cloud::Dialogflow::CX::V3::GenerativeSettings](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-dialogflow-cx-v3/latest/Google-Cloud-Dialogflow-CX-V3-GenerativeSettings)) --- A result object deserialized from the server's reply
**Raises**

- (::ArgumentError)

### #list_agents

    def list_agents(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::Dialogflow::CX::V3::ListAgentsResponse

Baseline implementation for the list_agents REST call
**Parameters**

- **request_pb** ([::Google::Cloud::Dialogflow::CX::V3::ListAgentsRequest](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-dialogflow-cx-v3/latest/Google-Cloud-Dialogflow-CX-V3-ListAgentsRequest)) --- A request object representing the call parameters. Required.
- **options** (::Gapic::CallOptions) --- Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
**Yields**

- (result, operation) --- Access the result along with the TransportOperation object
**Yield Parameters**

- **result** ([::Google::Cloud::Dialogflow::CX::V3::ListAgentsResponse](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-dialogflow-cx-v3/latest/Google-Cloud-Dialogflow-CX-V3-ListAgentsResponse))
- **operation** (::Gapic::Rest::TransportOperation)
**Returns**

- ([::Google::Cloud::Dialogflow::CX::V3::ListAgentsResponse](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-dialogflow-cx-v3/latest/Google-Cloud-Dialogflow-CX-V3-ListAgentsResponse)) --- A result object deserialized from the server's reply
**Raises**

- (::ArgumentError)

### #logger

    def logger(stub: false) -> Logger

The logger used for request/response debug logging.
**Returns**

- (Logger)

### #restore_agent

    def restore_agent(request_pb, options = nil) { |result, operation| ... } -> ::Google::Longrunning::Operation

Baseline implementation for the restore_agent REST call
**Parameters**

- **request_pb** ([::Google::Cloud::Dialogflow::CX::V3::RestoreAgentRequest](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-dialogflow-cx-v3/latest/Google-Cloud-Dialogflow-CX-V3-RestoreAgentRequest)) --- A request object representing the call parameters. Required.
- **options** (::Gapic::CallOptions) --- Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
**Yields**

- (result, operation) --- Access the result along with the TransportOperation object
**Yield Parameters**

- **result** ([::Google::Longrunning::Operation](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-dialogflow-cx-v3/latest/Google-Longrunning-Operation))
- **operation** (::Gapic::Rest::TransportOperation)
**Returns**

- ([::Google::Longrunning::Operation](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-dialogflow-cx-v3/latest/Google-Longrunning-Operation)) --- A result object deserialized from the server's reply
**Raises**

- (::ArgumentError)

### #universe_domain

    def universe_domain() -> String

The effective universe domain
**Returns**

- (String)

### #update_agent

    def update_agent(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::Dialogflow::CX::V3::Agent

Baseline implementation for the update_agent REST call
**Parameters**

- **request_pb** ([::Google::Cloud::Dialogflow::CX::V3::UpdateAgentRequest](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-dialogflow-cx-v3/latest/Google-Cloud-Dialogflow-CX-V3-UpdateAgentRequest)) --- A request object representing the call parameters. Required.
- **options** (::Gapic::CallOptions) --- Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
**Yields**

- (result, operation) --- Access the result along with the TransportOperation object
**Yield Parameters**

- **result** ([::Google::Cloud::Dialogflow::CX::V3::Agent](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-dialogflow-cx-v3/latest/Google-Cloud-Dialogflow-CX-V3-Agent))
- **operation** (::Gapic::Rest::TransportOperation)
**Returns**

- ([::Google::Cloud::Dialogflow::CX::V3::Agent](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-dialogflow-cx-v3/latest/Google-Cloud-Dialogflow-CX-V3-Agent)) --- A result object deserialized from the server's reply
**Raises**

- (::ArgumentError)

### #update_generative_settings

    def update_generative_settings(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::Dialogflow::CX::V3::GenerativeSettings

Baseline implementation for the update_generative_settings REST call
**Parameters**

- **request_pb** ([::Google::Cloud::Dialogflow::CX::V3::UpdateGenerativeSettingsRequest](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-dialogflow-cx-v3/latest/Google-Cloud-Dialogflow-CX-V3-UpdateGenerativeSettingsRequest)) --- A request object representing the call parameters. Required.
- **options** (::Gapic::CallOptions) --- Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
**Yields**

- (result, operation) --- Access the result along with the TransportOperation object
**Yield Parameters**

- **result** ([::Google::Cloud::Dialogflow::CX::V3::GenerativeSettings](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-dialogflow-cx-v3/latest/Google-Cloud-Dialogflow-CX-V3-GenerativeSettings))
- **operation** (::Gapic::Rest::TransportOperation)
**Returns**

- ([::Google::Cloud::Dialogflow::CX::V3::GenerativeSettings](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-dialogflow-cx-v3/latest/Google-Cloud-Dialogflow-CX-V3-GenerativeSettings)) --- A result object deserialized from the server's reply
**Raises**

- (::ArgumentError)

### #validate_agent

    def validate_agent(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::Dialogflow::CX::V3::AgentValidationResult

Baseline implementation for the validate_agent REST call
**Parameters**

- **request_pb** ([::Google::Cloud::Dialogflow::CX::V3::ValidateAgentRequest](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-dialogflow-cx-v3/latest/Google-Cloud-Dialogflow-CX-V3-ValidateAgentRequest)) --- A request object representing the call parameters. Required.
- **options** (::Gapic::CallOptions) --- Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
**Yields**

- (result, operation) --- Access the result along with the TransportOperation object
**Yield Parameters**

- **result** ([::Google::Cloud::Dialogflow::CX::V3::AgentValidationResult](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-dialogflow-cx-v3/latest/Google-Cloud-Dialogflow-CX-V3-AgentValidationResult))
- **operation** (::Gapic::Rest::TransportOperation)
**Returns**

- ([::Google::Cloud::Dialogflow::CX::V3::AgentValidationResult](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-dialogflow-cx-v3/latest/Google-Cloud-Dialogflow-CX-V3-AgentValidationResult)) --- A result object deserialized from the server's reply
**Raises**

- (::ArgumentError)