Documentation ¶
Overview ¶
Licensed to Elasticsearch B.V. under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. Elasticsearch B.V. licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
Types ¶
type GroupVersionDetails ¶
type GroupVersionDetails struct { schema.GroupVersion Doc string Kinds []string Types map[string]*Type }
GroupVersionDetails encapsulates details about a discovered API group.
func (GroupVersionDetails) GroupVersionString ¶
func (gvd GroupVersionDetails) GroupVersionString() string
func (GroupVersionDetails) SortedKinds ¶
func (gvd GroupVersionDetails) SortedKinds() []string
func (GroupVersionDetails) SortedTypes ¶
func (gvd GroupVersionDetails) SortedTypes() []*Type
func (GroupVersionDetails) TypeForKind ¶
func (gvd GroupVersionDetails) TypeForKind(k string) *Type
type Kind ¶
type Kind int
Kind describes the kind of the type (alias, array, etc.)
func (Kind) MarshalJSON ¶
func (*Kind) UnmarshalJSON ¶
type Type ¶
type Type struct { Name string `json:"name"` Package string `json:"package"` Doc string `json:"doc"` GVK *schema.GroupVersionKind `json:"gvk"` Kind Kind `json:"kind"` Imported bool `json:"imported"` UnderlyingType *Type `json:"underlyingType"` // for aliases, slices and pointers KeyType *Type `json:"keyType"` // for maps ValueType *Type `json:"valueType"` // for maps Fields []*Field `json:"fields"` // for structs References []*Type `json:"-"` // other types that refer to this type }
Type describes a declared type