Google Cloud Ces V1 Client - Class OpenApiToolset (0.1.0)

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

A toolset that contains a list of tools that are defined by an OpenAPI schema.

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

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 of the toolset.

↳ api_authentication ApiAuthentication

Optional. Authentication information required by the API.

↳ tls_config TlsConfig

Optional. The TLS configuration. Includes the custom server certificates

↳ 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 for all operations defined in the OpenAPI schema.

↳ url string

Optional. The server URL of the Open API schema. This field is only set in toolsets 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 of the toolset.

Returns
Type Description
string

setOpenApiSchema

Required. The OpenAPI schema of the toolset.

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

Returns
Type Description
TlsConfig|null

hasTlsConfig

clearTlsConfig

setTlsConfig

Optional. The TLS configuration. Includes the custom server certificates

Parameter
Name Description
var TlsConfig
Returns
Type Description
$this

getServiceDirectoryConfig

Optional. Service Directory configuration.

Returns
Type Description
ServiceDirectoryConfig|null

hasServiceDirectoryConfig

clearServiceDirectoryConfig

setServiceDirectoryConfig

Optional. Service Directory configuration.

Parameter
Name Description
var ServiceDirectoryConfig
Returns
Type Description
$this

getIgnoreUnknownFields

Optional. If true, the agent will ignore unknown fields in the API response for all operations defined in the OpenAPI schema.

Returns
Type Description
bool

setIgnoreUnknownFields

Optional. If true, the agent will ignore unknown fields in the API response for all operations defined in the OpenAPI schema.

Parameter
Name Description
var bool
Returns
Type Description
$this

getUrl

Optional. The server URL of the Open API schema.

This field is only set in toolsets 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
Type Description
string

setUrl

Optional. The server URL of the Open API schema.

This field is only set in toolsets 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.

Parameter
Name Description
var string
Returns
Type Description
$this