Google Native

v0.26.0 published on Friday, Sep 16, 2022 by Pulumi

getTransferConfig

Returns information about a data transfer config.

Using getTransferConfig

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getTransferConfig(args: GetTransferConfigArgs, opts?: InvokeOptions): Promise<GetTransferConfigResult>
function getTransferConfigOutput(args: GetTransferConfigOutputArgs, opts?: InvokeOptions): Output<GetTransferConfigResult>
def get_transfer_config(location: Optional[str] = None,
                        project: Optional[str] = None,
                        transfer_config_id: Optional[str] = None,
                        opts: Optional[InvokeOptions] = None) -> GetTransferConfigResult
def get_transfer_config_output(location: Optional[pulumi.Input[str]] = None,
                        project: Optional[pulumi.Input[str]] = None,
                        transfer_config_id: Optional[pulumi.Input[str]] = None,
                        opts: Optional[InvokeOptions] = None) -> Output[GetTransferConfigResult]
func LookupTransferConfig(ctx *Context, args *LookupTransferConfigArgs, opts ...InvokeOption) (*LookupTransferConfigResult, error)
func LookupTransferConfigOutput(ctx *Context, args *LookupTransferConfigOutputArgs, opts ...InvokeOption) LookupTransferConfigResultOutput

> Note: This function is named LookupTransferConfig in the Go SDK.

public static class GetTransferConfig 
{
    public static Task<GetTransferConfigResult> InvokeAsync(GetTransferConfigArgs args, InvokeOptions? opts = null)
    public static Output<GetTransferConfigResult> Invoke(GetTransferConfigInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetTransferConfigResult> getTransferConfig(GetTransferConfigArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
Fn::Invoke:
  Function: google-native:bigquerydatatransfer/v1:getTransferConfig
  Arguments:
    # Arguments dictionary

The following arguments are supported:

Location string
TransferConfigId string
Project string
Location string
TransferConfigId string
Project string
location String
transferConfigId String
project String
location string
transferConfigId string
project string
location String
transferConfigId String
project String

getTransferConfig Result

The following output properties are available:

DataRefreshWindowDays int

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.

DataSourceId string

Data source ID. This cannot be changed once data transfer is created. The full list of available data source IDs can be returned through an API call: https://cloud.google.com/bigquery-transfer/docs/reference/datatransfer/rest/v1/projects.locations.dataSources/list

DatasetRegion string

Region in which BigQuery dataset is located.

DestinationDatasetId string

The BigQuery target dataset id.

Disabled bool

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

DisplayName string

User specified display name for the data transfer.

EmailPreferences Pulumi.GoogleNative.BigQueryDataTransfer.V1.Outputs.EmailPreferencesResponse

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

Name string

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.

NextRunTime string

Next time when data transfer will run.

NotificationPubsubTopic string

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}

OwnerInfo Pulumi.GoogleNative.BigQueryDataTransfer.V1.Outputs.UserInfoResponse

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.

Params Dictionary<string, string>

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

Schedule string

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.

ScheduleOptions Pulumi.GoogleNative.BigQueryDataTransfer.V1.Outputs.ScheduleOptionsResponse

Options customizing the data transfer schedule.

State string

State of the most recently updated transfer run.

UpdateTime string

Data transfer modification time. Ignored by server on input.

UserId string

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.

DataRefreshWindowDays int

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.

DataSourceId string

Data source ID. This cannot be changed once data transfer is created. The full list of available data source IDs can be returned through an API call: https://cloud.google.com/bigquery-transfer/docs/reference/datatransfer/rest/v1/projects.locations.dataSources/list

DatasetRegion string

Region in which BigQuery dataset is located.

DestinationDatasetId string

The BigQuery target dataset id.

Disabled bool

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

DisplayName string

User specified display name for the data transfer.

EmailPreferences EmailPreferencesResponse

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

Name string

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.

NextRunTime string

Next time when data transfer will run.

NotificationPubsubTopic string

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}

OwnerInfo UserInfoResponse

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.

Params map[string]string

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

Schedule string

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.

ScheduleOptions ScheduleOptionsResponse

Options customizing the data transfer schedule.

State string

State of the most recently updated transfer run.

UpdateTime string

Data transfer modification time. Ignored by server on input.

UserId string

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.

dataRefreshWindowDays Integer

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.

dataSourceId String

Data source ID. This cannot be changed once data transfer is created. The full list of available data source IDs can be returned through an API call: https://cloud.google.com/bigquery-transfer/docs/reference/datatransfer/rest/v1/projects.locations.dataSources/list

datasetRegion String

Region in which BigQuery dataset is located.

destinationDatasetId String

The BigQuery target dataset id.

disabled Boolean

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

displayName String

User specified display name for the data transfer.

emailPreferences EmailPreferencesResponse

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

name String

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.

nextRunTime String

Next time when data transfer will run.

notificationPubsubTopic String

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}

ownerInfo UserInfoResponse

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.

params Map<String,String>

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

schedule String

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.

scheduleOptions ScheduleOptionsResponse

Options customizing the data transfer schedule.

state String

State of the most recently updated transfer run.

updateTime String

Data transfer modification time. Ignored by server on input.

userId String

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.

dataRefreshWindowDays number

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.

dataSourceId string

Data source ID. This cannot be changed once data transfer is created. The full list of available data source IDs can be returned through an API call: https://cloud.google.com/bigquery-transfer/docs/reference/datatransfer/rest/v1/projects.locations.dataSources/list

datasetRegion string

Region in which BigQuery dataset is located.

destinationDatasetId string

The BigQuery target dataset id.

disabled boolean

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

displayName string

User specified display name for the data transfer.

emailPreferences EmailPreferencesResponse

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

name string

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.

nextRunTime string

Next time when data transfer will run.

notificationPubsubTopic string

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}

ownerInfo UserInfoResponse

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.

params {[key: string]: string}

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

schedule string

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.

scheduleOptions ScheduleOptionsResponse

Options customizing the data transfer schedule.

state string

State of the most recently updated transfer run.

updateTime string

Data transfer modification time. Ignored by server on input.

userId string

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.

data_refresh_window_days int

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.

data_source_id str

Data source ID. This cannot be changed once data transfer is created. The full list of available data source IDs can be returned through an API call: https://cloud.google.com/bigquery-transfer/docs/reference/datatransfer/rest/v1/projects.locations.dataSources/list

dataset_region str

Region in which BigQuery dataset is located.

destination_dataset_id str

The BigQuery target dataset id.

disabled bool

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

display_name str

User specified display name for the data transfer.

email_preferences EmailPreferencesResponse

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

name str

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.

next_run_time str

Next time when data transfer will run.

notification_pubsub_topic str

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}

owner_info UserInfoResponse

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.

params Mapping[str, str]

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

schedule str

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_options ScheduleOptionsResponse

Options customizing the data transfer schedule.

state str

State of the most recently updated transfer run.

update_time str

Data transfer modification time. Ignored by server on input.

user_id str

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.

dataRefreshWindowDays Number

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.

dataSourceId String

Data source ID. This cannot be changed once data transfer is created. The full list of available data source IDs can be returned through an API call: https://cloud.google.com/bigquery-transfer/docs/reference/datatransfer/rest/v1/projects.locations.dataSources/list

datasetRegion String

Region in which BigQuery dataset is located.

destinationDatasetId String

The BigQuery target dataset id.

disabled Boolean

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

displayName String

User specified display name for the data transfer.

emailPreferences Property Map

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

name String

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.

nextRunTime String

Next time when data transfer will run.

notificationPubsubTopic String

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}

ownerInfo Property Map

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.

params Map<String>

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

schedule String

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.

scheduleOptions Property Map

Options customizing the data transfer schedule.

state String

State of the most recently updated transfer run.

updateTime String

Data transfer modification time. Ignored by server on input.

userId String

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.

Supporting Types

EmailPreferencesResponse

EnableFailureEmail bool

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

EnableFailureEmail bool

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

enableFailureEmail Boolean

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

enableFailureEmail boolean

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

enable_failure_email bool

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

enableFailureEmail Boolean

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

ScheduleOptionsResponse

DisableAutoScheduling bool

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.

EndTime string

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.

StartTime string

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.

DisableAutoScheduling bool

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.

EndTime string

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.

StartTime string

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.

disableAutoScheduling Boolean

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.

endTime String

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.

startTime String

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.

disableAutoScheduling boolean

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.

endTime string

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.

startTime string

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.

disable_auto_scheduling bool

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.

end_time str

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.

start_time str

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.

disableAutoScheduling Boolean

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.

endTime String

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.

startTime String

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.

UserInfoResponse

Email string

E-mail address of the user.

Email string

E-mail address of the user.

email String

E-mail address of the user.

email string

E-mail address of the user.

email str

E-mail address of the user.

email String

E-mail address of the user.

Package Details

Repository
https://github.com/pulumi/pulumi-google-native
License
Apache-2.0