org.yamcs.api

Class HttpRoute

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

org.yamcs.api.HttpRoute

All Implemented Interfaces:

com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable, HttpRouteOrBuilder

public final class HttpRoute
extends com.google.protobuf.GeneratedMessageV3
implements HttpRouteOrBuilder

Protobuf type yamcs.api.HttpRoute

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	HttpRoute.Builder Protobuf type yamcs.api.HttpRoute
static class	HttpRoute.PatternCase

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage,BuilderType extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType,BuilderType>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable

Field Summary

Fields

Modifier and Type	Field and Description
static int	ADDITIONAL_BINDINGS_FIELD_NUMBER
static int	BODY_FIELD_NUMBER
static int	DELETE_FIELD_NUMBER
static int	DEPRECATED_FIELD_NUMBER
static int	GET_FIELD_NUMBER
static int	MAX_BODY_SIZE_FIELD_NUMBER
static int	OFFLOADED_FIELD_NUMBER
static com.google.protobuf.Parser<HttpRoute>	PARSER Deprecated.
static int	PATCH_FIELD_NUMBER
static int	POST_FIELD_NUMBER
static int	PUT_FIELD_NUMBER

Fields inherited from class com.google.protobuf.GeneratedMessageV3

alwaysUseFieldBuilders, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage

memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite

memoizedHashCode

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
HttpRoute	getAdditionalBindings(int index) repeated .yamcs.api.HttpRoute additional_bindings = 11;
int	getAdditionalBindingsCount() repeated .yamcs.api.HttpRoute additional_bindings = 11;
List<HttpRoute>	getAdditionalBindingsList() repeated .yamcs.api.HttpRoute additional_bindings = 11;
HttpRouteOrBuilder	getAdditionalBindingsOrBuilder(int index) repeated .yamcs.api.HttpRoute additional_bindings = 11;
List<? extends HttpRouteOrBuilder>	getAdditionalBindingsOrBuilderList() repeated .yamcs.api.HttpRoute additional_bindings = 11;
String	getBody() Name of the field in the request message that maps to the request body The special value "*" indicates that the request message as a whole represents the body (excepting route params).
com.google.protobuf.ByteString	getBodyBytes() Name of the field in the request message that maps to the request body The special value "*" indicates that the request message as a whole represents the body (excepting route params).
static HttpRoute	getDefaultInstance()
HttpRoute	getDefaultInstanceForType()
String	getDelete() Maps to HTTP DELETE.
com.google.protobuf.ByteString	getDeleteBytes() Maps to HTTP DELETE.
boolean	getDeprecated() optional bool deprecated = 6;
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
String	getGet() Maps to HTTP GET.
com.google.protobuf.ByteString	getGetBytes() Maps to HTTP GET.
int	getMaxBodySize() optional int32 max_body_size = 8;
boolean	getOffloaded() Set true if the execution of the route is expected to take a long time (more than 0.5 seconds).
com.google.protobuf.Parser<HttpRoute>	getParserForType()
String	getPatch() Maps to HTTP PATCH.
com.google.protobuf.ByteString	getPatchBytes() Maps to HTTP PATCH.
HttpRoute.PatternCase	getPatternCase()
String	getPost() Maps to HTTP POST.
com.google.protobuf.ByteString	getPostBytes() Maps to HTTP POST.
String	getPut() Maps to HTTP PUT.
com.google.protobuf.ByteString	getPutBytes() Maps to HTTP PUT.
int	getSerializedSize()
com.google.protobuf.UnknownFieldSet	getUnknownFields()
boolean	hasBody() Name of the field in the request message that maps to the request body The special value "*" indicates that the request message as a whole represents the body (excepting route params).
boolean	hasDelete() Maps to HTTP DELETE.
boolean	hasDeprecated() optional bool deprecated = 6;
boolean	hasGet() Maps to HTTP GET.
int	hashCode()
boolean	hasMaxBodySize() optional int32 max_body_size = 8;
boolean	hasOffloaded() Set true if the execution of the route is expected to take a long time (more than 0.5 seconds).
boolean	hasPatch() Maps to HTTP PATCH.
boolean	hasPost() Maps to HTTP POST.
boolean	hasPut() Maps to HTTP PUT.
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
static HttpRoute.Builder	newBuilder()
static HttpRoute.Builder	newBuilder(HttpRoute prototype)
HttpRoute.Builder	newBuilderForType()
protected HttpRoute.Builder	newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
static HttpRoute	parseDelimitedFrom(InputStream input)
static HttpRoute	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static HttpRoute	parseFrom(byte[] data)
static HttpRoute	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static HttpRoute	parseFrom(ByteBuffer data)
static HttpRoute	parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static HttpRoute	parseFrom(com.google.protobuf.ByteString data)
static HttpRoute	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static HttpRoute	parseFrom(com.google.protobuf.CodedInputStream input)
static HttpRoute	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static HttpRoute	parseFrom(InputStream input)
static HttpRoute	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<HttpRoute>	parser()
HttpRoute.Builder	toBuilder()
void	writeTo(com.google.protobuf.CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessageV3

canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof, internalGetMapField, makeExtensionsImmutable, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

Methods inherited from class com.google.protobuf.AbstractMessage

findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite

addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Field Detail

GET_FIELD_NUMBER

public static final int GET_FIELD_NUMBER

See Also:

Constant Field Values

PUT_FIELD_NUMBER

public static final int PUT_FIELD_NUMBER

See Also:

Constant Field Values

POST_FIELD_NUMBER

public static final int POST_FIELD_NUMBER

See Also:

Constant Field Values

DELETE_FIELD_NUMBER

public static final int DELETE_FIELD_NUMBER

See Also:

Constant Field Values

PATCH_FIELD_NUMBER

public static final int PATCH_FIELD_NUMBER

See Also:

Constant Field Values

DEPRECATED_FIELD_NUMBER

public static final int DEPRECATED_FIELD_NUMBER

See Also:

Constant Field Values

BODY_FIELD_NUMBER

public static final int BODY_FIELD_NUMBER

See Also:

Constant Field Values

MAX_BODY_SIZE_FIELD_NUMBER

public static final int MAX_BODY_SIZE_FIELD_NUMBER

See Also:

Constant Field Values

OFFLOADED_FIELD_NUMBER

public static final int OFFLOADED_FIELD_NUMBER

See Also:

Constant Field Values

ADDITIONAL_BINDINGS_FIELD_NUMBER

public static final int ADDITIONAL_BINDINGS_FIELD_NUMBER

See Also:

Constant Field Values

PARSER

@Deprecated
public static final com.google.protobuf.Parser<HttpRoute> PARSER

Deprecated.

Method Detail

getUnknownFields

public final com.google.protobuf.UnknownFieldSet getUnknownFields()

Specified by:

getUnknownFields in interface com.google.protobuf.MessageOrBuilder

Overrides:

getUnknownFields in class com.google.protobuf.GeneratedMessageV3

getDescriptor

public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

internalGetFieldAccessorTable

protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

getPatternCase

public HttpRoute.PatternCase getPatternCase()

Specified by:

getPatternCase in interface HttpRouteOrBuilder

hasGet

public boolean hasGet()

 Maps to HTTP GET. Used for listing and getting information about
 resources.
 

optional string get = 1;

Specified by:

hasGet in interface HttpRouteOrBuilder

getGet

public String getGet()

 Maps to HTTP GET. Used for listing and getting information about
 resources.
 

optional string get = 1;

Specified by:

getGet in interface HttpRouteOrBuilder

getGetBytes

public com.google.protobuf.ByteString getGetBytes()

 Maps to HTTP GET. Used for listing and getting information about
 resources.
 

optional string get = 1;

Specified by:

getGetBytes in interface HttpRouteOrBuilder

hasPut

public boolean hasPut()

 Maps to HTTP PUT. Used for replacing a resource.
 

optional string put = 2;

Specified by:

hasPut in interface HttpRouteOrBuilder

getPut

public String getPut()

 Maps to HTTP PUT. Used for replacing a resource.
 

optional string put = 2;

Specified by:

getPut in interface HttpRouteOrBuilder

getPutBytes

public com.google.protobuf.ByteString getPutBytes()

 Maps to HTTP PUT. Used for replacing a resource.
 

optional string put = 2;

Specified by:

getPutBytes in interface HttpRouteOrBuilder

hasPost

public boolean hasPost()

 Maps to HTTP POST. Used for creating a resource or performing an action.
 

optional string post = 3;

Specified by:

hasPost in interface HttpRouteOrBuilder

getPost

public String getPost()

 Maps to HTTP POST. Used for creating a resource or performing an action.
 

optional string post = 3;

Specified by:

getPost in interface HttpRouteOrBuilder

getPostBytes

public com.google.protobuf.ByteString getPostBytes()

 Maps to HTTP POST. Used for creating a resource or performing an action.
 

optional string post = 3;

Specified by:

getPostBytes in interface HttpRouteOrBuilder

hasDelete

public boolean hasDelete()

 Maps to HTTP DELETE. Used for deleting a resource.
 

optional string delete = 4;

Specified by:

hasDelete in interface HttpRouteOrBuilder

getDelete

public String getDelete()

 Maps to HTTP DELETE. Used for deleting a resource.
 

optional string delete = 4;

Specified by:

getDelete in interface HttpRouteOrBuilder

getDeleteBytes

public com.google.protobuf.ByteString getDeleteBytes()

 Maps to HTTP DELETE. Used for deleting a resource.
 

optional string delete = 4;

Specified by:

getDeleteBytes in interface HttpRouteOrBuilder

hasPatch

public boolean hasPatch()

 Maps to HTTP PATCH. Used for updating a resource.
 

optional string patch = 5;

Specified by:

hasPatch in interface HttpRouteOrBuilder

getPatch

public String getPatch()

 Maps to HTTP PATCH. Used for updating a resource.
 

optional string patch = 5;

Specified by:

getPatch in interface HttpRouteOrBuilder

getPatchBytes

public com.google.protobuf.ByteString getPatchBytes()

 Maps to HTTP PATCH. Used for updating a resource.
 

optional string patch = 5;

Specified by:

getPatchBytes in interface HttpRouteOrBuilder

hasDeprecated

public boolean hasDeprecated()

optional bool deprecated = 6;

Specified by:

hasDeprecated in interface HttpRouteOrBuilder

getDeprecated

public boolean getDeprecated()

optional bool deprecated = 6;

Specified by:

getDeprecated in interface HttpRouteOrBuilder

hasBody

public boolean hasBody()

 Name of the field in the request message that maps to the request body
 The special value "*" indicates that the request message as a whole
 represents the body (excepting route params).
 

optional string body = 7;

Specified by:

hasBody in interface HttpRouteOrBuilder

getBody

public String getBody()

 Name of the field in the request message that maps to the request body
 The special value "*" indicates that the request message as a whole
 represents the body (excepting route params).
 

optional string body = 7;

Specified by:

getBody in interface HttpRouteOrBuilder

getBodyBytes

public com.google.protobuf.ByteString getBodyBytes()

 Name of the field in the request message that maps to the request body
 The special value "*" indicates that the request message as a whole
 represents the body (excepting route params).
 

optional string body = 7;

Specified by:

getBodyBytes in interface HttpRouteOrBuilder

hasMaxBodySize

public boolean hasMaxBodySize()

optional int32 max_body_size = 8;

Specified by:

hasMaxBodySize in interface HttpRouteOrBuilder

getMaxBodySize

public int getMaxBodySize()

optional int32 max_body_size = 8;

Specified by:

getMaxBodySize in interface HttpRouteOrBuilder

hasOffloaded

public boolean hasOffloaded()

 Set true if the execution of the route is expected to take a long time
 (more than 0.5 seconds). It will be offloaded to a worker thread.
 Leave false if the route uses its own threading mechanism (most of the
 routes should do that).
 

optional bool offloaded = 9;

Specified by:

hasOffloaded in interface HttpRouteOrBuilder

getOffloaded

public boolean getOffloaded()

 Set true if the execution of the route is expected to take a long time
 (more than 0.5 seconds). It will be offloaded to a worker thread.
 Leave false if the route uses its own threading mechanism (most of the
 routes should do that).
 

optional bool offloaded = 9;

Specified by:

getOffloaded in interface HttpRouteOrBuilder

getAdditionalBindingsList

public List<HttpRoute> getAdditionalBindingsList()

repeated .yamcs.api.HttpRoute additional_bindings = 11;

Specified by:

getAdditionalBindingsList in interface HttpRouteOrBuilder

getAdditionalBindingsOrBuilderList

public List<? extends HttpRouteOrBuilder> getAdditionalBindingsOrBuilderList()

repeated .yamcs.api.HttpRoute additional_bindings = 11;

Specified by:

getAdditionalBindingsOrBuilderList in interface HttpRouteOrBuilder

getAdditionalBindingsCount

public int getAdditionalBindingsCount()

repeated .yamcs.api.HttpRoute additional_bindings = 11;

Specified by:

getAdditionalBindingsCount in interface HttpRouteOrBuilder

getAdditionalBindings

public HttpRoute getAdditionalBindings(int index)

repeated .yamcs.api.HttpRoute additional_bindings = 11;

Specified by:

getAdditionalBindings in interface HttpRouteOrBuilder

getAdditionalBindingsOrBuilder

public HttpRouteOrBuilder getAdditionalBindingsOrBuilder(int index)

repeated .yamcs.api.HttpRoute additional_bindings = 11;

Specified by:

getAdditionalBindingsOrBuilder in interface HttpRouteOrBuilder

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3

writeTo

public void writeTo(com.google.protobuf.CodedOutputStream output)
             throws IOException

Specified by:

writeTo in interface com.google.protobuf.MessageLite

Overrides:

writeTo in class com.google.protobuf.GeneratedMessageV3

Throws:

IOException

getSerializedSize

public int getSerializedSize()

Specified by:

getSerializedSize in interface com.google.protobuf.MessageLite

Overrides:

getSerializedSize in class com.google.protobuf.GeneratedMessageV3

equals

public boolean equals(Object obj)

Specified by:

equals in interface com.google.protobuf.Message

Overrides:

equals in class com.google.protobuf.AbstractMessage

hashCode

public int hashCode()

Specified by:

hashCode in interface com.google.protobuf.Message

Overrides:

hashCode in class com.google.protobuf.AbstractMessage

parseFrom

public static HttpRoute parseFrom(ByteBuffer data)
                           throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static HttpRoute parseFrom(ByteBuffer data,
                                  com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                           throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static HttpRoute parseFrom(com.google.protobuf.ByteString data)
                           throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static HttpRoute parseFrom(com.google.protobuf.ByteString data,
                                  com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                           throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static HttpRoute parseFrom(byte[] data)
                           throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static HttpRoute parseFrom(byte[] data,
                                  com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                           throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static HttpRoute parseFrom(InputStream input)
                           throws IOException

Throws:

IOException

parseFrom

public static HttpRoute parseFrom(InputStream input,
                                  com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                           throws IOException

Throws:

IOException

parseDelimitedFrom

public static HttpRoute parseDelimitedFrom(InputStream input)
                                    throws IOException

Throws:

IOException

parseDelimitedFrom

public static HttpRoute parseDelimitedFrom(InputStream input,
                                           com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                    throws IOException

Throws:

IOException

parseFrom

public static HttpRoute parseFrom(com.google.protobuf.CodedInputStream input)
                           throws IOException

Throws:

IOException

parseFrom

public static HttpRoute parseFrom(com.google.protobuf.CodedInputStream input,
                                  com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                           throws IOException

Throws:

IOException

newBuilderForType

public HttpRoute.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static HttpRoute.Builder newBuilder()

newBuilder

public static HttpRoute.Builder newBuilder(HttpRoute prototype)

toBuilder

public HttpRoute.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

protected HttpRoute.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)

Specified by:

newBuilderForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstance

public static HttpRoute getDefaultInstance()

parser

public static com.google.protobuf.Parser<HttpRoute> parser()

getParserForType

public com.google.protobuf.Parser<HttpRoute> getParserForType()

Specified by:

getParserForType in interface com.google.protobuf.Message

Specified by:

getParserForType in interface com.google.protobuf.MessageLite

Overrides:

getParserForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstanceForType

public HttpRoute getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder