Package org.yamcs.api

Class HttpRoute.Builder

  • All Implemented Interfaces:
    com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable, HttpRouteOrBuilder
    Enclosing class:
    HttpRoute
    public static final class HttpRoute.Builder
extends com.google.protobuf.GeneratedMessageV3.Builder<HttpRoute.Builder>
implements HttpRouteOrBuilder
    Protobuf type yamcs.api.HttpRoute

    • Method Detail

      • 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.Builder<HttpRoute.Builder>

      • clear

        public HttpRoute.Builder clear()
        Specified by:
        clear in interface com.google.protobuf.Message.Builder
        Specified by:
        clear in interface com.google.protobuf.MessageLite.Builder
        Overrides:
        clear in class com.google.protobuf.GeneratedMessageV3.Builder<HttpRoute.Builder>

      • getDescriptorForType

        public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
        Specified by:
        getDescriptorForType in interface com.google.protobuf.Message.Builder
        Specified by:
        getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
        Overrides:
        getDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<HttpRoute.Builder>

      • getDefaultInstanceForType

        public HttpRoute getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

      • build

        public HttpRoute build()
        Specified by:
        build in interface com.google.protobuf.Message.Builder
        Specified by:
        build in interface com.google.protobuf.MessageLite.Builder

      • buildPartial

        public HttpRoute buildPartial()
        Specified by:
        buildPartial in interface com.google.protobuf.Message.Builder
        Specified by:
        buildPartial in interface com.google.protobuf.MessageLite.Builder

      • clone

        public HttpRoute.Builder clone()
        Specified by:
        clone in interface com.google.protobuf.Message.Builder
        Specified by:
        clone in interface com.google.protobuf.MessageLite.Builder
        Overrides:
        clone in class com.google.protobuf.GeneratedMessageV3.Builder<HttpRoute.Builder>

      • setField

        public HttpRoute.Builder setField​(com.google.protobuf.Descriptors.FieldDescriptor field,
                                  Object value)
        Specified by:
        setField in interface com.google.protobuf.Message.Builder
        Overrides:
        setField in class com.google.protobuf.GeneratedMessageV3.Builder<HttpRoute.Builder>

      • clearField

        public HttpRoute.Builder clearField​(com.google.protobuf.Descriptors.FieldDescriptor field)
        Specified by:
        clearField in interface com.google.protobuf.Message.Builder
        Overrides:
        clearField in class com.google.protobuf.GeneratedMessageV3.Builder<HttpRoute.Builder>

      • clearOneof

        public HttpRoute.Builder clearOneof​(com.google.protobuf.Descriptors.OneofDescriptor oneof)
        Specified by:
        clearOneof in interface com.google.protobuf.Message.Builder
        Overrides:
        clearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<HttpRoute.Builder>

      • setRepeatedField

        public HttpRoute.Builder setRepeatedField​(com.google.protobuf.Descriptors.FieldDescriptor field,
                                          int index,
                                          Object value)
        Specified by:
        setRepeatedField in interface com.google.protobuf.Message.Builder
        Overrides:
        setRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<HttpRoute.Builder>

      • addRepeatedField

        public HttpRoute.Builder addRepeatedField​(com.google.protobuf.Descriptors.FieldDescriptor field,
                                          Object value)
        Specified by:
        addRepeatedField in interface com.google.protobuf.Message.Builder
        Overrides:
        addRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<HttpRoute.Builder>

      • mergeFrom

        public HttpRoute.Builder mergeFrom​(com.google.protobuf.Message other)
        Specified by:
        mergeFrom in interface com.google.protobuf.Message.Builder
        Overrides:
        mergeFrom in class com.google.protobuf.AbstractMessage.Builder<HttpRoute.Builder>

      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<HttpRoute.Builder>

      • mergeFrom

        public HttpRoute.Builder mergeFrom​(com.google.protobuf.CodedInputStream input,
                                   com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                            throws IOException
        Specified by:
        mergeFrom in interface com.google.protobuf.Message.Builder
        Specified by:
        mergeFrom in interface com.google.protobuf.MessageLite.Builder
        Overrides:
        mergeFrom in class com.google.protobuf.AbstractMessage.Builder<HttpRoute.Builder>
        Throws:
        IOException

      • hasGet

        public boolean hasGet()
         Maps to HTTP GET. Used for listing and getting information about
 resources.
        string get = 1;
        Specified by:
        hasGet in interface HttpRouteOrBuilder
        Returns:
        Whether the get field is set.

      • getGet

        public String getGet()
         Maps to HTTP GET. Used for listing and getting information about
 resources.
        string get = 1;
        Specified by:
        getGet in interface HttpRouteOrBuilder
        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:
        getGetBytes in interface HttpRouteOrBuilder
        Returns:
        The bytes for get.

      • setGet

        public HttpRoute.Builder setGet​(String value)
         Maps to HTTP GET. Used for listing and getting information about
 resources.
        string get = 1;
        Parameters:
        value - The get to set.
        Returns:
        This builder for chaining.

      • clearGet

        public HttpRoute.Builder clearGet()
         Maps to HTTP GET. Used for listing and getting information about
 resources.
        string get = 1;
        Returns:
        This builder for chaining.

      • setGetBytes

        public HttpRoute.Builder setGetBytes​(com.google.protobuf.ByteString value)
         Maps to HTTP GET. Used for listing and getting information about
 resources.
        string get = 1;
        Parameters:
        value - The bytes for get to set.
        Returns:
        This builder for chaining.

      • hasPut

        public boolean hasPut()
         Maps to HTTP PUT. Used for replacing a resource.
        string put = 2;
        Specified by:
        hasPut in interface HttpRouteOrBuilder
        Returns:
        Whether the put field is set.

      • getPut

        public String getPut()
         Maps to HTTP PUT. Used for replacing a resource.
        string put = 2;
        Specified by:
        getPut in interface HttpRouteOrBuilder
        Returns:
        The put.

      • getPutBytes

        public com.google.protobuf.ByteString getPutBytes()
         Maps to HTTP PUT. Used for replacing a resource.
        string put = 2;
        Specified by:
        getPutBytes in interface HttpRouteOrBuilder
        Returns:
        The bytes for put.

      • setPut

        public HttpRoute.Builder setPut​(String value)
         Maps to HTTP PUT. Used for replacing a resource.
        string put = 2;
        Parameters:
        value - The put to set.
        Returns:
        This builder for chaining.

      • clearPut

        public HttpRoute.Builder clearPut()
         Maps to HTTP PUT. Used for replacing a resource.
        string put = 2;
        Returns:
        This builder for chaining.

      • setPutBytes

        public HttpRoute.Builder setPutBytes​(com.google.protobuf.ByteString value)
         Maps to HTTP PUT. Used for replacing a resource.
        string put = 2;
        Parameters:
        value - The bytes for put to set.
        Returns:
        This builder for chaining.

      • hasPost

        public boolean hasPost()
         Maps to HTTP POST. Used for creating a resource or performing an action.
        string post = 3;
        Specified by:
        hasPost in interface HttpRouteOrBuilder
        Returns:
        Whether the post field is set.

      • getPost

        public String getPost()
         Maps to HTTP POST. Used for creating a resource or performing an action.
        string post = 3;
        Specified by:
        getPost in interface HttpRouteOrBuilder
        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:
        getPostBytes in interface HttpRouteOrBuilder
        Returns:
        The bytes for post.

      • setPost

        public HttpRoute.Builder setPost​(String value)
         Maps to HTTP POST. Used for creating a resource or performing an action.
        string post = 3;
        Parameters:
        value - The post to set.
        Returns:
        This builder for chaining.

      • clearPost

        public HttpRoute.Builder clearPost()
         Maps to HTTP POST. Used for creating a resource or performing an action.
        string post = 3;
        Returns:
        This builder for chaining.

      • setPostBytes

        public HttpRoute.Builder setPostBytes​(com.google.protobuf.ByteString value)
         Maps to HTTP POST. Used for creating a resource or performing an action.
        string post = 3;
        Parameters:
        value - The bytes for post to set.
        Returns:
        This builder for chaining.

      • hasDelete

        public boolean hasDelete()
         Maps to HTTP DELETE. Used for deleting a resource.
        string delete = 4;
        Specified by:
        hasDelete in interface HttpRouteOrBuilder
        Returns:
        Whether the delete field is set.

      • getDelete

        public String getDelete()
         Maps to HTTP DELETE. Used for deleting a resource.
        string delete = 4;
        Specified by:
        getDelete in interface HttpRouteOrBuilder
        Returns:
        The delete.

      • getDeleteBytes

        public com.google.protobuf.ByteString getDeleteBytes()
         Maps to HTTP DELETE. Used for deleting a resource.
        string delete = 4;
        Specified by:
        getDeleteBytes in interface HttpRouteOrBuilder
        Returns:
        The bytes for delete.

      • setDelete

        public HttpRoute.Builder setDelete​(String value)
         Maps to HTTP DELETE. Used for deleting a resource.
        string delete = 4;
        Parameters:
        value - The delete to set.
        Returns:
        This builder for chaining.

      • clearDelete

        public HttpRoute.Builder clearDelete()
         Maps to HTTP DELETE. Used for deleting a resource.
        string delete = 4;
        Returns:
        This builder for chaining.

      • setDeleteBytes

        public HttpRoute.Builder setDeleteBytes​(com.google.protobuf.ByteString value)
         Maps to HTTP DELETE. Used for deleting a resource.
        string delete = 4;
        Parameters:
        value - The bytes for delete to set.
        Returns:
        This builder for chaining.

      • hasPatch

        public boolean hasPatch()
         Maps to HTTP PATCH. Used for updating a resource.
        string patch = 5;
        Specified by:
        hasPatch in interface HttpRouteOrBuilder
        Returns:
        Whether the patch field is set.

      • getPatch

        public String getPatch()
         Maps to HTTP PATCH. Used for updating a resource.
        string patch = 5;
        Specified by:
        getPatch in interface HttpRouteOrBuilder
        Returns:
        The patch.

      • getPatchBytes

        public com.google.protobuf.ByteString getPatchBytes()
         Maps to HTTP PATCH. Used for updating a resource.
        string patch = 5;
        Specified by:
        getPatchBytes in interface HttpRouteOrBuilder
        Returns:
        The bytes for patch.

      • setPatch

        public HttpRoute.Builder setPatch​(String value)
         Maps to HTTP PATCH. Used for updating a resource.
        string patch = 5;
        Parameters:
        value - The patch to set.
        Returns:
        This builder for chaining.

      • clearPatch

        public HttpRoute.Builder clearPatch()
         Maps to HTTP PATCH. Used for updating a resource.
        string patch = 5;
        Returns:
        This builder for chaining.

      • setPatchBytes

        public HttpRoute.Builder setPatchBytes​(com.google.protobuf.ByteString value)
         Maps to HTTP PATCH. Used for updating a resource.
        string patch = 5;
        Parameters:
        value - The bytes for patch to set.
        Returns:
        This builder for chaining.

      • hasDeprecated

        public boolean hasDeprecated()
        optional bool deprecated = 6;
        Specified by:
        hasDeprecated in interface HttpRouteOrBuilder
        Returns:
        Whether the deprecated field is set.

      • getDeprecated

        public boolean getDeprecated()
        optional bool deprecated = 6;
        Specified by:
        getDeprecated in interface HttpRouteOrBuilder
        Returns:
        The deprecated.

      • setDeprecated

        public HttpRoute.Builder setDeprecated​(boolean value)
        optional bool deprecated = 6;
        Parameters:
        value - The deprecated to set.
        Returns:
        This builder for chaining.

      • clearDeprecated

        public HttpRoute.Builder clearDeprecated()
        optional bool deprecated = 6;
        Returns:
        This builder for chaining.

      • 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
        Returns:
        Whether the body field is set.

      • 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
        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:
        getBodyBytes in interface HttpRouteOrBuilder
        Returns:
        The bytes for body.

      • setBody

        public HttpRoute.Builder setBody​(String value)
         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;
        Parameters:
        value - The body to set.
        Returns:
        This builder for chaining.

      • clearBody

        public HttpRoute.Builder clearBody()
         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;
        Returns:
        This builder for chaining.

      • setBodyBytes

        public HttpRoute.Builder setBodyBytes​(com.google.protobuf.ByteString value)
         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;
        Parameters:
        value - The bytes for body to set.
        Returns:
        This builder for chaining.

      • hasMaxBodySize

        public boolean hasMaxBodySize()
        optional int32 max_body_size = 8;
        Specified by:
        hasMaxBodySize in interface HttpRouteOrBuilder
        Returns:
        Whether the maxBodySize field is set.

      • getMaxBodySize

        public int getMaxBodySize()
        optional int32 max_body_size = 8;
        Specified by:
        getMaxBodySize in interface HttpRouteOrBuilder
        Returns:
        The maxBodySize.

      • setMaxBodySize

        public HttpRoute.Builder setMaxBodySize​(int value)
        optional int32 max_body_size = 8;
        Parameters:
        value - The maxBodySize to set.
        Returns:
        This builder for chaining.

      • clearMaxBodySize

        public HttpRoute.Builder clearMaxBodySize()
        optional int32 max_body_size = 8;
        Returns:
        This builder for chaining.

      • 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
        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:
        getOffloaded in interface HttpRouteOrBuilder
        Returns:
        The offloaded.

      • setOffloaded

        public HttpRoute.Builder setOffloaded​(boolean value)
         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;
        Parameters:
        value - The offloaded to set.
        Returns:
        This builder for chaining.

      • clearOffloaded

        public HttpRoute.Builder clearOffloaded()
         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;
        Returns:
        This builder for chaining.

      • 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:
        hasFieldMaskRoot in interface HttpRouteOrBuilder
        Returns:
        Whether the fieldMaskRoot field is set.

      • getFieldMaskRoot

        public String 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:
        getFieldMaskRoot in interface HttpRouteOrBuilder
        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:
        getFieldMaskRootBytes in interface HttpRouteOrBuilder
        Returns:
        The bytes for fieldMaskRoot.

      • setFieldMaskRoot

        public HttpRoute.Builder setFieldMaskRoot​(String value)
         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;
        Parameters:
        value - The fieldMaskRoot to set.
        Returns:
        This builder for chaining.

      • clearFieldMaskRoot

        public HttpRoute.Builder clearFieldMaskRoot()
         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;
        Returns:
        This builder for chaining.

      • setFieldMaskRootBytes

        public HttpRoute.Builder setFieldMaskRootBytes​(com.google.protobuf.ByteString value)
         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;
        Parameters:
        value - The bytes for fieldMaskRoot to set.
        Returns:
        This builder for chaining.

      • setAdditionalBindings

        public HttpRoute.Builder setAdditionalBindings​(int index,
                                               HttpRoute value)
        repeated .yamcs.api.HttpRoute additional_bindings = 11;

      • setAdditionalBindings

        public HttpRoute.Builder setAdditionalBindings​(int index,
                                               HttpRoute.Builder builderForValue)
        repeated .yamcs.api.HttpRoute additional_bindings = 11;

      • addAdditionalBindings

        public HttpRoute.Builder addAdditionalBindings​(HttpRoute value)
        repeated .yamcs.api.HttpRoute additional_bindings = 11;

      • addAdditionalBindings

        public HttpRoute.Builder addAdditionalBindings​(int index,
                                               HttpRoute value)
        repeated .yamcs.api.HttpRoute additional_bindings = 11;

      • addAdditionalBindings

        public HttpRoute.Builder addAdditionalBindings​(int index,
                                               HttpRoute.Builder builderForValue)
        repeated .yamcs.api.HttpRoute additional_bindings = 11;

      • addAllAdditionalBindings

        public HttpRoute.Builder addAllAdditionalBindings​(Iterable<? extends HttpRoute> values)
        repeated .yamcs.api.HttpRoute additional_bindings = 11;

      • clearAdditionalBindings

        public HttpRoute.Builder clearAdditionalBindings()
        repeated .yamcs.api.HttpRoute additional_bindings = 11;

      • removeAdditionalBindings

        public HttpRoute.Builder removeAdditionalBindings​(int index)
        repeated .yamcs.api.HttpRoute additional_bindings = 11;

      • getAdditionalBindingsBuilder

        public HttpRoute.Builder getAdditionalBindingsBuilder​(int index)
        repeated .yamcs.api.HttpRoute additional_bindings = 11;

      • addAdditionalBindingsBuilder

        public HttpRoute.Builder addAdditionalBindingsBuilder()
        repeated .yamcs.api.HttpRoute additional_bindings = 11;

      • addAdditionalBindingsBuilder

        public HttpRoute.Builder addAdditionalBindingsBuilder​(int index)
        repeated .yamcs.api.HttpRoute additional_bindings = 11;

      • getAdditionalBindingsBuilderList

        public List<HttpRoute.Builder> getAdditionalBindingsBuilderList()
        repeated .yamcs.api.HttpRoute additional_bindings = 11;

      • hasLog

        public boolean hasLog()
         Human-friendly log message format.
        optional string log = 12;
        Specified by:
        hasLog in interface HttpRouteOrBuilder
        Returns:
        Whether the log field is set.

      • getLog

        public String getLog()
         Human-friendly log message format.
        optional string log = 12;
        Specified by:
        getLog in interface HttpRouteOrBuilder
        Returns:
        The log.

      • getLogBytes

        public com.google.protobuf.ByteString getLogBytes()
         Human-friendly log message format.
        optional string log = 12;
        Specified by:
        getLogBytes in interface HttpRouteOrBuilder
        Returns:
        The bytes for log.

      • setLog

        public HttpRoute.Builder setLog​(String value)
         Human-friendly log message format.
        optional string log = 12;
        Parameters:
        value - The log to set.
        Returns:
        This builder for chaining.

      • clearLog

        public HttpRoute.Builder clearLog()
         Human-friendly log message format.
        optional string log = 12;
        Returns:
        This builder for chaining.

      • setLogBytes

        public HttpRoute.Builder setLogBytes​(com.google.protobuf.ByteString value)
         Human-friendly log message format.
        optional string log = 12;
        Parameters:
        value - The bytes for log to set.
        Returns:
        This builder for chaining.

      • setUnknownFields

        public final HttpRoute.Builder setUnknownFields​(com.google.protobuf.UnknownFieldSet unknownFields)
        Specified by:
        setUnknownFields in interface com.google.protobuf.Message.Builder
        Overrides:
        setUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<HttpRoute.Builder>

      • mergeUnknownFields

        public final HttpRoute.Builder mergeUnknownFields​(com.google.protobuf.UnknownFieldSet unknownFields)
        Specified by:
        mergeUnknownFields in interface com.google.protobuf.Message.Builder
        Overrides:
        mergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<HttpRoute.Builder>