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 Summary
Modifier and TypeMethodDescriptionaddAllRequirements
(Iterable<? extends AuthRequirement> values) Requirements for additional authentication providers.addRepeatedField
(com.google.protobuf.Descriptors.FieldDescriptor field, Object value) addRequirements
(int index, AuthRequirement value) Requirements for additional authentication providers.addRequirements
(int index, AuthRequirement.Builder builderForValue) Requirements for additional authentication providers.addRequirements
(AuthRequirement value) Requirements for additional authentication providers.addRequirements
(AuthRequirement.Builder builderForValue) Requirements for additional authentication providers.Requirements for additional authentication providers.addRequirementsBuilder
(int index) Requirements for additional authentication providers.build()
clear()
If true, the service accepts API keys without any other credential.clearField
(com.google.protobuf.Descriptors.FieldDescriptor field) The requirements for OAuth credentials.clearOneof
(com.google.protobuf.Descriptors.OneofDescriptor oneof) Requirements for additional authentication providers.Selects the methods to which this rule applies.clone()
boolean
If true, the service accepts API keys without any other credential.static final com.google.protobuf.Descriptors.Descriptor
com.google.protobuf.Descriptors.Descriptor
getOauth()
The requirements for OAuth credentials.The requirements for OAuth credentials.The requirements for OAuth credentials.getRequirements
(int index) Requirements for additional authentication providers.getRequirementsBuilder
(int index) Requirements for additional authentication providers.Requirements for additional authentication providers.int
Requirements for additional authentication providers.Requirements for additional authentication providers.getRequirementsOrBuilder
(int index) Requirements for additional authentication providers.List<? extends AuthRequirementOrBuilder>
Requirements for additional authentication providers.Selects the methods to which this rule applies.com.google.protobuf.ByteString
Selects the methods to which this rule applies.boolean
hasOauth()
The requirements for OAuth credentials.protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable
final boolean
mergeFrom
(AuthenticationRule other) mergeFrom
(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) mergeFrom
(com.google.protobuf.Message other) mergeOauth
(OAuthRequirements value) The requirements for OAuth credentials.mergeUnknownFields
(com.google.protobuf.UnknownFieldSet unknownFields) removeRequirements
(int index) Requirements for additional authentication providers.setAllowWithoutCredential
(boolean value) If true, the service accepts API keys without any other credential.setOauth
(OAuthRequirements value) The requirements for OAuth credentials.setOauth
(OAuthRequirements.Builder builderForValue) The requirements for OAuth credentials.setRepeatedField
(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value) setRequirements
(int index, AuthRequirement value) Requirements for additional authentication providers.setRequirements
(int index, AuthRequirement.Builder builderForValue) Requirements for additional authentication providers.setSelector
(String value) Selects the methods to which this rule applies.setSelectorBytes
(com.google.protobuf.ByteString value) Selects the methods to which this rule applies.setUnknownFields
(com.google.protobuf.UnknownFieldSet unknownFields) Methods inherited from class com.google.protobuf.GeneratedMessageV3.Builder
getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, internalGetMutableMapField, internalGetMutableMapFieldReflection, isClean, markClean, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, 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
Methods inherited from interface com.google.protobuf.Message.Builder
mergeDelimitedFrom, mergeDelimitedFrom
Methods inherited from interface com.google.protobuf.MessageLite.Builder
mergeFrom
Methods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof
-
Method Details
-
getDescriptor
public static final com.google.protobuf.Descriptors.Descriptor getDescriptor() -
internalGetFieldAccessorTable
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()- Specified by:
internalGetFieldAccessorTable
in classcom.google.protobuf.GeneratedMessageV3.Builder<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.GeneratedMessageV3.Builder<AuthenticationRule.Builder>
-
getDefaultInstanceForType
- Specified by:
getDefaultInstanceForType
in interfacecom.google.protobuf.MessageLiteOrBuilder
- Specified by:
getDefaultInstanceForType
in interfacecom.google.protobuf.MessageOrBuilder
-
build
- Specified by:
build
in interfacecom.google.protobuf.Message.Builder
- Specified by:
build
in interfacecom.google.protobuf.MessageLite.Builder
-
buildPartial
- Specified by:
buildPartial
in interfacecom.google.protobuf.Message.Builder
- Specified by:
buildPartial
in interfacecom.google.protobuf.MessageLite.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, Object value) - Specified by:
setField
in interfacecom.google.protobuf.Message.Builder
- Overrides:
setField
in classcom.google.protobuf.GeneratedMessageV3.Builder<AuthenticationRule.Builder>
-
clearField
- Specified by:
clearField
in interfacecom.google.protobuf.Message.Builder
- Overrides:
clearField
in classcom.google.protobuf.GeneratedMessageV3.Builder<AuthenticationRule.Builder>
-
clearOneof
- 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, 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, Object value) - Specified by:
addRepeatedField
in interfacecom.google.protobuf.Message.Builder
- Overrides:
addRepeatedField
in classcom.google.protobuf.GeneratedMessageV3.Builder<AuthenticationRule.Builder>
-
mergeFrom
- Specified by:
mergeFrom
in interfacecom.google.protobuf.Message.Builder
- Overrides:
mergeFrom
in classcom.google.protobuf.AbstractMessage.Builder<AuthenticationRule.Builder>
-
mergeFrom
-
isInitialized
public final boolean isInitialized()- Specified by:
isInitialized
in interfacecom.google.protobuf.MessageLiteOrBuilder
- Overrides:
isInitialized
in classcom.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 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:
IOException
-
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
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
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
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
The requirements for OAuth credentials.
.google.api.OAuthRequirements oauth = 2;
- Specified by:
getOauth
in interfaceAuthenticationRuleOrBuilder
- Returns:
- The oauth.
-
setOauth
The requirements for OAuth credentials.
.google.api.OAuthRequirements oauth = 2;
-
setOauth
The requirements for OAuth credentials.
.google.api.OAuthRequirements oauth = 2;
-
mergeOauth
The requirements for OAuth credentials.
.google.api.OAuthRequirements oauth = 2;
-
clearOauth
The requirements for OAuth credentials.
.google.api.OAuthRequirements oauth = 2;
-
getOauthBuilder
The requirements for OAuth credentials.
.google.api.OAuthRequirements oauth = 2;
-
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
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
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
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
Requirements for additional authentication providers.
repeated .google.api.AuthRequirement requirements = 7;
- Specified by:
getRequirements
in interfaceAuthenticationRuleOrBuilder
-
setRequirements
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
Requirements for additional authentication providers.
repeated .google.api.AuthRequirement requirements = 7;
-
addRequirements
Requirements for additional authentication providers.
repeated .google.api.AuthRequirement requirements = 7;
-
addRequirements
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
Requirements for additional authentication providers.
repeated .google.api.AuthRequirement requirements = 7;
-
clearRequirements
Requirements for additional authentication providers.
repeated .google.api.AuthRequirement requirements = 7;
-
removeRequirements
Requirements for additional authentication providers.
repeated .google.api.AuthRequirement requirements = 7;
-
getRequirementsBuilder
Requirements for additional authentication providers.
repeated .google.api.AuthRequirement requirements = 7;
-
getRequirementsOrBuilder
Requirements for additional authentication providers.
repeated .google.api.AuthRequirement requirements = 7;
- Specified by:
getRequirementsOrBuilder
in interfaceAuthenticationRuleOrBuilder
-
getRequirementsOrBuilderList
Requirements for additional authentication providers.
repeated .google.api.AuthRequirement requirements = 7;
- Specified by:
getRequirementsOrBuilderList
in interfaceAuthenticationRuleOrBuilder
-
addRequirementsBuilder
Requirements for additional authentication providers.
repeated .google.api.AuthRequirement requirements = 7;
-
addRequirementsBuilder
Requirements for additional authentication providers.
repeated .google.api.AuthRequirement requirements = 7;
-
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>
-