metadata

package
v0.0.0-...-3a708ea Latest Latest
Warning

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

Go to latest
Published: Apr 28, 2023 License: Apache-2.0 Imports: 4 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

View Source
var (
	Language_name = map[int32]string{
		0:  "LANGUAGE_UNSPECIFIED",
		1:  "C_PLUS_PLUS",
		2:  "C_SHARP",
		3:  "DART",
		4:  "ELIXIR",
		5:  "ERLANG",
		6:  "F_SHARP",
		7:  "GO",
		8:  "JAVA",
		9:  "JAVASCRIPT",
		10: "KOTLIN",
		11: "PHP",
		12: "PYTHON",
		13: "RUBY",
		14: "RUST",
		15: "SWIFT",
		16: "TYPESCRIPT",
		17: "VB_NET",
	}
	Language_value = map[string]int32{
		"LANGUAGE_UNSPECIFIED": 0,
		"C_PLUS_PLUS":          1,
		"C_SHARP":              2,
		"DART":                 3,
		"ELIXIR":               4,
		"ERLANG":               5,
		"F_SHARP":              6,
		"GO":                   7,
		"JAVA":                 8,
		"JAVASCRIPT":           9,
		"KOTLIN":               10,
		"PHP":                  11,
		"PYTHON":               12,
		"RUBY":                 13,
		"RUST":                 14,
		"SWIFT":                15,
		"TYPESCRIPT":           16,
		"VB_NET":               17,
	}
)

Enum value maps for Language.

View Source
var (
	Snippet_Origin_name = map[int32]string{
		0: "ORIGIN_UNSPECIFIED",
		1: "API_DEFINITION",
		2: "CONFIG",
		3: "HANDWRITTEN",
	}
	Snippet_Origin_value = map[string]int32{
		"ORIGIN_UNSPECIFIED": 0,
		"API_DEFINITION":     1,
		"CONFIG":             2,
		"HANDWRITTEN":        3,
	}
)

Enum value maps for Snippet_Origin.

View Source
var (
	Snippet_Segment_SegmentType_name = map[int32]string{
		0: "SEGMENT_TYPE_UNSPECIFIED",
		1: "FULL",
		2: "SHORT",
		3: "CLIENT_INITIALIZATION",
		4: "REQUEST_INITIALIZATION",
		5: "REQUEST_EXECUTION",
		6: "RESPONSE_HANDLING",
	}
	Snippet_Segment_SegmentType_value = map[string]int32{
		"SEGMENT_TYPE_UNSPECIFIED": 0,
		"FULL":                     1,
		"SHORT":                    2,
		"CLIENT_INITIALIZATION":    3,
		"REQUEST_INITIALIZATION":   4,
		"REQUEST_EXECUTION":        5,
		"RESPONSE_HANDLING":        6,
	}
)

Enum value maps for Snippet_Segment_SegmentType.

View Source
var File_metadata_metadata_proto protoreflect.FileDescriptor

Functions

This section is empty.

Types

type Api

type Api struct {

	// The ID of the API, identical to the protobuf package
	// ending with a version number.
	// Example: "google.cloud.translate.v3"
	Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
	// The full version inferred from the end of the ID.
	// Examples: "v3", "v2beta1", "v1beta"
	Version string `protobuf:"bytes,2,opt,name=version,proto3" json:"version,omitempty"`
	// contains filtered or unexported fields
}

An API

func (*Api) Descriptor deprecated

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

Deprecated: Use Api.ProtoReflect.Descriptor instead.

func (*Api) GetId

func (x *Api) GetId() string

func (*Api) GetVersion

func (x *Api) GetVersion() string

func (*Api) ProtoMessage

func (*Api) ProtoMessage()

func (*Api) ProtoReflect

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

func (*Api) Reset

func (x *Api) Reset()

func (*Api) String

func (x *Api) String() string

type ClientLibrary

type ClientLibrary struct {

	// The name of the client library. This value will be language dependent
	// and may or may not include the library version.
	// Usually this will be the name used to identify the library on per-language
	// package managers.
	// Examples: "Google.Cloud.Translate.V3",
	// "cloud.google.com/go/translate/apiv3".
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// The full version of the client library. May also be language dependent.
	// Cannot be updated on metadata generation, but on library release.
	// Examples: "4.3.0", "2.5.2-beta01"
	Version string `protobuf:"bytes,2,opt,name=version,proto3" json:"version,omitempty"`
	// The programming language the library is written in.
	// Note that this does not contain information about the library supported
	// platforms or language versions, etc. This is just a quick way to identify
	// the generally supported langauge.
	Language Language `` /* 130-byte string literal not displayed */
	// The APIs this client library is for.
	// Some languages bundle several APIs on the same client library.
	Apis []*Api `protobuf:"bytes,4,rep,name=apis,proto3" json:"apis,omitempty"`
	// contains filtered or unexported fields
}

A client library. Will contain language specific information.

func (*ClientLibrary) Descriptor deprecated

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

Deprecated: Use ClientLibrary.ProtoReflect.Descriptor instead.

func (*ClientLibrary) GetApis

func (x *ClientLibrary) GetApis() []*Api

func (*ClientLibrary) GetLanguage

func (x *ClientLibrary) GetLanguage() Language

func (*ClientLibrary) GetName

func (x *ClientLibrary) GetName() string

func (*ClientLibrary) GetVersion

func (x *ClientLibrary) GetVersion() string

func (*ClientLibrary) ProtoMessage

func (*ClientLibrary) ProtoMessage()

func (*ClientLibrary) ProtoReflect

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

func (*ClientLibrary) Reset

func (x *ClientLibrary) Reset()

func (*ClientLibrary) String

func (x *ClientLibrary) String() string

type ClientMethod

type ClientMethod struct {

	// The short name of the method, usually the name it is declared with.
	// This may not be unique within the service client because of overloads.
	ShortName string `protobuf:"bytes,1,opt,name=short_name,json=shortName,proto3" json:"short_name,omitempty"`
	// The fully qualified name of the method, which is the short_name qualified
	// by the full_name of the service client.
	// This value is redundant, but present to make it easier for consumers to
	// obtain it.
	// This may not be unique within the service client because of overloads.
	FullName string `protobuf:"bytes,2,opt,name=full_name,json=fullName,proto3" json:"full_name,omitempty"`
	// Indicates wether this method is synchronous or asynchronous.
	// Some languages may support only one of the variants, in which case, this
	// field will always have the same value (for that language).
	Async bool `protobuf:"varint,3,opt,name=async,proto3" json:"async,omitempty"`
	// Parameters of this method in the same order as they appear on the method
	// declaration. Must be empty if the method has no parameters.
	Parameters []*ClientMethod_Parameter `protobuf:"bytes,4,rep,name=parameters,proto3" json:"parameters,omitempty"`
	// Fully qualified type name of this method result, if any.
	ResultType string `protobuf:"bytes,5,opt,name=result_type,json=resultType,proto3" json:"result_type,omitempty"`
	// The service client this method is declared in.
	Client *ServiceClient `protobuf:"bytes,6,opt,name=client,proto3" json:"client,omitempty"`
	// The service method this client method is for.
	Method *Method `protobuf:"bytes,7,opt,name=method,proto3" json:"method,omitempty"`
	// contains filtered or unexported fields
}

A client library method. Will contain language specific information.

func (*ClientMethod) Descriptor deprecated

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

Deprecated: Use ClientMethod.ProtoReflect.Descriptor instead.

func (*ClientMethod) GetAsync

func (x *ClientMethod) GetAsync() bool

func (*ClientMethod) GetClient

func (x *ClientMethod) GetClient() *ServiceClient

func (*ClientMethod) GetFullName

func (x *ClientMethod) GetFullName() string

func (*ClientMethod) GetMethod

func (x *ClientMethod) GetMethod() *Method

func (*ClientMethod) GetParameters

func (x *ClientMethod) GetParameters() []*ClientMethod_Parameter

func (*ClientMethod) GetResultType

func (x *ClientMethod) GetResultType() string

func (*ClientMethod) GetShortName

func (x *ClientMethod) GetShortName() string

func (*ClientMethod) ProtoMessage

func (*ClientMethod) ProtoMessage()

func (*ClientMethod) ProtoReflect

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

func (*ClientMethod) Reset

func (x *ClientMethod) Reset()

func (*ClientMethod) String

func (x *ClientMethod) String() string

type ClientMethod_Parameter

type ClientMethod_Parameter struct {

	// Fully qualified type name of this parameter.
	// May be empty for languages that don't specify a type.
	Type string `protobuf:"bytes,1,opt,name=type,proto3" json:"type,omitempty"`
	// Name of the parameter as it appears on the method declaration.
	Name string `protobuf:"bytes,2,opt,name=name,proto3" json:"name,omitempty"`
	// contains filtered or unexported fields
}

A method parameter as described by its type and name.

func (*ClientMethod_Parameter) Descriptor deprecated

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

Deprecated: Use ClientMethod_Parameter.ProtoReflect.Descriptor instead.

func (*ClientMethod_Parameter) GetName

func (x *ClientMethod_Parameter) GetName() string

func (*ClientMethod_Parameter) GetType

func (x *ClientMethod_Parameter) GetType() string

func (*ClientMethod_Parameter) ProtoMessage

func (*ClientMethod_Parameter) ProtoMessage()

func (*ClientMethod_Parameter) ProtoReflect

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

func (*ClientMethod_Parameter) Reset

func (x *ClientMethod_Parameter) Reset()

func (*ClientMethod_Parameter) String

func (x *ClientMethod_Parameter) String() string

type Index

type Index struct {

	// The Client Library these snippets are for.
	ClientLibrary *ClientLibrary `protobuf:"bytes,1,opt,name=client_library,json=clientLibrary,proto3" json:"client_library,omitempty"`
	// The list of snippets.
	Snippets []*Snippet `protobuf:"bytes,2,rep,name=snippets,proto3" json:"snippets,omitempty"`
	// contains filtered or unexported fields
}

The snippet index for a single client library.

func (*Index) Descriptor deprecated

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

Deprecated: Use Index.ProtoReflect.Descriptor instead.

func (*Index) GetClientLibrary

func (x *Index) GetClientLibrary() *ClientLibrary

func (*Index) GetSnippets

func (x *Index) GetSnippets() []*Snippet

func (*Index) ProtoMessage

func (*Index) ProtoMessage()

func (*Index) ProtoReflect

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

func (*Index) Reset

func (x *Index) Reset()

func (*Index) String

func (x *Index) String() string

type Language

type Language int32

A programming language

const (
	// The language has not been specified. Consumers should not see this value.
	Language_LANGUAGE_UNSPECIFIED Language = 0
	Language_C_PLUS_PLUS          Language = 1
	Language_C_SHARP              Language = 2
	Language_DART                 Language = 3
	Language_ELIXIR               Language = 4
	Language_ERLANG               Language = 5
	Language_F_SHARP              Language = 6
	Language_GO                   Language = 7
	Language_JAVA                 Language = 8
	Language_JAVASCRIPT           Language = 9
	Language_KOTLIN               Language = 10
	Language_PHP                  Language = 11
	Language_PYTHON               Language = 12
	Language_RUBY                 Language = 13
	Language_RUST                 Language = 14
	Language_SWIFT                Language = 15
	Language_TYPESCRIPT           Language = 16
	Language_VB_NET               Language = 17
)

func (Language) Descriptor

func (Language) Descriptor() protoreflect.EnumDescriptor

func (Language) Enum

func (x Language) Enum() *Language

func (Language) EnumDescriptor deprecated

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

Deprecated: Use Language.Descriptor instead.

func (Language) Number

func (x Language) Number() protoreflect.EnumNumber

func (Language) String

func (x Language) String() string

func (Language) Type

type Method

type Method struct {

	// The short name of the method, which is the name used to
	// declare it within the proto file. This is unique within the service,
	// but may not be unique within the API.
	ShortName string `protobuf:"bytes,1,opt,name=short_name,json=shortName,proto3" json:"short_name,omitempty"`
	// The full name of the method, which is the short name qualified
	// by the full name of the service in which it is declared.
	// This is globally unique.
	FullName string `protobuf:"bytes,2,opt,name=full_name,json=fullName,proto3" json:"full_name,omitempty"`
	// The service this method is declared in.
	Service *Service `protobuf:"bytes,3,opt,name=service,proto3" json:"service,omitempty"`
	// contains filtered or unexported fields
}

func (*Method) Descriptor deprecated

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

Deprecated: Use Method.ProtoReflect.Descriptor instead.

func (*Method) GetFullName

func (x *Method) GetFullName() string

func (*Method) GetService

func (x *Method) GetService() *Service

func (*Method) GetShortName

func (x *Method) GetShortName() string

func (*Method) ProtoMessage

func (*Method) ProtoMessage()

func (*Method) ProtoReflect

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

func (*Method) Reset

func (x *Method) Reset()

func (*Method) String

func (x *Method) String() string

type Service

type Service struct {

	// The short name of the service, which is the name used to
	// declare it within the proto file. This is usually, but not
	// absolutely necessarily, unique within an API.
	// Example: "TranslationService"
	ShortName string `protobuf:"bytes,1,opt,name=short_name,json=shortName,proto3" json:"short_name,omitempty"`
	// The full name of the service, which is the short name qualified
	// by the package of the proto in which it is declared.
	// This is globally unique.
	// Example: "google.cloud.translate.v3.TranslationService"
	FullName string `protobuf:"bytes,2,opt,name=full_name,json=fullName,proto3" json:"full_name,omitempty"`
	// contains filtered or unexported fields
}

A service defined in the API the client library referenced in Index is for.

func (*Service) Descriptor deprecated

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

Deprecated: Use Service.ProtoReflect.Descriptor instead.

func (*Service) GetFullName

func (x *Service) GetFullName() string

func (*Service) GetShortName

func (x *Service) GetShortName() string

func (*Service) ProtoMessage

func (*Service) ProtoMessage()

func (*Service) ProtoReflect

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

func (*Service) Reset

func (x *Service) Reset()

func (*Service) String

func (x *Service) String() string

type ServiceClient

type ServiceClient struct {

	// The short name of the service client, usually the name it is declared with.
	// This may not be unique within the client library because of
	// namespaces/packages.
	ShortName string `protobuf:"bytes,1,opt,name=short_name,json=shortName,proto3" json:"short_name,omitempty"`
	// The fully qualified name of the service client, which is the short_name
	// qualified by the namespace/package/type name this client is declared in.
	// This will be unique within the client libray.
	FullName string `protobuf:"bytes,2,opt,name=full_name,json=fullName,proto3" json:"full_name,omitempty"`
	// contains filtered or unexported fields
}

A service client defined in the client library specified in Index. Will contain language specific information.

func (*ServiceClient) Descriptor deprecated

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

Deprecated: Use ServiceClient.ProtoReflect.Descriptor instead.

func (*ServiceClient) GetFullName

func (x *ServiceClient) GetFullName() string

func (*ServiceClient) GetShortName

func (x *ServiceClient) GetShortName() string

func (*ServiceClient) ProtoMessage

func (*ServiceClient) ProtoMessage()

func (*ServiceClient) ProtoReflect

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

func (*ServiceClient) Reset

func (x *ServiceClient) Reset()

func (*ServiceClient) String

func (x *ServiceClient) String() string

type Snippet

type Snippet struct {

	// The region tag name. Does not include the square brackets or the START or
	// END indicators.
	RegionTag string `protobuf:"bytes,1,opt,name=region_tag,json=regionTag,proto3" json:"region_tag,omitempty"`
	// The title of the snippet, for human consumption mostly. For generated
	// snippets this may be the snippet method or file name, or obtained from
	/// snippet configuration.
	Title string `protobuf:"bytes,2,opt,name=title,proto3" json:"title,omitempty"`
	// A description of the snippet, for human consumption mostly. For generated
	// snippets this may be the description of the service method, or obtained
	// from snippet configuration.
	Description string `protobuf:"bytes,3,opt,name=description,proto3" json:"description,omitempty"`
	// The file where the snippet code lives.
	// The path should be relative to where this metadata file is stored on the
	// GitHub repo root and should not include branch, tag, commitish, etc.,
	// as those will be the same as for the metadata file.
	File string `protobuf:"bytes,4,opt,name=file,proto3" json:"file,omitempty"`
	// The programming language the snippet is written in.
	// This will match the client library language most of the time, but not
	// always. For instance, in .NET, libraries are written in C# but some samples
	// may be written in F# or VB .NET.
	// Note that this does not contain information about the snippet supported
	// platforms or language versions, etc. This is just a quick way to identify
	// the generally supported langauge.
	Language Language `` /* 130-byte string literal not displayed */
	// The client library method this snippet is for.
	ClientMethod *ClientMethod `protobuf:"bytes,6,opt,name=client_method,json=clientMethod,proto3" json:"client_method,omitempty"`
	// Wether this is the canonical snippet for the corresponding service method.
	// This is to be interpreted in conjunction with origin as follows:
	// For a given service method:
	// - A handwritten canonical takes precedence over
	// - A config canonical which in turn takes precedence over
	// - A baseline canonical.
	Canonical bool `protobuf:"varint,7,opt,name=canonical,proto3" json:"canonical,omitempty"`
	// The origin of the snippet.
	Origin Snippet_Origin `` /* 132-byte string literal not displayed */
	// The different segments of the snippet.
	// Must contain the FULL segment always.
	// There may be overlap between segments.
	Segments []*Snippet_Segment `protobuf:"bytes,9,rep,name=segments,proto3" json:"segments,omitempty"`
	// contains filtered or unexported fields
}

One sample. Parts of this information will be language specific.

func (*Snippet) Descriptor deprecated

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

Deprecated: Use Snippet.ProtoReflect.Descriptor instead.

func (*Snippet) GetCanonical

func (x *Snippet) GetCanonical() bool

func (*Snippet) GetClientMethod

func (x *Snippet) GetClientMethod() *ClientMethod

func (*Snippet) GetDescription

func (x *Snippet) GetDescription() string

func (*Snippet) GetFile

func (x *Snippet) GetFile() string

func (*Snippet) GetLanguage

func (x *Snippet) GetLanguage() Language

func (*Snippet) GetOrigin

func (x *Snippet) GetOrigin() Snippet_Origin

func (*Snippet) GetRegionTag

func (x *Snippet) GetRegionTag() string

func (*Snippet) GetSegments

func (x *Snippet) GetSegments() []*Snippet_Segment

func (*Snippet) GetTitle

func (x *Snippet) GetTitle() string

func (*Snippet) ProtoMessage

func (*Snippet) ProtoMessage()

func (*Snippet) ProtoReflect

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

func (*Snippet) Reset

func (x *Snippet) Reset()

func (*Snippet) String

func (x *Snippet) String() string

type Snippet_Origin

type Snippet_Origin int32

The origin of the snippet.

const (
	// The origin has not been specified. Consumers should not see this value.
	Snippet_ORIGIN_UNSPECIFIED Snippet_Origin = 0
	// The snippet is generated from the API definition only, including protos
	// and descriptive information, i.e. the same information used to generate
	// the client libraries themselves.
	// No snippet configuration has been specified. This refers to SnippetGen
	// phase 1.
	Snippet_API_DEFINITION Snippet_Origin = 1
	// The snippet is generated from the API definition and a specific snippet
	// configuration. This refers to SnippetGen phase 2.
	Snippet_CONFIG Snippet_Origin = 2
	// The snippet is handwritten.
	Snippet_HANDWRITTEN Snippet_Origin = 3
)

func (Snippet_Origin) Descriptor

func (Snippet_Origin) Enum

func (x Snippet_Origin) Enum() *Snippet_Origin

func (Snippet_Origin) EnumDescriptor deprecated

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

Deprecated: Use Snippet_Origin.Descriptor instead.

func (Snippet_Origin) Number

func (Snippet_Origin) String

func (x Snippet_Origin) String() string

func (Snippet_Origin) Type

type Snippet_Segment

type Snippet_Segment struct {

	// The line where this segment begins, inclusive.
	// For the FULL segment, this will be the START region tag line + 1.
	Start int32 `protobuf:"varint,1,opt,name=start,proto3" json:"start,omitempty"`
	// The line where this segment ends, inclusive.
	// For the FULL segment, this will be the END region tag line - 1.
	End int32 `protobuf:"varint,2,opt,name=end,proto3" json:"end,omitempty"`
	// The type of the segment.
	Type Snippet_Segment_SegmentType `` /* 141-byte string literal not displayed */
	// contains filtered or unexported fields
}

A segment of the snippet.

func (*Snippet_Segment) Descriptor deprecated

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

Deprecated: Use Snippet_Segment.ProtoReflect.Descriptor instead.

func (*Snippet_Segment) GetEnd

func (x *Snippet_Segment) GetEnd() int32

func (*Snippet_Segment) GetStart

func (x *Snippet_Segment) GetStart() int32

func (*Snippet_Segment) GetType

func (*Snippet_Segment) ProtoMessage

func (*Snippet_Segment) ProtoMessage()

func (*Snippet_Segment) ProtoReflect

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

func (*Snippet_Segment) Reset

func (x *Snippet_Segment) Reset()

func (*Snippet_Segment) String

func (x *Snippet_Segment) String() string

type Snippet_Segment_SegmentType

type Snippet_Segment_SegmentType int32

The type of the segment. Basically describes what this segment shows.

const (
	// The segment type has not been specified. Consumers should not see this
	// value.
	Snippet_Segment_SEGMENT_TYPE_UNSPECIFIED Snippet_Segment_SegmentType = 0
	// The full sample including import statements.
	// This corresponds to the sample as determined by the region tags.
	Snippet_Segment_FULL Snippet_Segment_SegmentType = 1
	// A shorter version of the full sample, may not include imports and some
	// langauge specific initialization code. This is to be used in contexts
	// in which the full aspects of the sample are made clear outside the
	// code.
	Snippet_Segment_SHORT Snippet_Segment_SegmentType = 2
	// The segment contains the service client initialization code only.
	// To be used in tutorials, codelabs, etc.
	Snippet_Segment_CLIENT_INITIALIZATION Snippet_Segment_SegmentType = 3
	// The segment contains the request initialization code only.
	// To be used in tutorials, codelabs, etc.
	Snippet_Segment_REQUEST_INITIALIZATION Snippet_Segment_SegmentType = 4
	// The segment contains the request execution code only.
	// To be used in tutorials, codelabs, etc.
	Snippet_Segment_REQUEST_EXECUTION Snippet_Segment_SegmentType = 5
	// The segment contains the response handling code only.
	// To be used in tutorials, codelabs, etc.
	Snippet_Segment_RESPONSE_HANDLING Snippet_Segment_SegmentType = 6
)

func (Snippet_Segment_SegmentType) Descriptor

func (Snippet_Segment_SegmentType) Enum

func (Snippet_Segment_SegmentType) EnumDescriptor deprecated

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

Deprecated: Use Snippet_Segment_SegmentType.Descriptor instead.

func (Snippet_Segment_SegmentType) Number

func (Snippet_Segment_SegmentType) String

func (Snippet_Segment_SegmentType) Type

Jump to

Keyboard shortcuts

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