Skip to content

Latest commit

 

History

History
2124 lines (1334 loc) · 82.9 KB

dataflowJob.go.md

File metadata and controls

2124 lines (1334 loc) · 82.9 KB
Raw

dataflowJob Submodule

Constructs

DataflowJob

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

Initializers 

import "github.com/cdktf/cdktf-provider-google-go/google/v14/dataflowjob"

dataflowjob.NewDataflowJob(scope Construct, id *string, config DataflowJobConfig) DataflowJob
Name Type Description
scope github.com/aws/constructs-go/constructs/v10.Construct The scope in which to define this construct.
id *string The scoped construct ID.
config DataflowJobConfig No description.
scopeRequired
  • Type: github.com/aws/constructs-go/constructs/v10.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 
func ToString() *string

Returns a string representation of this construct.

AddOverride 
func AddOverride(path *string, value interface{})
pathRequired
  • Type: *string
valueRequired
  • Type: interface{}
OverrideLogicalId 
func OverrideLogicalId(newLogicalId *string)

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

newLogicalIdRequired
  • Type: *string

The new logical ID to use for this stack element.

ResetOverrideLogicalId 
func ResetOverrideLogicalId()

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

ToHclTerraform 
func ToHclTerraform() interface{}
ToMetadata 
func ToMetadata() interface{}
ToTerraform 
func ToTerraform() interface{}

Adds this resource to the terraform JSON output.

AddMoveTarget 
func AddMoveTarget(moveTarget *string)

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 
func GetAnyMapAttribute(terraformAttribute *string) *map[string]interface{}
terraformAttributeRequired
  • Type: *string
GetBooleanAttribute 
func GetBooleanAttribute(terraformAttribute *string) IResolvable
terraformAttributeRequired
  • Type: *string
GetBooleanMapAttribute 
func GetBooleanMapAttribute(terraformAttribute *string) *map[string]*bool
terraformAttributeRequired
  • Type: *string
GetListAttribute 
func GetListAttribute(terraformAttribute *string) *[]*string
terraformAttributeRequired
  • Type: *string
GetNumberAttribute 
func GetNumberAttribute(terraformAttribute *string) *f64
terraformAttributeRequired
  • Type: *string
GetNumberListAttribute 
func GetNumberListAttribute(terraformAttribute *string) *[]*f64
terraformAttributeRequired
  • Type: *string
GetNumberMapAttribute 
func GetNumberMapAttribute(terraformAttribute *string) *map[string]*f64
terraformAttributeRequired
  • Type: *string
GetStringAttribute 
func GetStringAttribute(terraformAttribute *string) *string
terraformAttributeRequired
  • Type: *string
GetStringMapAttribute 
func GetStringMapAttribute(terraformAttribute *string) *map[string]*string
terraformAttributeRequired
  • Type: *string
HasResourceMove 
func HasResourceMove() interface{}
ImportFrom 
func ImportFrom(id *string, provider TerraformProvider)
idRequired
  • Type: *string
providerOptional
  • Type: github.com/hashicorp/terraform-cdk-go/cdktf.TerraformProvider
InterpolationForAttribute 
func InterpolationForAttribute(terraformAttribute *string) IResolvable
terraformAttributeRequired
  • Type: *string
MoveFromId 
func MoveFromId(id *string)

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 
func MoveTo(moveTarget *string, index interface{})

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: interface{}

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

MoveToId 
func MoveToId(id *string)

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 
func PutTimeouts(value DataflowJobTimeouts)
valueRequired
ResetAdditionalExperiments 
func ResetAdditionalExperiments()
ResetEnableStreamingEngine 
func ResetEnableStreamingEngine()
ResetId 
func ResetId()
ResetIpConfiguration 
func ResetIpConfiguration()
ResetKmsKeyName 
func ResetKmsKeyName()
ResetLabels 
func ResetLabels()
ResetMachineType 
func ResetMachineType()
ResetMaxWorkers 
func ResetMaxWorkers()
ResetNetwork 
func ResetNetwork()
ResetOnDelete 
func ResetOnDelete()
ResetParameters 
func ResetParameters()
ResetProject 
func ResetProject()
ResetRegion 
func ResetRegion()
ResetServiceAccountEmail 
func ResetServiceAccountEmail()
ResetSkipWaitOnJobTermination 
func ResetSkipWaitOnJobTermination()
ResetSubnetwork 
func ResetSubnetwork()
ResetTimeouts 
func ResetTimeouts()
ResetTransformNameMapping 
func ResetTransformNameMapping()
ResetZone 
func 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 
import "github.com/cdktf/cdktf-provider-google-go/google/v14/dataflowjob"

dataflowjob.DataflowJob_IsConstruct(x interface{}) *bool

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: interface{}

Any object.

IsTerraformElement 
import "github.com/cdktf/cdktf-provider-google-go/google/v14/dataflowjob"

dataflowjob.DataflowJob_IsTerraformElement(x interface{}) *bool
xRequired
  • Type: interface{}
IsTerraformResource 
import "github.com/cdktf/cdktf-provider-google-go/google/v14/dataflowjob"

dataflowjob.DataflowJob_IsTerraformResource(x interface{}) *bool
xRequired
  • Type: interface{}
GenerateConfigForImport 
import "github.com/cdktf/cdktf-provider-google-go/google/v14/dataflowjob"

dataflowjob.DataflowJob_GenerateConfigForImport(scope Construct, importToId *string, importFromId *string, provider TerraformProvider) ImportableResource

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

scopeRequired
  • Type: github.com/aws/constructs-go/constructs/v10.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.14.1/docs/resources/dataflow_job#import import section} in the documentation of this resource for the id to use

providerOptional
  • Type: github.com/hashicorp/terraform-cdk-go/cdktf.TerraformProvider

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

Properties

Name Type Description
Node github.com/aws/constructs-go/constructs/v10.Node The tree node.
CdktfStack github.com/hashicorp/terraform-cdk-go/cdktf.TerraformStack No description.
Fqn *string No description.
FriendlyUniqueId *string No description.
TerraformMetaArguments *map[string]interface{} No description.
TerraformResourceType *string No description.
TerraformGeneratorMetadata github.com/hashicorp/terraform-cdk-go/cdktf.TerraformProviderGeneratorMetadata No description.
Connection interface{} No description.
Count interface{} No description.
DependsOn *[]*string No description.
ForEach github.com/hashicorp/terraform-cdk-go/cdktf.ITerraformIterator No description.
Lifecycle github.com/hashicorp/terraform-cdk-go/cdktf.TerraformResourceLifecycle No description.
Provider github.com/hashicorp/terraform-cdk-go/cdktf.TerraformProvider No description.
Provisioners *[]interface{} No description.
EffectiveLabels github.com/hashicorp/terraform-cdk-go/cdktf.StringMap No description.
JobId *string No description.
State *string No description.
TerraformLabels github.com/hashicorp/terraform-cdk-go/cdktf.StringMap No description.
Timeouts DataflowJobTimeoutsOutputReference No description.
Type *string No description.
AdditionalExperimentsInput *[]*string No description.
EnableStreamingEngineInput interface{} No description.
IdInput *string No description.
IpConfigurationInput *string No description.
KmsKeyNameInput *string No description.
LabelsInput *map[string]*string No description.
MachineTypeInput *string No description.
MaxWorkersInput *f64 No description.
NameInput *string No description.
NetworkInput *string No description.
OnDeleteInput *string No description.
ParametersInput *map[string]*string No description.
ProjectInput *string No description.
RegionInput *string No description.
ServiceAccountEmailInput *string No description.
SkipWaitOnJobTerminationInput interface{} No description.
SubnetworkInput *string No description.
TempGcsLocationInput *string No description.
TemplateGcsPathInput *string No description.
TimeoutsInput interface{} No description.
TransformNameMappingInput *map[string]*string No description.
ZoneInput *string No description.
AdditionalExperiments *[]*string No description.
EnableStreamingEngine interface{} No description.
Id *string No description.
IpConfiguration *string No description.
KmsKeyName *string No description.
Labels *map[string]*string No description.
MachineType *string No description.
MaxWorkers *f64 No description.
Name *string No description.
Network *string No description.
OnDelete *string No description.
Parameters *map[string]*string No description.
Project *string No description.
Region *string No description.
ServiceAccountEmail *string No description.
SkipWaitOnJobTermination interface{} No description.
Subnetwork *string No description.
TempGcsLocation *string No description.
TemplateGcsPath *string No description.
TransformNameMapping *map[string]*string No description.
Zone *string No description.
NodeRequired 
func Node() Node
  • Type: github.com/aws/constructs-go/constructs/v10.Node

The tree node.

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

Constants

Name Type Description
TfResourceType *string No description.
TfResourceTypeRequired 
func TfResourceType() *string
  • Type: *string

Structs

DataflowJobConfig

Initializer 

import "github.com/cdktf/cdktf-provider-google-go/google/v14/dataflowjob"

&dataflowjob.DataflowJobConfig {
	Connection: interface{},
	Count: interface{},
	DependsOn: *[]github.com/hashicorp/terraform-cdk-go/cdktf.ITerraformDependable,
	ForEach: github.com/hashicorp/terraform-cdk-go/cdktf.ITerraformIterator,
	Lifecycle: github.com/hashicorp/terraform-cdk-go/cdktf.TerraformResourceLifecycle,
	Provider: github.com/hashicorp/terraform-cdk-go/cdktf.TerraformProvider,
	Provisioners: *[]interface{},
	Name: *string,
	TempGcsLocation: *string,
	TemplateGcsPath: *string,
	AdditionalExperiments: *[]*string,
	EnableStreamingEngine: interface{},
	Id: *string,
	IpConfiguration: *string,
	KmsKeyName: *string,
	Labels: *map[string]*string,
	MachineType: *string,
	MaxWorkers: *f64,
	Network: *string,
	OnDelete: *string,
	Parameters: *map[string]*string,
	Project: *string,
	Region: *string,
	ServiceAccountEmail: *string,
	SkipWaitOnJobTermination: interface{},
	Subnetwork: *string,
	Timeouts: github.com/cdktf/cdktf-provider-google-go/google/v14.dataflowJob.DataflowJobTimeouts,
	TransformNameMapping: *map[string]*string,
	Zone: *string,
}

Properties

Name Type Description
Connection interface{} No description.
Count interface{} No description.
DependsOn *[]github.com/hashicorp/terraform-cdk-go/cdktf.ITerraformDependable No description.
ForEach github.com/hashicorp/terraform-cdk-go/cdktf.ITerraformIterator No description.
Lifecycle github.com/hashicorp/terraform-cdk-go/cdktf.TerraformResourceLifecycle No description.
Provider github.com/hashicorp/terraform-cdk-go/cdktf.TerraformProvider No description.
Provisioners *[]interface{} 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 interface{} 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.14.1/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 *map[string]*string User labels to be specified for the job.
MachineType *string The machine type to use for the job.
MaxWorkers *f64 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 *map[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 interface{} 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 *map[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 
Connection interface{}
  • Type: interface{}
CountOptional 
Count interface{}
  • Type: interface{}
DependsOnOptional 
DependsOn *[]ITerraformDependable
  • Type: *[]github.com/hashicorp/terraform-cdk-go/cdktf.ITerraformDependable
ForEachOptional 
ForEach ITerraformIterator
  • Type: github.com/hashicorp/terraform-cdk-go/cdktf.ITerraformIterator
LifecycleOptional 
Lifecycle TerraformResourceLifecycle
  • Type: github.com/hashicorp/terraform-cdk-go/cdktf.TerraformResourceLifecycle
ProviderOptional 
Provider TerraformProvider
  • Type: github.com/hashicorp/terraform-cdk-go/cdktf.TerraformProvider
ProvisionersOptional 
Provisioners *[]interface{}
  • Type: *[]interface{}
NameRequired 
Name *string
  • Type: *string

A unique name for the resource, required by Dataflow.

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

TempGcsLocationRequired 
TempGcsLocation *string
  • 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.14.1/docs/resources/dataflow_job#temp_gcs_location DataflowJob#temp_gcs_location}

TemplateGcsPathRequired 
TemplateGcsPath *string
  • 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.14.1/docs/resources/dataflow_job#template_gcs_path DataflowJob#template_gcs_path}

AdditionalExperimentsOptional 
AdditionalExperiments *[]*string
  • 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.14.1/docs/resources/dataflow_job#additional_experiments DataflowJob#additional_experiments}

EnableStreamingEngineOptional 
EnableStreamingEngine interface{}
  • Type: interface{}

Indicates if the job should use the streaming engine feature.

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

IdOptional 
Id *string
  • Type: *string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.14.1/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 
IpConfiguration *string
  • 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.14.1/docs/resources/dataflow_job#ip_configuration DataflowJob#ip_configuration}

KmsKeyNameOptional 
KmsKeyName *string
  • 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.14.1/docs/resources/dataflow_job#kms_key_name DataflowJob#kms_key_name}

LabelsOptional 
Labels *map[string]*string
  • Type: *map[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.14.1/docs/resources/dataflow_job#labels DataflowJob#labels}

MachineTypeOptional 
MachineType *string
  • Type: *string

The machine type to use for the job.

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

MaxWorkersOptional 
MaxWorkers *f64
  • Type: *f64

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.14.1/docs/resources/dataflow_job#max_workers DataflowJob#max_workers}

NetworkOptional 
Network *string
  • 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.14.1/docs/resources/dataflow_job#network DataflowJob#network}

OnDeleteOptional 
OnDelete *string
  • 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.14.1/docs/resources/dataflow_job#on_delete DataflowJob#on_delete}

ParametersOptional 
Parameters *map[string]*string
  • Type: *map[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.14.1/docs/resources/dataflow_job#parameters DataflowJob#parameters}

ProjectOptional 
Project *string
  • Type: *string

The project in which the resource belongs.

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

RegionOptional 
Region *string
  • Type: *string

The region in which the created job should run.

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

ServiceAccountEmailOptional 
ServiceAccountEmail *string
  • Type: *string

The Service Account email used to create the job.

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

SkipWaitOnJobTerminationOptional 
SkipWaitOnJobTermination interface{}
  • Type: interface{}

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.14.1/docs/resources/dataflow_job#skip_wait_on_job_termination DataflowJob#skip_wait_on_job_termination}

SubnetworkOptional 
Subnetwork *string
  • 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.14.1/docs/resources/dataflow_job#subnetwork DataflowJob#subnetwork}

TimeoutsOptional 
Timeouts DataflowJobTimeouts

timeouts block.

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

TransformNameMappingOptional 
TransformNameMapping *map[string]*string
  • Type: *map[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.14.1/docs/resources/dataflow_job#transform_name_mapping DataflowJob#transform_name_mapping}

ZoneOptional 
Zone *string
  • 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.14.1/docs/resources/dataflow_job#zone DataflowJob#zone}

DataflowJobTimeouts

Initializer 

import "github.com/cdktf/cdktf-provider-google-go/google/v14/dataflowjob"

&dataflowjob.DataflowJobTimeouts {
	Update: *string,
}

Properties

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

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

Classes

DataflowJobTimeoutsOutputReference

Initializers 

import "github.com/cdktf/cdktf-provider-google-go/google/v14/dataflowjob"

dataflowjob.NewDataflowJobTimeoutsOutputReference(terraformResource IInterpolatingParent, terraformAttribute *string) DataflowJobTimeoutsOutputReference
Name Type Description
terraformResource github.com/hashicorp/terraform-cdk-go/cdktf.IInterpolatingParent The parent resource.
terraformAttribute *string The attribute on the parent resource this class is referencing.
terraformResourceRequired
  • Type: github.com/hashicorp/terraform-cdk-go/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 
func ComputeFqn() *string
GetAnyMapAttribute 
func GetAnyMapAttribute(terraformAttribute *string) *map[string]interface{}
terraformAttributeRequired
  • Type: *string
GetBooleanAttribute 
func GetBooleanAttribute(terraformAttribute *string) IResolvable
terraformAttributeRequired
  • Type: *string
GetBooleanMapAttribute 
func GetBooleanMapAttribute(terraformAttribute *string) *map[string]*bool
terraformAttributeRequired
  • Type: *string
GetListAttribute 
func GetListAttribute(terraformAttribute *string) *[]*string
terraformAttributeRequired
  • Type: *string
GetNumberAttribute 
func GetNumberAttribute(terraformAttribute *string) *f64
terraformAttributeRequired
  • Type: *string
GetNumberListAttribute 
func GetNumberListAttribute(terraformAttribute *string) *[]*f64
terraformAttributeRequired
  • Type: *string
GetNumberMapAttribute 
func GetNumberMapAttribute(terraformAttribute *string) *map[string]*f64
terraformAttributeRequired
  • Type: *string
GetStringAttribute 
func GetStringAttribute(terraformAttribute *string) *string
terraformAttributeRequired
  • Type: *string
GetStringMapAttribute 
func GetStringMapAttribute(terraformAttribute *string) *map[string]*string
terraformAttributeRequired
  • Type: *string
InterpolationForAttribute 
func InterpolationForAttribute(property *string) IResolvable
propertyRequired
  • Type: *string
Resolve 
func Resolve(_context IResolveContext) interface{}

Produce the Token's value at resolution time.

_contextRequired
  • Type: github.com/hashicorp/terraform-cdk-go/cdktf.IResolveContext
ToString 
func ToString() *string

Return a string representation of this resolvable object.

Returns a reversible string representation.

ResetUpdate 
func 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 interface{} No description.
CreationStackRequired 
func CreationStack() *[]*string
  • 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 
func Fqn() *string
  • Type: *string
UpdateInputOptional 
func UpdateInput() *string
  • Type: *string
UpdateRequired 
func Update() *string
  • Type: *string
InternalValueOptional 
func InternalValue() interface{}
  • Type: interface{}