target.apidocs.com.google.api.services.bigquerydatatransfer.v1.BigQueryDataTransfer.Projects.TransferConfigs.html Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of google-api-services-bigquerydatatransfer Show documentation

There is a newer version: v1-rev20240922-2.0.0

Show newest version







BigQueryDataTransfer.Projects.TransferConfigs (BigQuery Data Transfer API v1-rev20240914-2.0.0)











Skip navigation links




Overview
Package
Class
Use
Tree
Deprecated
Index
Help




Prev Class
Next Class


Frames
No Frames


All Classes






Summary: 
Nested | 
Field | 
Constr | 
Method


Detail: 
Field | 
Constr | 
Method








com.google.api.services.bigquerydatatransfer.v1
Class BigQueryDataTransfer.Projects.TransferConfigs



java.lang.Object


com.google.api.services.bigquerydatatransfer.v1.BigQueryDataTransfer.Projects.TransferConfigs







Enclosing class:
BigQueryDataTransfer.Projects




public class BigQueryDataTransfer.Projects.TransferConfigs
extends Object
The "transferConfigs" collection of methods.











Nested Class Summary

Nested Classes 

Modifier and Type
Class and Description


class 
BigQueryDataTransfer.Projects.TransferConfigs.Create 


class 
BigQueryDataTransfer.Projects.TransferConfigs.Delete 


class 
BigQueryDataTransfer.Projects.TransferConfigs.Get 


class 
BigQueryDataTransfer.Projects.TransferConfigs.List 


class 
BigQueryDataTransfer.Projects.TransferConfigs.Patch 


class 
BigQueryDataTransfer.Projects.TransferConfigs.Runs
The "runs" collection of methods.



class 
BigQueryDataTransfer.Projects.TransferConfigs.ScheduleRuns 


class 
BigQueryDataTransfer.Projects.TransferConfigs.StartManualRuns 









Constructor Summary

Constructors 

Constructor and Description


TransferConfigs() 









Method Summary

All Methods Instance Methods Concrete Methods 

Modifier and Type
Method and Description


BigQueryDataTransfer.Projects.TransferConfigs.Create
create(String parent,
      TransferConfig content)
Creates a new data transfer configuration.



BigQueryDataTransfer.Projects.TransferConfigs.Delete
delete(String name)
Deletes a data transfer configuration, including any associated transfer runs and logs.



BigQueryDataTransfer.Projects.TransferConfigs.Get
get(String name)
Returns information about a data transfer config.



BigQueryDataTransfer.Projects.TransferConfigs.List
list(String parent)
Returns information about all transfer configs owned by a project in the specified location.



BigQueryDataTransfer.Projects.TransferConfigs.Patch
patch(String name,
     TransferConfig content)
Updates a data transfer configuration.



BigQueryDataTransfer.Projects.TransferConfigs.Runs
runs()
An accessor for creating requests from the Runs collection.



BigQueryDataTransfer.Projects.TransferConfigs.ScheduleRuns
scheduleRuns(String parent,
            ScheduleTransferRunsRequest content)
Creates transfer runs for a time range [start_time, end_time].



BigQueryDataTransfer.Projects.TransferConfigs.StartManualRuns
startManualRuns(String parent,
               StartManualTransferRunsRequest content)
Start manual transfer runs to be executed now with schedule_time equal to current time.







Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait














Constructor Detail





TransferConfigs
public TransferConfigs()









Method Detail





create
public BigQueryDataTransfer.Projects.TransferConfigs.Create create(String parent,
                                                                   TransferConfig content)
                                                            throws IOException
Creates a new data transfer configuration.

 Create a request for the method "transferConfigs.create".

 This request holds the parameters needed by the bigquerydatatransfer server.  After setting any
 optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:
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.
content - the TransferConfig
Returns:
the request
Throws:
IOException








delete
public BigQueryDataTransfer.Projects.TransferConfigs.Delete delete(String name)
                                                            throws IOException
Deletes a data transfer configuration, including any associated transfer runs and logs.

 Create a request for the method "transferConfigs.delete".

 This request holds the parameters needed by the bigquerydatatransfer server.  After setting any
 optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:
name - Required. The field will contain name of the resource requested, for example:
        `projects/{project_id}/transferConfigs/{config_id}` or
        `projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}`
Returns:
the request
Throws:
IOException








get
public BigQueryDataTransfer.Projects.TransferConfigs.Get get(String name)
                                                      throws IOException
Returns information about a data transfer config.

 Create a request for the method "transferConfigs.get".

 This request holds the parameters needed by the bigquerydatatransfer server.  After setting any
 optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:
name - Required. The field will contain name of the resource requested, for example:
        `projects/{project_id}/transferConfigs/{config_id}` or
        `projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}`
Returns:
the request
Throws:
IOException








list
public BigQueryDataTransfer.Projects.TransferConfigs.List list(String parent)
                                                        throws IOException
Returns information about all transfer configs owned by a project in the specified location.

 Create a request for the method "transferConfigs.list".

 This request holds the parameters needed by the bigquerydatatransfer server.  After setting any
 optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:
parent - Required. The BigQuery project id for which transfer configs should be returned:
        `projects/{project_id}` or `projects/{project_id}/locations/{location_id}`
Returns:
the request
Throws:
IOException








patch
public BigQueryDataTransfer.Projects.TransferConfigs.Patch patch(String name,
                                                                 TransferConfig content)
                                                          throws IOException
Updates a data transfer configuration. All fields must be set, even if they are not updated.

 Create a request for the method "transferConfigs.patch".

 This request holds the parameters needed by the bigquerydatatransfer server.  After setting any
 optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:
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.
content - the TransferConfig
Returns:
the request
Throws:
IOException








scheduleRuns
public BigQueryDataTransfer.Projects.TransferConfigs.ScheduleRuns scheduleRuns(String parent,
                                                                               ScheduleTransferRunsRequest content)
                                                                        throws IOException
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.

 Create a request for the method "transferConfigs.scheduleRuns".

 This request holds the parameters needed by the bigquerydatatransfer server.  After setting any
 optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote
 operation.

Parameters:
parent - Required. Transfer configuration name in the form:
        `projects/{project_id}/transferConfigs/{config_id}` or
        `projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}`.
content - the ScheduleTransferRunsRequest
Returns:
the request
Throws:
IOException








startManualRuns
public BigQueryDataTransfer.Projects.TransferConfigs.StartManualRuns startManualRuns(String parent,
                                                                                     StartManualTransferRunsRequest content)
                                                                              throws IOException
Start manual transfer runs to be executed now with schedule_time equal to current time. The
 transfer runs can be created for a time range where the run_time is between start_time
 (inclusive) and end_time (exclusive), or for a specific run_time.

 Create a request for the method "transferConfigs.startManualRuns".

 This request holds the parameters needed by the bigquerydatatransfer server.  After setting any
 optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote
 operation.

Parameters:
parent - Required. Transfer configuration name in the form:
        `projects/{project_id}/transferConfigs/{config_id}` or
        `projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}`.
content - the StartManualTransferRunsRequest
Returns:
the request
Throws:
IOException








runs
public BigQueryDataTransfer.Projects.TransferConfigs.Runs runs()
An accessor for creating requests from the Runs collection.

 The typical use is:
     BigQueryDataTransfer bigquerydatatransfer = new BigQueryDataTransfer(...);
    BigQueryDataTransfer.Runs.List request = bigquerydatatransfer.runs().list(parameters ...)
 

Returns:
the resource collection














Skip navigation links




Overview
Package
Class
Use
Tree
Deprecated
Index
Help




Prev Class
Next Class


Frames
No Frames


All Classes






Summary: 
Nested | 
Field | 
Constr | 
Method


Detail: 
Field | 
Constr | 
Method






Copyright © 2011–2024 Google. All rights reserved.

Modifier and Type	Class and Description
`class`	`BigQueryDataTransfer.Projects.TransferConfigs.Create`
`class`	`BigQueryDataTransfer.Projects.TransferConfigs.Delete`
`class`	`BigQueryDataTransfer.Projects.TransferConfigs.Get`
`class`	`BigQueryDataTransfer.Projects.TransferConfigs.List`
`class`	`BigQueryDataTransfer.Projects.TransferConfigs.Patch`
`class`	`BigQueryDataTransfer.Projects.TransferConfigs.Runs` The "runs" collection of methods.
`class`	`BigQueryDataTransfer.Projects.TransferConfigs.ScheduleRuns`
`class`	`BigQueryDataTransfer.Projects.TransferConfigs.StartManualRuns`

Modifier and Type	Method and Description
`BigQueryDataTransfer.Projects.TransferConfigs.Create`	`create(String parent, TransferConfig content)` Creates a new data transfer configuration.
`BigQueryDataTransfer.Projects.TransferConfigs.Delete`	`delete(String name)` Deletes a data transfer configuration, including any associated transfer runs and logs.
`BigQueryDataTransfer.Projects.TransferConfigs.Get`	`get(String name)` Returns information about a data transfer config.
`BigQueryDataTransfer.Projects.TransferConfigs.List`	`list(String parent)` Returns information about all transfer configs owned by a project in the specified location.
`BigQueryDataTransfer.Projects.TransferConfigs.Patch`	`patch(String name, TransferConfig content)` Updates a data transfer configuration.
`BigQueryDataTransfer.Projects.TransferConfigs.Runs`	`runs()` An accessor for creating requests from the Runs collection.
`BigQueryDataTransfer.Projects.TransferConfigs.ScheduleRuns`	`scheduleRuns(String parent, ScheduleTransferRunsRequest content)` Creates transfer runs for a time range [start_time, end_time].
`BigQueryDataTransfer.Projects.TransferConfigs.StartManualRuns`	`startManualRuns(String parent, StartManualTransferRunsRequest content)` Start manual transfer runs to be executed now with schedule_time equal to current time.