client

package
v1.0.0 Latest Latest
Warning

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

Go to latest
Published: Jun 18, 2015 License: Apache-2.0 Imports: 22 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

View Source
var ErrTriggerIsNotAWebHook = fmt.Errorf("the specified trigger is not a webhook")

ErrTriggerIsNotAWebHook is returned when a webhook URL is requested for a trigger that is not a webhook type.

Functions

func DefaultOpenShiftUserAgent

func DefaultOpenShiftUserAgent() string

DefaultOpenShiftUserAgent returns the default user agent that clients can use.

func SetOpenShiftDefaults

func SetOpenShiftDefaults(config *kclient.Config) error

SetOpenShiftDefaults sets the default settings on the passed client configuration

Types

type BuildConfigInterface

type BuildConfigInterface interface {
	List(label labels.Selector, field fields.Selector) (*buildapi.BuildConfigList, error)
	Get(name string) (*buildapi.BuildConfig, error)
	Create(config *buildapi.BuildConfig) (*buildapi.BuildConfig, error)
	Update(config *buildapi.BuildConfig) (*buildapi.BuildConfig, error)
	Delete(name string) error
	Watch(label labels.Selector, field fields.Selector, resourceVersion string) (watch.Interface, error)
	Instantiate(request *buildapi.BuildRequest) (result *buildapi.Build, err error)
	WebHookURL(name string, trigger *buildapi.BuildTriggerPolicy) (*url.URL, error)
}

BuildConfigInterface exposes methods on BuildConfig resources

type BuildConfigsNamespacer

type BuildConfigsNamespacer interface {
	BuildConfigs(namespace string) BuildConfigInterface
}

BuildConfigsNamespacer has methods to work with BuildConfig resources in a namespace

type BuildInterface

type BuildInterface interface {
	List(label labels.Selector, field fields.Selector) (*buildapi.BuildList, error)
	Get(name string) (*buildapi.Build, error)
	Create(build *buildapi.Build) (*buildapi.Build, error)
	Update(build *buildapi.Build) (*buildapi.Build, error)
	Delete(name string) error
	Watch(label labels.Selector, field fields.Selector, resourceVersion string) (watch.Interface, error)
	Clone(request *buildapi.BuildRequest) (*buildapi.Build, error)
}

BuildInterface exposes methods on Build resources.

type BuildLogsInterface

type BuildLogsInterface interface {
	Get(name string, opts api.BuildLogOptions) *kclient.Request
}

BuildLogsInterface exposes methods on BuildLogs resources.

type BuildLogsNamespacer

type BuildLogsNamespacer interface {
	BuildLogs(namespace string) BuildLogsInterface
}

BuildLogsNamespacer has methods to work with BuildLogs resources in a namespace

type BuildsNamespacer

type BuildsNamespacer interface {
	Builds(namespace string) BuildInterface
}

BuildsNamespacer has methods to work with Build resources in a namespace

type Client

type Client struct {
	*kclient.RESTClient
}

Client is an OpenShift client object

func New

func New(c *kclient.Config) (*Client, error)

New creates an OpenShift client for the given config. This client works with builds, deployments, templates, routes, and images. It allows operations such as list, get, update and delete on these objects. An error is returned if the provided configuration is not valid.

func NewOrDie

func NewOrDie(c *kclient.Config) *Client

NewOrDie creates an OpenShift client and panics if the provided API version is not recognized.

func (*Client) BuildConfigs

func (c *Client) BuildConfigs(namespace string) BuildConfigInterface

BuildConfigs provides a REST client for BuildConfigs

func (*Client) BuildLogs

func (c *Client) BuildLogs(namespace string) BuildLogsInterface

BuildLogs provides a REST client for BuildLogs

func (*Client) Builds

func (c *Client) Builds(namespace string) BuildInterface

Builds provides a REST client for Builds

func (*Client) ClusterNetwork

func (c *Client) ClusterNetwork() ClusterNetworkInterface

ClusterNetwork provides a REST client for ClusterNetworking

func (*Client) ClusterPolicies

func (c *Client) ClusterPolicies() ClusterPolicyInterface

func (*Client) ClusterPolicyBindings

func (c *Client) ClusterPolicyBindings() ClusterPolicyBindingInterface

func (*Client) ClusterResourceAccessReviews

func (c *Client) ClusterResourceAccessReviews() ResourceAccessReviewInterface

ClusterResourceAccessReviews provides a REST client for ClusterResourceAccessReviews

func (*Client) ClusterRoleBindings

func (c *Client) ClusterRoleBindings() ClusterRoleBindingInterface

func (*Client) ClusterRoles

func (c *Client) ClusterRoles() ClusterRoleInterface

func (*Client) ClusterSubjectAccessReviews

func (c *Client) ClusterSubjectAccessReviews() SubjectAccessReviewInterface

ClusterSubjectAccessReviews provides a REST client for SubjectAccessReviews

func (*Client) DeploymentConfigs

func (c *Client) DeploymentConfigs(namespace string) DeploymentConfigInterface

DeploymentConfigs provides a REST client for DeploymentConfig

func (*Client) HostSubnets

func (c *Client) HostSubnets() HostSubnetInterface

HostSubnet provides a REST client for HostSubnet

func (*Client) Identities

func (c *Client) Identities() IdentityInterface

Identities provides a REST client for Identity

func (*Client) ImageStreamImages

func (c *Client) ImageStreamImages(namespace string) ImageStreamImageInterface

ImageStreamImages provides a REST client for ImageStreamImage

func (*Client) ImageStreamMappings

func (c *Client) ImageStreamMappings(namespace string) ImageStreamMappingInterface

ImageStreamMappings provides a REST client for ImageStreamMapping

func (*Client) ImageStreamTags

func (c *Client) ImageStreamTags(namespace string) ImageStreamTagInterface

ImageStreamTags provides a REST client for ImageStreamTag

func (*Client) ImageStreams

func (c *Client) ImageStreams(namespace string) ImageStreamInterface

ImageStreams provides a REST client for ImageStream

func (*Client) Images

func (c *Client) Images() ImageInterface

Images provides a REST client for Images

func (*Client) OAuthAccessTokens

func (c *Client) OAuthAccessTokens() OAuthAccessTokenInterface

OAuthAccessTokens provides a REST client for OAuthAccessTokens

func (*Client) Policies

func (c *Client) Policies(namespace string) PolicyInterface

Policies provides a REST client for Policies

func (*Client) PolicyBindings

func (c *Client) PolicyBindings(namespace string) PolicyBindingInterface

PolicyBindings provides a REST client for PolicyBindings

func (*Client) ProjectRequests

func (c *Client) ProjectRequests() ProjectRequestInterface

ProjectRequests provides a REST client for Projects

func (*Client) Projects

func (c *Client) Projects() ProjectInterface

Projects provides a REST client for Projects

func (*Client) ResourceAccessReviews

func (c *Client) ResourceAccessReviews(namespace string) ResourceAccessReviewInterface

ResourceAccessReviews provides a REST client for ResourceAccessReviews

func (*Client) RoleBindings

func (c *Client) RoleBindings(namespace string) RoleBindingInterface

RoleBindings provides a REST client for RoleBindings

func (*Client) Roles

func (c *Client) Roles(namespace string) RoleInterface

Roles provides a REST client for Roles

func (*Client) Routes

func (c *Client) Routes(namespace string) RouteInterface

Routes provides a REST client for Route

func (*Client) SubjectAccessReviews

func (c *Client) SubjectAccessReviews(namespace string) SubjectAccessReviewInterface

SubjectAccessReviews provides a REST client for SubjectAccessReviews

func (*Client) TemplateConfigs

func (c *Client) TemplateConfigs(namespace string) TemplateConfigInterface

TemplateConfigs provides a REST client for TemplateConfig

func (*Client) Templates

func (c *Client) Templates(namespace string) TemplateInterface

Templates provides a REST client for Templates

func (*Client) UserIdentityMappings

func (c *Client) UserIdentityMappings() UserIdentityMappingInterface

UserIdentityMappings provides a REST client for UserIdentityMapping

func (*Client) Users

func (c *Client) Users() UserInterface

Users provides a REST client for User

type ClusterNetworkInterface

type ClusterNetworkInterface interface {
	Get(name string) (*sdnapi.ClusterNetwork, error)
	Create(sub *sdnapi.ClusterNetwork) (*sdnapi.ClusterNetwork, error)
}

ClusterNetworkInterface exposes methods on clusterNetwork resources.

type ClusterNetworkingInterface

type ClusterNetworkingInterface interface {
	ClusterNetwork() ClusterNetworkInterface
}

ClusterNetworkingInterface has methods to work with ClusterNetwork resources

type ClusterPoliciesInterface

type ClusterPoliciesInterface interface {
	ClusterPolicies() ClusterPolicyInterface
}

ClusterPoliciesInterface has methods to work with ClusterPolicies resources in a namespace

type ClusterPolicyBindingInterface

type ClusterPolicyBindingInterface interface {
	List(label labels.Selector, field fields.Selector) (*authorizationapi.ClusterPolicyBindingList, error)
	Get(name string) (*authorizationapi.ClusterPolicyBinding, error)
	Create(policyBinding *authorizationapi.ClusterPolicyBinding) (*authorizationapi.ClusterPolicyBinding, error)
	Delete(name string) error
	Watch(label labels.Selector, field fields.Selector, resourceVersion string) (watch.Interface, error)
}

ClusterPolicyBindingInterface exposes methods on ClusterPolicyBindings resources

type ClusterPolicyBindingsInterface

type ClusterPolicyBindingsInterface interface {
	ClusterPolicyBindings() ClusterPolicyBindingInterface
}

ClusterPolicyBindingsInterface has methods to work with ClusterPolicyBindings resources in a namespace

type ClusterPolicyInterface

type ClusterPolicyInterface interface {
	List(label labels.Selector, field fields.Selector) (*authorizationapi.ClusterPolicyList, error)
	Get(name string) (*authorizationapi.ClusterPolicy, error)
	Delete(name string) error
	Watch(label labels.Selector, field fields.Selector, resourceVersion string) (watch.Interface, error)
}

ClusterPolicyInterface exposes methods on ClusterPolicies resources

type ClusterResourceAccessReviews

type ClusterResourceAccessReviews interface {
	ClusterResourceAccessReviews() ResourceAccessReviewInterface
}

ClusterResourceAccessReviews has methods to work with ResourceAccessReview resources in the cluster scope

type ClusterRoleBindingInterface

ClusterRoleBindingInterface exposes methods on ClusterRoleBindings resources

type ClusterRoleBindingsInterface

type ClusterRoleBindingsInterface interface {
	ClusterRoleBindings() ClusterRoleBindingInterface
}

ClusterRoleBindingsInterface has methods to work with ClusterRoleBindings resources in a namespace

type ClusterRoleInterface

ClusterRoleInterface exposes methods on ClusterRoles resources

type ClusterRolesInterface

type ClusterRolesInterface interface {
	ClusterRoles() ClusterRoleInterface
}

ClusterRolesInterface has methods to work with ClusterRoles resources in a namespace

type ClusterSubjectAccessReviews

type ClusterSubjectAccessReviews interface {
	ClusterSubjectAccessReviews() SubjectAccessReviewInterface
}

ClusterSubjectAccessReviews has methods to work with SubjectAccessReview resources in the cluster scope

type DeploymentConfigInterface

type DeploymentConfigInterface interface {
	List(label labels.Selector, field fields.Selector) (*deployapi.DeploymentConfigList, error)
	Get(name string) (*deployapi.DeploymentConfig, error)
	Create(config *deployapi.DeploymentConfig) (*deployapi.DeploymentConfig, error)
	Update(config *deployapi.DeploymentConfig) (*deployapi.DeploymentConfig, error)
	Delete(name string) error
	Watch(label labels.Selector, field fields.Selector, resourceVersion string) (watch.Interface, error)
	Generate(name string) (*deployapi.DeploymentConfig, error)
	Rollback(config *deployapi.DeploymentConfigRollback) (*deployapi.DeploymentConfig, error)
}

DeploymentConfigInterface contains methods for working with DeploymentConfigs

type DeploymentConfigsNamespacer

type DeploymentConfigsNamespacer interface {
	DeploymentConfigs(namespace string) DeploymentConfigInterface
}

DeploymentConfigsNamespacer has methods to work with DeploymentConfig resources in a namespace

type HostSubnetInterface

type HostSubnetInterface interface {
	List() (*sdnapi.HostSubnetList, error)
	Get(name string) (*sdnapi.HostSubnet, error)
	Create(sub *sdnapi.HostSubnet) (*sdnapi.HostSubnet, error)
	Delete(name string) error
	Watch(resourceVersion string) (watch.Interface, error)
}

HostSubnetInterface exposes methods on HostSubnet resources.

type HostSubnetsInterface

type HostSubnetsInterface interface {
	HostSubnets() HostSubnetInterface
}

HostSubnetInterface has methods to work with HostSubnet resources

type IdentitiesInterface

type IdentitiesInterface interface {
	Identities() IdentityInterface
}

IdentitiesInterface has methods to work with Identity resources

type IdentityInterface

type IdentityInterface interface {
	List(label labels.Selector, field fields.Selector) (*userapi.IdentityList, error)
	Get(name string) (*userapi.Identity, error)
	Create(identity *userapi.Identity) (*userapi.Identity, error)
	Update(identity *userapi.Identity) (*userapi.Identity, error)
}

IdentityInterface exposes methods on identity resources.

type ImageInterface

type ImageInterface interface {
	List(label labels.Selector, field fields.Selector) (*imageapi.ImageList, error)
	Get(name string) (*imageapi.Image, error)
	Create(image *imageapi.Image) (*imageapi.Image, error)
	Delete(name string) error
}

ImageInterface exposes methods on Image resources.

type ImageStreamImageInterface

type ImageStreamImageInterface interface {
	Get(name, id string) (*api.ImageStreamImage, error)
}

ImageStreamImageInterface exposes methods on ImageStreamImage resources.

type ImageStreamImagesNamespacer

type ImageStreamImagesNamespacer interface {
	ImageStreamImages(namespace string) ImageStreamImageInterface
}

ImageStreamImagesNamespacer has methods to work with ImageStreamImage resources in a namespace

type ImageStreamInterface

type ImageStreamInterface interface {
	List(label labels.Selector, field fields.Selector) (*imageapi.ImageStreamList, error)
	Get(name string) (*imageapi.ImageStream, error)
	Create(stream *imageapi.ImageStream) (*imageapi.ImageStream, error)
	Update(stream *imageapi.ImageStream) (*imageapi.ImageStream, error)
	Delete(name string) error
	Watch(label labels.Selector, field fields.Selector, resourceVersion string) (watch.Interface, error)
	UpdateStatus(stream *imageapi.ImageStream) (*imageapi.ImageStream, error)
}

ImageStreamInterface exposes methods on ImageStream resources.

type ImageStreamMappingInterface

type ImageStreamMappingInterface interface {
	Create(mapping *imageapi.ImageStreamMapping) error
}

ImageStreamMappingInterface exposes methods on ImageStreamMapping resources.

type ImageStreamMappingsNamespacer

type ImageStreamMappingsNamespacer interface {
	ImageStreamMappings(namespace string) ImageStreamMappingInterface
}

ImageStreamMappingsNamespacer has methods to work with ImageStreamMapping resources in a namespace

type ImageStreamNamespaceGetter

type ImageStreamNamespaceGetter interface {
	GetByNamespace(namespace, name string) (*imageapi.ImageStream, error)
}

ImageStreamNamespaceGetter exposes methods to get ImageStreams by Namespace

type ImageStreamTagInterface

type ImageStreamTagInterface interface {
	Get(name, tag string) (*api.ImageStreamTag, error)
	Delete(name, tag string) error
}

ImageStreamTagInterface exposes methods on ImageStreamTag resources.

type ImageStreamTagsNamespacer

type ImageStreamTagsNamespacer interface {
	ImageStreamTags(namespace string) ImageStreamTagInterface
}

ImageStreamTagsNamespacer has methods to work with ImageStreamTag resources in a namespace

type ImageStreamsNamespacer

type ImageStreamsNamespacer interface {
	ImageStreams(namespace string) ImageStreamInterface
}

ImageStreamsNamespacer has methods to work with ImageStream resources in a namespace

type ImagesInterfacer

type ImagesInterfacer interface {
	Images() ImageInterface
}

ImagesInterfacer has methods to work with Image resources

type OAuthAccessTokenInterface

type OAuthAccessTokenInterface interface {
	Delete(name string) error
}

OAuthAccessTokenInterface exposes methods on OAuthAccessTokens resources.

type OAuthAccessTokensInterface

type OAuthAccessTokensInterface interface {
	OAuthAccessTokens() OAuthAccessTokenInterface
}

OAuthAccessTokensInterface has methods to work with OAuthAccessTokens resources in a namespace

type PoliciesNamespacer

type PoliciesNamespacer interface {
	Policies(namespace string) PolicyInterface
}

PoliciesNamespacer has methods to work with Policy resources in a namespace

type PolicyBindingInterface

type PolicyBindingInterface interface {
	List(label labels.Selector, field fields.Selector) (*authorizationapi.PolicyBindingList, error)
	Get(name string) (*authorizationapi.PolicyBinding, error)
	Create(policyBinding *authorizationapi.PolicyBinding) (*authorizationapi.PolicyBinding, error)
	Delete(name string) error
	Watch(label labels.Selector, field fields.Selector, resourceVersion string) (watch.Interface, error)
}

PolicyBindingInterface exposes methods on PolicyBinding resources.

type PolicyBindingsNamespacer

type PolicyBindingsNamespacer interface {
	PolicyBindings(namespace string) PolicyBindingInterface
}

PolicyBindingsNamespacer has methods to work with PolicyBinding resources in a namespace

type PolicyInterface

type PolicyInterface interface {
	List(label labels.Selector, field fields.Selector) (*authorizationapi.PolicyList, error)
	Get(name string) (*authorizationapi.Policy, error)
	Delete(name string) error
	Watch(label labels.Selector, field fields.Selector, resourceVersion string) (watch.Interface, error)
}

PolicyInterface exposes methods on Policy resources.

type ProjectInterface

type ProjectInterface interface {
	Create(p *projectapi.Project) (*projectapi.Project, error)
	Delete(name string) error
	Get(name string) (*projectapi.Project, error)
	List(label labels.Selector, field fields.Selector) (*projectapi.ProjectList, error)
}

ProjectInterface exposes methods on project resources.

type ProjectRequestInterface

type ProjectRequestInterface interface {
	Create(p *projectapi.ProjectRequest) (*projectapi.Project, error)
	List(label labels.Selector, field fields.Selector) (*kapi.Status, error)
}

ProjectRequestInterface exposes methods on projectRequest resources.

type ProjectRequestsInterface

type ProjectRequestsInterface interface {
	ProjectRequests() ProjectRequestInterface
}

ProjectRequestsInterface has methods to work with ProjectRequest resources in a namespace

type ProjectsInterface

type ProjectsInterface interface {
	Projects() ProjectInterface
}

ProjectsInterface has methods to work with Project resources in a namespace

type ResourceAccessReviewInterface

type ResourceAccessReviewInterface interface {
	Create(policy *authorizationapi.ResourceAccessReview) (*authorizationapi.ResourceAccessReviewResponse, error)
}

ResourceAccessReviewInterface exposes methods on ResourceAccessReview resources.

type ResourceAccessReviewsNamespacer

type ResourceAccessReviewsNamespacer interface {
	ResourceAccessReviews(namespace string) ResourceAccessReviewInterface
}

ResourceAccessReviewsNamespacer has methods to work with ResourceAccessReview resources in a namespace

type RoleBindingInterface

type RoleBindingInterface interface {
	List(label labels.Selector, field fields.Selector) (*authorizationapi.RoleBindingList, error)
	Get(name string) (*authorizationapi.RoleBinding, error)
	Create(roleBinding *authorizationapi.RoleBinding) (*authorizationapi.RoleBinding, error)
	Update(roleBinding *authorizationapi.RoleBinding) (*authorizationapi.RoleBinding, error)
	Delete(name string) error
}

RoleBindingInterface exposes methods on RoleBinding resources.

type RoleBindingsNamespacer

type RoleBindingsNamespacer interface {
	RoleBindings(namespace string) RoleBindingInterface
}

RoleBindingsNamespacer has methods to work with RoleBinding resources in a namespace

type RoleInterface

type RoleInterface interface {
	List(label labels.Selector, field fields.Selector) (*authorizationapi.RoleList, error)
	Get(name string) (*authorizationapi.Role, error)
	Create(role *authorizationapi.Role) (*authorizationapi.Role, error)
	Update(role *authorizationapi.Role) (*authorizationapi.Role, error)
	Delete(name string) error
}

RoleInterface exposes methods on Role resources.

type RolesNamespacer

type RolesNamespacer interface {
	Roles(namespace string) RoleInterface
}

RolesNamespacer has methods to work with Role resources in a namespace

type RouteInterface

type RouteInterface interface {
	List(label labels.Selector, field fields.Selector) (*routeapi.RouteList, error)
	Get(name string) (*routeapi.Route, error)
	Create(route *routeapi.Route) (*routeapi.Route, error)
	Update(route *routeapi.Route) (*routeapi.Route, error)
	Delete(name string) error
	Watch(label labels.Selector, field fields.Selector, resourceVersion string) (watch.Interface, error)
}

RouteInterface exposes methods on Route resources

type RoutesNamespacer

type RoutesNamespacer interface {
	Routes(namespace string) RouteInterface
}

RoutesNamespacer has methods to work with Route resources in a namespace

type SubjectAccessReviewInterface

type SubjectAccessReviewInterface interface {
	Create(policy *authorizationapi.SubjectAccessReview) (*authorizationapi.SubjectAccessReviewResponse, error)
}

SubjectAccessReviewInterface exposes methods on SubjectAccessReview resources.

type SubjectAccessReviewsNamespacer

type SubjectAccessReviewsNamespacer interface {
	SubjectAccessReviews(namespace string) SubjectAccessReviewInterface
}

SubjectAccessReviewsNamespacer has methods to work with SubjectAccessReview resources in a namespace

type TemplateConfigInterface

type TemplateConfigInterface interface {
	Create(t *templateapi.Template) (*templateapi.Template, error)
}

TemplateConfigInterface exposes methods on Image resources.

type TemplateConfigsNamespacer

type TemplateConfigsNamespacer interface {
	TemplateConfigs(namespace string) TemplateConfigInterface
}

TemplateConfigNamespacer has methods to work with Image resources in a namespace TODO: Rename to ProcessedTemplates

type TemplateInterface

type TemplateInterface interface {
	List(label labels.Selector, field fields.Selector) (*templateapi.TemplateList, error)
	Get(name string) (*templateapi.Template, error)
	Create(template *templateapi.Template) (*templateapi.Template, error)
	Update(template *templateapi.Template) (*templateapi.Template, error)
	Delete(name string) error
	Watch(label labels.Selector, field fields.Selector, resourceVersion string) (watch.Interface, error)
}

TemplateInterface exposes methods on Template resources.

type TemplatesNamespacer

type TemplatesNamespacer interface {
	Templates(namespace string) TemplateInterface
}

TemplatesNamespacer has methods to work with Template resources in a namespace

type UserIdentityMappingInterface

type UserIdentityMappingInterface interface {
	Get(string) (*userapi.UserIdentityMapping, error)
	Create(*userapi.UserIdentityMapping) (*userapi.UserIdentityMapping, error)
	Update(*userapi.UserIdentityMapping) (*userapi.UserIdentityMapping, error)
	Delete(string) error
}

UserIdentityMappingInterface exposes methods on UserIdentityMapping resources.

type UserIdentityMappingsInterface

type UserIdentityMappingsInterface interface {
	UserIdentityMappings() UserIdentityMappingInterface
}

UserIdentityMappingsInterface has methods to work with UserIdentityMapping resources in a namespace

type UserInterface

type UserInterface interface {
	List(label labels.Selector, field fields.Selector) (*userapi.UserList, error)
	Get(name string) (*userapi.User, error)
	Create(user *userapi.User) (*userapi.User, error)
	Update(user *userapi.User) (*userapi.User, error)
}

UserInterface exposes methods on user resources.

type UsersInterface

type UsersInterface interface {
	Users() UserInterface
}

UsersInterface has methods to work with User resources

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL