AuthenticationRule.Builder (java API)

java.lang.Object
- com.google.protobuf.AbstractMessageLite.Builder
- - com.google.protobuf.AbstractMessage.Builder<BuilderType>
  - - com.google.protobuf.GeneratedMessageV3.Builder<AuthenticationRule.Builder>
    - - com.google.api.AuthenticationRule.Builder

All Implemented Interfaces:: AuthenticationRuleOrBuilder, Message.Builder, MessageLite.Builder, MessageLiteOrBuilder, MessageOrBuilder, java.lang.Cloneable

Enclosing class:: AuthenticationRule

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

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`AuthenticationRule.Builder`	`addAllRequirements(java.lang.Iterable<? extends AuthRequirement> values)` Requirements for additional authentication providers.
`AuthenticationRule.Builder`	`addRepeatedField(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(Descriptors.FieldDescriptor field)`
`AuthenticationRule.Builder`	`clearOauth()` The requirements for OAuth credentials.
`AuthenticationRule.Builder`	`clearOneof(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 Descriptors.Descriptor`	`getDescriptor()`
`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.
`ByteString`	`getSelectorBytes()` Selects the methods to which this rule applies.
`boolean`	`hasOauth()` The requirements for OAuth credentials.
`protected GeneratedMessageV3.FieldAccessorTable`	`internalGetFieldAccessorTable()`
`boolean`	`isInitialized()`
`AuthenticationRule.Builder`	`mergeFrom(AuthenticationRule other)`
`AuthenticationRule.Builder`	`mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)`
`AuthenticationRule.Builder`	`mergeFrom(Message other)`
`AuthenticationRule.Builder`	`mergeOauth(OAuthRequirements value)` The requirements for OAuth credentials.
`AuthenticationRule.Builder`	`mergeUnknownFields(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(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(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(ByteString value)` Selects the methods to which this rule applies.
`AuthenticationRule.Builder`	`setUnknownFields(UnknownFieldSet unknownFields)`

Methods inherited from class com.google.protobuf.GeneratedMessageV3.Builder
getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMutableMapField, isClean, markClean, newBuilderForField, onBuilt, onChanged, setUnknownFieldsProto3

Methods inherited from class com.google.protobuf.AbstractMessage.Builder
findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder
addAll, addAll, 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.MessageOrBuilder
findInitializationErrors, getAllFields, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLite.Builder
mergeFrom

Method Detail

getDescriptor

public static final Descriptors.Descriptor getDescriptor()

internalGetFieldAccessorTable
```
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
```
Specified by:

internalGetFieldAccessorTable in class GeneratedMessageV3.Builder<AuthenticationRule.Builder>

clear
```
public AuthenticationRule.Builder clear()
```
Specified by:

clear in interface Message.Builder

Specified by:

clear in interface MessageLite.Builder

Overrides:

clear in class GeneratedMessageV3.Builder<AuthenticationRule.Builder>

getDescriptorForType
```
public Descriptors.Descriptor getDescriptorForType()
```
Specified by:

getDescriptorForType in interface Message.Builder

Specified by:

getDescriptorForType in interface MessageOrBuilder

Overrides:

getDescriptorForType in class GeneratedMessageV3.Builder<AuthenticationRule.Builder>

getDefaultInstanceForType
```
public AuthenticationRule getDefaultInstanceForType()
```
Specified by:

getDefaultInstanceForType in interface MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface MessageOrBuilder

build
```
public AuthenticationRule build()
```
Specified by:

build in interface Message.Builder

Specified by:

build in interface MessageLite.Builder

buildPartial
```
public AuthenticationRule buildPartial()
```
Specified by:

buildPartial in interface Message.Builder

Specified by:

buildPartial in interface MessageLite.Builder

clone
```
public AuthenticationRule.Builder clone()
```
Specified by:

clone in interface Message.Builder

Specified by:

clone in interface MessageLite.Builder

Overrides:

clone in class GeneratedMessageV3.Builder<AuthenticationRule.Builder>

setField

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

Specified by:: setField in interface Message.Builder
Overrides:: setField in class GeneratedMessageV3.Builder<AuthenticationRule.Builder>

clearField
```
public AuthenticationRule.Builder clearField(Descriptors.FieldDescriptor field)
```
Specified by:

clearField in interface Message.Builder

Overrides:

clearField in class GeneratedMessageV3.Builder<AuthenticationRule.Builder>

clearOneof
```
public AuthenticationRule.Builder clearOneof(Descriptors.OneofDescriptor oneof)
```
Specified by:

clearOneof in interface Message.Builder

Overrides:

clearOneof in class GeneratedMessageV3.Builder<AuthenticationRule.Builder>

setRepeatedField

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

Specified by:: setRepeatedField in interface Message.Builder
Overrides:: setRepeatedField in class GeneratedMessageV3.Builder<AuthenticationRule.Builder>

addRepeatedField

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

Specified by:: addRepeatedField in interface Message.Builder
Overrides:: addRepeatedField in class GeneratedMessageV3.Builder<AuthenticationRule.Builder>

mergeFrom
```
public AuthenticationRule.Builder mergeFrom(Message other)
```
Specified by:

mergeFrom in interface Message.Builder

Overrides:

mergeFrom in class AbstractMessage.Builder<AuthenticationRule.Builder>

mergeFrom

public AuthenticationRule.Builder mergeFrom(AuthenticationRule other)

isInitialized
```
public final boolean isInitialized()
```
Specified by:

isInitialized in interface MessageLiteOrBuilder

Overrides:

isInitialized in class GeneratedMessageV3.Builder<AuthenticationRule.Builder>

mergeFrom

public AuthenticationRule.Builder mergeFrom(CodedInputStream input,
                                            ExtensionRegistryLite extensionRegistry)
                                     throws java.io.IOException

Specified by:: mergeFrom in interface Message.Builder
Specified by:: mergeFrom in interface MessageLite.Builder
Overrides:: mergeFrom in class 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 interface AuthenticationRuleOrBuilder

getSelectorBytes

public 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

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;

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;

setSelectorBytes

public AuthenticationRule.Builder setSelectorBytes(ByteString value)

 Selects the methods to which this rule applies.
 Refer to [selector][google.api.DocumentationRule.selector] for syntax details.

string selector = 1;

hasOauth
```
public boolean hasOauth()
```
```
 The requirements for OAuth credentials.
 
```
.google.api.OAuthRequirements oauth = 2;
Specified by:

hasOauth in interface AuthenticationRuleOrBuilder

getOauth
```
public OAuthRequirements getOauth()
```
```
 The requirements for OAuth credentials.
 
```
.google.api.OAuthRequirements oauth = 2;
Specified by:

getOauth in interface AuthenticationRuleOrBuilder

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.
 
```
bool allow_without_credential = 5;
Specified by:

getAllowWithoutCredential in interface AuthenticationRuleOrBuilder

setAllowWithoutCredential

public AuthenticationRule.Builder setAllowWithoutCredential(boolean value)

 If true, the service accepts API keys without any other credential.

bool allow_without_credential = 5;

clearAllowWithoutCredential

public AuthenticationRule.Builder clearAllowWithoutCredential()

 If true, the service accepts API keys without any other credential.

bool allow_without_credential = 5;

getRequirementsList
```
public java.util.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