1. Packages
  2. Airbyte Provider
  3. API Docs
  4. SourceGoogleSheets
airbyte 0.10.0 published on Monday, Apr 14, 2025 by airbytehq

airbyte.SourceGoogleSheets

Explore with Pulumi AI

SourceGoogleSheets Resource

Example Usage

Coming soon!
Coming soon!
Coming soon!
Coming soon!
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.airbyte.SourceGoogleSheets;
import com.pulumi.airbyte.SourceGoogleSheetsArgs;
import com.pulumi.airbyte.inputs.SourceGoogleSheetsConfigurationArgs;
import com.pulumi.airbyte.inputs.SourceGoogleSheetsConfigurationCredentialsArgs;
import com.pulumi.airbyte.inputs.SourceGoogleSheetsConfigurationCredentialsServiceAccountKeyAuthenticationArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var mySourceGooglesheets = new SourceGoogleSheets("mySourceGooglesheets", SourceGoogleSheetsArgs.builder()
            .configuration(SourceGoogleSheetsConfigurationArgs.builder()
                .batch_size(10)
                .credentials(SourceGoogleSheetsConfigurationCredentialsArgs.builder()
                    .serviceAccountKeyAuthentication(SourceGoogleSheetsConfigurationCredentialsServiceAccountKeyAuthenticationArgs.builder()
                        .serviceAccountInfo("{ \"type\": \"service_account\", \"project_id\": YOUR_PROJECT_ID, \"private_key_id\": YOUR_PRIVATE_KEY, ... }")
                        .build())
                    .build())
                .names_conversion(false)
                .spreadsheet_id("https://docs.google.com/spreadsheets/d/1hLd9Qqti3UyLXZB2aFfUWDT7BG-arw2xy4HR3D-dwUb/edit")
                .build())
            .definitionId("8010dc77-56bf-4220-982b-1460e03dad99")
            .secretId("...my_secret_id...")
            .workspaceId("6266806c-1cd7-4250-b2c6-f4ef1504f265")
            .build());

    }
}
Copy
resources:
  mySourceGooglesheets:
    type: airbyte:SourceGoogleSheets
    properties:
      configuration:
        batch_size: 10
        credentials:
          serviceAccountKeyAuthentication:
            serviceAccountInfo: '{ "type": "service_account", "project_id": YOUR_PROJECT_ID, "private_key_id": YOUR_PRIVATE_KEY, ... }'
        names_conversion: false
        spreadsheet_id: https://docs.google.com/spreadsheets/d/1hLd9Qqti3UyLXZB2aFfUWDT7BG-arw2xy4HR3D-dwUb/edit
      definitionId: 8010dc77-56bf-4220-982b-1460e03dad99
      secretId: '...my_secret_id...'
      workspaceId: 6266806c-1cd7-4250-b2c6-f4ef1504f265
Copy

Create SourceGoogleSheets Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new SourceGoogleSheets(name: string, args: SourceGoogleSheetsArgs, opts?: CustomResourceOptions);
@overload
def SourceGoogleSheets(resource_name: str,
                       args: SourceGoogleSheetsArgs,
                       opts: Optional[ResourceOptions] = None)

@overload
def SourceGoogleSheets(resource_name: str,
                       opts: Optional[ResourceOptions] = None,
                       configuration: Optional[SourceGoogleSheetsConfigurationArgs] = None,
                       workspace_id: Optional[str] = None,
                       definition_id: Optional[str] = None,
                       name: Optional[str] = None,
                       secret_id: Optional[str] = None)
func NewSourceGoogleSheets(ctx *Context, name string, args SourceGoogleSheetsArgs, opts ...ResourceOption) (*SourceGoogleSheets, error)
public SourceGoogleSheets(string name, SourceGoogleSheetsArgs args, CustomResourceOptions? opts = null)
public SourceGoogleSheets(String name, SourceGoogleSheetsArgs args)
public SourceGoogleSheets(String name, SourceGoogleSheetsArgs args, CustomResourceOptions options)
type: airbyte:SourceGoogleSheets
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. SourceGoogleSheetsArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. SourceGoogleSheetsArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. SourceGoogleSheetsArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. SourceGoogleSheetsArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. SourceGoogleSheetsArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Constructor example

The following reference example uses placeholder values for all input properties.

var sourceGoogleSheetsResource = new Airbyte.SourceGoogleSheets("sourceGoogleSheetsResource", new()
{
    Configuration = new Airbyte.Inputs.SourceGoogleSheetsConfigurationArgs
    {
        Credentials = new Airbyte.Inputs.SourceGoogleSheetsConfigurationCredentialsArgs
        {
            AuthenticateViaGoogleOAuth = new Airbyte.Inputs.SourceGoogleSheetsConfigurationCredentialsAuthenticateViaGoogleOAuthArgs
            {
                ClientId = "string",
                ClientSecret = "string",
                RefreshToken = "string",
            },
            ServiceAccountKeyAuthentication = new Airbyte.Inputs.SourceGoogleSheetsConfigurationCredentialsServiceAccountKeyAuthenticationArgs
            {
                ServiceAccountInfo = "string",
            },
        },
        SpreadsheetId = "string",
        BatchSize = 0,
        NamesConversion = false,
    },
    WorkspaceId = "string",
    DefinitionId = "string",
    Name = "string",
    SecretId = "string",
});
Copy
example, err := airbyte.NewSourceGoogleSheets(ctx, "sourceGoogleSheetsResource", &airbyte.SourceGoogleSheetsArgs{
Configuration: &.SourceGoogleSheetsConfigurationArgs{
Credentials: &.SourceGoogleSheetsConfigurationCredentialsArgs{
AuthenticateViaGoogleOAuth: &.SourceGoogleSheetsConfigurationCredentialsAuthenticateViaGoogleOAuthArgs{
ClientId: pulumi.String("string"),
ClientSecret: pulumi.String("string"),
RefreshToken: pulumi.String("string"),
},
ServiceAccountKeyAuthentication: &.SourceGoogleSheetsConfigurationCredentialsServiceAccountKeyAuthenticationArgs{
ServiceAccountInfo: pulumi.String("string"),
},
},
SpreadsheetId: pulumi.String("string"),
BatchSize: pulumi.Float64(0),
NamesConversion: pulumi.Bool(false),
},
WorkspaceId: pulumi.String("string"),
DefinitionId: pulumi.String("string"),
Name: pulumi.String("string"),
SecretId: pulumi.String("string"),
})
Copy
var sourceGoogleSheetsResource = new SourceGoogleSheets("sourceGoogleSheetsResource", SourceGoogleSheetsArgs.builder()
    .configuration(SourceGoogleSheetsConfigurationArgs.builder()
        .credentials(SourceGoogleSheetsConfigurationCredentialsArgs.builder()
            .authenticateViaGoogleOAuth(SourceGoogleSheetsConfigurationCredentialsAuthenticateViaGoogleOAuthArgs.builder()
                .clientId("string")
                .clientSecret("string")
                .refreshToken("string")
                .build())
            .serviceAccountKeyAuthentication(SourceGoogleSheetsConfigurationCredentialsServiceAccountKeyAuthenticationArgs.builder()
                .serviceAccountInfo("string")
                .build())
            .build())
        .spreadsheetId("string")
        .batchSize(0)
        .namesConversion(false)
        .build())
    .workspaceId("string")
    .definitionId("string")
    .name("string")
    .secretId("string")
    .build());
Copy
source_google_sheets_resource = airbyte.SourceGoogleSheets("sourceGoogleSheetsResource",
    configuration={
        "credentials": {
            "authenticate_via_google_o_auth": {
                "client_id": "string",
                "client_secret": "string",
                "refresh_token": "string",
            },
            "service_account_key_authentication": {
                "service_account_info": "string",
            },
        },
        "spreadsheet_id": "string",
        "batch_size": 0,
        "names_conversion": False,
    },
    workspace_id="string",
    definition_id="string",
    name="string",
    secret_id="string")
Copy
const sourceGoogleSheetsResource = new airbyte.SourceGoogleSheets("sourceGoogleSheetsResource", {
    configuration: {
        credentials: {
            authenticateViaGoogleOAuth: {
                clientId: "string",
                clientSecret: "string",
                refreshToken: "string",
            },
            serviceAccountKeyAuthentication: {
                serviceAccountInfo: "string",
            },
        },
        spreadsheetId: "string",
        batchSize: 0,
        namesConversion: false,
    },
    workspaceId: "string",
    definitionId: "string",
    name: "string",
    secretId: "string",
});
Copy
type: airbyte:SourceGoogleSheets
properties:
    configuration:
        batchSize: 0
        credentials:
            authenticateViaGoogleOAuth:
                clientId: string
                clientSecret: string
                refreshToken: string
            serviceAccountKeyAuthentication:
                serviceAccountInfo: string
        namesConversion: false
        spreadsheetId: string
    definitionId: string
    name: string
    secretId: string
    workspaceId: string
Copy

SourceGoogleSheets Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The SourceGoogleSheets resource accepts the following input properties:

Configuration This property is required. SourceGoogleSheetsConfiguration
WorkspaceId This property is required. string
DefinitionId string
The UUID of the connector definition. One of configuration.sourceType or definitionId must be provided. Requires replacement if changed.
Name string
Name of the source e.g. dev-mysql-instance.
SecretId string
Optional secretID obtained through the public API OAuth redirect flow. Requires replacement if changed.
Configuration This property is required. SourceGoogleSheetsConfigurationArgs
WorkspaceId This property is required. string
DefinitionId string
The UUID of the connector definition. One of configuration.sourceType or definitionId must be provided. Requires replacement if changed.
Name string
Name of the source e.g. dev-mysql-instance.
SecretId string
Optional secretID obtained through the public API OAuth redirect flow. Requires replacement if changed.
configuration This property is required. SourceGoogleSheetsConfiguration
workspaceId This property is required. String
definitionId String
The UUID of the connector definition. One of configuration.sourceType or definitionId must be provided. Requires replacement if changed.
name String
Name of the source e.g. dev-mysql-instance.
secretId String
Optional secretID obtained through the public API OAuth redirect flow. Requires replacement if changed.
configuration This property is required. SourceGoogleSheetsConfiguration
workspaceId This property is required. string
definitionId string
The UUID of the connector definition. One of configuration.sourceType or definitionId must be provided. Requires replacement if changed.
name string
Name of the source e.g. dev-mysql-instance.
secretId string
Optional secretID obtained through the public API OAuth redirect flow. Requires replacement if changed.
configuration This property is required. SourceGoogleSheetsConfigurationArgs
workspace_id This property is required. str
definition_id str
The UUID of the connector definition. One of configuration.sourceType or definitionId must be provided. Requires replacement if changed.
name str
Name of the source e.g. dev-mysql-instance.
secret_id str
Optional secretID obtained through the public API OAuth redirect flow. Requires replacement if changed.
configuration This property is required. Property Map
workspaceId This property is required. String
definitionId String
The UUID of the connector definition. One of configuration.sourceType or definitionId must be provided. Requires replacement if changed.
name String
Name of the source e.g. dev-mysql-instance.
secretId String
Optional secretID obtained through the public API OAuth redirect flow. Requires replacement if changed.

Outputs

All input properties are implicitly available as output properties. Additionally, the SourceGoogleSheets resource produces the following output properties:

CreatedAt double
Id string
The provider-assigned unique ID for this managed resource.
ResourceAllocation SourceGoogleSheetsResourceAllocation
actor or actor definition specific resource requirements. if default is set, these are the requirements that should be set for ALL jobs run for this actor definition. it is overriden by the job type specific configurations. if not set, the platform will use defaults. these values will be overriden by configuration at the connection level.
SourceId string
SourceType string
CreatedAt float64
Id string
The provider-assigned unique ID for this managed resource.
ResourceAllocation SourceGoogleSheetsResourceAllocation
actor or actor definition specific resource requirements. if default is set, these are the requirements that should be set for ALL jobs run for this actor definition. it is overriden by the job type specific configurations. if not set, the platform will use defaults. these values will be overriden by configuration at the connection level.
SourceId string
SourceType string
createdAt Double
id String
The provider-assigned unique ID for this managed resource.
resourceAllocation SourceGoogleSheetsResourceAllocation
actor or actor definition specific resource requirements. if default is set, these are the requirements that should be set for ALL jobs run for this actor definition. it is overriden by the job type specific configurations. if not set, the platform will use defaults. these values will be overriden by configuration at the connection level.
sourceId String
sourceType String
createdAt number
id string
The provider-assigned unique ID for this managed resource.
resourceAllocation SourceGoogleSheetsResourceAllocation
actor or actor definition specific resource requirements. if default is set, these are the requirements that should be set for ALL jobs run for this actor definition. it is overriden by the job type specific configurations. if not set, the platform will use defaults. these values will be overriden by configuration at the connection level.
sourceId string
sourceType string
created_at float
id str
The provider-assigned unique ID for this managed resource.
resource_allocation SourceGoogleSheetsResourceAllocation
actor or actor definition specific resource requirements. if default is set, these are the requirements that should be set for ALL jobs run for this actor definition. it is overriden by the job type specific configurations. if not set, the platform will use defaults. these values will be overriden by configuration at the connection level.
source_id str
source_type str
createdAt Number
id String
The provider-assigned unique ID for this managed resource.
resourceAllocation Property Map
actor or actor definition specific resource requirements. if default is set, these are the requirements that should be set for ALL jobs run for this actor definition. it is overriden by the job type specific configurations. if not set, the platform will use defaults. these values will be overriden by configuration at the connection level.
sourceId String
sourceType String

Look up Existing SourceGoogleSheets Resource

Get an existing SourceGoogleSheets resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: SourceGoogleSheetsState, opts?: CustomResourceOptions): SourceGoogleSheets
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        configuration: Optional[SourceGoogleSheetsConfigurationArgs] = None,
        created_at: Optional[float] = None,
        definition_id: Optional[str] = None,
        name: Optional[str] = None,
        resource_allocation: Optional[SourceGoogleSheetsResourceAllocationArgs] = None,
        secret_id: Optional[str] = None,
        source_id: Optional[str] = None,
        source_type: Optional[str] = None,
        workspace_id: Optional[str] = None) -> SourceGoogleSheets
func GetSourceGoogleSheets(ctx *Context, name string, id IDInput, state *SourceGoogleSheetsState, opts ...ResourceOption) (*SourceGoogleSheets, error)
public static SourceGoogleSheets Get(string name, Input<string> id, SourceGoogleSheetsState? state, CustomResourceOptions? opts = null)
public static SourceGoogleSheets get(String name, Output<String> id, SourceGoogleSheetsState state, CustomResourceOptions options)
resources:  _:    type: airbyte:SourceGoogleSheets    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
resource_name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
The following state arguments are supported:
Configuration SourceGoogleSheetsConfiguration
CreatedAt double
DefinitionId string
The UUID of the connector definition. One of configuration.sourceType or definitionId must be provided. Requires replacement if changed.
Name string
Name of the source e.g. dev-mysql-instance.
ResourceAllocation SourceGoogleSheetsResourceAllocation
actor or actor definition specific resource requirements. if default is set, these are the requirements that should be set for ALL jobs run for this actor definition. it is overriden by the job type specific configurations. if not set, the platform will use defaults. these values will be overriden by configuration at the connection level.
SecretId string
Optional secretID obtained through the public API OAuth redirect flow. Requires replacement if changed.
SourceId string
SourceType string
WorkspaceId string
Configuration SourceGoogleSheetsConfigurationArgs
CreatedAt float64
DefinitionId string
The UUID of the connector definition. One of configuration.sourceType or definitionId must be provided. Requires replacement if changed.
Name string
Name of the source e.g. dev-mysql-instance.
ResourceAllocation SourceGoogleSheetsResourceAllocationArgs
actor or actor definition specific resource requirements. if default is set, these are the requirements that should be set for ALL jobs run for this actor definition. it is overriden by the job type specific configurations. if not set, the platform will use defaults. these values will be overriden by configuration at the connection level.
SecretId string
Optional secretID obtained through the public API OAuth redirect flow. Requires replacement if changed.
SourceId string
SourceType string
WorkspaceId string
configuration SourceGoogleSheetsConfiguration
createdAt Double
definitionId String
The UUID of the connector definition. One of configuration.sourceType or definitionId must be provided. Requires replacement if changed.
name String
Name of the source e.g. dev-mysql-instance.
resourceAllocation SourceGoogleSheetsResourceAllocation
actor or actor definition specific resource requirements. if default is set, these are the requirements that should be set for ALL jobs run for this actor definition. it is overriden by the job type specific configurations. if not set, the platform will use defaults. these values will be overriden by configuration at the connection level.
secretId String
Optional secretID obtained through the public API OAuth redirect flow. Requires replacement if changed.
sourceId String
sourceType String
workspaceId String
configuration SourceGoogleSheetsConfiguration
createdAt number
definitionId string
The UUID of the connector definition. One of configuration.sourceType or definitionId must be provided. Requires replacement if changed.
name string
Name of the source e.g. dev-mysql-instance.
resourceAllocation SourceGoogleSheetsResourceAllocation
actor or actor definition specific resource requirements. if default is set, these are the requirements that should be set for ALL jobs run for this actor definition. it is overriden by the job type specific configurations. if not set, the platform will use defaults. these values will be overriden by configuration at the connection level.
secretId string
Optional secretID obtained through the public API OAuth redirect flow. Requires replacement if changed.
sourceId string
sourceType string
workspaceId string
configuration SourceGoogleSheetsConfigurationArgs
created_at float
definition_id str
The UUID of the connector definition. One of configuration.sourceType or definitionId must be provided. Requires replacement if changed.
name str
Name of the source e.g. dev-mysql-instance.
resource_allocation SourceGoogleSheetsResourceAllocationArgs
actor or actor definition specific resource requirements. if default is set, these are the requirements that should be set for ALL jobs run for this actor definition. it is overriden by the job type specific configurations. if not set, the platform will use defaults. these values will be overriden by configuration at the connection level.
secret_id str
Optional secretID obtained through the public API OAuth redirect flow. Requires replacement if changed.
source_id str
source_type str
workspace_id str
configuration Property Map
createdAt Number
definitionId String
The UUID of the connector definition. One of configuration.sourceType or definitionId must be provided. Requires replacement if changed.
name String
Name of the source e.g. dev-mysql-instance.
resourceAllocation Property Map
actor or actor definition specific resource requirements. if default is set, these are the requirements that should be set for ALL jobs run for this actor definition. it is overriden by the job type specific configurations. if not set, the platform will use defaults. these values will be overriden by configuration at the connection level.
secretId String
Optional secretID obtained through the public API OAuth redirect flow. Requires replacement if changed.
sourceId String
sourceType String
workspaceId String

Supporting Types

SourceGoogleSheetsConfiguration
, SourceGoogleSheetsConfigurationArgs

Credentials This property is required. SourceGoogleSheetsConfigurationCredentials
Credentials for connecting to the Google Sheets API
SpreadsheetId This property is required. string
Enter the link to the Google spreadsheet you want to sync. To copy the link, click the 'Share' button in the top-right corner of the spreadsheet, then click 'Copy link'.
BatchSize double
Default value is 1000000. An integer representing row batch size for each sent request to Google Sheets API. Row batch size means how many rows are processed from the google sheet, for example default value 1000000 would process rows 2-1000002, then 1000003-2000003 and so on. Based on \n\nGoogle Sheets API limits documentation\n\n, it is possible to send up to 300 requests per minute, but each individual request has to be processed under 180 seconds, otherwise the request returns a timeout error. In regards to this information, consider network speed and number of columns of the google sheet when deciding a batch_size value. Default: 1000000
NamesConversion bool
Enables the conversion of column names to a standardized, SQL-compliant format. For example, 'My Name' > 'my_name'. Enable this option if your destination is SQL-based. Default: false
Credentials This property is required. SourceGoogleSheetsConfigurationCredentials
Credentials for connecting to the Google Sheets API
SpreadsheetId This property is required. string
Enter the link to the Google spreadsheet you want to sync. To copy the link, click the 'Share' button in the top-right corner of the spreadsheet, then click 'Copy link'.
BatchSize float64
Default value is 1000000. An integer representing row batch size for each sent request to Google Sheets API. Row batch size means how many rows are processed from the google sheet, for example default value 1000000 would process rows 2-1000002, then 1000003-2000003 and so on. Based on \n\nGoogle Sheets API limits documentation\n\n, it is possible to send up to 300 requests per minute, but each individual request has to be processed under 180 seconds, otherwise the request returns a timeout error. In regards to this information, consider network speed and number of columns of the google sheet when deciding a batch_size value. Default: 1000000
NamesConversion bool
Enables the conversion of column names to a standardized, SQL-compliant format. For example, 'My Name' > 'my_name'. Enable this option if your destination is SQL-based. Default: false
credentials This property is required. SourceGoogleSheetsConfigurationCredentials
Credentials for connecting to the Google Sheets API
spreadsheetId This property is required. String
Enter the link to the Google spreadsheet you want to sync. To copy the link, click the 'Share' button in the top-right corner of the spreadsheet, then click 'Copy link'.
batchSize Double
Default value is 1000000. An integer representing row batch size for each sent request to Google Sheets API. Row batch size means how many rows are processed from the google sheet, for example default value 1000000 would process rows 2-1000002, then 1000003-2000003 and so on. Based on \n\nGoogle Sheets API limits documentation\n\n, it is possible to send up to 300 requests per minute, but each individual request has to be processed under 180 seconds, otherwise the request returns a timeout error. In regards to this information, consider network speed and number of columns of the google sheet when deciding a batch_size value. Default: 1000000
namesConversion Boolean
Enables the conversion of column names to a standardized, SQL-compliant format. For example, 'My Name' > 'my_name'. Enable this option if your destination is SQL-based. Default: false
credentials This property is required. SourceGoogleSheetsConfigurationCredentials
Credentials for connecting to the Google Sheets API
spreadsheetId This property is required. string
Enter the link to the Google spreadsheet you want to sync. To copy the link, click the 'Share' button in the top-right corner of the spreadsheet, then click 'Copy link'.
batchSize number
Default value is 1000000. An integer representing row batch size for each sent request to Google Sheets API. Row batch size means how many rows are processed from the google sheet, for example default value 1000000 would process rows 2-1000002, then 1000003-2000003 and so on. Based on \n\nGoogle Sheets API limits documentation\n\n, it is possible to send up to 300 requests per minute, but each individual request has to be processed under 180 seconds, otherwise the request returns a timeout error. In regards to this information, consider network speed and number of columns of the google sheet when deciding a batch_size value. Default: 1000000
namesConversion boolean
Enables the conversion of column names to a standardized, SQL-compliant format. For example, 'My Name' > 'my_name'. Enable this option if your destination is SQL-based. Default: false
credentials This property is required. SourceGoogleSheetsConfigurationCredentials
Credentials for connecting to the Google Sheets API
spreadsheet_id This property is required. str
Enter the link to the Google spreadsheet you want to sync. To copy the link, click the 'Share' button in the top-right corner of the spreadsheet, then click 'Copy link'.
batch_size float
Default value is 1000000. An integer representing row batch size for each sent request to Google Sheets API. Row batch size means how many rows are processed from the google sheet, for example default value 1000000 would process rows 2-1000002, then 1000003-2000003 and so on. Based on \n\nGoogle Sheets API limits documentation\n\n, it is possible to send up to 300 requests per minute, but each individual request has to be processed under 180 seconds, otherwise the request returns a timeout error. In regards to this information, consider network speed and number of columns of the google sheet when deciding a batch_size value. Default: 1000000
names_conversion bool
Enables the conversion of column names to a standardized, SQL-compliant format. For example, 'My Name' > 'my_name'. Enable this option if your destination is SQL-based. Default: false
credentials This property is required. Property Map
Credentials for connecting to the Google Sheets API
spreadsheetId This property is required. String
Enter the link to the Google spreadsheet you want to sync. To copy the link, click the 'Share' button in the top-right corner of the spreadsheet, then click 'Copy link'.
batchSize Number
Default value is 1000000. An integer representing row batch size for each sent request to Google Sheets API. Row batch size means how many rows are processed from the google sheet, for example default value 1000000 would process rows 2-1000002, then 1000003-2000003 and so on. Based on \n\nGoogle Sheets API limits documentation\n\n, it is possible to send up to 300 requests per minute, but each individual request has to be processed under 180 seconds, otherwise the request returns a timeout error. In regards to this information, consider network speed and number of columns of the google sheet when deciding a batch_size value. Default: 1000000
namesConversion Boolean
Enables the conversion of column names to a standardized, SQL-compliant format. For example, 'My Name' > 'my_name'. Enable this option if your destination is SQL-based. Default: false

SourceGoogleSheetsConfigurationCredentials
, SourceGoogleSheetsConfigurationCredentialsArgs

SourceGoogleSheetsConfigurationCredentialsAuthenticateViaGoogleOAuth
, SourceGoogleSheetsConfigurationCredentialsAuthenticateViaGoogleOAuthArgs

ClientId This property is required. string
Enter your Google application's Client ID. See \n\nGoogle's documentation\n\n for more information.
ClientSecret This property is required. string
Enter your Google application's Client Secret. See \n\nGoogle's documentation\n\n for more information.
RefreshToken This property is required. string
Enter your Google application's refresh token. See \n\nGoogle's documentation\n\n for more information.
ClientId This property is required. string
Enter your Google application's Client ID. See \n\nGoogle's documentation\n\n for more information.
ClientSecret This property is required. string
Enter your Google application's Client Secret. See \n\nGoogle's documentation\n\n for more information.
RefreshToken This property is required. string
Enter your Google application's refresh token. See \n\nGoogle's documentation\n\n for more information.
clientId This property is required. String
Enter your Google application's Client ID. See \n\nGoogle's documentation\n\n for more information.
clientSecret This property is required. String
Enter your Google application's Client Secret. See \n\nGoogle's documentation\n\n for more information.
refreshToken This property is required. String
Enter your Google application's refresh token. See \n\nGoogle's documentation\n\n for more information.
clientId This property is required. string
Enter your Google application's Client ID. See \n\nGoogle's documentation\n\n for more information.
clientSecret This property is required. string
Enter your Google application's Client Secret. See \n\nGoogle's documentation\n\n for more information.
refreshToken This property is required. string
Enter your Google application's refresh token. See \n\nGoogle's documentation\n\n for more information.
client_id This property is required. str
Enter your Google application's Client ID. See \n\nGoogle's documentation\n\n for more information.
client_secret This property is required. str
Enter your Google application's Client Secret. See \n\nGoogle's documentation\n\n for more information.
refresh_token This property is required. str
Enter your Google application's refresh token. See \n\nGoogle's documentation\n\n for more information.
clientId This property is required. String
Enter your Google application's Client ID. See \n\nGoogle's documentation\n\n for more information.
clientSecret This property is required. String
Enter your Google application's Client Secret. See \n\nGoogle's documentation\n\n for more information.
refreshToken This property is required. String
Enter your Google application's refresh token. See \n\nGoogle's documentation\n\n for more information.

SourceGoogleSheetsConfigurationCredentialsServiceAccountKeyAuthentication
, SourceGoogleSheetsConfigurationCredentialsServiceAccountKeyAuthenticationArgs

ServiceAccountInfo This property is required. string
The JSON key of the service account to use for authorization. Read more \n\nhere\n\n.
ServiceAccountInfo This property is required. string
The JSON key of the service account to use for authorization. Read more \n\nhere\n\n.
serviceAccountInfo This property is required. String
The JSON key of the service account to use for authorization. Read more \n\nhere\n\n.
serviceAccountInfo This property is required. string
The JSON key of the service account to use for authorization. Read more \n\nhere\n\n.
service_account_info This property is required. str
The JSON key of the service account to use for authorization. Read more \n\nhere\n\n.
serviceAccountInfo This property is required. String
The JSON key of the service account to use for authorization. Read more \n\nhere\n\n.

SourceGoogleSheetsResourceAllocation
, SourceGoogleSheetsResourceAllocationArgs

Default SourceGoogleSheetsResourceAllocationDefault
optional resource requirements to run workers (blank for unbounded allocations)
JobSpecifics List<SourceGoogleSheetsResourceAllocationJobSpecific>
Default SourceGoogleSheetsResourceAllocationDefault
optional resource requirements to run workers (blank for unbounded allocations)
JobSpecifics []SourceGoogleSheetsResourceAllocationJobSpecific
default_ SourceGoogleSheetsResourceAllocationDefault
optional resource requirements to run workers (blank for unbounded allocations)
jobSpecifics List<SourceGoogleSheetsResourceAllocationJobSpecific>
default SourceGoogleSheetsResourceAllocationDefault
optional resource requirements to run workers (blank for unbounded allocations)
jobSpecifics SourceGoogleSheetsResourceAllocationJobSpecific[]
default SourceGoogleSheetsResourceAllocationDefault
optional resource requirements to run workers (blank for unbounded allocations)
job_specifics Sequence[SourceGoogleSheetsResourceAllocationJobSpecific]
default Property Map
optional resource requirements to run workers (blank for unbounded allocations)
jobSpecifics List<Property Map>

SourceGoogleSheetsResourceAllocationDefault
, SourceGoogleSheetsResourceAllocationDefaultArgs

SourceGoogleSheetsResourceAllocationJobSpecific
, SourceGoogleSheetsResourceAllocationJobSpecificArgs

JobType string
enum that describes the different types of jobs that the platform runs. must be one of ["getspec", "checkconnection", "discoverschema", "sync", "resetconnection", "connection_updater", "replicate"]
ResourceRequirements SourceGoogleSheetsResourceAllocationJobSpecificResourceRequirements
optional resource requirements to run workers (blank for unbounded allocations)
JobType string
enum that describes the different types of jobs that the platform runs. must be one of ["getspec", "checkconnection", "discoverschema", "sync", "resetconnection", "connection_updater", "replicate"]
ResourceRequirements SourceGoogleSheetsResourceAllocationJobSpecificResourceRequirements
optional resource requirements to run workers (blank for unbounded allocations)
jobType String
enum that describes the different types of jobs that the platform runs. must be one of ["getspec", "checkconnection", "discoverschema", "sync", "resetconnection", "connection_updater", "replicate"]
resourceRequirements SourceGoogleSheetsResourceAllocationJobSpecificResourceRequirements
optional resource requirements to run workers (blank for unbounded allocations)
jobType string
enum that describes the different types of jobs that the platform runs. must be one of ["getspec", "checkconnection", "discoverschema", "sync", "resetconnection", "connection_updater", "replicate"]
resourceRequirements SourceGoogleSheetsResourceAllocationJobSpecificResourceRequirements
optional resource requirements to run workers (blank for unbounded allocations)
job_type str
enum that describes the different types of jobs that the platform runs. must be one of ["getspec", "checkconnection", "discoverschema", "sync", "resetconnection", "connection_updater", "replicate"]
resource_requirements SourceGoogleSheetsResourceAllocationJobSpecificResourceRequirements
optional resource requirements to run workers (blank for unbounded allocations)
jobType String
enum that describes the different types of jobs that the platform runs. must be one of ["getspec", "checkconnection", "discoverschema", "sync", "resetconnection", "connection_updater", "replicate"]
resourceRequirements Property Map
optional resource requirements to run workers (blank for unbounded allocations)

SourceGoogleSheetsResourceAllocationJobSpecificResourceRequirements
, SourceGoogleSheetsResourceAllocationJobSpecificResourceRequirementsArgs

Import

$ pulumi import airbyte:index/sourceGoogleSheets:SourceGoogleSheets my_airbyte_source_google_sheets ""
Copy

To learn more about importing existing cloud resources, see Importing resources.

Package Details

Repository
airbyte airbytehq/terraform-provider-airbyte
License
Notes
This Pulumi package is based on the airbyte Terraform Provider.