v1

package
v1.5.0-alpha.3 Latest Latest
Warning

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

 Go to latest Published: Feb 19, 2017 License: Apache-2.0 Imports: 15 Imported by: 0

Documentation

Overview

Package v1 is the v1 version of the API. 

Package v1 is a generated protocol buffer package.

It is generated from these files:
	github.com/openshift/origin/pkg/template/api/v1/generated.proto

It has these top-level messages:
	Parameter
	Template
	TemplateList

Index

Constants

View Source 
const GroupName = ""

Variables

View Source 
var (
	ErrInvalidLengthGenerated = fmt.Errorf("proto: negative length found during unmarshaling")
	ErrIntOverflowGenerated   = fmt.Errorf("proto: integer overflow")
)
View Source 
var (
	SchemeBuilder = runtime.NewSchemeBuilder(addKnownTypes, addConversionFuncs)
	AddToScheme   = SchemeBuilder.AddToScheme
)
View Source 
var SchemeGroupVersion = unversioned.GroupVersion{Group: GroupName, Version: "v1"}

SchemeGroupVersion is group version used to register these objects

Functions

func Convert_api_Parameter_To_v1_Parameter added in v1.3.0 

func Convert_api_Parameter_To_v1_Parameter(in *api.Parameter, out *Parameter, s conversion.Scope) error

func Convert_api_TemplateList_To_v1_TemplateList added in v1.3.0 

func Convert_api_TemplateList_To_v1_TemplateList(in *api.TemplateList, out *TemplateList, s conversion.Scope) error

func Convert_api_Template_To_v1_Template added in v1.3.0 

func Convert_api_Template_To_v1_Template(in *api.Template, out *Template, s conversion.Scope) error

func Convert_v1_Parameter_To_api_Parameter added in v1.3.0 

func Convert_v1_Parameter_To_api_Parameter(in *Parameter, out *api.Parameter, s conversion.Scope) error

func Convert_v1_TemplateList_To_api_TemplateList added in v1.3.0 

func Convert_v1_TemplateList_To_api_TemplateList(in *TemplateList, out *api.TemplateList, s conversion.Scope) error

func Convert_v1_Template_To_api_Template added in v1.3.0 

func Convert_v1_Template_To_api_Template(in *Template, out *api.Template, s conversion.Scope) error

func DeepCopy_v1_Parameter added in v1.3.0 

func DeepCopy_v1_Parameter(in interface{}, out interface{}, c *conversion.Cloner) error

func DeepCopy_v1_Template added in v1.3.0 

func DeepCopy_v1_Template(in interface{}, out interface{}, c *conversion.Cloner) error

func DeepCopy_v1_TemplateList added in v1.3.0 

func DeepCopy_v1_TemplateList(in interface{}, out interface{}, c *conversion.Cloner) error

func RegisterConversions added in v1.4.0 

func RegisterConversions(scheme *runtime.Scheme) error

RegisterConversions adds conversion functions to the given scheme. Public to allow building arbitrary schemes.

func RegisterDeepCopies added in v1.4.0 

func RegisterDeepCopies(scheme *runtime.Scheme) error

RegisterDeepCopies adds deep-copy functions to the given scheme. Public to allow building arbitrary schemes.

Types

type Parameter 

type Parameter struct {
	// Name must be set and it can be referenced in Template
	// Items using ${PARAMETER_NAME}. Required.
	Name string `json:"name" protobuf:"bytes,1,opt,name=name"`

	// Optional: The name that will show in UI instead of parameter 'Name'
	DisplayName string `json:"displayName,omitempty" protobuf:"bytes,2,opt,name=displayName"`

	// Description of a parameter. Optional.
	Description string `json:"description,omitempty" protobuf:"bytes,3,opt,name=description"`

	// Value holds the Parameter data. If specified, the generator will be
	// ignored. The value replaces all occurrences of the Parameter ${Name}
	// expression during the Template to Config transformation. Optional.
	Value string `json:"value,omitempty" protobuf:"bytes,4,opt,name=value"`

	// generate specifies the generator to be used to generate random string
	// from an input value specified by From field. The result string is
	// stored into Value field. If empty, no generator is being used, leaving
	// the result Value untouched. Optional.
	//
	// The only supported generator is "expression", which accepts a "from"
	// value in the form of a simple regular expression containing the
	// range expression "[a-zA-Z0-9]", and the length expression "a{length}".
	//
	// Examples:
	//
	// from             | value
	// -----------------------------
	// "test[0-9]{1}x"  | "test7x"
	// "[0-1]{8}"       | "01001100"
	// "0x[A-F0-9]{4}"  | "0xB3AF"
	// "[a-zA-Z0-9]{8}" | "hW4yQU5i"
	//
	Generate string `json:"generate,omitempty" protobuf:"bytes,5,opt,name=generate"`

	// From is an input value for the generator. Optional.
	From string `json:"from,omitempty" protobuf:"bytes,6,opt,name=from"`

	// Optional: Indicates the parameter must have a value.  Defaults to false.
	Required bool `json:"required,omitempty" protobuf:"varint,7,opt,name=required"`
}

Parameter defines a name/value variable that is to be processed during the Template to Config transformation.

func (*Parameter) Descriptor added in v1.4.0 

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

func (*Parameter) Marshal added in v1.3.0 

func (m *Parameter) Marshal() (data []byte, err error)

func (*Parameter) MarshalTo added in v1.3.0 

func (m *Parameter) MarshalTo(data []byte) (int, error)

func (*Parameter) ProtoMessage added in v1.3.0 

func (*Parameter) ProtoMessage()

func (*Parameter) Reset added in v1.3.0 

func (m *Parameter) Reset()

func (*Parameter) Size added in v1.3.0 

func (m *Parameter) Size() (n int)

func (*Parameter) String added in v1.3.0 

func (this *Parameter) String() string

func (Parameter) SwaggerDoc added in v1.1.4 

func (Parameter) SwaggerDoc() map[string]string

func (*Parameter) Unmarshal added in v1.3.0 

func (m *Parameter) Unmarshal(data []byte) error

type Template 

type Template struct {
	unversioned.TypeMeta `json:",inline"`
	// Standard object's metadata.
	kapi.ObjectMeta `json:"metadata,omitempty" protobuf:"bytes,1,opt,name=metadata"`

	// message is an optional instructional message that will
	// be displayed when this template is instantiated.
	// This field should inform the user how to utilize the newly created resources.
	// Parameter substitution will be performed on the message before being
	// displayed so that generated credentials and other parameters can be
	// included in the output.
	Message string `json:"message,omitempty" protobuf:"bytes,2,opt,name=message"`

	// objects is an array of resources to include in this template.
	// If a namespace value is hardcoded in the object, it will be removed
	// during template instantiation, however if the namespace value
	// is, or contains, a ${PARAMETER_REFERENCE}, the resolved
	// value after parameter substitution will be respected and the object
	// will be created in that namespace.
	Objects []runtime.RawExtension `json:"objects" protobuf:"bytes,3,rep,name=objects"`

	// parameters is an optional array of Parameters used during the
	// Template to Config transformation.
	Parameters []Parameter `json:"parameters,omitempty" protobuf:"bytes,4,rep,name=parameters"`

	// labels is a optional set of labels that are applied to every
	// object during the Template to Config transformation.
	ObjectLabels map[string]string `json:"labels,omitempty" protobuf:"bytes,5,rep,name=labels"`
}

Template contains the inputs needed to produce a Config.

func (*Template) DecodeNestedObjects added in v1.3.0 

func (c *Template) DecodeNestedObjects(d runtime.Decoder) error

DecodeNestedObjects decodes the object as a runtime.Unknown with JSON content.

func (*Template) Descriptor added in v1.4.0 

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

func (*Template) EncodeNestedObjects added in v1.3.0 

func (c *Template) EncodeNestedObjects(e runtime.Encoder) error

func (*Template) GetObjectKind added in v1.1.3 

func (obj *Template) GetObjectKind() unversioned.ObjectKind

func (*Template) Marshal added in v1.3.0 

func (m *Template) Marshal() (data []byte, err error)

func (*Template) MarshalTo added in v1.3.0 

func (m *Template) MarshalTo(data []byte) (int, error)

func (*Template) ProtoMessage added in v1.3.0 

func (*Template) ProtoMessage()

func (*Template) Reset added in v1.3.0 

func (m *Template) Reset()

func (*Template) Size added in v1.3.0 

func (m *Template) Size() (n int)

func (*Template) String added in v1.3.0 

func (this *Template) String() string

func (Template) SwaggerDoc added in v1.1.4 

func (Template) SwaggerDoc() map[string]string

func (*Template) Unmarshal added in v1.3.0 

func (m *Template) Unmarshal(data []byte) error

type TemplateList 

type TemplateList struct {
	unversioned.TypeMeta `json:",inline"`
	// Standard object's metadata.
	unversioned.ListMeta `json:"metadata,omitempty" protobuf:"bytes,1,opt,name=metadata"`

	// Items is a list of templates
	Items []Template `json:"items" protobuf:"bytes,2,rep,name=items"`
}

TemplateList is a list of Template objects.

func (*TemplateList) Descriptor added in v1.4.0 

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

func (*TemplateList) GetObjectKind added in v1.1.3 

func (obj *TemplateList) GetObjectKind() unversioned.ObjectKind

func (*TemplateList) Marshal added in v1.3.0 

func (m *TemplateList) Marshal() (data []byte, err error)

func (*TemplateList) MarshalTo added in v1.3.0 

func (m *TemplateList) MarshalTo(data []byte) (int, error)

func (*TemplateList) ProtoMessage added in v1.3.0 

func (*TemplateList) ProtoMessage()

func (*TemplateList) Reset added in v1.3.0 

func (m *TemplateList) Reset()

func (*TemplateList) Size added in v1.3.0 

func (m *TemplateList) Size() (n int)

func (*TemplateList) String added in v1.3.0 

func (this *TemplateList) String() string

func (TemplateList) SwaggerDoc added in v1.1.4 

func (TemplateList) SwaggerDoc() map[string]string

func (*TemplateList) Unmarshal added in v1.3.0 

func (m *TemplateList) Unmarshal(data []byte) error

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.