com.google.api.UsageRule Maven / Gradle / Ivy
The newest version!
// Generated by the protocol buffer compiler. DO NOT EDIT!
// source: google/api/usage.proto
package com.google.api;
/**
*
* Usage configuration rules for the service.
* NOTE: Under development.
* Use this rule to configure unregistered calls for the service. Unregistered
* calls are calls that do not contain consumer project identity.
* (Example: calls that do not contain an API key).
* By default, API methods do not allow unregistered calls, and each method call
* must be identified by a consumer project identity. Use this rule to
* allow/disallow unregistered calls.
* Example of an API that wants to allow unregistered calls for entire service.
* usage:
* rules:
* - selector: "*"
* allow_unregistered_calls: true
* Example of a method that wants to allow unregistered calls.
* usage:
* rules:
* - selector: "google.example.library.v1.LibraryService.CreateBook"
* allow_unregistered_calls: true
*
*
* Protobuf type {@code google.api.UsageRule}
*/
public final class UsageRule extends
com.google.protobuf.GeneratedMessageV3 implements
// @@protoc_insertion_point(message_implements:google.api.UsageRule)
UsageRuleOrBuilder {
private static final long serialVersionUID = 0L;
// Use UsageRule.newBuilder() to construct.
private UsageRule(com.google.protobuf.GeneratedMessageV3.Builder builder) {
super(builder);
}
private UsageRule() {
selector_ = "";
allowUnregisteredCalls_ = false;
skipServiceControl_ = false;
}
@java.lang.Override
public final com.google.protobuf.UnknownFieldSet
getUnknownFields() {
return this.unknownFields;
}
private UsageRule(
com.google.protobuf.CodedInputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry)
throws com.google.protobuf.InvalidProtocolBufferException {
this();
if (extensionRegistry == null) {
throw new java.lang.NullPointerException();
}
int mutable_bitField0_ = 0;
com.google.protobuf.UnknownFieldSet.Builder unknownFields =
com.google.protobuf.UnknownFieldSet.newBuilder();
try {
boolean done = false;
while (!done) {
int tag = input.readTag();
switch (tag) {
case 0:
done = true;
break;
case 10: {
java.lang.String s = input.readStringRequireUtf8();
selector_ = s;
break;
}
case 16: {
allowUnregisteredCalls_ = input.readBool();
break;
}
case 24: {
skipServiceControl_ = input.readBool();
break;
}
default: {
if (!parseUnknownFieldProto3(
input, unknownFields, extensionRegistry, tag)) {
done = true;
}
break;
}
}
}
} catch (com.google.protobuf.InvalidProtocolBufferException e) {
throw e.setUnfinishedMessage(this);
} catch (java.io.IOException e) {
throw new com.google.protobuf.InvalidProtocolBufferException(
e).setUnfinishedMessage(this);
} finally {
this.unknownFields = unknownFields.build();
makeExtensionsImmutable();
}
}
public static final com.google.protobuf.Descriptors.Descriptor
getDescriptor() {
return com.google.api.UsageProto.internal_static_google_api_UsageRule_descriptor;
}
@java.lang.Override
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable
internalGetFieldAccessorTable() {
return com.google.api.UsageProto.internal_static_google_api_UsageRule_fieldAccessorTable
.ensureFieldAccessorsInitialized(
com.google.api.UsageRule.class, com.google.api.UsageRule.Builder.class);
}
public static final int SELECTOR_FIELD_NUMBER = 1;
private volatile java.lang.Object selector_;
/**
*
* Selects the methods to which this rule applies. Use '*' to indicate all
* methods in all APIs.
* Refer to [selector][google.api.DocumentationRule.selector] for syntax details.
*
*
* string selector = 1;
*/
public java.lang.String getSelector() {
java.lang.Object ref = selector_;
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();
selector_ = s;
return s;
}
}
/**
*
* Selects the methods to which this rule applies. Use '*' to indicate all
* methods in all APIs.
* Refer to [selector][google.api.DocumentationRule.selector] for syntax details.
*
*
* string selector = 1;
*/
public com.google.protobuf.ByteString
getSelectorBytes() {
java.lang.Object ref = selector_;
if (ref instanceof java.lang.String) {
com.google.protobuf.ByteString b =
com.google.protobuf.ByteString.copyFromUtf8(
(java.lang.String) ref);
selector_ = b;
return b;
} else {
return (com.google.protobuf.ByteString) ref;
}
}
public static final int ALLOW_UNREGISTERED_CALLS_FIELD_NUMBER = 2;
private boolean allowUnregisteredCalls_;
/**
*
* If true, the selected method allows unregistered calls, e.g. calls
* that don't identify any user or application.
*
*
* bool allow_unregistered_calls = 2;
*/
public boolean getAllowUnregisteredCalls() {
return allowUnregisteredCalls_;
}
public static final int SKIP_SERVICE_CONTROL_FIELD_NUMBER = 3;
private boolean skipServiceControl_;
/**
*
* If true, the selected method should skip service control and the control
* plane features, such as quota and billing, will not be available.
* This flag is used by Google Cloud Endpoints to bypass checks for internal
* methods, such as service health check methods.
*
*
* bool skip_service_control = 3;
*/
public boolean getSkipServiceControl() {
return skipServiceControl_;
}
private byte memoizedIsInitialized = -1;
@java.lang.Override
public final boolean isInitialized() {
byte isInitialized = memoizedIsInitialized;
if (isInitialized == 1) return true;
if (isInitialized == 0) return false;
memoizedIsInitialized = 1;
return true;
}
@java.lang.Override
public void writeTo(com.google.protobuf.CodedOutputStream output)
throws java.io.IOException {
if (!getSelectorBytes().isEmpty()) {
com.google.protobuf.GeneratedMessageV3.writeString(output, 1, selector_);
}
if (allowUnregisteredCalls_ != false) {
output.writeBool(2, allowUnregisteredCalls_);
}
if (skipServiceControl_ != false) {
output.writeBool(3, skipServiceControl_);
}
unknownFields.writeTo(output);
}
@java.lang.Override
public int getSerializedSize() {
int size = memoizedSize;
if (size != -1) return size;
size = 0;
if (!getSelectorBytes().isEmpty()) {
size += com.google.protobuf.GeneratedMessageV3.computeStringSize(1, selector_);
}
if (allowUnregisteredCalls_ != false) {
size += com.google.protobuf.CodedOutputStream
.computeBoolSize(2, allowUnregisteredCalls_);
}
if (skipServiceControl_ != false) {
size += com.google.protobuf.CodedOutputStream
.computeBoolSize(3, skipServiceControl_);
}
size += unknownFields.getSerializedSize();
memoizedSize = size;
return size;
}
@java.lang.Override
public boolean equals(final java.lang.Object obj) {
if (obj == this) {
return true;
}
if (!(obj instanceof com.google.api.UsageRule)) {
return super.equals(obj);
}
com.google.api.UsageRule other = (com.google.api.UsageRule) obj;
boolean result = true;
result = result && getSelector()
.equals(other.getSelector());
result = result && (getAllowUnregisteredCalls()
== other.getAllowUnregisteredCalls());
result = result && (getSkipServiceControl()
== other.getSkipServiceControl());
result = result && unknownFields.equals(other.unknownFields);
return result;
}
@java.lang.Override
public int hashCode() {
if (memoizedHashCode != 0) {
return memoizedHashCode;
}
int hash = 41;
hash = (19 * hash) + getDescriptor().hashCode();
hash = (37 * hash) + SELECTOR_FIELD_NUMBER;
hash = (53 * hash) + getSelector().hashCode();
hash = (37 * hash) + ALLOW_UNREGISTERED_CALLS_FIELD_NUMBER;
hash = (53 * hash) + com.google.protobuf.Internal.hashBoolean(
getAllowUnregisteredCalls());
hash = (37 * hash) + SKIP_SERVICE_CONTROL_FIELD_NUMBER;
hash = (53 * hash) + com.google.protobuf.Internal.hashBoolean(
getSkipServiceControl());
hash = (29 * hash) + unknownFields.hashCode();
memoizedHashCode = hash;
return hash;
}
public static com.google.api.UsageRule parseFrom(
java.nio.ByteBuffer data)
throws com.google.protobuf.InvalidProtocolBufferException {
return PARSER.parseFrom(data);
}
public static com.google.api.UsageRule parseFrom(
java.nio.ByteBuffer data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry)
throws com.google.protobuf.InvalidProtocolBufferException {
return PARSER.parseFrom(data, extensionRegistry);
}
public static com.google.api.UsageRule parseFrom(
com.google.protobuf.ByteString data)
throws com.google.protobuf.InvalidProtocolBufferException {
return PARSER.parseFrom(data);
}
public static com.google.api.UsageRule 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.UsageRule parseFrom(byte[] data)
throws com.google.protobuf.InvalidProtocolBufferException {
return PARSER.parseFrom(data);
}
public static com.google.api.UsageRule parseFrom(
byte[] data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry)
throws com.google.protobuf.InvalidProtocolBufferException {
return PARSER.parseFrom(data, extensionRegistry);
}
public static com.google.api.UsageRule parseFrom(java.io.InputStream input)
throws java.io.IOException {
return com.google.protobuf.GeneratedMessageV3
.parseWithIOException(PARSER, input);
}
public static com.google.api.UsageRule parseFrom(
java.io.InputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry)
throws java.io.IOException {
return com.google.protobuf.GeneratedMessageV3
.parseWithIOException(PARSER, input, extensionRegistry);
}
public static com.google.api.UsageRule parseDelimitedFrom(java.io.InputStream input)
throws java.io.IOException {
return com.google.protobuf.GeneratedMessageV3
.parseDelimitedWithIOException(PARSER, input);
}
public static com.google.api.UsageRule parseDelimitedFrom(
java.io.InputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry)
throws java.io.IOException {
return com.google.protobuf.GeneratedMessageV3
.parseDelimitedWithIOException(PARSER, input, extensionRegistry);
}
public static com.google.api.UsageRule parseFrom(
com.google.protobuf.CodedInputStream input)
throws java.io.IOException {
return com.google.protobuf.GeneratedMessageV3
.parseWithIOException(PARSER, input);
}
public static com.google.api.UsageRule parseFrom(
com.google.protobuf.CodedInputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry)
throws java.io.IOException {
return com.google.protobuf.GeneratedMessageV3
.parseWithIOException(PARSER, input, extensionRegistry);
}
@java.lang.Override
public Builder newBuilderForType() { return newBuilder(); }
public static Builder newBuilder() {
return DEFAULT_INSTANCE.toBuilder();
}
public static Builder newBuilder(com.google.api.UsageRule prototype) {
return DEFAULT_INSTANCE.toBuilder().mergeFrom(prototype);
}
@java.lang.Override
public Builder toBuilder() {
return this == DEFAULT_INSTANCE
? new Builder() : new Builder().mergeFrom(this);
}
@java.lang.Override
protected Builder newBuilderForType(
com.google.protobuf.GeneratedMessageV3.BuilderParent parent) {
Builder builder = new Builder(parent);
return builder;
}
/**
*
* Usage configuration rules for the service.
* NOTE: Under development.
* Use this rule to configure unregistered calls for the service. Unregistered
* calls are calls that do not contain consumer project identity.
* (Example: calls that do not contain an API key).
* By default, API methods do not allow unregistered calls, and each method call
* must be identified by a consumer project identity. Use this rule to
* allow/disallow unregistered calls.
* Example of an API that wants to allow unregistered calls for entire service.
* usage:
* rules:
* - selector: "*"
* allow_unregistered_calls: true
* Example of a method that wants to allow unregistered calls.
* usage:
* rules:
* - selector: "google.example.library.v1.LibraryService.CreateBook"
* allow_unregistered_calls: true
*
*
* Protobuf type {@code google.api.UsageRule}
*/
public static final class Builder extends
com.google.protobuf.GeneratedMessageV3.Builder implements
// @@protoc_insertion_point(builder_implements:google.api.UsageRule)
com.google.api.UsageRuleOrBuilder {
public static final com.google.protobuf.Descriptors.Descriptor
getDescriptor() {
return com.google.api.UsageProto.internal_static_google_api_UsageRule_descriptor;
}
@java.lang.Override
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable
internalGetFieldAccessorTable() {
return com.google.api.UsageProto.internal_static_google_api_UsageRule_fieldAccessorTable
.ensureFieldAccessorsInitialized(
com.google.api.UsageRule.class, com.google.api.UsageRule.Builder.class);
}
// Construct using com.google.api.UsageRule.newBuilder()
private Builder() {
maybeForceBuilderInitialization();
}
private Builder(
com.google.protobuf.GeneratedMessageV3.BuilderParent parent) {
super(parent);
maybeForceBuilderInitialization();
}
private void maybeForceBuilderInitialization() {
if (com.google.protobuf.GeneratedMessageV3
.alwaysUseFieldBuilders) {
}
}
@java.lang.Override
public Builder clear() {
super.clear();
selector_ = "";
allowUnregisteredCalls_ = false;
skipServiceControl_ = false;
return this;
}
@java.lang.Override
public com.google.protobuf.Descriptors.Descriptor
getDescriptorForType() {
return com.google.api.UsageProto.internal_static_google_api_UsageRule_descriptor;
}
@java.lang.Override
public com.google.api.UsageRule getDefaultInstanceForType() {
return com.google.api.UsageRule.getDefaultInstance();
}
@java.lang.Override
public com.google.api.UsageRule build() {
com.google.api.UsageRule result = buildPartial();
if (!result.isInitialized()) {
throw newUninitializedMessageException(result);
}
return result;
}
@java.lang.Override
public com.google.api.UsageRule buildPartial() {
com.google.api.UsageRule result = new com.google.api.UsageRule(this);
result.selector_ = selector_;
result.allowUnregisteredCalls_ = allowUnregisteredCalls_;
result.skipServiceControl_ = skipServiceControl_;
onBuilt();
return result;
}
@java.lang.Override
public Builder clone() {
return (Builder) super.clone();
}
@java.lang.Override
public Builder setField(
com.google.protobuf.Descriptors.FieldDescriptor field,
java.lang.Object value) {
return (Builder) super.setField(field, value);
}
@java.lang.Override
public Builder clearField(
com.google.protobuf.Descriptors.FieldDescriptor field) {
return (Builder) super.clearField(field);
}
@java.lang.Override
public Builder clearOneof(
com.google.protobuf.Descriptors.OneofDescriptor oneof) {
return (Builder) super.clearOneof(oneof);
}
@java.lang.Override
public Builder setRepeatedField(
com.google.protobuf.Descriptors.FieldDescriptor field,
int index, java.lang.Object value) {
return (Builder) super.setRepeatedField(field, index, value);
}
@java.lang.Override
public Builder addRepeatedField(
com.google.protobuf.Descriptors.FieldDescriptor field,
java.lang.Object value) {
return (Builder) super.addRepeatedField(field, value);
}
@java.lang.Override
public Builder mergeFrom(com.google.protobuf.Message other) {
if (other instanceof com.google.api.UsageRule) {
return mergeFrom((com.google.api.UsageRule)other);
} else {
super.mergeFrom(other);
return this;
}
}
public Builder mergeFrom(com.google.api.UsageRule other) {
if (other == com.google.api.UsageRule.getDefaultInstance()) return this;
if (!other.getSelector().isEmpty()) {
selector_ = other.selector_;
onChanged();
}
if (other.getAllowUnregisteredCalls() != false) {
setAllowUnregisteredCalls(other.getAllowUnregisteredCalls());
}
if (other.getSkipServiceControl() != false) {
setSkipServiceControl(other.getSkipServiceControl());
}
this.mergeUnknownFields(other.unknownFields);
onChanged();
return this;
}
@java.lang.Override
public final boolean isInitialized() {
return true;
}
@java.lang.Override
public Builder mergeFrom(
com.google.protobuf.CodedInputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry)
throws java.io.IOException {
com.google.api.UsageRule parsedMessage = null;
try {
parsedMessage = PARSER.parsePartialFrom(input, extensionRegistry);
} catch (com.google.protobuf.InvalidProtocolBufferException e) {
parsedMessage = (com.google.api.UsageRule) e.getUnfinishedMessage();
throw e.unwrapIOException();
} finally {
if (parsedMessage != null) {
mergeFrom(parsedMessage);
}
}
return this;
}
private java.lang.Object selector_ = "";
/**
*
* Selects the methods to which this rule applies. Use '*' to indicate all
* methods in all APIs.
* Refer to [selector][google.api.DocumentationRule.selector] for syntax details.
*
*
* string selector = 1;
*/
public java.lang.String getSelector() {
java.lang.Object ref = selector_;
if (!(ref instanceof java.lang.String)) {
com.google.protobuf.ByteString bs =
(com.google.protobuf.ByteString) ref;
java.lang.String s = bs.toStringUtf8();
selector_ = s;
return s;
} else {
return (java.lang.String) ref;
}
}
/**
*
* Selects the methods to which this rule applies. Use '*' to indicate all
* methods in all APIs.
* Refer to [selector][google.api.DocumentationRule.selector] for syntax details.
*
*
* string selector = 1;
*/
public com.google.protobuf.ByteString
getSelectorBytes() {
java.lang.Object ref = selector_;
if (ref instanceof String) {
com.google.protobuf.ByteString b =
com.google.protobuf.ByteString.copyFromUtf8(
(java.lang.String) ref);
selector_ = b;
return b;
} else {
return (com.google.protobuf.ByteString) ref;
}
}
/**
*
* Selects the methods to which this rule applies. Use '*' to indicate all
* methods in all APIs.
* Refer to [selector][google.api.DocumentationRule.selector] for syntax details.
*
*
* string selector = 1;
*/
public Builder setSelector(
java.lang.String value) {
if (value == null) {
throw new NullPointerException();
}
selector_ = value;
onChanged();
return this;
}
/**
*
* Selects the methods to which this rule applies. Use '*' to indicate all
* methods in all APIs.
* Refer to [selector][google.api.DocumentationRule.selector] for syntax details.
*
*
* string selector = 1;
*/
public Builder clearSelector() {
selector_ = getDefaultInstance().getSelector();
onChanged();
return this;
}
/**
*
* Selects the methods to which this rule applies. Use '*' to indicate all
* methods in all APIs.
* Refer to [selector][google.api.DocumentationRule.selector] for syntax details.
*
*
* string selector = 1;
*/
public Builder setSelectorBytes(
com.google.protobuf.ByteString value) {
if (value == null) {
throw new NullPointerException();
}
checkByteStringIsUtf8(value);
selector_ = value;
onChanged();
return this;
}
private boolean allowUnregisteredCalls_ ;
/**
*
* If true, the selected method allows unregistered calls, e.g. calls
* that don't identify any user or application.
*
*
* bool allow_unregistered_calls = 2;
*/
public boolean getAllowUnregisteredCalls() {
return allowUnregisteredCalls_;
}
/**
*
* If true, the selected method allows unregistered calls, e.g. calls
* that don't identify any user or application.
*
*
* bool allow_unregistered_calls = 2;
*/
public Builder setAllowUnregisteredCalls(boolean value) {
allowUnregisteredCalls_ = value;
onChanged();
return this;
}
/**
*
* If true, the selected method allows unregistered calls, e.g. calls
* that don't identify any user or application.
*
*
* bool allow_unregistered_calls = 2;
*/
public Builder clearAllowUnregisteredCalls() {
allowUnregisteredCalls_ = false;
onChanged();
return this;
}
private boolean skipServiceControl_ ;
/**
*
* If true, the selected method should skip service control and the control
* plane features, such as quota and billing, will not be available.
* This flag is used by Google Cloud Endpoints to bypass checks for internal
* methods, such as service health check methods.
*
*
* bool skip_service_control = 3;
*/
public boolean getSkipServiceControl() {
return skipServiceControl_;
}
/**
*
* If true, the selected method should skip service control and the control
* plane features, such as quota and billing, will not be available.
* This flag is used by Google Cloud Endpoints to bypass checks for internal
* methods, such as service health check methods.
*
*
* bool skip_service_control = 3;
*/
public Builder setSkipServiceControl(boolean value) {
skipServiceControl_ = value;
onChanged();
return this;
}
/**
*
* If true, the selected method should skip service control and the control
* plane features, such as quota and billing, will not be available.
* This flag is used by Google Cloud Endpoints to bypass checks for internal
* methods, such as service health check methods.
*
*
* bool skip_service_control = 3;
*/
public Builder clearSkipServiceControl() {
skipServiceControl_ = false;
onChanged();
return this;
}
@java.lang.Override
public final Builder setUnknownFields(
final com.google.protobuf.UnknownFieldSet unknownFields) {
return super.setUnknownFieldsProto3(unknownFields);
}
@java.lang.Override
public final Builder mergeUnknownFields(
final com.google.protobuf.UnknownFieldSet unknownFields) {
return super.mergeUnknownFields(unknownFields);
}
// @@protoc_insertion_point(builder_scope:google.api.UsageRule)
}
// @@protoc_insertion_point(class_scope:google.api.UsageRule)
private static final com.google.api.UsageRule DEFAULT_INSTANCE;
static {
DEFAULT_INSTANCE = new com.google.api.UsageRule();
}
public static com.google.api.UsageRule getDefaultInstance() {
return DEFAULT_INSTANCE;
}
private static final com.google.protobuf.Parser
PARSER = new com.google.protobuf.AbstractParser() {
@java.lang.Override
public UsageRule parsePartialFrom(
com.google.protobuf.CodedInputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry)
throws com.google.protobuf.InvalidProtocolBufferException {
return new UsageRule(input, extensionRegistry);
}
};
public static com.google.protobuf.Parser parser() {
return PARSER;
}
@java.lang.Override
public com.google.protobuf.Parser getParserForType() {
return PARSER;
}
@java.lang.Override
public com.google.api.UsageRule getDefaultInstanceForType() {
return DEFAULT_INSTANCE;
}
}