v1

package
v0.17.0 Latest Latest
Warning

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

 Go to latest Published: Mar 17, 2022 License: Apache-2.0 Imports: 6 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type EmailPreferences 

type EmailPreferences struct {
	// If true, email notifications will be sent on transfer run failures.
	EnableFailureEmail *bool `pulumi:"enableFailureEmail"`
}

Represents preferences for sending email notifications for transfer run events.

type EmailPreferencesArgs 

type EmailPreferencesArgs struct {
	// If true, email notifications will be sent on transfer run failures.
	EnableFailureEmail pulumi.BoolPtrInput `pulumi:"enableFailureEmail"`
}

Represents preferences for sending email notifications for transfer run events.

func (EmailPreferencesArgs) ElementType 

func (EmailPreferencesArgs) ElementType() reflect.Type

func (EmailPreferencesArgs) ToEmailPreferencesOutput 

func (i EmailPreferencesArgs) ToEmailPreferencesOutput() EmailPreferencesOutput

func (EmailPreferencesArgs) ToEmailPreferencesOutputWithContext 

func (i EmailPreferencesArgs) ToEmailPreferencesOutputWithContext(ctx context.Context) EmailPreferencesOutput

func (EmailPreferencesArgs) ToEmailPreferencesPtrOutput 

func (i EmailPreferencesArgs) ToEmailPreferencesPtrOutput() EmailPreferencesPtrOutput

func (EmailPreferencesArgs) ToEmailPreferencesPtrOutputWithContext 

func (i EmailPreferencesArgs) ToEmailPreferencesPtrOutputWithContext(ctx context.Context) EmailPreferencesPtrOutput

type EmailPreferencesInput 

type EmailPreferencesInput interface {
	pulumi.Input

	ToEmailPreferencesOutput() EmailPreferencesOutput
	ToEmailPreferencesOutputWithContext(context.Context) EmailPreferencesOutput
}

EmailPreferencesInput is an input type that accepts EmailPreferencesArgs and EmailPreferencesOutput values. You can construct a concrete instance of `EmailPreferencesInput` via: 

EmailPreferencesArgs{...}

type EmailPreferencesOutput 

type EmailPreferencesOutput struct{ *pulumi.OutputState }

Represents preferences for sending email notifications for transfer run events.

func (EmailPreferencesOutput) ElementType 

func (EmailPreferencesOutput) ElementType() reflect.Type

func (EmailPreferencesOutput) EnableFailureEmail 

func (o EmailPreferencesOutput) EnableFailureEmail() pulumi.BoolPtrOutput

If true, email notifications will be sent on transfer run failures.

func (EmailPreferencesOutput) ToEmailPreferencesOutput 

func (o EmailPreferencesOutput) ToEmailPreferencesOutput() EmailPreferencesOutput

func (EmailPreferencesOutput) ToEmailPreferencesOutputWithContext 

func (o EmailPreferencesOutput) ToEmailPreferencesOutputWithContext(ctx context.Context) EmailPreferencesOutput

func (EmailPreferencesOutput) ToEmailPreferencesPtrOutput 

func (o EmailPreferencesOutput) ToEmailPreferencesPtrOutput() EmailPreferencesPtrOutput

func (EmailPreferencesOutput) ToEmailPreferencesPtrOutputWithContext 

func (o EmailPreferencesOutput) ToEmailPreferencesPtrOutputWithContext(ctx context.Context) EmailPreferencesPtrOutput

type EmailPreferencesPtrInput 

type EmailPreferencesPtrInput interface {
	pulumi.Input

	ToEmailPreferencesPtrOutput() EmailPreferencesPtrOutput
	ToEmailPreferencesPtrOutputWithContext(context.Context) EmailPreferencesPtrOutput
}

EmailPreferencesPtrInput is an input type that accepts EmailPreferencesArgs, EmailPreferencesPtr and EmailPreferencesPtrOutput values. You can construct a concrete instance of `EmailPreferencesPtrInput` via: 

        EmailPreferencesArgs{...}

or:

        nil

func EmailPreferencesPtr 

func EmailPreferencesPtr(v *EmailPreferencesArgs) EmailPreferencesPtrInput

type EmailPreferencesPtrOutput 

type EmailPreferencesPtrOutput struct{ *pulumi.OutputState }

func (EmailPreferencesPtrOutput) Elem 

func (o EmailPreferencesPtrOutput) Elem() EmailPreferencesOutput

func (EmailPreferencesPtrOutput) ElementType 

func (EmailPreferencesPtrOutput) ElementType() reflect.Type

func (EmailPreferencesPtrOutput) EnableFailureEmail 

func (o EmailPreferencesPtrOutput) EnableFailureEmail() pulumi.BoolPtrOutput

If true, email notifications will be sent on transfer run failures.

func (EmailPreferencesPtrOutput) ToEmailPreferencesPtrOutput 

func (o EmailPreferencesPtrOutput) ToEmailPreferencesPtrOutput() EmailPreferencesPtrOutput

func (EmailPreferencesPtrOutput) ToEmailPreferencesPtrOutputWithContext 

func (o EmailPreferencesPtrOutput) ToEmailPreferencesPtrOutputWithContext(ctx context.Context) EmailPreferencesPtrOutput

type EmailPreferencesResponse 

type EmailPreferencesResponse struct {
	// If true, email notifications will be sent on transfer run failures.
	EnableFailureEmail bool `pulumi:"enableFailureEmail"`
}

Represents preferences for sending email notifications for transfer run events.

type EmailPreferencesResponseOutput 

type EmailPreferencesResponseOutput struct{ *pulumi.OutputState }

Represents preferences for sending email notifications for transfer run events.

func (EmailPreferencesResponseOutput) ElementType 

func (EmailPreferencesResponseOutput) ElementType() reflect.Type

func (EmailPreferencesResponseOutput) EnableFailureEmail 

func (o EmailPreferencesResponseOutput) EnableFailureEmail() pulumi.BoolOutput

If true, email notifications will be sent on transfer run failures.

func (EmailPreferencesResponseOutput) ToEmailPreferencesResponseOutput 

func (o EmailPreferencesResponseOutput) ToEmailPreferencesResponseOutput() EmailPreferencesResponseOutput

func (EmailPreferencesResponseOutput) ToEmailPreferencesResponseOutputWithContext 

func (o EmailPreferencesResponseOutput) ToEmailPreferencesResponseOutputWithContext(ctx context.Context) EmailPreferencesResponseOutput

type LookupTransferConfigArgs added in v0.4.0 

type LookupTransferConfigArgs struct {
	Location         string  `pulumi:"location"`
	Project          *string `pulumi:"project"`
	TransferConfigId string  `pulumi:"transferConfigId"`
}

type LookupTransferConfigOutputArgs added in v0.8.0 

type LookupTransferConfigOutputArgs struct {
	Location         pulumi.StringInput    `pulumi:"location"`
	Project          pulumi.StringPtrInput `pulumi:"project"`
	TransferConfigId pulumi.StringInput    `pulumi:"transferConfigId"`
}

func (LookupTransferConfigOutputArgs) ElementType added in v0.8.0 

func (LookupTransferConfigOutputArgs) ElementType() reflect.Type

type LookupTransferConfigResult added in v0.4.0 

type LookupTransferConfigResult struct {
	// The number of days to look back to automatically refresh the data. For example, if `data_refresh_window_days = 10`, then every day BigQuery reingests data for [today-10, today-1], rather than ingesting data for just [today-1]. Only valid if the data source supports the feature. Set the value to 0 to use the default value.
	DataRefreshWindowDays int `pulumi:"dataRefreshWindowDays"`
	// Data source id. Cannot be changed once data transfer is created.
	DataSourceId string `pulumi:"dataSourceId"`
	// Region in which BigQuery dataset is located.
	DatasetRegion string `pulumi:"datasetRegion"`
	// The BigQuery target dataset id.
	DestinationDatasetId string `pulumi:"destinationDatasetId"`
	// Is this config disabled. When set to true, no runs are scheduled for a given transfer.
	Disabled bool `pulumi:"disabled"`
	// User specified display name for the data transfer.
	DisplayName string `pulumi:"displayName"`
	// Email notifications will be sent according to these preferences to the email address of the user who owns this transfer config.
	EmailPreferences EmailPreferencesResponse `pulumi:"emailPreferences"`
	// The resource name of the transfer config. Transfer config names have the form `projects/{project_id}/locations/{region}/transferConfigs/{config_id}`. Where `config_id` is usually a uuid, even though it is not guaranteed or required. The name is ignored when creating a transfer config.
	Name string `pulumi:"name"`
	// Next time when data transfer will run.
	NextRunTime string `pulumi:"nextRunTime"`
	// Pub/Sub topic where notifications will be sent after transfer runs associated with this transfer config finish. The format for specifying a pubsub topic is: `projects/{project}/topics/{topic}`
	NotificationPubsubTopic string `pulumi:"notificationPubsubTopic"`
	// Information about the user whose credentials are used to transfer data. Populated only for `transferConfigs.get` requests. In case the user information is not available, this field will not be populated.
	OwnerInfo UserInfoResponse `pulumi:"ownerInfo"`
	// Parameters specific to each data source. For more information see the bq tab in the 'Setting up a data transfer' section for each data source. For example the parameters for Cloud Storage transfers are listed here: https://cloud.google.com/bigquery-transfer/docs/cloud-storage-transfer#bq
	Params map[string]string `pulumi:"params"`
	// Data transfer schedule. If the data source does not support a custom schedule, this should be empty. If it is empty, the default value for the data source will be used. The specified times are in UTC. Examples of valid format: `1st,3rd monday of month 15:30`, `every wed,fri of jan,jun 13:15`, and `first sunday of quarter 00:00`. See more explanation about the format here: https://cloud.google.com/appengine/docs/flexible/python/scheduling-jobs-with-cron-yaml#the_schedule_format NOTE: The minimum interval time between recurring transfers depends on the data source; refer to the documentation for your data source.
	Schedule string `pulumi:"schedule"`
	// Options customizing the data transfer schedule.
	ScheduleOptions ScheduleOptionsResponse `pulumi:"scheduleOptions"`
	// State of the most recently updated transfer run.
	State string `pulumi:"state"`
	// Data transfer modification time. Ignored by server on input.
	UpdateTime string `pulumi:"updateTime"`
	// Deprecated. Unique ID of the user on whose behalf transfer is done.
	//
	// Deprecated: Deprecated. Unique ID of the user on whose behalf transfer is done.
	UserId string `pulumi:"userId"`
}

func LookupTransferConfig added in v0.4.0 

func LookupTransferConfig(ctx *pulumi.Context, args *LookupTransferConfigArgs, opts ...pulumi.InvokeOption) (*LookupTransferConfigResult, error)

Returns information about a data transfer config.

type LookupTransferConfigResultOutput added in v0.8.0 

type LookupTransferConfigResultOutput struct{ *pulumi.OutputState }

func LookupTransferConfigOutput added in v0.8.0 

func LookupTransferConfigOutput(ctx *pulumi.Context, args LookupTransferConfigOutputArgs, opts ...pulumi.InvokeOption) LookupTransferConfigResultOutput

func (LookupTransferConfigResultOutput) DataRefreshWindowDays added in v0.8.0 

func (o LookupTransferConfigResultOutput) DataRefreshWindowDays() pulumi.IntOutput

The number of days to look back to automatically refresh the data. For example, if `data_refresh_window_days = 10`, then every day BigQuery reingests data for [today-10, today-1], rather than ingesting data for just [today-1]. Only valid if the data source supports the feature. Set the value to 0 to use the default value.

func (LookupTransferConfigResultOutput) DataSourceId added in v0.8.0 

func (o LookupTransferConfigResultOutput) DataSourceId() pulumi.StringOutput

Data source id. Cannot be changed once data transfer is created.

func (LookupTransferConfigResultOutput) DatasetRegion added in v0.8.0 

func (o LookupTransferConfigResultOutput) DatasetRegion() pulumi.StringOutput

Region in which BigQuery dataset is located.

func (LookupTransferConfigResultOutput) DestinationDatasetId added in v0.8.0 

func (o LookupTransferConfigResultOutput) DestinationDatasetId() pulumi.StringOutput

The BigQuery target dataset id.

func (LookupTransferConfigResultOutput) Disabled added in v0.8.0 

func (o LookupTransferConfigResultOutput) Disabled() pulumi.BoolOutput

Is this config disabled. When set to true, no runs are scheduled for a given transfer.

func (LookupTransferConfigResultOutput) DisplayName added in v0.8.0 

func (o LookupTransferConfigResultOutput) DisplayName() pulumi.StringOutput

User specified display name for the data transfer.

func (LookupTransferConfigResultOutput) ElementType added in v0.8.0 

func (LookupTransferConfigResultOutput) ElementType() reflect.Type

func (LookupTransferConfigResultOutput) EmailPreferences added in v0.8.0 

func (o LookupTransferConfigResultOutput) EmailPreferences() EmailPreferencesResponseOutput

Email notifications will be sent according to these preferences to the email address of the user who owns this transfer config.

func (LookupTransferConfigResultOutput) Name added in v0.8.0 

func (o LookupTransferConfigResultOutput) Name() pulumi.StringOutput

The resource name of the transfer config. Transfer config names have the form `projects/{project_id}/locations/{region}/transferConfigs/{config_id}`. Where `config_id` is usually a uuid, even though it is not guaranteed or required. The name is ignored when creating a transfer config.

func (LookupTransferConfigResultOutput) NextRunTime added in v0.8.0 

func (o LookupTransferConfigResultOutput) NextRunTime() pulumi.StringOutput

Next time when data transfer will run.

func (LookupTransferConfigResultOutput) NotificationPubsubTopic added in v0.8.0 

func (o LookupTransferConfigResultOutput) NotificationPubsubTopic() pulumi.StringOutput

Pub/Sub topic where notifications will be sent after transfer runs associated with this transfer config finish. The format for specifying a pubsub topic is: `projects/{project}/topics/{topic}`

func (LookupTransferConfigResultOutput) OwnerInfo added in v0.8.0 

func (o LookupTransferConfigResultOutput) OwnerInfo() UserInfoResponseOutput

Information about the user whose credentials are used to transfer data. Populated only for `transferConfigs.get` requests. In case the user information is not available, this field will not be populated.

func (LookupTransferConfigResultOutput) Params added in v0.8.0 

func (o LookupTransferConfigResultOutput) Params() pulumi.StringMapOutput

Parameters specific to each data source. For more information see the bq tab in the 'Setting up a data transfer' section for each data source. For example the parameters for Cloud Storage transfers are listed here: https://cloud.google.com/bigquery-transfer/docs/cloud-storage-transfer#bq

func (LookupTransferConfigResultOutput) Schedule added in v0.8.0 

func (o LookupTransferConfigResultOutput) Schedule() pulumi.StringOutput

Data transfer schedule. If the data source does not support a custom schedule, this should be empty. If it is empty, the default value for the data source will be used. The specified times are in UTC. Examples of valid format: `1st,3rd monday of month 15:30`, `every wed,fri of jan,jun 13:15`, and `first sunday of quarter 00:00`. See more explanation about the format here: https://cloud.google.com/appengine/docs/flexible/python/scheduling-jobs-with-cron-yaml#the_schedule_format NOTE: The minimum interval time between recurring transfers depends on the data source; refer to the documentation for your data source.

func (LookupTransferConfigResultOutput) ScheduleOptions added in v0.8.0 

func (o LookupTransferConfigResultOutput) ScheduleOptions() ScheduleOptionsResponseOutput

Options customizing the data transfer schedule.

func (LookupTransferConfigResultOutput) State added in v0.8.0 

func (o LookupTransferConfigResultOutput) State() pulumi.StringOutput

State of the most recently updated transfer run.

func (LookupTransferConfigResultOutput) ToLookupTransferConfigResultOutput added in v0.8.0 

func (o LookupTransferConfigResultOutput) ToLookupTransferConfigResultOutput() LookupTransferConfigResultOutput

func (LookupTransferConfigResultOutput) ToLookupTransferConfigResultOutputWithContext added in v0.8.0 

func (o LookupTransferConfigResultOutput) ToLookupTransferConfigResultOutputWithContext(ctx context.Context) LookupTransferConfigResultOutput

func (LookupTransferConfigResultOutput) UpdateTime added in v0.8.0 

func (o LookupTransferConfigResultOutput) UpdateTime() pulumi.StringOutput

Data transfer modification time. Ignored by server on input.

func (LookupTransferConfigResultOutput) UserId deprecated added in v0.17.0 

func (o LookupTransferConfigResultOutput) UserId() pulumi.StringOutput

Deprecated. Unique ID of the user on whose behalf transfer is done.

Deprecated: Deprecated. Unique ID of the user on whose behalf transfer is done.

type ScheduleOptions 

type ScheduleOptions struct {
	// If true, automatic scheduling of data transfer runs for this configuration will be disabled. The runs can be started on ad-hoc basis using StartManualTransferRuns API. When automatic scheduling is disabled, the TransferConfig.schedule field will be ignored.
	DisableAutoScheduling *bool `pulumi:"disableAutoScheduling"`
	// Defines time to stop scheduling transfer runs. A transfer run cannot be scheduled at or after the end time. The end time can be changed at any moment. The time when a data transfer can be trigerred manually is not limited by this option.
	EndTime *string `pulumi:"endTime"`
	// Specifies time to start scheduling transfer runs. The first run will be scheduled at or after the start time according to a recurrence pattern defined in the schedule string. The start time can be changed at any moment. The time when a data transfer can be trigerred manually is not limited by this option.
	StartTime *string `pulumi:"startTime"`
}

Options customizing the data transfer schedule.

type ScheduleOptionsArgs 

type ScheduleOptionsArgs struct {
	// If true, automatic scheduling of data transfer runs for this configuration will be disabled. The runs can be started on ad-hoc basis using StartManualTransferRuns API. When automatic scheduling is disabled, the TransferConfig.schedule field will be ignored.
	DisableAutoScheduling pulumi.BoolPtrInput `pulumi:"disableAutoScheduling"`
	// Defines time to stop scheduling transfer runs. A transfer run cannot be scheduled at or after the end time. The end time can be changed at any moment. The time when a data transfer can be trigerred manually is not limited by this option.
	EndTime pulumi.StringPtrInput `pulumi:"endTime"`
	// Specifies time to start scheduling transfer runs. The first run will be scheduled at or after the start time according to a recurrence pattern defined in the schedule string. The start time can be changed at any moment. The time when a data transfer can be trigerred manually is not limited by this option.
	StartTime pulumi.StringPtrInput `pulumi:"startTime"`
}

Options customizing the data transfer schedule.

func (ScheduleOptionsArgs) ElementType 

func (ScheduleOptionsArgs) ElementType() reflect.Type

func (ScheduleOptionsArgs) ToScheduleOptionsOutput 

func (i ScheduleOptionsArgs) ToScheduleOptionsOutput() ScheduleOptionsOutput

func (ScheduleOptionsArgs) ToScheduleOptionsOutputWithContext 

func (i ScheduleOptionsArgs) ToScheduleOptionsOutputWithContext(ctx context.Context) ScheduleOptionsOutput

func (ScheduleOptionsArgs) ToScheduleOptionsPtrOutput 

func (i ScheduleOptionsArgs) ToScheduleOptionsPtrOutput() ScheduleOptionsPtrOutput

func (ScheduleOptionsArgs) ToScheduleOptionsPtrOutputWithContext 

func (i ScheduleOptionsArgs) ToScheduleOptionsPtrOutputWithContext(ctx context.Context) ScheduleOptionsPtrOutput

type ScheduleOptionsInput 

type ScheduleOptionsInput interface {
	pulumi.Input

	ToScheduleOptionsOutput() ScheduleOptionsOutput
	ToScheduleOptionsOutputWithContext(context.Context) ScheduleOptionsOutput
}

ScheduleOptionsInput is an input type that accepts ScheduleOptionsArgs and ScheduleOptionsOutput values. You can construct a concrete instance of `ScheduleOptionsInput` via: 

ScheduleOptionsArgs{...}

type ScheduleOptionsOutput 

type ScheduleOptionsOutput struct{ *pulumi.OutputState }

Options customizing the data transfer schedule.

func (ScheduleOptionsOutput) DisableAutoScheduling 

func (o ScheduleOptionsOutput) DisableAutoScheduling() pulumi.BoolPtrOutput

If true, automatic scheduling of data transfer runs for this configuration will be disabled. The runs can be started on ad-hoc basis using StartManualTransferRuns API. When automatic scheduling is disabled, the TransferConfig.schedule field will be ignored.

func (ScheduleOptionsOutput) ElementType 

func (ScheduleOptionsOutput) ElementType() reflect.Type

func (ScheduleOptionsOutput) EndTime 

func (o ScheduleOptionsOutput) EndTime() pulumi.StringPtrOutput

Defines time to stop scheduling transfer runs. A transfer run cannot be scheduled at or after the end time. The end time can be changed at any moment. The time when a data transfer can be trigerred manually is not limited by this option.

func (ScheduleOptionsOutput) StartTime 

func (o ScheduleOptionsOutput) StartTime() pulumi.StringPtrOutput

Specifies time to start scheduling transfer runs. The first run will be scheduled at or after the start time according to a recurrence pattern defined in the schedule string. The start time can be changed at any moment. The time when a data transfer can be trigerred manually is not limited by this option.

func (ScheduleOptionsOutput) ToScheduleOptionsOutput 

func (o ScheduleOptionsOutput) ToScheduleOptionsOutput() ScheduleOptionsOutput

func (ScheduleOptionsOutput) ToScheduleOptionsOutputWithContext 

func (o ScheduleOptionsOutput) ToScheduleOptionsOutputWithContext(ctx context.Context) ScheduleOptionsOutput

func (ScheduleOptionsOutput) ToScheduleOptionsPtrOutput 

func (o ScheduleOptionsOutput) ToScheduleOptionsPtrOutput() ScheduleOptionsPtrOutput

func (ScheduleOptionsOutput) ToScheduleOptionsPtrOutputWithContext 

func (o ScheduleOptionsOutput) ToScheduleOptionsPtrOutputWithContext(ctx context.Context) ScheduleOptionsPtrOutput

type ScheduleOptionsPtrInput 

type ScheduleOptionsPtrInput interface {
	pulumi.Input

	ToScheduleOptionsPtrOutput() ScheduleOptionsPtrOutput
	ToScheduleOptionsPtrOutputWithContext(context.Context) ScheduleOptionsPtrOutput
}

ScheduleOptionsPtrInput is an input type that accepts ScheduleOptionsArgs, ScheduleOptionsPtr and ScheduleOptionsPtrOutput values. You can construct a concrete instance of `ScheduleOptionsPtrInput` via: 

        ScheduleOptionsArgs{...}

or:

        nil

func ScheduleOptionsPtr 

func ScheduleOptionsPtr(v *ScheduleOptionsArgs) ScheduleOptionsPtrInput

type ScheduleOptionsPtrOutput 

type ScheduleOptionsPtrOutput struct{ *pulumi.OutputState }

func (ScheduleOptionsPtrOutput) DisableAutoScheduling 

func (o ScheduleOptionsPtrOutput) DisableAutoScheduling() pulumi.BoolPtrOutput

If true, automatic scheduling of data transfer runs for this configuration will be disabled. The runs can be started on ad-hoc basis using StartManualTransferRuns API. When automatic scheduling is disabled, the TransferConfig.schedule field will be ignored.

func (ScheduleOptionsPtrOutput) Elem 

func (o ScheduleOptionsPtrOutput) Elem() ScheduleOptionsOutput

func (ScheduleOptionsPtrOutput) ElementType 

func (ScheduleOptionsPtrOutput) ElementType() reflect.Type

func (ScheduleOptionsPtrOutput) EndTime 

func (o ScheduleOptionsPtrOutput) EndTime() pulumi.StringPtrOutput

Defines time to stop scheduling transfer runs. A transfer run cannot be scheduled at or after the end time. The end time can be changed at any moment. The time when a data transfer can be trigerred manually is not limited by this option.

func (ScheduleOptionsPtrOutput) StartTime 

func (o ScheduleOptionsPtrOutput) StartTime() pulumi.StringPtrOutput

Specifies time to start scheduling transfer runs. The first run will be scheduled at or after the start time according to a recurrence pattern defined in the schedule string. The start time can be changed at any moment. The time when a data transfer can be trigerred manually is not limited by this option.

func (ScheduleOptionsPtrOutput) ToScheduleOptionsPtrOutput 

func (o ScheduleOptionsPtrOutput) ToScheduleOptionsPtrOutput() ScheduleOptionsPtrOutput

func (ScheduleOptionsPtrOutput) ToScheduleOptionsPtrOutputWithContext 

func (o ScheduleOptionsPtrOutput) ToScheduleOptionsPtrOutputWithContext(ctx context.Context) ScheduleOptionsPtrOutput

type ScheduleOptionsResponse 

type ScheduleOptionsResponse struct {
	// If true, automatic scheduling of data transfer runs for this configuration will be disabled. The runs can be started on ad-hoc basis using StartManualTransferRuns API. When automatic scheduling is disabled, the TransferConfig.schedule field will be ignored.
	DisableAutoScheduling bool `pulumi:"disableAutoScheduling"`
	// Defines time to stop scheduling transfer runs. A transfer run cannot be scheduled at or after the end time. The end time can be changed at any moment. The time when a data transfer can be trigerred manually is not limited by this option.
	EndTime string `pulumi:"endTime"`
	// Specifies time to start scheduling transfer runs. The first run will be scheduled at or after the start time according to a recurrence pattern defined in the schedule string. The start time can be changed at any moment. The time when a data transfer can be trigerred manually is not limited by this option.
	StartTime string `pulumi:"startTime"`
}

Options customizing the data transfer schedule.

type ScheduleOptionsResponseOutput 

type ScheduleOptionsResponseOutput struct{ *pulumi.OutputState }

Options customizing the data transfer schedule.

func (ScheduleOptionsResponseOutput) DisableAutoScheduling 

func (o ScheduleOptionsResponseOutput) DisableAutoScheduling() pulumi.BoolOutput

If true, automatic scheduling of data transfer runs for this configuration will be disabled. The runs can be started on ad-hoc basis using StartManualTransferRuns API. When automatic scheduling is disabled, the TransferConfig.schedule field will be ignored.

func (ScheduleOptionsResponseOutput) ElementType 

func (ScheduleOptionsResponseOutput) ElementType() reflect.Type

func (ScheduleOptionsResponseOutput) EndTime 

func (o ScheduleOptionsResponseOutput) EndTime() pulumi.StringOutput

Defines time to stop scheduling transfer runs. A transfer run cannot be scheduled at or after the end time. The end time can be changed at any moment. The time when a data transfer can be trigerred manually is not limited by this option.

func (ScheduleOptionsResponseOutput) StartTime 

func (o ScheduleOptionsResponseOutput) StartTime() pulumi.StringOutput

Specifies time to start scheduling transfer runs. The first run will be scheduled at or after the start time according to a recurrence pattern defined in the schedule string. The start time can be changed at any moment. The time when a data transfer can be trigerred manually is not limited by this option.

func (ScheduleOptionsResponseOutput) ToScheduleOptionsResponseOutput 

func (o ScheduleOptionsResponseOutput) ToScheduleOptionsResponseOutput() ScheduleOptionsResponseOutput

func (ScheduleOptionsResponseOutput) ToScheduleOptionsResponseOutputWithContext 

func (o ScheduleOptionsResponseOutput) ToScheduleOptionsResponseOutputWithContext(ctx context.Context) ScheduleOptionsResponseOutput

type TransferConfig 

type TransferConfig struct {
	pulumi.CustomResourceState

	// The number of days to look back to automatically refresh the data. For example, if `data_refresh_window_days = 10`, then every day BigQuery reingests data for [today-10, today-1], rather than ingesting data for just [today-1]. Only valid if the data source supports the feature. Set the value to 0 to use the default value.
	DataRefreshWindowDays pulumi.IntOutput `pulumi:"dataRefreshWindowDays"`
	// Data source id. Cannot be changed once data transfer is created.
	DataSourceId pulumi.StringOutput `pulumi:"dataSourceId"`
	// Region in which BigQuery dataset is located.
	DatasetRegion pulumi.StringOutput `pulumi:"datasetRegion"`
	// The BigQuery target dataset id.
	DestinationDatasetId pulumi.StringOutput `pulumi:"destinationDatasetId"`
	// Is this config disabled. When set to true, no runs are scheduled for a given transfer.
	Disabled pulumi.BoolOutput `pulumi:"disabled"`
	// User specified display name for the data transfer.
	DisplayName pulumi.StringOutput `pulumi:"displayName"`
	// Email notifications will be sent according to these preferences to the email address of the user who owns this transfer config.
	EmailPreferences EmailPreferencesResponseOutput `pulumi:"emailPreferences"`
	// The resource name of the transfer config. Transfer config names have the form `projects/{project_id}/locations/{region}/transferConfigs/{config_id}`. Where `config_id` is usually a uuid, even though it is not guaranteed or required. The name is ignored when creating a transfer config.
	Name pulumi.StringOutput `pulumi:"name"`
	// Next time when data transfer will run.
	NextRunTime pulumi.StringOutput `pulumi:"nextRunTime"`
	// Pub/Sub topic where notifications will be sent after transfer runs associated with this transfer config finish. The format for specifying a pubsub topic is: `projects/{project}/topics/{topic}`
	NotificationPubsubTopic pulumi.StringOutput `pulumi:"notificationPubsubTopic"`
	// Information about the user whose credentials are used to transfer data. Populated only for `transferConfigs.get` requests. In case the user information is not available, this field will not be populated.
	OwnerInfo UserInfoResponseOutput `pulumi:"ownerInfo"`
	// Parameters specific to each data source. For more information see the bq tab in the 'Setting up a data transfer' section for each data source. For example the parameters for Cloud Storage transfers are listed here: https://cloud.google.com/bigquery-transfer/docs/cloud-storage-transfer#bq
	Params pulumi.StringMapOutput `pulumi:"params"`
	// Data transfer schedule. If the data source does not support a custom schedule, this should be empty. If it is empty, the default value for the data source will be used. The specified times are in UTC. Examples of valid format: `1st,3rd monday of month 15:30`, `every wed,fri of jan,jun 13:15`, and `first sunday of quarter 00:00`. See more explanation about the format here: https://cloud.google.com/appengine/docs/flexible/python/scheduling-jobs-with-cron-yaml#the_schedule_format NOTE: The minimum interval time between recurring transfers depends on the data source; refer to the documentation for your data source.
	Schedule pulumi.StringOutput `pulumi:"schedule"`
	// Options customizing the data transfer schedule.
	ScheduleOptions ScheduleOptionsResponseOutput `pulumi:"scheduleOptions"`
	// State of the most recently updated transfer run.
	State pulumi.StringOutput `pulumi:"state"`
	// Data transfer modification time. Ignored by server on input.
	UpdateTime pulumi.StringOutput `pulumi:"updateTime"`
	// Deprecated. Unique ID of the user on whose behalf transfer is done.
	//
	// Deprecated: Deprecated. Unique ID of the user on whose behalf transfer is done.
	UserId pulumi.StringOutput `pulumi:"userId"`
}

Creates a new data transfer configuration.

func GetTransferConfig 

func GetTransferConfig(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *TransferConfigState, opts ...pulumi.ResourceOption) (*TransferConfig, error)

GetTransferConfig gets an existing TransferConfig 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 NewTransferConfig 

func NewTransferConfig(ctx *pulumi.Context,
	name string, args *TransferConfigArgs, opts ...pulumi.ResourceOption) (*TransferConfig, error)

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

func (*TransferConfig) ElementType 

func (*TransferConfig) ElementType() reflect.Type

func (*TransferConfig) ToTransferConfigOutput 

func (i *TransferConfig) ToTransferConfigOutput() TransferConfigOutput

func (*TransferConfig) ToTransferConfigOutputWithContext 

func (i *TransferConfig) ToTransferConfigOutputWithContext(ctx context.Context) TransferConfigOutput

type TransferConfigArgs 

type TransferConfigArgs struct {
	// Optional OAuth2 authorization code to use with this transfer configuration. This is required only if `transferConfig.dataSourceId` is 'youtube_channel' and new credentials are needed, as indicated by `CheckValidCreds`. In order to obtain authorization_code, please make a request to https://www.gstatic.com/bigquerydatatransfer/oauthz/auth?client_id=&scope=&redirect_uri=urn:ietf:wg:oauth:2.0:oob&response_type=authorization_code * client_id should be OAuth client_id of BigQuery DTS API for the given data source returned by ListDataSources method. * data_source_scopes are the scopes returned by ListDataSources method. Note that this should not be set when `service_account_name` is used to create the transfer config.
	AuthorizationCode pulumi.StringPtrInput
	// The number of days to look back to automatically refresh the data. For example, if `data_refresh_window_days = 10`, then every day BigQuery reingests data for [today-10, today-1], rather than ingesting data for just [today-1]. Only valid if the data source supports the feature. Set the value to 0 to use the default value.
	DataRefreshWindowDays pulumi.IntPtrInput
	// Data source id. Cannot be changed once data transfer is created.
	DataSourceId pulumi.StringPtrInput
	// The BigQuery target dataset id.
	DestinationDatasetId pulumi.StringPtrInput
	// Is this config disabled. When set to true, no runs are scheduled for a given transfer.
	Disabled pulumi.BoolPtrInput
	// User specified display name for the data transfer.
	DisplayName pulumi.StringPtrInput
	// Email notifications will be sent according to these preferences to the email address of the user who owns this transfer config.
	EmailPreferences EmailPreferencesPtrInput
	Location         pulumi.StringPtrInput
	// The resource name of the transfer config. Transfer config names have the form `projects/{project_id}/locations/{region}/transferConfigs/{config_id}`. Where `config_id` is usually a uuid, even though it is not guaranteed or required. The name is ignored when creating a transfer config.
	Name pulumi.StringPtrInput
	// Pub/Sub topic where notifications will be sent after transfer runs associated with this transfer config finish. The format for specifying a pubsub topic is: `projects/{project}/topics/{topic}`
	NotificationPubsubTopic pulumi.StringPtrInput
	// Parameters specific to each data source. For more information see the bq tab in the 'Setting up a data transfer' section for each data source. For example the parameters for Cloud Storage transfers are listed here: https://cloud.google.com/bigquery-transfer/docs/cloud-storage-transfer#bq
	Params  pulumi.StringMapInput
	Project pulumi.StringPtrInput
	// Data transfer schedule. If the data source does not support a custom schedule, this should be empty. If it is empty, the default value for the data source will be used. The specified times are in UTC. Examples of valid format: `1st,3rd monday of month 15:30`, `every wed,fri of jan,jun 13:15`, and `first sunday of quarter 00:00`. See more explanation about the format here: https://cloud.google.com/appengine/docs/flexible/python/scheduling-jobs-with-cron-yaml#the_schedule_format NOTE: The minimum interval time between recurring transfers depends on the data source; refer to the documentation for your data source.
	Schedule pulumi.StringPtrInput
	// Options customizing the data transfer schedule.
	ScheduleOptions ScheduleOptionsPtrInput
	// Optional service account name. If this field is set, transfer config will be created with this service account credential. It requires that requesting user calling this API has permissions to act as this service account. Note that not all data sources support service account credentials when creating transfer config. Please refer to this public guide for the latest list of data sources with service account support: https://cloud.google.com/bigquery-transfer/docs/use-service-accounts
	ServiceAccountName pulumi.StringPtrInput
	// Deprecated. Unique ID of the user on whose behalf transfer is done.
	//
	// Deprecated: Deprecated. Unique ID of the user on whose behalf transfer is done.
	UserId pulumi.StringPtrInput
	// Optional version info. This is required only if `transferConfig.dataSourceId` is anything else but 'youtube_channel' and new credentials are needed, as indicated by `CheckValidCreds`. In order to obtain version info, please make a request to https://www.gstatic.com/bigquerydatatransfer/oauthz/auth?client_id=&scope=&redirect_uri=urn:ietf:wg:oauth:2.0:oob&response_type=version_info * client_id should be OAuth client_id of BigQuery DTS API for the given data source returned by ListDataSources method. * data_source_scopes are the scopes returned by ListDataSources method. Note that this should not be set when `service_account_name` is used to create the transfer config.
	VersionInfo pulumi.StringPtrInput
}

The set of arguments for constructing a TransferConfig resource.

func (TransferConfigArgs) ElementType 

func (TransferConfigArgs) ElementType() reflect.Type

type TransferConfigInput 

type TransferConfigInput interface {
	pulumi.Input

	ToTransferConfigOutput() TransferConfigOutput
	ToTransferConfigOutputWithContext(ctx context.Context) TransferConfigOutput
}

type TransferConfigOutput 

type TransferConfigOutput struct{ *pulumi.OutputState }

func (TransferConfigOutput) ElementType 

func (TransferConfigOutput) ElementType() reflect.Type

func (TransferConfigOutput) ToTransferConfigOutput 

func (o TransferConfigOutput) ToTransferConfigOutput() TransferConfigOutput

func (TransferConfigOutput) ToTransferConfigOutputWithContext 

func (o TransferConfigOutput) ToTransferConfigOutputWithContext(ctx context.Context) TransferConfigOutput

type TransferConfigState 

type TransferConfigState struct {
}

func (TransferConfigState) ElementType 

func (TransferConfigState) ElementType() reflect.Type

type UserInfoResponse added in v0.8.0 

type UserInfoResponse struct {
	// E-mail address of the user.
	Email string `pulumi:"email"`
}

Information about a user.

type UserInfoResponseOutput added in v0.8.0 

type UserInfoResponseOutput struct{ *pulumi.OutputState }

Information about a user.

func (UserInfoResponseOutput) ElementType added in v0.8.0 

func (UserInfoResponseOutput) ElementType() reflect.Type

func (UserInfoResponseOutput) Email added in v0.8.0 

func (o UserInfoResponseOutput) Email() pulumi.StringOutput

E-mail address of the user.

func (UserInfoResponseOutput) ToUserInfoResponseOutput added in v0.8.0 

func (o UserInfoResponseOutput) ToUserInfoResponseOutput() UserInfoResponseOutput

func (UserInfoResponseOutput) ToUserInfoResponseOutputWithContext added in v0.8.0 

func (o UserInfoResponseOutput) ToUserInfoResponseOutputWithContext(ctx context.Context) UserInfoResponseOutput

Source Files

View all Source files

Jump to

Keyboard shortcuts

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