Package com.google.api

Class OAuthRequirements.Builder

java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<BuilderT>
com.google.protobuf.GeneratedMessage.Builder<OAuthRequirements.Builder>
com.google.api.OAuthRequirements.Builder
All Implemented Interfaces:
OAuthRequirementsOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable
Enclosing class:
OAuthRequirements
public static final class OAuthRequirements.Builder extends com.google.protobuf.GeneratedMessage.Builder<OAuthRequirements.Builder> implements OAuthRequirementsOrBuilder
 OAuth scopes are a way to define data and permissions on data. For example,
 there are scopes defined for "Read-only access to Google Calendar" and
 "Access to Cloud Platform". Users can consent to a scope for an application,
 giving it permission to access that data on their behalf.

 OAuth scope specifications should be fairly coarse grained; a user will need
 to see and understand the text description of what your scope means.

 In most cases: use one or at most two OAuth scopes for an entire family of
 products. If your product has multiple APIs, you should probably be sharing
 the OAuth scope across all of those APIs.

 When you need finer grained OAuth consent screens: talk with your product
 management about how developers will use them in practice.

 Please note that even though each of the canonical scopes is enough for a
 request to be accepted and passed to the backend, a request can still fail
 due to the backend requiring additional scopes or permissions.
Protobuf type google.api.OAuthRequirements

  • Method Summary

    Modifier and Type
    Method
    Description
    OAuthRequirements
    build()
     
    OAuthRequirements
    buildPartial()
     
    OAuthRequirements.Builder
    clear()
     
    OAuthRequirements.Builder
    clearCanonicalScopes()
    The list of publicly documented OAuth scopes that are allowed access.
    String
    getCanonicalScopes()
    The list of publicly documented OAuth scopes that are allowed access.
    com.google.protobuf.ByteString
    getCanonicalScopesBytes()
    The list of publicly documented OAuth scopes that are allowed access.
    OAuthRequirements
    getDefaultInstanceForType()
     
    static final com.google.protobuf.Descriptors.Descriptor
    getDescriptor()
     
    com.google.protobuf.Descriptors.Descriptor
    getDescriptorForType()
     
    protected com.google.protobuf.GeneratedMessage.FieldAccessorTable
    internalGetFieldAccessorTable()
     
    final boolean
    isInitialized()
     
    OAuthRequirements.Builder
    mergeFrom(OAuthRequirements other)
     
    OAuthRequirements.Builder
    mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    OAuthRequirements.Builder
    mergeFrom(com.google.protobuf.Message other)
     
    OAuthRequirements.Builder
    setCanonicalScopes(String value)
    The list of publicly documented OAuth scopes that are allowed access.
    OAuthRequirements.Builder
    setCanonicalScopesBytes(com.google.protobuf.ByteString value)
    The list of publicly documented OAuth scopes that are allowed access.

    Methods inherited from class com.google.protobuf.GeneratedMessage.Builder

    addRepeatedField, clearField, clearOneof, clone, getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, internalGetMutableMapField, internalGetMutableMapFieldReflection, isClean, markClean, mergeUnknownFields, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setField, setRepeatedField, setUnknownFields, setUnknownFieldSetBuilder, setUnknownFieldsProto3

    Methods inherited from class com.google.protobuf.AbstractMessage.Builder

    findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toString

    Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder

    addAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, 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.Message.Builder

    mergeDelimitedFrom, mergeDelimitedFrom

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

    mergeFrom

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

  • Method Details

    • getDescriptor

      public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage.Builder<OAuthRequirements.Builder>

    • clear

      public OAuthRequirements.Builder clear()
      Specified by:
      clear in interface com.google.protobuf.Message.Builder
      Specified by:
      clear in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      clear in class com.google.protobuf.GeneratedMessage.Builder<OAuthRequirements.Builder>

    • getDescriptorForType

      public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
      Specified by:
      getDescriptorForType in interface com.google.protobuf.Message.Builder
      Specified by:
      getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
      Overrides:
      getDescriptorForType in class com.google.protobuf.GeneratedMessage.Builder<OAuthRequirements.Builder>

    • getDefaultInstanceForType

      public OAuthRequirements getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

    • build

      public OAuthRequirements build()
      Specified by:
      build in interface com.google.protobuf.Message.Builder
      Specified by:
      build in interface com.google.protobuf.MessageLite.Builder

    • buildPartial

      public OAuthRequirements buildPartial()
      Specified by:
      buildPartial in interface com.google.protobuf.Message.Builder
      Specified by:
      buildPartial in interface com.google.protobuf.MessageLite.Builder

    • mergeFrom

      public OAuthRequirements.Builder mergeFrom(com.google.protobuf.Message other)
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<OAuthRequirements.Builder>

    • mergeFrom

      public OAuthRequirements.Builder mergeFrom(OAuthRequirements other)

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage.Builder<OAuthRequirements.Builder>

    • mergeFrom

      public OAuthRequirements.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Specified by:
      mergeFrom in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<OAuthRequirements.Builder>
      Throws:
      IOException

    • getCanonicalScopes

      public String getCanonicalScopes()
       The list of publicly documented OAuth scopes that are allowed access. An
 OAuth token containing any of these scopes will be accepted.

 Example:

 canonical_scopes: https://www.googleapis.com/auth/calendar,
 https://www.googleapis.com/auth/calendar.read
      string canonical_scopes = 1;
      Specified by:
      getCanonicalScopes in interface OAuthRequirementsOrBuilder
      Returns:
      The canonicalScopes.

    • getCanonicalScopesBytes

      public com.google.protobuf.ByteString getCanonicalScopesBytes()
       The list of publicly documented OAuth scopes that are allowed access. An
 OAuth token containing any of these scopes will be accepted.

 Example:

 canonical_scopes: https://www.googleapis.com/auth/calendar,
 https://www.googleapis.com/auth/calendar.read
      string canonical_scopes = 1;
      Specified by:
      getCanonicalScopesBytes in interface OAuthRequirementsOrBuilder
      Returns:
      The bytes for canonicalScopes.

    • setCanonicalScopes

      public OAuthRequirements.Builder setCanonicalScopes(String value)
       The list of publicly documented OAuth scopes that are allowed access. An
 OAuth token containing any of these scopes will be accepted.

 Example:

 canonical_scopes: https://www.googleapis.com/auth/calendar,
 https://www.googleapis.com/auth/calendar.read
      string canonical_scopes = 1;
      Parameters:
      value - The canonicalScopes to set.
      Returns:
      This builder for chaining.

    • clearCanonicalScopes

      public OAuthRequirements.Builder clearCanonicalScopes()
       The list of publicly documented OAuth scopes that are allowed access. An
 OAuth token containing any of these scopes will be accepted.

 Example:

 canonical_scopes: https://www.googleapis.com/auth/calendar,
 https://www.googleapis.com/auth/calendar.read
      string canonical_scopes = 1;
      Returns:
      This builder for chaining.

    • setCanonicalScopesBytes

      public OAuthRequirements.Builder setCanonicalScopesBytes(com.google.protobuf.ByteString value)
       The list of publicly documented OAuth scopes that are allowed access. An
 OAuth token containing any of these scopes will be accepted.

 Example:

 canonical_scopes: https://www.googleapis.com/auth/calendar,
 https://www.googleapis.com/auth/calendar.read
      string canonical_scopes = 1;
      Parameters:
      value - The bytes for canonicalScopes to set.
      Returns:
      This builder for chaining.