Gemini Enterprise for Customer Experience V1 API - Class Google::Cloud::Ces::V1::OpenApiTool (v0.1.0)

Reference documentation and code samples for the Gemini Enterprise for Customer Experience V1 API class Google::Cloud::Ces::V1::OpenApiTool.

A remote API tool defined by an OpenAPI schema.

Inherits

• Object

Extended By

• Google::Protobuf::MessageExts::ClassMethods

Includes

• Google::Protobuf::MessageExts

Methods

#api_authentication

def api_authentication() -> ::Google::Cloud::Ces::V1::ApiAuthentication

Returns

• (::Google::Cloud::Ces::V1::ApiAuthentication) — Optional. Authentication information required by the API.

#api_authentication=

def api_authentication=(value) -> ::Google::Cloud::Ces::V1::ApiAuthentication

Parameter

• value (::Google::Cloud::Ces::V1::ApiAuthentication) — Optional. Authentication information required by the API.

Returns

• (::Google::Cloud::Ces::V1::ApiAuthentication) — Optional. Authentication information required by the API.

#description

def description() -> ::String

Returns

• (::String) — Optional. The description of the tool. If not provided, the description of the tool will be derived from the OpenAPI schema, from operation.description or operation.summary.

#description=

def description=(value) -> ::String

Parameter

• value (::String) — Optional. The description of the tool. If not provided, the description of the tool will be derived from the OpenAPI schema, from operation.description or operation.summary.

Returns

• (::String) — Optional. The description of the tool. If not provided, the description of the tool will be derived from the OpenAPI schema, from operation.description or operation.summary.

#ignore_unknown_fields

def ignore_unknown_fields() -> ::Boolean

Returns

• (::Boolean) — Optional. If true, the agent will ignore unknown fields in the API response.

#ignore_unknown_fields=

def ignore_unknown_fields=(value) -> ::Boolean

Parameter

• value (::Boolean) — Optional. If true, the agent will ignore unknown fields in the API response.

Returns

• (::Boolean) — Optional. If true, the agent will ignore unknown fields in the API response.

#name

def name() -> ::String

Returns

• (::String) — Optional. The name of the tool. If not provided, the name of the tool will be derived from the OpenAPI schema, from operation.operationId.

#name=

def name=(value) -> ::String

Parameter

• value (::String) — Optional. The name of the tool. If not provided, the name of the tool will be derived from the OpenAPI schema, from operation.operationId.

Returns

• (::String) — Optional. The name of the tool. If not provided, the name of the tool will be derived from the OpenAPI schema, from operation.operationId.

#open_api_schema

def open_api_schema() -> ::String

Returns

• (::String) — Required. The OpenAPI schema in JSON or YAML format.

#open_api_schema=

def open_api_schema=(value) -> ::String

Parameter

• value (::String) — Required. The OpenAPI schema in JSON or YAML format.

Returns

• (::String) — Required. The OpenAPI schema in JSON or YAML format.

#service_directory_config

def service_directory_config() -> ::Google::Cloud::Ces::V1::ServiceDirectoryConfig

Returns

• (::Google::Cloud::Ces::V1::ServiceDirectoryConfig) — Optional. Service Directory configuration.

#service_directory_config=

def service_directory_config=(value) -> ::Google::Cloud::Ces::V1::ServiceDirectoryConfig

Parameter

• value (::Google::Cloud::Ces::V1::ServiceDirectoryConfig) — Optional. Service Directory configuration.

Returns

• (::Google::Cloud::Ces::V1::ServiceDirectoryConfig) — Optional. Service Directory configuration.

#tls_config

def tls_config() -> ::Google::Cloud::Ces::V1::TlsConfig

Returns

• (::Google::Cloud::Ces::V1::TlsConfig) — Optional. The TLS configuration. Includes the custom server certificates that the client will trust.

#tls_config=

def tls_config=(value) -> ::Google::Cloud::Ces::V1::TlsConfig

Parameter

• value (::Google::Cloud::Ces::V1::TlsConfig) — Optional. The TLS configuration. Includes the custom server certificates that the client will trust.

Returns

• (::Google::Cloud::Ces::V1::TlsConfig) — Optional. The TLS configuration. Includes the custom server certificates that the client will trust.

#url

def url() -> ::String

Returns

• (::String) — Optional. The server URL of the Open API schema. This field is only set in tools in the environment dependencies during the export process if the schema contains a server url. During the import process, if this url is present in the environment dependencies and the schema has the $env_var placeholder, it will replace the placeholder in the schema.

#url=

def url=(value) -> ::String

Parameter

• value (::String) — Optional. The server URL of the Open API schema. This field is only set in tools in the environment dependencies during the export process if the schema contains a server url. During the import process, if this url is present in the environment dependencies and the schema has the $env_var placeholder, it will replace the placeholder in the schema.

Returns

• (::String) — Optional. The server URL of the Open API schema. This field is only set in tools in the environment dependencies during the export process if the schema contains a server url. During the import process, if this url is present in the environment dependencies and the schema has the $env_var placeholder, it will replace the placeholder in the schema.