public static final class OAuthRequirements.Builder extends com.google.protobuf.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
Modifier and Type | Method and Description |
---|---|
OAuthRequirements.Builder |
addRepeatedField(com.google.protobuf.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(com.google.protobuf.Descriptors.FieldDescriptor field) |
OAuthRequirements.Builder |
clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof) |
OAuthRequirements.Builder |
clone() |
java.lang.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 com.google.protobuf.Descriptors.Descriptor |
getDescriptor() |
com.google.protobuf.Descriptors.Descriptor |
getDescriptorForType() |
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable |
internalGetFieldAccessorTable() |
boolean |
isInitialized() |
OAuthRequirements.Builder |
mergeFrom(com.google.protobuf.CodedInputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
OAuthRequirements.Builder |
mergeFrom(com.google.protobuf.Message other) |
OAuthRequirements.Builder |
mergeFrom(OAuthRequirements other) |
OAuthRequirements.Builder |
mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields) |
OAuthRequirements.Builder |
setCanonicalScopes(java.lang.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.
|
OAuthRequirements.Builder |
setField(com.google.protobuf.Descriptors.FieldDescriptor field,
java.lang.Object value) |
OAuthRequirements.Builder |
setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
int index,
java.lang.Object value) |
OAuthRequirements.Builder |
setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields) |
getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMutableMapField, isClean, markClean, newBuilderForField, onBuilt, onChanged, setUnknownFieldsProto3
findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toString
addAll, addAll, mergeFrom, newUninitializedMessageException
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
internalGetFieldAccessorTable
in class com.google.protobuf.GeneratedMessageV3.Builder<OAuthRequirements.Builder>
public OAuthRequirements.Builder clear()
clear
in interface com.google.protobuf.Message.Builder
clear
in interface com.google.protobuf.MessageLite.Builder
clear
in class com.google.protobuf.GeneratedMessageV3.Builder<OAuthRequirements.Builder>
public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
getDescriptorForType
in interface com.google.protobuf.Message.Builder
getDescriptorForType
in interface com.google.protobuf.MessageOrBuilder
getDescriptorForType
in class com.google.protobuf.GeneratedMessageV3.Builder<OAuthRequirements.Builder>
public OAuthRequirements getDefaultInstanceForType()
getDefaultInstanceForType
in interface com.google.protobuf.MessageLiteOrBuilder
getDefaultInstanceForType
in interface com.google.protobuf.MessageOrBuilder
public OAuthRequirements build()
build
in interface com.google.protobuf.Message.Builder
build
in interface com.google.protobuf.MessageLite.Builder
public OAuthRequirements buildPartial()
buildPartial
in interface com.google.protobuf.Message.Builder
buildPartial
in interface com.google.protobuf.MessageLite.Builder
public OAuthRequirements.Builder clone()
clone
in interface com.google.protobuf.Message.Builder
clone
in interface com.google.protobuf.MessageLite.Builder
clone
in class com.google.protobuf.GeneratedMessageV3.Builder<OAuthRequirements.Builder>
public OAuthRequirements.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field, java.lang.Object value)
setField
in interface com.google.protobuf.Message.Builder
setField
in class com.google.protobuf.GeneratedMessageV3.Builder<OAuthRequirements.Builder>
public OAuthRequirements.Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
clearField
in interface com.google.protobuf.Message.Builder
clearField
in class com.google.protobuf.GeneratedMessageV3.Builder<OAuthRequirements.Builder>
public OAuthRequirements.Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
clearOneof
in interface com.google.protobuf.Message.Builder
clearOneof
in class com.google.protobuf.GeneratedMessageV3.Builder<OAuthRequirements.Builder>
public OAuthRequirements.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, java.lang.Object value)
setRepeatedField
in interface com.google.protobuf.Message.Builder
setRepeatedField
in class com.google.protobuf.GeneratedMessageV3.Builder<OAuthRequirements.Builder>
public OAuthRequirements.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, java.lang.Object value)
addRepeatedField
in interface com.google.protobuf.Message.Builder
addRepeatedField
in class com.google.protobuf.GeneratedMessageV3.Builder<OAuthRequirements.Builder>
public OAuthRequirements.Builder mergeFrom(com.google.protobuf.Message other)
mergeFrom
in interface com.google.protobuf.Message.Builder
mergeFrom
in class com.google.protobuf.AbstractMessage.Builder<OAuthRequirements.Builder>
public OAuthRequirements.Builder mergeFrom(OAuthRequirements other)
public final boolean isInitialized()
isInitialized
in interface com.google.protobuf.MessageLiteOrBuilder
isInitialized
in class com.google.protobuf.GeneratedMessageV3.Builder<OAuthRequirements.Builder>
public OAuthRequirements.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws java.io.IOException
mergeFrom
in interface com.google.protobuf.Message.Builder
mergeFrom
in interface com.google.protobuf.MessageLite.Builder
mergeFrom
in class com.google.protobuf.AbstractMessage.Builder<OAuthRequirements.Builder>
java.io.IOException
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;
getCanonicalScopes
in interface OAuthRequirementsOrBuilder
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;
getCanonicalScopesBytes
in interface OAuthRequirementsOrBuilder
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;
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;
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;
public final OAuthRequirements.Builder setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
setUnknownFields
in interface com.google.protobuf.Message.Builder
setUnknownFields
in class com.google.protobuf.GeneratedMessageV3.Builder<OAuthRequirements.Builder>
public final OAuthRequirements.Builder mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
mergeUnknownFields
in interface com.google.protobuf.Message.Builder
mergeUnknownFields
in class com.google.protobuf.GeneratedMessageV3.Builder<OAuthRequirements.Builder>