public final class AuthenticationRule extends GeneratedMessageV3 implements AuthenticationRuleOrBuilderAuthentication 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<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > AuthenticationRuleImplements
AuthenticationRuleOrBuilderStatic Fields
ALLOW_WITHOUT_CREDENTIAL_FIELD_NUMBER
public static final int ALLOW_WITHOUT_CREDENTIAL_FIELD_NUMBER| Type | Description |
| int |
OAUTH_FIELD_NUMBER
public static final int OAUTH_FIELD_NUMBER| Type | Description |
| int |
REQUIREMENTS_FIELD_NUMBER
public static final int REQUIREMENTS_FIELD_NUMBER| Type | Description |
| int |
SELECTOR_FIELD_NUMBER
public static final int SELECTOR_FIELD_NUMBER| Type | Description |
| int |
Static Methods
getDefaultInstance()
public static AuthenticationRule getDefaultInstance()| Type | Description |
| AuthenticationRule |
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Type | Description |
| Descriptor |
newBuilder()
public static AuthenticationRule.Builder newBuilder()| Type | Description |
| AuthenticationRule.Builder |
newBuilder(AuthenticationRule prototype)
public static AuthenticationRule.Builder newBuilder(AuthenticationRule prototype)| Name | Description |
| prototype | AuthenticationRule |
| Type | Description |
| AuthenticationRule.Builder |
parseDelimitedFrom(InputStream input)
public static AuthenticationRule parseDelimitedFrom(InputStream input)| Name | Description |
| input | InputStream |
| Type | Description |
| AuthenticationRule |
| Type | Description |
| IOException |
parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static AuthenticationRule parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)| Name | Description |
| input | InputStream |
| extensionRegistry | ExtensionRegistryLite |
| Type | Description |
| AuthenticationRule |
| Type | Description |
| IOException |
parseFrom(byte[] data)
public static AuthenticationRule parseFrom(byte[] data)| Name | Description |
| data | byte[] |
| Type | Description |
| AuthenticationRule |
| Type | Description |
| InvalidProtocolBufferException |
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static AuthenticationRule parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)| Name | Description |
| data | byte[] |
| extensionRegistry | ExtensionRegistryLite |
| Type | Description |
| AuthenticationRule |
| Type | Description |
| InvalidProtocolBufferException |
parseFrom(ByteString data)
public static AuthenticationRule parseFrom(ByteString data)| Name | Description |
| data | ByteString |
| Type | Description |
| AuthenticationRule |
| Type | Description |
| InvalidProtocolBufferException |
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static AuthenticationRule parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)| Name | Description |
| data | ByteString |
| extensionRegistry | ExtensionRegistryLite |
| Type | Description |
| AuthenticationRule |
| Type | Description |
| InvalidProtocolBufferException |
parseFrom(CodedInputStream input)
public static AuthenticationRule parseFrom(CodedInputStream input)| Name | Description |
| input | CodedInputStream |
| Type | Description |
| AuthenticationRule |
| Type | Description |
| IOException |
parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static AuthenticationRule parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Name | Description |
| input | CodedInputStream |
| extensionRegistry | ExtensionRegistryLite |
| Type | Description |
| AuthenticationRule |
| Type | Description |
| IOException |
parseFrom(InputStream input)
public static AuthenticationRule parseFrom(InputStream input)| Name | Description |
| input | InputStream |
| Type | Description |
| AuthenticationRule |
| Type | Description |
| IOException |
parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static AuthenticationRule parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)| Name | Description |
| input | InputStream |
| extensionRegistry | ExtensionRegistryLite |
| Type | Description |
| AuthenticationRule |
| Type | Description |
| IOException |
parseFrom(ByteBuffer data)
public static AuthenticationRule parseFrom(ByteBuffer data)| Name | Description |
| data | ByteBuffer |
| Type | Description |
| AuthenticationRule |
| Type | Description |
| InvalidProtocolBufferException |
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static AuthenticationRule parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)| Name | Description |
| data | ByteBuffer |
| extensionRegistry | ExtensionRegistryLite |
| Type | Description |
| AuthenticationRule |
| Type | Description |
| InvalidProtocolBufferException |
parser()
public static Parser<AuthenticationRule> parser()| Type | Description |
| Parser<AuthenticationRule> |
Methods
equals(Object obj)
public boolean equals(Object obj)| Name | Description |
| obj | Object |
| Type | Description |
| boolean |
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;
| Type | Description |
| boolean | The allowWithoutCredential. |
getDefaultInstanceForType()
public AuthenticationRule getDefaultInstanceForType()| Type | Description |
| AuthenticationRule |
getOauth()
public OAuthRequirements getOauth()The requirements for OAuth credentials.
.google.api.OAuthRequirements oauth = 2;
| Type | Description |
| OAuthRequirements | The oauth. |
getOauthOrBuilder()
public OAuthRequirementsOrBuilder getOauthOrBuilder()The requirements for OAuth credentials.
.google.api.OAuthRequirements oauth = 2;
| Type | Description |
| OAuthRequirementsOrBuilder |
getParserForType()
public Parser<AuthenticationRule> getParserForType()| Type | Description |
| Parser<AuthenticationRule> |
getRequirements(int index)
public AuthRequirement getRequirements(int index)Requirements for additional authentication providers.
repeated .google.api.AuthRequirement requirements = 7;
| Name | Description |
| index | int |
| Type | Description |
| AuthRequirement |
getRequirementsCount()
public int getRequirementsCount()Requirements for additional authentication providers.
repeated .google.api.AuthRequirement requirements = 7;
| Type | Description |
| int |
getRequirementsList()
public List<AuthRequirement> getRequirementsList()Requirements for additional authentication providers.
repeated .google.api.AuthRequirement requirements = 7;
| Type | Description |
| List<AuthRequirement> |
getRequirementsOrBuilder(int index)
public AuthRequirementOrBuilder getRequirementsOrBuilder(int index)Requirements for additional authentication providers.
repeated .google.api.AuthRequirement requirements = 7;
| Name | Description |
| index | int |
| Type | Description |
| AuthRequirementOrBuilder |
getRequirementsOrBuilderList()
public List<? extends AuthRequirementOrBuilder> getRequirementsOrBuilderList()Requirements for additional authentication providers.
repeated .google.api.AuthRequirement requirements = 7;
| 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;
| 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;
| Type | Description |
| ByteString | The bytes for selector. |
getSerializedSize()
public int getSerializedSize()| Type | Description |
| int |
getUnknownFields()
public final UnknownFieldSet getUnknownFields()| Type | Description |
| UnknownFieldSet |
hasOauth()
public boolean hasOauth()The requirements for OAuth credentials.
.google.api.OAuthRequirements oauth = 2;
| Type | Description |
| boolean | Whether the oauth field is set. |
hashCode()
public int hashCode()| Type | Description |
| int |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()| Type | Description |
| FieldAccessorTable |
isInitialized()
public final boolean isInitialized()| Type | Description |
| boolean |
newBuilderForType()
public AuthenticationRule.Builder newBuilderForType()| Type | Description |
| AuthenticationRule.Builder |
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected AuthenticationRule.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)| Name | Description |
| parent | BuilderParent |
| Type | Description |
| AuthenticationRule.Builder |
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)| Name | Description |
| unused | UnusedPrivateParameter |
| Type | Description |
| Object |
toBuilder()
public AuthenticationRule.Builder toBuilder()| Type | Description |
| AuthenticationRule.Builder |
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)| Name | Description |
| output | CodedOutputStream |
| Type | Description |
| IOException |