java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
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
@Generated
public final class HttpRoute
extends com.google.protobuf.GeneratedMessage
implements HttpRouteOrBuilder
Protobuf type
yamcs.api.HttpRoute- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic final classProtobuf typeyamcs.api.HttpRoutestatic enumNested classes/interfaces inherited from class com.google.protobuf.GeneratedMessage
com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT, BuilderT>>, com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.FieldAccessorTable, com.google.protobuf.GeneratedMessage.GeneratedExtension<ContainingT extends com.google.protobuf.Message, T>, com.google.protobuf.GeneratedMessage.UnusedPrivateParameter Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessage
com.google.protobuf.AbstractMessage.BuilderParentNested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessageLite.InternalOneOfEnum -
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intFields inherited from class com.google.protobuf.GeneratedMessage
alwaysUseFieldBuilders, loggedPre22TypeNames, unknownFieldsFields inherited from class com.google.protobuf.AbstractMessage
memoizedSizeFields inherited from class com.google.protobuf.AbstractMessageLite
memoizedHashCode -
Method Summary
Modifier and TypeMethodDescriptionbooleangetAdditionalBindings(int index) repeated .yamcs.api.HttpRoute additional_bindings = 11;intrepeated .yamcs.api.HttpRoute additional_bindings = 11;repeated .yamcs.api.HttpRoute additional_bindings = 11;getAdditionalBindingsOrBuilder(int index) repeated .yamcs.api.HttpRoute additional_bindings = 11;List<? extends HttpRouteOrBuilder> repeated .yamcs.api.HttpRoute additional_bindings = 11;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.ByteStringName 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 HttpRouteMaps to HTTP DELETE.com.google.protobuf.ByteStringMaps to HTTP DELETE.booleanoptional bool deprecated = 6;static final com.google.protobuf.Descriptors.Descriptorcom.google.protobuf.Descriptors.DescriptorName of the field in the response message where a user-specified field mask is applied to.com.google.protobuf.ByteStringName of the field in the response message where a user-specified field mask is applied to.getGet()Maps to HTTP GET.com.google.protobuf.ByteStringMaps to HTTP GET.getLabel()Optional method label.com.google.protobuf.ByteStringOptional method label.getLog()Human-friendly log message format.com.google.protobuf.ByteStringHuman-friendly log message format.intoptional int32 max_body_size = 8;booleanSet true if the execution of the route is expected to take a long time (more than 0.5 seconds).com.google.protobuf.Parser<HttpRoute> getPatch()Maps to HTTP PATCH.com.google.protobuf.ByteStringMaps to HTTP PATCH.getPost()Maps to HTTP POST.com.google.protobuf.ByteStringMaps to HTTP POST.getPut()Maps to HTTP PUT.com.google.protobuf.ByteStringMaps to HTTP PUT.intbooleanhasBody()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).booleanMaps to HTTP DELETE.booleanoptional bool deprecated = 6;booleanName of the field in the response message where a user-specified field mask is applied to.booleanhasGet()Maps to HTTP GET.inthashCode()booleanhasLabel()Optional method label.booleanhasLog()Human-friendly log message format.booleanoptional int32 max_body_size = 8;booleanSet true if the execution of the route is expected to take a long time (more than 0.5 seconds).booleanhasPatch()Maps to HTTP PATCH.booleanhasPost()Maps to HTTP POST.booleanhasPut()Maps to HTTP PUT.protected com.google.protobuf.GeneratedMessage.FieldAccessorTablefinal booleanstatic HttpRoute.Builderstatic HttpRoute.BuildernewBuilder(HttpRoute prototype) protected HttpRoute.BuildernewBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent) static HttpRouteparseDelimitedFrom(InputStream input) static HttpRouteparseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static HttpRouteparseFrom(byte[] data) static HttpRouteparseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static HttpRouteparseFrom(com.google.protobuf.ByteString data) static HttpRouteparseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static HttpRouteparseFrom(com.google.protobuf.CodedInputStream input) static HttpRouteparseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static HttpRouteparseFrom(InputStream input) static HttpRouteparseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static HttpRouteparseFrom(ByteBuffer data) static HttpRouteparseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static com.google.protobuf.Parser<HttpRoute> parser()voidwriteTo(com.google.protobuf.CodedOutputStream output) Methods inherited from class com.google.protobuf.GeneratedMessage
computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, newFileScopedGeneratedExtension, newInstance, newMessageScopedGeneratedExtension, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTagMethods inherited from class com.google.protobuf.AbstractMessage
findInitializationErrors, getInitializationErrorString, hashFields, toStringMethods inherited from class com.google.protobuf.AbstractMessageLite
addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeToMethods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, waitMethods inherited from interface com.google.protobuf.MessageLite
toByteArray, toByteString, writeDelimitedTo, writeToMethods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof
-
Field Details
-
GET_FIELD_NUMBER
public static final int GET_FIELD_NUMBER- See Also:
-
PUT_FIELD_NUMBER
public static final int PUT_FIELD_NUMBER- See Also:
-
POST_FIELD_NUMBER
public static final int POST_FIELD_NUMBER- See Also:
-
DELETE_FIELD_NUMBER
public static final int DELETE_FIELD_NUMBER- See Also:
-
PATCH_FIELD_NUMBER
public static final int PATCH_FIELD_NUMBER- See Also:
-
DEPRECATED_FIELD_NUMBER
public static final int DEPRECATED_FIELD_NUMBER- See Also:
-
BODY_FIELD_NUMBER
public static final int BODY_FIELD_NUMBER- See Also:
-
MAX_BODY_SIZE_FIELD_NUMBER
public static final int MAX_BODY_SIZE_FIELD_NUMBER- See Also:
-
OFFLOADED_FIELD_NUMBER
public static final int OFFLOADED_FIELD_NUMBER- See Also:
-
FIELD_MASK_ROOT_FIELD_NUMBER
public static final int FIELD_MASK_ROOT_FIELD_NUMBER- See Also:
-
ADDITIONAL_BINDINGS_FIELD_NUMBER
public static final int ADDITIONAL_BINDINGS_FIELD_NUMBER- See Also:
-
LOG_FIELD_NUMBER
public static final int LOG_FIELD_NUMBER- See Also:
-
LABEL_FIELD_NUMBER
public static final int LABEL_FIELD_NUMBER- See Also:
-
-
Method Details
-
getDescriptor
public static final com.google.protobuf.Descriptors.Descriptor getDescriptor() -
getDescriptorForType
public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()- Specified by:
getDescriptorForTypein interfacecom.google.protobuf.MessageOrBuilder- Overrides:
getDescriptorForTypein classcom.google.protobuf.GeneratedMessage
-
internalGetFieldAccessorTable
protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()- Specified by:
internalGetFieldAccessorTablein classcom.google.protobuf.GeneratedMessage
-
getPatternCase
- Specified by:
getPatternCasein interfaceHttpRouteOrBuilder
-
hasGet
public boolean hasGet()Maps to HTTP GET. Used for listing and getting information about resources.
string get = 1;- Specified by:
hasGetin interfaceHttpRouteOrBuilder- Returns:
- Whether the get field is set.
-
getGet
Maps to HTTP GET. Used for listing and getting information about resources.
string get = 1;- Specified by:
getGetin interfaceHttpRouteOrBuilder- Returns:
- The get.
-
getGetBytes
public com.google.protobuf.ByteString getGetBytes()Maps to HTTP GET. Used for listing and getting information about resources.
string get = 1;- Specified by:
getGetBytesin interfaceHttpRouteOrBuilder- Returns:
- The bytes for get.
-
hasPut
public boolean hasPut()Maps to HTTP PUT. Used for replacing a resource.
string put = 2;- Specified by:
hasPutin interfaceHttpRouteOrBuilder- Returns:
- Whether the put field is set.
-
getPut
Maps to HTTP PUT. Used for replacing a resource.
string put = 2;- Specified by:
getPutin interfaceHttpRouteOrBuilder- Returns:
- The put.
-
getPutBytes
public com.google.protobuf.ByteString getPutBytes()Maps to HTTP PUT. Used for replacing a resource.
string put = 2;- Specified by:
getPutBytesin interfaceHttpRouteOrBuilder- Returns:
- The bytes for put.
-
hasPost
public boolean hasPost()Maps to HTTP POST. Used for creating a resource or performing an action.
string post = 3;- Specified by:
hasPostin interfaceHttpRouteOrBuilder- Returns:
- Whether the post field is set.
-
getPost
Maps to HTTP POST. Used for creating a resource or performing an action.
string post = 3;- Specified by:
getPostin interfaceHttpRouteOrBuilder- Returns:
- The post.
-
getPostBytes
public com.google.protobuf.ByteString getPostBytes()Maps to HTTP POST. Used for creating a resource or performing an action.
string post = 3;- Specified by:
getPostBytesin interfaceHttpRouteOrBuilder- Returns:
- The bytes for post.
-
hasDelete
public boolean hasDelete()Maps to HTTP DELETE. Used for deleting a resource.
string delete = 4;- Specified by:
hasDeletein interfaceHttpRouteOrBuilder- Returns:
- Whether the delete field is set.
-
getDelete
Maps to HTTP DELETE. Used for deleting a resource.
string delete = 4;- Specified by:
getDeletein interfaceHttpRouteOrBuilder- Returns:
- The delete.
-
getDeleteBytes
public com.google.protobuf.ByteString getDeleteBytes()Maps to HTTP DELETE. Used for deleting a resource.
string delete = 4;- Specified by:
getDeleteBytesin interfaceHttpRouteOrBuilder- Returns:
- The bytes for delete.
-
hasPatch
public boolean hasPatch()Maps to HTTP PATCH. Used for updating a resource.
string patch = 5;- Specified by:
hasPatchin interfaceHttpRouteOrBuilder- Returns:
- Whether the patch field is set.
-
getPatch
Maps to HTTP PATCH. Used for updating a resource.
string patch = 5;- Specified by:
getPatchin interfaceHttpRouteOrBuilder- Returns:
- The patch.
-
getPatchBytes
public com.google.protobuf.ByteString getPatchBytes()Maps to HTTP PATCH. Used for updating a resource.
string patch = 5;- Specified by:
getPatchBytesin interfaceHttpRouteOrBuilder- Returns:
- The bytes for patch.
-
hasDeprecated
public boolean hasDeprecated()optional bool deprecated = 6;- Specified by:
hasDeprecatedin interfaceHttpRouteOrBuilder- Returns:
- Whether the deprecated field is set.
-
getDeprecated
public boolean getDeprecated()optional bool deprecated = 6;- Specified by:
getDeprecatedin interfaceHttpRouteOrBuilder- Returns:
- The deprecated.
-
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:
hasBodyin interfaceHttpRouteOrBuilder- Returns:
- Whether the body field is set.
-
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:
getBodyin interfaceHttpRouteOrBuilder- Returns:
- The body.
-
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:
getBodyBytesin interfaceHttpRouteOrBuilder- Returns:
- The bytes for body.
-
hasMaxBodySize
public boolean hasMaxBodySize()optional int32 max_body_size = 8;- Specified by:
hasMaxBodySizein interfaceHttpRouteOrBuilder- Returns:
- Whether the maxBodySize field is set.
-
getMaxBodySize
public int getMaxBodySize()optional int32 max_body_size = 8;- Specified by:
getMaxBodySizein interfaceHttpRouteOrBuilder- Returns:
- The maxBodySize.
-
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:
hasOffloadedin interfaceHttpRouteOrBuilder- Returns:
- Whether the offloaded field is set.
-
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:
getOffloadedin interfaceHttpRouteOrBuilder- Returns:
- The offloaded.
-
hasFieldMaskRoot
public boolean hasFieldMaskRoot()Name of the field in the response message where a user-specified field mask is applied to. If this indicates a repeated field, the field mask is applied to each of those messages. If unspecified, Yamcs will try to derive this itself.
optional string field_mask_root = 10;- Specified by:
hasFieldMaskRootin interfaceHttpRouteOrBuilder- Returns:
- Whether the fieldMaskRoot field is set.
-
getFieldMaskRoot
Name of the field in the response message where a user-specified field mask is applied to. If this indicates a repeated field, the field mask is applied to each of those messages. If unspecified, Yamcs will try to derive this itself.
optional string field_mask_root = 10;- Specified by:
getFieldMaskRootin interfaceHttpRouteOrBuilder- Returns:
- The fieldMaskRoot.
-
getFieldMaskRootBytes
public com.google.protobuf.ByteString getFieldMaskRootBytes()Name of the field in the response message where a user-specified field mask is applied to. If this indicates a repeated field, the field mask is applied to each of those messages. If unspecified, Yamcs will try to derive this itself.
optional string field_mask_root = 10;- Specified by:
getFieldMaskRootBytesin interfaceHttpRouteOrBuilder- Returns:
- The bytes for fieldMaskRoot.
-
getAdditionalBindingsList
repeated .yamcs.api.HttpRoute additional_bindings = 11;- Specified by:
getAdditionalBindingsListin interfaceHttpRouteOrBuilder
-
getAdditionalBindingsOrBuilderList
repeated .yamcs.api.HttpRoute additional_bindings = 11;- Specified by:
getAdditionalBindingsOrBuilderListin interfaceHttpRouteOrBuilder
-
getAdditionalBindingsCount
public int getAdditionalBindingsCount()repeated .yamcs.api.HttpRoute additional_bindings = 11;- Specified by:
getAdditionalBindingsCountin interfaceHttpRouteOrBuilder
-
getAdditionalBindings
repeated .yamcs.api.HttpRoute additional_bindings = 11;- Specified by:
getAdditionalBindingsin interfaceHttpRouteOrBuilder
-
getAdditionalBindingsOrBuilder
repeated .yamcs.api.HttpRoute additional_bindings = 11;- Specified by:
getAdditionalBindingsOrBuilderin interfaceHttpRouteOrBuilder
-
hasLog
public boolean hasLog()Human-friendly log message format.
optional string log = 12;- Specified by:
hasLogin interfaceHttpRouteOrBuilder- Returns:
- Whether the log field is set.
-
getLog
Human-friendly log message format.
optional string log = 12;- Specified by:
getLogin interfaceHttpRouteOrBuilder- Returns:
- The log.
-
getLogBytes
public com.google.protobuf.ByteString getLogBytes()Human-friendly log message format.
optional string log = 12;- Specified by:
getLogBytesin interfaceHttpRouteOrBuilder- Returns:
- The bytes for log.
-
hasLabel
public boolean hasLabel()Optional method label. This is a hint to programs that process proto definitions (example: document generation), intended for when the camel-case method name does not give a good result.
optional string label = 13;- Specified by:
hasLabelin interfaceHttpRouteOrBuilder- Returns:
- Whether the label field is set.
-
getLabel
Optional method label. This is a hint to programs that process proto definitions (example: document generation), intended for when the camel-case method name does not give a good result.
optional string label = 13;- Specified by:
getLabelin interfaceHttpRouteOrBuilder- Returns:
- The label.
-
getLabelBytes
public com.google.protobuf.ByteString getLabelBytes()Optional method label. This is a hint to programs that process proto definitions (example: document generation), intended for when the camel-case method name does not give a good result.
optional string label = 13;- Specified by:
getLabelBytesin interfaceHttpRouteOrBuilder- Returns:
- The bytes for label.
-
isInitialized
public final boolean isInitialized()- Specified by:
isInitializedin interfacecom.google.protobuf.MessageLiteOrBuilder- Overrides:
isInitializedin classcom.google.protobuf.GeneratedMessage
-
writeTo
- Specified by:
writeToin interfacecom.google.protobuf.MessageLite- Overrides:
writeToin classcom.google.protobuf.GeneratedMessage- Throws:
IOException
-
getSerializedSize
public int getSerializedSize()- Specified by:
getSerializedSizein interfacecom.google.protobuf.MessageLite- Overrides:
getSerializedSizein classcom.google.protobuf.GeneratedMessage
-
equals
- Specified by:
equalsin interfacecom.google.protobuf.Message- Overrides:
equalsin classcom.google.protobuf.AbstractMessage
-
hashCode
public int hashCode()- Specified by:
hashCodein interfacecom.google.protobuf.Message- Overrides:
hashCodein classcom.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
- Throws:
IOException
-
parseFrom
public static HttpRoute parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Throws:
IOException
-
parseDelimitedFrom
- Throws:
IOException
-
parseDelimitedFrom
public static HttpRoute parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Throws:
IOException
-
parseFrom
- Throws:
IOException
-
parseFrom
public static HttpRoute parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Throws:
IOException
-
newBuilderForType
- Specified by:
newBuilderForTypein interfacecom.google.protobuf.Message- Specified by:
newBuilderForTypein interfacecom.google.protobuf.MessageLite
-
newBuilder
-
newBuilder
-
toBuilder
- Specified by:
toBuilderin interfacecom.google.protobuf.Message- Specified by:
toBuilderin interfacecom.google.protobuf.MessageLite
-
newBuilderForType
protected HttpRoute.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent) - Overrides:
newBuilderForTypein classcom.google.protobuf.AbstractMessage
-
getDefaultInstance
-
parser
-
getParserForType
- Specified by:
getParserForTypein interfacecom.google.protobuf.Message- Specified by:
getParserForTypein interfacecom.google.protobuf.MessageLite- Overrides:
getParserForTypein classcom.google.protobuf.GeneratedMessage
-
getDefaultInstanceForType
- Specified by:
getDefaultInstanceForTypein interfacecom.google.protobuf.MessageLiteOrBuilder- Specified by:
getDefaultInstanceForTypein interfacecom.google.protobuf.MessageOrBuilder
-