Google Cloud Ces V1 Client - Class OpenApiTool (0.1.0)

Reference documentation and code samples for the Google Cloud Ces V1 Client class OpenApiTool.

A remote API tool defined by an OpenAPI schema.

Generated from protobuf message google.cloud.ces.v1.OpenApiTool

Namespace

Google \ Cloud \ Ces \ V1

Methods

__construct

Constructor.

Parameters
Name	Description
`data`	`array` Optional. Data for populating the Message object.
`↳ open_api_schema`	`string` Required. The OpenAPI schema in JSON or YAML format.
`↳ name`	`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`.
`↳ description`	`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`.
`↳ api_authentication`	`ApiAuthentication` Optional. Authentication information required by the API.
`↳ tls_config`	`TlsConfig` Optional. The TLS configuration. Includes the custom server certificates that the client will trust.
`↳ service_directory_config`	`ServiceDirectoryConfig` Optional. Service Directory configuration.
`↳ ignore_unknown_fields`	`bool` Optional. If true, the agent will ignore unknown fields in the API response.
`↳ url`	`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.

getOpenApiSchema

Required. The OpenAPI schema in JSON or YAML format.

Returns
Type	Description
`string`

setOpenApiSchema

Required. The OpenAPI schema in JSON or YAML format.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getName

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
Type	Description
`string`

setName

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

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getDescription

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
Type	Description
`string`

setDescription

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.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getApiAuthentication

Optional. Authentication information required by the API.

Returns
Type	Description
`ApiAuthentication\|null`

hasApiAuthentication

clearApiAuthentication

setApiAuthentication

Optional. Authentication information required by the API.

Parameter
Name	Description
`var`	`ApiAuthentication`

Returns
Type	Description
`$this`

getTlsConfig

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

Returns
Type	Description
`TlsConfig\|null`

hasTlsConfig

clearTlsConfig

setTlsConfig

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

Parameter
Name	Description
`var`	`TlsConfig`

Returns
Type	Description
`$this`

getServiceDirectoryConfig

Optional. Service Directory configuration.

Returns
Type	Description
`ServiceDirectoryConfig\|null`

hasServiceDirectoryConfig

clearServiceDirectoryConfig

setServiceDirectoryConfig