job

Documentation

Index

• type Provider
  • func NewDefaultJobProvider() Provider
• type UnsupportedJobProvider
  • func (u *UnsupportedJobProvider) EnumerateJobs(ctx context.Context, in *api.SdkEnumerateJobsRequest) (*api.SdkEnumerateJobsResponse, error)
  • func (u *UnsupportedJobProvider) GetJobStatus(ctx context.Context, in *api.SdkGetJobStatusRequest) (*api.SdkGetJobStatusResponse, error)
  • func (u *UnsupportedJobProvider) UpdateJobState(ctx context.Context, in *api.SdkUpdateJobRequest) (*api.SdkUpdateJobResponse, error)

Types

type Provider

type Provider interface {
	// UpdateJobState updates an existing job
	// Only acceptable values are
	// JobState_PAUSED - acceptable only from running state
	// JobState_CANCELLED - acceptable only from running/pause state
	// JobState_RUNNING - acceptable only from pause state
	UpdateJobState(ctx context.Context, in *api.SdkUpdateJobRequest) (*api.SdkUpdateJobResponse, error)
	// GetJobStatus gets the status of a job
	GetJobStatus(ctx context.Context, in *api.SdkGetJobStatusRequest) (*api.SdkGetJobStatusResponse, error)
	// EnumerateJobs returns all the jobs currently known to the system
	EnumerateJobs(ctx context.Context, in *api.SdkEnumerateJobsRequest) (*api.SdkEnumerateJobsResponse, error)
}

Provider implements the APIs for executing and querying asynchronous jobs

func NewDefaultJobProvider

func NewDefaultJobProvider() Provider

NewDefaultJobProvider does not support asynchronous jobs

type UnsupportedJobProvider

type UnsupportedJobProvider struct {
}

UnsupportedJobProvider unsupported implementation of jobs APIs

func (*UnsupportedJobProvider) EnumerateJobs

func (u *UnsupportedJobProvider) EnumerateJobs(ctx context.Context, in *api.SdkEnumerateJobsRequest) (*api.SdkEnumerateJobsResponse, error)

func (*UnsupportedJobProvider) GetJobStatus

func (u *UnsupportedJobProvider) GetJobStatus(ctx context.Context, in *api.SdkGetJobStatusRequest) (*api.SdkGetJobStatusResponse, error)

func (*UnsupportedJobProvider) UpdateJobState

func (u *UnsupportedJobProvider) UpdateJobState(ctx context.Context, in *api.SdkUpdateJobRequest) (*api.SdkUpdateJobResponse, error)