v1alpha1

Documentation

Overview

Package v1alpha1 is the v1alpha1 version of the API.

Index

• Variables
• func Kind(kind string) schema.GroupKind
• func Resource(resource string) schema.GroupResource
• type HashKeyRange
  • func (in *HashKeyRange) DeepCopy() *HashKeyRange
  • func (in *HashKeyRange) DeepCopyInto(out *HashKeyRange)
• type SequenceNumberRange
  • func (in *SequenceNumberRange) DeepCopy() *SequenceNumberRange
  • func (in *SequenceNumberRange) DeepCopyInto(out *SequenceNumberRange)
• type Shard
  • func (in *Shard) DeepCopy() *Shard
  • func (in *Shard) DeepCopyInto(out *Shard)
• type Stream
  • func (in *Stream) DeepCopy() *Stream
  • func (in *Stream) DeepCopyInto(out *Stream)
  • func (in *Stream) DeepCopyObject() runtime.Object
• type StreamList
  • func (in *StreamList) DeepCopy() *StreamList
  • func (in *StreamList) DeepCopyInto(out *StreamList)
  • func (in *StreamList) DeepCopyObject() runtime.Object
• type StreamSpec
  • func (in *StreamSpec) DeepCopy() *StreamSpec
  • func (in *StreamSpec) DeepCopyInto(out *StreamSpec)
• type StreamStatus
  • func (in *StreamStatus) DeepCopy() *StreamStatus
  • func (in *StreamStatus) DeepCopyInto(out *StreamStatus)
• type Tag
  • func (in *Tag) DeepCopy() *Tag
  • func (in *Tag) DeepCopyInto(out *Tag)

Variables

var (
	// SchemeBuilder initializes a scheme builder
	SchemeBuilder = runtime.NewSchemeBuilder(addKnownTypes)
	// AddToScheme is a global function that registers this API group & version to a scheme
	AddToScheme = SchemeBuilder.AddToScheme
)

var SchemeGroupVersion = schema.GroupVersion{Group: awsservices.GroupName, Version: "v1alpha1"}

SchemeGroupVersion is group version used to register these objects

Functions

func Kind

func Kind(kind string) schema.GroupKind

Kind takes an unqualified kind and returns back a Group qualified GroupKind

func Resource

func Resource(resource string) schema.GroupResource

Resource takes an unqualified resource and returns a Group qualified GroupResource

Types

type HashKeyRange

type HashKeyRange struct {
	StartingHashKey string `json:"startingHashKey"`
	EndingHashKey   string `json:"endingHashKey"`
}

HashKeyRange range of hash keys supported by shard

func (*HashKeyRange) DeepCopy

func (in *HashKeyRange) DeepCopy() *HashKeyRange

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new HashKeyRange.

func (*HashKeyRange) DeepCopyInto

func (in *HashKeyRange) DeepCopyInto(out *HashKeyRange)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type SequenceNumberRange

type SequenceNumberRange struct {
	StartingSequenceNumber string `json:"startingSequenceNumber"`
	EndingSequenceNumber   string `json:"endingSequenceNumber"`
}

SequenceNumberRange used by a shard

func (*SequenceNumberRange) DeepCopy

func (in *SequenceNumberRange) DeepCopy() *SequenceNumberRange

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new SequenceNumberRange.

func (*SequenceNumberRange) DeepCopyInto

func (in *SequenceNumberRange) DeepCopyInto(out *SequenceNumberRange)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type Shard

type Shard struct {
	HashKeyRange          HashKeyRange        `json:"hashKeyRange"`
	SequenceNumberRange   SequenceNumberRange `json:"sequenceNumberRange"`
	ShardID               string              `json:"shardId"`
	AdjacentParentShardID string              `json:"adjacentParentShardId"`
	ParentShardID         string              `json:"parentShardId"`
}

Shard information of a stream

func (*Shard) DeepCopy

func (in *Shard) DeepCopy() *Shard

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Shard.

func (*Shard) DeepCopyInto

func (in *Shard) DeepCopyInto(out *Shard)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type Stream

type Stream struct {
	metav1.TypeMeta   `json:",inline"`
	metav1.ObjectMeta `json:"metadata,omitempty"`

	Spec   StreamSpec   `json:"spec"`
	Status StreamStatus `json:"status"`
}

Stream is a specification for a Stream resource

func (*Stream) DeepCopy

func (in *Stream) DeepCopy() *Stream

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Stream.

func (*Stream) DeepCopyInto

func (in *Stream) DeepCopyInto(out *Stream)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*Stream) DeepCopyObject

func (in *Stream) DeepCopyObject() runtime.Object

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

type StreamList

type StreamList struct {
	metav1.TypeMeta `json:",inline"`
	metav1.ListMeta `json:"metadata"`

	Items []Stream `json:"items"`
}

StreamList is a list of Stream resources

func (*StreamList) DeepCopy

func (in *StreamList) DeepCopy() *StreamList

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new StreamList.

func (*StreamList) DeepCopyInto

func (in *StreamList) DeepCopyInto(out *StreamList)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*StreamList) DeepCopyObject

func (in *StreamList) DeepCopyObject() runtime.Object

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

type StreamSpec

type StreamSpec struct {
	StreamName string `json:"streamName"`
	ShardCount *int32 `json:"shardCount"`
	Tags       []Tag  `json:"tags"`
}

StreamSpec is the spec for a Stream resource

func (*StreamSpec) DeepCopy

func (in *StreamSpec) DeepCopy() *StreamSpec

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new StreamSpec.

func (*StreamSpec) DeepCopyInto

func (in *StreamSpec) DeepCopyInto(out *StreamSpec)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type StreamStatus

type StreamStatus struct {
	RetryCount           int32   `json:"retryCount"`
	Error                string  `json:"error"`
	Status               string  `json:"status"`
	RetentionPeriodHours int32   `json:"retentionPeriodHours"`
	Shards               []Shard `json:"shards"`
	StreamARN            string  `json:"streamARN"`
	StreamName           string  `json:"streamName"`
	StreamStatus         string  `json:"streamStatus"`
	EncryptionType       string  `json:"encryptionType"`
	KeyID                string  `json:"keyId"`
}

StreamStatus is the status for a Stream resource

func (*StreamStatus) DeepCopy

func (in *StreamStatus) DeepCopy() *StreamStatus

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new StreamStatus.

func (*StreamStatus) DeepCopyInto

func (in *StreamStatus) DeepCopyInto(out *StreamStatus)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type Tag

type Tag struct {
	Key   string `json:"tagKey"`
	Value string `json:"tagValue"`
}

Tag associated with streams

func (*Tag) DeepCopy

func (in *Tag) DeepCopy() *Tag

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Tag.

func (*Tag) DeepCopyInto

func (in *Tag) DeepCopyInto(out *Tag)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.