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

This package is deprecated. Active development has stopped. We recommend using the Google Cloud package instead.

Viewing docs for Google Cloud Native v0.32.0
published on Wednesday, Nov 29, 2023 by Pulumi
google-native logo Google Cloud Native

This package is deprecated. Active development has stopped. We recommend using the Google Cloud package instead.

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

    Creates a new data collector.

    Create DataCollector Resource

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

    Constructor syntax

    new DataCollector(name: string, args: DataCollectorArgs, opts?: CustomResourceOptions);
    @overload
    def DataCollector(resource_name: str,
                      args: DataCollectorArgs,
                      opts: Optional[ResourceOptions] = None)
    
    @overload
    def DataCollector(resource_name: str,
                      opts: Optional[ResourceOptions] = None,
                      organization_id: Optional[str] = None,
                      data_collector_id: Optional[str] = None,
                      description: Optional[str] = None,
                      name: Optional[str] = None,
                      type: Optional[DataCollectorType] = None)
    func NewDataCollector(ctx *Context, name string, args DataCollectorArgs, opts ...ResourceOption) (*DataCollector, error)
    public DataCollector(string name, DataCollectorArgs args, CustomResourceOptions? opts = null)
    public DataCollector(String name, DataCollectorArgs args)
    public DataCollector(String name, DataCollectorArgs args, CustomResourceOptions options)
    
    type: google-native:apigee/v1:DataCollector
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    
    resource "google-native_apigee_v1_data_collector" "name" {
        # resource properties
    }

    Parameters

    name string
    The unique name of the resource.
    args DataCollectorArgs
    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 DataCollectorArgs
    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 DataCollectorArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args DataCollectorArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args DataCollectorArgs
    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 dataCollectorResource = new GoogleNative.Apigee.V1.DataCollector("dataCollectorResource", new()
    {
        OrganizationId = "string",
        DataCollectorId = "string",
        Description = "string",
        Name = "string",
        Type = GoogleNative.Apigee.V1.DataCollectorType.TypeUnspecified,
    });
    
    example, err := apigee.NewDataCollector(ctx, "dataCollectorResource", &apigee.DataCollectorArgs{
    	OrganizationId:  pulumi.String("string"),
    	DataCollectorId: pulumi.String("string"),
    	Description:     pulumi.String("string"),
    	Name:            pulumi.String("string"),
    	Type:            apigee.DataCollectorTypeTypeUnspecified,
    })
    
    resource "google-native_apigee_v1_data_collector" "dataCollectorResource" {
      lifecycle {
        create_before_destroy = true
      }
      organization_id   = "string"
      data_collector_id = "string"
      description       = "string"
      name              = "string"
      type              = "TYPE_UNSPECIFIED"
    }
    
    var dataCollectorResource = new DataCollector("dataCollectorResource", DataCollectorArgs.builder()
        .organizationId("string")
        .dataCollectorId("string")
        .description("string")
        .name("string")
        .type(com.pulumi.googlenative.apigee_v1.enums.DataCollectorType.TypeUnspecified)
        .build());
    
    data_collector_resource = google_native.apigee.v1.DataCollector("dataCollectorResource",
        organization_id="string",
        data_collector_id="string",
        description="string",
        name="string",
        type=google_native.apigee.v1.DataCollectorType.TYPE_UNSPECIFIED)
    
    const dataCollectorResource = new google_native.apigee.v1.DataCollector("dataCollectorResource", {
        organizationId: "string",
        dataCollectorId: "string",
        description: "string",
        name: "string",
        type: google_native.apigee.v1.DataCollectorType.TypeUnspecified,
    });
    
    type: google-native:apigee/v1:DataCollector
    properties:
        dataCollectorId: string
        description: string
        name: string
        organizationId: string
        type: TYPE_UNSPECIFIED
    

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

    OrganizationId string
    DataCollectorId string
    ID of the data collector. Overrides any ID in the data collector resource. Must be a string beginning with dc_ that contains only letters, numbers, and underscores.
    Description string
    A description of the data collector.
    Name string
    ID of the data collector. Must begin with dc_.
    Type Pulumi.GoogleNative.Apigee.V1.DataCollectorType
    Immutable. The type of data this data collector will collect.
    OrganizationId string
    DataCollectorId string
    ID of the data collector. Overrides any ID in the data collector resource. Must be a string beginning with dc_ that contains only letters, numbers, and underscores.
    Description string
    A description of the data collector.
    Name string
    ID of the data collector. Must begin with dc_.
    Type DataCollectorType
    Immutable. The type of data this data collector will collect.
    organization_id string
    data_collector_id string
    ID of the data collector. Overrides any ID in the data collector resource. Must be a string beginning with dc_ that contains only letters, numbers, and underscores.
    description string
    A description of the data collector.
    name string
    ID of the data collector. Must begin with dc_.
    type "TYPE_UNSPECIFIED" | "INTEGER" | "FLOAT" | "STRING" | "BOOLEAN" | "DATETIME"
    Immutable. The type of data this data collector will collect.
    organizationId String
    dataCollectorId String
    ID of the data collector. Overrides any ID in the data collector resource. Must be a string beginning with dc_ that contains only letters, numbers, and underscores.
    description String
    A description of the data collector.
    name String
    ID of the data collector. Must begin with dc_.
    type DataCollectorType
    Immutable. The type of data this data collector will collect.
    organizationId string
    dataCollectorId string
    ID of the data collector. Overrides any ID in the data collector resource. Must be a string beginning with dc_ that contains only letters, numbers, and underscores.
    description string
    A description of the data collector.
    name string
    ID of the data collector. Must begin with dc_.
    type DataCollectorType
    Immutable. The type of data this data collector will collect.
    organization_id str
    data_collector_id str
    ID of the data collector. Overrides any ID in the data collector resource. Must be a string beginning with dc_ that contains only letters, numbers, and underscores.
    description str
    A description of the data collector.
    name str
    ID of the data collector. Must begin with dc_.
    type DataCollectorType
    Immutable. The type of data this data collector will collect.
    organizationId String
    dataCollectorId String
    ID of the data collector. Overrides any ID in the data collector resource. Must be a string beginning with dc_ that contains only letters, numbers, and underscores.
    description String
    A description of the data collector.
    name String
    ID of the data collector. Must begin with dc_.
    type "TYPE_UNSPECIFIED" | "INTEGER" | "FLOAT" | "STRING" | "BOOLEAN" | "DATETIME"
    Immutable. The type of data this data collector will collect.

    Outputs

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

    CreatedAt string
    The time at which the data collector was created in milliseconds since the epoch.
    Id string
    The provider-assigned unique ID for this managed resource.
    LastModifiedAt string
    The time at which the Data Collector was last updated in milliseconds since the epoch.
    CreatedAt string
    The time at which the data collector was created in milliseconds since the epoch.
    Id string
    The provider-assigned unique ID for this managed resource.
    LastModifiedAt string
    The time at which the Data Collector was last updated in milliseconds since the epoch.
    created_at string
    The time at which the data collector was created in milliseconds since the epoch.
    id string
    The provider-assigned unique ID for this managed resource.
    last_modified_at string
    The time at which the Data Collector was last updated in milliseconds since the epoch.
    createdAt String
    The time at which the data collector was created in milliseconds since the epoch.
    id String
    The provider-assigned unique ID for this managed resource.
    lastModifiedAt String
    The time at which the Data Collector was last updated in milliseconds since the epoch.
    createdAt string
    The time at which the data collector was created in milliseconds since the epoch.
    id string
    The provider-assigned unique ID for this managed resource.
    lastModifiedAt string
    The time at which the Data Collector was last updated in milliseconds since the epoch.
    created_at str
    The time at which the data collector was created in milliseconds since the epoch.
    id str
    The provider-assigned unique ID for this managed resource.
    last_modified_at str
    The time at which the Data Collector was last updated in milliseconds since the epoch.
    createdAt String
    The time at which the data collector was created in milliseconds since the epoch.
    id String
    The provider-assigned unique ID for this managed resource.
    lastModifiedAt String
    The time at which the Data Collector was last updated in milliseconds since the epoch.

    Look up Existing DataCollector Resource

    Get an existing DataCollector 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>, opts?: CustomResourceOptions): DataCollector
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None) -> DataCollector
    func GetDataCollector(ctx *Context, name string, id IDInput, state *DataCollectorState, opts ...ResourceOption) (*DataCollector, error)
    public static DataCollector Get(string name, Input<string> id, CustomResourceOptions? opts = null)
    public static DataCollector get(String name, Output<String> id, CustomResourceOptions options)
    resources:  existingDataCollector:    type: google-native:apigee/v1:DataCollector    get:      id: ${id}
    import {
      to = google-native_apigee_v1_data_collector.example
      id = "${id}"
    }
    
    name string
    The unique name of the resulting resource.
    id Input<ID>
    The unique provider ID of the resource to look up.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resulting resource.
    id str
    The unique provider ID of the resource to look up.
    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 resulting resource.
    id IDInput
    The unique provider ID of the resource to look up.
    state DataCollectorState
    Pass nil. This resource has no state arguments.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resulting resource.
    id Input<string>
    The unique provider ID of the resource to look up.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resulting resource.
    id Output<String>
    The unique provider ID of the resource to look up.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Supporting Types

    DataCollectorType, DataCollectorTypeArgs

    Immutable. The type of data this data collector will collect.
    NameValueDescription
    TypeUnspecifiedTYPE_UNSPECIFIEDFor future compatibility.
    IntegerINTEGERFor integer values.
    FloatFLOATFor float values.
    StringSTRINGFor string values.
    BooleanBOOLEANFor boolean values.
    DatetimeDATETIMEFor datetime values.
    NameValueDescription
    DataCollectorTypeTypeUnspecifiedTYPE_UNSPECIFIEDFor future compatibility.
    DataCollectorTypeIntegerINTEGERFor integer values.
    DataCollectorTypeFloatFLOATFor float values.
    DataCollectorTypeStringSTRINGFor string values.
    DataCollectorTypeBooleanBOOLEANFor boolean values.
    DataCollectorTypeDatetimeDATETIMEFor datetime values.
    ValueDescription
    TYPE_UNSPECIFIEDFor future compatibility.
    INTEGERFor integer values.
    FLOATFor float values.
    STRINGFor string values.
    BOOLEANFor boolean values.
    DATETIMEFor datetime values.
    NameValueDescription
    TypeUnspecifiedTYPE_UNSPECIFIEDFor future compatibility.
    IntegerINTEGERFor integer values.
    FloatFLOATFor float values.
    StringSTRINGFor string values.
    BooleanBOOLEANFor boolean values.
    DatetimeDATETIMEFor datetime values.
    NameValueDescription
    TypeUnspecifiedTYPE_UNSPECIFIEDFor future compatibility.
    IntegerINTEGERFor integer values.
    FloatFLOATFor float values.
    StringSTRINGFor string values.
    BooleanBOOLEANFor boolean values.
    DatetimeDATETIMEFor datetime values.
    NameValueDescription
    TYPE_UNSPECIFIEDTYPE_UNSPECIFIEDFor future compatibility.
    INTEGERINTEGERFor integer values.
    FLOATFLOATFor float values.
    STRINGSTRINGFor string values.
    BOOLEANBOOLEANFor boolean values.
    DATETIMEDATETIMEFor datetime values.
    ValueDescription
    TYPE_UNSPECIFIEDFor future compatibility.
    INTEGERFor integer values.
    FLOATFor float values.
    STRINGFor string values.
    BOOLEANFor boolean values.
    DATETIMEFor datetime values.

    Package Details

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

    This package is deprecated. Active development has stopped. We recommend using the Google Cloud package instead.

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

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial