views

package
v1.1.2 Latest Latest
Warning

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

 Go to latest Published: Aug 28, 2019 License: Apache-2.0 Imports: 7 Imported by: 0

Documentation

Overview

Copyright 2019 Cohesity Inc.

Copyright 2019 Cohesity Inc.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type VIEWS 

type VIEWS interface {
	DeleteClearNlmLocks(*models.ClearNlmLocksParameters) error

	ListNlmLocks(*string, *string, *int64, *string) (*models.ListNlmLocksResponse, error)

	GetQoSPolicies([]int64, []string) ([]*models.QoSPolicy, error)

	GetViewsByShareName([]string, *bool, *string, *int64, *string) (*models.GetViewsByShareNameResult, error)

	GetSmbConnections([]string, []int64, *int64, *bool) ([]*models.SmbConnection, error)

	CreateViewAlias(*models.ViewAlias) (*models.ViewAlias, error)

	UpdateViewAlias(*models.UpdateViewAliasParam) (*models.ViewAlias, error)

	DeleteViewAlias(string) error

	CreateActivateViewAliases(string) (*models.ActivateViewAliasesResult, error)

	GetViewDirQuotaInfo(string) (*models.DirQuotaInfo, error)

	UpdateViewDirQuota(*models.UpdateDirQuotaArgs) (*models.DirQuotaInfo, error)

	DeleteViewUsersQuota(*models.DeleteViewUsersQuotaParameters) error

	GetViewUserQuotas(*string, *bool, *bool, *int64, *string, []int64, []string, []string, *bool, *int64, *int64, *string, *string) (*models.ViewUserQuotas, error)

	CreateViewUserQuota(*models.ViewUserQuotaParameters) (*models.UserQuotaAndUsage, error)

	UpdateViewUserQuota(*models.ViewUserQuotaParameters) (*models.UserQuotaAndUsage, error)

	UpdateUserQuotaSettings(*models.UpdateUserQuotaSettingsForView) (*models.UserQuotaSettings, error)

	GetViews([]string, *bool, []string, []int64, []int64, []string, *bool, *int64, *bool, *int64, *bool, []int64, *bool, *bool, *bool, *bool) (*models.GetViewsResult, error)

	CreateView(*models.CreateViewRequest) (*models.View, error)

	UpdateView(*models.UpdateViewParam) (*models.View, error)

	CreateCloneView(*models.CloneViewRequest) (*models.View, error)

	CreateCloneDirectory(*models.CloneDirectoryParams) error

	DeleteViewById(int64) error

	GetViewById(int64) (*models.View, error)

	GetFileLockStatusById(int64, *string) (*models.FileLockStatus, error)

	CreateLockFileById(int64, *models.LockFileParams) (*models.FileLockStatus, error)

	CreateOverwriteView(*models.OverwriteViewParam) (*models.View, error)

	CreateRenameViewById(*models.RenameViewParam, int64) (*models.View, error)

	CreateRenameView(*models.RenameViewParam, string) (*models.View, error)

	DeleteView(string) error

	GetViewByName(string) (*models.View, error)

	UpdateViewByName(string, *models.UpdateViewParam) (*models.View, error)

	GetFileLockStatus(string, *string) (*models.FileLockStatus, error)

	CreateLockFile(string, *models.LockFileParams) (*models.FileLockStatus, error)
}

* Interface for the VIEWS_IMPL

type VIEWS_IMPL 

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

* Client structure as interface implementation

func NewVIEWS 

func NewVIEWS(config configuration.CONFIGURATION) *VIEWS_IMPL

* Factory for the VIEWS interaface returning VIEWS_IMPL

func (*VIEWS_IMPL) CreateActivateViewAliases 

func (me *VIEWS_IMPL) CreateActivateViewAliases(
	name string) (*models.ActivateViewAliasesResult, error)

*

  • Returns error if op fails.
  • @param string name parameter: Required
  • @return Returns the *models.ActivateViewAliasesResult response from the API call

func (*VIEWS_IMPL) CreateCloneDirectory 

func (me *VIEWS_IMPL) CreateCloneDirectory(
	body *models.CloneDirectoryParams) error

*

  • Returns error if op fails.
  • @param *models.CloneDirectoryParams body parameter: Required
  • @return Returns the response from the API call

func (*VIEWS_IMPL) CreateCloneView 

func (me *VIEWS_IMPL) CreateCloneView(
	body *models.CloneViewRequest) (*models.View, error)

*

  • Returns the cloned View.
  • @param *models.CloneViewRequest body parameter: Required
  • @return Returns the *models.View response from the API call

func (*VIEWS_IMPL) CreateLockFile 

func (me *VIEWS_IMPL) CreateLockFile(
	name string,
	body *models.LockFileParams) (*models.FileLockStatus, error)

*

  • Returns error if op fails.
  • @param string name parameter: Required
  • @param *models.LockFileParams body parameter: Optional
  • @return Returns the *models.FileLockStatus response from the API call

func (*VIEWS_IMPL) CreateLockFileById added in v1.1.2 

func (me *VIEWS_IMPL) CreateLockFileById(
	id int64,
	body *models.LockFileParams) (*models.FileLockStatus, error)

*

  • Returns error if op fails.
  • @param int64 id parameter: Required
  • @param *models.LockFileParams body parameter: Optional
  • @return Returns the *models.FileLockStatus response from the API call

func (*VIEWS_IMPL) CreateOverwriteView 

func (me *VIEWS_IMPL) CreateOverwriteView(
	body *models.OverwriteViewParam) (*models.View, error)

*

  • Specifies source and target view names as params.
  • Returns the modified Target View.
  • @param *models.OverwriteViewParam body parameter: Required
  • @return Returns the *models.View response from the API call

func (*VIEWS_IMPL) CreateRenameView 

func (me *VIEWS_IMPL) CreateRenameView(
	body *models.RenameViewParam,
	name string) (*models.View, error)

*

  • Specify original name of the View in the 'name' parameter.
  • Returns the renamed View.
  • @param *models.RenameViewParam body parameter: Required
  • @param string name parameter: Required
  • @return Returns the *models.View response from the API call

func (*VIEWS_IMPL) CreateRenameViewById added in v1.1.2 

func (me *VIEWS_IMPL) CreateRenameViewById(
	body *models.RenameViewParam,
	id int64) (*models.View, error)

*

  • Specify unique id of the View in the 'id' parameter.
  • Returns the renamed View.
  • @param *models.RenameViewParam body parameter: Required
  • @param int64 id parameter: Required
  • @return Returns the *models.View response from the API call

func (*VIEWS_IMPL) CreateView 

func (me *VIEWS_IMPL) CreateView(
	body *models.CreateViewRequest) (*models.View, error)

*

  • Returns the created View.
  • @param *models.CreateViewRequest body parameter: Required
  • @return Returns the *models.View response from the API call

func (*VIEWS_IMPL) CreateViewAlias 

func (me *VIEWS_IMPL) CreateViewAlias(
	body *models.ViewAlias) (*models.ViewAlias, error)

*

  • Returns the created View Alias.
  • @param *models.ViewAlias body parameter: Required
  • @return Returns the *models.ViewAlias response from the API call

func (*VIEWS_IMPL) CreateViewUserQuota 

func (me *VIEWS_IMPL) CreateViewUserQuota(
	body *models.ViewUserQuotaParameters) (*models.UserQuotaAndUsage, error)

*

  • Returns error if op fails.
  • @param *models.ViewUserQuotaParameters body parameter: Optional
  • @return Returns the *models.UserQuotaAndUsage response from the API call

func (*VIEWS_IMPL) DeleteClearNlmLocks 

func (me *VIEWS_IMPL) DeleteClearNlmLocks(
	body *models.ClearNlmLocksParameters) error

*

  • Returns nothing upon success.
  • @param *models.ClearNlmLocksParameters body parameter: Required
  • @return Returns the response from the API call

func (*VIEWS_IMPL) DeleteView 

func (me *VIEWS_IMPL) DeleteView(
	name string) error

*

  • Returns delete status upon completion.
  • @param string name parameter: Required
  • @return Returns the response from the API call

func (*VIEWS_IMPL) DeleteViewAlias 

func (me *VIEWS_IMPL) DeleteViewAlias(
	name string) error

*

  • Returns delete status upon completion.
  • @param string name parameter: Required
  • @return Returns the response from the API call

func (*VIEWS_IMPL) DeleteViewById added in v1.1.2 

func (me *VIEWS_IMPL) DeleteViewById(
	id int64) error

*

  • Returns delete status upon completion.
  • @param int64 id parameter: Required
  • @return Returns the response from the API call

func (*VIEWS_IMPL) DeleteViewUsersQuota 

func (me *VIEWS_IMPL) DeleteViewUsersQuota(
	body *models.DeleteViewUsersQuotaParameters) error

*

  • Returns error if op fails.
  • @param *models.DeleteViewUsersQuotaParameters body parameter: Optional
  • @return Returns the response from the API call

func (*VIEWS_IMPL) GetFileLockStatus 

func (me *VIEWS_IMPL) GetFileLockStatus(
	name string,
	path *string) (*models.FileLockStatus, error)

*

  • Returns error if op fails.
  • @param string name parameter: Required
  • @param *string path parameter: Optional
  • @return Returns the *models.FileLockStatus response from the API call

func (*VIEWS_IMPL) GetFileLockStatusById added in v1.1.2 

func (me *VIEWS_IMPL) GetFileLockStatusById(
	id int64,
	path *string) (*models.FileLockStatus, error)

*

  • Returns error if op fails.
  • @param int64 id parameter: Required
  • @param *string path parameter: Optional
  • @return Returns the *models.FileLockStatus response from the API call

func (*VIEWS_IMPL) GetQoSPolicies added in v1.1.2 

func (me *VIEWS_IMPL) GetQoSPolicies(
	ids []int64,
	names []string) ([]*models.QoSPolicy, error)

*

  • Returns error if op fails.
  • @param []int64 ids parameter: Optional
  • @param []string names parameter: Optional
  • @return Returns the []*models.QoSPolicy response from the API call

func (*VIEWS_IMPL) GetSmbConnections added in v1.1.2 

func (me *VIEWS_IMPL) GetSmbConnections(
	viewNames []string,
	viewIds []int64,
	maxCount *int64,
	includeSid *bool) ([]*models.SmbConnection, error)

*

  • Returns error if op fails.
  • @param []string viewNames parameter: Optional
  • @param []int64 viewIds parameter: Optional
  • @param *int64 maxCount parameter: Optional
  • @param *bool includeSid parameter: Optional
  • @return Returns the []*models.SmbConnection response from the API call

func (*VIEWS_IMPL) GetViewById added in v1.1.2 

func (me *VIEWS_IMPL) GetViewById(
	id int64) (*models.View, error)

*

  • Returns the View corresponding to the specified View id.
  • @param int64 id parameter: Required
  • @return Returns the *models.View response from the API call

func (*VIEWS_IMPL) GetViewByName 

func (me *VIEWS_IMPL) GetViewByName(
	name string) (*models.View, error)

*

  • Returns the View corresponding to the specified View name.
  • @param string name parameter: Required
  • @return Returns the *models.View response from the API call

func (*VIEWS_IMPL) GetViewDirQuotaInfo added in v1.1.2 

func (me *VIEWS_IMPL) GetViewDirQuotaInfo(
	viewName string) (*models.DirQuotaInfo, error)

*

  • Gets directory quota info for a view. Returns error if op fails.
  • @param string viewName parameter: Required
  • @return Returns the *models.DirQuotaInfo response from the API call

func (*VIEWS_IMPL) GetViewUserQuotas 

func (me *VIEWS_IMPL) GetViewUserQuotas(
	viewName *string,
	includeUsage *bool,
	excludeUsersWithinAlertThreshold *bool,
	unixUid *int64,
	sid *string,
	userUnixIdsForView []int64,
	userSidsForView []string,
	viewNamesForUser []string,
	summaryOnly *bool,
	pageCount *int64,
	maxViewId *int64,
	cookie *string,
	outputFormat *string) (*models.ViewUserQuotas, error)

*

  • Returns error if op fails.
  • @param *string viewName parameter: Optional
  • @param *bool includeUsage parameter: Optional
  • @param *bool excludeUsersWithinAlertThreshold parameter: Optional
  • @param *int64 unixUid parameter: Optional
  • @param *string sid parameter: Optional
  • @param []int64 userUnixIdsForView parameter: Optional
  • @param []string userSidsForView parameter: Optional
  • @param []string viewNamesForUser parameter: Optional
  • @param *bool summaryOnly parameter: Optional
  • @param *int64 pageCount parameter: Optional
  • @param *int64 maxViewId parameter: Optional
  • @param *string cookie parameter: Optional
  • @param *string outputFormat parameter: Optional
  • @return Returns the *models.ViewUserQuotas response from the API call

func (*VIEWS_IMPL) GetViews 

func (me *VIEWS_IMPL) GetViews(
	tenantIds []string,
	allUnderHierarchy *bool,
	viewNames []string,
	viewIds []int64,
	viewBoxIds []int64,
	viewBoxNames []string,
	matchPartialNames *bool,
	maxCount *int64,
	includeProtectionJobs *bool,
	maxViewId *int64,
	includeInactive *bool,
	jobIds []int64,
	sortByLogicalUsage *bool,
	matchAliasNames *bool,
	includeViewsWithAntivirusEnabledOnly *bool,
	includeStats *bool) (*models.GetViewsResult, error)

*

  • If no parameters are specified, all Views on the Cohesity Cluster are returned.
  • Specifying parameters filters the results that are returned.
  • NOTE: If maxCount is set and the number of Views returned exceeds the maxCount,
  • there are more Views to return.
  • To get the next set of Views, send another request and specify the id of the
  • last View returned in viewList from the previous response.
  • @param []string tenantIds parameter: Optional
  • @param *bool allUnderHierarchy parameter: Optional
  • @param []string viewNames parameter: Optional
  • @param []int64 viewIds parameter: Optional
  • @param []int64 viewBoxIds parameter: Optional
  • @param []string viewBoxNames parameter: Optional
  • @param *bool matchPartialNames parameter: Optional
  • @param *int64 maxCount parameter: Optional
  • @param *bool includeProtectionJobs parameter: Optional
  • @param *int64 maxViewId parameter: Optional
  • @param *bool includeInactive parameter: Optional
  • @param []int64 jobIds parameter: Optional
  • @param *bool sortByLogicalUsage parameter: Optional
  • @param *bool matchAliasNames parameter: Optional
  • @param *bool includeViewsWithAntivirusEnabledOnly parameter: Optional
  • @param *bool includeStats parameter: Optional
  • @return Returns the *models.GetViewsResult response from the API call

func (*VIEWS_IMPL) GetViewsByShareName 

func (me *VIEWS_IMPL) GetViewsByShareName(
	tenantIds []string,
	allUnderHierarchy *bool,
	shareName *string,
	maxCount *int64,
	paginationCookie *string) (*models.GetViewsByShareNameResult, error)

*

  • If no parameters are specified, all shares on the Cohesity Cluster are
  • returned. Specifying share name/prefix filters the results that are returned.
  • NOTE: If maxCount is set and the number of Views returned exceeds the maxCount,
  • there are more Views to return.
  • To get the next set of Views, send another request and specify the pagination
  • cookie from the previous response.
  • @param []string tenantIds parameter: Optional
  • @param *bool allUnderHierarchy parameter: Optional
  • @param *string shareName parameter: Optional
  • @param *int64 maxCount parameter: Optional
  • @param *string paginationCookie parameter: Optional
  • @return Returns the *models.GetViewsByShareNameResult response from the API call

func (*VIEWS_IMPL) ListNlmLocks 

func (me *VIEWS_IMPL) ListNlmLocks(
	filePath *string,
	viewName *string,
	pageCount *int64,
	cookie *string) (*models.ListNlmLocksResponse, error)

*

  • If no parameters are specified, all NLM locks currently on the Cohesity Cluster
  • are returned. Specifying parameters filters the results that are returned.
  • @param *string filePath parameter: Optional
  • @param *string viewName parameter: Optional
  • @param *int64 pageCount parameter: Optional
  • @param *string cookie parameter: Optional
  • @return Returns the *models.ListNlmLocksResponse response from the API call

func (*VIEWS_IMPL) UpdateUserQuotaSettings 

func (me *VIEWS_IMPL) UpdateUserQuotaSettings(
	body *models.UpdateUserQuotaSettingsForView) (*models.UserQuotaSettings, error)

*

  • Returns error if op fails.
  • @param *models.UpdateUserQuotaSettingsForView body parameter: Optional
  • @return Returns the *models.UserQuotaSettings response from the API call

func (*VIEWS_IMPL) UpdateView 

func (me *VIEWS_IMPL) UpdateView(
	body *models.UpdateViewParam) (*models.View, error)

*

  • Returns the updated View.
  • @param *models.UpdateViewParam body parameter: Required
  • @return Returns the *models.View response from the API call

func (*VIEWS_IMPL) UpdateViewAlias added in v1.1.2 

func (me *VIEWS_IMPL) UpdateViewAlias(
	body *models.UpdateViewAliasParam) (*models.ViewAlias, error)

*

  • Returns the updated View Alias.
  • @param *models.UpdateViewAliasParam body parameter: Required
  • @return Returns the *models.ViewAlias response from the API call

func (*VIEWS_IMPL) UpdateViewByName 

func (me *VIEWS_IMPL) UpdateViewByName(
	name string,
	body *models.UpdateViewParam) (*models.View, error)

*

  • Returns the updated View.
  • @param string name parameter: Required
  • @param *models.UpdateViewParam body parameter: Required
  • @return Returns the *models.View response from the API call

func (*VIEWS_IMPL) UpdateViewDirQuota added in v1.1.2 

func (me *VIEWS_IMPL) UpdateViewDirQuota(
	body *models.UpdateDirQuotaArgs) (*models.DirQuotaInfo, error)

*

  • Updates a directory quota policy for a view. Returns error if op fails.
  • @param *models.UpdateDirQuotaArgs body parameter: Required
  • @return Returns the *models.DirQuotaInfo response from the API call

func (*VIEWS_IMPL) UpdateViewUserQuota 

func (me *VIEWS_IMPL) UpdateViewUserQuota(
	body *models.ViewUserQuotaParameters) (*models.UserQuotaAndUsage, error)

*

  • Returns error if op fails.
  • @param *models.ViewUserQuotaParameters body parameter: Optional
  • @return Returns the *models.UserQuotaAndUsage response from the API call

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.