com.google.longrunning.Operation Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of proto-google-common-protos Show documentation
Show all versions of proto-google-common-protos Show documentation
PROTO library for proto-google-common-protos
/*
* Copyright 2024 Google LLC
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
// Generated by the protocol buffer compiler. DO NOT EDIT!
// source: google/longrunning/operations.proto
// Protobuf Java Version: 3.25.5
package com.google.longrunning;
/**
*
*
*
* This resource represents a long-running operation that is the result of a
* network API call.
*
*
* Protobuf type {@code google.longrunning.Operation}
*/
public final class Operation extends com.google.protobuf.GeneratedMessageV3
implements
// @@protoc_insertion_point(message_implements:google.longrunning.Operation)
OperationOrBuilder {
private static final long serialVersionUID = 0L;
// Use Operation.newBuilder() to construct.
private Operation(com.google.protobuf.GeneratedMessageV3.Builder builder) {
super(builder);
}
private Operation() {
name_ = "";
}
@java.lang.Override
@SuppressWarnings({"unused"})
protected java.lang.Object newInstance(UnusedPrivateParameter unused) {
return new Operation();
}
public static final com.google.protobuf.Descriptors.Descriptor getDescriptor() {
return com.google.longrunning.OperationsProto
.internal_static_google_longrunning_Operation_descriptor;
}
@java.lang.Override
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable
internalGetFieldAccessorTable() {
return com.google.longrunning.OperationsProto
.internal_static_google_longrunning_Operation_fieldAccessorTable
.ensureFieldAccessorsInitialized(
com.google.longrunning.Operation.class, com.google.longrunning.Operation.Builder.class);
}
private int bitField0_;
private int resultCase_ = 0;
@SuppressWarnings("serial")
private java.lang.Object result_;
public enum ResultCase
implements
com.google.protobuf.Internal.EnumLite,
com.google.protobuf.AbstractMessage.InternalOneOfEnum {
ERROR(4),
RESPONSE(5),
RESULT_NOT_SET(0);
private final int value;
private ResultCase(int value) {
this.value = value;
}
/**
* @param value The number of the enum to look for.
* @return The enum associated with the given number.
* @deprecated Use {@link #forNumber(int)} instead.
*/
@java.lang.Deprecated
public static ResultCase valueOf(int value) {
return forNumber(value);
}
public static ResultCase forNumber(int value) {
switch (value) {
case 4:
return ERROR;
case 5:
return RESPONSE;
case 0:
return RESULT_NOT_SET;
default:
return null;
}
}
public int getNumber() {
return this.value;
}
};
public ResultCase getResultCase() {
return ResultCase.forNumber(resultCase_);
}
public static final int NAME_FIELD_NUMBER = 1;
@SuppressWarnings("serial")
private volatile java.lang.Object name_ = "";
/**
*
*
*
* The server-assigned name, which is only unique within the same service that
* originally returns it. If you use the default HTTP mapping, the
* `name` should be a resource name ending with `operations/{unique_id}`.
*
*
* string name = 1;
*
* @return The name.
*/
@java.lang.Override
public java.lang.String getName() {
java.lang.Object ref = name_;
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();
name_ = s;
return s;
}
}
/**
*
*
*
* The server-assigned name, which is only unique within the same service that
* originally returns it. If you use the default HTTP mapping, the
* `name` should be a resource name ending with `operations/{unique_id}`.
*
*
* string name = 1;
*
* @return The bytes for name.
*/
@java.lang.Override
public com.google.protobuf.ByteString getNameBytes() {
java.lang.Object ref = name_;
if (ref instanceof java.lang.String) {
com.google.protobuf.ByteString b =
com.google.protobuf.ByteString.copyFromUtf8((java.lang.String) ref);
name_ = b;
return b;
} else {
return (com.google.protobuf.ByteString) ref;
}
}
public static final int METADATA_FIELD_NUMBER = 2;
private com.google.protobuf.Any metadata_;
/**
*
*
*
* Service-specific metadata associated with the operation. It typically
* contains progress information and common metadata such as create time.
* Some services might not provide such metadata. Any method that returns a
* long-running operation should document the metadata type, if any.
*
*
* .google.protobuf.Any metadata = 2;
*
* @return Whether the metadata field is set.
*/
@java.lang.Override
public boolean hasMetadata() {
return ((bitField0_ & 0x00000001) != 0);
}
/**
*
*
*
* Service-specific metadata associated with the operation. It typically
* contains progress information and common metadata such as create time.
* Some services might not provide such metadata. Any method that returns a
* long-running operation should document the metadata type, if any.
*
*
* .google.protobuf.Any metadata = 2;
*
* @return The metadata.
*/
@java.lang.Override
public com.google.protobuf.Any getMetadata() {
return metadata_ == null ? com.google.protobuf.Any.getDefaultInstance() : metadata_;
}
/**
*
*
*
* Service-specific metadata associated with the operation. It typically
* contains progress information and common metadata such as create time.
* Some services might not provide such metadata. Any method that returns a
* long-running operation should document the metadata type, if any.
*
*
* .google.protobuf.Any metadata = 2;
*/
@java.lang.Override
public com.google.protobuf.AnyOrBuilder getMetadataOrBuilder() {
return metadata_ == null ? com.google.protobuf.Any.getDefaultInstance() : metadata_;
}
public static final int DONE_FIELD_NUMBER = 3;
private boolean done_ = false;
/**
*
*
*
* If the value is `false`, it means the operation is still in progress.
* If `true`, the operation is completed, and either `error` or `response` is
* available.
*
*
* bool done = 3;
*
* @return The done.
*/
@java.lang.Override
public boolean getDone() {
return done_;
}
public static final int ERROR_FIELD_NUMBER = 4;
/**
*
*
*
* The error result of the operation in case of failure or cancellation.
*
*
* .google.rpc.Status error = 4;
*
* @return Whether the error field is set.
*/
@java.lang.Override
public boolean hasError() {
return resultCase_ == 4;
}
/**
*
*
*
* The error result of the operation in case of failure or cancellation.
*
*
* .google.rpc.Status error = 4;
*
* @return The error.
*/
@java.lang.Override
public com.google.rpc.Status getError() {
if (resultCase_ == 4) {
return (com.google.rpc.Status) result_;
}
return com.google.rpc.Status.getDefaultInstance();
}
/**
*
*
*
* The error result of the operation in case of failure or cancellation.
*
*
* .google.rpc.Status error = 4;
*/
@java.lang.Override
public com.google.rpc.StatusOrBuilder getErrorOrBuilder() {
if (resultCase_ == 4) {
return (com.google.rpc.Status) result_;
}
return com.google.rpc.Status.getDefaultInstance();
}
public static final int RESPONSE_FIELD_NUMBER = 5;
/**
*
*
*
* The normal response of the operation in case of success. If the original
* method returns no data on success, such as `Delete`, the response is
* `google.protobuf.Empty`. If the original method is standard
* `Get`/`Create`/`Update`, the response should be the resource. For other
* methods, the response should have the type `XxxResponse`, where `Xxx`
* is the original method name. For example, if the original method name
* is `TakeSnapshot()`, the inferred response type is
* `TakeSnapshotResponse`.
*
*
* .google.protobuf.Any response = 5;
*
* @return Whether the response field is set.
*/
@java.lang.Override
public boolean hasResponse() {
return resultCase_ == 5;
}
/**
*
*
*
* The normal response of the operation in case of success. If the original
* method returns no data on success, such as `Delete`, the response is
* `google.protobuf.Empty`. If the original method is standard
* `Get`/`Create`/`Update`, the response should be the resource. For other
* methods, the response should have the type `XxxResponse`, where `Xxx`
* is the original method name. For example, if the original method name
* is `TakeSnapshot()`, the inferred response type is
* `TakeSnapshotResponse`.
*
*
* .google.protobuf.Any response = 5;
*
* @return The response.
*/
@java.lang.Override
public com.google.protobuf.Any getResponse() {
if (resultCase_ == 5) {
return (com.google.protobuf.Any) result_;
}
return com.google.protobuf.Any.getDefaultInstance();
}
/**
*
*
*
* The normal response of the operation in case of success. If the original
* method returns no data on success, such as `Delete`, the response is
* `google.protobuf.Empty`. If the original method is standard
* `Get`/`Create`/`Update`, the response should be the resource. For other
* methods, the response should have the type `XxxResponse`, where `Xxx`
* is the original method name. For example, if the original method name
* is `TakeSnapshot()`, the inferred response type is
* `TakeSnapshotResponse`.
*
*
* .google.protobuf.Any response = 5;
*/
@java.lang.Override
public com.google.protobuf.AnyOrBuilder getResponseOrBuilder() {
if (resultCase_ == 5) {
return (com.google.protobuf.Any) result_;
}
return com.google.protobuf.Any.getDefaultInstance();
}
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 (!com.google.protobuf.GeneratedMessageV3.isStringEmpty(name_)) {
com.google.protobuf.GeneratedMessageV3.writeString(output, 1, name_);
}
if (((bitField0_ & 0x00000001) != 0)) {
output.writeMessage(2, getMetadata());
}
if (done_ != false) {
output.writeBool(3, done_);
}
if (resultCase_ == 4) {
output.writeMessage(4, (com.google.rpc.Status) result_);
}
if (resultCase_ == 5) {
output.writeMessage(5, (com.google.protobuf.Any) result_);
}
getUnknownFields().writeTo(output);
}
@java.lang.Override
public int getSerializedSize() {
int size = memoizedSize;
if (size != -1) return size;
size = 0;
if (!com.google.protobuf.GeneratedMessageV3.isStringEmpty(name_)) {
size += com.google.protobuf.GeneratedMessageV3.computeStringSize(1, name_);
}
if (((bitField0_ & 0x00000001) != 0)) {
size += com.google.protobuf.CodedOutputStream.computeMessageSize(2, getMetadata());
}
if (done_ != false) {
size += com.google.protobuf.CodedOutputStream.computeBoolSize(3, done_);
}
if (resultCase_ == 4) {
size +=
com.google.protobuf.CodedOutputStream.computeMessageSize(
4, (com.google.rpc.Status) result_);
}
if (resultCase_ == 5) {
size +=
com.google.protobuf.CodedOutputStream.computeMessageSize(
5, (com.google.protobuf.Any) result_);
}
size += getUnknownFields().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.longrunning.Operation)) {
return super.equals(obj);
}
com.google.longrunning.Operation other = (com.google.longrunning.Operation) obj;
if (!getName().equals(other.getName())) return false;
if (hasMetadata() != other.hasMetadata()) return false;
if (hasMetadata()) {
if (!getMetadata().equals(other.getMetadata())) return false;
}
if (getDone() != other.getDone()) return false;
if (!getResultCase().equals(other.getResultCase())) return false;
switch (resultCase_) {
case 4:
if (!getError().equals(other.getError())) return false;
break;
case 5:
if (!getResponse().equals(other.getResponse())) return false;
break;
case 0:
default:
}
if (!getUnknownFields().equals(other.getUnknownFields())) return false;
return true;
}
@java.lang.Override
public int hashCode() {
if (memoizedHashCode != 0) {
return memoizedHashCode;
}
int hash = 41;
hash = (19 * hash) + getDescriptor().hashCode();
hash = (37 * hash) + NAME_FIELD_NUMBER;
hash = (53 * hash) + getName().hashCode();
if (hasMetadata()) {
hash = (37 * hash) + METADATA_FIELD_NUMBER;
hash = (53 * hash) + getMetadata().hashCode();
}
hash = (37 * hash) + DONE_FIELD_NUMBER;
hash = (53 * hash) + com.google.protobuf.Internal.hashBoolean(getDone());
switch (resultCase_) {
case 4:
hash = (37 * hash) + ERROR_FIELD_NUMBER;
hash = (53 * hash) + getError().hashCode();
break;
case 5:
hash = (37 * hash) + RESPONSE_FIELD_NUMBER;
hash = (53 * hash) + getResponse().hashCode();
break;
case 0:
default:
}
hash = (29 * hash) + getUnknownFields().hashCode();
memoizedHashCode = hash;
return hash;
}
public static com.google.longrunning.Operation parseFrom(java.nio.ByteBuffer data)
throws com.google.protobuf.InvalidProtocolBufferException {
return PARSER.parseFrom(data);
}
public static com.google.longrunning.Operation parseFrom(
java.nio.ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
throws com.google.protobuf.InvalidProtocolBufferException {
return PARSER.parseFrom(data, extensionRegistry);
}
public static com.google.longrunning.Operation parseFrom(com.google.protobuf.ByteString data)
throws com.google.protobuf.InvalidProtocolBufferException {
return PARSER.parseFrom(data);
}
public static com.google.longrunning.Operation 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.longrunning.Operation parseFrom(byte[] data)
throws com.google.protobuf.InvalidProtocolBufferException {
return PARSER.parseFrom(data);
}
public static com.google.longrunning.Operation parseFrom(
byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
throws com.google.protobuf.InvalidProtocolBufferException {
return PARSER.parseFrom(data, extensionRegistry);
}
public static com.google.longrunning.Operation parseFrom(java.io.InputStream input)
throws java.io.IOException {
return com.google.protobuf.GeneratedMessageV3.parseWithIOException(PARSER, input);
}
public static com.google.longrunning.Operation 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.longrunning.Operation parseDelimitedFrom(java.io.InputStream input)
throws java.io.IOException {
return com.google.protobuf.GeneratedMessageV3.parseDelimitedWithIOException(PARSER, input);
}
public static com.google.longrunning.Operation 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.longrunning.Operation parseFrom(
com.google.protobuf.CodedInputStream input) throws java.io.IOException {
return com.google.protobuf.GeneratedMessageV3.parseWithIOException(PARSER, input);
}
public static com.google.longrunning.Operation 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.longrunning.Operation 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;
}
/**
*
*
*
* This resource represents a long-running operation that is the result of a
* network API call.
*
*
* Protobuf type {@code google.longrunning.Operation}
*/
public static final class Builder extends com.google.protobuf.GeneratedMessageV3.Builder
implements
// @@protoc_insertion_point(builder_implements:google.longrunning.Operation)
com.google.longrunning.OperationOrBuilder {
public static final com.google.protobuf.Descriptors.Descriptor getDescriptor() {
return com.google.longrunning.OperationsProto
.internal_static_google_longrunning_Operation_descriptor;
}
@java.lang.Override
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable
internalGetFieldAccessorTable() {
return com.google.longrunning.OperationsProto
.internal_static_google_longrunning_Operation_fieldAccessorTable
.ensureFieldAccessorsInitialized(
com.google.longrunning.Operation.class,
com.google.longrunning.Operation.Builder.class);
}
// Construct using com.google.longrunning.Operation.newBuilder()
private Builder() {
maybeForceBuilderInitialization();
}
private Builder(com.google.protobuf.GeneratedMessageV3.BuilderParent parent) {
super(parent);
maybeForceBuilderInitialization();
}
private void maybeForceBuilderInitialization() {
if (com.google.protobuf.GeneratedMessageV3.alwaysUseFieldBuilders) {
getMetadataFieldBuilder();
}
}
@java.lang.Override
public Builder clear() {
super.clear();
bitField0_ = 0;
name_ = "";
metadata_ = null;
if (metadataBuilder_ != null) {
metadataBuilder_.dispose();
metadataBuilder_ = null;
}
done_ = false;
if (errorBuilder_ != null) {
errorBuilder_.clear();
}
if (responseBuilder_ != null) {
responseBuilder_.clear();
}
resultCase_ = 0;
result_ = null;
return this;
}
@java.lang.Override
public com.google.protobuf.Descriptors.Descriptor getDescriptorForType() {
return com.google.longrunning.OperationsProto
.internal_static_google_longrunning_Operation_descriptor;
}
@java.lang.Override
public com.google.longrunning.Operation getDefaultInstanceForType() {
return com.google.longrunning.Operation.getDefaultInstance();
}
@java.lang.Override
public com.google.longrunning.Operation build() {
com.google.longrunning.Operation result = buildPartial();
if (!result.isInitialized()) {
throw newUninitializedMessageException(result);
}
return result;
}
@java.lang.Override
public com.google.longrunning.Operation buildPartial() {
com.google.longrunning.Operation result = new com.google.longrunning.Operation(this);
if (bitField0_ != 0) {
buildPartial0(result);
}
buildPartialOneofs(result);
onBuilt();
return result;
}
private void buildPartial0(com.google.longrunning.Operation result) {
int from_bitField0_ = bitField0_;
if (((from_bitField0_ & 0x00000001) != 0)) {
result.name_ = name_;
}
int to_bitField0_ = 0;
if (((from_bitField0_ & 0x00000002) != 0)) {
result.metadata_ = metadataBuilder_ == null ? metadata_ : metadataBuilder_.build();
to_bitField0_ |= 0x00000001;
}
if (((from_bitField0_ & 0x00000004) != 0)) {
result.done_ = done_;
}
result.bitField0_ |= to_bitField0_;
}
private void buildPartialOneofs(com.google.longrunning.Operation result) {
result.resultCase_ = resultCase_;
result.result_ = this.result_;
if (resultCase_ == 4 && errorBuilder_ != null) {
result.result_ = errorBuilder_.build();
}
if (resultCase_ == 5 && responseBuilder_ != null) {
result.result_ = responseBuilder_.build();
}
}
@java.lang.Override
public Builder clone() {
return super.clone();
}
@java.lang.Override
public Builder setField(
com.google.protobuf.Descriptors.FieldDescriptor field, java.lang.Object value) {
return super.setField(field, value);
}
@java.lang.Override
public Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field) {
return super.clearField(field);
}
@java.lang.Override
public Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof) {
return super.clearOneof(oneof);
}
@java.lang.Override
public Builder setRepeatedField(
com.google.protobuf.Descriptors.FieldDescriptor field, int index, java.lang.Object value) {
return super.setRepeatedField(field, index, value);
}
@java.lang.Override
public Builder addRepeatedField(
com.google.protobuf.Descriptors.FieldDescriptor field, java.lang.Object value) {
return super.addRepeatedField(field, value);
}
@java.lang.Override
public Builder mergeFrom(com.google.protobuf.Message other) {
if (other instanceof com.google.longrunning.Operation) {
return mergeFrom((com.google.longrunning.Operation) other);
} else {
super.mergeFrom(other);
return this;
}
}
public Builder mergeFrom(com.google.longrunning.Operation other) {
if (other == com.google.longrunning.Operation.getDefaultInstance()) return this;
if (!other.getName().isEmpty()) {
name_ = other.name_;
bitField0_ |= 0x00000001;
onChanged();
}
if (other.hasMetadata()) {
mergeMetadata(other.getMetadata());
}
if (other.getDone() != false) {
setDone(other.getDone());
}
switch (other.getResultCase()) {
case ERROR:
{
mergeError(other.getError());
break;
}
case RESPONSE:
{
mergeResponse(other.getResponse());
break;
}
case RESULT_NOT_SET:
{
break;
}
}
this.mergeUnknownFields(other.getUnknownFields());
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 {
if (extensionRegistry == null) {
throw new java.lang.NullPointerException();
}
try {
boolean done = false;
while (!done) {
int tag = input.readTag();
switch (tag) {
case 0:
done = true;
break;
case 10:
{
name_ = input.readStringRequireUtf8();
bitField0_ |= 0x00000001;
break;
} // case 10
case 18:
{
input.readMessage(getMetadataFieldBuilder().getBuilder(), extensionRegistry);
bitField0_ |= 0x00000002;
break;
} // case 18
case 24:
{
done_ = input.readBool();
bitField0_ |= 0x00000004;
break;
} // case 24
case 34:
{
input.readMessage(getErrorFieldBuilder().getBuilder(), extensionRegistry);
resultCase_ = 4;
break;
} // case 34
case 42:
{
input.readMessage(getResponseFieldBuilder().getBuilder(), extensionRegistry);
resultCase_ = 5;
break;
} // case 42
default:
{
if (!super.parseUnknownField(input, extensionRegistry, tag)) {
done = true; // was an endgroup tag
}
break;
} // default:
} // switch (tag)
} // while (!done)
} catch (com.google.protobuf.InvalidProtocolBufferException e) {
throw e.unwrapIOException();
} finally {
onChanged();
} // finally
return this;
}
private int resultCase_ = 0;
private java.lang.Object result_;
public ResultCase getResultCase() {
return ResultCase.forNumber(resultCase_);
}
public Builder clearResult() {
resultCase_ = 0;
result_ = null;
onChanged();
return this;
}
private int bitField0_;
private java.lang.Object name_ = "";
/**
*
*
*
* The server-assigned name, which is only unique within the same service that
* originally returns it. If you use the default HTTP mapping, the
* `name` should be a resource name ending with `operations/{unique_id}`.
*
*
* string name = 1;
*
* @return The name.
*/
public java.lang.String getName() {
java.lang.Object ref = name_;
if (!(ref instanceof java.lang.String)) {
com.google.protobuf.ByteString bs = (com.google.protobuf.ByteString) ref;
java.lang.String s = bs.toStringUtf8();
name_ = s;
return s;
} else {
return (java.lang.String) ref;
}
}
/**
*
*
*
* The server-assigned name, which is only unique within the same service that
* originally returns it. If you use the default HTTP mapping, the
* `name` should be a resource name ending with `operations/{unique_id}`.
*
*
* string name = 1;
*
* @return The bytes for name.
*/
public com.google.protobuf.ByteString getNameBytes() {
java.lang.Object ref = name_;
if (ref instanceof String) {
com.google.protobuf.ByteString b =
com.google.protobuf.ByteString.copyFromUtf8((java.lang.String) ref);
name_ = b;
return b;
} else {
return (com.google.protobuf.ByteString) ref;
}
}
/**
*
*
*
* The server-assigned name, which is only unique within the same service that
* originally returns it. If you use the default HTTP mapping, the
* `name` should be a resource name ending with `operations/{unique_id}`.
*
*
* string name = 1;
*
* @param value The name to set.
* @return This builder for chaining.
*/
public Builder setName(java.lang.String value) {
if (value == null) {
throw new NullPointerException();
}
name_ = value;
bitField0_ |= 0x00000001;
onChanged();
return this;
}
/**
*
*
*
* The server-assigned name, which is only unique within the same service that
* originally returns it. If you use the default HTTP mapping, the
* `name` should be a resource name ending with `operations/{unique_id}`.
*
*
* string name = 1;
*
* @return This builder for chaining.
*/
public Builder clearName() {
name_ = getDefaultInstance().getName();
bitField0_ = (bitField0_ & ~0x00000001);
onChanged();
return this;
}
/**
*
*
*
* The server-assigned name, which is only unique within the same service that
* originally returns it. If you use the default HTTP mapping, the
* `name` should be a resource name ending with `operations/{unique_id}`.
*
*
* string name = 1;
*
* @param value The bytes for name to set.
* @return This builder for chaining.
*/
public Builder setNameBytes(com.google.protobuf.ByteString value) {
if (value == null) {
throw new NullPointerException();
}
checkByteStringIsUtf8(value);
name_ = value;
bitField0_ |= 0x00000001;
onChanged();
return this;
}
private com.google.protobuf.Any metadata_;
private com.google.protobuf.SingleFieldBuilderV3<
com.google.protobuf.Any,
com.google.protobuf.Any.Builder,
com.google.protobuf.AnyOrBuilder>
metadataBuilder_;
/**
*
*
*
* Service-specific metadata associated with the operation. It typically
* contains progress information and common metadata such as create time.
* Some services might not provide such metadata. Any method that returns a
* long-running operation should document the metadata type, if any.
*
*
* .google.protobuf.Any metadata = 2;
*
* @return Whether the metadata field is set.
*/
public boolean hasMetadata() {
return ((bitField0_ & 0x00000002) != 0);
}
/**
*
*
*
* Service-specific metadata associated with the operation. It typically
* contains progress information and common metadata such as create time.
* Some services might not provide such metadata. Any method that returns a
* long-running operation should document the metadata type, if any.
*
*
* .google.protobuf.Any metadata = 2;
*
* @return The metadata.
*/
public com.google.protobuf.Any getMetadata() {
if (metadataBuilder_ == null) {
return metadata_ == null ? com.google.protobuf.Any.getDefaultInstance() : metadata_;
} else {
return metadataBuilder_.getMessage();
}
}
/**
*
*
*
* Service-specific metadata associated with the operation. It typically
* contains progress information and common metadata such as create time.
* Some services might not provide such metadata. Any method that returns a
* long-running operation should document the metadata type, if any.
*
*
* .google.protobuf.Any metadata = 2;
*/
public Builder setMetadata(com.google.protobuf.Any value) {
if (metadataBuilder_ == null) {
if (value == null) {
throw new NullPointerException();
}
metadata_ = value;
} else {
metadataBuilder_.setMessage(value);
}
bitField0_ |= 0x00000002;
onChanged();
return this;
}
/**
*
*
*
* Service-specific metadata associated with the operation. It typically
* contains progress information and common metadata such as create time.
* Some services might not provide such metadata. Any method that returns a
* long-running operation should document the metadata type, if any.
*
*
* .google.protobuf.Any metadata = 2;
*/
public Builder setMetadata(com.google.protobuf.Any.Builder builderForValue) {
if (metadataBuilder_ == null) {
metadata_ = builderForValue.build();
} else {
metadataBuilder_.setMessage(builderForValue.build());
}
bitField0_ |= 0x00000002;
onChanged();
return this;
}
/**
*
*
*
* Service-specific metadata associated with the operation. It typically
* contains progress information and common metadata such as create time.
* Some services might not provide such metadata. Any method that returns a
* long-running operation should document the metadata type, if any.
*
*
* .google.protobuf.Any metadata = 2;
*/
public Builder mergeMetadata(com.google.protobuf.Any value) {
if (metadataBuilder_ == null) {
if (((bitField0_ & 0x00000002) != 0)
&& metadata_ != null
&& metadata_ != com.google.protobuf.Any.getDefaultInstance()) {
getMetadataBuilder().mergeFrom(value);
} else {
metadata_ = value;
}
} else {
metadataBuilder_.mergeFrom(value);
}
if (metadata_ != null) {
bitField0_ |= 0x00000002;
onChanged();
}
return this;
}
/**
*
*
*
* Service-specific metadata associated with the operation. It typically
* contains progress information and common metadata such as create time.
* Some services might not provide such metadata. Any method that returns a
* long-running operation should document the metadata type, if any.
*
*
* .google.protobuf.Any metadata = 2;
*/
public Builder clearMetadata() {
bitField0_ = (bitField0_ & ~0x00000002);
metadata_ = null;
if (metadataBuilder_ != null) {
metadataBuilder_.dispose();
metadataBuilder_ = null;
}
onChanged();
return this;
}
/**
*
*
*
* Service-specific metadata associated with the operation. It typically
* contains progress information and common metadata such as create time.
* Some services might not provide such metadata. Any method that returns a
* long-running operation should document the metadata type, if any.
*
*
* .google.protobuf.Any metadata = 2;
*/
public com.google.protobuf.Any.Builder getMetadataBuilder() {
bitField0_ |= 0x00000002;
onChanged();
return getMetadataFieldBuilder().getBuilder();
}
/**
*
*
*
* Service-specific metadata associated with the operation. It typically
* contains progress information and common metadata such as create time.
* Some services might not provide such metadata. Any method that returns a
* long-running operation should document the metadata type, if any.
*
*
* .google.protobuf.Any metadata = 2;
*/
public com.google.protobuf.AnyOrBuilder getMetadataOrBuilder() {
if (metadataBuilder_ != null) {
return metadataBuilder_.getMessageOrBuilder();
} else {
return metadata_ == null ? com.google.protobuf.Any.getDefaultInstance() : metadata_;
}
}
/**
*
*
*
* Service-specific metadata associated with the operation. It typically
* contains progress information and common metadata such as create time.
* Some services might not provide such metadata. Any method that returns a
* long-running operation should document the metadata type, if any.
*
*
* .google.protobuf.Any metadata = 2;
*/
private com.google.protobuf.SingleFieldBuilderV3<
com.google.protobuf.Any,
com.google.protobuf.Any.Builder,
com.google.protobuf.AnyOrBuilder>
getMetadataFieldBuilder() {
if (metadataBuilder_ == null) {
metadataBuilder_ =
new com.google.protobuf.SingleFieldBuilderV3<
com.google.protobuf.Any,
com.google.protobuf.Any.Builder,
com.google.protobuf.AnyOrBuilder>(getMetadata(), getParentForChildren(), isClean());
metadata_ = null;
}
return metadataBuilder_;
}
private boolean done_;
/**
*
*
*
* If the value is `false`, it means the operation is still in progress.
* If `true`, the operation is completed, and either `error` or `response` is
* available.
*
*
* bool done = 3;
*
* @return The done.
*/
@java.lang.Override
public boolean getDone() {
return done_;
}
/**
*
*
*
* If the value is `false`, it means the operation is still in progress.
* If `true`, the operation is completed, and either `error` or `response` is
* available.
*
*
* bool done = 3;
*
* @param value The done to set.
* @return This builder for chaining.
*/
public Builder setDone(boolean value) {
done_ = value;
bitField0_ |= 0x00000004;
onChanged();
return this;
}
/**
*
*
*
* If the value is `false`, it means the operation is still in progress.
* If `true`, the operation is completed, and either `error` or `response` is
* available.
*
*
* bool done = 3;
*
* @return This builder for chaining.
*/
public Builder clearDone() {
bitField0_ = (bitField0_ & ~0x00000004);
done_ = false;
onChanged();
return this;
}
private com.google.protobuf.SingleFieldBuilderV3<
com.google.rpc.Status, com.google.rpc.Status.Builder, com.google.rpc.StatusOrBuilder>
errorBuilder_;
/**
*
*
*
* The error result of the operation in case of failure or cancellation.
*
*
* .google.rpc.Status error = 4;
*
* @return Whether the error field is set.
*/
@java.lang.Override
public boolean hasError() {
return resultCase_ == 4;
}
/**
*
*
*
* The error result of the operation in case of failure or cancellation.
*
*
* .google.rpc.Status error = 4;
*
* @return The error.
*/
@java.lang.Override
public com.google.rpc.Status getError() {
if (errorBuilder_ == null) {
if (resultCase_ == 4) {
return (com.google.rpc.Status) result_;
}
return com.google.rpc.Status.getDefaultInstance();
} else {
if (resultCase_ == 4) {
return errorBuilder_.getMessage();
}
return com.google.rpc.Status.getDefaultInstance();
}
}
/**
*
*
*
* The error result of the operation in case of failure or cancellation.
*
*
* .google.rpc.Status error = 4;
*/
public Builder setError(com.google.rpc.Status value) {
if (errorBuilder_ == null) {
if (value == null) {
throw new NullPointerException();
}
result_ = value;
onChanged();
} else {
errorBuilder_.setMessage(value);
}
resultCase_ = 4;
return this;
}
/**
*
*
*
* The error result of the operation in case of failure or cancellation.
*
*
* .google.rpc.Status error = 4;
*/
public Builder setError(com.google.rpc.Status.Builder builderForValue) {
if (errorBuilder_ == null) {
result_ = builderForValue.build();
onChanged();
} else {
errorBuilder_.setMessage(builderForValue.build());
}
resultCase_ = 4;
return this;
}
/**
*
*
*
* The error result of the operation in case of failure or cancellation.
*
*
* .google.rpc.Status error = 4;
*/
public Builder mergeError(com.google.rpc.Status value) {
if (errorBuilder_ == null) {
if (resultCase_ == 4 && result_ != com.google.rpc.Status.getDefaultInstance()) {
result_ =
com.google.rpc.Status.newBuilder((com.google.rpc.Status) result_)
.mergeFrom(value)
.buildPartial();
} else {
result_ = value;
}
onChanged();
} else {
if (resultCase_ == 4) {
errorBuilder_.mergeFrom(value);
} else {
errorBuilder_.setMessage(value);
}
}
resultCase_ = 4;
return this;
}
/**
*
*
*
* The error result of the operation in case of failure or cancellation.
*
*
* .google.rpc.Status error = 4;
*/
public Builder clearError() {
if (errorBuilder_ == null) {
if (resultCase_ == 4) {
resultCase_ = 0;
result_ = null;
onChanged();
}
} else {
if (resultCase_ == 4) {
resultCase_ = 0;
result_ = null;
}
errorBuilder_.clear();
}
return this;
}
/**
*
*
*
* The error result of the operation in case of failure or cancellation.
*
*
* .google.rpc.Status error = 4;
*/
public com.google.rpc.Status.Builder getErrorBuilder() {
return getErrorFieldBuilder().getBuilder();
}
/**
*
*
*
* The error result of the operation in case of failure or cancellation.
*
*
* .google.rpc.Status error = 4;
*/
@java.lang.Override
public com.google.rpc.StatusOrBuilder getErrorOrBuilder() {
if ((resultCase_ == 4) && (errorBuilder_ != null)) {
return errorBuilder_.getMessageOrBuilder();
} else {
if (resultCase_ == 4) {
return (com.google.rpc.Status) result_;
}
return com.google.rpc.Status.getDefaultInstance();
}
}
/**
*
*
*
* The error result of the operation in case of failure or cancellation.
*
*
* .google.rpc.Status error = 4;
*/
private com.google.protobuf.SingleFieldBuilderV3<
com.google.rpc.Status, com.google.rpc.Status.Builder, com.google.rpc.StatusOrBuilder>
getErrorFieldBuilder() {
if (errorBuilder_ == null) {
if (!(resultCase_ == 4)) {
result_ = com.google.rpc.Status.getDefaultInstance();
}
errorBuilder_ =
new com.google.protobuf.SingleFieldBuilderV3<
com.google.rpc.Status,
com.google.rpc.Status.Builder,
com.google.rpc.StatusOrBuilder>(
(com.google.rpc.Status) result_, getParentForChildren(), isClean());
result_ = null;
}
resultCase_ = 4;
onChanged();
return errorBuilder_;
}
private com.google.protobuf.SingleFieldBuilderV3<
com.google.protobuf.Any,
com.google.protobuf.Any.Builder,
com.google.protobuf.AnyOrBuilder>
responseBuilder_;
/**
*
*
*
* The normal response of the operation in case of success. If the original
* method returns no data on success, such as `Delete`, the response is
* `google.protobuf.Empty`. If the original method is standard
* `Get`/`Create`/`Update`, the response should be the resource. For other
* methods, the response should have the type `XxxResponse`, where `Xxx`
* is the original method name. For example, if the original method name
* is `TakeSnapshot()`, the inferred response type is
* `TakeSnapshotResponse`.
*
*
* .google.protobuf.Any response = 5;
*
* @return Whether the response field is set.
*/
@java.lang.Override
public boolean hasResponse() {
return resultCase_ == 5;
}
/**
*
*
*
* The normal response of the operation in case of success. If the original
* method returns no data on success, such as `Delete`, the response is
* `google.protobuf.Empty`. If the original method is standard
* `Get`/`Create`/`Update`, the response should be the resource. For other
* methods, the response should have the type `XxxResponse`, where `Xxx`
* is the original method name. For example, if the original method name
* is `TakeSnapshot()`, the inferred response type is
* `TakeSnapshotResponse`.
*
*
* .google.protobuf.Any response = 5;
*
* @return The response.
*/
@java.lang.Override
public com.google.protobuf.Any getResponse() {
if (responseBuilder_ == null) {
if (resultCase_ == 5) {
return (com.google.protobuf.Any) result_;
}
return com.google.protobuf.Any.getDefaultInstance();
} else {
if (resultCase_ == 5) {
return responseBuilder_.getMessage();
}
return com.google.protobuf.Any.getDefaultInstance();
}
}
/**
*
*
*
* The normal response of the operation in case of success. If the original
* method returns no data on success, such as `Delete`, the response is
* `google.protobuf.Empty`. If the original method is standard
* `Get`/`Create`/`Update`, the response should be the resource. For other
* methods, the response should have the type `XxxResponse`, where `Xxx`
* is the original method name. For example, if the original method name
* is `TakeSnapshot()`, the inferred response type is
* `TakeSnapshotResponse`.
*
*
* .google.protobuf.Any response = 5;
*/
public Builder setResponse(com.google.protobuf.Any value) {
if (responseBuilder_ == null) {
if (value == null) {
throw new NullPointerException();
}
result_ = value;
onChanged();
} else {
responseBuilder_.setMessage(value);
}
resultCase_ = 5;
return this;
}
/**
*
*
*
* The normal response of the operation in case of success. If the original
* method returns no data on success, such as `Delete`, the response is
* `google.protobuf.Empty`. If the original method is standard
* `Get`/`Create`/`Update`, the response should be the resource. For other
* methods, the response should have the type `XxxResponse`, where `Xxx`
* is the original method name. For example, if the original method name
* is `TakeSnapshot()`, the inferred response type is
* `TakeSnapshotResponse`.
*
*
* .google.protobuf.Any response = 5;
*/
public Builder setResponse(com.google.protobuf.Any.Builder builderForValue) {
if (responseBuilder_ == null) {
result_ = builderForValue.build();
onChanged();
} else {
responseBuilder_.setMessage(builderForValue.build());
}
resultCase_ = 5;
return this;
}
/**
*
*
*
* The normal response of the operation in case of success. If the original
* method returns no data on success, such as `Delete`, the response is
* `google.protobuf.Empty`. If the original method is standard
* `Get`/`Create`/`Update`, the response should be the resource. For other
* methods, the response should have the type `XxxResponse`, where `Xxx`
* is the original method name. For example, if the original method name
* is `TakeSnapshot()`, the inferred response type is
* `TakeSnapshotResponse`.
*
*
* .google.protobuf.Any response = 5;
*/
public Builder mergeResponse(com.google.protobuf.Any value) {
if (responseBuilder_ == null) {
if (resultCase_ == 5 && result_ != com.google.protobuf.Any.getDefaultInstance()) {
result_ =
com.google.protobuf.Any.newBuilder((com.google.protobuf.Any) result_)
.mergeFrom(value)
.buildPartial();
} else {
result_ = value;
}
onChanged();
} else {
if (resultCase_ == 5) {
responseBuilder_.mergeFrom(value);
} else {
responseBuilder_.setMessage(value);
}
}
resultCase_ = 5;
return this;
}
/**
*
*
*
* The normal response of the operation in case of success. If the original
* method returns no data on success, such as `Delete`, the response is
* `google.protobuf.Empty`. If the original method is standard
* `Get`/`Create`/`Update`, the response should be the resource. For other
* methods, the response should have the type `XxxResponse`, where `Xxx`
* is the original method name. For example, if the original method name
* is `TakeSnapshot()`, the inferred response type is
* `TakeSnapshotResponse`.
*
*
* .google.protobuf.Any response = 5;
*/
public Builder clearResponse() {
if (responseBuilder_ == null) {
if (resultCase_ == 5) {
resultCase_ = 0;
result_ = null;
onChanged();
}
} else {
if (resultCase_ == 5) {
resultCase_ = 0;
result_ = null;
}
responseBuilder_.clear();
}
return this;
}
/**
*
*
*
* The normal response of the operation in case of success. If the original
* method returns no data on success, such as `Delete`, the response is
* `google.protobuf.Empty`. If the original method is standard
* `Get`/`Create`/`Update`, the response should be the resource. For other
* methods, the response should have the type `XxxResponse`, where `Xxx`
* is the original method name. For example, if the original method name
* is `TakeSnapshot()`, the inferred response type is
* `TakeSnapshotResponse`.
*
*
* .google.protobuf.Any response = 5;
*/
public com.google.protobuf.Any.Builder getResponseBuilder() {
return getResponseFieldBuilder().getBuilder();
}
/**
*
*
*
* The normal response of the operation in case of success. If the original
* method returns no data on success, such as `Delete`, the response is
* `google.protobuf.Empty`. If the original method is standard
* `Get`/`Create`/`Update`, the response should be the resource. For other
* methods, the response should have the type `XxxResponse`, where `Xxx`
* is the original method name. For example, if the original method name
* is `TakeSnapshot()`, the inferred response type is
* `TakeSnapshotResponse`.
*
*
* .google.protobuf.Any response = 5;
*/
@java.lang.Override
public com.google.protobuf.AnyOrBuilder getResponseOrBuilder() {
if ((resultCase_ == 5) && (responseBuilder_ != null)) {
return responseBuilder_.getMessageOrBuilder();
} else {
if (resultCase_ == 5) {
return (com.google.protobuf.Any) result_;
}
return com.google.protobuf.Any.getDefaultInstance();
}
}
/**
*
*
*
* The normal response of the operation in case of success. If the original
* method returns no data on success, such as `Delete`, the response is
* `google.protobuf.Empty`. If the original method is standard
* `Get`/`Create`/`Update`, the response should be the resource. For other
* methods, the response should have the type `XxxResponse`, where `Xxx`
* is the original method name. For example, if the original method name
* is `TakeSnapshot()`, the inferred response type is
* `TakeSnapshotResponse`.
*
*
* .google.protobuf.Any response = 5;
*/
private com.google.protobuf.SingleFieldBuilderV3<
com.google.protobuf.Any,
com.google.protobuf.Any.Builder,
com.google.protobuf.AnyOrBuilder>
getResponseFieldBuilder() {
if (responseBuilder_ == null) {
if (!(resultCase_ == 5)) {
result_ = com.google.protobuf.Any.getDefaultInstance();
}
responseBuilder_ =
new com.google.protobuf.SingleFieldBuilderV3<
com.google.protobuf.Any,
com.google.protobuf.Any.Builder,
com.google.protobuf.AnyOrBuilder>(
(com.google.protobuf.Any) result_, getParentForChildren(), isClean());
result_ = null;
}
resultCase_ = 5;
onChanged();
return responseBuilder_;
}
@java.lang.Override
public final Builder setUnknownFields(final com.google.protobuf.UnknownFieldSet unknownFields) {
return super.setUnknownFields(unknownFields);
}
@java.lang.Override
public final Builder mergeUnknownFields(
final com.google.protobuf.UnknownFieldSet unknownFields) {
return super.mergeUnknownFields(unknownFields);
}
// @@protoc_insertion_point(builder_scope:google.longrunning.Operation)
}
// @@protoc_insertion_point(class_scope:google.longrunning.Operation)
private static final com.google.longrunning.Operation DEFAULT_INSTANCE;
static {
DEFAULT_INSTANCE = new com.google.longrunning.Operation();
}
public static com.google.longrunning.Operation getDefaultInstance() {
return DEFAULT_INSTANCE;
}
private static final com.google.protobuf.Parser PARSER =
new com.google.protobuf.AbstractParser() {
@java.lang.Override
public Operation parsePartialFrom(
com.google.protobuf.CodedInputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry)
throws com.google.protobuf.InvalidProtocolBufferException {
Builder builder = newBuilder();
try {
builder.mergeFrom(input, extensionRegistry);
} catch (com.google.protobuf.InvalidProtocolBufferException e) {
throw e.setUnfinishedMessage(builder.buildPartial());
} catch (com.google.protobuf.UninitializedMessageException e) {
throw e.asInvalidProtocolBufferException().setUnfinishedMessage(builder.buildPartial());
} catch (java.io.IOException e) {
throw new com.google.protobuf.InvalidProtocolBufferException(e)
.setUnfinishedMessage(builder.buildPartial());
}
return builder.buildPartial();
}
};
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.longrunning.Operation getDefaultInstanceForType() {
return DEFAULT_INSTANCE;
}
}