airbyte 0.7.0-beta2, Mar 7 25

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

airbyte.SourceTheGuardianApi

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.SourceTheGuardianApi;
import com.pulumi.airbyte.SourceTheGuardianApiArgs;
import com.pulumi.airbyte.inputs.SourceTheGuardianApiConfigurationArgs;
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 mySourceTheguardianapi = new SourceTheGuardianApi("mySourceTheguardianapi", SourceTheGuardianApiArgs.builder()
            .configuration(SourceTheGuardianApiConfigurationArgs.builder()
                .api_key("...my_api_key...")
                .end_date("YYYY-MM-DD")
                .query("environment AND NOT water")
                .section("media")
                .start_date("YYYY-MM-DD")
                .tag("environment/recycling")
                .build())
            .definitionId("b41ed4be-d785-4faf-b482-1fac261be026")
            .secretId("...my_secret_id...")
            .workspaceId("4d24582c-b7c1-4d05-99b9-d96b62ad290b")
            .build());

    }
}

resources:
  mySourceTheguardianapi:
    type: airbyte:SourceTheGuardianApi
    properties:
      configuration:
        api_key: '...my_api_key...'
        end_date: YYYY-MM-DD
        query: environment AND NOT water
        section: media
        start_date: YYYY-MM-DD
        tag: environment/recycling
      definitionId: b41ed4be-d785-4faf-b482-1fac261be026
      secretId: '...my_secret_id...'
      workspaceId: 4d24582c-b7c1-4d05-99b9-d96b62ad290b

Create SourceTheGuardianApi Resource

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

Constructor syntax

new SourceTheGuardianApi(name: string, args: SourceTheGuardianApiArgs, opts?: CustomResourceOptions);

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

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

func NewSourceTheGuardianApi(ctx *Context, name string, args SourceTheGuardianApiArgs, opts ...ResourceOption) (*SourceTheGuardianApi, error)

public SourceTheGuardianApi(string name, SourceTheGuardianApiArgs args, CustomResourceOptions? opts = null)

public SourceTheGuardianApi(String name, SourceTheGuardianApiArgs args)
public SourceTheGuardianApi(String name, SourceTheGuardianApiArgs args, CustomResourceOptions options)

type: airbyte:SourceTheGuardianApi
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 SourceTheGuardianApiArgs: 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 SourceTheGuardianApiArgs: 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 SourceTheGuardianApiArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

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

name String: The unique name of the resource.
args SourceTheGuardianApiArgs: 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 sourceTheGuardianApiResource = new Airbyte.SourceTheGuardianApi("sourceTheGuardianApiResource", new()
{
    Configuration = new Airbyte.Inputs.SourceTheGuardianApiConfigurationArgs
    {
        ApiKey = "string",
        StartDate = "string",
        EndDate = "string",
        Query = "string",
        Section = "string",
        Tag = "string",
    },
    WorkspaceId = "string",
    DefinitionId = "string",
    Name = "string",
    SecretId = "string",
});

example, err := airbyte.NewSourceTheGuardianApi(ctx, "sourceTheGuardianApiResource", &airbyte.SourceTheGuardianApiArgs{
Configuration: &.SourceTheGuardianApiConfigurationArgs{
ApiKey: pulumi.String("string"),
StartDate: pulumi.String("string"),
EndDate: pulumi.String("string"),
Query: pulumi.String("string"),
Section: pulumi.String("string"),
Tag: pulumi.String("string"),
},
WorkspaceId: pulumi.String("string"),
DefinitionId: pulumi.String("string"),
Name: pulumi.String("string"),
SecretId: pulumi.String("string"),
})

var sourceTheGuardianApiResource = new SourceTheGuardianApi("sourceTheGuardianApiResource", SourceTheGuardianApiArgs.builder()
    .configuration(SourceTheGuardianApiConfigurationArgs.builder()
        .apiKey("string")
        .startDate("string")
        .endDate("string")
        .query("string")
        .section("string")
        .tag("string")
        .build())
    .workspaceId("string")
    .definitionId("string")
    .name("string")
    .secretId("string")
    .build());

source_the_guardian_api_resource = airbyte.SourceTheGuardianApi("sourceTheGuardianApiResource",
    configuration={
        "api_key": "string",
        "start_date": "string",
        "end_date": "string",
        "query": "string",
        "section": "string",
        "tag": "string",
    },
    workspace_id="string",
    definition_id="string",
    name="string",
    secret_id="string")

const sourceTheGuardianApiResource = new airbyte.SourceTheGuardianApi("sourceTheGuardianApiResource", {
    configuration: {
        apiKey: "string",
        startDate: "string",
        endDate: "string",
        query: "string",
        section: "string",
        tag: "string",
    },
    workspaceId: "string",
    definitionId: "string",
    name: "string",
    secretId: "string",
});

type: airbyte:SourceTheGuardianApi
properties:
    configuration:
        apiKey: string
        endDate: string
        query: string
        section: string
        startDate: string
        tag: string
    definitionId: string
    name: string
    secretId: string
    workspaceId: string

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

Configuration SourceTheGuardianApiConfiguration
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 SourceTheGuardianApiConfigurationArgs
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 SourceTheGuardianApiConfiguration
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 SourceTheGuardianApiConfiguration
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 SourceTheGuardianApiConfigurationArgs
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 SourceTheGuardianApi 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 SourceTheGuardianApi Resource

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

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        configuration: Optional[SourceTheGuardianApiConfigurationArgs] = 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) -> SourceTheGuardianApi

func GetSourceTheGuardianApi(ctx *Context, name string, id IDInput, state *SourceTheGuardianApiState, opts ...ResourceOption) (*SourceTheGuardianApi, error)

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

public static SourceTheGuardianApi get(String name, Output<String> id, SourceTheGuardianApiState state, CustomResourceOptions options)

resources:  _:    type: airbyte:SourceTheGuardianApi    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 SourceTheGuardianApiConfiguration
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 SourceTheGuardianApiConfigurationArgs
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 SourceTheGuardianApiConfiguration
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 SourceTheGuardianApiConfiguration
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 SourceTheGuardianApiConfigurationArgs
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

SourceTheGuardianApiConfiguration, SourceTheGuardianApiConfigurationArgs

ApiKey string: Your API Key. See \n\nhere\n\n. The key is case sensitive.
StartDate string: Use this to set the minimum date (YYYY-MM-DD) of the results. Results older than the start_date will not be shown.
EndDate string: (Optional) Use this to set the maximum date (YYYY-MM-DD) of the results. Results newer than the end_date will not be shown. Default is set to the current date (today) for incremental syncs.
Query string: (Optional) The query (q) parameter filters the results to only those that include that search term. The q parameter supports AND, OR and NOT operators.
Section string: (Optional) Use this to filter the results by a particular section. See \n\nhere\n\n for a list of all sections, and \n\nhere\n\n for the sections endpoint documentation.
Tag string: (Optional) A tag is a piece of data that is used by The Guardian to categorise content. Use this parameter to filter results by showing only the ones matching the entered tag. See \n\nhere\n\n for a list of all tags, and \n\nhere\n\n for the tags endpoint documentation.

ApiKey string: Your API Key. See \n\nhere\n\n. The key is case sensitive.
StartDate string: Use this to set the minimum date (YYYY-MM-DD) of the results. Results older than the start_date will not be shown.
EndDate string: (Optional) Use this to set the maximum date (YYYY-MM-DD) of the results. Results newer than the end_date will not be shown. Default is set to the current date (today) for incremental syncs.
Query string: (Optional) The query (q) parameter filters the results to only those that include that search term. The q parameter supports AND, OR and NOT operators.
Section string: (Optional) Use this to filter the results by a particular section. See \n\nhere\n\n for a list of all sections, and \n\nhere\n\n for the sections endpoint documentation.
Tag string: (Optional) A tag is a piece of data that is used by The Guardian to categorise content. Use this parameter to filter results by showing only the ones matching the entered tag. See \n\nhere\n\n for a list of all tags, and \n\nhere\n\n for the tags endpoint documentation.

apiKey String: Your API Key. See \n\nhere\n\n. The key is case sensitive.
startDate String: Use this to set the minimum date (YYYY-MM-DD) of the results. Results older than the start_date will not be shown.
endDate String: (Optional) Use this to set the maximum date (YYYY-MM-DD) of the results. Results newer than the end_date will not be shown. Default is set to the current date (today) for incremental syncs.
query String: (Optional) The query (q) parameter filters the results to only those that include that search term. The q parameter supports AND, OR and NOT operators.
section String: (Optional) Use this to filter the results by a particular section. See \n\nhere\n\n for a list of all sections, and \n\nhere\n\n for the sections endpoint documentation.
tag String: (Optional) A tag is a piece of data that is used by The Guardian to categorise content. Use this parameter to filter results by showing only the ones matching the entered tag. See \n\nhere\n\n for a list of all tags, and \n\nhere\n\n for the tags endpoint documentation.

apiKey string: Your API Key. See \n\nhere\n\n. The key is case sensitive.
startDate string: Use this to set the minimum date (YYYY-MM-DD) of the results. Results older than the start_date will not be shown.
endDate string: (Optional) Use this to set the maximum date (YYYY-MM-DD) of the results. Results newer than the end_date will not be shown. Default is set to the current date (today) for incremental syncs.
query string: (Optional) The query (q) parameter filters the results to only those that include that search term. The q parameter supports AND, OR and NOT operators.
section string: (Optional) Use this to filter the results by a particular section. See \n\nhere\n\n for a list of all sections, and \n\nhere\n\n for the sections endpoint documentation.
tag string: (Optional) A tag is a piece of data that is used by The Guardian to categorise content. Use this parameter to filter results by showing only the ones matching the entered tag. See \n\nhere\n\n for a list of all tags, and \n\nhere\n\n for the tags endpoint documentation.

api_key str: Your API Key. See \n\nhere\n\n. The key is case sensitive.
start_date str: Use this to set the minimum date (YYYY-MM-DD) of the results. Results older than the start_date will not be shown.
end_date str: (Optional) Use this to set the maximum date (YYYY-MM-DD) of the results. Results newer than the end_date will not be shown. Default is set to the current date (today) for incremental syncs.
query str: (Optional) The query (q) parameter filters the results to only those that include that search term. The q parameter supports AND, OR and NOT operators.
section str: (Optional) Use this to filter the results by a particular section. See \n\nhere\n\n for a list of all sections, and \n\nhere\n\n for the sections endpoint documentation.
tag str: (Optional) A tag is a piece of data that is used by The Guardian to categorise content. Use this parameter to filter results by showing only the ones matching the entered tag. See \n\nhere\n\n for a list of all tags, and \n\nhere\n\n for the tags endpoint documentation.

apiKey String: Your API Key. See \n\nhere\n\n. The key is case sensitive.
startDate String: Use this to set the minimum date (YYYY-MM-DD) of the results. Results older than the start_date will not be shown.
endDate String: (Optional) Use this to set the maximum date (YYYY-MM-DD) of the results. Results newer than the end_date will not be shown. Default is set to the current date (today) for incremental syncs.
query String: (Optional) The query (q) parameter filters the results to only those that include that search term. The q parameter supports AND, OR and NOT operators.
section String: (Optional) Use this to filter the results by a particular section. See \n\nhere\n\n for a list of all sections, and \n\nhere\n\n for the sections endpoint documentation.
tag String: (Optional) A tag is a piece of data that is used by The Guardian to categorise content. Use this parameter to filter results by showing only the ones matching the entered tag. See \n\nhere\n\n for a list of all tags, and \n\nhere\n\n for the tags endpoint documentation.

Import

$ pulumi import airbyte:index/sourceTheGuardianApi:SourceTheGuardianApi my_airbyte_source_the_guardian_api ""

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.SourceTheGuardianApi

On this page

On this page

Example Usage

Create SourceTheGuardianApi Resource

Constructor syntax

Parameters

Constructor example

SourceTheGuardianApi Resource Properties

Inputs

Outputs

Look up Existing SourceTheGuardianApi Resource

Supporting Types

SourceTheGuardianApiConfiguration, SourceTheGuardianApiConfigurationArgs

Import

Package Details

On this page

On this page