com.google.api.OAuthRequirements Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of grpc-core-proto Show documentation
Show all versions of grpc-core-proto Show documentation
GoogleAPI classes generated from core protos
// Generated by the protocol buffer compiler. DO NOT EDIT!
// source: google/api/auth.proto
package com.google.api;
/**
* Protobuf type {@code google.api.OAuthRequirements}
*
*
* 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.
*
*/
public final class OAuthRequirements extends
com.google.protobuf.GeneratedMessage implements
// @@protoc_insertion_point(message_implements:google.api.OAuthRequirements)
OAuthRequirementsOrBuilder {
// Use OAuthRequirements.newBuilder() to construct.
private OAuthRequirements(com.google.protobuf.GeneratedMessage.Builder builder) {
super(builder);
}
private OAuthRequirements() {
canonicalScopes_ = "";
}
@java.lang.Override
public final com.google.protobuf.UnknownFieldSet
getUnknownFields() {
return com.google.protobuf.UnknownFieldSet.getDefaultInstance();
}
private OAuthRequirements(
com.google.protobuf.CodedInputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) {
this();
int mutable_bitField0_ = 0;
try {
boolean done = false;
while (!done) {
int tag = input.readTag();
switch (tag) {
case 0:
done = true;
break;
default: {
if (!input.skipField(tag)) {
done = true;
}
break;
}
case 10: {
java.lang.String s = input.readStringRequireUtf8();
canonicalScopes_ = s;
break;
}
}
}
} catch (com.google.protobuf.InvalidProtocolBufferException e) {
throw new RuntimeException(e.setUnfinishedMessage(this));
} catch (java.io.IOException e) {
throw new RuntimeException(
new com.google.protobuf.InvalidProtocolBufferException(
e.getMessage()).setUnfinishedMessage(this));
} finally {
makeExtensionsImmutable();
}
}
public static final com.google.protobuf.Descriptors.Descriptor
getDescriptor() {
return com.google.api.AuthProto.internal_static_google_api_OAuthRequirements_descriptor;
}
protected com.google.protobuf.GeneratedMessage.FieldAccessorTable
internalGetFieldAccessorTable() {
return com.google.api.AuthProto.internal_static_google_api_OAuthRequirements_fieldAccessorTable
.ensureFieldAccessorsInitialized(
com.google.api.OAuthRequirements.class, com.google.api.OAuthRequirements.Builder.class);
}
public static final int CANONICAL_SCOPES_FIELD_NUMBER = 1;
private volatile java.lang.Object canonicalScopes_;
/**
* optional string canonical_scopes = 1;
*
*
* 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
*
*/
public java.lang.String getCanonicalScopes() {
java.lang.Object ref = canonicalScopes_;
if (ref instanceof java.lang.String) {
return (java.lang.String) ref;
} else {
com.google.protobuf.ByteString bs =
(com.google.protobuf.ByteString) ref;
java.lang.String s = bs.toStringUtf8();
canonicalScopes_ = s;
return s;
}
}
/**
* optional string canonical_scopes = 1;
*
*
* 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
*
*/
public com.google.protobuf.ByteString
getCanonicalScopesBytes() {
java.lang.Object ref = canonicalScopes_;
if (ref instanceof java.lang.String) {
com.google.protobuf.ByteString b =
com.google.protobuf.ByteString.copyFromUtf8(
(java.lang.String) ref);
canonicalScopes_ = b;
return b;
} else {
return (com.google.protobuf.ByteString) ref;
}
}
private byte memoizedIsInitialized = -1;
public final boolean isInitialized() {
byte isInitialized = memoizedIsInitialized;
if (isInitialized == 1) return true;
if (isInitialized == 0) return false;
memoizedIsInitialized = 1;
return true;
}
public void writeTo(com.google.protobuf.CodedOutputStream output)
throws java.io.IOException {
if (!getCanonicalScopesBytes().isEmpty()) {
com.google.protobuf.GeneratedMessage.writeString(output, 1, canonicalScopes_);
}
}
public int getSerializedSize() {
int size = memoizedSize;
if (size != -1) return size;
size = 0;
if (!getCanonicalScopesBytes().isEmpty()) {
size += com.google.protobuf.GeneratedMessage.computeStringSize(1, canonicalScopes_);
}
memoizedSize = size;
return size;
}
private static final long serialVersionUID = 0L;
public static com.google.api.OAuthRequirements parseFrom(
com.google.protobuf.ByteString data)
throws com.google.protobuf.InvalidProtocolBufferException {
return PARSER.parseFrom(data);
}
public static com.google.api.OAuthRequirements parseFrom(
com.google.protobuf.ByteString data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry)
throws com.google.protobuf.InvalidProtocolBufferException {
return PARSER.parseFrom(data, extensionRegistry);
}
public static com.google.api.OAuthRequirements parseFrom(byte[] data)
throws com.google.protobuf.InvalidProtocolBufferException {
return PARSER.parseFrom(data);
}
public static com.google.api.OAuthRequirements parseFrom(
byte[] data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry)
throws com.google.protobuf.InvalidProtocolBufferException {
return PARSER.parseFrom(data, extensionRegistry);
}
public static com.google.api.OAuthRequirements parseFrom(java.io.InputStream input)
throws java.io.IOException {
return PARSER.parseFrom(input);
}
public static com.google.api.OAuthRequirements parseFrom(
java.io.InputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry)
throws java.io.IOException {
return PARSER.parseFrom(input, extensionRegistry);
}
public static com.google.api.OAuthRequirements parseDelimitedFrom(java.io.InputStream input)
throws java.io.IOException {
return PARSER.parseDelimitedFrom(input);
}
public static com.google.api.OAuthRequirements parseDelimitedFrom(
java.io.InputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry)
throws java.io.IOException {
return PARSER.parseDelimitedFrom(input, extensionRegistry);
}
public static com.google.api.OAuthRequirements parseFrom(
com.google.protobuf.CodedInputStream input)
throws java.io.IOException {
return PARSER.parseFrom(input);
}
public static com.google.api.OAuthRequirements parseFrom(
com.google.protobuf.CodedInputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry)
throws java.io.IOException {
return PARSER.parseFrom(input, extensionRegistry);
}
public Builder newBuilderForType() { return newBuilder(); }
public static Builder newBuilder() {
return DEFAULT_INSTANCE.toBuilder();
}
public static Builder newBuilder(com.google.api.OAuthRequirements prototype) {
return DEFAULT_INSTANCE.toBuilder().mergeFrom(prototype);
}
public Builder toBuilder() {
return this == DEFAULT_INSTANCE
? new Builder() : new Builder().mergeFrom(this);
}
@java.lang.Override
protected Builder newBuilderForType(
com.google.protobuf.GeneratedMessage.BuilderParent parent) {
Builder builder = new Builder(parent);
return builder;
}
/**
* Protobuf type {@code google.api.OAuthRequirements}
*
*
* 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.
*
*/
public static final class Builder extends
com.google.protobuf.GeneratedMessage.Builder implements
// @@protoc_insertion_point(builder_implements:google.api.OAuthRequirements)
com.google.api.OAuthRequirementsOrBuilder {
public static final com.google.protobuf.Descriptors.Descriptor
getDescriptor() {
return com.google.api.AuthProto.internal_static_google_api_OAuthRequirements_descriptor;
}
protected com.google.protobuf.GeneratedMessage.FieldAccessorTable
internalGetFieldAccessorTable() {
return com.google.api.AuthProto.internal_static_google_api_OAuthRequirements_fieldAccessorTable
.ensureFieldAccessorsInitialized(
com.google.api.OAuthRequirements.class, com.google.api.OAuthRequirements.Builder.class);
}
// Construct using com.google.api.OAuthRequirements.newBuilder()
private Builder() {
maybeForceBuilderInitialization();
}
private Builder(
com.google.protobuf.GeneratedMessage.BuilderParent parent) {
super(parent);
maybeForceBuilderInitialization();
}
private void maybeForceBuilderInitialization() {
if (com.google.protobuf.GeneratedMessage.alwaysUseFieldBuilders) {
}
}
public Builder clear() {
super.clear();
canonicalScopes_ = "";
return this;
}
public com.google.protobuf.Descriptors.Descriptor
getDescriptorForType() {
return com.google.api.AuthProto.internal_static_google_api_OAuthRequirements_descriptor;
}
public com.google.api.OAuthRequirements getDefaultInstanceForType() {
return com.google.api.OAuthRequirements.getDefaultInstance();
}
public com.google.api.OAuthRequirements build() {
com.google.api.OAuthRequirements result = buildPartial();
if (!result.isInitialized()) {
throw newUninitializedMessageException(result);
}
return result;
}
public com.google.api.OAuthRequirements buildPartial() {
com.google.api.OAuthRequirements result = new com.google.api.OAuthRequirements(this);
result.canonicalScopes_ = canonicalScopes_;
onBuilt();
return result;
}
public Builder mergeFrom(com.google.protobuf.Message other) {
if (other instanceof com.google.api.OAuthRequirements) {
return mergeFrom((com.google.api.OAuthRequirements)other);
} else {
super.mergeFrom(other);
return this;
}
}
public Builder mergeFrom(com.google.api.OAuthRequirements other) {
if (other == com.google.api.OAuthRequirements.getDefaultInstance()) return this;
if (!other.getCanonicalScopes().isEmpty()) {
canonicalScopes_ = other.canonicalScopes_;
onChanged();
}
onChanged();
return this;
}
public final boolean isInitialized() {
return true;
}
public Builder mergeFrom(
com.google.protobuf.CodedInputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry)
throws java.io.IOException {
com.google.api.OAuthRequirements parsedMessage = null;
try {
parsedMessage = PARSER.parsePartialFrom(input, extensionRegistry);
} catch (com.google.protobuf.InvalidProtocolBufferException e) {
parsedMessage = (com.google.api.OAuthRequirements) e.getUnfinishedMessage();
throw e;
} finally {
if (parsedMessage != null) {
mergeFrom(parsedMessage);
}
}
return this;
}
private java.lang.Object canonicalScopes_ = "";
/**
* optional string canonical_scopes = 1;
*
*
* 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
*
*/
public java.lang.String getCanonicalScopes() {
java.lang.Object ref = canonicalScopes_;
if (!(ref instanceof java.lang.String)) {
com.google.protobuf.ByteString bs =
(com.google.protobuf.ByteString) ref;
java.lang.String s = bs.toStringUtf8();
canonicalScopes_ = s;
return s;
} else {
return (java.lang.String) ref;
}
}
/**
* optional string canonical_scopes = 1;
*
*
* 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
*
*/
public com.google.protobuf.ByteString
getCanonicalScopesBytes() {
java.lang.Object ref = canonicalScopes_;
if (ref instanceof String) {
com.google.protobuf.ByteString b =
com.google.protobuf.ByteString.copyFromUtf8(
(java.lang.String) ref);
canonicalScopes_ = b;
return b;
} else {
return (com.google.protobuf.ByteString) ref;
}
}
/**
* optional string canonical_scopes = 1;
*
*
* 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
*
*/
public Builder setCanonicalScopes(
java.lang.String value) {
if (value == null) {
throw new NullPointerException();
}
canonicalScopes_ = value;
onChanged();
return this;
}
/**
* optional string canonical_scopes = 1;
*
*
* 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
*
*/
public Builder clearCanonicalScopes() {
canonicalScopes_ = getDefaultInstance().getCanonicalScopes();
onChanged();
return this;
}
/**
* optional string canonical_scopes = 1;
*
*
* 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
*
*/
public Builder setCanonicalScopesBytes(
com.google.protobuf.ByteString value) {
if (value == null) {
throw new NullPointerException();
}
checkByteStringIsUtf8(value);
canonicalScopes_ = value;
onChanged();
return this;
}
public final Builder setUnknownFields(
final com.google.protobuf.UnknownFieldSet unknownFields) {
return this;
}
public final Builder mergeUnknownFields(
final com.google.protobuf.UnknownFieldSet unknownFields) {
return this;
}
// @@protoc_insertion_point(builder_scope:google.api.OAuthRequirements)
}
// @@protoc_insertion_point(class_scope:google.api.OAuthRequirements)
private static final com.google.api.OAuthRequirements DEFAULT_INSTANCE;
static {
DEFAULT_INSTANCE = new com.google.api.OAuthRequirements();
}
public static com.google.api.OAuthRequirements getDefaultInstance() {
return DEFAULT_INSTANCE;
}
private static final com.google.protobuf.Parser
PARSER = new com.google.protobuf.AbstractParser() {
public OAuthRequirements parsePartialFrom(
com.google.protobuf.CodedInputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry)
throws com.google.protobuf.InvalidProtocolBufferException {
try {
return new OAuthRequirements(input, extensionRegistry);
} catch (RuntimeException e) {
if (e.getCause() instanceof
com.google.protobuf.InvalidProtocolBufferException) {
throw (com.google.protobuf.InvalidProtocolBufferException)
e.getCause();
}
throw e;
}
}
};
public static com.google.protobuf.Parser parser() {
return PARSER;
}
@java.lang.Override
public com.google.protobuf.Parser getParserForType() {
return PARSER;
}
public com.google.api.OAuthRequirements getDefaultInstanceForType() {
return DEFAULT_INSTANCE;
}
}