Package com.google.api
Class AuthenticationRule.Builder
- java.lang.Object
-
- com.google.protobuf.AbstractMessageLite.Builder
-
- com.google.protobuf.AbstractMessage.Builder<BuilderT>
-
- com.google.protobuf.GeneratedMessage.Builder<BuilderT>
-
- com.google.protobuf.GeneratedMessage.ExtendableBuilder<com.google.protobuf.GeneratedMessageV3,BuilderT>
-
- com.google.protobuf.GeneratedMessageV3.Builder<AuthenticationRule.Builder>
-
- com.google.api.AuthenticationRule.Builder
-
- All Implemented Interfaces:
AuthenticationRuleOrBuilder
,com.google.protobuf.GeneratedMessage.ExtendableMessageOrBuilder<com.google.protobuf.GeneratedMessageV3>
,com.google.protobuf.Message.Builder
,com.google.protobuf.MessageLite.Builder
,com.google.protobuf.MessageLiteOrBuilder
,com.google.protobuf.MessageOrBuilder
,java.lang.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 typegoogle.api.AuthenticationRule
-
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description AuthenticationRule.Builder
addAllRequirements(java.lang.Iterable<? extends AuthRequirement> values)
Requirements for additional authentication providers.AuthenticationRule.Builder
addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, java.lang.Object value)
AuthenticationRule.Builder
addRequirements(int index, AuthRequirement value)
Requirements for additional authentication providers.AuthenticationRule.Builder
addRequirements(int index, AuthRequirement.Builder builderForValue)
Requirements for additional authentication providers.AuthenticationRule.Builder
addRequirements(AuthRequirement value)
Requirements for additional authentication providers.AuthenticationRule.Builder
addRequirements(AuthRequirement.Builder builderForValue)
Requirements for additional authentication providers.AuthRequirement.Builder
addRequirementsBuilder()
Requirements for additional authentication providers.AuthRequirement.Builder
addRequirementsBuilder(int index)
Requirements for additional authentication providers.AuthenticationRule
build()
AuthenticationRule
buildPartial()
AuthenticationRule.Builder
clear()
AuthenticationRule.Builder
clearAllowWithoutCredential()
If true, the service accepts API keys without any other credential.AuthenticationRule.Builder
clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
AuthenticationRule.Builder
clearOauth()
The requirements for OAuth credentials.AuthenticationRule.Builder
clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
AuthenticationRule.Builder
clearRequirements()
Requirements for additional authentication providers.AuthenticationRule.Builder
clearSelector()
Selects the methods to which this rule applies.AuthenticationRule.Builder
clone()
boolean
getAllowWithoutCredential()
If true, the service accepts API keys without any other credential.AuthenticationRule
getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor
getDescriptor()
com.google.protobuf.Descriptors.Descriptor
getDescriptorForType()
OAuthRequirements
getOauth()
The requirements for OAuth credentials.OAuthRequirements.Builder
getOauthBuilder()
The requirements for OAuth credentials.OAuthRequirementsOrBuilder
getOauthOrBuilder()
The requirements for OAuth credentials.AuthRequirement
getRequirements(int index)
Requirements for additional authentication providers.AuthRequirement.Builder
getRequirementsBuilder(int index)
Requirements for additional authentication providers.java.util.List<AuthRequirement.Builder>
getRequirementsBuilderList()
Requirements for additional authentication providers.int
getRequirementsCount()
Requirements for additional authentication providers.java.util.List<AuthRequirement>
getRequirementsList()
Requirements for additional authentication providers.AuthRequirementOrBuilder
getRequirementsOrBuilder(int index)
Requirements for additional authentication providers.java.util.List<? extends AuthRequirementOrBuilder>
getRequirementsOrBuilderList()
Requirements for additional authentication providers.java.lang.String
getSelector()
Selects the methods to which this rule applies.com.google.protobuf.ByteString
getSelectorBytes()
Selects the methods to which this rule applies.boolean
hasOauth()
The requirements for OAuth credentials.protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable
internalGetFieldAccessorTable()
boolean
isInitialized()
AuthenticationRule.Builder
mergeFrom(AuthenticationRule other)
AuthenticationRule.Builder
mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
AuthenticationRule.Builder
mergeFrom(com.google.protobuf.Message other)
AuthenticationRule.Builder
mergeOauth(OAuthRequirements value)
The requirements for OAuth credentials.AuthenticationRule.Builder
mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
AuthenticationRule.Builder
removeRequirements(int index)
Requirements for additional authentication providers.AuthenticationRule.Builder
setAllowWithoutCredential(boolean value)
If true, the service accepts API keys without any other credential.AuthenticationRule.Builder
setField(com.google.protobuf.Descriptors.FieldDescriptor field, java.lang.Object value)
AuthenticationRule.Builder
setOauth(OAuthRequirements value)
The requirements for OAuth credentials.AuthenticationRule.Builder
setOauth(OAuthRequirements.Builder builderForValue)
The requirements for OAuth credentials.AuthenticationRule.Builder
setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, java.lang.Object value)
AuthenticationRule.Builder
setRequirements(int index, AuthRequirement value)
Requirements for additional authentication providers.AuthenticationRule.Builder
setRequirements(int index, AuthRequirement.Builder builderForValue)
Requirements for additional authentication providers.AuthenticationRule.Builder
setSelector(java.lang.String value)
Selects the methods to which this rule applies.AuthenticationRule.Builder
setSelectorBytes(com.google.protobuf.ByteString value)
Selects the methods to which this rule applies.AuthenticationRule.Builder
setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
-
Methods inherited from class com.google.protobuf.GeneratedMessage.ExtendableBuilder
addExtension, clearExtension, extensionsAreInitialized, getAllFields, getExtension, getExtension, getExtensionCount, getField, getFieldBuilder, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, hasExtension, hasField, mergeExtensionFields, newBuilderForField, parseUnknownField, setExtension, setExtension
-
Methods inherited from class com.google.protobuf.GeneratedMessage.Builder
getOneofFieldDescriptor, getUnknownFields, getUnknownFieldSetBuilder, hasOneof, internalGetMapField, internalGetMapFieldReflection, internalGetMutableMapField, internalGetMutableMapFieldReflection, isClean, markClean, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, onBuilt, onChanged, setUnknownFieldSetBuilder, setUnknownFieldsProto3
-
Methods inherited from class com.google.protobuf.AbstractMessage.Builder
findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toString
-
Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder
addAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, newUninitializedMessageException
-
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
-
-
-
-
Method Detail
-
getDescriptor
public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
-
internalGetFieldAccessorTable
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
- Overrides:
internalGetFieldAccessorTable
in classcom.google.protobuf.GeneratedMessageV3.Builder<AuthenticationRule.Builder>
-
clear
public AuthenticationRule.Builder clear()
- Specified by:
clear
in interfacecom.google.protobuf.Message.Builder
- Specified by:
clear
in interfacecom.google.protobuf.MessageLite.Builder
- Overrides:
clear
in classcom.google.protobuf.GeneratedMessageV3.Builder<AuthenticationRule.Builder>
-
getDescriptorForType
public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
- Specified by:
getDescriptorForType
in interfacecom.google.protobuf.Message.Builder
- Specified by:
getDescriptorForType
in interfacecom.google.protobuf.MessageOrBuilder
- Overrides:
getDescriptorForType
in classcom.google.protobuf.GeneratedMessage.Builder<AuthenticationRule.Builder>
-
getDefaultInstanceForType
public AuthenticationRule getDefaultInstanceForType()
- Specified by:
getDefaultInstanceForType
in interfacecom.google.protobuf.GeneratedMessage.ExtendableMessageOrBuilder<com.google.protobuf.GeneratedMessageV3>
- Specified by:
getDefaultInstanceForType
in interfacecom.google.protobuf.MessageLiteOrBuilder
- Specified by:
getDefaultInstanceForType
in interfacecom.google.protobuf.MessageOrBuilder
-
build
public AuthenticationRule build()
- Specified by:
build
in interfacecom.google.protobuf.Message.Builder
- Specified by:
build
in interfacecom.google.protobuf.MessageLite.Builder
-
buildPartial
public AuthenticationRule buildPartial()
- Specified by:
buildPartial
in interfacecom.google.protobuf.Message.Builder
- Specified by:
buildPartial
in interfacecom.google.protobuf.MessageLite.Builder
-
clone
public AuthenticationRule.Builder clone()
- Specified by:
clone
in interfacecom.google.protobuf.Message.Builder
- Specified by:
clone
in interfacecom.google.protobuf.MessageLite.Builder
- Overrides:
clone
in classcom.google.protobuf.GeneratedMessageV3.Builder<AuthenticationRule.Builder>
-
setField
public AuthenticationRule.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field, java.lang.Object value)
- Specified by:
setField
in interfacecom.google.protobuf.Message.Builder
- Overrides:
setField
in classcom.google.protobuf.GeneratedMessageV3.Builder<AuthenticationRule.Builder>
-
clearField
public AuthenticationRule.Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
- Specified by:
clearField
in interfacecom.google.protobuf.Message.Builder
- Overrides:
clearField
in classcom.google.protobuf.GeneratedMessageV3.Builder<AuthenticationRule.Builder>
-
clearOneof
public AuthenticationRule.Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
- Specified by:
clearOneof
in interfacecom.google.protobuf.Message.Builder
- Overrides:
clearOneof
in classcom.google.protobuf.GeneratedMessageV3.Builder<AuthenticationRule.Builder>
-
setRepeatedField
public AuthenticationRule.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, java.lang.Object value)
- Specified by:
setRepeatedField
in interfacecom.google.protobuf.Message.Builder
- Overrides:
setRepeatedField
in classcom.google.protobuf.GeneratedMessageV3.Builder<AuthenticationRule.Builder>
-
addRepeatedField
public AuthenticationRule.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, java.lang.Object value)
- Specified by:
addRepeatedField
in interfacecom.google.protobuf.Message.Builder
- Overrides:
addRepeatedField
in classcom.google.protobuf.GeneratedMessageV3.Builder<AuthenticationRule.Builder>
-
mergeFrom
public AuthenticationRule.Builder mergeFrom(com.google.protobuf.Message other)
- Specified by:
mergeFrom
in interfacecom.google.protobuf.Message.Builder
- Overrides:
mergeFrom
in classcom.google.protobuf.AbstractMessage.Builder<AuthenticationRule.Builder>
-
mergeFrom
public AuthenticationRule.Builder mergeFrom(AuthenticationRule other)
-
isInitialized
public final boolean isInitialized()
- Specified by:
isInitialized
in interfacecom.google.protobuf.MessageLiteOrBuilder
- Overrides:
isInitialized
in classcom.google.protobuf.GeneratedMessage.ExtendableBuilder<com.google.protobuf.GeneratedMessageV3,AuthenticationRule.Builder>
-
mergeFrom
public AuthenticationRule.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws java.io.IOException
- Specified by:
mergeFrom
in interfacecom.google.protobuf.Message.Builder
- Specified by:
mergeFrom
in interfacecom.google.protobuf.MessageLite.Builder
- Overrides:
mergeFrom
in classcom.google.protobuf.AbstractMessage.Builder<AuthenticationRule.Builder>
- Throws:
java.io.IOException
-
getSelector
public java.lang.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 interfaceAuthenticationRuleOrBuilder
- 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 interfaceAuthenticationRuleOrBuilder
- Returns:
- The bytes for selector.
-
setSelector
public AuthenticationRule.Builder setSelector(java.lang.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 interfaceAuthenticationRuleOrBuilder
- 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 interfaceAuthenticationRuleOrBuilder
- 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 interfaceAuthenticationRuleOrBuilder
-
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 interfaceAuthenticationRuleOrBuilder
- 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 java.util.List<AuthRequirement> getRequirementsList()
Requirements for additional authentication providers.
repeated .google.api.AuthRequirement requirements = 7;
- Specified by:
getRequirementsList
in interfaceAuthenticationRuleOrBuilder
-
getRequirementsCount
public int getRequirementsCount()
Requirements for additional authentication providers.
repeated .google.api.AuthRequirement requirements = 7;
- Specified by:
getRequirementsCount
in interfaceAuthenticationRuleOrBuilder
-
getRequirements
public AuthRequirement getRequirements(int index)
Requirements for additional authentication providers.
repeated .google.api.AuthRequirement requirements = 7;
- Specified by:
getRequirements
in interfaceAuthenticationRuleOrBuilder
-
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(java.lang.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 interfaceAuthenticationRuleOrBuilder
-
getRequirementsOrBuilderList
public java.util.List<? extends AuthRequirementOrBuilder> getRequirementsOrBuilderList()
Requirements for additional authentication providers.
repeated .google.api.AuthRequirement requirements = 7;
- Specified by:
getRequirementsOrBuilderList
in interfaceAuthenticationRuleOrBuilder
-
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 java.util.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 interfacecom.google.protobuf.Message.Builder
- Overrides:
setUnknownFields
in classcom.google.protobuf.GeneratedMessageV3.Builder<AuthenticationRule.Builder>
-
mergeUnknownFields
public final AuthenticationRule.Builder mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
- Specified by:
mergeUnknownFields
in interfacecom.google.protobuf.Message.Builder
- Overrides:
mergeUnknownFields
in classcom.google.protobuf.GeneratedMessageV3.Builder<AuthenticationRule.Builder>
-
-