kubernetes: github.com/erimatnor/kubernetes/pkg/api/rest Index | Files | Directories

package rest

import "github.com/erimatnor/kubernetes/pkg/api/rest"

Package rest defines common logic around changes to Kubernetes resources.

Index

Package Files

create.go delete.go doc.go rest.go types.go update.go

Variables

var Services = svcStrategy{api.Scheme, api.SimpleNameGenerator}

Services is the default logic that applies when creating and updating Service objects.

func BeforeCreate Uses

func BeforeCreate(strategy RESTCreateStrategy, ctx api.Context, obj runtime.Object) error

BeforeCreate ensures that common operations for all resources are performed on creation. It only returns errors that can be converted to api.Status. It invokes PrepareForCreate, then GenerateName, then Validate. It returns nil if the object should be created.

func BeforeDelete Uses

func BeforeDelete(strategy RESTDeleteStrategy, ctx api.Context, obj runtime.Object, options *api.DeleteOptions) (graceful, gracefulPending bool, err error)

BeforeDelete tests whether the object can be gracefully deleted. If graceful is set the object should be gracefully deleted, if gracefulPending is set the object has already been gracefully deleted (and the provided grace period is longer than the time to deletion), and an error is returned if the condition cannot be checked or the gracePeriodSeconds is invalid. The options argument may be updated with default values if graceful is true.

func BeforeUpdate Uses

func BeforeUpdate(strategy RESTUpdateStrategy, ctx api.Context, obj, old runtime.Object) error

BeforeUpdate ensures that common operations for all resources are performed on update. It only returns errors that can be converted to api.Status. It will invoke update validation with the provided existing and updated objects.

func CheckGeneratedNameError Uses

func CheckGeneratedNameError(strategy RESTCreateStrategy, err error, obj runtime.Object) error

CheckGeneratedNameError checks whether an error that occurred creating a resource is due to generation being unable to pick a valid name.

type ConnectHandler Uses

type ConnectHandler interface {
    http.Handler

    // RequestError returns an error if one occurred during handling of an HTTP request
    RequestError() error
}

ConnectHandler is a handler for HTTP connection requests. It extends the standard http.Handler interface by adding a method that returns an error object if an error occurred during the handling of the request.

type Connecter Uses

type Connecter interface {
    // Connect returns a ConnectHandler that will handle the request/response for a request
    Connect(ctx api.Context, id string, options runtime.Object) (ConnectHandler, error)

    // NewConnectOptions returns an empty options object that will be used to pass
    // options to the Connect method. If nil, then a nil options object is passed to
    // Connect. It may return a bool and a string. If true, the value of the request
    // path below the object will be included as the named string in the serialization
    // of the runtime object.
    NewConnectOptions() (runtime.Object, bool, string)

    // ConnectMethods returns the list of HTTP methods handled by Connect
    ConnectMethods() []string
}

Connecter is a storage object that responds to a connection request

type Creater Uses

type Creater interface {
    // New returns an empty object that can be used with Create after request data has been put into it.
    // This object must be a pointer type for use with Codec.DecodeInto([]byte, runtime.Object)
    New() runtime.Object

    // Create creates a new version of a resource.
    Create(ctx api.Context, obj runtime.Object) (runtime.Object, error)
}

Creater is an object that can create an instance of a RESTful object.

type CreaterUpdater Uses

type CreaterUpdater interface {
    Creater
    Update(ctx api.Context, obj runtime.Object) (runtime.Object, bool, error)
}

CreaterUpdater is a storage object that must support both create and update. Go prevents embedded interfaces that implement the same method.

type Deleter Uses

type Deleter interface {
    // Delete finds a resource in the storage and deletes it.
    // Although it can return an arbitrary error value, IsNotFound(err) is true for the
    // returned error value err when the specified resource is not found.
    // Delete *may* return the object that was deleted, or a status object indicating additional
    // information about deletion.
    Delete(ctx api.Context, name string) (runtime.Object, error)
}

Deleter is an object that can delete a named RESTful resource.

type Getter Uses

type Getter interface {
    // Get finds a resource in the storage by name and returns it.
    // Although it can return an arbitrary error value, IsNotFound(err) is true for the
    // returned error value err when the specified resource is not found.
    Get(ctx api.Context, name string) (runtime.Object, error)
}

Getter is an object that can retrieve a named RESTful resource.

type GetterWithOptions Uses

type GetterWithOptions interface {
    // Get finds a resource in the storage by name and returns it.
    // Although it can return an arbitrary error value, IsNotFound(err) is true for the
    // returned error value err when the specified resource is not found.
    // The options object passed to it is of the same type returned by the NewGetOptions
    // method.
    Get(ctx api.Context, name string, options runtime.Object) (runtime.Object, error)

    // NewGetOptions returns an empty options object that will be used to pass
    // options to the Get method. It may return a bool and a string, if true, the
    // value of the request path below the object will be included as the named
    // string in the serialization of the runtime object. E.g., returning "path"
    // will convert the trailing request scheme value to "path" in the map[string][]string
    // passed to the convertor.
    NewGetOptions() (runtime.Object, bool, string)
}

GetterWithOptions is an object that retrieve a named RESTful resource and takes additional options on the get request. It allows a caller to also receive the subpath of the GET request.

type GracefulDeleteAdapter Uses

type GracefulDeleteAdapter struct {
    Deleter
}

GracefulDeleteAdapter adapts the Deleter interface to GracefulDeleter

func (GracefulDeleteAdapter) Delete Uses

func (w GracefulDeleteAdapter) Delete(ctx api.Context, name string, options *api.DeleteOptions) (runtime.Object, error)

Delete implements RESTGracefulDeleter in terms of Deleter

type GracefulDeleter Uses

type GracefulDeleter interface {
    // Delete finds a resource in the storage and deletes it.
    // If options are provided, the resource will attempt to honor them or return an invalid
    // request error.
    // Although it can return an arbitrary error value, IsNotFound(err) is true for the
    // returned error value err when the specified resource is not found.
    // Delete *may* return the object that was deleted, or a status object indicating additional
    // information about deletion.
    Delete(ctx api.Context, name string, options *api.DeleteOptions) (runtime.Object, error)
}

GracefulDeleter knows how to pass deletion options to allow delayed deletion of a RESTful object.

type Lister Uses

type Lister interface {
    // NewList returns an empty object that can be used with the List call.
    // This object must be a pointer type for use with Codec.DecodeInto([]byte, runtime.Object)
    NewList() runtime.Object
    // List selects resources in the storage which match to the selector.
    List(ctx api.Context, label labels.Selector, field fields.Selector) (runtime.Object, error)
}

Lister is an object that can retrieve resources that match the provided field and label criteria.

type ObjectFunc Uses

type ObjectFunc func(obj runtime.Object) error

ObjectFunc is a function to act on a given object. An error may be returned if the hook cannot be completed. An ObjectFunc may transform the provided object.

func AllFuncs Uses

func AllFuncs(fns ...ObjectFunc) ObjectFunc

AllFuncs returns an ObjectFunc that attempts to run all of the provided functions in order, returning early if there are any errors.

type Patcher Uses

type Patcher interface {
    Getter
    Updater
}

Patcher is a storage object that supports both get and update.

type RESTCreateStrategy Uses

type RESTCreateStrategy interface {
    runtime.ObjectTyper
    // The name generate is used when the standard GenerateName field is set.
    // The NameGenerator will be invoked prior to validation.
    api.NameGenerator

    // NamespaceScoped returns true if the object must be within a namespace.
    NamespaceScoped() bool
    // PrepareForCreate is invoked on create before validation to normalize
    // the object.  For example: remove fields that are not to be persisted,
    // sort order-insensitive list fields, etc.
    PrepareForCreate(obj runtime.Object)
    // Validate is invoked after default fields in the object have been filled in before
    // the object is persisted.
    Validate(ctx api.Context, obj runtime.Object) fielderrors.ValidationErrorList
}

RESTCreateStrategy defines the minimum validation, accepted input, and name generation behavior to create an object that follows Kubernetes API conventions.

type RESTDeleteStrategy Uses

type RESTDeleteStrategy interface {
    runtime.ObjectTyper

    // CheckGracefulDelete should return true if the object can be gracefully deleted and set
    // any default values on the DeleteOptions.
    CheckGracefulDelete(obj runtime.Object, options *api.DeleteOptions) bool
}

RESTDeleteStrategy defines deletion behavior on an object that follows Kubernetes API conventions.

type RESTUpdateStrategy Uses

type RESTUpdateStrategy interface {
    runtime.ObjectTyper
    // NamespaceScoped returns true if the object must be within a namespace.
    NamespaceScoped() bool
    // AllowCreateOnUpdate returns true if the object can be created by a PUT.
    AllowCreateOnUpdate() bool
    // PrepareForUpdate is invoked on update before validation to normalize
    // the object.  For example: remove fields that are not to be persisted,
    // sort order-insensitive list fields, etc.
    PrepareForUpdate(obj, old runtime.Object)
    // ValidateUpdate is invoked after default fields in the object have been filled in before
    // the object is persisted.
    ValidateUpdate(ctx api.Context, obj, old runtime.Object) fielderrors.ValidationErrorList
}

RESTUpdateStrategy defines the minimum validation, accepted input, and name generation behavior to update an object that follows Kubernetes API conventions. A resource may have many UpdateStrategies, depending on the call pattern in use.

type Redirector Uses

type Redirector interface {
    // ResourceLocation should return the remote location of the given resource, and an optional transport to use to request it, or an error.
    ResourceLocation(ctx api.Context, id string) (remoteLocation *url.URL, transport http.RoundTripper, err error)
}

Redirector know how to return a remote resource's location.

type ResourceStreamer Uses

type ResourceStreamer interface {
    // InputStream should return an io.ReadCloser if the provided object supports streaming. The desired
    // api version and a accept header (may be empty) are passed to the call. If no error occurs,
    // the caller may return a flag indicating whether the result should be flushed as writes occur
    // and a content type string that indicates the type of the stream.
    // If a null stream is returned, a StatusNoContent response wil be generated.
    InputStream(apiVersion, acceptHeader string) (stream io.ReadCloser, flush bool, mimeType string, err error)
}

ResourceStreamer is an interface implemented by objects that prefer to be streamed from the server instead of decoded directly.

type StandardStorage Uses

type StandardStorage interface {
    Getter
    Lister
    CreaterUpdater
    GracefulDeleter
    Watcher
}

StandardStorage is an interface covering the common verbs. Provided for testing whether a resource satisfies the normal storage methods. Use Storage when passing opaque storage objects.

type Storage Uses

type Storage interface {
    // New returns an empty object that can be used with Create and Update after request data has been put into it.
    // This object must be a pointer type for use with Codec.DecodeInto([]byte, runtime.Object)
    New() runtime.Object
}

Storage is a generic interface for RESTful storage services. Resources which are exported to the RESTful API of apiserver need to implement this interface. It is expected that objects may implement any of the below interfaces.

type StorageMetadata Uses

type StorageMetadata interface {
    // ProducesMIMETypes returns a list of the MIME types the specified HTTP verb (GET, POST, DELETE,
    // PATCH) can respond with.
    ProducesMIMETypes(verb string) []string
}

StorageMetadata is an optional interface that callers can implement to provide additional information about their Storage objects.

type Updater Uses

type Updater interface {
    // New returns an empty object that can be used with Update after request data has been put into it.
    // This object must be a pointer type for use with Codec.DecodeInto([]byte, runtime.Object)
    New() runtime.Object

    // Update finds a resource in the storage and updates it. Some implementations
    // may allow updates creates the object - they should set the created boolean
    // to true.
    Update(ctx api.Context, obj runtime.Object) (runtime.Object, bool, error)
}

Updater is an object that can update an instance of a RESTful object.

type Watcher Uses

type Watcher interface {
    // 'label' selects on labels; 'field' selects on the object's fields. Not all fields
    // are supported; an error should be returned if 'field' tries to select on a field that
    // isn't supported. 'resourceVersion' allows for continuing/starting a watch at a
    // particular version.
    Watch(ctx api.Context, label labels.Selector, field fields.Selector, resourceVersion string) (watch.Interface, error)
}

Watcher should be implemented by all Storage objects that want to offer the ability to watch for changes through the watch api.

Directories

PathSynopsis
resttest

Package rest imports 11 packages (graph). Updated 2017-05-11. Refresh now. Tools for package owners.