...

Text file src/github.com/GoogleCloudPlatform/k8s-config-connector/crds/datacatalog_v1alpha1_datacatalogentry.yaml

Documentation: github.com/GoogleCloudPlatform/k8s-config-connector/crds

     1# Copyright 2020 Google LLC
     2#
     3# Licensed under the Apache License, Version 2.0 (the "License");
     4# you may not use this file except in compliance with the License.
     5# You may obtain a copy of the License at
     6#
     7#     http://www.apache.org/licenses/LICENSE-2.0
     8#
     9# Unless required by applicable law or agreed to in writing, software
    10# distributed under the License is distributed on an "AS IS" BASIS,
    11# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    12# See the License for the specific language governing permissions and
    13# limitations under the License.
    14
    15apiVersion: apiextensions.k8s.io/v1
    16kind: CustomResourceDefinition
    17metadata:
    18  annotations:
    19    cnrm.cloud.google.com/version: 1.106.0
    20  creationTimestamp: null
    21  labels:
    22    cnrm.cloud.google.com/managed-by-kcc: "true"
    23    cnrm.cloud.google.com/stability-level: alpha
    24    cnrm.cloud.google.com/system: "true"
    25    cnrm.cloud.google.com/tf2crd: "true"
    26  name: datacatalogentries.datacatalog.cnrm.cloud.google.com
    27spec:
    28  group: datacatalog.cnrm.cloud.google.com
    29  names:
    30    categories:
    31    - gcp
    32    kind: DataCatalogEntry
    33    plural: datacatalogentries
    34    shortNames:
    35    - gcpdatacatalogentry
    36    - gcpdatacatalogentries
    37    singular: datacatalogentry
    38  scope: Namespaced
    39  versions:
    40  - additionalPrinterColumns:
    41    - jsonPath: .metadata.creationTimestamp
    42      name: Age
    43      type: date
    44    - description: When 'True', the most recent reconcile of the resource succeeded
    45      jsonPath: .status.conditions[?(@.type=='Ready')].status
    46      name: Ready
    47      type: string
    48    - description: The reason for the value in 'Ready'
    49      jsonPath: .status.conditions[?(@.type=='Ready')].reason
    50      name: Status
    51      type: string
    52    - description: The last transition time for the value in 'Status'
    53      jsonPath: .status.conditions[?(@.type=='Ready')].lastTransitionTime
    54      name: Status Age
    55      type: date
    56    name: v1alpha1
    57    schema:
    58      openAPIV3Schema:
    59        properties:
    60          apiVersion:
    61            description: 'apiVersion defines the versioned schema of this representation
    62              of an object. Servers should convert recognized schemas to the latest
    63              internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources'
    64            type: string
    65          kind:
    66            description: 'kind is a string value representing the REST resource this
    67              object represents. Servers may infer this from the endpoint the client
    68              submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds'
    69            type: string
    70          metadata:
    71            type: object
    72          spec:
    73            properties:
    74              description:
    75                description: Entry description, which can consist of several sentences
    76                  or paragraphs that describe entry contents.
    77                type: string
    78              displayName:
    79                description: |-
    80                  Display information such as title and description. A short name to identify the entry,
    81                  for example, "Analytics Data - Jan 2011".
    82                type: string
    83              entryGroup:
    84                description: Immutable. The name of the entry group this entry is
    85                  in.
    86                type: string
    87              entryId:
    88                description: Immutable. The id of the entry to create.
    89                type: string
    90              gcsFilesetSpec:
    91                description: Specification that applies to a Cloud Storage fileset.
    92                  This is only valid on entries of type FILESET.
    93                properties:
    94                  filePatterns:
    95                    description: |-
    96                      Patterns to identify a set of files in Google Cloud Storage.
    97                      See [Cloud Storage documentation](https://cloud.google.com/storage/docs/gsutil/addlhelp/WildcardNames)
    98                      for more information. Note that bucket wildcards are currently not supported. Examples of valid filePatterns:
    99
   100                      * gs://bucket_name/dir/*: matches all files within bucket_name/dir directory.
   101                      * gs://bucket_name/dir/**: matches all files in bucket_name/dir spanning all subdirectories.
   102                      * gs://bucket_name/file*: matches files prefixed by file in bucket_name
   103                      * gs://bucket_name/??.txt: matches files with two characters followed by .txt in bucket_name
   104                      * gs://bucket_name/[aeiou].txt: matches files that contain a single vowel character followed by .txt in bucket_name
   105                      * gs://bucket_name/[a-m].txt: matches files that contain a, b, ... or m followed by .txt in bucket_name
   106                      * gs://bucket_name/a/*/b: matches all files in bucket_name that match a/*/b pattern, such as a/c/b, a/d/b
   107                      * gs://another_bucket/a.txt: matches gs://another_bucket/a.txt.
   108                    items:
   109                      type: string
   110                    type: array
   111                  sampleGcsFileSpecs:
   112                    description: Sample files contained in this fileset, not all files
   113                      contained in this fileset are represented here.
   114                    items:
   115                      properties:
   116                        filePath:
   117                          description: The full file path.
   118                          type: string
   119                        sizeBytes:
   120                          description: The size of the file, in bytes.
   121                          type: integer
   122                      type: object
   123                    type: array
   124                required:
   125                - filePatterns
   126                type: object
   127              linkedResource:
   128                description: |-
   129                  The resource this metadata entry refers to.
   130                  For Google Cloud Platform resources, linkedResource is the full name of the resource.
   131                  For example, the linkedResource for a table resource from BigQuery is:
   132                  //bigquery.googleapis.com/projects/projectId/datasets/datasetId/tables/tableId
   133                  Output only when Entry is of type in the EntryType enum. For entries with userSpecifiedType,
   134                  this field is optional and defaults to an empty string.
   135                type: string
   136              resourceID:
   137                description: Immutable. Optional. The service-generated name of the
   138                  resource. Used for acquisition only. Leave unset to create a new
   139                  resource.
   140                type: string
   141              schema:
   142                description: |-
   143                  Schema of the entry (e.g. BigQuery, GoogleSQL, Avro schema), as a json string. An entry might not have any schema
   144                  attached to it. See
   145                  https://cloud.google.com/data-catalog/docs/reference/rest/v1/projects.locations.entryGroups.entries#schema
   146                  for what fields this schema can contain.
   147                type: string
   148              type:
   149                description: |-
   150                  Immutable. The type of the entry. Only used for Entries with types in the EntryType enum.
   151                  Currently, only FILESET enum value is allowed. All other entries created through Data Catalog must use userSpecifiedType. Possible values: ["FILESET"].
   152                type: string
   153              userSpecifiedSystem:
   154                description: |-
   155                  This field indicates the entry's source system that Data Catalog does not integrate with.
   156                  userSpecifiedSystem strings must begin with a letter or underscore and can only contain letters, numbers,
   157                  and underscores; are case insensitive; must be at least 1 character and at most 64 characters long.
   158                type: string
   159              userSpecifiedType:
   160                description: |-
   161                  Entry type if it does not fit any of the input-allowed values listed in EntryType enum above.
   162                  When creating an entry, users should check the enum values first, if nothing matches the entry
   163                  to be created, then provide a custom value, for example "my_special_type".
   164                  userSpecifiedType strings must begin with a letter or underscore and can only contain letters,
   165                  numbers, and underscores; are case insensitive; must be at least 1 character and at most 64 characters long.
   166                type: string
   167            required:
   168            - entryGroup
   169            - entryId
   170            type: object
   171          status:
   172            properties:
   173              bigqueryDateShardedSpec:
   174                description: |-
   175                  Specification for a group of BigQuery tables with name pattern [prefix]YYYYMMDD.
   176                  Context: https://cloud.google.com/bigquery/docs/partitioned-tables#partitioning_versus_sharding.
   177                items:
   178                  properties:
   179                    dataset:
   180                      description: |-
   181                        The Data Catalog resource name of the dataset entry the current table belongs to, for example,
   182                        projects/{project_id}/locations/{location}/entrygroups/{entryGroupId}/entries/{entryId}.
   183                      type: string
   184                    shardCount:
   185                      description: Total number of shards.
   186                      type: integer
   187                    tablePrefix:
   188                      description: |-
   189                        The table name prefix of the shards. The name of any given shard is [tablePrefix]YYYYMMDD,
   190                        for example, for shard MyTable20180101, the tablePrefix is MyTable.
   191                      type: string
   192                  type: object
   193                type: array
   194              bigqueryTableSpec:
   195                description: Specification that applies to a BigQuery table. This
   196                  is only valid on entries of type TABLE.
   197                items:
   198                  properties:
   199                    tableSourceType:
   200                      description: The table source type.
   201                      type: string
   202                    tableSpec:
   203                      description: Spec of a BigQuery table. This field should only
   204                        be populated if tableSourceType is BIGQUERY_TABLE.
   205                      items:
   206                        properties:
   207                          groupedEntry:
   208                            description: |-
   209                              If the table is a dated shard, i.e., with name pattern [prefix]YYYYMMDD, groupedEntry is the
   210                              Data Catalog resource name of the date sharded grouped entry, for example,
   211                              projects/{project_id}/locations/{location}/entrygroups/{entryGroupId}/entries/{entryId}.
   212                              Otherwise, groupedEntry is empty.
   213                            type: string
   214                        type: object
   215                      type: array
   216                    viewSpec:
   217                      description: Table view specification. This field should only
   218                        be populated if tableSourceType is BIGQUERY_VIEW.
   219                      items:
   220                        properties:
   221                          viewQuery:
   222                            description: The query that defines the table view.
   223                            type: string
   224                        type: object
   225                      type: array
   226                  type: object
   227                type: array
   228              conditions:
   229                description: Conditions represent the latest available observation
   230                  of the resource's current state.
   231                items:
   232                  properties:
   233                    lastTransitionTime:
   234                      description: Last time the condition transitioned from one status
   235                        to another.
   236                      type: string
   237                    message:
   238                      description: Human-readable message indicating details about
   239                        last transition.
   240                      type: string
   241                    reason:
   242                      description: Unique, one-word, CamelCase reason for the condition's
   243                        last transition.
   244                      type: string
   245                    status:
   246                      description: Status is the status of the condition. Can be True,
   247                        False, Unknown.
   248                      type: string
   249                    type:
   250                      description: Type is the type of the condition.
   251                      type: string
   252                  type: object
   253                type: array
   254              integratedSystem:
   255                description: This field indicates the entry's source system that Data
   256                  Catalog integrates with, such as BigQuery or Pub/Sub.
   257                type: string
   258              name:
   259                description: |-
   260                  The Data Catalog resource name of the entry in URL format.
   261                  Example: projects/{project_id}/locations/{location}/entryGroups/{entryGroupId}/entries/{entryId}.
   262                  Note that this Entry and its child resources may not actually be stored in the location in this name.
   263                type: string
   264              observedGeneration:
   265                description: ObservedGeneration is the generation of the resource
   266                  that was most recently observed by the Config Connector controller.
   267                  If this is equal to metadata.generation, then that means that the
   268                  current reported status reflects the most recent desired state of
   269                  the resource.
   270                type: integer
   271            type: object
   272        required:
   273        - spec
   274        type: object
   275    served: true
   276    storage: true
   277    subresources:
   278      status: {}
   279status:
   280  acceptedNames:
   281    kind: ""
   282    plural: ""
   283  conditions: []
   284  storedVersions: []

View as plain text