diff --git a/.generator/schemas/v2/openapi.yaml b/.generator/schemas/v2/openapi.yaml index 6ed4b42368e..554f744a5d5 100644 --- a/.generator/schemas/v2/openapi.yaml +++ b/.generator/schemas/v2/openapi.yaml @@ -13066,7 +13066,8 @@ components: x-enum-varnames: - CREATE_RULESET CreateTableRequest: - description: The definition of `CreateTableRequest` object. + description: Request body for creating a new reference table from a local file + or cloud storage. example: data: attributes: @@ -13096,23 +13097,23 @@ components: $ref: '#/components/schemas/CreateTableRequestData' type: object CreateTableRequestData: - description: The definition of `CreateTableRequestData` object. + additionalProperties: false + description: The data object containing the table definition. properties: attributes: $ref: '#/components/schemas/CreateTableRequestDataAttributes' - id: - description: The ID of the reference table. - type: string type: $ref: '#/components/schemas/CreateTableRequestDataType' required: - type type: object CreateTableRequestDataAttributes: - description: The definition of `CreateTableRequestDataAttributes` object. + description: Attributes that define the reference table's configuration and + properties. properties: description: - description: The description of the reference table. + description: Optional text describing the purpose or contents of this reference + table. type: string file_metadata: $ref: '#/components/schemas/CreateTableRequestDataAttributesFileMetadata' @@ -13121,11 +13122,14 @@ components: source: $ref: '#/components/schemas/ReferenceTableCreateSourceType' table_name: - description: The name of the reference table. - example: '' + description: Name to identify this reference table. + example: table_1 type: string tags: - description: The tags of the reference table. + description: Tags for organizing and filtering reference tables. + example: + - tag_1 + - tag_2 items: type: string type: array @@ -13135,8 +13139,8 @@ components: - source type: object CreateTableRequestDataAttributesFileMetadata: - description: The definition of `CreateTableRequestDataAttributesFileMetadata` - object. + description: Metadata specifying where and how to access the reference table's + data file. oneOf: - $ref: '#/components/schemas/CreateTableRequestDataAttributesFileMetadataCloudStorage' - $ref: '#/components/schemas/CreateTableRequestDataAttributesFileMetadataLocalFile' @@ -13162,15 +13166,15 @@ components: properties: upload_id: description: The upload ID. - example: '' + example: 00000000-0000-0000-0000-000000000000 type: string required: - upload_id title: LocalFileMetadataV2 type: object CreateTableRequestDataAttributesFileMetadataOneOfAccessDetails: - description: The definition of `CreateTableRequestDataAttributesFileMetadataOneOfAccessDetails` - object. + description: Cloud storage access configuration for the reference table data + file. properties: aws_detail: $ref: '#/components/schemas/CreateTableRequestDataAttributesFileMetadataOneOfAccessDetailsAwsDetail' @@ -13180,15 +13184,14 @@ components: $ref: '#/components/schemas/CreateTableRequestDataAttributesFileMetadataOneOfAccessDetailsGcpDetail' type: object CreateTableRequestDataAttributesFileMetadataOneOfAccessDetailsAwsDetail: - description: The definition of `CreateTableRequestDataAttributesFileMetadataOneOfAccessDetailsAwsDetail` - object. + description: Amazon Web Services S3 storage access configuration. properties: aws_account_id: - description: The ID of the AWS account. + description: AWS account ID where the S3 bucket is located. example: '123456789000' type: string aws_bucket_name: - description: The name of the Amazon S3 bucket. + description: S3 bucket containing the CSV file. example: example-data-bucket type: string file_path: @@ -13203,23 +13206,23 @@ components: x-oneOf-parent: - AwsDetail CreateTableRequestDataAttributesFileMetadataOneOfAccessDetailsAzureDetail: - description: The definition of `CreateTableRequestDataAttributesFileMetadataOneOfAccessDetailsAzureDetail` - object. + description: Azure Blob Storage access configuration. properties: azure_client_id: - description: The Azure client ID. + description: Azure service principal (application) client ID with permissions + to read from the container. example: aaaaaaaa-1111-2222-3333-bbbbbbbbbbbb type: string azure_container_name: - description: The name of the Azure container. + description: Azure Blob Storage container containing the CSV file. example: reference-data type: string azure_storage_account_name: - description: The name of the Azure storage account. + description: Azure storage account where the container is located. example: examplestorageaccount type: string azure_tenant_id: - description: The ID of the Azure tenant. + description: Azure Active Directory tenant ID. example: cccccccc-4444-5555-6666-dddddddddddd type: string file_path: @@ -13237,8 +13240,7 @@ components: x-oneOf-parent: - AzureDetail CreateTableRequestDataAttributesFileMetadataOneOfAccessDetailsGcpDetail: - description: The definition of `CreateTableRequestDataAttributesFileMetadataOneOfAccessDetailsGcpDetail` - object. + description: Google Cloud Platform storage access configuration. properties: file_path: description: The relative file path from the GCS bucket root to the CSV @@ -13246,15 +13248,15 @@ components: example: data/reference_tables/users.csv type: string gcp_bucket_name: - description: The name of the GCP bucket. + description: GCP bucket containing the CSV file. example: example-data-bucket type: string gcp_project_id: - description: The ID of the GCP project. + description: GCP project ID where the bucket is located. example: example-gcp-project-12345 type: string gcp_service_account_email: - description: The email of the GCP service account. + description: Service account email with read permissions for the GCS bucket. example: example-service@example-gcp-project-12345.iam.gserviceaccount.com type: string required: @@ -13266,10 +13268,10 @@ components: x-oneOf-parent: - GcpDetail CreateTableRequestDataAttributesSchema: - description: The definition of `CreateTableRequestDataAttributesSchema` object. + description: Schema defining the structure and columns of the reference table. properties: fields: - description: The `schema` `fields`. + description: The schema fields. items: $ref: '#/components/schemas/CreateTableRequestDataAttributesSchemaFieldsItems' type: array @@ -13278,7 +13280,7 @@ components: Only one primary key is supported, and it is used as an ID to retrieve rows. example: - - '' + - field_1 items: type: string type: array @@ -13287,12 +13289,11 @@ components: - primary_keys type: object CreateTableRequestDataAttributesSchemaFieldsItems: - description: The definition of `CreateTableRequestDataAttributesSchemaFieldsItems` - object. + description: A single field (column) in the reference table schema to be created. properties: name: description: The field name. - example: '' + example: field_1 type: string type: $ref: '#/components/schemas/ReferenceTableSchemaFieldType' @@ -13310,50 +13311,51 @@ components: x-enum-varnames: - REFERENCE_TABLE CreateUploadRequest: - description: The definition of `CreateUploadRequest` object. + description: Request to create an upload for a file to be ingested into a reference + table. properties: data: $ref: '#/components/schemas/CreateUploadRequestData' type: object CreateUploadRequestData: - description: The definition of `CreateUploadRequestData` object. + additionalProperties: false + description: Request data for creating an upload for a file to be ingested into + a reference table. properties: attributes: $ref: '#/components/schemas/CreateUploadRequestDataAttributes' - id: - description: The ID of the upload. - type: string type: $ref: '#/components/schemas/CreateUploadRequestDataType' required: - type type: object CreateUploadRequestDataAttributes: - description: The definition of `CreateUploadRequestDataAttributes` object. + description: Upload configuration specifying how data will be uploaded by the + user, and properties of the table to associate the upload with. properties: headers: - description: The headers of the file to upload. + description: The CSV file headers that define the schema fields, provided + in the same order as the columns in the uploaded file. example: - - '' + - field_1 + - field_2 items: type: string type: array part_count: - description: The number of parts in the upload. + description: Number of parts to split the file into for multipart upload. example: 3 format: int32 maximum: 20 type: integer part_size: - description: The size of each part in the upload in bytes. For multipart - uploads (part_count > 1), all parts except the last one must be at least - 5,000,000 bytes. For single-part uploads (part_count = 1), any size is - allowed. + description: The size of each part in the upload in bytes. All parts except + the last one must be at least 5,000,000 bytes. example: 10000000 format: int64 type: integer table_name: - description: The name of the reference table. + description: Name of the table to associate with this upload. example: '' type: string required: @@ -13372,18 +13374,21 @@ components: x-enum-varnames: - UPLOAD CreateUploadResponse: - description: The definition of `CreateUploadResponse` object. + description: Information about the upload created containing the upload ID and + pre-signed URLs to PUT chunks of the CSV file to. properties: data: $ref: '#/components/schemas/CreateUploadResponseData' type: object CreateUploadResponseData: - description: The definition of `CreateUploadResponseData` object. + additionalProperties: false + description: Upload ID and attributes of the created upload. properties: attributes: $ref: '#/components/schemas/CreateUploadResponseDataAttributes' id: - description: The ID of the upload. + description: Unique identifier for this upload. Use this ID when creating + the reference table. type: string type: $ref: '#/components/schemas/CreateUploadResponseDataType' @@ -13391,10 +13396,11 @@ components: - type type: object CreateUploadResponseDataAttributes: - description: The definition of `CreateUploadResponseDataAttributes` object. + description: Pre-signed URLs for uploading parts of the file. properties: part_urls: - description: The URLs of the parts in the upload. + description: The pre-signed URLs for uploading parts. These URLs expire + after 5 minutes. items: type: string type: array @@ -38129,7 +38135,7 @@ components: $ref: '#/components/schemas/Version' type: object PatchTableRequest: - description: The definition of `PatchTableRequest` object. + description: Request body for updating an existing reference table. example: data: attributes: @@ -38152,30 +38158,30 @@ components: sync_enabled: false tags: - test_tag - id: 00000000-0000-0000-0000-000000000000 type: reference_table properties: data: $ref: '#/components/schemas/PatchTableRequestData' type: object PatchTableRequestData: - description: The definition of `PatchTableRequestData` object. + additionalProperties: false + description: The data object containing the partial table definition updates. properties: attributes: $ref: '#/components/schemas/PatchTableRequestDataAttributes' - id: - description: The ID of the reference table. - type: string type: $ref: '#/components/schemas/PatchTableRequestDataType' required: - type type: object PatchTableRequestDataAttributes: - description: The definition of `PatchTableRequestDataAttributes` object. + description: Attributes that define the updates to the reference table's configuration + and properties. properties: description: - description: The description of the reference table. + description: Optional text describing the purpose or contents of this reference + table. + example: example description type: string file_metadata: $ref: '#/components/schemas/PatchTableRequestDataAttributesFileMetadata' @@ -38183,16 +38189,20 @@ components: $ref: '#/components/schemas/PatchTableRequestDataAttributesSchema' sync_enabled: description: Whether this table is synced automatically. + example: false type: boolean tags: - description: The tags of the reference table. + description: Tags for organizing and filtering reference tables. + example: + - tag_1 + - tag_2 items: type: string type: array type: object PatchTableRequestDataAttributesFileMetadata: - description: The definition of `PatchTableRequestDataAttributesFileMetadata` - object. + description: Metadata specifying where and how to access the reference table's + data file. oneOf: - $ref: '#/components/schemas/PatchTableRequestDataAttributesFileMetadataCloudStorage' - $ref: '#/components/schemas/PatchTableRequestDataAttributesFileMetadataLocalFile' @@ -38215,15 +38225,15 @@ components: properties: upload_id: description: The upload ID. - example: '' + example: 00000000-0000-0000-0000-000000000000 type: string required: - upload_id title: LocalFileMetadataV2 type: object PatchTableRequestDataAttributesFileMetadataOneOfAccessDetails: - description: The definition of `PatchTableRequestDataAttributesFileMetadataOneOfAccessDetails` - object. + description: Cloud storage access configuration for the reference table data + file. properties: aws_detail: $ref: '#/components/schemas/PatchTableRequestDataAttributesFileMetadataOneOfAccessDetailsAwsDetail' @@ -38233,15 +38243,14 @@ components: $ref: '#/components/schemas/PatchTableRequestDataAttributesFileMetadataOneOfAccessDetailsGcpDetail' type: object PatchTableRequestDataAttributesFileMetadataOneOfAccessDetailsAwsDetail: - description: The definition of `PatchTableRequestDataAttributesFileMetadataOneOfAccessDetailsAwsDetail` - object. + description: Amazon Web Services S3 storage access configuration. properties: aws_account_id: - description: The ID of the AWS account. + description: AWS account ID where the S3 bucket is located. example: '123456789000' type: string aws_bucket_name: - description: The name of the AWS bucket. + description: S3 bucket containing the CSV file. example: example-data-bucket type: string file_path: @@ -38252,23 +38261,23 @@ components: x-oneOf-parent: - AwsDetail PatchTableRequestDataAttributesFileMetadataOneOfAccessDetailsAzureDetail: - description: The definition of `PatchTableRequestDataAttributesFileMetadataOneOfAccessDetailsAzureDetail` - object. + description: Azure Blob Storage access configuration. properties: azure_client_id: - description: The Azure client ID. + description: Azure service principal (application) client ID with permissions + to read from the container. example: aaaaaaaa-1111-2222-3333-bbbbbbbbbbbb type: string azure_container_name: - description: The name of the Azure container. + description: Azure Blob Storage container containing the CSV file. example: reference-data type: string azure_storage_account_name: - description: The name of the Azure storage account. + description: Azure storage account where the container is located. example: examplestorageaccount type: string azure_tenant_id: - description: The ID of the Azure tenant. + description: Azure Active Directory tenant ID. example: cccccccc-4444-5555-6666-dddddddddddd type: string file_path: @@ -38280,8 +38289,7 @@ components: x-oneOf-parent: - AzureDetail PatchTableRequestDataAttributesFileMetadataOneOfAccessDetailsGcpDetail: - description: The definition of `PatchTableRequestDataAttributesFileMetadataOneOfAccessDetailsGcpDetail` - object. + description: Google Cloud Platform storage access configuration. properties: file_path: description: The relative file path from the GCS bucket root to the CSV @@ -38289,34 +38297,35 @@ components: example: data/reference_tables/users.csv type: string gcp_bucket_name: - description: The name of the GCP bucket. + description: GCP bucket containing the CSV file. example: example-data-bucket type: string gcp_project_id: - description: The ID of the GCP project. + description: GCP project ID where the bucket is located. example: example-gcp-project-12345 type: string gcp_service_account_email: - description: The email of the GCP service account. + description: Service account email with read permissions for the GCS bucket. example: example-service@example-gcp-project-12345.iam.gserviceaccount.com type: string type: object x-oneOf-parent: - GcpDetail PatchTableRequestDataAttributesSchema: - description: The definition of `PatchTableRequestDataAttributesSchema` object. + description: Schema defining the updates to the structure and columns of the + reference table. Schema fields cannot be deleted or renamed. properties: fields: - description: The `schema` `fields`. + description: The schema fields. items: $ref: '#/components/schemas/PatchTableRequestDataAttributesSchemaFieldsItems' type: array primary_keys: description: List of field names that serve as primary keys for the table. Only one primary key is supported, and it is used as an ID to retrieve - rows. + rows. Primary keys cannot be changed after table creation. example: - - '' + - field_1 items: type: string type: array @@ -38325,12 +38334,12 @@ components: - primary_keys type: object PatchTableRequestDataAttributesSchemaFieldsItems: - description: The definition of `PatchTableRequestDataAttributesSchemaFieldsItems` - object. + description: A single field (column) in the reference table schema to be updated. + Schema fields cannot be deleted or renamed. properties: name: description: The field name. - example: '' + example: field_1 type: string type: $ref: '#/components/schemas/ReferenceTableSchemaFieldType' @@ -50806,16 +50815,21 @@ components: type: number type: object TableResultV2: - description: The definition of `TableResultV2` object. + description: A reference table resource containing its full configuration and + state. example: data: attributes: created_by: 00000000-0000-0000-0000-000000000000 description: example description file_metadata: - access_details: {} - upload_id: 00000000-0000-0000-0000-000000000000 - last_updated_by: '' + access_details: + aws_detail: + aws_account_id: '123456789000' + aws_bucket_name: my-bucket + file_path: path/to/file.csv + sync_enabled: true + last_updated_by: 00000000-0000-0000-0000-000000000000 row_count: 5 schema: fields: @@ -50825,7 +50839,7 @@ components: type: STRING primary_keys: - id - source: LOCAL_FILE + source: S3 status: DONE table_name: test_reference_table tags: @@ -50839,7 +50853,7 @@ components: $ref: '#/components/schemas/TableResultV2Data' type: object TableResultV2Array: - description: The definition of `TableResultV2Array` object. + description: List of reference tables. example: data: - attributes: @@ -50911,12 +50925,14 @@ components: - data type: object TableResultV2Data: - description: The definition of `TableResultV2Data` object. + additionalProperties: false + description: The data object containing the reference table configuration and + state. properties: attributes: $ref: '#/components/schemas/TableResultV2DataAttributes' id: - description: The ID of the reference table. + description: Unique identifier for the reference table. type: string type: $ref: '#/components/schemas/TableResultV2DataType' @@ -50924,22 +50940,28 @@ components: - type type: object TableResultV2DataAttributes: - description: The definition of `TableResultV2DataAttributes` object. + description: Attributes that define the reference table's configuration and + properties. properties: created_by: description: UUID of the user who created the reference table. + example: 00000000-0000-0000-0000-000000000000 type: string description: - description: The description of the reference table. + description: Optional text describing the purpose or contents of this reference + table. + example: example description type: string file_metadata: $ref: '#/components/schemas/TableResultV2DataAttributesFileMetadata' last_updated_by: description: UUID of the user who last updated the reference table. + example: 00000000-0000-0000-0000-000000000000 type: string row_count: description: The number of successfully processed rows in the reference table. + example: 5 format: int64 type: integer schema: @@ -50947,23 +50969,30 @@ components: source: $ref: '#/components/schemas/ReferenceTableSourceType' status: - description: The status of the reference table. + description: The processing status of the table. + example: DONE type: string table_name: - description: The name of the reference table. + description: Unique name to identify this reference table. Used in enrichment + processors and API calls. + example: table_1 type: string tags: - description: The tags of the reference table. + description: Tags for organizing and filtering reference tables. + example: + - tag_1 + - tag_2 items: type: string type: array updated_at: - description: The timestamp of the last update to the reference table in - ISO 8601 format. + description: When the reference table was last updated, in ISO 8601 format. + example: '2000-01-01T01:00:00+00:00' type: string type: object TableResultV2DataAttributesFileMetadata: - description: The definition of `TableResultV2DataAttributesFileMetadata` object. + description: Metadata specifying where and how to access the reference table's + data file. oneOf: - $ref: '#/components/schemas/TableResultV2DataAttributesFileMetadataCloudStorage' - $ref: '#/components/schemas/TableResultV2DataAttributesFileMetadataLocalFile' @@ -50984,6 +51013,8 @@ components: sync_enabled: description: Whether this table is synced automatically. type: boolean + required: + - access_details title: CloudFileMetadataV2 type: object TableResultV2DataAttributesFileMetadataCloudStorageErrorType: @@ -51012,7 +51043,9 @@ components: - OPERATION_ERROR - SYSTEM_ERROR TableResultV2DataAttributesFileMetadataLocalFile: - description: File metadata for reference tables created by upload. + description: File metadata for reference tables created by upload. Note that + upload_id is only returned in the immediate create/replace response and is + not available in subsequent GET requests. properties: error_message: description: The error message returned from the creation/update. @@ -51021,14 +51054,11 @@ components: description: The number of rows that failed to create/update. format: int64 type: integer - upload_id: - description: The upload ID that was used to create/update the table. - type: string title: LocalFileMetadataV2 type: object TableResultV2DataAttributesFileMetadataOneOfAccessDetails: - description: The definition of `TableResultV2DataAttributesFileMetadataOneOfAccessDetails` - object. + description: Cloud storage access configuration for the reference table data + file. properties: aws_detail: $ref: '#/components/schemas/TableResultV2DataAttributesFileMetadataOneOfAccessDetailsAwsDetail' @@ -51038,15 +51068,14 @@ components: $ref: '#/components/schemas/TableResultV2DataAttributesFileMetadataOneOfAccessDetailsGcpDetail' type: object TableResultV2DataAttributesFileMetadataOneOfAccessDetailsAwsDetail: - description: The definition of `TableResultV2DataAttributesFileMetadataOneOfAccessDetailsAwsDetail` - object. + description: Amazon Web Services S3 storage access configuration. properties: aws_account_id: - description: The ID of the AWS account. + description: AWS account ID where the S3 bucket is located. example: '123456789000' type: string aws_bucket_name: - description: The name of the AWS bucket. + description: S3 bucket containing the CSV file. example: example-data-bucket type: string file_path: @@ -51057,23 +51086,23 @@ components: x-oneOf-parent: - AwsDetail TableResultV2DataAttributesFileMetadataOneOfAccessDetailsAzureDetail: - description: The definition of `TableResultV2DataAttributesFileMetadataOneOfAccessDetailsAzureDetail` - object. + description: Azure Blob Storage access configuration. properties: azure_client_id: - description: The Azure client ID. + description: Azure service principal (application) client ID with permissions + to read from the container. example: aaaaaaaa-1111-2222-3333-bbbbbbbbbbbb type: string azure_container_name: - description: The name of the Azure container. + description: Azure Blob Storage container containing the CSV file. example: reference-data type: string azure_storage_account_name: - description: The name of the Azure storage account. + description: Azure storage account where the container is located. example: examplestorageaccount type: string azure_tenant_id: - description: The ID of the Azure tenant. + description: Azure Active Directory tenant ID. example: cccccccc-4444-5555-6666-dddddddddddd type: string file_path: @@ -51085,8 +51114,7 @@ components: x-oneOf-parent: - AzureDetail TableResultV2DataAttributesFileMetadataOneOfAccessDetailsGcpDetail: - description: The definition of `TableResultV2DataAttributesFileMetadataOneOfAccessDetailsGcpDetail` - object. + description: Google Cloud Platform storage access configuration. properties: file_path: description: The relative file path from the GCS bucket root to the CSV @@ -51094,25 +51122,25 @@ components: example: data/reference_tables/users.csv type: string gcp_bucket_name: - description: The name of the GCP bucket. + description: GCP bucket containing the CSV file. example: example-data-bucket type: string gcp_project_id: - description: The ID of the GCP project. + description: GCP project ID where the bucket is located. example: example-gcp-project-12345 type: string gcp_service_account_email: - description: The email of the GCP service account. + description: Service account email with read permissions for the GCS bucket. example: example-service@example-gcp-project-12345.iam.gserviceaccount.com type: string type: object x-oneOf-parent: - GcpDetail TableResultV2DataAttributesSchema: - description: The definition of `TableResultV2DataAttributesSchema` object. + description: Schema defining the structure and columns of the reference table. properties: fields: - description: The `schema` `fields`. + description: The schema fields. items: $ref: '#/components/schemas/TableResultV2DataAttributesSchemaFieldsItems' type: array @@ -51121,7 +51149,7 @@ components: Only one primary key is supported, and it is used as an ID to retrieve rows. example: - - '' + - field_1 items: type: string type: array @@ -51130,12 +51158,11 @@ components: - primary_keys type: object TableResultV2DataAttributesSchemaFieldsItems: - description: The definition of `TableResultV2DataAttributesSchemaFieldsItems` - object. + description: A single field (column) in the reference table schema to be returned. properties: name: description: The field name. - example: '' + example: field_1 type: string type: $ref: '#/components/schemas/ReferenceTableSchemaFieldType' @@ -51153,7 +51180,7 @@ components: x-enum-varnames: - REFERENCE_TABLE TableRowResourceArray: - description: The definition of `TableRowResourceArray` object. + description: List of rows from a reference table query. properties: data: description: The rows. @@ -51164,12 +51191,13 @@ components: - data type: object TableRowResourceData: - description: The definition of `TableRowResourceData` object. + additionalProperties: false + description: The data object containing the row column names and values. properties: attributes: $ref: '#/components/schemas/TableRowResourceDataAttributes' id: - description: The ID of the row. + description: Row identifier, corresponding to the primary key value. type: string type: $ref: '#/components/schemas/TableRowResourceDataType' @@ -51177,11 +51205,12 @@ components: - type type: object TableRowResourceDataAttributes: - description: The definition of `TableRowResourceDataAttributes` object. + additionalProperties: false + description: Column values for this row in the reference table. properties: values: - additionalProperties: {} - description: The values of the row. + description: Key-value pairs representing the row data, where keys are field + names from the schema. type: object type: object TableRowResourceDataType: @@ -73141,8 +73170,8 @@ paths: format: int64 minimum: 0 type: integer - - description: Sort field and direction. Use field name for ascending, prefix - with "-" for descending. + - description: Sort field and direction for the list of reference tables. Use + field name for ascending, prefix with "-" for descending. example: -updated_at in: query name: sort @@ -73189,12 +73218,12 @@ paths: tags: - Reference Tables post: - description: 'Create a new reference table. You can provide data in two ways: - 1) Call POST api/v2/reference-tables/upload first to get an upload ID, then - PUT chunks of CSV data to each provided URL, and finally call this POST endpoint - with the upload_id in file_metadata, OR 2) Provide access_details in file_metadata - pointing to a CSV file in cloud storage (Amazon S3, Azure Blob Storage, or - GCP Cloud Storage).' + description: "Creates a reference table. You can provide data in two ways:\n1. + Call POST /api/v2/reference-tables/upload to get an upload ID. Then PUT the + CSV data\n (not the file itself) in chunks to each URL in the request body. + Finally, call this\n POST endpoint with `upload_id` in `file_metadata`.\n2. + Provide `access_details` in `file_metadata` pointing to a CSV file in cloud + storage." operationId: CreateReferenceTable requestBody: content: @@ -73227,7 +73256,7 @@ paths: description: Delete a reference table by ID operationId: DeleteTable parameters: - - description: The ID of the reference table to delete + - description: Unique identifier of the reference table to delete in: path name: id required: true @@ -73253,7 +73282,7 @@ paths: description: Get a reference table by ID operationId: GetTable parameters: - - description: The ID of the reference table to retrieve + - description: Unique identifier of the reference table to retrieve in: path name: id required: true @@ -73290,7 +73319,7 @@ paths: pointing to a CSV file in the same type of cloud storage.' operationId: UpdateReferenceTable parameters: - - description: The ID of the reference table to update + - description: Unique identifier of the reference table to update in: path name: id required: true @@ -73323,7 +73352,7 @@ paths: description: Get reference table rows by their primary key values. operationId: GetRowsByID parameters: - - description: The ID of the reference table + - description: Unique identifier of the reference table to get rows from example: table-123 in: path name: id diff --git a/examples/v2/reference-tables/UpdateReferenceTable.rb b/examples/v2/reference-tables/UpdateReferenceTable.rb index 31d18341364..067a1bd49d7 100644 --- a/examples/v2/reference-tables/UpdateReferenceTable.rb +++ b/examples/v2/reference-tables/UpdateReferenceTable.rb @@ -37,7 +37,6 @@ "test_tag", ], }), - id: "00000000-0000-0000-0000-000000000000", type: DatadogAPIClient::V2::PatchTableRequestDataType::REFERENCE_TABLE, }), }) diff --git a/features/v2/reference_tables.feature b/features/v2/reference_tables.feature index 8a01298dc59..6d4bc4b97f5 100644 --- a/features/v2/reference_tables.feature +++ b/features/v2/reference_tables.feature @@ -24,7 +24,7 @@ Feature: Reference Tables @generated @skip @team:DataDog/redapl-experiences Scenario: Create reference table upload returns "Bad Request" response Given new "CreateReferenceTableUpload" request - And body with value {"data": {"attributes": {"headers": [""], "part_count": 3, "part_size": 10000000, "table_name": ""}, "type": "upload"}} + And body with value {"data": {"attributes": {"headers": ["field_1", "field_2"], "part_count": 3, "part_size": 10000000, "table_name": ""}, "type": "upload"}} When the request is sent Then the response status is 400 Bad Request @@ -108,7 +108,7 @@ Feature: Reference Tables Scenario: Update reference table returns "Bad Request" response Given new "UpdateReferenceTable" request And request contains "id" parameter from "REPLACE.ME" - And body with value {"data": {"attributes": {"description": "this is a cloud table generated via a cloud bucket sync", "file_metadata": {"access_details": {"aws_detail": {"aws_account_id": "test-account-id", "aws_bucket_name": "test-bucket", "file_path": "test_rt.csv"}}, "sync_enabled": true}, "schema": {"fields": [{"name": "id", "type": "INT32"}, {"name": "name", "type": "STRING"}], "primary_keys": ["id"]}, "sync_enabled": false, "tags": ["test_tag"]}, "id": "00000000-0000-0000-0000-000000000000", "type": "reference_table"}} + And body with value {"data": {"attributes": {"description": "this is a cloud table generated via a cloud bucket sync", "file_metadata": {"access_details": {"aws_detail": {"aws_account_id": "test-account-id", "aws_bucket_name": "test-bucket", "file_path": "test_rt.csv"}}, "sync_enabled": true}, "schema": {"fields": [{"name": "id", "type": "INT32"}, {"name": "name", "type": "STRING"}], "primary_keys": ["id"]}, "sync_enabled": false, "tags": ["test_tag"]}, "type": "reference_table"}} When the request is sent Then the response status is 400 Bad Request @@ -116,6 +116,6 @@ Feature: Reference Tables Scenario: Update reference table returns "OK" response Given new "UpdateReferenceTable" request And request contains "id" parameter from "REPLACE.ME" - And body with value {"data": {"attributes": {"description": "this is a cloud table generated via a cloud bucket sync", "file_metadata": {"access_details": {"aws_detail": {"aws_account_id": "test-account-id", "aws_bucket_name": "test-bucket", "file_path": "test_rt.csv"}}, "sync_enabled": true}, "schema": {"fields": [{"name": "id", "type": "INT32"}, {"name": "name", "type": "STRING"}], "primary_keys": ["id"]}, "sync_enabled": false, "tags": ["test_tag"]}, "id": "00000000-0000-0000-0000-000000000000", "type": "reference_table"}} + And body with value {"data": {"attributes": {"description": "this is a cloud table generated via a cloud bucket sync", "file_metadata": {"access_details": {"aws_detail": {"aws_account_id": "test-account-id", "aws_bucket_name": "test-bucket", "file_path": "test_rt.csv"}}, "sync_enabled": true}, "schema": {"fields": [{"name": "id", "type": "INT32"}, {"name": "name", "type": "STRING"}], "primary_keys": ["id"]}, "sync_enabled": false, "tags": ["test_tag"]}, "type": "reference_table"}} When the request is sent Then the response status is 200 OK diff --git a/lib/datadog_api_client/v2/api/reference_tables_api.rb b/lib/datadog_api_client/v2/api/reference_tables_api.rb index 8348ee21c38..924a1c5fc4e 100644 --- a/lib/datadog_api_client/v2/api/reference_tables_api.rb +++ b/lib/datadog_api_client/v2/api/reference_tables_api.rb @@ -33,7 +33,11 @@ def create_reference_table(body, opts = {}) # Create reference table. # - # Create a new reference table. You can provide data in two ways: 1) Call POST api/v2/reference-tables/upload first to get an upload ID, then PUT chunks of CSV data to each provided URL, and finally call this POST endpoint with the upload_id in file_metadata, OR 2) Provide access_details in file_metadata pointing to a CSV file in cloud storage (Amazon S3, Azure Blob Storage, or GCP Cloud Storage). + # Creates a reference table. You can provide data in two ways: + # 1. Call POST /api/v2/reference-tables/upload to get an upload ID. Then PUT the CSV data + # (not the file itself) in chunks to each URL in the request body. Finally, call this + # POST endpoint with `upload_id` in `file_metadata`. + # 2. Provide `access_details` in `file_metadata` pointing to a CSV file in cloud storage. # # @param body [CreateTableRequest] # @param opts [Hash] the optional parameters @@ -169,7 +173,7 @@ def delete_table(id, opts = {}) # # Delete a reference table by ID # - # @param id [String] The ID of the reference table to delete + # @param id [String] Unique identifier of the reference table to delete # @param opts [Hash] the optional parameters # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers def delete_table_with_http_info(id, opts = {}) @@ -234,7 +238,7 @@ def get_rows_by_id(id, row_id, opts = {}) # # Get reference table rows by their primary key values. # - # @param id [String] The ID of the reference table + # @param id [String] Unique identifier of the reference table to get rows from # @param row_id [Array] List of row IDs (primary key values) to retrieve from the reference table. # @param opts [Hash] the optional parameters # @return [Array<(TableRowResourceArray, Integer, Hash)>] TableRowResourceArray data, response status code and response headers @@ -306,7 +310,7 @@ def get_table(id, opts = {}) # # Get a reference table by ID # - # @param id [String] The ID of the reference table to retrieve + # @param id [String] Unique identifier of the reference table to retrieve # @param opts [Hash] the optional parameters # @return [Array<(TableResultV2, Integer, Hash)>] TableResultV2 data, response status code and response headers def get_table_with_http_info(id, opts = {}) @@ -374,7 +378,7 @@ def list_tables(opts = {}) # @param opts [Hash] the optional parameters # @option opts [Integer] :page_limit Number of tables to return. # @option opts [Integer] :page_offset Number of tables to skip for pagination. - # @option opts [ReferenceTableSortType] :sort Sort field and direction. Use field name for ascending, prefix with "-" for descending. + # @option opts [ReferenceTableSortType] :sort Sort field and direction for the list of reference tables. Use field name for ascending, prefix with "-" for descending. # @option opts [String] :filter_status Filter by table status. # @option opts [String] :filter_table_name_exact Filter by exact table name match. # @option opts [String] :filter_table_name_contains Filter by table name containing substring. @@ -456,7 +460,7 @@ def update_reference_table(id, body, opts = {}) # # Update a reference table by ID. You can update the table's data, description, and tags. Note: The source type cannot be changed after table creation. For data updates: For existing tables of type `source:LOCAL_FILE`, call POST api/v2/reference-tables/uploads first to get an upload ID, then PUT chunks of CSV data to each provided URL, and finally call this PATCH endpoint with the upload_id in file_metadata. For existing tables with `source:` types of `S3`, `GCS`, or `AZURE`, provide updated access_details in file_metadata pointing to a CSV file in the same type of cloud storage. # - # @param id [String] The ID of the reference table to update + # @param id [String] Unique identifier of the reference table to update # @param body [PatchTableRequest] # @param opts [Hash] the optional parameters # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers diff --git a/lib/datadog_api_client/v2/models/create_table_request.rb b/lib/datadog_api_client/v2/models/create_table_request.rb index c51aa5d8cfe..aacef76f450 100644 --- a/lib/datadog_api_client/v2/models/create_table_request.rb +++ b/lib/datadog_api_client/v2/models/create_table_request.rb @@ -17,11 +17,11 @@ require 'time' module DatadogAPIClient::V2 - # The definition of `CreateTableRequest` object. + # Request body for creating a new reference table from a local file or cloud storage. class CreateTableRequest include BaseGenericModel - # The definition of `CreateTableRequestData` object. + # The data object containing the table definition. attr_accessor :data attr_accessor :additional_properties diff --git a/lib/datadog_api_client/v2/models/create_table_request_data.rb b/lib/datadog_api_client/v2/models/create_table_request_data.rb index 03614a894de..b481a949574 100644 --- a/lib/datadog_api_client/v2/models/create_table_request_data.rb +++ b/lib/datadog_api_client/v2/models/create_table_request_data.rb @@ -17,27 +17,21 @@ require 'time' module DatadogAPIClient::V2 - # The definition of `CreateTableRequestData` object. + # The data object containing the table definition. class CreateTableRequestData include BaseGenericModel - # The definition of `CreateTableRequestDataAttributes` object. + # Attributes that define the reference table's configuration and properties. attr_accessor :attributes - # The ID of the reference table. - attr_accessor :id - # Reference table resource type. attr_reader :type - attr_accessor :additional_properties - # Attribute mapping from ruby-style variable name to JSON key. # @!visibility private def self.attribute_map { :'attributes' => :'attributes', - :'id' => :'id', :'type' => :'type' } end @@ -47,7 +41,6 @@ def self.attribute_map def self.openapi_types { :'attributes' => :'CreateTableRequestDataAttributes', - :'id' => :'String', :'type' => :'CreateTableRequestDataType' } end @@ -60,24 +53,18 @@ def initialize(attributes = {}) fail ArgumentError, "The input argument (attributes) must be a hash in `DatadogAPIClient::V2::CreateTableRequestData` initialize method" end - self.additional_properties = {} # check to see if the attribute exists and convert string to symbol for hash key attributes = attributes.each_with_object({}) { |(k, v), h| if (!self.class.attribute_map.key?(k.to_sym)) - self.additional_properties[k.to_sym] = v - else - h[k.to_sym] = v + fail ArgumentError, "`#{k}` is not a valid attribute in `DatadogAPIClient::V2::CreateTableRequestData`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect end + h[k.to_sym] = v } if attributes.key?(:'attributes') self.attributes = attributes[:'attributes'] end - if attributes.key?(:'id') - self.id = attributes[:'id'] - end - if attributes.key?(:'type') self.type = attributes[:'type'] end @@ -101,26 +88,6 @@ def type=(type) @type = type end - # Returns the object in the form of hash, with additionalProperties support. - # @return [Hash] Returns the object in the form of hash - # @!visibility private - def to_hash - hash = {} - self.class.attribute_map.each_pair do |attr, param| - value = self.send(attr) - if value.nil? - is_nullable = self.class.openapi_nullable.include?(attr) - next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}")) - end - - hash[param] = _to_hash(value) - end - self.additional_properties.each_pair do |attr, value| - hash[attr] = value - end - hash - end - # Checks equality by comparing each attribute. # @param o [Object] Object to be compared # @!visibility private @@ -128,16 +95,14 @@ def ==(o) return true if self.equal?(o) self.class == o.class && attributes == o.attributes && - id == o.id && - type == o.type && - additional_properties == o.additional_properties + type == o.type end # Calculates hash code according to all attributes. # @return [Integer] Hash code # @!visibility private def hash - [attributes, id, type, additional_properties].hash + [attributes, type].hash end end end diff --git a/lib/datadog_api_client/v2/models/create_table_request_data_attributes.rb b/lib/datadog_api_client/v2/models/create_table_request_data_attributes.rb index e924ff843f0..27541228924 100644 --- a/lib/datadog_api_client/v2/models/create_table_request_data_attributes.rb +++ b/lib/datadog_api_client/v2/models/create_table_request_data_attributes.rb @@ -17,26 +17,26 @@ require 'time' module DatadogAPIClient::V2 - # The definition of `CreateTableRequestDataAttributes` object. + # Attributes that define the reference table's configuration and properties. class CreateTableRequestDataAttributes include BaseGenericModel - # The description of the reference table. + # Optional text describing the purpose or contents of this reference table. attr_accessor :description - # The definition of `CreateTableRequestDataAttributesFileMetadata` object. + # Metadata specifying where and how to access the reference table's data file. attr_accessor :file_metadata - # The definition of `CreateTableRequestDataAttributesSchema` object. + # Schema defining the structure and columns of the reference table. attr_reader :schema # The source type for creating reference table data. Only these source types can be created through this API. attr_reader :source - # The name of the reference table. + # Name to identify this reference table. attr_reader :table_name - # The tags of the reference table. + # Tags for organizing and filtering reference tables. attr_accessor :tags attr_accessor :additional_properties diff --git a/lib/datadog_api_client/v2/models/create_table_request_data_attributes_file_metadata.rb b/lib/datadog_api_client/v2/models/create_table_request_data_attributes_file_metadata.rb index 8bb539f0a8f..223022ae3f0 100644 --- a/lib/datadog_api_client/v2/models/create_table_request_data_attributes_file_metadata.rb +++ b/lib/datadog_api_client/v2/models/create_table_request_data_attributes_file_metadata.rb @@ -17,7 +17,7 @@ require 'time' module DatadogAPIClient::V2 - # The definition of `CreateTableRequestDataAttributesFileMetadata` object. + # Metadata specifying where and how to access the reference table's data file. module CreateTableRequestDataAttributesFileMetadata class << self include BaseOneOfModel diff --git a/lib/datadog_api_client/v2/models/create_table_request_data_attributes_file_metadata_cloud_storage.rb b/lib/datadog_api_client/v2/models/create_table_request_data_attributes_file_metadata_cloud_storage.rb index d6df3248c03..01b9cd5e2c1 100644 --- a/lib/datadog_api_client/v2/models/create_table_request_data_attributes_file_metadata_cloud_storage.rb +++ b/lib/datadog_api_client/v2/models/create_table_request_data_attributes_file_metadata_cloud_storage.rb @@ -21,7 +21,7 @@ module DatadogAPIClient::V2 class CreateTableRequestDataAttributesFileMetadataCloudStorage include BaseGenericModel - # The definition of `CreateTableRequestDataAttributesFileMetadataOneOfAccessDetails` object. + # Cloud storage access configuration for the reference table data file. attr_reader :access_details # Whether this table is synced automatically. diff --git a/lib/datadog_api_client/v2/models/create_table_request_data_attributes_file_metadata_one_of_access_details.rb b/lib/datadog_api_client/v2/models/create_table_request_data_attributes_file_metadata_one_of_access_details.rb index dc91255bc7a..ccabe749d07 100644 --- a/lib/datadog_api_client/v2/models/create_table_request_data_attributes_file_metadata_one_of_access_details.rb +++ b/lib/datadog_api_client/v2/models/create_table_request_data_attributes_file_metadata_one_of_access_details.rb @@ -17,17 +17,17 @@ require 'time' module DatadogAPIClient::V2 - # The definition of `CreateTableRequestDataAttributesFileMetadataOneOfAccessDetails` object. + # Cloud storage access configuration for the reference table data file. class CreateTableRequestDataAttributesFileMetadataOneOfAccessDetails include BaseGenericModel - # The definition of `CreateTableRequestDataAttributesFileMetadataOneOfAccessDetailsAwsDetail` object. + # Amazon Web Services S3 storage access configuration. attr_accessor :aws_detail - # The definition of `CreateTableRequestDataAttributesFileMetadataOneOfAccessDetailsAzureDetail` object. + # Azure Blob Storage access configuration. attr_accessor :azure_detail - # The definition of `CreateTableRequestDataAttributesFileMetadataOneOfAccessDetailsGcpDetail` object. + # Google Cloud Platform storage access configuration. attr_accessor :gcp_detail attr_accessor :additional_properties diff --git a/lib/datadog_api_client/v2/models/create_table_request_data_attributes_file_metadata_one_of_access_details_aws_detail.rb b/lib/datadog_api_client/v2/models/create_table_request_data_attributes_file_metadata_one_of_access_details_aws_detail.rb index ae0c7746371..3397c0347fd 100644 --- a/lib/datadog_api_client/v2/models/create_table_request_data_attributes_file_metadata_one_of_access_details_aws_detail.rb +++ b/lib/datadog_api_client/v2/models/create_table_request_data_attributes_file_metadata_one_of_access_details_aws_detail.rb @@ -17,14 +17,14 @@ require 'time' module DatadogAPIClient::V2 - # The definition of `CreateTableRequestDataAttributesFileMetadataOneOfAccessDetailsAwsDetail` object. + # Amazon Web Services S3 storage access configuration. class CreateTableRequestDataAttributesFileMetadataOneOfAccessDetailsAwsDetail include BaseGenericModel - # The ID of the AWS account. + # AWS account ID where the S3 bucket is located. attr_reader :aws_account_id - # The name of the Amazon S3 bucket. + # S3 bucket containing the CSV file. attr_reader :aws_bucket_name # The relative file path from the S3 bucket root to the CSV file. diff --git a/lib/datadog_api_client/v2/models/create_table_request_data_attributes_file_metadata_one_of_access_details_azure_detail.rb b/lib/datadog_api_client/v2/models/create_table_request_data_attributes_file_metadata_one_of_access_details_azure_detail.rb index 5bf5d397982..f5151f910a9 100644 --- a/lib/datadog_api_client/v2/models/create_table_request_data_attributes_file_metadata_one_of_access_details_azure_detail.rb +++ b/lib/datadog_api_client/v2/models/create_table_request_data_attributes_file_metadata_one_of_access_details_azure_detail.rb @@ -17,20 +17,20 @@ require 'time' module DatadogAPIClient::V2 - # The definition of `CreateTableRequestDataAttributesFileMetadataOneOfAccessDetailsAzureDetail` object. + # Azure Blob Storage access configuration. class CreateTableRequestDataAttributesFileMetadataOneOfAccessDetailsAzureDetail include BaseGenericModel - # The Azure client ID. + # Azure service principal (application) client ID with permissions to read from the container. attr_reader :azure_client_id - # The name of the Azure container. + # Azure Blob Storage container containing the CSV file. attr_reader :azure_container_name - # The name of the Azure storage account. + # Azure storage account where the container is located. attr_reader :azure_storage_account_name - # The ID of the Azure tenant. + # Azure Active Directory tenant ID. attr_reader :azure_tenant_id # The relative file path from the Azure container root to the CSV file. diff --git a/lib/datadog_api_client/v2/models/create_table_request_data_attributes_file_metadata_one_of_access_details_gcp_detail.rb b/lib/datadog_api_client/v2/models/create_table_request_data_attributes_file_metadata_one_of_access_details_gcp_detail.rb index d4b921d0000..6c5657946f0 100644 --- a/lib/datadog_api_client/v2/models/create_table_request_data_attributes_file_metadata_one_of_access_details_gcp_detail.rb +++ b/lib/datadog_api_client/v2/models/create_table_request_data_attributes_file_metadata_one_of_access_details_gcp_detail.rb @@ -17,20 +17,20 @@ require 'time' module DatadogAPIClient::V2 - # The definition of `CreateTableRequestDataAttributesFileMetadataOneOfAccessDetailsGcpDetail` object. + # Google Cloud Platform storage access configuration. class CreateTableRequestDataAttributesFileMetadataOneOfAccessDetailsGcpDetail include BaseGenericModel # The relative file path from the GCS bucket root to the CSV file. attr_reader :file_path - # The name of the GCP bucket. + # GCP bucket containing the CSV file. attr_reader :gcp_bucket_name - # The ID of the GCP project. + # GCP project ID where the bucket is located. attr_reader :gcp_project_id - # The email of the GCP service account. + # Service account email with read permissions for the GCS bucket. attr_reader :gcp_service_account_email attr_accessor :additional_properties diff --git a/lib/datadog_api_client/v2/models/create_table_request_data_attributes_schema.rb b/lib/datadog_api_client/v2/models/create_table_request_data_attributes_schema.rb index a9fd105f8a3..48aa5686054 100644 --- a/lib/datadog_api_client/v2/models/create_table_request_data_attributes_schema.rb +++ b/lib/datadog_api_client/v2/models/create_table_request_data_attributes_schema.rb @@ -17,11 +17,11 @@ require 'time' module DatadogAPIClient::V2 - # The definition of `CreateTableRequestDataAttributesSchema` object. + # Schema defining the structure and columns of the reference table. class CreateTableRequestDataAttributesSchema include BaseGenericModel - # The `schema` `fields`. + # The schema fields. attr_reader :fields # List of field names that serve as primary keys for the table. Only one primary key is supported, and it is used as an ID to retrieve rows. diff --git a/lib/datadog_api_client/v2/models/create_table_request_data_attributes_schema_fields_items.rb b/lib/datadog_api_client/v2/models/create_table_request_data_attributes_schema_fields_items.rb index 77c01aa424c..3aaad1a4eb4 100644 --- a/lib/datadog_api_client/v2/models/create_table_request_data_attributes_schema_fields_items.rb +++ b/lib/datadog_api_client/v2/models/create_table_request_data_attributes_schema_fields_items.rb @@ -17,7 +17,7 @@ require 'time' module DatadogAPIClient::V2 - # The definition of `CreateTableRequestDataAttributesSchemaFieldsItems` object. + # A single field (column) in the reference table schema to be created. class CreateTableRequestDataAttributesSchemaFieldsItems include BaseGenericModel diff --git a/lib/datadog_api_client/v2/models/create_upload_request.rb b/lib/datadog_api_client/v2/models/create_upload_request.rb index 355ffecfcd4..90da5488377 100644 --- a/lib/datadog_api_client/v2/models/create_upload_request.rb +++ b/lib/datadog_api_client/v2/models/create_upload_request.rb @@ -17,11 +17,11 @@ require 'time' module DatadogAPIClient::V2 - # The definition of `CreateUploadRequest` object. + # Request to create an upload for a file to be ingested into a reference table. class CreateUploadRequest include BaseGenericModel - # The definition of `CreateUploadRequestData` object. + # Request data for creating an upload for a file to be ingested into a reference table. attr_accessor :data attr_accessor :additional_properties diff --git a/lib/datadog_api_client/v2/models/create_upload_request_data.rb b/lib/datadog_api_client/v2/models/create_upload_request_data.rb index 9564540dad8..3929d21df4d 100644 --- a/lib/datadog_api_client/v2/models/create_upload_request_data.rb +++ b/lib/datadog_api_client/v2/models/create_upload_request_data.rb @@ -17,27 +17,21 @@ require 'time' module DatadogAPIClient::V2 - # The definition of `CreateUploadRequestData` object. + # Request data for creating an upload for a file to be ingested into a reference table. class CreateUploadRequestData include BaseGenericModel - # The definition of `CreateUploadRequestDataAttributes` object. + # Upload configuration specifying how data will be uploaded by the user, and properties of the table to associate the upload with. attr_accessor :attributes - # The ID of the upload. - attr_accessor :id - # Upload resource type. attr_reader :type - attr_accessor :additional_properties - # Attribute mapping from ruby-style variable name to JSON key. # @!visibility private def self.attribute_map { :'attributes' => :'attributes', - :'id' => :'id', :'type' => :'type' } end @@ -47,7 +41,6 @@ def self.attribute_map def self.openapi_types { :'attributes' => :'CreateUploadRequestDataAttributes', - :'id' => :'String', :'type' => :'CreateUploadRequestDataType' } end @@ -60,24 +53,18 @@ def initialize(attributes = {}) fail ArgumentError, "The input argument (attributes) must be a hash in `DatadogAPIClient::V2::CreateUploadRequestData` initialize method" end - self.additional_properties = {} # check to see if the attribute exists and convert string to symbol for hash key attributes = attributes.each_with_object({}) { |(k, v), h| if (!self.class.attribute_map.key?(k.to_sym)) - self.additional_properties[k.to_sym] = v - else - h[k.to_sym] = v + fail ArgumentError, "`#{k}` is not a valid attribute in `DatadogAPIClient::V2::CreateUploadRequestData`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect end + h[k.to_sym] = v } if attributes.key?(:'attributes') self.attributes = attributes[:'attributes'] end - if attributes.key?(:'id') - self.id = attributes[:'id'] - end - if attributes.key?(:'type') self.type = attributes[:'type'] end @@ -101,26 +88,6 @@ def type=(type) @type = type end - # Returns the object in the form of hash, with additionalProperties support. - # @return [Hash] Returns the object in the form of hash - # @!visibility private - def to_hash - hash = {} - self.class.attribute_map.each_pair do |attr, param| - value = self.send(attr) - if value.nil? - is_nullable = self.class.openapi_nullable.include?(attr) - next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}")) - end - - hash[param] = _to_hash(value) - end - self.additional_properties.each_pair do |attr, value| - hash[attr] = value - end - hash - end - # Checks equality by comparing each attribute. # @param o [Object] Object to be compared # @!visibility private @@ -128,16 +95,14 @@ def ==(o) return true if self.equal?(o) self.class == o.class && attributes == o.attributes && - id == o.id && - type == o.type && - additional_properties == o.additional_properties + type == o.type end # Calculates hash code according to all attributes. # @return [Integer] Hash code # @!visibility private def hash - [attributes, id, type, additional_properties].hash + [attributes, type].hash end end end diff --git a/lib/datadog_api_client/v2/models/create_upload_request_data_attributes.rb b/lib/datadog_api_client/v2/models/create_upload_request_data_attributes.rb index a2588889329..305ef59ad6a 100644 --- a/lib/datadog_api_client/v2/models/create_upload_request_data_attributes.rb +++ b/lib/datadog_api_client/v2/models/create_upload_request_data_attributes.rb @@ -17,20 +17,20 @@ require 'time' module DatadogAPIClient::V2 - # The definition of `CreateUploadRequestDataAttributes` object. + # Upload configuration specifying how data will be uploaded by the user, and properties of the table to associate the upload with. class CreateUploadRequestDataAttributes include BaseGenericModel - # The headers of the file to upload. + # The CSV file headers that define the schema fields, provided in the same order as the columns in the uploaded file. attr_reader :headers - # The number of parts in the upload. + # Number of parts to split the file into for multipart upload. attr_reader :part_count - # The size of each part in the upload in bytes. For multipart uploads (part_count > 1), all parts except the last one must be at least 5,000,000 bytes. For single-part uploads (part_count = 1), any size is allowed. + # The size of each part in the upload in bytes. All parts except the last one must be at least 5,000,000 bytes. attr_reader :part_size - # The name of the reference table. + # Name of the table to associate with this upload. attr_reader :table_name attr_accessor :additional_properties diff --git a/lib/datadog_api_client/v2/models/create_upload_response.rb b/lib/datadog_api_client/v2/models/create_upload_response.rb index a49e0ff77f3..a4aa8870ac8 100644 --- a/lib/datadog_api_client/v2/models/create_upload_response.rb +++ b/lib/datadog_api_client/v2/models/create_upload_response.rb @@ -17,11 +17,11 @@ require 'time' module DatadogAPIClient::V2 - # The definition of `CreateUploadResponse` object. + # Information about the upload created containing the upload ID and pre-signed URLs to PUT chunks of the CSV file to. class CreateUploadResponse include BaseGenericModel - # The definition of `CreateUploadResponseData` object. + # Upload ID and attributes of the created upload. attr_accessor :data attr_accessor :additional_properties diff --git a/lib/datadog_api_client/v2/models/create_upload_response_data.rb b/lib/datadog_api_client/v2/models/create_upload_response_data.rb index 9c49d6e8890..c7d83f0057c 100644 --- a/lib/datadog_api_client/v2/models/create_upload_response_data.rb +++ b/lib/datadog_api_client/v2/models/create_upload_response_data.rb @@ -17,21 +17,19 @@ require 'time' module DatadogAPIClient::V2 - # The definition of `CreateUploadResponseData` object. + # Upload ID and attributes of the created upload. class CreateUploadResponseData include BaseGenericModel - # The definition of `CreateUploadResponseDataAttributes` object. + # Pre-signed URLs for uploading parts of the file. attr_accessor :attributes - # The ID of the upload. + # Unique identifier for this upload. Use this ID when creating the reference table. attr_accessor :id # Upload resource type. attr_reader :type - attr_accessor :additional_properties - # Attribute mapping from ruby-style variable name to JSON key. # @!visibility private def self.attribute_map @@ -60,14 +58,12 @@ def initialize(attributes = {}) fail ArgumentError, "The input argument (attributes) must be a hash in `DatadogAPIClient::V2::CreateUploadResponseData` initialize method" end - self.additional_properties = {} # check to see if the attribute exists and convert string to symbol for hash key attributes = attributes.each_with_object({}) { |(k, v), h| if (!self.class.attribute_map.key?(k.to_sym)) - self.additional_properties[k.to_sym] = v - else - h[k.to_sym] = v + fail ArgumentError, "`#{k}` is not a valid attribute in `DatadogAPIClient::V2::CreateUploadResponseData`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect end + h[k.to_sym] = v } if attributes.key?(:'attributes') @@ -101,26 +97,6 @@ def type=(type) @type = type end - # Returns the object in the form of hash, with additionalProperties support. - # @return [Hash] Returns the object in the form of hash - # @!visibility private - def to_hash - hash = {} - self.class.attribute_map.each_pair do |attr, param| - value = self.send(attr) - if value.nil? - is_nullable = self.class.openapi_nullable.include?(attr) - next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}")) - end - - hash[param] = _to_hash(value) - end - self.additional_properties.each_pair do |attr, value| - hash[attr] = value - end - hash - end - # Checks equality by comparing each attribute. # @param o [Object] Object to be compared # @!visibility private @@ -129,15 +105,14 @@ def ==(o) self.class == o.class && attributes == o.attributes && id == o.id && - type == o.type && - additional_properties == o.additional_properties + type == o.type end # Calculates hash code according to all attributes. # @return [Integer] Hash code # @!visibility private def hash - [attributes, id, type, additional_properties].hash + [attributes, id, type].hash end end end diff --git a/lib/datadog_api_client/v2/models/create_upload_response_data_attributes.rb b/lib/datadog_api_client/v2/models/create_upload_response_data_attributes.rb index 9eb74ef23b3..a06c2aee639 100644 --- a/lib/datadog_api_client/v2/models/create_upload_response_data_attributes.rb +++ b/lib/datadog_api_client/v2/models/create_upload_response_data_attributes.rb @@ -17,11 +17,11 @@ require 'time' module DatadogAPIClient::V2 - # The definition of `CreateUploadResponseDataAttributes` object. + # Pre-signed URLs for uploading parts of the file. class CreateUploadResponseDataAttributes include BaseGenericModel - # The URLs of the parts in the upload. + # The pre-signed URLs for uploading parts. These URLs expire after 5 minutes. attr_accessor :part_urls attr_accessor :additional_properties diff --git a/lib/datadog_api_client/v2/models/patch_table_request.rb b/lib/datadog_api_client/v2/models/patch_table_request.rb index 5cb5daa99c3..24678a104d1 100644 --- a/lib/datadog_api_client/v2/models/patch_table_request.rb +++ b/lib/datadog_api_client/v2/models/patch_table_request.rb @@ -17,11 +17,11 @@ require 'time' module DatadogAPIClient::V2 - # The definition of `PatchTableRequest` object. + # Request body for updating an existing reference table. class PatchTableRequest include BaseGenericModel - # The definition of `PatchTableRequestData` object. + # The data object containing the partial table definition updates. attr_accessor :data attr_accessor :additional_properties diff --git a/lib/datadog_api_client/v2/models/patch_table_request_data.rb b/lib/datadog_api_client/v2/models/patch_table_request_data.rb index c1598587473..9e67d633af7 100644 --- a/lib/datadog_api_client/v2/models/patch_table_request_data.rb +++ b/lib/datadog_api_client/v2/models/patch_table_request_data.rb @@ -17,27 +17,21 @@ require 'time' module DatadogAPIClient::V2 - # The definition of `PatchTableRequestData` object. + # The data object containing the partial table definition updates. class PatchTableRequestData include BaseGenericModel - # The definition of `PatchTableRequestDataAttributes` object. + # Attributes that define the updates to the reference table's configuration and properties. attr_accessor :attributes - # The ID of the reference table. - attr_accessor :id - # Reference table resource type. attr_reader :type - attr_accessor :additional_properties - # Attribute mapping from ruby-style variable name to JSON key. # @!visibility private def self.attribute_map { :'attributes' => :'attributes', - :'id' => :'id', :'type' => :'type' } end @@ -47,7 +41,6 @@ def self.attribute_map def self.openapi_types { :'attributes' => :'PatchTableRequestDataAttributes', - :'id' => :'String', :'type' => :'PatchTableRequestDataType' } end @@ -60,24 +53,18 @@ def initialize(attributes = {}) fail ArgumentError, "The input argument (attributes) must be a hash in `DatadogAPIClient::V2::PatchTableRequestData` initialize method" end - self.additional_properties = {} # check to see if the attribute exists and convert string to symbol for hash key attributes = attributes.each_with_object({}) { |(k, v), h| if (!self.class.attribute_map.key?(k.to_sym)) - self.additional_properties[k.to_sym] = v - else - h[k.to_sym] = v + fail ArgumentError, "`#{k}` is not a valid attribute in `DatadogAPIClient::V2::PatchTableRequestData`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect end + h[k.to_sym] = v } if attributes.key?(:'attributes') self.attributes = attributes[:'attributes'] end - if attributes.key?(:'id') - self.id = attributes[:'id'] - end - if attributes.key?(:'type') self.type = attributes[:'type'] end @@ -101,26 +88,6 @@ def type=(type) @type = type end - # Returns the object in the form of hash, with additionalProperties support. - # @return [Hash] Returns the object in the form of hash - # @!visibility private - def to_hash - hash = {} - self.class.attribute_map.each_pair do |attr, param| - value = self.send(attr) - if value.nil? - is_nullable = self.class.openapi_nullable.include?(attr) - next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}")) - end - - hash[param] = _to_hash(value) - end - self.additional_properties.each_pair do |attr, value| - hash[attr] = value - end - hash - end - # Checks equality by comparing each attribute. # @param o [Object] Object to be compared # @!visibility private @@ -128,16 +95,14 @@ def ==(o) return true if self.equal?(o) self.class == o.class && attributes == o.attributes && - id == o.id && - type == o.type && - additional_properties == o.additional_properties + type == o.type end # Calculates hash code according to all attributes. # @return [Integer] Hash code # @!visibility private def hash - [attributes, id, type, additional_properties].hash + [attributes, type].hash end end end diff --git a/lib/datadog_api_client/v2/models/patch_table_request_data_attributes.rb b/lib/datadog_api_client/v2/models/patch_table_request_data_attributes.rb index 376fc4d42a2..5b65b9e26a6 100644 --- a/lib/datadog_api_client/v2/models/patch_table_request_data_attributes.rb +++ b/lib/datadog_api_client/v2/models/patch_table_request_data_attributes.rb @@ -17,23 +17,23 @@ require 'time' module DatadogAPIClient::V2 - # The definition of `PatchTableRequestDataAttributes` object. + # Attributes that define the updates to the reference table's configuration and properties. class PatchTableRequestDataAttributes include BaseGenericModel - # The description of the reference table. + # Optional text describing the purpose or contents of this reference table. attr_accessor :description - # The definition of `PatchTableRequestDataAttributesFileMetadata` object. + # Metadata specifying where and how to access the reference table's data file. attr_accessor :file_metadata - # The definition of `PatchTableRequestDataAttributesSchema` object. + # Schema defining the updates to the structure and columns of the reference table. Schema fields cannot be deleted or renamed. attr_accessor :schema # Whether this table is synced automatically. attr_accessor :sync_enabled - # The tags of the reference table. + # Tags for organizing and filtering reference tables. attr_accessor :tags attr_accessor :additional_properties diff --git a/lib/datadog_api_client/v2/models/patch_table_request_data_attributes_file_metadata.rb b/lib/datadog_api_client/v2/models/patch_table_request_data_attributes_file_metadata.rb index 12dee29ce3f..e0b87461362 100644 --- a/lib/datadog_api_client/v2/models/patch_table_request_data_attributes_file_metadata.rb +++ b/lib/datadog_api_client/v2/models/patch_table_request_data_attributes_file_metadata.rb @@ -17,7 +17,7 @@ require 'time' module DatadogAPIClient::V2 - # The definition of `PatchTableRequestDataAttributesFileMetadata` object. + # Metadata specifying where and how to access the reference table's data file. module PatchTableRequestDataAttributesFileMetadata class << self include BaseOneOfModel diff --git a/lib/datadog_api_client/v2/models/patch_table_request_data_attributes_file_metadata_cloud_storage.rb b/lib/datadog_api_client/v2/models/patch_table_request_data_attributes_file_metadata_cloud_storage.rb index 2b387827de5..cf19e0ee2c5 100644 --- a/lib/datadog_api_client/v2/models/patch_table_request_data_attributes_file_metadata_cloud_storage.rb +++ b/lib/datadog_api_client/v2/models/patch_table_request_data_attributes_file_metadata_cloud_storage.rb @@ -21,7 +21,7 @@ module DatadogAPIClient::V2 class PatchTableRequestDataAttributesFileMetadataCloudStorage include BaseGenericModel - # The definition of `PatchTableRequestDataAttributesFileMetadataOneOfAccessDetails` object. + # Cloud storage access configuration for the reference table data file. attr_accessor :access_details # Whether this table is synced automatically. diff --git a/lib/datadog_api_client/v2/models/patch_table_request_data_attributes_file_metadata_one_of_access_details.rb b/lib/datadog_api_client/v2/models/patch_table_request_data_attributes_file_metadata_one_of_access_details.rb index 6c939ca06f4..8d2f65250b4 100644 --- a/lib/datadog_api_client/v2/models/patch_table_request_data_attributes_file_metadata_one_of_access_details.rb +++ b/lib/datadog_api_client/v2/models/patch_table_request_data_attributes_file_metadata_one_of_access_details.rb @@ -17,17 +17,17 @@ require 'time' module DatadogAPIClient::V2 - # The definition of `PatchTableRequestDataAttributesFileMetadataOneOfAccessDetails` object. + # Cloud storage access configuration for the reference table data file. class PatchTableRequestDataAttributesFileMetadataOneOfAccessDetails include BaseGenericModel - # The definition of `PatchTableRequestDataAttributesFileMetadataOneOfAccessDetailsAwsDetail` object. + # Amazon Web Services S3 storage access configuration. attr_accessor :aws_detail - # The definition of `PatchTableRequestDataAttributesFileMetadataOneOfAccessDetailsAzureDetail` object. + # Azure Blob Storage access configuration. attr_accessor :azure_detail - # The definition of `PatchTableRequestDataAttributesFileMetadataOneOfAccessDetailsGcpDetail` object. + # Google Cloud Platform storage access configuration. attr_accessor :gcp_detail attr_accessor :additional_properties diff --git a/lib/datadog_api_client/v2/models/patch_table_request_data_attributes_file_metadata_one_of_access_details_aws_detail.rb b/lib/datadog_api_client/v2/models/patch_table_request_data_attributes_file_metadata_one_of_access_details_aws_detail.rb index 02ed86ac16f..af5eb6685f3 100644 --- a/lib/datadog_api_client/v2/models/patch_table_request_data_attributes_file_metadata_one_of_access_details_aws_detail.rb +++ b/lib/datadog_api_client/v2/models/patch_table_request_data_attributes_file_metadata_one_of_access_details_aws_detail.rb @@ -17,14 +17,14 @@ require 'time' module DatadogAPIClient::V2 - # The definition of `PatchTableRequestDataAttributesFileMetadataOneOfAccessDetailsAwsDetail` object. + # Amazon Web Services S3 storage access configuration. class PatchTableRequestDataAttributesFileMetadataOneOfAccessDetailsAwsDetail include BaseGenericModel - # The ID of the AWS account. + # AWS account ID where the S3 bucket is located. attr_accessor :aws_account_id - # The name of the AWS bucket. + # S3 bucket containing the CSV file. attr_accessor :aws_bucket_name # The relative file path from the S3 bucket root to the CSV file. diff --git a/lib/datadog_api_client/v2/models/patch_table_request_data_attributes_file_metadata_one_of_access_details_azure_detail.rb b/lib/datadog_api_client/v2/models/patch_table_request_data_attributes_file_metadata_one_of_access_details_azure_detail.rb index 87ee1c160c5..393b1dfa917 100644 --- a/lib/datadog_api_client/v2/models/patch_table_request_data_attributes_file_metadata_one_of_access_details_azure_detail.rb +++ b/lib/datadog_api_client/v2/models/patch_table_request_data_attributes_file_metadata_one_of_access_details_azure_detail.rb @@ -17,20 +17,20 @@ require 'time' module DatadogAPIClient::V2 - # The definition of `PatchTableRequestDataAttributesFileMetadataOneOfAccessDetailsAzureDetail` object. + # Azure Blob Storage access configuration. class PatchTableRequestDataAttributesFileMetadataOneOfAccessDetailsAzureDetail include BaseGenericModel - # The Azure client ID. + # Azure service principal (application) client ID with permissions to read from the container. attr_accessor :azure_client_id - # The name of the Azure container. + # Azure Blob Storage container containing the CSV file. attr_accessor :azure_container_name - # The name of the Azure storage account. + # Azure storage account where the container is located. attr_accessor :azure_storage_account_name - # The ID of the Azure tenant. + # Azure Active Directory tenant ID. attr_accessor :azure_tenant_id # The relative file path from the Azure container root to the CSV file. diff --git a/lib/datadog_api_client/v2/models/patch_table_request_data_attributes_file_metadata_one_of_access_details_gcp_detail.rb b/lib/datadog_api_client/v2/models/patch_table_request_data_attributes_file_metadata_one_of_access_details_gcp_detail.rb index 46f9be35c43..7ebf1333b41 100644 --- a/lib/datadog_api_client/v2/models/patch_table_request_data_attributes_file_metadata_one_of_access_details_gcp_detail.rb +++ b/lib/datadog_api_client/v2/models/patch_table_request_data_attributes_file_metadata_one_of_access_details_gcp_detail.rb @@ -17,20 +17,20 @@ require 'time' module DatadogAPIClient::V2 - # The definition of `PatchTableRequestDataAttributesFileMetadataOneOfAccessDetailsGcpDetail` object. + # Google Cloud Platform storage access configuration. class PatchTableRequestDataAttributesFileMetadataOneOfAccessDetailsGcpDetail include BaseGenericModel # The relative file path from the GCS bucket root to the CSV file. attr_accessor :file_path - # The name of the GCP bucket. + # GCP bucket containing the CSV file. attr_accessor :gcp_bucket_name - # The ID of the GCP project. + # GCP project ID where the bucket is located. attr_accessor :gcp_project_id - # The email of the GCP service account. + # Service account email with read permissions for the GCS bucket. attr_accessor :gcp_service_account_email attr_accessor :additional_properties diff --git a/lib/datadog_api_client/v2/models/patch_table_request_data_attributes_schema.rb b/lib/datadog_api_client/v2/models/patch_table_request_data_attributes_schema.rb index 8643995b4b3..962bd2913b9 100644 --- a/lib/datadog_api_client/v2/models/patch_table_request_data_attributes_schema.rb +++ b/lib/datadog_api_client/v2/models/patch_table_request_data_attributes_schema.rb @@ -17,14 +17,14 @@ require 'time' module DatadogAPIClient::V2 - # The definition of `PatchTableRequestDataAttributesSchema` object. + # Schema defining the updates to the structure and columns of the reference table. Schema fields cannot be deleted or renamed. class PatchTableRequestDataAttributesSchema include BaseGenericModel - # The `schema` `fields`. + # The schema fields. attr_reader :fields - # List of field names that serve as primary keys for the table. Only one primary key is supported, and it is used as an ID to retrieve rows. + # List of field names that serve as primary keys for the table. Only one primary key is supported, and it is used as an ID to retrieve rows. Primary keys cannot be changed after table creation. attr_reader :primary_keys attr_accessor :additional_properties diff --git a/lib/datadog_api_client/v2/models/patch_table_request_data_attributes_schema_fields_items.rb b/lib/datadog_api_client/v2/models/patch_table_request_data_attributes_schema_fields_items.rb index d2e8fbf8d10..2d683ace1a8 100644 --- a/lib/datadog_api_client/v2/models/patch_table_request_data_attributes_schema_fields_items.rb +++ b/lib/datadog_api_client/v2/models/patch_table_request_data_attributes_schema_fields_items.rb @@ -17,7 +17,7 @@ require 'time' module DatadogAPIClient::V2 - # The definition of `PatchTableRequestDataAttributesSchemaFieldsItems` object. + # A single field (column) in the reference table schema to be updated. Schema fields cannot be deleted or renamed. class PatchTableRequestDataAttributesSchemaFieldsItems include BaseGenericModel diff --git a/lib/datadog_api_client/v2/models/table_result_v2.rb b/lib/datadog_api_client/v2/models/table_result_v2.rb index 87ee8534440..a1af0f2e7fa 100644 --- a/lib/datadog_api_client/v2/models/table_result_v2.rb +++ b/lib/datadog_api_client/v2/models/table_result_v2.rb @@ -17,11 +17,11 @@ require 'time' module DatadogAPIClient::V2 - # The definition of `TableResultV2` object. + # A reference table resource containing its full configuration and state. class TableResultV2 include BaseGenericModel - # The definition of `TableResultV2Data` object. + # The data object containing the reference table configuration and state. attr_accessor :data attr_accessor :additional_properties diff --git a/lib/datadog_api_client/v2/models/table_result_v2_array.rb b/lib/datadog_api_client/v2/models/table_result_v2_array.rb index 7246cb5216f..68921e62aa8 100644 --- a/lib/datadog_api_client/v2/models/table_result_v2_array.rb +++ b/lib/datadog_api_client/v2/models/table_result_v2_array.rb @@ -17,7 +17,7 @@ require 'time' module DatadogAPIClient::V2 - # The definition of `TableResultV2Array` object. + # List of reference tables. class TableResultV2Array include BaseGenericModel diff --git a/lib/datadog_api_client/v2/models/table_result_v2_data.rb b/lib/datadog_api_client/v2/models/table_result_v2_data.rb index 7c07a29ef61..f740d9da80c 100644 --- a/lib/datadog_api_client/v2/models/table_result_v2_data.rb +++ b/lib/datadog_api_client/v2/models/table_result_v2_data.rb @@ -17,21 +17,19 @@ require 'time' module DatadogAPIClient::V2 - # The definition of `TableResultV2Data` object. + # The data object containing the reference table configuration and state. class TableResultV2Data include BaseGenericModel - # The definition of `TableResultV2DataAttributes` object. + # Attributes that define the reference table's configuration and properties. attr_accessor :attributes - # The ID of the reference table. + # Unique identifier for the reference table. attr_accessor :id # Reference table resource type. attr_reader :type - attr_accessor :additional_properties - # Attribute mapping from ruby-style variable name to JSON key. # @!visibility private def self.attribute_map @@ -60,14 +58,12 @@ def initialize(attributes = {}) fail ArgumentError, "The input argument (attributes) must be a hash in `DatadogAPIClient::V2::TableResultV2Data` initialize method" end - self.additional_properties = {} # check to see if the attribute exists and convert string to symbol for hash key attributes = attributes.each_with_object({}) { |(k, v), h| if (!self.class.attribute_map.key?(k.to_sym)) - self.additional_properties[k.to_sym] = v - else - h[k.to_sym] = v + fail ArgumentError, "`#{k}` is not a valid attribute in `DatadogAPIClient::V2::TableResultV2Data`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect end + h[k.to_sym] = v } if attributes.key?(:'attributes') @@ -101,26 +97,6 @@ def type=(type) @type = type end - # Returns the object in the form of hash, with additionalProperties support. - # @return [Hash] Returns the object in the form of hash - # @!visibility private - def to_hash - hash = {} - self.class.attribute_map.each_pair do |attr, param| - value = self.send(attr) - if value.nil? - is_nullable = self.class.openapi_nullable.include?(attr) - next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}")) - end - - hash[param] = _to_hash(value) - end - self.additional_properties.each_pair do |attr, value| - hash[attr] = value - end - hash - end - # Checks equality by comparing each attribute. # @param o [Object] Object to be compared # @!visibility private @@ -129,15 +105,14 @@ def ==(o) self.class == o.class && attributes == o.attributes && id == o.id && - type == o.type && - additional_properties == o.additional_properties + type == o.type end # Calculates hash code according to all attributes. # @return [Integer] Hash code # @!visibility private def hash - [attributes, id, type, additional_properties].hash + [attributes, id, type].hash end end end diff --git a/lib/datadog_api_client/v2/models/table_result_v2_data_attributes.rb b/lib/datadog_api_client/v2/models/table_result_v2_data_attributes.rb index a4853b78ad4..fbe8e3dd87b 100644 --- a/lib/datadog_api_client/v2/models/table_result_v2_data_attributes.rb +++ b/lib/datadog_api_client/v2/models/table_result_v2_data_attributes.rb @@ -17,17 +17,17 @@ require 'time' module DatadogAPIClient::V2 - # The definition of `TableResultV2DataAttributes` object. + # Attributes that define the reference table's configuration and properties. class TableResultV2DataAttributes include BaseGenericModel # UUID of the user who created the reference table. attr_accessor :created_by - # The description of the reference table. + # Optional text describing the purpose or contents of this reference table. attr_accessor :description - # The definition of `TableResultV2DataAttributesFileMetadata` object. + # Metadata specifying where and how to access the reference table's data file. attr_accessor :file_metadata # UUID of the user who last updated the reference table. @@ -36,22 +36,22 @@ class TableResultV2DataAttributes # The number of successfully processed rows in the reference table. attr_accessor :row_count - # The definition of `TableResultV2DataAttributesSchema` object. + # Schema defining the structure and columns of the reference table. attr_accessor :schema # The source type for reference table data. Includes all possible source types that can appear in responses. attr_accessor :source - # The status of the reference table. + # The processing status of the table. attr_accessor :status - # The name of the reference table. + # Unique name to identify this reference table. Used in enrichment processors and API calls. attr_accessor :table_name - # The tags of the reference table. + # Tags for organizing and filtering reference tables. attr_accessor :tags - # The timestamp of the last update to the reference table in ISO 8601 format. + # When the reference table was last updated, in ISO 8601 format. attr_accessor :updated_at attr_accessor :additional_properties diff --git a/lib/datadog_api_client/v2/models/table_result_v2_data_attributes_file_metadata.rb b/lib/datadog_api_client/v2/models/table_result_v2_data_attributes_file_metadata.rb index c7451434609..116e19841bd 100644 --- a/lib/datadog_api_client/v2/models/table_result_v2_data_attributes_file_metadata.rb +++ b/lib/datadog_api_client/v2/models/table_result_v2_data_attributes_file_metadata.rb @@ -17,7 +17,7 @@ require 'time' module DatadogAPIClient::V2 - # The definition of `TableResultV2DataAttributesFileMetadata` object. + # Metadata specifying where and how to access the reference table's data file. module TableResultV2DataAttributesFileMetadata class << self include BaseOneOfModel diff --git a/lib/datadog_api_client/v2/models/table_result_v2_data_attributes_file_metadata_cloud_storage.rb b/lib/datadog_api_client/v2/models/table_result_v2_data_attributes_file_metadata_cloud_storage.rb index de2dc4a226e..e949cb365f1 100644 --- a/lib/datadog_api_client/v2/models/table_result_v2_data_attributes_file_metadata_cloud_storage.rb +++ b/lib/datadog_api_client/v2/models/table_result_v2_data_attributes_file_metadata_cloud_storage.rb @@ -21,8 +21,8 @@ module DatadogAPIClient::V2 class TableResultV2DataAttributesFileMetadataCloudStorage include BaseGenericModel - # The definition of `TableResultV2DataAttributesFileMetadataOneOfAccessDetails` object. - attr_accessor :access_details + # Cloud storage access configuration for the reference table data file. + attr_reader :access_details # The error message returned from the sync. attr_accessor :error_message @@ -101,6 +101,24 @@ def initialize(attributes = {}) end end + # Check to see if the all the properties in the model are valid + # @return true if the model is valid + # @!visibility private + def valid? + return false if @access_details.nil? + true + end + + # Custom attribute writer method with validation + # @param access_details [Object] Object to be assigned + # @!visibility private + def access_details=(access_details) + if access_details.nil? + fail ArgumentError, 'invalid value for "access_details", access_details cannot be nil.' + end + @access_details = access_details + end + # Returns the object in the form of hash, with additionalProperties support. # @return [Hash] Returns the object in the form of hash # @!visibility private diff --git a/lib/datadog_api_client/v2/models/table_result_v2_data_attributes_file_metadata_local_file.rb b/lib/datadog_api_client/v2/models/table_result_v2_data_attributes_file_metadata_local_file.rb index 58d48852f33..e8acd894328 100644 --- a/lib/datadog_api_client/v2/models/table_result_v2_data_attributes_file_metadata_local_file.rb +++ b/lib/datadog_api_client/v2/models/table_result_v2_data_attributes_file_metadata_local_file.rb @@ -17,7 +17,7 @@ require 'time' module DatadogAPIClient::V2 - # File metadata for reference tables created by upload. + # File metadata for reference tables created by upload. Note that upload_id is only returned in the immediate create/replace response and is not available in subsequent GET requests. class TableResultV2DataAttributesFileMetadataLocalFile include BaseGenericModel @@ -27,9 +27,6 @@ class TableResultV2DataAttributesFileMetadataLocalFile # The number of rows that failed to create/update. attr_accessor :error_row_count - # The upload ID that was used to create/update the table. - attr_accessor :upload_id - attr_accessor :additional_properties # Attribute mapping from ruby-style variable name to JSON key. @@ -37,8 +34,7 @@ class TableResultV2DataAttributesFileMetadataLocalFile def self.attribute_map { :'error_message' => :'error_message', - :'error_row_count' => :'error_row_count', - :'upload_id' => :'upload_id' + :'error_row_count' => :'error_row_count' } end @@ -47,8 +43,7 @@ def self.attribute_map def self.openapi_types { :'error_message' => :'String', - :'error_row_count' => :'Integer', - :'upload_id' => :'String' + :'error_row_count' => :'Integer' } end @@ -77,10 +72,6 @@ def initialize(attributes = {}) if attributes.key?(:'error_row_count') self.error_row_count = attributes[:'error_row_count'] end - - if attributes.key?(:'upload_id') - self.upload_id = attributes[:'upload_id'] - end end # Returns the object in the form of hash, with additionalProperties support. @@ -111,7 +102,6 @@ def ==(o) self.class == o.class && error_message == o.error_message && error_row_count == o.error_row_count && - upload_id == o.upload_id && additional_properties == o.additional_properties end @@ -119,7 +109,7 @@ def ==(o) # @return [Integer] Hash code # @!visibility private def hash - [error_message, error_row_count, upload_id, additional_properties].hash + [error_message, error_row_count, additional_properties].hash end end end diff --git a/lib/datadog_api_client/v2/models/table_result_v2_data_attributes_file_metadata_one_of_access_details.rb b/lib/datadog_api_client/v2/models/table_result_v2_data_attributes_file_metadata_one_of_access_details.rb index 25d0663eece..dd2cad9bc6f 100644 --- a/lib/datadog_api_client/v2/models/table_result_v2_data_attributes_file_metadata_one_of_access_details.rb +++ b/lib/datadog_api_client/v2/models/table_result_v2_data_attributes_file_metadata_one_of_access_details.rb @@ -17,17 +17,17 @@ require 'time' module DatadogAPIClient::V2 - # The definition of `TableResultV2DataAttributesFileMetadataOneOfAccessDetails` object. + # Cloud storage access configuration for the reference table data file. class TableResultV2DataAttributesFileMetadataOneOfAccessDetails include BaseGenericModel - # The definition of `TableResultV2DataAttributesFileMetadataOneOfAccessDetailsAwsDetail` object. + # Amazon Web Services S3 storage access configuration. attr_accessor :aws_detail - # The definition of `TableResultV2DataAttributesFileMetadataOneOfAccessDetailsAzureDetail` object. + # Azure Blob Storage access configuration. attr_accessor :azure_detail - # The definition of `TableResultV2DataAttributesFileMetadataOneOfAccessDetailsGcpDetail` object. + # Google Cloud Platform storage access configuration. attr_accessor :gcp_detail attr_accessor :additional_properties diff --git a/lib/datadog_api_client/v2/models/table_result_v2_data_attributes_file_metadata_one_of_access_details_aws_detail.rb b/lib/datadog_api_client/v2/models/table_result_v2_data_attributes_file_metadata_one_of_access_details_aws_detail.rb index 7f70596dc54..598c181044b 100644 --- a/lib/datadog_api_client/v2/models/table_result_v2_data_attributes_file_metadata_one_of_access_details_aws_detail.rb +++ b/lib/datadog_api_client/v2/models/table_result_v2_data_attributes_file_metadata_one_of_access_details_aws_detail.rb @@ -17,14 +17,14 @@ require 'time' module DatadogAPIClient::V2 - # The definition of `TableResultV2DataAttributesFileMetadataOneOfAccessDetailsAwsDetail` object. + # Amazon Web Services S3 storage access configuration. class TableResultV2DataAttributesFileMetadataOneOfAccessDetailsAwsDetail include BaseGenericModel - # The ID of the AWS account. + # AWS account ID where the S3 bucket is located. attr_accessor :aws_account_id - # The name of the AWS bucket. + # S3 bucket containing the CSV file. attr_accessor :aws_bucket_name # The relative file path from the S3 bucket root to the CSV file. diff --git a/lib/datadog_api_client/v2/models/table_result_v2_data_attributes_file_metadata_one_of_access_details_azure_detail.rb b/lib/datadog_api_client/v2/models/table_result_v2_data_attributes_file_metadata_one_of_access_details_azure_detail.rb index 3f0b1639d9a..7d26832c3d6 100644 --- a/lib/datadog_api_client/v2/models/table_result_v2_data_attributes_file_metadata_one_of_access_details_azure_detail.rb +++ b/lib/datadog_api_client/v2/models/table_result_v2_data_attributes_file_metadata_one_of_access_details_azure_detail.rb @@ -17,20 +17,20 @@ require 'time' module DatadogAPIClient::V2 - # The definition of `TableResultV2DataAttributesFileMetadataOneOfAccessDetailsAzureDetail` object. + # Azure Blob Storage access configuration. class TableResultV2DataAttributesFileMetadataOneOfAccessDetailsAzureDetail include BaseGenericModel - # The Azure client ID. + # Azure service principal (application) client ID with permissions to read from the container. attr_accessor :azure_client_id - # The name of the Azure container. + # Azure Blob Storage container containing the CSV file. attr_accessor :azure_container_name - # The name of the Azure storage account. + # Azure storage account where the container is located. attr_accessor :azure_storage_account_name - # The ID of the Azure tenant. + # Azure Active Directory tenant ID. attr_accessor :azure_tenant_id # The relative file path from the Azure container root to the CSV file. diff --git a/lib/datadog_api_client/v2/models/table_result_v2_data_attributes_file_metadata_one_of_access_details_gcp_detail.rb b/lib/datadog_api_client/v2/models/table_result_v2_data_attributes_file_metadata_one_of_access_details_gcp_detail.rb index 3de02f8240c..4bf56338f62 100644 --- a/lib/datadog_api_client/v2/models/table_result_v2_data_attributes_file_metadata_one_of_access_details_gcp_detail.rb +++ b/lib/datadog_api_client/v2/models/table_result_v2_data_attributes_file_metadata_one_of_access_details_gcp_detail.rb @@ -17,20 +17,20 @@ require 'time' module DatadogAPIClient::V2 - # The definition of `TableResultV2DataAttributesFileMetadataOneOfAccessDetailsGcpDetail` object. + # Google Cloud Platform storage access configuration. class TableResultV2DataAttributesFileMetadataOneOfAccessDetailsGcpDetail include BaseGenericModel # The relative file path from the GCS bucket root to the CSV file. attr_accessor :file_path - # The name of the GCP bucket. + # GCP bucket containing the CSV file. attr_accessor :gcp_bucket_name - # The ID of the GCP project. + # GCP project ID where the bucket is located. attr_accessor :gcp_project_id - # The email of the GCP service account. + # Service account email with read permissions for the GCS bucket. attr_accessor :gcp_service_account_email attr_accessor :additional_properties diff --git a/lib/datadog_api_client/v2/models/table_result_v2_data_attributes_schema.rb b/lib/datadog_api_client/v2/models/table_result_v2_data_attributes_schema.rb index 8deb8d18870..fb57e87b387 100644 --- a/lib/datadog_api_client/v2/models/table_result_v2_data_attributes_schema.rb +++ b/lib/datadog_api_client/v2/models/table_result_v2_data_attributes_schema.rb @@ -17,11 +17,11 @@ require 'time' module DatadogAPIClient::V2 - # The definition of `TableResultV2DataAttributesSchema` object. + # Schema defining the structure and columns of the reference table. class TableResultV2DataAttributesSchema include BaseGenericModel - # The `schema` `fields`. + # The schema fields. attr_reader :fields # List of field names that serve as primary keys for the table. Only one primary key is supported, and it is used as an ID to retrieve rows. diff --git a/lib/datadog_api_client/v2/models/table_result_v2_data_attributes_schema_fields_items.rb b/lib/datadog_api_client/v2/models/table_result_v2_data_attributes_schema_fields_items.rb index 538ec6a487e..fe71952969e 100644 --- a/lib/datadog_api_client/v2/models/table_result_v2_data_attributes_schema_fields_items.rb +++ b/lib/datadog_api_client/v2/models/table_result_v2_data_attributes_schema_fields_items.rb @@ -17,7 +17,7 @@ require 'time' module DatadogAPIClient::V2 - # The definition of `TableResultV2DataAttributesSchemaFieldsItems` object. + # A single field (column) in the reference table schema to be returned. class TableResultV2DataAttributesSchemaFieldsItems include BaseGenericModel diff --git a/lib/datadog_api_client/v2/models/table_row_resource_array.rb b/lib/datadog_api_client/v2/models/table_row_resource_array.rb index c27dc8ae9d6..723a927a094 100644 --- a/lib/datadog_api_client/v2/models/table_row_resource_array.rb +++ b/lib/datadog_api_client/v2/models/table_row_resource_array.rb @@ -17,7 +17,7 @@ require 'time' module DatadogAPIClient::V2 - # The definition of `TableRowResourceArray` object. + # List of rows from a reference table query. class TableRowResourceArray include BaseGenericModel diff --git a/lib/datadog_api_client/v2/models/table_row_resource_data.rb b/lib/datadog_api_client/v2/models/table_row_resource_data.rb index 8941378a12c..f585a23b9a7 100644 --- a/lib/datadog_api_client/v2/models/table_row_resource_data.rb +++ b/lib/datadog_api_client/v2/models/table_row_resource_data.rb @@ -17,21 +17,19 @@ require 'time' module DatadogAPIClient::V2 - # The definition of `TableRowResourceData` object. + # The data object containing the row column names and values. class TableRowResourceData include BaseGenericModel - # The definition of `TableRowResourceDataAttributes` object. + # Column values for this row in the reference table. attr_accessor :attributes - # The ID of the row. + # Row identifier, corresponding to the primary key value. attr_accessor :id # Row resource type. attr_reader :type - attr_accessor :additional_properties - # Attribute mapping from ruby-style variable name to JSON key. # @!visibility private def self.attribute_map @@ -60,14 +58,12 @@ def initialize(attributes = {}) fail ArgumentError, "The input argument (attributes) must be a hash in `DatadogAPIClient::V2::TableRowResourceData` initialize method" end - self.additional_properties = {} # check to see if the attribute exists and convert string to symbol for hash key attributes = attributes.each_with_object({}) { |(k, v), h| if (!self.class.attribute_map.key?(k.to_sym)) - self.additional_properties[k.to_sym] = v - else - h[k.to_sym] = v + fail ArgumentError, "`#{k}` is not a valid attribute in `DatadogAPIClient::V2::TableRowResourceData`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect end + h[k.to_sym] = v } if attributes.key?(:'attributes') @@ -101,26 +97,6 @@ def type=(type) @type = type end - # Returns the object in the form of hash, with additionalProperties support. - # @return [Hash] Returns the object in the form of hash - # @!visibility private - def to_hash - hash = {} - self.class.attribute_map.each_pair do |attr, param| - value = self.send(attr) - if value.nil? - is_nullable = self.class.openapi_nullable.include?(attr) - next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}")) - end - - hash[param] = _to_hash(value) - end - self.additional_properties.each_pair do |attr, value| - hash[attr] = value - end - hash - end - # Checks equality by comparing each attribute. # @param o [Object] Object to be compared # @!visibility private @@ -129,15 +105,14 @@ def ==(o) self.class == o.class && attributes == o.attributes && id == o.id && - type == o.type && - additional_properties == o.additional_properties + type == o.type end # Calculates hash code according to all attributes. # @return [Integer] Hash code # @!visibility private def hash - [attributes, id, type, additional_properties].hash + [attributes, id, type].hash end end end diff --git a/lib/datadog_api_client/v2/models/table_row_resource_data_attributes.rb b/lib/datadog_api_client/v2/models/table_row_resource_data_attributes.rb index 005e25ae3e4..977ca91325f 100644 --- a/lib/datadog_api_client/v2/models/table_row_resource_data_attributes.rb +++ b/lib/datadog_api_client/v2/models/table_row_resource_data_attributes.rb @@ -17,15 +17,13 @@ require 'time' module DatadogAPIClient::V2 - # The definition of `TableRowResourceDataAttributes` object. + # Column values for this row in the reference table. class TableRowResourceDataAttributes include BaseGenericModel - # The values of the row. + # Key-value pairs representing the row data, where keys are field names from the schema. attr_accessor :values - attr_accessor :additional_properties - # Attribute mapping from ruby-style variable name to JSON key. # @!visibility private def self.attribute_map @@ -38,7 +36,7 @@ def self.attribute_map # @!visibility private def self.openapi_types { - :'values' => :'Hash' + :'values' => :'Object' } end @@ -50,14 +48,12 @@ def initialize(attributes = {}) fail ArgumentError, "The input argument (attributes) must be a hash in `DatadogAPIClient::V2::TableRowResourceDataAttributes` initialize method" end - self.additional_properties = {} # check to see if the attribute exists and convert string to symbol for hash key attributes = attributes.each_with_object({}) { |(k, v), h| if (!self.class.attribute_map.key?(k.to_sym)) - self.additional_properties[k.to_sym] = v - else - h[k.to_sym] = v + fail ArgumentError, "`#{k}` is not a valid attribute in `DatadogAPIClient::V2::TableRowResourceDataAttributes`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect end + h[k.to_sym] = v } if attributes.key?(:'values') @@ -65,41 +61,20 @@ def initialize(attributes = {}) end end - # Returns the object in the form of hash, with additionalProperties support. - # @return [Hash] Returns the object in the form of hash - # @!visibility private - def to_hash - hash = {} - self.class.attribute_map.each_pair do |attr, param| - value = self.send(attr) - if value.nil? - is_nullable = self.class.openapi_nullable.include?(attr) - next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}")) - end - - hash[param] = _to_hash(value) - end - self.additional_properties.each_pair do |attr, value| - hash[attr] = value - end - hash - end - # Checks equality by comparing each attribute. # @param o [Object] Object to be compared # @!visibility private def ==(o) return true if self.equal?(o) self.class == o.class && - values == o.values && - additional_properties == o.additional_properties + values == o.values end # Calculates hash code according to all attributes. # @return [Integer] Hash code # @!visibility private def hash - [values, additional_properties].hash + [values].hash end end end