annotations

package
Version: v0.0.0-...-a2ec334 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Nov 30, 2022 License: Apache-2.0 Imports: 7 Imported by: 11,280

Documentation

Index

Constants

This section is empty.

Variables

View Source
var (
	ClientLibraryOrganization_name = map[int32]string{
		0: "CLIENT_LIBRARY_ORGANIZATION_UNSPECIFIED",
		1: "CLOUD",
		2: "ADS",
		3: "PHOTOS",
		4: "STREET_VIEW",
	}
	ClientLibraryOrganization_value = map[string]int32{
		"CLIENT_LIBRARY_ORGANIZATION_UNSPECIFIED": 0,
		"CLOUD":       1,
		"ADS":         2,
		"PHOTOS":      3,
		"STREET_VIEW": 4,
	}
)

Enum value maps for ClientLibraryOrganization.

View Source
var (
	ClientLibraryDestination_name = map[int32]string{
		0:  "CLIENT_LIBRARY_DESTINATION_UNSPECIFIED",
		10: "GITHUB",
		20: "PACKAGE_MANAGER",
	}
	ClientLibraryDestination_value = map[string]int32{
		"CLIENT_LIBRARY_DESTINATION_UNSPECIFIED": 0,
		"GITHUB":                                 10,
		"PACKAGE_MANAGER":                        20,
	}
)

Enum value maps for ClientLibraryDestination.

View Source
var (
	// The hostname for this service.
	// This should be specified with no prefix or protocol.
	//
	// Example:
	//
	//	service Foo {
	//	  option (google.api.default_host) = "foo.googleapi.com";
	//	  ...
	//	}
	//
	// optional string default_host = 1049;
	E_DefaultHost = &file_google_api_client_proto_extTypes[1]
	// OAuth scopes needed for the client.
	//
	// Example:
	//
	//	service Foo {
	//	  option (google.api.oauth_scopes) = \
	//	    "https://www.googleapis.com/auth/cloud-platform";
	//	  ...
	//	}
	//
	// If there is more than one scope, use a comma-separated string:
	//
	// Example:
	//
	//	service Foo {
	//	  option (google.api.oauth_scopes) = \
	//	    "https://www.googleapis.com/auth/cloud-platform,"
	//	    "https://www.googleapis.com/auth/monitoring";
	//	  ...
	//	}
	//
	// optional string oauth_scopes = 1050;
	E_OauthScopes = &file_google_api_client_proto_extTypes[2]
)

Extension fields to descriptorpb.ServiceOptions.

View Source
var (
	FieldBehavior_name = map[int32]string{
		0: "FIELD_BEHAVIOR_UNSPECIFIED",
		1: "OPTIONAL",
		2: "REQUIRED",
		3: "OUTPUT_ONLY",
		4: "INPUT_ONLY",
		5: "IMMUTABLE",
		6: "UNORDERED_LIST",
		7: "NON_EMPTY_DEFAULT",
	}
	FieldBehavior_value = map[string]int32{
		"FIELD_BEHAVIOR_UNSPECIFIED": 0,
		"OPTIONAL":                   1,
		"REQUIRED":                   2,
		"OUTPUT_ONLY":                3,
		"INPUT_ONLY":                 4,
		"IMMUTABLE":                  5,
		"UNORDERED_LIST":             6,
		"NON_EMPTY_DEFAULT":          7,
	}
)

Enum value maps for FieldBehavior.

View Source
var (
	ResourceDescriptor_History_name = map[int32]string{
		0: "HISTORY_UNSPECIFIED",
		1: "ORIGINALLY_SINGLE_PATTERN",
		2: "FUTURE_MULTI_PATTERN",
	}
	ResourceDescriptor_History_value = map[string]int32{
		"HISTORY_UNSPECIFIED":       0,
		"ORIGINALLY_SINGLE_PATTERN": 1,
		"FUTURE_MULTI_PATTERN":      2,
	}
)

Enum value maps for ResourceDescriptor_History.

View Source
var (
	ResourceDescriptor_Style_name = map[int32]string{
		0: "STYLE_UNSPECIFIED",
		1: "DECLARATIVE_FRIENDLY",
	}
	ResourceDescriptor_Style_value = map[string]int32{
		"STYLE_UNSPECIFIED":    0,
		"DECLARATIVE_FRIENDLY": 1,
	}
)

Enum value maps for ResourceDescriptor_Style.

View Source
var (
	// A designation of a specific field behavior (required, output only, etc.)
	// in protobuf messages.
	//
	// Examples:
	//
	//   string name = 1 [(google.api.field_behavior) = REQUIRED];
	//   State state = 1 [(google.api.field_behavior) = OUTPUT_ONLY];
	//   google.protobuf.Duration ttl = 1
	//     [(google.api.field_behavior) = INPUT_ONLY];
	//   google.protobuf.Timestamp expire_time = 1
	//     [(google.api.field_behavior) = OUTPUT_ONLY,
	//      (google.api.field_behavior) = IMMUTABLE];
	//
	// repeated google.api.FieldBehavior field_behavior = 1052;
	E_FieldBehavior = &file_google_api_field_behavior_proto_extTypes[0]
)

Extension fields to descriptorpb.FieldOptions.

View Source
var (
	// See `HttpRule`.
	//
	// optional google.api.HttpRule http = 72295728;
	E_Http = &file_google_api_annotations_proto_extTypes[0]
)

Extension fields to descriptorpb.MethodOptions.

View Source
var (
	// A definition of a client library method signature.
	//
	// In client libraries, each proto RPC corresponds to one or more methods
	// which the end user is able to call, and calls the underlying RPC.
	// Normally, this method receives a single argument (a struct or instance
	// corresponding to the RPC request object). Defining this field will
	// add one or more overloads providing flattened or simpler method signatures
	// in some languages.
	//
	// The fields on the method signature are provided as a comma-separated
	// string.
	//
	// For example, the proto RPC and annotation:
	//
	//	rpc CreateSubscription(CreateSubscriptionRequest)
	//	    returns (Subscription) {
	//	  option (google.api.method_signature) = "name,topic";
	//	}
	//
	// Would add the following Java overload (in addition to the method accepting
	// the request object):
	//
	//	public final Subscription createSubscription(String name, String topic)
	//
	// The following backwards-compatibility guidelines apply:
	//
	//   - Adding this annotation to an unannotated method is backwards
	//     compatible.
	//   - Adding this annotation to a method which already has existing
	//     method signature annotations is backwards compatible if and only if
	//     the new method signature annotation is last in the sequence.
	//   - Modifying or removing an existing method signature annotation is
	//     a breaking change.
	//   - Re-ordering existing method signature annotations is a breaking
	//     change.
	//
	// repeated string method_signature = 1051;
	E_MethodSignature = &file_google_api_client_proto_extTypes[0]
)

Extension fields to descriptorpb.MethodOptions.

View Source
var (
	// An annotation that describes a resource definition, see
	// [ResourceDescriptor][].
	//
	// optional google.api.ResourceDescriptor resource = 1053;
	E_Resource = &file_google_api_resource_proto_extTypes[2]
)

Extension fields to descriptorpb.MessageOptions.

View Source
var (
	// An annotation that describes a resource definition without a corresponding
	// message; see [ResourceDescriptor][].
	//
	// repeated google.api.ResourceDescriptor resource_definition = 1053;
	E_ResourceDefinition = &file_google_api_resource_proto_extTypes[1]
)

Extension fields to descriptorpb.FileOptions.

View Source
var (
	// An annotation that describes a resource reference, see
	// [ResourceReference][].
	//
	// optional google.api.ResourceReference resource_reference = 1055;
	E_ResourceReference = &file_google_api_resource_proto_extTypes[0]
)

Extension fields to descriptorpb.FieldOptions.

View Source
var (
	// See RoutingRule.
	//
	// optional google.api.RoutingRule routing = 72295729;
	E_Routing = &file_google_api_routing_proto_extTypes[0]
)

Extension fields to descriptorpb.MethodOptions.

View Source
var File_google_api_annotations_proto protoreflect.FileDescriptor
View Source
var File_google_api_client_proto protoreflect.FileDescriptor
View Source
var File_google_api_field_behavior_proto protoreflect.FileDescriptor
View Source
var File_google_api_http_proto protoreflect.FileDescriptor
View Source
var File_google_api_resource_proto protoreflect.FileDescriptor
View Source
var File_google_api_routing_proto protoreflect.FileDescriptor

Functions

This section is empty.

Types

type ClientLibraryDestination

type ClientLibraryDestination int32

To where should client libraries be published?

const (
	// Client libraries will neither be generated nor published to package
	// managers.
	ClientLibraryDestination_CLIENT_LIBRARY_DESTINATION_UNSPECIFIED ClientLibraryDestination = 0
	// Generate the client library in a repo under github.com/googleapis,
	// but don't publish it to package managers.
	ClientLibraryDestination_GITHUB ClientLibraryDestination = 10
	// Publish the library to package managers like nuget.org and npmjs.com.
	ClientLibraryDestination_PACKAGE_MANAGER ClientLibraryDestination = 20
)

func (ClientLibraryDestination) Descriptor

func (ClientLibraryDestination) Enum

func (ClientLibraryDestination) EnumDescriptor deprecated

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

Deprecated: Use ClientLibraryDestination.Descriptor instead.

func (ClientLibraryDestination) Number

func (ClientLibraryDestination) String

func (x ClientLibraryDestination) String() string

func (ClientLibraryDestination) Type

type ClientLibraryOrganization

type ClientLibraryOrganization int32

The organization for which the client libraries are being published. Affects the url where generated docs are published, etc.

const (
	// Not useful.
	ClientLibraryOrganization_CLIENT_LIBRARY_ORGANIZATION_UNSPECIFIED ClientLibraryOrganization = 0
	// Google Cloud Platform Org.
	ClientLibraryOrganization_CLOUD ClientLibraryOrganization = 1
	// Ads (Advertising) Org.
	ClientLibraryOrganization_ADS ClientLibraryOrganization = 2
	// Photos Org.
	ClientLibraryOrganization_PHOTOS ClientLibraryOrganization = 3
	// Street View Org.
	ClientLibraryOrganization_STREET_VIEW ClientLibraryOrganization = 4
)

func (ClientLibraryOrganization) Descriptor

func (ClientLibraryOrganization) Enum

func (ClientLibraryOrganization) EnumDescriptor deprecated

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

Deprecated: Use ClientLibraryOrganization.Descriptor instead.

func (ClientLibraryOrganization) Number

func (ClientLibraryOrganization) String

func (x ClientLibraryOrganization) String() string

func (ClientLibraryOrganization) Type

type ClientLibrarySettings

type ClientLibrarySettings struct {

	// Version of the API to apply these settings to.
	Version string `protobuf:"bytes,1,opt,name=version,proto3" json:"version,omitempty"`
	// Launch stage of this version of the API.
	LaunchStage api.LaunchStage `protobuf:"varint,2,opt,name=launch_stage,json=launchStage,proto3,enum=google.api.LaunchStage" json:"launch_stage,omitempty"`
	// When using transport=rest, the client request will encode enums as
	// numbers rather than strings.
	RestNumericEnums bool `protobuf:"varint,3,opt,name=rest_numeric_enums,json=restNumericEnums,proto3" json:"rest_numeric_enums,omitempty"`
	// Settings for legacy Java features, supported in the Service YAML.
	JavaSettings *JavaSettings `protobuf:"bytes,21,opt,name=java_settings,json=javaSettings,proto3" json:"java_settings,omitempty"`
	// Settings for C++ client libraries.
	CppSettings *CppSettings `protobuf:"bytes,22,opt,name=cpp_settings,json=cppSettings,proto3" json:"cpp_settings,omitempty"`
	// Settings for PHP client libraries.
	PhpSettings *PhpSettings `protobuf:"bytes,23,opt,name=php_settings,json=phpSettings,proto3" json:"php_settings,omitempty"`
	// Settings for Python client libraries.
	PythonSettings *PythonSettings `protobuf:"bytes,24,opt,name=python_settings,json=pythonSettings,proto3" json:"python_settings,omitempty"`
	// Settings for Node client libraries.
	NodeSettings *NodeSettings `protobuf:"bytes,25,opt,name=node_settings,json=nodeSettings,proto3" json:"node_settings,omitempty"`
	// Settings for .NET client libraries.
	DotnetSettings *DotnetSettings `protobuf:"bytes,26,opt,name=dotnet_settings,json=dotnetSettings,proto3" json:"dotnet_settings,omitempty"`
	// Settings for Ruby client libraries.
	RubySettings *RubySettings `protobuf:"bytes,27,opt,name=ruby_settings,json=rubySettings,proto3" json:"ruby_settings,omitempty"`
	// Settings for Go client libraries.
	GoSettings *GoSettings `protobuf:"bytes,28,opt,name=go_settings,json=goSettings,proto3" json:"go_settings,omitempty"`
	// contains filtered or unexported fields
}

Details about how and where to publish client libraries.

func (*ClientLibrarySettings) Descriptor deprecated

func (*ClientLibrarySettings) Descriptor() ([]byte, []int)

Deprecated: Use ClientLibrarySettings.ProtoReflect.Descriptor instead.

func (*ClientLibrarySettings) GetCppSettings

func (x *ClientLibrarySettings) GetCppSettings() *CppSettings

func (*ClientLibrarySettings) GetDotnetSettings

func (x *ClientLibrarySettings) GetDotnetSettings() *DotnetSettings

func (*ClientLibrarySettings) GetGoSettings

func (x *ClientLibrarySettings) GetGoSettings() *GoSettings

func (*ClientLibrarySettings) GetJavaSettings

func (x *ClientLibrarySettings) GetJavaSettings() *JavaSettings

func (*ClientLibrarySettings) GetLaunchStage

func (x *ClientLibrarySettings) GetLaunchStage() api.LaunchStage

func (*ClientLibrarySettings) GetNodeSettings

func (x *ClientLibrarySettings) GetNodeSettings() *NodeSettings

func (*ClientLibrarySettings) GetPhpSettings

func (x *ClientLibrarySettings) GetPhpSettings() *PhpSettings

func (*ClientLibrarySettings) GetPythonSettings

func (x *ClientLibrarySettings) GetPythonSettings() *PythonSettings

func (*ClientLibrarySettings) GetRestNumericEnums

func (x *ClientLibrarySettings) GetRestNumericEnums() bool

func (*ClientLibrarySettings) GetRubySettings

func (x *ClientLibrarySettings) GetRubySettings() *RubySettings

func (*ClientLibrarySettings) GetVersion

func (x *ClientLibrarySettings) GetVersion() string

func (*ClientLibrarySettings) ProtoMessage

func (*ClientLibrarySettings) ProtoMessage()

func (*ClientLibrarySettings) ProtoReflect

func (x *ClientLibrarySettings) ProtoReflect() protoreflect.Message

func (*ClientLibrarySettings) Reset

func (x *ClientLibrarySettings) Reset()

func (*ClientLibrarySettings) String

func (x *ClientLibrarySettings) String() string

type CommonLanguageSettings

type CommonLanguageSettings struct {

	// Link to automatically generated reference documentation.  Example:
	// https://cloud.google.com/nodejs/docs/reference/asset/latest
	ReferenceDocsUri string `protobuf:"bytes,1,opt,name=reference_docs_uri,json=referenceDocsUri,proto3" json:"reference_docs_uri,omitempty"`
	// The destination where API teams want this client library to be published.
	Destinations []ClientLibraryDestination `` /* 126-byte string literal not displayed */
	// contains filtered or unexported fields
}

Required information for every language.

func (*CommonLanguageSettings) Descriptor deprecated

func (*CommonLanguageSettings) Descriptor() ([]byte, []int)

Deprecated: Use CommonLanguageSettings.ProtoReflect.Descriptor instead.

func (*CommonLanguageSettings) GetDestinations

func (x *CommonLanguageSettings) GetDestinations() []ClientLibraryDestination

func (*CommonLanguageSettings) GetReferenceDocsUri

func (x *CommonLanguageSettings) GetReferenceDocsUri() string

func (*CommonLanguageSettings) ProtoMessage

func (*CommonLanguageSettings) ProtoMessage()

func (*CommonLanguageSettings) ProtoReflect

func (x *CommonLanguageSettings) ProtoReflect() protoreflect.Message

func (*CommonLanguageSettings) Reset

func (x *CommonLanguageSettings) Reset()

func (*CommonLanguageSettings) String

func (x *CommonLanguageSettings) String() string

type CppSettings

type CppSettings struct {

	// Some settings.
	Common *CommonLanguageSettings `protobuf:"bytes,1,opt,name=common,proto3" json:"common,omitempty"`
	// contains filtered or unexported fields
}

Settings for C++ client libraries.

func (*CppSettings) Descriptor deprecated

func (*CppSettings) Descriptor() ([]byte, []int)

Deprecated: Use CppSettings.ProtoReflect.Descriptor instead.

func (*CppSettings) GetCommon

func (x *CppSettings) GetCommon() *CommonLanguageSettings

func (*CppSettings) ProtoMessage

func (*CppSettings) ProtoMessage()

func (*CppSettings) ProtoReflect

func (x *CppSettings) ProtoReflect() protoreflect.Message

func (*CppSettings) Reset

func (x *CppSettings) Reset()

func (*CppSettings) String

func (x *CppSettings) String() string

type CustomHttpPattern

type CustomHttpPattern struct {

	// The name of this custom HTTP verb.
	Kind string `protobuf:"bytes,1,opt,name=kind,proto3" json:"kind,omitempty"`
	// The path matched by this custom verb.
	Path string `protobuf:"bytes,2,opt,name=path,proto3" json:"path,omitempty"`
	// contains filtered or unexported fields
}

A custom pattern is used for defining custom HTTP verb.

func (*CustomHttpPattern) Descriptor deprecated

func (*CustomHttpPattern) Descriptor() ([]byte, []int)

Deprecated: Use CustomHttpPattern.ProtoReflect.Descriptor instead.

func (*CustomHttpPattern) GetKind

func (x *CustomHttpPattern) GetKind() string

func (*CustomHttpPattern) GetPath

func (x *CustomHttpPattern) GetPath() string

func (*CustomHttpPattern) ProtoMessage

func (*CustomHttpPattern) ProtoMessage()

func (*CustomHttpPattern) ProtoReflect

func (x *CustomHttpPattern) ProtoReflect() protoreflect.Message

func (*CustomHttpPattern) Reset

func (x *CustomHttpPattern) Reset()

func (*CustomHttpPattern) String

func (x *CustomHttpPattern) String() string

type DotnetSettings

type DotnetSettings struct {

	// Some settings.
	Common *CommonLanguageSettings `protobuf:"bytes,1,opt,name=common,proto3" json:"common,omitempty"`
	// contains filtered or unexported fields
}

Settings for Dotnet client libraries.

func (*DotnetSettings) Descriptor deprecated

func (*DotnetSettings) Descriptor() ([]byte, []int)

Deprecated: Use DotnetSettings.ProtoReflect.Descriptor instead.

func (*DotnetSettings) GetCommon

func (x *DotnetSettings) GetCommon() *CommonLanguageSettings

func (*DotnetSettings) ProtoMessage

func (*DotnetSettings) ProtoMessage()

func (*DotnetSettings) ProtoReflect

func (x *DotnetSettings) ProtoReflect() protoreflect.Message

func (*DotnetSettings) Reset

func (x *DotnetSettings) Reset()

func (*DotnetSettings) String

func (x *DotnetSettings) String() string

type FieldBehavior

type FieldBehavior int32

An indicator of the behavior of a given field (for example, that a field is required in requests, or given as output but ignored as input). This **does not** change the behavior in protocol buffers itself; it only denotes the behavior and may affect how API tooling handles the field.

Note: This enum **may** receive new values in the future.

const (
	// Conventional default for enums. Do not use this.
	FieldBehavior_FIELD_BEHAVIOR_UNSPECIFIED FieldBehavior = 0
	// Specifically denotes a field as optional.
	// While all fields in protocol buffers are optional, this may be specified
	// for emphasis if appropriate.
	FieldBehavior_OPTIONAL FieldBehavior = 1
	// Denotes a field as required.
	// This indicates that the field **must** be provided as part of the request,
	// and failure to do so will cause an error (usually `INVALID_ARGUMENT`).
	FieldBehavior_REQUIRED FieldBehavior = 2
	// Denotes a field as output only.
	// This indicates that the field is provided in responses, but including the
	// field in a request does nothing (the server *must* ignore it and
	// *must not* throw an error as a result of the field's presence).
	FieldBehavior_OUTPUT_ONLY FieldBehavior = 3
	// Denotes a field as input only.
	// This indicates that the field is provided in requests, and the
	// corresponding field is not included in output.
	FieldBehavior_INPUT_ONLY FieldBehavior = 4
	// Denotes a field as immutable.
	// This indicates that the field may be set once in a request to create a
	// resource, but may not be changed thereafter.
	FieldBehavior_IMMUTABLE FieldBehavior = 5
	// Denotes that a (repeated) field is an unordered list.
	// This indicates that the service may provide the elements of the list
	// in any arbitrary  order, rather than the order the user originally
	// provided. Additionally, the list's order may or may not be stable.
	FieldBehavior_UNORDERED_LIST FieldBehavior = 6
	// Denotes that this field returns a non-empty default value if not set.
	// This indicates that if the user provides the empty value in a request,
	// a non-empty value will be returned. The user will not be aware of what
	// non-empty value to expect.
	FieldBehavior_NON_EMPTY_DEFAULT FieldBehavior = 7
)

func (FieldBehavior) Descriptor

func (FieldBehavior) Enum

func (x FieldBehavior) Enum() *FieldBehavior

func (FieldBehavior) EnumDescriptor deprecated

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

Deprecated: Use FieldBehavior.Descriptor instead.

func (FieldBehavior) Number

func (FieldBehavior) String

func (x FieldBehavior) String() string

func (FieldBehavior) Type

type GoSettings

type GoSettings struct {

	// Some settings.
	Common *CommonLanguageSettings `protobuf:"bytes,1,opt,name=common,proto3" json:"common,omitempty"`
	// contains filtered or unexported fields
}

Settings for Go client libraries.

func (*GoSettings) Descriptor deprecated

func (*GoSettings) Descriptor() ([]byte, []int)

Deprecated: Use GoSettings.ProtoReflect.Descriptor instead.

func (*GoSettings) GetCommon

func (x *GoSettings) GetCommon() *CommonLanguageSettings

func (*GoSettings) ProtoMessage

func (*GoSettings) ProtoMessage()

func (*GoSettings) ProtoReflect

func (x *GoSettings) ProtoReflect() protoreflect.Message

func (*GoSettings) Reset

func (x *GoSettings) Reset()

func (*GoSettings) String

func (x *GoSettings) String() string

type Http

type Http struct {

	// A list of HTTP configuration rules that apply to individual API methods.
	//
	// **NOTE:** All service configuration rules follow "last one wins" order.
	Rules []*HttpRule `protobuf:"bytes,1,rep,name=rules,proto3" json:"rules,omitempty"`
	// When set to true, URL path parameters will be fully URI-decoded except in
	// cases of single segment matches in reserved expansion, where "%2F" will be
	// left encoded.
	//
	// The default behavior is to not decode RFC 6570 reserved characters in multi
	// segment matches.
	FullyDecodeReservedExpansion bool `` /* 150-byte string literal not displayed */
	// contains filtered or unexported fields
}

Defines the HTTP configuration for an API service. It contains a list of HttpRule[google.api.HttpRule], each specifying the mapping of an RPC method to one or more HTTP REST API methods.

func (*Http) Descriptor deprecated

func (*Http) Descriptor() ([]byte, []int)

Deprecated: Use Http.ProtoReflect.Descriptor instead.

func (*Http) GetFullyDecodeReservedExpansion

func (x *Http) GetFullyDecodeReservedExpansion() bool

func (*Http) GetRules

func (x *Http) GetRules() []*HttpRule

func (*Http) ProtoMessage

func (*Http) ProtoMessage()

func (*Http) ProtoReflect

func (x *Http) ProtoReflect() protoreflect.Message

func (*Http) Reset

func (x *Http) Reset()

func (*Http) String

func (x *Http) String() string

type HttpRule

type HttpRule struct {

	// Selects a method to which this rule applies.
	//
	// Refer to [selector][google.api.DocumentationRule.selector] for syntax details.
	Selector string `protobuf:"bytes,1,opt,name=selector,proto3" json:"selector,omitempty"`
	// Determines the URL pattern is matched by this rules. This pattern can be
	// used with any of the {get|put|post|delete|patch} methods. A custom method
	// can be defined using the 'custom' field.
	//
	// Types that are assignable to Pattern:
	//	*HttpRule_Get
	//	*HttpRule_Put
	//	*HttpRule_Post
	//	*HttpRule_Delete
	//	*HttpRule_Patch
	//	*HttpRule_Custom
	Pattern isHttpRule_Pattern `protobuf_oneof:"pattern"`
	// The name of the request field whose value is mapped to the HTTP request
	// body, or `*` for mapping all request fields not captured by the path
	// pattern to the HTTP body, or omitted for not having any HTTP request body.
	//
	// NOTE: the referred field must be present at the top-level of the request
	// message type.
	Body string `protobuf:"bytes,7,opt,name=body,proto3" json:"body,omitempty"`
	// Optional. The name of the response field whose value is mapped to the HTTP
	// response body. When omitted, the entire response message will be used
	// as the HTTP response body.
	//
	// NOTE: The referred field must be present at the top-level of the response
	// message type.
	ResponseBody string `protobuf:"bytes,12,opt,name=response_body,json=responseBody,proto3" json:"response_body,omitempty"`
	// Additional HTTP bindings for the selector. Nested bindings must
	// not contain an `additional_bindings` field themselves (that is,
	// the nesting may only be one level deep).
	AdditionalBindings []*HttpRule `protobuf:"bytes,11,rep,name=additional_bindings,json=additionalBindings,proto3" json:"additional_bindings,omitempty"`
	// contains filtered or unexported fields
}

gRPC Transcoding

gRPC Transcoding is a feature for mapping between a gRPC method and one or more HTTP REST endpoints. It allows developers to build a single API service that supports both gRPC APIs and REST APIs. Many systems, including [Google APIs](https://github.com/googleapis/googleapis), [Cloud Endpoints](https://cloud.google.com/endpoints), [gRPC Gateway](https://github.com/grpc-ecosystem/grpc-gateway), and [Envoy](https://github.com/envoyproxy/envoy) proxy support this feature and use it for large scale production services.

`HttpRule` defines the schema of the gRPC/REST mapping. The mapping specifies how different portions of the gRPC request message are mapped to the URL path, URL query parameters, and HTTP request body. It also controls how the gRPC response message is mapped to the HTTP response body. `HttpRule` is typically specified as an `google.api.http` annotation on the gRPC method.

Each mapping specifies a URL path template and an HTTP method. The path template may refer to one or more fields in the gRPC request message, as long as each field is a non-repeated field with a primitive (non-message) type. The path template controls how fields of the request message are mapped to the URL path.

Example:

service Messaging {
  rpc GetMessage(GetMessageRequest) returns (Message) {
    option (google.api.http) = {
        get: "/v1/{name=messages/*}"
    };
  }
}
message GetMessageRequest {
  string name = 1; // Mapped to URL path.
}
message Message {
  string text = 1; // The resource content.
}

This enables an HTTP REST to gRPC mapping as below:

HTTP | gRPC -----|----- `GET /v1/messages/123456` | `GetMessage(name: "messages/123456")`

Any fields in the request message which are not bound by the path template automatically become HTTP query parameters if there is no HTTP request body. For example:

service Messaging {
  rpc GetMessage(GetMessageRequest) returns (Message) {
    option (google.api.http) = {
        get:"/v1/messages/{message_id}"
    };
  }
}
message GetMessageRequest {
  message SubMessage {
    string subfield = 1;
  }
  string message_id = 1; // Mapped to URL path.
  int64 revision = 2;    // Mapped to URL query parameter `revision`.
  SubMessage sub = 3;    // Mapped to URL query parameter `sub.subfield`.
}

This enables a HTTP JSON to RPC mapping as below:

HTTP | gRPC -----|----- `GET /v1/messages/123456?revision=2&sub.subfield=foo` | `GetMessage(message_id: "123456" revision: 2 sub: SubMessage(subfield: "foo"))`

Note that fields which are mapped to URL query parameters must have a primitive type or a repeated primitive type or a non-repeated message type. In the case of a repeated type, the parameter can be repeated in the URL as `...?param=A&param=B`. In the case of a message type, each field of the message is mapped to a separate parameter, such as `...?foo.a=A&foo.b=B&foo.c=C`.

For HTTP methods that allow a request body, the `body` field specifies the mapping. Consider a REST update method on the message resource collection:

service Messaging {
  rpc UpdateMessage(UpdateMessageRequest) returns (Message) {
    option (google.api.http) = {
      patch: "/v1/messages/{message_id}"
      body: "message"
    };
  }
}
message UpdateMessageRequest {
  string message_id = 1; // mapped to the URL
  Message message = 2;   // mapped to the body
}

The following HTTP JSON to RPC mapping is enabled, where the representation of the JSON in the request body is determined by protos JSON encoding:

HTTP | gRPC -----|----- `PATCH /v1/messages/123456 { "text": "Hi!" }` | `UpdateMessage(message_id: "123456" message { text: "Hi!" })`

The special name `*` can be used in the body mapping to define that every field not bound by the path template should be mapped to the request body. This enables the following alternative definition of the update method:

service Messaging {
  rpc UpdateMessage(Message) returns (Message) {
    option (google.api.http) = {
      patch: "/v1/messages/{message_id}"
      body: "*"
    };
  }
}
message Message {
  string message_id = 1;
  string text = 2;
}

The following HTTP JSON to RPC mapping is enabled:

HTTP | gRPC -----|----- `PATCH /v1/messages/123456 { "text": "Hi!" }` | `UpdateMessage(message_id: "123456" text: "Hi!")`

Note that when using `*` in the body mapping, it is not possible to have HTTP parameters, as all fields not bound by the path end in the body. This makes this option more rarely used in practice when defining REST APIs. The common usage of `*` is in custom methods which don't use the URL at all for transferring data.

It is possible to define multiple HTTP methods for one RPC by using the `additional_bindings` option. Example:

service Messaging {
  rpc GetMessage(GetMessageRequest) returns (Message) {
    option (google.api.http) = {
      get: "/v1/messages/{message_id}"
      additional_bindings {
        get: "/v1/users/{user_id}/messages/{message_id}"
      }
    };
  }
}
message GetMessageRequest {
  string message_id = 1;
  string user_id = 2;
}

This enables the following two alternative HTTP JSON to RPC mappings:

HTTP | gRPC -----|----- `GET /v1/messages/123456` | `GetMessage(message_id: "123456")` `GET /v1/users/me/messages/123456` | `GetMessage(user_id: "me" message_id: "123456")`

## Rules for HTTP mapping

  1. Leaf request fields (recursive expansion nested messages in the request message) are classified into three categories: - Fields referred by the path template. They are passed via the URL path. - Fields referred by the [HttpRule.body][google.api.HttpRule.body]. They are passed via the HTTP request body. - All other fields are passed via the URL query parameters, and the parameter name is the field path in the request message. A repeated field can be represented as multiple query parameters under the same name.
  2. If [HttpRule.body][google.api.HttpRule.body] is "*", there is no URL query parameter, all fields are passed via URL path and HTTP request body.
  3. If [HttpRule.body][google.api.HttpRule.body] is omitted, there is no HTTP request body, all fields are passed via URL path and URL query parameters.

### Path template syntax

Template = "/" Segments [ Verb ] ;
Segments = Segment { "/" Segment } ;
Segment  = "*" | "**" | LITERAL | Variable ;
Variable = "{" FieldPath [ "=" Segments ] "}" ;
FieldPath = IDENT { "." IDENT } ;
Verb     = ":" LITERAL ;

The syntax `*` matches a single URL path segment. The syntax `**` matches zero or more URL path segments, which must be the last part of the URL path except the `Verb`.

The syntax `Variable` matches part of the URL path as specified by its template. A variable template must not contain other variables. If a variable matches a single path segment, its template may be omitted, e.g. `{var}` is equivalent to `{var=*}`.

The syntax `LITERAL` matches literal text in the URL path. If the `LITERAL` contains any reserved character, such characters should be percent-encoded before the matching.

If a variable contains exactly one path segment, such as `"{var}"` or `"{var=*}"`, when such a variable is expanded into a URL path on the client side, all characters except `[-_.~0-9a-zA-Z]` are percent-encoded. The server side does the reverse decoding. Such variables show up in the [Discovery Document](https://developers.google.com/discovery/v1/reference/apis) as `{var}`.

If a variable contains multiple path segments, such as `"{var=foo/*}"` or `"{var=**}"`, when such a variable is expanded into a URL path on the client side, all characters except `[-_.~/0-9a-zA-Z]` are percent-encoded. The server side does the reverse decoding, except "%2F" and "%2f" are left unchanged. Such variables show up in the [Discovery Document](https://developers.google.com/discovery/v1/reference/apis) as `{+var}`.

## Using gRPC API Service Configuration

gRPC API Service Configuration (service config) is a configuration language for configuring a gRPC service to become a user-facing product. The service config is simply the YAML representation of the `google.api.Service` proto message.

As an alternative to annotating your proto file, you can configure gRPC transcoding in your service config YAML files. You do this by specifying a `HttpRule` that maps the gRPC method to a REST endpoint, achieving the same effect as the proto annotation. This can be particularly useful if you have a proto that is reused in multiple services. Note that any transcoding specified in the service config will override any matching transcoding configuration in the proto.

Example:

http:
  rules:
    # Selects a gRPC method and applies HttpRule to it.
    - selector: example.v1.Messaging.GetMessage
      get: /v1/messages/{message_id}/{sub.subfield}

## Special notes

When gRPC Transcoding is used to map a gRPC to JSON REST endpoints, the proto to JSON conversion must follow the [proto3 specification](https://developers.google.com/protocol-buffers/docs/proto3#json).

While the single segment variable follows the semantics of [RFC 6570](https://tools.ietf.org/html/rfc6570) Section 3.2.2 Simple String Expansion, the multi segment variable **does not** follow RFC 6570 Section 3.2.3 Reserved Expansion. The reason is that the Reserved Expansion does not expand special characters like `?` and `#`, which would lead to invalid URLs. As the result, gRPC Transcoding uses a custom encoding for multi segment variables.

The path variables **must not** refer to any repeated or mapped field, because client libraries are not capable of handling such variable expansion.

The path variables **must not** capture the leading "/" character. The reason is that the most common use case "{var}" does not capture the leading "/" character. For consistency, all path variables must share the same behavior.

Repeated message fields must not be mapped to URL query parameters, because no client library can support such complicated mapping.

If an API needs to use a JSON array for request or response body, it can map the request or response body to a repeated field. However, some gRPC Transcoding implementations may not support this feature.

func (*HttpRule) Descriptor deprecated

func (*HttpRule) Descriptor() ([]byte, []int)

Deprecated: Use HttpRule.ProtoReflect.Descriptor instead.

func (*HttpRule) GetAdditionalBindings

func (x *HttpRule) GetAdditionalBindings() []*HttpRule

func (*HttpRule) GetBody

func (x *HttpRule) GetBody() string

func (*HttpRule) GetCustom

func (x *HttpRule) GetCustom() *CustomHttpPattern

func (*HttpRule) GetDelete

func (x *HttpRule) GetDelete() string

func (*HttpRule) GetGet

func (x *HttpRule) GetGet() string

func (*HttpRule) GetPatch

func (x *HttpRule) GetPatch() string

func (*HttpRule) GetPattern

func (m *HttpRule) GetPattern() isHttpRule_Pattern

func (*HttpRule) GetPost

func (x *HttpRule) GetPost() string

func (*HttpRule) GetPut

func (x *HttpRule) GetPut() string

func (*HttpRule) GetResponseBody

func (x *HttpRule) GetResponseBody() string

func (*HttpRule) GetSelector

func (x *HttpRule) GetSelector() string

func (*HttpRule) ProtoMessage

func (*HttpRule) ProtoMessage()

func (*HttpRule) ProtoReflect

func (x *HttpRule) ProtoReflect() protoreflect.Message

func (*HttpRule) Reset

func (x *HttpRule) Reset()

func (*HttpRule) String

func (x *HttpRule) String() string

type HttpRule_Custom

type HttpRule_Custom struct {
	// The custom pattern is used for specifying an HTTP method that is not
	// included in the `pattern` field, such as HEAD, or "*" to leave the
	// HTTP method unspecified for this rule. The wild-card rule is useful
	// for services that provide content to Web (HTML) clients.
	Custom *CustomHttpPattern `protobuf:"bytes,8,opt,name=custom,proto3,oneof"`
}

type HttpRule_Delete

type HttpRule_Delete struct {
	// Maps to HTTP DELETE. Used for deleting a resource.
	Delete string `protobuf:"bytes,5,opt,name=delete,proto3,oneof"`
}

type HttpRule_Get

type HttpRule_Get struct {
	// Maps to HTTP GET. Used for listing and getting information about
	// resources.
	Get string `protobuf:"bytes,2,opt,name=get,proto3,oneof"`
}

type HttpRule_Patch

type HttpRule_Patch struct {
	// Maps to HTTP PATCH. Used for updating a resource.
	Patch string `protobuf:"bytes,6,opt,name=patch,proto3,oneof"`
}

type HttpRule_Post

type HttpRule_Post struct {
	// Maps to HTTP POST. Used for creating a resource or performing an action.
	Post string `protobuf:"bytes,4,opt,name=post,proto3,oneof"`
}

type HttpRule_Put

type HttpRule_Put struct {
	// Maps to HTTP PUT. Used for replacing a resource.
	Put string `protobuf:"bytes,3,opt,name=put,proto3,oneof"`
}

type JavaSettings

type JavaSettings struct {

	// The package name to use in Java. Clobbers the java_package option
	// set in the protobuf. This should be used **only** by APIs
	// who have already set the language_settings.java.package_name" field
	// in gapic.yaml. API teams should use the protobuf java_package option
	// where possible.
	//
	// Example of a YAML configuration::
	//
	//	publishing:
	//	  java_settings:
	//	    library_package: com.google.cloud.pubsub.v1
	LibraryPackage string `protobuf:"bytes,1,opt,name=library_package,json=libraryPackage,proto3" json:"library_package,omitempty"`
	// Configure the Java class name to use instead of the service's for its
	// corresponding generated GAPIC client. Keys are fully-qualified
	// service names as they appear in the protobuf (including the full
	// the language_settings.java.interface_names" field in gapic.yaml. API
	// teams should otherwise use the service name as it appears in the
	// protobuf.
	//
	// Example of a YAML configuration::
	//
	//	publishing:
	//	  java_settings:
	//	    service_class_names:
	//	      - google.pubsub.v1.Publisher: TopicAdmin
	//	      - google.pubsub.v1.Subscriber: SubscriptionAdmin
	ServiceClassNames map[string]string `` /* 202-byte string literal not displayed */
	// Some settings.
	Common *CommonLanguageSettings `protobuf:"bytes,3,opt,name=common,proto3" json:"common,omitempty"`
	// contains filtered or unexported fields
}

Settings for Java client libraries.

func (*JavaSettings) Descriptor deprecated

func (*JavaSettings) Descriptor() ([]byte, []int)

Deprecated: Use JavaSettings.ProtoReflect.Descriptor instead.

func (*JavaSettings) GetCommon

func (x *JavaSettings) GetCommon() *CommonLanguageSettings

func (*JavaSettings) GetLibraryPackage

func (x *JavaSettings) GetLibraryPackage() string

func (*JavaSettings) GetServiceClassNames

func (x *JavaSettings) GetServiceClassNames() map[string]string

func (*JavaSettings) ProtoMessage

func (*JavaSettings) ProtoMessage()

func (*JavaSettings) ProtoReflect

func (x *JavaSettings) ProtoReflect() protoreflect.Message

func (*JavaSettings) Reset

func (x *JavaSettings) Reset()

func (*JavaSettings) String

func (x *JavaSettings) String() string

type MethodSettings

type MethodSettings struct {

	// The fully qualified name of the method, for which the options below apply.
	// This is used to find the method to apply the options.
	Selector string `protobuf:"bytes,1,opt,name=selector,proto3" json:"selector,omitempty"`
	// Describes settings to use for long-running operations when generating
	// API methods for RPCs. Complements RPCs that use the annotations in
	// google/longrunning/operations.proto.
	//
	// Example of a YAML configuration::
	//
	//	publishing:
	//	  method_behavior:
	//	    - selector: CreateAdDomain
	//	      long_running:
	//	        initial_poll_delay:
	//	          seconds: 60 # 1 minute
	//	        poll_delay_multiplier: 1.5
	//	        max_poll_delay:
	//	          seconds: 360 # 6 minutes
	//	        total_poll_timeout:
	//	           seconds: 54000 # 90 minutes
	LongRunning *MethodSettings_LongRunning `protobuf:"bytes,2,opt,name=long_running,json=longRunning,proto3" json:"long_running,omitempty"`
	// contains filtered or unexported fields
}

Describes the generator configuration for a method.

func (*MethodSettings) Descriptor deprecated

func (*MethodSettings) Descriptor() ([]byte, []int)

Deprecated: Use MethodSettings.ProtoReflect.Descriptor instead.

func (*MethodSettings) GetLongRunning

func (x *MethodSettings) GetLongRunning() *MethodSettings_LongRunning

func (*MethodSettings) GetSelector

func (x *MethodSettings) GetSelector() string

func (*MethodSettings) ProtoMessage

func (*MethodSettings) ProtoMessage()

func (*MethodSettings) ProtoReflect

func (x *MethodSettings) ProtoReflect() protoreflect.Message

func (*MethodSettings) Reset

func (x *MethodSettings) Reset()

func (*MethodSettings) String

func (x *MethodSettings) String() string

type MethodSettings_LongRunning

type MethodSettings_LongRunning struct {

	// Initial delay after which the first poll request will be made.
	// Default value: 5 seconds.
	InitialPollDelay *durationpb.Duration `protobuf:"bytes,1,opt,name=initial_poll_delay,json=initialPollDelay,proto3" json:"initial_poll_delay,omitempty"`
	// Multiplier to gradually increase delay between subsequent polls until it
	// reaches max_poll_delay.
	// Default value: 1.5.
	PollDelayMultiplier float32 `protobuf:"fixed32,2,opt,name=poll_delay_multiplier,json=pollDelayMultiplier,proto3" json:"poll_delay_multiplier,omitempty"`
	// Maximum time between two subsequent poll requests.
	// Default value: 45 seconds.
	MaxPollDelay *durationpb.Duration `protobuf:"bytes,3,opt,name=max_poll_delay,json=maxPollDelay,proto3" json:"max_poll_delay,omitempty"`
	// Total polling timeout.
	// Default value: 5 minutes.
	TotalPollTimeout *durationpb.Duration `protobuf:"bytes,4,opt,name=total_poll_timeout,json=totalPollTimeout,proto3" json:"total_poll_timeout,omitempty"`
	// contains filtered or unexported fields
}

Describes settings to use when generating API methods that use the long-running operation pattern. All default values below are from those used in the client library generators (e.g. [Java](https://github.com/googleapis/gapic-generator-java/blob/04c2faa191a9b5a10b92392fe8482279c4404803/src/main/java/com/google/api/generator/gapic/composer/common/RetrySettingsComposer.java)).

func (*MethodSettings_LongRunning) Descriptor deprecated

func (*MethodSettings_LongRunning) Descriptor() ([]byte, []int)

Deprecated: Use MethodSettings_LongRunning.ProtoReflect.Descriptor instead.

func (*MethodSettings_LongRunning) GetInitialPollDelay

func (x *MethodSettings_LongRunning) GetInitialPollDelay() *durationpb.Duration

func (*MethodSettings_LongRunning) GetMaxPollDelay

func (x *MethodSettings_LongRunning) GetMaxPollDelay() *durationpb.Duration

func (*MethodSettings_LongRunning) GetPollDelayMultiplier

func (x *MethodSettings_LongRunning) GetPollDelayMultiplier() float32

func (*MethodSettings_LongRunning) GetTotalPollTimeout

func (x *MethodSettings_LongRunning) GetTotalPollTimeout() *durationpb.Duration

func (*MethodSettings_LongRunning) ProtoMessage

func (*MethodSettings_LongRunning) ProtoMessage()

func (*MethodSettings_LongRunning) ProtoReflect

func (*MethodSettings_LongRunning) Reset

func (x *MethodSettings_LongRunning) Reset()

func (*MethodSettings_LongRunning) String

func (x *MethodSettings_LongRunning) String() string

type NodeSettings

type NodeSettings struct {

	// Some settings.
	Common *CommonLanguageSettings `protobuf:"bytes,1,opt,name=common,proto3" json:"common,omitempty"`
	// contains filtered or unexported fields
}

Settings for Node client libraries.

func (*NodeSettings) Descriptor deprecated

func (*NodeSettings) Descriptor() ([]byte, []int)

Deprecated: Use NodeSettings.ProtoReflect.Descriptor instead.

func (*NodeSettings) GetCommon

func (x *NodeSettings) GetCommon() *CommonLanguageSettings

func (*NodeSettings) ProtoMessage

func (*NodeSettings) ProtoMessage()

func (*NodeSettings) ProtoReflect

func (x *NodeSettings) ProtoReflect() protoreflect.Message

func (*NodeSettings) Reset

func (x *NodeSettings) Reset()

func (*NodeSettings) String

func (x *NodeSettings) String() string

type PhpSettings

type PhpSettings struct {

	// Some settings.
	Common *CommonLanguageSettings `protobuf:"bytes,1,opt,name=common,proto3" json:"common,omitempty"`
	// contains filtered or unexported fields
}

Settings for Php client libraries.

func (*PhpSettings) Descriptor deprecated

func (*PhpSettings) Descriptor() ([]byte, []int)

Deprecated: Use PhpSettings.ProtoReflect.Descriptor instead.

func (*PhpSettings) GetCommon

func (x *PhpSettings) GetCommon() *CommonLanguageSettings

func (*PhpSettings) ProtoMessage

func (*PhpSettings) ProtoMessage()

func (*PhpSettings) ProtoReflect

func (x *PhpSettings) ProtoReflect() protoreflect.Message

func (*PhpSettings) Reset

func (x *PhpSettings) Reset()

func (*PhpSettings) String

func (x *PhpSettings) String() string

type Publishing

type Publishing struct {

	// A list of API method settings, e.g. the behavior for methods that use the
	// long-running operation pattern.
	MethodSettings []*MethodSettings `protobuf:"bytes,2,rep,name=method_settings,json=methodSettings,proto3" json:"method_settings,omitempty"`
	// Link to a place that API users can report issues.  Example:
	// https://issuetracker.google.com/issues/new?component=190865&template=1161103
	NewIssueUri string `protobuf:"bytes,101,opt,name=new_issue_uri,json=newIssueUri,proto3" json:"new_issue_uri,omitempty"`
	// Link to product home page.  Example:
	// https://cloud.google.com/asset-inventory/docs/overview
	DocumentationUri string `protobuf:"bytes,102,opt,name=documentation_uri,json=documentationUri,proto3" json:"documentation_uri,omitempty"`
	// Used as a tracking tag when collecting data about the APIs developer
	// relations artifacts like docs, packages delivered to package managers,
	// etc.  Example: "speech".
	ApiShortName string `protobuf:"bytes,103,opt,name=api_short_name,json=apiShortName,proto3" json:"api_short_name,omitempty"`
	// GitHub label to apply to issues and pull requests opened for this API.
	GithubLabel string `protobuf:"bytes,104,opt,name=github_label,json=githubLabel,proto3" json:"github_label,omitempty"`
	// GitHub teams to be added to CODEOWNERS in the directory in GitHub
	// containing source code for the client libraries for this API.
	CodeownerGithubTeams []string `protobuf:"bytes,105,rep,name=codeowner_github_teams,json=codeownerGithubTeams,proto3" json:"codeowner_github_teams,omitempty"`
	// A prefix used in sample code when demarking regions to be included in
	// documentation.
	DocTagPrefix string `protobuf:"bytes,106,opt,name=doc_tag_prefix,json=docTagPrefix,proto3" json:"doc_tag_prefix,omitempty"`
	// For whom the client library is being published.
	Organization ClientLibraryOrganization `protobuf:"varint,107,opt,name=organization,proto3,enum=google.api.ClientLibraryOrganization" json:"organization,omitempty"`
	// Client library settings.  If the same version string appears multiple
	// times in this list, then the last one wins.  Settings from earlier
	// settings with the same version string are discarded.
	LibrarySettings []*ClientLibrarySettings `protobuf:"bytes,109,rep,name=library_settings,json=librarySettings,proto3" json:"library_settings,omitempty"`
	// contains filtered or unexported fields
}

This message configures the settings for publishing [Google Cloud Client libraries](https://cloud.google.com/apis/docs/cloud-client-libraries) generated from the service config.

func (*Publishing) Descriptor deprecated

func (*Publishing) Descriptor() ([]byte, []int)

Deprecated: Use Publishing.ProtoReflect.Descriptor instead.

func (*Publishing) GetApiShortName

func (x *Publishing) GetApiShortName() string

func (*Publishing) GetCodeownerGithubTeams

func (x *Publishing) GetCodeownerGithubTeams() []string

func (*Publishing) GetDocTagPrefix

func (x *Publishing) GetDocTagPrefix() string

func (*Publishing) GetDocumentationUri

func (x *Publishing) GetDocumentationUri() string

func (*Publishing) GetGithubLabel

func (x *Publishing) GetGithubLabel() string

func (*Publishing) GetLibrarySettings

func (x *Publishing) GetLibrarySettings() []*ClientLibrarySettings

func (*Publishing) GetMethodSettings

func (x *Publishing) GetMethodSettings() []*MethodSettings

func (*Publishing) GetNewIssueUri

func (x *Publishing) GetNewIssueUri() string

func (*Publishing) GetOrganization

func (x *Publishing) GetOrganization() ClientLibraryOrganization

func (*Publishing) ProtoMessage

func (*Publishing) ProtoMessage()

func (*Publishing) ProtoReflect

func (x *Publishing) ProtoReflect() protoreflect.Message

func (*Publishing) Reset

func (x *Publishing) Reset()

func (*Publishing) String

func (x *Publishing) String() string

type PythonSettings

type PythonSettings struct {

	// Some settings.
	Common *CommonLanguageSettings `protobuf:"bytes,1,opt,name=common,proto3" json:"common,omitempty"`
	// contains filtered or unexported fields
}

Settings for Python client libraries.

func (*PythonSettings) Descriptor deprecated

func (*PythonSettings) Descriptor() ([]byte, []int)

Deprecated: Use PythonSettings.ProtoReflect.Descriptor instead.

func (*PythonSettings) GetCommon

func (x *PythonSettings) GetCommon() *CommonLanguageSettings

func (*PythonSettings) ProtoMessage

func (*PythonSettings) ProtoMessage()

func (*PythonSettings) ProtoReflect

func (x *PythonSettings) ProtoReflect() protoreflect.Message

func (*PythonSettings) Reset

func (x *PythonSettings) Reset()

func (*PythonSettings) String

func (x *PythonSettings) String() string

type ResourceDescriptor

type ResourceDescriptor struct {

	// The resource type. It must be in the format of
	// {service_name}/{resource_type_kind}. The `resource_type_kind` must be
	// singular and must not include version numbers.
	//
	// Example: `storage.googleapis.com/Bucket`
	//
	// The value of the resource_type_kind must follow the regular expression
	// /[A-Za-z][a-zA-Z0-9]+/. It should start with an upper case character and
	// should use PascalCase (UpperCamelCase). The maximum number of
	// characters allowed for the `resource_type_kind` is 100.
	Type string `protobuf:"bytes,1,opt,name=type,proto3" json:"type,omitempty"`
	// Optional. The relative resource name pattern associated with this resource
	// type. The DNS prefix of the full resource name shouldn't be specified here.
	//
	// The path pattern must follow the syntax, which aligns with HTTP binding
	// syntax:
	//
	//     Template = Segment { "/" Segment } ;
	//     Segment = LITERAL | Variable ;
	//     Variable = "{" LITERAL "}" ;
	//
	// Examples:
	//
	//     - "projects/{project}/topics/{topic}"
	//     - "projects/{project}/knowledgeBases/{knowledge_base}"
	//
	// The components in braces correspond to the IDs for each resource in the
	// hierarchy. It is expected that, if multiple patterns are provided,
	// the same component name (e.g. "project") refers to IDs of the same
	// type of resource.
	Pattern []string `protobuf:"bytes,2,rep,name=pattern,proto3" json:"pattern,omitempty"`
	// Optional. The field on the resource that designates the resource name
	// field. If omitted, this is assumed to be "name".
	NameField string `protobuf:"bytes,3,opt,name=name_field,json=nameField,proto3" json:"name_field,omitempty"`
	// Optional. The historical or future-looking state of the resource pattern.
	//
	// Example:
	//
	//     // The InspectTemplate message originally only supported resource
	//     // names with organization, and project was added later.
	//     message InspectTemplate {
	//       option (google.api.resource) = {
	//         type: "dlp.googleapis.com/InspectTemplate"
	//         pattern:
	//         "organizations/{organization}/inspectTemplates/{inspect_template}"
	//         pattern: "projects/{project}/inspectTemplates/{inspect_template}"
	//         history: ORIGINALLY_SINGLE_PATTERN
	//       };
	//     }
	History ResourceDescriptor_History `protobuf:"varint,4,opt,name=history,proto3,enum=google.api.ResourceDescriptor_History" json:"history,omitempty"`
	// The plural name used in the resource name and permission names, such as
	// 'projects' for the resource name of 'projects/{project}' and the permission
	// name of 'cloudresourcemanager.googleapis.com/projects.get'. It is the same
	// concept of the `plural` field in k8s CRD spec
	// https://kubernetes.io/docs/tasks/access-kubernetes-api/custom-resources/custom-resource-definitions/
	//
	// Note: The plural form is required even for singleton resources. See
	// https://aip.dev/156
	Plural string `protobuf:"bytes,5,opt,name=plural,proto3" json:"plural,omitempty"`
	// The same concept of the `singular` field in k8s CRD spec
	// https://kubernetes.io/docs/tasks/access-kubernetes-api/custom-resources/custom-resource-definitions/
	// Such as "project" for the `resourcemanager.googleapis.com/Project` type.
	Singular string `protobuf:"bytes,6,opt,name=singular,proto3" json:"singular,omitempty"`
	// Style flag(s) for this resource.
	// These indicate that a resource is expected to conform to a given
	// style. See the specific style flags for additional information.
	Style []ResourceDescriptor_Style `protobuf:"varint,10,rep,packed,name=style,proto3,enum=google.api.ResourceDescriptor_Style" json:"style,omitempty"`
	// contains filtered or unexported fields
}

A simple descriptor of a resource type.

ResourceDescriptor annotates a resource message (either by means of a protobuf annotation or use in the service config), and associates the resource's schema, the resource type, and the pattern of the resource name.

Example:

message Topic {
  // Indicates this message defines a resource schema.
  // Declares the resource type in the format of {service}/{kind}.
  // For Kubernetes resources, the format is {api group}/{kind}.
  option (google.api.resource) = {
    type: "pubsub.googleapis.com/Topic"
    pattern: "projects/{project}/topics/{topic}"
  };
}

The ResourceDescriptor Yaml config will look like:

resources:
- type: "pubsub.googleapis.com/Topic"
  pattern: "projects/{project}/topics/{topic}"

Sometimes, resources have multiple patterns, typically because they can live under multiple parents.

Example:

message LogEntry {
  option (google.api.resource) = {
    type: "logging.googleapis.com/LogEntry"
    pattern: "projects/{project}/logs/{log}"
    pattern: "folders/{folder}/logs/{log}"
    pattern: "organizations/{organization}/logs/{log}"
    pattern: "billingAccounts/{billing_account}/logs/{log}"
  };
}

The ResourceDescriptor Yaml config will look like:

resources:
- type: 'logging.googleapis.com/LogEntry'
  pattern: "projects/{project}/logs/{log}"
  pattern: "folders/{folder}/logs/{log}"
  pattern: "organizations/{organization}/logs/{log}"
  pattern: "billingAccounts/{billing_account}/logs/{log}"

func (*ResourceDescriptor) Descriptor deprecated

func (*ResourceDescriptor) Descriptor() ([]byte, []int)

Deprecated: Use ResourceDescriptor.ProtoReflect.Descriptor instead.

func (*ResourceDescriptor) GetHistory

func (*ResourceDescriptor) GetNameField

func (x *ResourceDescriptor) GetNameField() string

func (*ResourceDescriptor) GetPattern

func (x *ResourceDescriptor) GetPattern() []string

func (*ResourceDescriptor) GetPlural

func (x *ResourceDescriptor) GetPlural() string

func (*ResourceDescriptor) GetSingular

func (x *ResourceDescriptor) GetSingular() string

func (*ResourceDescriptor) GetStyle

func (*ResourceDescriptor) GetType

func (x *ResourceDescriptor) GetType() string

func (*ResourceDescriptor) ProtoMessage

func (*ResourceDescriptor) ProtoMessage()

func (*ResourceDescriptor) ProtoReflect

func (x *ResourceDescriptor) ProtoReflect() protoreflect.Message

func (*ResourceDescriptor) Reset

func (x *ResourceDescriptor) Reset()

func (*ResourceDescriptor) String

func (x *ResourceDescriptor) String() string

type ResourceDescriptor_History

type ResourceDescriptor_History int32

A description of the historical or future-looking state of the resource pattern.

const (
	// The "unset" value.
	ResourceDescriptor_HISTORY_UNSPECIFIED ResourceDescriptor_History = 0
	// The resource originally had one pattern and launched as such, and
	// additional patterns were added later.
	ResourceDescriptor_ORIGINALLY_SINGLE_PATTERN ResourceDescriptor_History = 1
	// The resource has one pattern, but the API owner expects to add more
	// later. (This is the inverse of ORIGINALLY_SINGLE_PATTERN, and prevents
	// that from being necessary once there are multiple patterns.)
	ResourceDescriptor_FUTURE_MULTI_PATTERN ResourceDescriptor_History = 2
)

func (ResourceDescriptor_History) Descriptor

func (ResourceDescriptor_History) Enum

func (ResourceDescriptor_History) EnumDescriptor deprecated

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

Deprecated: Use ResourceDescriptor_History.Descriptor instead.

func (ResourceDescriptor_History) Number

func (ResourceDescriptor_History) String

func (ResourceDescriptor_History) Type

type ResourceDescriptor_Style

type ResourceDescriptor_Style int32

A flag representing a specific style that a resource claims to conform to.

const (
	// The unspecified value. Do not use.
	ResourceDescriptor_STYLE_UNSPECIFIED ResourceDescriptor_Style = 0
	// This resource is intended to be "declarative-friendly".
	//
	// Declarative-friendly resources must be more strictly consistent, and
	// setting this to true communicates to tools that this resource should
	// adhere to declarative-friendly expectations.
	//
	// Note: This is used by the API linter (linter.aip.dev) to enable
	// additional checks.
	ResourceDescriptor_DECLARATIVE_FRIENDLY ResourceDescriptor_Style = 1
)

func (ResourceDescriptor_Style) Descriptor

func (ResourceDescriptor_Style) Enum

func (ResourceDescriptor_Style) EnumDescriptor deprecated

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

Deprecated: Use ResourceDescriptor_Style.Descriptor instead.

func (ResourceDescriptor_Style) Number

func (ResourceDescriptor_Style) String

func (x ResourceDescriptor_Style) String() string

func (ResourceDescriptor_Style) Type

type ResourceReference

type ResourceReference struct {

	// The resource type that the annotated field references.
	//
	// Example:
	//
	//     message Subscription {
	//       string topic = 2 [(google.api.resource_reference) = {
	//         type: "pubsub.googleapis.com/Topic"
	//       }];
	//     }
	//
	// Occasionally, a field may reference an arbitrary resource. In this case,
	// APIs use the special value * in their resource reference.
	//
	// Example:
	//
	//     message GetIamPolicyRequest {
	//       string resource = 2 [(google.api.resource_reference) = {
	//         type: "*"
	//       }];
	//     }
	Type string `protobuf:"bytes,1,opt,name=type,proto3" json:"type,omitempty"`
	// The resource type of a child collection that the annotated field
	// references. This is useful for annotating the `parent` field that
	// doesn't have a fixed resource type.
	//
	// Example:
	//
	//     message ListLogEntriesRequest {
	//       string parent = 1 [(google.api.resource_reference) = {
	//         child_type: "logging.googleapis.com/LogEntry"
	//       };
	//     }
	ChildType string `protobuf:"bytes,2,opt,name=child_type,json=childType,proto3" json:"child_type,omitempty"`
	// contains filtered or unexported fields
}

Defines a proto annotation that describes a string field that refers to an API resource.

func (*ResourceReference) Descriptor deprecated

func (*ResourceReference) Descriptor() ([]byte, []int)

Deprecated: Use ResourceReference.ProtoReflect.Descriptor instead.

func (*ResourceReference) GetChildType

func (x *ResourceReference) GetChildType() string

func (*ResourceReference) GetType

func (x *ResourceReference) GetType() string

func (*ResourceReference) ProtoMessage

func (*ResourceReference) ProtoMessage()

func (*ResourceReference) ProtoReflect

func (x *ResourceReference) ProtoReflect() protoreflect.Message

func (*ResourceReference) Reset

func (x *ResourceReference) Reset()

func (*ResourceReference) String

func (x *ResourceReference) String() string

type RoutingParameter

type RoutingParameter struct {

	// A request field to extract the header key-value pair from.
	Field string `protobuf:"bytes,1,opt,name=field,proto3" json:"field,omitempty"`
	// A pattern matching the key-value field. Optional.
	// If not specified, the whole field specified in the `field` field will be
	// taken as value, and its name used as key. If specified, it MUST contain
	// exactly one named segment (along with any number of unnamed segments) The
	// pattern will be matched over the field specified in the `field` field, then
	// if the match is successful:
	// - the name of the single named segment will be used as a header name,
	// - the match value of the segment will be used as a header value;
	// if the match is NOT successful, nothing will be sent.
	//
	// Example:
	//
	//               -- This is a field in the request message
	//              |   that the header value will be extracted from.
	//              |
	//              |                     -- This is the key name in the
	//              |                    |   routing header.
	//              V                    |
	//     field: "table_name"           v
	//     path_template: "projects/*/{table_location=instances/*}/tables/*"
	//                                                ^            ^
	//                                                |            |
	//       In the {} brackets is the pattern that --             |
	//       specifies what to extract from the                    |
	//       field as a value to be sent.                          |
	//                                                             |
	//      The string in the field must match the whole pattern --
	//      before brackets, inside brackets, after brackets.
	//
	// When looking at this specific example, we can see that:
	// - A key-value pair with the key `table_location`
	//   and the value matching `instances/*` should be added
	//   to the x-goog-request-params routing header.
	// - The value is extracted from the request message's `table_name` field
	//   if it matches the full pattern specified:
	//   `projects/*/instances/*/tables/*`.
	//
	// **NB:** If the `path_template` field is not provided, the key name is
	// equal to the field name, and the whole field should be sent as a value.
	// This makes the pattern for the field and the value functionally equivalent
	// to `**`, and the configuration
	//
	//     {
	//       field: "table_name"
	//     }
	//
	// is a functionally equivalent shorthand to:
	//
	//     {
	//       field: "table_name"
	//       path_template: "{table_name=**}"
	//     }
	//
	// See Example 1 for more details.
	PathTemplate string `protobuf:"bytes,2,opt,name=path_template,json=pathTemplate,proto3" json:"path_template,omitempty"`
	// contains filtered or unexported fields
}

A projection from an input message to the GRPC or REST header.

func (*RoutingParameter) Descriptor deprecated

func (*RoutingParameter) Descriptor() ([]byte, []int)

Deprecated: Use RoutingParameter.ProtoReflect.Descriptor instead.

func (*RoutingParameter) GetField

func (x *RoutingParameter) GetField() string

func (*RoutingParameter) GetPathTemplate

func (x *RoutingParameter) GetPathTemplate() string

func (*RoutingParameter) ProtoMessage

func (*RoutingParameter) ProtoMessage()

func (*RoutingParameter) ProtoReflect

func (x *RoutingParameter) ProtoReflect() protoreflect.Message

func (*RoutingParameter) Reset

func (x *RoutingParameter) Reset()

func (*RoutingParameter) String

func (x *RoutingParameter) String() string

type RoutingRule

type RoutingRule struct {

	// A collection of Routing Parameter specifications.
	// **NOTE:** If multiple Routing Parameters describe the same key
	// (via the `path_template` field or via the `field` field when
	// `path_template` is not provided), "last one wins" rule
	// determines which Parameter gets used.
	// See the examples for more details.
	RoutingParameters []*RoutingParameter `protobuf:"bytes,2,rep,name=routing_parameters,json=routingParameters,proto3" json:"routing_parameters,omitempty"`
	// contains filtered or unexported fields
}

Specifies the routing information that should be sent along with the request in the form of routing header. **NOTE:** All service configuration rules follow the "last one wins" order.

The examples below will apply to an RPC which has the following request type:

Message Definition:

message Request {
  // The name of the Table
  // Values can be of the following formats:
  // - `projects/<project>/tables/<table>`
  // - `projects/<project>/instances/<instance>/tables/<table>`
  // - `region/<region>/zones/<zone>/tables/<table>`
  string table_name = 1;

  // This value specifies routing for replication.
  // It can be in the following formats:
  // - `profiles/<profile_id>`
  // - a legacy `profile_id` that can be any string
  string app_profile_id = 2;
}

Example message:

{
  table_name: projects/proj_foo/instances/instance_bar/table/table_baz,
  app_profile_id: profiles/prof_qux
}

The routing header consists of one or multiple key-value pairs. Every key and value must be percent-encoded, and joined together in the format of `key1=value1&key2=value2`. In the examples below I am skipping the percent-encoding for readablity.

Example 1

Extracting a field from the request to put into the routing header unchanged, with the key equal to the field name.

annotation:

option (google.api.routing) = {
  // Take the `app_profile_id`.
  routing_parameters {
    field: "app_profile_id"
  }
};

result:

x-goog-request-params: app_profile_id=profiles/prof_qux

Example 2

Extracting a field from the request to put into the routing header unchanged, with the key different from the field name.

annotation:

option (google.api.routing) = {
  // Take the `app_profile_id`, but name it `routing_id` in the header.
  routing_parameters {
    field: "app_profile_id"
    path_template: "{routing_id=**}"
  }
};

result:

x-goog-request-params: routing_id=profiles/prof_qux

Example 3

Extracting a field from the request to put into the routing header, while matching a path template syntax on the field's value.

NB: it is more useful to send nothing than to send garbage for the purpose of dynamic routing, since garbage pollutes cache. Thus the matching.

Sub-example 3a

The field matches the template.

annotation:

option (google.api.routing) = {
  // Take the `table_name`, if it's well-formed (with project-based
  // syntax).
  routing_parameters {
    field: "table_name"
    path_template: "{table_name=projects/*/instances/*/**}"
  }
};

result:

x-goog-request-params:
table_name=projects/proj_foo/instances/instance_bar/table/table_baz

Sub-example 3b

The field does not match the template.

annotation:

option (google.api.routing) = {
  // Take the `table_name`, if it's well-formed (with region-based
  // syntax).
  routing_parameters {
    field: "table_name"
    path_template: "{table_name=regions/*/zones/*/**}"
  }
};

result:

<no routing header will be sent>

Sub-example 3c

Multiple alternative conflictingly named path templates are specified. The one that matches is used to construct the header.

annotation:

option (google.api.routing) = {
  // Take the `table_name`, if it's well-formed, whether
  // using the region- or projects-based syntax.

  routing_parameters {
    field: "table_name"
    path_template: "{table_name=regions/*/zones/*/**}"
  }
  routing_parameters {
    field: "table_name"
    path_template: "{table_name=projects/*/instances/*/**}"
  }
};

result:

x-goog-request-params:
table_name=projects/proj_foo/instances/instance_bar/table/table_baz

Example 4

Extracting a single routing header key-value pair by matching a template syntax on (a part of) a single request field.

annotation:

option (google.api.routing) = {
  // Take just the project id from the `table_name` field.
  routing_parameters {
    field: "table_name"
    path_template: "{routing_id=projects/*}/**"
  }
};

result:

x-goog-request-params: routing_id=projects/proj_foo

Example 5

Extracting a single routing header key-value pair by matching several conflictingly named path templates on (parts of) a single request field. The last template to match "wins" the conflict.

annotation:

option (google.api.routing) = {
  // If the `table_name` does not have instances information,
  // take just the project id for routing.
  // Otherwise take project + instance.

  routing_parameters {
    field: "table_name"
    path_template: "{routing_id=projects/*}/**"
  }
  routing_parameters {
    field: "table_name"
    path_template: "{routing_id=projects/*/instances/*}/**"
  }
};

result:

x-goog-request-params:
routing_id=projects/proj_foo/instances/instance_bar

Example 6

Extracting multiple routing header key-value pairs by matching several non-conflicting path templates on (parts of) a single request field.

Sub-example 6a

Make the templates strict, so that if the `table_name` does not have an instance information, nothing is sent.

annotation:

option (google.api.routing) = {
  // The routing code needs two keys instead of one composite
  // but works only for the tables with the "project-instance" name
  // syntax.

  routing_parameters {
    field: "table_name"
    path_template: "{project_id=projects/*}/instances/*/**"
  }
  routing_parameters {
    field: "table_name"
    path_template: "projects/*/{instance_id=instances/*}/**"
  }
};

result:

x-goog-request-params:
project_id=projects/proj_foo&instance_id=instances/instance_bar

Sub-example 6b

Make the templates loose, so that if the `table_name` does not have an instance information, just the project id part is sent.

annotation:

option (google.api.routing) = {
  // The routing code wants two keys instead of one composite
  // but will work with just the `project_id` for tables without
  // an instance in the `table_name`.

  routing_parameters {
    field: "table_name"
    path_template: "{project_id=projects/*}/**"
  }
  routing_parameters {
    field: "table_name"
    path_template: "projects/*/{instance_id=instances/*}/**"
  }
};

result (is the same as 6a for our example message because it has the instance information):

x-goog-request-params:
project_id=projects/proj_foo&instance_id=instances/instance_bar

Example 7

Extracting multiple routing header key-value pairs by matching several path templates on multiple request fields.

NB: note that here there is no way to specify sending nothing if one of the fields does not match its template. E.g. if the `table_name` is in the wrong format, the `project_id` will not be sent, but the `routing_id` will be. The backend routing code has to be aware of that and be prepared to not receive a full complement of keys if it expects multiple.

annotation:

option (google.api.routing) = {
  // The routing needs both `project_id` and `routing_id`
  // (from the `app_profile_id` field) for routing.

  routing_parameters {
    field: "table_name"
    path_template: "{project_id=projects/*}/**"
  }
  routing_parameters {
    field: "app_profile_id"
    path_template: "{routing_id=**}"
  }
};

result:

x-goog-request-params:
project_id=projects/proj_foo&routing_id=profiles/prof_qux

Example 8

Extracting a single routing header key-value pair by matching several conflictingly named path templates on several request fields. The last template to match "wins" the conflict.

annotation:

option (google.api.routing) = {
  // The `routing_id` can be a project id or a region id depending on
  // the table name format, but only if the `app_profile_id` is not set.
  // If `app_profile_id` is set it should be used instead.

  routing_parameters {
    field: "table_name"
    path_template: "{routing_id=projects/*}/**"
  }
  routing_parameters {
     field: "table_name"
     path_template: "{routing_id=regions/*}/**"
  }
  routing_parameters {
    field: "app_profile_id"
    path_template: "{routing_id=**}"
  }
};

result:

x-goog-request-params: routing_id=profiles/prof_qux

Example 9

Bringing it all together.

annotation:

option (google.api.routing) = {
  // For routing both `table_location` and a `routing_id` are needed.
  //
  // table_location can be either an instance id or a region+zone id.
  //
  // For `routing_id`, take the value of `app_profile_id`
  // - If it's in the format `profiles/<profile_id>`, send
  // just the `<profile_id>` part.
  // - If it's any other literal, send it as is.
  // If the `app_profile_id` is empty, and the `table_name` starts with
  // the project_id, send that instead.

  routing_parameters {
    field: "table_name"
    path_template: "projects/*/{table_location=instances/*}/tables/*"
  }
  routing_parameters {
    field: "table_name"
    path_template: "{table_location=regions/*/zones/*}/tables/*"
  }
  routing_parameters {
    field: "table_name"
    path_template: "{routing_id=projects/*}/**"
  }
  routing_parameters {
    field: "app_profile_id"
    path_template: "{routing_id=**}"
  }
  routing_parameters {
    field: "app_profile_id"
    path_template: "profiles/{routing_id=*}"
  }
};

result:

x-goog-request-params:
table_location=instances/instance_bar&routing_id=prof_qux

func (*RoutingRule) Descriptor deprecated

func (*RoutingRule) Descriptor() ([]byte, []int)

Deprecated: Use RoutingRule.ProtoReflect.Descriptor instead.

func (*RoutingRule) GetRoutingParameters

func (x *RoutingRule) GetRoutingParameters() []*RoutingParameter

func (*RoutingRule) ProtoMessage

func (*RoutingRule) ProtoMessage()

func (*RoutingRule) ProtoReflect

func (x *RoutingRule) ProtoReflect() protoreflect.Message

func (*RoutingRule) Reset

func (x *RoutingRule) Reset()

func (*RoutingRule) String

func (x *RoutingRule) String() string

type RubySettings

type RubySettings struct {

	// Some settings.
	Common *CommonLanguageSettings `protobuf:"bytes,1,opt,name=common,proto3" json:"common,omitempty"`
	// contains filtered or unexported fields
}

Settings for Ruby client libraries.

func (*RubySettings) Descriptor deprecated

func (*RubySettings) Descriptor() ([]byte, []int)

Deprecated: Use RubySettings.ProtoReflect.Descriptor instead.

func (*RubySettings) GetCommon

func (x *RubySettings) GetCommon() *CommonLanguageSettings

func (*RubySettings) ProtoMessage

func (*RubySettings) ProtoMessage()

func (*RubySettings) ProtoReflect

func (x *RubySettings) ProtoReflect() protoreflect.Message

func (*RubySettings) Reset

func (x *RubySettings) Reset()

func (*RubySettings) String

func (x *RubySettings) String() string

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL