Class ProjectsResource.LocationsResource.TransferConfigsResource

The "transferConfigs" collection of methods.

Inheritance

object

ProjectsResource.LocationsResource.TransferConfigsResource

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Google.Apis.BigQueryDataTransfer.v1

Assembly: Google.Apis.BigQueryDataTransfer.v1.dll

Syntax

public class ProjectsResource.LocationsResource.TransferConfigsResource

Constructors

TransferConfigsResource(IClientService)

Constructs a new resource.

Declaration

public TransferConfigsResource(IClientService service)

Parameters

Type	Name	Description
IClientService	service

Properties

Runs

Gets the Runs resource.

Declaration

public virtual ProjectsResource.LocationsResource.TransferConfigsResource.RunsResource Runs { get; }

Property Value

Type	Description
ProjectsResource.LocationsResource.TransferConfigsResource.RunsResource

Methods

Create(TransferConfig, string)

Creates a new data transfer configuration.

Declaration

public virtual ProjectsResource.LocationsResource.TransferConfigsResource.CreateRequest Create(TransferConfig body, string parent)

Parameters

Type	Name	Description
TransferConfig	body	The body of the request.
string	parent	Required. The BigQuery project id where the transfer configuration should be created. Must be in the format projects/{project_id}/locations/{location_id} or projects/{project_id}. If specified location and location of the destination bigquery dataset do not match - the request will fail.

Returns

Type	Description
ProjectsResource.LocationsResource.TransferConfigsResource.CreateRequest

Delete(string)

Deletes a data transfer configuration, including any associated transfer runs and logs.

Declaration

public virtual ProjectsResource.LocationsResource.TransferConfigsResource.DeleteRequest Delete(string name)

Parameters

Type	Name	Description
string	name	Required. The name of the resource to delete. If you are using the regionless method, the location must be US and the name should be in the following form: * projects/{project_id}/transferConfigs/{config_id} If you are using the regionalized method, the name should be in the following form: * projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}

Returns

Type	Description
ProjectsResource.LocationsResource.TransferConfigsResource.DeleteRequest

Get(string)

Returns information about a data transfer config.

Declaration

public virtual ProjectsResource.LocationsResource.TransferConfigsResource.GetRequest Get(string name)

Parameters

Type	Name	Description
string	name	Required. The name of the resource requested. If you are using the regionless method, the location must be US and the name should be in the following form: * projects/{project_id}/transferConfigs/{config_id} If you are using the regionalized method, the name should be in the following form: * projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}

Returns

Type	Description
ProjectsResource.LocationsResource.TransferConfigsResource.GetRequest

List(string)

Returns information about all transfer configs owned by a project in the specified location.

Declaration

public virtual ProjectsResource.LocationsResource.TransferConfigsResource.ListRequest List(string parent)

Parameters

Type	Name	Description
string	parent	Required. The BigQuery project id for which transfer configs should be returned. If you are using the regionless method, the location must be US and parent should be in the following form: * projects/{project_id} If you are using the regionalized method, parentshould be in the following form: *projects/{project_id}/locations/{location_id}`

Returns

Type	Description
ProjectsResource.LocationsResource.TransferConfigsResource.ListRequest

Patch(TransferConfig, string)

Updates a data transfer configuration. All fields must be set, even if they are not updated.

Declaration

public virtual ProjectsResource.LocationsResource.TransferConfigsResource.PatchRequest Patch(TransferConfig body, string name)

Parameters

Type	Name	Description
TransferConfig	body	The body of the request.
string	name	Identifier. The resource name of the transfer config. Transfer config names have the form either projects/{project_id}/locations/{region}/transferConfigs/{config_id} or projects/{project_id}/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.

Returns

Type	Description
ProjectsResource.LocationsResource.TransferConfigsResource.PatchRequest

ScheduleRuns(ScheduleTransferRunsRequest, string)

Creates transfer runs for a time range [start_time, end_time]. For each date - or whatever granularity the data source supports - in the range, one transfer run is created. Note that runs are created per UTC time in the time range. DEPRECATED: use StartManualTransferRuns instead.

Declaration

public virtual ProjectsResource.LocationsResource.TransferConfigsResource.ScheduleRunsRequest ScheduleRuns(ScheduleTransferRunsRequest body, string parent)

Parameters

Type	Name	Description
ScheduleTransferRunsRequest	body	The body of the request.
string	parent	Required. Transfer configuration name. If you are using the regionless method, the location must be US and the name should be in the following form: * projects/{project_id}/transferConfigs/{config_id} If you are using the regionalized method, the name should be in the following form: * projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}

Returns

Type	Description
ProjectsResource.LocationsResource.TransferConfigsResource.ScheduleRunsRequest

StartManualRuns(StartManualTransferRunsRequest, string)

Manually initiates transfer runs. You can schedule these runs in two ways: 1. For a specific point in time using the 'requested_run_time' parameter. 2. For a period between 'start_time' (inclusive) and 'end_time' (exclusive). If scheduling a single run, it is set to execute immediately (schedule_time equals the current time). When scheduling multiple runs within a time range, the first run starts now, and subsequent runs are delayed by 15 seconds each.

Declaration

public virtual ProjectsResource.LocationsResource.TransferConfigsResource.StartManualRunsRequest StartManualRuns(StartManualTransferRunsRequest body, string parent)

Parameters

Type	Name	Description
StartManualTransferRunsRequest	body	The body of the request.
string	parent	Required. Transfer configuration name. If you are using the regionless method, the location must be US and the name should be in the following form: * projects/{project_id}/transferConfigs/{config_id} If you are using the regionalized method, the name should be in the following form: * projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}

Returns

Type	Description
ProjectsResource.LocationsResource.TransferConfigsResource.StartManualRunsRequest