v1

Documentation

Overview

Copyright 2017 the Heptio Ark contributors.

Licensed 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.

Copyright 2017 the Heptio Ark contributors.

Licensed 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.

Copyright 2017 the Heptio Ark contributors.

Licensed 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.

This package has the automatically generated typed clients.

Copyright 2017 the Heptio Ark contributors.

Licensed 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.

Copyright 2017 the Heptio Ark contributors.

Licensed 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.

Copyright 2017 the Heptio Ark contributors.

Licensed 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.

Copyright 2017 the Heptio Ark contributors.

Licensed 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

• type ArkV1Client
  • func New(c rest.Interface) *ArkV1Client
  • func NewForConfig(c *rest.Config) (*ArkV1Client, error)
  • func NewForConfigOrDie(c *rest.Config) *ArkV1Client
  • func (c *ArkV1Client) Backups(namespace string) BackupInterface
  • func (c *ArkV1Client) Configs(namespace string) ConfigInterface
  • func (c *ArkV1Client) DownloadRequests(namespace string) DownloadRequestInterface
  • func (c *ArkV1Client) RESTClient() rest.Interface
  • func (c *ArkV1Client) Restores(namespace string) RestoreInterface
  • func (c *ArkV1Client) Schedules(namespace string) ScheduleInterface
• type ArkV1Interface
• type BackupExpansion
• type BackupInterface
• type BackupsGetter
• type ConfigExpansion
• type ConfigInterface
• type ConfigsGetter
• type DownloadRequestExpansion
• type DownloadRequestInterface
• type DownloadRequestsGetter
• type RestoreExpansion
• type RestoreInterface
• type RestoresGetter
• type ScheduleExpansion
• type ScheduleInterface
• type SchedulesGetter

Types

type ArkV1Client

type ArkV1Client struct {
	// contains filtered or unexported fields
}

ArkV1Client is used to interact with features provided by the ark.heptio.com group.

func New

func New(c rest.Interface) *ArkV1Client

New creates a new ArkV1Client for the given RESTClient.

func NewForConfig

func NewForConfig(c *rest.Config) (*ArkV1Client, error)

NewForConfig creates a new ArkV1Client for the given config.

func NewForConfigOrDie

func NewForConfigOrDie(c *rest.Config) *ArkV1Client

NewForConfigOrDie creates a new ArkV1Client for the given config and panics if there is an error in the config.

func (*ArkV1Client) Backups

func (c *ArkV1Client) Backups(namespace string) BackupInterface

func (*ArkV1Client) Configs

func (c *ArkV1Client) Configs(namespace string) ConfigInterface

func (*ArkV1Client) DownloadRequests

func (c *ArkV1Client) DownloadRequests(namespace string) DownloadRequestInterface

func (*ArkV1Client) RESTClient

func (c *ArkV1Client) RESTClient() rest.Interface

RESTClient returns a RESTClient that is used to communicate with API server by this client implementation.

func (*ArkV1Client) Restores

func (c *ArkV1Client) Restores(namespace string) RestoreInterface

func (*ArkV1Client) Schedules

func (c *ArkV1Client) Schedules(namespace string) ScheduleInterface

type ArkV1Interface

type ArkV1Interface interface {
	RESTClient() rest.Interface
	BackupsGetter
	ConfigsGetter
	DownloadRequestsGetter
	RestoresGetter
	SchedulesGetter
}

type BackupExpansion

type BackupExpansion interface{}

type BackupInterface

type BackupInterface interface {
	Create(*v1.Backup) (*v1.Backup, error)
	Update(*v1.Backup) (*v1.Backup, error)
	UpdateStatus(*v1.Backup) (*v1.Backup, error)
	Delete(name string, options *meta_v1.DeleteOptions) error
	DeleteCollection(options *meta_v1.DeleteOptions, listOptions meta_v1.ListOptions) error
	Get(name string, options meta_v1.GetOptions) (*v1.Backup, error)
	List(opts meta_v1.ListOptions) (*v1.BackupList, error)
	Watch(opts meta_v1.ListOptions) (watch.Interface, error)
	Patch(name string, pt types.PatchType, data []byte, subresources ...string) (result *v1.Backup, err error)
	BackupExpansion
}

BackupInterface has methods to work with Backup resources.

type BackupsGetter

type BackupsGetter interface {
	Backups(namespace string) BackupInterface
}

BackupsGetter has a method to return a BackupInterface. A group's client should implement this interface.

type ConfigExpansion

type ConfigExpansion interface{}

type ConfigInterface

type ConfigInterface interface {
	Create(*v1.Config) (*v1.Config, error)
	Update(*v1.Config) (*v1.Config, error)
	Delete(name string, options *meta_v1.DeleteOptions) error
	DeleteCollection(options *meta_v1.DeleteOptions, listOptions meta_v1.ListOptions) error
	Get(name string, options meta_v1.GetOptions) (*v1.Config, error)
	List(opts meta_v1.ListOptions) (*v1.ConfigList, error)
	Watch(opts meta_v1.ListOptions) (watch.Interface, error)
	Patch(name string, pt types.PatchType, data []byte, subresources ...string) (result *v1.Config, err error)
	ConfigExpansion
}

ConfigInterface has methods to work with Config resources.

type ConfigsGetter

type ConfigsGetter interface {
	Configs(namespace string) ConfigInterface
}

ConfigsGetter has a method to return a ConfigInterface. A group's client should implement this interface.

type DownloadRequestExpansion

type DownloadRequestExpansion interface{}

type DownloadRequestInterface

type DownloadRequestInterface interface {
	Create(*v1.DownloadRequest) (*v1.DownloadRequest, error)
	Update(*v1.DownloadRequest) (*v1.DownloadRequest, error)
	UpdateStatus(*v1.DownloadRequest) (*v1.DownloadRequest, error)
	Delete(name string, options *meta_v1.DeleteOptions) error
	DeleteCollection(options *meta_v1.DeleteOptions, listOptions meta_v1.ListOptions) error
	Get(name string, options meta_v1.GetOptions) (*v1.DownloadRequest, error)
	List(opts meta_v1.ListOptions) (*v1.DownloadRequestList, error)
	Watch(opts meta_v1.ListOptions) (watch.Interface, error)
	Patch(name string, pt types.PatchType, data []byte, subresources ...string) (result *v1.DownloadRequest, err error)
	DownloadRequestExpansion
}

DownloadRequestInterface has methods to work with DownloadRequest resources.

type DownloadRequestsGetter

type DownloadRequestsGetter interface {
	DownloadRequests(namespace string) DownloadRequestInterface
}

DownloadRequestsGetter has a method to return a DownloadRequestInterface. A group's client should implement this interface.

type RestoreExpansion

type RestoreExpansion interface{}

type RestoreInterface

type RestoreInterface interface {
	Create(*v1.Restore) (*v1.Restore, error)
	Update(*v1.Restore) (*v1.Restore, error)
	UpdateStatus(*v1.Restore) (*v1.Restore, error)
	Delete(name string, options *meta_v1.DeleteOptions) error
	DeleteCollection(options *meta_v1.DeleteOptions, listOptions meta_v1.ListOptions) error
	Get(name string, options meta_v1.GetOptions) (*v1.Restore, error)
	List(opts meta_v1.ListOptions) (*v1.RestoreList, error)
	Watch(opts meta_v1.ListOptions) (watch.Interface, error)
	Patch(name string, pt types.PatchType, data []byte, subresources ...string) (result *v1.Restore, err error)
	RestoreExpansion
}

RestoreInterface has methods to work with Restore resources.

type RestoresGetter

type RestoresGetter interface {
	Restores(namespace string) RestoreInterface
}

RestoresGetter has a method to return a RestoreInterface. A group's client should implement this interface.

type ScheduleExpansion

type ScheduleExpansion interface{}

type ScheduleInterface

type ScheduleInterface interface {
	Create(*v1.Schedule) (*v1.Schedule, error)
	Update(*v1.Schedule) (*v1.Schedule, error)
	UpdateStatus(*v1.Schedule) (*v1.Schedule, error)
	Delete(name string, options *meta_v1.DeleteOptions) error
	DeleteCollection(options *meta_v1.DeleteOptions, listOptions meta_v1.ListOptions) error
	Get(name string, options meta_v1.GetOptions) (*v1.Schedule, error)
	List(opts meta_v1.ListOptions) (*v1.ScheduleList, error)
	Watch(opts meta_v1.ListOptions) (watch.Interface, error)
	Patch(name string, pt types.PatchType, data []byte, subresources ...string) (result *v1.Schedule, err error)
	ScheduleExpansion
}

ScheduleInterface has methods to work with Schedule resources.

type SchedulesGetter

type SchedulesGetter interface {
	Schedules(namespace string) ScheduleInterface
}

SchedulesGetter has a method to return a ScheduleInterface. A group's client should implement this interface.