Class OpenApiTool

A remote API tool defined by an OpenAPI schema.

Inheritance

object

OpenApiTool

Implements

IDirectResponseSchema

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Google.Apis.CustomerEngagementSuite.v1.Data

Assembly: Google.Apis.CustomerEngagementSuite.v1.dll

Syntax

public class OpenApiTool : IDirectResponseSchema

Properties

ApiAuthentication

Optional. Authentication information required by the API.

Declaration

[JsonProperty("apiAuthentication")]
public virtual ApiAuthentication ApiAuthentication { get; set; }

Property Value

Type	Description
ApiAuthentication

Description

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.

Declaration

[JsonProperty("description")]
public virtual string Description { get; set; }

Property Value

Type	Description
string

ETag

The ETag of the item.

Declaration

public virtual string ETag { get; set; }

Property Value

Type	Description
string

IgnoreUnknownFields

Optional. If true, the agent will ignore unknown fields in the API response.

Declaration

[JsonProperty("ignoreUnknownFields")]
public virtual bool? IgnoreUnknownFields { get; set; }

Property Value

Type	Description
bool?

Name

Optional. The name of the tool. If not provided, the name of the tool will be derived from the OpenAPI schema, from operation.operationId.

Declaration

[JsonProperty("name")]
public virtual string Name { get; set; }

Property Value

Type	Description
string

OpenApiSchema

Required. The OpenAPI schema in JSON or YAML format.

Declaration

[JsonProperty("openApiSchema")]
public virtual string OpenApiSchema { get; set; }

Property Value

Type	Description
string

ServiceDirectoryConfig

Optional. Service Directory configuration.

Declaration

[JsonProperty("serviceDirectoryConfig")]
public virtual ServiceDirectoryConfig ServiceDirectoryConfig { get; set; }

Property Value

Type	Description
ServiceDirectoryConfig

TlsConfig

Optional. The TLS configuration. Includes the custom server certificates that the client will trust.

Declaration

[JsonProperty("tlsConfig")]
public virtual TlsConfig TlsConfig { get; set; }

Property Value

Type	Description
TlsConfig

Url

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.

Declaration

[JsonProperty("url")]
public virtual string Url { get; set; }

Property Value

Type	Description
string

Implements

IDirectResponseSchema