Class OpenApiTool (0.1.0)

public final class OpenApiTool extends GeneratedMessage implements OpenApiToolOrBuilder

A remote API tool defined by an OpenAPI schema.

Protobuf type google.cloud.ces.v1.OpenApiTool

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessage > OpenApiTool

Implements

OpenApiToolOrBuilder

Inherited Members

AbstractMessage.equals(Object)

AbstractMessage.findInitializationErrors()

AbstractMessage.getInitializationErrorString()

AbstractMessage.hashCode()

AbstractMessage.hashFields(int,Map<Descriptors.FieldDescriptor,Object>)

AbstractMessage.newBuilderForType(AbstractMessage.BuilderParent)

AbstractMessage.toString()

AbstractMessageLite.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.checkByteStringIsUtf8(ByteString)

AbstractMessageLite.toByteArray()

AbstractMessageLite.toByteString()

AbstractMessageLite.writeDelimitedTo(OutputStream)

AbstractMessageLite.writeTo(OutputStream)

com.google.protobuf.GeneratedMessage.<ContainingT,T>newFileScopedGeneratedExtension(java.lang.Class<?>,com.google.protobuf.Message)

com.google.protobuf.GeneratedMessage.<ContainingT,T>newMessageScopedGeneratedExtension(com.google.protobuf.Message,int,java.lang.Class<?>,com.google.protobuf.Message)

com.google.protobuf.GeneratedMessage.<ListT>makeMutableCopy(ListT)

com.google.protobuf.GeneratedMessage.<ListT>makeMutableCopy(ListT,int)

GeneratedMessage.<M>parseDelimitedWithIOException(Parser<M>,InputStream)

GeneratedMessage.<M>parseDelimitedWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

GeneratedMessage.<M>parseWithIOException(Parser<M>,CodedInputStream)

GeneratedMessage.<M>parseWithIOException(Parser<M>,CodedInputStream,ExtensionRegistryLite)

GeneratedMessage.<M>parseWithIOException(Parser<M>,InputStream)

GeneratedMessage.<M>parseWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

com.google.protobuf.GeneratedMessage.<T>emptyList(java.lang.Class<T>)

com.google.protobuf.GeneratedMessage.<V>serializeBooleanMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.Boolean,V>,com.google.protobuf.MapEntry<java.lang.Boolean,V>,int)

com.google.protobuf.GeneratedMessage.<V>serializeIntegerMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.Integer,V>,com.google.protobuf.MapEntry<java.lang.Integer,V>,int)

com.google.protobuf.GeneratedMessage.<V>serializeLongMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.Long,V>,com.google.protobuf.MapEntry<java.lang.Long,V>,int)

com.google.protobuf.GeneratedMessage.<V>serializeStringMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.String,V>,com.google.protobuf.MapEntry<java.lang.String,V>,int)

com.google.protobuf.GeneratedMessage.canUseUnsafe()

GeneratedMessage.computeStringSize(int,Object)

GeneratedMessage.computeStringSizeNoTag(Object)

com.google.protobuf.GeneratedMessage.emptyBooleanList()

com.google.protobuf.GeneratedMessage.emptyDoubleList()

com.google.protobuf.GeneratedMessage.emptyFloatList()

com.google.protobuf.GeneratedMessage.emptyIntList()

com.google.protobuf.GeneratedMessage.emptyLongList()

GeneratedMessage.getAllFields()

GeneratedMessage.getDescriptorForType()

GeneratedMessage.getField(Descriptors.FieldDescriptor)

GeneratedMessage.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessage.getParserForType()

GeneratedMessage.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessage.getRepeatedFieldCount(Descriptors.FieldDescriptor)

GeneratedMessage.getSerializedSize()

GeneratedMessage.getUnknownFields()

GeneratedMessage.hasField(Descriptors.FieldDescriptor)

GeneratedMessage.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessage.internalGetFieldAccessorTable()

GeneratedMessage.internalGetMapField(int)

com.google.protobuf.GeneratedMessage.internalGetMapFieldReflection(int)

GeneratedMessage.isInitialized()

com.google.protobuf.GeneratedMessage.isStringEmpty(java.lang.Object)

GeneratedMessage.makeExtensionsImmutable()

com.google.protobuf.GeneratedMessage.mergeFromAndMakeImmutableInternal(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite)

com.google.protobuf.GeneratedMessage.newInstance(com.google.protobuf.GeneratedMessage.UnusedPrivateParameter)

GeneratedMessage.parseUnknownField(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

com.google.protobuf.GeneratedMessage.parseUnknownFieldProto3(com.google.protobuf.CodedInputStream,com.google.protobuf.UnknownFieldSet.Builder,com.google.protobuf.ExtensionRegistryLite,int)

GeneratedMessage.writeReplace()

GeneratedMessage.writeString(CodedOutputStream,int,Object)

GeneratedMessage.writeStringNoTag(CodedOutputStream,Object)

GeneratedMessage.writeTo(CodedOutputStream)

Object.clone()

Object.finalize()

Object.getClass()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Fields

API_AUTHENTICATION_FIELD_NUMBER

public static final int API_AUTHENTICATION_FIELD_NUMBER

Field Value
Type	Description
int

DESCRIPTION_FIELD_NUMBER

public static final int DESCRIPTION_FIELD_NUMBER

Field Value
Type	Description
int

IGNORE_UNKNOWN_FIELDS_FIELD_NUMBER

public static final int IGNORE_UNKNOWN_FIELDS_FIELD_NUMBER

Field Value
Type	Description
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER

Field Value
Type	Description
int

OPEN_API_SCHEMA_FIELD_NUMBER

public static final int OPEN_API_SCHEMA_FIELD_NUMBER

Field Value
Type	Description
int

SERVICE_DIRECTORY_CONFIG_FIELD_NUMBER

public static final int SERVICE_DIRECTORY_CONFIG_FIELD_NUMBER

Field Value
Type	Description
int

TLS_CONFIG_FIELD_NUMBER

public static final int TLS_CONFIG_FIELD_NUMBER

Field Value
Type	Description
int

URL_FIELD_NUMBER

public static final int URL_FIELD_NUMBER

Field Value
Type	Description
int

Static Methods

getDefaultInstance()

public static OpenApiTool getDefaultInstance()

Returns
Type	Description
OpenApiTool

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns
Type	Description
Descriptor

newBuilder()

public static OpenApiTool.Builder newBuilder()

Returns
Type	Description
OpenApiTool.Builder

newBuilder(OpenApiTool prototype)

public static OpenApiTool.Builder newBuilder(OpenApiTool prototype)

Parameter
Name	Description
prototype	OpenApiTool

Returns
Type	Description
OpenApiTool.Builder

parseDelimitedFrom(InputStream input)

public static OpenApiTool parseDelimitedFrom(InputStream input)

Parameter
Name	Description
input	InputStream

Returns
Type	Description
OpenApiTool

Exceptions
Type	Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static OpenApiTool parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	InputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
OpenApiTool

Exceptions
Type	Description
IOException

parseFrom(byte[] data)

public static OpenApiTool parseFrom(byte[] data)

Parameter
Name	Description
data	byte[]

Returns
Type	Description
OpenApiTool

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static OpenApiTool parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
data	byte[]
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
OpenApiTool

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static OpenApiTool parseFrom(ByteString data)

Parameter
Name	Description
data	ByteString

Returns
Type	Description
OpenApiTool

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static OpenApiTool parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
data	ByteString
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
OpenApiTool

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static OpenApiTool parseFrom(CodedInputStream input)

Parameter
Name	Description
input	CodedInputStream

Returns
Type	Description
OpenApiTool

Exceptions
Type	Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static OpenApiTool parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	CodedInputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
OpenApiTool

Exceptions
Type	Description
IOException

parseFrom(InputStream input)

public static OpenApiTool parseFrom(InputStream input)

Parameter
Name	Description
input	InputStream

Returns
Type	Description
OpenApiTool

Exceptions
Type	Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static OpenApiTool parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	InputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
OpenApiTool

Exceptions
Type	Description
IOException

parseFrom(ByteBuffer data)

public static OpenApiTool parseFrom(ByteBuffer data)

Parameter
Name	Description
data	ByteBuffer

Returns
Type	Description
OpenApiTool

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static OpenApiTool parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
data	ByteBuffer
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
OpenApiTool

Exceptions
Type	Description
InvalidProtocolBufferException

parser()

public static Parser<OpenApiTool> parser()

Returns
Type	Description
Parser<OpenApiTool>

Methods

equals(Object obj)

public boolean equals(Object obj)

Parameter
Name	Description
obj	Object

Returns
Type	Description
boolean

Overrides

AbstractMessage.equals(Object other)

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.

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.

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.

getParserForType()

public Parser<OpenApiTool> getParserForType()

Returns
Type	Description
Parser<OpenApiTool>

Overrides

GeneratedMessage.getParserForType()

getSerializedSize()

public int getSerializedSize()

Returns
Type	Description
int

Overrides

GeneratedMessage.getSerializedSize()

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.

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.

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.

hashCode()

public int hashCode()

Returns
Type	Description
int

Overrides

AbstractMessage.hashCode()

internalGetFieldAccessorTable()

protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
FieldAccessorTable

Overrides

GeneratedMessage.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
boolean

Overrides

GeneratedMessage.isInitialized()

newBuilderForType()

public OpenApiTool.Builder newBuilderForType()

Returns
Type	Description
OpenApiTool.Builder

newBuilderForType(AbstractMessage.BuilderParent parent)

protected OpenApiTool.Builder newBuilderForType(AbstractMessage.BuilderParent parent)

Parameter
Name	Description
parent	BuilderParent

Returns
Type	Description
OpenApiTool.Builder

Overrides

AbstractMessage.newBuilderForType(AbstractMessage.BuilderParent parent)

toBuilder()

public OpenApiTool.Builder toBuilder()

Returns
Type	Description
OpenApiTool.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)

Parameter
Name	Description
output	CodedOutputStream

Overrides

GeneratedMessage.writeTo(CodedOutputStream output)

Exceptions
Type	Description
IOException