Class GoogleCloudDatapipelinesV1Pipeline
The main pipeline entity and all the necessary metadata for launching and managing linked jobs.
Implements
Inherited Members
Namespace: Google.Apis.Datapipelines.v1.Data
Assembly: Google.Apis.Datapipelines.v1.dll
Syntax
public class GoogleCloudDatapipelinesV1Pipeline : IDirectResponseSchema
Properties
CreateTime
object representation of CreateTimeRaw.
Declaration
[JsonIgnore]
[Obsolete("This property is obsolete and may behave unexpectedly; please use CreateTimeDateTimeOffset instead.")]
public virtual object CreateTime { get; set; }
Property Value
Type | Description |
---|---|
object |
CreateTimeDateTimeOffset
DateTimeOffset representation of CreateTimeRaw.
Declaration
[JsonIgnore]
public virtual DateTimeOffset? CreateTimeDateTimeOffset { get; set; }
Property Value
Type | Description |
---|---|
DateTimeOffset? |
CreateTimeRaw
Output only. Immutable. The timestamp when the pipeline was initially created. Set by the Data Pipelines service.
Declaration
[JsonProperty("createTime")]
public virtual string CreateTimeRaw { get; set; }
Property Value
Type | Description |
---|---|
string |
DisplayName
Required. The display name of the pipeline. It can contain only letters ([A-Za-z]), numbers ([0-9]), hyphens (-), and underscores (_).
Declaration
[JsonProperty("displayName")]
public virtual string DisplayName { get; set; }
Property Value
Type | Description |
---|---|
string |
ETag
The ETag of the item.
Declaration
public virtual string ETag { get; set; }
Property Value
Type | Description |
---|---|
string |
JobCount
Output only. Number of jobs.
Declaration
[JsonProperty("jobCount")]
public virtual int? JobCount { get; set; }
Property Value
Type | Description |
---|---|
int? |
LastUpdateTime
object representation of LastUpdateTimeRaw.
Declaration
[JsonIgnore]
[Obsolete("This property is obsolete and may behave unexpectedly; please use LastUpdateTimeDateTimeOffset instead.")]
public virtual object LastUpdateTime { get; set; }
Property Value
Type | Description |
---|---|
object |
LastUpdateTimeDateTimeOffset
DateTimeOffset representation of LastUpdateTimeRaw.
Declaration
[JsonIgnore]
public virtual DateTimeOffset? LastUpdateTimeDateTimeOffset { get; set; }
Property Value
Type | Description |
---|---|
DateTimeOffset? |
LastUpdateTimeRaw
Output only. Immutable. The timestamp when the pipeline was last modified. Set by the Data Pipelines service.
Declaration
[JsonProperty("lastUpdateTime")]
public virtual string LastUpdateTimeRaw { get; set; }
Property Value
Type | Description |
---|---|
string |
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. *
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. * PIPELINE_ID
is the
ID of the pipeline. Must be unique for the selected project and location.
Declaration
[JsonProperty("name")]
public virtual string Name { get; set; }
Property Value
Type | Description |
---|---|
string |
PipelineSources
Immutable. The sources of the pipeline (for example, Dataplex). The keys and values are set by the corresponding sources during pipeline creation.
Declaration
[JsonProperty("pipelineSources")]
public virtual IDictionary<string, string> PipelineSources { get; set; }
Property Value
Type | Description |
---|---|
IDictionary<string, string> |
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.
Declaration
[JsonProperty("scheduleInfo")]
public virtual GoogleCloudDatapipelinesV1ScheduleSpec ScheduleInfo { get; set; }
Property Value
Type | Description |
---|---|
GoogleCloudDatapipelinesV1ScheduleSpec |
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.
Declaration
[JsonProperty("schedulerServiceAccountEmail")]
public virtual string SchedulerServiceAccountEmail { get; set; }
Property Value
Type | Description |
---|---|
string |
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.
Declaration
[JsonProperty("state")]
public virtual string State { get; set; }
Property Value
Type | Description |
---|---|
string |
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.
Declaration
[JsonProperty("type")]
public virtual string Type { get; set; }
Property Value
Type | Description |
---|---|
string |
Workload
Workload information for creating new jobs.
Declaration
[JsonProperty("workload")]
public virtual GoogleCloudDatapipelinesV1Workload Workload { get; set; }
Property Value
Type | Description |
---|---|
GoogleCloudDatapipelinesV1Workload |