datapipelines

package
v0.214.0 Latest Latest
Warning

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

 Go to latest Published: Dec 19, 2024 License: BSD-3-Clause Imports: 18 Imported by: 0

Documentation

Overview

Package datapipelines provides access to the Data pipelines API.

For product documentation, see: https://cloud.google.com/dataflow/docs/guides/data-pipelines

Library status

These client libraries are officially supported by Google. However, this library is considered complete and is in maintenance mode. This means that we will address critical bugs and security issues but will not add any new features.

When possible, we recommend using our newer [Cloud Client Libraries for Go](https://pkg.go.dev/cloud.google.com/go) that are still actively being worked and iterated on.

Creating a client

Usage example: 

import "google.golang.org/api/datapipelines/v1"
...
ctx := context.Background()
datapipelinesService, err := datapipelines.NewService(ctx)

In this example, Google Application Default Credentials are used for authentication. For information on how to create and obtain Application Default Credentials, see https://developers.google.com/identity/protocols/application-default-credentials.

Other authentication options

To use an API key for authentication (note: some APIs do not support API keys), use google.golang.org/api/option.WithAPIKey: 

datapipelinesService, err := datapipelines.NewService(ctx, option.WithAPIKey("AIza..."))

To use an OAuth token (e.g., a user token obtained via a three-legged OAuth flow, use google.golang.org/api/option.WithTokenSource: 

config := &oauth2.Config{...}
// ...
token, err := config.Exchange(ctx, ...)
datapipelinesService, err := datapipelines.NewService(ctx, option.WithTokenSource(config.TokenSource(ctx, token)))

See google.golang.org/api/option.ClientOption for details on options.

Index

Constants

View Source 
const (
	// See, edit, configure, and delete your Google Cloud data and see the email
	// address for your Google Account.
	CloudPlatformScope = "https://www.googleapis.com/auth/cloud-platform"
)

OAuth2 scopes used by this API.

Variables

This section is empty.

Functions

This section is empty.

Types

type GoogleCloudDatapipelinesV1DataflowJobDetails 

type GoogleCloudDatapipelinesV1DataflowJobDetails struct {
	// CurrentWorkers: Output only. The current number of workers used to run the
	// jobs. Only set to a value if the job is still running.
	CurrentWorkers int64 `json:"currentWorkers,omitempty"`
	// ResourceInfo: Cached version of all the metrics of interest for the job.
	// This value gets stored here when the job is terminated. As long as the job
	// is running, this field is populated from the Dataflow API.
	ResourceInfo map[string]float64 `json:"resourceInfo,omitempty"`
	// SdkVersion: Output only. The SDK version used to run the job.
	SdkVersion *GoogleCloudDatapipelinesV1SdkVersion `json:"sdkVersion,omitempty"`
	// ForceSendFields is a list of field names (e.g. "CurrentWorkers") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "CurrentWorkers") to include in
	// API requests with the JSON null value. By default, fields with empty values
	// are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

GoogleCloudDatapipelinesV1DataflowJobDetails: Pipeline job details specific to the Dataflow API. This is encapsulated here to allow for more executors to store their specific details separately.

func (GoogleCloudDatapipelinesV1DataflowJobDetails) MarshalJSON 

func (s GoogleCloudDatapipelinesV1DataflowJobDetails) MarshalJSON() ([]byte, error)

type GoogleCloudDatapipelinesV1FlexTemplateRuntimeEnvironment 

type GoogleCloudDatapipelinesV1FlexTemplateRuntimeEnvironment struct {
	// AdditionalExperiments: Additional experiment flags for the job.
	AdditionalExperiments []string `json:"additionalExperiments,omitempty"`
	// AdditionalUserLabels: Additional user labels to be specified for the job.
	// Keys and values must follow the restrictions specified in the labeling
	// restrictions
	// (https://cloud.google.com/compute/docs/labeling-resources#restrictions). An
	// object containing a list of key/value pairs. Example: `{ "name": "wrench",
	// "mass": "1kg", "count": "3" }`.
	AdditionalUserLabels map[string]string `json:"additionalUserLabels,omitempty"`
	// EnableStreamingEngine: Whether to enable Streaming Engine for the job.
	EnableStreamingEngine bool `json:"enableStreamingEngine,omitempty"`
	// FlexrsGoal: Set FlexRS goal for the job.
	// https://cloud.google.com/dataflow/docs/guides/flexrs
	//
	// Possible values:
	//   "FLEXRS_UNSPECIFIED" - Run in the default mode.
	//   "FLEXRS_SPEED_OPTIMIZED" - Optimize for lower execution time.
	//   "FLEXRS_COST_OPTIMIZED" - Optimize for lower cost.
	FlexrsGoal string `json:"flexrsGoal,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"`
	// KmsKeyName: Name for the Cloud KMS key for the job. Key format is:
	// projects//locations//keyRings//cryptoKeys/
	KmsKeyName string `json:"kmsKeyName,omitempty"`
	// MachineType: The machine type to use for the job. Defaults to the value from
	// the template if not specified.
	MachineType string `json:"machineType,omitempty"`
	// MaxWorkers: The maximum number of Compute Engine instances to be made
	// available to your pipeline during execution, from 1 to 1000.
	MaxWorkers int64 `json:"maxWorkers,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"`
	// NumWorkers: The initial number of Compute Engine instances for the job.
	NumWorkers int64 `json:"numWorkers,omitempty"`
	// ServiceAccountEmail: The email address of the service account to run the job
	// as.
	ServiceAccountEmail string `json:"serviceAccountEmail,omitempty"`
	// Subnetwork: Subnetwork to which VMs will be assigned, if desired. You can
	// specify a subnetwork using either a complete URL or an abbreviated path.
	// Expected to be of the form
	// "https://www.googleapis.com/compute/v1/projects/HOST_PROJECT_ID/regions/REGIO
	// N/subnetworks/SUBNETWORK" or "regions/REGION/subnetworks/SUBNETWORK". If the
	// subnetwork is located in a Shared VPC network, you must use the complete
	// URL.
	Subnetwork string `json:"subnetwork,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"`
	// WorkerRegion: The Compute Engine region
	// (https://cloud.google.com/compute/docs/regions-zones/regions-zones) in which
	// worker processing should occur, e.g. "us-west1". Mutually exclusive with
	// worker_zone. If neither worker_region nor worker_zone is specified, defaults
	// to the control plane region.
	WorkerRegion string `json:"workerRegion,omitempty"`
	// WorkerZone: The Compute Engine zone
	// (https://cloud.google.com/compute/docs/regions-zones/regions-zones) in which
	// worker processing should occur, e.g. "us-west1-a". Mutually exclusive with
	// worker_region. If neither worker_region nor worker_zone is specified, a zone
	// in the control plane region is chosen based on available capacity. If both
	// `worker_zone` and `zone` are set, `worker_zone` takes precedence.
	WorkerZone string `json:"workerZone,omitempty"`
	// Zone: The Compute Engine availability zone
	// (https://cloud.google.com/compute/docs/regions-zones/regions-zones) for
	// launching worker instances to run your pipeline. In the future, worker_zone
	// will take precedence.
	Zone string `json:"zone,omitempty"`
	// ForceSendFields is a list of field names (e.g. "AdditionalExperiments") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "AdditionalExperiments") to
	// include in API requests with the JSON null value. By default, fields with
	// empty values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

GoogleCloudDatapipelinesV1FlexTemplateRuntimeEnvironment: The environment values to be set at runtime for a Flex Template.

func (GoogleCloudDatapipelinesV1FlexTemplateRuntimeEnvironment) MarshalJSON 

func (s GoogleCloudDatapipelinesV1FlexTemplateRuntimeEnvironment) MarshalJSON() ([]byte, error)

type GoogleCloudDatapipelinesV1Job 

type GoogleCloudDatapipelinesV1Job struct {
	// CreateTime: Output only. The time of job creation.
	CreateTime string `json:"createTime,omitempty"`
	// DataflowJobDetails: All the details that are specific to a Dataflow job.
	DataflowJobDetails *GoogleCloudDatapipelinesV1DataflowJobDetails `json:"dataflowJobDetails,omitempty"`
	// EndTime: Output only. The time of job termination. This is absent if the job
	// is still running.
	EndTime string `json:"endTime,omitempty"`
	// Id: Output only. The internal ID for the job.
	Id string `json:"id,omitempty"`
	// Name: Required. The fully qualified resource name for the job.
	Name string `json:"name,omitempty"`
	// State: The current state of the job.
	//
	// Possible values:
	//   "STATE_UNSPECIFIED" - The job state isn't specified.
	//   "STATE_PENDING" - The job is waiting to start execution.
	//   "STATE_RUNNING" - The job is executing.
	//   "STATE_DONE" - The job has finished execution successfully.
	//   "STATE_FAILED" - The job has finished execution with a failure.
	//   "STATE_CANCELLED" - The job has been terminated upon user request.
	State string `json:"state,omitempty"`
	// Status: Status capturing any error code or message related to job creation
	// or execution.
	Status *GoogleRpcStatus `json:"status,omitempty"`
	// ForceSendFields is a list of field names (e.g. "CreateTime") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "CreateTime") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

GoogleCloudDatapipelinesV1Job: Definition of the job information maintained by the pipeline. Fields in this entity are retrieved from the executor API (e.g. Dataflow API).

func (GoogleCloudDatapipelinesV1Job) MarshalJSON 

func (s GoogleCloudDatapipelinesV1Job) MarshalJSON() ([]byte, error)

type GoogleCloudDatapipelinesV1LaunchFlexTemplateParameter 

type GoogleCloudDatapipelinesV1LaunchFlexTemplateParameter struct {
	// ContainerSpecGcsPath: Cloud Storage path to a file with a JSON-serialized
	// ContainerSpec as content.
	ContainerSpecGcsPath string `json:"containerSpecGcsPath,omitempty"`
	// Environment: The runtime environment for the Flex Template job.
	Environment *GoogleCloudDatapipelinesV1FlexTemplateRuntimeEnvironment `json:"environment,omitempty"`
	// JobName: Required. The job name to use for the created job. For an update
	// job request, the job name should be the same as the existing running job.
	JobName string `json:"jobName,omitempty"`
	// LaunchOptions: Launch options for this Flex Template job. This is a common
	// set of options across languages and templates. This should not be used to
	// pass job parameters.
	LaunchOptions map[string]string `json:"launchOptions,omitempty"`
	// Parameters: The parameters for the Flex Template. Example:
	// `{"num_workers":"5"}`
	Parameters map[string]string `json:"parameters,omitempty"`
	// TransformNameMappings: Use this to pass transform name mappings for
	// streaming update jobs. Example:
	// `{"oldTransformName":"newTransformName",...}`
	TransformNameMappings map[string]string `json:"transformNameMappings,omitempty"`
	// Update: Set this to true if you are sending a request to update a running
	// streaming job. When set, the job name should be the same as the running job.
	Update bool `json:"update,omitempty"`
	// ForceSendFields is a list of field names (e.g. "ContainerSpecGcsPath") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "ContainerSpecGcsPath") to include
	// in API requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

GoogleCloudDatapipelinesV1LaunchFlexTemplateParameter: Launch Flex Template parameter.

func (GoogleCloudDatapipelinesV1LaunchFlexTemplateParameter) MarshalJSON 

func (s GoogleCloudDatapipelinesV1LaunchFlexTemplateParameter) MarshalJSON() ([]byte, error)

type GoogleCloudDatapipelinesV1LaunchFlexTemplateRequest 

type GoogleCloudDatapipelinesV1LaunchFlexTemplateRequest struct {
	// LaunchParameter: Required. Parameter to launch a job from a Flex Template.
	LaunchParameter *GoogleCloudDatapipelinesV1LaunchFlexTemplateParameter `json:"launchParameter,omitempty"`
	// Location: Required. The [regional endpoint]
	// (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) to
	// which to direct the request. For example, `us-central1`, `us-west1`.
	Location string `json:"location,omitempty"`
	// ProjectId: Required. The ID of the Cloud Platform project that the job
	// belongs to.
	ProjectId string `json:"projectId,omitempty"`
	// ValidateOnly: If true, the request is validated but not actually executed.
	// Defaults to false.
	ValidateOnly bool `json:"validateOnly,omitempty"`
	// ForceSendFields is a list of field names (e.g. "LaunchParameter") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "LaunchParameter") to include in
	// API requests with the JSON null value. By default, fields with empty values
	// are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

GoogleCloudDatapipelinesV1LaunchFlexTemplateRequest: A request to launch a Dataflow job from a Flex Template.

func (GoogleCloudDatapipelinesV1LaunchFlexTemplateRequest) MarshalJSON 

func (s GoogleCloudDatapipelinesV1LaunchFlexTemplateRequest) MarshalJSON() ([]byte, error)

type GoogleCloudDatapipelinesV1LaunchTemplateParameters 

type GoogleCloudDatapipelinesV1LaunchTemplateParameters struct {
	// Environment: The runtime environment for the job.
	Environment *GoogleCloudDatapipelinesV1RuntimeEnvironment `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"`
	// TransformNameMapping: Map of transform name prefixes of the job to be
	// replaced to the corresponding name prefixes of the new job. Only applicable
	// when updating a pipeline.
	TransformNameMapping map[string]string `json:"transformNameMapping,omitempty"`
	// Update: If set, replace the existing pipeline with the name specified by
	// jobName with this pipeline, preserving state.
	Update bool `json:"update,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Environment") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Environment") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

GoogleCloudDatapipelinesV1LaunchTemplateParameters: Parameters to provide to the template being launched.

func (GoogleCloudDatapipelinesV1LaunchTemplateParameters) MarshalJSON 

func (s GoogleCloudDatapipelinesV1LaunchTemplateParameters) MarshalJSON() ([]byte, error)

type GoogleCloudDatapipelinesV1LaunchTemplateRequest 

type GoogleCloudDatapipelinesV1LaunchTemplateRequest struct {
	// GcsPath: 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"`
	// LaunchParameters: The parameters of the template to launch. This should be
	// part of the body of the POST request.
	LaunchParameters *GoogleCloudDatapipelinesV1LaunchTemplateParameters `json:"launchParameters,omitempty"`
	// Location: The [regional endpoint]
	// (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) to
	// which to direct the request.
	Location string `json:"location,omitempty"`
	// ProjectId: Required. The ID of the Cloud Platform project that the job
	// belongs to.
	ProjectId string `json:"projectId,omitempty"`
	// ValidateOnly: If true, the request is validated but not actually executed.
	// Defaults to false.
	ValidateOnly bool `json:"validateOnly,omitempty"`
	// ForceSendFields is a list of field names (e.g. "GcsPath") to unconditionally
	// include in API requests. By default, fields with empty or default values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "GcsPath") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

GoogleCloudDatapipelinesV1LaunchTemplateRequest: A request to launch a template.

func (GoogleCloudDatapipelinesV1LaunchTemplateRequest) MarshalJSON 

func (s GoogleCloudDatapipelinesV1LaunchTemplateRequest) MarshalJSON() ([]byte, error)

type GoogleCloudDatapipelinesV1ListJobsResponse added in v0.66.0 

type GoogleCloudDatapipelinesV1ListJobsResponse struct {
	// Jobs: Results that were accessible to the caller. Results are always in
	// descending order of job creation date.
	Jobs []*GoogleCloudDatapipelinesV1Job `json:"jobs,omitempty"`
	// NextPageToken: A token, which can be sent as `page_token` to retrieve the
	// next page. If this field is omitted, there are no subsequent pages.
	NextPageToken string `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. "Jobs") to unconditionally
	// include in API requests. By default, fields with empty or default values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Jobs") to include in API requests
	// with the JSON null value. By default, fields with empty values are omitted
	// from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

GoogleCloudDatapipelinesV1ListJobsResponse: Response message for ListJobs

func (GoogleCloudDatapipelinesV1ListJobsResponse) MarshalJSON added in v0.66.0 

func (s GoogleCloudDatapipelinesV1ListJobsResponse) MarshalJSON() ([]byte, error)

type GoogleCloudDatapipelinesV1ListPipelinesResponse 

type GoogleCloudDatapipelinesV1ListPipelinesResponse struct {
	// NextPageToken: A token, which can be sent as `page_token` to retrieve the
	// next page. If this field is omitted, there are no subsequent pages.
	NextPageToken string `json:"nextPageToken,omitempty"`
	// Pipelines: Results that matched the filter criteria and were accessible to
	// the caller. Results are always in descending order of pipeline creation
	// date.
	Pipelines []*GoogleCloudDatapipelinesV1Pipeline `json:"pipelines,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the server.
	googleapi.ServerResponse `json:"-"`
	// ForceSendFields is a list of field names (e.g. "NextPageToken") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "NextPageToken") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

GoogleCloudDatapipelinesV1ListPipelinesResponse: Response message for ListPipelines.

func (GoogleCloudDatapipelinesV1ListPipelinesResponse) MarshalJSON 

func (s GoogleCloudDatapipelinesV1ListPipelinesResponse) MarshalJSON() ([]byte, error)

type GoogleCloudDatapipelinesV1Pipeline 

type GoogleCloudDatapipelinesV1Pipeline struct {
	// CreateTime: Output only. Immutable. The timestamp when the pipeline was
	// initially created. Set by the Data Pipelines service.
	CreateTime string `json:"createTime,omitempty"`
	// DisplayName: Required. The display name of the pipeline. It can contain only
	// letters ([A-Za-z]), numbers ([0-9]), hyphens (-), and underscores (_).
	DisplayName string `json:"displayName,omitempty"`
	// JobCount: Output only. Number of jobs.
	JobCount int64 `json:"jobCount,omitempty"`
	// LastUpdateTime: Output only. Immutable. The timestamp when the pipeline was
	// last modified. Set by the Data Pipelines service.
	LastUpdateTime string `json:"lastUpdateTime,omitempty"`
	// Name: The pipeline name. For example:
	// `projects/PROJECT_ID/locations/LOCATION_ID/pipelines/PIPELINE_ID`. *
	// `PROJECT_ID` can contain letters ([A-Za-z]), numbers ([0-9]), hyphens (-),
	// colons (:), and periods (.). For more information, see Identifying projects
	// (https://cloud.google.com/resource-manager/docs/creating-managing-projects#identifying_projects).
	// * `LOCATION_ID` is the canonical ID for the pipeline's location. The list of
	// available locations can be obtained by calling
	// `google.cloud.location.Locations.ListLocations`. Note that the Data
	// Pipelines service is not available in all regions. It depends on Cloud
	// Scheduler, an App Engine application, so it's only available in App Engine
	// regions (https://cloud.google.com/about/locations#region). * `PIPELINE_ID`
	// is the ID of the pipeline. Must be unique for the selected project and
	// location.
	Name string `json:"name,omitempty"`
	// PipelineSources: Immutable. The sources of the pipeline (for example,
	// Dataplex). The keys and values are set by the corresponding sources during
	// pipeline creation.
	PipelineSources map[string]string `json:"pipelineSources,omitempty"`
	// ScheduleInfo: Internal scheduling information for a pipeline. If this
	// information is provided, periodic jobs will be created per the schedule. If
	// not, users are responsible for creating jobs externally.
	ScheduleInfo *GoogleCloudDatapipelinesV1ScheduleSpec `json:"scheduleInfo,omitempty"`
	// SchedulerServiceAccountEmail: Optional. A service account email to be used
	// with the Cloud Scheduler job. If not specified, the default compute engine
	// service account will be used.
	SchedulerServiceAccountEmail string `json:"schedulerServiceAccountEmail,omitempty"`
	// State: Required. The state of the pipeline. When the pipeline is created,
	// the state is set to 'PIPELINE_STATE_ACTIVE' by default. State changes can be
	// requested by setting the state to stopping, paused, or resuming. State
	// cannot be changed through UpdatePipeline requests.
	//
	// Possible values:
	//   "STATE_UNSPECIFIED" - The pipeline state isn't specified.
	//   "STATE_RESUMING" - The pipeline is getting started or resumed. When
	// finished, the pipeline state will be 'PIPELINE_STATE_ACTIVE'.
	//   "STATE_ACTIVE" - The pipeline is actively running.
	//   "STATE_STOPPING" - The pipeline is in the process of stopping. When
	// finished, the pipeline state will be 'PIPELINE_STATE_ARCHIVED'.
	//   "STATE_ARCHIVED" - The pipeline has been stopped. This is a terminal state
	// and cannot be undone.
	//   "STATE_PAUSED" - The pipeline is paused. This is a non-terminal state.
	// When the pipeline is paused, it will hold processing jobs, but can be
	// resumed later. For a batch pipeline, this means pausing the scheduler job.
	// For a streaming pipeline, creating a job snapshot to resume from will give
	// the same effect.
	State string `json:"state,omitempty"`
	// Type: Required. The type of the pipeline. This field affects the scheduling
	// of the pipeline and the type of metrics to show for the pipeline.
	//
	// Possible values:
	//   "PIPELINE_TYPE_UNSPECIFIED" - The pipeline type isn't specified.
	//   "PIPELINE_TYPE_BATCH" - A batch pipeline. It runs jobs on a specific
	// schedule, and each job will automatically terminate once execution is
	// finished.
	//   "PIPELINE_TYPE_STREAMING" - A streaming pipeline. The underlying job is
	// continuously running until it is manually terminated by the user. This type
	// of pipeline doesn't have a schedule to run on, and the linked job gets
	// created when the pipeline is created.
	Type string `json:"type,omitempty"`
	// Workload: Workload information for creating new jobs.
	Workload *GoogleCloudDatapipelinesV1Workload `json:"workload,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the server.
	googleapi.ServerResponse `json:"-"`
	// ForceSendFields is a list of field names (e.g. "CreateTime") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "CreateTime") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

GoogleCloudDatapipelinesV1Pipeline: The main pipeline entity and all the necessary metadata for launching and managing linked jobs.

func (GoogleCloudDatapipelinesV1Pipeline) MarshalJSON 

func (s GoogleCloudDatapipelinesV1Pipeline) MarshalJSON() ([]byte, error)

type GoogleCloudDatapipelinesV1RunPipelineRequest 

type GoogleCloudDatapipelinesV1RunPipelineRequest struct {
}

GoogleCloudDatapipelinesV1RunPipelineRequest: Request message for RunPipeline

type GoogleCloudDatapipelinesV1RunPipelineResponse 

type GoogleCloudDatapipelinesV1RunPipelineResponse struct {
	// Job: Job that was created as part of RunPipeline operation.
	Job *GoogleCloudDatapipelinesV1Job `json:"job,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 or default values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Job") to include in API requests
	// with the JSON null value. By default, fields with empty values are omitted
	// from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

GoogleCloudDatapipelinesV1RunPipelineResponse: Response message for RunPipeline

func (GoogleCloudDatapipelinesV1RunPipelineResponse) MarshalJSON 

func (s GoogleCloudDatapipelinesV1RunPipelineResponse) MarshalJSON() ([]byte, error)

type GoogleCloudDatapipelinesV1RuntimeEnvironment 

type GoogleCloudDatapipelinesV1RuntimeEnvironment struct {
	// AdditionalExperiments: Additional experiment flags for the job.
	AdditionalExperiments []string `json:"additionalExperiments,omitempty"`
	// AdditionalUserLabels: Additional user labels to be specified for the job.
	// Keys and values should follow the restrictions specified in the labeling
	// restrictions
	// (https://cloud.google.com/compute/docs/labeling-resources#restrictions)
	// page. An object containing a list of key/value pairs. Example: { "name":
	// "wrench", "mass": "1kg", "count": "3" }.
	AdditionalUserLabels map[string]string `json:"additionalUserLabels,omitempty"`
	// BypassTempDirValidation: Whether to bypass the safety checks for the job's
	// temporary directory. Use with caution.
	BypassTempDirValidation bool `json:"bypassTempDirValidation,omitempty"`
	// EnableStreamingEngine: Whether to enable Streaming Engine for the job.
	EnableStreamingEngine bool `json:"enableStreamingEngine,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"`
	// KmsKeyName: Name for the Cloud KMS key for the job. The key format is:
	// projects//locations//keyRings//cryptoKeys/
	KmsKeyName string `json:"kmsKeyName,omitempty"`
	// MachineType: The machine type to use for the job. Defaults to the value from
	// the template if not specified.
	MachineType string `json:"machineType,omitempty"`
	// MaxWorkers: The maximum number of Compute Engine instances to be made
	// available to your pipeline during execution, from 1 to 1000.
	MaxWorkers int64 `json:"maxWorkers,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"`
	// NumWorkers: The initial number of Compute Engine instances for the job.
	NumWorkers int64 `json:"numWorkers,omitempty"`
	// ServiceAccountEmail: The email address of the service account to run the job
	// as.
	ServiceAccountEmail string `json:"serviceAccountEmail,omitempty"`
	// Subnetwork: Subnetwork to which VMs will be assigned, if desired. You can
	// specify a subnetwork using either a complete URL or an abbreviated path.
	// Expected to be of the form
	// "https://www.googleapis.com/compute/v1/projects/HOST_PROJECT_ID/regions/REGIO
	// N/subnetworks/SUBNETWORK" or "regions/REGION/subnetworks/SUBNETWORK". If the
	// subnetwork is located in a Shared VPC network, you must use the complete
	// URL.
	Subnetwork string `json:"subnetwork,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"`
	// WorkerRegion: The Compute Engine region
	// (https://cloud.google.com/compute/docs/regions-zones/regions-zones) in which
	// worker processing should occur, e.g. "us-west1". Mutually exclusive with
	// worker_zone. If neither worker_region nor worker_zone is specified, default
	// to the control plane's region.
	WorkerRegion string `json:"workerRegion,omitempty"`
	// WorkerZone: The Compute Engine zone
	// (https://cloud.google.com/compute/docs/regions-zones/regions-zones) in which
	// worker processing should occur, e.g. "us-west1-a". Mutually exclusive with
	// worker_region. If neither worker_region nor worker_zone is specified, a zone
	// in the control plane's region is chosen based on available capacity. If both
	// `worker_zone` and `zone` are set, `worker_zone` takes precedence.
	WorkerZone string `json:"workerZone,omitempty"`
	// Zone: The Compute Engine availability zone
	// (https://cloud.google.com/compute/docs/regions-zones/regions-zones) for
	// launching worker instances to run your pipeline. In the future, worker_zone
	// will take precedence.
	Zone string `json:"zone,omitempty"`
	// ForceSendFields is a list of field names (e.g. "AdditionalExperiments") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "AdditionalExperiments") to
	// include in API requests with the JSON null value. By default, fields with
	// empty values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

GoogleCloudDatapipelinesV1RuntimeEnvironment: The environment values to set at runtime.

func (GoogleCloudDatapipelinesV1RuntimeEnvironment) MarshalJSON 

func (s GoogleCloudDatapipelinesV1RuntimeEnvironment) MarshalJSON() ([]byte, error)

type GoogleCloudDatapipelinesV1ScheduleSpec 

type GoogleCloudDatapipelinesV1ScheduleSpec struct {
	// NextJobTime: Output only. When the next Scheduler job is going to run.
	NextJobTime string `json:"nextJobTime,omitempty"`
	// Schedule: Unix-cron format of the schedule. This information is retrieved
	// from the linked Cloud Scheduler.
	Schedule string `json:"schedule,omitempty"`
	// TimeZone: Timezone ID. This matches the timezone IDs used by the Cloud
	// Scheduler API. If empty, UTC time is assumed.
	TimeZone string `json:"timeZone,omitempty"`
	// ForceSendFields is a list of field names (e.g. "NextJobTime") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "NextJobTime") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

GoogleCloudDatapipelinesV1ScheduleSpec: Details of the schedule the pipeline runs on.

func (GoogleCloudDatapipelinesV1ScheduleSpec) MarshalJSON 

func (s GoogleCloudDatapipelinesV1ScheduleSpec) MarshalJSON() ([]byte, error)

type GoogleCloudDatapipelinesV1SdkVersion 

type GoogleCloudDatapipelinesV1SdkVersion struct {
	// SdkSupportStatus: The support status for this SDK version.
	//
	// Possible values:
	//   "UNKNOWN" - Dataflow is unaware of this version.
	//   "SUPPORTED" - This is a known version of an SDK, and is supported.
	//   "STALE" - A newer version of the SDK exists, and an update is recommended.
	//   "DEPRECATED" - This version of the SDK is deprecated and will eventually
	// be unsupported.
	//   "UNSUPPORTED" - Support for this SDK version has ended and it should no
	// longer be used.
	SdkSupportStatus string `json:"sdkSupportStatus,omitempty"`
	// Version: The version of the SDK used to run the job.
	Version string `json:"version,omitempty"`
	// VersionDisplayName: A readable string describing the version of the SDK.
	VersionDisplayName string `json:"versionDisplayName,omitempty"`
	// ForceSendFields is a list of field names (e.g. "SdkSupportStatus") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "SdkSupportStatus") to include in
	// API requests with the JSON null value. By default, fields with empty values
	// are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

GoogleCloudDatapipelinesV1SdkVersion: The version of the SDK used to run the job.

func (GoogleCloudDatapipelinesV1SdkVersion) MarshalJSON 

func (s GoogleCloudDatapipelinesV1SdkVersion) MarshalJSON() ([]byte, error)

type GoogleCloudDatapipelinesV1StopPipelineRequest 

type GoogleCloudDatapipelinesV1StopPipelineRequest struct {
}

GoogleCloudDatapipelinesV1StopPipelineRequest: Request message for StopPipeline.

type GoogleCloudDatapipelinesV1Workload 

type GoogleCloudDatapipelinesV1Workload struct {
	// DataflowFlexTemplateRequest: Template information and additional parameters
	// needed to launch a Dataflow job using the flex launch API.
	DataflowFlexTemplateRequest *GoogleCloudDatapipelinesV1LaunchFlexTemplateRequest `json:"dataflowFlexTemplateRequest,omitempty"`
	// DataflowLaunchTemplateRequest: Template information and additional
	// parameters needed to launch a Dataflow job using the standard launch API.
	DataflowLaunchTemplateRequest *GoogleCloudDatapipelinesV1LaunchTemplateRequest `json:"dataflowLaunchTemplateRequest,omitempty"`
	// ForceSendFields is a list of field names (e.g.
	// "DataflowFlexTemplateRequest") to unconditionally include in API requests.
	// By default, fields with empty or default values are omitted from API
	// requests. See https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields
	// for more details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "DataflowFlexTemplateRequest") to
	// include in API requests with the JSON null value. By default, fields with
	// empty values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

GoogleCloudDatapipelinesV1Workload: Workload details for creating the pipeline jobs.

func (GoogleCloudDatapipelinesV1Workload) MarshalJSON 

func (s GoogleCloudDatapipelinesV1Workload) MarshalJSON() ([]byte, error)

type GoogleProtobufEmpty 

type GoogleProtobufEmpty struct {
	// ServerResponse contains the HTTP response code and headers from the server.
	googleapi.ServerResponse `json:"-"`
}

GoogleProtobufEmpty: A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }

type GoogleRpcStatus 

type GoogleRpcStatus 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 is a common
	// set of message types for APIs to use.
	Details []googleapi.RawMessage `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 or default values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Code") to include in API requests
	// with the JSON null value. By default, fields with empty values are omitted
	// from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

GoogleRpcStatus: 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). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the API Design Guide (https://cloud.google.com/apis/design/errors).

func (GoogleRpcStatus) MarshalJSON 

func (s GoogleRpcStatus) MarshalJSON() ([]byte, error)

type ProjectsLocationsPipelinesCreateCall 

type ProjectsLocationsPipelinesCreateCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsPipelinesCreateCall) Context 

func (c *ProjectsLocationsPipelinesCreateCall) Context(ctx context.Context) *ProjectsLocationsPipelinesCreateCall

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsPipelinesCreateCall) Do 

func (c *ProjectsLocationsPipelinesCreateCall) Do(opts ...googleapi.CallOption) (*GoogleCloudDatapipelinesV1Pipeline, error)

Do executes the "datapipelines.projects.locations.pipelines.create" call. Any non-2xx status code is an error. Response headers are in either *GoogleCloudDatapipelinesV1Pipeline.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 (*ProjectsLocationsPipelinesCreateCall) Fields 

func (c *ProjectsLocationsPipelinesCreateCall) Fields(s ...googleapi.Field) *ProjectsLocationsPipelinesCreateCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsPipelinesCreateCall) Header 

func (c *ProjectsLocationsPipelinesCreateCall) Header() http.Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

type ProjectsLocationsPipelinesDeleteCall 

type ProjectsLocationsPipelinesDeleteCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsPipelinesDeleteCall) Context 

func (c *ProjectsLocationsPipelinesDeleteCall) Context(ctx context.Context) *ProjectsLocationsPipelinesDeleteCall

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsPipelinesDeleteCall) Do 

func (c *ProjectsLocationsPipelinesDeleteCall) Do(opts ...googleapi.CallOption) (*GoogleProtobufEmpty, error)

Do executes the "datapipelines.projects.locations.pipelines.delete" call. Any non-2xx status code is an error. Response headers are in either *GoogleProtobufEmpty.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 (*ProjectsLocationsPipelinesDeleteCall) Fields 

func (c *ProjectsLocationsPipelinesDeleteCall) Fields(s ...googleapi.Field) *ProjectsLocationsPipelinesDeleteCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsPipelinesDeleteCall) Header 

func (c *ProjectsLocationsPipelinesDeleteCall) Header() http.Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

type ProjectsLocationsPipelinesGetCall 

type ProjectsLocationsPipelinesGetCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsPipelinesGetCall) Context 

func (c *ProjectsLocationsPipelinesGetCall) Context(ctx context.Context) *ProjectsLocationsPipelinesGetCall

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsPipelinesGetCall) Do 

func (c *ProjectsLocationsPipelinesGetCall) Do(opts ...googleapi.CallOption) (*GoogleCloudDatapipelinesV1Pipeline, error)

Do executes the "datapipelines.projects.locations.pipelines.get" call. Any non-2xx status code is an error. Response headers are in either *GoogleCloudDatapipelinesV1Pipeline.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 (*ProjectsLocationsPipelinesGetCall) Fields 

func (c *ProjectsLocationsPipelinesGetCall) Fields(s ...googleapi.Field) *ProjectsLocationsPipelinesGetCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsPipelinesGetCall) Header 

func (c *ProjectsLocationsPipelinesGetCall) Header() http.Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*ProjectsLocationsPipelinesGetCall) IfNoneMatch 

func (c *ProjectsLocationsPipelinesGetCall) IfNoneMatch(entityTag string) *ProjectsLocationsPipelinesGetCall

IfNoneMatch sets an 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.

type ProjectsLocationsPipelinesJobsListCall added in v0.66.0 

type ProjectsLocationsPipelinesJobsListCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsPipelinesJobsListCall) Context added in v0.66.0 

func (c *ProjectsLocationsPipelinesJobsListCall) Context(ctx context.Context) *ProjectsLocationsPipelinesJobsListCall

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsPipelinesJobsListCall) Do added in v0.66.0 

func (c *ProjectsLocationsPipelinesJobsListCall) Do(opts ...googleapi.CallOption) (*GoogleCloudDatapipelinesV1ListJobsResponse, error)

Do executes the "datapipelines.projects.locations.pipelines.jobs.list" call. Any non-2xx status code is an error. Response headers are in either *GoogleCloudDatapipelinesV1ListJobsResponse.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 (*ProjectsLocationsPipelinesJobsListCall) Fields added in v0.66.0 

func (c *ProjectsLocationsPipelinesJobsListCall) Fields(s ...googleapi.Field) *ProjectsLocationsPipelinesJobsListCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsPipelinesJobsListCall) Header added in v0.66.0 

func (c *ProjectsLocationsPipelinesJobsListCall) Header() http.Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*ProjectsLocationsPipelinesJobsListCall) IfNoneMatch added in v0.66.0 

func (c *ProjectsLocationsPipelinesJobsListCall) IfNoneMatch(entityTag string) *ProjectsLocationsPipelinesJobsListCall

IfNoneMatch sets an 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.

func (*ProjectsLocationsPipelinesJobsListCall) PageSize added in v0.66.0 

func (c *ProjectsLocationsPipelinesJobsListCall) PageSize(pageSize int64) *ProjectsLocationsPipelinesJobsListCall

PageSize sets the optional parameter "pageSize": The maximum number of entities to return. The service may return fewer than this value, even if there are additional pages. If unspecified, the max limit will be determined by the backend implementation.

func (*ProjectsLocationsPipelinesJobsListCall) PageToken added in v0.66.0 

func (c *ProjectsLocationsPipelinesJobsListCall) PageToken(pageToken string) *ProjectsLocationsPipelinesJobsListCall

PageToken sets the optional parameter "pageToken": A page token, received from a previous `ListJobs` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListJobs` must match the call that provided the page token.

func (*ProjectsLocationsPipelinesJobsListCall) Pages added in v0.66.0 

func (c *ProjectsLocationsPipelinesJobsListCall) Pages(ctx context.Context, f func(*GoogleCloudDatapipelinesV1ListJobsResponse) 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.

type ProjectsLocationsPipelinesJobsService added in v0.66.0 

type ProjectsLocationsPipelinesJobsService struct {
	// contains filtered or unexported fields
}

func NewProjectsLocationsPipelinesJobsService added in v0.66.0 

func NewProjectsLocationsPipelinesJobsService(s *Service) *ProjectsLocationsPipelinesJobsService

func (*ProjectsLocationsPipelinesJobsService) List added in v0.66.0 

func (r *ProjectsLocationsPipelinesJobsService) List(parent string) *ProjectsLocationsPipelinesJobsListCall

List: Lists jobs for a given pipeline. Throws a "FORBIDDEN" error if the caller doesn't have permission to access it.

  • parent: The pipeline name. For example: `projects/PROJECT_ID/locations/LOCATION_ID/pipelines/PIPELINE_ID`.

type ProjectsLocationsPipelinesListCall added in v0.106.0 

type ProjectsLocationsPipelinesListCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsPipelinesListCall) Context added in v0.106.0 

func (c *ProjectsLocationsPipelinesListCall) Context(ctx context.Context) *ProjectsLocationsPipelinesListCall

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsPipelinesListCall) Do added in v0.106.0 

func (c *ProjectsLocationsPipelinesListCall) Do(opts ...googleapi.CallOption) (*GoogleCloudDatapipelinesV1ListPipelinesResponse, error)

Do executes the "datapipelines.projects.locations.pipelines.list" call. Any non-2xx status code is an error. Response headers are in either *GoogleCloudDatapipelinesV1ListPipelinesResponse.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 (*ProjectsLocationsPipelinesListCall) Fields added in v0.106.0 

func (c *ProjectsLocationsPipelinesListCall) Fields(s ...googleapi.Field) *ProjectsLocationsPipelinesListCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsPipelinesListCall) Filter added in v0.106.0 

func (c *ProjectsLocationsPipelinesListCall) Filter(filter string) *ProjectsLocationsPipelinesListCall

Filter sets the optional parameter "filter": An expression for filtering the results of the request. If unspecified, all pipelines will be returned. Multiple filters can be applied and must be comma separated. Fields eligible for filtering are: + `type`: The type of the pipeline (streaming or batch). Allowed values are `ALL`, `BATCH`, and `STREAMING`. + `status`: The activity status of the pipeline. Allowed values are `ALL`, `ACTIVE`, `ARCHIVED`, and `PAUSED`. For example, to limit results to active batch processing pipelines: type:BATCH,status:ACTIVE

func (*ProjectsLocationsPipelinesListCall) Header added in v0.106.0 

func (c *ProjectsLocationsPipelinesListCall) Header() http.Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*ProjectsLocationsPipelinesListCall) IfNoneMatch added in v0.106.0 

func (c *ProjectsLocationsPipelinesListCall) IfNoneMatch(entityTag string) *ProjectsLocationsPipelinesListCall

IfNoneMatch sets an 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.

func (*ProjectsLocationsPipelinesListCall) PageSize added in v0.106.0 

func (c *ProjectsLocationsPipelinesListCall) PageSize(pageSize int64) *ProjectsLocationsPipelinesListCall

PageSize sets the optional parameter "pageSize": The maximum number of entities to return. The service may return fewer than this value, even if there are additional pages. If unspecified, the max limit is yet to be determined by the backend implementation.

func (*ProjectsLocationsPipelinesListCall) PageToken added in v0.106.0 

func (c *ProjectsLocationsPipelinesListCall) PageToken(pageToken string) *ProjectsLocationsPipelinesListCall

PageToken sets the optional parameter "pageToken": A page token, received from a previous `ListPipelines` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListPipelines` must match the call that provided the page token.

func (*ProjectsLocationsPipelinesListCall) Pages added in v0.106.0 

func (c *ProjectsLocationsPipelinesListCall) Pages(ctx context.Context, f func(*GoogleCloudDatapipelinesV1ListPipelinesResponse) 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.

type ProjectsLocationsPipelinesPatchCall 

type ProjectsLocationsPipelinesPatchCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsPipelinesPatchCall) Context 

func (c *ProjectsLocationsPipelinesPatchCall) Context(ctx context.Context) *ProjectsLocationsPipelinesPatchCall

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsPipelinesPatchCall) Do 

func (c *ProjectsLocationsPipelinesPatchCall) Do(opts ...googleapi.CallOption) (*GoogleCloudDatapipelinesV1Pipeline, error)

Do executes the "datapipelines.projects.locations.pipelines.patch" call. Any non-2xx status code is an error. Response headers are in either *GoogleCloudDatapipelinesV1Pipeline.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 (*ProjectsLocationsPipelinesPatchCall) Fields 

func (c *ProjectsLocationsPipelinesPatchCall) Fields(s ...googleapi.Field) *ProjectsLocationsPipelinesPatchCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsPipelinesPatchCall) Header 

func (c *ProjectsLocationsPipelinesPatchCall) Header() http.Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*ProjectsLocationsPipelinesPatchCall) UpdateMask 

func (c *ProjectsLocationsPipelinesPatchCall) UpdateMask(updateMask string) *ProjectsLocationsPipelinesPatchCall

UpdateMask sets the optional parameter "updateMask": The list of fields to be updated.

type ProjectsLocationsPipelinesRunCall 

type ProjectsLocationsPipelinesRunCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsPipelinesRunCall) Context 

func (c *ProjectsLocationsPipelinesRunCall) Context(ctx context.Context) *ProjectsLocationsPipelinesRunCall

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsPipelinesRunCall) Do 

func (c *ProjectsLocationsPipelinesRunCall) Do(opts ...googleapi.CallOption) (*GoogleCloudDatapipelinesV1RunPipelineResponse, error)

Do executes the "datapipelines.projects.locations.pipelines.run" call. Any non-2xx status code is an error. Response headers are in either *GoogleCloudDatapipelinesV1RunPipelineResponse.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 (*ProjectsLocationsPipelinesRunCall) Fields 

func (c *ProjectsLocationsPipelinesRunCall) Fields(s ...googleapi.Field) *ProjectsLocationsPipelinesRunCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsPipelinesRunCall) Header 

func (c *ProjectsLocationsPipelinesRunCall) Header() http.Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

type ProjectsLocationsPipelinesService 

type ProjectsLocationsPipelinesService struct {
	Jobs *ProjectsLocationsPipelinesJobsService
	// contains filtered or unexported fields
}

func NewProjectsLocationsPipelinesService 

func NewProjectsLocationsPipelinesService(s *Service) *ProjectsLocationsPipelinesService

func (*ProjectsLocationsPipelinesService) Create 

func (r *ProjectsLocationsPipelinesService) Create(parent string, googleclouddatapipelinesv1pipeline *GoogleCloudDatapipelinesV1Pipeline) *ProjectsLocationsPipelinesCreateCall

Create: Creates a pipeline. For a batch pipeline, you can pass scheduler information. Data Pipelines uses the scheduler information to create an internal scheduler that runs jobs periodically. If the internal scheduler is not configured, you can use RunPipeline to run jobs.

  • parent: The location name. For example: `projects/PROJECT_ID/locations/LOCATION_ID`.

func (*ProjectsLocationsPipelinesService) Delete 

func (r *ProjectsLocationsPipelinesService) Delete(name string) *ProjectsLocationsPipelinesDeleteCall

Delete: Deletes a pipeline. If a scheduler job is attached to the pipeline, it will be deleted.

  • name: The pipeline name. For example: `projects/PROJECT_ID/locations/LOCATION_ID/pipelines/PIPELINE_ID`.

func (*ProjectsLocationsPipelinesService) Get 

func (r *ProjectsLocationsPipelinesService) Get(name string) *ProjectsLocationsPipelinesGetCall

Get: Looks up a single pipeline. Returns a "NOT_FOUND" error if no such pipeline exists. Returns a "FORBIDDEN" error if the caller doesn't have permission to access it.

  • name: The pipeline name. For example: `projects/PROJECT_ID/locations/LOCATION_ID/pipelines/PIPELINE_ID`.

func (*ProjectsLocationsPipelinesService) List added in v0.106.0 

func (r *ProjectsLocationsPipelinesService) List(parent string) *ProjectsLocationsPipelinesListCall

List: Lists pipelines. Returns a "FORBIDDEN" error if the caller doesn't have permission to access it.

  • parent: The location name. For example: `projects/PROJECT_ID/locations/LOCATION_ID`.

func (*ProjectsLocationsPipelinesService) Patch 

func (r *ProjectsLocationsPipelinesService) Patch(name string, googleclouddatapipelinesv1pipeline *GoogleCloudDatapipelinesV1Pipeline) *ProjectsLocationsPipelinesPatchCall

Patch: Updates a pipeline. If successful, the updated Pipeline is returned. Returns `NOT_FOUND` if the pipeline doesn't exist. If UpdatePipeline does not return successfully, you can retry the UpdatePipeline request until you receive a successful response.

  • name: The pipeline name. For example: `projects/PROJECT_ID/locations/LOCATION_ID/pipelines/PIPELINE_ID`. * `PROJECT_ID` can contain letters ([A-Za-z]), numbers ([0-9]), hyphens (-), colons (:), and periods (.). For more information, see Identifying projects (https://cloud.google.com/resource-manager/docs/creating-managing-projects#identifying_projects).
  • `LOCATION_ID` is the canonical ID for the pipeline's location. The list of available locations can be obtained by calling `google.cloud.location.Locations.ListLocations`. Note that the Data Pipelines service is not available in all regions. It depends on Cloud Scheduler, an App Engine application, so it's only available in App Engine regions (https://cloud.google.com/about/locations#region). * `PIPELINE_ID` is the ID of the pipeline. Must be unique for the selected project and location.

func (*ProjectsLocationsPipelinesService) Run 

func (r *ProjectsLocationsPipelinesService) Run(name string, googleclouddatapipelinesv1runpipelinerequest *GoogleCloudDatapipelinesV1RunPipelineRequest) *ProjectsLocationsPipelinesRunCall

Run: Creates a job for the specified pipeline directly. You can use this method when the internal scheduler is not configured and you want to trigger the job directly or through an external system. Returns a "NOT_FOUND" error if the pipeline doesn't exist. Returns a "FORBIDDEN" error if the user doesn't have permission to access the pipeline or run jobs for the pipeline.

  • name: The pipeline name. For example: `projects/PROJECT_ID/locations/LOCATION_ID/pipelines/PIPELINE_ID`.

func (*ProjectsLocationsPipelinesService) Stop 

func (r *ProjectsLocationsPipelinesService) Stop(name string, googleclouddatapipelinesv1stoppipelinerequest *GoogleCloudDatapipelinesV1StopPipelineRequest) *ProjectsLocationsPipelinesStopCall

Stop: Freezes pipeline execution permanently. If there's a corresponding scheduler entry, it's deleted, and the pipeline state is changed to "ARCHIVED". However, pipeline metadata is retained.

  • name: The pipeline name. For example: `projects/PROJECT_ID/locations/LOCATION_ID/pipelines/PIPELINE_ID`.

type ProjectsLocationsPipelinesStopCall 

type ProjectsLocationsPipelinesStopCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsPipelinesStopCall) Context 

func (c *ProjectsLocationsPipelinesStopCall) Context(ctx context.Context) *ProjectsLocationsPipelinesStopCall

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsPipelinesStopCall) Do 

func (c *ProjectsLocationsPipelinesStopCall) Do(opts ...googleapi.CallOption) (*GoogleCloudDatapipelinesV1Pipeline, error)

Do executes the "datapipelines.projects.locations.pipelines.stop" call. Any non-2xx status code is an error. Response headers are in either *GoogleCloudDatapipelinesV1Pipeline.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 (*ProjectsLocationsPipelinesStopCall) Fields 

func (c *ProjectsLocationsPipelinesStopCall) Fields(s ...googleapi.Field) *ProjectsLocationsPipelinesStopCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsPipelinesStopCall) Header 

func (c *ProjectsLocationsPipelinesStopCall) Header() http.Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

type ProjectsLocationsService 

type ProjectsLocationsService struct {
	Pipelines *ProjectsLocationsPipelinesService
	// contains filtered or unexported fields
}

func NewProjectsLocationsService 

func NewProjectsLocationsService(s *Service) *ProjectsLocationsService

type ProjectsService 

type ProjectsService struct {
	Locations *ProjectsLocationsService
	// contains filtered or unexported fields
}

func NewProjectsService 

func NewProjectsService(s *Service) *ProjectsService

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
}

func New deprecated 

func New(client *http.Client) (*Service, error)

New creates a new Service. It uses the provided http.Client for requests.

Deprecated: please use NewService instead. To provide a custom HTTP client, use option.WithHTTPClient. If you are using google.golang.org/api/googleapis/transport.APIKey, use option.WithAPIKey with NewService instead.

func NewService 

func NewService(ctx context.Context, opts ...option.ClientOption) (*Service, error)

NewService creates a new Service.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.