Package com.google.api

Class AuthenticationRule

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessageV3
com.google.api.AuthenticationRule
All Implemented Interfaces:
AuthenticationRuleOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
public final class AuthenticationRule extends com.google.protobuf.GeneratedMessageV3 implements AuthenticationRuleOrBuilder
 Authentication rules for the service.

 By default, if a method has any authentication requirements, every request
 must include a valid credential matching one of the requirements.
 It's an error to include more than one kind of credential in a single
 request.

 If a method doesn't have any auth requirements, request credentials will be
 ignored.
Protobuf type google.api.AuthenticationRule
See Also:

  • Field Details

    • SELECTOR_FIELD_NUMBER

      public static final int SELECTOR_FIELD_NUMBER
      See Also:

    • OAUTH_FIELD_NUMBER

      public static final int OAUTH_FIELD_NUMBER
      See Also:

    • ALLOW_WITHOUT_CREDENTIAL_FIELD_NUMBER

      public static final int ALLOW_WITHOUT_CREDENTIAL_FIELD_NUMBER
      See Also:

    • REQUIREMENTS_FIELD_NUMBER

      public static final int REQUIREMENTS_FIELD_NUMBER
      See Also:

  • Method Details

    • 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

    • getSelector

      public String getSelector()
       Selects the methods to which this rule applies.

 Refer to [selector][google.api.DocumentationRule.selector] for syntax
 details.
      string selector = 1;
      Specified by:
      getSelector in interface AuthenticationRuleOrBuilder
      Returns:
      The selector.

    • getSelectorBytes

      public com.google.protobuf.ByteString getSelectorBytes()
       Selects the methods to which this rule applies.

 Refer to [selector][google.api.DocumentationRule.selector] for syntax
 details.
      string selector = 1;
      Specified by:
      getSelectorBytes in interface AuthenticationRuleOrBuilder
      Returns:
      The bytes for selector.

    • hasOauth

      public boolean hasOauth()
       The requirements for OAuth credentials.
      .google.api.OAuthRequirements oauth = 2;
      Specified by:
      hasOauth in interface AuthenticationRuleOrBuilder
      Returns:
      Whether the oauth field is set.

    • getOauth

      public OAuthRequirements getOauth()
       The requirements for OAuth credentials.
      .google.api.OAuthRequirements oauth = 2;
      Specified by:
      getOauth in interface AuthenticationRuleOrBuilder
      Returns:
      The oauth.

    • getOauthOrBuilder

      public OAuthRequirementsOrBuilder getOauthOrBuilder()
       The requirements for OAuth credentials.
      .google.api.OAuthRequirements oauth = 2;
      Specified by:
      getOauthOrBuilder in interface AuthenticationRuleOrBuilder

    • getAllowWithoutCredential

      public boolean getAllowWithoutCredential()
       If true, the service accepts API keys without any other credential.
 This flag only applies to HTTP and gRPC requests.
      bool allow_without_credential = 5;
      Specified by:
      getAllowWithoutCredential in interface AuthenticationRuleOrBuilder
      Returns:
      The allowWithoutCredential.

    • getRequirementsList

      public List<AuthRequirement> getRequirementsList()
       Requirements for additional authentication providers.
      repeated .google.api.AuthRequirement requirements = 7;
      Specified by:
      getRequirementsList in interface AuthenticationRuleOrBuilder

    • getRequirementsOrBuilderList

      public List<? extends AuthRequirementOrBuilder> getRequirementsOrBuilderList()
       Requirements for additional authentication providers.
      repeated .google.api.AuthRequirement requirements = 7;
      Specified by:
      getRequirementsOrBuilderList in interface AuthenticationRuleOrBuilder

    • getRequirementsCount

      public int getRequirementsCount()
       Requirements for additional authentication providers.
      repeated .google.api.AuthRequirement requirements = 7;
      Specified by:
      getRequirementsCount in interface AuthenticationRuleOrBuilder

    • getRequirements

      public AuthRequirement getRequirements(int index)
       Requirements for additional authentication providers.
      repeated .google.api.AuthRequirement requirements = 7;
      Specified by:
      getRequirements in interface AuthenticationRuleOrBuilder

    • getRequirementsOrBuilder

      public AuthRequirementOrBuilder getRequirementsOrBuilder(int index)
       Requirements for additional authentication providers.
      repeated .google.api.AuthRequirement requirements = 7;
      Specified by:
      getRequirementsOrBuilder in interface AuthenticationRuleOrBuilder

    • 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 AuthenticationRule parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

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

    • parseFrom

      public static AuthenticationRule parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

      public static AuthenticationRule parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

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

    • parseDelimitedFrom

      public static AuthenticationRule parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

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

    • parseFrom

      public static AuthenticationRule parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

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

    • newBuilderForType

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

    • newBuilder

      public static AuthenticationRule.Builder newBuilder()

    • newBuilder

      public static AuthenticationRule.Builder newBuilder(AuthenticationRule prototype)

    • toBuilder

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

    • newBuilderForType

      protected AuthenticationRule.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
      Specified by:
      newBuilderForType in class com.google.protobuf.GeneratedMessageV3

    • getDefaultInstance

      public static AuthenticationRule getDefaultInstance()

    • parser

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

    • getParserForType

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