Skip to content

Latest commit

 

History

History
2124 lines (1334 loc) · 84.6 KB

dataflowJob.csharp.md

File metadata and controls

2124 lines (1334 loc) · 84.6 KB
Raw

dataflowJob Submodule

Constructs

DataflowJob

Represents a {@link https://registry.terraform.io/providers/hashicorp/google/6.11.2/docs/resources/dataflow_job google_dataflow_job}.

Initializers 

using HashiCorp.Cdktf.Providers.Google;

new DataflowJob(Construct Scope, string Id, DataflowJobConfig Config);
Name Type Description
Scope Constructs.Construct The scope in which to define this construct.
Id string The scoped construct ID.
Config DataflowJobConfig No description.
ScopeRequired
  • Type: Constructs.Construct

The scope in which to define this construct.

IdRequired
  • Type: string

The scoped construct ID.

Must be unique amongst siblings in the same scope

ConfigRequired

Methods

Name Description
ToString Returns a string representation of this construct.
AddOverride No description.
OverrideLogicalId Overrides the auto-generated logical ID with a specific ID.
ResetOverrideLogicalId Resets a previously passed logical Id to use the auto-generated logical id again.
ToHclTerraform No description.
ToMetadata No description.
ToTerraform Adds this resource to the terraform JSON output.
AddMoveTarget Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move.
GetAnyMapAttribute No description.
GetBooleanAttribute No description.
GetBooleanMapAttribute No description.
GetListAttribute No description.
GetNumberAttribute No description.
GetNumberListAttribute No description.
GetNumberMapAttribute No description.
GetStringAttribute No description.
GetStringMapAttribute No description.
HasResourceMove No description.
ImportFrom No description.
InterpolationForAttribute No description.
MoveFromId Move the resource corresponding to "id" to this resource.
MoveTo Moves this resource to the target resource given by moveTarget.
MoveToId Moves this resource to the resource corresponding to "id".
PutTimeouts No description.
ResetAdditionalExperiments No description.
ResetEnableStreamingEngine No description.
ResetId No description.
ResetIpConfiguration No description.
ResetKmsKeyName No description.
ResetLabels No description.
ResetMachineType No description.
ResetMaxWorkers No description.
ResetNetwork No description.
ResetOnDelete No description.
ResetParameters No description.
ResetProject No description.
ResetRegion No description.
ResetServiceAccountEmail No description.
ResetSkipWaitOnJobTermination No description.
ResetSubnetwork No description.
ResetTimeouts No description.
ResetTransformNameMapping No description.
ResetZone No description.
ToString 
private string ToString()

Returns a string representation of this construct.

AddOverride 
private void AddOverride(string Path, object Value)
PathRequired
  • Type: string
ValueRequired
  • Type: object
OverrideLogicalId 
private void OverrideLogicalId(string NewLogicalId)

Overrides the auto-generated logical ID with a specific ID.

NewLogicalIdRequired
  • Type: string

The new logical ID to use for this stack element.

ResetOverrideLogicalId 
private void ResetOverrideLogicalId()

Resets a previously passed logical Id to use the auto-generated logical id again.

ToHclTerraform 
private object ToHclTerraform()
ToMetadata 
private object ToMetadata()
ToTerraform 
private object ToTerraform()

Adds this resource to the terraform JSON output.

AddMoveTarget 
private void AddMoveTarget(string MoveTarget)

Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move.

MoveTargetRequired
  • Type: string

The string move target that will correspond to this resource.

GetAnyMapAttribute 
private System.Collections.Generic.IDictionary<string, object> GetAnyMapAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string
GetBooleanAttribute 
private IResolvable GetBooleanAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string
GetBooleanMapAttribute 
private System.Collections.Generic.IDictionary<string, bool> GetBooleanMapAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string
GetListAttribute 
private string[] GetListAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string
GetNumberAttribute 
private double GetNumberAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string
GetNumberListAttribute 
private double[] GetNumberListAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string
GetNumberMapAttribute 
private System.Collections.Generic.IDictionary<string, double> GetNumberMapAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string
GetStringAttribute 
private string GetStringAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string
GetStringMapAttribute 
private System.Collections.Generic.IDictionary<string, string> GetStringMapAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string
HasResourceMove 
private object HasResourceMove()
ImportFrom 
private void ImportFrom(string Id, TerraformProvider Provider = null)
IdRequired
  • Type: string
ProviderOptional
  • Type: HashiCorp.Cdktf.TerraformProvider
InterpolationForAttribute 
private IResolvable InterpolationForAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string
MoveFromId 
private void MoveFromId(string Id)

Move the resource corresponding to "id" to this resource.

Note that the resource being moved from must be marked as moved using it's instance function.

IdRequired
  • Type: string

Full id of resource being moved from, e.g. "aws_s3_bucket.example".

MoveTo 
private void MoveTo(string MoveTarget, object Index = null)

Moves this resource to the target resource given by moveTarget.

MoveTargetRequired
  • Type: string

The previously set user defined string set by .addMoveTarget() corresponding to the resource to move to.

IndexOptional
  • Type: object

Optional The index corresponding to the key the resource is to appear in the foreach of a resource to move to.

MoveToId 
private void MoveToId(string Id)

Moves this resource to the resource corresponding to "id".

IdRequired
  • Type: string

Full id of resource to move to, e.g. "aws_s3_bucket.example".

PutTimeouts 
private void PutTimeouts(DataflowJobTimeouts Value)
ValueRequired
ResetAdditionalExperiments 
private void ResetAdditionalExperiments()
ResetEnableStreamingEngine 
private void ResetEnableStreamingEngine()
ResetId 
private void ResetId()
ResetIpConfiguration 
private void ResetIpConfiguration()
ResetKmsKeyName 
private void ResetKmsKeyName()
ResetLabels 
private void ResetLabels()
ResetMachineType 
private void ResetMachineType()
ResetMaxWorkers 
private void ResetMaxWorkers()
ResetNetwork 
private void ResetNetwork()
ResetOnDelete 
private void ResetOnDelete()
ResetParameters 
private void ResetParameters()
ResetProject 
private void ResetProject()
ResetRegion 
private void ResetRegion()
ResetServiceAccountEmail 
private void ResetServiceAccountEmail()
ResetSkipWaitOnJobTermination 
private void ResetSkipWaitOnJobTermination()
ResetSubnetwork 
private void ResetSubnetwork()
ResetTimeouts 
private void ResetTimeouts()
ResetTransformNameMapping 
private void ResetTransformNameMapping()
ResetZone 
private void ResetZone()

Static Functions

Name Description
IsConstruct Checks if x is a construct.
IsTerraformElement No description.
IsTerraformResource No description.
GenerateConfigForImport Generates CDKTF code for importing a DataflowJob resource upon running "cdktf plan ".
IsConstruct 
using HashiCorp.Cdktf.Providers.Google;

DataflowJob.IsConstruct(object X);

Checks if x is a construct.

Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.

XRequired
  • Type: object

Any object.

IsTerraformElement 
using HashiCorp.Cdktf.Providers.Google;

DataflowJob.IsTerraformElement(object X);
XRequired
  • Type: object
IsTerraformResource 
using HashiCorp.Cdktf.Providers.Google;

DataflowJob.IsTerraformResource(object X);
XRequired
  • Type: object
GenerateConfigForImport 
using HashiCorp.Cdktf.Providers.Google;

DataflowJob.GenerateConfigForImport(Construct Scope, string ImportToId, string ImportFromId, TerraformProvider Provider = null);

Generates CDKTF code for importing a DataflowJob resource upon running "cdktf plan ".

ScopeRequired
  • Type: Constructs.Construct

The scope in which to define this construct.

ImportToIdRequired
  • Type: string

The construct id used in the generated config for the DataflowJob to import.

ImportFromIdRequired
  • Type: string

The id of the existing DataflowJob that should be imported.

Refer to the {@link https://registry.terraform.io/providers/hashicorp/google/6.11.2/docs/resources/dataflow_job#import import section} in the documentation of this resource for the id to use

ProviderOptional
  • Type: HashiCorp.Cdktf.TerraformProvider

? Optional instance of the provider where the DataflowJob to import is found.

Properties

Name Type Description
Node Constructs.Node The tree node.
CdktfStack HashiCorp.Cdktf.TerraformStack No description.
Fqn string No description.
FriendlyUniqueId string No description.
TerraformMetaArguments System.Collections.Generic.IDictionary<string, object> No description.
TerraformResourceType string No description.
TerraformGeneratorMetadata HashiCorp.Cdktf.TerraformProviderGeneratorMetadata No description.
Connection object No description.
Count object No description.
DependsOn string[] No description.
ForEach HashiCorp.Cdktf.ITerraformIterator No description.
Lifecycle HashiCorp.Cdktf.TerraformResourceLifecycle No description.
Provider HashiCorp.Cdktf.TerraformProvider No description.
Provisioners object[] No description.
EffectiveLabels HashiCorp.Cdktf.StringMap No description.
JobId string No description.
State string No description.
TerraformLabels HashiCorp.Cdktf.StringMap No description.
Timeouts DataflowJobTimeoutsOutputReference No description.
Type string No description.
AdditionalExperimentsInput string[] No description.
EnableStreamingEngineInput object No description.
IdInput string No description.
IpConfigurationInput string No description.
KmsKeyNameInput string No description.
LabelsInput System.Collections.Generic.IDictionary<string, string> No description.
MachineTypeInput string No description.
MaxWorkersInput double No description.
NameInput string No description.
NetworkInput string No description.
OnDeleteInput string No description.
ParametersInput System.Collections.Generic.IDictionary<string, string> No description.
ProjectInput string No description.
RegionInput string No description.
ServiceAccountEmailInput string No description.
SkipWaitOnJobTerminationInput object No description.
SubnetworkInput string No description.
TempGcsLocationInput string No description.
TemplateGcsPathInput string No description.
TimeoutsInput object No description.
TransformNameMappingInput System.Collections.Generic.IDictionary<string, string> No description.
ZoneInput string No description.
AdditionalExperiments string[] No description.
EnableStreamingEngine object No description.
Id string No description.
IpConfiguration string No description.
KmsKeyName string No description.
Labels System.Collections.Generic.IDictionary<string, string> No description.
MachineType string No description.
MaxWorkers double No description.
Name string No description.
Network string No description.
OnDelete string No description.
Parameters System.Collections.Generic.IDictionary<string, string> No description.
Project string No description.
Region string No description.
ServiceAccountEmail string No description.
SkipWaitOnJobTermination object No description.
Subnetwork string No description.
TempGcsLocation string No description.
TemplateGcsPath string No description.
TransformNameMapping System.Collections.Generic.IDictionary<string, string> No description.
Zone string No description.
NodeRequired 
public Node Node { get; }
  • Type: Constructs.Node

The tree node.

CdktfStackRequired 
public TerraformStack CdktfStack { get; }
  • Type: HashiCorp.Cdktf.TerraformStack
FqnRequired 
public string Fqn { get; }
  • Type: string
FriendlyUniqueIdRequired 
public string FriendlyUniqueId { get; }
  • Type: string
TerraformMetaArgumentsRequired 
public System.Collections.Generic.IDictionary<string, object> TerraformMetaArguments { get; }
  • Type: System.Collections.Generic.IDictionary<string, object>
TerraformResourceTypeRequired 
public string TerraformResourceType { get; }
  • Type: string
TerraformGeneratorMetadataOptional 
public TerraformProviderGeneratorMetadata TerraformGeneratorMetadata { get; }
  • Type: HashiCorp.Cdktf.TerraformProviderGeneratorMetadata
ConnectionOptional 
public object Connection { get; }
  • Type: object
CountOptional 
public object Count { get; }
  • Type: object
DependsOnOptional 
public string[] DependsOn { get; }
  • Type: string[]
ForEachOptional 
public ITerraformIterator ForEach { get; }
  • Type: HashiCorp.Cdktf.ITerraformIterator
LifecycleOptional 
public TerraformResourceLifecycle Lifecycle { get; }
  • Type: HashiCorp.Cdktf.TerraformResourceLifecycle
ProviderOptional 
public TerraformProvider Provider { get; }
  • Type: HashiCorp.Cdktf.TerraformProvider
ProvisionersOptional 
public object[] Provisioners { get; }
  • Type: object[]
EffectiveLabelsRequired 
public StringMap EffectiveLabels { get; }
  • Type: HashiCorp.Cdktf.StringMap
JobIdRequired 
public string JobId { get; }
  • Type: string
StateRequired 
public string State { get; }
  • Type: string
TerraformLabelsRequired 
public StringMap TerraformLabels { get; }
  • Type: HashiCorp.Cdktf.StringMap
TimeoutsRequired 
public DataflowJobTimeoutsOutputReference Timeouts { get; }
TypeRequired 
public string Type { get; }
  • Type: string
AdditionalExperimentsInputOptional 
public string[] AdditionalExperimentsInput { get; }
  • Type: string[]
EnableStreamingEngineInputOptional 
public object EnableStreamingEngineInput { get; }
  • Type: object
IdInputOptional 
public string IdInput { get; }
  • Type: string
IpConfigurationInputOptional 
public string IpConfigurationInput { get; }
  • Type: string
KmsKeyNameInputOptional 
public string KmsKeyNameInput { get; }
  • Type: string
LabelsInputOptional 
public System.Collections.Generic.IDictionary<string, string> LabelsInput { get; }
  • Type: System.Collections.Generic.IDictionary<string, string>
MachineTypeInputOptional 
public string MachineTypeInput { get; }
  • Type: string
MaxWorkersInputOptional 
public double MaxWorkersInput { get; }
  • Type: double
NameInputOptional 
public string NameInput { get; }
  • Type: string
NetworkInputOptional 
public string NetworkInput { get; }
  • Type: string
OnDeleteInputOptional 
public string OnDeleteInput { get; }
  • Type: string
ParametersInputOptional 
public System.Collections.Generic.IDictionary<string, string> ParametersInput { get; }
  • Type: System.Collections.Generic.IDictionary<string, string>
ProjectInputOptional 
public string ProjectInput { get; }
  • Type: string
RegionInputOptional 
public string RegionInput { get; }
  • Type: string
ServiceAccountEmailInputOptional 
public string ServiceAccountEmailInput { get; }
  • Type: string
SkipWaitOnJobTerminationInputOptional 
public object SkipWaitOnJobTerminationInput { get; }
  • Type: object
SubnetworkInputOptional 
public string SubnetworkInput { get; }
  • Type: string
TempGcsLocationInputOptional 
public string TempGcsLocationInput { get; }
  • Type: string
TemplateGcsPathInputOptional 
public string TemplateGcsPathInput { get; }
  • Type: string
TimeoutsInputOptional 
public object TimeoutsInput { get; }
  • Type: object
TransformNameMappingInputOptional 
public System.Collections.Generic.IDictionary<string, string> TransformNameMappingInput { get; }
  • Type: System.Collections.Generic.IDictionary<string, string>
ZoneInputOptional 
public string ZoneInput { get; }
  • Type: string
AdditionalExperimentsRequired 
public string[] AdditionalExperiments { get; }
  • Type: string[]
EnableStreamingEngineRequired 
public object EnableStreamingEngine { get; }
  • Type: object
IdRequired 
public string Id { get; }
  • Type: string
IpConfigurationRequired 
public string IpConfiguration { get; }
  • Type: string
KmsKeyNameRequired 
public string KmsKeyName { get; }
  • Type: string
LabelsRequired 
public System.Collections.Generic.IDictionary<string, string> Labels { get; }
  • Type: System.Collections.Generic.IDictionary<string, string>
MachineTypeRequired 
public string MachineType { get; }
  • Type: string
MaxWorkersRequired 
public double MaxWorkers { get; }
  • Type: double
NameRequired 
public string Name { get; }
  • Type: string
NetworkRequired 
public string Network { get; }
  • Type: string
OnDeleteRequired 
public string OnDelete { get; }
  • Type: string
ParametersRequired 
public System.Collections.Generic.IDictionary<string, string> Parameters { get; }
  • Type: System.Collections.Generic.IDictionary<string, string>
ProjectRequired 
public string Project { get; }
  • Type: string
RegionRequired 
public string Region { get; }
  • Type: string
ServiceAccountEmailRequired 
public string ServiceAccountEmail { get; }
  • Type: string
SkipWaitOnJobTerminationRequired 
public object SkipWaitOnJobTermination { get; }
  • Type: object
SubnetworkRequired 
public string Subnetwork { get; }
  • Type: string
TempGcsLocationRequired 
public string TempGcsLocation { get; }
  • Type: string
TemplateGcsPathRequired 
public string TemplateGcsPath { get; }
  • Type: string
TransformNameMappingRequired 
public System.Collections.Generic.IDictionary<string, string> TransformNameMapping { get; }
  • Type: System.Collections.Generic.IDictionary<string, string>
ZoneRequired 
public string Zone { get; }
  • Type: string

Constants

Name Type Description
TfResourceType string No description.
TfResourceTypeRequired 
public string TfResourceType { get; }
  • Type: string

Structs

DataflowJobConfig

Initializer 

using HashiCorp.Cdktf.Providers.Google;

new DataflowJobConfig {
    object Connection = null,
    object Count = null,
    ITerraformDependable[] DependsOn = null,
    ITerraformIterator ForEach = null,
    TerraformResourceLifecycle Lifecycle = null,
    TerraformProvider Provider = null,
    object[] Provisioners = null,
    string Name,
    string TempGcsLocation,
    string TemplateGcsPath,
    string[] AdditionalExperiments = null,
    object EnableStreamingEngine = null,
    string Id = null,
    string IpConfiguration = null,
    string KmsKeyName = null,
    System.Collections.Generic.IDictionary<string, string> Labels = null,
    string MachineType = null,
    double MaxWorkers = null,
    string Network = null,
    string OnDelete = null,
    System.Collections.Generic.IDictionary<string, string> Parameters = null,
    string Project = null,
    string Region = null,
    string ServiceAccountEmail = null,
    object SkipWaitOnJobTermination = null,
    string Subnetwork = null,
    DataflowJobTimeouts Timeouts = null,
    System.Collections.Generic.IDictionary<string, string> TransformNameMapping = null,
    string Zone = null
};

Properties

Name Type Description
Connection object No description.
Count object No description.
DependsOn HashiCorp.Cdktf.ITerraformDependable[] No description.
ForEach HashiCorp.Cdktf.ITerraformIterator No description.
Lifecycle HashiCorp.Cdktf.TerraformResourceLifecycle No description.
Provider HashiCorp.Cdktf.TerraformProvider No description.
Provisioners object[] No description.
Name string A unique name for the resource, required by Dataflow.
TempGcsLocation string A writeable location on Google Cloud Storage for the Dataflow job to dump its temporary data.
TemplateGcsPath string The Google Cloud Storage path to the Dataflow job template.
AdditionalExperiments string[] List of experiments that should be used by the job. An example value is ["enable_stackdriver_agent_metrics"].
EnableStreamingEngine object Indicates if the job should use the streaming engine feature.
Id string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.11.2/docs/resources/dataflow_job#id DataflowJob#id}.
IpConfiguration string The configuration for VM IPs. Options are "WORKER_IP_PUBLIC" or "WORKER_IP_PRIVATE".
KmsKeyName string The name for the Cloud KMS key for the job. Key format is: projects/PROJECT_ID/locations/LOCATION/keyRings/KEY_RING/cryptoKeys/KEY.
Labels System.Collections.Generic.IDictionary<string, string> User labels to be specified for the job.
MachineType string The machine type to use for the job.
MaxWorkers double The number of workers permitted to work on the job. More workers may improve processing speed at additional cost.
Network string The network to which VMs will be assigned. If it is not provided, "default" will be used.
OnDelete string One of "drain" or "cancel". Specifies behavior of deletion during terraform destroy.
Parameters System.Collections.Generic.IDictionary<string, string> Key/Value pairs to be passed to the Dataflow job (as used in the template).
Project string The project in which the resource belongs.
Region string The region in which the created job should run.
ServiceAccountEmail string The Service Account email used to create the job.
SkipWaitOnJobTermination object If true, treat DRAINING and CANCELLING as terminal job states and do not wait for further changes before removing from terraform state and moving on.
Subnetwork string The subnetwork to which VMs will be assigned. Should be of the form "regions/REGION/subnetworks/SUBNETWORK".
Timeouts DataflowJobTimeouts timeouts block.
TransformNameMapping System.Collections.Generic.IDictionary<string, string> Only applicable when updating a pipeline.
Zone string The zone in which the created job should run. If it is not provided, the provider zone is used.
ConnectionOptional 
public object Connection { get; set; }
  • Type: object
CountOptional 
public object Count { get; set; }
  • Type: object
DependsOnOptional 
public ITerraformDependable[] DependsOn { get; set; }
  • Type: HashiCorp.Cdktf.ITerraformDependable[]
ForEachOptional 
public ITerraformIterator ForEach { get; set; }
  • Type: HashiCorp.Cdktf.ITerraformIterator
LifecycleOptional 
public TerraformResourceLifecycle Lifecycle { get; set; }
  • Type: HashiCorp.Cdktf.TerraformResourceLifecycle
ProviderOptional 
public TerraformProvider Provider { get; set; }
  • Type: HashiCorp.Cdktf.TerraformProvider
ProvisionersOptional 
public object[] Provisioners { get; set; }
  • Type: object[]
NameRequired 
public string Name { get; set; }
  • Type: string

A unique name for the resource, required by Dataflow.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.11.2/docs/resources/dataflow_job#name DataflowJob#name}

TempGcsLocationRequired 
public string TempGcsLocation { get; set; }
  • Type: string

A writeable location on Google Cloud Storage for the Dataflow job to dump its temporary data.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.11.2/docs/resources/dataflow_job#temp_gcs_location DataflowJob#temp_gcs_location}

TemplateGcsPathRequired 
public string TemplateGcsPath { get; set; }
  • Type: string

The Google Cloud Storage path to the Dataflow job template.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.11.2/docs/resources/dataflow_job#template_gcs_path DataflowJob#template_gcs_path}

AdditionalExperimentsOptional 
public string[] AdditionalExperiments { get; set; }
  • Type: string[]

List of experiments that should be used by the job. An example value is ["enable_stackdriver_agent_metrics"].

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.11.2/docs/resources/dataflow_job#additional_experiments DataflowJob#additional_experiments}

EnableStreamingEngineOptional 
public object EnableStreamingEngine { get; set; }
  • Type: object

Indicates if the job should use the streaming engine feature.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.11.2/docs/resources/dataflow_job#enable_streaming_engine DataflowJob#enable_streaming_engine}

IdOptional 
public string Id { get; set; }
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.11.2/docs/resources/dataflow_job#id DataflowJob#id}.

Please be aware that the id field is automatically added to all resources in Terraform providers using a Terraform provider SDK version below 2. If you experience problems setting this value it might not be settable. Please take a look at the provider documentation to ensure it should be settable.

IpConfigurationOptional 
public string IpConfiguration { get; set; }
  • Type: string

The configuration for VM IPs. Options are "WORKER_IP_PUBLIC" or "WORKER_IP_PRIVATE".

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.11.2/docs/resources/dataflow_job#ip_configuration DataflowJob#ip_configuration}

KmsKeyNameOptional 
public string KmsKeyName { get; set; }
  • Type: string

The name for the Cloud KMS key for the job. Key format is: projects/PROJECT_ID/locations/LOCATION/keyRings/KEY_RING/cryptoKeys/KEY.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.11.2/docs/resources/dataflow_job#kms_key_name DataflowJob#kms_key_name}

LabelsOptional 
public System.Collections.Generic.IDictionary<string, string> Labels { get; set; }
  • Type: System.Collections.Generic.IDictionary<string, string>

User labels to be specified for the job.

Keys and values should follow the restrictions specified in the labeling restrictions page. NOTE: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field 'effective_labels' for all of the labels present on the resource.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.11.2/docs/resources/dataflow_job#labels DataflowJob#labels}

MachineTypeOptional 
public string MachineType { get; set; }
  • Type: string

The machine type to use for the job.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.11.2/docs/resources/dataflow_job#machine_type DataflowJob#machine_type}

MaxWorkersOptional 
public double MaxWorkers { get; set; }
  • Type: double

The number of workers permitted to work on the job. More workers may improve processing speed at additional cost.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.11.2/docs/resources/dataflow_job#max_workers DataflowJob#max_workers}

NetworkOptional 
public string Network { get; set; }
  • Type: string

The network to which VMs will be assigned. If it is not provided, "default" will be used.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.11.2/docs/resources/dataflow_job#network DataflowJob#network}

OnDeleteOptional 
public string OnDelete { get; set; }
  • Type: string

One of "drain" or "cancel". Specifies behavior of deletion during terraform destroy.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.11.2/docs/resources/dataflow_job#on_delete DataflowJob#on_delete}

ParametersOptional 
public System.Collections.Generic.IDictionary<string, string> Parameters { get; set; }
  • Type: System.Collections.Generic.IDictionary<string, string>

Key/Value pairs to be passed to the Dataflow job (as used in the template).

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.11.2/docs/resources/dataflow_job#parameters DataflowJob#parameters}

ProjectOptional 
public string Project { get; set; }
  • Type: string

The project in which the resource belongs.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.11.2/docs/resources/dataflow_job#project DataflowJob#project}

RegionOptional 
public string Region { get; set; }
  • Type: string

The region in which the created job should run.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.11.2/docs/resources/dataflow_job#region DataflowJob#region}

ServiceAccountEmailOptional 
public string ServiceAccountEmail { get; set; }
  • Type: string

The Service Account email used to create the job.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.11.2/docs/resources/dataflow_job#service_account_email DataflowJob#service_account_email}

SkipWaitOnJobTerminationOptional 
public object SkipWaitOnJobTermination { get; set; }
  • Type: object

If true, treat DRAINING and CANCELLING as terminal job states and do not wait for further changes before removing from terraform state and moving on.

WARNING: this will lead to job name conflicts if you do not ensure that the job names are different, e.g. by embedding a release ID or by using a random_id.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.11.2/docs/resources/dataflow_job#skip_wait_on_job_termination DataflowJob#skip_wait_on_job_termination}

SubnetworkOptional 
public string Subnetwork { get; set; }
  • Type: string

The subnetwork to which VMs will be assigned. Should be of the form "regions/REGION/subnetworks/SUBNETWORK".

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.11.2/docs/resources/dataflow_job#subnetwork DataflowJob#subnetwork}

TimeoutsOptional 
public DataflowJobTimeouts Timeouts { get; set; }

timeouts block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.11.2/docs/resources/dataflow_job#timeouts DataflowJob#timeouts}

TransformNameMappingOptional 
public System.Collections.Generic.IDictionary<string, string> TransformNameMapping { get; set; }
  • Type: System.Collections.Generic.IDictionary<string, string>

Only applicable when updating a pipeline.

Map of transform name prefixes of the job to be replaced with the corresponding name prefixes of the new job.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.11.2/docs/resources/dataflow_job#transform_name_mapping DataflowJob#transform_name_mapping}

ZoneOptional 
public string Zone { get; set; }
  • Type: string

The zone in which the created job should run. If it is not provided, the provider zone is used.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.11.2/docs/resources/dataflow_job#zone DataflowJob#zone}

DataflowJobTimeouts

Initializer 

using HashiCorp.Cdktf.Providers.Google;

new DataflowJobTimeouts {
    string Update = null
};

Properties

Name Type Description
Update string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.11.2/docs/resources/dataflow_job#update DataflowJob#update}.
UpdateOptional 
public string Update { get; set; }
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.11.2/docs/resources/dataflow_job#update DataflowJob#update}.

Classes

DataflowJobTimeoutsOutputReference

Initializers 

using HashiCorp.Cdktf.Providers.Google;

new DataflowJobTimeoutsOutputReference(IInterpolatingParent TerraformResource, string TerraformAttribute);
Name Type Description
TerraformResource HashiCorp.Cdktf.IInterpolatingParent The parent resource.
TerraformAttribute string The attribute on the parent resource this class is referencing.
TerraformResourceRequired
  • Type: HashiCorp.Cdktf.IInterpolatingParent

The parent resource.

TerraformAttributeRequired
  • Type: string

The attribute on the parent resource this class is referencing.

Methods

Name Description
ComputeFqn No description.
GetAnyMapAttribute No description.
GetBooleanAttribute No description.
GetBooleanMapAttribute No description.
GetListAttribute No description.
GetNumberAttribute No description.
GetNumberListAttribute No description.
GetNumberMapAttribute No description.
GetStringAttribute No description.
GetStringMapAttribute No description.
InterpolationForAttribute No description.
Resolve Produce the Token's value at resolution time.
ToString Return a string representation of this resolvable object.
ResetUpdate No description.
ComputeFqn 
private string ComputeFqn()
GetAnyMapAttribute 
private System.Collections.Generic.IDictionary<string, object> GetAnyMapAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string
GetBooleanAttribute 
private IResolvable GetBooleanAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string
GetBooleanMapAttribute 
private System.Collections.Generic.IDictionary<string, bool> GetBooleanMapAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string
GetListAttribute 
private string[] GetListAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string
GetNumberAttribute 
private double GetNumberAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string
GetNumberListAttribute 
private double[] GetNumberListAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string
GetNumberMapAttribute 
private System.Collections.Generic.IDictionary<string, double> GetNumberMapAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string
GetStringAttribute 
private string GetStringAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string
GetStringMapAttribute 
private System.Collections.Generic.IDictionary<string, string> GetStringMapAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string
InterpolationForAttribute 
private IResolvable InterpolationForAttribute(string Property)
PropertyRequired
  • Type: string
Resolve 
private object Resolve(IResolveContext Context)

Produce the Token's value at resolution time.

ContextRequired
  • Type: HashiCorp.Cdktf.IResolveContext
ToString 
private string ToString()

Return a string representation of this resolvable object.

Returns a reversible string representation.

ResetUpdate 
private void ResetUpdate()

Properties

Name Type Description
CreationStack string[] The creation stack of this resolvable which will be appended to errors thrown during resolution.
Fqn string No description.
UpdateInput string No description.
Update string No description.
InternalValue object No description.
CreationStackRequired 
public string[] CreationStack { get; }
  • Type: string[]

The creation stack of this resolvable which will be appended to errors thrown during resolution.

If this returns an empty array the stack will not be attached.

FqnRequired 
public string Fqn { get; }
  • Type: string
UpdateInputOptional 
public string UpdateInput { get; }
  • Type: string
UpdateRequired 
public string Update { get; }
  • Type: string
InternalValueOptional 
public object InternalValue { get; }
  • Type: object