...

Package extendedops

import "google.golang.org/genproto/googleapis/cloud/extendedops"
Overview
Index

Overview ▾

Variables

Enum value maps for OperationResponseMapping.

var (
    OperationResponseMapping_name = map[int32]string{
        0: "UNDEFINED",
        1: "NAME",
        2: "STATUS",
        3: "ERROR_CODE",
        4: "ERROR_MESSAGE",
    }
    OperationResponseMapping_value = map[string]int32{
        "UNDEFINED":     0,
        "NAME":          1,
        "STATUS":        2,
        "ERROR_CODE":    3,
        "ERROR_MESSAGE": 4,
    }
)

Extension fields to descriptorpb.FieldOptions.

var (
    // A field annotation that maps fields in an API-specific Operation object to
    // their standard counterparts in google.longrunning.Operation. See
    // OperationResponseMapping enum definition.
    //
    // optional google.cloud.OperationResponseMapping operation_field = 1149;
    E_OperationField = &file_google_cloud_extended_operations_proto_extTypes[0]
    // A field annotation that maps fields in the initial request message
    // (the one which started the LRO) to their counterparts in the polling
    // request message. For non-standard LRO, the polling response may be missing
    // some of the information needed to make a subsequent polling request. The
    // missing information (for example, project or region ID) is contained in the
    // fields of the initial request message that this annotation must be applied
    // to. The string value of the annotation corresponds to the name of the
    // counterpart field in the polling request message that the annotated field's
    // value will be copied to.
    //
    // optional string operation_request_field = 1150;
    E_OperationRequestField = &file_google_cloud_extended_operations_proto_extTypes[1]
    // A field annotation that maps fields in the polling request message to their
    // counterparts in the initial and/or polling response message. The initial
    // and the polling methods return an API-specific Operation object. Some of
    // the fields from that response object must be reused in the subsequent
    // request (like operation name/ID) to fully identify the polled operation.
    // This annotation must be applied to the fields in the polling request
    // message, the string value of the annotation must correspond to the name of
    // the counterpart field in the Operation response object whose value will be
    // copied to the annotated field.
    //
    // optional string operation_response_field = 1151;
    E_OperationResponseField = &file_google_cloud_extended_operations_proto_extTypes[2]
)

Extension fields to descriptorpb.MethodOptions.

var (
    // A method annotation that maps an LRO method (the one which starts an LRO)
    // to the service, which will be used to poll for the operation status. The
    // annotation must be applied to the method which starts an LRO, the string
    // value of the annotation must correspond to the name of the service used to
    // poll for the operation status.
    //
    // optional string operation_service = 1249;
    E_OperationService = &file_google_cloud_extended_operations_proto_extTypes[3]
    // A method annotation that marks methods that can be used for polling
    // operation status (e.g. the MyPollingService.Get(MyPollingRequest) method).
    //
    // optional bool operation_polling_method = 1250;
    E_OperationPollingMethod = &file_google_cloud_extended_operations_proto_extTypes[4]
)
var File_google_cloud_extended_operations_proto protoreflect.FileDescriptor

type OperationResponseMapping

An enum to be used to mark the essential (for polling) fields in an API-specific Operation object. A custom Operation object may contain many different fields, but only few of them are essential to conduct a successful polling process.

type OperationResponseMapping int32
const (
    // Do not use.
    OperationResponseMapping_UNDEFINED OperationResponseMapping = 0
    // A field in an API-specific (custom) Operation object which carries the same
    // meaning as google.longrunning.Operation.name.
    OperationResponseMapping_NAME OperationResponseMapping = 1
    // A field in an API-specific (custom) Operation object which carries the same
    // meaning as google.longrunning.Operation.done. If the annotated field is of
    // an enum type, `annotated_field_name == EnumType.DONE` semantics should be
    // equivalent to `Operation.done == true`. If the annotated field is of type
    // boolean, then it should follow the same semantics as Operation.done.
    // Otherwise, a non-empty value should be treated as `Operation.done == true`.
    OperationResponseMapping_STATUS OperationResponseMapping = 2
    // A field in an API-specific (custom) Operation object which carries the same
    // meaning as google.longrunning.Operation.error.code.
    OperationResponseMapping_ERROR_CODE OperationResponseMapping = 3
    // A field in an API-specific (custom) Operation object which carries the same
    // meaning as google.longrunning.Operation.error.message.
    OperationResponseMapping_ERROR_MESSAGE OperationResponseMapping = 4
)

func (OperationResponseMapping) Descriptor

func (OperationResponseMapping) Descriptor() protoreflect.EnumDescriptor

func (OperationResponseMapping) Enum

func (x OperationResponseMapping) Enum() *OperationResponseMapping

func (OperationResponseMapping) EnumDescriptor

func (OperationResponseMapping) EnumDescriptor() ([]byte, []int)

Deprecated: Use OperationResponseMapping.Descriptor instead.

func (OperationResponseMapping) Number

func (x OperationResponseMapping) Number() protoreflect.EnumNumber

func (OperationResponseMapping) String

func (x OperationResponseMapping) String() string

func (OperationResponseMapping) Type

func (OperationResponseMapping) Type() protoreflect.EnumType