service

package
v0.21.8 Latest Latest
Warning

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

Go to latest
Published: Oct 28, 2021 License: Apache-2.0 Imports: 23 Imported by: 36

Documentation

Overview

Package service is a reverse proxy.

It translates gRPC into RESTful JSON APIs.

Package service is a reverse proxy.

It translates gRPC into RESTful JSON APIs.

Package service is a reverse proxy.

It translates gRPC into RESTful JSON APIs.

Package service generated by go-bindata.// sources: ../service/admin.swagger.json

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func Asset

func Asset(name string) ([]byte, error)

Asset loads and returns the asset for the given name. It returns an error if the asset could not be found or could not be loaded.

func AssetDir

func AssetDir(name string) ([]string, error)

AssetDir returns the file names below a certain directory embedded in the file by go-bindata. For example if you run go-bindata on data/... and data contains the following hierarchy:

data/
  foo.txt
  img/
    a.png
    b.png

then AssetDir("data") would return []string{"foo.txt", "img"} AssetDir("data/img") would return []string{"a.png", "b.png"} AssetDir("foo.txt") and AssetDir("notexist") would return an error AssetDir("") will return []string{"data"}.

func AssetInfo

func AssetInfo(name string) (os.FileInfo, error)

AssetInfo loads and returns the asset info for the given name. It returns an error if the asset could not be found or could not be loaded.

func AssetNames

func AssetNames() []string

AssetNames returns the names of the assets.

func MustAsset

func MustAsset(name string) []byte

MustAsset is like Asset but panics when Asset would return an error. It simplifies safe initialization of global variables.

func RegisterAdminServiceHandler

func RegisterAdminServiceHandler(ctx context.Context, mux *runtime.ServeMux, conn *grpc.ClientConn) error

RegisterAdminServiceHandler registers the http handlers for service AdminService to "mux". The handlers forward requests to the grpc endpoint over "conn".

func RegisterAdminServiceHandlerClient

func RegisterAdminServiceHandlerClient(ctx context.Context, mux *runtime.ServeMux, client AdminServiceClient) error

RegisterAdminServiceHandlerClient registers the http handlers for service AdminService to "mux". The handlers forward requests to the grpc endpoint over the given implementation of "AdminServiceClient". Note: the gRPC framework executes interceptors within the gRPC handler. If the passed in "AdminServiceClient" doesn't go through the normal gRPC flow (creating a gRPC client etc.) then it will be up to the passed in "AdminServiceClient" to call the correct interceptors.

func RegisterAdminServiceHandlerFromEndpoint

func RegisterAdminServiceHandlerFromEndpoint(ctx context.Context, mux *runtime.ServeMux, endpoint string, opts []grpc.DialOption) (err error)

RegisterAdminServiceHandlerFromEndpoint is same as RegisterAdminServiceHandler but automatically dials to "endpoint" and closes the connection when "ctx" gets done.

func RegisterAdminServiceServer

func RegisterAdminServiceServer(s *grpc.Server, srv AdminServiceServer)

func RegisterAuthMetadataServiceHandler added in v0.18.40

func RegisterAuthMetadataServiceHandler(ctx context.Context, mux *runtime.ServeMux, conn *grpc.ClientConn) error

RegisterAuthMetadataServiceHandler registers the http handlers for service AuthMetadataService to "mux". The handlers forward requests to the grpc endpoint over "conn".

func RegisterAuthMetadataServiceHandlerClient added in v0.18.40

func RegisterAuthMetadataServiceHandlerClient(ctx context.Context, mux *runtime.ServeMux, client AuthMetadataServiceClient) error

RegisterAuthMetadataServiceHandlerClient registers the http handlers for service AuthMetadataService to "mux". The handlers forward requests to the grpc endpoint over the given implementation of "AuthMetadataServiceClient". Note: the gRPC framework executes interceptors within the gRPC handler. If the passed in "AuthMetadataServiceClient" doesn't go through the normal gRPC flow (creating a gRPC client etc.) then it will be up to the passed in "AuthMetadataServiceClient" to call the correct interceptors.

func RegisterAuthMetadataServiceHandlerFromEndpoint added in v0.18.40

func RegisterAuthMetadataServiceHandlerFromEndpoint(ctx context.Context, mux *runtime.ServeMux, endpoint string, opts []grpc.DialOption) (err error)

RegisterAuthMetadataServiceHandlerFromEndpoint is same as RegisterAuthMetadataServiceHandler but automatically dials to "endpoint" and closes the connection when "ctx" gets done.

func RegisterAuthMetadataServiceServer added in v0.18.40

func RegisterAuthMetadataServiceServer(s *grpc.Server, srv AuthMetadataServiceServer)

func RegisterIdentityServiceHandler added in v0.18.40

func RegisterIdentityServiceHandler(ctx context.Context, mux *runtime.ServeMux, conn *grpc.ClientConn) error

RegisterIdentityServiceHandler registers the http handlers for service IdentityService to "mux". The handlers forward requests to the grpc endpoint over "conn".

func RegisterIdentityServiceHandlerClient added in v0.18.40

func RegisterIdentityServiceHandlerClient(ctx context.Context, mux *runtime.ServeMux, client IdentityServiceClient) error

RegisterIdentityServiceHandlerClient registers the http handlers for service IdentityService to "mux". The handlers forward requests to the grpc endpoint over the given implementation of "IdentityServiceClient". Note: the gRPC framework executes interceptors within the gRPC handler. If the passed in "IdentityServiceClient" doesn't go through the normal gRPC flow (creating a gRPC client etc.) then it will be up to the passed in "IdentityServiceClient" to call the correct interceptors.

func RegisterIdentityServiceHandlerFromEndpoint added in v0.18.40

func RegisterIdentityServiceHandlerFromEndpoint(ctx context.Context, mux *runtime.ServeMux, endpoint string, opts []grpc.DialOption) (err error)

RegisterIdentityServiceHandlerFromEndpoint is same as RegisterIdentityServiceHandler but automatically dials to "endpoint" and closes the connection when "ctx" gets done.

func RegisterIdentityServiceServer added in v0.18.40

func RegisterIdentityServiceServer(s *grpc.Server, srv IdentityServiceServer)

func RestoreAsset

func RestoreAsset(dir, name string) error

RestoreAsset restores an asset under the given directory

func RestoreAssets

func RestoreAssets(dir, name string) error

RestoreAssets restores an asset under the given directory recursively

Types

type AdminServiceClient

type AdminServiceClient interface {
	// Create and upload a :ref:`ref_flyteidl.admin.Task` definition
	CreateTask(ctx context.Context, in *admin.TaskCreateRequest, opts ...grpc.CallOption) (*admin.TaskCreateResponse, error)
	// Fetch a :ref:`ref_flyteidl.admin.Task` definition.
	GetTask(ctx context.Context, in *admin.ObjectGetRequest, opts ...grpc.CallOption) (*admin.Task, error)
	// Fetch a list of :ref:`ref_flyteidl.admin.NamedEntityIdentifier` of task objects.
	ListTaskIds(ctx context.Context, in *admin.NamedEntityIdentifierListRequest, opts ...grpc.CallOption) (*admin.NamedEntityIdentifierList, error)
	// Fetch a list of :ref:`ref_flyteidl.admin.Task` definitions.
	ListTasks(ctx context.Context, in *admin.ResourceListRequest, opts ...grpc.CallOption) (*admin.TaskList, error)
	// Create and upload a :ref:`ref_flyteidl.admin.Workflow` definition
	CreateWorkflow(ctx context.Context, in *admin.WorkflowCreateRequest, opts ...grpc.CallOption) (*admin.WorkflowCreateResponse, error)
	// Fetch a :ref:`ref_flyteidl.admin.Workflow` definition.
	GetWorkflow(ctx context.Context, in *admin.ObjectGetRequest, opts ...grpc.CallOption) (*admin.Workflow, error)
	// Fetch a list of :ref:`ref_flyteidl.admin.NamedEntityIdentifier` of workflow objects.
	ListWorkflowIds(ctx context.Context, in *admin.NamedEntityIdentifierListRequest, opts ...grpc.CallOption) (*admin.NamedEntityIdentifierList, error)
	// Fetch a list of :ref:`ref_flyteidl.admin.Workflow` definitions.
	ListWorkflows(ctx context.Context, in *admin.ResourceListRequest, opts ...grpc.CallOption) (*admin.WorkflowList, error)
	// Create and upload a :ref:`ref_flyteidl.admin.LaunchPlan` definition
	CreateLaunchPlan(ctx context.Context, in *admin.LaunchPlanCreateRequest, opts ...grpc.CallOption) (*admin.LaunchPlanCreateResponse, error)
	// Fetch a :ref:`ref_flyteidl.admin.LaunchPlan` definition.
	GetLaunchPlan(ctx context.Context, in *admin.ObjectGetRequest, opts ...grpc.CallOption) (*admin.LaunchPlan, error)
	// Fetch the active version of a :ref:`ref_flyteidl.admin.LaunchPlan`.
	GetActiveLaunchPlan(ctx context.Context, in *admin.ActiveLaunchPlanRequest, opts ...grpc.CallOption) (*admin.LaunchPlan, error)
	// List active versions of :ref:`ref_flyteidl.admin.LaunchPlan`.
	ListActiveLaunchPlans(ctx context.Context, in *admin.ActiveLaunchPlanListRequest, opts ...grpc.CallOption) (*admin.LaunchPlanList, error)
	// Fetch a list of :ref:`ref_flyteidl.admin.NamedEntityIdentifier` of launch plan objects.
	ListLaunchPlanIds(ctx context.Context, in *admin.NamedEntityIdentifierListRequest, opts ...grpc.CallOption) (*admin.NamedEntityIdentifierList, error)
	// Fetch a list of :ref:`ref_flyteidl.admin.LaunchPlan` definitions.
	ListLaunchPlans(ctx context.Context, in *admin.ResourceListRequest, opts ...grpc.CallOption) (*admin.LaunchPlanList, error)
	// Updates the status of a registered :ref:`ref_flyteidl.admin.LaunchPlan`.
	UpdateLaunchPlan(ctx context.Context, in *admin.LaunchPlanUpdateRequest, opts ...grpc.CallOption) (*admin.LaunchPlanUpdateResponse, error)
	// Triggers the creation of a :ref:`ref_flyteidl.admin.Execution`
	CreateExecution(ctx context.Context, in *admin.ExecutionCreateRequest, opts ...grpc.CallOption) (*admin.ExecutionCreateResponse, error)
	// Triggers the creation of an identical :ref:`ref_flyteidl.admin.Execution`
	RelaunchExecution(ctx context.Context, in *admin.ExecutionRelaunchRequest, opts ...grpc.CallOption) (*admin.ExecutionCreateResponse, error)
	// 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.
	RecoverExecution(ctx context.Context, in *admin.ExecutionRecoverRequest, opts ...grpc.CallOption) (*admin.ExecutionCreateResponse, error)
	// Fetches a :ref:`ref_flyteidl.admin.Execution`.
	GetExecution(ctx context.Context, in *admin.WorkflowExecutionGetRequest, opts ...grpc.CallOption) (*admin.Execution, error)
	// Fetches input and output data for a :ref:`ref_flyteidl.admin.Execution`.
	GetExecutionData(ctx context.Context, in *admin.WorkflowExecutionGetDataRequest, opts ...grpc.CallOption) (*admin.WorkflowExecutionGetDataResponse, error)
	// Fetch a list of :ref:`ref_flyteidl.admin.Execution`.
	ListExecutions(ctx context.Context, in *admin.ResourceListRequest, opts ...grpc.CallOption) (*admin.ExecutionList, error)
	// Terminates an in-progress :ref:`ref_flyteidl.admin.Execution`.
	TerminateExecution(ctx context.Context, in *admin.ExecutionTerminateRequest, opts ...grpc.CallOption) (*admin.ExecutionTerminateResponse, error)
	// Fetches a :ref:`ref_flyteidl.admin.NodeExecution`.
	GetNodeExecution(ctx context.Context, in *admin.NodeExecutionGetRequest, opts ...grpc.CallOption) (*admin.NodeExecution, error)
	// Fetch a list of :ref:`ref_flyteidl.admin.NodeExecution`.
	ListNodeExecutions(ctx context.Context, in *admin.NodeExecutionListRequest, opts ...grpc.CallOption) (*admin.NodeExecutionList, error)
	// Fetch a list of :ref:`ref_flyteidl.admin.NodeExecution` launched by the reference :ref:`ref_flyteidl.admin.TaskExecution`.
	ListNodeExecutionsForTask(ctx context.Context, in *admin.NodeExecutionForTaskListRequest, opts ...grpc.CallOption) (*admin.NodeExecutionList, error)
	// Fetches input and output data for a :ref:`ref_flyteidl.admin.NodeExecution`.
	GetNodeExecutionData(ctx context.Context, in *admin.NodeExecutionGetDataRequest, opts ...grpc.CallOption) (*admin.NodeExecutionGetDataResponse, error)
	// Registers a :ref:`ref_flyteidl.admin.Project` with the Flyte deployment.
	RegisterProject(ctx context.Context, in *admin.ProjectRegisterRequest, opts ...grpc.CallOption) (*admin.ProjectRegisterResponse, error)
	// 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.
	UpdateProject(ctx context.Context, in *admin.Project, opts ...grpc.CallOption) (*admin.ProjectUpdateResponse, error)
	// Fetches a list of :ref:`ref_flyteidl.admin.Project`
	ListProjects(ctx context.Context, in *admin.ProjectListRequest, opts ...grpc.CallOption) (*admin.Projects, error)
	// Indicates a :ref:`ref_flyteidl.event.WorkflowExecutionEvent` has occurred.
	CreateWorkflowEvent(ctx context.Context, in *admin.WorkflowExecutionEventRequest, opts ...grpc.CallOption) (*admin.WorkflowExecutionEventResponse, error)
	// Indicates a :ref:`ref_flyteidl.event.NodeExecutionEvent` has occurred.
	CreateNodeEvent(ctx context.Context, in *admin.NodeExecutionEventRequest, opts ...grpc.CallOption) (*admin.NodeExecutionEventResponse, error)
	// Indicates a :ref:`ref_flyteidl.event.TaskExecutionEvent` has occurred.
	CreateTaskEvent(ctx context.Context, in *admin.TaskExecutionEventRequest, opts ...grpc.CallOption) (*admin.TaskExecutionEventResponse, error)
	// Fetches a :ref:`ref_flyteidl.admin.TaskExecution`.
	GetTaskExecution(ctx context.Context, in *admin.TaskExecutionGetRequest, opts ...grpc.CallOption) (*admin.TaskExecution, error)
	// Fetches a list of :ref:`ref_flyteidl.admin.TaskExecution`.
	ListTaskExecutions(ctx context.Context, in *admin.TaskExecutionListRequest, opts ...grpc.CallOption) (*admin.TaskExecutionList, error)
	// Fetches input and output data for a :ref:`ref_flyteidl.admin.TaskExecution`.
	GetTaskExecutionData(ctx context.Context, in *admin.TaskExecutionGetDataRequest, opts ...grpc.CallOption) (*admin.TaskExecutionGetDataResponse, error)
	// Creates or updates custom :ref:`ref_flyteidl.admin.MatchableAttributesConfiguration` for a project and domain.
	UpdateProjectDomainAttributes(ctx context.Context, in *admin.ProjectDomainAttributesUpdateRequest, opts ...grpc.CallOption) (*admin.ProjectDomainAttributesUpdateResponse, error)
	// Fetches custom :ref:`ref_flyteidl.admin.MatchableAttributesConfiguration` for a project and domain.
	GetProjectDomainAttributes(ctx context.Context, in *admin.ProjectDomainAttributesGetRequest, opts ...grpc.CallOption) (*admin.ProjectDomainAttributesGetResponse, error)
	// Deletes custom :ref:`ref_flyteidl.admin.MatchableAttributesConfiguration` for a project and domain.
	DeleteProjectDomainAttributes(ctx context.Context, in *admin.ProjectDomainAttributesDeleteRequest, opts ...grpc.CallOption) (*admin.ProjectDomainAttributesDeleteResponse, error)
	// Creates or updates custom :ref:`ref_flyteidl.admin.MatchableAttributesConfiguration` for a project, domain and workflow.
	UpdateWorkflowAttributes(ctx context.Context, in *admin.WorkflowAttributesUpdateRequest, opts ...grpc.CallOption) (*admin.WorkflowAttributesUpdateResponse, error)
	// Fetches custom :ref:`ref_flyteidl.admin.MatchableAttributesConfiguration` for a project, domain and workflow.
	GetWorkflowAttributes(ctx context.Context, in *admin.WorkflowAttributesGetRequest, opts ...grpc.CallOption) (*admin.WorkflowAttributesGetResponse, error)
	// Deletes custom :ref:`ref_flyteidl.admin.MatchableAttributesConfiguration` for a project, domain and workflow.
	DeleteWorkflowAttributes(ctx context.Context, in *admin.WorkflowAttributesDeleteRequest, opts ...grpc.CallOption) (*admin.WorkflowAttributesDeleteResponse, error)
	// Lists custom :ref:`ref_flyteidl.admin.MatchableAttributesConfiguration` for a specific resource type.
	ListMatchableAttributes(ctx context.Context, in *admin.ListMatchableAttributesRequest, opts ...grpc.CallOption) (*admin.ListMatchableAttributesResponse, error)
	// Returns a list of :ref:`ref_flyteidl.admin.NamedEntity` objects.
	ListNamedEntities(ctx context.Context, in *admin.NamedEntityListRequest, opts ...grpc.CallOption) (*admin.NamedEntityList, error)
	// Returns a :ref:`ref_flyteidl.admin.NamedEntity` object.
	GetNamedEntity(ctx context.Context, in *admin.NamedEntityGetRequest, opts ...grpc.CallOption) (*admin.NamedEntity, error)
	// Updates a :ref:`ref_flyteidl.admin.NamedEntity` object.
	UpdateNamedEntity(ctx context.Context, in *admin.NamedEntityUpdateRequest, opts ...grpc.CallOption) (*admin.NamedEntityUpdateResponse, error)
	GetVersion(ctx context.Context, in *admin.GetVersionRequest, opts ...grpc.CallOption) (*admin.GetVersionResponse, error)
}

AdminServiceClient is the client API for AdminService service.

For semantics around ctx use and closing/ending streaming RPCs, please refer to https://godoc.org/google.golang.org/grpc#ClientConn.NewStream.

func NewAdminServiceClient

func NewAdminServiceClient(cc *grpc.ClientConn) AdminServiceClient

type AdminServiceServer

type AdminServiceServer interface {
	// Create and upload a :ref:`ref_flyteidl.admin.Task` definition
	CreateTask(context.Context, *admin.TaskCreateRequest) (*admin.TaskCreateResponse, error)
	// Fetch a :ref:`ref_flyteidl.admin.Task` definition.
	GetTask(context.Context, *admin.ObjectGetRequest) (*admin.Task, error)
	// Fetch a list of :ref:`ref_flyteidl.admin.NamedEntityIdentifier` of task objects.
	ListTaskIds(context.Context, *admin.NamedEntityIdentifierListRequest) (*admin.NamedEntityIdentifierList, error)
	// Fetch a list of :ref:`ref_flyteidl.admin.Task` definitions.
	ListTasks(context.Context, *admin.ResourceListRequest) (*admin.TaskList, error)
	// Create and upload a :ref:`ref_flyteidl.admin.Workflow` definition
	CreateWorkflow(context.Context, *admin.WorkflowCreateRequest) (*admin.WorkflowCreateResponse, error)
	// Fetch a :ref:`ref_flyteidl.admin.Workflow` definition.
	GetWorkflow(context.Context, *admin.ObjectGetRequest) (*admin.Workflow, error)
	// Fetch a list of :ref:`ref_flyteidl.admin.NamedEntityIdentifier` of workflow objects.
	ListWorkflowIds(context.Context, *admin.NamedEntityIdentifierListRequest) (*admin.NamedEntityIdentifierList, error)
	// Fetch a list of :ref:`ref_flyteidl.admin.Workflow` definitions.
	ListWorkflows(context.Context, *admin.ResourceListRequest) (*admin.WorkflowList, error)
	// Create and upload a :ref:`ref_flyteidl.admin.LaunchPlan` definition
	CreateLaunchPlan(context.Context, *admin.LaunchPlanCreateRequest) (*admin.LaunchPlanCreateResponse, error)
	// Fetch a :ref:`ref_flyteidl.admin.LaunchPlan` definition.
	GetLaunchPlan(context.Context, *admin.ObjectGetRequest) (*admin.LaunchPlan, error)
	// Fetch the active version of a :ref:`ref_flyteidl.admin.LaunchPlan`.
	GetActiveLaunchPlan(context.Context, *admin.ActiveLaunchPlanRequest) (*admin.LaunchPlan, error)
	// List active versions of :ref:`ref_flyteidl.admin.LaunchPlan`.
	ListActiveLaunchPlans(context.Context, *admin.ActiveLaunchPlanListRequest) (*admin.LaunchPlanList, error)
	// Fetch a list of :ref:`ref_flyteidl.admin.NamedEntityIdentifier` of launch plan objects.
	ListLaunchPlanIds(context.Context, *admin.NamedEntityIdentifierListRequest) (*admin.NamedEntityIdentifierList, error)
	// Fetch a list of :ref:`ref_flyteidl.admin.LaunchPlan` definitions.
	ListLaunchPlans(context.Context, *admin.ResourceListRequest) (*admin.LaunchPlanList, error)
	// Updates the status of a registered :ref:`ref_flyteidl.admin.LaunchPlan`.
	UpdateLaunchPlan(context.Context, *admin.LaunchPlanUpdateRequest) (*admin.LaunchPlanUpdateResponse, error)
	// Triggers the creation of a :ref:`ref_flyteidl.admin.Execution`
	CreateExecution(context.Context, *admin.ExecutionCreateRequest) (*admin.ExecutionCreateResponse, error)
	// Triggers the creation of an identical :ref:`ref_flyteidl.admin.Execution`
	RelaunchExecution(context.Context, *admin.ExecutionRelaunchRequest) (*admin.ExecutionCreateResponse, error)
	// 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.
	RecoverExecution(context.Context, *admin.ExecutionRecoverRequest) (*admin.ExecutionCreateResponse, error)
	// Fetches a :ref:`ref_flyteidl.admin.Execution`.
	GetExecution(context.Context, *admin.WorkflowExecutionGetRequest) (*admin.Execution, error)
	// Fetches input and output data for a :ref:`ref_flyteidl.admin.Execution`.
	GetExecutionData(context.Context, *admin.WorkflowExecutionGetDataRequest) (*admin.WorkflowExecutionGetDataResponse, error)
	// Fetch a list of :ref:`ref_flyteidl.admin.Execution`.
	ListExecutions(context.Context, *admin.ResourceListRequest) (*admin.ExecutionList, error)
	// Terminates an in-progress :ref:`ref_flyteidl.admin.Execution`.
	TerminateExecution(context.Context, *admin.ExecutionTerminateRequest) (*admin.ExecutionTerminateResponse, error)
	// Fetches a :ref:`ref_flyteidl.admin.NodeExecution`.
	GetNodeExecution(context.Context, *admin.NodeExecutionGetRequest) (*admin.NodeExecution, error)
	// Fetch a list of :ref:`ref_flyteidl.admin.NodeExecution`.
	ListNodeExecutions(context.Context, *admin.NodeExecutionListRequest) (*admin.NodeExecutionList, error)
	// Fetch a list of :ref:`ref_flyteidl.admin.NodeExecution` launched by the reference :ref:`ref_flyteidl.admin.TaskExecution`.
	ListNodeExecutionsForTask(context.Context, *admin.NodeExecutionForTaskListRequest) (*admin.NodeExecutionList, error)
	// Fetches input and output data for a :ref:`ref_flyteidl.admin.NodeExecution`.
	GetNodeExecutionData(context.Context, *admin.NodeExecutionGetDataRequest) (*admin.NodeExecutionGetDataResponse, error)
	// Registers a :ref:`ref_flyteidl.admin.Project` with the Flyte deployment.
	RegisterProject(context.Context, *admin.ProjectRegisterRequest) (*admin.ProjectRegisterResponse, error)
	// 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.
	UpdateProject(context.Context, *admin.Project) (*admin.ProjectUpdateResponse, error)
	// Fetches a list of :ref:`ref_flyteidl.admin.Project`
	ListProjects(context.Context, *admin.ProjectListRequest) (*admin.Projects, error)
	// Indicates a :ref:`ref_flyteidl.event.WorkflowExecutionEvent` has occurred.
	CreateWorkflowEvent(context.Context, *admin.WorkflowExecutionEventRequest) (*admin.WorkflowExecutionEventResponse, error)
	// Indicates a :ref:`ref_flyteidl.event.NodeExecutionEvent` has occurred.
	CreateNodeEvent(context.Context, *admin.NodeExecutionEventRequest) (*admin.NodeExecutionEventResponse, error)
	// Indicates a :ref:`ref_flyteidl.event.TaskExecutionEvent` has occurred.
	CreateTaskEvent(context.Context, *admin.TaskExecutionEventRequest) (*admin.TaskExecutionEventResponse, error)
	// Fetches a :ref:`ref_flyteidl.admin.TaskExecution`.
	GetTaskExecution(context.Context, *admin.TaskExecutionGetRequest) (*admin.TaskExecution, error)
	// Fetches a list of :ref:`ref_flyteidl.admin.TaskExecution`.
	ListTaskExecutions(context.Context, *admin.TaskExecutionListRequest) (*admin.TaskExecutionList, error)
	// Fetches input and output data for a :ref:`ref_flyteidl.admin.TaskExecution`.
	GetTaskExecutionData(context.Context, *admin.TaskExecutionGetDataRequest) (*admin.TaskExecutionGetDataResponse, error)
	// Creates or updates custom :ref:`ref_flyteidl.admin.MatchableAttributesConfiguration` for a project and domain.
	UpdateProjectDomainAttributes(context.Context, *admin.ProjectDomainAttributesUpdateRequest) (*admin.ProjectDomainAttributesUpdateResponse, error)
	// Fetches custom :ref:`ref_flyteidl.admin.MatchableAttributesConfiguration` for a project and domain.
	GetProjectDomainAttributes(context.Context, *admin.ProjectDomainAttributesGetRequest) (*admin.ProjectDomainAttributesGetResponse, error)
	// Deletes custom :ref:`ref_flyteidl.admin.MatchableAttributesConfiguration` for a project and domain.
	DeleteProjectDomainAttributes(context.Context, *admin.ProjectDomainAttributesDeleteRequest) (*admin.ProjectDomainAttributesDeleteResponse, error)
	// Creates or updates custom :ref:`ref_flyteidl.admin.MatchableAttributesConfiguration` for a project, domain and workflow.
	UpdateWorkflowAttributes(context.Context, *admin.WorkflowAttributesUpdateRequest) (*admin.WorkflowAttributesUpdateResponse, error)
	// Fetches custom :ref:`ref_flyteidl.admin.MatchableAttributesConfiguration` for a project, domain and workflow.
	GetWorkflowAttributes(context.Context, *admin.WorkflowAttributesGetRequest) (*admin.WorkflowAttributesGetResponse, error)
	// Deletes custom :ref:`ref_flyteidl.admin.MatchableAttributesConfiguration` for a project, domain and workflow.
	DeleteWorkflowAttributes(context.Context, *admin.WorkflowAttributesDeleteRequest) (*admin.WorkflowAttributesDeleteResponse, error)
	// Lists custom :ref:`ref_flyteidl.admin.MatchableAttributesConfiguration` for a specific resource type.
	ListMatchableAttributes(context.Context, *admin.ListMatchableAttributesRequest) (*admin.ListMatchableAttributesResponse, error)
	// Returns a list of :ref:`ref_flyteidl.admin.NamedEntity` objects.
	ListNamedEntities(context.Context, *admin.NamedEntityListRequest) (*admin.NamedEntityList, error)
	// Returns a :ref:`ref_flyteidl.admin.NamedEntity` object.
	GetNamedEntity(context.Context, *admin.NamedEntityGetRequest) (*admin.NamedEntity, error)
	// Updates a :ref:`ref_flyteidl.admin.NamedEntity` object.
	UpdateNamedEntity(context.Context, *admin.NamedEntityUpdateRequest) (*admin.NamedEntityUpdateResponse, error)
	GetVersion(context.Context, *admin.GetVersionRequest) (*admin.GetVersionResponse, error)
}

AdminServiceServer is the server API for AdminService service.

type AuthMetadataServiceClient added in v0.18.40

type AuthMetadataServiceClient interface {
	// Anonymously accessible. Retrieves local or external oauth authorization server metadata.
	GetOAuth2Metadata(ctx context.Context, in *OAuth2MetadataRequest, opts ...grpc.CallOption) (*OAuth2MetadataResponse, error)
	// Anonymously accessible. Retrieves the client information clients should use when initiating OAuth2 authorization
	// requests.
	GetPublicClientConfig(ctx context.Context, in *PublicClientAuthConfigRequest, opts ...grpc.CallOption) (*PublicClientAuthConfigResponse, error)
}

AuthMetadataServiceClient is the client API for AuthMetadataService service.

For semantics around ctx use and closing/ending streaming RPCs, please refer to https://godoc.org/google.golang.org/grpc#ClientConn.NewStream.

func NewAuthMetadataServiceClient added in v0.18.40

func NewAuthMetadataServiceClient(cc *grpc.ClientConn) AuthMetadataServiceClient

type AuthMetadataServiceServer added in v0.18.40

type AuthMetadataServiceServer interface {
	// Anonymously accessible. Retrieves local or external oauth authorization server metadata.
	GetOAuth2Metadata(context.Context, *OAuth2MetadataRequest) (*OAuth2MetadataResponse, error)
	// Anonymously accessible. Retrieves the client information clients should use when initiating OAuth2 authorization
	// requests.
	GetPublicClientConfig(context.Context, *PublicClientAuthConfigRequest) (*PublicClientAuthConfigResponse, error)
}

AuthMetadataServiceServer is the server API for AuthMetadataService service.

type IdentityServiceClient added in v0.18.40

type IdentityServiceClient interface {
	// Retrieves user information about the currently logged in user.
	UserInfo(ctx context.Context, in *UserInfoRequest, opts ...grpc.CallOption) (*UserInfoResponse, error)
}

IdentityServiceClient is the client API for IdentityService service.

For semantics around ctx use and closing/ending streaming RPCs, please refer to https://godoc.org/google.golang.org/grpc#ClientConn.NewStream.

func NewIdentityServiceClient added in v0.18.40

func NewIdentityServiceClient(cc *grpc.ClientConn) IdentityServiceClient

type IdentityServiceServer added in v0.18.40

type IdentityServiceServer interface {
	// Retrieves user information about the currently logged in user.
	UserInfo(context.Context, *UserInfoRequest) (*UserInfoResponse, error)
}

IdentityServiceServer is the server API for IdentityService service.

type OAuth2MetadataRequest added in v0.18.40

type OAuth2MetadataRequest struct {
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

func (*OAuth2MetadataRequest) Descriptor added in v0.18.40

func (*OAuth2MetadataRequest) Descriptor() ([]byte, []int)

func (*OAuth2MetadataRequest) ProtoMessage added in v0.18.40

func (*OAuth2MetadataRequest) ProtoMessage()

func (*OAuth2MetadataRequest) Reset added in v0.18.40

func (m *OAuth2MetadataRequest) Reset()

func (*OAuth2MetadataRequest) String added in v0.18.40

func (m *OAuth2MetadataRequest) String() string

func (*OAuth2MetadataRequest) XXX_DiscardUnknown added in v0.18.40

func (m *OAuth2MetadataRequest) XXX_DiscardUnknown()

func (*OAuth2MetadataRequest) XXX_Marshal added in v0.18.40

func (m *OAuth2MetadataRequest) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*OAuth2MetadataRequest) XXX_Merge added in v0.18.40

func (m *OAuth2MetadataRequest) XXX_Merge(src proto.Message)

func (*OAuth2MetadataRequest) XXX_Size added in v0.18.40

func (m *OAuth2MetadataRequest) XXX_Size() int

func (*OAuth2MetadataRequest) XXX_Unmarshal added in v0.18.40

func (m *OAuth2MetadataRequest) XXX_Unmarshal(b []byte) error

type OAuth2MetadataResponse added in v0.18.40

type OAuth2MetadataResponse struct {
	// Defines the issuer string in all JWT tokens this server issues. The issuer can be admin itself or an external
	// issuer.
	Issuer string `protobuf:"bytes,1,opt,name=issuer,proto3" json:"issuer,omitempty"`
	// URL of the authorization server's authorization endpoint [RFC6749]. This is REQUIRED unless no grant types are
	// supported that use the authorization endpoint.
	AuthorizationEndpoint string `protobuf:"bytes,2,opt,name=authorization_endpoint,json=authorizationEndpoint,proto3" json:"authorization_endpoint,omitempty"`
	// URL of the authorization server's token endpoint [RFC6749].
	TokenEndpoint string `protobuf:"bytes,3,opt,name=token_endpoint,json=tokenEndpoint,proto3" json:"token_endpoint,omitempty"`
	// Array containing a list of the OAuth 2.0 response_type values that this authorization server supports.
	ResponseTypesSupported []string `` /* 129-byte string literal not displayed */
	// JSON array containing a list of the OAuth 2.0 [RFC6749] scope values that this authorization server supports.
	ScopesSupported []string `protobuf:"bytes,5,rep,name=scopes_supported,json=scopesSupported,proto3" json:"scopes_supported,omitempty"`
	// JSON array containing a list of client authentication methods supported by this token endpoint.
	TokenEndpointAuthMethodsSupported []string `` /* 166-byte string literal not displayed */
	// URL of the authorization server's JWK Set [JWK] document. The referenced document contains the signing key(s) the
	// client uses to validate signatures from the authorization server.
	JwksUri string `protobuf:"bytes,7,opt,name=jwks_uri,json=jwksUri,proto3" json:"jwks_uri,omitempty"`
	// JSON array containing a list of Proof Key for Code Exchange (PKCE) [RFC7636] code challenge methods supported by
	// this authorization server.
	CodeChallengeMethodsSupported []string `` /* 152-byte string literal not displayed */
	// JSON array containing a list of the OAuth 2.0 grant type values that this authorization server supports.
	GrantTypesSupported  []string `protobuf:"bytes,9,rep,name=grant_types_supported,json=grantTypesSupported,proto3" json:"grant_types_supported,omitempty"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

OAuth2MetadataResponse defines an RFC-Compliant response for /.well-known/oauth-authorization-server metadata as defined in https://tools.ietf.org/html/rfc8414

func (*OAuth2MetadataResponse) Descriptor added in v0.18.40

func (*OAuth2MetadataResponse) Descriptor() ([]byte, []int)

func (*OAuth2MetadataResponse) GetAuthorizationEndpoint added in v0.18.40

func (m *OAuth2MetadataResponse) GetAuthorizationEndpoint() string

func (*OAuth2MetadataResponse) GetCodeChallengeMethodsSupported added in v0.18.40

func (m *OAuth2MetadataResponse) GetCodeChallengeMethodsSupported() []string

func (*OAuth2MetadataResponse) GetGrantTypesSupported added in v0.18.40

func (m *OAuth2MetadataResponse) GetGrantTypesSupported() []string

func (*OAuth2MetadataResponse) GetIssuer added in v0.18.40

func (m *OAuth2MetadataResponse) GetIssuer() string

func (*OAuth2MetadataResponse) GetJwksUri added in v0.18.40

func (m *OAuth2MetadataResponse) GetJwksUri() string

func (*OAuth2MetadataResponse) GetResponseTypesSupported added in v0.18.40

func (m *OAuth2MetadataResponse) GetResponseTypesSupported() []string

func (*OAuth2MetadataResponse) GetScopesSupported added in v0.18.40

func (m *OAuth2MetadataResponse) GetScopesSupported() []string

func (*OAuth2MetadataResponse) GetTokenEndpoint added in v0.18.40

func (m *OAuth2MetadataResponse) GetTokenEndpoint() string

func (*OAuth2MetadataResponse) GetTokenEndpointAuthMethodsSupported added in v0.18.40

func (m *OAuth2MetadataResponse) GetTokenEndpointAuthMethodsSupported() []string

func (*OAuth2MetadataResponse) ProtoMessage added in v0.18.40

func (*OAuth2MetadataResponse) ProtoMessage()

func (*OAuth2MetadataResponse) Reset added in v0.18.40

func (m *OAuth2MetadataResponse) Reset()

func (*OAuth2MetadataResponse) String added in v0.18.40

func (m *OAuth2MetadataResponse) String() string

func (*OAuth2MetadataResponse) XXX_DiscardUnknown added in v0.18.40

func (m *OAuth2MetadataResponse) XXX_DiscardUnknown()

func (*OAuth2MetadataResponse) XXX_Marshal added in v0.18.40

func (m *OAuth2MetadataResponse) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*OAuth2MetadataResponse) XXX_Merge added in v0.18.40

func (m *OAuth2MetadataResponse) XXX_Merge(src proto.Message)

func (*OAuth2MetadataResponse) XXX_Size added in v0.18.40

func (m *OAuth2MetadataResponse) XXX_Size() int

func (*OAuth2MetadataResponse) XXX_Unmarshal added in v0.18.40

func (m *OAuth2MetadataResponse) XXX_Unmarshal(b []byte) error

type PublicClientAuthConfigRequest added in v0.18.40

type PublicClientAuthConfigRequest struct {
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

func (*PublicClientAuthConfigRequest) Descriptor added in v0.18.40

func (*PublicClientAuthConfigRequest) Descriptor() ([]byte, []int)

func (*PublicClientAuthConfigRequest) ProtoMessage added in v0.18.40

func (*PublicClientAuthConfigRequest) ProtoMessage()

func (*PublicClientAuthConfigRequest) Reset added in v0.18.40

func (m *PublicClientAuthConfigRequest) Reset()

func (*PublicClientAuthConfigRequest) String added in v0.18.40

func (*PublicClientAuthConfigRequest) XXX_DiscardUnknown added in v0.18.40

func (m *PublicClientAuthConfigRequest) XXX_DiscardUnknown()

func (*PublicClientAuthConfigRequest) XXX_Marshal added in v0.18.40

func (m *PublicClientAuthConfigRequest) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*PublicClientAuthConfigRequest) XXX_Merge added in v0.18.40

func (m *PublicClientAuthConfigRequest) XXX_Merge(src proto.Message)

func (*PublicClientAuthConfigRequest) XXX_Size added in v0.18.40

func (m *PublicClientAuthConfigRequest) XXX_Size() int

func (*PublicClientAuthConfigRequest) XXX_Unmarshal added in v0.18.40

func (m *PublicClientAuthConfigRequest) XXX_Unmarshal(b []byte) error

type PublicClientAuthConfigResponse added in v0.18.40

type PublicClientAuthConfigResponse struct {
	// client_id to use when initiating OAuth2 authorization requests.
	ClientId string `protobuf:"bytes,1,opt,name=client_id,json=clientId,proto3" json:"client_id,omitempty"`
	// redirect uri to use when initiating OAuth2 authorization requests.
	RedirectUri string `protobuf:"bytes,2,opt,name=redirect_uri,json=redirectUri,proto3" json:"redirect_uri,omitempty"`
	// scopes to request when initiating OAuth2 authorization requests.
	Scopes []string `protobuf:"bytes,3,rep,name=scopes,proto3" json:"scopes,omitempty"`
	// Authorization Header to use when passing Access Tokens to the server. If not provided, the client should use the
	// default http `Authorization` header.
	AuthorizationMetadataKey string   `` /* 135-byte string literal not displayed */
	XXX_NoUnkeyedLiteral     struct{} `json:"-"`
	XXX_unrecognized         []byte   `json:"-"`
	XXX_sizecache            int32    `json:"-"`
}

FlyteClientResponse encapsulates public information that flyte clients (CLIs... etc.) can use to authenticate users.

func (*PublicClientAuthConfigResponse) Descriptor added in v0.18.40

func (*PublicClientAuthConfigResponse) Descriptor() ([]byte, []int)

func (*PublicClientAuthConfigResponse) GetAuthorizationMetadataKey added in v0.18.40

func (m *PublicClientAuthConfigResponse) GetAuthorizationMetadataKey() string

func (*PublicClientAuthConfigResponse) GetClientId added in v0.18.40

func (m *PublicClientAuthConfigResponse) GetClientId() string

func (*PublicClientAuthConfigResponse) GetRedirectUri added in v0.18.40

func (m *PublicClientAuthConfigResponse) GetRedirectUri() string

func (*PublicClientAuthConfigResponse) GetScopes added in v0.18.40

func (m *PublicClientAuthConfigResponse) GetScopes() []string

func (*PublicClientAuthConfigResponse) ProtoMessage added in v0.18.40

func (*PublicClientAuthConfigResponse) ProtoMessage()

func (*PublicClientAuthConfigResponse) Reset added in v0.18.40

func (m *PublicClientAuthConfigResponse) Reset()

func (*PublicClientAuthConfigResponse) String added in v0.18.40

func (*PublicClientAuthConfigResponse) XXX_DiscardUnknown added in v0.18.40

func (m *PublicClientAuthConfigResponse) XXX_DiscardUnknown()

func (*PublicClientAuthConfigResponse) XXX_Marshal added in v0.18.40

func (m *PublicClientAuthConfigResponse) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*PublicClientAuthConfigResponse) XXX_Merge added in v0.18.40

func (m *PublicClientAuthConfigResponse) XXX_Merge(src proto.Message)

func (*PublicClientAuthConfigResponse) XXX_Size added in v0.18.40

func (m *PublicClientAuthConfigResponse) XXX_Size() int

func (*PublicClientAuthConfigResponse) XXX_Unmarshal added in v0.18.40

func (m *PublicClientAuthConfigResponse) XXX_Unmarshal(b []byte) error

type UnimplementedAdminServiceServer added in v0.16.1

type UnimplementedAdminServiceServer struct {
}

UnimplementedAdminServiceServer can be embedded to have forward compatible implementations.

func (*UnimplementedAdminServiceServer) CreateExecution added in v0.16.1

func (*UnimplementedAdminServiceServer) CreateLaunchPlan added in v0.16.1

func (*UnimplementedAdminServiceServer) CreateNodeEvent added in v0.16.1

func (*UnimplementedAdminServiceServer) CreateTask added in v0.16.1

func (*UnimplementedAdminServiceServer) CreateTaskEvent added in v0.16.1

func (*UnimplementedAdminServiceServer) CreateWorkflow added in v0.16.1

func (*UnimplementedAdminServiceServer) CreateWorkflowEvent added in v0.16.1

func (*UnimplementedAdminServiceServer) DeleteProjectDomainAttributes added in v0.16.5

func (*UnimplementedAdminServiceServer) DeleteWorkflowAttributes added in v0.16.5

func (*UnimplementedAdminServiceServer) GetActiveLaunchPlan added in v0.16.1

func (*UnimplementedAdminServiceServer) GetExecution added in v0.16.1

func (*UnimplementedAdminServiceServer) GetExecutionData added in v0.16.1

func (*UnimplementedAdminServiceServer) GetLaunchPlan added in v0.16.1

func (*UnimplementedAdminServiceServer) GetNamedEntity added in v0.16.1

func (*UnimplementedAdminServiceServer) GetNodeExecution added in v0.16.1

func (*UnimplementedAdminServiceServer) GetNodeExecutionData added in v0.16.1

func (*UnimplementedAdminServiceServer) GetProjectDomainAttributes added in v0.16.5

func (*UnimplementedAdminServiceServer) GetTask added in v0.16.1

func (*UnimplementedAdminServiceServer) GetTaskExecution added in v0.16.1

func (*UnimplementedAdminServiceServer) GetTaskExecutionData added in v0.16.1

func (*UnimplementedAdminServiceServer) GetVersion added in v0.18.17

func (*UnimplementedAdminServiceServer) GetWorkflow added in v0.16.1

func (*UnimplementedAdminServiceServer) GetWorkflowAttributes added in v0.16.5

func (*UnimplementedAdminServiceServer) ListActiveLaunchPlans added in v0.16.1

func (*UnimplementedAdminServiceServer) ListExecutions added in v0.16.1

func (*UnimplementedAdminServiceServer) ListLaunchPlanIds added in v0.16.1

func (*UnimplementedAdminServiceServer) ListLaunchPlans added in v0.16.1

func (*UnimplementedAdminServiceServer) ListMatchableAttributes added in v0.18.15

func (*UnimplementedAdminServiceServer) ListNamedEntities added in v0.16.1

func (*UnimplementedAdminServiceServer) ListNodeExecutions added in v0.16.1

func (*UnimplementedAdminServiceServer) ListNodeExecutionsForTask added in v0.16.1

func (*UnimplementedAdminServiceServer) ListProjects added in v0.16.1

func (*UnimplementedAdminServiceServer) ListTaskExecutions added in v0.16.1

func (*UnimplementedAdminServiceServer) ListTaskIds added in v0.16.1

func (*UnimplementedAdminServiceServer) ListTasks added in v0.16.1

func (*UnimplementedAdminServiceServer) ListWorkflowIds added in v0.16.1

func (*UnimplementedAdminServiceServer) ListWorkflows added in v0.16.1

func (*UnimplementedAdminServiceServer) RecoverExecution added in v0.19.14

func (*UnimplementedAdminServiceServer) RegisterProject added in v0.16.1

func (*UnimplementedAdminServiceServer) RelaunchExecution added in v0.16.1

func (*UnimplementedAdminServiceServer) TerminateExecution added in v0.16.1

func (*UnimplementedAdminServiceServer) UpdateLaunchPlan added in v0.16.1

func (*UnimplementedAdminServiceServer) UpdateNamedEntity added in v0.16.1

func (*UnimplementedAdminServiceServer) UpdateProject added in v0.18.15

func (*UnimplementedAdminServiceServer) UpdateProjectDomainAttributes added in v0.16.1

func (*UnimplementedAdminServiceServer) UpdateWorkflowAttributes added in v0.16.4

type UnimplementedAuthMetadataServiceServer added in v0.18.40

type UnimplementedAuthMetadataServiceServer struct {
}

UnimplementedAuthMetadataServiceServer can be embedded to have forward compatible implementations.

func (*UnimplementedAuthMetadataServiceServer) GetOAuth2Metadata added in v0.18.40

func (*UnimplementedAuthMetadataServiceServer) GetPublicClientConfig added in v0.18.40

type UnimplementedIdentityServiceServer added in v0.18.40

type UnimplementedIdentityServiceServer struct {
}

UnimplementedIdentityServiceServer can be embedded to have forward compatible implementations.

func (*UnimplementedIdentityServiceServer) UserInfo added in v0.18.40

type UserInfoRequest added in v0.18.40

type UserInfoRequest struct {
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

func (*UserInfoRequest) Descriptor added in v0.18.40

func (*UserInfoRequest) Descriptor() ([]byte, []int)

func (*UserInfoRequest) ProtoMessage added in v0.18.40

func (*UserInfoRequest) ProtoMessage()

func (*UserInfoRequest) Reset added in v0.18.40

func (m *UserInfoRequest) Reset()

func (*UserInfoRequest) String added in v0.18.40

func (m *UserInfoRequest) String() string

func (*UserInfoRequest) XXX_DiscardUnknown added in v0.18.40

func (m *UserInfoRequest) XXX_DiscardUnknown()

func (*UserInfoRequest) XXX_Marshal added in v0.18.40

func (m *UserInfoRequest) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*UserInfoRequest) XXX_Merge added in v0.18.40

func (m *UserInfoRequest) XXX_Merge(src proto.Message)

func (*UserInfoRequest) XXX_Size added in v0.18.40

func (m *UserInfoRequest) XXX_Size() int

func (*UserInfoRequest) XXX_Unmarshal added in v0.18.40

func (m *UserInfoRequest) XXX_Unmarshal(b []byte) error

type UserInfoResponse added in v0.18.40

type UserInfoResponse struct {
	// Locally unique and never reassigned identifier within the Issuer for the End-User, which is intended to be consumed
	// by the Client.
	Subject string `protobuf:"bytes,1,opt,name=subject,proto3" json:"subject,omitempty"`
	// Full name
	Name string `protobuf:"bytes,2,opt,name=name,proto3" json:"name,omitempty"`
	// Shorthand name by which the End-User wishes to be referred to
	PreferredUsername string `protobuf:"bytes,3,opt,name=preferred_username,json=preferredUsername,proto3" json:"preferred_username,omitempty"`
	// Given name(s) or first name(s)
	GivenName string `protobuf:"bytes,4,opt,name=given_name,json=givenName,proto3" json:"given_name,omitempty"`
	// Surname(s) or last name(s)
	FamilyName string `protobuf:"bytes,5,opt,name=family_name,json=familyName,proto3" json:"family_name,omitempty"`
	// Preferred e-mail address
	Email string `protobuf:"bytes,6,opt,name=email,proto3" json:"email,omitempty"`
	// Profile picture URL
	Picture              string   `protobuf:"bytes,7,opt,name=picture,proto3" json:"picture,omitempty"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

See the OpenID Connect spec at https://openid.net/specs/openid-connect-core-1_0.html#UserInfoResponse for more information.

func (*UserInfoResponse) Descriptor added in v0.18.40

func (*UserInfoResponse) Descriptor() ([]byte, []int)

func (*UserInfoResponse) GetEmail added in v0.18.40

func (m *UserInfoResponse) GetEmail() string

func (*UserInfoResponse) GetFamilyName added in v0.18.40

func (m *UserInfoResponse) GetFamilyName() string

func (*UserInfoResponse) GetGivenName added in v0.18.40

func (m *UserInfoResponse) GetGivenName() string

func (*UserInfoResponse) GetName added in v0.18.40

func (m *UserInfoResponse) GetName() string

func (*UserInfoResponse) GetPicture added in v0.18.40

func (m *UserInfoResponse) GetPicture() string

func (*UserInfoResponse) GetPreferredUsername added in v0.18.40

func (m *UserInfoResponse) GetPreferredUsername() string

func (*UserInfoResponse) GetSubject added in v0.18.40

func (m *UserInfoResponse) GetSubject() string

func (*UserInfoResponse) ProtoMessage added in v0.18.40

func (*UserInfoResponse) ProtoMessage()

func (*UserInfoResponse) Reset added in v0.18.40

func (m *UserInfoResponse) Reset()

func (*UserInfoResponse) String added in v0.18.40

func (m *UserInfoResponse) String() string

func (*UserInfoResponse) XXX_DiscardUnknown added in v0.18.40

func (m *UserInfoResponse) XXX_DiscardUnknown()

func (*UserInfoResponse) XXX_Marshal added in v0.18.40

func (m *UserInfoResponse) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*UserInfoResponse) XXX_Merge added in v0.18.40

func (m *UserInfoResponse) XXX_Merge(src proto.Message)

func (*UserInfoResponse) XXX_Size added in v0.18.40

func (m *UserInfoResponse) XXX_Size() int

func (*UserInfoResponse) XXX_Unmarshal added in v0.18.40

func (m *UserInfoResponse) XXX_Unmarshal(b []byte) error

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL