Interface OpenApiToolOrBuilder (0.1.0)

public interface OpenApiToolOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getApiAuthentication()

public abstract ApiAuthentication getApiAuthentication()

Optional. Authentication information required by the API.

.google.cloud.ces.v1.ApiAuthentication api_authentication = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ApiAuthentication

The apiAuthentication.

getApiAuthenticationOrBuilder()

public abstract ApiAuthenticationOrBuilder getApiAuthenticationOrBuilder()

Optional. Authentication information required by the API.

.google.cloud.ces.v1.ApiAuthentication api_authentication = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ApiAuthenticationOrBuilder

getDescription()

public abstract String 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 description = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The description.

getDescriptionBytes()

public abstract ByteString getDescriptionBytes()

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 description = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for description.

getIgnoreUnknownFields()

public abstract boolean getIgnoreUnknownFields()

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

bool ignore_unknown_fields = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

The ignoreUnknownFields.

getName()

public abstract String 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 name = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The name.

getNameBytes()

public abstract ByteString getNameBytes()

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 name = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for name.

getOpenApiSchema()

public abstract String getOpenApiSchema()

Required. The OpenAPI schema in JSON or YAML format.

string open_api_schema = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
String

The openApiSchema.

getOpenApiSchemaBytes()

public abstract ByteString getOpenApiSchemaBytes()

Required. The OpenAPI schema in JSON or YAML format.

string open_api_schema = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ByteString

The bytes for openApiSchema.

getServiceDirectoryConfig()

public abstract ServiceDirectoryConfig getServiceDirectoryConfig()

Optional. Service Directory configuration.

.google.cloud.ces.v1.ServiceDirectoryConfig service_directory_config = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ServiceDirectoryConfig

The serviceDirectoryConfig.

getServiceDirectoryConfigOrBuilder()

public abstract ServiceDirectoryConfigOrBuilder getServiceDirectoryConfigOrBuilder()

Optional. Service Directory configuration.

.google.cloud.ces.v1.ServiceDirectoryConfig service_directory_config = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ServiceDirectoryConfigOrBuilder

getTlsConfig()

public abstract TlsConfig getTlsConfig()

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

.google.cloud.ces.v1.TlsConfig tls_config = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
TlsConfig

The tlsConfig.

getTlsConfigOrBuilder()

public abstract TlsConfigOrBuilder getTlsConfigOrBuilder()

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

.google.cloud.ces.v1.TlsConfig tls_config = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
TlsConfigOrBuilder

getUrl()

public abstract String 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 url = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The url.

getUrlBytes()

public abstract ByteString getUrlBytes()

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 url = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for url.

hasApiAuthentication()

public abstract boolean hasApiAuthentication()

Optional. Authentication information required by the API.

.google.cloud.ces.v1.ApiAuthentication api_authentication = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the apiAuthentication field is set.

hasServiceDirectoryConfig()

public abstract boolean hasServiceDirectoryConfig()

Optional. Service Directory configuration.

.google.cloud.ces.v1.ServiceDirectoryConfig service_directory_config = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the serviceDirectoryConfig field is set.

hasTlsConfig()

public abstract boolean hasTlsConfig()

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

.google.cloud.ces.v1.TlsConfig tls_config = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the tlsConfig field is set.