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
Modifier and Type | Method and 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(AuthRequirement.Builder builderForValue)
Requirements for additional authentication providers.
|
AuthenticationRule.Builder |
addRequirements(AuthRequirement value)
Requirements for additional authentication providers.
|
AuthenticationRule.Builder |
addRequirements(int index,
AuthRequirement.Builder builderForValue)
Requirements for additional authentication providers.
|
AuthenticationRule.Builder |
addRequirements(int index,
AuthRequirement value)
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.Builder builderForValue)
The requirements for OAuth credentials.
|
AuthenticationRule.Builder |
setOauth(OAuthRequirements value)
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.Builder builderForValue)
Requirements for additional authentication providers.
|
AuthenticationRule.Builder |
setRequirements(int index,
AuthRequirement value)
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) |
getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMutableMapField, isClean, markClean, newBuilderForField, onBuilt, onChanged, setUnknownFieldsProto3
findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toString
addAll, addAll, mergeFrom, newUninitializedMessageException
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
internalGetFieldAccessorTable
in class com.google.protobuf.GeneratedMessageV3.Builder<AuthenticationRule.Builder>
public AuthenticationRule.Builder clear()
clear
in interface com.google.protobuf.Message.Builder
clear
in interface com.google.protobuf.MessageLite.Builder
clear
in class com.google.protobuf.GeneratedMessageV3.Builder<AuthenticationRule.Builder>
public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
getDescriptorForType
in interface com.google.protobuf.Message.Builder
getDescriptorForType
in interface com.google.protobuf.MessageOrBuilder
getDescriptorForType
in class com.google.protobuf.GeneratedMessageV3.Builder<AuthenticationRule.Builder>
public AuthenticationRule getDefaultInstanceForType()
getDefaultInstanceForType
in interface com.google.protobuf.MessageLiteOrBuilder
getDefaultInstanceForType
in interface com.google.protobuf.MessageOrBuilder
public AuthenticationRule build()
build
in interface com.google.protobuf.Message.Builder
build
in interface com.google.protobuf.MessageLite.Builder
public AuthenticationRule buildPartial()
buildPartial
in interface com.google.protobuf.Message.Builder
buildPartial
in interface com.google.protobuf.MessageLite.Builder
public AuthenticationRule.Builder clone()
clone
in interface com.google.protobuf.Message.Builder
clone
in interface com.google.protobuf.MessageLite.Builder
clone
in class com.google.protobuf.GeneratedMessageV3.Builder<AuthenticationRule.Builder>
public AuthenticationRule.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field, java.lang.Object value)
setField
in interface com.google.protobuf.Message.Builder
setField
in class com.google.protobuf.GeneratedMessageV3.Builder<AuthenticationRule.Builder>
public AuthenticationRule.Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
clearField
in interface com.google.protobuf.Message.Builder
clearField
in class com.google.protobuf.GeneratedMessageV3.Builder<AuthenticationRule.Builder>
public AuthenticationRule.Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
clearOneof
in interface com.google.protobuf.Message.Builder
clearOneof
in class com.google.protobuf.GeneratedMessageV3.Builder<AuthenticationRule.Builder>
public AuthenticationRule.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, java.lang.Object value)
setRepeatedField
in interface com.google.protobuf.Message.Builder
setRepeatedField
in class com.google.protobuf.GeneratedMessageV3.Builder<AuthenticationRule.Builder>
public AuthenticationRule.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, java.lang.Object value)
addRepeatedField
in interface com.google.protobuf.Message.Builder
addRepeatedField
in class com.google.protobuf.GeneratedMessageV3.Builder<AuthenticationRule.Builder>
public AuthenticationRule.Builder mergeFrom(com.google.protobuf.Message other)
mergeFrom
in interface com.google.protobuf.Message.Builder
mergeFrom
in class com.google.protobuf.AbstractMessage.Builder<AuthenticationRule.Builder>
public AuthenticationRule.Builder mergeFrom(AuthenticationRule other)
public final boolean isInitialized()
isInitialized
in interface com.google.protobuf.MessageLiteOrBuilder
isInitialized
in class com.google.protobuf.GeneratedMessageV3.Builder<AuthenticationRule.Builder>
public AuthenticationRule.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws java.io.IOException
mergeFrom
in interface com.google.protobuf.Message.Builder
mergeFrom
in interface com.google.protobuf.MessageLite.Builder
mergeFrom
in class com.google.protobuf.AbstractMessage.Builder<AuthenticationRule.Builder>
java.io.IOException
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;
getSelector
in interface AuthenticationRuleOrBuilder
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;
getSelectorBytes
in interface AuthenticationRuleOrBuilder
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;
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;
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;
public boolean hasOauth()
The requirements for OAuth credentials.
.google.api.OAuthRequirements oauth = 2;
hasOauth
in interface AuthenticationRuleOrBuilder
public OAuthRequirements getOauth()
The requirements for OAuth credentials.
.google.api.OAuthRequirements oauth = 2;
getOauth
in interface AuthenticationRuleOrBuilder
public AuthenticationRule.Builder setOauth(OAuthRequirements value)
The requirements for OAuth credentials.
.google.api.OAuthRequirements oauth = 2;
public AuthenticationRule.Builder setOauth(OAuthRequirements.Builder builderForValue)
The requirements for OAuth credentials.
.google.api.OAuthRequirements oauth = 2;
public AuthenticationRule.Builder mergeOauth(OAuthRequirements value)
The requirements for OAuth credentials.
.google.api.OAuthRequirements oauth = 2;
public AuthenticationRule.Builder clearOauth()
The requirements for OAuth credentials.
.google.api.OAuthRequirements oauth = 2;
public OAuthRequirements.Builder getOauthBuilder()
The requirements for OAuth credentials.
.google.api.OAuthRequirements oauth = 2;
public OAuthRequirementsOrBuilder getOauthOrBuilder()
The requirements for OAuth credentials.
.google.api.OAuthRequirements oauth = 2;
getOauthOrBuilder
in interface AuthenticationRuleOrBuilder
public boolean getAllowWithoutCredential()
If true, the service accepts API keys without any other credential.
bool allow_without_credential = 5;
getAllowWithoutCredential
in interface AuthenticationRuleOrBuilder
public AuthenticationRule.Builder setAllowWithoutCredential(boolean value)
If true, the service accepts API keys without any other credential.
bool allow_without_credential = 5;
public AuthenticationRule.Builder clearAllowWithoutCredential()
If true, the service accepts API keys without any other credential.
bool allow_without_credential = 5;
public java.util.List<AuthRequirement> getRequirementsList()
Requirements for additional authentication providers.
repeated .google.api.AuthRequirement requirements = 7;
getRequirementsList
in interface AuthenticationRuleOrBuilder
public int getRequirementsCount()
Requirements for additional authentication providers.
repeated .google.api.AuthRequirement requirements = 7;
getRequirementsCount
in interface AuthenticationRuleOrBuilder
public AuthRequirement getRequirements(int index)
Requirements for additional authentication providers.
repeated .google.api.AuthRequirement requirements = 7;
getRequirements
in interface AuthenticationRuleOrBuilder
public AuthenticationRule.Builder setRequirements(int index, AuthRequirement value)
Requirements for additional authentication providers.
repeated .google.api.AuthRequirement requirements = 7;
public AuthenticationRule.Builder setRequirements(int index, AuthRequirement.Builder builderForValue)
Requirements for additional authentication providers.
repeated .google.api.AuthRequirement requirements = 7;
public AuthenticationRule.Builder addRequirements(AuthRequirement value)
Requirements for additional authentication providers.
repeated .google.api.AuthRequirement requirements = 7;
public AuthenticationRule.Builder addRequirements(int index, AuthRequirement value)
Requirements for additional authentication providers.
repeated .google.api.AuthRequirement requirements = 7;
public AuthenticationRule.Builder addRequirements(AuthRequirement.Builder builderForValue)
Requirements for additional authentication providers.
repeated .google.api.AuthRequirement requirements = 7;
public AuthenticationRule.Builder addRequirements(int index, AuthRequirement.Builder builderForValue)
Requirements for additional authentication providers.
repeated .google.api.AuthRequirement requirements = 7;
public AuthenticationRule.Builder addAllRequirements(java.lang.Iterable<? extends AuthRequirement> values)
Requirements for additional authentication providers.
repeated .google.api.AuthRequirement requirements = 7;
public AuthenticationRule.Builder clearRequirements()
Requirements for additional authentication providers.
repeated .google.api.AuthRequirement requirements = 7;
public AuthenticationRule.Builder removeRequirements(int index)
Requirements for additional authentication providers.
repeated .google.api.AuthRequirement requirements = 7;
public AuthRequirement.Builder getRequirementsBuilder(int index)
Requirements for additional authentication providers.
repeated .google.api.AuthRequirement requirements = 7;
public AuthRequirementOrBuilder getRequirementsOrBuilder(int index)
Requirements for additional authentication providers.
repeated .google.api.AuthRequirement requirements = 7;
getRequirementsOrBuilder
in interface AuthenticationRuleOrBuilder
public java.util.List<? extends AuthRequirementOrBuilder> getRequirementsOrBuilderList()
Requirements for additional authentication providers.
repeated .google.api.AuthRequirement requirements = 7;
getRequirementsOrBuilderList
in interface AuthenticationRuleOrBuilder
public AuthRequirement.Builder addRequirementsBuilder()
Requirements for additional authentication providers.
repeated .google.api.AuthRequirement requirements = 7;
public AuthRequirement.Builder addRequirementsBuilder(int index)
Requirements for additional authentication providers.
repeated .google.api.AuthRequirement requirements = 7;
public java.util.List<AuthRequirement.Builder> getRequirementsBuilderList()
Requirements for additional authentication providers.
repeated .google.api.AuthRequirement requirements = 7;
public final AuthenticationRule.Builder setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
setUnknownFields
in interface com.google.protobuf.Message.Builder
setUnknownFields
in class com.google.protobuf.GeneratedMessageV3.Builder<AuthenticationRule.Builder>
public final AuthenticationRule.Builder mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
mergeUnknownFields
in interface com.google.protobuf.Message.Builder
mergeUnknownFields
in class com.google.protobuf.GeneratedMessageV3.Builder<AuthenticationRule.Builder>