discoveryenginedatastore_v1alpha1.json

{
  "description": "DiscoveryEngineDataStore is the Schema for the DiscoveryEngineDataStore API",
  "properties": {
    "apiVersion": {
      "description": "APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources",
      "type": "string"
    },
    "kind": {
      "description": "Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds",
      "type": "string"
    },
    "metadata": {
      "type": "object"
    },
    "spec": {
      "description": "DiscoveryEngineDataStoreSpec defines the desired state of DiscoveryEngineDataStore",
      "properties": {
        "collection": {
          "description": "Immutable. The collection for the DataStore.",
          "type": "string",
          "x-kubernetes-validations": [
            {
              "message": "Collection field is immutable",
              "rule": "self == oldSelf"
            }
          ]
        },
        "contentConfig": {
          "description": "Immutable. The content config of the data store. If this field is unset, the server behavior defaults to [ContentConfig.NO_CONTENT][google.cloud.discoveryengine.v1.DataStore.ContentConfig.NO_CONTENT].",
          "type": "string"
        },
        "displayName": {
          "description": "Required. The data store display name.\n\nThis field must be a UTF-8 encoded string with a length limit of 128\ncharacters. Otherwise, an INVALID_ARGUMENT error is returned.",
          "type": "string"
        },
        "industryVertical": {
          "description": "Immutable. The industry vertical that the data store registers.",
          "type": "string"
        },
        "location": {
          "description": "Immutable. The location for the resource.",
          "type": "string",
          "x-kubernetes-validations": [
            {
              "message": "Location field is immutable",
              "rule": "self == oldSelf"
            }
          ]
        },
        "projectRef": {
          "description": "The ID of the project in which the resource belongs.",
          "oneOf": [
            {
              "not": {
                "required": [
                  "external"
                ]
              },
              "required": [
                "name"
              ]
            },
            {
              "not": {
                "anyOf": [
                  {
                    "required": [
                      "name"
                    ]
                  },
                  {
                    "required": [
                      "namespace"
                    ]
                  }
                ]
              },
              "required": [
                "external"
              ]
            }
          ],
          "properties": {
            "external": {
              "description": "The `projectID` field of a project, when not managed by Config Connector.",
              "type": "string"
            },
            "kind": {
              "description": "The kind of the Project resource; optional but must be `Project` if provided.",
              "type": "string"
            },
            "name": {
              "description": "The `name` field of a `Project` resource.",
              "type": "string"
            },
            "namespace": {
              "description": "The `namespace` field of a `Project` resource.",
              "type": "string"
            }
          },
          "type": "object",
          "additionalProperties": false
        },
        "resourceID": {
          "description": "Immutable. The DiscoveryEngineDataStore name. If not given, the metadata.name will be used.",
          "type": "string",
          "x-kubernetes-validations": [
            {
              "message": "ResourceID field is immutable",
              "rule": "self == oldSelf"
            }
          ]
        },
        "solutionTypes": {
          "description": "The solutions that the data store enrolls. Available solutions for each\n[industry_vertical][google.cloud.discoveryengine.v1.DataStore.industry_vertical]:\n\n* `MEDIA`: `SOLUTION_TYPE_RECOMMENDATION` and `SOLUTION_TYPE_SEARCH`.\n* `SITE_SEARCH`: `SOLUTION_TYPE_SEARCH` is automatically enrolled. Other\n  solutions cannot be enrolled.",
          "items": {
            "type": "string"
          },
          "type": "array"
        },
        "workspaceConfig": {
          "description": "Config to store data store type configuration for workspace data. This must be set when [DataStore.content_config][google.cloud.discoveryengine.v1.DataStore.content_config] is set as [DataStore.ContentConfig.GOOGLE_WORKSPACE][google.cloud.discoveryengine.v1.DataStore.ContentConfig.GOOGLE_WORKSPACE].",
          "properties": {
            "dasherCustomerID": {
              "description": "Obfuscated Dasher customer ID.",
              "type": "string"
            },
            "superAdminEmailAddress": {
              "description": "Optional. The super admin email address for the workspace that will be used for access token generation. For now we only use it for Native Google Drive connector data ingestion.",
              "type": "string"
            },
            "superAdminServiceAccount": {
              "description": "Optional. The super admin service account for the workspace that will be used for access token generation. For now we only use it for Native Google Drive connector data ingestion.",
              "type": "string"
            },
            "type": {
              "description": "The Google Workspace data source.",
              "type": "string"
            }
          },
          "type": "object",
          "additionalProperties": false
        }
      },
      "required": [
        "collection",
        "location",
        "projectRef"
      ],
      "type": "object",
      "additionalProperties": false
    },
    "status": {
      "description": "DiscoveryEngineDataStoreStatus defines the config connector machine state of DiscoveryEngineDataStore",
      "properties": {
        "conditions": {
          "description": "Conditions represent the latest available observations of the object's current state.",
          "items": {
            "properties": {
              "lastTransitionTime": {
                "description": "Last time the condition transitioned from one status to another.",
                "type": "string"
              },
              "message": {
                "description": "Human-readable message indicating details about last transition.",
                "type": "string"
              },
              "reason": {
                "description": "Unique, one-word, CamelCase reason for the condition's last transition.",
                "type": "string"
              },
              "status": {
                "description": "Status is the status of the condition. Can be True, False, Unknown.",
                "type": "string"
              },
              "type": {
                "description": "Type is the type of the condition.",
                "type": "string"
              }
            },
            "type": "object",
            "additionalProperties": false
          },
          "type": "array"
        },
        "externalRef": {
          "description": "A unique specifier for the DiscoveryEngineDataStore resource in GCP.",
          "type": "string"
        },
        "observedGeneration": {
          "description": "ObservedGeneration is the generation of the resource that was most recently observed by the Config Connector controller. If this is equal to metadata.generation, then that means that the current reported status reflects the most recent desired state of the resource.",
          "format": "int64",
          "type": "integer"
        },
        "observedState": {
          "description": "ObservedState is the state of the resource as most recently observed in GCP.",
          "properties": {
            "billingEstimation": {
              "description": "Output only. Data size estimation for billing.",
              "properties": {
                "structuredDataSize": {
                  "description": "Data size for structured data in terms of bytes.",
                  "format": "int64",
                  "type": "integer"
                },
                "structuredDataUpdateTime": {
                  "description": "Last updated timestamp for structured data.",
                  "type": "string"
                },
                "unstructuredDataSize": {
                  "description": "Data size for unstructured data in terms of bytes.",
                  "format": "int64",
                  "type": "integer"
                },
                "unstructuredDataUpdateTime": {
                  "description": "Last updated timestamp for unstructured data.",
                  "type": "string"
                },
                "websiteDataSize": {
                  "description": "Data size for websites in terms of bytes.",
                  "format": "int64",
                  "type": "integer"
                },
                "websiteDataUpdateTime": {
                  "description": "Last updated timestamp for websites.",
                  "type": "string"
                }
              },
              "type": "object",
              "additionalProperties": false
            },
            "createTime": {
              "description": "Output only. Timestamp the [DataStore][google.cloud.discoveryengine.v1.DataStore] was created at.",
              "type": "string"
            },
            "defaultSchemaID": {
              "description": "Output only. The id of the default [Schema][google.cloud.discoveryengine.v1.Schema] asscociated to this data store.",
              "type": "string"
            }
          },
          "type": "object",
          "additionalProperties": false
        }
      },
      "type": "object",
      "additionalProperties": false
    }
  },
  "required": [
    "spec"
  ],
  "type": "object"
}