Package com.google.api

Interface AuthRequirementOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
AuthRequirement, AuthRequirement.Builder
public interface AuthRequirementOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getAudiences()
    NOTE: This will be deprecated soon, once AuthProvider.audiences is implemented and accepted in all the runtime components.
    com.google.protobuf.ByteString
    getAudiencesBytes()
    NOTE: This will be deprecated soon, once AuthProvider.audiences is implemented and accepted in all the runtime components.
    String
    getProviderId()
    [id][google.api.AuthProvider.id] from authentication provider.
    com.google.protobuf.ByteString
    getProviderIdBytes()
    [id][google.api.AuthProvider.id] from authentication provider.

    Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

    isInitialized

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

    findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

  • Method Details

    • getProviderId

      String getProviderId()
       [id][google.api.AuthProvider.id] from authentication provider.
 Example:
     provider_id: bookstore_auth
      string provider_id = 1;
      Returns:
      The providerId.

    • getProviderIdBytes

      com.google.protobuf.ByteString getProviderIdBytes()
       [id][google.api.AuthProvider.id] from authentication provider.
 Example:
     provider_id: bookstore_auth
      string provider_id = 1;
      Returns:
      The bytes for providerId.

    • getAudiences

      String getAudiences()
       NOTE: This will be deprecated soon, once AuthProvider.audiences is
 implemented and accepted in all the runtime components.
 The list of JWT
 [audiences](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32#section-4.1.3).
 that are allowed to access. A JWT containing any of these audiences will
 be accepted. When this setting is absent, only JWTs with audience
 "https://[Service_name][google.api.Service.name]/[API_name][google.protobuf.Api.name]"
 will be accepted. For example, if no audiences are in the setting,
 LibraryService API will only accept JWTs with the following audience
 "https://library-example.googleapis.com/google.example.library.v1.LibraryService".
 Example:
     audiences: bookstore_android.apps.googleusercontent.com,
                bookstore_web.apps.googleusercontent.com
      string audiences = 2;
      Returns:
      The audiences.

    • getAudiencesBytes

      com.google.protobuf.ByteString getAudiencesBytes()
       NOTE: This will be deprecated soon, once AuthProvider.audiences is
 implemented and accepted in all the runtime components.
 The list of JWT
 [audiences](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32#section-4.1.3).
 that are allowed to access. A JWT containing any of these audiences will
 be accepted. When this setting is absent, only JWTs with audience
 "https://[Service_name][google.api.Service.name]/[API_name][google.protobuf.Api.name]"
 will be accepted. For example, if no audiences are in the setting,
 LibraryService API will only accept JWTs with the following audience
 "https://library-example.googleapis.com/google.example.library.v1.LibraryService".
 Example:
     audiences: bookstore_android.apps.googleusercontent.com,
                bookstore_web.apps.googleusercontent.com
      string audiences = 2;
      Returns:
      The bytes for audiences.