genproto: google.golang.org/genproto/googleapis/cloud/workflows/v1beta Index | Files

package workflows

import "google.golang.org/genproto/googleapis/cloud/workflows/v1beta"

Index

Package Files

workflows.pb.go

Variables

var (
    Workflow_State_name = map[int32]string{
        0:  "STATE_UNSPECIFIED",
        1:  "ACTIVE",
    }
    Workflow_State_value = map[string]int32{
        "STATE_UNSPECIFIED": 0,
        "ACTIVE":            1,
    }
)

Enum value maps for Workflow_State.

var File_google_cloud_workflows_v1beta_workflows_proto protoreflect.FileDescriptor

func RegisterWorkflowsServer Uses

func RegisterWorkflowsServer(s *grpc.Server, srv WorkflowsServer)

type CreateWorkflowRequest Uses

type CreateWorkflowRequest struct {

    // Required. Project and location in which the workflow should be created.
    // Format:  projects/{project}/locations/{location}
    Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
    // Required. Workflow to be created.
    Workflow *Workflow `protobuf:"bytes,2,opt,name=workflow,proto3" json:"workflow,omitempty"`
    // Required. The ID of the workflow to be created. It has to fulfill the
    // following requirements:
    //
    // * Must contain only letters, numbers, underscores and hyphens.
    // * Must start with a letter.
    // * Must be between 1-64 characters.
    // * Must end with a number or a letter.
    // * Must be unique within the customer project and location.
    WorkflowId string `protobuf:"bytes,3,opt,name=workflow_id,json=workflowId,proto3" json:"workflow_id,omitempty"`
    // contains filtered or unexported fields
}

Request for the [CreateWorkflow][google.cloud.workflows.v1beta.Workflows.CreateWorkflow] method.

func (*CreateWorkflowRequest) Descriptor Uses

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

Deprecated: Use CreateWorkflowRequest.ProtoReflect.Descriptor instead.

func (*CreateWorkflowRequest) GetParent Uses

func (x *CreateWorkflowRequest) GetParent() string

func (*CreateWorkflowRequest) GetWorkflow Uses

func (x *CreateWorkflowRequest) GetWorkflow() *Workflow

func (*CreateWorkflowRequest) GetWorkflowId Uses

func (x *CreateWorkflowRequest) GetWorkflowId() string

func (*CreateWorkflowRequest) ProtoMessage Uses

func (*CreateWorkflowRequest) ProtoMessage()

func (*CreateWorkflowRequest) ProtoReflect Uses

func (x *CreateWorkflowRequest) ProtoReflect() protoreflect.Message

func (*CreateWorkflowRequest) Reset Uses

func (x *CreateWorkflowRequest) Reset()

func (*CreateWorkflowRequest) String Uses

func (x *CreateWorkflowRequest) String() string

type DeleteWorkflowRequest Uses

type DeleteWorkflowRequest struct {

    // Required. Name of the workflow to be deleted.
    // Format: projects/{project}/locations/{location}/workflows/{workflow}
    Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
    // contains filtered or unexported fields
}

Request for the [DeleteWorkflow][google.cloud.workflows.v1beta.Workflows.DeleteWorkflow] method.

func (*DeleteWorkflowRequest) Descriptor Uses

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

Deprecated: Use DeleteWorkflowRequest.ProtoReflect.Descriptor instead.

func (*DeleteWorkflowRequest) GetName Uses

func (x *DeleteWorkflowRequest) GetName() string

func (*DeleteWorkflowRequest) ProtoMessage Uses

func (*DeleteWorkflowRequest) ProtoMessage()

func (*DeleteWorkflowRequest) ProtoReflect Uses

func (x *DeleteWorkflowRequest) ProtoReflect() protoreflect.Message

func (*DeleteWorkflowRequest) Reset Uses

func (x *DeleteWorkflowRequest) Reset()

func (*DeleteWorkflowRequest) String Uses

func (x *DeleteWorkflowRequest) String() string

type GetWorkflowRequest Uses

type GetWorkflowRequest struct {

    // Required. Name of the workflow which information should be retrieved.
    // Format: projects/{project}/locations/{location}/workflows/{workflow}
    Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
    // contains filtered or unexported fields
}

Request for the [GetWorkflow][google.cloud.workflows.v1beta.Workflows.GetWorkflow] method.

func (*GetWorkflowRequest) Descriptor Uses

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

Deprecated: Use GetWorkflowRequest.ProtoReflect.Descriptor instead.

func (*GetWorkflowRequest) GetName Uses

func (x *GetWorkflowRequest) GetName() string

func (*GetWorkflowRequest) ProtoMessage Uses

func (*GetWorkflowRequest) ProtoMessage()

func (*GetWorkflowRequest) ProtoReflect Uses

func (x *GetWorkflowRequest) ProtoReflect() protoreflect.Message

func (*GetWorkflowRequest) Reset Uses

func (x *GetWorkflowRequest) Reset()

func (*GetWorkflowRequest) String Uses

func (x *GetWorkflowRequest) String() string

type ListWorkflowsRequest Uses

type ListWorkflowsRequest struct {

    // Required. Project and location from which the workflows should be listed.
    // Format: projects/{project}/locations/{location}
    Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
    // Maximum number of workflows to return per call. The service may return
    // fewer than this value. If the value is not specified, a default value of
    // 500 will be used. The maximum permitted value is 1000 and values greater
    // than 1000 will be coerced down to 1000.
    PageSize int32 `protobuf:"varint,2,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"`
    // A page token, received from a previous `ListWorkflows` call.
    // Provide this to retrieve the subsequent page.
    //
    // When paginating, all other parameters provided to `ListWorkflows` must
    // match the call that provided the page token.
    PageToken string `protobuf:"bytes,3,opt,name=page_token,json=pageToken,proto3" json:"page_token,omitempty"`
    // Filter to restrict results to specific workflows.
    Filter string `protobuf:"bytes,4,opt,name=filter,proto3" json:"filter,omitempty"`
    // Comma-separated list of fields that that specify the order of the results.
    // Default sorting order for a field is ascending. To specify descending order
    // for a field, append a " desc" suffix.
    // If not specified, the results will be returned in an unspecified order.
    OrderBy string `protobuf:"bytes,5,opt,name=order_by,json=orderBy,proto3" json:"order_by,omitempty"`
    // contains filtered or unexported fields
}

Request for the [ListWorkflows][google.cloud.workflows.v1beta.Workflows.ListWorkflows] method.

func (*ListWorkflowsRequest) Descriptor Uses

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

Deprecated: Use ListWorkflowsRequest.ProtoReflect.Descriptor instead.

func (*ListWorkflowsRequest) GetFilter Uses

func (x *ListWorkflowsRequest) GetFilter() string

func (*ListWorkflowsRequest) GetOrderBy Uses

func (x *ListWorkflowsRequest) GetOrderBy() string

func (*ListWorkflowsRequest) GetPageSize Uses

func (x *ListWorkflowsRequest) GetPageSize() int32

func (*ListWorkflowsRequest) GetPageToken Uses

func (x *ListWorkflowsRequest) GetPageToken() string

func (*ListWorkflowsRequest) GetParent Uses

func (x *ListWorkflowsRequest) GetParent() string

func (*ListWorkflowsRequest) ProtoMessage Uses

func (*ListWorkflowsRequest) ProtoMessage()

func (*ListWorkflowsRequest) ProtoReflect Uses

func (x *ListWorkflowsRequest) ProtoReflect() protoreflect.Message

func (*ListWorkflowsRequest) Reset Uses

func (x *ListWorkflowsRequest) Reset()

func (*ListWorkflowsRequest) String Uses

func (x *ListWorkflowsRequest) String() string

type ListWorkflowsResponse Uses

type ListWorkflowsResponse struct {

    // The workflows which match the request.
    Workflows []*Workflow `protobuf:"bytes,1,rep,name=workflows,proto3" json:"workflows,omitempty"`
    // A token, which can be sent as `page_token` to retrieve the next page.
    // If this field is omitted, there are no subsequent pages.
    NextPageToken string `protobuf:"bytes,2,opt,name=next_page_token,json=nextPageToken,proto3" json:"next_page_token,omitempty"`
    // Unreachable resources.
    Unreachable []string `protobuf:"bytes,3,rep,name=unreachable,proto3" json:"unreachable,omitempty"`
    // contains filtered or unexported fields
}

Response for the [ListWorkflows][google.cloud.workflows.v1beta.Workflows.ListWorkflows] method.

func (*ListWorkflowsResponse) Descriptor Uses

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

Deprecated: Use ListWorkflowsResponse.ProtoReflect.Descriptor instead.

func (*ListWorkflowsResponse) GetNextPageToken Uses

func (x *ListWorkflowsResponse) GetNextPageToken() string

func (*ListWorkflowsResponse) GetUnreachable Uses

func (x *ListWorkflowsResponse) GetUnreachable() []string

func (*ListWorkflowsResponse) GetWorkflows Uses

func (x *ListWorkflowsResponse) GetWorkflows() []*Workflow

func (*ListWorkflowsResponse) ProtoMessage Uses

func (*ListWorkflowsResponse) ProtoMessage()

func (*ListWorkflowsResponse) ProtoReflect Uses

func (x *ListWorkflowsResponse) ProtoReflect() protoreflect.Message

func (*ListWorkflowsResponse) Reset Uses

func (x *ListWorkflowsResponse) Reset()

func (*ListWorkflowsResponse) String Uses

func (x *ListWorkflowsResponse) String() string

type OperationMetadata Uses

type OperationMetadata struct {

    // The time the operation was created.
    CreateTime *timestamppb.Timestamp `protobuf:"bytes,1,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"`
    // The time the operation finished running.
    EndTime *timestamppb.Timestamp `protobuf:"bytes,2,opt,name=end_time,json=endTime,proto3" json:"end_time,omitempty"`
    // Server-defined resource path for the target of the operation.
    Target string `protobuf:"bytes,3,opt,name=target,proto3" json:"target,omitempty"`
    // Name of the verb executed by the operation.
    Verb string `protobuf:"bytes,4,opt,name=verb,proto3" json:"verb,omitempty"`
    // API version used to start the operation.
    ApiVersion string `protobuf:"bytes,5,opt,name=api_version,json=apiVersion,proto3" json:"api_version,omitempty"`
    // contains filtered or unexported fields
}

Represents the metadata of the long-running operation.

func (*OperationMetadata) Descriptor Uses

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

Deprecated: Use OperationMetadata.ProtoReflect.Descriptor instead.

func (*OperationMetadata) GetApiVersion Uses

func (x *OperationMetadata) GetApiVersion() string

func (*OperationMetadata) GetCreateTime Uses

func (x *OperationMetadata) GetCreateTime() *timestamppb.Timestamp

func (*OperationMetadata) GetEndTime Uses

func (x *OperationMetadata) GetEndTime() *timestamppb.Timestamp

func (*OperationMetadata) GetTarget Uses

func (x *OperationMetadata) GetTarget() string

func (*OperationMetadata) GetVerb Uses

func (x *OperationMetadata) GetVerb() string

func (*OperationMetadata) ProtoMessage Uses

func (*OperationMetadata) ProtoMessage()

func (*OperationMetadata) ProtoReflect Uses

func (x *OperationMetadata) ProtoReflect() protoreflect.Message

func (*OperationMetadata) Reset Uses

func (x *OperationMetadata) Reset()

func (*OperationMetadata) String Uses

func (x *OperationMetadata) String() string

type UnimplementedWorkflowsServer Uses

type UnimplementedWorkflowsServer struct {
}

UnimplementedWorkflowsServer can be embedded to have forward compatible implementations.

func (*UnimplementedWorkflowsServer) CreateWorkflow Uses

func (*UnimplementedWorkflowsServer) CreateWorkflow(context.Context, *CreateWorkflowRequest) (*longrunning.Operation, error)

func (*UnimplementedWorkflowsServer) DeleteWorkflow Uses

func (*UnimplementedWorkflowsServer) DeleteWorkflow(context.Context, *DeleteWorkflowRequest) (*longrunning.Operation, error)

func (*UnimplementedWorkflowsServer) GetWorkflow Uses

func (*UnimplementedWorkflowsServer) GetWorkflow(context.Context, *GetWorkflowRequest) (*Workflow, error)

func (*UnimplementedWorkflowsServer) ListWorkflows Uses

func (*UnimplementedWorkflowsServer) ListWorkflows(context.Context, *ListWorkflowsRequest) (*ListWorkflowsResponse, error)

func (*UnimplementedWorkflowsServer) UpdateWorkflow Uses

func (*UnimplementedWorkflowsServer) UpdateWorkflow(context.Context, *UpdateWorkflowRequest) (*longrunning.Operation, error)

type UpdateWorkflowRequest Uses

type UpdateWorkflowRequest struct {

    // Required. Workflow to be updated.
    Workflow *Workflow `protobuf:"bytes,1,opt,name=workflow,proto3" json:"workflow,omitempty"`
    // List of fields to be updated. If not present, the entire workflow
    // will be updated.
    UpdateMask *fieldmaskpb.FieldMask `protobuf:"bytes,2,opt,name=update_mask,json=updateMask,proto3" json:"update_mask,omitempty"`
    // contains filtered or unexported fields
}

Request for the [UpdateWorkflow][google.cloud.workflows.v1beta.Workflows.UpdateWorkflow] method.

func (*UpdateWorkflowRequest) Descriptor Uses

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

Deprecated: Use UpdateWorkflowRequest.ProtoReflect.Descriptor instead.

func (*UpdateWorkflowRequest) GetUpdateMask Uses

func (x *UpdateWorkflowRequest) GetUpdateMask() *fieldmaskpb.FieldMask

func (*UpdateWorkflowRequest) GetWorkflow Uses

func (x *UpdateWorkflowRequest) GetWorkflow() *Workflow

func (*UpdateWorkflowRequest) ProtoMessage Uses

func (*UpdateWorkflowRequest) ProtoMessage()

func (*UpdateWorkflowRequest) ProtoReflect Uses

func (x *UpdateWorkflowRequest) ProtoReflect() protoreflect.Message

func (*UpdateWorkflowRequest) Reset Uses

func (x *UpdateWorkflowRequest) Reset()

func (*UpdateWorkflowRequest) String Uses

func (x *UpdateWorkflowRequest) String() string

type Workflow Uses

type Workflow struct {

    // The resource name of the workflow.
    // Format: projects/{project}/locations/{location}/workflows/{workflow}
    Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
    // Description of the workflow provided by the user.
    // Must be at most 1000 unicode characters long.
    Description string `protobuf:"bytes,2,opt,name=description,proto3" json:"description,omitempty"`
    // Output only. State of the workflow deployment.
    State Workflow_State `protobuf:"varint,3,opt,name=state,proto3,enum=google.cloud.workflows.v1beta.Workflow_State" json:"state,omitempty"`
    // Output only. The revision of the workflow.
    // A new revision of a workflow is created as a result of updating the
    // following fields of a workflow:
    // - `source_code`
    // - `service_account`
    // The format is "000001-a4d", where the first 6 characters define
    // the zero-padded revision ordinal number. They are followed by a hyphen and
    // 3 hexadecimal random characters.
    RevisionId string `protobuf:"bytes,4,opt,name=revision_id,json=revisionId,proto3" json:"revision_id,omitempty"`
    // Output only. The timestamp of when the workflow was created.
    CreateTime *timestamppb.Timestamp `protobuf:"bytes,5,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"`
    // Output only. The last update timestamp of the workflow.
    UpdateTime *timestamppb.Timestamp `protobuf:"bytes,6,opt,name=update_time,json=updateTime,proto3" json:"update_time,omitempty"`
    // Output only. The timestamp that the latest revision of the workflow
    // was created.
    RevisionCreateTime *timestamppb.Timestamp `protobuf:"bytes,7,opt,name=revision_create_time,json=revisionCreateTime,proto3" json:"revision_create_time,omitempty"`
    // Labels associated with this workflow.
    // Labels can contain at most 64 entries. Keys and values can be no longer
    // than 63 characters and can only contain lowercase letters, numeric
    // characters, underscores and dashes. Label keys must start with a letter.
    // International characters are allowed.
    Labels map[string]string `protobuf:"bytes,8,rep,name=labels,proto3" json:"labels,omitempty" protobuf_key:"bytes,1,opt,name=key,proto3" protobuf_val:"bytes,2,opt,name=value,proto3"`
    // Name of the service account associated with the latest workflow version.
    // This service account represents the identity of the workflow and determines
    // what permissions the workflow has.
    // Format: projects/{project}/serviceAccounts/{account}
    //
    // Using `-` as a wildcard for the `{project}` will infer the project from
    // the account. The `{account}` value can be the `email` address or the
    // `unique_id` of the service account.
    //
    // If not provided, workflow will use the project's default service account.
    // Modifying this field for an existing workflow results in a new workflow
    // revision.
    ServiceAccount string `protobuf:"bytes,9,opt,name=service_account,json=serviceAccount,proto3" json:"service_account,omitempty"`
    // Required. Location of the workflow source code.
    // Modifying this field for an existing workflow results in a new workflow
    // revision.
    //
    // Types that are assignable to SourceCode:
    //	*Workflow_SourceContents
    SourceCode isWorkflow_SourceCode `protobuf_oneof:"source_code"`
    // contains filtered or unexported fields
}

Workflow program to be executed by Workflows.

func (*Workflow) Descriptor Uses

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

Deprecated: Use Workflow.ProtoReflect.Descriptor instead.

func (*Workflow) GetCreateTime Uses

func (x *Workflow) GetCreateTime() *timestamppb.Timestamp

func (*Workflow) GetDescription Uses

func (x *Workflow) GetDescription() string

func (*Workflow) GetLabels Uses

func (x *Workflow) GetLabels() map[string]string

func (*Workflow) GetName Uses

func (x *Workflow) GetName() string

func (*Workflow) GetRevisionCreateTime Uses

func (x *Workflow) GetRevisionCreateTime() *timestamppb.Timestamp

func (*Workflow) GetRevisionId Uses

func (x *Workflow) GetRevisionId() string

func (*Workflow) GetServiceAccount Uses

func (x *Workflow) GetServiceAccount() string

func (*Workflow) GetSourceCode Uses

func (m *Workflow) GetSourceCode() isWorkflow_SourceCode

func (*Workflow) GetSourceContents Uses

func (x *Workflow) GetSourceContents() string

func (*Workflow) GetState Uses

func (x *Workflow) GetState() Workflow_State

func (*Workflow) GetUpdateTime Uses

func (x *Workflow) GetUpdateTime() *timestamppb.Timestamp

func (*Workflow) ProtoMessage Uses

func (*Workflow) ProtoMessage()

func (*Workflow) ProtoReflect Uses

func (x *Workflow) ProtoReflect() protoreflect.Message

func (*Workflow) Reset Uses

func (x *Workflow) Reset()

func (*Workflow) String Uses

func (x *Workflow) String() string

type Workflow_SourceContents Uses

type Workflow_SourceContents struct {
    // Workflow code to be executed. The size limit is 32KB.
    SourceContents string `protobuf:"bytes,10,opt,name=source_contents,json=sourceContents,proto3,oneof"`
}

type Workflow_State Uses

type Workflow_State int32

Describes the current state of workflow deployment. More states may be added in the future.

const (
    // Invalid state.
    Workflow_STATE_UNSPECIFIED Workflow_State = 0
    // The workflow has been deployed successfully and is serving.
    Workflow_ACTIVE Workflow_State = 1
)

func (Workflow_State) Descriptor Uses

func (Workflow_State) Descriptor() protoreflect.EnumDescriptor

func (Workflow_State) Enum Uses

func (x Workflow_State) Enum() *Workflow_State

func (Workflow_State) EnumDescriptor Uses

func (Workflow_State) EnumDescriptor() ([]byte, []int)

Deprecated: Use Workflow_State.Descriptor instead.

func (Workflow_State) Number Uses

func (x Workflow_State) Number() protoreflect.EnumNumber

func (Workflow_State) String Uses

func (x Workflow_State) String() string

func (Workflow_State) Type Uses

func (Workflow_State) Type() protoreflect.EnumType

type WorkflowsClient Uses

type WorkflowsClient interface {
    // Lists Workflows in a given project and location.
    // The default order is not specified.
    ListWorkflows(ctx context.Context, in *ListWorkflowsRequest, opts ...grpc.CallOption) (*ListWorkflowsResponse, error)
    // Gets details of a single Workflow.
    GetWorkflow(ctx context.Context, in *GetWorkflowRequest, opts ...grpc.CallOption) (*Workflow, error)
    // Creates a new workflow. If a workflow with the specified name already
    // exists in the specified project and location, the long running operation
    // will return [ALREADY_EXISTS][google.rpc.Code.ALREADY_EXISTS] error.
    CreateWorkflow(ctx context.Context, in *CreateWorkflowRequest, opts ...grpc.CallOption) (*longrunning.Operation, error)
    // Deletes a workflow with the specified name.
    // This method also cancels and deletes all running executions of the
    // workflow.
    DeleteWorkflow(ctx context.Context, in *DeleteWorkflowRequest, opts ...grpc.CallOption) (*longrunning.Operation, error)
    // Updates an existing workflow.
    // Running this method has no impact on already running executions of the
    // workflow. A new revision of the workflow may be created as a result of a
    // successful update operation. In that case, such revision will be used
    // in new workflow executions.
    UpdateWorkflow(ctx context.Context, in *UpdateWorkflowRequest, opts ...grpc.CallOption) (*longrunning.Operation, error)
}

WorkflowsClient is the client API for Workflows service.

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

func NewWorkflowsClient Uses

func NewWorkflowsClient(cc grpc.ClientConnInterface) WorkflowsClient

type WorkflowsServer Uses

type WorkflowsServer interface {
    // Lists Workflows in a given project and location.
    // The default order is not specified.
    ListWorkflows(context.Context, *ListWorkflowsRequest) (*ListWorkflowsResponse, error)
    // Gets details of a single Workflow.
    GetWorkflow(context.Context, *GetWorkflowRequest) (*Workflow, error)
    // Creates a new workflow. If a workflow with the specified name already
    // exists in the specified project and location, the long running operation
    // will return [ALREADY_EXISTS][google.rpc.Code.ALREADY_EXISTS] error.
    CreateWorkflow(context.Context, *CreateWorkflowRequest) (*longrunning.Operation, error)
    // Deletes a workflow with the specified name.
    // This method also cancels and deletes all running executions of the
    // workflow.
    DeleteWorkflow(context.Context, *DeleteWorkflowRequest) (*longrunning.Operation, error)
    // Updates an existing workflow.
    // Running this method has no impact on already running executions of the
    // workflow. A new revision of the workflow may be created as a result of a
    // successful update operation. In that case, such revision will be used
    // in new workflow executions.
    UpdateWorkflow(context.Context, *UpdateWorkflowRequest) (*longrunning.Operation, error)
}

WorkflowsServer is the server API for Workflows service.

Package workflows imports 13 packages (graph) and is imported by 1 packages. Updated 2020-10-11. Refresh now. Tools for package owners.