extended_operations.pb.go

Documentation: google.golang.org/genproto/googleapis/cloud/extendedops

     1  // Copyright 2021 Google LLC.
     2  //
     3  // Licensed under the Apache License, Version 2.0 (the "License");
     4  // you may not use this file except in compliance with the License.
     5  // You may obtain a copy of the License at
     6  //
     7  //     http://www.apache.org/licenses/LICENSE-2.0
     8  //
     9  // Unless required by applicable law or agreed to in writing, software
    10  // distributed under the License is distributed on an "AS IS" BASIS,
    11  // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    12  // See the License for the specific language governing permissions and
    13  // limitations under the License.
    14  
    15  // This file contains custom annotations that are used by GAPIC generators to
    16  // handle Long Running Operation methods (LRO) that are NOT compliant with
    17  // https://google.aip.dev/151. These annotations are public for technical
    18  // reasons only. Please DO NOT USE them in your protos.
    19  
    20  // Code generated by protoc-gen-go. DO NOT EDIT.
    21  // versions:
    22  // 	protoc-gen-go v1.26.0
    23  // 	protoc        v3.12.2
    24  // source: google/cloud/extended_operations.proto
    25  
    26  package extendedops
    27  
    28  import (
    29  	reflect "reflect"
    30  	sync "sync"
    31  
    32  	protoreflect "google.golang.org/protobuf/reflect/protoreflect"
    33  	protoimpl "google.golang.org/protobuf/runtime/protoimpl"
    34  	descriptorpb "google.golang.org/protobuf/types/descriptorpb"
    35  )
    36  
    37  const (
    38  	// Verify that this generated code is sufficiently up-to-date.
    39  	_ = protoimpl.EnforceVersion(20 - protoimpl.MinVersion)
    40  	// Verify that runtime/protoimpl is sufficiently up-to-date.
    41  	_ = protoimpl.EnforceVersion(protoimpl.MaxVersion - 20)
    42  )
    43  
    44  // An enum to be used to mark the essential (for polling) fields in an
    45  // API-specific Operation object. A custom Operation object may contain many
    46  // different fields, but only few of them are essential to conduct a successful
    47  // polling process.
    48  type OperationResponseMapping int32
    49  
    50  const (
    51  	// Do not use.
    52  	OperationResponseMapping_UNDEFINED OperationResponseMapping = 0
    53  	// A field in an API-specific (custom) Operation object which carries the same
    54  	// meaning as google.longrunning.Operation.name.
    55  	OperationResponseMapping_NAME OperationResponseMapping = 1
    56  	// A field in an API-specific (custom) Operation object which carries the same
    57  	// meaning as google.longrunning.Operation.done. If the annotated field is of
    58  	// an enum type, `annotated_field_name == EnumType.DONE` semantics should be
    59  	// equivalent to `Operation.done == true`. If the annotated field is of type
    60  	// boolean, then it should follow the same semantics as Operation.done.
    61  	// Otherwise, a non-empty value should be treated as `Operation.done == true`.
    62  	OperationResponseMapping_STATUS OperationResponseMapping = 2
    63  	// A field in an API-specific (custom) Operation object which carries the same
    64  	// meaning as google.longrunning.Operation.error.code.
    65  	OperationResponseMapping_ERROR_CODE OperationResponseMapping = 3
    66  	// A field in an API-specific (custom) Operation object which carries the same
    67  	// meaning as google.longrunning.Operation.error.message.
    68  	OperationResponseMapping_ERROR_MESSAGE OperationResponseMapping = 4
    69  )
    70  
    71  // Enum value maps for OperationResponseMapping.
    72  var (
    73  	OperationResponseMapping_name = map[int32]string{
    74  		0: "UNDEFINED",
    75  		1: "NAME",
    76  		2: "STATUS",
    77  		3: "ERROR_CODE",
    78  		4: "ERROR_MESSAGE",
    79  	}
    80  	OperationResponseMapping_value = map[string]int32{
    81  		"UNDEFINED":     0,
    82  		"NAME":          1,
    83  		"STATUS":        2,
    84  		"ERROR_CODE":    3,
    85  		"ERROR_MESSAGE": 4,
    86  	}
    87  )
    88  
    89  func (x OperationResponseMapping) Enum() *OperationResponseMapping {
    90  	p := new(OperationResponseMapping)
    91  	*p = x
    92  	return p
    93  }
    94  
    95  func (x OperationResponseMapping) String() string {
    96  	return protoimpl.X.EnumStringOf(x.Descriptor(), protoreflect.EnumNumber(x))
    97  }
    98  
    99  func (OperationResponseMapping) Descriptor() protoreflect.EnumDescriptor {
   100  	return file_google_cloud_extended_operations_proto_enumTypes[0].Descriptor()
   101  }
   102  
   103  func (OperationResponseMapping) Type() protoreflect.EnumType {
   104  	return &file_google_cloud_extended_operations_proto_enumTypes[0]
   105  }
   106  
   107  func (x OperationResponseMapping) Number() protoreflect.EnumNumber {
   108  	return protoreflect.EnumNumber(x)
   109  }
   110  
   111  // Deprecated: Use OperationResponseMapping.Descriptor instead.
   112  func (OperationResponseMapping) EnumDescriptor() ([]byte, []int) {
   113  	return file_google_cloud_extended_operations_proto_rawDescGZIP(), []int{0}
   114  }
   115  
   116  var file_google_cloud_extended_operations_proto_extTypes = []protoimpl.ExtensionInfo{
   117  	{
   118  		ExtendedType:  (*descriptorpb.FieldOptions)(nil),
   119  		ExtensionType: (*OperationResponseMapping)(nil),
   120  		Field:         1149,
   121  		Name:          "google.cloud.operation_field",
   122  		Tag:           "varint,1149,opt,name=operation_field,enum=google.cloud.OperationResponseMapping",
   123  		Filename:      "google/cloud/extended_operations.proto",
   124  	},
   125  	{
   126  		ExtendedType:  (*descriptorpb.FieldOptions)(nil),
   127  		ExtensionType: (*string)(nil),
   128  		Field:         1150,
   129  		Name:          "google.cloud.operation_request_field",
   130  		Tag:           "bytes,1150,opt,name=operation_request_field",
   131  		Filename:      "google/cloud/extended_operations.proto",
   132  	},
   133  	{
   134  		ExtendedType:  (*descriptorpb.FieldOptions)(nil),
   135  		ExtensionType: (*string)(nil),
   136  		Field:         1151,
   137  		Name:          "google.cloud.operation_response_field",
   138  		Tag:           "bytes,1151,opt,name=operation_response_field",
   139  		Filename:      "google/cloud/extended_operations.proto",
   140  	},
   141  	{
   142  		ExtendedType:  (*descriptorpb.MethodOptions)(nil),
   143  		ExtensionType: (*string)(nil),
   144  		Field:         1249,
   145  		Name:          "google.cloud.operation_service",
   146  		Tag:           "bytes,1249,opt,name=operation_service",
   147  		Filename:      "google/cloud/extended_operations.proto",
   148  	},
   149  	{
   150  		ExtendedType:  (*descriptorpb.MethodOptions)(nil),
   151  		ExtensionType: (*bool)(nil),
   152  		Field:         1250,
   153  		Name:          "google.cloud.operation_polling_method",
   154  		Tag:           "varint,1250,opt,name=operation_polling_method",
   155  		Filename:      "google/cloud/extended_operations.proto",
   156  	},
   157  }
   158  
   159  // Extension fields to descriptorpb.FieldOptions.
   160  var (
   161  	// A field annotation that maps fields in an API-specific Operation object to
   162  	// their standard counterparts in google.longrunning.Operation. See
   163  	// OperationResponseMapping enum definition.
   164  	//
   165  	// optional google.cloud.OperationResponseMapping operation_field = 1149;
   166  	E_OperationField = &file_google_cloud_extended_operations_proto_extTypes[0]
   167  	// A field annotation that maps fields in the initial request message
   168  	// (the one which started the LRO) to their counterparts in the polling
   169  	// request message. For non-standard LRO, the polling response may be missing
   170  	// some of the information needed to make a subsequent polling request. The
   171  	// missing information (for example, project or region ID) is contained in the
   172  	// fields of the initial request message that this annotation must be applied
   173  	// to. The string value of the annotation corresponds to the name of the
   174  	// counterpart field in the polling request message that the annotated field's
   175  	// value will be copied to.
   176  	//
   177  	// optional string operation_request_field = 1150;
   178  	E_OperationRequestField = &file_google_cloud_extended_operations_proto_extTypes[1]
   179  	// A field annotation that maps fields in the polling request message to their
   180  	// counterparts in the initial and/or polling response message. The initial
   181  	// and the polling methods return an API-specific Operation object. Some of
   182  	// the fields from that response object must be reused in the subsequent
   183  	// request (like operation name/ID) to fully identify the polled operation.
   184  	// This annotation must be applied to the fields in the polling request
   185  	// message, the string value of the annotation must correspond to the name of
   186  	// the counterpart field in the Operation response object whose value will be
   187  	// copied to the annotated field.
   188  	//
   189  	// optional string operation_response_field = 1151;
   190  	E_OperationResponseField = &file_google_cloud_extended_operations_proto_extTypes[2]
   191  )
   192  
   193  // Extension fields to descriptorpb.MethodOptions.
   194  var (
   195  	// A method annotation that maps an LRO method (the one which starts an LRO)
   196  	// to the service, which will be used to poll for the operation status. The
   197  	// annotation must be applied to the method which starts an LRO, the string
   198  	// value of the annotation must correspond to the name of the service used to
   199  	// poll for the operation status.
   200  	//
   201  	// optional string operation_service = 1249;
   202  	E_OperationService = &file_google_cloud_extended_operations_proto_extTypes[3]
   203  	// A method annotation that marks methods that can be used for polling
   204  	// operation status (e.g. the MyPollingService.Get(MyPollingRequest) method).
   205  	//
   206  	// optional bool operation_polling_method = 1250;
   207  	E_OperationPollingMethod = &file_google_cloud_extended_operations_proto_extTypes[4]
   208  )
   209  
   210  var File_google_cloud_extended_operations_proto protoreflect.FileDescriptor
   211  
   212  var file_google_cloud_extended_operations_proto_rawDesc = []byte{
   213  	0x0a, 0x26, 0x67, 0x6f, 0x6f, 0x67, 0x6c, 0x65, 0x2f, 0x63, 0x6c, 0x6f, 0x75, 0x64, 0x2f, 0x65,
   214  	0x78, 0x74, 0x65, 0x6e, 0x64, 0x65, 0x64, 0x5f, 0x6f, 0x70, 0x65, 0x72, 0x61, 0x74, 0x69, 0x6f,
   215  	0x6e, 0x73, 0x2e, 0x70, 0x72, 0x6f, 0x74, 0x6f, 0x12, 0x0c, 0x67, 0x6f, 0x6f, 0x67, 0x6c, 0x65,
   216  	0x2e, 0x63, 0x6c, 0x6f, 0x75, 0x64, 0x1a, 0x20, 0x67, 0x6f, 0x6f, 0x67, 0x6c, 0x65, 0x2f, 0x70,
   217  	0x72, 0x6f, 0x74, 0x6f, 0x62, 0x75, 0x66, 0x2f, 0x64, 0x65, 0x73, 0x63, 0x72, 0x69, 0x70, 0x74,
   218  	0x6f, 0x72, 0x2e, 0x70, 0x72, 0x6f, 0x74, 0x6f, 0x2a, 0x62, 0x0a, 0x18, 0x4f, 0x70, 0x65, 0x72,
   219  	0x61, 0x74, 0x69, 0x6f, 0x6e, 0x52, 0x65, 0x73, 0x70, 0x6f, 0x6e, 0x73, 0x65, 0x4d, 0x61, 0x70,
   220  	0x70, 0x69, 0x6e, 0x67, 0x12, 0x0d, 0x0a, 0x09, 0x55, 0x4e, 0x44, 0x45, 0x46, 0x49, 0x4e, 0x45,
   221  	0x44, 0x10, 0x00, 0x12, 0x08, 0x0a, 0x04, 0x4e, 0x41, 0x4d, 0x45, 0x10, 0x01, 0x12, 0x0a, 0x0a,
   222  	0x06, 0x53, 0x54, 0x41, 0x54, 0x55, 0x53, 0x10, 0x02, 0x12, 0x0e, 0x0a, 0x0a, 0x45, 0x52, 0x52,
   223  	0x4f, 0x52, 0x5f, 0x43, 0x4f, 0x44, 0x45, 0x10, 0x03, 0x12, 0x11, 0x0a, 0x0d, 0x45, 0x52, 0x52,
   224  	0x4f, 0x52, 0x5f, 0x4d, 0x45, 0x53, 0x53, 0x41, 0x47, 0x45, 0x10, 0x04, 0x3a, 0x6f, 0x0a, 0x0f,
   225  	0x6f, 0x70, 0x65, 0x72, 0x61, 0x74, 0x69, 0x6f, 0x6e, 0x5f, 0x66, 0x69, 0x65, 0x6c, 0x64, 0x12,
   226  	0x1d, 0x2e, 0x67, 0x6f, 0x6f, 0x67, 0x6c, 0x65, 0x2e, 0x70, 0x72, 0x6f, 0x74, 0x6f, 0x62, 0x75,
   227  	0x66, 0x2e, 0x46, 0x69, 0x65, 0x6c, 0x64, 0x4f, 0x70, 0x74, 0x69, 0x6f, 0x6e, 0x73, 0x18, 0xfd,
   228  	0x08, 0x20, 0x01, 0x28, 0x0e, 0x32, 0x26, 0x2e, 0x67, 0x6f, 0x6f, 0x67, 0x6c, 0x65, 0x2e, 0x63,
   229  	0x6c, 0x6f, 0x75, 0x64, 0x2e, 0x4f, 0x70, 0x65, 0x72, 0x61, 0x74, 0x69, 0x6f, 0x6e, 0x52, 0x65,
   230  	0x73, 0x70, 0x6f, 0x6e, 0x73, 0x65, 0x4d, 0x61, 0x70, 0x70, 0x69, 0x6e, 0x67, 0x52, 0x0e, 0x6f,
   231  	0x70, 0x65, 0x72, 0x61, 0x74, 0x69, 0x6f, 0x6e, 0x46, 0x69, 0x65, 0x6c, 0x64, 0x3a, 0x56, 0x0a,
   232  	0x17, 0x6f, 0x70, 0x65, 0x72, 0x61, 0x74, 0x69, 0x6f, 0x6e, 0x5f, 0x72, 0x65, 0x71, 0x75, 0x65,
   233  	0x73, 0x74, 0x5f, 0x66, 0x69, 0x65, 0x6c, 0x64, 0x12, 0x1d, 0x2e, 0x67, 0x6f, 0x6f, 0x67, 0x6c,
   234  	0x65, 0x2e, 0x70, 0x72, 0x6f, 0x74, 0x6f, 0x62, 0x75, 0x66, 0x2e, 0x46, 0x69, 0x65, 0x6c, 0x64,
   235  	0x4f, 0x70, 0x74, 0x69, 0x6f, 0x6e, 0x73, 0x18, 0xfe, 0x08, 0x20, 0x01, 0x28, 0x09, 0x52, 0x15,
   236  	0x6f, 0x70, 0x65, 0x72, 0x61, 0x74, 0x69, 0x6f, 0x6e, 0x52, 0x65, 0x71, 0x75, 0x65, 0x73, 0x74,
   237  	0x46, 0x69, 0x65, 0x6c, 0x64, 0x3a, 0x58, 0x0a, 0x18, 0x6f, 0x70, 0x65, 0x72, 0x61, 0x74, 0x69,
   238  	0x6f, 0x6e, 0x5f, 0x72, 0x65, 0x73, 0x70, 0x6f, 0x6e, 0x73, 0x65, 0x5f, 0x66, 0x69, 0x65, 0x6c,
   239  	0x64, 0x12, 0x1d, 0x2e, 0x67, 0x6f, 0x6f, 0x67, 0x6c, 0x65, 0x2e, 0x70, 0x72, 0x6f, 0x74, 0x6f,
   240  	0x62, 0x75, 0x66, 0x2e, 0x46, 0x69, 0x65, 0x6c, 0x64, 0x4f, 0x70, 0x74, 0x69, 0x6f, 0x6e, 0x73,
   241  	0x18, 0xff, 0x08, 0x20, 0x01, 0x28, 0x09, 0x52, 0x16, 0x6f, 0x70, 0x65, 0x72, 0x61, 0x74, 0x69,
   242  	0x6f, 0x6e, 0x52, 0x65, 0x73, 0x70, 0x6f, 0x6e, 0x73, 0x65, 0x46, 0x69, 0x65, 0x6c, 0x64, 0x3a,
   243  	0x4c, 0x0a, 0x11, 0x6f, 0x70, 0x65, 0x72, 0x61, 0x74, 0x69, 0x6f, 0x6e, 0x5f, 0x73, 0x65, 0x72,
   244  	0x76, 0x69, 0x63, 0x65, 0x12, 0x1e, 0x2e, 0x67, 0x6f, 0x6f, 0x67, 0x6c, 0x65, 0x2e, 0x70, 0x72,
   245  	0x6f, 0x74, 0x6f, 0x62, 0x75, 0x66, 0x2e, 0x4d, 0x65, 0x74, 0x68, 0x6f, 0x64, 0x4f, 0x70, 0x74,
   246  	0x69, 0x6f, 0x6e, 0x73, 0x18, 0xe1, 0x09, 0x20, 0x01, 0x28, 0x09, 0x52, 0x10, 0x6f, 0x70, 0x65,
   247  	0x72, 0x61, 0x74, 0x69, 0x6f, 0x6e, 0x53, 0x65, 0x72, 0x76, 0x69, 0x63, 0x65, 0x3a, 0x59, 0x0a,
   248  	0x18, 0x6f, 0x70, 0x65, 0x72, 0x61, 0x74, 0x69, 0x6f, 0x6e, 0x5f, 0x70, 0x6f, 0x6c, 0x6c, 0x69,
   249  	0x6e, 0x67, 0x5f, 0x6d, 0x65, 0x74, 0x68, 0x6f, 0x64, 0x12, 0x1e, 0x2e, 0x67, 0x6f, 0x6f, 0x67,
   250  	0x6c, 0x65, 0x2e, 0x70, 0x72, 0x6f, 0x74, 0x6f, 0x62, 0x75, 0x66, 0x2e, 0x4d, 0x65, 0x74, 0x68,
   251  	0x6f, 0x64, 0x4f, 0x70, 0x74, 0x69, 0x6f, 0x6e, 0x73, 0x18, 0xe2, 0x09, 0x20, 0x01, 0x28, 0x08,
   252  	0x52, 0x16, 0x6f, 0x70, 0x65, 0x72, 0x61, 0x74, 0x69, 0x6f, 0x6e, 0x50, 0x6f, 0x6c, 0x6c, 0x69,
   253  	0x6e, 0x67, 0x4d, 0x65, 0x74, 0x68, 0x6f, 0x64, 0x42, 0x79, 0x0a, 0x10, 0x63, 0x6f, 0x6d, 0x2e,
   254  	0x67, 0x6f, 0x6f, 0x67, 0x6c, 0x65, 0x2e, 0x63, 0x6c, 0x6f, 0x75, 0x64, 0x42, 0x17, 0x45, 0x78,
   255  	0x74, 0x65, 0x6e, 0x64, 0x65, 0x64, 0x4f, 0x70, 0x65, 0x72, 0x61, 0x74, 0x69, 0x6f, 0x6e, 0x73,
   256  	0x50, 0x72, 0x6f, 0x74, 0x6f, 0x50, 0x01, 0x5a, 0x43, 0x67, 0x6f, 0x6f, 0x67, 0x6c, 0x65, 0x2e,
   257  	0x67, 0x6f, 0x6c, 0x61, 0x6e, 0x67, 0x2e, 0x6f, 0x72, 0x67, 0x2f, 0x67, 0x65, 0x6e, 0x70, 0x72,
   258  	0x6f, 0x74, 0x6f, 0x2f, 0x67, 0x6f, 0x6f, 0x67, 0x6c, 0x65, 0x61, 0x70, 0x69, 0x73, 0x2f, 0x63,
   259  	0x6c, 0x6f, 0x75, 0x64, 0x2f, 0x65, 0x78, 0x74, 0x65, 0x6e, 0x64, 0x65, 0x64, 0x6f, 0x70, 0x73,
   260  	0x3b, 0x65, 0x78, 0x74, 0x65, 0x6e, 0x64, 0x65, 0x64, 0x6f, 0x70, 0x73, 0xa2, 0x02, 0x04, 0x47,
   261  	0x41, 0x50, 0x49, 0x62, 0x06, 0x70, 0x72, 0x6f, 0x74, 0x6f, 0x33,
   262  }
   263  
   264  var (
   265  	file_google_cloud_extended_operations_proto_rawDescOnce sync.Once
   266  	file_google_cloud_extended_operations_proto_rawDescData = file_google_cloud_extended_operations_proto_rawDesc
   267  )
   268  
   269  func file_google_cloud_extended_operations_proto_rawDescGZIP() []byte {
   270  	file_google_cloud_extended_operations_proto_rawDescOnce.Do(func() {
   271  		file_google_cloud_extended_operations_proto_rawDescData = protoimpl.X.CompressGZIP(file_google_cloud_extended_operations_proto_rawDescData)
   272  	})
   273  	return file_google_cloud_extended_operations_proto_rawDescData
   274  }
   275  
   276  var file_google_cloud_extended_operations_proto_enumTypes = make([]protoimpl.EnumInfo, 1)
   277  var file_google_cloud_extended_operations_proto_goTypes = []interface{}{
   278  	(OperationResponseMapping)(0),      // 0: google.cloud.OperationResponseMapping
   279  	(*descriptorpb.FieldOptions)(nil),  // 1: google.protobuf.FieldOptions
   280  	(*descriptorpb.MethodOptions)(nil), // 2: google.protobuf.MethodOptions
   281  }
   282  var file_google_cloud_extended_operations_proto_depIdxs = []int32{
   283  	1, // 0: google.cloud.operation_field:extendee -> google.protobuf.FieldOptions
   284  	1, // 1: google.cloud.operation_request_field:extendee -> google.protobuf.FieldOptions
   285  	1, // 2: google.cloud.operation_response_field:extendee -> google.protobuf.FieldOptions
   286  	2, // 3: google.cloud.operation_service:extendee -> google.protobuf.MethodOptions
   287  	2, // 4: google.cloud.operation_polling_method:extendee -> google.protobuf.MethodOptions
   288  	0, // 5: google.cloud.operation_field:type_name -> google.cloud.OperationResponseMapping
   289  	6, // [6:6] is the sub-list for method output_type
   290  	6, // [6:6] is the sub-list for method input_type
   291  	5, // [5:6] is the sub-list for extension type_name
   292  	0, // [0:5] is the sub-list for extension extendee
   293  	0, // [0:0] is the sub-list for field type_name
   294  }
   295  
   296  func init() { file_google_cloud_extended_operations_proto_init() }
   297  func file_google_cloud_extended_operations_proto_init() {
   298  	if File_google_cloud_extended_operations_proto != nil {
   299  		return
   300  	}
   301  	type x struct{}
   302  	out := protoimpl.TypeBuilder{
   303  		File: protoimpl.DescBuilder{
   304  			GoPackagePath: reflect.TypeOf(x{}).PkgPath(),
   305  			RawDescriptor: file_google_cloud_extended_operations_proto_rawDesc,
   306  			NumEnums:      1,
   307  			NumMessages:   0,
   308  			NumExtensions: 5,
   309  			NumServices:   0,
   310  		},
   311  		GoTypes:           file_google_cloud_extended_operations_proto_goTypes,
   312  		DependencyIndexes: file_google_cloud_extended_operations_proto_depIdxs,
   313  		EnumInfos:         file_google_cloud_extended_operations_proto_enumTypes,
   314  		ExtensionInfos:    file_google_cloud_extended_operations_proto_extTypes,
   315  	}.Build()
   316  	File_google_cloud_extended_operations_proto = out.File
   317  	file_google_cloud_extended_operations_proto_rawDesc = nil
   318  	file_google_cloud_extended_operations_proto_goTypes = nil
   319  	file_google_cloud_extended_operations_proto_depIdxs = nil
   320  }
   321
View as plain text