Class TelcoAutomationGrpc.TelcoAutomationFutureStub (0.16.0)

public static final class TelcoAutomationGrpc.TelcoAutomationFutureStub extends AbstractFutureStub<TelcoAutomationGrpc.TelcoAutomationFutureStub>

A stub to allow clients to do ListenableFuture-style rpc calls to service TelcoAutomation.

TelcoAutomation Service manages the control plane cluster a.k.a. Orchestration Cluster (GKE cluster with config controller) of TNA. It also exposes blueprint APIs which manages the lifecycle of blueprints that control the infrastructure setup (e.g GDCE clusters) and deployment of network functions.

Inheritance

java.lang.Object > io.grpc.stub.AbstractStub > io.grpc.stub.AbstractFutureStub > TelcoAutomationGrpc.TelcoAutomationFutureStub

Methods

applyDeployment(ApplyDeploymentRequest request)

public ListenableFuture<Deployment> applyDeployment(ApplyDeploymentRequest request)

Applies the deployment's YAML files to the parent orchestration cluster.

Parameter
Name Description
request ApplyDeploymentRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<Deployment>

applyHydratedDeployment(ApplyHydratedDeploymentRequest request)

public ListenableFuture<HydratedDeployment> applyHydratedDeployment(ApplyHydratedDeploymentRequest request)

Applies a hydrated deployment to a workload cluster.

Parameter
Name Description
request ApplyHydratedDeploymentRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<HydratedDeployment>

approveBlueprint(ApproveBlueprintRequest request)

public ListenableFuture<Blueprint> approveBlueprint(ApproveBlueprintRequest request)

Approves a blueprint and commits a new revision.

Parameter
Name Description
request ApproveBlueprintRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<Blueprint>

build(Channel channel, CallOptions callOptions)

protected TelcoAutomationGrpc.TelcoAutomationFutureStub build(Channel channel, CallOptions callOptions)
Parameters
Name Description
channel io.grpc.Channel
callOptions io.grpc.CallOptions
Returns
Type Description
TelcoAutomationGrpc.TelcoAutomationFutureStub
Overrides
io.grpc.stub.AbstractStub.build(io.grpc.Channel,io.grpc.CallOptions)

computeDeploymentStatus(ComputeDeploymentStatusRequest request)

public ListenableFuture<ComputeDeploymentStatusResponse> computeDeploymentStatus(ComputeDeploymentStatusRequest request)

Returns the requested deployment status.

Parameter
Name Description
request ComputeDeploymentStatusRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<ComputeDeploymentStatusResponse>

createBlueprint(CreateBlueprintRequest request)

public ListenableFuture<Blueprint> createBlueprint(CreateBlueprintRequest request)

Creates a blueprint.

Parameter
Name Description
request CreateBlueprintRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<Blueprint>

createDeployment(CreateDeploymentRequest request)

public ListenableFuture<Deployment> createDeployment(CreateDeploymentRequest request)

Creates a deployment.

Parameter
Name Description
request CreateDeploymentRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<Deployment>

createEdgeSlm(CreateEdgeSlmRequest request)

public ListenableFuture<Operation> createEdgeSlm(CreateEdgeSlmRequest request)

Creates a new EdgeSlm in a given project and location.

Parameter
Name Description
request CreateEdgeSlmRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<Operation>

createOrchestrationCluster(CreateOrchestrationClusterRequest request)

public ListenableFuture<Operation> createOrchestrationCluster(CreateOrchestrationClusterRequest request)

Creates a new OrchestrationCluster in a given project and location.

Parameter
Name Description
request CreateOrchestrationClusterRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<Operation>

deleteBlueprint(DeleteBlueprintRequest request)

public ListenableFuture<Empty> deleteBlueprint(DeleteBlueprintRequest request)

Deletes a blueprint and all its revisions.

Parameter
Name Description
request DeleteBlueprintRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<Empty>

deleteEdgeSlm(DeleteEdgeSlmRequest request)

public ListenableFuture<Operation> deleteEdgeSlm(DeleteEdgeSlmRequest request)

Deletes a single EdgeSlm.

Parameter
Name Description
request DeleteEdgeSlmRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<Operation>

deleteOrchestrationCluster(DeleteOrchestrationClusterRequest request)

public ListenableFuture<Operation> deleteOrchestrationCluster(DeleteOrchestrationClusterRequest request)

Deletes a single OrchestrationCluster.

Parameter
Name Description
request DeleteOrchestrationClusterRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<Operation>

discardBlueprintChanges(DiscardBlueprintChangesRequest request)

public ListenableFuture<DiscardBlueprintChangesResponse> discardBlueprintChanges(DiscardBlueprintChangesRequest request)

Discards the changes in a blueprint and reverts the blueprint to the last approved blueprint revision. No changes take place if a blueprint does not have revisions.

Parameter
Name Description
request DiscardBlueprintChangesRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<DiscardBlueprintChangesResponse>

discardDeploymentChanges(DiscardDeploymentChangesRequest request)

public ListenableFuture<DiscardDeploymentChangesResponse> discardDeploymentChanges(DiscardDeploymentChangesRequest request)

Discards the changes in a deployment and reverts the deployment to the last approved deployment revision. No changes take place if a deployment does not have revisions.

Parameter
Name Description
request DiscardDeploymentChangesRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<DiscardDeploymentChangesResponse>

getBlueprint(GetBlueprintRequest request)

public ListenableFuture<Blueprint> getBlueprint(GetBlueprintRequest request)

Returns the requested blueprint.

Parameter
Name Description
request GetBlueprintRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<Blueprint>

getDeployment(GetDeploymentRequest request)

public ListenableFuture<Deployment> getDeployment(GetDeploymentRequest request)

Returns the requested deployment.

Parameter
Name Description
request GetDeploymentRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<Deployment>

getEdgeSlm(GetEdgeSlmRequest request)

public ListenableFuture<EdgeSlm> getEdgeSlm(GetEdgeSlmRequest request)

Gets details of a single EdgeSlm.

Parameter
Name Description
request GetEdgeSlmRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<EdgeSlm>

getHydratedDeployment(GetHydratedDeploymentRequest request)

public ListenableFuture<HydratedDeployment> getHydratedDeployment(GetHydratedDeploymentRequest request)

Returns the requested hydrated deployment.

Parameter
Name Description
request GetHydratedDeploymentRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<HydratedDeployment>

getOrchestrationCluster(GetOrchestrationClusterRequest request)

public ListenableFuture<OrchestrationCluster> getOrchestrationCluster(GetOrchestrationClusterRequest request)

Gets details of a single OrchestrationCluster.

Parameter
Name Description
request GetOrchestrationClusterRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<OrchestrationCluster>

getPublicBlueprint(GetPublicBlueprintRequest request)

public ListenableFuture<PublicBlueprint> getPublicBlueprint(GetPublicBlueprintRequest request)

Returns the requested public blueprint.

Parameter
Name Description
request GetPublicBlueprintRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<PublicBlueprint>

listBlueprintRevisions(ListBlueprintRevisionsRequest request)

public ListenableFuture<ListBlueprintRevisionsResponse> listBlueprintRevisions(ListBlueprintRevisionsRequest request)

List blueprint revisions of a given blueprint.

Parameter
Name Description
request ListBlueprintRevisionsRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<ListBlueprintRevisionsResponse>

listBlueprints(ListBlueprintsRequest request)

public ListenableFuture<ListBlueprintsResponse> listBlueprints(ListBlueprintsRequest request)

List all blueprints.

Parameter
Name Description
request ListBlueprintsRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<ListBlueprintsResponse>

listDeploymentRevisions(ListDeploymentRevisionsRequest request)

public ListenableFuture<ListDeploymentRevisionsResponse> listDeploymentRevisions(ListDeploymentRevisionsRequest request)

List deployment revisions of a given deployment.

Parameter
Name Description
request ListDeploymentRevisionsRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<ListDeploymentRevisionsResponse>

listDeployments(ListDeploymentsRequest request)

public ListenableFuture<ListDeploymentsResponse> listDeployments(ListDeploymentsRequest request)

List all deployments.

Parameter
Name Description
request ListDeploymentsRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<ListDeploymentsResponse>

listEdgeSlms(ListEdgeSlmsRequest request)

public ListenableFuture<ListEdgeSlmsResponse> listEdgeSlms(ListEdgeSlmsRequest request)

Lists EdgeSlms in a given project and location.

Parameter
Name Description
request ListEdgeSlmsRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<ListEdgeSlmsResponse>

listHydratedDeployments(ListHydratedDeploymentsRequest request)

public ListenableFuture<ListHydratedDeploymentsResponse> listHydratedDeployments(ListHydratedDeploymentsRequest request)

List all hydrated deployments present under a deployment.

Parameter
Name Description
request ListHydratedDeploymentsRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<ListHydratedDeploymentsResponse>

listOrchestrationClusters(ListOrchestrationClustersRequest request)

public ListenableFuture<ListOrchestrationClustersResponse> listOrchestrationClusters(ListOrchestrationClustersRequest request)

Lists OrchestrationClusters in a given project and location.

Parameter
Name Description
request ListOrchestrationClustersRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<ListOrchestrationClustersResponse>

listPublicBlueprints(ListPublicBlueprintsRequest request)

public ListenableFuture<ListPublicBlueprintsResponse> listPublicBlueprints(ListPublicBlueprintsRequest request)

Lists the blueprints in TNA's public catalog. Default page size = 20, Max Page Size = 100.

Parameter
Name Description
request ListPublicBlueprintsRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<ListPublicBlueprintsResponse>

proposeBlueprint(ProposeBlueprintRequest request)

public ListenableFuture<Blueprint> proposeBlueprint(ProposeBlueprintRequest request)

Proposes a blueprint for approval of changes.

Parameter
Name Description
request ProposeBlueprintRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<Blueprint>

rejectBlueprint(RejectBlueprintRequest request)

public ListenableFuture<Blueprint> rejectBlueprint(RejectBlueprintRequest request)

Rejects a blueprint revision proposal and flips it back to Draft state.

Parameter
Name Description
request RejectBlueprintRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<Blueprint>

removeDeployment(RemoveDeploymentRequest request)

public ListenableFuture<Empty> removeDeployment(RemoveDeploymentRequest request)

Removes the deployment by marking it as DELETING. Post which deployment and it's revisions gets deleted.

Parameter
Name Description
request RemoveDeploymentRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<Empty>

rollbackDeployment(RollbackDeploymentRequest request)

public ListenableFuture<Deployment> rollbackDeployment(RollbackDeploymentRequest request)

Rollback the active deployment to the given past approved deployment revision.

Parameter
Name Description
request RollbackDeploymentRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<Deployment>

searchBlueprintRevisions(SearchBlueprintRevisionsRequest request)

public ListenableFuture<SearchBlueprintRevisionsResponse> searchBlueprintRevisions(SearchBlueprintRevisionsRequest request)

Searches across blueprint revisions.

Parameter
Name Description
request SearchBlueprintRevisionsRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<SearchBlueprintRevisionsResponse>

searchDeploymentRevisions(SearchDeploymentRevisionsRequest request)

public ListenableFuture<SearchDeploymentRevisionsResponse> searchDeploymentRevisions(SearchDeploymentRevisionsRequest request)

Searches across deployment revisions.

Parameter
Name Description
request SearchDeploymentRevisionsRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<SearchDeploymentRevisionsResponse>

updateBlueprint(UpdateBlueprintRequest request)

public ListenableFuture<Blueprint> updateBlueprint(UpdateBlueprintRequest request)

Updates a blueprint.

Parameter
Name Description
request UpdateBlueprintRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<Blueprint>

updateDeployment(UpdateDeploymentRequest request)

public ListenableFuture<Deployment> updateDeployment(UpdateDeploymentRequest request)

Updates a deployment.

Parameter
Name Description
request UpdateDeploymentRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<Deployment>

updateHydratedDeployment(UpdateHydratedDeploymentRequest request)

public ListenableFuture<HydratedDeployment> updateHydratedDeployment(UpdateHydratedDeploymentRequest request)

Updates a hydrated deployment.

Parameter
Name Description
request UpdateHydratedDeploymentRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<HydratedDeployment>