apihub

package
v0.6.16 Latest Latest
Warning

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

 Go to latest Published: Oct 16, 2023 License: Apache-2.0 Imports: 5 Imported by: 6

Documentation

Index

Constants

This section is empty.

Variables

View Source 
var File_google_cloud_apigeeregistry_v1_apihub_display_settings_proto protoreflect.FileDescriptor
View Source 
var File_google_cloud_apigeeregistry_v1_apihub_extensions_proto protoreflect.FileDescriptor
View Source 
var File_google_cloud_apigeeregistry_v1_apihub_fields_proto protoreflect.FileDescriptor
View Source 
var File_google_cloud_apigeeregistry_v1_apihub_lifecycle_proto protoreflect.FileDescriptor
View Source 
var File_google_cloud_apigeeregistry_v1_apihub_references_proto protoreflect.FileDescriptor
View Source 
var File_google_cloud_apigeeregistry_v1_apihub_taxonomies_proto protoreflect.FileDescriptor

Functions

This section is empty.

Types

type ApiSpecExtensionList 

type ApiSpecExtensionList struct {

	// Artifact identifier. May be used in YAML representations to indicate the id
	// to be used to attach the artifact.
	Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
	// Artifact kind. May be used in YAML representations to identify the type of
	// this artifact.
	Kind string `protobuf:"bytes,2,opt,name=kind,proto3" json:"kind,omitempty"`
	// A human-friendly name for the ApiSpecExtension list.
	DisplayName string `protobuf:"bytes,3,opt,name=display_name,json=displayName,proto3" json:"display_name,omitempty"`
	// A more detailed description of the ApiSpecExtension list.
	Description string `protobuf:"bytes,4,opt,name=description,proto3" json:"description,omitempty"`
	// The extensions in the list
	Extensions []*ApiSpecExtensionList_ApiSpecExtension `protobuf:"bytes,5,rep,name=extensions,proto3" json:"extensions,omitempty"`
	// contains filtered or unexported fields
}

An ApiSpecExtensionList contains a list of extensions applicable to specs stored in the registry ApiSpecExtensionList is stored as an Artifact attached to a project.

func (*ApiSpecExtensionList) Descriptor deprecated 

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

Deprecated: Use ApiSpecExtensionList.ProtoReflect.Descriptor instead.

func (*ApiSpecExtensionList) GetDescription 

func (x *ApiSpecExtensionList) GetDescription() string

func (*ApiSpecExtensionList) GetDisplayName 

func (x *ApiSpecExtensionList) GetDisplayName() string

func (*ApiSpecExtensionList) GetExtensions 

func (x *ApiSpecExtensionList) GetExtensions() []*ApiSpecExtensionList_ApiSpecExtension

func (*ApiSpecExtensionList) GetId 

func (x *ApiSpecExtensionList) GetId() string

func (*ApiSpecExtensionList) GetKind 

func (x *ApiSpecExtensionList) GetKind() string

func (*ApiSpecExtensionList) ProtoMessage 

func (*ApiSpecExtensionList) ProtoMessage()

func (*ApiSpecExtensionList) ProtoReflect 

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

func (*ApiSpecExtensionList) Reset 

func (x *ApiSpecExtensionList) Reset()

func (*ApiSpecExtensionList) String 

func (x *ApiSpecExtensionList) String() string

type ApiSpecExtensionList_ApiSpecExtension 

type ApiSpecExtensionList_ApiSpecExtension struct {

	// The id of the Extension
	Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
	// A human-friendly name for the extension
	DisplayName string `protobuf:"bytes,2,opt,name=display_name,json=displayName,proto3" json:"display_name,omitempty"`
	// A more detailed description of the extension
	Description string `protobuf:"bytes,3,opt,name=description,proto3" json:"description,omitempty"`
	// A filter expression which evaluates if the extension applies to a spec
	// e.g. mime_type.contains('openapi')
	Filter string `protobuf:"bytes,4,opt,name=filter,proto3" json:"filter,omitempty"`
	// A uri pattern used to generate the target url
	UriPattern string `protobuf:"bytes,5,opt,name=uri_pattern,json=uriPattern,proto3" json:"uri_pattern,omitempty"`
	// contains filtered or unexported fields
}

Represents a single Extension for an ApiSpec

func (*ApiSpecExtensionList_ApiSpecExtension) Descriptor deprecated 

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

Deprecated: Use ApiSpecExtensionList_ApiSpecExtension.ProtoReflect.Descriptor instead.

func (*ApiSpecExtensionList_ApiSpecExtension) GetDescription 

func (x *ApiSpecExtensionList_ApiSpecExtension) GetDescription() string

func (*ApiSpecExtensionList_ApiSpecExtension) GetDisplayName 

func (x *ApiSpecExtensionList_ApiSpecExtension) GetDisplayName() string

func (*ApiSpecExtensionList_ApiSpecExtension) GetFilter 

func (x *ApiSpecExtensionList_ApiSpecExtension) GetFilter() string

func (*ApiSpecExtensionList_ApiSpecExtension) GetId 

func (x *ApiSpecExtensionList_ApiSpecExtension) GetId() string

func (*ApiSpecExtensionList_ApiSpecExtension) GetUriPattern 

func (x *ApiSpecExtensionList_ApiSpecExtension) GetUriPattern() string

func (*ApiSpecExtensionList_ApiSpecExtension) ProtoMessage 

func (*ApiSpecExtensionList_ApiSpecExtension) ProtoMessage()

func (*ApiSpecExtensionList_ApiSpecExtension) ProtoReflect 

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

func (*ApiSpecExtensionList_ApiSpecExtension) Reset 

func (x *ApiSpecExtensionList_ApiSpecExtension) Reset()

func (*ApiSpecExtensionList_ApiSpecExtension) String 

func (x *ApiSpecExtensionList_ApiSpecExtension) String() string

type DisplaySettings 

type DisplaySettings struct {

	// Artifact identifier. May be used in YAML representations to indicate the id
	// to be used to attach the artifact.
	Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
	// Artifact kind. May be used in YAML representations to identify the type of
	// this artifact.
	Kind string `protobuf:"bytes,2,opt,name=kind,proto3" json:"kind,omitempty"`
	// A more detailed description of the display settings.
	Description string `protobuf:"bytes,3,opt,name=description,proto3" json:"description,omitempty"`
	// The organization name. Displayed in areas throughout the API hub UI to
	// identify APIs owned by the user's organization.
	Organization string `protobuf:"bytes,4,opt,name=organization,proto3" json:"organization,omitempty"`
	// If true the API guide tab will be displayed in the API detail page; if
	// false, it will be hidden
	ApiGuideEnabled bool `protobuf:"varint,5,opt,name=api_guide_enabled,json=apiGuideEnabled,proto3" json:"api_guide_enabled,omitempty"`
	// If true the API scores will be displayed on the API list page and API
	// detail page; if false, they will be hidden
	ApiScoreEnabled bool `protobuf:"varint,6,opt,name=api_score_enabled,json=apiScoreEnabled,proto3" json:"api_score_enabled,omitempty"`
	// contains filtered or unexported fields
}

Defines display settings for the API hub UI.

func (*DisplaySettings) Descriptor deprecated 

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

Deprecated: Use DisplaySettings.ProtoReflect.Descriptor instead.

func (*DisplaySettings) GetApiGuideEnabled 

func (x *DisplaySettings) GetApiGuideEnabled() bool

func (*DisplaySettings) GetApiScoreEnabled 

func (x *DisplaySettings) GetApiScoreEnabled() bool

func (*DisplaySettings) GetDescription 

func (x *DisplaySettings) GetDescription() string

func (*DisplaySettings) GetId 

func (x *DisplaySettings) GetId() string

func (*DisplaySettings) GetKind 

func (x *DisplaySettings) GetKind() string

func (*DisplaySettings) GetOrganization 

func (x *DisplaySettings) GetOrganization() string

func (*DisplaySettings) ProtoMessage 

func (*DisplaySettings) ProtoMessage()

func (*DisplaySettings) ProtoReflect 

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

func (*DisplaySettings) Reset 

func (x *DisplaySettings) Reset()

func (*DisplaySettings) String 

func (x *DisplaySettings) String() string

type FieldDefinition added in v0.6.6 

type FieldDefinition struct {

	// The id of the field, used as a key in the fields map.
	Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
	// The display_name of the field, used when the field is displayed.
	DisplayName string `protobuf:"bytes,2,opt,name=display_name,json=displayName,proto3" json:"display_name,omitempty"`
	// A description of the field, possibly displayable as a tooltip.
	Description string `protobuf:"bytes,3,opt,name=description,proto3" json:"description,omitempty"`
	// Optional string specifying the field format.
	// Currently applications are free to define values,
	// but we expect to formalize values for this in the future.
	Format string `protobuf:"bytes,4,opt,name=format,proto3" json:"format,omitempty"`
	// Optional list of allowed values for the field.
	AllowedValues []string `protobuf:"bytes,5,rep,name=allowed_values,json=allowedValues,proto3" json:"allowed_values,omitempty"`
	// contains filtered or unexported fields
}

func (*FieldDefinition) Descriptor deprecated added in v0.6.6 

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

Deprecated: Use FieldDefinition.ProtoReflect.Descriptor instead.

func (*FieldDefinition) GetAllowedValues added in v0.6.6 

func (x *FieldDefinition) GetAllowedValues() []string

func (*FieldDefinition) GetDescription added in v0.6.6 

func (x *FieldDefinition) GetDescription() string

func (*FieldDefinition) GetDisplayName added in v0.6.6 

func (x *FieldDefinition) GetDisplayName() string

func (*FieldDefinition) GetFormat added in v0.6.6 

func (x *FieldDefinition) GetFormat() string

func (*FieldDefinition) GetId added in v0.6.6 

func (x *FieldDefinition) GetId() string

func (*FieldDefinition) ProtoMessage added in v0.6.6 

func (*FieldDefinition) ProtoMessage()

func (*FieldDefinition) ProtoReflect added in v0.6.6 

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

func (*FieldDefinition) Reset added in v0.6.6 

func (x *FieldDefinition) Reset()

func (*FieldDefinition) String added in v0.6.6 

func (x *FieldDefinition) String() string

type FieldSet added in v0.6.6 

type FieldSet struct {

	// Artifact identifier. May be used in YAML representations to indicate the id
	// to be used to attach the artifact.
	Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
	// Artifact kind. May be used in YAML representations to identify the type of
	// this artifact.
	Kind string `protobuf:"bytes,2,opt,name=kind,proto3" json:"kind,omitempty"`
	// Full resource name of an FieldSetDefinition artifact that
	// describes this field set.
	DefinitionName string `protobuf:"bytes,3,opt,name=definition_name,json=definitionName,proto3" json:"definition_name,omitempty"`
	// The field values, stored using field ids as keys.
	Values map[string]string `` /* 153-byte string literal not displayed */
	// contains filtered or unexported fields
}

Defines a structure for general field storage.

func (*FieldSet) Descriptor deprecated added in v0.6.6 

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

Deprecated: Use FieldSet.ProtoReflect.Descriptor instead.

func (*FieldSet) GetDefinitionName added in v0.6.6 

func (x *FieldSet) GetDefinitionName() string

func (*FieldSet) GetId added in v0.6.6 

func (x *FieldSet) GetId() string

func (*FieldSet) GetKind added in v0.6.6 

func (x *FieldSet) GetKind() string

func (*FieldSet) GetValues added in v0.6.6 

func (x *FieldSet) GetValues() map[string]string

func (*FieldSet) ProtoMessage added in v0.6.6 

func (*FieldSet) ProtoMessage()

func (*FieldSet) ProtoReflect added in v0.6.6 

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

func (*FieldSet) Reset added in v0.6.6 

func (x *FieldSet) Reset()

func (*FieldSet) String added in v0.6.6 

func (x *FieldSet) String() string

type FieldSetDefinition added in v0.6.6 

type FieldSetDefinition struct {

	// Artifact identifier. May be used in YAML representations to indicate the id
	// to be used to attach the artifact.
	Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
	// Artifact kind. May be used in YAML representations to identify the type of
	// this artifact.
	Kind string `protobuf:"bytes,2,opt,name=kind,proto3" json:"kind,omitempty"`
	// A short displayable name for the field set definition.
	DisplayName string `protobuf:"bytes,3,opt,name=display_name,json=displayName,proto3" json:"display_name,omitempty"`
	// A description of the field set being defined.
	Description string `protobuf:"bytes,4,opt,name=description,proto3" json:"description,omitempty"`
	// The field definitions
	Fields []*FieldDefinition `protobuf:"bytes,5,rep,name=fields,proto3" json:"fields,omitempty"`
	// contains filtered or unexported fields
}

func (*FieldSetDefinition) Descriptor deprecated added in v0.6.6 

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

Deprecated: Use FieldSetDefinition.ProtoReflect.Descriptor instead.

func (*FieldSetDefinition) GetDescription added in v0.6.6 

func (x *FieldSetDefinition) GetDescription() string

func (*FieldSetDefinition) GetDisplayName added in v0.6.6 

func (x *FieldSetDefinition) GetDisplayName() string

func (*FieldSetDefinition) GetFields added in v0.6.6 

func (x *FieldSetDefinition) GetFields() []*FieldDefinition

func (*FieldSetDefinition) GetId added in v0.6.6 

func (x *FieldSetDefinition) GetId() string

func (*FieldSetDefinition) GetKind added in v0.6.6 

func (x *FieldSetDefinition) GetKind() string

func (*FieldSetDefinition) ProtoMessage added in v0.6.6 

func (*FieldSetDefinition) ProtoMessage()

func (*FieldSetDefinition) ProtoReflect added in v0.6.6 

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

func (*FieldSetDefinition) Reset added in v0.6.6 

func (x *FieldSetDefinition) Reset()

func (*FieldSetDefinition) String added in v0.6.6 

func (x *FieldSetDefinition) String() string

type Lifecycle 

type Lifecycle struct {

	// Artifact identifier. May be used in YAML representations to indicate the id
	// to be used to attach the artifact.
	Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
	// Artifact kind. May be used in YAML representations to identify the type of
	// this artifact.
	Kind string `protobuf:"bytes,2,opt,name=kind,proto3" json:"kind,omitempty"`
	// A human-friendly name for the lifecycle.
	DisplayName string `protobuf:"bytes,3,opt,name=display_name,json=displayName,proto3" json:"display_name,omitempty"`
	// A more detailed description of the lifecycle.
	Description string `protobuf:"bytes,4,opt,name=description,proto3" json:"description,omitempty"`
	// The stages of an API lifecycle.
	Stages []*Lifecycle_Stage `protobuf:"bytes,5,rep,name=stages,proto3" json:"stages,omitempty"`
	// contains filtered or unexported fields
}

A lifecycle represents a series of stages that an API typically moves through in its lifetime. Lifecycles are usually organization-specific, so rather than force a fixed set of stages, we allow them to be specified in this project- level artifact.

func (*Lifecycle) Descriptor deprecated 

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

Deprecated: Use Lifecycle.ProtoReflect.Descriptor instead.

func (*Lifecycle) GetDescription 

func (x *Lifecycle) GetDescription() string

func (*Lifecycle) GetDisplayName 

func (x *Lifecycle) GetDisplayName() string

func (*Lifecycle) GetId 

func (x *Lifecycle) GetId() string

func (*Lifecycle) GetKind 

func (x *Lifecycle) GetKind() string

func (*Lifecycle) GetStages 

func (x *Lifecycle) GetStages() []*Lifecycle_Stage

func (*Lifecycle) ProtoMessage 

func (*Lifecycle) ProtoMessage()

func (*Lifecycle) ProtoReflect 

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

func (*Lifecycle) Reset 

func (x *Lifecycle) Reset()

func (*Lifecycle) String 

func (x *Lifecycle) String() string

type Lifecycle_Stage 

type Lifecycle_Stage struct {

	// Lifecycle stage identifier.
	Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
	// A human-friendly name of the lifecycle stage.
	DisplayName string `protobuf:"bytes,2,opt,name=display_name,json=displayName,proto3" json:"display_name,omitempty"`
	// A detailed description of the lifecycle stage.
	Description string `protobuf:"bytes,3,opt,name=description,proto3" json:"description,omitempty"`
	// An optional link to more information about the lifecycle stage.
	Url string `protobuf:"bytes,4,opt,name=url,proto3" json:"url,omitempty"`
	// An ordering value used to configure display of the lifecycle stage.
	DisplayOrder int32 `protobuf:"varint,5,opt,name=display_order,json=displayOrder,proto3" json:"display_order,omitempty"`
	// contains filtered or unexported fields
}

Stages represent distinct stages in an API lifecycle, e.g. concept, design, development, testing, preview, available, deprecated, disabled.

func (*Lifecycle_Stage) Descriptor deprecated 

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

Deprecated: Use Lifecycle_Stage.ProtoReflect.Descriptor instead.

func (*Lifecycle_Stage) GetDescription 

func (x *Lifecycle_Stage) GetDescription() string

func (*Lifecycle_Stage) GetDisplayName 

func (x *Lifecycle_Stage) GetDisplayName() string

func (*Lifecycle_Stage) GetDisplayOrder 

func (x *Lifecycle_Stage) GetDisplayOrder() int32

func (*Lifecycle_Stage) GetId 

func (x *Lifecycle_Stage) GetId() string

func (*Lifecycle_Stage) GetUrl 

func (x *Lifecycle_Stage) GetUrl() string

func (*Lifecycle_Stage) ProtoMessage 

func (*Lifecycle_Stage) ProtoMessage()

func (*Lifecycle_Stage) ProtoReflect 

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

func (*Lifecycle_Stage) Reset 

func (x *Lifecycle_Stage) Reset()

func (*Lifecycle_Stage) String 

func (x *Lifecycle_Stage) String() string

type ReferenceList 

type ReferenceList struct {

	// Artifact identifier. May be used in YAML representations to indicate the id
	// to be used to attach the artifact.
	Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
	// Artifact kind. May be used in YAML representations to identify the type of
	// this artifact.
	Kind string `protobuf:"bytes,2,opt,name=kind,proto3" json:"kind,omitempty"`
	// A human-friendly name for the reference list.
	DisplayName string `protobuf:"bytes,3,opt,name=display_name,json=displayName,proto3" json:"display_name,omitempty"`
	// A more detailed description of the reference list.
	Description string `protobuf:"bytes,4,opt,name=description,proto3" json:"description,omitempty"`
	// The list of references for the resource.
	References []*ReferenceList_Reference `protobuf:"bytes,6,rep,name=references,proto3" json:"references,omitempty"`
	// contains filtered or unexported fields
}

A ReferenceList message contains a list of references that are associated with a resource. A Reference is a categorized resource name or URI that points to some internal or external resource, respectively.

ReferenceLists are used to define relationships to things like source code repositories, dependencies, and dependent APIs (inverse relationship of an API dependency).

The ReferenceList is stored as an Artifact attached to a specific resource.

func (*ReferenceList) Descriptor deprecated 

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

Deprecated: Use ReferenceList.ProtoReflect.Descriptor instead.

func (*ReferenceList) GetDescription 

func (x *ReferenceList) GetDescription() string

func (*ReferenceList) GetDisplayName 

func (x *ReferenceList) GetDisplayName() string

func (*ReferenceList) GetId 

func (x *ReferenceList) GetId() string

func (*ReferenceList) GetKind 

func (x *ReferenceList) GetKind() string

func (*ReferenceList) GetReferences 

func (x *ReferenceList) GetReferences() []*ReferenceList_Reference

func (*ReferenceList) ProtoMessage 

func (*ReferenceList) ProtoMessage()

func (*ReferenceList) ProtoReflect 

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

func (*ReferenceList) Reset 

func (x *ReferenceList) Reset()

func (*ReferenceList) String 

func (x *ReferenceList) String() string

type ReferenceList_Reference 

type ReferenceList_Reference struct {

	// The id of the reference.
	Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
	// A human-friendly name for the reference.
	DisplayName string `protobuf:"bytes,2,opt,name=display_name,json=displayName,proto3" json:"display_name,omitempty"`
	// An optional string used to categorize the reference.
	Category string `protobuf:"bytes,3,opt,name=category,proto3" json:"category,omitempty"`
	// A resource name [AIP-122] for the item being referenced.
	// At least one of resource and uri must be set. Resource takes precedent
	// over uri in API hub.
	Resource string `protobuf:"bytes,4,opt,name=resource,proto3" json:"resource,omitempty"`
	// A URI [RFC-3986] for the item being referenced.
	// At least one of resource and uri must be set. Resource takes precedent
	// over uri in API hub.
	Uri string `protobuf:"bytes,5,opt,name=uri,proto3" json:"uri,omitempty"`
	// contains filtered or unexported fields
}

Represents a single reference for a resource.

func (*ReferenceList_Reference) Descriptor deprecated 

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

Deprecated: Use ReferenceList_Reference.ProtoReflect.Descriptor instead.

func (*ReferenceList_Reference) GetCategory 

func (x *ReferenceList_Reference) GetCategory() string

func (*ReferenceList_Reference) GetDisplayName 

func (x *ReferenceList_Reference) GetDisplayName() string

func (*ReferenceList_Reference) GetId 

func (x *ReferenceList_Reference) GetId() string

func (*ReferenceList_Reference) GetResource 

func (x *ReferenceList_Reference) GetResource() string

func (*ReferenceList_Reference) GetUri 

func (x *ReferenceList_Reference) GetUri() string

func (*ReferenceList_Reference) ProtoMessage 

func (*ReferenceList_Reference) ProtoMessage()

func (*ReferenceList_Reference) ProtoReflect 

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

func (*ReferenceList_Reference) Reset 

func (x *ReferenceList_Reference) Reset()

func (*ReferenceList_Reference) String 

func (x *ReferenceList_Reference) String() string

type TaxonomyList 

type TaxonomyList struct {

	// Artifact identifier. May be used in YAML representations to indicate the id
	// to be used to attach the artifact.
	Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
	// Artifact kind. May be used in YAML representations to identify the type of
	// this artifact.
	Kind string `protobuf:"bytes,2,opt,name=kind,proto3" json:"kind,omitempty"`
	// A human-friendly name for the taxonomy list.
	DisplayName string `protobuf:"bytes,3,opt,name=display_name,json=displayName,proto3" json:"display_name,omitempty"`
	// A more detailed description of the taxonomy list.
	Description string `protobuf:"bytes,4,opt,name=description,proto3" json:"description,omitempty"`
	// The taxonomies in the list.
	Taxonomies []*TaxonomyList_Taxonomy `protobuf:"bytes,5,rep,name=taxonomies,proto3" json:"taxonomies,omitempty"`
	// contains filtered or unexported fields
}

A TaxonomyList message contains a list of taxonomies that can be used to classify resources in the registry. Typically all of the system-managed taxonomies would be stored in a registry as a single TaxonomyList artifact.

func (*TaxonomyList) Descriptor deprecated 

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

Deprecated: Use TaxonomyList.ProtoReflect.Descriptor instead.

func (*TaxonomyList) GetDescription 

func (x *TaxonomyList) GetDescription() string

func (*TaxonomyList) GetDisplayName 

func (x *TaxonomyList) GetDisplayName() string

func (*TaxonomyList) GetId 

func (x *TaxonomyList) GetId() string

func (*TaxonomyList) GetKind 

func (x *TaxonomyList) GetKind() string

func (*TaxonomyList) GetTaxonomies 

func (x *TaxonomyList) GetTaxonomies() []*TaxonomyList_Taxonomy

func (*TaxonomyList) ProtoMessage 

func (*TaxonomyList) ProtoMessage()

func (*TaxonomyList) ProtoReflect 

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

func (*TaxonomyList) Reset 

func (x *TaxonomyList) Reset()

func (*TaxonomyList) String 

func (x *TaxonomyList) String() string

type TaxonomyList_Taxonomy 

type TaxonomyList_Taxonomy struct {

	// Taxonomy identifier.
	Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
	// A human-friendly name of the taxonomy.
	DisplayName string `protobuf:"bytes,2,opt,name=display_name,json=displayName,proto3" json:"display_name,omitempty"`
	// A detailed description of the taxonomy.
	Description string `protobuf:"bytes,3,opt,name=description,proto3" json:"description,omitempty"`
	// If true, this taxonomy is applied by admins only.
	AdminApplied bool `protobuf:"varint,4,opt,name=admin_applied,json=adminApplied,proto3" json:"admin_applied,omitempty"`
	// If true, this taxonomy only allows one of its members to be associated
	// with an item (multiple selection is disallowed).
	SingleSelection bool `protobuf:"varint,5,opt,name=single_selection,json=singleSelection,proto3" json:"single_selection,omitempty"`
	// If true, this taxonomy is not included in search indexes.
	SearchExcluded bool `protobuf:"varint,6,opt,name=search_excluded,json=searchExcluded,proto3" json:"search_excluded,omitempty"`
	// If true, this taxonomy is a system-managed taxonomy.
	SystemManaged bool `protobuf:"varint,7,opt,name=system_managed,json=systemManaged,proto3" json:"system_managed,omitempty"`
	// An ordering value used to configure display of the taxonomy.
	DisplayOrder int32 `protobuf:"varint,8,opt,name=display_order,json=displayOrder,proto3" json:"display_order,omitempty"`
	// The elements of the taxonomy.
	Elements []*TaxonomyList_Taxonomy_Element `protobuf:"bytes,9,rep,name=elements,proto3" json:"elements,omitempty"`
	// contains filtered or unexported fields
}

A Taxonomy specifies a list of values that can be associated with an item in a registry, typically an API. There may be multiple taxonomies, each representing a different aspect or dimension of the item being labelled.

func (*TaxonomyList_Taxonomy) Descriptor deprecated 

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

Deprecated: Use TaxonomyList_Taxonomy.ProtoReflect.Descriptor instead.

func (*TaxonomyList_Taxonomy) GetAdminApplied 

func (x *TaxonomyList_Taxonomy) GetAdminApplied() bool

func (*TaxonomyList_Taxonomy) GetDescription 

func (x *TaxonomyList_Taxonomy) GetDescription() string

func (*TaxonomyList_Taxonomy) GetDisplayName 

func (x *TaxonomyList_Taxonomy) GetDisplayName() string

func (*TaxonomyList_Taxonomy) GetDisplayOrder 

func (x *TaxonomyList_Taxonomy) GetDisplayOrder() int32

func (*TaxonomyList_Taxonomy) GetElements 

func (x *TaxonomyList_Taxonomy) GetElements() []*TaxonomyList_Taxonomy_Element

func (*TaxonomyList_Taxonomy) GetId 

func (x *TaxonomyList_Taxonomy) GetId() string

func (*TaxonomyList_Taxonomy) GetSearchExcluded 

func (x *TaxonomyList_Taxonomy) GetSearchExcluded() bool

func (*TaxonomyList_Taxonomy) GetSingleSelection 

func (x *TaxonomyList_Taxonomy) GetSingleSelection() bool

func (*TaxonomyList_Taxonomy) GetSystemManaged 

func (x *TaxonomyList_Taxonomy) GetSystemManaged() bool

func (*TaxonomyList_Taxonomy) ProtoMessage 

func (*TaxonomyList_Taxonomy) ProtoMessage()

func (*TaxonomyList_Taxonomy) ProtoReflect 

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

func (*TaxonomyList_Taxonomy) Reset 

func (x *TaxonomyList_Taxonomy) Reset()

func (*TaxonomyList_Taxonomy) String 

func (x *TaxonomyList_Taxonomy) String() string

type TaxonomyList_Taxonomy_Element 

type TaxonomyList_Taxonomy_Element struct {

	// Element identifier.
	Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
	// A human-friendly name of the element.
	DisplayName string `protobuf:"bytes,2,opt,name=display_name,json=displayName,proto3" json:"display_name,omitempty"`
	// A detailed description of the element.
	Description string `protobuf:"bytes,3,opt,name=description,proto3" json:"description,omitempty"`
	// contains filtered or unexported fields
}

An element in a taxonomy represents one of the values that can be used to label an item.

func (*TaxonomyList_Taxonomy_Element) Descriptor deprecated 

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

Deprecated: Use TaxonomyList_Taxonomy_Element.ProtoReflect.Descriptor instead.

func (*TaxonomyList_Taxonomy_Element) GetDescription 

func (x *TaxonomyList_Taxonomy_Element) GetDescription() string

func (*TaxonomyList_Taxonomy_Element) GetDisplayName 

func (x *TaxonomyList_Taxonomy_Element) GetDisplayName() string

func (*TaxonomyList_Taxonomy_Element) GetId 

func (x *TaxonomyList_Taxonomy_Element) GetId() string

func (*TaxonomyList_Taxonomy_Element) ProtoMessage 

func (*TaxonomyList_Taxonomy_Element) ProtoMessage()

func (*TaxonomyList_Taxonomy_Element) ProtoReflect 

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

func (*TaxonomyList_Taxonomy_Element) Reset 

func (x *TaxonomyList_Taxonomy_Element) Reset()

func (*TaxonomyList_Taxonomy_Element) String 

func (x *TaxonomyList_Taxonomy_Element) String() string

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.