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 \ V1Methods
__construct
Constructor.
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
↳ tls_config
TlsConfig
Optional. The TLS configuration. Includes the custom server certificates that the client will trust.
↳ service_directory_config
↳ 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.
string
setOpenApiSchema
Required. The OpenAPI schema in JSON or YAML format.
var
string
$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
.
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
.
var
string
$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
.
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
.
var
string
$this
getApiAuthentication
Optional. Authentication information required by the API.
hasApiAuthentication
clearApiAuthentication
setApiAuthentication
Optional. Authentication information required by the API.
$this
getTlsConfig
Optional. The TLS configuration. Includes the custom server certificates that the client will trust.
hasTlsConfig
clearTlsConfig
setTlsConfig
Optional. The TLS configuration. Includes the custom server certificates that the client will trust.
$this
getServiceDirectoryConfig
Optional. Service Directory configuration.
hasServiceDirectoryConfig
clearServiceDirectoryConfig
setServiceDirectoryConfig
Optional. Service Directory configuration.
$this
getIgnoreUnknownFields
Optional. If true, the agent will ignore unknown fields in the API response.
bool
setIgnoreUnknownFields
Optional. If true, the agent will ignore unknown fields in the API response.
var
bool
$this
getUrl
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.
string
setUrl
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.
var
string
$this
