Documentation ¶
Overview ¶
Package dataflow provides access to the Google Dataflow API.
See https://cloud.google.com/dataflow
Usage example:
import "github.com/skelterjohn/gcloud_apis/clients/dataflow/v1b3" ... dataflowService, err := dataflow.New(oauthHttpClient)
Index ¶
- Constants
- type ApproximateProgress
- type ApproximateReportedProgress
- type ApproximateSplitRequest
- type AutoscalingSettings
- type CPUTime
- type ComponentSource
- type ComponentTransform
- type ComputationTopology
- type ConcatPosition
- type CounterMetadata
- type CounterStructuredName
- type CounterStructuredNameAndMetadata
- type CounterUpdate
- type CreateJobFromTemplateRequest
- type CustomSourceLocation
- type DataDiskAssignment
- type DerivedSource
- type Disk
- type DisplayData
- type DistributionUpdate
- type DynamicSourceSplit
- type Environment
- type EnvironmentInternalExperiments
- type EnvironmentSdkPipelineOptions
- type EnvironmentUserAgent
- type EnvironmentVersion
- type ExecutionStageSummary
- type FailedLocation
- type FlattenInstruction
- type FloatingPointList
- type FloatingPointMean
- type GetDebugConfigRequest
- type GetDebugConfigResponse
- type GetTemplateResponse
- type InstructionInput
- type InstructionOutput
- type InstructionOutputCodec
- type IntegerList
- type IntegerMean
- type Job
- type JobExecutionInfo
- type JobExecutionStageInfo
- type JobMessage
- type JobMetrics
- type KeyRangeDataDiskAssignment
- type KeyRangeLocation
- type LaunchTemplateParameters
- type LaunchTemplateResponse
- type LeaseWorkItemRequest
- type LeaseWorkItemResponse
- type ListJobMessagesResponse
- type ListJobsResponse
- type MapTask
- type MetricShortId
- type MetricStructuredName
- type MetricUpdate
- type MountedDataDisk
- type MultiOutputInfo
- type NameAndKind
- type Package
- type ParDoInstruction
- type ParDoInstructionUserFn
- type ParallelInstruction
- type ParameterMetadata
- type PartialGroupByKeyInstruction
- type PartialGroupByKeyInstructionInputElementCodec
- type PartialGroupByKeyInstructionValueCombiningFn
- type PipelineDescription
- type Position
- type ProjectsJobsCreateCall
- func (c *ProjectsJobsCreateCall) Context(ctx context.Context) *ProjectsJobsCreateCall
- func (c *ProjectsJobsCreateCall) Do(opts ...googleapi.CallOption) (*Job, error)
- func (c *ProjectsJobsCreateCall) Fields(s ...googleapi.Field) *ProjectsJobsCreateCall
- func (c *ProjectsJobsCreateCall) Location(location string) *ProjectsJobsCreateCall
- func (c *ProjectsJobsCreateCall) ReplaceJobId(replaceJobId string) *ProjectsJobsCreateCall
- func (c *ProjectsJobsCreateCall) View(view string) *ProjectsJobsCreateCall
- type ProjectsJobsDebugGetConfigCall
- func (c *ProjectsJobsDebugGetConfigCall) Context(ctx context.Context) *ProjectsJobsDebugGetConfigCall
- func (c *ProjectsJobsDebugGetConfigCall) Do(opts ...googleapi.CallOption) (*GetDebugConfigResponse, error)
- func (c *ProjectsJobsDebugGetConfigCall) Fields(s ...googleapi.Field) *ProjectsJobsDebugGetConfigCall
- type ProjectsJobsDebugSendCaptureCall
- func (c *ProjectsJobsDebugSendCaptureCall) Context(ctx context.Context) *ProjectsJobsDebugSendCaptureCall
- func (c *ProjectsJobsDebugSendCaptureCall) Do(opts ...googleapi.CallOption) (*SendDebugCaptureResponse, error)
- func (c *ProjectsJobsDebugSendCaptureCall) Fields(s ...googleapi.Field) *ProjectsJobsDebugSendCaptureCall
- type ProjectsJobsDebugService
- type ProjectsJobsGetCall
- func (c *ProjectsJobsGetCall) Context(ctx context.Context) *ProjectsJobsGetCall
- func (c *ProjectsJobsGetCall) Do(opts ...googleapi.CallOption) (*Job, error)
- func (c *ProjectsJobsGetCall) Fields(s ...googleapi.Field) *ProjectsJobsGetCall
- func (c *ProjectsJobsGetCall) IfNoneMatch(entityTag string) *ProjectsJobsGetCall
- func (c *ProjectsJobsGetCall) Location(location string) *ProjectsJobsGetCall
- func (c *ProjectsJobsGetCall) View(view string) *ProjectsJobsGetCall
- type ProjectsJobsGetMetricsCall
- func (c *ProjectsJobsGetMetricsCall) Context(ctx context.Context) *ProjectsJobsGetMetricsCall
- func (c *ProjectsJobsGetMetricsCall) Do(opts ...googleapi.CallOption) (*JobMetrics, error)
- func (c *ProjectsJobsGetMetricsCall) Fields(s ...googleapi.Field) *ProjectsJobsGetMetricsCall
- func (c *ProjectsJobsGetMetricsCall) IfNoneMatch(entityTag string) *ProjectsJobsGetMetricsCall
- func (c *ProjectsJobsGetMetricsCall) Location(location string) *ProjectsJobsGetMetricsCall
- func (c *ProjectsJobsGetMetricsCall) StartTime(startTime string) *ProjectsJobsGetMetricsCall
- type ProjectsJobsListCall
- func (c *ProjectsJobsListCall) Context(ctx context.Context) *ProjectsJobsListCall
- func (c *ProjectsJobsListCall) Do(opts ...googleapi.CallOption) (*ListJobsResponse, error)
- func (c *ProjectsJobsListCall) Fields(s ...googleapi.Field) *ProjectsJobsListCall
- func (c *ProjectsJobsListCall) Filter(filter string) *ProjectsJobsListCall
- func (c *ProjectsJobsListCall) IfNoneMatch(entityTag string) *ProjectsJobsListCall
- func (c *ProjectsJobsListCall) Location(location string) *ProjectsJobsListCall
- func (c *ProjectsJobsListCall) PageSize(pageSize int64) *ProjectsJobsListCall
- func (c *ProjectsJobsListCall) PageToken(pageToken string) *ProjectsJobsListCall
- func (c *ProjectsJobsListCall) Pages(ctx context.Context, f func(*ListJobsResponse) error) error
- func (c *ProjectsJobsListCall) View(view string) *ProjectsJobsListCall
- type ProjectsJobsMessagesListCall
- func (c *ProjectsJobsMessagesListCall) Context(ctx context.Context) *ProjectsJobsMessagesListCall
- func (c *ProjectsJobsMessagesListCall) Do(opts ...googleapi.CallOption) (*ListJobMessagesResponse, error)
- func (c *ProjectsJobsMessagesListCall) EndTime(endTime string) *ProjectsJobsMessagesListCall
- func (c *ProjectsJobsMessagesListCall) Fields(s ...googleapi.Field) *ProjectsJobsMessagesListCall
- func (c *ProjectsJobsMessagesListCall) IfNoneMatch(entityTag string) *ProjectsJobsMessagesListCall
- func (c *ProjectsJobsMessagesListCall) Location(location string) *ProjectsJobsMessagesListCall
- func (c *ProjectsJobsMessagesListCall) MinimumImportance(minimumImportance string) *ProjectsJobsMessagesListCall
- func (c *ProjectsJobsMessagesListCall) PageSize(pageSize int64) *ProjectsJobsMessagesListCall
- func (c *ProjectsJobsMessagesListCall) PageToken(pageToken string) *ProjectsJobsMessagesListCall
- func (c *ProjectsJobsMessagesListCall) Pages(ctx context.Context, f func(*ListJobMessagesResponse) error) error
- func (c *ProjectsJobsMessagesListCall) StartTime(startTime string) *ProjectsJobsMessagesListCall
- type ProjectsJobsMessagesService
- type ProjectsJobsService
- func (r *ProjectsJobsService) Create(projectId string, job *Job) *ProjectsJobsCreateCall
- func (r *ProjectsJobsService) Get(projectId string, jobId string) *ProjectsJobsGetCall
- func (r *ProjectsJobsService) GetMetrics(projectId string, jobId string) *ProjectsJobsGetMetricsCall
- func (r *ProjectsJobsService) List(projectId string) *ProjectsJobsListCall
- func (r *ProjectsJobsService) Update(projectId string, jobId string, job *Job) *ProjectsJobsUpdateCall
- type ProjectsJobsUpdateCall
- func (c *ProjectsJobsUpdateCall) Context(ctx context.Context) *ProjectsJobsUpdateCall
- func (c *ProjectsJobsUpdateCall) Do(opts ...googleapi.CallOption) (*Job, error)
- func (c *ProjectsJobsUpdateCall) Fields(s ...googleapi.Field) *ProjectsJobsUpdateCall
- func (c *ProjectsJobsUpdateCall) Location(location string) *ProjectsJobsUpdateCall
- type ProjectsJobsWorkItemsLeaseCall
- func (c *ProjectsJobsWorkItemsLeaseCall) Context(ctx context.Context) *ProjectsJobsWorkItemsLeaseCall
- func (c *ProjectsJobsWorkItemsLeaseCall) Do(opts ...googleapi.CallOption) (*LeaseWorkItemResponse, error)
- func (c *ProjectsJobsWorkItemsLeaseCall) Fields(s ...googleapi.Field) *ProjectsJobsWorkItemsLeaseCall
- type ProjectsJobsWorkItemsReportStatusCall
- func (c *ProjectsJobsWorkItemsReportStatusCall) Context(ctx context.Context) *ProjectsJobsWorkItemsReportStatusCall
- func (c *ProjectsJobsWorkItemsReportStatusCall) Do(opts ...googleapi.CallOption) (*ReportWorkItemStatusResponse, error)
- func (c *ProjectsJobsWorkItemsReportStatusCall) Fields(s ...googleapi.Field) *ProjectsJobsWorkItemsReportStatusCall
- type ProjectsJobsWorkItemsService
- type ProjectsLocationsJobsCreateCall
- func (c *ProjectsLocationsJobsCreateCall) Context(ctx context.Context) *ProjectsLocationsJobsCreateCall
- func (c *ProjectsLocationsJobsCreateCall) Do(opts ...googleapi.CallOption) (*Job, error)
- func (c *ProjectsLocationsJobsCreateCall) Fields(s ...googleapi.Field) *ProjectsLocationsJobsCreateCall
- func (c *ProjectsLocationsJobsCreateCall) ReplaceJobId(replaceJobId string) *ProjectsLocationsJobsCreateCall
- func (c *ProjectsLocationsJobsCreateCall) View(view string) *ProjectsLocationsJobsCreateCall
- type ProjectsLocationsJobsGetCall
- func (c *ProjectsLocationsJobsGetCall) Context(ctx context.Context) *ProjectsLocationsJobsGetCall
- func (c *ProjectsLocationsJobsGetCall) Do(opts ...googleapi.CallOption) (*Job, error)
- func (c *ProjectsLocationsJobsGetCall) Fields(s ...googleapi.Field) *ProjectsLocationsJobsGetCall
- func (c *ProjectsLocationsJobsGetCall) IfNoneMatch(entityTag string) *ProjectsLocationsJobsGetCall
- func (c *ProjectsLocationsJobsGetCall) View(view string) *ProjectsLocationsJobsGetCall
- type ProjectsLocationsJobsGetMetricsCall
- func (c *ProjectsLocationsJobsGetMetricsCall) Context(ctx context.Context) *ProjectsLocationsJobsGetMetricsCall
- func (c *ProjectsLocationsJobsGetMetricsCall) Do(opts ...googleapi.CallOption) (*JobMetrics, error)
- func (c *ProjectsLocationsJobsGetMetricsCall) Fields(s ...googleapi.Field) *ProjectsLocationsJobsGetMetricsCall
- func (c *ProjectsLocationsJobsGetMetricsCall) IfNoneMatch(entityTag string) *ProjectsLocationsJobsGetMetricsCall
- func (c *ProjectsLocationsJobsGetMetricsCall) StartTime(startTime string) *ProjectsLocationsJobsGetMetricsCall
- type ProjectsLocationsJobsListCall
- func (c *ProjectsLocationsJobsListCall) Context(ctx context.Context) *ProjectsLocationsJobsListCall
- func (c *ProjectsLocationsJobsListCall) Do(opts ...googleapi.CallOption) (*ListJobsResponse, error)
- func (c *ProjectsLocationsJobsListCall) Fields(s ...googleapi.Field) *ProjectsLocationsJobsListCall
- func (c *ProjectsLocationsJobsListCall) Filter(filter string) *ProjectsLocationsJobsListCall
- func (c *ProjectsLocationsJobsListCall) IfNoneMatch(entityTag string) *ProjectsLocationsJobsListCall
- func (c *ProjectsLocationsJobsListCall) PageSize(pageSize int64) *ProjectsLocationsJobsListCall
- func (c *ProjectsLocationsJobsListCall) PageToken(pageToken string) *ProjectsLocationsJobsListCall
- func (c *ProjectsLocationsJobsListCall) Pages(ctx context.Context, f func(*ListJobsResponse) error) error
- func (c *ProjectsLocationsJobsListCall) View(view string) *ProjectsLocationsJobsListCall
- type ProjectsLocationsJobsMessagesListCall
- func (c *ProjectsLocationsJobsMessagesListCall) Context(ctx context.Context) *ProjectsLocationsJobsMessagesListCall
- func (c *ProjectsLocationsJobsMessagesListCall) Do(opts ...googleapi.CallOption) (*ListJobMessagesResponse, error)
- func (c *ProjectsLocationsJobsMessagesListCall) EndTime(endTime string) *ProjectsLocationsJobsMessagesListCall
- func (c *ProjectsLocationsJobsMessagesListCall) Fields(s ...googleapi.Field) *ProjectsLocationsJobsMessagesListCall
- func (c *ProjectsLocationsJobsMessagesListCall) IfNoneMatch(entityTag string) *ProjectsLocationsJobsMessagesListCall
- func (c *ProjectsLocationsJobsMessagesListCall) MinimumImportance(minimumImportance string) *ProjectsLocationsJobsMessagesListCall
- func (c *ProjectsLocationsJobsMessagesListCall) PageSize(pageSize int64) *ProjectsLocationsJobsMessagesListCall
- func (c *ProjectsLocationsJobsMessagesListCall) PageToken(pageToken string) *ProjectsLocationsJobsMessagesListCall
- func (c *ProjectsLocationsJobsMessagesListCall) Pages(ctx context.Context, f func(*ListJobMessagesResponse) error) error
- func (c *ProjectsLocationsJobsMessagesListCall) StartTime(startTime string) *ProjectsLocationsJobsMessagesListCall
- type ProjectsLocationsJobsMessagesService
- type ProjectsLocationsJobsService
- func (r *ProjectsLocationsJobsService) Create(projectId string, location string, job *Job) *ProjectsLocationsJobsCreateCall
- func (r *ProjectsLocationsJobsService) Get(projectId string, location string, jobId string) *ProjectsLocationsJobsGetCall
- func (r *ProjectsLocationsJobsService) GetMetrics(projectId string, location string, jobId string) *ProjectsLocationsJobsGetMetricsCall
- func (r *ProjectsLocationsJobsService) List(projectId string, location string) *ProjectsLocationsJobsListCall
- func (r *ProjectsLocationsJobsService) Update(projectId string, location string, jobId string, job *Job) *ProjectsLocationsJobsUpdateCall
- type ProjectsLocationsJobsUpdateCall
- type ProjectsLocationsJobsWorkItemsLeaseCall
- func (c *ProjectsLocationsJobsWorkItemsLeaseCall) Context(ctx context.Context) *ProjectsLocationsJobsWorkItemsLeaseCall
- func (c *ProjectsLocationsJobsWorkItemsLeaseCall) Do(opts ...googleapi.CallOption) (*LeaseWorkItemResponse, error)
- func (c *ProjectsLocationsJobsWorkItemsLeaseCall) Fields(s ...googleapi.Field) *ProjectsLocationsJobsWorkItemsLeaseCall
- type ProjectsLocationsJobsWorkItemsReportStatusCall
- func (c *ProjectsLocationsJobsWorkItemsReportStatusCall) Context(ctx context.Context) *ProjectsLocationsJobsWorkItemsReportStatusCall
- func (c *ProjectsLocationsJobsWorkItemsReportStatusCall) Do(opts ...googleapi.CallOption) (*ReportWorkItemStatusResponse, error)
- func (c *ProjectsLocationsJobsWorkItemsReportStatusCall) Fields(s ...googleapi.Field) *ProjectsLocationsJobsWorkItemsReportStatusCall
- type ProjectsLocationsJobsWorkItemsService
- func (r *ProjectsLocationsJobsWorkItemsService) Lease(projectId string, location string, jobId string, ...) *ProjectsLocationsJobsWorkItemsLeaseCall
- func (r *ProjectsLocationsJobsWorkItemsService) ReportStatus(projectId string, location string, jobId string, ...) *ProjectsLocationsJobsWorkItemsReportStatusCall
- type ProjectsLocationsService
- type ProjectsService
- type ProjectsTemplatesCreateCall
- type ProjectsTemplatesGetCall
- func (c *ProjectsTemplatesGetCall) Context(ctx context.Context) *ProjectsTemplatesGetCall
- func (c *ProjectsTemplatesGetCall) Do(opts ...googleapi.CallOption) (*GetTemplateResponse, error)
- func (c *ProjectsTemplatesGetCall) Fields(s ...googleapi.Field) *ProjectsTemplatesGetCall
- func (c *ProjectsTemplatesGetCall) GcsPath(gcsPath string) *ProjectsTemplatesGetCall
- func (c *ProjectsTemplatesGetCall) IfNoneMatch(entityTag string) *ProjectsTemplatesGetCall
- func (c *ProjectsTemplatesGetCall) View(view string) *ProjectsTemplatesGetCall
- type ProjectsTemplatesLaunchCall
- func (c *ProjectsTemplatesLaunchCall) Context(ctx context.Context) *ProjectsTemplatesLaunchCall
- func (c *ProjectsTemplatesLaunchCall) Do(opts ...googleapi.CallOption) (*LaunchTemplateResponse, error)
- func (c *ProjectsTemplatesLaunchCall) DryRun(dryRun bool) *ProjectsTemplatesLaunchCall
- func (c *ProjectsTemplatesLaunchCall) Fields(s ...googleapi.Field) *ProjectsTemplatesLaunchCall
- func (c *ProjectsTemplatesLaunchCall) GcsPath(gcsPath string) *ProjectsTemplatesLaunchCall
- type ProjectsTemplatesService
- func (r *ProjectsTemplatesService) Create(projectId string, createjobfromtemplaterequest *CreateJobFromTemplateRequest) *ProjectsTemplatesCreateCall
- func (r *ProjectsTemplatesService) Get(projectId string) *ProjectsTemplatesGetCall
- func (r *ProjectsTemplatesService) Launch(projectId string, launchtemplateparameters *LaunchTemplateParameters) *ProjectsTemplatesLaunchCall
- type ProjectsWorkerMessagesCall
- type PubsubLocation
- type ReadInstruction
- type ReportWorkItemStatusRequest
- type ReportWorkItemStatusResponse
- type ReportedParallelism
- type ResourceUtilizationReport
- type ResourceUtilizationReportResponse
- type RuntimeEnvironment
- type SendDebugCaptureRequest
- type SendDebugCaptureResponse
- type SendWorkerMessagesRequest
- type SendWorkerMessagesResponse
- type SeqMapTask
- type SeqMapTaskOutputInfo
- type SeqMapTaskUserFn
- type Service
- type ShellTask
- type SideInputInfo
- type SideInputInfoKind
- type Sink
- type SinkCodec
- type SinkSpec
- type Source
- type SourceBaseSpecs
- type SourceCodec
- type SourceFork
- type SourceGetMetadataRequest
- type SourceGetMetadataResponse
- type SourceMetadata
- type SourceOperationRequest
- type SourceOperationResponse
- type SourceSpec
- type SourceSplitOptions
- type SourceSplitRequest
- type SourceSplitResponse
- type SourceSplitShard
- type SplitInt64
- type StageSource
- type StateFamilyConfig
- type Status
- type StatusDetails
- type Step
- type StepProperties
- type StreamLocation
- type StreamingComputationConfig
- type StreamingComputationRanges
- type StreamingComputationTask
- type StreamingConfigTask
- type StreamingSetupTask
- type StreamingSideInputLocation
- type StreamingStageLocation
- type StringList
- type TaskRunnerSettings
- type TemplateMetadata
- type TopologyConfig
- type TransformSummary
- type WorkItem
- type WorkItemServiceState
- type WorkItemServiceStateHarnessData
- type WorkItemStatus
- type WorkerHealthReport
- type WorkerHealthReportPods
- type WorkerHealthReportResponse
- type WorkerMessage
- type WorkerMessageCode
- type WorkerMessageCodeParameters
- type WorkerMessageResponse
- type WorkerPool
- type WorkerPoolPoolArgs
- type WorkerSettings
- type WriteInstruction
Constants ¶
const ( // View and manage your data across Google Cloud Platform services CloudPlatformScope = "https://www.googleapis.com/auth/cloud-platform" // View your email address UserinfoEmailScope = "https://www.googleapis.com/auth/userinfo.email" )
OAuth2 scopes used by this API.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type ApproximateProgress ¶
type ApproximateProgress struct { // PercentComplete: Obsolete. PercentComplete float64 `json:"percentComplete,omitempty"` // Position: Obsolete. Position *Position `json:"position,omitempty"` // RemainingTime: Obsolete. RemainingTime string `json:"remainingTime,omitempty"` // ForceSendFields is a list of field names (e.g. "PercentComplete") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` }
ApproximateProgress: Obsolete in favor of ApproximateReportedProgress and ApproximateSplitRequest.
func (*ApproximateProgress) MarshalJSON ¶
func (s *ApproximateProgress) MarshalJSON() ([]byte, error)
type ApproximateReportedProgress ¶
type ApproximateReportedProgress struct { // ConsumedParallelism: Total amount of parallelism in the portion of // input of this task that has // already been consumed and is no longer active. In the first two // examples // above (see remaining_parallelism), the value should be 29 or // 2 // respectively. The sum of remaining_parallelism and // consumed_parallelism // should equal the total amount of parallelism in this work item. // If // specified, must be finite. ConsumedParallelism *ReportedParallelism `json:"consumedParallelism,omitempty"` // FractionConsumed: Completion as fraction of the input consumed, from // 0.0 (beginning, nothing // consumed), to 1.0 (end of the input, entire input consumed). FractionConsumed float64 `json:"fractionConsumed,omitempty"` // Position: A Position within the work to represent a progress. Position *Position `json:"position,omitempty"` // RemainingParallelism: Total amount of parallelism in the input of // this task that remains, // (i.e. can be delegated to this task and any new tasks via // dynamic // splitting). Always at least 1 for non-finished work items and 0 // for // finished. // // "Amount of parallelism" refers to how many non-empty parts of the // input // can be read in parallel. This does not necessarily equal number // of records. An input that can be read in parallel down to // the // individual records is called "perfectly splittable". // An example of non-perfectly parallelizable input is a // block-compressed // file format where a block of records has to be read as a whole, // but different blocks can be read in parallel. // // Examples: // * If we are processing record #30 (starting at 1) out of 50 in a // perfectly // splittable 50-record input, this value should be 21 (20 remaining + // 1 // current). // * If we are reading through block 3 in a block-compressed file // consisting // of 5 blocks, this value should be 3 (since blocks 4 and 5 can be // processed in parallel by new tasks via dynamic splitting and the // current // task remains processing block 3). // * If we are reading through the last block in a block-compressed // file, // or reading or processing the last record in a perfectly splittable // input, this value should be 1, because apart from the current task, // no // additional remainder can be split off. RemainingParallelism *ReportedParallelism `json:"remainingParallelism,omitempty"` // ForceSendFields is a list of field names (e.g. "ConsumedParallelism") // to unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` }
ApproximateReportedProgress: A progress measurement of a WorkItem by a worker.
func (*ApproximateReportedProgress) MarshalJSON ¶
func (s *ApproximateReportedProgress) MarshalJSON() ([]byte, error)
type ApproximateSplitRequest ¶
type ApproximateSplitRequest struct { // FractionConsumed: A fraction at which to split the work item, from // 0.0 (beginning of the // input) to 1.0 (end of the input). FractionConsumed float64 `json:"fractionConsumed,omitempty"` // Position: A Position at which to split the work item. Position *Position `json:"position,omitempty"` // ForceSendFields is a list of field names (e.g. "FractionConsumed") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` }
ApproximateSplitRequest: A suggestion by the service to the worker to dynamically split the WorkItem.
func (*ApproximateSplitRequest) MarshalJSON ¶
func (s *ApproximateSplitRequest) MarshalJSON() ([]byte, error)
type AutoscalingSettings ¶
type AutoscalingSettings struct { // Algorithm: The algorithm to use for autoscaling. // // Possible values: // "AUTOSCALING_ALGORITHM_UNKNOWN" - The algorithm is unknown, or // unspecified. // "AUTOSCALING_ALGORITHM_NONE" - Disable autoscaling. // "AUTOSCALING_ALGORITHM_BASIC" - Increase worker count over time to // reduce job execution time. Algorithm string `json:"algorithm,omitempty"` // MaxNumWorkers: The maximum number of workers to cap scaling at. MaxNumWorkers int64 `json:"maxNumWorkers,omitempty"` // ForceSendFields is a list of field names (e.g. "Algorithm") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` }
AutoscalingSettings: Settings for WorkerPool autoscaling.
func (*AutoscalingSettings) MarshalJSON ¶
func (s *AutoscalingSettings) MarshalJSON() ([]byte, error)
type CPUTime ¶
type CPUTime struct { // Rate: Average CPU utilization rate (% non-idle cpu / second) since // previous // sample. Rate float64 `json:"rate,omitempty"` // Timestamp: Timestamp of the measurement. Timestamp string `json:"timestamp,omitempty"` // TotalMs: Total active CPU time across all cores (ie., non-idle) in // milliseconds // since start-up. TotalMs uint64 `json:"totalMs,omitempty,string"` // ForceSendFields is a list of field names (e.g. "Rate") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` }
CPUTime: Modeled after information exposed by /proc/stat.
func (*CPUTime) MarshalJSON ¶
type ComponentSource ¶
type ComponentSource struct { // Name: Dataflow service generated name for this source. Name string `json:"name,omitempty"` // OriginalTransformOrCollection: User name for the original user // transform or collection with which this // source is most closely associated. OriginalTransformOrCollection string `json:"originalTransformOrCollection,omitempty"` // UserName: Human-readable name for this transform; may be user or // system generated. UserName string `json:"userName,omitempty"` // ForceSendFields is a list of field names (e.g. "Name") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` }
ComponentSource: Description of an interstitial value between transforms in an execution stage.
func (*ComponentSource) MarshalJSON ¶
func (s *ComponentSource) MarshalJSON() ([]byte, error)
type ComponentTransform ¶
type ComponentTransform struct { // Name: Dataflow service generated name for this source. Name string `json:"name,omitempty"` // OriginalTransform: User name for the original user transform with // which this transform is // most closely associated. OriginalTransform string `json:"originalTransform,omitempty"` // UserName: Human-readable name for this transform; may be user or // system generated. UserName string `json:"userName,omitempty"` // ForceSendFields is a list of field names (e.g. "Name") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` }
ComponentTransform: Description of a transform executed as part of an execution stage.
func (*ComponentTransform) MarshalJSON ¶
func (s *ComponentTransform) MarshalJSON() ([]byte, error)
type ComputationTopology ¶
type ComputationTopology struct { // ComputationId: The ID of the computation. ComputationId string `json:"computationId,omitempty"` // Inputs: The inputs to the computation. Inputs []*StreamLocation `json:"inputs,omitempty"` // KeyRanges: The key ranges processed by the computation. KeyRanges []*KeyRangeLocation `json:"keyRanges,omitempty"` // Outputs: The outputs from the computation. Outputs []*StreamLocation `json:"outputs,omitempty"` // StateFamilies: The state family values. StateFamilies []*StateFamilyConfig `json:"stateFamilies,omitempty"` // SystemStageName: The system stage name. SystemStageName string `json:"systemStageName,omitempty"` // UserStageName: The user stage name. UserStageName string `json:"userStageName,omitempty"` // ForceSendFields is a list of field names (e.g. "ComputationId") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` }
ComputationTopology: All configuration data for a particular Computation.
func (*ComputationTopology) MarshalJSON ¶
func (s *ComputationTopology) MarshalJSON() ([]byte, error)
type ConcatPosition ¶
type ConcatPosition struct { // Index: Index of the inner source. Index int64 `json:"index,omitempty"` // Position: Position within the inner source. Position *Position `json:"position,omitempty"` // ForceSendFields is a list of field names (e.g. "Index") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` }
ConcatPosition: A position that encapsulates an inner position and an index for the inner position. A ConcatPosition can be used by a reader of a source that encapsulates a set of other sources.
func (*ConcatPosition) MarshalJSON ¶
func (s *ConcatPosition) MarshalJSON() ([]byte, error)
type CounterMetadata ¶
type CounterMetadata struct { // Description: Human-readable description of the counter semantics. Description string `json:"description,omitempty"` // Kind: Counter aggregation kind. // // Possible values: // "INVALID" - Counter aggregation kind was not set. // "SUM" - Aggregated value is the sum of all contributed values. // "MAX" - Aggregated value is the max of all contributed values. // "MIN" - Aggregated value is the min of all contributed values. // "MEAN" - Aggregated value is the mean of all contributed values. // "OR" - Aggregated value represents the logical 'or' of all // contributed values. // "AND" - Aggregated value represents the logical 'and' of all // contributed values. // "SET" - Aggregated value is a set of unique contributed values. // "DISTRIBUTION" - Aggregated value captures statistics about a // distribution. Kind string `json:"kind,omitempty"` // OtherUnits: A string referring to the unit type. OtherUnits string `json:"otherUnits,omitempty"` // StandardUnits: System defined Units, see above enum. // // Possible values: // "BYTES" - Counter returns a value in bytes. // "BYTES_PER_SEC" - Counter returns a value in bytes per second. // "MILLISECONDS" - Counter returns a value in milliseconds. // "MICROSECONDS" - Counter returns a value in microseconds. // "NANOSECONDS" - Counter returns a value in nanoseconds. // "TIMESTAMP_MSEC" - Counter returns a timestamp in milliseconds. // "TIMESTAMP_USEC" - Counter returns a timestamp in microseconds. // "TIMESTAMP_NSEC" - Counter returns a timestamp in nanoseconds. StandardUnits string `json:"standardUnits,omitempty"` // ForceSendFields is a list of field names (e.g. "Description") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` }
CounterMetadata: CounterMetadata includes all static non-name non-value counter attributes.
func (*CounterMetadata) MarshalJSON ¶
func (s *CounterMetadata) MarshalJSON() ([]byte, error)
type CounterStructuredName ¶
type CounterStructuredName struct { // ComponentStepName: Name of the optimized step being executed by the // workers. ComponentStepName string `json:"componentStepName,omitempty"` // ExecutionStepName: Name of the stage. An execution step contains // multiple component steps. ExecutionStepName string `json:"executionStepName,omitempty"` // Name: Counter name. Not necessarily globally-unique, but unique // within the // context of the other fields. // Required. Name string `json:"name,omitempty"` // Origin: One of the standard Origins defined above. // // Possible values: // "SYSTEM" - Counter was created by the Dataflow system. // "USER" - Counter was created by the user. Origin string `json:"origin,omitempty"` // OriginNamespace: A string containing a more specific namespace of the // counter's origin. OriginNamespace string `json:"originNamespace,omitempty"` // OriginalStepName: System generated name of the original step in the // user's graph, before // optimization. OriginalStepName string `json:"originalStepName,omitempty"` // Portion: Portion of this counter, either key or value. // // Possible values: // "ALL" - Counter portion has not been set. // "KEY" - Counter reports a key. // "VALUE" - Counter reports a value. Portion string `json:"portion,omitempty"` // WorkerId: ID of a particular worker. WorkerId string `json:"workerId,omitempty"` // ForceSendFields is a list of field names (e.g. "ComponentStepName") // to unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` }
CounterStructuredName: Identifies a counter within a per-job namespace. Counters whose structured names are the same get merged into a single value for the job.
func (*CounterStructuredName) MarshalJSON ¶
func (s *CounterStructuredName) MarshalJSON() ([]byte, error)
type CounterStructuredNameAndMetadata ¶
type CounterStructuredNameAndMetadata struct { // Metadata: Metadata associated with a counter Metadata *CounterMetadata `json:"metadata,omitempty"` // Name: Structured name of the counter. Name *CounterStructuredName `json:"name,omitempty"` // ForceSendFields is a list of field names (e.g. "Metadata") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` }
CounterStructuredNameAndMetadata: A single message which encapsulates structured name and metadata for a given counter.
func (*CounterStructuredNameAndMetadata) MarshalJSON ¶
func (s *CounterStructuredNameAndMetadata) MarshalJSON() ([]byte, error)
type CounterUpdate ¶
type CounterUpdate struct { // Boolean: Boolean value for And, Or. Boolean bool `json:"boolean,omitempty"` // Cumulative: True if this counter is reported as the total cumulative // aggregate // value accumulated since the worker started working on this // WorkItem. // By default this is false, indicating that this counter is reported // as a delta. Cumulative bool `json:"cumulative,omitempty"` // Distribution: Distribution data Distribution *DistributionUpdate `json:"distribution,omitempty"` // FloatingPoint: Floating point value for Sum, Max, Min. FloatingPoint float64 `json:"floatingPoint,omitempty"` // FloatingPointList: List of floating point numbers, for Set. FloatingPointList *FloatingPointList `json:"floatingPointList,omitempty"` // FloatingPointMean: Floating point mean aggregation value for Mean. FloatingPointMean *FloatingPointMean `json:"floatingPointMean,omitempty"` // Integer: Integer value for Sum, Max, Min. Integer *SplitInt64 `json:"integer,omitempty"` // IntegerList: List of integers, for Set. IntegerList *IntegerList `json:"integerList,omitempty"` // IntegerMean: Integer mean aggregation value for Mean. IntegerMean *IntegerMean `json:"integerMean,omitempty"` // Internal: Value for internally-defined counters used by the Dataflow // service. Internal interface{} `json:"internal,omitempty"` // NameAndKind: Counter name and aggregation type. NameAndKind *NameAndKind `json:"nameAndKind,omitempty"` // ShortId: The service-generated short identifier for this counter. // The short_id -> (name, metadata) mapping is constant for the lifetime // of // a job. ShortId int64 `json:"shortId,omitempty,string"` // StringList: List of strings, for Set. StringList *StringList `json:"stringList,omitempty"` // StructuredNameAndMetadata: Counter structured name and metadata. StructuredNameAndMetadata *CounterStructuredNameAndMetadata `json:"structuredNameAndMetadata,omitempty"` // ForceSendFields is a list of field names (e.g. "Boolean") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` }
CounterUpdate: An update to a Counter sent from a worker.
func (*CounterUpdate) MarshalJSON ¶
func (s *CounterUpdate) MarshalJSON() ([]byte, error)
type CreateJobFromTemplateRequest ¶
type CreateJobFromTemplateRequest struct { // Environment: The runtime environment for the job. Environment *RuntimeEnvironment `json:"environment,omitempty"` // GcsPath: Required. A Cloud Storage path to the template from which // to // create the job. // Must be a valid Cloud Storage URL, beginning with `gs://`. GcsPath string `json:"gcsPath,omitempty"` // JobName: Required. The job name to use for the created job. JobName string `json:"jobName,omitempty"` // Parameters: The runtime parameters to pass to the job. Parameters map[string]string `json:"parameters,omitempty"` // ForceSendFields is a list of field names (e.g. "Environment") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` }
CreateJobFromTemplateRequest: A request to create a Cloud Dataflow job from a template.
func (*CreateJobFromTemplateRequest) MarshalJSON ¶
func (s *CreateJobFromTemplateRequest) MarshalJSON() ([]byte, error)
type CustomSourceLocation ¶
type CustomSourceLocation struct { // Stateful: Whether this source is stateful. Stateful bool `json:"stateful,omitempty"` // ForceSendFields is a list of field names (e.g. "Stateful") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` }
CustomSourceLocation: Identifies the location of a custom souce.
func (*CustomSourceLocation) MarshalJSON ¶
func (s *CustomSourceLocation) MarshalJSON() ([]byte, error)
type DataDiskAssignment ¶
type DataDiskAssignment struct { // DataDisks: Mounted data disks. The order is important a data disk's // 0-based index in // this list defines which persistent directory the disk is mounted to, // for // example the list of { "myproject-1014-104817-4c2-harness-0-disk-0" // }, // { "myproject-1014-104817-4c2-harness-0-disk-1" }. DataDisks []string `json:"dataDisks,omitempty"` // VmInstance: VM instance name the data disks mounted to, for // example // "myproject-1014-104817-4c2-harness-0". VmInstance string `json:"vmInstance,omitempty"` // ForceSendFields is a list of field names (e.g. "DataDisks") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` }
DataDiskAssignment: Data disk assignment for a given VM instance.
func (*DataDiskAssignment) MarshalJSON ¶
func (s *DataDiskAssignment) MarshalJSON() ([]byte, error)
type DerivedSource ¶
type DerivedSource struct { // DerivationMode: What source to base the produced source on (if any). // // Possible values: // "SOURCE_DERIVATION_MODE_UNKNOWN" - The source derivation is // unknown, or unspecified. // "SOURCE_DERIVATION_MODE_INDEPENDENT" - Produce a completely // independent Source with no base. // "SOURCE_DERIVATION_MODE_CHILD_OF_CURRENT" - Produce a Source based // on the Source being split. // "SOURCE_DERIVATION_MODE_SIBLING_OF_CURRENT" - Produce a Source // based on the base of the Source being split. DerivationMode string `json:"derivationMode,omitempty"` // Source: Specification of the source. Source *Source `json:"source,omitempty"` // ForceSendFields is a list of field names (e.g. "DerivationMode") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` }
DerivedSource: Specification of one of the bundles produced as a result of splitting a Source (e.g. when executing a SourceSplitRequest, or when splitting an active task using WorkItemStatus.dynamic_source_split), relative to the source being split.
func (*DerivedSource) MarshalJSON ¶
func (s *DerivedSource) MarshalJSON() ([]byte, error)
type Disk ¶
type Disk struct { // DiskType: Disk storage type, as defined by Google Compute Engine. // This // must be a disk type appropriate to the project and zone in which // the workers will run. If unknown or unspecified, the service // will attempt to choose a reasonable default. // // For example, the standard persistent disk type is a resource // name // typically ending in "pd-standard". If SSD persistent disks // are // available, the resource name typically ends with "pd-ssd". // The // actual valid values are defined the Google Compute Engine API, // not by the Cloud Dataflow API; consult the Google Compute // Engine // documentation for more information about determining the set // of // available disk types for a particular project and zone. // // Google Compute Engine Disk types are local to a particular // project in a particular zone, and so the resource name will // typically look something like // this: // // compute.googleapis.com/projects/project-id/zones/zone/diskTypes // /pd-standard DiskType string `json:"diskType,omitempty"` // MountPoint: Directory in a VM where disk is mounted. MountPoint string `json:"mountPoint,omitempty"` // SizeGb: Size of disk in GB. If zero or unspecified, the service // will // attempt to choose a reasonable default. SizeGb int64 `json:"sizeGb,omitempty"` // ForceSendFields is a list of field names (e.g. "DiskType") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` }
Disk: Describes the data disk used by a workflow job.
func (*Disk) MarshalJSON ¶
type DisplayData ¶
type DisplayData struct { // BoolValue: Contains value if the data is of a boolean type. BoolValue bool `json:"boolValue,omitempty"` // DurationValue: Contains value if the data is of duration type. DurationValue string `json:"durationValue,omitempty"` // FloatValue: Contains value if the data is of float type. FloatValue float64 `json:"floatValue,omitempty"` // Int64Value: Contains value if the data is of int64 type. Int64Value int64 `json:"int64Value,omitempty,string"` // JavaClassValue: Contains value if the data is of java class type. JavaClassValue string `json:"javaClassValue,omitempty"` // Key: The key identifying the display data. // This is intended to be used as a label for the display data // when viewed in a dax monitoring system. Key string `json:"key,omitempty"` // Label: An optional label to display in a dax UI for the element. Label string `json:"label,omitempty"` // Namespace: The namespace for the key. This is usually a class name or // programming // language namespace (i.e. python module) which defines the display // data. // This allows a dax monitoring system to specially handle the data // and perform custom rendering. Namespace string `json:"namespace,omitempty"` // ShortStrValue: A possible additional shorter value to display. // For example a java_class_name_value of com.mypackage.MyDoFn // will be stored with MyDoFn as the short_str_value // and // com.mypackage.MyDoFn as the java_class_name value. // short_str_value can be displayed and java_class_name_value // will be displayed as a tooltip. ShortStrValue string `json:"shortStrValue,omitempty"` // StrValue: Contains value if the data is of string type. StrValue string `json:"strValue,omitempty"` // TimestampValue: Contains value if the data is of timestamp type. TimestampValue string `json:"timestampValue,omitempty"` // Url: An optional full URL. Url string `json:"url,omitempty"` // ForceSendFields is a list of field names (e.g. "BoolValue") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` }
DisplayData: Data provided with a pipeline or transform to provide descriptive info.
func (*DisplayData) MarshalJSON ¶
func (s *DisplayData) MarshalJSON() ([]byte, error)
type DistributionUpdate ¶
type DistributionUpdate struct { // Count: The count of the number of elements present in the // distribution. Count *SplitInt64 `json:"count,omitempty"` // Max: The maximum value present in the distribution. Max *SplitInt64 `json:"max,omitempty"` // Min: The minimum value present in the distribution. Min *SplitInt64 `json:"min,omitempty"` // Sum: Use an int64 since we'd prefer the added precision. If overflow // is a common // problem we can detect it and use an additional int64 or a double. Sum *SplitInt64 `json:"sum,omitempty"` // SumOfSquares: Use a double since the sum of squares is likely to // overflow int64. SumOfSquares float64 `json:"sumOfSquares,omitempty"` // ForceSendFields is a list of field names (e.g. "Count") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` }
DistributionUpdate: A metric value representing a distribution.
func (*DistributionUpdate) MarshalJSON ¶
func (s *DistributionUpdate) MarshalJSON() ([]byte, error)
type DynamicSourceSplit ¶
type DynamicSourceSplit struct { // Primary: Primary part (continued to be processed by // worker). // Specified relative to the previously-current source. // Becomes current. Primary *DerivedSource `json:"primary,omitempty"` // Residual: Residual part (returned to the pool of work). // Specified relative to the previously-current source. Residual *DerivedSource `json:"residual,omitempty"` // ForceSendFields is a list of field names (e.g. "Primary") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` }
DynamicSourceSplit: When a task splits using WorkItemStatus.dynamic_source_split, this message describes the two parts of the split relative to the description of the current task's input.
func (*DynamicSourceSplit) MarshalJSON ¶
func (s *DynamicSourceSplit) MarshalJSON() ([]byte, error)
type Environment ¶
type Environment struct { // ClusterManagerApiService: The type of cluster manager API to use. If // unknown or // unspecified, the service will attempt to choose a reasonable // default. This should be in the form of the API service name, // e.g. "compute.googleapis.com". ClusterManagerApiService string `json:"clusterManagerApiService,omitempty"` // Dataset: The dataset for the current project where various // workflow // related tables are stored. // // The supported resource type is: // // Google BigQuery: // bigquery.googleapis.com/{dataset} Dataset string `json:"dataset,omitempty"` // Experiments: The list of experiments to enable. Experiments []string `json:"experiments,omitempty"` // InternalExperiments: Experimental settings. InternalExperiments EnvironmentInternalExperiments `json:"internalExperiments,omitempty"` // SdkPipelineOptions: The Cloud Dataflow SDK pipeline options specified // by the user. These // options are passed through the service and are used to recreate // the // SDK pipeline options on the worker in a language agnostic and // platform // independent way. SdkPipelineOptions EnvironmentSdkPipelineOptions `json:"sdkPipelineOptions,omitempty"` // ServiceAccountEmail: Identity to run virtual machines as. Defaults to // the default account. ServiceAccountEmail string `json:"serviceAccountEmail,omitempty"` // TempStoragePrefix: The prefix of the resources the system should use // for temporary // storage. The system will append the suffix "/temp-{JOBNAME} to // this resource prefix, where {JOBNAME} is the value of the // job_name field. The resulting bucket and object prefix is used // as the prefix of the resources used to store temporary data // needed during the job execution. NOTE: This will override the // value in taskrunner_settings. // The supported resource type is: // // Google Cloud Storage: // // storage.googleapis.com/{bucket}/{object} // bucket.storage.googleapis.com/{object} TempStoragePrefix string `json:"tempStoragePrefix,omitempty"` // UserAgent: A description of the process that generated the request. UserAgent EnvironmentUserAgent `json:"userAgent,omitempty"` // Version: A structure describing which components and their versions // of the service // are required in order to run the job. Version EnvironmentVersion `json:"version,omitempty"` // WorkerPools: The worker pools. At least one "harness" worker pool // must be // specified in order for the job to have workers. WorkerPools []*WorkerPool `json:"workerPools,omitempty"` // ForceSendFields is a list of field names (e.g. // "ClusterManagerApiService") to unconditionally include in API // requests. By default, fields with empty values are omitted from API // requests. However, any non-pointer, non-interface field appearing in // ForceSendFields will be sent to the server regardless of whether the // field is empty or not. This may be used to include empty fields in // Patch requests. ForceSendFields []string `json:"-"` }
Environment: Describes the environment in which a Dataflow Job runs.
func (*Environment) MarshalJSON ¶
func (s *Environment) MarshalJSON() ([]byte, error)
type EnvironmentInternalExperiments ¶
type EnvironmentInternalExperiments interface{}
type EnvironmentSdkPipelineOptions ¶
type EnvironmentSdkPipelineOptions interface{}
type EnvironmentUserAgent ¶
type EnvironmentUserAgent interface{}
type EnvironmentVersion ¶
type EnvironmentVersion interface{}
type ExecutionStageSummary ¶
type ExecutionStageSummary struct { // ComponentSource: Collections produced and consumed by component // transforms of this stage. ComponentSource []*ComponentSource `json:"componentSource,omitempty"` // ComponentTransform: Transforms that comprise this execution stage. ComponentTransform []*ComponentTransform `json:"componentTransform,omitempty"` // Id: Dataflow service generated id for this stage. Id string `json:"id,omitempty"` // InputSource: Input sources for this stage. InputSource []*StageSource `json:"inputSource,omitempty"` // Kind: Type of tranform this stage is executing. // // Possible values: // "UNKNOWN_KIND" - Unrecognized transform type. // "PAR_DO_KIND" - ParDo transform. // "GROUP_BY_KEY_KIND" - Group By Key transform. // "FLATTEN_KIND" - Flatten transform. // "READ_KIND" - Read transform. // "WRITE_KIND" - Write transform. // "CONSTANT_KIND" - Constructs from a constant value, such as with // Create.of. // "SINGLETON_KIND" - Creates a Singleton view of a collection. // "SHUFFLE_KIND" - Opening or closing a shuffle session, often as // part of a GroupByKey. Kind string `json:"kind,omitempty"` // Name: Dataflow service generated name for this stage. Name string `json:"name,omitempty"` // OutputSource: Output sources for this stage. OutputSource []*StageSource `json:"outputSource,omitempty"` // ForceSendFields is a list of field names (e.g. "ComponentSource") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` }
ExecutionStageSummary: Description of the composing transforms, names/ids, and input/outputs of a stage of execution. Some composing transforms and sources may have been generated by the Dataflow service during execution planning.
func (*ExecutionStageSummary) MarshalJSON ¶
func (s *ExecutionStageSummary) MarshalJSON() ([]byte, error)
type FailedLocation ¶
type FailedLocation struct { // Name: The name of the failed location. Name string `json:"name,omitempty"` // ForceSendFields is a list of field names (e.g. "Name") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` }
FailedLocation: Indicates which location failed to respond to a request for data.
func (*FailedLocation) MarshalJSON ¶
func (s *FailedLocation) MarshalJSON() ([]byte, error)
type FlattenInstruction ¶
type FlattenInstruction struct { // Inputs: Describes the inputs to the flatten instruction. Inputs []*InstructionInput `json:"inputs,omitempty"` // ForceSendFields is a list of field names (e.g. "Inputs") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` }
FlattenInstruction: An instruction that copies its inputs (zero or more) to its (single) output.
func (*FlattenInstruction) MarshalJSON ¶
func (s *FlattenInstruction) MarshalJSON() ([]byte, error)
type FloatingPointList ¶
type FloatingPointList struct { // Elements: Elements of the list. Elements []float64 `json:"elements,omitempty"` // ForceSendFields is a list of field names (e.g. "Elements") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` }
FloatingPointList: A metric value representing a list of floating point numbers.
func (*FloatingPointList) MarshalJSON ¶
func (s *FloatingPointList) MarshalJSON() ([]byte, error)
type FloatingPointMean ¶
type FloatingPointMean struct { // Count: The number of values being aggregated. Count *SplitInt64 `json:"count,omitempty"` // Sum: The sum of all values being aggregated. Sum float64 `json:"sum,omitempty"` // ForceSendFields is a list of field names (e.g. "Count") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` }
FloatingPointMean: A representation of a floating point mean metric contribution.
func (*FloatingPointMean) MarshalJSON ¶
func (s *FloatingPointMean) MarshalJSON() ([]byte, error)
type GetDebugConfigRequest ¶
type GetDebugConfigRequest struct { // ComponentId: The internal component id for which debug configuration // is // requested. ComponentId string `json:"componentId,omitempty"` // WorkerId: The worker id, i.e., VM hostname. WorkerId string `json:"workerId,omitempty"` // ForceSendFields is a list of field names (e.g. "ComponentId") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` }
GetDebugConfigRequest: Request to get updated debug configuration for component.
func (*GetDebugConfigRequest) MarshalJSON ¶
func (s *GetDebugConfigRequest) MarshalJSON() ([]byte, error)
type GetDebugConfigResponse ¶
type GetDebugConfigResponse struct { // Config: The encoded debug configuration for the requested component. Config string `json:"config,omitempty"` // ServerResponse contains the HTTP response code and headers from the // server. googleapi.ServerResponse `json:"-"` // ForceSendFields is a list of field names (e.g. "Config") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` }
GetDebugConfigResponse: Response to a get debug configuration request.
func (*GetDebugConfigResponse) MarshalJSON ¶
func (s *GetDebugConfigResponse) MarshalJSON() ([]byte, error)
type GetTemplateResponse ¶
type GetTemplateResponse struct { // Metadata: The template metadata describing the template name, // available // parameters, etc. Metadata *TemplateMetadata `json:"metadata,omitempty"` // Status: The status of the get template request. Any problems with // the // request will be indicated in the error_details. Status *Status `json:"status,omitempty"` // ServerResponse contains the HTTP response code and headers from the // server. googleapi.ServerResponse `json:"-"` // ForceSendFields is a list of field names (e.g. "Metadata") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` }
GetTemplateResponse: The response to a GetTemplate request.
func (*GetTemplateResponse) MarshalJSON ¶
func (s *GetTemplateResponse) MarshalJSON() ([]byte, error)
type InstructionInput ¶
type InstructionInput struct { // OutputNum: The output index (origin zero) within the producer. OutputNum int64 `json:"outputNum,omitempty"` // ProducerInstructionIndex: The index (origin zero) of the parallel // instruction that produces // the output to be consumed by this input. This index is relative // to the list of instructions in this input's instruction's // containing MapTask. ProducerInstructionIndex int64 `json:"producerInstructionIndex,omitempty"` // ForceSendFields is a list of field names (e.g. "OutputNum") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` }
InstructionInput: An input of an instruction, as a reference to an output of a producer instruction.
func (*InstructionInput) MarshalJSON ¶
func (s *InstructionInput) MarshalJSON() ([]byte, error)
type InstructionOutput ¶
type InstructionOutput struct { // Codec: The codec to use to encode data being written via this output. Codec InstructionOutputCodec `json:"codec,omitempty"` // Name: The user-provided name of this output. Name string `json:"name,omitempty"` // OnlyCountKeyBytes: For system-generated byte and mean byte metrics, // certain instructions // should only report the key size. OnlyCountKeyBytes bool `json:"onlyCountKeyBytes,omitempty"` // OnlyCountValueBytes: For system-generated byte and mean byte metrics, // certain instructions // should only report the value size. OnlyCountValueBytes bool `json:"onlyCountValueBytes,omitempty"` // OriginalName: System-defined name for this output in the original // workflow graph. // Outputs that do not contribute to an original instruction do not set // this. OriginalName string `json:"originalName,omitempty"` // SystemName: System-defined name of this output. // Unique across the workflow. SystemName string `json:"systemName,omitempty"` // ForceSendFields is a list of field names (e.g. "Codec") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` }
InstructionOutput: An output of an instruction.
func (*InstructionOutput) MarshalJSON ¶
func (s *InstructionOutput) MarshalJSON() ([]byte, error)
type InstructionOutputCodec ¶
type InstructionOutputCodec interface{}
type IntegerList ¶
type IntegerList struct { // Elements: Elements of the list. Elements []*SplitInt64 `json:"elements,omitempty"` // ForceSendFields is a list of field names (e.g. "Elements") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` }
IntegerList: A metric value representing a list of integers.
func (*IntegerList) MarshalJSON ¶
func (s *IntegerList) MarshalJSON() ([]byte, error)
type IntegerMean ¶
type IntegerMean struct { // Count: The number of values being aggregated. Count *SplitInt64 `json:"count,omitempty"` // Sum: The sum of all values being aggregated. Sum *SplitInt64 `json:"sum,omitempty"` // ForceSendFields is a list of field names (e.g. "Count") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` }
IntegerMean: A representation of an integer mean metric contribution.
func (*IntegerMean) MarshalJSON ¶
func (s *IntegerMean) MarshalJSON() ([]byte, error)
type Job ¶
type Job struct { // ClientRequestId: The client's unique identifier of the job, re-used // across retried attempts. // If this field is set, the service will ensure its uniqueness. // The request to create a job will fail if the service has knowledge of // a // previously submitted job with the same client's ID and job name. // The caller may use this field to ensure idempotence of job // creation across retried attempts to create a job. // By default, the field is empty and, in that case, the service ignores // it. ClientRequestId string `json:"clientRequestId,omitempty"` // CreateTime: The timestamp when the job was initially created. // Immutable and set by the // Cloud Dataflow service. CreateTime string `json:"createTime,omitempty"` // CurrentState: The current state of the job. // // Jobs are created in the `JOB_STATE_STOPPED` state unless // otherwise // specified. // // A job in the `JOB_STATE_RUNNING` state may asynchronously enter // a // terminal state. After a job has reached a terminal state, no // further state updates may be made. // // This field may be mutated by the Cloud Dataflow service; // callers cannot mutate it. // // Possible values: // "JOB_STATE_UNKNOWN" - The job's run state isn't specified. // "JOB_STATE_STOPPED" - `JOB_STATE_STOPPED` indicates that the job // has not // yet started to run. // "JOB_STATE_RUNNING" - `JOB_STATE_RUNNING` indicates that the job is // currently running. // "JOB_STATE_DONE" - `JOB_STATE_DONE` indicates that the job has // successfully completed. // This is a terminal job state. This state may be set by the Cloud // Dataflow // service, as a transition from `JOB_STATE_RUNNING`. It may also be set // via a // Cloud Dataflow `UpdateJob` call, if the job has not yet reached a // terminal // state. // "JOB_STATE_FAILED" - `JOB_STATE_FAILED` indicates that the job has // failed. This is a // terminal job state. This state may only be set by the Cloud // Dataflow // service, and only as a transition from `JOB_STATE_RUNNING`. // "JOB_STATE_CANCELLED" - `JOB_STATE_CANCELLED` indicates that the // job has been explicitly // cancelled. This is a terminal job state. This state may only be // set via a Cloud Dataflow `UpdateJob` call, and only if the job has // not // yet reached another terminal state. // "JOB_STATE_UPDATED" - `JOB_STATE_UPDATED` indicates that the job // was successfully updated, // meaning that this job was stopped and another job was started, // inheriting // state from this one. This is a terminal job state. This state may // only be // set by the Cloud Dataflow service, and only as a transition // from // `JOB_STATE_RUNNING`. // "JOB_STATE_DRAINING" - `JOB_STATE_DRAINING` indicates that the job // is in the process of draining. // A draining job has stopped pulling from its input sources and is // processing // any data that remains in-flight. This state may be set via a Cloud // Dataflow // `UpdateJob` call, but only as a transition from `JOB_STATE_RUNNING`. // Jobs // that are draining may only transition to // `JOB_STATE_DRAINED`, // `JOB_STATE_CANCELLED`, or `JOB_STATE_FAILED`. // "JOB_STATE_DRAINED" - `JOB_STATE_DRAINED` indicates that the job // has been drained. // A drained job terminated by stopping pulling from its input sources // and // processing any data that remained in-flight when draining was // requested. // This state is a terminal state, may only be set by the Cloud // Dataflow // service, and only as a transition from `JOB_STATE_DRAINING`. CurrentState string `json:"currentState,omitempty"` // CurrentStateTime: The timestamp associated with the current state. CurrentStateTime string `json:"currentStateTime,omitempty"` // Environment: The environment for the job. Environment *Environment `json:"environment,omitempty"` // ExecutionInfo: Deprecated. ExecutionInfo *JobExecutionInfo `json:"executionInfo,omitempty"` // Id: The unique ID of this job. // // This field is set by the Cloud Dataflow service when the Job // is // created, and is immutable for the life of the job. Id string `json:"id,omitempty"` // Labels: User-defined labels for this job. // // The labels map can contain no more than 64 entries. Entries of the // labels // map are UTF8 strings that comply with the following restrictions: // // * Keys must conform to regexp: \p{Ll}\p{Lo}{0,62} // * Values must conform to regexp: [\p{Ll}\p{Lo}\p{N}_-]{0,63} // * Both keys and values are additionally constrained to be <= 128 // bytes in // size. Labels map[string]string `json:"labels,omitempty"` // Location: The location that contains this job. Location string `json:"location,omitempty"` // Name: The user-specified Cloud Dataflow job name. // // Only one Job with a given name may exist in a project at any // given time. If a caller attempts to create a Job with the same // name as an already-existing Job, the attempt returns the // existing Job. // // The name must match the regular // expression // `[a-z]([-a-z0-9]{0,38}[a-z0-9])?` Name string `json:"name,omitempty"` // PipelineDescription: Preliminary field: The format of this data may // change at any time. // A description of the user pipeline and stages through which it is // executed. // Created by Cloud Dataflow service. Only retrieved // with // JOB_VIEW_DESCRIPTION or JOB_VIEW_ALL. PipelineDescription *PipelineDescription `json:"pipelineDescription,omitempty"` // ProjectId: The ID of the Cloud Platform project that the job belongs // to. ProjectId string `json:"projectId,omitempty"` // ReplaceJobId: If this job is an update of an existing job, this field // is the job ID // of the job it replaced. // // When sending a `CreateJobRequest`, you can update a job by specifying // it // here. The job named here is stopped, and its intermediate state // is // transferred to this job. ReplaceJobId string `json:"replaceJobId,omitempty"` // ReplacedByJobId: If another job is an update of this job (and thus, // this job is in // `JOB_STATE_UPDATED`), this field contains the ID of that job. ReplacedByJobId string `json:"replacedByJobId,omitempty"` // RequestedState: The job's requested state. // // `UpdateJob` may be used to switch between the `JOB_STATE_STOPPED` // and // `JOB_STATE_RUNNING` states, by setting requested_state. `UpdateJob` // may // also be used to directly set a job's requested state // to // `JOB_STATE_CANCELLED` or `JOB_STATE_DONE`, irrevocably terminating // the // job if it has not already reached a terminal state. // // Possible values: // "JOB_STATE_UNKNOWN" - The job's run state isn't specified. // "JOB_STATE_STOPPED" - `JOB_STATE_STOPPED` indicates that the job // has not // yet started to run. // "JOB_STATE_RUNNING" - `JOB_STATE_RUNNING` indicates that the job is // currently running. // "JOB_STATE_DONE" - `JOB_STATE_DONE` indicates that the job has // successfully completed. // This is a terminal job state. This state may be set by the Cloud // Dataflow // service, as a transition from `JOB_STATE_RUNNING`. It may also be set // via a // Cloud Dataflow `UpdateJob` call, if the job has not yet reached a // terminal // state. // "JOB_STATE_FAILED" - `JOB_STATE_FAILED` indicates that the job has // failed. This is a // terminal job state. This state may only be set by the Cloud // Dataflow // service, and only as a transition from `JOB_STATE_RUNNING`. // "JOB_STATE_CANCELLED" - `JOB_STATE_CANCELLED` indicates that the // job has been explicitly // cancelled. This is a terminal job state. This state may only be // set via a Cloud Dataflow `UpdateJob` call, and only if the job has // not // yet reached another terminal state. // "JOB_STATE_UPDATED" - `JOB_STATE_UPDATED` indicates that the job // was successfully updated, // meaning that this job was stopped and another job was started, // inheriting // state from this one. This is a terminal job state. This state may // only be // set by the Cloud Dataflow service, and only as a transition // from // `JOB_STATE_RUNNING`. // "JOB_STATE_DRAINING" - `JOB_STATE_DRAINING` indicates that the job // is in the process of draining. // A draining job has stopped pulling from its input sources and is // processing // any data that remains in-flight. This state may be set via a Cloud // Dataflow // `UpdateJob` call, but only as a transition from `JOB_STATE_RUNNING`. // Jobs // that are draining may only transition to // `JOB_STATE_DRAINED`, // `JOB_STATE_CANCELLED`, or `JOB_STATE_FAILED`. // "JOB_STATE_DRAINED" - `JOB_STATE_DRAINED` indicates that the job // has been drained. // A drained job terminated by stopping pulling from its input sources // and // processing any data that remained in-flight when draining was // requested. // This state is a terminal state, may only be set by the Cloud // Dataflow // service, and only as a transition from `JOB_STATE_DRAINING`. RequestedState string `json:"requestedState,omitempty"` // Steps: The top-level steps that constitute the entire job. Steps []*Step `json:"steps,omitempty"` // TempFiles: A set of files the system should be aware of that are // used // for temporary storage. These temporary files will be // removed on job completion. // No duplicates are allowed. // No file patterns are supported. // // The supported files are: // // Google Cloud Storage: // // storage.googleapis.com/{bucket}/{object} // bucket.storage.googleapis.com/{object} TempFiles []string `json:"tempFiles,omitempty"` // TransformNameMapping: The map of transform name prefixes of the job // to be replaced to the // corresponding name prefixes of the new job. TransformNameMapping map[string]string `json:"transformNameMapping,omitempty"` // Type: The type of Cloud Dataflow job. // // Possible values: // "JOB_TYPE_UNKNOWN" - The type of the job is unspecified, or // unknown. // "JOB_TYPE_BATCH" - A batch job with a well-defined end point: data // is read, data is // processed, data is written, and the job is done. // "JOB_TYPE_STREAMING" - A continuously streaming job with no end: // data is read, // processed, and written continuously. Type string `json:"type,omitempty"` // ServerResponse contains the HTTP response code and headers from the // server. googleapi.ServerResponse `json:"-"` // ForceSendFields is a list of field names (e.g. "ClientRequestId") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` }
Job: Defines a job to be run by the Cloud Dataflow service.
func (*Job) MarshalJSON ¶
type JobExecutionInfo ¶
type JobExecutionInfo struct { // Stages: A mapping from each stage to the information about that // stage. Stages map[string]JobExecutionStageInfo `json:"stages,omitempty"` // ForceSendFields is a list of field names (e.g. "Stages") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` }
JobExecutionInfo: Additional information about how a Cloud Dataflow job will be executed that isn't contained in the submitted job.
func (*JobExecutionInfo) MarshalJSON ¶
func (s *JobExecutionInfo) MarshalJSON() ([]byte, error)
type JobExecutionStageInfo ¶
type JobExecutionStageInfo struct { // StepName: The steps associated with the execution stage. // Note that stages may have several steps, and that a given step // might be run by more than one stage. StepName []string `json:"stepName,omitempty"` // ForceSendFields is a list of field names (e.g. "StepName") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` }
JobExecutionStageInfo: Contains information about how a particular google.dataflow.v1beta3.Step will be executed.
func (*JobExecutionStageInfo) MarshalJSON ¶
func (s *JobExecutionStageInfo) MarshalJSON() ([]byte, error)
type JobMessage ¶
type JobMessage struct { // Id: Identifies the message. This is automatically generated by // the // service; the caller should treat it as an opaque string. Id string `json:"id,omitempty"` // MessageImportance: Importance level of the message. // // Possible values: // "JOB_MESSAGE_IMPORTANCE_UNKNOWN" - The message importance isn't // specified, or is unknown. // "JOB_MESSAGE_DEBUG" - The message is at the 'debug' level: // typically only useful for // software engineers working on the code the job is running. // Typically, Dataflow pipeline runners do not display log messages // at this level by default. // "JOB_MESSAGE_DETAILED" - The message is at the 'detailed' level: // somewhat verbose, but // potentially useful to users. Typically, Dataflow pipeline // runners do not display log messages at this level by default. // These messages are displayed by default in the Dataflow // monitoring UI. // "JOB_MESSAGE_BASIC" - The message is at the 'basic' level: useful // for keeping // track of the execution of a Dataflow pipeline. Typically, // Dataflow pipeline runners display log messages at this level // by // default, and these messages are displayed by default in the // Dataflow monitoring UI. // "JOB_MESSAGE_WARNING" - The message is at the 'warning' level: // indicating a condition // pertaining to a job which may require human intervention. // Typically, Dataflow pipeline runners display log messages at // this // level by default, and these messages are displayed by default in // the Dataflow monitoring UI. // "JOB_MESSAGE_ERROR" - The message is at the 'error' level: // indicating a condition // preventing a job from succeeding. Typically, Dataflow // pipeline // runners display log messages at this level by default, and // these // messages are displayed by default in the Dataflow monitoring UI. MessageImportance string `json:"messageImportance,omitempty"` // MessageText: The text of the message. MessageText string `json:"messageText,omitempty"` // Time: The timestamp of the message. Time string `json:"time,omitempty"` // ForceSendFields is a list of field names (e.g. "Id") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` }
JobMessage: A particular message pertaining to a Dataflow job.
func (*JobMessage) MarshalJSON ¶
func (s *JobMessage) MarshalJSON() ([]byte, error)
type JobMetrics ¶
type JobMetrics struct { // MetricTime: Timestamp as of which metric values are current. MetricTime string `json:"metricTime,omitempty"` // Metrics: All metrics for this job. Metrics []*MetricUpdate `json:"metrics,omitempty"` // ServerResponse contains the HTTP response code and headers from the // server. googleapi.ServerResponse `json:"-"` // ForceSendFields is a list of field names (e.g. "MetricTime") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` }
JobMetrics: JobMetrics contains a collection of metrics descibing the detailed progress of a Dataflow job. Metrics correspond to user-defined and system-defined metrics in the job.
This resource captures only the most recent values of each metric; time-series data can be queried for them (under the same metric names) from Cloud Monitoring.
func (*JobMetrics) MarshalJSON ¶
func (s *JobMetrics) MarshalJSON() ([]byte, error)
type KeyRangeDataDiskAssignment ¶
type KeyRangeDataDiskAssignment struct { // DataDisk: The name of the data disk where data for this range is // stored. // This name is local to the Google Cloud Platform project and // uniquely // identifies the disk within that project, for // example // "myproject-1014-104817-4c2-harness-0-disk-1". DataDisk string `json:"dataDisk,omitempty"` // End: The end (exclusive) of the key range. End string `json:"end,omitempty"` // Start: The start (inclusive) of the key range. Start string `json:"start,omitempty"` // ForceSendFields is a list of field names (e.g. "DataDisk") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` }
KeyRangeDataDiskAssignment: Data disk assignment information for a specific key-range of a sharded computation. Currently we only support UTF-8 character splits to simplify encoding into JSON.
func (*KeyRangeDataDiskAssignment) MarshalJSON ¶
func (s *KeyRangeDataDiskAssignment) MarshalJSON() ([]byte, error)
type KeyRangeLocation ¶
type KeyRangeLocation struct { // DataDisk: The name of the data disk where data for this range is // stored. // This name is local to the Google Cloud Platform project and // uniquely // identifies the disk within that project, for // example // "myproject-1014-104817-4c2-harness-0-disk-1". DataDisk string `json:"dataDisk,omitempty"` // DeliveryEndpoint: The physical location of this range assignment to // be used for // streaming computation cross-worker message delivery. DeliveryEndpoint string `json:"deliveryEndpoint,omitempty"` // End: The end (exclusive) of the key range. End string `json:"end,omitempty"` // PersistentDirectory: The location of the persistent state for this // range, as a // persistent directory in the worker local filesystem. PersistentDirectory string `json:"persistentDirectory,omitempty"` // Start: The start (inclusive) of the key range. Start string `json:"start,omitempty"` // ForceSendFields is a list of field names (e.g. "DataDisk") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` }
KeyRangeLocation: Location information for a specific key-range of a sharded computation. Currently we only support UTF-8 character splits to simplify encoding into JSON.
func (*KeyRangeLocation) MarshalJSON ¶
func (s *KeyRangeLocation) MarshalJSON() ([]byte, error)
type LaunchTemplateParameters ¶
type LaunchTemplateParameters struct { // Environment: The runtime environment for the job. Environment *RuntimeEnvironment `json:"environment,omitempty"` // JobName: Required. The job name to use for the created job. JobName string `json:"jobName,omitempty"` // Parameters: The runtime parameters to pass to the job. Parameters map[string]string `json:"parameters,omitempty"` // ForceSendFields is a list of field names (e.g. "Environment") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` }
LaunchTemplateParameters: Parameters to provide to the template being launched.
func (*LaunchTemplateParameters) MarshalJSON ¶
func (s *LaunchTemplateParameters) MarshalJSON() ([]byte, error)
type LaunchTemplateResponse ¶
type LaunchTemplateResponse struct { // Job: The job that was launched, if the request was not a dry run // and // the job was successfully launched. Job *Job `json:"job,omitempty"` // Status: The status of the launch template request. Any problems with // the request // will be indicated in the error_details. Status *Status `json:"status,omitempty"` // ServerResponse contains the HTTP response code and headers from the // server. googleapi.ServerResponse `json:"-"` // ForceSendFields is a list of field names (e.g. "Job") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` }
LaunchTemplateResponse: Response to the request to launch a template.
func (*LaunchTemplateResponse) MarshalJSON ¶
func (s *LaunchTemplateResponse) MarshalJSON() ([]byte, error)
type LeaseWorkItemRequest ¶
type LeaseWorkItemRequest struct { // CurrentWorkerTime: The current timestamp at the worker. CurrentWorkerTime string `json:"currentWorkerTime,omitempty"` // Location: The location which contains the WorkItem's job. Location string `json:"location,omitempty"` // RequestedLeaseDuration: The initial lease period. RequestedLeaseDuration string `json:"requestedLeaseDuration,omitempty"` // WorkItemTypes: Filter for WorkItem type. WorkItemTypes []string `json:"workItemTypes,omitempty"` // WorkerCapabilities: Worker capabilities. WorkItems might be limited // to workers with specific // capabilities. WorkerCapabilities []string `json:"workerCapabilities,omitempty"` // WorkerId: Identifies the worker leasing work -- typically the ID of // the // virtual machine running the worker. WorkerId string `json:"workerId,omitempty"` // ForceSendFields is a list of field names (e.g. "CurrentWorkerTime") // to unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` }
LeaseWorkItemRequest: Request to lease WorkItems.
func (*LeaseWorkItemRequest) MarshalJSON ¶
func (s *LeaseWorkItemRequest) MarshalJSON() ([]byte, error)
type LeaseWorkItemResponse ¶
type LeaseWorkItemResponse struct { // WorkItems: A list of the leased WorkItems. WorkItems []*WorkItem `json:"workItems,omitempty"` // ServerResponse contains the HTTP response code and headers from the // server. googleapi.ServerResponse `json:"-"` // ForceSendFields is a list of field names (e.g. "WorkItems") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` }
LeaseWorkItemResponse: Response to a request to lease WorkItems.
func (*LeaseWorkItemResponse) MarshalJSON ¶
func (s *LeaseWorkItemResponse) MarshalJSON() ([]byte, error)
type ListJobMessagesResponse ¶
type ListJobMessagesResponse struct { // JobMessages: Messages in ascending timestamp order. JobMessages []*JobMessage `json:"jobMessages,omitempty"` // NextPageToken: The token to obtain the next page of results if there // are more. NextPageToken string `json:"nextPageToken,omitempty"` // ServerResponse contains the HTTP response code and headers from the // server. googleapi.ServerResponse `json:"-"` // ForceSendFields is a list of field names (e.g. "JobMessages") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` }
ListJobMessagesResponse: Response to a request to list job messages.
func (*ListJobMessagesResponse) MarshalJSON ¶
func (s *ListJobMessagesResponse) MarshalJSON() ([]byte, error)
type ListJobsResponse ¶
type ListJobsResponse struct { // FailedLocation: Zero or more messages describing locations that // failed to respond. FailedLocation []*FailedLocation `json:"failedLocation,omitempty"` // Jobs: A subset of the requested job information. Jobs []*Job `json:"jobs,omitempty"` // NextPageToken: Set if there may be more results than fit in this // response. NextPageToken string `json:"nextPageToken,omitempty"` // ServerResponse contains the HTTP response code and headers from the // server. googleapi.ServerResponse `json:"-"` // ForceSendFields is a list of field names (e.g. "FailedLocation") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` }
ListJobsResponse: Response to a request to list Cloud Dataflow jobs. This may be a partial response, depending on the page size in the ListJobsRequest.
func (*ListJobsResponse) MarshalJSON ¶
func (s *ListJobsResponse) MarshalJSON() ([]byte, error)
type MapTask ¶
type MapTask struct { // Instructions: The instructions in the MapTask. Instructions []*ParallelInstruction `json:"instructions,omitempty"` // StageName: System-defined name of the stage containing this // MapTask. // Unique across the workflow. StageName string `json:"stageName,omitempty"` // SystemName: System-defined name of this MapTask. // Unique across the workflow. SystemName string `json:"systemName,omitempty"` // ForceSendFields is a list of field names (e.g. "Instructions") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` }
MapTask: MapTask consists of an ordered set of instructions, each of which describes one particular low-level operation for the worker to perform in order to accomplish the MapTask's WorkItem.
Each instruction must appear in the list before any instructions which depends on its output.
func (*MapTask) MarshalJSON ¶
type MetricShortId ¶
type MetricShortId struct { // MetricIndex: The index of the corresponding metric in // the ReportWorkItemStatusRequest. Required. MetricIndex int64 `json:"metricIndex,omitempty"` // ShortId: The service-generated short identifier for the metric. ShortId int64 `json:"shortId,omitempty,string"` // ForceSendFields is a list of field names (e.g. "MetricIndex") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` }
MetricShortId: The metric short id is returned to the user alongside an offset into ReportWorkItemStatusRequest
func (*MetricShortId) MarshalJSON ¶
func (s *MetricShortId) MarshalJSON() ([]byte, error)
type MetricStructuredName ¶
type MetricStructuredName struct { // Context: Zero or more labeled fields which identify the part of the // job this // metric is associated with, such as the name of a step or // collection. // // For example, built-in counters associated with steps will // have // context['step'] = <step-name>. Counters associated with // PCollections // in the SDK will have context['pcollection'] = <pcollection-name>. Context map[string]string `json:"context,omitempty"` // Name: Worker-defined metric name. Name string `json:"name,omitempty"` // Origin: Origin (namespace) of metric name. May be blank for // user-define metrics; // will be "dataflow" for metrics defined by the Dataflow service or // SDK. Origin string `json:"origin,omitempty"` // ForceSendFields is a list of field names (e.g. "Context") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` }
MetricStructuredName: Identifies a metric, by describing the source which generated the metric.
func (*MetricStructuredName) MarshalJSON ¶
func (s *MetricStructuredName) MarshalJSON() ([]byte, error)
type MetricUpdate ¶
type MetricUpdate struct { // Cumulative: True if this metric is reported as the total cumulative // aggregate // value accumulated since the worker started working on this // WorkItem. // By default this is false, indicating that this metric is reported // as a delta that is not associated with any WorkItem. Cumulative bool `json:"cumulative,omitempty"` // Internal: Worker-computed aggregate value for internal use by the // Dataflow // service. Internal interface{} `json:"internal,omitempty"` // Kind: Metric aggregation kind. The possible metric aggregation kinds // are // "Sum", "Max", "Min", "Mean", "Set", "And", and "Or". // The specified aggregation kind is case-insensitive. // // If omitted, this is not an aggregated value but instead // a single metric sample value. Kind string `json:"kind,omitempty"` // MeanCount: Worker-computed aggregate value for the "Mean" aggregation // kind. // This holds the count of the aggregated values and is used in // combination // with mean_sum above to obtain the actual mean aggregate value. // The only possible value type is Long. MeanCount interface{} `json:"meanCount,omitempty"` // MeanSum: Worker-computed aggregate value for the "Mean" aggregation // kind. // This holds the sum of the aggregated values and is used in // combination // with mean_count below to obtain the actual mean aggregate value. // The only possible value types are Long and Double. MeanSum interface{} `json:"meanSum,omitempty"` // Name: Name of the metric. Name *MetricStructuredName `json:"name,omitempty"` // Scalar: Worker-computed aggregate value for aggregation kinds "Sum", // "Max", "Min", // "And", and "Or". The possible value types are Long, Double, and // Boolean. Scalar interface{} `json:"scalar,omitempty"` // Set: Worker-computed aggregate value for the "Set" aggregation kind. // The only // possible value type is a list of Values whose type can be Long, // Double, // or String, according to the metric's type. All Values in the list // must // be of the same type. Set interface{} `json:"set,omitempty"` // UpdateTime: Timestamp associated with the metric value. Optional when // workers are // reporting work progress; it will be filled in responses from // the // metrics API. UpdateTime string `json:"updateTime,omitempty"` // ForceSendFields is a list of field names (e.g. "Cumulative") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` }
MetricUpdate: Describes the state of a metric.
func (*MetricUpdate) MarshalJSON ¶
func (s *MetricUpdate) MarshalJSON() ([]byte, error)
type MountedDataDisk ¶
type MountedDataDisk struct { // DataDisk: The name of the data disk. // This name is local to the Google Cloud Platform project and // uniquely // identifies the disk within that project, for // example // "myproject-1014-104817-4c2-harness-0-disk-1". DataDisk string `json:"dataDisk,omitempty"` // ForceSendFields is a list of field names (e.g. "DataDisk") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` }
MountedDataDisk: Describes mounted data disk.
func (*MountedDataDisk) MarshalJSON ¶
func (s *MountedDataDisk) MarshalJSON() ([]byte, error)
type MultiOutputInfo ¶
type MultiOutputInfo struct { // Tag: The id of the tag the user code will emit to this output by; // this // should correspond to the tag of some SideInputInfo. Tag string `json:"tag,omitempty"` // ForceSendFields is a list of field names (e.g. "Tag") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` }
MultiOutputInfo: Information about an output of a multi-output DoFn.
func (*MultiOutputInfo) MarshalJSON ¶
func (s *MultiOutputInfo) MarshalJSON() ([]byte, error)
type NameAndKind ¶
type NameAndKind struct { // Kind: Counter aggregation kind. // // Possible values: // "INVALID" - Counter aggregation kind was not set. // "SUM" - Aggregated value is the sum of all contributed values. // "MAX" - Aggregated value is the max of all contributed values. // "MIN" - Aggregated value is the min of all contributed values. // "MEAN" - Aggregated value is the mean of all contributed values. // "OR" - Aggregated value represents the logical 'or' of all // contributed values. // "AND" - Aggregated value represents the logical 'and' of all // contributed values. // "SET" - Aggregated value is a set of unique contributed values. // "DISTRIBUTION" - Aggregated value captures statistics about a // distribution. Kind string `json:"kind,omitempty"` // Name: Name of the counter. Name string `json:"name,omitempty"` // ForceSendFields is a list of field names (e.g. "Kind") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` }
NameAndKind: Basic metadata about a counter.
func (*NameAndKind) MarshalJSON ¶
func (s *NameAndKind) MarshalJSON() ([]byte, error)
type Package ¶
type Package struct { // Location: The resource to read the package from. The supported // resource type is: // // Google Cloud Storage: // // storage.googleapis.com/{bucket} // bucket.storage.googleapis.com/ Location string `json:"location,omitempty"` // Name: The name of the package. Name string `json:"name,omitempty"` // ForceSendFields is a list of field names (e.g. "Location") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` }
Package: The packages that must be installed in order for a worker to run the steps of the Cloud Dataflow job that will be assigned to its worker pool.
This is the mechanism by which the Cloud Dataflow SDK causes code to be loaded onto the workers. For example, the Cloud Dataflow Java SDK might use this to install jars containing the user's code and all of the various dependencies (libraries, data files, etc.) required in order for that code to run.
func (*Package) MarshalJSON ¶
type ParDoInstruction ¶
type ParDoInstruction struct { // Input: The input. Input *InstructionInput `json:"input,omitempty"` // MultiOutputInfos: Information about each of the outputs, if user_fn // is a MultiDoFn. MultiOutputInfos []*MultiOutputInfo `json:"multiOutputInfos,omitempty"` // NumOutputs: The number of outputs. NumOutputs int64 `json:"numOutputs,omitempty"` // SideInputs: Zero or more side inputs. SideInputs []*SideInputInfo `json:"sideInputs,omitempty"` // UserFn: The user function to invoke. UserFn ParDoInstructionUserFn `json:"userFn,omitempty"` // ForceSendFields is a list of field names (e.g. "Input") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` }
ParDoInstruction: An instruction that does a ParDo operation. Takes one main input and zero or more side inputs, and produces zero or more outputs. Runs user code.
func (*ParDoInstruction) MarshalJSON ¶
func (s *ParDoInstruction) MarshalJSON() ([]byte, error)
type ParDoInstructionUserFn ¶
type ParDoInstructionUserFn interface{}
type ParallelInstruction ¶
type ParallelInstruction struct { // Flatten: Additional information for Flatten instructions. Flatten *FlattenInstruction `json:"flatten,omitempty"` // Name: User-provided name of this operation. Name string `json:"name,omitempty"` // OriginalName: System-defined name for the operation in the original // workflow graph. OriginalName string `json:"originalName,omitempty"` // Outputs: Describes the outputs of the instruction. Outputs []*InstructionOutput `json:"outputs,omitempty"` // ParDo: Additional information for ParDo instructions. ParDo *ParDoInstruction `json:"parDo,omitempty"` // PartialGroupByKey: Additional information for PartialGroupByKey // instructions. PartialGroupByKey *PartialGroupByKeyInstruction `json:"partialGroupByKey,omitempty"` // Read: Additional information for Read instructions. Read *ReadInstruction `json:"read,omitempty"` // SystemName: System-defined name of this operation. // Unique across the workflow. SystemName string `json:"systemName,omitempty"` // Write: Additional information for Write instructions. Write *WriteInstruction `json:"write,omitempty"` // ForceSendFields is a list of field names (e.g. "Flatten") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` }
ParallelInstruction: Describes a particular operation comprising a MapTask.
func (*ParallelInstruction) MarshalJSON ¶
func (s *ParallelInstruction) MarshalJSON() ([]byte, error)
type ParameterMetadata ¶
type ParameterMetadata struct { // HelpText: Required. The help text to display for the parameter. HelpText string `json:"helpText,omitempty"` // IsOptional: Optional. Whether the parameter is optional. Defaults to // false. IsOptional bool `json:"isOptional,omitempty"` // Label: Required. The label to display for the parameter. Label string `json:"label,omitempty"` // Name: Required. The name of the parameter. Name string `json:"name,omitempty"` // Regexes: Optional. Regexes that the parameter must match. Regexes []string `json:"regexes,omitempty"` // ForceSendFields is a list of field names (e.g. "HelpText") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` }
ParameterMetadata: Metadata for a specific parameter.
func (*ParameterMetadata) MarshalJSON ¶
func (s *ParameterMetadata) MarshalJSON() ([]byte, error)
type PartialGroupByKeyInstruction ¶
type PartialGroupByKeyInstruction struct { // Input: Describes the input to the partial group-by-key instruction. Input *InstructionInput `json:"input,omitempty"` // InputElementCodec: The codec to use for interpreting an element in // the input PTable. InputElementCodec PartialGroupByKeyInstructionInputElementCodec `json:"inputElementCodec,omitempty"` // OriginalCombineValuesInputStoreName: If this instruction includes a // combining function this is the name of the // intermediate store between the GBK and the CombineValues. OriginalCombineValuesInputStoreName string `json:"originalCombineValuesInputStoreName,omitempty"` // OriginalCombineValuesStepName: If this instruction includes a // combining function, this is the name of the // CombineValues instruction lifted into this instruction. OriginalCombineValuesStepName string `json:"originalCombineValuesStepName,omitempty"` // SideInputs: Zero or more side inputs. SideInputs []*SideInputInfo `json:"sideInputs,omitempty"` // ValueCombiningFn: The value combining function to invoke. ValueCombiningFn PartialGroupByKeyInstructionValueCombiningFn `json:"valueCombiningFn,omitempty"` // ForceSendFields is a list of field names (e.g. "Input") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` }
PartialGroupByKeyInstruction: An instruction that does a partial group-by-key. One input and one output.
func (*PartialGroupByKeyInstruction) MarshalJSON ¶
func (s *PartialGroupByKeyInstruction) MarshalJSON() ([]byte, error)
type PartialGroupByKeyInstructionInputElementCodec ¶
type PartialGroupByKeyInstructionInputElementCodec interface{}
type PartialGroupByKeyInstructionValueCombiningFn ¶
type PartialGroupByKeyInstructionValueCombiningFn interface{}
type PipelineDescription ¶
type PipelineDescription struct { // DisplayData: Pipeline level display data. DisplayData []*DisplayData `json:"displayData,omitempty"` // ExecutionPipelineStage: Description of each stage of execution of the // pipeline. ExecutionPipelineStage []*ExecutionStageSummary `json:"executionPipelineStage,omitempty"` // OriginalPipelineTransform: Description of each transform in the // pipeline and collections between them. OriginalPipelineTransform []*TransformSummary `json:"originalPipelineTransform,omitempty"` // ForceSendFields is a list of field names (e.g. "DisplayData") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` }
PipelineDescription: A descriptive representation of submitted pipeline as well as the executed form. This data is provided by the Dataflow service for ease of visualizing the pipeline and interpretting Dataflow provided metrics.
func (*PipelineDescription) MarshalJSON ¶
func (s *PipelineDescription) MarshalJSON() ([]byte, error)
type Position ¶
type Position struct { // ByteOffset: Position is a byte offset. ByteOffset int64 `json:"byteOffset,omitempty,string"` // ConcatPosition: CloudPosition is a concat position. ConcatPosition *ConcatPosition `json:"concatPosition,omitempty"` // End: Position is past all other positions. Also useful for the // end // position of an unbounded range. End bool `json:"end,omitempty"` // Key: Position is a string key, ordered lexicographically. Key string `json:"key,omitempty"` // RecordIndex: Position is a record index. RecordIndex int64 `json:"recordIndex,omitempty,string"` // ShufflePosition: CloudPosition is a base64 encoded // BatchShufflePosition (with FIXED // sharding). ShufflePosition string `json:"shufflePosition,omitempty"` // ForceSendFields is a list of field names (e.g. "ByteOffset") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` }
Position: Position defines a position within a collection of data. The value can be either the end position, a key (used with ordered collections), a byte offset, or a record index.
func (*Position) MarshalJSON ¶
type ProjectsJobsCreateCall ¶
type ProjectsJobsCreateCall struct {
// contains filtered or unexported fields
}
func (*ProjectsJobsCreateCall) Context ¶
func (c *ProjectsJobsCreateCall) Context(ctx context.Context) *ProjectsJobsCreateCall
Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.
func (*ProjectsJobsCreateCall) Do ¶
func (c *ProjectsJobsCreateCall) Do(opts ...googleapi.CallOption) (*Job, error)
Do executes the "dataflow.projects.jobs.create" call. Exactly one of *Job or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Job.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (*ProjectsJobsCreateCall) Fields ¶
func (c *ProjectsJobsCreateCall) Fields(s ...googleapi.Field) *ProjectsJobsCreateCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
func (*ProjectsJobsCreateCall) Location ¶
func (c *ProjectsJobsCreateCall) Location(location string) *ProjectsJobsCreateCall
Location sets the optional parameter "location": The location that contains this job.
func (*ProjectsJobsCreateCall) ReplaceJobId ¶
func (c *ProjectsJobsCreateCall) ReplaceJobId(replaceJobId string) *ProjectsJobsCreateCall
ReplaceJobId sets the optional parameter "replaceJobId": Deprecated. This field is now in the Job message.
func (*ProjectsJobsCreateCall) View ¶
func (c *ProjectsJobsCreateCall) View(view string) *ProjectsJobsCreateCall
View sets the optional parameter "view": The level of information requested in response.
Possible values:
"JOB_VIEW_UNKNOWN" "JOB_VIEW_SUMMARY" "JOB_VIEW_ALL" "JOB_VIEW_DESCRIPTION"
type ProjectsJobsDebugGetConfigCall ¶
type ProjectsJobsDebugGetConfigCall struct {
// contains filtered or unexported fields
}
func (*ProjectsJobsDebugGetConfigCall) Context ¶
func (c *ProjectsJobsDebugGetConfigCall) Context(ctx context.Context) *ProjectsJobsDebugGetConfigCall
Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.
func (*ProjectsJobsDebugGetConfigCall) Do ¶
func (c *ProjectsJobsDebugGetConfigCall) Do(opts ...googleapi.CallOption) (*GetDebugConfigResponse, error)
Do executes the "dataflow.projects.jobs.debug.getConfig" call. Exactly one of *GetDebugConfigResponse or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *GetDebugConfigResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (*ProjectsJobsDebugGetConfigCall) Fields ¶
func (c *ProjectsJobsDebugGetConfigCall) Fields(s ...googleapi.Field) *ProjectsJobsDebugGetConfigCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
type ProjectsJobsDebugSendCaptureCall ¶
type ProjectsJobsDebugSendCaptureCall struct {
// contains filtered or unexported fields
}
func (*ProjectsJobsDebugSendCaptureCall) Context ¶
func (c *ProjectsJobsDebugSendCaptureCall) Context(ctx context.Context) *ProjectsJobsDebugSendCaptureCall
Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.
func (*ProjectsJobsDebugSendCaptureCall) Do ¶
func (c *ProjectsJobsDebugSendCaptureCall) Do(opts ...googleapi.CallOption) (*SendDebugCaptureResponse, error)
Do executes the "dataflow.projects.jobs.debug.sendCapture" call. Exactly one of *SendDebugCaptureResponse or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *SendDebugCaptureResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (*ProjectsJobsDebugSendCaptureCall) Fields ¶
func (c *ProjectsJobsDebugSendCaptureCall) Fields(s ...googleapi.Field) *ProjectsJobsDebugSendCaptureCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
type ProjectsJobsDebugService ¶
type ProjectsJobsDebugService struct {
// contains filtered or unexported fields
}
func NewProjectsJobsDebugService ¶
func NewProjectsJobsDebugService(s *Service) *ProjectsJobsDebugService
func (*ProjectsJobsDebugService) GetConfig ¶
func (r *ProjectsJobsDebugService) GetConfig(projectId string, jobId string, getdebugconfigrequest *GetDebugConfigRequest) *ProjectsJobsDebugGetConfigCall
GetConfig: Get encoded debug configuration for component. Not cacheable.
func (*ProjectsJobsDebugService) SendCapture ¶
func (r *ProjectsJobsDebugService) SendCapture(projectId string, jobId string, senddebugcapturerequest *SendDebugCaptureRequest) *ProjectsJobsDebugSendCaptureCall
SendCapture: Send encoded debug capture data for component.
type ProjectsJobsGetCall ¶
type ProjectsJobsGetCall struct {
// contains filtered or unexported fields
}
func (*ProjectsJobsGetCall) Context ¶
func (c *ProjectsJobsGetCall) Context(ctx context.Context) *ProjectsJobsGetCall
Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.
func (*ProjectsJobsGetCall) Do ¶
func (c *ProjectsJobsGetCall) Do(opts ...googleapi.CallOption) (*Job, error)
Do executes the "dataflow.projects.jobs.get" call. Exactly one of *Job or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Job.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (*ProjectsJobsGetCall) Fields ¶
func (c *ProjectsJobsGetCall) Fields(s ...googleapi.Field) *ProjectsJobsGetCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
func (*ProjectsJobsGetCall) IfNoneMatch ¶
func (c *ProjectsJobsGetCall) IfNoneMatch(entityTag string) *ProjectsJobsGetCall
IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.
func (*ProjectsJobsGetCall) Location ¶
func (c *ProjectsJobsGetCall) Location(location string) *ProjectsJobsGetCall
Location sets the optional parameter "location": The location that contains this job.
func (*ProjectsJobsGetCall) View ¶
func (c *ProjectsJobsGetCall) View(view string) *ProjectsJobsGetCall
View sets the optional parameter "view": The level of information requested in response.
Possible values:
"JOB_VIEW_UNKNOWN" "JOB_VIEW_SUMMARY" "JOB_VIEW_ALL" "JOB_VIEW_DESCRIPTION"
type ProjectsJobsGetMetricsCall ¶
type ProjectsJobsGetMetricsCall struct {
// contains filtered or unexported fields
}
func (*ProjectsJobsGetMetricsCall) Context ¶
func (c *ProjectsJobsGetMetricsCall) Context(ctx context.Context) *ProjectsJobsGetMetricsCall
Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.
func (*ProjectsJobsGetMetricsCall) Do ¶
func (c *ProjectsJobsGetMetricsCall) Do(opts ...googleapi.CallOption) (*JobMetrics, error)
Do executes the "dataflow.projects.jobs.getMetrics" call. Exactly one of *JobMetrics or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *JobMetrics.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (*ProjectsJobsGetMetricsCall) Fields ¶
func (c *ProjectsJobsGetMetricsCall) Fields(s ...googleapi.Field) *ProjectsJobsGetMetricsCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
func (*ProjectsJobsGetMetricsCall) IfNoneMatch ¶
func (c *ProjectsJobsGetMetricsCall) IfNoneMatch(entityTag string) *ProjectsJobsGetMetricsCall
IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.
func (*ProjectsJobsGetMetricsCall) Location ¶
func (c *ProjectsJobsGetMetricsCall) Location(location string) *ProjectsJobsGetMetricsCall
Location sets the optional parameter "location": The location which contains the job specified by job_id.
func (*ProjectsJobsGetMetricsCall) StartTime ¶
func (c *ProjectsJobsGetMetricsCall) StartTime(startTime string) *ProjectsJobsGetMetricsCall
StartTime sets the optional parameter "startTime": Return only metric data that has changed since this time. Default is to return all information about all metrics for the job.
type ProjectsJobsListCall ¶
type ProjectsJobsListCall struct {
// contains filtered or unexported fields
}
func (*ProjectsJobsListCall) Context ¶
func (c *ProjectsJobsListCall) Context(ctx context.Context) *ProjectsJobsListCall
Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.
func (*ProjectsJobsListCall) Do ¶
func (c *ProjectsJobsListCall) Do(opts ...googleapi.CallOption) (*ListJobsResponse, error)
Do executes the "dataflow.projects.jobs.list" call. Exactly one of *ListJobsResponse or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *ListJobsResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (*ProjectsJobsListCall) Fields ¶
func (c *ProjectsJobsListCall) Fields(s ...googleapi.Field) *ProjectsJobsListCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
func (*ProjectsJobsListCall) Filter ¶
func (c *ProjectsJobsListCall) Filter(filter string) *ProjectsJobsListCall
Filter sets the optional parameter "filter": The kind of filter to use.
Possible values:
"UNKNOWN" "ALL" "TERMINATED" "ACTIVE"
func (*ProjectsJobsListCall) IfNoneMatch ¶
func (c *ProjectsJobsListCall) IfNoneMatch(entityTag string) *ProjectsJobsListCall
IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.
func (*ProjectsJobsListCall) Location ¶
func (c *ProjectsJobsListCall) Location(location string) *ProjectsJobsListCall
Location sets the optional parameter "location": The location that contains this job.
func (*ProjectsJobsListCall) PageSize ¶
func (c *ProjectsJobsListCall) PageSize(pageSize int64) *ProjectsJobsListCall
PageSize sets the optional parameter "pageSize": If there are many jobs, limit response to at most this many. The actual number of jobs returned will be the lesser of max_responses and an unspecified server-defined limit.
func (*ProjectsJobsListCall) PageToken ¶
func (c *ProjectsJobsListCall) PageToken(pageToken string) *ProjectsJobsListCall
PageToken sets the optional parameter "pageToken": Set this to the 'next_page_token' field of a previous response to request additional results in a long list.
func (*ProjectsJobsListCall) Pages ¶
func (c *ProjectsJobsListCall) Pages(ctx context.Context, f func(*ListJobsResponse) error) error
Pages invokes f for each page of results. A non-nil error returned from f will halt the iteration. The provided context supersedes any context provided to the Context method.
func (*ProjectsJobsListCall) View ¶
func (c *ProjectsJobsListCall) View(view string) *ProjectsJobsListCall
View sets the optional parameter "view": Level of information requested in response. Default is `JOB_VIEW_SUMMARY`.
Possible values:
"JOB_VIEW_UNKNOWN" "JOB_VIEW_SUMMARY" "JOB_VIEW_ALL" "JOB_VIEW_DESCRIPTION"
type ProjectsJobsMessagesListCall ¶
type ProjectsJobsMessagesListCall struct {
// contains filtered or unexported fields
}
func (*ProjectsJobsMessagesListCall) Context ¶
func (c *ProjectsJobsMessagesListCall) Context(ctx context.Context) *ProjectsJobsMessagesListCall
Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.
func (*ProjectsJobsMessagesListCall) Do ¶
func (c *ProjectsJobsMessagesListCall) Do(opts ...googleapi.CallOption) (*ListJobMessagesResponse, error)
Do executes the "dataflow.projects.jobs.messages.list" call. Exactly one of *ListJobMessagesResponse or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *ListJobMessagesResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (*ProjectsJobsMessagesListCall) EndTime ¶
func (c *ProjectsJobsMessagesListCall) EndTime(endTime string) *ProjectsJobsMessagesListCall
EndTime sets the optional parameter "endTime": Return only messages with timestamps < end_time. The default is now (i.e. return up to the latest messages available).
func (*ProjectsJobsMessagesListCall) Fields ¶
func (c *ProjectsJobsMessagesListCall) Fields(s ...googleapi.Field) *ProjectsJobsMessagesListCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
func (*ProjectsJobsMessagesListCall) IfNoneMatch ¶
func (c *ProjectsJobsMessagesListCall) IfNoneMatch(entityTag string) *ProjectsJobsMessagesListCall
IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.
func (*ProjectsJobsMessagesListCall) Location ¶
func (c *ProjectsJobsMessagesListCall) Location(location string) *ProjectsJobsMessagesListCall
Location sets the optional parameter "location": The location which contains the job specified by job_id.
func (*ProjectsJobsMessagesListCall) MinimumImportance ¶
func (c *ProjectsJobsMessagesListCall) MinimumImportance(minimumImportance string) *ProjectsJobsMessagesListCall
MinimumImportance sets the optional parameter "minimumImportance": Filter to only get messages with importance >= level
Possible values:
"JOB_MESSAGE_IMPORTANCE_UNKNOWN" "JOB_MESSAGE_DEBUG" "JOB_MESSAGE_DETAILED" "JOB_MESSAGE_BASIC" "JOB_MESSAGE_WARNING" "JOB_MESSAGE_ERROR"
func (*ProjectsJobsMessagesListCall) PageSize ¶
func (c *ProjectsJobsMessagesListCall) PageSize(pageSize int64) *ProjectsJobsMessagesListCall
PageSize sets the optional parameter "pageSize": If specified, determines the maximum number of messages to return. If unspecified, the service may choose an appropriate default, or may return an arbitrarily large number of results.
func (*ProjectsJobsMessagesListCall) PageToken ¶
func (c *ProjectsJobsMessagesListCall) PageToken(pageToken string) *ProjectsJobsMessagesListCall
PageToken sets the optional parameter "pageToken": If supplied, this should be the value of next_page_token returned by an earlier call. This will cause the next page of results to be returned.
func (*ProjectsJobsMessagesListCall) Pages ¶
func (c *ProjectsJobsMessagesListCall) Pages(ctx context.Context, f func(*ListJobMessagesResponse) error) error
Pages invokes f for each page of results. A non-nil error returned from f will halt the iteration. The provided context supersedes any context provided to the Context method.
func (*ProjectsJobsMessagesListCall) StartTime ¶
func (c *ProjectsJobsMessagesListCall) StartTime(startTime string) *ProjectsJobsMessagesListCall
StartTime sets the optional parameter "startTime": If specified, return only messages with timestamps >= start_time. The default is the job creation time (i.e. beginning of messages).
type ProjectsJobsMessagesService ¶
type ProjectsJobsMessagesService struct {
// contains filtered or unexported fields
}
func NewProjectsJobsMessagesService ¶
func NewProjectsJobsMessagesService(s *Service) *ProjectsJobsMessagesService
func (*ProjectsJobsMessagesService) List ¶
func (r *ProjectsJobsMessagesService) List(projectId string, jobId string) *ProjectsJobsMessagesListCall
List: Request the job status.
type ProjectsJobsService ¶
type ProjectsJobsService struct { Debug *ProjectsJobsDebugService Messages *ProjectsJobsMessagesService WorkItems *ProjectsJobsWorkItemsService // contains filtered or unexported fields }
func NewProjectsJobsService ¶
func NewProjectsJobsService(s *Service) *ProjectsJobsService
func (*ProjectsJobsService) Create ¶
func (r *ProjectsJobsService) Create(projectId string, job *Job) *ProjectsJobsCreateCall
Create: Creates a Cloud Dataflow job.
func (*ProjectsJobsService) Get ¶
func (r *ProjectsJobsService) Get(projectId string, jobId string) *ProjectsJobsGetCall
Get: Gets the state of the specified Cloud Dataflow job.
func (*ProjectsJobsService) GetMetrics ¶
func (r *ProjectsJobsService) GetMetrics(projectId string, jobId string) *ProjectsJobsGetMetricsCall
GetMetrics: Request the job status.
func (*ProjectsJobsService) List ¶
func (r *ProjectsJobsService) List(projectId string) *ProjectsJobsListCall
List: List the jobs of a project.
func (*ProjectsJobsService) Update ¶
func (r *ProjectsJobsService) Update(projectId string, jobId string, job *Job) *ProjectsJobsUpdateCall
Update: Updates the state of an existing Cloud Dataflow job.
type ProjectsJobsUpdateCall ¶
type ProjectsJobsUpdateCall struct {
// contains filtered or unexported fields
}
func (*ProjectsJobsUpdateCall) Context ¶
func (c *ProjectsJobsUpdateCall) Context(ctx context.Context) *ProjectsJobsUpdateCall
Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.
func (*ProjectsJobsUpdateCall) Do ¶
func (c *ProjectsJobsUpdateCall) Do(opts ...googleapi.CallOption) (*Job, error)
Do executes the "dataflow.projects.jobs.update" call. Exactly one of *Job or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Job.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (*ProjectsJobsUpdateCall) Fields ¶
func (c *ProjectsJobsUpdateCall) Fields(s ...googleapi.Field) *ProjectsJobsUpdateCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
func (*ProjectsJobsUpdateCall) Location ¶
func (c *ProjectsJobsUpdateCall) Location(location string) *ProjectsJobsUpdateCall
Location sets the optional parameter "location": The location that contains this job.
type ProjectsJobsWorkItemsLeaseCall ¶
type ProjectsJobsWorkItemsLeaseCall struct {
// contains filtered or unexported fields
}
func (*ProjectsJobsWorkItemsLeaseCall) Context ¶
func (c *ProjectsJobsWorkItemsLeaseCall) Context(ctx context.Context) *ProjectsJobsWorkItemsLeaseCall
Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.
func (*ProjectsJobsWorkItemsLeaseCall) Do ¶
func (c *ProjectsJobsWorkItemsLeaseCall) Do(opts ...googleapi.CallOption) (*LeaseWorkItemResponse, error)
Do executes the "dataflow.projects.jobs.workItems.lease" call. Exactly one of *LeaseWorkItemResponse or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *LeaseWorkItemResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (*ProjectsJobsWorkItemsLeaseCall) Fields ¶
func (c *ProjectsJobsWorkItemsLeaseCall) Fields(s ...googleapi.Field) *ProjectsJobsWorkItemsLeaseCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
type ProjectsJobsWorkItemsReportStatusCall ¶
type ProjectsJobsWorkItemsReportStatusCall struct {
// contains filtered or unexported fields
}
func (*ProjectsJobsWorkItemsReportStatusCall) Context ¶
func (c *ProjectsJobsWorkItemsReportStatusCall) Context(ctx context.Context) *ProjectsJobsWorkItemsReportStatusCall
Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.
func (*ProjectsJobsWorkItemsReportStatusCall) Do ¶
func (c *ProjectsJobsWorkItemsReportStatusCall) Do(opts ...googleapi.CallOption) (*ReportWorkItemStatusResponse, error)
Do executes the "dataflow.projects.jobs.workItems.reportStatus" call. Exactly one of *ReportWorkItemStatusResponse or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *ReportWorkItemStatusResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (*ProjectsJobsWorkItemsReportStatusCall) Fields ¶
func (c *ProjectsJobsWorkItemsReportStatusCall) Fields(s ...googleapi.Field) *ProjectsJobsWorkItemsReportStatusCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
type ProjectsJobsWorkItemsService ¶
type ProjectsJobsWorkItemsService struct {
// contains filtered or unexported fields
}
func NewProjectsJobsWorkItemsService ¶
func NewProjectsJobsWorkItemsService(s *Service) *ProjectsJobsWorkItemsService
func (*ProjectsJobsWorkItemsService) Lease ¶
func (r *ProjectsJobsWorkItemsService) Lease(projectId string, jobId string, leaseworkitemrequest *LeaseWorkItemRequest) *ProjectsJobsWorkItemsLeaseCall
Lease: Leases a dataflow WorkItem to run.
func (*ProjectsJobsWorkItemsService) ReportStatus ¶
func (r *ProjectsJobsWorkItemsService) ReportStatus(projectId string, jobId string, reportworkitemstatusrequest *ReportWorkItemStatusRequest) *ProjectsJobsWorkItemsReportStatusCall
ReportStatus: Reports the status of dataflow WorkItems leased by a worker.
type ProjectsLocationsJobsCreateCall ¶
type ProjectsLocationsJobsCreateCall struct {
// contains filtered or unexported fields
}
func (*ProjectsLocationsJobsCreateCall) Context ¶
func (c *ProjectsLocationsJobsCreateCall) Context(ctx context.Context) *ProjectsLocationsJobsCreateCall
Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.
func (*ProjectsLocationsJobsCreateCall) Do ¶
func (c *ProjectsLocationsJobsCreateCall) Do(opts ...googleapi.CallOption) (*Job, error)
Do executes the "dataflow.projects.locations.jobs.create" call. Exactly one of *Job or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Job.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (*ProjectsLocationsJobsCreateCall) Fields ¶
func (c *ProjectsLocationsJobsCreateCall) Fields(s ...googleapi.Field) *ProjectsLocationsJobsCreateCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
func (*ProjectsLocationsJobsCreateCall) ReplaceJobId ¶
func (c *ProjectsLocationsJobsCreateCall) ReplaceJobId(replaceJobId string) *ProjectsLocationsJobsCreateCall
ReplaceJobId sets the optional parameter "replaceJobId": Deprecated. This field is now in the Job message.
func (*ProjectsLocationsJobsCreateCall) View ¶
func (c *ProjectsLocationsJobsCreateCall) View(view string) *ProjectsLocationsJobsCreateCall
View sets the optional parameter "view": The level of information requested in response.
Possible values:
"JOB_VIEW_UNKNOWN" "JOB_VIEW_SUMMARY" "JOB_VIEW_ALL" "JOB_VIEW_DESCRIPTION"
type ProjectsLocationsJobsGetCall ¶
type ProjectsLocationsJobsGetCall struct {
// contains filtered or unexported fields
}
func (*ProjectsLocationsJobsGetCall) Context ¶
func (c *ProjectsLocationsJobsGetCall) Context(ctx context.Context) *ProjectsLocationsJobsGetCall
Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.
func (*ProjectsLocationsJobsGetCall) Do ¶
func (c *ProjectsLocationsJobsGetCall) Do(opts ...googleapi.CallOption) (*Job, error)
Do executes the "dataflow.projects.locations.jobs.get" call. Exactly one of *Job or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Job.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (*ProjectsLocationsJobsGetCall) Fields ¶
func (c *ProjectsLocationsJobsGetCall) Fields(s ...googleapi.Field) *ProjectsLocationsJobsGetCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
func (*ProjectsLocationsJobsGetCall) IfNoneMatch ¶
func (c *ProjectsLocationsJobsGetCall) IfNoneMatch(entityTag string) *ProjectsLocationsJobsGetCall
IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.
func (*ProjectsLocationsJobsGetCall) View ¶
func (c *ProjectsLocationsJobsGetCall) View(view string) *ProjectsLocationsJobsGetCall
View sets the optional parameter "view": The level of information requested in response.
Possible values:
"JOB_VIEW_UNKNOWN" "JOB_VIEW_SUMMARY" "JOB_VIEW_ALL" "JOB_VIEW_DESCRIPTION"
type ProjectsLocationsJobsGetMetricsCall ¶
type ProjectsLocationsJobsGetMetricsCall struct {
// contains filtered or unexported fields
}
func (*ProjectsLocationsJobsGetMetricsCall) Context ¶
func (c *ProjectsLocationsJobsGetMetricsCall) Context(ctx context.Context) *ProjectsLocationsJobsGetMetricsCall
Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.
func (*ProjectsLocationsJobsGetMetricsCall) Do ¶
func (c *ProjectsLocationsJobsGetMetricsCall) Do(opts ...googleapi.CallOption) (*JobMetrics, error)
Do executes the "dataflow.projects.locations.jobs.getMetrics" call. Exactly one of *JobMetrics or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *JobMetrics.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (*ProjectsLocationsJobsGetMetricsCall) Fields ¶
func (c *ProjectsLocationsJobsGetMetricsCall) Fields(s ...googleapi.Field) *ProjectsLocationsJobsGetMetricsCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
func (*ProjectsLocationsJobsGetMetricsCall) IfNoneMatch ¶
func (c *ProjectsLocationsJobsGetMetricsCall) IfNoneMatch(entityTag string) *ProjectsLocationsJobsGetMetricsCall
IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.
func (*ProjectsLocationsJobsGetMetricsCall) StartTime ¶
func (c *ProjectsLocationsJobsGetMetricsCall) StartTime(startTime string) *ProjectsLocationsJobsGetMetricsCall
StartTime sets the optional parameter "startTime": Return only metric data that has changed since this time. Default is to return all information about all metrics for the job.
type ProjectsLocationsJobsListCall ¶
type ProjectsLocationsJobsListCall struct {
// contains filtered or unexported fields
}
func (*ProjectsLocationsJobsListCall) Context ¶
func (c *ProjectsLocationsJobsListCall) Context(ctx context.Context) *ProjectsLocationsJobsListCall
Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.
func (*ProjectsLocationsJobsListCall) Do ¶
func (c *ProjectsLocationsJobsListCall) Do(opts ...googleapi.CallOption) (*ListJobsResponse, error)
Do executes the "dataflow.projects.locations.jobs.list" call. Exactly one of *ListJobsResponse or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *ListJobsResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (*ProjectsLocationsJobsListCall) Fields ¶
func (c *ProjectsLocationsJobsListCall) Fields(s ...googleapi.Field) *ProjectsLocationsJobsListCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
func (*ProjectsLocationsJobsListCall) Filter ¶
func (c *ProjectsLocationsJobsListCall) Filter(filter string) *ProjectsLocationsJobsListCall
Filter sets the optional parameter "filter": The kind of filter to use.
Possible values:
"UNKNOWN" "ALL" "TERMINATED" "ACTIVE"
func (*ProjectsLocationsJobsListCall) IfNoneMatch ¶
func (c *ProjectsLocationsJobsListCall) IfNoneMatch(entityTag string) *ProjectsLocationsJobsListCall
IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.
func (*ProjectsLocationsJobsListCall) PageSize ¶
func (c *ProjectsLocationsJobsListCall) PageSize(pageSize int64) *ProjectsLocationsJobsListCall
PageSize sets the optional parameter "pageSize": If there are many jobs, limit response to at most this many. The actual number of jobs returned will be the lesser of max_responses and an unspecified server-defined limit.
func (*ProjectsLocationsJobsListCall) PageToken ¶
func (c *ProjectsLocationsJobsListCall) PageToken(pageToken string) *ProjectsLocationsJobsListCall
PageToken sets the optional parameter "pageToken": Set this to the 'next_page_token' field of a previous response to request additional results in a long list.
func (*ProjectsLocationsJobsListCall) Pages ¶
func (c *ProjectsLocationsJobsListCall) Pages(ctx context.Context, f func(*ListJobsResponse) error) error
Pages invokes f for each page of results. A non-nil error returned from f will halt the iteration. The provided context supersedes any context provided to the Context method.
func (*ProjectsLocationsJobsListCall) View ¶
func (c *ProjectsLocationsJobsListCall) View(view string) *ProjectsLocationsJobsListCall
View sets the optional parameter "view": Level of information requested in response. Default is `JOB_VIEW_SUMMARY`.
Possible values:
"JOB_VIEW_UNKNOWN" "JOB_VIEW_SUMMARY" "JOB_VIEW_ALL" "JOB_VIEW_DESCRIPTION"
type ProjectsLocationsJobsMessagesListCall ¶
type ProjectsLocationsJobsMessagesListCall struct {
// contains filtered or unexported fields
}
func (*ProjectsLocationsJobsMessagesListCall) Context ¶
func (c *ProjectsLocationsJobsMessagesListCall) Context(ctx context.Context) *ProjectsLocationsJobsMessagesListCall
Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.
func (*ProjectsLocationsJobsMessagesListCall) Do ¶
func (c *ProjectsLocationsJobsMessagesListCall) Do(opts ...googleapi.CallOption) (*ListJobMessagesResponse, error)
Do executes the "dataflow.projects.locations.jobs.messages.list" call. Exactly one of *ListJobMessagesResponse or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *ListJobMessagesResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (*ProjectsLocationsJobsMessagesListCall) EndTime ¶
func (c *ProjectsLocationsJobsMessagesListCall) EndTime(endTime string) *ProjectsLocationsJobsMessagesListCall
EndTime sets the optional parameter "endTime": Return only messages with timestamps < end_time. The default is now (i.e. return up to the latest messages available).
func (*ProjectsLocationsJobsMessagesListCall) Fields ¶
func (c *ProjectsLocationsJobsMessagesListCall) Fields(s ...googleapi.Field) *ProjectsLocationsJobsMessagesListCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
func (*ProjectsLocationsJobsMessagesListCall) IfNoneMatch ¶
func (c *ProjectsLocationsJobsMessagesListCall) IfNoneMatch(entityTag string) *ProjectsLocationsJobsMessagesListCall
IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.
func (*ProjectsLocationsJobsMessagesListCall) MinimumImportance ¶
func (c *ProjectsLocationsJobsMessagesListCall) MinimumImportance(minimumImportance string) *ProjectsLocationsJobsMessagesListCall
MinimumImportance sets the optional parameter "minimumImportance": Filter to only get messages with importance >= level
Possible values:
"JOB_MESSAGE_IMPORTANCE_UNKNOWN" "JOB_MESSAGE_DEBUG" "JOB_MESSAGE_DETAILED" "JOB_MESSAGE_BASIC" "JOB_MESSAGE_WARNING" "JOB_MESSAGE_ERROR"
func (*ProjectsLocationsJobsMessagesListCall) PageSize ¶
func (c *ProjectsLocationsJobsMessagesListCall) PageSize(pageSize int64) *ProjectsLocationsJobsMessagesListCall
PageSize sets the optional parameter "pageSize": If specified, determines the maximum number of messages to return. If unspecified, the service may choose an appropriate default, or may return an arbitrarily large number of results.
func (*ProjectsLocationsJobsMessagesListCall) PageToken ¶
func (c *ProjectsLocationsJobsMessagesListCall) PageToken(pageToken string) *ProjectsLocationsJobsMessagesListCall
PageToken sets the optional parameter "pageToken": If supplied, this should be the value of next_page_token returned by an earlier call. This will cause the next page of results to be returned.
func (*ProjectsLocationsJobsMessagesListCall) Pages ¶
func (c *ProjectsLocationsJobsMessagesListCall) Pages(ctx context.Context, f func(*ListJobMessagesResponse) error) error
Pages invokes f for each page of results. A non-nil error returned from f will halt the iteration. The provided context supersedes any context provided to the Context method.
func (*ProjectsLocationsJobsMessagesListCall) StartTime ¶
func (c *ProjectsLocationsJobsMessagesListCall) StartTime(startTime string) *ProjectsLocationsJobsMessagesListCall
StartTime sets the optional parameter "startTime": If specified, return only messages with timestamps >= start_time. The default is the job creation time (i.e. beginning of messages).
type ProjectsLocationsJobsMessagesService ¶
type ProjectsLocationsJobsMessagesService struct {
// contains filtered or unexported fields
}
func NewProjectsLocationsJobsMessagesService ¶
func NewProjectsLocationsJobsMessagesService(s *Service) *ProjectsLocationsJobsMessagesService
func (*ProjectsLocationsJobsMessagesService) List ¶
func (r *ProjectsLocationsJobsMessagesService) List(projectId string, location string, jobId string) *ProjectsLocationsJobsMessagesListCall
List: Request the job status.
type ProjectsLocationsJobsService ¶
type ProjectsLocationsJobsService struct { Messages *ProjectsLocationsJobsMessagesService WorkItems *ProjectsLocationsJobsWorkItemsService // contains filtered or unexported fields }
func NewProjectsLocationsJobsService ¶
func NewProjectsLocationsJobsService(s *Service) *ProjectsLocationsJobsService
func (*ProjectsLocationsJobsService) Create ¶
func (r *ProjectsLocationsJobsService) Create(projectId string, location string, job *Job) *ProjectsLocationsJobsCreateCall
Create: Creates a Cloud Dataflow job.
func (*ProjectsLocationsJobsService) Get ¶
func (r *ProjectsLocationsJobsService) Get(projectId string, location string, jobId string) *ProjectsLocationsJobsGetCall
Get: Gets the state of the specified Cloud Dataflow job.
func (*ProjectsLocationsJobsService) GetMetrics ¶
func (r *ProjectsLocationsJobsService) GetMetrics(projectId string, location string, jobId string) *ProjectsLocationsJobsGetMetricsCall
GetMetrics: Request the job status.
func (*ProjectsLocationsJobsService) List ¶
func (r *ProjectsLocationsJobsService) List(projectId string, location string) *ProjectsLocationsJobsListCall
List: List the jobs of a project.
func (*ProjectsLocationsJobsService) Update ¶
func (r *ProjectsLocationsJobsService) Update(projectId string, location string, jobId string, job *Job) *ProjectsLocationsJobsUpdateCall
Update: Updates the state of an existing Cloud Dataflow job.
type ProjectsLocationsJobsUpdateCall ¶
type ProjectsLocationsJobsUpdateCall struct {
// contains filtered or unexported fields
}
func (*ProjectsLocationsJobsUpdateCall) Context ¶
func (c *ProjectsLocationsJobsUpdateCall) Context(ctx context.Context) *ProjectsLocationsJobsUpdateCall
Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.
func (*ProjectsLocationsJobsUpdateCall) Do ¶
func (c *ProjectsLocationsJobsUpdateCall) Do(opts ...googleapi.CallOption) (*Job, error)
Do executes the "dataflow.projects.locations.jobs.update" call. Exactly one of *Job or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Job.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (*ProjectsLocationsJobsUpdateCall) Fields ¶
func (c *ProjectsLocationsJobsUpdateCall) Fields(s ...googleapi.Field) *ProjectsLocationsJobsUpdateCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
type ProjectsLocationsJobsWorkItemsLeaseCall ¶
type ProjectsLocationsJobsWorkItemsLeaseCall struct {
// contains filtered or unexported fields
}
func (*ProjectsLocationsJobsWorkItemsLeaseCall) Context ¶
func (c *ProjectsLocationsJobsWorkItemsLeaseCall) Context(ctx context.Context) *ProjectsLocationsJobsWorkItemsLeaseCall
Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.
func (*ProjectsLocationsJobsWorkItemsLeaseCall) Do ¶
func (c *ProjectsLocationsJobsWorkItemsLeaseCall) Do(opts ...googleapi.CallOption) (*LeaseWorkItemResponse, error)
Do executes the "dataflow.projects.locations.jobs.workItems.lease" call. Exactly one of *LeaseWorkItemResponse or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *LeaseWorkItemResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (*ProjectsLocationsJobsWorkItemsLeaseCall) Fields ¶
func (c *ProjectsLocationsJobsWorkItemsLeaseCall) Fields(s ...googleapi.Field) *ProjectsLocationsJobsWorkItemsLeaseCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
type ProjectsLocationsJobsWorkItemsReportStatusCall ¶
type ProjectsLocationsJobsWorkItemsReportStatusCall struct {
// contains filtered or unexported fields
}
func (*ProjectsLocationsJobsWorkItemsReportStatusCall) Context ¶
func (c *ProjectsLocationsJobsWorkItemsReportStatusCall) Context(ctx context.Context) *ProjectsLocationsJobsWorkItemsReportStatusCall
Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.
func (*ProjectsLocationsJobsWorkItemsReportStatusCall) Do ¶
func (c *ProjectsLocationsJobsWorkItemsReportStatusCall) Do(opts ...googleapi.CallOption) (*ReportWorkItemStatusResponse, error)
Do executes the "dataflow.projects.locations.jobs.workItems.reportStatus" call. Exactly one of *ReportWorkItemStatusResponse or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *ReportWorkItemStatusResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (*ProjectsLocationsJobsWorkItemsReportStatusCall) Fields ¶
func (c *ProjectsLocationsJobsWorkItemsReportStatusCall) Fields(s ...googleapi.Field) *ProjectsLocationsJobsWorkItemsReportStatusCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
type ProjectsLocationsJobsWorkItemsService ¶
type ProjectsLocationsJobsWorkItemsService struct {
// contains filtered or unexported fields
}
func NewProjectsLocationsJobsWorkItemsService ¶
func NewProjectsLocationsJobsWorkItemsService(s *Service) *ProjectsLocationsJobsWorkItemsService
func (*ProjectsLocationsJobsWorkItemsService) Lease ¶
func (r *ProjectsLocationsJobsWorkItemsService) Lease(projectId string, location string, jobId string, leaseworkitemrequest *LeaseWorkItemRequest) *ProjectsLocationsJobsWorkItemsLeaseCall
Lease: Leases a dataflow WorkItem to run.
func (*ProjectsLocationsJobsWorkItemsService) ReportStatus ¶
func (r *ProjectsLocationsJobsWorkItemsService) ReportStatus(projectId string, location string, jobId string, reportworkitemstatusrequest *ReportWorkItemStatusRequest) *ProjectsLocationsJobsWorkItemsReportStatusCall
ReportStatus: Reports the status of dataflow WorkItems leased by a worker.
type ProjectsLocationsService ¶
type ProjectsLocationsService struct { Jobs *ProjectsLocationsJobsService // contains filtered or unexported fields }
func NewProjectsLocationsService ¶
func NewProjectsLocationsService(s *Service) *ProjectsLocationsService
type ProjectsService ¶
type ProjectsService struct { Jobs *ProjectsJobsService Locations *ProjectsLocationsService Templates *ProjectsTemplatesService // contains filtered or unexported fields }
func NewProjectsService ¶
func NewProjectsService(s *Service) *ProjectsService
func (*ProjectsService) WorkerMessages ¶
func (r *ProjectsService) WorkerMessages(projectId string, sendworkermessagesrequest *SendWorkerMessagesRequest) *ProjectsWorkerMessagesCall
WorkerMessages: Send a worker_message to the service.
type ProjectsTemplatesCreateCall ¶
type ProjectsTemplatesCreateCall struct {
// contains filtered or unexported fields
}
func (*ProjectsTemplatesCreateCall) Context ¶
func (c *ProjectsTemplatesCreateCall) Context(ctx context.Context) *ProjectsTemplatesCreateCall
Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.
func (*ProjectsTemplatesCreateCall) Do ¶
func (c *ProjectsTemplatesCreateCall) Do(opts ...googleapi.CallOption) (*Job, error)
Do executes the "dataflow.projects.templates.create" call. Exactly one of *Job or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Job.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (*ProjectsTemplatesCreateCall) Fields ¶
func (c *ProjectsTemplatesCreateCall) Fields(s ...googleapi.Field) *ProjectsTemplatesCreateCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
type ProjectsTemplatesGetCall ¶
type ProjectsTemplatesGetCall struct {
// contains filtered or unexported fields
}
func (*ProjectsTemplatesGetCall) Context ¶
func (c *ProjectsTemplatesGetCall) Context(ctx context.Context) *ProjectsTemplatesGetCall
Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.
func (*ProjectsTemplatesGetCall) Do ¶
func (c *ProjectsTemplatesGetCall) Do(opts ...googleapi.CallOption) (*GetTemplateResponse, error)
Do executes the "dataflow.projects.templates.get" call. Exactly one of *GetTemplateResponse or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *GetTemplateResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (*ProjectsTemplatesGetCall) Fields ¶
func (c *ProjectsTemplatesGetCall) Fields(s ...googleapi.Field) *ProjectsTemplatesGetCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
func (*ProjectsTemplatesGetCall) GcsPath ¶
func (c *ProjectsTemplatesGetCall) GcsPath(gcsPath string) *ProjectsTemplatesGetCall
GcsPath sets the optional parameter "gcsPath": Required. A Cloud Storage path to the template from which to create the job. Must be a valid Cloud Storage URL, beginning with `gs://`.
func (*ProjectsTemplatesGetCall) IfNoneMatch ¶
func (c *ProjectsTemplatesGetCall) IfNoneMatch(entityTag string) *ProjectsTemplatesGetCall
IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.
func (*ProjectsTemplatesGetCall) View ¶
func (c *ProjectsTemplatesGetCall) View(view string) *ProjectsTemplatesGetCall
View sets the optional parameter "view": The view to retrieve. Defaults to METADATA_ONLY.
Possible values:
"METADATA_ONLY"
type ProjectsTemplatesLaunchCall ¶
type ProjectsTemplatesLaunchCall struct {
// contains filtered or unexported fields
}
func (*ProjectsTemplatesLaunchCall) Context ¶
func (c *ProjectsTemplatesLaunchCall) Context(ctx context.Context) *ProjectsTemplatesLaunchCall
Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.
func (*ProjectsTemplatesLaunchCall) Do ¶
func (c *ProjectsTemplatesLaunchCall) Do(opts ...googleapi.CallOption) (*LaunchTemplateResponse, error)
Do executes the "dataflow.projects.templates.launch" call. Exactly one of *LaunchTemplateResponse or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *LaunchTemplateResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (*ProjectsTemplatesLaunchCall) DryRun ¶
func (c *ProjectsTemplatesLaunchCall) DryRun(dryRun bool) *ProjectsTemplatesLaunchCall
DryRun sets the optional parameter "dryRun": Whether or not the job should actually be executed after validating parameters. Defaults to false. Validation errors do not cause the HTTP request to fail if true.
func (*ProjectsTemplatesLaunchCall) Fields ¶
func (c *ProjectsTemplatesLaunchCall) Fields(s ...googleapi.Field) *ProjectsTemplatesLaunchCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
func (*ProjectsTemplatesLaunchCall) GcsPath ¶
func (c *ProjectsTemplatesLaunchCall) GcsPath(gcsPath string) *ProjectsTemplatesLaunchCall
GcsPath sets the optional parameter "gcsPath": Required. A Cloud Storage path to the template from which to create the job. Must be valid Cloud Storage URL, beginning with 'gs://'.
type ProjectsTemplatesService ¶
type ProjectsTemplatesService struct {
// contains filtered or unexported fields
}
func NewProjectsTemplatesService ¶
func NewProjectsTemplatesService(s *Service) *ProjectsTemplatesService
func (*ProjectsTemplatesService) Create ¶
func (r *ProjectsTemplatesService) Create(projectId string, createjobfromtemplaterequest *CreateJobFromTemplateRequest) *ProjectsTemplatesCreateCall
Create: Creates a Cloud Dataflow job from a template.
func (*ProjectsTemplatesService) Get ¶
func (r *ProjectsTemplatesService) Get(projectId string) *ProjectsTemplatesGetCall
Get: Get the template associated with a template.
func (*ProjectsTemplatesService) Launch ¶
func (r *ProjectsTemplatesService) Launch(projectId string, launchtemplateparameters *LaunchTemplateParameters) *ProjectsTemplatesLaunchCall
Launch: Launch a template.
type ProjectsWorkerMessagesCall ¶
type ProjectsWorkerMessagesCall struct {
// contains filtered or unexported fields
}
func (*ProjectsWorkerMessagesCall) Context ¶
func (c *ProjectsWorkerMessagesCall) Context(ctx context.Context) *ProjectsWorkerMessagesCall
Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.
func (*ProjectsWorkerMessagesCall) Do ¶
func (c *ProjectsWorkerMessagesCall) Do(opts ...googleapi.CallOption) (*SendWorkerMessagesResponse, error)
Do executes the "dataflow.projects.workerMessages" call. Exactly one of *SendWorkerMessagesResponse or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *SendWorkerMessagesResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (*ProjectsWorkerMessagesCall) Fields ¶
func (c *ProjectsWorkerMessagesCall) Fields(s ...googleapi.Field) *ProjectsWorkerMessagesCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
type PubsubLocation ¶
type PubsubLocation struct { // DropLateData: Indicates whether the pipeline allows late-arriving // data. DropLateData bool `json:"dropLateData,omitempty"` // IdLabel: If set, contains a pubsub label from which to extract record // ids. // If left empty, record deduplication will be strictly best effort. IdLabel string `json:"idLabel,omitempty"` // Subscription: A pubsub subscription, in the form // of // "pubsub.googleapis.com/subscriptions/<project-id>/<subscription-nam // e>" Subscription string `json:"subscription,omitempty"` // TimestampLabel: If set, contains a pubsub label from which to extract // record timestamps. // If left empty, record timestamps will be generated upon arrival. TimestampLabel string `json:"timestampLabel,omitempty"` // Topic: A pubsub topic, in the form // of // "pubsub.googleapis.com/topics/<project-id>/<topic-name>" Topic string `json:"topic,omitempty"` // TrackingSubscription: If set, specifies the pubsub subscription that // will be used for tracking // custom time timestamps for watermark estimation. TrackingSubscription string `json:"trackingSubscription,omitempty"` // WithAttributes: If true, then the client has requested to get pubsub // attributes. WithAttributes bool `json:"withAttributes,omitempty"` // ForceSendFields is a list of field names (e.g. "DropLateData") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` }
PubsubLocation: Identifies a pubsub location to use for transferring data into or out of a streaming Dataflow job.
func (*PubsubLocation) MarshalJSON ¶
func (s *PubsubLocation) MarshalJSON() ([]byte, error)
type ReadInstruction ¶
type ReadInstruction struct { // Source: The source to read from. Source *Source `json:"source,omitempty"` // ForceSendFields is a list of field names (e.g. "Source") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` }
ReadInstruction: An instruction that reads records. Takes no inputs, produces one output.
func (*ReadInstruction) MarshalJSON ¶
func (s *ReadInstruction) MarshalJSON() ([]byte, error)
type ReportWorkItemStatusRequest ¶
type ReportWorkItemStatusRequest struct { // CurrentWorkerTime: The current timestamp at the worker. CurrentWorkerTime string `json:"currentWorkerTime,omitempty"` // Location: The location which contains the WorkItem's job. Location string `json:"location,omitempty"` // WorkItemStatuses: The order is unimportant, except that the order of // the // WorkItemServiceState messages in the // ReportWorkItemStatusResponse // corresponds to the order of WorkItemStatus messages here. WorkItemStatuses []*WorkItemStatus `json:"workItemStatuses,omitempty"` // WorkerId: The ID of the worker reporting the WorkItem status. If // this // does not match the ID of the worker which the Dataflow // service // believes currently has the lease on the WorkItem, the report // will be dropped (with an error response). WorkerId string `json:"workerId,omitempty"` // ForceSendFields is a list of field names (e.g. "CurrentWorkerTime") // to unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` }
ReportWorkItemStatusRequest: Request to report the status of WorkItems.
func (*ReportWorkItemStatusRequest) MarshalJSON ¶
func (s *ReportWorkItemStatusRequest) MarshalJSON() ([]byte, error)
type ReportWorkItemStatusResponse ¶
type ReportWorkItemStatusResponse struct { // WorkItemServiceStates: A set of messages indicating the service-side // state for each // WorkItem whose status was reported, in the same order as // the // WorkItemStatus messages in the ReportWorkItemStatusRequest // which // resulting in this response. WorkItemServiceStates []*WorkItemServiceState `json:"workItemServiceStates,omitempty"` // ServerResponse contains the HTTP response code and headers from the // server. googleapi.ServerResponse `json:"-"` // ForceSendFields is a list of field names (e.g. // "WorkItemServiceStates") to unconditionally include in API requests. // By default, fields with empty values are omitted from API requests. // However, any non-pointer, non-interface field appearing in // ForceSendFields will be sent to the server regardless of whether the // field is empty or not. This may be used to include empty fields in // Patch requests. ForceSendFields []string `json:"-"` }
ReportWorkItemStatusResponse: Response from a request to report the status of WorkItems.
func (*ReportWorkItemStatusResponse) MarshalJSON ¶
func (s *ReportWorkItemStatusResponse) MarshalJSON() ([]byte, error)
type ReportedParallelism ¶
type ReportedParallelism struct { // IsInfinite: Specifies whether the parallelism is infinite. If true, // "value" is // ignored. // Infinite parallelism means the service will assume that the work // item // can always be split into more non-empty work items by dynamic // splitting. // This is a work-around for lack of support for infinity by the // current // JSON-based Java RPC stack. IsInfinite bool `json:"isInfinite,omitempty"` // Value: Specifies the level of parallelism in case it is finite. Value float64 `json:"value,omitempty"` // ForceSendFields is a list of field names (e.g. "IsInfinite") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` }
ReportedParallelism: Represents the level of parallelism in a WorkItem's input, reported by the worker.
func (*ReportedParallelism) MarshalJSON ¶
func (s *ReportedParallelism) MarshalJSON() ([]byte, error)
type ResourceUtilizationReport ¶
type ResourceUtilizationReport struct { // CpuTime: CPU utilization samples. CpuTime []*CPUTime `json:"cpuTime,omitempty"` // ForceSendFields is a list of field names (e.g. "CpuTime") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` }
ResourceUtilizationReport: Worker metrics exported from workers. This contains resource utilization metrics accumulated from a variety of sources. For more information, see go/df-resource-signals.
func (*ResourceUtilizationReport) MarshalJSON ¶
func (s *ResourceUtilizationReport) MarshalJSON() ([]byte, error)
type ResourceUtilizationReportResponse ¶
type ResourceUtilizationReportResponse struct { }
ResourceUtilizationReportResponse: Service-side response to WorkerMessage reporting resource utilization.
type RuntimeEnvironment ¶
type RuntimeEnvironment struct { // BypassTempDirValidation: Whether to bypass the safety checks for the // job's temporary directory. // Use with caution. BypassTempDirValidation bool `json:"bypassTempDirValidation,omitempty"` // MaxWorkers: The maximum number of Google Compute Engine instances to // be made // available to your pipeline during execution, from 1 to 1000. MaxWorkers int64 `json:"maxWorkers,omitempty"` // ServiceAccountEmail: The email address of the service account to run // the job as. ServiceAccountEmail string `json:"serviceAccountEmail,omitempty"` // TempLocation: The Cloud Storage path to use for temporary files. // Must be a valid Cloud Storage URL, beginning with `gs://`. TempLocation string `json:"tempLocation,omitempty"` // Zone: The Compute Engine [availability // zone](https://cloud.google.com/compute/docs/regions-zones/regions-zone // s) // for launching worker instances to run your pipeline. Zone string `json:"zone,omitempty"` // ForceSendFields is a list of field names (e.g. // "BypassTempDirValidation") to unconditionally include in API // requests. By default, fields with empty values are omitted from API // requests. However, any non-pointer, non-interface field appearing in // ForceSendFields will be sent to the server regardless of whether the // field is empty or not. This may be used to include empty fields in // Patch requests. ForceSendFields []string `json:"-"` }
RuntimeEnvironment: The environment values to set at runtime.
func (*RuntimeEnvironment) MarshalJSON ¶
func (s *RuntimeEnvironment) MarshalJSON() ([]byte, error)
type SendDebugCaptureRequest ¶
type SendDebugCaptureRequest struct { // ComponentId: The internal component id for which debug information is // sent. ComponentId string `json:"componentId,omitempty"` // Data: The encoded debug information. Data string `json:"data,omitempty"` // WorkerId: The worker id, i.e., VM hostname. WorkerId string `json:"workerId,omitempty"` // ForceSendFields is a list of field names (e.g. "ComponentId") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` }
SendDebugCaptureRequest: Request to send encoded debug information.
func (*SendDebugCaptureRequest) MarshalJSON ¶
func (s *SendDebugCaptureRequest) MarshalJSON() ([]byte, error)
type SendDebugCaptureResponse ¶
type SendDebugCaptureResponse struct { // ServerResponse contains the HTTP response code and headers from the // server. googleapi.ServerResponse `json:"-"` }
SendDebugCaptureResponse: Response to a send capture request. nothing
type SendWorkerMessagesRequest ¶
type SendWorkerMessagesRequest struct { // WorkerMessages: The WorkerMessages to send. WorkerMessages []*WorkerMessage `json:"workerMessages,omitempty"` // ForceSendFields is a list of field names (e.g. "WorkerMessages") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` }
SendWorkerMessagesRequest: A request for sending worker messages to the service.
func (*SendWorkerMessagesRequest) MarshalJSON ¶
func (s *SendWorkerMessagesRequest) MarshalJSON() ([]byte, error)
type SendWorkerMessagesResponse ¶
type SendWorkerMessagesResponse struct { // WorkerMessageResponses: The servers response to the worker messages. WorkerMessageResponses []*WorkerMessageResponse `json:"workerMessageResponses,omitempty"` // ServerResponse contains the HTTP response code and headers from the // server. googleapi.ServerResponse `json:"-"` // ForceSendFields is a list of field names (e.g. // "WorkerMessageResponses") to unconditionally include in API requests. // By default, fields with empty values are omitted from API requests. // However, any non-pointer, non-interface field appearing in // ForceSendFields will be sent to the server regardless of whether the // field is empty or not. This may be used to include empty fields in // Patch requests. ForceSendFields []string `json:"-"` }
SendWorkerMessagesResponse: The response to the worker messages.
func (*SendWorkerMessagesResponse) MarshalJSON ¶
func (s *SendWorkerMessagesResponse) MarshalJSON() ([]byte, error)
type SeqMapTask ¶
type SeqMapTask struct { // Inputs: Information about each of the inputs. Inputs []*SideInputInfo `json:"inputs,omitempty"` // Name: The user-provided name of the SeqDo operation. Name string `json:"name,omitempty"` // OutputInfos: Information about each of the outputs. OutputInfos []*SeqMapTaskOutputInfo `json:"outputInfos,omitempty"` // StageName: System-defined name of the stage containing the SeqDo // operation. // Unique across the workflow. StageName string `json:"stageName,omitempty"` // SystemName: System-defined name of the SeqDo operation. // Unique across the workflow. SystemName string `json:"systemName,omitempty"` // UserFn: The user function to invoke. UserFn SeqMapTaskUserFn `json:"userFn,omitempty"` // ForceSendFields is a list of field names (e.g. "Inputs") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` }
SeqMapTask: Describes a particular function to invoke.
func (*SeqMapTask) MarshalJSON ¶
func (s *SeqMapTask) MarshalJSON() ([]byte, error)
type SeqMapTaskOutputInfo ¶
type SeqMapTaskOutputInfo struct { // Sink: The sink to write the output value to. Sink *Sink `json:"sink,omitempty"` // Tag: The id of the TupleTag the user code will tag the output value // by. Tag string `json:"tag,omitempty"` // ForceSendFields is a list of field names (e.g. "Sink") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` }
SeqMapTaskOutputInfo: Information about an output of a SeqMapTask.
func (*SeqMapTaskOutputInfo) MarshalJSON ¶
func (s *SeqMapTaskOutputInfo) MarshalJSON() ([]byte, error)
type SeqMapTaskUserFn ¶
type SeqMapTaskUserFn interface{}
type Service ¶
type Service struct { BasePath string // API endpoint base URL UserAgent string // optional additional User-Agent fragment Projects *ProjectsService // contains filtered or unexported fields }
type ShellTask ¶
type ShellTask struct { // Command: The shell command to run. Command string `json:"command,omitempty"` // ExitCode: Exit code for the task. ExitCode int64 `json:"exitCode,omitempty"` // ForceSendFields is a list of field names (e.g. "Command") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` }
ShellTask: A task which consists of a shell command for the worker to execute.
func (*ShellTask) MarshalJSON ¶
type SideInputInfo ¶
type SideInputInfo struct { // Kind: How to interpret the source element(s) as a side input value. Kind SideInputInfoKind `json:"kind,omitempty"` // Sources: The source(s) to read element(s) from to get the value of // this side input. // If more than one source, then the elements are taken from // the // sources, in the specified order if order matters. // At least one source is required. Sources []*Source `json:"sources,omitempty"` // Tag: The id of the tag the user code will access this side input // by; // this should correspond to the tag of some MultiOutputInfo. Tag string `json:"tag,omitempty"` // ForceSendFields is a list of field names (e.g. "Kind") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` }
SideInputInfo: Information about a side input of a DoFn or an input of a SeqDoFn.
func (*SideInputInfo) MarshalJSON ¶
func (s *SideInputInfo) MarshalJSON() ([]byte, error)
type SideInputInfoKind ¶
type SideInputInfoKind interface{}
type Sink ¶
type Sink struct { // Codec: The codec to use to encode data written to the sink. Codec SinkCodec `json:"codec,omitempty"` // Spec: The sink to write to, plus its parameters. Spec SinkSpec `json:"spec,omitempty"` // ForceSendFields is a list of field names (e.g. "Codec") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` }
Sink: A sink that records can be encoded and written to.
func (*Sink) MarshalJSON ¶
type Source ¶
type Source struct { // BaseSpecs: While splitting, sources may specify the produced // bundles // as differences against another source, in order to save // backend-side // memory and allow bigger jobs. For details, see SourceSplitRequest. // To support this use case, the full set of parameters of the source // is logically obtained by taking the latest explicitly specified // value // of each parameter in the order: // base_specs (later items win), spec (overrides anything in // base_specs). BaseSpecs []SourceBaseSpecs `json:"baseSpecs,omitempty"` // Codec: The codec to use to decode data read from the source. Codec SourceCodec `json:"codec,omitempty"` // DoesNotNeedSplitting: Setting this value to true hints to the // framework that the source // doesn't need splitting, and using SourceSplitRequest on it // would // yield SOURCE_SPLIT_OUTCOME_USE_CURRENT. // // E.g. a file splitter may set this to true when splitting a single // file // into a set of byte ranges of appropriate size, and set this // to false when splitting a filepattern into individual files. // However, for efficiency, a file splitter may decide to produce // file subranges directly from the filepattern to avoid a // splitting // round-trip. // // See SourceSplitRequest for an overview of the splitting // process. // // This field is meaningful only in the Source objects populated // by the user (e.g. when filling in a DerivedSource). // Source objects supplied by the framework to the user don't have // this field populated. DoesNotNeedSplitting bool `json:"doesNotNeedSplitting,omitempty"` // Metadata: Optionally, metadata for this source can be supplied right // away, // avoiding a SourceGetMetadataOperation roundtrip // (see SourceOperationRequest). // // This field is meaningful only in the Source objects populated // by the user (e.g. when filling in a DerivedSource). // Source objects supplied by the framework to the user don't have // this field populated. Metadata *SourceMetadata `json:"metadata,omitempty"` // Spec: The source to read from, plus its parameters. Spec SourceSpec `json:"spec,omitempty"` // ForceSendFields is a list of field names (e.g. "BaseSpecs") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` }
Source: A source that records can be read and decoded from.
func (*Source) MarshalJSON ¶
type SourceBaseSpecs ¶
type SourceBaseSpecs interface{}
type SourceCodec ¶
type SourceCodec interface{}
type SourceFork ¶
type SourceFork struct { // Primary: DEPRECATED Primary *SourceSplitShard `json:"primary,omitempty"` // PrimarySource: DEPRECATED PrimarySource *DerivedSource `json:"primarySource,omitempty"` // Residual: DEPRECATED Residual *SourceSplitShard `json:"residual,omitempty"` // ResidualSource: DEPRECATED ResidualSource *DerivedSource `json:"residualSource,omitempty"` // ForceSendFields is a list of field names (e.g. "Primary") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` }
SourceFork: DEPRECATED in favor of DynamicSourceSplit.
func (*SourceFork) MarshalJSON ¶
func (s *SourceFork) MarshalJSON() ([]byte, error)
type SourceGetMetadataRequest ¶
type SourceGetMetadataRequest struct { // Source: Specification of the source whose metadata should be // computed. Source *Source `json:"source,omitempty"` // ForceSendFields is a list of field names (e.g. "Source") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` }
SourceGetMetadataRequest: A request to compute the SourceMetadata of a Source.
func (*SourceGetMetadataRequest) MarshalJSON ¶
func (s *SourceGetMetadataRequest) MarshalJSON() ([]byte, error)
type SourceGetMetadataResponse ¶
type SourceGetMetadataResponse struct { // Metadata: The computed metadata. Metadata *SourceMetadata `json:"metadata,omitempty"` // ForceSendFields is a list of field names (e.g. "Metadata") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` }
SourceGetMetadataResponse: The result of a SourceGetMetadataOperation.
func (*SourceGetMetadataResponse) MarshalJSON ¶
func (s *SourceGetMetadataResponse) MarshalJSON() ([]byte, error)
type SourceMetadata ¶
type SourceMetadata struct { // EstimatedSizeBytes: An estimate of the total size (in bytes) of the // data that would be // read from this source. This estimate is in terms of external // storage // size, before any decompression or other processing done by the // reader. EstimatedSizeBytes int64 `json:"estimatedSizeBytes,omitempty,string"` // Infinite: Specifies that the size of this source is known to be // infinite // (this is a streaming source). Infinite bool `json:"infinite,omitempty"` // ProducesSortedKeys: Whether this source is known to produce key/value // pairs with // the (encoded) keys in lexicographically sorted order. ProducesSortedKeys bool `json:"producesSortedKeys,omitempty"` // ForceSendFields is a list of field names (e.g. "EstimatedSizeBytes") // to unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` }
SourceMetadata: Metadata about a Source useful for automatically optimizing and tuning the pipeline, etc.
func (*SourceMetadata) MarshalJSON ¶
func (s *SourceMetadata) MarshalJSON() ([]byte, error)
type SourceOperationRequest ¶
type SourceOperationRequest struct { // GetMetadata: Information about a request to get metadata about a // source. GetMetadata *SourceGetMetadataRequest `json:"getMetadata,omitempty"` // Split: Information about a request to split a source. Split *SourceSplitRequest `json:"split,omitempty"` // ForceSendFields is a list of field names (e.g. "GetMetadata") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` }
SourceOperationRequest: A work item that represents the different operations that can be performed on a user-defined Source specification.
func (*SourceOperationRequest) MarshalJSON ¶
func (s *SourceOperationRequest) MarshalJSON() ([]byte, error)
type SourceOperationResponse ¶
type SourceOperationResponse struct { // GetMetadata: A response to a request to get metadata about a source. GetMetadata *SourceGetMetadataResponse `json:"getMetadata,omitempty"` // Split: A response to a request to split a source. Split *SourceSplitResponse `json:"split,omitempty"` // ForceSendFields is a list of field names (e.g. "GetMetadata") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` }
SourceOperationResponse: The result of a SourceOperationRequest, specified in ReportWorkItemStatusRequest.source_operation when the work item is completed.
func (*SourceOperationResponse) MarshalJSON ¶
func (s *SourceOperationResponse) MarshalJSON() ([]byte, error)
type SourceSpec ¶
type SourceSpec interface{}
type SourceSplitOptions ¶
type SourceSplitOptions struct { // DesiredBundleSizeBytes: The source should be split into a set of // bundles where the estimated size // of each is approximately this many bytes. DesiredBundleSizeBytes int64 `json:"desiredBundleSizeBytes,omitempty,string"` // DesiredShardSizeBytes: DEPRECATED in favor of // desired_bundle_size_bytes. DesiredShardSizeBytes int64 `json:"desiredShardSizeBytes,omitempty,string"` // ForceSendFields is a list of field names (e.g. // "DesiredBundleSizeBytes") to unconditionally include in API requests. // By default, fields with empty values are omitted from API requests. // However, any non-pointer, non-interface field appearing in // ForceSendFields will be sent to the server regardless of whether the // field is empty or not. This may be used to include empty fields in // Patch requests. ForceSendFields []string `json:"-"` }
SourceSplitOptions: Hints for splitting a Source into bundles (parts for parallel processing) using SourceSplitRequest.
func (*SourceSplitOptions) MarshalJSON ¶
func (s *SourceSplitOptions) MarshalJSON() ([]byte, error)
type SourceSplitRequest ¶
type SourceSplitRequest struct { // Options: Hints for tuning the splitting process. Options *SourceSplitOptions `json:"options,omitempty"` // Source: Specification of the source to be split. Source *Source `json:"source,omitempty"` // ForceSendFields is a list of field names (e.g. "Options") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` }
SourceSplitRequest: Represents the operation to split a high-level Source specification into bundles (parts for parallel processing).
At a high level, splitting of a source into bundles happens as follows: SourceSplitRequest is applied to the source. If it returns SOURCE_SPLIT_OUTCOME_USE_CURRENT, no further splitting happens and the source is used "as is". Otherwise, splitting is applied recursively to each produced DerivedSource.
As an optimization, for any Source, if its does_not_need_splitting is true, the framework assumes that splitting this source would return SOURCE_SPLIT_OUTCOME_USE_CURRENT, and doesn't initiate a SourceSplitRequest. This applies both to the initial source being split and to bundles produced from it.
func (*SourceSplitRequest) MarshalJSON ¶
func (s *SourceSplitRequest) MarshalJSON() ([]byte, error)
type SourceSplitResponse ¶
type SourceSplitResponse struct { // Bundles: If outcome is SPLITTING_HAPPENED, then this is a list of // bundles // into which the source was split. Otherwise this field is // ignored. // This list can be empty, which means the source represents an empty // input. Bundles []*DerivedSource `json:"bundles,omitempty"` // Outcome: Indicates whether splitting happened and produced a list of // bundles. // If this is USE_CURRENT_SOURCE_AS_IS, the current source should // be processed "as is" without splitting. "bundles" is ignored in this // case. // If this is SPLITTING_HAPPENED, then "bundles" contains a list // of // bundles into which the source was split. // // Possible values: // "SOURCE_SPLIT_OUTCOME_UNKNOWN" - The source split outcome is // unknown, or unspecified. // "SOURCE_SPLIT_OUTCOME_USE_CURRENT" - The current source should be // processed "as is" without splitting. // "SOURCE_SPLIT_OUTCOME_SPLITTING_HAPPENED" - Splitting produced a // list of bundles. Outcome string `json:"outcome,omitempty"` // Shards: DEPRECATED in favor of bundles. Shards []*SourceSplitShard `json:"shards,omitempty"` // ForceSendFields is a list of field names (e.g. "Bundles") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` }
SourceSplitResponse: The response to a SourceSplitRequest.
func (*SourceSplitResponse) MarshalJSON ¶
func (s *SourceSplitResponse) MarshalJSON() ([]byte, error)
type SourceSplitShard ¶
type SourceSplitShard struct { // DerivationMode: DEPRECATED // // Possible values: // "SOURCE_DERIVATION_MODE_UNKNOWN" - The source derivation is // unknown, or unspecified. // "SOURCE_DERIVATION_MODE_INDEPENDENT" - Produce a completely // independent Source with no base. // "SOURCE_DERIVATION_MODE_CHILD_OF_CURRENT" - Produce a Source based // on the Source being split. // "SOURCE_DERIVATION_MODE_SIBLING_OF_CURRENT" - Produce a Source // based on the base of the Source being split. DerivationMode string `json:"derivationMode,omitempty"` // Source: DEPRECATED Source *Source `json:"source,omitempty"` // ForceSendFields is a list of field names (e.g. "DerivationMode") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` }
SourceSplitShard: DEPRECATED in favor of DerivedSource.
func (*SourceSplitShard) MarshalJSON ¶
func (s *SourceSplitShard) MarshalJSON() ([]byte, error)
type SplitInt64 ¶
type SplitInt64 struct { // HighBits: The high order bits, including the sign: n >> 32. HighBits int64 `json:"highBits,omitempty"` // LowBits: The low order bits: n & 0xffffffff. LowBits int64 `json:"lowBits,omitempty"` // ForceSendFields is a list of field names (e.g. "HighBits") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` }
SplitInt64: A representation of an int64, n, that is immune to precision loss when encoded in JSON.
func (*SplitInt64) MarshalJSON ¶
func (s *SplitInt64) MarshalJSON() ([]byte, error)
type StageSource ¶
type StageSource struct { // Name: Dataflow service generated name for this source. Name string `json:"name,omitempty"` // OriginalTransformOrCollection: User name for the original user // transform or collection with which this // source is most closely associated. OriginalTransformOrCollection string `json:"originalTransformOrCollection,omitempty"` // SizeBytes: Size of the source, if measurable. SizeBytes int64 `json:"sizeBytes,omitempty,string"` // UserName: Human-readable name for this source; may be user or system // generated. UserName string `json:"userName,omitempty"` // ForceSendFields is a list of field names (e.g. "Name") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` }
StageSource: Description of an input or output of an execution stage.
func (*StageSource) MarshalJSON ¶
func (s *StageSource) MarshalJSON() ([]byte, error)
type StateFamilyConfig ¶
type StateFamilyConfig struct { // IsRead: If true, this family corresponds to a read operation. IsRead bool `json:"isRead,omitempty"` // StateFamily: The state family value. StateFamily string `json:"stateFamily,omitempty"` // ForceSendFields is a list of field names (e.g. "IsRead") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` }
StateFamilyConfig: State family configuration.
func (*StateFamilyConfig) MarshalJSON ¶
func (s *StateFamilyConfig) MarshalJSON() ([]byte, error)
type Status ¶
type Status struct { // Code: The status code, which should be an enum value of // google.rpc.Code. Code int64 `json:"code,omitempty"` // Details: A list of messages that carry the error details. There will // be a // common set of message types for APIs to use. Details []StatusDetails `json:"details,omitempty"` // Message: A developer-facing error message, which should be in // English. Any // user-facing error message should be localized and sent in // the // google.rpc.Status.details field, or localized by the client. Message string `json:"message,omitempty"` // ForceSendFields is a list of field names (e.g. "Code") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` }
Status: The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). The error model is designed to be:
- Simple to use and understand for most users - Flexible enough to meet unexpected needs
Overview ¶
The `Status` message contains three pieces of data: error code, error message, and error details. The error code should be an enum value of google.rpc.Code, but it may accept additional error codes if needed. The error message should be a developer-facing English message that helps developers *understand* and *resolve* the error. If a localized user-facing error message is needed, put the localized message in the error details or localize it in the client. The optional error details may contain arbitrary information about the error. There is a predefined set of error detail types in the package `google.rpc` which can be used for common error conditions.
Language mapping ¶
The `Status` message is the logical representation of the error model, but it is not necessarily the actual wire format. When the `Status` message is exposed in different client libraries and different wire protocols, it can be mapped differently. For example, it will likely be mapped to some exceptions in Java, but more likely mapped to some error codes in C.
Other uses ¶
The error model and the `Status` message can be used in a variety of environments, either with or without APIs, to provide a consistent developer experience across different environments.
Example uses of this error model include:
- Partial errors. If a service needs to return partial errors to the client,
it may embed the `Status` in the normal response to indicate the
partial
errors.
- Workflow errors. A typical workflow has multiple steps. Each step may
have a `Status` message for error reporting purpose.
- Batch operations. If a client uses batch request and batch response, the
`Status` message should be used directly inside batch response,
one for
each error sub-response.
- Asynchronous operations. If an API call embeds asynchronous operation
results in its response, the status of those operations should
be
represented directly using the `Status` message.
- Logging. If some API errors are stored in logs, the message `Status` could
be used directly after any stripping needed for security/privacy
reasons.
func (*Status) MarshalJSON ¶
type StatusDetails ¶
type StatusDetails interface{}
type Step ¶
type Step struct { // Kind: The kind of step in the Cloud Dataflow job. Kind string `json:"kind,omitempty"` // Name: The name that identifies the step. This must be unique for // each // step with respect to all other steps in the Cloud Dataflow job. Name string `json:"name,omitempty"` // Properties: Named properties associated with the step. Each kind // of // predefined step has its own required set of properties. // Must be provided on Create. Only retrieved with JOB_VIEW_ALL. Properties StepProperties `json:"properties,omitempty"` // ForceSendFields is a list of field names (e.g. "Kind") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` }
Step: Defines a particular step within a Cloud Dataflow job.
A job consists of multiple steps, each of which performs some specific operation as part of the overall job. Data is typically passed from one step to another as part of the job.
Here's an example of a sequence of steps which together implement a Map-Reduce job:
Read a collection of data from some source, parsing the collection's elements.
Validate the elements.
Apply a user-defined function to map each element to some value and extract an element-specific key value.
Group elements with the same key into a single element with that key, transforming a multiply-keyed collection into a uniquely-keyed collection.
Write the elements out to some data sink.
Note that the Cloud Dataflow service may be used to run many different types of jobs, not just Map-Reduce.
func (*Step) MarshalJSON ¶
type StepProperties ¶
type StepProperties interface{}
type StreamLocation ¶
type StreamLocation struct { // CustomSourceLocation: The stream is a custom source. CustomSourceLocation *CustomSourceLocation `json:"customSourceLocation,omitempty"` // PubsubLocation: The stream is a pubsub stream. PubsubLocation *PubsubLocation `json:"pubsubLocation,omitempty"` // SideInputLocation: The stream is a streaming side input. SideInputLocation *StreamingSideInputLocation `json:"sideInputLocation,omitempty"` // StreamingStageLocation: The stream is part of another computation // within the current // streaming Dataflow job. StreamingStageLocation *StreamingStageLocation `json:"streamingStageLocation,omitempty"` // ForceSendFields is a list of field names (e.g. // "CustomSourceLocation") to unconditionally include in API requests. // By default, fields with empty values are omitted from API requests. // However, any non-pointer, non-interface field appearing in // ForceSendFields will be sent to the server regardless of whether the // field is empty or not. This may be used to include empty fields in // Patch requests. ForceSendFields []string `json:"-"` }
StreamLocation: Describes a stream of data, either as input to be processed or as output of a streaming Dataflow job.
func (*StreamLocation) MarshalJSON ¶
func (s *StreamLocation) MarshalJSON() ([]byte, error)
type StreamingComputationConfig ¶
type StreamingComputationConfig struct { // ComputationId: Unique identifier for this computation. ComputationId string `json:"computationId,omitempty"` // Instructions: Instructions that comprise the computation. Instructions []*ParallelInstruction `json:"instructions,omitempty"` // StageName: Stage name of this computation. StageName string `json:"stageName,omitempty"` // SystemName: System defined name for this computation. SystemName string `json:"systemName,omitempty"` // ForceSendFields is a list of field names (e.g. "ComputationId") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` }
StreamingComputationConfig: Configuration information for a single streaming computation.
func (*StreamingComputationConfig) MarshalJSON ¶
func (s *StreamingComputationConfig) MarshalJSON() ([]byte, error)
type StreamingComputationRanges ¶
type StreamingComputationRanges struct { // ComputationId: The ID of the computation. ComputationId string `json:"computationId,omitempty"` // RangeAssignments: Data disk assignments for ranges from this // computation. RangeAssignments []*KeyRangeDataDiskAssignment `json:"rangeAssignments,omitempty"` // ForceSendFields is a list of field names (e.g. "ComputationId") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` }
StreamingComputationRanges: Describes full or partial data disk assignment information of the computation ranges.
func (*StreamingComputationRanges) MarshalJSON ¶
func (s *StreamingComputationRanges) MarshalJSON() ([]byte, error)
type StreamingComputationTask ¶
type StreamingComputationTask struct { // ComputationRanges: Contains ranges of a streaming computation this // task should apply to. ComputationRanges []*StreamingComputationRanges `json:"computationRanges,omitempty"` // DataDisks: Describes the set of data disks this task should apply to. DataDisks []*MountedDataDisk `json:"dataDisks,omitempty"` // TaskType: A type of streaming computation task. // // Possible values: // "STREAMING_COMPUTATION_TASK_UNKNOWN" - The streaming computation // task is unknown, or unspecified. // "STREAMING_COMPUTATION_TASK_STOP" - Stop processing specified // streaming computation range(s). // "STREAMING_COMPUTATION_TASK_START" - Start processing specified // streaming computation range(s). TaskType string `json:"taskType,omitempty"` // ForceSendFields is a list of field names (e.g. "ComputationRanges") // to unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` }
StreamingComputationTask: A task which describes what action should be performed for the specified streaming computation ranges.
func (*StreamingComputationTask) MarshalJSON ¶
func (s *StreamingComputationTask) MarshalJSON() ([]byte, error)
type StreamingConfigTask ¶
type StreamingConfigTask struct { // StreamingComputationConfigs: Set of computation configuration // information. StreamingComputationConfigs []*StreamingComputationConfig `json:"streamingComputationConfigs,omitempty"` // UserStepToStateFamilyNameMap: Map from user step names to state // families. UserStepToStateFamilyNameMap map[string]string `json:"userStepToStateFamilyNameMap,omitempty"` // ForceSendFields is a list of field names (e.g. // "StreamingComputationConfigs") to unconditionally include in API // requests. By default, fields with empty values are omitted from API // requests. However, any non-pointer, non-interface field appearing in // ForceSendFields will be sent to the server regardless of whether the // field is empty or not. This may be used to include empty fields in // Patch requests. ForceSendFields []string `json:"-"` }
StreamingConfigTask: A task that carries configuration information for streaming computations.
func (*StreamingConfigTask) MarshalJSON ¶
func (s *StreamingConfigTask) MarshalJSON() ([]byte, error)
type StreamingSetupTask ¶
type StreamingSetupTask struct { // Drain: The user has requested drain. Drain bool `json:"drain,omitempty"` // ReceiveWorkPort: The TCP port on which the worker should listen for // messages from // other streaming computation workers. ReceiveWorkPort int64 `json:"receiveWorkPort,omitempty"` // StreamingComputationTopology: The global topology of the streaming // Dataflow job. StreamingComputationTopology *TopologyConfig `json:"streamingComputationTopology,omitempty"` // WorkerHarnessPort: The TCP port used by the worker to communicate // with the Dataflow // worker harness. WorkerHarnessPort int64 `json:"workerHarnessPort,omitempty"` // ForceSendFields is a list of field names (e.g. "Drain") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` }
StreamingSetupTask: A task which initializes part of a streaming Dataflow job.
func (*StreamingSetupTask) MarshalJSON ¶
func (s *StreamingSetupTask) MarshalJSON() ([]byte, error)
type StreamingSideInputLocation ¶
type StreamingSideInputLocation struct { // StateFamily: Identifies the state family where this side input is // stored. StateFamily string `json:"stateFamily,omitempty"` // Tag: Identifies the particular side input within the streaming // Dataflow job. Tag string `json:"tag,omitempty"` // ForceSendFields is a list of field names (e.g. "StateFamily") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` }
StreamingSideInputLocation: Identifies the location of a streaming side input.
func (*StreamingSideInputLocation) MarshalJSON ¶
func (s *StreamingSideInputLocation) MarshalJSON() ([]byte, error)
type StreamingStageLocation ¶
type StreamingStageLocation struct { // StreamId: Identifies the particular stream within the streaming // Dataflow // job. StreamId string `json:"streamId,omitempty"` // ForceSendFields is a list of field names (e.g. "StreamId") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` }
StreamingStageLocation: Identifies the location of a streaming computation stage, for stage-to-stage communication.
func (*StreamingStageLocation) MarshalJSON ¶
func (s *StreamingStageLocation) MarshalJSON() ([]byte, error)
type StringList ¶
type StringList struct { // Elements: Elements of the list. Elements []string `json:"elements,omitempty"` // ForceSendFields is a list of field names (e.g. "Elements") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` }
StringList: A metric value representing a list of strings.
func (*StringList) MarshalJSON ¶
func (s *StringList) MarshalJSON() ([]byte, error)
type TaskRunnerSettings ¶
type TaskRunnerSettings struct { // Alsologtostderr: Whether to also send taskrunner log info to stderr. Alsologtostderr bool `json:"alsologtostderr,omitempty"` // BaseTaskDir: The location on the worker for task-specific // subdirectories. BaseTaskDir string `json:"baseTaskDir,omitempty"` // BaseUrl: The base URL for the taskrunner to use when accessing Google // Cloud APIs. // // When workers access Google Cloud APIs, they logically do so // via // relative URLs. If this field is specified, it supplies the base // URL to use for resolving these relative URLs. The // normative // algorithm used is defined by RFC 1808, "Relative Uniform // Resource // Locators". // // If not specified, the default value is "http://www.googleapis.com/" BaseUrl string `json:"baseUrl,omitempty"` // CommandlinesFileName: The file to store preprocessing commands in. CommandlinesFileName string `json:"commandlinesFileName,omitempty"` // ContinueOnException: Whether to continue taskrunner if an exception // is hit. ContinueOnException bool `json:"continueOnException,omitempty"` // DataflowApiVersion: The API version of endpoint, e.g. "v1b3" DataflowApiVersion string `json:"dataflowApiVersion,omitempty"` // HarnessCommand: The command to launch the worker harness. HarnessCommand string `json:"harnessCommand,omitempty"` // LanguageHint: The suggested backend language. LanguageHint string `json:"languageHint,omitempty"` // LogDir: The directory on the VM to store logs. LogDir string `json:"logDir,omitempty"` // LogToSerialconsole: Whether to send taskrunner log info to Google // Compute Engine VM serial // console. LogToSerialconsole bool `json:"logToSerialconsole,omitempty"` // LogUploadLocation: Indicates where to put logs. If this is not // specified, the logs // will not be uploaded. // // The supported resource type is: // // Google Cloud Storage: // storage.googleapis.com/{bucket}/{object} // bucket.storage.googleapis.com/{object} LogUploadLocation string `json:"logUploadLocation,omitempty"` // OauthScopes: The OAuth2 scopes to be requested by the taskrunner in // order to // access the Cloud Dataflow API. OauthScopes []string `json:"oauthScopes,omitempty"` // ParallelWorkerSettings: The settings to pass to the parallel worker // harness. ParallelWorkerSettings *WorkerSettings `json:"parallelWorkerSettings,omitempty"` // StreamingWorkerMainClass: The streaming worker main class name. StreamingWorkerMainClass string `json:"streamingWorkerMainClass,omitempty"` // TaskGroup: The UNIX group ID on the worker VM to use for tasks // launched by // taskrunner; e.g. "wheel". TaskGroup string `json:"taskGroup,omitempty"` // TaskUser: The UNIX user ID on the worker VM to use for tasks launched // by // taskrunner; e.g. "root". TaskUser string `json:"taskUser,omitempty"` // TempStoragePrefix: The prefix of the resources the taskrunner should // use for // temporary storage. // // The supported resource type is: // // Google Cloud Storage: // storage.googleapis.com/{bucket}/{object} // bucket.storage.googleapis.com/{object} TempStoragePrefix string `json:"tempStoragePrefix,omitempty"` // VmId: The ID string of the VM. VmId string `json:"vmId,omitempty"` // WorkflowFileName: The file to store the workflow in. WorkflowFileName string `json:"workflowFileName,omitempty"` // ForceSendFields is a list of field names (e.g. "Alsologtostderr") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` }
TaskRunnerSettings: Taskrunner configuration settings.
func (*TaskRunnerSettings) MarshalJSON ¶
func (s *TaskRunnerSettings) MarshalJSON() ([]byte, error)
type TemplateMetadata ¶
type TemplateMetadata struct { // BypassTempDirValidation: If true, will bypass the validation that the // temp directory is // writable. This should only be used with templates for pipelines // that are guaranteed not to need to write to the temp directory, // which is subject to change based on the optimizer. BypassTempDirValidation bool `json:"bypassTempDirValidation,omitempty"` // Description: Optional. A description of the template. Description string `json:"description,omitempty"` // Name: Required. The name of the template. Name string `json:"name,omitempty"` // Parameters: The parameters for the template. Parameters []*ParameterMetadata `json:"parameters,omitempty"` // ForceSendFields is a list of field names (e.g. // "BypassTempDirValidation") to unconditionally include in API // requests. By default, fields with empty values are omitted from API // requests. However, any non-pointer, non-interface field appearing in // ForceSendFields will be sent to the server regardless of whether the // field is empty or not. This may be used to include empty fields in // Patch requests. ForceSendFields []string `json:"-"` }
TemplateMetadata: Metadata describing a template.
func (*TemplateMetadata) MarshalJSON ¶
func (s *TemplateMetadata) MarshalJSON() ([]byte, error)
type TopologyConfig ¶
type TopologyConfig struct { // Computations: The computations associated with a streaming Dataflow // job. Computations []*ComputationTopology `json:"computations,omitempty"` // DataDiskAssignments: The disks assigned to a streaming Dataflow job. DataDiskAssignments []*DataDiskAssignment `json:"dataDiskAssignments,omitempty"` // ForwardingKeyBits: The size (in bits) of keys that will be assigned // to source messages. ForwardingKeyBits int64 `json:"forwardingKeyBits,omitempty"` // PersistentStateVersion: Version number for persistent state. PersistentStateVersion int64 `json:"persistentStateVersion,omitempty"` // UserStageToComputationNameMap: Maps user stage names to stable // computation names. UserStageToComputationNameMap map[string]string `json:"userStageToComputationNameMap,omitempty"` // ForceSendFields is a list of field names (e.g. "Computations") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` }
TopologyConfig: Global topology of the streaming Dataflow job, including all computations and their sharded locations.
func (*TopologyConfig) MarshalJSON ¶
func (s *TopologyConfig) MarshalJSON() ([]byte, error)
type TransformSummary ¶
type TransformSummary struct { // DisplayData: Transform-specific display data. DisplayData []*DisplayData `json:"displayData,omitempty"` // Id: SDK generated id of this transform instance. Id string `json:"id,omitempty"` // InputCollectionName: User names for all collection inputs to this // transform. InputCollectionName []string `json:"inputCollectionName,omitempty"` // Kind: Type of transform. // // Possible values: // "UNKNOWN_KIND" - Unrecognized transform type. // "PAR_DO_KIND" - ParDo transform. // "GROUP_BY_KEY_KIND" - Group By Key transform. // "FLATTEN_KIND" - Flatten transform. // "READ_KIND" - Read transform. // "WRITE_KIND" - Write transform. // "CONSTANT_KIND" - Constructs from a constant value, such as with // Create.of. // "SINGLETON_KIND" - Creates a Singleton view of a collection. // "SHUFFLE_KIND" - Opening or closing a shuffle session, often as // part of a GroupByKey. Kind string `json:"kind,omitempty"` // Name: User provided name for this transform instance. Name string `json:"name,omitempty"` // OutputCollectionName: User names for all collection outputs to this // transform. OutputCollectionName []string `json:"outputCollectionName,omitempty"` // ForceSendFields is a list of field names (e.g. "DisplayData") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` }
TransformSummary: Description of the type, names/ids, and input/outputs for a transform.
func (*TransformSummary) MarshalJSON ¶
func (s *TransformSummary) MarshalJSON() ([]byte, error)
type WorkItem ¶
type WorkItem struct { // Configuration: Work item-specific configuration as an opaque blob. Configuration string `json:"configuration,omitempty"` // Id: Identifies this WorkItem. Id int64 `json:"id,omitempty,string"` // InitialReportIndex: The initial index to use when reporting the // status of the WorkItem. InitialReportIndex int64 `json:"initialReportIndex,omitempty,string"` // JobId: Identifies the workflow job this WorkItem belongs to. JobId string `json:"jobId,omitempty"` // LeaseExpireTime: Time when the lease on this Work will expire. LeaseExpireTime string `json:"leaseExpireTime,omitempty"` // MapTask: Additional information for MapTask WorkItems. MapTask *MapTask `json:"mapTask,omitempty"` // Packages: Any required packages that need to be fetched in order to // execute // this WorkItem. Packages []*Package `json:"packages,omitempty"` // ProjectId: Identifies the cloud project this WorkItem belongs to. ProjectId string `json:"projectId,omitempty"` // ReportStatusInterval: Recommended reporting interval. ReportStatusInterval string `json:"reportStatusInterval,omitempty"` // SeqMapTask: Additional information for SeqMapTask WorkItems. SeqMapTask *SeqMapTask `json:"seqMapTask,omitempty"` // ShellTask: Additional information for ShellTask WorkItems. ShellTask *ShellTask `json:"shellTask,omitempty"` // SourceOperationTask: Additional information for source operation // WorkItems. SourceOperationTask *SourceOperationRequest `json:"sourceOperationTask,omitempty"` // StreamingComputationTask: Additional information for // StreamingComputationTask WorkItems. StreamingComputationTask *StreamingComputationTask `json:"streamingComputationTask,omitempty"` // StreamingConfigTask: Additional information for StreamingConfigTask // WorkItems. StreamingConfigTask *StreamingConfigTask `json:"streamingConfigTask,omitempty"` // StreamingSetupTask: Additional information for StreamingSetupTask // WorkItems. StreamingSetupTask *StreamingSetupTask `json:"streamingSetupTask,omitempty"` // ForceSendFields is a list of field names (e.g. "Configuration") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` }
WorkItem: WorkItem represents basic information about a WorkItem to be executed in the cloud.
func (*WorkItem) MarshalJSON ¶
type WorkItemServiceState ¶
type WorkItemServiceState struct { // HarnessData: Other data returned by the service, specific to the // particular // worker harness. HarnessData WorkItemServiceStateHarnessData `json:"harnessData,omitempty"` // LeaseExpireTime: Time at which the current lease will expire. LeaseExpireTime string `json:"leaseExpireTime,omitempty"` // MetricShortId: The short ids that workers should use in subsequent // metric updates. // Workers should strive to use short ids whenever possible, but it is // ok // to request the short_id again if a worker lost track of it // (e.g. if the worker is recovering from a crash). // NOTE: it is possible that the response may have short ids for a // subset // of the metrics. MetricShortId []*MetricShortId `json:"metricShortId,omitempty"` // NextReportIndex: The index value to use for the next report sent by // the worker. // Note: If the report call fails for whatever reason, the worker // should // reuse this index for subsequent report attempts. NextReportIndex int64 `json:"nextReportIndex,omitempty,string"` // ReportStatusInterval: New recommended reporting interval. ReportStatusInterval string `json:"reportStatusInterval,omitempty"` // SplitRequest: The progress point in the WorkItem where the Dataflow // service // suggests that the worker truncate the task. SplitRequest *ApproximateSplitRequest `json:"splitRequest,omitempty"` // SuggestedStopPoint: DEPRECATED in favor of split_request. SuggestedStopPoint *ApproximateProgress `json:"suggestedStopPoint,omitempty"` // SuggestedStopPosition: Obsolete, always empty. SuggestedStopPosition *Position `json:"suggestedStopPosition,omitempty"` // ForceSendFields is a list of field names (e.g. "HarnessData") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` }
WorkItemServiceState: The Dataflow service's idea of the current state of a WorkItem being processed by a worker.
func (*WorkItemServiceState) MarshalJSON ¶
func (s *WorkItemServiceState) MarshalJSON() ([]byte, error)
type WorkItemServiceStateHarnessData ¶
type WorkItemServiceStateHarnessData interface{}
type WorkItemStatus ¶
type WorkItemStatus struct { // Completed: True if the WorkItem was completed (successfully or // unsuccessfully). Completed bool `json:"completed,omitempty"` // CounterUpdates: Worker output counters for this WorkItem. CounterUpdates []*CounterUpdate `json:"counterUpdates,omitempty"` // DynamicSourceSplit: See documentation of stop_position. DynamicSourceSplit *DynamicSourceSplit `json:"dynamicSourceSplit,omitempty"` // Errors: Specifies errors which occurred during processing. If errors // are // provided, and completed = true, then the WorkItem is considered // to have failed. Errors []*Status `json:"errors,omitempty"` // MetricUpdates: DEPRECATED in favor of counter_updates. MetricUpdates []*MetricUpdate `json:"metricUpdates,omitempty"` // Progress: DEPRECATED in favor of reported_progress. Progress *ApproximateProgress `json:"progress,omitempty"` // ReportIndex: The report index. When a WorkItem is leased, the lease // will // contain an initial report index. When a WorkItem's status // is // reported to the system, the report should be sent with // that report index, and the response will contain the index the // worker should use for the next report. Reports received // with // unexpected index values will be rejected by the service. // // In order to preserve idempotency, the worker should not alter // the // contents of a report, even if the worker must submit the same // report multiple times before getting back a response. The // worker // should not submit a subsequent report until the response for // the // previous report had been received from the service. ReportIndex int64 `json:"reportIndex,omitempty,string"` // ReportedProgress: The worker's progress through this WorkItem. ReportedProgress *ApproximateReportedProgress `json:"reportedProgress,omitempty"` // RequestedLeaseDuration: Amount of time the worker requests for its // lease. RequestedLeaseDuration string `json:"requestedLeaseDuration,omitempty"` // SourceFork: DEPRECATED in favor of dynamic_source_split. SourceFork *SourceFork `json:"sourceFork,omitempty"` // SourceOperationResponse: If the work item represented a // SourceOperationRequest, and the work // is completed, contains the result of the operation. SourceOperationResponse *SourceOperationResponse `json:"sourceOperationResponse,omitempty"` // StopPosition: A worker may split an active map task in two parts, // "primary" and // "residual", continuing to process the primary part and returning // the // residual part into the pool of available work. // This event is called a "dynamic split" and is critical to the // dynamic // work rebalancing feature. The two obtained sub-tasks are // called // "parts" of the split. // The parts, if concatenated, must represent the same input as would // be read by the current task if the split did not happen. // The exact way in which the original task is decomposed into the // two // parts is specified either as a position demarcating // them // (stop_position), or explicitly as two DerivedSources, if this // task consumes a user-defined source type (dynamic_source_split). // // The "current" task is adjusted as a result of the split: after a // task // with range [A, B) sends a stop_position update at C, its range // is // considered to be [A, C), e.g.: // * Progress should be interpreted relative to the new range, e.g. // "75% completed" means "75% of [A, C) completed" // * The worker should interpret proposed_stop_position relative to the // new range, e.g. "split at 68%" should be interpreted as // "split at 68% of [A, C)". // * If the worker chooses to split again using stop_position, only // stop_positions in [A, C) will be accepted. // * Etc. // dynamic_source_split has similar semantics: e.g., if a task // with // source S splits using dynamic_source_split into {P, R} // (where P and R must be together equivalent to S), then // subsequent // progress and proposed_stop_position should be interpreted relative // to P, and in a potential subsequent dynamic_source_split into {P', // R'}, // P' and R' must be together equivalent to P, etc. StopPosition *Position `json:"stopPosition,omitempty"` // WorkItemId: Identifies the WorkItem. WorkItemId string `json:"workItemId,omitempty"` // ForceSendFields is a list of field names (e.g. "Completed") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` }
WorkItemStatus: Conveys a worker's progress through the work described by a WorkItem.
func (*WorkItemStatus) MarshalJSON ¶
func (s *WorkItemStatus) MarshalJSON() ([]byte, error)
type WorkerHealthReport ¶
type WorkerHealthReport struct { // Pods: The pods running on the worker. // See: // http://kubernetes.io/v1.1/docs/api-reference/v1/definitions.html# // _v1_pod // // This field is used by the worker to send the status of the // indvidual // containers running on each worker. Pods []WorkerHealthReportPods `json:"pods,omitempty"` // ReportInterval: The interval at which the worker is sending health // reports. // The default value of 0 should be interpreted as the field is not // being // explicitly set by the worker. ReportInterval string `json:"reportInterval,omitempty"` // VmIsHealthy: Whether the VM is healthy. VmIsHealthy bool `json:"vmIsHealthy,omitempty"` // VmStartupTime: The time the VM was booted. VmStartupTime string `json:"vmStartupTime,omitempty"` // ForceSendFields is a list of field names (e.g. "Pods") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` }
WorkerHealthReport: WorkerHealthReport contains information about the health of a worker.
The VM should be identified by the labels attached to the WorkerMessage that this health ping belongs to.
func (*WorkerHealthReport) MarshalJSON ¶
func (s *WorkerHealthReport) MarshalJSON() ([]byte, error)
type WorkerHealthReportPods ¶
type WorkerHealthReportPods interface{}
type WorkerHealthReportResponse ¶
type WorkerHealthReportResponse struct { // ReportInterval: A positive value indicates the worker should change // its reporting interval // to the specified value. // // The default value of zero means no change in report rate is requested // by // the server. ReportInterval string `json:"reportInterval,omitempty"` // ForceSendFields is a list of field names (e.g. "ReportInterval") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` }
WorkerHealthReportResponse: WorkerHealthReportResponse contains information returned to the worker in response to a health ping.
func (*WorkerHealthReportResponse) MarshalJSON ¶
func (s *WorkerHealthReportResponse) MarshalJSON() ([]byte, error)
type WorkerMessage ¶
type WorkerMessage struct { // Labels: Labels are used to group WorkerMessages. // For example, a worker_message about a particular container // might have the labels: // { "JOB_ID": "2015-04-22", // "WORKER_ID": "wordcount-vm-2015…" // "CONTAINER_TYPE": "worker", // "CONTAINER_ID": "ac1234def"} // Label tags typically correspond to Label enum values. However, for // ease // of development other strings can be used as tags. LABEL_UNSPECIFIED // should // not be used here. Labels map[string]string `json:"labels,omitempty"` // Time: The timestamp of the worker_message. Time string `json:"time,omitempty"` // WorkerHealthReport: The health of a worker. WorkerHealthReport *WorkerHealthReport `json:"workerHealthReport,omitempty"` // WorkerMessageCode: A worker message code. WorkerMessageCode *WorkerMessageCode `json:"workerMessageCode,omitempty"` // WorkerMetrics: Resource metrics reported by workers. WorkerMetrics *ResourceUtilizationReport `json:"workerMetrics,omitempty"` // ForceSendFields is a list of field names (e.g. "Labels") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` }
WorkerMessage: WorkerMessage provides information to the backend about a worker.
func (*WorkerMessage) MarshalJSON ¶
func (s *WorkerMessage) MarshalJSON() ([]byte, error)
type WorkerMessageCode ¶
type WorkerMessageCode struct { // Code: The code is a string intended for consumption by a machine that // identifies // the type of message being sent. // Examples: // 1. "HARNESS_STARTED" might be used to indicate the worker harness // has // started. // 2. "GCS_DOWNLOAD_ERROR" might be used to indicate an error // downloading // a GCS file as part of the boot process of one of the worker // containers. // // This is a string and not an enum to make it easy to add new codes // without // waiting for an API change. Code string `json:"code,omitempty"` // Parameters: Parameters contains specific information about the // code. // // This is a struct to allow parameters of different types. // // Examples: // 1. For a "HARNESS_STARTED" message parameters might provide the // name // of the worker and additional data like timing information. // 2. For a "GCS_DOWNLOAD_ERROR" parameters might contain fields // listing // the GCS objects being downloaded and fields containing // errors. // // In general complex data structures should be avoided. If a // worker // needs to send a specific and complicated data structure then // please // consider defining a new proto and adding it to the data oneof // in // WorkerMessageResponse. // // Conventions: // Parameters should only be used for information that isn't typically // passed // as a label. // hostname and other worker identifiers should almost always be // passed // as labels since they will be included on most messages. Parameters WorkerMessageCodeParameters `json:"parameters,omitempty"` // ForceSendFields is a list of field names (e.g. "Code") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` }
WorkerMessageCode: A message code is used to report status and error messages to the service. The message codes are intended to be machine readable. The service will take care of translating these into user understandable messages if necessary.
Example use cases:
- Worker processes reporting successful startup.
- Worker processes reporting specific errors (e.g. package
staging
failure).
func (*WorkerMessageCode) MarshalJSON ¶
func (s *WorkerMessageCode) MarshalJSON() ([]byte, error)
type WorkerMessageCodeParameters ¶
type WorkerMessageCodeParameters interface{}
type WorkerMessageResponse ¶
type WorkerMessageResponse struct { // WorkerHealthReportResponse: The service's response to a worker's // health report. WorkerHealthReportResponse *WorkerHealthReportResponse `json:"workerHealthReportResponse,omitempty"` // WorkerMetricsResponse: Service's response to reporting worker metrics // (currently empty). WorkerMetricsResponse *ResourceUtilizationReportResponse `json:"workerMetricsResponse,omitempty"` // ForceSendFields is a list of field names (e.g. // "WorkerHealthReportResponse") to unconditionally include in API // requests. By default, fields with empty values are omitted from API // requests. However, any non-pointer, non-interface field appearing in // ForceSendFields will be sent to the server regardless of whether the // field is empty or not. This may be used to include empty fields in // Patch requests. ForceSendFields []string `json:"-"` }
WorkerMessageResponse: A worker_message response allows the server to pass information to the sender.
func (*WorkerMessageResponse) MarshalJSON ¶
func (s *WorkerMessageResponse) MarshalJSON() ([]byte, error)
type WorkerPool ¶
type WorkerPool struct { // AutoscalingSettings: Settings for autoscaling of this WorkerPool. AutoscalingSettings *AutoscalingSettings `json:"autoscalingSettings,omitempty"` // DataDisks: Data disks that are used by a VM in this workflow. DataDisks []*Disk `json:"dataDisks,omitempty"` // DefaultPackageSet: The default package set to install. This allows // the service to // select a default set of packages which are useful to worker // harnesses written in a particular language. // // Possible values: // "DEFAULT_PACKAGE_SET_UNKNOWN" - The default set of packages to // stage is unknown, or unspecified. // "DEFAULT_PACKAGE_SET_NONE" - Indicates that no packages should be // staged at the worker unless // explicitly specified by the job. // "DEFAULT_PACKAGE_SET_JAVA" - Stage packages typically useful to // workers written in Java. // "DEFAULT_PACKAGE_SET_PYTHON" - Stage pacakges typically useful to // workers written in Python. DefaultPackageSet string `json:"defaultPackageSet,omitempty"` // DiskSizeGb: Size of root disk for VMs, in GB. If zero or // unspecified, the service will // attempt to choose a reasonable default. DiskSizeGb int64 `json:"diskSizeGb,omitempty"` // DiskSourceImage: Fully qualified source image for disks. DiskSourceImage string `json:"diskSourceImage,omitempty"` // DiskType: Type of root disk for VMs. If empty or unspecified, the // service will // attempt to choose a reasonable default. DiskType string `json:"diskType,omitempty"` // IpConfiguration: Configuration for VM IPs. // // Possible values: // "WORKER_IP_UNSPECIFIED" - The configuration is unknown, or // unspecified. // "WORKER_IP_PUBLIC" - Workers should have public IP addresses. // "WORKER_IP_PRIVATE" - Workers should have private IP addresses. IpConfiguration string `json:"ipConfiguration,omitempty"` // Kind: The kind of the worker pool; currently only `harness` and // `shuffle` // are supported. Kind string `json:"kind,omitempty"` // MachineType: Machine type (e.g. "n1-standard-1"). If empty or // unspecified, the // service will attempt to choose a reasonable default. MachineType string `json:"machineType,omitempty"` // Metadata: Metadata to set on the Google Compute Engine VMs. Metadata map[string]string `json:"metadata,omitempty"` // Network: Network to which VMs will be assigned. If empty or // unspecified, // the service will use the network "default". Network string `json:"network,omitempty"` // NumThreadsPerWorker: The number of threads per worker harness. If // empty or unspecified, the // service will choose a number of threads (according to the number of // cores // on the selected machine type for batch, or 1 by convention for // streaming). NumThreadsPerWorker int64 `json:"numThreadsPerWorker,omitempty"` // NumWorkers: Number of Google Compute Engine workers in this pool // needed to // execute the job. If zero or unspecified, the service will // attempt to choose a reasonable default. NumWorkers int64 `json:"numWorkers,omitempty"` // OnHostMaintenance: The action to take on host maintenance, as defined // by the Google // Compute Engine API. OnHostMaintenance string `json:"onHostMaintenance,omitempty"` // Packages: Packages to be installed on workers. Packages []*Package `json:"packages,omitempty"` // PoolArgs: Extra arguments for this worker pool. PoolArgs WorkerPoolPoolArgs `json:"poolArgs,omitempty"` // Subnetwork: Subnetwork to which VMs will be assigned, if desired. // Expected to be of // the form "regions/REGION/subnetworks/SUBNETWORK". Subnetwork string `json:"subnetwork,omitempty"` // TaskrunnerSettings: Settings passed through to Google Compute Engine // workers when // using the standard Dataflow task runner. Users should ignore // this field. TaskrunnerSettings *TaskRunnerSettings `json:"taskrunnerSettings,omitempty"` // TeardownPolicy: Sets the policy for determining when to turndown // worker pool. // Allowed values are: `TEARDOWN_ALWAYS`, `TEARDOWN_ON_SUCCESS`, // and // `TEARDOWN_NEVER`. // `TEARDOWN_ALWAYS` means workers are always torn down regardless of // whether // the job succeeds. `TEARDOWN_ON_SUCCESS` means workers are torn // down // if the job succeeds. `TEARDOWN_NEVER` means the workers are never // torn // down. // // If the workers are not torn down by the service, they will // continue to run and use Google Compute Engine VM resources in // the // user's project until they are explicitly terminated by the // user. // Because of this, Google recommends using the `TEARDOWN_ALWAYS` // policy except for small, manually supervised test jobs. // // If unknown or unspecified, the service will attempt to choose a // reasonable // default. // // Possible values: // "TEARDOWN_POLICY_UNKNOWN" - The teardown policy isn't specified, or // is unknown. // "TEARDOWN_ALWAYS" - Always teardown the resource. // "TEARDOWN_ON_SUCCESS" - Teardown the resource on success. This is // useful for debugging // failures. // "TEARDOWN_NEVER" - Never teardown the resource. This is useful for // debugging and // development. TeardownPolicy string `json:"teardownPolicy,omitempty"` // WorkerHarnessContainerImage: Required. Docker container image that // executes the Cloud Dataflow worker // harness, residing in Google Container Registry. WorkerHarnessContainerImage string `json:"workerHarnessContainerImage,omitempty"` // Zone: Zone to run the worker pools in. If empty or unspecified, the // service // will attempt to choose a reasonable default. Zone string `json:"zone,omitempty"` // ForceSendFields is a list of field names (e.g. "AutoscalingSettings") // to unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` }
WorkerPool: Describes one particular pool of Cloud Dataflow workers to be instantiated by the Cloud Dataflow service in order to perform the computations required by a job. Note that a workflow job may use multiple pools, in order to match the various computational requirements of the various stages of the job.
func (*WorkerPool) MarshalJSON ¶
func (s *WorkerPool) MarshalJSON() ([]byte, error)
type WorkerPoolPoolArgs ¶
type WorkerPoolPoolArgs interface{}
type WorkerSettings ¶
type WorkerSettings struct { // BaseUrl: The base URL for accessing Google Cloud APIs. // // When workers access Google Cloud APIs, they logically do so // via // relative URLs. If this field is specified, it supplies the base // URL to use for resolving these relative URLs. The // normative // algorithm used is defined by RFC 1808, "Relative Uniform // Resource // Locators". // // If not specified, the default value is "http://www.googleapis.com/" BaseUrl string `json:"baseUrl,omitempty"` // ReportingEnabled: Whether to send work progress updates to the // service. ReportingEnabled bool `json:"reportingEnabled,omitempty"` // ServicePath: The Cloud Dataflow service path relative to the root // URL, for example, // "dataflow/v1b3/projects". ServicePath string `json:"servicePath,omitempty"` // ShuffleServicePath: The Shuffle service path relative to the root // URL, for example, // "shuffle/v1beta1". ShuffleServicePath string `json:"shuffleServicePath,omitempty"` // TempStoragePrefix: The prefix of the resources the system should use // for temporary // storage. // // The supported resource type is: // // Google Cloud Storage: // // storage.googleapis.com/{bucket}/{object} // bucket.storage.googleapis.com/{object} TempStoragePrefix string `json:"tempStoragePrefix,omitempty"` // WorkerId: The ID of the worker running this pipeline. WorkerId string `json:"workerId,omitempty"` // ForceSendFields is a list of field names (e.g. "BaseUrl") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` }
WorkerSettings: Provides data to pass through to the worker harness.
func (*WorkerSettings) MarshalJSON ¶
func (s *WorkerSettings) MarshalJSON() ([]byte, error)
type WriteInstruction ¶
type WriteInstruction struct { // Input: The input. Input *InstructionInput `json:"input,omitempty"` // Sink: The sink to write to. Sink *Sink `json:"sink,omitempty"` // ForceSendFields is a list of field names (e.g. "Input") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` }
WriteInstruction: An instruction that writes records. Takes one input, produces no outputs.
func (*WriteInstruction) MarshalJSON ¶
func (s *WriteInstruction) MarshalJSON() ([]byte, error)