Class ApiConfigHandler

  • All Implemented Interfaces:
    ApiConfigHandlerOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable

    public final class ApiConfigHandler
    extends com.google.protobuf.GeneratedMessageV3
    implements ApiConfigHandlerOrBuilder
     [Google Cloud Endpoints](https://cloud.google.com/appengine/docs/python/endpoints/)
     configuration for API handlers.
     
    Protobuf type google.appengine.v1.ApiConfigHandler
    See Also:
    Serialized Form
    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  ApiConfigHandler.Builder
      [Google Cloud Endpoints](https://cloud.google.com/appengine/docs/python/endpoints/) configuration for API handlers.
      • Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

        com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,​BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,​BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter
      • Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

        com.google.protobuf.AbstractMessageLite.InternalOneOfEnum
    • Method Detail

      • newInstance

        protected Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
        Overrides:
        newInstance 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
      • getAuthFailActionValue

        public int getAuthFailActionValue()
         Action to take when users access resources that require
         authentication. Defaults to `redirect`.
         
        .google.appengine.v1.AuthFailAction auth_fail_action = 1;
        Specified by:
        getAuthFailActionValue in interface ApiConfigHandlerOrBuilder
        Returns:
        The enum numeric value on the wire for authFailAction.
      • getAuthFailAction

        public AuthFailAction getAuthFailAction()
         Action to take when users access resources that require
         authentication. Defaults to `redirect`.
         
        .google.appengine.v1.AuthFailAction auth_fail_action = 1;
        Specified by:
        getAuthFailAction in interface ApiConfigHandlerOrBuilder
        Returns:
        The authFailAction.
      • getLoginValue

        public int getLoginValue()
         Level of login required to access this resource. Defaults to
         `optional`.
         
        .google.appengine.v1.LoginRequirement login = 2;
        Specified by:
        getLoginValue in interface ApiConfigHandlerOrBuilder
        Returns:
        The enum numeric value on the wire for login.
      • getLogin

        public LoginRequirement getLogin()
         Level of login required to access this resource. Defaults to
         `optional`.
         
        .google.appengine.v1.LoginRequirement login = 2;
        Specified by:
        getLogin in interface ApiConfigHandlerOrBuilder
        Returns:
        The login.
      • getScript

        public String getScript()
         Path to the script from the application root directory.
         
        string script = 3;
        Specified by:
        getScript in interface ApiConfigHandlerOrBuilder
        Returns:
        The script.
      • getScriptBytes

        public com.google.protobuf.ByteString getScriptBytes()
         Path to the script from the application root directory.
         
        string script = 3;
        Specified by:
        getScriptBytes in interface ApiConfigHandlerOrBuilder
        Returns:
        The bytes for script.
      • getSecurityLevelValue

        public int getSecurityLevelValue()
         Security (HTTPS) enforcement for this URL.
         
        .google.appengine.v1.SecurityLevel security_level = 4;
        Specified by:
        getSecurityLevelValue in interface ApiConfigHandlerOrBuilder
        Returns:
        The enum numeric value on the wire for securityLevel.
      • getUrlBytes

        public com.google.protobuf.ByteString getUrlBytes()
         URL to serve the endpoint at.
         
        string url = 5;
        Specified by:
        getUrlBytes in interface ApiConfigHandlerOrBuilder
        Returns:
        The bytes for url.
      • 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 ApiConfigHandler parseFrom​(ByteBuffer data)
                                          throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

        public static ApiConfigHandler parseFrom​(ByteBuffer data,
                                                 com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                          throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

        public static ApiConfigHandler parseFrom​(com.google.protobuf.ByteString data)
                                          throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

        public static ApiConfigHandler parseFrom​(com.google.protobuf.ByteString data,
                                                 com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                          throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

        public static ApiConfigHandler parseFrom​(byte[] data)
                                          throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

        public static ApiConfigHandler parseFrom​(byte[] data,
                                                 com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                          throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

        public static ApiConfigHandler parseFrom​(com.google.protobuf.CodedInputStream input,
                                                 com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                          throws IOException
        Throws:
        IOException
      • newBuilderForType

        public ApiConfigHandler.Builder newBuilderForType()
        Specified by:
        newBuilderForType in interface com.google.protobuf.Message
        Specified by:
        newBuilderForType in interface com.google.protobuf.MessageLite
      • toBuilder

        public ApiConfigHandler.Builder toBuilder()
        Specified by:
        toBuilder in interface com.google.protobuf.Message
        Specified by:
        toBuilder in interface com.google.protobuf.MessageLite
      • newBuilderForType

        protected ApiConfigHandler.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3
      • getParserForType

        public com.google.protobuf.Parser<ApiConfigHandler> 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 ApiConfigHandler getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder