com.google.longrunning.OperationOrBuilder 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.4
package com.google.longrunning;
public interface OperationOrBuilder
extends
// @@protoc_insertion_point(interface_extends:google.longrunning.Operation)
com.google.protobuf.MessageOrBuilder {
/**
*
*
*
* 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.String getName();
/**
*
*
*
* 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.
*/
com.google.protobuf.ByteString getNameBytes();
/**
*
*
*
* 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.
*/
boolean hasMetadata();
/**
*
*
*
* 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.
*/
com.google.protobuf.Any getMetadata();
/**
*
*
*
* 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;
*/
com.google.protobuf.AnyOrBuilder getMetadataOrBuilder();
/**
*
*
*
* 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.
*/
boolean getDone();
/**
*
*
*
* The error result of the operation in case of failure or cancellation.
*
*
* .google.rpc.Status error = 4;
*
* @return Whether the error field is set.
*/
boolean hasError();
/**
*
*
*
* The error result of the operation in case of failure or cancellation.
*
*
* .google.rpc.Status error = 4;
*
* @return The error.
*/
com.google.rpc.Status getError();
/**
*
*
*
* The error result of the operation in case of failure or cancellation.
*
*
* .google.rpc.Status error = 4;
*/
com.google.rpc.StatusOrBuilder getErrorOrBuilder();
/**
*
*
*
* 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.
*/
boolean hasResponse();
/**
*
*
*
* 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.
*/
com.google.protobuf.Any getResponse();
/**
*
*
*
* 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;
*/
com.google.protobuf.AnyOrBuilder getResponseOrBuilder();
com.google.longrunning.Operation.ResultCase getResultCase();
}