v1alpha2

package
v0.32.0 Latest Latest
Warning

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

Go to latest
Published: Nov 29, 2023 License: Apache-2.0 Imports: 8 Imported by: 0

Documentation

Index

Constants

View Source
const (
	// Default disk type. Use one of the other options below.
	DiskTypeTypeUnspecified = DiskType("TYPE_UNSPECIFIED")
	// Specifies a Google Compute Engine persistent hard disk. See https://cloud.google.com/compute/docs/disks/#pdspecs for details.
	DiskTypePersistentHdd = DiskType("PERSISTENT_HDD")
	// Specifies a Google Compute Engine persistent solid-state disk. See https://cloud.google.com/compute/docs/disks/#pdspecs for details.
	DiskTypePersistentSsd = DiskType("PERSISTENT_SSD")
	// Specifies a Google Compute Engine local SSD. See https://cloud.google.com/compute/docs/disks/local-ssd for details.
	DiskTypeLocalSsd = DiskType("LOCAL_SSD")
)

Variables

This section is empty.

Functions

This section is empty.

Types

type Disk

type Disk struct {
	// Deprecated. Disks created by the Pipelines API will be deleted at the end of the pipeline run, regardless of what this field is set to.
	//
	// Deprecated: Deprecated. Disks created by the Pipelines API will be deleted at the end of the pipeline run, regardless of what this field is set to.
	AutoDelete *bool `pulumi:"autoDelete"`
	// Required at create time and cannot be overridden at run time. Specifies the path in the docker container where files on this disk should be located. For example, if `mountPoint` is `/mnt/disk`, and the parameter has `localPath` `inputs/file.txt`, the docker container can access the data at `/mnt/disk/inputs/file.txt`.
	MountPoint *string `pulumi:"mountPoint"`
	// The name of the disk that can be used in the pipeline parameters. Must be 1 - 63 characters. The name "boot" is reserved for system use.
	Name string `pulumi:"name"`
	// Specifies how a sourced-base persistent disk will be mounted. See https://cloud.google.com/compute/docs/disks/persistent-disks#use_multi_instances for more details. Can only be set at create time.
	ReadOnly *bool `pulumi:"readOnly"`
	// The size of the disk. Defaults to 500 (GB). This field is not applicable for local SSD.
	SizeGb *int `pulumi:"sizeGb"`
	// The full or partial URL of the persistent disk to attach. See https://cloud.google.com/compute/docs/reference/latest/instances#resource and https://cloud.google.com/compute/docs/disks/persistent-disks#snapshots for more details.
	Source *string `pulumi:"source"`
	// The type of the disk to create.
	Type DiskType `pulumi:"type"`
}

A Google Compute Engine disk resource specification.

type DiskArgs

type DiskArgs struct {
	// Deprecated. Disks created by the Pipelines API will be deleted at the end of the pipeline run, regardless of what this field is set to.
	//
	// Deprecated: Deprecated. Disks created by the Pipelines API will be deleted at the end of the pipeline run, regardless of what this field is set to.
	AutoDelete pulumi.BoolPtrInput `pulumi:"autoDelete"`
	// Required at create time and cannot be overridden at run time. Specifies the path in the docker container where files on this disk should be located. For example, if `mountPoint` is `/mnt/disk`, and the parameter has `localPath` `inputs/file.txt`, the docker container can access the data at `/mnt/disk/inputs/file.txt`.
	MountPoint pulumi.StringPtrInput `pulumi:"mountPoint"`
	// The name of the disk that can be used in the pipeline parameters. Must be 1 - 63 characters. The name "boot" is reserved for system use.
	Name pulumi.StringInput `pulumi:"name"`
	// Specifies how a sourced-base persistent disk will be mounted. See https://cloud.google.com/compute/docs/disks/persistent-disks#use_multi_instances for more details. Can only be set at create time.
	ReadOnly pulumi.BoolPtrInput `pulumi:"readOnly"`
	// The size of the disk. Defaults to 500 (GB). This field is not applicable for local SSD.
	SizeGb pulumi.IntPtrInput `pulumi:"sizeGb"`
	// The full or partial URL of the persistent disk to attach. See https://cloud.google.com/compute/docs/reference/latest/instances#resource and https://cloud.google.com/compute/docs/disks/persistent-disks#snapshots for more details.
	Source pulumi.StringPtrInput `pulumi:"source"`
	// The type of the disk to create.
	Type DiskTypeInput `pulumi:"type"`
}

A Google Compute Engine disk resource specification.

func (DiskArgs) ElementType

func (DiskArgs) ElementType() reflect.Type

func (DiskArgs) ToDiskOutput

func (i DiskArgs) ToDiskOutput() DiskOutput

func (DiskArgs) ToDiskOutputWithContext

func (i DiskArgs) ToDiskOutputWithContext(ctx context.Context) DiskOutput

type DiskArray

type DiskArray []DiskInput

func (DiskArray) ElementType

func (DiskArray) ElementType() reflect.Type

func (DiskArray) ToDiskArrayOutput

func (i DiskArray) ToDiskArrayOutput() DiskArrayOutput

func (DiskArray) ToDiskArrayOutputWithContext

func (i DiskArray) ToDiskArrayOutputWithContext(ctx context.Context) DiskArrayOutput

type DiskArrayInput

type DiskArrayInput interface {
	pulumi.Input

	ToDiskArrayOutput() DiskArrayOutput
	ToDiskArrayOutputWithContext(context.Context) DiskArrayOutput
}

DiskArrayInput is an input type that accepts DiskArray and DiskArrayOutput values. You can construct a concrete instance of `DiskArrayInput` via:

DiskArray{ DiskArgs{...} }

type DiskArrayOutput

type DiskArrayOutput struct{ *pulumi.OutputState }

func (DiskArrayOutput) ElementType

func (DiskArrayOutput) ElementType() reflect.Type

func (DiskArrayOutput) Index

func (DiskArrayOutput) ToDiskArrayOutput

func (o DiskArrayOutput) ToDiskArrayOutput() DiskArrayOutput

func (DiskArrayOutput) ToDiskArrayOutputWithContext

func (o DiskArrayOutput) ToDiskArrayOutputWithContext(ctx context.Context) DiskArrayOutput

type DiskInput

type DiskInput interface {
	pulumi.Input

	ToDiskOutput() DiskOutput
	ToDiskOutputWithContext(context.Context) DiskOutput
}

DiskInput is an input type that accepts DiskArgs and DiskOutput values. You can construct a concrete instance of `DiskInput` via:

DiskArgs{...}

type DiskOutput

type DiskOutput struct{ *pulumi.OutputState }

A Google Compute Engine disk resource specification.

func (DiskOutput) AutoDelete deprecated added in v0.17.0

func (o DiskOutput) AutoDelete() pulumi.BoolPtrOutput

Deprecated. Disks created by the Pipelines API will be deleted at the end of the pipeline run, regardless of what this field is set to.

Deprecated: Deprecated. Disks created by the Pipelines API will be deleted at the end of the pipeline run, regardless of what this field is set to.

func (DiskOutput) ElementType

func (DiskOutput) ElementType() reflect.Type

func (DiskOutput) MountPoint

func (o DiskOutput) MountPoint() pulumi.StringPtrOutput

Required at create time and cannot be overridden at run time. Specifies the path in the docker container where files on this disk should be located. For example, if `mountPoint` is `/mnt/disk`, and the parameter has `localPath` `inputs/file.txt`, the docker container can access the data at `/mnt/disk/inputs/file.txt`.

func (DiskOutput) Name

func (o DiskOutput) Name() pulumi.StringOutput

The name of the disk that can be used in the pipeline parameters. Must be 1 - 63 characters. The name "boot" is reserved for system use.

func (DiskOutput) ReadOnly

func (o DiskOutput) ReadOnly() pulumi.BoolPtrOutput

Specifies how a sourced-base persistent disk will be mounted. See https://cloud.google.com/compute/docs/disks/persistent-disks#use_multi_instances for more details. Can only be set at create time.

func (DiskOutput) SizeGb

func (o DiskOutput) SizeGb() pulumi.IntPtrOutput

The size of the disk. Defaults to 500 (GB). This field is not applicable for local SSD.

func (DiskOutput) Source

func (o DiskOutput) Source() pulumi.StringPtrOutput

The full or partial URL of the persistent disk to attach. See https://cloud.google.com/compute/docs/reference/latest/instances#resource and https://cloud.google.com/compute/docs/disks/persistent-disks#snapshots for more details.

func (DiskOutput) ToDiskOutput

func (o DiskOutput) ToDiskOutput() DiskOutput

func (DiskOutput) ToDiskOutputWithContext

func (o DiskOutput) ToDiskOutputWithContext(ctx context.Context) DiskOutput

func (DiskOutput) Type

func (o DiskOutput) Type() DiskTypeOutput

The type of the disk to create.

type DiskResponse

type DiskResponse struct {
	// Deprecated. Disks created by the Pipelines API will be deleted at the end of the pipeline run, regardless of what this field is set to.
	//
	// Deprecated: Deprecated. Disks created by the Pipelines API will be deleted at the end of the pipeline run, regardless of what this field is set to.
	AutoDelete bool `pulumi:"autoDelete"`
	// Required at create time and cannot be overridden at run time. Specifies the path in the docker container where files on this disk should be located. For example, if `mountPoint` is `/mnt/disk`, and the parameter has `localPath` `inputs/file.txt`, the docker container can access the data at `/mnt/disk/inputs/file.txt`.
	MountPoint string `pulumi:"mountPoint"`
	// The name of the disk that can be used in the pipeline parameters. Must be 1 - 63 characters. The name "boot" is reserved for system use.
	Name string `pulumi:"name"`
	// Specifies how a sourced-base persistent disk will be mounted. See https://cloud.google.com/compute/docs/disks/persistent-disks#use_multi_instances for more details. Can only be set at create time.
	ReadOnly bool `pulumi:"readOnly"`
	// The size of the disk. Defaults to 500 (GB). This field is not applicable for local SSD.
	SizeGb int `pulumi:"sizeGb"`
	// The full or partial URL of the persistent disk to attach. See https://cloud.google.com/compute/docs/reference/latest/instances#resource and https://cloud.google.com/compute/docs/disks/persistent-disks#snapshots for more details.
	Source string `pulumi:"source"`
	// The type of the disk to create.
	Type string `pulumi:"type"`
}

A Google Compute Engine disk resource specification.

type DiskResponseArrayOutput

type DiskResponseArrayOutput struct{ *pulumi.OutputState }

func (DiskResponseArrayOutput) ElementType

func (DiskResponseArrayOutput) ElementType() reflect.Type

func (DiskResponseArrayOutput) Index

func (DiskResponseArrayOutput) ToDiskResponseArrayOutput

func (o DiskResponseArrayOutput) ToDiskResponseArrayOutput() DiskResponseArrayOutput

func (DiskResponseArrayOutput) ToDiskResponseArrayOutputWithContext

func (o DiskResponseArrayOutput) ToDiskResponseArrayOutputWithContext(ctx context.Context) DiskResponseArrayOutput

type DiskResponseOutput

type DiskResponseOutput struct{ *pulumi.OutputState }

A Google Compute Engine disk resource specification.

func (DiskResponseOutput) AutoDelete deprecated added in v0.17.0

func (o DiskResponseOutput) AutoDelete() pulumi.BoolOutput

Deprecated. Disks created by the Pipelines API will be deleted at the end of the pipeline run, regardless of what this field is set to.

Deprecated: Deprecated. Disks created by the Pipelines API will be deleted at the end of the pipeline run, regardless of what this field is set to.

func (DiskResponseOutput) ElementType

func (DiskResponseOutput) ElementType() reflect.Type

func (DiskResponseOutput) MountPoint

func (o DiskResponseOutput) MountPoint() pulumi.StringOutput

Required at create time and cannot be overridden at run time. Specifies the path in the docker container where files on this disk should be located. For example, if `mountPoint` is `/mnt/disk`, and the parameter has `localPath` `inputs/file.txt`, the docker container can access the data at `/mnt/disk/inputs/file.txt`.

func (DiskResponseOutput) Name

The name of the disk that can be used in the pipeline parameters. Must be 1 - 63 characters. The name "boot" is reserved for system use.

func (DiskResponseOutput) ReadOnly

func (o DiskResponseOutput) ReadOnly() pulumi.BoolOutput

Specifies how a sourced-base persistent disk will be mounted. See https://cloud.google.com/compute/docs/disks/persistent-disks#use_multi_instances for more details. Can only be set at create time.

func (DiskResponseOutput) SizeGb

func (o DiskResponseOutput) SizeGb() pulumi.IntOutput

The size of the disk. Defaults to 500 (GB). This field is not applicable for local SSD.

func (DiskResponseOutput) Source

The full or partial URL of the persistent disk to attach. See https://cloud.google.com/compute/docs/reference/latest/instances#resource and https://cloud.google.com/compute/docs/disks/persistent-disks#snapshots for more details.

func (DiskResponseOutput) ToDiskResponseOutput

func (o DiskResponseOutput) ToDiskResponseOutput() DiskResponseOutput

func (DiskResponseOutput) ToDiskResponseOutputWithContext

func (o DiskResponseOutput) ToDiskResponseOutputWithContext(ctx context.Context) DiskResponseOutput

func (DiskResponseOutput) Type

The type of the disk to create.

type DiskType added in v0.4.0

type DiskType string

Required. The type of the disk to create.

func (DiskType) ElementType added in v0.4.0

func (DiskType) ElementType() reflect.Type

func (DiskType) ToDiskTypeOutput added in v0.6.0

func (e DiskType) ToDiskTypeOutput() DiskTypeOutput

func (DiskType) ToDiskTypeOutputWithContext added in v0.6.0

func (e DiskType) ToDiskTypeOutputWithContext(ctx context.Context) DiskTypeOutput

func (DiskType) ToDiskTypePtrOutput added in v0.6.0

func (e DiskType) ToDiskTypePtrOutput() DiskTypePtrOutput

func (DiskType) ToDiskTypePtrOutputWithContext added in v0.6.0

func (e DiskType) ToDiskTypePtrOutputWithContext(ctx context.Context) DiskTypePtrOutput

func (DiskType) ToStringOutput added in v0.4.0

func (e DiskType) ToStringOutput() pulumi.StringOutput

func (DiskType) ToStringOutputWithContext added in v0.4.0

func (e DiskType) ToStringOutputWithContext(ctx context.Context) pulumi.StringOutput

func (DiskType) ToStringPtrOutput added in v0.4.0

func (e DiskType) ToStringPtrOutput() pulumi.StringPtrOutput

func (DiskType) ToStringPtrOutputWithContext added in v0.4.0

func (e DiskType) ToStringPtrOutputWithContext(ctx context.Context) pulumi.StringPtrOutput

type DiskTypeInput added in v0.6.0

type DiskTypeInput interface {
	pulumi.Input

	ToDiskTypeOutput() DiskTypeOutput
	ToDiskTypeOutputWithContext(context.Context) DiskTypeOutput
}

DiskTypeInput is an input type that accepts DiskTypeArgs and DiskTypeOutput values. You can construct a concrete instance of `DiskTypeInput` via:

DiskTypeArgs{...}

type DiskTypeOutput added in v0.6.0

type DiskTypeOutput struct{ *pulumi.OutputState }

func (DiskTypeOutput) ElementType added in v0.6.0

func (DiskTypeOutput) ElementType() reflect.Type

func (DiskTypeOutput) ToDiskTypeOutput added in v0.6.0

func (o DiskTypeOutput) ToDiskTypeOutput() DiskTypeOutput

func (DiskTypeOutput) ToDiskTypeOutputWithContext added in v0.6.0

func (o DiskTypeOutput) ToDiskTypeOutputWithContext(ctx context.Context) DiskTypeOutput

func (DiskTypeOutput) ToDiskTypePtrOutput added in v0.6.0

func (o DiskTypeOutput) ToDiskTypePtrOutput() DiskTypePtrOutput

func (DiskTypeOutput) ToDiskTypePtrOutputWithContext added in v0.6.0

func (o DiskTypeOutput) ToDiskTypePtrOutputWithContext(ctx context.Context) DiskTypePtrOutput

func (DiskTypeOutput) ToStringOutput added in v0.6.0

func (o DiskTypeOutput) ToStringOutput() pulumi.StringOutput

func (DiskTypeOutput) ToStringOutputWithContext added in v0.6.0

func (o DiskTypeOutput) ToStringOutputWithContext(ctx context.Context) pulumi.StringOutput

func (DiskTypeOutput) ToStringPtrOutput added in v0.6.0

func (o DiskTypeOutput) ToStringPtrOutput() pulumi.StringPtrOutput

func (DiskTypeOutput) ToStringPtrOutputWithContext added in v0.6.0

func (o DiskTypeOutput) ToStringPtrOutputWithContext(ctx context.Context) pulumi.StringPtrOutput

type DiskTypePtrInput added in v0.6.0

type DiskTypePtrInput interface {
	pulumi.Input

	ToDiskTypePtrOutput() DiskTypePtrOutput
	ToDiskTypePtrOutputWithContext(context.Context) DiskTypePtrOutput
}

func DiskTypePtr added in v0.6.0

func DiskTypePtr(v string) DiskTypePtrInput

type DiskTypePtrOutput added in v0.6.0

type DiskTypePtrOutput struct{ *pulumi.OutputState }

func (DiskTypePtrOutput) Elem added in v0.6.0

func (DiskTypePtrOutput) ElementType added in v0.6.0

func (DiskTypePtrOutput) ElementType() reflect.Type

func (DiskTypePtrOutput) ToDiskTypePtrOutput added in v0.6.0

func (o DiskTypePtrOutput) ToDiskTypePtrOutput() DiskTypePtrOutput

func (DiskTypePtrOutput) ToDiskTypePtrOutputWithContext added in v0.6.0

func (o DiskTypePtrOutput) ToDiskTypePtrOutputWithContext(ctx context.Context) DiskTypePtrOutput

func (DiskTypePtrOutput) ToStringPtrOutput added in v0.6.0

func (o DiskTypePtrOutput) ToStringPtrOutput() pulumi.StringPtrOutput

func (DiskTypePtrOutput) ToStringPtrOutputWithContext added in v0.6.0

func (o DiskTypePtrOutput) ToStringPtrOutputWithContext(ctx context.Context) pulumi.StringPtrOutput

type DockerExecutor

type DockerExecutor struct {
	// The command or newline delimited script to run. The command string will be executed within a bash shell. If the command exits with a non-zero exit code, output parameter de-localization will be skipped and the pipeline operation's `error` field will be populated. Maximum command string length is 16384.
	Cmd string `pulumi:"cmd"`
	// Image name from either Docker Hub or Google Container Registry. Users that run pipelines must have READ access to the image.
	ImageName string `pulumi:"imageName"`
}

The Docker execuctor specification.

type DockerExecutorArgs

type DockerExecutorArgs struct {
	// The command or newline delimited script to run. The command string will be executed within a bash shell. If the command exits with a non-zero exit code, output parameter de-localization will be skipped and the pipeline operation's `error` field will be populated. Maximum command string length is 16384.
	Cmd pulumi.StringInput `pulumi:"cmd"`
	// Image name from either Docker Hub or Google Container Registry. Users that run pipelines must have READ access to the image.
	ImageName pulumi.StringInput `pulumi:"imageName"`
}

The Docker execuctor specification.

func (DockerExecutorArgs) ElementType

func (DockerExecutorArgs) ElementType() reflect.Type

func (DockerExecutorArgs) ToDockerExecutorOutput

func (i DockerExecutorArgs) ToDockerExecutorOutput() DockerExecutorOutput

func (DockerExecutorArgs) ToDockerExecutorOutputWithContext

func (i DockerExecutorArgs) ToDockerExecutorOutputWithContext(ctx context.Context) DockerExecutorOutput

func (DockerExecutorArgs) ToDockerExecutorPtrOutput

func (i DockerExecutorArgs) ToDockerExecutorPtrOutput() DockerExecutorPtrOutput

func (DockerExecutorArgs) ToDockerExecutorPtrOutputWithContext

func (i DockerExecutorArgs) ToDockerExecutorPtrOutputWithContext(ctx context.Context) DockerExecutorPtrOutput

type DockerExecutorInput

type DockerExecutorInput interface {
	pulumi.Input

	ToDockerExecutorOutput() DockerExecutorOutput
	ToDockerExecutorOutputWithContext(context.Context) DockerExecutorOutput
}

DockerExecutorInput is an input type that accepts DockerExecutorArgs and DockerExecutorOutput values. You can construct a concrete instance of `DockerExecutorInput` via:

DockerExecutorArgs{...}

type DockerExecutorOutput

type DockerExecutorOutput struct{ *pulumi.OutputState }

The Docker execuctor specification.

func (DockerExecutorOutput) Cmd

The command or newline delimited script to run. The command string will be executed within a bash shell. If the command exits with a non-zero exit code, output parameter de-localization will be skipped and the pipeline operation's `error` field will be populated. Maximum command string length is 16384.

func (DockerExecutorOutput) ElementType

func (DockerExecutorOutput) ElementType() reflect.Type

func (DockerExecutorOutput) ImageName

Image name from either Docker Hub or Google Container Registry. Users that run pipelines must have READ access to the image.

func (DockerExecutorOutput) ToDockerExecutorOutput

func (o DockerExecutorOutput) ToDockerExecutorOutput() DockerExecutorOutput

func (DockerExecutorOutput) ToDockerExecutorOutputWithContext

func (o DockerExecutorOutput) ToDockerExecutorOutputWithContext(ctx context.Context) DockerExecutorOutput

func (DockerExecutorOutput) ToDockerExecutorPtrOutput

func (o DockerExecutorOutput) ToDockerExecutorPtrOutput() DockerExecutorPtrOutput

func (DockerExecutorOutput) ToDockerExecutorPtrOutputWithContext

func (o DockerExecutorOutput) ToDockerExecutorPtrOutputWithContext(ctx context.Context) DockerExecutorPtrOutput

type DockerExecutorPtrInput

type DockerExecutorPtrInput interface {
	pulumi.Input

	ToDockerExecutorPtrOutput() DockerExecutorPtrOutput
	ToDockerExecutorPtrOutputWithContext(context.Context) DockerExecutorPtrOutput
}

DockerExecutorPtrInput is an input type that accepts DockerExecutorArgs, DockerExecutorPtr and DockerExecutorPtrOutput values. You can construct a concrete instance of `DockerExecutorPtrInput` via:

        DockerExecutorArgs{...}

or:

        nil

type DockerExecutorPtrOutput

type DockerExecutorPtrOutput struct{ *pulumi.OutputState }

func (DockerExecutorPtrOutput) Cmd

The command or newline delimited script to run. The command string will be executed within a bash shell. If the command exits with a non-zero exit code, output parameter de-localization will be skipped and the pipeline operation's `error` field will be populated. Maximum command string length is 16384.

func (DockerExecutorPtrOutput) Elem

func (DockerExecutorPtrOutput) ElementType

func (DockerExecutorPtrOutput) ElementType() reflect.Type

func (DockerExecutorPtrOutput) ImageName

Image name from either Docker Hub or Google Container Registry. Users that run pipelines must have READ access to the image.

func (DockerExecutorPtrOutput) ToDockerExecutorPtrOutput

func (o DockerExecutorPtrOutput) ToDockerExecutorPtrOutput() DockerExecutorPtrOutput

func (DockerExecutorPtrOutput) ToDockerExecutorPtrOutputWithContext

func (o DockerExecutorPtrOutput) ToDockerExecutorPtrOutputWithContext(ctx context.Context) DockerExecutorPtrOutput

type DockerExecutorResponse

type DockerExecutorResponse struct {
	// The command or newline delimited script to run. The command string will be executed within a bash shell. If the command exits with a non-zero exit code, output parameter de-localization will be skipped and the pipeline operation's `error` field will be populated. Maximum command string length is 16384.
	Cmd string `pulumi:"cmd"`
	// Image name from either Docker Hub or Google Container Registry. Users that run pipelines must have READ access to the image.
	ImageName string `pulumi:"imageName"`
}

The Docker execuctor specification.

type DockerExecutorResponseOutput

type DockerExecutorResponseOutput struct{ *pulumi.OutputState }

The Docker execuctor specification.

func (DockerExecutorResponseOutput) Cmd

The command or newline delimited script to run. The command string will be executed within a bash shell. If the command exits with a non-zero exit code, output parameter de-localization will be skipped and the pipeline operation's `error` field will be populated. Maximum command string length is 16384.

func (DockerExecutorResponseOutput) ElementType

func (DockerExecutorResponseOutput) ImageName

Image name from either Docker Hub or Google Container Registry. Users that run pipelines must have READ access to the image.

func (DockerExecutorResponseOutput) ToDockerExecutorResponseOutput

func (o DockerExecutorResponseOutput) ToDockerExecutorResponseOutput() DockerExecutorResponseOutput

func (DockerExecutorResponseOutput) ToDockerExecutorResponseOutputWithContext

func (o DockerExecutorResponseOutput) ToDockerExecutorResponseOutputWithContext(ctx context.Context) DockerExecutorResponseOutput

type LocalCopy

type LocalCopy struct {
	// The name of the disk where this parameter is located. Can be the name of one of the disks specified in the Resources field, or "boot", which represents the Docker instance's boot disk and has a mount point of `/`.
	Disk string `pulumi:"disk"`
	// The path within the user's docker container where this input should be localized to and from, relative to the specified disk's mount point. For example: file.txt,
	Path string `pulumi:"path"`
}

LocalCopy defines how a remote file should be copied to and from the VM.

type LocalCopyArgs

type LocalCopyArgs struct {
	// The name of the disk where this parameter is located. Can be the name of one of the disks specified in the Resources field, or "boot", which represents the Docker instance's boot disk and has a mount point of `/`.
	Disk pulumi.StringInput `pulumi:"disk"`
	// The path within the user's docker container where this input should be localized to and from, relative to the specified disk's mount point. For example: file.txt,
	Path pulumi.StringInput `pulumi:"path"`
}

LocalCopy defines how a remote file should be copied to and from the VM.

func (LocalCopyArgs) ElementType

func (LocalCopyArgs) ElementType() reflect.Type

func (LocalCopyArgs) ToLocalCopyOutput

func (i LocalCopyArgs) ToLocalCopyOutput() LocalCopyOutput

func (LocalCopyArgs) ToLocalCopyOutputWithContext

func (i LocalCopyArgs) ToLocalCopyOutputWithContext(ctx context.Context) LocalCopyOutput

func (LocalCopyArgs) ToLocalCopyPtrOutput

func (i LocalCopyArgs) ToLocalCopyPtrOutput() LocalCopyPtrOutput

func (LocalCopyArgs) ToLocalCopyPtrOutputWithContext

func (i LocalCopyArgs) ToLocalCopyPtrOutputWithContext(ctx context.Context) LocalCopyPtrOutput

type LocalCopyInput

type LocalCopyInput interface {
	pulumi.Input

	ToLocalCopyOutput() LocalCopyOutput
	ToLocalCopyOutputWithContext(context.Context) LocalCopyOutput
}

LocalCopyInput is an input type that accepts LocalCopyArgs and LocalCopyOutput values. You can construct a concrete instance of `LocalCopyInput` via:

LocalCopyArgs{...}

type LocalCopyOutput

type LocalCopyOutput struct{ *pulumi.OutputState }

LocalCopy defines how a remote file should be copied to and from the VM.

func (LocalCopyOutput) Disk

The name of the disk where this parameter is located. Can be the name of one of the disks specified in the Resources field, or "boot", which represents the Docker instance's boot disk and has a mount point of `/`.

func (LocalCopyOutput) ElementType

func (LocalCopyOutput) ElementType() reflect.Type

func (LocalCopyOutput) Path

The path within the user's docker container where this input should be localized to and from, relative to the specified disk's mount point. For example: file.txt,

func (LocalCopyOutput) ToLocalCopyOutput

func (o LocalCopyOutput) ToLocalCopyOutput() LocalCopyOutput

func (LocalCopyOutput) ToLocalCopyOutputWithContext

func (o LocalCopyOutput) ToLocalCopyOutputWithContext(ctx context.Context) LocalCopyOutput

func (LocalCopyOutput) ToLocalCopyPtrOutput

func (o LocalCopyOutput) ToLocalCopyPtrOutput() LocalCopyPtrOutput

func (LocalCopyOutput) ToLocalCopyPtrOutputWithContext

func (o LocalCopyOutput) ToLocalCopyPtrOutputWithContext(ctx context.Context) LocalCopyPtrOutput

type LocalCopyPtrInput

type LocalCopyPtrInput interface {
	pulumi.Input

	ToLocalCopyPtrOutput() LocalCopyPtrOutput
	ToLocalCopyPtrOutputWithContext(context.Context) LocalCopyPtrOutput
}

LocalCopyPtrInput is an input type that accepts LocalCopyArgs, LocalCopyPtr and LocalCopyPtrOutput values. You can construct a concrete instance of `LocalCopyPtrInput` via:

        LocalCopyArgs{...}

or:

        nil

func LocalCopyPtr

func LocalCopyPtr(v *LocalCopyArgs) LocalCopyPtrInput

type LocalCopyPtrOutput

type LocalCopyPtrOutput struct{ *pulumi.OutputState }

func (LocalCopyPtrOutput) Disk

The name of the disk where this parameter is located. Can be the name of one of the disks specified in the Resources field, or "boot", which represents the Docker instance's boot disk and has a mount point of `/`.

func (LocalCopyPtrOutput) Elem

func (LocalCopyPtrOutput) ElementType

func (LocalCopyPtrOutput) ElementType() reflect.Type

func (LocalCopyPtrOutput) Path

The path within the user's docker container where this input should be localized to and from, relative to the specified disk's mount point. For example: file.txt,

func (LocalCopyPtrOutput) ToLocalCopyPtrOutput

func (o LocalCopyPtrOutput) ToLocalCopyPtrOutput() LocalCopyPtrOutput

func (LocalCopyPtrOutput) ToLocalCopyPtrOutputWithContext

func (o LocalCopyPtrOutput) ToLocalCopyPtrOutputWithContext(ctx context.Context) LocalCopyPtrOutput

type LocalCopyResponse

type LocalCopyResponse struct {
	// The name of the disk where this parameter is located. Can be the name of one of the disks specified in the Resources field, or "boot", which represents the Docker instance's boot disk and has a mount point of `/`.
	Disk string `pulumi:"disk"`
	// The path within the user's docker container where this input should be localized to and from, relative to the specified disk's mount point. For example: file.txt,
	Path string `pulumi:"path"`
}

LocalCopy defines how a remote file should be copied to and from the VM.

type LocalCopyResponseOutput

type LocalCopyResponseOutput struct{ *pulumi.OutputState }

LocalCopy defines how a remote file should be copied to and from the VM.

func (LocalCopyResponseOutput) Disk

The name of the disk where this parameter is located. Can be the name of one of the disks specified in the Resources field, or "boot", which represents the Docker instance's boot disk and has a mount point of `/`.

func (LocalCopyResponseOutput) ElementType

func (LocalCopyResponseOutput) ElementType() reflect.Type

func (LocalCopyResponseOutput) Path

The path within the user's docker container where this input should be localized to and from, relative to the specified disk's mount point. For example: file.txt,

func (LocalCopyResponseOutput) ToLocalCopyResponseOutput

func (o LocalCopyResponseOutput) ToLocalCopyResponseOutput() LocalCopyResponseOutput

func (LocalCopyResponseOutput) ToLocalCopyResponseOutputWithContext

func (o LocalCopyResponseOutput) ToLocalCopyResponseOutputWithContext(ctx context.Context) LocalCopyResponseOutput

type LookupPipelineArgs added in v0.4.0

type LookupPipelineArgs struct {
	PipelineId string `pulumi:"pipelineId"`
}

type LookupPipelineOutputArgs added in v0.8.0

type LookupPipelineOutputArgs struct {
	PipelineId pulumi.StringInput `pulumi:"pipelineId"`
}

func (LookupPipelineOutputArgs) ElementType added in v0.8.0

func (LookupPipelineOutputArgs) ElementType() reflect.Type

type LookupPipelineResult added in v0.4.0

type LookupPipelineResult struct {
	// User-specified description.
	Description string `pulumi:"description"`
	// Specifies the docker run information.
	Docker DockerExecutorResponse `pulumi:"docker"`
	// Input parameters of the pipeline.
	InputParameters []PipelineParameterResponse `pulumi:"inputParameters"`
	// A user specified pipeline name that does not have to be unique. This name can be used for filtering Pipelines in ListPipelines.
	Name string `pulumi:"name"`
	// Output parameters of the pipeline.
	OutputParameters []PipelineParameterResponse `pulumi:"outputParameters"`
	// Unique pipeline id that is generated by the service when CreatePipeline is called. Cannot be specified in the Pipeline used in the CreatePipelineRequest, and will be populated in the response to CreatePipeline and all subsequent Get and List calls. Indicates that the service has registered this pipeline.
	PipelineId string `pulumi:"pipelineId"`
	// The project in which to create the pipeline. The caller must have WRITE access.
	Project string `pulumi:"project"`
	// Specifies resource requirements for the pipeline run. Required fields: * minimumCpuCores * minimumRamGb
	Resources PipelineResourcesResponse `pulumi:"resources"`
}

func LookupPipeline added in v0.4.0

func LookupPipeline(ctx *pulumi.Context, args *LookupPipelineArgs, opts ...pulumi.InvokeOption) (*LookupPipelineResult, error)

Retrieves a pipeline based on ID. Caller must have READ permission to the project.

type LookupPipelineResultOutput added in v0.8.0

type LookupPipelineResultOutput struct{ *pulumi.OutputState }

func LookupPipelineOutput added in v0.8.0

func LookupPipelineOutput(ctx *pulumi.Context, args LookupPipelineOutputArgs, opts ...pulumi.InvokeOption) LookupPipelineResultOutput

func (LookupPipelineResultOutput) Description added in v0.8.0

User-specified description.

func (LookupPipelineResultOutput) Docker added in v0.8.0

Specifies the docker run information.

func (LookupPipelineResultOutput) ElementType added in v0.8.0

func (LookupPipelineResultOutput) ElementType() reflect.Type

func (LookupPipelineResultOutput) InputParameters added in v0.8.0

Input parameters of the pipeline.

func (LookupPipelineResultOutput) Name added in v0.8.0

A user specified pipeline name that does not have to be unique. This name can be used for filtering Pipelines in ListPipelines.

func (LookupPipelineResultOutput) OutputParameters added in v0.8.0

Output parameters of the pipeline.

func (LookupPipelineResultOutput) PipelineId added in v0.8.0

Unique pipeline id that is generated by the service when CreatePipeline is called. Cannot be specified in the Pipeline used in the CreatePipelineRequest, and will be populated in the response to CreatePipeline and all subsequent Get and List calls. Indicates that the service has registered this pipeline.

func (LookupPipelineResultOutput) Project added in v0.8.0

The project in which to create the pipeline. The caller must have WRITE access.

func (LookupPipelineResultOutput) Resources added in v0.8.0

Specifies resource requirements for the pipeline run. Required fields: * minimumCpuCores * minimumRamGb

func (LookupPipelineResultOutput) ToLookupPipelineResultOutput added in v0.8.0

func (o LookupPipelineResultOutput) ToLookupPipelineResultOutput() LookupPipelineResultOutput

func (LookupPipelineResultOutput) ToLookupPipelineResultOutputWithContext added in v0.8.0

func (o LookupPipelineResultOutput) ToLookupPipelineResultOutputWithContext(ctx context.Context) LookupPipelineResultOutput

type Pipeline

type Pipeline struct {
	pulumi.CustomResourceState

	// User-specified description.
	Description pulumi.StringOutput `pulumi:"description"`
	// Specifies the docker run information.
	Docker DockerExecutorResponseOutput `pulumi:"docker"`
	// Input parameters of the pipeline.
	InputParameters PipelineParameterResponseArrayOutput `pulumi:"inputParameters"`
	// A user specified pipeline name that does not have to be unique. This name can be used for filtering Pipelines in ListPipelines.
	Name pulumi.StringOutput `pulumi:"name"`
	// Output parameters of the pipeline.
	OutputParameters PipelineParameterResponseArrayOutput `pulumi:"outputParameters"`
	// Unique pipeline id that is generated by the service when CreatePipeline is called. Cannot be specified in the Pipeline used in the CreatePipelineRequest, and will be populated in the response to CreatePipeline and all subsequent Get and List calls. Indicates that the service has registered this pipeline.
	PipelineId pulumi.StringOutput `pulumi:"pipelineId"`
	// The project in which to create the pipeline. The caller must have WRITE access.
	Project pulumi.StringOutput `pulumi:"project"`
	// Specifies resource requirements for the pipeline run. Required fields: * minimumCpuCores * minimumRamGb
	Resources PipelineResourcesResponseOutput `pulumi:"resources"`
}

Creates a pipeline that can be run later. Create takes a Pipeline that has all fields other than `pipelineId` populated, and then returns the same pipeline with `pipelineId` populated. This id can be used to run the pipeline. Caller must have WRITE permission to the project.

func GetPipeline

func GetPipeline(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *PipelineState, opts ...pulumi.ResourceOption) (*Pipeline, error)

GetPipeline gets an existing Pipeline resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).

func NewPipeline

func NewPipeline(ctx *pulumi.Context,
	name string, args *PipelineArgs, opts ...pulumi.ResourceOption) (*Pipeline, error)

NewPipeline registers a new resource with the given unique name, arguments, and options.

func (*Pipeline) ElementType

func (*Pipeline) ElementType() reflect.Type

func (*Pipeline) ToPipelineOutput

func (i *Pipeline) ToPipelineOutput() PipelineOutput

func (*Pipeline) ToPipelineOutputWithContext

func (i *Pipeline) ToPipelineOutputWithContext(ctx context.Context) PipelineOutput

type PipelineArgs

type PipelineArgs struct {
	// User-specified description.
	Description pulumi.StringPtrInput
	// Specifies the docker run information.
	Docker DockerExecutorPtrInput
	// Input parameters of the pipeline.
	InputParameters PipelineParameterArrayInput
	// A user specified pipeline name that does not have to be unique. This name can be used for filtering Pipelines in ListPipelines.
	Name pulumi.StringPtrInput
	// Output parameters of the pipeline.
	OutputParameters PipelineParameterArrayInput
	// Unique pipeline id that is generated by the service when CreatePipeline is called. Cannot be specified in the Pipeline used in the CreatePipelineRequest, and will be populated in the response to CreatePipeline and all subsequent Get and List calls. Indicates that the service has registered this pipeline.
	PipelineId pulumi.StringPtrInput
	// The project in which to create the pipeline. The caller must have WRITE access.
	Project pulumi.StringPtrInput
	// Specifies resource requirements for the pipeline run. Required fields: * minimumCpuCores * minimumRamGb
	Resources PipelineResourcesInput
}

The set of arguments for constructing a Pipeline resource.

func (PipelineArgs) ElementType

func (PipelineArgs) ElementType() reflect.Type

type PipelineInput

type PipelineInput interface {
	pulumi.Input

	ToPipelineOutput() PipelineOutput
	ToPipelineOutputWithContext(ctx context.Context) PipelineOutput
}

type PipelineOutput

type PipelineOutput struct{ *pulumi.OutputState }

func (PipelineOutput) Description added in v0.19.0

func (o PipelineOutput) Description() pulumi.StringOutput

User-specified description.

func (PipelineOutput) Docker added in v0.19.0

Specifies the docker run information.

func (PipelineOutput) ElementType

func (PipelineOutput) ElementType() reflect.Type

func (PipelineOutput) InputParameters added in v0.19.0

Input parameters of the pipeline.

func (PipelineOutput) Name added in v0.19.0

A user specified pipeline name that does not have to be unique. This name can be used for filtering Pipelines in ListPipelines.

func (PipelineOutput) OutputParameters added in v0.19.0

Output parameters of the pipeline.

func (PipelineOutput) PipelineId added in v0.19.0

func (o PipelineOutput) PipelineId() pulumi.StringOutput

Unique pipeline id that is generated by the service when CreatePipeline is called. Cannot be specified in the Pipeline used in the CreatePipelineRequest, and will be populated in the response to CreatePipeline and all subsequent Get and List calls. Indicates that the service has registered this pipeline.

func (PipelineOutput) Project added in v0.19.0

func (o PipelineOutput) Project() pulumi.StringOutput

The project in which to create the pipeline. The caller must have WRITE access.

func (PipelineOutput) Resources added in v0.19.0

Specifies resource requirements for the pipeline run. Required fields: * minimumCpuCores * minimumRamGb

func (PipelineOutput) ToPipelineOutput

func (o PipelineOutput) ToPipelineOutput() PipelineOutput

func (PipelineOutput) ToPipelineOutputWithContext

func (o PipelineOutput) ToPipelineOutputWithContext(ctx context.Context) PipelineOutput

type PipelineParameter

type PipelineParameter struct {
	// The default value for this parameter. Can be overridden at runtime. If `localCopy` is present, then this must be a Google Cloud Storage path beginning with `gs://`.
	DefaultValue *string `pulumi:"defaultValue"`
	// Human-readable description.
	Description *string `pulumi:"description"`
	// If present, this parameter is marked for copying to and from the VM. `LocalCopy` indicates where on the VM the file should be. The value given to this parameter (either at runtime or using `defaultValue`) must be the remote path where the file should be.
	LocalCopy *LocalCopy `pulumi:"localCopy"`
	// Name of the parameter - the pipeline runner uses this string as the key to the input and output maps in RunPipeline.
	Name string `pulumi:"name"`
}

Parameters facilitate setting and delivering data into the pipeline's execution environment. They are defined at create time, with optional defaults, and can be overridden at run time. If `localCopy` is unset, then the parameter specifies a string that is passed as-is into the pipeline, as the value of the environment variable with the given name. A default value can be optionally specified at create time. The default can be overridden at run time using the inputs map. If no default is given, a value must be supplied at runtime. If `localCopy` is defined, then the parameter specifies a data source or sink, both in Google Cloud Storage and on the Docker container where the pipeline computation is run. The service account associated with the Pipeline (by default the project's Compute Engine service account) must have access to the Google Cloud Storage paths. At run time, the Google Cloud Storage paths can be overridden if a default was provided at create time, or must be set otherwise. The pipeline runner should add a key/value pair to either the inputs or outputs map. The indicated data copies will be carried out before/after pipeline execution, just as if the corresponding arguments were provided to `gsutil cp`. For example: Given the following `PipelineParameter`, specified in the `inputParameters` list: ```{name: "input_file", localCopy: {path: "file.txt", disk: "pd1"}}``` where `disk` is defined in the `PipelineResources` object as: ```{name: "pd1", mountPoint: "/mnt/disk/"}``` We create a disk named `pd1`, mount it on the host VM, and map `/mnt/pd1` to `/mnt/disk` in the docker container. At runtime, an entry for `input_file` would be required in the inputs map, such as: ```inputs["input_file"] = "gs://my-bucket/bar.txt"``` This would generate the following gsutil call: ```gsutil cp gs://my-bucket/bar.txt /mnt/pd1/file.txt``` The file `/mnt/pd1/file.txt` maps to `/mnt/disk/file.txt` in the Docker container. Acceptable paths are: Google Cloud storage pathLocal path file file glob directory For outputs, the direction of the copy is reversed: ```gsutil cp /mnt/disk/file.txt gs://my-bucket/bar.txt``` Acceptable paths are: Local pathGoogle Cloud Storage path file file file directory - directory must already exist glob directory - directory will be created if it doesn't exist One restriction due to docker limitations, is that for outputs that are found on the boot disk, the local path cannot be a glob and must be a file.

type PipelineParameterArgs

type PipelineParameterArgs struct {
	// The default value for this parameter. Can be overridden at runtime. If `localCopy` is present, then this must be a Google Cloud Storage path beginning with `gs://`.
	DefaultValue pulumi.StringPtrInput `pulumi:"defaultValue"`
	// Human-readable description.
	Description pulumi.StringPtrInput `pulumi:"description"`
	// If present, this parameter is marked for copying to and from the VM. `LocalCopy` indicates where on the VM the file should be. The value given to this parameter (either at runtime or using `defaultValue`) must be the remote path where the file should be.
	LocalCopy LocalCopyPtrInput `pulumi:"localCopy"`
	// Name of the parameter - the pipeline runner uses this string as the key to the input and output maps in RunPipeline.
	Name pulumi.StringInput `pulumi:"name"`
}

Parameters facilitate setting and delivering data into the pipeline's execution environment. They are defined at create time, with optional defaults, and can be overridden at run time. If `localCopy` is unset, then the parameter specifies a string that is passed as-is into the pipeline, as the value of the environment variable with the given name. A default value can be optionally specified at create time. The default can be overridden at run time using the inputs map. If no default is given, a value must be supplied at runtime. If `localCopy` is defined, then the parameter specifies a data source or sink, both in Google Cloud Storage and on the Docker container where the pipeline computation is run. The service account associated with the Pipeline (by default the project's Compute Engine service account) must have access to the Google Cloud Storage paths. At run time, the Google Cloud Storage paths can be overridden if a default was provided at create time, or must be set otherwise. The pipeline runner should add a key/value pair to either the inputs or outputs map. The indicated data copies will be carried out before/after pipeline execution, just as if the corresponding arguments were provided to `gsutil cp`. For example: Given the following `PipelineParameter`, specified in the `inputParameters` list: ```{name: "input_file", localCopy: {path: "file.txt", disk: "pd1"}}``` where `disk` is defined in the `PipelineResources` object as: ```{name: "pd1", mountPoint: "/mnt/disk/"}``` We create a disk named `pd1`, mount it on the host VM, and map `/mnt/pd1` to `/mnt/disk` in the docker container. At runtime, an entry for `input_file` would be required in the inputs map, such as: ```inputs["input_file"] = "gs://my-bucket/bar.txt"``` This would generate the following gsutil call: ```gsutil cp gs://my-bucket/bar.txt /mnt/pd1/file.txt``` The file `/mnt/pd1/file.txt` maps to `/mnt/disk/file.txt` in the Docker container. Acceptable paths are: Google Cloud storage pathLocal path file file glob directory For outputs, the direction of the copy is reversed: ```gsutil cp /mnt/disk/file.txt gs://my-bucket/bar.txt``` Acceptable paths are: Local pathGoogle Cloud Storage path file file file directory - directory must already exist glob directory - directory will be created if it doesn't exist One restriction due to docker limitations, is that for outputs that are found on the boot disk, the local path cannot be a glob and must be a file.

func (PipelineParameterArgs) ElementType

func (PipelineParameterArgs) ElementType() reflect.Type

func (PipelineParameterArgs) ToPipelineParameterOutput

func (i PipelineParameterArgs) ToPipelineParameterOutput() PipelineParameterOutput

func (PipelineParameterArgs) ToPipelineParameterOutputWithContext

func (i PipelineParameterArgs) ToPipelineParameterOutputWithContext(ctx context.Context) PipelineParameterOutput

type PipelineParameterArray

type PipelineParameterArray []PipelineParameterInput

func (PipelineParameterArray) ElementType

func (PipelineParameterArray) ElementType() reflect.Type

func (PipelineParameterArray) ToPipelineParameterArrayOutput

func (i PipelineParameterArray) ToPipelineParameterArrayOutput() PipelineParameterArrayOutput

func (PipelineParameterArray) ToPipelineParameterArrayOutputWithContext

func (i PipelineParameterArray) ToPipelineParameterArrayOutputWithContext(ctx context.Context) PipelineParameterArrayOutput

type PipelineParameterArrayInput

type PipelineParameterArrayInput interface {
	pulumi.Input

	ToPipelineParameterArrayOutput() PipelineParameterArrayOutput
	ToPipelineParameterArrayOutputWithContext(context.Context) PipelineParameterArrayOutput
}

PipelineParameterArrayInput is an input type that accepts PipelineParameterArray and PipelineParameterArrayOutput values. You can construct a concrete instance of `PipelineParameterArrayInput` via:

PipelineParameterArray{ PipelineParameterArgs{...} }

type PipelineParameterArrayOutput

type PipelineParameterArrayOutput struct{ *pulumi.OutputState }

func (PipelineParameterArrayOutput) ElementType

func (PipelineParameterArrayOutput) Index

func (PipelineParameterArrayOutput) ToPipelineParameterArrayOutput

func (o PipelineParameterArrayOutput) ToPipelineParameterArrayOutput() PipelineParameterArrayOutput

func (PipelineParameterArrayOutput) ToPipelineParameterArrayOutputWithContext

func (o PipelineParameterArrayOutput) ToPipelineParameterArrayOutputWithContext(ctx context.Context) PipelineParameterArrayOutput

type PipelineParameterInput

type PipelineParameterInput interface {
	pulumi.Input

	ToPipelineParameterOutput() PipelineParameterOutput
	ToPipelineParameterOutputWithContext(context.Context) PipelineParameterOutput
}

PipelineParameterInput is an input type that accepts PipelineParameterArgs and PipelineParameterOutput values. You can construct a concrete instance of `PipelineParameterInput` via:

PipelineParameterArgs{...}

type PipelineParameterOutput

type PipelineParameterOutput struct{ *pulumi.OutputState }

Parameters facilitate setting and delivering data into the pipeline's execution environment. They are defined at create time, with optional defaults, and can be overridden at run time. If `localCopy` is unset, then the parameter specifies a string that is passed as-is into the pipeline, as the value of the environment variable with the given name. A default value can be optionally specified at create time. The default can be overridden at run time using the inputs map. If no default is given, a value must be supplied at runtime. If `localCopy` is defined, then the parameter specifies a data source or sink, both in Google Cloud Storage and on the Docker container where the pipeline computation is run. The service account associated with the Pipeline (by default the project's Compute Engine service account) must have access to the Google Cloud Storage paths. At run time, the Google Cloud Storage paths can be overridden if a default was provided at create time, or must be set otherwise. The pipeline runner should add a key/value pair to either the inputs or outputs map. The indicated data copies will be carried out before/after pipeline execution, just as if the corresponding arguments were provided to `gsutil cp`. For example: Given the following `PipelineParameter`, specified in the `inputParameters` list: ```{name: "input_file", localCopy: {path: "file.txt", disk: "pd1"}}``` where `disk` is defined in the `PipelineResources` object as: ```{name: "pd1", mountPoint: "/mnt/disk/"}``` We create a disk named `pd1`, mount it on the host VM, and map `/mnt/pd1` to `/mnt/disk` in the docker container. At runtime, an entry for `input_file` would be required in the inputs map, such as: ```inputs["input_file"] = "gs://my-bucket/bar.txt"``` This would generate the following gsutil call: ```gsutil cp gs://my-bucket/bar.txt /mnt/pd1/file.txt``` The file `/mnt/pd1/file.txt` maps to `/mnt/disk/file.txt` in the Docker container. Acceptable paths are: Google Cloud storage pathLocal path file file glob directory For outputs, the direction of the copy is reversed: ```gsutil cp /mnt/disk/file.txt gs://my-bucket/bar.txt``` Acceptable paths are: Local pathGoogle Cloud Storage path file file file directory - directory must already exist glob directory - directory will be created if it doesn't exist One restriction due to docker limitations, is that for outputs that are found on the boot disk, the local path cannot be a glob and must be a file.

func (PipelineParameterOutput) DefaultValue

The default value for this parameter. Can be overridden at runtime. If `localCopy` is present, then this must be a Google Cloud Storage path beginning with `gs://`.

func (PipelineParameterOutput) Description

Human-readable description.

func (PipelineParameterOutput) ElementType

func (PipelineParameterOutput) ElementType() reflect.Type

func (PipelineParameterOutput) LocalCopy

If present, this parameter is marked for copying to and from the VM. `LocalCopy` indicates where on the VM the file should be. The value given to this parameter (either at runtime or using `defaultValue`) must be the remote path where the file should be.

func (PipelineParameterOutput) Name

Name of the parameter - the pipeline runner uses this string as the key to the input and output maps in RunPipeline.

func (PipelineParameterOutput) ToPipelineParameterOutput

func (o PipelineParameterOutput) ToPipelineParameterOutput() PipelineParameterOutput

func (PipelineParameterOutput) ToPipelineParameterOutputWithContext

func (o PipelineParameterOutput) ToPipelineParameterOutputWithContext(ctx context.Context) PipelineParameterOutput

type PipelineParameterResponse

type PipelineParameterResponse struct {
	// The default value for this parameter. Can be overridden at runtime. If `localCopy` is present, then this must be a Google Cloud Storage path beginning with `gs://`.
	DefaultValue string `pulumi:"defaultValue"`
	// Human-readable description.
	Description string `pulumi:"description"`
	// If present, this parameter is marked for copying to and from the VM. `LocalCopy` indicates where on the VM the file should be. The value given to this parameter (either at runtime or using `defaultValue`) must be the remote path where the file should be.
	LocalCopy LocalCopyResponse `pulumi:"localCopy"`
	// Name of the parameter - the pipeline runner uses this string as the key to the input and output maps in RunPipeline.
	Name string `pulumi:"name"`
}

Parameters facilitate setting and delivering data into the pipeline's execution environment. They are defined at create time, with optional defaults, and can be overridden at run time. If `localCopy` is unset, then the parameter specifies a string that is passed as-is into the pipeline, as the value of the environment variable with the given name. A default value can be optionally specified at create time. The default can be overridden at run time using the inputs map. If no default is given, a value must be supplied at runtime. If `localCopy` is defined, then the parameter specifies a data source or sink, both in Google Cloud Storage and on the Docker container where the pipeline computation is run. The service account associated with the Pipeline (by default the project's Compute Engine service account) must have access to the Google Cloud Storage paths. At run time, the Google Cloud Storage paths can be overridden if a default was provided at create time, or must be set otherwise. The pipeline runner should add a key/value pair to either the inputs or outputs map. The indicated data copies will be carried out before/after pipeline execution, just as if the corresponding arguments were provided to `gsutil cp`. For example: Given the following `PipelineParameter`, specified in the `inputParameters` list: ```{name: "input_file", localCopy: {path: "file.txt", disk: "pd1"}}``` where `disk` is defined in the `PipelineResources` object as: ```{name: "pd1", mountPoint: "/mnt/disk/"}``` We create a disk named `pd1`, mount it on the host VM, and map `/mnt/pd1` to `/mnt/disk` in the docker container. At runtime, an entry for `input_file` would be required in the inputs map, such as: ```inputs["input_file"] = "gs://my-bucket/bar.txt"``` This would generate the following gsutil call: ```gsutil cp gs://my-bucket/bar.txt /mnt/pd1/file.txt``` The file `/mnt/pd1/file.txt` maps to `/mnt/disk/file.txt` in the Docker container. Acceptable paths are: Google Cloud storage pathLocal path file file glob directory For outputs, the direction of the copy is reversed: ```gsutil cp /mnt/disk/file.txt gs://my-bucket/bar.txt``` Acceptable paths are: Local pathGoogle Cloud Storage path file file file directory - directory must already exist glob directory - directory will be created if it doesn't exist One restriction due to docker limitations, is that for outputs that are found on the boot disk, the local path cannot be a glob and must be a file.

type PipelineParameterResponseArrayOutput

type PipelineParameterResponseArrayOutput struct{ *pulumi.OutputState }

func (PipelineParameterResponseArrayOutput) ElementType

func (PipelineParameterResponseArrayOutput) Index

func (PipelineParameterResponseArrayOutput) ToPipelineParameterResponseArrayOutput

func (o PipelineParameterResponseArrayOutput) ToPipelineParameterResponseArrayOutput() PipelineParameterResponseArrayOutput

func (PipelineParameterResponseArrayOutput) ToPipelineParameterResponseArrayOutputWithContext

func (o PipelineParameterResponseArrayOutput) ToPipelineParameterResponseArrayOutputWithContext(ctx context.Context) PipelineParameterResponseArrayOutput

type PipelineParameterResponseOutput

type PipelineParameterResponseOutput struct{ *pulumi.OutputState }

Parameters facilitate setting and delivering data into the pipeline's execution environment. They are defined at create time, with optional defaults, and can be overridden at run time. If `localCopy` is unset, then the parameter specifies a string that is passed as-is into the pipeline, as the value of the environment variable with the given name. A default value can be optionally specified at create time. The default can be overridden at run time using the inputs map. If no default is given, a value must be supplied at runtime. If `localCopy` is defined, then the parameter specifies a data source or sink, both in Google Cloud Storage and on the Docker container where the pipeline computation is run. The service account associated with the Pipeline (by default the project's Compute Engine service account) must have access to the Google Cloud Storage paths. At run time, the Google Cloud Storage paths can be overridden if a default was provided at create time, or must be set otherwise. The pipeline runner should add a key/value pair to either the inputs or outputs map. The indicated data copies will be carried out before/after pipeline execution, just as if the corresponding arguments were provided to `gsutil cp`. For example: Given the following `PipelineParameter`, specified in the `inputParameters` list: ```{name: "input_file", localCopy: {path: "file.txt", disk: "pd1"}}``` where `disk` is defined in the `PipelineResources` object as: ```{name: "pd1", mountPoint: "/mnt/disk/"}``` We create a disk named `pd1`, mount it on the host VM, and map `/mnt/pd1` to `/mnt/disk` in the docker container. At runtime, an entry for `input_file` would be required in the inputs map, such as: ```inputs["input_file"] = "gs://my-bucket/bar.txt"``` This would generate the following gsutil call: ```gsutil cp gs://my-bucket/bar.txt /mnt/pd1/file.txt``` The file `/mnt/pd1/file.txt` maps to `/mnt/disk/file.txt` in the Docker container. Acceptable paths are: Google Cloud storage pathLocal path file file glob directory For outputs, the direction of the copy is reversed: ```gsutil cp /mnt/disk/file.txt gs://my-bucket/bar.txt``` Acceptable paths are: Local pathGoogle Cloud Storage path file file file directory - directory must already exist glob directory - directory will be created if it doesn't exist One restriction due to docker limitations, is that for outputs that are found on the boot disk, the local path cannot be a glob and must be a file.

func (PipelineParameterResponseOutput) DefaultValue

The default value for this parameter. Can be overridden at runtime. If `localCopy` is present, then this must be a Google Cloud Storage path beginning with `gs://`.

func (PipelineParameterResponseOutput) Description

Human-readable description.

func (PipelineParameterResponseOutput) ElementType

func (PipelineParameterResponseOutput) LocalCopy

If present, this parameter is marked for copying to and from the VM. `LocalCopy` indicates where on the VM the file should be. The value given to this parameter (either at runtime or using `defaultValue`) must be the remote path where the file should be.

func (PipelineParameterResponseOutput) Name

Name of the parameter - the pipeline runner uses this string as the key to the input and output maps in RunPipeline.

func (PipelineParameterResponseOutput) ToPipelineParameterResponseOutput

func (o PipelineParameterResponseOutput) ToPipelineParameterResponseOutput() PipelineParameterResponseOutput

func (PipelineParameterResponseOutput) ToPipelineParameterResponseOutputWithContext

func (o PipelineParameterResponseOutput) ToPipelineParameterResponseOutputWithContext(ctx context.Context) PipelineParameterResponseOutput

type PipelineResources

type PipelineResources struct {
	// Optional. The number of accelerators of the specified type to attach. By specifying this parameter, you will download and install the following third-party software onto your managed Compute Engine instances: NVIDIA® Tesla® drivers and NVIDIA® CUDA toolkit.
	AcceleratorCount *string `pulumi:"acceleratorCount"`
	// Optional. The Compute Engine defined accelerator type. By specifying this parameter, you will download and install the following third-party software onto your managed Compute Engine instances: NVIDIA® Tesla® drivers and NVIDIA® CUDA toolkit. Please see https://cloud.google.com/compute/docs/gpus/ for a list of available accelerator types.
	AcceleratorType *string `pulumi:"acceleratorType"`
	// The size of the boot disk. Defaults to 10 (GB).
	BootDiskSizeGb *int `pulumi:"bootDiskSizeGb"`
	// Disks to attach.
	Disks []Disk `pulumi:"disks"`
	// The minimum number of cores to use. Defaults to 1.
	MinimumCpuCores *int `pulumi:"minimumCpuCores"`
	// The minimum amount of RAM to use. Defaults to 3.75 (GB)
	MinimumRamGb *float64 `pulumi:"minimumRamGb"`
	// Whether to assign an external IP to the instance. This is an experimental feature that may go away. Defaults to false. Corresponds to `--no_address` flag for [gcloud compute instances create] (https://cloud.google.com/sdk/gcloud/reference/compute/instances/create). In order to use this, must be true for both create time and run time. Cannot be true at run time if false at create time. If you need to ssh into a private IP VM for debugging, you can ssh to a public VM and then ssh into the private VM's Internal IP. If noAddress is set, this pipeline run may only load docker images from Google Container Registry and not Docker Hub. Before using this, you must [configure access to Google services from internal IPs](https://cloud.google.com/compute/docs/configure-private-google-access#configuring_access_to_google_services_from_internal_ips).
	NoAddress *bool `pulumi:"noAddress"`
	// Whether to use preemptible VMs. Defaults to `false`. In order to use this, must be true for both create time and run time. Cannot be true at run time if false at create time.
	Preemptible *bool `pulumi:"preemptible"`
	// List of Google Compute Engine availability zones to which resource creation will restricted. If empty, any zone may be chosen.
	Zones []string `pulumi:"zones"`
}

The system resources for the pipeline run.

type PipelineResourcesArgs

type PipelineResourcesArgs struct {
	// Optional. The number of accelerators of the specified type to attach. By specifying this parameter, you will download and install the following third-party software onto your managed Compute Engine instances: NVIDIA® Tesla® drivers and NVIDIA® CUDA toolkit.
	AcceleratorCount pulumi.StringPtrInput `pulumi:"acceleratorCount"`
	// Optional. The Compute Engine defined accelerator type. By specifying this parameter, you will download and install the following third-party software onto your managed Compute Engine instances: NVIDIA® Tesla® drivers and NVIDIA® CUDA toolkit. Please see https://cloud.google.com/compute/docs/gpus/ for a list of available accelerator types.
	AcceleratorType pulumi.StringPtrInput `pulumi:"acceleratorType"`
	// The size of the boot disk. Defaults to 10 (GB).
	BootDiskSizeGb pulumi.IntPtrInput `pulumi:"bootDiskSizeGb"`
	// Disks to attach.
	Disks DiskArrayInput `pulumi:"disks"`
	// The minimum number of cores to use. Defaults to 1.
	MinimumCpuCores pulumi.IntPtrInput `pulumi:"minimumCpuCores"`
	// The minimum amount of RAM to use. Defaults to 3.75 (GB)
	MinimumRamGb pulumi.Float64PtrInput `pulumi:"minimumRamGb"`
	// Whether to assign an external IP to the instance. This is an experimental feature that may go away. Defaults to false. Corresponds to `--no_address` flag for [gcloud compute instances create] (https://cloud.google.com/sdk/gcloud/reference/compute/instances/create). In order to use this, must be true for both create time and run time. Cannot be true at run time if false at create time. If you need to ssh into a private IP VM for debugging, you can ssh to a public VM and then ssh into the private VM's Internal IP. If noAddress is set, this pipeline run may only load docker images from Google Container Registry and not Docker Hub. Before using this, you must [configure access to Google services from internal IPs](https://cloud.google.com/compute/docs/configure-private-google-access#configuring_access_to_google_services_from_internal_ips).
	NoAddress pulumi.BoolPtrInput `pulumi:"noAddress"`
	// Whether to use preemptible VMs. Defaults to `false`. In order to use this, must be true for both create time and run time. Cannot be true at run time if false at create time.
	Preemptible pulumi.BoolPtrInput `pulumi:"preemptible"`
	// List of Google Compute Engine availability zones to which resource creation will restricted. If empty, any zone may be chosen.
	Zones pulumi.StringArrayInput `pulumi:"zones"`
}

The system resources for the pipeline run.

func (PipelineResourcesArgs) ElementType

func (PipelineResourcesArgs) ElementType() reflect.Type

func (PipelineResourcesArgs) ToPipelineResourcesOutput

func (i PipelineResourcesArgs) ToPipelineResourcesOutput() PipelineResourcesOutput

func (PipelineResourcesArgs) ToPipelineResourcesOutputWithContext

func (i PipelineResourcesArgs) ToPipelineResourcesOutputWithContext(ctx context.Context) PipelineResourcesOutput

type PipelineResourcesInput

type PipelineResourcesInput interface {
	pulumi.Input

	ToPipelineResourcesOutput() PipelineResourcesOutput
	ToPipelineResourcesOutputWithContext(context.Context) PipelineResourcesOutput
}

PipelineResourcesInput is an input type that accepts PipelineResourcesArgs and PipelineResourcesOutput values. You can construct a concrete instance of `PipelineResourcesInput` via:

PipelineResourcesArgs{...}

type PipelineResourcesOutput

type PipelineResourcesOutput struct{ *pulumi.OutputState }

The system resources for the pipeline run.

func (PipelineResourcesOutput) AcceleratorCount

func (o PipelineResourcesOutput) AcceleratorCount() pulumi.StringPtrOutput

Optional. The number of accelerators of the specified type to attach. By specifying this parameter, you will download and install the following third-party software onto your managed Compute Engine instances: NVIDIA® Tesla® drivers and NVIDIA® CUDA toolkit.

func (PipelineResourcesOutput) AcceleratorType

func (o PipelineResourcesOutput) AcceleratorType() pulumi.StringPtrOutput

Optional. The Compute Engine defined accelerator type. By specifying this parameter, you will download and install the following third-party software onto your managed Compute Engine instances: NVIDIA® Tesla® drivers and NVIDIA® CUDA toolkit. Please see https://cloud.google.com/compute/docs/gpus/ for a list of available accelerator types.

func (PipelineResourcesOutput) BootDiskSizeGb

func (o PipelineResourcesOutput) BootDiskSizeGb() pulumi.IntPtrOutput

The size of the boot disk. Defaults to 10 (GB).

func (PipelineResourcesOutput) Disks

Disks to attach.

func (PipelineResourcesOutput) ElementType

func (PipelineResourcesOutput) ElementType() reflect.Type

func (PipelineResourcesOutput) MinimumCpuCores

func (o PipelineResourcesOutput) MinimumCpuCores() pulumi.IntPtrOutput

The minimum number of cores to use. Defaults to 1.

func (PipelineResourcesOutput) MinimumRamGb

The minimum amount of RAM to use. Defaults to 3.75 (GB)

func (PipelineResourcesOutput) NoAddress

Whether to assign an external IP to the instance. This is an experimental feature that may go away. Defaults to false. Corresponds to `--no_address` flag for [gcloud compute instances create] (https://cloud.google.com/sdk/gcloud/reference/compute/instances/create). In order to use this, must be true for both create time and run time. Cannot be true at run time if false at create time. If you need to ssh into a private IP VM for debugging, you can ssh to a public VM and then ssh into the private VM's Internal IP. If noAddress is set, this pipeline run may only load docker images from Google Container Registry and not Docker Hub. Before using this, you must [configure access to Google services from internal IPs](https://cloud.google.com/compute/docs/configure-private-google-access#configuring_access_to_google_services_from_internal_ips).

func (PipelineResourcesOutput) Preemptible

Whether to use preemptible VMs. Defaults to `false`. In order to use this, must be true for both create time and run time. Cannot be true at run time if false at create time.

func (PipelineResourcesOutput) ToPipelineResourcesOutput

func (o PipelineResourcesOutput) ToPipelineResourcesOutput() PipelineResourcesOutput

func (PipelineResourcesOutput) ToPipelineResourcesOutputWithContext

func (o PipelineResourcesOutput) ToPipelineResourcesOutputWithContext(ctx context.Context) PipelineResourcesOutput

func (PipelineResourcesOutput) Zones

List of Google Compute Engine availability zones to which resource creation will restricted. If empty, any zone may be chosen.

type PipelineResourcesResponse

type PipelineResourcesResponse struct {
	// Optional. The number of accelerators of the specified type to attach. By specifying this parameter, you will download and install the following third-party software onto your managed Compute Engine instances: NVIDIA® Tesla® drivers and NVIDIA® CUDA toolkit.
	AcceleratorCount string `pulumi:"acceleratorCount"`
	// Optional. The Compute Engine defined accelerator type. By specifying this parameter, you will download and install the following third-party software onto your managed Compute Engine instances: NVIDIA® Tesla® drivers and NVIDIA® CUDA toolkit. Please see https://cloud.google.com/compute/docs/gpus/ for a list of available accelerator types.
	AcceleratorType string `pulumi:"acceleratorType"`
	// The size of the boot disk. Defaults to 10 (GB).
	BootDiskSizeGb int `pulumi:"bootDiskSizeGb"`
	// Disks to attach.
	Disks []DiskResponse `pulumi:"disks"`
	// The minimum number of cores to use. Defaults to 1.
	MinimumCpuCores int `pulumi:"minimumCpuCores"`
	// The minimum amount of RAM to use. Defaults to 3.75 (GB)
	MinimumRamGb float64 `pulumi:"minimumRamGb"`
	// Whether to assign an external IP to the instance. This is an experimental feature that may go away. Defaults to false. Corresponds to `--no_address` flag for [gcloud compute instances create] (https://cloud.google.com/sdk/gcloud/reference/compute/instances/create). In order to use this, must be true for both create time and run time. Cannot be true at run time if false at create time. If you need to ssh into a private IP VM for debugging, you can ssh to a public VM and then ssh into the private VM's Internal IP. If noAddress is set, this pipeline run may only load docker images from Google Container Registry and not Docker Hub. Before using this, you must [configure access to Google services from internal IPs](https://cloud.google.com/compute/docs/configure-private-google-access#configuring_access_to_google_services_from_internal_ips).
	NoAddress bool `pulumi:"noAddress"`
	// Whether to use preemptible VMs. Defaults to `false`. In order to use this, must be true for both create time and run time. Cannot be true at run time if false at create time.
	Preemptible bool `pulumi:"preemptible"`
	// List of Google Compute Engine availability zones to which resource creation will restricted. If empty, any zone may be chosen.
	Zones []string `pulumi:"zones"`
}

The system resources for the pipeline run.

type PipelineResourcesResponseOutput

type PipelineResourcesResponseOutput struct{ *pulumi.OutputState }

The system resources for the pipeline run.

func (PipelineResourcesResponseOutput) AcceleratorCount

Optional. The number of accelerators of the specified type to attach. By specifying this parameter, you will download and install the following third-party software onto your managed Compute Engine instances: NVIDIA® Tesla® drivers and NVIDIA® CUDA toolkit.

func (PipelineResourcesResponseOutput) AcceleratorType

Optional. The Compute Engine defined accelerator type. By specifying this parameter, you will download and install the following third-party software onto your managed Compute Engine instances: NVIDIA® Tesla® drivers and NVIDIA® CUDA toolkit. Please see https://cloud.google.com/compute/docs/gpus/ for a list of available accelerator types.

func (PipelineResourcesResponseOutput) BootDiskSizeGb

The size of the boot disk. Defaults to 10 (GB).

func (PipelineResourcesResponseOutput) Disks

Disks to attach.

func (PipelineResourcesResponseOutput) ElementType

func (PipelineResourcesResponseOutput) MinimumCpuCores

func (o PipelineResourcesResponseOutput) MinimumCpuCores() pulumi.IntOutput

The minimum number of cores to use. Defaults to 1.

func (PipelineResourcesResponseOutput) MinimumRamGb

The minimum amount of RAM to use. Defaults to 3.75 (GB)

func (PipelineResourcesResponseOutput) NoAddress

Whether to assign an external IP to the instance. This is an experimental feature that may go away. Defaults to false. Corresponds to `--no_address` flag for [gcloud compute instances create] (https://cloud.google.com/sdk/gcloud/reference/compute/instances/create). In order to use this, must be true for both create time and run time. Cannot be true at run time if false at create time. If you need to ssh into a private IP VM for debugging, you can ssh to a public VM and then ssh into the private VM's Internal IP. If noAddress is set, this pipeline run may only load docker images from Google Container Registry and not Docker Hub. Before using this, you must [configure access to Google services from internal IPs](https://cloud.google.com/compute/docs/configure-private-google-access#configuring_access_to_google_services_from_internal_ips).

func (PipelineResourcesResponseOutput) Preemptible

Whether to use preemptible VMs. Defaults to `false`. In order to use this, must be true for both create time and run time. Cannot be true at run time if false at create time.

func (PipelineResourcesResponseOutput) ToPipelineResourcesResponseOutput

func (o PipelineResourcesResponseOutput) ToPipelineResourcesResponseOutput() PipelineResourcesResponseOutput

func (PipelineResourcesResponseOutput) ToPipelineResourcesResponseOutputWithContext

func (o PipelineResourcesResponseOutput) ToPipelineResourcesResponseOutputWithContext(ctx context.Context) PipelineResourcesResponseOutput

func (PipelineResourcesResponseOutput) Zones

List of Google Compute Engine availability zones to which resource creation will restricted. If empty, any zone may be chosen.

type PipelineState

type PipelineState struct {
}

func (PipelineState) ElementType

func (PipelineState) ElementType() reflect.Type

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL