api

package
v0.0.3 Latest Latest
Warning

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

Go to latest
Published: Oct 22, 2024 License: Apache-2.0 Imports: 25 Imported by: 0

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",
		5: "SHOPPING",
		6: "GEO",
		7: "GENERATIVE_AI",
	}
	ClientLibraryOrganization_value = map[string]int32{
		"CLIENT_LIBRARY_ORGANIZATION_UNSPECIFIED": 0,
		"CLOUD":         1,
		"ADS":           2,
		"PHOTOS":        3,
		"STREET_VIEW":   4,
		"SHOPPING":      5,
		"GEO":           6,
		"GENERATIVE_AI": 7,
	}
)

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",
		8: "IDENTIFIER",
	}
	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,
		"IDENTIFIER":                 8,
	}
)

Enum value maps for FieldBehavior.

View Source
var (
	LaunchStage_name = map[int32]string{
		0: "LAUNCH_STAGE_UNSPECIFIED",
		6: "UNIMPLEMENTED",
		7: "PRELAUNCH",
		1: "EARLY_ACCESS",
		2: "ALPHA",
		3: "BETA",
		4: "GA",
		5: "DEPRECATED",
	}
	LaunchStage_value = map[string]int32{
		"LAUNCH_STAGE_UNSPECIFIED": 0,
		"UNIMPLEMENTED":            6,
		"PRELAUNCH":                7,
		"EARLY_ACCESS":             1,
		"ALPHA":                    2,
		"BETA":                     3,
		"GA":                       4,
		"DEPRECATED":               5,
	}
)

Enum value maps for LaunchStage.

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 (
	// See `VisibilityRule`.
	//
	// optional google.api.VisibilityRule api_visibility = 72295727;
	E_ApiVisibility = &file_google_api_visibility_proto_extTypes[5]
)

Extension fields to descriptorpb.ServiceOptions.

View Source
var (
	// See `VisibilityRule`.
	//
	// optional google.api.VisibilityRule enum_visibility = 72295727;
	E_EnumVisibility = &file_google_api_visibility_proto_extTypes[0]
)

Extension fields to descriptorpb.EnumOptions.

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 `VisibilityRule`.
	//
	// optional google.api.VisibilityRule field_visibility = 72295727;
	E_FieldVisibility = &file_google_api_visibility_proto_extTypes[2]
)

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 (
	// See `VisibilityRule`.
	//
	// optional google.api.VisibilityRule message_visibility = 72295727;
	E_MessageVisibility = &file_google_api_visibility_proto_extTypes[3]
)

Extension fields to descriptorpb.MessageOptions.

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 (
	// See `VisibilityRule`.
	//
	// optional google.api.VisibilityRule method_visibility = 72295727;
	E_MethodVisibility = &file_google_api_visibility_proto_extTypes[4]
)

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 `VisibilityRule`.
	//
	// optional google.api.VisibilityRule value_visibility = 72295727;
	E_ValueVisibility = &file_google_api_visibility_proto_extTypes[1]
)

Extension fields to descriptorpb.EnumValueOptions.

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_httpbody_proto protoreflect.FileDescriptor
View Source
var File_google_api_launch_stage_proto protoreflect.FileDescriptor
View Source
var File_google_api_resource_proto protoreflect.FileDescriptor
View Source
var File_google_api_visibility_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
	// Shopping Org.
	ClientLibraryOrganization_SHOPPING ClientLibraryOrganization = 5
	// Geo Org.
	ClientLibraryOrganization_GEO ClientLibraryOrganization = 6
	// Generative AI - https://developers.generativeai.google
	ClientLibraryOrganization_GENERATIVE_AI ClientLibraryOrganization = 7
)

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. This is the full protobuf
	// package for the API, ending in the version element.
	// Examples: "google.cloud.speech.v1" and "google.spanner.admin.database.v1".
	Version string `protobuf:"bytes,1,opt,name=version,proto3" json:"version,omitempty"`
	// Launch stage of this version of the API.
	LaunchStage 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) CloneMessageVT

func (m *ClientLibrarySettings) CloneMessageVT() proto.Message

func (*ClientLibrarySettings) CloneVT

func (*ClientLibrarySettings) Descriptor deprecated

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

Deprecated: Use ClientLibrarySettings.ProtoReflect.Descriptor instead.

func (*ClientLibrarySettings) EqualMessageVT

func (this *ClientLibrarySettings) EqualMessageVT(thatMsg proto.Message) bool

func (*ClientLibrarySettings) EqualVT

func (this *ClientLibrarySettings) EqualVT(that *ClientLibrarySettings) bool

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() 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) MarshalToSizedBufferVT

func (m *ClientLibrarySettings) MarshalToSizedBufferVT(dAtA []byte) (int, error)

func (*ClientLibrarySettings) MarshalToVT

func (m *ClientLibrarySettings) MarshalToVT(dAtA []byte) (int, error)

func (*ClientLibrarySettings) MarshalVT

func (m *ClientLibrarySettings) MarshalVT() (dAtA []byte, err error)

func (*ClientLibrarySettings) ProtoMessage

func (*ClientLibrarySettings) ProtoMessage()

func (*ClientLibrarySettings) ProtoReflect

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

func (*ClientLibrarySettings) Reset

func (x *ClientLibrarySettings) Reset()

func (*ClientLibrarySettings) SizeVT

func (m *ClientLibrarySettings) SizeVT() (n int)

func (*ClientLibrarySettings) String

func (x *ClientLibrarySettings) String() string

func (*ClientLibrarySettings) UnmarshalVT

func (m *ClientLibrarySettings) UnmarshalVT(dAtA []byte) error

func (*ClientLibrarySettings) Validate

func (m *ClientLibrarySettings) Validate() error

Validate checks the field values on ClientLibrarySettings with the rules defined in the proto definition for this message. If any rules are violated, the first error encountered is returned, or nil if there are no violations.

func (*ClientLibrarySettings) ValidateAll

func (m *ClientLibrarySettings) ValidateAll() error

ValidateAll checks the field values on ClientLibrarySettings with the rules defined in the proto definition for this message. If any rules are violated, the result is a list of violation errors wrapped in ClientLibrarySettingsMultiError, or nil if none found.

type ClientLibrarySettingsMultiError

type ClientLibrarySettingsMultiError []error

ClientLibrarySettingsMultiError is an error wrapping multiple validation errors returned by ClientLibrarySettings.ValidateAll() if the designated constraints aren't met.

func (ClientLibrarySettingsMultiError) AllErrors

func (m ClientLibrarySettingsMultiError) AllErrors() []error

AllErrors returns a list of validation violation errors.

func (ClientLibrarySettingsMultiError) Error

Error returns a concatenation of all the error messages it wraps.

type ClientLibrarySettingsValidationError

type ClientLibrarySettingsValidationError struct {
	// contains filtered or unexported fields
}

ClientLibrarySettingsValidationError is the validation error returned by ClientLibrarySettings.Validate if the designated constraints aren't met.

func (ClientLibrarySettingsValidationError) Cause

Cause function returns cause value.

func (ClientLibrarySettingsValidationError) Error

Error satisfies the builtin error interface

func (ClientLibrarySettingsValidationError) ErrorName

ErrorName returns error name.

func (ClientLibrarySettingsValidationError) Field

Field function returns field value.

func (ClientLibrarySettingsValidationError) Key

Key function returns key value.

func (ClientLibrarySettingsValidationError) Reason

Reason function returns reason value.

type CommonLanguageSettings

type CommonLanguageSettings struct {

	// Link to automatically generated reference documentation.  Example:
	// https://cloud.google.com/nodejs/docs/reference/asset/latest
	//
	// Deprecated: Marked as deprecated in google/api/client.proto.
	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) CloneMessageVT

func (m *CommonLanguageSettings) CloneMessageVT() proto.Message

func (*CommonLanguageSettings) CloneVT

func (*CommonLanguageSettings) Descriptor deprecated

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

Deprecated: Use CommonLanguageSettings.ProtoReflect.Descriptor instead.

func (*CommonLanguageSettings) EqualMessageVT

func (this *CommonLanguageSettings) EqualMessageVT(thatMsg proto.Message) bool

func (*CommonLanguageSettings) EqualVT

func (this *CommonLanguageSettings) EqualVT(that *CommonLanguageSettings) bool

func (*CommonLanguageSettings) GetDestinations

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

func (*CommonLanguageSettings) GetReferenceDocsUri deprecated

func (x *CommonLanguageSettings) GetReferenceDocsUri() string

Deprecated: Marked as deprecated in google/api/client.proto.

func (*CommonLanguageSettings) MarshalToSizedBufferVT

func (m *CommonLanguageSettings) MarshalToSizedBufferVT(dAtA []byte) (int, error)

func (*CommonLanguageSettings) MarshalToVT

func (m *CommonLanguageSettings) MarshalToVT(dAtA []byte) (int, error)

func (*CommonLanguageSettings) MarshalVT

func (m *CommonLanguageSettings) MarshalVT() (dAtA []byte, err error)

func (*CommonLanguageSettings) ProtoMessage

func (*CommonLanguageSettings) ProtoMessage()

func (*CommonLanguageSettings) ProtoReflect

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

func (*CommonLanguageSettings) Reset

func (x *CommonLanguageSettings) Reset()

func (*CommonLanguageSettings) SizeVT

func (m *CommonLanguageSettings) SizeVT() (n int)

func (*CommonLanguageSettings) String

func (x *CommonLanguageSettings) String() string

func (*CommonLanguageSettings) UnmarshalVT

func (m *CommonLanguageSettings) UnmarshalVT(dAtA []byte) error

func (*CommonLanguageSettings) Validate

func (m *CommonLanguageSettings) Validate() error

Validate checks the field values on CommonLanguageSettings with the rules defined in the proto definition for this message. If any rules are violated, the first error encountered is returned, or nil if there are no violations.

func (*CommonLanguageSettings) ValidateAll

func (m *CommonLanguageSettings) ValidateAll() error

ValidateAll checks the field values on CommonLanguageSettings with the rules defined in the proto definition for this message. If any rules are violated, the result is a list of violation errors wrapped in CommonLanguageSettingsMultiError, or nil if none found.

type CommonLanguageSettingsMultiError

type CommonLanguageSettingsMultiError []error

CommonLanguageSettingsMultiError is an error wrapping multiple validation errors returned by CommonLanguageSettings.ValidateAll() if the designated constraints aren't met.

func (CommonLanguageSettingsMultiError) AllErrors

func (m CommonLanguageSettingsMultiError) AllErrors() []error

AllErrors returns a list of validation violation errors.

func (CommonLanguageSettingsMultiError) Error

Error returns a concatenation of all the error messages it wraps.

type CommonLanguageSettingsValidationError

type CommonLanguageSettingsValidationError struct {
	// contains filtered or unexported fields
}

CommonLanguageSettingsValidationError is the validation error returned by CommonLanguageSettings.Validate if the designated constraints aren't met.

func (CommonLanguageSettingsValidationError) Cause

Cause function returns cause value.

func (CommonLanguageSettingsValidationError) Error

Error satisfies the builtin error interface

func (CommonLanguageSettingsValidationError) ErrorName

ErrorName returns error name.

func (CommonLanguageSettingsValidationError) Field

Field function returns field value.

func (CommonLanguageSettingsValidationError) Key

Key function returns key value.

func (CommonLanguageSettingsValidationError) Reason

Reason function returns reason value.

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) CloneMessageVT

func (m *CppSettings) CloneMessageVT() proto.Message

func (*CppSettings) CloneVT

func (m *CppSettings) CloneVT() *CppSettings

func (*CppSettings) Descriptor deprecated

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

Deprecated: Use CppSettings.ProtoReflect.Descriptor instead.

func (*CppSettings) EqualMessageVT

func (this *CppSettings) EqualMessageVT(thatMsg proto.Message) bool

func (*CppSettings) EqualVT

func (this *CppSettings) EqualVT(that *CppSettings) bool

func (*CppSettings) GetCommon

func (x *CppSettings) GetCommon() *CommonLanguageSettings

func (*CppSettings) MarshalToSizedBufferVT

func (m *CppSettings) MarshalToSizedBufferVT(dAtA []byte) (int, error)

func (*CppSettings) MarshalToVT

func (m *CppSettings) MarshalToVT(dAtA []byte) (int, error)

func (*CppSettings) MarshalVT

func (m *CppSettings) MarshalVT() (dAtA []byte, err error)

func (*CppSettings) ProtoMessage

func (*CppSettings) ProtoMessage()

func (*CppSettings) ProtoReflect

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

func (*CppSettings) Reset

func (x *CppSettings) Reset()

func (*CppSettings) SizeVT

func (m *CppSettings) SizeVT() (n int)

func (*CppSettings) String

func (x *CppSettings) String() string

func (*CppSettings) UnmarshalVT

func (m *CppSettings) UnmarshalVT(dAtA []byte) error

func (*CppSettings) Validate

func (m *CppSettings) Validate() error

Validate checks the field values on CppSettings with the rules defined in the proto definition for this message. If any rules are violated, the first error encountered is returned, or nil if there are no violations.

func (*CppSettings) ValidateAll

func (m *CppSettings) ValidateAll() error

ValidateAll checks the field values on CppSettings with the rules defined in the proto definition for this message. If any rules are violated, the result is a list of violation errors wrapped in CppSettingsMultiError, or nil if none found.

type CppSettingsMultiError

type CppSettingsMultiError []error

CppSettingsMultiError is an error wrapping multiple validation errors returned by CppSettings.ValidateAll() if the designated constraints aren't met.

func (CppSettingsMultiError) AllErrors

func (m CppSettingsMultiError) AllErrors() []error

AllErrors returns a list of validation violation errors.

func (CppSettingsMultiError) Error

func (m CppSettingsMultiError) Error() string

Error returns a concatenation of all the error messages it wraps.

type CppSettingsValidationError

type CppSettingsValidationError struct {
	// contains filtered or unexported fields
}

CppSettingsValidationError is the validation error returned by CppSettings.Validate if the designated constraints aren't met.

func (CppSettingsValidationError) Cause

Cause function returns cause value.

func (CppSettingsValidationError) Error

Error satisfies the builtin error interface

func (CppSettingsValidationError) ErrorName

func (e CppSettingsValidationError) ErrorName() string

ErrorName returns error name.

func (CppSettingsValidationError) Field

Field function returns field value.

func (CppSettingsValidationError) Key

Key function returns key value.

func (CppSettingsValidationError) Reason

Reason function returns reason value.

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) CloneMessageVT

func (m *CustomHttpPattern) CloneMessageVT() proto.Message

func (*CustomHttpPattern) CloneVT

func (m *CustomHttpPattern) CloneVT() *CustomHttpPattern

func (*CustomHttpPattern) Descriptor deprecated

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

Deprecated: Use CustomHttpPattern.ProtoReflect.Descriptor instead.

func (*CustomHttpPattern) EqualMessageVT

func (this *CustomHttpPattern) EqualMessageVT(thatMsg proto.Message) bool

func (*CustomHttpPattern) EqualVT

func (this *CustomHttpPattern) EqualVT(that *CustomHttpPattern) bool

func (*CustomHttpPattern) GetKind

func (x *CustomHttpPattern) GetKind() string

func (*CustomHttpPattern) GetPath

func (x *CustomHttpPattern) GetPath() string

func (*CustomHttpPattern) MarshalToSizedBufferVT

func (m *CustomHttpPattern) MarshalToSizedBufferVT(dAtA []byte) (int, error)

func (*CustomHttpPattern) MarshalToVT

func (m *CustomHttpPattern) MarshalToVT(dAtA []byte) (int, error)

func (*CustomHttpPattern) MarshalVT

func (m *CustomHttpPattern) MarshalVT() (dAtA []byte, err error)

func (*CustomHttpPattern) ProtoMessage

func (*CustomHttpPattern) ProtoMessage()

func (*CustomHttpPattern) ProtoReflect

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

func (*CustomHttpPattern) Reset

func (x *CustomHttpPattern) Reset()

func (*CustomHttpPattern) SizeVT

func (m *CustomHttpPattern) SizeVT() (n int)

func (*CustomHttpPattern) String

func (x *CustomHttpPattern) String() string

func (*CustomHttpPattern) UnmarshalVT

func (m *CustomHttpPattern) UnmarshalVT(dAtA []byte) error

func (*CustomHttpPattern) Validate

func (m *CustomHttpPattern) Validate() error

Validate checks the field values on CustomHttpPattern with the rules defined in the proto definition for this message. If any rules are violated, the first error encountered is returned, or nil if there are no violations.

func (*CustomHttpPattern) ValidateAll

func (m *CustomHttpPattern) ValidateAll() error

ValidateAll checks the field values on CustomHttpPattern with the rules defined in the proto definition for this message. If any rules are violated, the result is a list of violation errors wrapped in CustomHttpPatternMultiError, or nil if none found.

type CustomHttpPatternMultiError

type CustomHttpPatternMultiError []error

CustomHttpPatternMultiError is an error wrapping multiple validation errors returned by CustomHttpPattern.ValidateAll() if the designated constraints aren't met.

func (CustomHttpPatternMultiError) AllErrors

func (m CustomHttpPatternMultiError) AllErrors() []error

AllErrors returns a list of validation violation errors.

func (CustomHttpPatternMultiError) Error

Error returns a concatenation of all the error messages it wraps.

type CustomHttpPatternValidationError

type CustomHttpPatternValidationError struct {
	// contains filtered or unexported fields
}

CustomHttpPatternValidationError is the validation error returned by CustomHttpPattern.Validate if the designated constraints aren't met.

func (CustomHttpPatternValidationError) Cause

Cause function returns cause value.

func (CustomHttpPatternValidationError) Error

Error satisfies the builtin error interface

func (CustomHttpPatternValidationError) ErrorName

ErrorName returns error name.

func (CustomHttpPatternValidationError) Field

Field function returns field value.

func (CustomHttpPatternValidationError) Key

Key function returns key value.

func (CustomHttpPatternValidationError) Reason

Reason function returns reason value.

type DotnetSettings

type DotnetSettings struct {

	// Some settings.
	Common *CommonLanguageSettings `protobuf:"bytes,1,opt,name=common,proto3" json:"common,omitempty"`
	// Map from original service names to renamed versions.
	// This is used when the default generated types
	// would cause a naming conflict. (Neither name is
	// fully-qualified.)
	// Example: Subscriber to SubscriberServiceApi.
	RenamedServices map[string]string `` /* 194-byte string literal not displayed */
	// Map from full resource types to the effective short name
	// for the resource. This is used when otherwise resource
	// named from different services would cause naming collisions.
	// Example entry:
	// "datalabeling.googleapis.com/Dataset": "DataLabelingDataset"
	RenamedResources map[string]string `` /* 197-byte string literal not displayed */
	// List of full resource types to ignore during generation.
	// This is typically used for API-specific Location resources,
	// which should be handled by the generator as if they were actually
	// the common Location resources.
	// Example entry: "documentai.googleapis.com/Location"
	IgnoredResources []string `protobuf:"bytes,4,rep,name=ignored_resources,json=ignoredResources,proto3" json:"ignored_resources,omitempty"`
	// Namespaces which must be aliased in snippets due to
	// a known (but non-generator-predictable) naming collision
	ForcedNamespaceAliases []string `` /* 129-byte string literal not displayed */
	// Method signatures (in the form "service.method(signature)")
	// which are provided separately, so shouldn't be generated.
	// Snippets *calling* these methods are still generated, however.
	HandwrittenSignatures []string `protobuf:"bytes,6,rep,name=handwritten_signatures,json=handwrittenSignatures,proto3" json:"handwritten_signatures,omitempty"`
	// contains filtered or unexported fields
}

Settings for Dotnet client libraries.

func (*DotnetSettings) CloneMessageVT

func (m *DotnetSettings) CloneMessageVT() proto.Message

func (*DotnetSettings) CloneVT

func (m *DotnetSettings) CloneVT() *DotnetSettings

func (*DotnetSettings) Descriptor deprecated

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

Deprecated: Use DotnetSettings.ProtoReflect.Descriptor instead.

func (*DotnetSettings) EqualMessageVT

func (this *DotnetSettings) EqualMessageVT(thatMsg proto.Message) bool

func (*DotnetSettings) EqualVT

func (this *DotnetSettings) EqualVT(that *DotnetSettings) bool

func (*DotnetSettings) GetCommon

func (x *DotnetSettings) GetCommon() *CommonLanguageSettings

func (*DotnetSettings) GetForcedNamespaceAliases

func (x *DotnetSettings) GetForcedNamespaceAliases() []string

func (*DotnetSettings) GetHandwrittenSignatures

func (x *DotnetSettings) GetHandwrittenSignatures() []string

func (*DotnetSettings) GetIgnoredResources

func (x *DotnetSettings) GetIgnoredResources() []string

func (*DotnetSettings) GetRenamedResources

func (x *DotnetSettings) GetRenamedResources() map[string]string

func (*DotnetSettings) GetRenamedServices

func (x *DotnetSettings) GetRenamedServices() map[string]string

func (*DotnetSettings) MarshalToSizedBufferVT

func (m *DotnetSettings) MarshalToSizedBufferVT(dAtA []byte) (int, error)

func (*DotnetSettings) MarshalToVT

func (m *DotnetSettings) MarshalToVT(dAtA []byte) (int, error)

func (*DotnetSettings) MarshalVT

func (m *DotnetSettings) MarshalVT() (dAtA []byte, err error)

func (*DotnetSettings) ProtoMessage

func (*DotnetSettings) ProtoMessage()

func (*DotnetSettings) ProtoReflect

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

func (*DotnetSettings) Reset

func (x *DotnetSettings) Reset()

func (*DotnetSettings) SizeVT

func (m *DotnetSettings) SizeVT() (n int)

func (*DotnetSettings) String

func (x *DotnetSettings) String() string

func (*DotnetSettings) UnmarshalVT

func (m *DotnetSettings) UnmarshalVT(dAtA []byte) error

func (*DotnetSettings) Validate

func (m *DotnetSettings) Validate() error

Validate checks the field values on DotnetSettings with the rules defined in the proto definition for this message. If any rules are violated, the first error encountered is returned, or nil if there are no violations.

func (*DotnetSettings) ValidateAll

func (m *DotnetSettings) ValidateAll() error

ValidateAll checks the field values on DotnetSettings with the rules defined in the proto definition for this message. If any rules are violated, the result is a list of violation errors wrapped in DotnetSettingsMultiError, or nil if none found.

type DotnetSettingsMultiError

type DotnetSettingsMultiError []error

DotnetSettingsMultiError is an error wrapping multiple validation errors returned by DotnetSettings.ValidateAll() if the designated constraints aren't met.

func (DotnetSettingsMultiError) AllErrors

func (m DotnetSettingsMultiError) AllErrors() []error

AllErrors returns a list of validation violation errors.

func (DotnetSettingsMultiError) Error

func (m DotnetSettingsMultiError) Error() string

Error returns a concatenation of all the error messages it wraps.

type DotnetSettingsValidationError

type DotnetSettingsValidationError struct {
	// contains filtered or unexported fields
}

DotnetSettingsValidationError is the validation error returned by DotnetSettings.Validate if the designated constraints aren't met.

func (DotnetSettingsValidationError) Cause

Cause function returns cause value.

func (DotnetSettingsValidationError) Error

Error satisfies the builtin error interface

func (DotnetSettingsValidationError) ErrorName

func (e DotnetSettingsValidationError) ErrorName() string

ErrorName returns error name.

func (DotnetSettingsValidationError) Field

Field function returns field value.

func (DotnetSettingsValidationError) Key

Key function returns key value.

func (DotnetSettingsValidationError) Reason

Reason function returns reason value.

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
	// Denotes that the field in a resource (a message annotated with
	// google.api.resource) is used in the resource name to uniquely identify the
	// resource. For AIP-compliant APIs, this should only be applied to the
	// `name` field on the resource.
	//
	// This behavior should not be applied to references to other resources within
	// the message.
	//
	// The identifier field of resources often have different field behavior
	// depending on the request it is embedded in (e.g. for Create methods name
	// is optional and unused, while for Update methods it is required). Instead
	// of method-specific annotations, only `IDENTIFIER` is required.
	FieldBehavior_IDENTIFIER FieldBehavior = 8
)

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) CloneMessageVT

func (m *GoSettings) CloneMessageVT() proto.Message

func (*GoSettings) CloneVT

func (m *GoSettings) CloneVT() *GoSettings

func (*GoSettings) Descriptor deprecated

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

Deprecated: Use GoSettings.ProtoReflect.Descriptor instead.

func (*GoSettings) EqualMessageVT

func (this *GoSettings) EqualMessageVT(thatMsg proto.Message) bool

func (*GoSettings) EqualVT

func (this *GoSettings) EqualVT(that *GoSettings) bool

func (*GoSettings) GetCommon

func (x *GoSettings) GetCommon() *CommonLanguageSettings

func (*GoSettings) MarshalToSizedBufferVT

func (m *GoSettings) MarshalToSizedBufferVT(dAtA []byte) (int, error)

func (*GoSettings) MarshalToVT

func (m *GoSettings) MarshalToVT(dAtA []byte) (int, error)

func (*GoSettings) MarshalVT

func (m *GoSettings) MarshalVT() (dAtA []byte, err error)

func (*GoSettings) ProtoMessage

func (*GoSettings) ProtoMessage()

func (*GoSettings) ProtoReflect

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

func (*GoSettings) Reset

func (x *GoSettings) Reset()

func (*GoSettings) SizeVT

func (m *GoSettings) SizeVT() (n int)

func (*GoSettings) String

func (x *GoSettings) String() string

func (*GoSettings) UnmarshalVT

func (m *GoSettings) UnmarshalVT(dAtA []byte) error

func (*GoSettings) Validate

func (m *GoSettings) Validate() error

Validate checks the field values on GoSettings with the rules defined in the proto definition for this message. If any rules are violated, the first error encountered is returned, or nil if there are no violations.

func (*GoSettings) ValidateAll

func (m *GoSettings) ValidateAll() error

ValidateAll checks the field values on GoSettings with the rules defined in the proto definition for this message. If any rules are violated, the result is a list of violation errors wrapped in GoSettingsMultiError, or nil if none found.

type GoSettingsMultiError

type GoSettingsMultiError []error

GoSettingsMultiError is an error wrapping multiple validation errors returned by GoSettings.ValidateAll() if the designated constraints aren't met.

func (GoSettingsMultiError) AllErrors

func (m GoSettingsMultiError) AllErrors() []error

AllErrors returns a list of validation violation errors.

func (GoSettingsMultiError) Error

func (m GoSettingsMultiError) Error() string

Error returns a concatenation of all the error messages it wraps.

type GoSettingsValidationError

type GoSettingsValidationError struct {
	// contains filtered or unexported fields
}

GoSettingsValidationError is the validation error returned by GoSettings.Validate if the designated constraints aren't met.

func (GoSettingsValidationError) Cause

func (e GoSettingsValidationError) Cause() error

Cause function returns cause value.

func (GoSettingsValidationError) Error

Error satisfies the builtin error interface

func (GoSettingsValidationError) ErrorName

func (e GoSettingsValidationError) ErrorName() string

ErrorName returns error name.

func (GoSettingsValidationError) Field

Field function returns field value.

func (GoSettingsValidationError) Key

Key function returns key value.

func (GoSettingsValidationError) Reason

func (e GoSettingsValidationError) Reason() string

Reason function returns reason value.

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) CloneMessageVT

func (m *Http) CloneMessageVT() proto.Message

func (*Http) CloneVT

func (m *Http) CloneVT() *Http

func (*Http) Descriptor deprecated

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

Deprecated: Use Http.ProtoReflect.Descriptor instead.

func (*Http) EqualMessageVT

func (this *Http) EqualMessageVT(thatMsg proto.Message) bool

func (*Http) EqualVT

func (this *Http) EqualVT(that *Http) bool

func (*Http) GetFullyDecodeReservedExpansion

func (x *Http) GetFullyDecodeReservedExpansion() bool

func (*Http) GetRules

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

func (*Http) MarshalToSizedBufferVT

func (m *Http) MarshalToSizedBufferVT(dAtA []byte) (int, error)

func (*Http) MarshalToVT

func (m *Http) MarshalToVT(dAtA []byte) (int, error)

func (*Http) MarshalVT

func (m *Http) MarshalVT() (dAtA []byte, err error)

func (*Http) ProtoMessage

func (*Http) ProtoMessage()

func (*Http) ProtoReflect

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

func (*Http) Reset

func (x *Http) Reset()

func (*Http) SizeVT

func (m *Http) SizeVT() (n int)

func (*Http) String

func (x *Http) String() string

func (*Http) UnmarshalVT

func (m *Http) UnmarshalVT(dAtA []byte) error

func (*Http) Validate

func (m *Http) Validate() error

Validate checks the field values on Http with the rules defined in the proto definition for this message. If any rules are violated, the first error encountered is returned, or nil if there are no violations.

func (*Http) ValidateAll

func (m *Http) ValidateAll() error

ValidateAll checks the field values on Http with the rules defined in the proto definition for this message. If any rules are violated, the result is a list of violation errors wrapped in HttpMultiError, or nil if none found.

type HttpBody

type HttpBody struct {

	// The HTTP Content-Type header value specifying the content type of the body.
	ContentType string `protobuf:"bytes,1,opt,name=content_type,json=contentType,proto3" json:"content_type,omitempty"`
	// The HTTP request/response body as raw binary.
	Data []byte `protobuf:"bytes,2,opt,name=data,proto3" json:"data,omitempty"`
	// Application specific response metadata. Must be set in the first response
	// for streaming APIs.
	Extensions []*anypb.Any `protobuf:"bytes,3,rep,name=extensions,proto3" json:"extensions,omitempty"`
	// contains filtered or unexported fields
}

Message that represents an arbitrary HTTP body. It should only be used for payload formats that can't be represented as JSON, such as raw binary or an HTML page.

This message can be used both in streaming and non-streaming API methods in the request as well as the response.

It can be used as a top-level request field, which is convenient if one wants to extract parameters from either the URL or HTTP template into the request fields and also want access to the raw HTTP body.

Example:

message GetResourceRequest {
  // A unique request id.
  string request_id = 1;

  // The raw HTTP body is bound to this field.
  google.api.HttpBody http_body = 2;

}

service ResourceService {
  rpc GetResource(GetResourceRequest)
    returns (google.api.HttpBody);
  rpc UpdateResource(google.api.HttpBody)
    returns (google.protobuf.Empty);

}

Example with streaming methods:

service CaldavService {
  rpc GetCalendar(stream google.api.HttpBody)
    returns (stream google.api.HttpBody);
  rpc UpdateCalendar(stream google.api.HttpBody)
    returns (stream google.api.HttpBody);

}

Use of this type only changes how the request and response bodies are handled, all other features will continue to work unchanged.

func (*HttpBody) CloneMessageVT

func (m *HttpBody) CloneMessageVT() proto.Message

func (*HttpBody) CloneVT

func (m *HttpBody) CloneVT() *HttpBody

func (*HttpBody) Descriptor deprecated

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

Deprecated: Use HttpBody.ProtoReflect.Descriptor instead.

func (*HttpBody) EqualMessageVT

func (this *HttpBody) EqualMessageVT(thatMsg proto.Message) bool

func (*HttpBody) EqualVT

func (this *HttpBody) EqualVT(that *HttpBody) bool

func (*HttpBody) GetContentType

func (x *HttpBody) GetContentType() string

func (*HttpBody) GetData

func (x *HttpBody) GetData() []byte

func (*HttpBody) GetExtensions

func (x *HttpBody) GetExtensions() []*anypb.Any

func (*HttpBody) MarshalToSizedBufferVT

func (m *HttpBody) MarshalToSizedBufferVT(dAtA []byte) (int, error)

func (*HttpBody) MarshalToVT

func (m *HttpBody) MarshalToVT(dAtA []byte) (int, error)

func (*HttpBody) MarshalVT

func (m *HttpBody) MarshalVT() (dAtA []byte, err error)

func (*HttpBody) ProtoMessage

func (*HttpBody) ProtoMessage()

func (*HttpBody) ProtoReflect

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

func (*HttpBody) Reset

func (x *HttpBody) Reset()

func (*HttpBody) SizeVT

func (m *HttpBody) SizeVT() (n int)

func (*HttpBody) String

func (x *HttpBody) String() string

func (*HttpBody) UnmarshalVT

func (m *HttpBody) UnmarshalVT(dAtA []byte) error

func (*HttpBody) Validate

func (m *HttpBody) Validate() error

Validate checks the field values on HttpBody with the rules defined in the proto definition for this message. If any rules are violated, the first error encountered is returned, or nil if there are no violations.

func (*HttpBody) ValidateAll

func (m *HttpBody) ValidateAll() error

ValidateAll checks the field values on HttpBody with the rules defined in the proto definition for this message. If any rules are violated, the result is a list of violation errors wrapped in HttpBodyMultiError, or nil if none found.

type HttpBodyMultiError

type HttpBodyMultiError []error

HttpBodyMultiError is an error wrapping multiple validation errors returned by HttpBody.ValidateAll() if the designated constraints aren't met.

func (HttpBodyMultiError) AllErrors

func (m HttpBodyMultiError) AllErrors() []error

AllErrors returns a list of validation violation errors.

func (HttpBodyMultiError) Error

func (m HttpBodyMultiError) Error() string

Error returns a concatenation of all the error messages it wraps.

type HttpBodyValidationError

type HttpBodyValidationError struct {
	// contains filtered or unexported fields
}

HttpBodyValidationError is the validation error returned by HttpBody.Validate if the designated constraints aren't met.

func (HttpBodyValidationError) Cause

func (e HttpBodyValidationError) Cause() error

Cause function returns cause value.

func (HttpBodyValidationError) Error

func (e HttpBodyValidationError) Error() string

Error satisfies the builtin error interface

func (HttpBodyValidationError) ErrorName

func (e HttpBodyValidationError) ErrorName() string

ErrorName returns error name.

func (HttpBodyValidationError) Field

func (e HttpBodyValidationError) Field() string

Field function returns field value.

func (HttpBodyValidationError) Key

func (e HttpBodyValidationError) Key() bool

Key function returns key value.

func (HttpBodyValidationError) Reason

func (e HttpBodyValidationError) Reason() string

Reason function returns reason value.

type HttpMultiError

type HttpMultiError []error

HttpMultiError is an error wrapping multiple validation errors returned by Http.ValidateAll() if the designated constraints aren't met.

func (HttpMultiError) AllErrors

func (m HttpMultiError) AllErrors() []error

AllErrors returns a list of validation violation errors.

func (HttpMultiError) Error

func (m HttpMultiError) Error() string

Error returns a concatenation of all the error messages it wraps.

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) CloneMessageVT

func (m *HttpRule) CloneMessageVT() proto.Message

func (*HttpRule) CloneVT

func (m *HttpRule) CloneVT() *HttpRule

func (*HttpRule) Descriptor deprecated

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

Deprecated: Use HttpRule.ProtoReflect.Descriptor instead.

func (*HttpRule) EqualMessageVT

func (this *HttpRule) EqualMessageVT(thatMsg proto.Message) bool

func (*HttpRule) EqualVT

func (this *HttpRule) EqualVT(that *HttpRule) bool

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) MarshalToSizedBufferVT

func (m *HttpRule) MarshalToSizedBufferVT(dAtA []byte) (int, error)

func (*HttpRule) MarshalToVT

func (m *HttpRule) MarshalToVT(dAtA []byte) (int, error)

func (*HttpRule) MarshalVT

func (m *HttpRule) MarshalVT() (dAtA []byte, err error)

func (*HttpRule) ProtoMessage

func (*HttpRule) ProtoMessage()

func (*HttpRule) ProtoReflect

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

func (*HttpRule) Reset

func (x *HttpRule) Reset()

func (*HttpRule) SizeVT

func (m *HttpRule) SizeVT() (n int)

func (*HttpRule) String

func (x *HttpRule) String() string

func (*HttpRule) UnmarshalVT

func (m *HttpRule) UnmarshalVT(dAtA []byte) error

func (*HttpRule) Validate

func (m *HttpRule) Validate() error

Validate checks the field values on HttpRule with the rules defined in the proto definition for this message. If any rules are violated, the first error encountered is returned, or nil if there are no violations.

func (*HttpRule) ValidateAll

func (m *HttpRule) ValidateAll() error

ValidateAll checks the field values on HttpRule with the rules defined in the proto definition for this message. If any rules are violated, the result is a list of violation errors wrapped in HttpRuleMultiError, or nil if none found.

type HttpRuleMultiError

type HttpRuleMultiError []error

HttpRuleMultiError is an error wrapping multiple validation errors returned by HttpRule.ValidateAll() if the designated constraints aren't met.

func (HttpRuleMultiError) AllErrors

func (m HttpRuleMultiError) AllErrors() []error

AllErrors returns a list of validation violation errors.

func (HttpRuleMultiError) Error

func (m HttpRuleMultiError) Error() string

Error returns a concatenation of all the error messages it wraps.

type HttpRuleValidationError

type HttpRuleValidationError struct {
	// contains filtered or unexported fields
}

HttpRuleValidationError is the validation error returned by HttpRule.Validate if the designated constraints aren't met.

func (HttpRuleValidationError) Cause

func (e HttpRuleValidationError) Cause() error

Cause function returns cause value.

func (HttpRuleValidationError) Error

func (e HttpRuleValidationError) Error() string

Error satisfies the builtin error interface

func (HttpRuleValidationError) ErrorName

func (e HttpRuleValidationError) ErrorName() string

ErrorName returns error name.

func (HttpRuleValidationError) Field

func (e HttpRuleValidationError) Field() string

Field function returns field value.

func (HttpRuleValidationError) Key

func (e HttpRuleValidationError) Key() bool

Key function returns key value.

func (HttpRuleValidationError) Reason

func (e HttpRuleValidationError) Reason() string

Reason function returns reason value.

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"`
}

func (*HttpRule_Custom) CloneVT

func (m *HttpRule_Custom) CloneVT() isHttpRule_Pattern

func (*HttpRule_Custom) EqualVT

func (this *HttpRule_Custom) EqualVT(thatIface isHttpRule_Pattern) bool

func (*HttpRule_Custom) MarshalToSizedBufferVT

func (m *HttpRule_Custom) MarshalToSizedBufferVT(dAtA []byte) (int, error)

func (*HttpRule_Custom) MarshalToVT

func (m *HttpRule_Custom) MarshalToVT(dAtA []byte) (int, error)

func (*HttpRule_Custom) SizeVT

func (m *HttpRule_Custom) SizeVT() (n int)

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"`
}

func (*HttpRule_Delete) CloneVT

func (m *HttpRule_Delete) CloneVT() isHttpRule_Pattern

func (*HttpRule_Delete) EqualVT

func (this *HttpRule_Delete) EqualVT(thatIface isHttpRule_Pattern) bool

func (*HttpRule_Delete) MarshalToSizedBufferVT

func (m *HttpRule_Delete) MarshalToSizedBufferVT(dAtA []byte) (int, error)

func (*HttpRule_Delete) MarshalToVT

func (m *HttpRule_Delete) MarshalToVT(dAtA []byte) (int, error)

func (*HttpRule_Delete) SizeVT

func (m *HttpRule_Delete) SizeVT() (n int)

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"`
}

func (*HttpRule_Get) CloneVT

func (m *HttpRule_Get) CloneVT() isHttpRule_Pattern

func (*HttpRule_Get) EqualVT

func (this *HttpRule_Get) EqualVT(thatIface isHttpRule_Pattern) bool

func (*HttpRule_Get) MarshalToSizedBufferVT

func (m *HttpRule_Get) MarshalToSizedBufferVT(dAtA []byte) (int, error)

func (*HttpRule_Get) MarshalToVT

func (m *HttpRule_Get) MarshalToVT(dAtA []byte) (int, error)

func (*HttpRule_Get) SizeVT

func (m *HttpRule_Get) SizeVT() (n int)

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"`
}

func (*HttpRule_Patch) CloneVT

func (m *HttpRule_Patch) CloneVT() isHttpRule_Pattern

func (*HttpRule_Patch) EqualVT

func (this *HttpRule_Patch) EqualVT(thatIface isHttpRule_Pattern) bool

func (*HttpRule_Patch) MarshalToSizedBufferVT

func (m *HttpRule_Patch) MarshalToSizedBufferVT(dAtA []byte) (int, error)

func (*HttpRule_Patch) MarshalToVT

func (m *HttpRule_Patch) MarshalToVT(dAtA []byte) (int, error)

func (*HttpRule_Patch) SizeVT

func (m *HttpRule_Patch) SizeVT() (n int)

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"`
}

func (*HttpRule_Post) CloneVT

func (m *HttpRule_Post) CloneVT() isHttpRule_Pattern

func (*HttpRule_Post) EqualVT

func (this *HttpRule_Post) EqualVT(thatIface isHttpRule_Pattern) bool

func (*HttpRule_Post) MarshalToSizedBufferVT

func (m *HttpRule_Post) MarshalToSizedBufferVT(dAtA []byte) (int, error)

func (*HttpRule_Post) MarshalToVT

func (m *HttpRule_Post) MarshalToVT(dAtA []byte) (int, error)

func (*HttpRule_Post) SizeVT

func (m *HttpRule_Post) SizeVT() (n int)

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"`
}

func (*HttpRule_Put) CloneVT

func (m *HttpRule_Put) CloneVT() isHttpRule_Pattern

func (*HttpRule_Put) EqualVT

func (this *HttpRule_Put) EqualVT(thatIface isHttpRule_Pattern) bool

func (*HttpRule_Put) MarshalToSizedBufferVT

func (m *HttpRule_Put) MarshalToSizedBufferVT(dAtA []byte) (int, error)

func (*HttpRule_Put) MarshalToVT

func (m *HttpRule_Put) MarshalToVT(dAtA []byte) (int, error)

func (*HttpRule_Put) SizeVT

func (m *HttpRule_Put) SizeVT() (n int)

type HttpValidationError

type HttpValidationError struct {
	// contains filtered or unexported fields
}

HttpValidationError is the validation error returned by Http.Validate if the designated constraints aren't met.

func (HttpValidationError) Cause

func (e HttpValidationError) Cause() error

Cause function returns cause value.

func (HttpValidationError) Error

func (e HttpValidationError) Error() string

Error satisfies the builtin error interface

func (HttpValidationError) ErrorName

func (e HttpValidationError) ErrorName() string

ErrorName returns error name.

func (HttpValidationError) Field

func (e HttpValidationError) Field() string

Field function returns field value.

func (HttpValidationError) Key

func (e HttpValidationError) Key() bool

Key function returns key value.

func (HttpValidationError) Reason

func (e HttpValidationError) Reason() string

Reason function returns reason value.

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) CloneMessageVT

func (m *JavaSettings) CloneMessageVT() proto.Message

func (*JavaSettings) CloneVT

func (m *JavaSettings) CloneVT() *JavaSettings

func (*JavaSettings) Descriptor deprecated

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

Deprecated: Use JavaSettings.ProtoReflect.Descriptor instead.

func (*JavaSettings) EqualMessageVT

func (this *JavaSettings) EqualMessageVT(thatMsg proto.Message) bool

func (*JavaSettings) EqualVT

func (this *JavaSettings) EqualVT(that *JavaSettings) bool

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) MarshalToSizedBufferVT

func (m *JavaSettings) MarshalToSizedBufferVT(dAtA []byte) (int, error)

func (*JavaSettings) MarshalToVT

func (m *JavaSettings) MarshalToVT(dAtA []byte) (int, error)

func (*JavaSettings) MarshalVT

func (m *JavaSettings) MarshalVT() (dAtA []byte, err error)

func (*JavaSettings) ProtoMessage

func (*JavaSettings) ProtoMessage()

func (*JavaSettings) ProtoReflect

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

func (*JavaSettings) Reset

func (x *JavaSettings) Reset()

func (*JavaSettings) SizeVT

func (m *JavaSettings) SizeVT() (n int)

func (*JavaSettings) String

func (x *JavaSettings) String() string

func (*JavaSettings) UnmarshalVT

func (m *JavaSettings) UnmarshalVT(dAtA []byte) error

func (*JavaSettings) Validate

func (m *JavaSettings) Validate() error

Validate checks the field values on JavaSettings with the rules defined in the proto definition for this message. If any rules are violated, the first error encountered is returned, or nil if there are no violations.

func (*JavaSettings) ValidateAll

func (m *JavaSettings) ValidateAll() error

ValidateAll checks the field values on JavaSettings with the rules defined in the proto definition for this message. If any rules are violated, the result is a list of violation errors wrapped in JavaSettingsMultiError, or nil if none found.

type JavaSettingsMultiError

type JavaSettingsMultiError []error

JavaSettingsMultiError is an error wrapping multiple validation errors returned by JavaSettings.ValidateAll() if the designated constraints aren't met.

func (JavaSettingsMultiError) AllErrors

func (m JavaSettingsMultiError) AllErrors() []error

AllErrors returns a list of validation violation errors.

func (JavaSettingsMultiError) Error

func (m JavaSettingsMultiError) Error() string

Error returns a concatenation of all the error messages it wraps.

type JavaSettingsValidationError

type JavaSettingsValidationError struct {
	// contains filtered or unexported fields
}

JavaSettingsValidationError is the validation error returned by JavaSettings.Validate if the designated constraints aren't met.

func (JavaSettingsValidationError) Cause

Cause function returns cause value.

func (JavaSettingsValidationError) Error

Error satisfies the builtin error interface

func (JavaSettingsValidationError) ErrorName

func (e JavaSettingsValidationError) ErrorName() string

ErrorName returns error name.

func (JavaSettingsValidationError) Field

Field function returns field value.

func (JavaSettingsValidationError) Key

Key function returns key value.

func (JavaSettingsValidationError) Reason

Reason function returns reason value.

type LaunchStage

type LaunchStage int32

The launch stage as defined by [Google Cloud Platform Launch Stages](https://cloud.google.com/terms/launch-stages).

const (
	// Do not use this default value.
	LaunchStage_LAUNCH_STAGE_UNSPECIFIED LaunchStage = 0
	// The feature is not yet implemented. Users can not use it.
	LaunchStage_UNIMPLEMENTED LaunchStage = 6
	// Prelaunch features are hidden from users and are only visible internally.
	LaunchStage_PRELAUNCH LaunchStage = 7
	// Early Access features are limited to a closed group of testers. To use
	// these features, you must sign up in advance and sign a Trusted Tester
	// agreement (which includes confidentiality provisions). These features may
	// be unstable, changed in backward-incompatible ways, and are not
	// guaranteed to be released.
	LaunchStage_EARLY_ACCESS LaunchStage = 1
	// Alpha is a limited availability test for releases before they are cleared
	// for widespread use. By Alpha, all significant design issues are resolved
	// and we are in the process of verifying functionality. Alpha customers
	// need to apply for access, agree to applicable terms, and have their
	// projects allowlisted. Alpha releases don't have to be feature complete,
	// no SLAs are provided, and there are no technical support obligations, but
	// they will be far enough along that customers can actually use them in
	// test environments or for limited-use tests -- just like they would in
	// normal production cases.
	LaunchStage_ALPHA LaunchStage = 2
	// Beta is the point at which we are ready to open a release for any
	// customer to use. There are no SLA or technical support obligations in a
	// Beta release. Products will be complete from a feature perspective, but
	// may have some open outstanding issues. Beta releases are suitable for
	// limited production use cases.
	LaunchStage_BETA LaunchStage = 3
	// GA features are open to all developers and are considered stable and
	// fully qualified for production use.
	LaunchStage_GA LaunchStage = 4
	// Deprecated features are scheduled to be shut down and removed. For more
	// information, see the "Deprecation Policy" section of our [Terms of
	// Service](https://cloud.google.com/terms/)
	// and the [Google Cloud Platform Subject to the Deprecation
	// Policy](https://cloud.google.com/terms/deprecation) documentation.
	LaunchStage_DEPRECATED LaunchStage = 5
)

func (LaunchStage) Descriptor

func (LaunchStage) Enum

func (x LaunchStage) Enum() *LaunchStage

func (LaunchStage) EnumDescriptor deprecated

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

Deprecated: Use LaunchStage.Descriptor instead.

func (LaunchStage) Number

func (x LaunchStage) Number() protoreflect.EnumNumber

func (LaunchStage) String

func (x LaunchStage) String() string

func (LaunchStage) Type

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_settings:
	//	    - selector: google.cloud.speech.v2.Speech.BatchRecognize
	//	      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"`
	// List of top-level fields of the request message, that should be
	// automatically populated by the client libraries based on their
	// (google.api.field_info).format. Currently supported format: UUID4.
	//
	// Example of a YAML configuration:
	//
	//	publishing:
	//	  method_settings:
	//	    - selector: google.example.v1.ExampleService.CreateExample
	//	      auto_populated_fields:
	//	      - request_id
	AutoPopulatedFields []string `protobuf:"bytes,3,rep,name=auto_populated_fields,json=autoPopulatedFields,proto3" json:"auto_populated_fields,omitempty"`
	// contains filtered or unexported fields
}

Describes the generator configuration for a method.

func (*MethodSettings) CloneMessageVT

func (m *MethodSettings) CloneMessageVT() proto.Message

func (*MethodSettings) CloneVT

func (m *MethodSettings) CloneVT() *MethodSettings

func (*MethodSettings) Descriptor deprecated

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

Deprecated: Use MethodSettings.ProtoReflect.Descriptor instead.

func (*MethodSettings) EqualMessageVT

func (this *MethodSettings) EqualMessageVT(thatMsg proto.Message) bool

func (*MethodSettings) EqualVT

func (this *MethodSettings) EqualVT(that *MethodSettings) bool

func (*MethodSettings) GetAutoPopulatedFields

func (x *MethodSettings) GetAutoPopulatedFields() []string

func (*MethodSettings) GetLongRunning

func (x *MethodSettings) GetLongRunning() *MethodSettings_LongRunning

func (*MethodSettings) GetSelector

func (x *MethodSettings) GetSelector() string

func (*MethodSettings) MarshalToSizedBufferVT

func (m *MethodSettings) MarshalToSizedBufferVT(dAtA []byte) (int, error)

func (*MethodSettings) MarshalToVT

func (m *MethodSettings) MarshalToVT(dAtA []byte) (int, error)

func (*MethodSettings) MarshalVT

func (m *MethodSettings) MarshalVT() (dAtA []byte, err error)

func (*MethodSettings) ProtoMessage

func (*MethodSettings) ProtoMessage()

func (*MethodSettings) ProtoReflect

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

func (*MethodSettings) Reset

func (x *MethodSettings) Reset()

func (*MethodSettings) SizeVT

func (m *MethodSettings) SizeVT() (n int)

func (*MethodSettings) String

func (x *MethodSettings) String() string

func (*MethodSettings) UnmarshalVT

func (m *MethodSettings) UnmarshalVT(dAtA []byte) error

func (*MethodSettings) Validate

func (m *MethodSettings) Validate() error

Validate checks the field values on MethodSettings with the rules defined in the proto definition for this message. If any rules are violated, the first error encountered is returned, or nil if there are no violations.

func (*MethodSettings) ValidateAll

func (m *MethodSettings) ValidateAll() error

ValidateAll checks the field values on MethodSettings with the rules defined in the proto definition for this message. If any rules are violated, the result is a list of violation errors wrapped in MethodSettingsMultiError, or nil if none found.

type MethodSettingsMultiError

type MethodSettingsMultiError []error

MethodSettingsMultiError is an error wrapping multiple validation errors returned by MethodSettings.ValidateAll() if the designated constraints aren't met.

func (MethodSettingsMultiError) AllErrors

func (m MethodSettingsMultiError) AllErrors() []error

AllErrors returns a list of validation violation errors.

func (MethodSettingsMultiError) Error

func (m MethodSettingsMultiError) Error() string

Error returns a concatenation of all the error messages it wraps.

type MethodSettingsValidationError

type MethodSettingsValidationError struct {
	// contains filtered or unexported fields
}

MethodSettingsValidationError is the validation error returned by MethodSettings.Validate if the designated constraints aren't met.

func (MethodSettingsValidationError) Cause

Cause function returns cause value.

func (MethodSettingsValidationError) Error

Error satisfies the builtin error interface

func (MethodSettingsValidationError) ErrorName

func (e MethodSettingsValidationError) ErrorName() string

ErrorName returns error name.

func (MethodSettingsValidationError) Field

Field function returns field value.

func (MethodSettingsValidationError) Key

Key function returns key value.

func (MethodSettingsValidationError) Reason

Reason function returns reason value.

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) CloneMessageVT

func (m *MethodSettings_LongRunning) CloneMessageVT() proto.Message

func (*MethodSettings_LongRunning) CloneVT

func (*MethodSettings_LongRunning) Descriptor deprecated

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

Deprecated: Use MethodSettings_LongRunning.ProtoReflect.Descriptor instead.

func (*MethodSettings_LongRunning) EqualMessageVT

func (this *MethodSettings_LongRunning) EqualMessageVT(thatMsg proto.Message) bool

func (*MethodSettings_LongRunning) EqualVT

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) MarshalToSizedBufferVT

func (m *MethodSettings_LongRunning) MarshalToSizedBufferVT(dAtA []byte) (int, error)

func (*MethodSettings_LongRunning) MarshalToVT

func (m *MethodSettings_LongRunning) MarshalToVT(dAtA []byte) (int, error)

func (*MethodSettings_LongRunning) MarshalVT

func (m *MethodSettings_LongRunning) MarshalVT() (dAtA []byte, err error)

func (*MethodSettings_LongRunning) ProtoMessage

func (*MethodSettings_LongRunning) ProtoMessage()

func (*MethodSettings_LongRunning) ProtoReflect

func (*MethodSettings_LongRunning) Reset

func (x *MethodSettings_LongRunning) Reset()

func (*MethodSettings_LongRunning) SizeVT

func (m *MethodSettings_LongRunning) SizeVT() (n int)

func (*MethodSettings_LongRunning) String

func (x *MethodSettings_LongRunning) String() string

func (*MethodSettings_LongRunning) UnmarshalVT

func (m *MethodSettings_LongRunning) UnmarshalVT(dAtA []byte) error

func (*MethodSettings_LongRunning) Validate

func (m *MethodSettings_LongRunning) Validate() error

Validate checks the field values on MethodSettings_LongRunning with the rules defined in the proto definition for this message. If any rules are violated, the first error encountered is returned, or nil if there are no violations.

func (*MethodSettings_LongRunning) ValidateAll

func (m *MethodSettings_LongRunning) ValidateAll() error

ValidateAll checks the field values on MethodSettings_LongRunning with the rules defined in the proto definition for this message. If any rules are violated, the result is a list of violation errors wrapped in MethodSettings_LongRunningMultiError, or nil if none found.

type MethodSettings_LongRunningMultiError

type MethodSettings_LongRunningMultiError []error

MethodSettings_LongRunningMultiError is an error wrapping multiple validation errors returned by MethodSettings_LongRunning.ValidateAll() if the designated constraints aren't met.

func (MethodSettings_LongRunningMultiError) AllErrors

AllErrors returns a list of validation violation errors.

func (MethodSettings_LongRunningMultiError) Error

Error returns a concatenation of all the error messages it wraps.

type MethodSettings_LongRunningValidationError

type MethodSettings_LongRunningValidationError struct {
	// contains filtered or unexported fields
}

MethodSettings_LongRunningValidationError is the validation error returned by MethodSettings_LongRunning.Validate if the designated constraints aren't met.

func (MethodSettings_LongRunningValidationError) Cause

Cause function returns cause value.

func (MethodSettings_LongRunningValidationError) Error

Error satisfies the builtin error interface

func (MethodSettings_LongRunningValidationError) ErrorName

ErrorName returns error name.

func (MethodSettings_LongRunningValidationError) Field

Field function returns field value.

func (MethodSettings_LongRunningValidationError) Key

Key function returns key value.

func (MethodSettings_LongRunningValidationError) Reason

Reason function returns reason value.

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) CloneMessageVT

func (m *NodeSettings) CloneMessageVT() proto.Message

func (*NodeSettings) CloneVT

func (m *NodeSettings) CloneVT() *NodeSettings

func (*NodeSettings) Descriptor deprecated

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

Deprecated: Use NodeSettings.ProtoReflect.Descriptor instead.

func (*NodeSettings) EqualMessageVT

func (this *NodeSettings) EqualMessageVT(thatMsg proto.Message) bool

func (*NodeSettings) EqualVT

func (this *NodeSettings) EqualVT(that *NodeSettings) bool

func (*NodeSettings) GetCommon

func (x *NodeSettings) GetCommon() *CommonLanguageSettings

func (*NodeSettings) MarshalToSizedBufferVT

func (m *NodeSettings) MarshalToSizedBufferVT(dAtA []byte) (int, error)

func (*NodeSettings) MarshalToVT

func (m *NodeSettings) MarshalToVT(dAtA []byte) (int, error)

func (*NodeSettings) MarshalVT

func (m *NodeSettings) MarshalVT() (dAtA []byte, err error)

func (*NodeSettings) ProtoMessage

func (*NodeSettings) ProtoMessage()

func (*NodeSettings) ProtoReflect

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

func (*NodeSettings) Reset

func (x *NodeSettings) Reset()

func (*NodeSettings) SizeVT

func (m *NodeSettings) SizeVT() (n int)

func (*NodeSettings) String

func (x *NodeSettings) String() string

func (*NodeSettings) UnmarshalVT

func (m *NodeSettings) UnmarshalVT(dAtA []byte) error

func (*NodeSettings) Validate

func (m *NodeSettings) Validate() error

Validate checks the field values on NodeSettings with the rules defined in the proto definition for this message. If any rules are violated, the first error encountered is returned, or nil if there are no violations.

func (*NodeSettings) ValidateAll

func (m *NodeSettings) ValidateAll() error

ValidateAll checks the field values on NodeSettings with the rules defined in the proto definition for this message. If any rules are violated, the result is a list of violation errors wrapped in NodeSettingsMultiError, or nil if none found.

type NodeSettingsMultiError

type NodeSettingsMultiError []error

NodeSettingsMultiError is an error wrapping multiple validation errors returned by NodeSettings.ValidateAll() if the designated constraints aren't met.

func (NodeSettingsMultiError) AllErrors

func (m NodeSettingsMultiError) AllErrors() []error

AllErrors returns a list of validation violation errors.

func (NodeSettingsMultiError) Error

func (m NodeSettingsMultiError) Error() string

Error returns a concatenation of all the error messages it wraps.

type NodeSettingsValidationError

type NodeSettingsValidationError struct {
	// contains filtered or unexported fields
}

NodeSettingsValidationError is the validation error returned by NodeSettings.Validate if the designated constraints aren't met.

func (NodeSettingsValidationError) Cause

Cause function returns cause value.

func (NodeSettingsValidationError) Error

Error satisfies the builtin error interface

func (NodeSettingsValidationError) ErrorName

func (e NodeSettingsValidationError) ErrorName() string

ErrorName returns error name.

func (NodeSettingsValidationError) Field

Field function returns field value.

func (NodeSettingsValidationError) Key

Key function returns key value.

func (NodeSettingsValidationError) Reason

Reason function returns reason value.

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) CloneMessageVT

func (m *PhpSettings) CloneMessageVT() proto.Message

func (*PhpSettings) CloneVT

func (m *PhpSettings) CloneVT() *PhpSettings

func (*PhpSettings) Descriptor deprecated

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

Deprecated: Use PhpSettings.ProtoReflect.Descriptor instead.

func (*PhpSettings) EqualMessageVT

func (this *PhpSettings) EqualMessageVT(thatMsg proto.Message) bool

func (*PhpSettings) EqualVT

func (this *PhpSettings) EqualVT(that *PhpSettings) bool

func (*PhpSettings) GetCommon

func (x *PhpSettings) GetCommon() *CommonLanguageSettings

func (*PhpSettings) MarshalToSizedBufferVT

func (m *PhpSettings) MarshalToSizedBufferVT(dAtA []byte) (int, error)

func (*PhpSettings) MarshalToVT

func (m *PhpSettings) MarshalToVT(dAtA []byte) (int, error)

func (*PhpSettings) MarshalVT

func (m *PhpSettings) MarshalVT() (dAtA []byte, err error)

func (*PhpSettings) ProtoMessage

func (*PhpSettings) ProtoMessage()

func (*PhpSettings) ProtoReflect

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

func (*PhpSettings) Reset

func (x *PhpSettings) Reset()

func (*PhpSettings) SizeVT

func (m *PhpSettings) SizeVT() (n int)

func (*PhpSettings) String

func (x *PhpSettings) String() string

func (*PhpSettings) UnmarshalVT

func (m *PhpSettings) UnmarshalVT(dAtA []byte) error

func (*PhpSettings) Validate

func (m *PhpSettings) Validate() error

Validate checks the field values on PhpSettings with the rules defined in the proto definition for this message. If any rules are violated, the first error encountered is returned, or nil if there are no violations.

func (*PhpSettings) ValidateAll

func (m *PhpSettings) ValidateAll() error

ValidateAll checks the field values on PhpSettings with the rules defined in the proto definition for this message. If any rules are violated, the result is a list of violation errors wrapped in PhpSettingsMultiError, or nil if none found.

type PhpSettingsMultiError

type PhpSettingsMultiError []error

PhpSettingsMultiError is an error wrapping multiple validation errors returned by PhpSettings.ValidateAll() if the designated constraints aren't met.

func (PhpSettingsMultiError) AllErrors

func (m PhpSettingsMultiError) AllErrors() []error

AllErrors returns a list of validation violation errors.

func (PhpSettingsMultiError) Error

func (m PhpSettingsMultiError) Error() string

Error returns a concatenation of all the error messages it wraps.

type PhpSettingsValidationError

type PhpSettingsValidationError struct {
	// contains filtered or unexported fields
}

PhpSettingsValidationError is the validation error returned by PhpSettings.Validate if the designated constraints aren't met.

func (PhpSettingsValidationError) Cause

Cause function returns cause value.

func (PhpSettingsValidationError) Error

Error satisfies the builtin error interface

func (PhpSettingsValidationError) ErrorName

func (e PhpSettingsValidationError) ErrorName() string

ErrorName returns error name.

func (PhpSettingsValidationError) Field

Field function returns field value.

func (PhpSettingsValidationError) Key

Key function returns key value.

func (PhpSettingsValidationError) Reason

Reason function returns reason value.

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 *public* URI where 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"`
	// Optional link to proto reference documentation.  Example:
	// https://cloud.google.com/pubsub/lite/docs/reference/rpc
	ProtoReferenceDocumentationUri string `` /* 157-byte string literal not displayed */
	// 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) CloneMessageVT

func (m *Publishing) CloneMessageVT() proto.Message

func (*Publishing) CloneVT

func (m *Publishing) CloneVT() *Publishing

func (*Publishing) Descriptor deprecated

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

Deprecated: Use Publishing.ProtoReflect.Descriptor instead.

func (*Publishing) EqualMessageVT

func (this *Publishing) EqualMessageVT(thatMsg proto.Message) bool

func (*Publishing) EqualVT

func (this *Publishing) EqualVT(that *Publishing) bool

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) GetProtoReferenceDocumentationUri

func (x *Publishing) GetProtoReferenceDocumentationUri() string

func (*Publishing) MarshalToSizedBufferVT

func (m *Publishing) MarshalToSizedBufferVT(dAtA []byte) (int, error)

func (*Publishing) MarshalToVT

func (m *Publishing) MarshalToVT(dAtA []byte) (int, error)

func (*Publishing) MarshalVT

func (m *Publishing) MarshalVT() (dAtA []byte, err error)

func (*Publishing) ProtoMessage

func (*Publishing) ProtoMessage()

func (*Publishing) ProtoReflect

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

func (*Publishing) Reset

func (x *Publishing) Reset()

func (*Publishing) SizeVT

func (m *Publishing) SizeVT() (n int)

func (*Publishing) String

func (x *Publishing) String() string

func (*Publishing) UnmarshalVT

func (m *Publishing) UnmarshalVT(dAtA []byte) error

func (*Publishing) Validate

func (m *Publishing) Validate() error

Validate checks the field values on Publishing with the rules defined in the proto definition for this message. If any rules are violated, the first error encountered is returned, or nil if there are no violations.

func (*Publishing) ValidateAll

func (m *Publishing) ValidateAll() error

ValidateAll checks the field values on Publishing with the rules defined in the proto definition for this message. If any rules are violated, the result is a list of violation errors wrapped in PublishingMultiError, or nil if none found.

type PublishingMultiError

type PublishingMultiError []error

PublishingMultiError is an error wrapping multiple validation errors returned by Publishing.ValidateAll() if the designated constraints aren't met.

func (PublishingMultiError) AllErrors

func (m PublishingMultiError) AllErrors() []error

AllErrors returns a list of validation violation errors.

func (PublishingMultiError) Error

func (m PublishingMultiError) Error() string

Error returns a concatenation of all the error messages it wraps.

type PublishingValidationError

type PublishingValidationError struct {
	// contains filtered or unexported fields
}

PublishingValidationError is the validation error returned by Publishing.Validate if the designated constraints aren't met.

func (PublishingValidationError) Cause

func (e PublishingValidationError) Cause() error

Cause function returns cause value.

func (PublishingValidationError) Error

Error satisfies the builtin error interface

func (PublishingValidationError) ErrorName

func (e PublishingValidationError) ErrorName() string

ErrorName returns error name.

func (PublishingValidationError) Field

Field function returns field value.

func (PublishingValidationError) Key

Key function returns key value.

func (PublishingValidationError) Reason

func (e PublishingValidationError) Reason() string

Reason function returns reason value.

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) CloneMessageVT

func (m *PythonSettings) CloneMessageVT() proto.Message

func (*PythonSettings) CloneVT

func (m *PythonSettings) CloneVT() *PythonSettings

func (*PythonSettings) Descriptor deprecated

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

Deprecated: Use PythonSettings.ProtoReflect.Descriptor instead.

func (*PythonSettings) EqualMessageVT

func (this *PythonSettings) EqualMessageVT(thatMsg proto.Message) bool

func (*PythonSettings) EqualVT

func (this *PythonSettings) EqualVT(that *PythonSettings) bool

func (*PythonSettings) GetCommon

func (x *PythonSettings) GetCommon() *CommonLanguageSettings

func (*PythonSettings) MarshalToSizedBufferVT

func (m *PythonSettings) MarshalToSizedBufferVT(dAtA []byte) (int, error)

func (*PythonSettings) MarshalToVT

func (m *PythonSettings) MarshalToVT(dAtA []byte) (int, error)

func (*PythonSettings) MarshalVT

func (m *PythonSettings) MarshalVT() (dAtA []byte, err error)

func (*PythonSettings) ProtoMessage

func (*PythonSettings) ProtoMessage()

func (*PythonSettings) ProtoReflect

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

func (*PythonSettings) Reset

func (x *PythonSettings) Reset()

func (*PythonSettings) SizeVT

func (m *PythonSettings) SizeVT() (n int)

func (*PythonSettings) String

func (x *PythonSettings) String() string

func (*PythonSettings) UnmarshalVT

func (m *PythonSettings) UnmarshalVT(dAtA []byte) error

func (*PythonSettings) Validate

func (m *PythonSettings) Validate() error

Validate checks the field values on PythonSettings with the rules defined in the proto definition for this message. If any rules are violated, the first error encountered is returned, or nil if there are no violations.

func (*PythonSettings) ValidateAll

func (m *PythonSettings) ValidateAll() error

ValidateAll checks the field values on PythonSettings with the rules defined in the proto definition for this message. If any rules are violated, the result is a list of violation errors wrapped in PythonSettingsMultiError, or nil if none found.

type PythonSettingsMultiError

type PythonSettingsMultiError []error

PythonSettingsMultiError is an error wrapping multiple validation errors returned by PythonSettings.ValidateAll() if the designated constraints aren't met.

func (PythonSettingsMultiError) AllErrors

func (m PythonSettingsMultiError) AllErrors() []error

AllErrors returns a list of validation violation errors.

func (PythonSettingsMultiError) Error

func (m PythonSettingsMultiError) Error() string

Error returns a concatenation of all the error messages it wraps.

type PythonSettingsValidationError

type PythonSettingsValidationError struct {
	// contains filtered or unexported fields
}

PythonSettingsValidationError is the validation error returned by PythonSettings.Validate if the designated constraints aren't met.

func (PythonSettingsValidationError) Cause

Cause function returns cause value.

func (PythonSettingsValidationError) Error

Error satisfies the builtin error interface

func (PythonSettingsValidationError) ErrorName

func (e PythonSettingsValidationError) ErrorName() string

ErrorName returns error name.

func (PythonSettingsValidationError) Field

Field function returns field value.

func (PythonSettingsValidationError) Key

Key function returns key value.

func (PythonSettingsValidationError) Reason

Reason function returns reason value.

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) CloneMessageVT

func (m *ResourceDescriptor) CloneMessageVT() proto.Message

func (*ResourceDescriptor) CloneVT

func (m *ResourceDescriptor) CloneVT() *ResourceDescriptor

func (*ResourceDescriptor) Descriptor deprecated

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

Deprecated: Use ResourceDescriptor.ProtoReflect.Descriptor instead.

func (*ResourceDescriptor) EqualMessageVT

func (this *ResourceDescriptor) EqualMessageVT(thatMsg proto.Message) bool

func (*ResourceDescriptor) EqualVT

func (this *ResourceDescriptor) EqualVT(that *ResourceDescriptor) bool

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) MarshalToSizedBufferVT

func (m *ResourceDescriptor) MarshalToSizedBufferVT(dAtA []byte) (int, error)

func (*ResourceDescriptor) MarshalToVT

func (m *ResourceDescriptor) MarshalToVT(dAtA []byte) (int, error)

func (*ResourceDescriptor) MarshalVT

func (m *ResourceDescriptor) MarshalVT() (dAtA []byte, err error)

func (*ResourceDescriptor) ProtoMessage

func (*ResourceDescriptor) ProtoMessage()

func (*ResourceDescriptor) ProtoReflect

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

func (*ResourceDescriptor) Reset

func (x *ResourceDescriptor) Reset()

func (*ResourceDescriptor) SizeVT

func (m *ResourceDescriptor) SizeVT() (n int)

func (*ResourceDescriptor) String

func (x *ResourceDescriptor) String() string

func (*ResourceDescriptor) UnmarshalVT

func (m *ResourceDescriptor) UnmarshalVT(dAtA []byte) error

func (*ResourceDescriptor) Validate

func (m *ResourceDescriptor) Validate() error

Validate checks the field values on ResourceDescriptor with the rules defined in the proto definition for this message. If any rules are violated, the first error encountered is returned, or nil if there are no violations.

func (*ResourceDescriptor) ValidateAll

func (m *ResourceDescriptor) ValidateAll() error

ValidateAll checks the field values on ResourceDescriptor with the rules defined in the proto definition for this message. If any rules are violated, the result is a list of violation errors wrapped in ResourceDescriptorMultiError, or nil if none found.

type ResourceDescriptorMultiError

type ResourceDescriptorMultiError []error

ResourceDescriptorMultiError is an error wrapping multiple validation errors returned by ResourceDescriptor.ValidateAll() if the designated constraints aren't met.

func (ResourceDescriptorMultiError) AllErrors

func (m ResourceDescriptorMultiError) AllErrors() []error

AllErrors returns a list of validation violation errors.

func (ResourceDescriptorMultiError) Error

Error returns a concatenation of all the error messages it wraps.

type ResourceDescriptorValidationError

type ResourceDescriptorValidationError struct {
	// contains filtered or unexported fields
}

ResourceDescriptorValidationError is the validation error returned by ResourceDescriptor.Validate if the designated constraints aren't met.

func (ResourceDescriptorValidationError) Cause

Cause function returns cause value.

func (ResourceDescriptorValidationError) Error

Error satisfies the builtin error interface

func (ResourceDescriptorValidationError) ErrorName

ErrorName returns error name.

func (ResourceDescriptorValidationError) Field

Field function returns field value.

func (ResourceDescriptorValidationError) Key

Key function returns key value.

func (ResourceDescriptorValidationError) Reason

Reason function returns reason value.

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) CloneMessageVT

func (m *ResourceReference) CloneMessageVT() proto.Message

func (*ResourceReference) CloneVT

func (m *ResourceReference) CloneVT() *ResourceReference

func (*ResourceReference) Descriptor deprecated

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

Deprecated: Use ResourceReference.ProtoReflect.Descriptor instead.

func (*ResourceReference) EqualMessageVT

func (this *ResourceReference) EqualMessageVT(thatMsg proto.Message) bool

func (*ResourceReference) EqualVT

func (this *ResourceReference) EqualVT(that *ResourceReference) bool

func (*ResourceReference) GetChildType

func (x *ResourceReference) GetChildType() string

func (*ResourceReference) GetType

func (x *ResourceReference) GetType() string

func (*ResourceReference) MarshalToSizedBufferVT

func (m *ResourceReference) MarshalToSizedBufferVT(dAtA []byte) (int, error)

func (*ResourceReference) MarshalToVT

func (m *ResourceReference) MarshalToVT(dAtA []byte) (int, error)

func (*ResourceReference) MarshalVT

func (m *ResourceReference) MarshalVT() (dAtA []byte, err error)

func (*ResourceReference) ProtoMessage

func (*ResourceReference) ProtoMessage()

func (*ResourceReference) ProtoReflect

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

func (*ResourceReference) Reset

func (x *ResourceReference) Reset()

func (*ResourceReference) SizeVT

func (m *ResourceReference) SizeVT() (n int)

func (*ResourceReference) String

func (x *ResourceReference) String() string

func (*ResourceReference) UnmarshalVT

func (m *ResourceReference) UnmarshalVT(dAtA []byte) error

func (*ResourceReference) Validate

func (m *ResourceReference) Validate() error

Validate checks the field values on ResourceReference with the rules defined in the proto definition for this message. If any rules are violated, the first error encountered is returned, or nil if there are no violations.

func (*ResourceReference) ValidateAll

func (m *ResourceReference) ValidateAll() error

ValidateAll checks the field values on ResourceReference with the rules defined in the proto definition for this message. If any rules are violated, the result is a list of violation errors wrapped in ResourceReferenceMultiError, or nil if none found.

type ResourceReferenceMultiError

type ResourceReferenceMultiError []error

ResourceReferenceMultiError is an error wrapping multiple validation errors returned by ResourceReference.ValidateAll() if the designated constraints aren't met.

func (ResourceReferenceMultiError) AllErrors

func (m ResourceReferenceMultiError) AllErrors() []error

AllErrors returns a list of validation violation errors.

func (ResourceReferenceMultiError) Error

Error returns a concatenation of all the error messages it wraps.

type ResourceReferenceValidationError

type ResourceReferenceValidationError struct {
	// contains filtered or unexported fields
}

ResourceReferenceValidationError is the validation error returned by ResourceReference.Validate if the designated constraints aren't met.

func (ResourceReferenceValidationError) Cause

Cause function returns cause value.

func (ResourceReferenceValidationError) Error

Error satisfies the builtin error interface

func (ResourceReferenceValidationError) ErrorName

ErrorName returns error name.

func (ResourceReferenceValidationError) Field

Field function returns field value.

func (ResourceReferenceValidationError) Key

Key function returns key value.

func (ResourceReferenceValidationError) Reason

Reason function returns reason value.

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) CloneMessageVT

func (m *RubySettings) CloneMessageVT() proto.Message

func (*RubySettings) CloneVT

func (m *RubySettings) CloneVT() *RubySettings

func (*RubySettings) Descriptor deprecated

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

Deprecated: Use RubySettings.ProtoReflect.Descriptor instead.

func (*RubySettings) EqualMessageVT

func (this *RubySettings) EqualMessageVT(thatMsg proto.Message) bool

func (*RubySettings) EqualVT

func (this *RubySettings) EqualVT(that *RubySettings) bool

func (*RubySettings) GetCommon

func (x *RubySettings) GetCommon() *CommonLanguageSettings

func (*RubySettings) MarshalToSizedBufferVT

func (m *RubySettings) MarshalToSizedBufferVT(dAtA []byte) (int, error)

func (*RubySettings) MarshalToVT

func (m *RubySettings) MarshalToVT(dAtA []byte) (int, error)

func (*RubySettings) MarshalVT

func (m *RubySettings) MarshalVT() (dAtA []byte, err error)

func (*RubySettings) ProtoMessage

func (*RubySettings) ProtoMessage()

func (*RubySettings) ProtoReflect

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

func (*RubySettings) Reset

func (x *RubySettings) Reset()

func (*RubySettings) SizeVT

func (m *RubySettings) SizeVT() (n int)

func (*RubySettings) String

func (x *RubySettings) String() string

func (*RubySettings) UnmarshalVT

func (m *RubySettings) UnmarshalVT(dAtA []byte) error

func (*RubySettings) Validate

func (m *RubySettings) Validate() error

Validate checks the field values on RubySettings with the rules defined in the proto definition for this message. If any rules are violated, the first error encountered is returned, or nil if there are no violations.

func (*RubySettings) ValidateAll

func (m *RubySettings) ValidateAll() error

ValidateAll checks the field values on RubySettings with the rules defined in the proto definition for this message. If any rules are violated, the result is a list of violation errors wrapped in RubySettingsMultiError, or nil if none found.

type RubySettingsMultiError

type RubySettingsMultiError []error

RubySettingsMultiError is an error wrapping multiple validation errors returned by RubySettings.ValidateAll() if the designated constraints aren't met.

func (RubySettingsMultiError) AllErrors

func (m RubySettingsMultiError) AllErrors() []error

AllErrors returns a list of validation violation errors.

func (RubySettingsMultiError) Error

func (m RubySettingsMultiError) Error() string

Error returns a concatenation of all the error messages it wraps.

type RubySettingsValidationError

type RubySettingsValidationError struct {
	// contains filtered or unexported fields
}

RubySettingsValidationError is the validation error returned by RubySettings.Validate if the designated constraints aren't met.

func (RubySettingsValidationError) Cause

Cause function returns cause value.

func (RubySettingsValidationError) Error

Error satisfies the builtin error interface

func (RubySettingsValidationError) ErrorName

func (e RubySettingsValidationError) ErrorName() string

ErrorName returns error name.

func (RubySettingsValidationError) Field

Field function returns field value.

func (RubySettingsValidationError) Key

Key function returns key value.

func (RubySettingsValidationError) Reason

Reason function returns reason value.

type Visibility

type Visibility struct {

	// A list of visibility rules that apply to individual API elements.
	//
	// **NOTE:** All service configuration rules follow "last one wins" order.
	Rules []*VisibilityRule `protobuf:"bytes,1,rep,name=rules,proto3" json:"rules,omitempty"`
	// contains filtered or unexported fields
}

`Visibility` restricts service consumer's access to service elements, such as whether an application can call a visibility-restricted method. The restriction is expressed by applying visibility labels on service elements. The visibility labels are elsewhere linked to service consumers.

A service can define multiple visibility labels, but a service consumer should be granted at most one visibility label. Multiple visibility labels for a single service consumer are not supported.

If an element and all its parents have no visibility label, its visibility is unconditionally granted.

Example:

visibility:
  rules:
  - selector: google.calendar.Calendar.EnhancedSearch
    restriction: PREVIEW
  - selector: google.calendar.Calendar.Delegate
    restriction: INTERNAL

Here, all methods are publicly visible except for the restricted methods EnhancedSearch and Delegate.

func (*Visibility) CloneMessageVT

func (m *Visibility) CloneMessageVT() proto.Message

func (*Visibility) CloneVT

func (m *Visibility) CloneVT() *Visibility

func (*Visibility) Descriptor deprecated

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

Deprecated: Use Visibility.ProtoReflect.Descriptor instead.

func (*Visibility) EqualMessageVT

func (this *Visibility) EqualMessageVT(thatMsg proto.Message) bool

func (*Visibility) EqualVT

func (this *Visibility) EqualVT(that *Visibility) bool

func (*Visibility) GetRules

func (x *Visibility) GetRules() []*VisibilityRule

func (*Visibility) MarshalToSizedBufferVT

func (m *Visibility) MarshalToSizedBufferVT(dAtA []byte) (int, error)

func (*Visibility) MarshalToVT

func (m *Visibility) MarshalToVT(dAtA []byte) (int, error)

func (*Visibility) MarshalVT

func (m *Visibility) MarshalVT() (dAtA []byte, err error)

func (*Visibility) ProtoMessage

func (*Visibility) ProtoMessage()

func (*Visibility) ProtoReflect

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

func (*Visibility) Reset

func (x *Visibility) Reset()

func (*Visibility) SizeVT

func (m *Visibility) SizeVT() (n int)

func (*Visibility) String

func (x *Visibility) String() string

func (*Visibility) UnmarshalVT

func (m *Visibility) UnmarshalVT(dAtA []byte) error

func (*Visibility) Validate

func (m *Visibility) Validate() error

Validate checks the field values on Visibility with the rules defined in the proto definition for this message. If any rules are violated, the first error encountered is returned, or nil if there are no violations.

func (*Visibility) ValidateAll

func (m *Visibility) ValidateAll() error

ValidateAll checks the field values on Visibility with the rules defined in the proto definition for this message. If any rules are violated, the result is a list of violation errors wrapped in VisibilityMultiError, or nil if none found.

type VisibilityMultiError

type VisibilityMultiError []error

VisibilityMultiError is an error wrapping multiple validation errors returned by Visibility.ValidateAll() if the designated constraints aren't met.

func (VisibilityMultiError) AllErrors

func (m VisibilityMultiError) AllErrors() []error

AllErrors returns a list of validation violation errors.

func (VisibilityMultiError) Error

func (m VisibilityMultiError) Error() string

Error returns a concatenation of all the error messages it wraps.

type VisibilityRule

type VisibilityRule struct {

	// Selects methods, messages, fields, enums, etc. 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"`
	// A comma-separated list of visibility labels that apply to the `selector`.
	// Any of the listed labels can be used to grant the visibility.
	//
	// If a rule has multiple labels, removing one of the labels but not all of
	// them can break clients.
	//
	// Example:
	//
	//	visibility:
	//	  rules:
	//	  - selector: google.calendar.Calendar.EnhancedSearch
	//	    restriction: INTERNAL, PREVIEW
	//
	// Removing INTERNAL from this restriction will break clients that rely on
	// this method and only had access to it through INTERNAL.
	Restriction string `protobuf:"bytes,2,opt,name=restriction,proto3" json:"restriction,omitempty"`
	// contains filtered or unexported fields
}

A visibility rule provides visibility configuration for an individual API element.

func (*VisibilityRule) CloneMessageVT

func (m *VisibilityRule) CloneMessageVT() proto.Message

func (*VisibilityRule) CloneVT

func (m *VisibilityRule) CloneVT() *VisibilityRule

func (*VisibilityRule) Descriptor deprecated

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

Deprecated: Use VisibilityRule.ProtoReflect.Descriptor instead.

func (*VisibilityRule) EqualMessageVT

func (this *VisibilityRule) EqualMessageVT(thatMsg proto.Message) bool

func (*VisibilityRule) EqualVT

func (this *VisibilityRule) EqualVT(that *VisibilityRule) bool

func (*VisibilityRule) GetRestriction

func (x *VisibilityRule) GetRestriction() string

func (*VisibilityRule) GetSelector

func (x *VisibilityRule) GetSelector() string

func (*VisibilityRule) MarshalToSizedBufferVT

func (m *VisibilityRule) MarshalToSizedBufferVT(dAtA []byte) (int, error)

func (*VisibilityRule) MarshalToVT

func (m *VisibilityRule) MarshalToVT(dAtA []byte) (int, error)

func (*VisibilityRule) MarshalVT

func (m *VisibilityRule) MarshalVT() (dAtA []byte, err error)

func (*VisibilityRule) ProtoMessage

func (*VisibilityRule) ProtoMessage()

func (*VisibilityRule) ProtoReflect

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

func (*VisibilityRule) Reset

func (x *VisibilityRule) Reset()

func (*VisibilityRule) SizeVT

func (m *VisibilityRule) SizeVT() (n int)

func (*VisibilityRule) String

func (x *VisibilityRule) String() string

func (*VisibilityRule) UnmarshalVT

func (m *VisibilityRule) UnmarshalVT(dAtA []byte) error

func (*VisibilityRule) Validate

func (m *VisibilityRule) Validate() error

Validate checks the field values on VisibilityRule with the rules defined in the proto definition for this message. If any rules are violated, the first error encountered is returned, or nil if there are no violations.

func (*VisibilityRule) ValidateAll

func (m *VisibilityRule) ValidateAll() error

ValidateAll checks the field values on VisibilityRule with the rules defined in the proto definition for this message. If any rules are violated, the result is a list of violation errors wrapped in VisibilityRuleMultiError, or nil if none found.

type VisibilityRuleMultiError

type VisibilityRuleMultiError []error

VisibilityRuleMultiError is an error wrapping multiple validation errors returned by VisibilityRule.ValidateAll() if the designated constraints aren't met.

func (VisibilityRuleMultiError) AllErrors

func (m VisibilityRuleMultiError) AllErrors() []error

AllErrors returns a list of validation violation errors.

func (VisibilityRuleMultiError) Error

func (m VisibilityRuleMultiError) Error() string

Error returns a concatenation of all the error messages it wraps.

type VisibilityRuleValidationError

type VisibilityRuleValidationError struct {
	// contains filtered or unexported fields
}

VisibilityRuleValidationError is the validation error returned by VisibilityRule.Validate if the designated constraints aren't met.

func (VisibilityRuleValidationError) Cause

Cause function returns cause value.

func (VisibilityRuleValidationError) Error

Error satisfies the builtin error interface

func (VisibilityRuleValidationError) ErrorName

func (e VisibilityRuleValidationError) ErrorName() string

ErrorName returns error name.

func (VisibilityRuleValidationError) Field

Field function returns field value.

func (VisibilityRuleValidationError) Key

Key function returns key value.

func (VisibilityRuleValidationError) Reason

Reason function returns reason value.

type VisibilityValidationError

type VisibilityValidationError struct {
	// contains filtered or unexported fields
}

VisibilityValidationError is the validation error returned by Visibility.Validate if the designated constraints aren't met.

func (VisibilityValidationError) Cause

func (e VisibilityValidationError) Cause() error

Cause function returns cause value.

func (VisibilityValidationError) Error

Error satisfies the builtin error interface

func (VisibilityValidationError) ErrorName

func (e VisibilityValidationError) ErrorName() string

ErrorName returns error name.

func (VisibilityValidationError) Field

Field function returns field value.

func (VisibilityValidationError) Key

Key function returns key value.

func (VisibilityValidationError) Reason

func (e VisibilityValidationError) Reason() string

Reason function returns reason value.

Directories

Path Synopsis
expr

Jump to

Keyboard shortcuts

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