public static final class OpenApiTool.Builder extends GeneratedMessage.Builder<OpenApiTool.Builder> implements OpenApiToolOrBuilderA remote API tool defined by an OpenAPI schema.
Protobuf type google.cloud.ces.v1.OpenApiTool
Inheritance
java.lang.Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessage.Builder > OpenApiTool.BuilderImplements
OpenApiToolOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
Methods
build()
public OpenApiTool build()| Returns | |
|---|---|
| Type | Description |
OpenApiTool |
|
buildPartial()
public OpenApiTool buildPartial()| Returns | |
|---|---|
| Type | Description |
OpenApiTool |
|
clear()
public OpenApiTool.Builder clear()| Returns | |
|---|---|
| Type | Description |
OpenApiTool.Builder |
|
clearApiAuthentication()
public OpenApiTool.Builder clearApiAuthentication()Optional. Authentication information required by the API.
.google.cloud.ces.v1.ApiAuthentication api_authentication = 4 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
OpenApiTool.Builder |
|
clearDescription()
public OpenApiTool.Builder clearDescription() 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 |
OpenApiTool.Builder |
This builder for chaining. |
clearIgnoreUnknownFields()
public OpenApiTool.Builder clearIgnoreUnknownFields()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 |
OpenApiTool.Builder |
This builder for chaining. |
clearName()
public OpenApiTool.Builder clearName() 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 |
OpenApiTool.Builder |
This builder for chaining. |
clearOpenApiSchema()
public OpenApiTool.Builder clearOpenApiSchema()Required. The OpenAPI schema in JSON or YAML format.
string open_api_schema = 1 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
OpenApiTool.Builder |
This builder for chaining. |
clearServiceDirectoryConfig()
public OpenApiTool.Builder clearServiceDirectoryConfig()Optional. Service Directory configuration.
.google.cloud.ces.v1.ServiceDirectoryConfig service_directory_config = 6 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
OpenApiTool.Builder |
|
clearTlsConfig()
public OpenApiTool.Builder clearTlsConfig()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 |
OpenApiTool.Builder |
|
clearUrl()
public OpenApiTool.Builder clearUrl()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 |
OpenApiTool.Builder |
This builder for chaining. |
getApiAuthentication()
public 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. |
getApiAuthenticationBuilder()
public ApiAuthentication.Builder getApiAuthenticationBuilder()Optional. Authentication information required by the API.
.google.cloud.ces.v1.ApiAuthentication api_authentication = 4 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
ApiAuthentication.Builder |
|
getApiAuthenticationOrBuilder()
public 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 |
|
getDefaultInstanceForType()
public OpenApiTool getDefaultInstanceForType()| Returns | |
|---|---|
| Type | Description |
OpenApiTool |
|
getDescription()
public 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 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. |
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
getIgnoreUnknownFields()
public 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 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 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 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 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 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. |
getServiceDirectoryConfigBuilder()
public ServiceDirectoryConfig.Builder getServiceDirectoryConfigBuilder()Optional. Service Directory configuration.
.google.cloud.ces.v1.ServiceDirectoryConfig service_directory_config = 6 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
ServiceDirectoryConfig.Builder |
|
getServiceDirectoryConfigOrBuilder()
public 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 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. |
getTlsConfigBuilder()
public TlsConfig.Builder getTlsConfigBuilder()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.Builder |
|
getTlsConfigOrBuilder()
public 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 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 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 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 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 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. |
internalGetFieldAccessorTable()
protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()| Returns | |
|---|---|
| Type | Description |
FieldAccessorTable |
|
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description |
boolean |
|
mergeApiAuthentication(ApiAuthentication value)
public OpenApiTool.Builder mergeApiAuthentication(ApiAuthentication value)Optional. Authentication information required by the API.
.google.cloud.ces.v1.ApiAuthentication api_authentication = 4 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
ApiAuthentication |
| Returns | |
|---|---|
| Type | Description |
OpenApiTool.Builder |
|
mergeFrom(OpenApiTool other)
public OpenApiTool.Builder mergeFrom(OpenApiTool other)| Parameter | |
|---|---|
| Name | Description |
other |
OpenApiTool |
| Returns | |
|---|---|
| Type | Description |
OpenApiTool.Builder |
|
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public OpenApiTool.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input |
CodedInputStream |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
OpenApiTool.Builder |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
mergeFrom(Message other)
public OpenApiTool.Builder mergeFrom(Message other)| Parameter | |
|---|---|
| Name | Description |
other |
Message |
| Returns | |
|---|---|
| Type | Description |
OpenApiTool.Builder |
|
mergeServiceDirectoryConfig(ServiceDirectoryConfig value)
public OpenApiTool.Builder mergeServiceDirectoryConfig(ServiceDirectoryConfig value)Optional. Service Directory configuration.
.google.cloud.ces.v1.ServiceDirectoryConfig service_directory_config = 6 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
ServiceDirectoryConfig |
| Returns | |
|---|---|
| Type | Description |
OpenApiTool.Builder |
|
mergeTlsConfig(TlsConfig value)
public OpenApiTool.Builder mergeTlsConfig(TlsConfig value)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];
| Parameter | |
|---|---|
| Name | Description |
value |
TlsConfig |
| Returns | |
|---|---|
| Type | Description |
OpenApiTool.Builder |
|
setApiAuthentication(ApiAuthentication value)
public OpenApiTool.Builder setApiAuthentication(ApiAuthentication value)Optional. Authentication information required by the API.
.google.cloud.ces.v1.ApiAuthentication api_authentication = 4 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
ApiAuthentication |
| Returns | |
|---|---|
| Type | Description |
OpenApiTool.Builder |
|
setApiAuthentication(ApiAuthentication.Builder builderForValue)
public OpenApiTool.Builder setApiAuthentication(ApiAuthentication.Builder builderForValue)Optional. Authentication information required by the API.
.google.cloud.ces.v1.ApiAuthentication api_authentication = 4 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
ApiAuthentication.Builder |
| Returns | |
|---|---|
| Type | Description |
OpenApiTool.Builder |
|
setDescription(String value)
public OpenApiTool.Builder setDescription(String value) 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];
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe description to set. |
| Returns | |
|---|---|
| Type | Description |
OpenApiTool.Builder |
This builder for chaining. |
setDescriptionBytes(ByteString value)
public OpenApiTool.Builder setDescriptionBytes(ByteString value) 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];
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for description to set. |
| Returns | |
|---|---|
| Type | Description |
OpenApiTool.Builder |
This builder for chaining. |
setIgnoreUnknownFields(boolean value)
public OpenApiTool.Builder setIgnoreUnknownFields(boolean value)Optional. If true, the agent will ignore unknown fields in the API response.
bool ignore_unknown_fields = 7 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
booleanThe ignoreUnknownFields to set. |
| Returns | |
|---|---|
| Type | Description |
OpenApiTool.Builder |
This builder for chaining. |
setName(String value)
public OpenApiTool.Builder setName(String value) 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];
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe name to set. |
| Returns | |
|---|---|
| Type | Description |
OpenApiTool.Builder |
This builder for chaining. |
setNameBytes(ByteString value)
public OpenApiTool.Builder setNameBytes(ByteString value) 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];
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for name to set. |
| Returns | |
|---|---|
| Type | Description |
OpenApiTool.Builder |
This builder for chaining. |
setOpenApiSchema(String value)
public OpenApiTool.Builder setOpenApiSchema(String value)Required. The OpenAPI schema in JSON or YAML format.
string open_api_schema = 1 [(.google.api.field_behavior) = REQUIRED];
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe openApiSchema to set. |
| Returns | |
|---|---|
| Type | Description |
OpenApiTool.Builder |
This builder for chaining. |
setOpenApiSchemaBytes(ByteString value)
public OpenApiTool.Builder setOpenApiSchemaBytes(ByteString value)Required. The OpenAPI schema in JSON or YAML format.
string open_api_schema = 1 [(.google.api.field_behavior) = REQUIRED];
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for openApiSchema to set. |
| Returns | |
|---|---|
| Type | Description |
OpenApiTool.Builder |
This builder for chaining. |
setServiceDirectoryConfig(ServiceDirectoryConfig value)
public OpenApiTool.Builder setServiceDirectoryConfig(ServiceDirectoryConfig value)Optional. Service Directory configuration.
.google.cloud.ces.v1.ServiceDirectoryConfig service_directory_config = 6 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
ServiceDirectoryConfig |
| Returns | |
|---|---|
| Type | Description |
OpenApiTool.Builder |
|
setServiceDirectoryConfig(ServiceDirectoryConfig.Builder builderForValue)
public OpenApiTool.Builder setServiceDirectoryConfig(ServiceDirectoryConfig.Builder builderForValue)Optional. Service Directory configuration.
.google.cloud.ces.v1.ServiceDirectoryConfig service_directory_config = 6 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
ServiceDirectoryConfig.Builder |
| Returns | |
|---|---|
| Type | Description |
OpenApiTool.Builder |
|
setTlsConfig(TlsConfig value)
public OpenApiTool.Builder setTlsConfig(TlsConfig value)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];
| Parameter | |
|---|---|
| Name | Description |
value |
TlsConfig |
| Returns | |
|---|---|
| Type | Description |
OpenApiTool.Builder |
|
setTlsConfig(TlsConfig.Builder builderForValue)
public OpenApiTool.Builder setTlsConfig(TlsConfig.Builder builderForValue)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];
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
TlsConfig.Builder |
| Returns | |
|---|---|
| Type | Description |
OpenApiTool.Builder |
|
setUrl(String value)
public OpenApiTool.Builder setUrl(String value)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];
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe url to set. |
| Returns | |
|---|---|
| Type | Description |
OpenApiTool.Builder |
This builder for chaining. |
setUrlBytes(ByteString value)
public OpenApiTool.Builder setUrlBytes(ByteString value)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];
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for url to set. |
| Returns | |
|---|---|
| Type | Description |
OpenApiTool.Builder |
This builder for chaining. |