Package com.google.api

Class AuthenticationRule.Builder

java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<BuilderT>
com.google.protobuf.GeneratedMessageV3.Builder<AuthenticationRule.Builder>
com.google.api.AuthenticationRule.Builder
All Implemented Interfaces:
AuthenticationRuleOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable
Enclosing class:
AuthenticationRule
public static final class AuthenticationRule.Builder extends com.google.protobuf.GeneratedMessageV3.Builder<AuthenticationRule.Builder> 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

  • Method Details

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

    • clear

      public AuthenticationRule.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<AuthenticationRule.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<AuthenticationRule.Builder>

    • getDefaultInstanceForType

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

    • build

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

    • buildPartial

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

    • clone

      public AuthenticationRule.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<AuthenticationRule.Builder>

    • setField

      public AuthenticationRule.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<AuthenticationRule.Builder>

    • clearField

      public AuthenticationRule.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<AuthenticationRule.Builder>

    • clearOneof

      public AuthenticationRule.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<AuthenticationRule.Builder>

    • setRepeatedField

      public AuthenticationRule.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<AuthenticationRule.Builder>

    • addRepeatedField

      public AuthenticationRule.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<AuthenticationRule.Builder>

    • mergeFrom

      public AuthenticationRule.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<AuthenticationRule.Builder>

    • mergeFrom

      public AuthenticationRule.Builder mergeFrom(AuthenticationRule other)

    • isInitialized

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

    • mergeFrom

      public AuthenticationRule.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<AuthenticationRule.Builder>
      Throws:
      IOException

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

    • setSelector

      public AuthenticationRule.Builder setSelector(String value)
       Selects the methods to which this rule applies.

 Refer to [selector][google.api.DocumentationRule.selector] for syntax
 details.
      string selector = 1;
      Parameters:
      value - The selector to set.
      Returns:
      This builder for chaining.

    • clearSelector

      public AuthenticationRule.Builder clearSelector()
       Selects the methods to which this rule applies.

 Refer to [selector][google.api.DocumentationRule.selector] for syntax
 details.
      string selector = 1;
      Returns:
      This builder for chaining.

    • setSelectorBytes

      public AuthenticationRule.Builder setSelectorBytes(com.google.protobuf.ByteString value)
       Selects the methods to which this rule applies.

 Refer to [selector][google.api.DocumentationRule.selector] for syntax
 details.
      string selector = 1;
      Parameters:
      value - The bytes for selector to set.
      Returns:
      This builder for chaining.

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

    • setOauth

      public AuthenticationRule.Builder setOauth(OAuthRequirements value)
       The requirements for OAuth credentials.
      .google.api.OAuthRequirements oauth = 2;

    • setOauth

      public AuthenticationRule.Builder setOauth(OAuthRequirements.Builder builderForValue)
       The requirements for OAuth credentials.
      .google.api.OAuthRequirements oauth = 2;

    • mergeOauth

      public AuthenticationRule.Builder mergeOauth(OAuthRequirements value)
       The requirements for OAuth credentials.
      .google.api.OAuthRequirements oauth = 2;

    • clearOauth

      public AuthenticationRule.Builder clearOauth()
       The requirements for OAuth credentials.
      .google.api.OAuthRequirements oauth = 2;

    • getOauthBuilder

      public OAuthRequirements.Builder getOauthBuilder()
       The requirements for OAuth credentials.
      .google.api.OAuthRequirements oauth = 2;

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

    • setAllowWithoutCredential

      public AuthenticationRule.Builder setAllowWithoutCredential(boolean value)
       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;
      Parameters:
      value - The allowWithoutCredential to set.
      Returns:
      This builder for chaining.

    • clearAllowWithoutCredential

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

    • getRequirementsList

      public List<AuthRequirement> getRequirementsList()
       Requirements for additional authentication providers.
      repeated .google.api.AuthRequirement requirements = 7;
      Specified by:
      getRequirementsList 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

    • setRequirements

      public AuthenticationRule.Builder setRequirements(int index, AuthRequirement value)
       Requirements for additional authentication providers.
      repeated .google.api.AuthRequirement requirements = 7;

    • setRequirements

      public AuthenticationRule.Builder setRequirements(int index, AuthRequirement.Builder builderForValue)
       Requirements for additional authentication providers.
      repeated .google.api.AuthRequirement requirements = 7;

    • addRequirements

      public AuthenticationRule.Builder addRequirements(AuthRequirement value)
       Requirements for additional authentication providers.
      repeated .google.api.AuthRequirement requirements = 7;

    • addRequirements

      public AuthenticationRule.Builder addRequirements(int index, AuthRequirement value)
       Requirements for additional authentication providers.
      repeated .google.api.AuthRequirement requirements = 7;

    • addRequirements

      public AuthenticationRule.Builder addRequirements(AuthRequirement.Builder builderForValue)
       Requirements for additional authentication providers.
      repeated .google.api.AuthRequirement requirements = 7;

    • addRequirements

      public AuthenticationRule.Builder addRequirements(int index, AuthRequirement.Builder builderForValue)
       Requirements for additional authentication providers.
      repeated .google.api.AuthRequirement requirements = 7;

    • addAllRequirements

      public AuthenticationRule.Builder addAllRequirements(Iterable<? extends AuthRequirement> values)
       Requirements for additional authentication providers.
      repeated .google.api.AuthRequirement requirements = 7;

    • clearRequirements

      public AuthenticationRule.Builder clearRequirements()
       Requirements for additional authentication providers.
      repeated .google.api.AuthRequirement requirements = 7;

    • removeRequirements

      public AuthenticationRule.Builder removeRequirements(int index)
       Requirements for additional authentication providers.
      repeated .google.api.AuthRequirement requirements = 7;

    • getRequirementsBuilder

      public AuthRequirement.Builder getRequirementsBuilder(int index)
       Requirements for additional authentication providers.
      repeated .google.api.AuthRequirement requirements = 7;

    • getRequirementsOrBuilder

      public AuthRequirementOrBuilder getRequirementsOrBuilder(int index)
       Requirements for additional authentication providers.
      repeated .google.api.AuthRequirement requirements = 7;
      Specified by:
      getRequirementsOrBuilder 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

    • addRequirementsBuilder

      public AuthRequirement.Builder addRequirementsBuilder()
       Requirements for additional authentication providers.
      repeated .google.api.AuthRequirement requirements = 7;

    • addRequirementsBuilder

      public AuthRequirement.Builder addRequirementsBuilder(int index)
       Requirements for additional authentication providers.
      repeated .google.api.AuthRequirement requirements = 7;

    • getRequirementsBuilderList

      public List<AuthRequirement.Builder> getRequirementsBuilderList()
       Requirements for additional authentication providers.
      repeated .google.api.AuthRequirement requirements = 7;

    • setUnknownFields

      public final AuthenticationRule.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<AuthenticationRule.Builder>

    • mergeUnknownFields

      public final AuthenticationRule.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<AuthenticationRule.Builder>