com.google.api

Class OAuthRequirements.Builder

java.lang.Object

com.google.protobuf.AbstractMessageLite.Builder

com.google.protobuf.AbstractMessage.Builder<BuilderType>

com.google.protobuf.GeneratedMessageV3.Builder<OAuthRequirements.Builder>

com.google.api.OAuthRequirements.Builder

All Implemented Interfaces:

OAuthRequirementsOrBuilder, Message.Builder, MessageLite.Builder, MessageLiteOrBuilder, MessageOrBuilder, java.lang.Cloneable

Enclosing class:

OAuthRequirements

public static final class OAuthRequirements.Builder
extends GeneratedMessageV3.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 and Description
OAuthRequirements.Builder	addRepeatedField(Descriptors.FieldDescriptor field, java.lang.Object value)
OAuthRequirements	build()
OAuthRequirements	buildPartial()
OAuthRequirements.Builder	clear()
OAuthRequirements.Builder	clearCanonicalScopes() The list of publicly documented OAuth scopes that are allowed access.
OAuthRequirements.Builder	clearField(Descriptors.FieldDescriptor field)
OAuthRequirements.Builder	clearOneof(Descriptors.OneofDescriptor oneof)
OAuthRequirements.Builder	clone()
java.lang.String	getCanonicalScopes() The list of publicly documented OAuth scopes that are allowed access.
ByteString	getCanonicalScopesBytes() The list of publicly documented OAuth scopes that are allowed access.
OAuthRequirements	getDefaultInstanceForType()
static Descriptors.Descriptor	getDescriptor()
Descriptors.Descriptor	getDescriptorForType()
protected GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
OAuthRequirements.Builder	mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
OAuthRequirements.Builder	mergeFrom(Message other)
OAuthRequirements.Builder	mergeFrom(OAuthRequirements other)
OAuthRequirements.Builder	mergeUnknownFields(UnknownFieldSet unknownFields)
OAuthRequirements.Builder	setCanonicalScopes(java.lang.String value) The list of publicly documented OAuth scopes that are allowed access.
OAuthRequirements.Builder	setCanonicalScopesBytes(ByteString value) The list of publicly documented OAuth scopes that are allowed access.
OAuthRequirements.Builder	setField(Descriptors.FieldDescriptor field, java.lang.Object value)
OAuthRequirements.Builder	setRepeatedField(Descriptors.FieldDescriptor field, int index, java.lang.Object value)
OAuthRequirements.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<OAuthRequirements.Builder>

clear

public OAuthRequirements.Builder clear()

Specified by:

clear in interface Message.Builder

Specified by:

clear in interface MessageLite.Builder

Overrides:

clear in class GeneratedMessageV3.Builder<OAuthRequirements.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<OAuthRequirements.Builder>

getDefaultInstanceForType

public OAuthRequirements getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface MessageOrBuilder

build

public OAuthRequirements build()

Specified by:

build in interface Message.Builder

Specified by:

build in interface MessageLite.Builder

buildPartial

public OAuthRequirements buildPartial()

Specified by:

buildPartial in interface Message.Builder

Specified by:

buildPartial in interface MessageLite.Builder

clone

public OAuthRequirements.Builder clone()

Specified by:

clone in interface Message.Builder

Specified by:

clone in interface MessageLite.Builder

Overrides:

clone in class GeneratedMessageV3.Builder<OAuthRequirements.Builder>

setField

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

Specified by:

setField in interface Message.Builder

Overrides:

setField in class GeneratedMessageV3.Builder<OAuthRequirements.Builder>

clearField

public OAuthRequirements.Builder clearField(Descriptors.FieldDescriptor field)

Specified by:

clearField in interface Message.Builder

Overrides:

clearField in class GeneratedMessageV3.Builder<OAuthRequirements.Builder>

clearOneof

public OAuthRequirements.Builder clearOneof(Descriptors.OneofDescriptor oneof)

Specified by:

clearOneof in interface Message.Builder

Overrides:

clearOneof in class GeneratedMessageV3.Builder<OAuthRequirements.Builder>

setRepeatedField

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

Specified by:

setRepeatedField in interface Message.Builder

Overrides:

setRepeatedField in class GeneratedMessageV3.Builder<OAuthRequirements.Builder>

addRepeatedField

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

Specified by:

addRepeatedField in interface Message.Builder

Overrides:

addRepeatedField in class GeneratedMessageV3.Builder<OAuthRequirements.Builder>

mergeFrom

public OAuthRequirements.Builder mergeFrom(Message other)

Specified by:

mergeFrom in interface Message.Builder

Overrides:

mergeFrom in class AbstractMessage.Builder<OAuthRequirements.Builder>

mergeFrom

public OAuthRequirements.Builder mergeFrom(OAuthRequirements other)

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface MessageLiteOrBuilder

Overrides:

isInitialized in class GeneratedMessageV3.Builder<OAuthRequirements.Builder>

mergeFrom

public OAuthRequirements.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<OAuthRequirements.Builder>

Throws:

java.io.IOException

getCanonicalScopes

public java.lang.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

getCanonicalScopesBytes

public 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

setCanonicalScopes

public OAuthRequirements.Builder setCanonicalScopes(java.lang.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;

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;

setCanonicalScopesBytes

public OAuthRequirements.Builder setCanonicalScopesBytes(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;

setUnknownFields

public final OAuthRequirements.Builder setUnknownFields(UnknownFieldSet unknownFields)

Specified by:

setUnknownFields in interface Message.Builder

Overrides:

setUnknownFields in class GeneratedMessageV3.Builder<OAuthRequirements.Builder>

mergeUnknownFields

public final OAuthRequirements.Builder mergeUnknownFields(UnknownFieldSet unknownFields)

Specified by:

mergeUnknownFields in interface Message.Builder

Overrides:

mergeUnknownFields in class GeneratedMessageV3.Builder<OAuthRequirements.Builder>