github.com/cloudfoundry/cli@v7.1.0+incompatible/actor/v3action/cloud_controller_client.go (about)

     1  package v3action
     2  
     3  import (
     4  	"io"
     5  
     6  	"code.cloudfoundry.org/cli/api/cloudcontroller/ccv3"
     7  	"code.cloudfoundry.org/cli/resources"
     8  )
     9  
    10  //go:generate counterfeiter . CloudControllerClient
    11  
    12  // CloudControllerClient is the interface to the cloud controller V3 API.
    13  type CloudControllerClient interface {
    14  	AppSSHEndpoint() string
    15  	AppSSHHostKeyFingerprint() string
    16  	CancelDeployment(deploymentGUID string) (ccv3.Warnings, error)
    17  	CloudControllerAPIVersion() string
    18  	CreateApplication(app resources.Application) (resources.Application, ccv3.Warnings, error)
    19  	CreateApplicationDeployment(appGUID string, dropletGUID string) (string, ccv3.Warnings, error)
    20  	CreateApplicationProcessScale(appGUID string, process ccv3.Process) (ccv3.Process, ccv3.Warnings, error)
    21  	CreateApplicationTask(appGUID string, task ccv3.Task) (ccv3.Task, ccv3.Warnings, error)
    22  	CreateBuild(build ccv3.Build) (ccv3.Build, ccv3.Warnings, error)
    23  	CreateIsolationSegment(isolationSegment ccv3.IsolationSegment) (ccv3.IsolationSegment, ccv3.Warnings, error)
    24  	CreatePackage(pkg ccv3.Package) (ccv3.Package, ccv3.Warnings, error)
    25  	DeleteApplication(guid string) (ccv3.JobURL, ccv3.Warnings, error)
    26  	DeleteApplicationProcessInstance(appGUID string, processType string, instanceIndex int) (ccv3.Warnings, error)
    27  	DeleteIsolationSegment(guid string) (ccv3.Warnings, error)
    28  	DeleteIsolationSegmentOrganization(isolationSegmentGUID string, organizationGUID string) (ccv3.Warnings, error)
    29  	DeleteServiceInstanceRelationshipsSharedSpace(serviceInstanceGUID string, sharedToSpaceGUID string) (ccv3.Warnings, error)
    30  	EntitleIsolationSegmentToOrganizations(isoGUID string, orgGUIDs []string) (resources.RelationshipList, ccv3.Warnings, error)
    31  	GetApplicationDropletCurrent(appGUID string) (resources.Droplet, ccv3.Warnings, error)
    32  	GetApplicationEnvironment(appGUID string) (ccv3.Environment, ccv3.Warnings, error)
    33  	GetApplicationProcessByType(appGUID string, processType string) (ccv3.Process, ccv3.Warnings, error)
    34  	GetApplicationProcesses(appGUID string) ([]ccv3.Process, ccv3.Warnings, error)
    35  	GetApplications(query ...ccv3.Query) ([]resources.Application, ccv3.Warnings, error)
    36  	GetApplicationTasks(appGUID string, query ...ccv3.Query) ([]ccv3.Task, ccv3.Warnings, error)
    37  	GetBuild(guid string) (ccv3.Build, ccv3.Warnings, error)
    38  	GetDeployment(guid string) (ccv3.Deployment, ccv3.Warnings, error)
    39  	GetDeployments(query ...ccv3.Query) ([]ccv3.Deployment, ccv3.Warnings, error)
    40  	GetDroplet(guid string) (resources.Droplet, ccv3.Warnings, error)
    41  	GetDroplets(query ...ccv3.Query) ([]resources.Droplet, ccv3.Warnings, error)
    42  	GetInfo() (ccv3.Info, ccv3.ResourceLinks, ccv3.Warnings, error)
    43  	GetIsolationSegment(guid string) (ccv3.IsolationSegment, ccv3.Warnings, error)
    44  	GetIsolationSegmentOrganizations(isolationSegmentGUID string) ([]resources.Organization, ccv3.Warnings, error)
    45  	GetIsolationSegments(query ...ccv3.Query) ([]ccv3.IsolationSegment, ccv3.Warnings, error)
    46  	GetOrganizationDefaultIsolationSegment(orgGUID string) (resources.Relationship, ccv3.Warnings, error)
    47  	GetOrganizations(query ...ccv3.Query) ([]resources.Organization, ccv3.Warnings, error)
    48  	GetPackage(guid string) (ccv3.Package, ccv3.Warnings, error)
    49  	GetPackages(query ...ccv3.Query) ([]ccv3.Package, ccv3.Warnings, error)
    50  	GetProcessInstances(processGUID string) ([]ccv3.ProcessInstance, ccv3.Warnings, error)
    51  	GetServiceInstances(query ...ccv3.Query) ([]resources.ServiceInstance, ccv3.Warnings, error)
    52  	GetSpaceIsolationSegment(spaceGUID string) (resources.Relationship, ccv3.Warnings, error)
    53  	GetSpaces(query ...ccv3.Query) ([]resources.Space, ccv3.IncludedResources, ccv3.Warnings, error)
    54  	PollJob(jobURL ccv3.JobURL) (ccv3.Warnings, error)
    55  	SetApplicationDroplet(appGUID string, dropletGUID string) (resources.Relationship, ccv3.Warnings, error)
    56  	ShareServiceInstanceToSpaces(serviceInstanceGUID string, spaceGUIDs []string) (resources.RelationshipList, ccv3.Warnings, error)
    57  	TargetCF(settings ccv3.TargetSettings) (ccv3.Info, ccv3.Warnings, error)
    58  	UpdateApplication(app resources.Application) (resources.Application, ccv3.Warnings, error)
    59  	UpdateApplicationApplyManifest(appGUID string, rawManifest []byte) (ccv3.JobURL, ccv3.Warnings, error)
    60  	UpdateApplicationEnvironmentVariables(appGUID string, envVars ccv3.EnvironmentVariables) (ccv3.EnvironmentVariables, ccv3.Warnings, error)
    61  	UpdateApplicationRestart(appGUID string) (resources.Application, ccv3.Warnings, error)
    62  	UpdateApplicationStart(appGUID string) (resources.Application, ccv3.Warnings, error)
    63  	UpdateApplicationStop(appGUID string) (resources.Application, ccv3.Warnings, error)
    64  	UpdateOrganizationDefaultIsolationSegmentRelationship(orgGUID string, isolationSegmentGUID string) (resources.Relationship, ccv3.Warnings, error)
    65  	UpdateProcess(process ccv3.Process) (ccv3.Process, ccv3.Warnings, error)
    66  	UpdateSpaceIsolationSegmentRelationship(spaceGUID string, isolationSegmentGUID string) (resources.Relationship, ccv3.Warnings, error)
    67  	UpdateTaskCancel(taskGUID string) (ccv3.Task, ccv3.Warnings, error)
    68  	UploadBitsPackage(pkg ccv3.Package, matchedResources []ccv3.Resource, newResources io.Reader, newResourcesLength int64) (ccv3.Package, ccv3.Warnings, error)
    69  	UploadDropletBits(dropletGUID string, dropletPath string, droplet io.Reader, dropletLength int64) (ccv3.JobURL, ccv3.Warnings, error)
    70  	UploadPackage(pkg ccv3.Package, zipFilepath string) (ccv3.Package, ccv3.Warnings, error)
    71  }