1. Packages
  2. Google Cloud Native
  3. API Docs
  4. apigee
  5. apigee/v1
  6. Export

Google Cloud Native is in preview. Google Cloud Classic is fully supported.

Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi

google-native.apigee/v1.Export

Explore with Pulumi AI

google-native logo

Google Cloud Native is in preview. Google Cloud Classic is fully supported.

Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi

    Submit a data export job to be processed in the background. If the request is successful, the API returns a 201 status, a URI that can be used to retrieve the status of the export job, and the state value of “enqueued”. Note - this resource’s API doesn’t support deletion. When deleted, the resource will persist on Google Cloud even though it will be deleted from Pulumi state.

    Create Export Resource

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

    Constructor syntax

    new Export(name: string, args: ExportArgs, opts?: CustomResourceOptions);
    @overload
    def Export(resource_name: str,
               args: ExportArgs,
               opts: Optional[ResourceOptions] = None)
    
    @overload
    def Export(resource_name: str,
               opts: Optional[ResourceOptions] = None,
               datastore_name: Optional[str] = None,
               date_range: Optional[GoogleCloudApigeeV1DateRangeArgs] = None,
               environment_id: Optional[str] = None,
               organization_id: Optional[str] = None,
               csv_delimiter: Optional[str] = None,
               description: Optional[str] = None,
               name: Optional[str] = None,
               output_format: Optional[str] = None)
    func NewExport(ctx *Context, name string, args ExportArgs, opts ...ResourceOption) (*Export, error)
    public Export(string name, ExportArgs args, CustomResourceOptions? opts = null)
    public Export(String name, ExportArgs args)
    public Export(String name, ExportArgs args, CustomResourceOptions options)
    
    type: google-native:apigee/v1:Export
    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 ExportArgs
    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 ExportArgs
    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 ExportArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ExportArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ExportArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Example

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

    var exportResource = new GoogleNative.Apigee.V1.Export("exportResource", new()
    {
        DatastoreName = "string",
        DateRange = new GoogleNative.Apigee.V1.Inputs.GoogleCloudApigeeV1DateRangeArgs
        {
            End = "string",
            Start = "string",
        },
        EnvironmentId = "string",
        OrganizationId = "string",
        CsvDelimiter = "string",
        Description = "string",
        Name = "string",
        OutputFormat = "string",
    });
    
    example, err := apigee.NewExport(ctx, "exportResource", &apigee.ExportArgs{
    DatastoreName: pulumi.String("string"),
    DateRange: &apigee.GoogleCloudApigeeV1DateRangeArgs{
    End: pulumi.String("string"),
    Start: pulumi.String("string"),
    },
    EnvironmentId: pulumi.String("string"),
    OrganizationId: pulumi.String("string"),
    CsvDelimiter: pulumi.String("string"),
    Description: pulumi.String("string"),
    Name: pulumi.String("string"),
    OutputFormat: pulumi.String("string"),
    })
    
    var exportResource = new Export("exportResource", ExportArgs.builder()
        .datastoreName("string")
        .dateRange(GoogleCloudApigeeV1DateRangeArgs.builder()
            .end("string")
            .start("string")
            .build())
        .environmentId("string")
        .organizationId("string")
        .csvDelimiter("string")
        .description("string")
        .name("string")
        .outputFormat("string")
        .build());
    
    export_resource = google_native.apigee.v1.Export("exportResource",
        datastore_name="string",
        date_range=google_native.apigee.v1.GoogleCloudApigeeV1DateRangeArgs(
            end="string",
            start="string",
        ),
        environment_id="string",
        organization_id="string",
        csv_delimiter="string",
        description="string",
        name="string",
        output_format="string")
    
    const exportResource = new google_native.apigee.v1.Export("exportResource", {
        datastoreName: "string",
        dateRange: {
            end: "string",
            start: "string",
        },
        environmentId: "string",
        organizationId: "string",
        csvDelimiter: "string",
        description: "string",
        name: "string",
        outputFormat: "string",
    });
    
    type: google-native:apigee/v1:Export
    properties:
        csvDelimiter: string
        datastoreName: string
        dateRange:
            end: string
            start: string
        description: string
        environmentId: string
        name: string
        organizationId: string
        outputFormat: string
    

    Export Resource Properties

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

    Inputs

    The Export resource accepts the following input properties:

    DatastoreName string
    Name of the preconfigured datastore.
    DateRange Pulumi.GoogleNative.Apigee.V1.Inputs.GoogleCloudApigeeV1DateRange
    Date range of the data to export.
    EnvironmentId string
    OrganizationId string
    CsvDelimiter string
    Optional. Delimiter used in the CSV file, if outputFormat is set to csv. Defaults to the , (comma) character. Supported delimiter characters include comma (,), pipe (|), and tab (\t).
    Description string
    Optional. Description of the export job.
    Name string
    Display name of the export job.
    OutputFormat string
    Optional. Output format of the export. Valid values include: csv or json. Defaults to json. Note: Configure the delimiter for CSV output using the csvDelimiter property.
    DatastoreName string
    Name of the preconfigured datastore.
    DateRange GoogleCloudApigeeV1DateRangeArgs
    Date range of the data to export.
    EnvironmentId string
    OrganizationId string
    CsvDelimiter string
    Optional. Delimiter used in the CSV file, if outputFormat is set to csv. Defaults to the , (comma) character. Supported delimiter characters include comma (,), pipe (|), and tab (\t).
    Description string
    Optional. Description of the export job.
    Name string
    Display name of the export job.
    OutputFormat string
    Optional. Output format of the export. Valid values include: csv or json. Defaults to json. Note: Configure the delimiter for CSV output using the csvDelimiter property.
    datastoreName String
    Name of the preconfigured datastore.
    dateRange GoogleCloudApigeeV1DateRange
    Date range of the data to export.
    environmentId String
    organizationId String
    csvDelimiter String
    Optional. Delimiter used in the CSV file, if outputFormat is set to csv. Defaults to the , (comma) character. Supported delimiter characters include comma (,), pipe (|), and tab (\t).
    description String
    Optional. Description of the export job.
    name String
    Display name of the export job.
    outputFormat String
    Optional. Output format of the export. Valid values include: csv or json. Defaults to json. Note: Configure the delimiter for CSV output using the csvDelimiter property.
    datastoreName string
    Name of the preconfigured datastore.
    dateRange GoogleCloudApigeeV1DateRange
    Date range of the data to export.
    environmentId string
    organizationId string
    csvDelimiter string
    Optional. Delimiter used in the CSV file, if outputFormat is set to csv. Defaults to the , (comma) character. Supported delimiter characters include comma (,), pipe (|), and tab (\t).
    description string
    Optional. Description of the export job.
    name string
    Display name of the export job.
    outputFormat string
    Optional. Output format of the export. Valid values include: csv or json. Defaults to json. Note: Configure the delimiter for CSV output using the csvDelimiter property.
    datastore_name str
    Name of the preconfigured datastore.
    date_range GoogleCloudApigeeV1DateRangeArgs
    Date range of the data to export.
    environment_id str
    organization_id str
    csv_delimiter str
    Optional. Delimiter used in the CSV file, if outputFormat is set to csv. Defaults to the , (comma) character. Supported delimiter characters include comma (,), pipe (|), and tab (\t).
    description str
    Optional. Description of the export job.
    name str
    Display name of the export job.
    output_format str
    Optional. Output format of the export. Valid values include: csv or json. Defaults to json. Note: Configure the delimiter for CSV output using the csvDelimiter property.
    datastoreName String
    Name of the preconfigured datastore.
    dateRange Property Map
    Date range of the data to export.
    environmentId String
    organizationId String
    csvDelimiter String
    Optional. Delimiter used in the CSV file, if outputFormat is set to csv. Defaults to the , (comma) character. Supported delimiter characters include comma (,), pipe (|), and tab (\t).
    description String
    Optional. Description of the export job.
    name String
    Display name of the export job.
    outputFormat String
    Optional. Output format of the export. Valid values include: csv or json. Defaults to json. Note: Configure the delimiter for CSV output using the csvDelimiter property.

    Outputs

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

    Created string
    Time the export job was created.
    Error string
    Error is set when export fails
    ExecutionTime string
    Execution time for this export job. If the job is still in progress, it will be set to the amount of time that has elapsed sincecreated, in seconds. Else, it will set to (updated - created), in seconds.
    Id string
    The provider-assigned unique ID for this managed resource.
    Self string
    Self link of the export job. A URI that can be used to retrieve the status of an export job. Example: /organizations/myorg/environments/myenv/analytics/exports/9cfc0d85-0f30-46d6-ae6f-318d0cb961bd
    State string
    Status of the export job. Valid values include enqueued, running, completed, and failed.
    Updated string
    Time the export job was last updated.
    Created string
    Time the export job was created.
    Error string
    Error is set when export fails
    ExecutionTime string
    Execution time for this export job. If the job is still in progress, it will be set to the amount of time that has elapsed sincecreated, in seconds. Else, it will set to (updated - created), in seconds.
    Id string
    The provider-assigned unique ID for this managed resource.
    Self string
    Self link of the export job. A URI that can be used to retrieve the status of an export job. Example: /organizations/myorg/environments/myenv/analytics/exports/9cfc0d85-0f30-46d6-ae6f-318d0cb961bd
    State string
    Status of the export job. Valid values include enqueued, running, completed, and failed.
    Updated string
    Time the export job was last updated.
    created String
    Time the export job was created.
    error String
    Error is set when export fails
    executionTime String
    Execution time for this export job. If the job is still in progress, it will be set to the amount of time that has elapsed sincecreated, in seconds. Else, it will set to (updated - created), in seconds.
    id String
    The provider-assigned unique ID for this managed resource.
    self String
    Self link of the export job. A URI that can be used to retrieve the status of an export job. Example: /organizations/myorg/environments/myenv/analytics/exports/9cfc0d85-0f30-46d6-ae6f-318d0cb961bd
    state String
    Status of the export job. Valid values include enqueued, running, completed, and failed.
    updated String
    Time the export job was last updated.
    created string
    Time the export job was created.
    error string
    Error is set when export fails
    executionTime string
    Execution time for this export job. If the job is still in progress, it will be set to the amount of time that has elapsed sincecreated, in seconds. Else, it will set to (updated - created), in seconds.
    id string
    The provider-assigned unique ID for this managed resource.
    self string
    Self link of the export job. A URI that can be used to retrieve the status of an export job. Example: /organizations/myorg/environments/myenv/analytics/exports/9cfc0d85-0f30-46d6-ae6f-318d0cb961bd
    state string
    Status of the export job. Valid values include enqueued, running, completed, and failed.
    updated string
    Time the export job was last updated.
    created str
    Time the export job was created.
    error str
    Error is set when export fails
    execution_time str
    Execution time for this export job. If the job is still in progress, it will be set to the amount of time that has elapsed sincecreated, in seconds. Else, it will set to (updated - created), in seconds.
    id str
    The provider-assigned unique ID for this managed resource.
    self str
    Self link of the export job. A URI that can be used to retrieve the status of an export job. Example: /organizations/myorg/environments/myenv/analytics/exports/9cfc0d85-0f30-46d6-ae6f-318d0cb961bd
    state str
    Status of the export job. Valid values include enqueued, running, completed, and failed.
    updated str
    Time the export job was last updated.
    created String
    Time the export job was created.
    error String
    Error is set when export fails
    executionTime String
    Execution time for this export job. If the job is still in progress, it will be set to the amount of time that has elapsed sincecreated, in seconds. Else, it will set to (updated - created), in seconds.
    id String
    The provider-assigned unique ID for this managed resource.
    self String
    Self link of the export job. A URI that can be used to retrieve the status of an export job. Example: /organizations/myorg/environments/myenv/analytics/exports/9cfc0d85-0f30-46d6-ae6f-318d0cb961bd
    state String
    Status of the export job. Valid values include enqueued, running, completed, and failed.
    updated String
    Time the export job was last updated.

    Supporting Types

    GoogleCloudApigeeV1DateRange, GoogleCloudApigeeV1DateRangeArgs

    End string
    End date (exclusive) of the data to export in the format yyyy-mm-dd. The date range ends at 00:00:00 UTC on the end date- which will not be in the output.
    Start string
    Start date of the data to export in the format yyyy-mm-dd. The date range begins at 00:00:00 UTC on the start date.
    End string
    End date (exclusive) of the data to export in the format yyyy-mm-dd. The date range ends at 00:00:00 UTC on the end date- which will not be in the output.
    Start string
    Start date of the data to export in the format yyyy-mm-dd. The date range begins at 00:00:00 UTC on the start date.
    end String
    End date (exclusive) of the data to export in the format yyyy-mm-dd. The date range ends at 00:00:00 UTC on the end date- which will not be in the output.
    start String
    Start date of the data to export in the format yyyy-mm-dd. The date range begins at 00:00:00 UTC on the start date.
    end string
    End date (exclusive) of the data to export in the format yyyy-mm-dd. The date range ends at 00:00:00 UTC on the end date- which will not be in the output.
    start string
    Start date of the data to export in the format yyyy-mm-dd. The date range begins at 00:00:00 UTC on the start date.
    end str
    End date (exclusive) of the data to export in the format yyyy-mm-dd. The date range ends at 00:00:00 UTC on the end date- which will not be in the output.
    start str
    Start date of the data to export in the format yyyy-mm-dd. The date range begins at 00:00:00 UTC on the start date.
    end String
    End date (exclusive) of the data to export in the format yyyy-mm-dd. The date range ends at 00:00:00 UTC on the end date- which will not be in the output.
    start String
    Start date of the data to export in the format yyyy-mm-dd. The date range begins at 00:00:00 UTC on the start date.

    Package Details

    Repository
    Google Cloud Native pulumi/pulumi-google-native
    License
    Apache-2.0
    google-native logo

    Google Cloud Native is in preview. Google Cloud Classic is fully supported.

    Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi