airbyte 0.7.0-beta2, Mar 7 25

airbyte 0.7.0-beta2 published on Friday, Mar 7, 2025 by airbytehq

airbyte.SourceGmail

Explore with Pulumi AI

airbyte 0.7.0-beta2 published on Friday, Mar 7, 2025 by airbytehq

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.SourceGmail;
import com.pulumi.airbyte.SourceGmailArgs;
import com.pulumi.airbyte.inputs.SourceGmailConfigurationArgs;
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 mySourceGmail = new SourceGmail("mySourceGmail", SourceGmailArgs.builder()
            .configuration(SourceGmailConfigurationArgs.builder()
                .client_id("...my_client_id...")
                .client_refresh_token("...my_client_refresh_token...")
                .client_secret("...my_client_secret...")
                .include_spam_and_trash(true)
                .build())
            .definitionId("7955e0e4-3651-43bd-aa0d-851fff1510aa")
            .secretId("...my_secret_id...")
            .workspaceId("91cf70dd-2922-4ba3-aa00-75c581c84b39")
            .build());

    }
}

resources:
  mySourceGmail:
    type: airbyte:SourceGmail
    properties:
      configuration:
        client_id: '...my_client_id...'
        client_refresh_token: '...my_client_refresh_token...'
        client_secret: '...my_client_secret...'
        include_spam_and_trash: true
      definitionId: 7955e0e4-3651-43bd-aa0d-851fff1510aa
      secretId: '...my_secret_id...'
      workspaceId: 91cf70dd-2922-4ba3-aa00-75c581c84b39

Create SourceGmail Resource

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

Constructor syntax

new SourceGmail(name: string, args: SourceGmailArgs, opts?: CustomResourceOptions);

@overload
def SourceGmail(resource_name: str,
                args: SourceGmailArgs,
                opts: Optional[ResourceOptions] = None)

@overload
def SourceGmail(resource_name: str,
                opts: Optional[ResourceOptions] = None,
                configuration: Optional[SourceGmailConfigurationArgs] = None,
                workspace_id: Optional[str] = None,
                definition_id: Optional[str] = None,
                name: Optional[str] = None,
                secret_id: Optional[str] = None)

func NewSourceGmail(ctx *Context, name string, args SourceGmailArgs, opts ...ResourceOption) (*SourceGmail, error)

public SourceGmail(string name, SourceGmailArgs args, CustomResourceOptions? opts = null)

public SourceGmail(String name, SourceGmailArgs args)
public SourceGmail(String name, SourceGmailArgs args, CustomResourceOptions options)

type: airbyte:SourceGmail
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name string: The unique name of the resource.
args SourceGmailArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

resource_name str: The unique name of the resource.
args SourceGmailArgs: The arguments to resource properties.
opts ResourceOptions: Bag of options to control resource's behavior.

ctx Context: Context object for the current deployment.
name string: The unique name of the resource.
args SourceGmailArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args SourceGmailArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args SourceGmailArgs: 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 sourceGmailResource = new Airbyte.SourceGmail("sourceGmailResource", new()
{
    Configuration = new Airbyte.Inputs.SourceGmailConfigurationArgs
    {
        ClientId = "string",
        ClientRefreshToken = "string",
        ClientSecret = "string",
        IncludeSpamAndTrash = false,
    },
    WorkspaceId = "string",
    DefinitionId = "string",
    Name = "string",
    SecretId = "string",
});

example, err := airbyte.NewSourceGmail(ctx, "sourceGmailResource", &airbyte.SourceGmailArgs{
Configuration: &.SourceGmailConfigurationArgs{
ClientId: pulumi.String("string"),
ClientRefreshToken: pulumi.String("string"),
ClientSecret: pulumi.String("string"),
IncludeSpamAndTrash: pulumi.Bool(false),
},
WorkspaceId: pulumi.String("string"),
DefinitionId: pulumi.String("string"),
Name: pulumi.String("string"),
SecretId: pulumi.String("string"),
})

var sourceGmailResource = new SourceGmail("sourceGmailResource", SourceGmailArgs.builder()
    .configuration(SourceGmailConfigurationArgs.builder()
        .clientId("string")
        .clientRefreshToken("string")
        .clientSecret("string")
        .includeSpamAndTrash(false)
        .build())
    .workspaceId("string")
    .definitionId("string")
    .name("string")
    .secretId("string")
    .build());

source_gmail_resource = airbyte.SourceGmail("sourceGmailResource",
    configuration={
        "client_id": "string",
        "client_refresh_token": "string",
        "client_secret": "string",
        "include_spam_and_trash": False,
    },
    workspace_id="string",
    definition_id="string",
    name="string",
    secret_id="string")

const sourceGmailResource = new airbyte.SourceGmail("sourceGmailResource", {
    configuration: {
        clientId: "string",
        clientRefreshToken: "string",
        clientSecret: "string",
        includeSpamAndTrash: false,
    },
    workspaceId: "string",
    definitionId: "string",
    name: "string",
    secretId: "string",
});

type: airbyte:SourceGmail
properties:
    configuration:
        clientId: string
        clientRefreshToken: string
        clientSecret: string
        includeSpamAndTrash: false
    definitionId: string
    name: string
    secretId: string
    workspaceId: string

SourceGmail 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 SourceGmail resource accepts the following input properties:

Configuration SourceGmailConfiguration
WorkspaceId 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 SourceGmailConfigurationArgs
WorkspaceId 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 SourceGmailConfiguration
workspaceId 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 SourceGmailConfiguration
workspaceId 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 SourceGmailConfigurationArgs
workspace_id 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 Property Map
workspaceId 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 SourceGmail resource produces the following output properties:

CreatedAt double
Id string: The provider-assigned unique ID for this managed resource.
SourceId string
SourceType string

CreatedAt float64
Id string: The provider-assigned unique ID for this managed resource.
SourceId string
SourceType string

createdAt Double
id String: The provider-assigned unique ID for this managed resource.
sourceId String
sourceType String

createdAt number
id string: The provider-assigned unique ID for this managed resource.
sourceId string
sourceType string

created_at float
id str: The provider-assigned unique ID for this managed resource.
source_id str
source_type str

createdAt Number
id String: The provider-assigned unique ID for this managed resource.
sourceId String
sourceType String

Look up Existing SourceGmail Resource

Get an existing SourceGmail 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?: SourceGmailState, opts?: CustomResourceOptions): SourceGmail

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        configuration: Optional[SourceGmailConfigurationArgs] = None,
        created_at: Optional[float] = None,
        definition_id: Optional[str] = None,
        name: Optional[str] = None,
        secret_id: Optional[str] = None,
        source_id: Optional[str] = None,
        source_type: Optional[str] = None,
        workspace_id: Optional[str] = None) -> SourceGmail

func GetSourceGmail(ctx *Context, name string, id IDInput, state *SourceGmailState, opts ...ResourceOption) (*SourceGmail, error)

public static SourceGmail Get(string name, Input<string> id, SourceGmailState? state, CustomResourceOptions? opts = null)

public static SourceGmail get(String name, Output<String> id, SourceGmailState state, CustomResourceOptions options)

resources:  _:    type: airbyte:SourceGmail    get:      id: ${id}

name: The unique name of the resulting resource.
id: 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: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.

name: The unique name of the resulting resource.
id: 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: The unique name of the resulting resource.
id: 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: The unique name of the resulting resource.
id: 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 SourceGmailConfiguration
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.
SecretId string: Optional secretID obtained through the public API OAuth redirect flow. Requires replacement if changed.
SourceId string
SourceType string
WorkspaceId string

Configuration SourceGmailConfigurationArgs
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.
SecretId string: Optional secretID obtained through the public API OAuth redirect flow. Requires replacement if changed.
SourceId string
SourceType string
WorkspaceId string

configuration SourceGmailConfiguration
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.
secretId String: Optional secretID obtained through the public API OAuth redirect flow. Requires replacement if changed.
sourceId String
sourceType String
workspaceId String

configuration SourceGmailConfiguration
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.
secretId string: Optional secretID obtained through the public API OAuth redirect flow. Requires replacement if changed.
sourceId string
sourceType string
workspaceId string

configuration SourceGmailConfigurationArgs
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.
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.
secretId String: Optional secretID obtained through the public API OAuth redirect flow. Requires replacement if changed.
sourceId String
sourceType String
workspaceId String

Supporting Types

SourceGmailConfiguration, SourceGmailConfigurationArgs

ClientId string
ClientRefreshToken string
ClientSecret string
IncludeSpamAndTrash bool: Include drafts/messages from SPAM and TRASH in the results. Defaults to false. Default: false

ClientId string
ClientRefreshToken string
ClientSecret string
IncludeSpamAndTrash bool: Include drafts/messages from SPAM and TRASH in the results. Defaults to false. Default: false

clientId String
clientRefreshToken String
clientSecret String
includeSpamAndTrash Boolean: Include drafts/messages from SPAM and TRASH in the results. Defaults to false. Default: false

clientId string
clientRefreshToken string
clientSecret string
includeSpamAndTrash boolean: Include drafts/messages from SPAM and TRASH in the results. Defaults to false. Default: false

client_id str
client_refresh_token str
client_secret str
include_spam_and_trash bool: Include drafts/messages from SPAM and TRASH in the results. Defaults to false. Default: false

clientId String
clientRefreshToken String
clientSecret String
includeSpamAndTrash Boolean: Include drafts/messages from SPAM and TRASH in the results. Defaults to false. Default: false

Import

$ pulumi import airbyte:index/sourceGmail:SourceGmail my_airbyte_source_gmail ""

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.

airbyte 0.7.0-beta2 published on Friday, Mar 7, 2025 by airbytehq

airbytehq/terraform-provider-airbyte

airbyte.SourceGmail

On this page

On this page

Example Usage

Create SourceGmail Resource

Constructor syntax

Parameters

Constructor example

SourceGmail Resource Properties

Inputs

Outputs

Look up Existing SourceGmail Resource

Supporting Types

SourceGmailConfiguration, SourceGmailConfigurationArgs

Import

Package Details

On this page

On this page