Package cloud.google.com/go/workflows/apiv1/workflowspb (v1.12.11)

Variables

Workflow_State_name, Workflow_State_value

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

Enum value maps for Workflow_State.

Workflow_CallLogLevel_name, Workflow_CallLogLevel_value

  var 
  
 ( 
  
 Workflow_CallLogLevel_name 
  
 = 
  
 map 
 [ 
  int32 
 
 ] 
  string 
 
 { 
  
 0 
 : 
  
 "CALL_LOG_LEVEL_UNSPECIFIED" 
 , 
  
 1 
 : 
  
 "LOG_ALL_CALLS" 
 , 
  
 2 
 : 
  
 "LOG_ERRORS_ONLY" 
 , 
  
 3 
 : 
  
 "LOG_NONE" 
 , 
  
 } 
  
 Workflow_CallLogLevel_value 
  
 = 
  
 map 
 [ 
  string 
 
 ] 
  int32 
 
 { 
  
 "CALL_LOG_LEVEL_UNSPECIFIED" 
 : 
  
 0 
 , 
  
 "LOG_ALL_CALLS" 
 : 
  
 1 
 , 
  
 "LOG_ERRORS_ONLY" 
 : 
  
 2 
 , 
  
 "LOG_NONE" 
 : 
  
 3 
 , 
  
 } 
 ) 
 

Enum value maps for Workflow_CallLogLevel.

Workflow_StateError_Type_name, Workflow_StateError_Type_value

  var 
  
 ( 
  
 Workflow_StateError_Type_name 
  
 = 
  
 map 
 [ 
  int32 
 
 ] 
  string 
 
 { 
  
 0 
 : 
  
 "TYPE_UNSPECIFIED" 
 , 
  
 1 
 : 
  
 "KMS_ERROR" 
 , 
  
 } 
  
 Workflow_StateError_Type_value 
  
 = 
  
 map 
 [ 
  string 
 
 ] 
  int32 
 
 { 
  
 "TYPE_UNSPECIFIED" 
 : 
  
 0 
 , 
  
 "KMS_ERROR" 
 : 
  
 1 
 , 
  
 } 
 ) 
 

Enum value maps for Workflow_StateError_Type.

File_google_cloud_workflows_v1_workflows_proto

  var 
  
 File_google_cloud_workflows_v1_workflows_proto 
  
  protoreflect 
 
 . 
  FileDescriptor 
 
 

Functions

func RegisterWorkflowsServer

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

CreateWorkflowRequest

  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.v1.Workflows.CreateWorkflow] method.

func (*CreateWorkflowRequest) Descriptor

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

Deprecated: Use CreateWorkflowRequest.ProtoReflect.Descriptor instead.

func (*CreateWorkflowRequest) GetParent

  func 
  
 ( 
 x 
  
 * 
  CreateWorkflowRequest 
 
 ) 
  
 GetParent 
 () 
  
  string 
 
 

func (*CreateWorkflowRequest) GetWorkflow

  func 
  
 ( 
 x 
  
 * 
  CreateWorkflowRequest 
 
 ) 
  
 GetWorkflow 
 () 
  
 * 
  Workflow 
 
 

func (*CreateWorkflowRequest) GetWorkflowId

  func 
  
 ( 
 x 
  
 * 
  CreateWorkflowRequest 
 
 ) 
  
 GetWorkflowId 
 () 
  
  string 
 
 

func (*CreateWorkflowRequest) ProtoMessage

  func 
  
 ( 
 * 
  CreateWorkflowRequest 
 
 ) 
  
 ProtoMessage 
 () 
 

func (*CreateWorkflowRequest) ProtoReflect

func (*CreateWorkflowRequest) Reset

  func 
  
 ( 
 x 
  
 * 
  CreateWorkflowRequest 
 
 ) 
  
 Reset 
 () 
 

func (*CreateWorkflowRequest) String

  func 
  
 ( 
 x 
  
 * 
  CreateWorkflowRequest 
 
 ) 
  
 String 
 () 
  
  string 
 
 

DeleteWorkflowRequest

  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.v1.Workflows.DeleteWorkflow] method.

func (*DeleteWorkflowRequest) Descriptor

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

Deprecated: Use DeleteWorkflowRequest.ProtoReflect.Descriptor instead.

func (*DeleteWorkflowRequest) GetName

  func 
  
 ( 
 x 
  
 * 
  DeleteWorkflowRequest 
 
 ) 
  
 GetName 
 () 
  
  string 
 
 

func (*DeleteWorkflowRequest) ProtoMessage

  func 
  
 ( 
 * 
  DeleteWorkflowRequest 
 
 ) 
  
 ProtoMessage 
 () 
 

func (*DeleteWorkflowRequest) ProtoReflect

func (*DeleteWorkflowRequest) Reset

  func 
  
 ( 
 x 
  
 * 
  DeleteWorkflowRequest 
 
 ) 
  
 Reset 
 () 
 

func (*DeleteWorkflowRequest) String

  func 
  
 ( 
 x 
  
 * 
  DeleteWorkflowRequest 
 
 ) 
  
 String 
 () 
  
  string 
 
 

GetWorkflowRequest

  type 
  
 GetWorkflowRequest 
  
 struct 
  
 { 
  
 // Required. Name of the workflow for which information should be retrieved. 
  
 // Format: projects/{project}/locations/{location}/workflows/{workflow} 
  
 Name 
  
  string 
 
  
 `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"` 
  
 // Optional. The revision of the workflow to retrieve. If the revision_id is 
  
 // empty, the latest revision is retrieved. 
  
 // The format is "000001-a4d", where the first six characters define 
  
 // the zero-padded decimal revision number. They are followed by a hyphen and 
  
 // three hexadecimal characters. 
  
 RevisionId 
  
  string 
 
  
 `protobuf:"bytes,2,opt,name=revision_id,json=revisionId,proto3" json:"revision_id,omitempty"` 
  
 // contains filtered or unexported fields 
 } 
 

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

func (*GetWorkflowRequest) Descriptor

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

Deprecated: Use GetWorkflowRequest.ProtoReflect.Descriptor instead.

func (*GetWorkflowRequest) GetName

  func 
  
 ( 
 x 
  
 * 
  GetWorkflowRequest 
 
 ) 
  
 GetName 
 () 
  
  string 
 
 

func (*GetWorkflowRequest) GetRevisionId

  func 
  
 ( 
 x 
  
 * 
  GetWorkflowRequest 
 
 ) 
  
 GetRevisionId 
 () 
  
  string 
 
 

func (*GetWorkflowRequest) ProtoMessage

  func 
  
 ( 
 * 
  GetWorkflowRequest 
 
 ) 
  
 ProtoMessage 
 () 
 

func (*GetWorkflowRequest) ProtoReflect

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

func (*GetWorkflowRequest) Reset

  func 
  
 ( 
 x 
  
 * 
  GetWorkflowRequest 
 
 ) 
  
 Reset 
 () 
 

func (*GetWorkflowRequest) String

  func 
  
 ( 
 x 
  
 * 
  GetWorkflowRequest 
 
 ) 
  
 String 
 () 
  
  string 
 
 

ListWorkflowsRequest

  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 might return 
  
 // fewer than this value even if not at the end of the collection. If a value 
  
 // is not specified, a default value of 500 is used. The maximum permitted 
  
 // value is 1000 and values greater than 1000 are 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 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 are 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.v1.Workflows.ListWorkflows] method.

func (*ListWorkflowsRequest) Descriptor

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

Deprecated: Use ListWorkflowsRequest.ProtoReflect.Descriptor instead.

func (*ListWorkflowsRequest) GetFilter

  func 
  
 ( 
 x 
  
 * 
  ListWorkflowsRequest 
 
 ) 
  
 GetFilter 
 () 
  
  string 
 
 

func (*ListWorkflowsRequest) GetOrderBy

  func 
  
 ( 
 x 
  
 * 
  ListWorkflowsRequest 
 
 ) 
  
 GetOrderBy 
 () 
  
  string 
 
 

func (*ListWorkflowsRequest) GetPageSize

  func 
  
 ( 
 x 
  
 * 
  ListWorkflowsRequest 
 
 ) 
  
 GetPageSize 
 () 
  
  int32 
 
 

func (*ListWorkflowsRequest) GetPageToken

  func 
  
 ( 
 x 
  
 * 
  ListWorkflowsRequest 
 
 ) 
  
 GetPageToken 
 () 
  
  string 
 
 

func (*ListWorkflowsRequest) GetParent

  func 
  
 ( 
 x 
  
 * 
  ListWorkflowsRequest 
 
 ) 
  
 GetParent 
 () 
  
  string 
 
 

func (*ListWorkflowsRequest) ProtoMessage

  func 
  
 ( 
 * 
  ListWorkflowsRequest 
 
 ) 
  
 ProtoMessage 
 () 
 

func (*ListWorkflowsRequest) ProtoReflect

func (*ListWorkflowsRequest) Reset

  func 
  
 ( 
 x 
  
 * 
  ListWorkflowsRequest 
 
 ) 
  
 Reset 
 () 
 

func (*ListWorkflowsRequest) String

  func 
  
 ( 
 x 
  
 * 
  ListWorkflowsRequest 
 
 ) 
  
 String 
 () 
  
  string 
 
 

ListWorkflowsResponse

  type 
  
 ListWorkflowsResponse 
  
 struct 
  
 { 
  
 // The workflows that 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.v1.Workflows.ListWorkflows] method.

func (*ListWorkflowsResponse) Descriptor

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

Deprecated: Use ListWorkflowsResponse.ProtoReflect.Descriptor instead.

func (*ListWorkflowsResponse) GetNextPageToken

  func 
  
 ( 
 x 
  
 * 
  ListWorkflowsResponse 
 
 ) 
  
 GetNextPageToken 
 () 
  
  string 
 
 

func (*ListWorkflowsResponse) GetUnreachable

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

func (*ListWorkflowsResponse) GetWorkflows

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

func (*ListWorkflowsResponse) ProtoMessage

  func 
  
 ( 
 * 
  ListWorkflowsResponse 
 
 ) 
  
 ProtoMessage 
 () 
 

func (*ListWorkflowsResponse) ProtoReflect

func (*ListWorkflowsResponse) Reset

  func 
  
 ( 
 x 
  
 * 
  ListWorkflowsResponse 
 
 ) 
  
 Reset 
 () 
 

func (*ListWorkflowsResponse) String

  func 
  
 ( 
 x 
  
 * 
  ListWorkflowsResponse 
 
 ) 
  
 String 
 () 
  
  string 
 
 
  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 
 () 
  
 ([] 
  byte 
 
 , 
  
 [] 
  int 
 
 ) 
 

Deprecated: Use OperationMetadata.ProtoReflect.Descriptor instead.

  func 
  
 ( 
 x 
  
 * 
  OperationMetadata 
 
 ) 
  
 GetApiVersion 
 () 
  
  string 
 
 
  func 
  
 ( 
 x 
  
 * 
  OperationMetadata 
 
 ) 
  
 GetCreateTime 
 () 
  
 * 
  timestamppb 
 
 . 
  Timestamp 
 
 
  func 
  
 ( 
 x 
  
 * 
  OperationMetadata 
 
 ) 
  
 GetEndTime 
 () 
  
 * 
  timestamppb 
 
 . 
  Timestamp 
 
 
  func 
  
 ( 
 x 
  
 * 
  OperationMetadata 
 
 ) 
  
 GetTarget 
 () 
  
  string 
 
 
  func 
  
 ( 
 x 
  
 * 
  OperationMetadata 
 
 ) 
  
 GetVerb 
 () 
  
  string 
 
 
  func 
  
 ( 
 * 
  OperationMetadata 
 
 ) 
  
 ProtoMessage 
 () 
 
  func 
  
 ( 
 x 
  
 * 
  OperationMetadata 
 
 ) 
  
 ProtoReflect 
 () 
  
  protoreflect 
 
 . 
  Message 
 
 
  func 
  
 ( 
 x 
  
 * 
  OperationMetadata 
 
 ) 
  
 Reset 
 () 
 
  func 
  
 ( 
 x 
  
 * 
  OperationMetadata 
 
 ) 
  
 String 
 () 
  
  string 
 
 

UnimplementedWorkflowsServer

  type 
  
 UnimplementedWorkflowsServer 
  
 struct 
  
 { 
 } 
 

UnimplementedWorkflowsServer can be embedded to have forward compatible implementations.

func (*UnimplementedWorkflowsServer) CreateWorkflow

func (*UnimplementedWorkflowsServer) DeleteWorkflow

func (*UnimplementedWorkflowsServer) GetWorkflow

func (*UnimplementedWorkflowsServer) ListWorkflows

func (*UnimplementedWorkflowsServer) UpdateWorkflow

UpdateWorkflowRequest

  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.v1.Workflows.UpdateWorkflow] method.

func (*UpdateWorkflowRequest) Descriptor

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

Deprecated: Use UpdateWorkflowRequest.ProtoReflect.Descriptor instead.

func (*UpdateWorkflowRequest) GetUpdateMask

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

func (*UpdateWorkflowRequest) GetWorkflow

  func 
  
 ( 
 x 
  
 * 
  UpdateWorkflowRequest 
 
 ) 
  
 GetWorkflow 
 () 
  
 * 
  Workflow 
 
 

func (*UpdateWorkflowRequest) ProtoMessage

  func 
  
 ( 
 * 
  UpdateWorkflowRequest 
 
 ) 
  
 ProtoMessage 
 () 
 

func (*UpdateWorkflowRequest) ProtoReflect

func (*UpdateWorkflowRequest) Reset

  func 
  
 ( 
 x 
  
 * 
  UpdateWorkflowRequest 
 
 ) 
  
 Reset 
 () 
 

func (*UpdateWorkflowRequest) String

  func 
  
 ( 
 x 
  
 * 
  UpdateWorkflowRequest 
 
 ) 
  
 String 
 () 
  
  string 
 
 

Workflow

  type 
  
 Workflow 
  
 struct 
  
 { 
  
 Name 
  
  string 
 
  
 `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"` 
  
 Description 
  
  string 
 
  
 `protobuf:"bytes,2,opt,name=description,proto3" json:"description,omitempty"` 
  
 State 
  
  Workflow_State 
 
  
 `protobuf:"varint,3,opt,name=state,proto3,enum=google.cloud.workflows.v1.Workflow_State" json:"state,omitempty"` 
  
 RevisionId 
  
  string 
 
  
 `protobuf:"bytes,4,opt,name=revision_id,json=revisionId,proto3" json:"revision_id,omitempty"` 
  
 CreateTime 
  
 * 
  timestamppb 
 
 . 
  Timestamp 
 
  
 `protobuf:"bytes,5,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"` 
  
 UpdateTime 
  
 * 
  timestamppb 
 
 . 
  Timestamp 
 
  
 `protobuf:"bytes,6,opt,name=update_time,json=updateTime,proto3" json:"update_time,omitempty"` 
  
 RevisionCreateTime 
  
 * 
  timestamppb 
 
 . 
  Timestamp 
 
  
 `protobuf:"bytes,7,opt,name=revision_create_time,json=revisionCreateTime,proto3" json:"revision_create_time,omitempty"` 
  
 Labels 
  
 map 
 [ 
  string 
 
 ] 
  string 
 
  
 "" 
  
 /* 153 byte string literal not displayed */ 
  
 ServiceAccount 
  
  string 
 
  
 `protobuf:"bytes,9,opt,name=service_account,json=serviceAccount,proto3" json:"service_account,omitempty"` 
  
 SourceCode 
  
 isWorkflow_SourceCode 
  
 `protobuf_oneof:"source_code"` 
  
 CryptoKeyName 
  
  string 
 
  
 `protobuf:"bytes,11,opt,name=crypto_key_name,json=cryptoKeyName,proto3" json:"crypto_key_name,omitempty"` 
  
 StateError 
  
 * 
  Workflow_StateError 
 
  
 `protobuf:"bytes,12,opt,name=state_error,json=stateError,proto3" json:"state_error,omitempty"` 
  
 CallLogLevel 
  
  Workflow_CallLogLevel 
 
  
 "" 
  
 /* 154 byte string literal not displayed */ 
  
 UserEnvVars 
  
 map 
 [ 
  string 
 
 ] 
  string 
 
  
 "" 
  
 /* 185 byte string literal not displayed */ 
 } 
 

Workflow program to be executed by Workflows.

func (*Workflow) Descriptor

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

Deprecated: Use Workflow.ProtoReflect.Descriptor instead.

func (*Workflow) GetCallLogLevel

  func 
  
 ( 
 x 
  
 * 
  Workflow 
 
 ) 
  
 GetCallLogLevel 
 () 
  
  Workflow_CallLogLevel 
 
 

func (*Workflow) GetCreateTime

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

func (*Workflow) GetCryptoKeyName

  func 
  
 ( 
 x 
  
 * 
  Workflow 
 
 ) 
  
 GetCryptoKeyName 
 () 
  
  string 
 
 

func (*Workflow) GetDescription

  func 
  
 ( 
 x 
  
 * 
  Workflow 
 
 ) 
  
 GetDescription 
 () 
  
  string 
 
 

func (*Workflow) GetLabels

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

func (*Workflow) GetName

  func 
  
 ( 
 x 
  
 * 
  Workflow 
 
 ) 
  
 GetName 
 () 
  
  string 
 
 

func (*Workflow) GetRevisionCreateTime

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

func (*Workflow) GetRevisionId

  func 
  
 ( 
 x 
  
 * 
  Workflow 
 
 ) 
  
 GetRevisionId 
 () 
  
  string 
 
 

func (*Workflow) GetServiceAccount

  func 
  
 ( 
 x 
  
 * 
  Workflow 
 
 ) 
  
 GetServiceAccount 
 () 
  
  string 
 
 

func (*Workflow) GetSourceCode

  func 
  
 ( 
 m 
  
 * 
  Workflow 
 
 ) 
  
 GetSourceCode 
 () 
  
 isWorkflow_SourceCode 
 

func (*Workflow) GetSourceContents

  func 
  
 ( 
 x 
  
 * 
  Workflow 
 
 ) 
  
 GetSourceContents 
 () 
  
  string 
 
 

func (*Workflow) GetState

  func 
  
 ( 
 x 
  
 * 
  Workflow 
 
 ) 
  
 GetState 
 () 
  
  Workflow_State 
 
 

func (*Workflow) GetStateError

  func 
  
 ( 
 x 
  
 * 
  Workflow 
 
 ) 
  
 GetStateError 
 () 
  
 * 
  Workflow_StateError 
 
 

func (*Workflow) GetUpdateTime

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

func (*Workflow) GetUserEnvVars

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

func (*Workflow) ProtoMessage

  func 
  
 ( 
 * 
  Workflow 
 
 ) 
  
 ProtoMessage 
 () 
 

func (*Workflow) ProtoReflect

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

func (*Workflow) Reset

  func 
  
 ( 
 x 
  
 * 
  Workflow 
 
 ) 
  
 Reset 
 () 
 

func (*Workflow) String

  func 
  
 ( 
 x 
  
 * 
  Workflow 
 
 ) 
  
 String 
 () 
  
  string 
 
 

Workflow_CallLogLevel

  type 
  
 Workflow_CallLogLevel 
  
  int32 
 
 

Describes the level of platform logging to apply to calls and call responses during workflow executions.

Workflow_CALL_LOG_LEVEL_UNSPECIFIED, Workflow_LOG_ALL_CALLS, Workflow_LOG_ERRORS_ONLY, Workflow_LOG_NONE

  const 
  
 ( 
  
 // No call logging level specified. 
  
 Workflow_CALL_LOG_LEVEL_UNSPECIFIED 
  
  Workflow_CallLogLevel 
 
  
 = 
  
 0 
  
 // Log all call steps within workflows, all call returns, and all exceptions 
  
 // raised. 
  
 Workflow_LOG_ALL_CALLS 
  
  Workflow_CallLogLevel 
 
  
 = 
  
 1 
  
 // Log only exceptions that are raised from call steps within workflows. 
  
 Workflow_LOG_ERRORS_ONLY 
  
  Workflow_CallLogLevel 
 
  
 = 
  
 2 
  
 // Explicitly log nothing. 
  
 Workflow_LOG_NONE 
  
  Workflow_CallLogLevel 
 
  
 = 
  
 3 
 ) 
 

func (Workflow_CallLogLevel) Descriptor

func (Workflow_CallLogLevel) Enum

func (Workflow_CallLogLevel) EnumDescriptor

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

Deprecated: Use Workflow_CallLogLevel.Descriptor instead.

func (Workflow_CallLogLevel) Number

func (Workflow_CallLogLevel) String

func (Workflow_CallLogLevel) Type

Workflow_SourceContents

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

Workflow_State

  type 
  
 Workflow_State 
  
  int32 
 
 

Describes the current state of workflow deployment.

Workflow_STATE_UNSPECIFIED, Workflow_ACTIVE, Workflow_UNAVAILABLE

  const 
  
 ( 
  
 // Invalid state. 
  
 Workflow_STATE_UNSPECIFIED 
  
  Workflow_State 
 
  
 = 
  
 0 
  
 // The workflow has been deployed successfully and is serving. 
  
 Workflow_ACTIVE 
  
  Workflow_State 
 
  
 = 
  
 1 
  
 // Workflow data is unavailable. See the `state_error` field. 
  
 Workflow_UNAVAILABLE 
  
  Workflow_State 
 
  
 = 
  
 2 
 ) 
 

func (Workflow_State) Descriptor

func (Workflow_State) Enum

func (Workflow_State) EnumDescriptor

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

Deprecated: Use Workflow_State.Descriptor instead.

func (Workflow_State) Number

func (Workflow_State) String

  func 
  
 ( 
 x 
  
  Workflow_State 
 
 ) 
  
 String 
 () 
  
  string 
 
 

func (Workflow_State) Type

Workflow_StateError

  type 
  
 Workflow_StateError 
  
 struct 
  
 { 
  
 // Provides specifics about the error. 
  
 Details 
  
  string 
 
  
 `protobuf:"bytes,1,opt,name=details,proto3" json:"details,omitempty"` 
  
 // The type of this state error. 
  
 Type 
  
  Workflow_StateError_Type 
 
  
 `protobuf:"varint,2,opt,name=type,proto3,enum=google.cloud.workflows.v1.Workflow_StateError_Type" json:"type,omitempty"` 
  
 // contains filtered or unexported fields 
 } 
 

Describes an error related to the current state of the workflow.

func (*Workflow_StateError) Descriptor

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

Deprecated: Use Workflow_StateError.ProtoReflect.Descriptor instead.

func (*Workflow_StateError) GetDetails

  func 
  
 ( 
 x 
  
 * 
  Workflow_StateError 
 
 ) 
  
 GetDetails 
 () 
  
  string 
 
 

func (*Workflow_StateError) GetType

func (*Workflow_StateError) ProtoMessage

  func 
  
 ( 
 * 
  Workflow_StateError 
 
 ) 
  
 ProtoMessage 
 () 
 

func (*Workflow_StateError) ProtoReflect

func (*Workflow_StateError) Reset

  func 
  
 ( 
 x 
  
 * 
  Workflow_StateError 
 
 ) 
  
 Reset 
 () 
 

func (*Workflow_StateError) String

  func 
  
 ( 
 x 
  
 * 
  Workflow_StateError 
 
 ) 
  
 String 
 () 
  
  string 
 
 

Workflow_StateError_Type

  type 
  
 Workflow_StateError_Type 
  
  int32 
 
 

Describes the possibled types of a state error.

Workflow_StateError_TYPE_UNSPECIFIED, Workflow_StateError_KMS_ERROR

  const 
  
 ( 
  
 // No type specified. 
  
 Workflow_StateError_TYPE_UNSPECIFIED 
  
  Workflow_StateError_Type 
 
  
 = 
  
 0 
  
 // Caused by an issue with KMS. 
  
 Workflow_StateError_KMS_ERROR 
  
  Workflow_StateError_Type 
 
  
 = 
  
 1 
 ) 
 

func (Workflow_StateError_Type) Descriptor

func (Workflow_StateError_Type) Enum

func (Workflow_StateError_Type) EnumDescriptor

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

Deprecated: Use Workflow_StateError_Type.Descriptor instead.

func (Workflow_StateError_Type) Number

func (Workflow_StateError_Type) String

func (Workflow_StateError_Type) Type

WorkflowsClient

  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 
  
 // returns a [ALREADY_EXISTS][google.rpc.Code.ALREADY_EXISTS] error. 
  
 CreateWorkflow 
 ( 
 ctx 
  
  context 
 
 . 
  Context 
 
 , 
  
 in 
  
 * 
  CreateWorkflowRequest 
 
 , 
  
 opts 
  
 ... 
  grpc 
 
 . 
  CallOption 
 
 ) 
  
 ( 
 * 
  longrunningpb 
 
 . 
  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 
 
 ) 
  
 ( 
 * 
  longrunningpb 
 
 . 
  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 might be created as a result of a 
  
 // successful update operation. In that case, the new revision is used 
  
 // in new workflow executions. 
  
 UpdateWorkflow 
 ( 
 ctx 
  
  context 
 
 . 
  Context 
 
 , 
  
 in 
  
 * 
  UpdateWorkflowRequest 
 
 , 
  
 opts 
  
 ... 
  grpc 
 
 . 
  CallOption 
 
 ) 
  
 ( 
 * 
  longrunningpb 
 
 . 
  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

  func 
  
 NewWorkflowsClient 
 ( 
 cc 
  
  grpc 
 
 . 
  ClientConnInterface 
 
 ) 
  
  WorkflowsClient 
 
 

WorkflowsServer

  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 
  
 // returns a [ALREADY_EXISTS][google.rpc.Code.ALREADY_EXISTS] error. 
  
 CreateWorkflow 
 ( 
  context 
 
 . 
  Context 
 
 , 
  
 * 
  CreateWorkflowRequest 
 
 ) 
  
 ( 
 * 
  longrunningpb 
 
 . 
  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 
 
 ) 
  
 ( 
 * 
  longrunningpb 
 
 . 
  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 might be created as a result of a 
  
 // successful update operation. In that case, the new revision is used 
  
 // in new workflow executions. 
  
 UpdateWorkflow 
 ( 
  context 
 
 . 
  Context 
 
 , 
  
 * 
  UpdateWorkflowRequest 
 
 ) 
  
 ( 
 * 
  longrunningpb 
 
 . 
  Operation 
 
 , 
  
  error 
 
 ) 
 } 
 

WorkflowsServer is the server API for Workflows service.

Create a Mobile Website
View Site in Mobile | Classic
Share by: