Package flyteidl.service

Class AdminServiceGrpc.AdminServiceBlockingStub

java.lang.Object

io.grpc.stub.AbstractStub<S>

io.grpc.stub.AbstractBlockingStub<AdminServiceGrpc.AdminServiceBlockingStub>

flyteidl.service.AdminServiceGrpc.AdminServiceBlockingStub

Enclosing class:

AdminServiceGrpc

public static final class AdminServiceGrpc.AdminServiceBlockingStub
extends io.grpc.stub.AbstractBlockingStub<AdminServiceGrpc.AdminServiceBlockingStub>

 The following defines an RPC service that is also served over HTTP via grpc-gateway.
 Standard response codes for both are defined here: https://github.com/grpc-ecosystem/grpc-gateway/blob/master/runtime/errors.go
 

Nested Class Summary

Nested classes/interfaces inherited from class io.grpc.stub.AbstractStub

io.grpc.stub.AbstractStub.StubFactory<T extends io.grpc.stub.AbstractStub<T>>

Constructor Summary

Constructors

Modifier	Constructor	Description
private	AdminServiceBlockingStub(io.grpc.Channel channel, io.grpc.CallOptions callOptions)

Method Summary

Modifier and Type	Method	Description
protected AdminServiceGrpc.AdminServiceBlockingStub	build(io.grpc.Channel channel, io.grpc.CallOptions callOptions)
ExecutionOuterClass.ExecutionCreateResponse	createExecution(ExecutionOuterClass.ExecutionCreateRequest request)	Triggers the creation of a :ref:`ref_flyteidl.admin.Execution`
LaunchPlanOuterClass.LaunchPlanCreateResponse	createLaunchPlan(LaunchPlanOuterClass.LaunchPlanCreateRequest request)	Create and upload a :ref:`ref_flyteidl.admin.LaunchPlan` definition
Event.NodeExecutionEventResponse	createNodeEvent(Event.NodeExecutionEventRequest request)	Indicates a :ref:`ref_flyteidl.event.NodeExecutionEvent` has occurred.
TaskOuterClass.TaskCreateResponse	createTask(TaskOuterClass.TaskCreateRequest request)	Create and upload a :ref:`ref_flyteidl.admin.Task` definition
Event.TaskExecutionEventResponse	createTaskEvent(Event.TaskExecutionEventRequest request)	Indicates a :ref:`ref_flyteidl.event.TaskExecutionEvent` has occurred.
WorkflowOuterClass.WorkflowCreateResponse	createWorkflow(WorkflowOuterClass.WorkflowCreateRequest request)	Create and upload a :ref:`ref_flyteidl.admin.Workflow` definition
Event.WorkflowExecutionEventResponse	createWorkflowEvent(Event.WorkflowExecutionEventRequest request)	Indicates a :ref:`ref_flyteidl.event.WorkflowExecutionEvent` has occurred.
ProjectDomainAttributesOuterClass.ProjectDomainAttributesDeleteResponse	deleteProjectDomainAttributes(ProjectDomainAttributesOuterClass.ProjectDomainAttributesDeleteRequest request)	Deletes custom :ref:`ref_flyteidl.admin.MatchableAttributesConfiguration` for a project and domain.
WorkflowAttributesOuterClass.WorkflowAttributesDeleteResponse	deleteWorkflowAttributes(WorkflowAttributesOuterClass.WorkflowAttributesDeleteRequest request)	Deletes custom :ref:`ref_flyteidl.admin.MatchableAttributesConfiguration` for a project, domain and workflow.
LaunchPlanOuterClass.LaunchPlan	getActiveLaunchPlan(LaunchPlanOuterClass.ActiveLaunchPlanRequest request)	Fetch the active version of a :ref:`ref_flyteidl.admin.LaunchPlan`.
ExecutionOuterClass.Execution	getExecution(ExecutionOuterClass.WorkflowExecutionGetRequest request)	Fetches a :ref:`ref_flyteidl.admin.Execution`.
ExecutionOuterClass.WorkflowExecutionGetDataResponse	getExecutionData(ExecutionOuterClass.WorkflowExecutionGetDataRequest request)	Fetches input and output data for a :ref:`ref_flyteidl.admin.Execution`.
LaunchPlanOuterClass.LaunchPlan	getLaunchPlan(Common.ObjectGetRequest request)	Fetch a :ref:`ref_flyteidl.admin.LaunchPlan` definition.
Common.NamedEntity	getNamedEntity(Common.NamedEntityGetRequest request)	Returns a :ref:`ref_flyteidl.admin.NamedEntity` object.
NodeExecutionOuterClass.NodeExecution	getNodeExecution(NodeExecutionOuterClass.NodeExecutionGetRequest request)	Fetches a :ref:`ref_flyteidl.admin.NodeExecution`.
NodeExecutionOuterClass.NodeExecutionGetDataResponse	getNodeExecutionData(NodeExecutionOuterClass.NodeExecutionGetDataRequest request)	Fetches input and output data for a :ref:`ref_flyteidl.admin.NodeExecution`.
ProjectDomainAttributesOuterClass.ProjectDomainAttributesGetResponse	getProjectDomainAttributes(ProjectDomainAttributesOuterClass.ProjectDomainAttributesGetRequest request)	Fetches custom :ref:`ref_flyteidl.admin.MatchableAttributesConfiguration` for a project and domain.
TaskOuterClass.Task	getTask(Common.ObjectGetRequest request)	Fetch a :ref:`ref_flyteidl.admin.Task` definition.
TaskExecutionOuterClass.TaskExecution	getTaskExecution(TaskExecutionOuterClass.TaskExecutionGetRequest request)	Fetches a :ref:`ref_flyteidl.admin.TaskExecution`.
TaskExecutionOuterClass.TaskExecutionGetDataResponse	getTaskExecutionData(TaskExecutionOuterClass.TaskExecutionGetDataRequest request)	Fetches input and output data for a :ref:`ref_flyteidl.admin.TaskExecution`.
VersionOuterClass.GetVersionResponse	getVersion(VersionOuterClass.GetVersionRequest request)
WorkflowOuterClass.Workflow	getWorkflow(Common.ObjectGetRequest request)	Fetch a :ref:`ref_flyteidl.admin.Workflow` definition.
WorkflowAttributesOuterClass.WorkflowAttributesGetResponse	getWorkflowAttributes(WorkflowAttributesOuterClass.WorkflowAttributesGetRequest request)	Fetches custom :ref:`ref_flyteidl.admin.MatchableAttributesConfiguration` for a project, domain and workflow.
LaunchPlanOuterClass.LaunchPlanList	listActiveLaunchPlans(LaunchPlanOuterClass.ActiveLaunchPlanListRequest request)	List active versions of :ref:`ref_flyteidl.admin.LaunchPlan`.
ExecutionOuterClass.ExecutionList	listExecutions(Common.ResourceListRequest request)	Fetch a list of :ref:`ref_flyteidl.admin.Execution`.
Common.NamedEntityIdentifierList	listLaunchPlanIds(Common.NamedEntityIdentifierListRequest request)	Fetch a list of :ref:`ref_flyteidl.admin.NamedEntityIdentifier` of launch plan objects.
LaunchPlanOuterClass.LaunchPlanList	listLaunchPlans(Common.ResourceListRequest request)	Fetch a list of :ref:`ref_flyteidl.admin.LaunchPlan` definitions.
MatchableResourceOuterClass.ListMatchableAttributesResponse	listMatchableAttributes(MatchableResourceOuterClass.ListMatchableAttributesRequest request)	Lists custom :ref:`ref_flyteidl.admin.MatchableAttributesConfiguration` for a specific resource type.
Common.NamedEntityList	listNamedEntities(Common.NamedEntityListRequest request)	Returns a list of :ref:`ref_flyteidl.admin.NamedEntity` objects.
NodeExecutionOuterClass.NodeExecutionList	listNodeExecutions(NodeExecutionOuterClass.NodeExecutionListRequest request)	Fetch a list of :ref:`ref_flyteidl.admin.NodeExecution`.
NodeExecutionOuterClass.NodeExecutionList	listNodeExecutionsForTask(NodeExecutionOuterClass.NodeExecutionForTaskListRequest request)	Fetch a list of :ref:`ref_flyteidl.admin.NodeExecution` launched by the reference :ref:`ref_flyteidl.admin.TaskExecution`.
ProjectOuterClass.Projects	listProjects(ProjectOuterClass.ProjectListRequest request)	Fetches a list of :ref:`ref_flyteidl.admin.Project`
TaskExecutionOuterClass.TaskExecutionList	listTaskExecutions(TaskExecutionOuterClass.TaskExecutionListRequest request)	Fetches a list of :ref:`ref_flyteidl.admin.TaskExecution`.
Common.NamedEntityIdentifierList	listTaskIds(Common.NamedEntityIdentifierListRequest request)	Fetch a list of :ref:`ref_flyteidl.admin.NamedEntityIdentifier` of task objects.
TaskOuterClass.TaskList	listTasks(Common.ResourceListRequest request)	Fetch a list of :ref:`ref_flyteidl.admin.Task` definitions.
Common.NamedEntityIdentifierList	listWorkflowIds(Common.NamedEntityIdentifierListRequest request)	Fetch a list of :ref:`ref_flyteidl.admin.NamedEntityIdentifier` of workflow objects.
WorkflowOuterClass.WorkflowList	listWorkflows(Common.ResourceListRequest request)	Fetch a list of :ref:`ref_flyteidl.admin.Workflow` definitions.
ExecutionOuterClass.ExecutionCreateResponse	recoverExecution(ExecutionOuterClass.ExecutionRecoverRequest request)	Recreates a previously-run workflow execution that will only start executing from the last known failure point.
ProjectOuterClass.ProjectRegisterResponse	registerProject(ProjectOuterClass.ProjectRegisterRequest request)	Registers a :ref:`ref_flyteidl.admin.Project` with the Flyte deployment.
ExecutionOuterClass.ExecutionCreateResponse	relaunchExecution(ExecutionOuterClass.ExecutionRelaunchRequest request)	Triggers the creation of an identical :ref:`ref_flyteidl.admin.Execution`
ExecutionOuterClass.ExecutionTerminateResponse	terminateExecution(ExecutionOuterClass.ExecutionTerminateRequest request)	Terminates an in-progress :ref:`ref_flyteidl.admin.Execution`.
ExecutionOuterClass.ExecutionUpdateResponse	updateExecution(ExecutionOuterClass.ExecutionUpdateRequest request)	Update execution belonging to project domain :ref:`ref_flyteidl.admin.Execution`.
LaunchPlanOuterClass.LaunchPlanUpdateResponse	updateLaunchPlan(LaunchPlanOuterClass.LaunchPlanUpdateRequest request)	Updates the status of a registered :ref:`ref_flyteidl.admin.LaunchPlan`.
Common.NamedEntityUpdateResponse	updateNamedEntity(Common.NamedEntityUpdateRequest request)	Updates a :ref:`ref_flyteidl.admin.NamedEntity` object.
ProjectOuterClass.ProjectUpdateResponse	updateProject(ProjectOuterClass.Project request)	Updates an existing :ref:`ref_flyteidl.admin.Project` flyteidl.admin.Project should be passed but the domains property should be empty; it will be ignored in the handler as domains cannot be updated via this API.
ProjectDomainAttributesOuterClass.ProjectDomainAttributesUpdateResponse	updateProjectDomainAttributes(ProjectDomainAttributesOuterClass.ProjectDomainAttributesUpdateRequest request)	Creates or updates custom :ref:`ref_flyteidl.admin.MatchableAttributesConfiguration` for a project and domain.
WorkflowAttributesOuterClass.WorkflowAttributesUpdateResponse	updateWorkflowAttributes(WorkflowAttributesOuterClass.WorkflowAttributesUpdateRequest request)	Creates or updates custom :ref:`ref_flyteidl.admin.MatchableAttributesConfiguration` for a project, domain and workflow.

Methods inherited from class io.grpc.stub.AbstractBlockingStub

newStub, newStub

Methods inherited from class io.grpc.stub.AbstractStub

getCallOptions, getChannel, withCallCredentials, withChannel, withCompression, withDeadline, withDeadlineAfter, withExecutor, withInterceptors, withMaxInboundMessageSize, withMaxOutboundMessageSize, withOption, withWaitForReady

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AdminServiceBlockingStub

private AdminServiceBlockingStub(io.grpc.Channel channel,
                                 io.grpc.CallOptions callOptions)

Method Detail

build

protected AdminServiceGrpc.AdminServiceBlockingStub build(io.grpc.Channel channel,
                                                          io.grpc.CallOptions callOptions)

Specified by:

build in class io.grpc.stub.AbstractStub<AdminServiceGrpc.AdminServiceBlockingStub>

createTask

public TaskOuterClass.TaskCreateResponse createTask(TaskOuterClass.TaskCreateRequest request)

 Create and upload a :ref:`ref_flyteidl.admin.Task` definition
 

getTask

public TaskOuterClass.Task getTask(Common.ObjectGetRequest request)

 Fetch a :ref:`ref_flyteidl.admin.Task` definition.
 

listTaskIds

public Common.NamedEntityIdentifierList listTaskIds(Common.NamedEntityIdentifierListRequest request)

 Fetch a list of :ref:`ref_flyteidl.admin.NamedEntityIdentifier` of task objects. 
 

listTasks

public TaskOuterClass.TaskList listTasks(Common.ResourceListRequest request)

 Fetch a list of :ref:`ref_flyteidl.admin.Task` definitions.
 

createWorkflow

public WorkflowOuterClass.WorkflowCreateResponse createWorkflow(WorkflowOuterClass.WorkflowCreateRequest request)

 Create and upload a :ref:`ref_flyteidl.admin.Workflow` definition
 

getWorkflow

public WorkflowOuterClass.Workflow getWorkflow(Common.ObjectGetRequest request)

 Fetch a :ref:`ref_flyteidl.admin.Workflow` definition.
 

listWorkflowIds

public Common.NamedEntityIdentifierList listWorkflowIds(Common.NamedEntityIdentifierListRequest request)

 Fetch a list of :ref:`ref_flyteidl.admin.NamedEntityIdentifier` of workflow objects.
 

listWorkflows

public WorkflowOuterClass.WorkflowList listWorkflows(Common.ResourceListRequest request)

 Fetch a list of :ref:`ref_flyteidl.admin.Workflow` definitions.
 

createLaunchPlan

public LaunchPlanOuterClass.LaunchPlanCreateResponse createLaunchPlan(LaunchPlanOuterClass.LaunchPlanCreateRequest request)

 Create and upload a :ref:`ref_flyteidl.admin.LaunchPlan` definition
 

getLaunchPlan

public LaunchPlanOuterClass.LaunchPlan getLaunchPlan(Common.ObjectGetRequest request)

 Fetch a :ref:`ref_flyteidl.admin.LaunchPlan` definition.
 

getActiveLaunchPlan

public LaunchPlanOuterClass.LaunchPlan getActiveLaunchPlan(LaunchPlanOuterClass.ActiveLaunchPlanRequest request)

 Fetch the active version of a :ref:`ref_flyteidl.admin.LaunchPlan`.
 

listActiveLaunchPlans

public LaunchPlanOuterClass.LaunchPlanList listActiveLaunchPlans(LaunchPlanOuterClass.ActiveLaunchPlanListRequest request)

 List active versions of :ref:`ref_flyteidl.admin.LaunchPlan`.
 

listLaunchPlanIds

public Common.NamedEntityIdentifierList listLaunchPlanIds(Common.NamedEntityIdentifierListRequest request)

 Fetch a list of :ref:`ref_flyteidl.admin.NamedEntityIdentifier` of launch plan objects.
 

listLaunchPlans

public LaunchPlanOuterClass.LaunchPlanList listLaunchPlans(Common.ResourceListRequest request)

 Fetch a list of :ref:`ref_flyteidl.admin.LaunchPlan` definitions.
 

updateLaunchPlan

public LaunchPlanOuterClass.LaunchPlanUpdateResponse updateLaunchPlan(LaunchPlanOuterClass.LaunchPlanUpdateRequest request)

 Updates the status of a registered :ref:`ref_flyteidl.admin.LaunchPlan`.
 

createExecution

public ExecutionOuterClass.ExecutionCreateResponse createExecution(ExecutionOuterClass.ExecutionCreateRequest request)

 Triggers the creation of a :ref:`ref_flyteidl.admin.Execution`
 

relaunchExecution

public ExecutionOuterClass.ExecutionCreateResponse relaunchExecution(ExecutionOuterClass.ExecutionRelaunchRequest request)

 Triggers the creation of an identical :ref:`ref_flyteidl.admin.Execution`
 

recoverExecution

public ExecutionOuterClass.ExecutionCreateResponse recoverExecution(ExecutionOuterClass.ExecutionRecoverRequest request)

 Recreates a previously-run workflow execution that will only start executing from the last known failure point.
 In Recover mode, users cannot change any input parameters or update the version of the execution.
 This is extremely useful to recover from system errors and byzantine faults like - Loss of K8s cluster, bugs in platform or instability, machine failures,
 downstream system failures (downstream services), or simply to recover executions that failed because of retry exhaustion and should complete if tried again.
 See :ref:`ref_flyteidl.admin.ExecutionRecoverRequest` for more details.
 

getExecution

public ExecutionOuterClass.Execution getExecution(ExecutionOuterClass.WorkflowExecutionGetRequest request)

 Fetches a :ref:`ref_flyteidl.admin.Execution`.
 

updateExecution

public ExecutionOuterClass.ExecutionUpdateResponse updateExecution(ExecutionOuterClass.ExecutionUpdateRequest request)

 Update execution belonging to project domain :ref:`ref_flyteidl.admin.Execution`.
 

getExecutionData

public ExecutionOuterClass.WorkflowExecutionGetDataResponse getExecutionData(ExecutionOuterClass.WorkflowExecutionGetDataRequest request)

 Fetches input and output data for a :ref:`ref_flyteidl.admin.Execution`.
 

listExecutions

public ExecutionOuterClass.ExecutionList listExecutions(Common.ResourceListRequest request)

 Fetch a list of :ref:`ref_flyteidl.admin.Execution`.
 

terminateExecution

public ExecutionOuterClass.ExecutionTerminateResponse terminateExecution(ExecutionOuterClass.ExecutionTerminateRequest request)

 Terminates an in-progress :ref:`ref_flyteidl.admin.Execution`.
 

getNodeExecution

public NodeExecutionOuterClass.NodeExecution getNodeExecution(NodeExecutionOuterClass.NodeExecutionGetRequest request)

 Fetches a :ref:`ref_flyteidl.admin.NodeExecution`.
 

listNodeExecutions

public NodeExecutionOuterClass.NodeExecutionList listNodeExecutions(NodeExecutionOuterClass.NodeExecutionListRequest request)

 Fetch a list of :ref:`ref_flyteidl.admin.NodeExecution`.
 

listNodeExecutionsForTask

public NodeExecutionOuterClass.NodeExecutionList listNodeExecutionsForTask(NodeExecutionOuterClass.NodeExecutionForTaskListRequest request)

 Fetch a list of :ref:`ref_flyteidl.admin.NodeExecution` launched by the reference :ref:`ref_flyteidl.admin.TaskExecution`.
 

getNodeExecutionData

public NodeExecutionOuterClass.NodeExecutionGetDataResponse getNodeExecutionData(NodeExecutionOuterClass.NodeExecutionGetDataRequest request)

 Fetches input and output data for a :ref:`ref_flyteidl.admin.NodeExecution`.
 

registerProject

public ProjectOuterClass.ProjectRegisterResponse registerProject(ProjectOuterClass.ProjectRegisterRequest request)

 Registers a :ref:`ref_flyteidl.admin.Project` with the Flyte deployment.
 

updateProject

public ProjectOuterClass.ProjectUpdateResponse updateProject(ProjectOuterClass.Project request)

 Updates an existing :ref:`ref_flyteidl.admin.Project` 
 flyteidl.admin.Project should be passed but the domains property should be empty;
 it will be ignored in the handler as domains cannot be updated via this API.
 

listProjects

public ProjectOuterClass.Projects listProjects(ProjectOuterClass.ProjectListRequest request)

 Fetches a list of :ref:`ref_flyteidl.admin.Project` 
 

createWorkflowEvent

public Event.WorkflowExecutionEventResponse createWorkflowEvent(Event.WorkflowExecutionEventRequest request)

 Indicates a :ref:`ref_flyteidl.event.WorkflowExecutionEvent` has occurred.
 

createNodeEvent

public Event.NodeExecutionEventResponse createNodeEvent(Event.NodeExecutionEventRequest request)

 Indicates a :ref:`ref_flyteidl.event.NodeExecutionEvent` has occurred.
 

createTaskEvent

public Event.TaskExecutionEventResponse createTaskEvent(Event.TaskExecutionEventRequest request)

 Indicates a :ref:`ref_flyteidl.event.TaskExecutionEvent` has occurred.
 

getTaskExecution

public TaskExecutionOuterClass.TaskExecution getTaskExecution(TaskExecutionOuterClass.TaskExecutionGetRequest request)

 Fetches a :ref:`ref_flyteidl.admin.TaskExecution`.
 

listTaskExecutions

public TaskExecutionOuterClass.TaskExecutionList listTaskExecutions(TaskExecutionOuterClass.TaskExecutionListRequest request)

 Fetches a list of :ref:`ref_flyteidl.admin.TaskExecution`.
 

getTaskExecutionData

public TaskExecutionOuterClass.TaskExecutionGetDataResponse getTaskExecutionData(TaskExecutionOuterClass.TaskExecutionGetDataRequest request)

 Fetches input and output data for a :ref:`ref_flyteidl.admin.TaskExecution`.
 

updateProjectDomainAttributes

public ProjectDomainAttributesOuterClass.ProjectDomainAttributesUpdateResponse updateProjectDomainAttributes(ProjectDomainAttributesOuterClass.ProjectDomainAttributesUpdateRequest request)

 Creates or updates custom :ref:`ref_flyteidl.admin.MatchableAttributesConfiguration` for a project and domain.
 

getProjectDomainAttributes

public ProjectDomainAttributesOuterClass.ProjectDomainAttributesGetResponse getProjectDomainAttributes(ProjectDomainAttributesOuterClass.ProjectDomainAttributesGetRequest request)

 Fetches custom :ref:`ref_flyteidl.admin.MatchableAttributesConfiguration` for a project and domain.
 

deleteProjectDomainAttributes

public ProjectDomainAttributesOuterClass.ProjectDomainAttributesDeleteResponse deleteProjectDomainAttributes(ProjectDomainAttributesOuterClass.ProjectDomainAttributesDeleteRequest request)

 Deletes custom :ref:`ref_flyteidl.admin.MatchableAttributesConfiguration` for a project and domain.
 

updateWorkflowAttributes

public WorkflowAttributesOuterClass.WorkflowAttributesUpdateResponse updateWorkflowAttributes(WorkflowAttributesOuterClass.WorkflowAttributesUpdateRequest request)

 Creates or updates custom :ref:`ref_flyteidl.admin.MatchableAttributesConfiguration` for a project, domain and workflow.
 

getWorkflowAttributes

public WorkflowAttributesOuterClass.WorkflowAttributesGetResponse getWorkflowAttributes(WorkflowAttributesOuterClass.WorkflowAttributesGetRequest request)

 Fetches custom :ref:`ref_flyteidl.admin.MatchableAttributesConfiguration` for a project, domain and workflow.
 

deleteWorkflowAttributes

public WorkflowAttributesOuterClass.WorkflowAttributesDeleteResponse deleteWorkflowAttributes(WorkflowAttributesOuterClass.WorkflowAttributesDeleteRequest request)

 Deletes custom :ref:`ref_flyteidl.admin.MatchableAttributesConfiguration` for a project, domain and workflow.
 

listMatchableAttributes

public MatchableResourceOuterClass.ListMatchableAttributesResponse listMatchableAttributes(MatchableResourceOuterClass.ListMatchableAttributesRequest request)

 Lists custom :ref:`ref_flyteidl.admin.MatchableAttributesConfiguration` for a specific resource type.
 

listNamedEntities

public Common.NamedEntityList listNamedEntities(Common.NamedEntityListRequest request)

 Returns a list of :ref:`ref_flyteidl.admin.NamedEntity` objects.
 

getNamedEntity

public Common.NamedEntity getNamedEntity(Common.NamedEntityGetRequest request)

 Returns a :ref:`ref_flyteidl.admin.NamedEntity` object.
 

updateNamedEntity

public Common.NamedEntityUpdateResponse updateNamedEntity(Common.NamedEntityUpdateRequest request)

 Updates a :ref:`ref_flyteidl.admin.NamedEntity` object.
 

getVersion

public VersionOuterClass.GetVersionResponse getVersion(VersionOuterClass.GetVersionRequest request)