Class AuthenticationRule.Builder (2.32.0)

Version 2.32.0

• 2.48.0 (latest)
• 2.46.0
• 2.45.1
• 2.44.0
• 2.43.0
• 2.42.0
• 2.41.0
• 2.40.0
• 2.39.1
• 2.38.0
• 2.37.1
• 2.36.0
• 2.34.0
• 2.33.0
• 2.32.0
• 2.30.0
• 2.29.0
• 2.28.0
• 2.27.0
• 2.26.0
• 2.25.1
• 2.24.0
• 2.23.1
• 2.22.1
• 2.21.1
• 2.15.0
• 2.14.3
• 2.13.0
• 2.12.0
• 2.11.0
• 2.10.0
• 2.9.6
• 2.8.4
• 2.7.4

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

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > AuthenticationRule.Builder

Implements

AuthenticationRuleOrBuilder

Inherited Members

AbstractMessage.Builder.findInitializationErrors()

AbstractMessage.Builder.getInitializationErrorString()

AbstractMessage.Builder.internalMergeFrom(AbstractMessageLite)

AbstractMessage.Builder.mergeFrom(byte[])

AbstractMessage.Builder.mergeFrom(byte[],ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(byte[],int,int)

AbstractMessage.Builder.mergeFrom(byte[],int,int,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(ByteString)

AbstractMessage.Builder.mergeFrom(ByteString,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(CodedInputStream)

AbstractMessage.Builder.mergeFrom(CodedInputStream,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(Message)

AbstractMessage.Builder.mergeFrom(InputStream)

AbstractMessage.Builder.mergeFrom(InputStream,ExtensionRegistryLite)

AbstractMessage.Builder.newUninitializedMessageException(Message)

AbstractMessage.Builder.toString()

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.Builder.internalMergeFrom(MessageType)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream,ExtensionRegistryLite)

AbstractMessageLite.Builder.mergeFrom(MessageLite)

AbstractMessageLite.Builder.newUninitializedMessageException(MessageLite)

GeneratedMessageV3.Builder.addRepeatedField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.clear()

GeneratedMessageV3.Builder.clearField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.clearOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.clone()

GeneratedMessageV3.Builder.getAllFields()

GeneratedMessageV3.Builder.getDescriptorForType()

GeneratedMessageV3.Builder.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getFieldBuilder(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.getParentForChildren()

GeneratedMessageV3.Builder.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldBuilder(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldCount(Descriptors.FieldDescriptor)

com.google.protobuf.GeneratedMessageV3.Builder.getUnknownFieldSetBuilder()

GeneratedMessageV3.Builder.getUnknownFields()

GeneratedMessageV3.Builder.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.internalGetFieldAccessorTable()

GeneratedMessageV3.Builder.internalGetMapField(int)

com.google.protobuf.GeneratedMessageV3.Builder.internalGetMapFieldReflection(int)

GeneratedMessageV3.Builder.internalGetMutableMapField(int)

com.google.protobuf.GeneratedMessageV3.Builder.internalGetMutableMapFieldReflection(int)

GeneratedMessageV3.Builder.isClean()

GeneratedMessageV3.Builder.isInitialized()

GeneratedMessageV3.Builder.markClean()

GeneratedMessageV3.Builder.mergeUnknownFields(UnknownFieldSet)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownLengthDelimitedField(int,com.google.protobuf.ByteString)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownVarintField(int,int)

GeneratedMessageV3.Builder.newBuilderForField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.onBuilt()

GeneratedMessageV3.Builder.onChanged()

com.google.protobuf.GeneratedMessageV3.Builder.parseUnknownField(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite,int)

GeneratedMessageV3.Builder.setField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.setRepeatedField(Descriptors.FieldDescriptor,int,Object)

com.google.protobuf.GeneratedMessageV3.Builder.setUnknownFieldSetBuilder(com.google.protobuf.UnknownFieldSet.Builder)

GeneratedMessageV3.Builder.setUnknownFields(UnknownFieldSet)

GeneratedMessageV3.Builder.setUnknownFieldsProto3(UnknownFieldSet)

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns
Type	Description
Descriptor

Methods

addAllRequirements(Iterable<? extends AuthRequirement> values)

public AuthenticationRule.Builder addAllRequirements(Iterable<? extends AuthRequirement> values)

Requirements for additional authentication providers.

repeated .google.api.AuthRequirement requirements = 7;

Parameter
Name	Description
values	Iterable<? extends com.google.api.AuthRequirement>

Returns
Type	Description
AuthenticationRule.Builder

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public AuthenticationRule.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)

Parameters
Name	Description
field	FieldDescriptor
value	Object

Returns
Type	Description
AuthenticationRule.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.addRepeatedField(Descriptors.FieldDescriptor field, Object value)

addRequirements(AuthRequirement value)

public AuthenticationRule.Builder addRequirements(AuthRequirement value)

Requirements for additional authentication providers.

repeated .google.api.AuthRequirement requirements = 7;

Parameter
Name	Description
value	AuthRequirement

Returns
Type	Description
AuthenticationRule.Builder

addRequirements(AuthRequirement.Builder builderForValue)

public AuthenticationRule.Builder addRequirements(AuthRequirement.Builder builderForValue)

Requirements for additional authentication providers.

repeated .google.api.AuthRequirement requirements = 7;

Parameter
Name	Description
builderForValue	AuthRequirement.Builder

Returns
Type	Description
AuthenticationRule.Builder

addRequirements(int index, AuthRequirement value)

public AuthenticationRule.Builder addRequirements(int index, AuthRequirement value)

Requirements for additional authentication providers.

repeated .google.api.AuthRequirement requirements = 7;

Parameters
Name	Description
index	int
value	AuthRequirement

Returns
Type	Description
AuthenticationRule.Builder

addRequirements(int index, AuthRequirement.Builder builderForValue)

public AuthenticationRule.Builder addRequirements(int index, AuthRequirement.Builder builderForValue)

Requirements for additional authentication providers.

repeated .google.api.AuthRequirement requirements = 7;

Parameters
Name	Description
index	int
builderForValue	AuthRequirement.Builder

Returns
Type	Description
AuthenticationRule.Builder

addRequirementsBuilder()

public AuthRequirement.Builder addRequirementsBuilder()

Requirements for additional authentication providers.

repeated .google.api.AuthRequirement requirements = 7;

Returns
Type	Description
AuthRequirement.Builder

addRequirementsBuilder(int index)

public AuthRequirement.Builder addRequirementsBuilder(int index)

Requirements for additional authentication providers.

repeated .google.api.AuthRequirement requirements = 7;

Parameter
Name	Description
index	int

Returns
Type	Description
AuthRequirement.Builder

build()

public AuthenticationRule build()

Returns
Type	Description
AuthenticationRule

buildPartial()

public AuthenticationRule buildPartial()

Returns
Type	Description
AuthenticationRule

clear()

public AuthenticationRule.Builder clear()

Returns
Type	Description
AuthenticationRule.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clear()

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
Type	Description
AuthenticationRule.Builder	This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public AuthenticationRule.Builder clearField(Descriptors.FieldDescriptor field)

Parameter
Name	Description
field	FieldDescriptor

Returns
Type	Description
AuthenticationRule.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearField(Descriptors.FieldDescriptor field)

clearOauth()

public AuthenticationRule.Builder clearOauth()

The requirements for OAuth credentials.

.google.api.OAuthRequirements oauth = 2;

Returns
Type	Description
AuthenticationRule.Builder

clearOneof(Descriptors.OneofDescriptor oneof)

public AuthenticationRule.Builder clearOneof(Descriptors.OneofDescriptor oneof)

Parameter
Name	Description
oneof	OneofDescriptor

Returns
Type	Description
AuthenticationRule.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearOneof(Descriptors.OneofDescriptor oneof)

clearRequirements()

public AuthenticationRule.Builder clearRequirements()

Requirements for additional authentication providers.

repeated .google.api.AuthRequirement requirements = 7;

Returns
Type	Description
AuthenticationRule.Builder

clearSelector()

public AuthenticationRule.Builder clearSelector()

Selects the methods to which this rule applies.

Refer to selector for syntax details.

string selector = 1;

Returns
Type	Description
AuthenticationRule.Builder	This builder for chaining.

clone()

public AuthenticationRule.Builder clone()

Returns
Type	Description
AuthenticationRule.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clone()

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;

Returns
Type	Description
boolean	The allowWithoutCredential.

getDefaultInstanceForType()

public AuthenticationRule getDefaultInstanceForType()

Returns
Type	Description
AuthenticationRule

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()

Returns
Type	Description
Descriptor

Overrides

GeneratedMessageV3.Builder<BuilderType>.getDescriptorForType()

getOauth()

public OAuthRequirements getOauth()

The requirements for OAuth credentials.

.google.api.OAuthRequirements oauth = 2;

Returns
Type	Description
OAuthRequirements	The oauth.

getOauthBuilder()

public OAuthRequirements.Builder getOauthBuilder()

The requirements for OAuth credentials.

.google.api.OAuthRequirements oauth = 2;

Returns
Type	Description
OAuthRequirements.Builder

getOauthOrBuilder()

public OAuthRequirementsOrBuilder getOauthOrBuilder()

The requirements for OAuth credentials.

.google.api.OAuthRequirements oauth = 2;

Returns
Type	Description
OAuthRequirementsOrBuilder

getRequirements(int index)

public AuthRequirement getRequirements(int index)

Requirements for additional authentication providers.

repeated .google.api.AuthRequirement requirements = 7;

Parameter
Name	Description
index	int

Returns
Type	Description
AuthRequirement

getRequirementsBuilder(int index)

public AuthRequirement.Builder getRequirementsBuilder(int index)

Requirements for additional authentication providers.

repeated .google.api.AuthRequirement requirements = 7;

Parameter
Name	Description
index	int

Returns
Type	Description
AuthRequirement.Builder

getRequirementsBuilderList()

public List<AuthRequirement.Builder> getRequirementsBuilderList()

Requirements for additional authentication providers.

repeated .google.api.AuthRequirement requirements = 7;

Returns
Type	Description
List<Builder>

getRequirementsCount()

public int getRequirementsCount()

Requirements for additional authentication providers.

repeated .google.api.AuthRequirement requirements = 7;

Returns
Type	Description
int

getRequirementsList()

public List<AuthRequirement> getRequirementsList()

Requirements for additional authentication providers.

repeated .google.api.AuthRequirement requirements = 7;

Returns
Type	Description
List<AuthRequirement>

getRequirementsOrBuilder(int index)

public AuthRequirementOrBuilder getRequirementsOrBuilder(int index)

Requirements for additional authentication providers.

repeated .google.api.AuthRequirement requirements = 7;

Parameter
Name	Description
index	int

Returns
Type	Description
AuthRequirementOrBuilder

getRequirementsOrBuilderList()

public List<? extends AuthRequirementOrBuilder> getRequirementsOrBuilderList()

Requirements for additional authentication providers.

repeated .google.api.AuthRequirement requirements = 7;

Returns
Type	Description
List<? extends com.google.api.AuthRequirementOrBuilder>

getSelector()

public String getSelector()

Selects the methods to which this rule applies.

Refer to selector for syntax details.

string selector = 1;

Returns
Type	Description
String	The selector.

getSelectorBytes()

public ByteString getSelectorBytes()

Selects the methods to which this rule applies.

Refer to selector for syntax details.

string selector = 1;

Returns
Type	Description
ByteString	The bytes for selector.

hasOauth()

public boolean hasOauth()

The requirements for OAuth credentials.

.google.api.OAuthRequirements oauth = 2;

Returns
Type	Description
boolean	Whether the oauth field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
FieldAccessorTable

Overrides

GeneratedMessageV3.Builder<BuilderType>.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
boolean

Overrides

GeneratedMessageV3.Builder<BuilderType>.isInitialized()

mergeFrom(AuthenticationRule other)

public AuthenticationRule.Builder mergeFrom(AuthenticationRule other)

Parameter
Name	Description
other	AuthenticationRule

Returns
Type	Description
AuthenticationRule.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public AuthenticationRule.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	CodedInputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
AuthenticationRule.Builder

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Exceptions
Type	Description
IOException

mergeFrom(Message other)

public AuthenticationRule.Builder mergeFrom(Message other)

Parameter
Name	Description
other	Message

Returns
Type	Description
AuthenticationRule.Builder

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(Message other)

mergeOauth(OAuthRequirements value)

public AuthenticationRule.Builder mergeOauth(OAuthRequirements value)

The requirements for OAuth credentials.

.google.api.OAuthRequirements oauth = 2;

Parameter
Name	Description
value	OAuthRequirements

Returns
Type	Description
AuthenticationRule.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final AuthenticationRule.Builder mergeUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
unknownFields	UnknownFieldSet

Returns
Type	Description
AuthenticationRule.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.mergeUnknownFields(UnknownFieldSet unknownFields)

removeRequirements(int index)

public AuthenticationRule.Builder removeRequirements(int index)

Requirements for additional authentication providers.

repeated .google.api.AuthRequirement requirements = 7;

Parameter
Name	Description
index	int

Returns
Type	Description
AuthenticationRule.Builder

setAllowWithoutCredential(boolean value)

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;

Parameter
Name	Description
value	boolean The allowWithoutCredential to set.

Returns
Type	Description
AuthenticationRule.Builder	This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public AuthenticationRule.Builder setField(Descriptors.FieldDescriptor field, Object value)

Parameters
Name	Description
field	FieldDescriptor
value	Object

Returns
Type	Description
AuthenticationRule.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setField(Descriptors.FieldDescriptor field, Object value)

setOauth(OAuthRequirements value)

public AuthenticationRule.Builder setOauth(OAuthRequirements value)

The requirements for OAuth credentials.

.google.api.OAuthRequirements oauth = 2;

Parameter
Name	Description
value	OAuthRequirements

Returns
Type	Description
AuthenticationRule.Builder

setOauth(OAuthRequirements.Builder builderForValue)

public AuthenticationRule.Builder setOauth(OAuthRequirements.Builder builderForValue)

The requirements for OAuth credentials.

.google.api.OAuthRequirements oauth = 2;

Parameter
Name	Description
builderForValue	OAuthRequirements.Builder

Returns
Type	Description
AuthenticationRule.Builder

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public AuthenticationRule.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

Parameters
Name	Description
field	FieldDescriptor
index	int
value	Object

Returns
Type	Description
AuthenticationRule.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

setRequirements(int index, AuthRequirement value)

public AuthenticationRule.Builder setRequirements(int index, AuthRequirement value)

Requirements for additional authentication providers.

repeated .google.api.AuthRequirement requirements = 7;

Parameters
Name	Description
index	int
value	AuthRequirement

Returns
Type	Description
AuthenticationRule.Builder

setRequirements(int index, AuthRequirement.Builder builderForValue)

public AuthenticationRule.Builder setRequirements(int index, AuthRequirement.Builder builderForValue)

Requirements for additional authentication providers.

repeated .google.api.AuthRequirement requirements = 7;

Parameters
Name	Description
index	int
builderForValue	AuthRequirement.Builder

Returns
Type	Description
AuthenticationRule.Builder

setSelector(String value)

public AuthenticationRule.Builder setSelector(String value)

Selects the methods to which this rule applies.

Refer to selector for syntax details.

string selector = 1;

Parameter
Name	Description
value	String The selector to set.

Returns
Type	Description
AuthenticationRule.Builder	This builder for chaining.

setSelectorBytes(ByteString value)

public AuthenticationRule.Builder setSelectorBytes(ByteString value)

Selects the methods to which this rule applies.

Refer to selector for syntax details.

string selector = 1;

Parameter
Name	Description
value	ByteString The bytes for selector to set.

Returns
Type	Description
AuthenticationRule.Builder	This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final AuthenticationRule.Builder setUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
unknownFields	UnknownFieldSet

Returns
Type	Description
AuthenticationRule.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setUnknownFields(UnknownFieldSet unknownFields)