org.yamcs.api

Interface HttpRouteOrBuilder

All Superinterfaces:

com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder

All Known Implementing Classes:

HttpRoute, HttpRoute.Builder

public interface HttpRouteOrBuilder
extends com.google.protobuf.MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
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).
String	getDelete() Maps to HTTP DELETE.
com.google.protobuf.ByteString	getDeleteBytes() Maps to HTTP DELETE.
boolean	getDeprecated() optional bool deprecated = 6;
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).
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.
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.
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.

Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Method Detail

hasGet

boolean hasGet()

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

optional string get = 1;

getGet

String getGet()

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

optional string get = 1;

getGetBytes

com.google.protobuf.ByteString getGetBytes()

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

optional string get = 1;

hasPut

boolean hasPut()

 Maps to HTTP PUT. Used for replacing a resource.
 

optional string put = 2;

getPut

String getPut()

 Maps to HTTP PUT. Used for replacing a resource.
 

optional string put = 2;

getPutBytes

com.google.protobuf.ByteString getPutBytes()

 Maps to HTTP PUT. Used for replacing a resource.
 

optional string put = 2;

hasPost

boolean hasPost()

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

optional string post = 3;

getPost

String getPost()

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

optional string post = 3;

getPostBytes

com.google.protobuf.ByteString getPostBytes()

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

optional string post = 3;

hasDelete

boolean hasDelete()

 Maps to HTTP DELETE. Used for deleting a resource.
 

optional string delete = 4;

getDelete

String getDelete()

 Maps to HTTP DELETE. Used for deleting a resource.
 

optional string delete = 4;

getDeleteBytes

com.google.protobuf.ByteString getDeleteBytes()

 Maps to HTTP DELETE. Used for deleting a resource.
 

optional string delete = 4;

hasPatch

boolean hasPatch()

 Maps to HTTP PATCH. Used for updating a resource.
 

optional string patch = 5;

getPatch

String getPatch()

 Maps to HTTP PATCH. Used for updating a resource.
 

optional string patch = 5;

getPatchBytes

com.google.protobuf.ByteString getPatchBytes()

 Maps to HTTP PATCH. Used for updating a resource.
 

optional string patch = 5;

hasDeprecated

boolean hasDeprecated()

optional bool deprecated = 6;

getDeprecated

boolean getDeprecated()

optional bool deprecated = 6;

hasBody

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;

getBody

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;

getBodyBytes

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;

hasMaxBodySize

boolean hasMaxBodySize()

optional int32 max_body_size = 8;

getMaxBodySize

int getMaxBodySize()

optional int32 max_body_size = 8;

hasOffloaded

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;

getOffloaded

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;

getAdditionalBindingsList

List<HttpRoute> getAdditionalBindingsList()

repeated .yamcs.api.HttpRoute additional_bindings = 11;

getAdditionalBindings

HttpRoute getAdditionalBindings(int index)

repeated .yamcs.api.HttpRoute additional_bindings = 11;

getAdditionalBindingsCount

int getAdditionalBindingsCount()

repeated .yamcs.api.HttpRoute additional_bindings = 11;

getAdditionalBindingsOrBuilderList

List<? extends HttpRouteOrBuilder> getAdditionalBindingsOrBuilderList()

repeated .yamcs.api.HttpRoute additional_bindings = 11;

getAdditionalBindingsOrBuilder

HttpRouteOrBuilder getAdditionalBindingsOrBuilder(int index)

repeated .yamcs.api.HttpRoute additional_bindings = 11;

getPatternCase

HttpRoute.PatternCase getPatternCase()