Skip to content

datacatalog.v1alpha1.dataCatalogEntry

Index

Fields

fn new

new(name)

new returns an instance of DataCatalogEntry

obj metadata

"ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create."

fn metadata.withAnnotations

withAnnotations(annotations)

"Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations"

fn metadata.withAnnotationsMixin

withAnnotationsMixin(annotations)

"Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations"

Note: This function appends passed data to existing values

fn metadata.withClusterName

withClusterName(clusterName)

"The name of the cluster which the object belongs to. This is used to distinguish resources with same name and namespace in different clusters. This field is not set anywhere right now and apiserver is going to ignore it if set in create or update request."

fn metadata.withCreationTimestamp

withCreationTimestamp(creationTimestamp)

"Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers."

fn metadata.withDeletionGracePeriodSeconds

withDeletionGracePeriodSeconds(deletionGracePeriodSeconds)

"Number of seconds allowed for this object to gracefully terminate before it will be removed from the system. Only set when deletionTimestamp is also set. May only be shortened. Read-only."

fn metadata.withDeletionTimestamp

withDeletionTimestamp(deletionTimestamp)

"Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers."

fn metadata.withFinalizers

withFinalizers(finalizers)

"Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list."

fn metadata.withFinalizersMixin

withFinalizersMixin(finalizers)

"Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list."

Note: This function appends passed data to existing values

fn metadata.withGenerateName

withGenerateName(generateName)

"GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. The provided value has the same validation rules as the Name field, and may be truncated by the length of the suffix required to make the value unique on the server.\n\nIf this field is specified and the generated name exists, the server will NOT return a 409 - instead, it will either return 201 Created or 500 with Reason ServerTimeout indicating a unique name could not be found in the time allotted, and the client should retry (optionally after the time indicated in the Retry-After header).\n\nApplied only if Name is not specified. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency"

fn metadata.withGeneration

withGeneration(generation)

"A sequence number representing a specific generation of the desired state. Populated by the system. Read-only."

fn metadata.withLabels

withLabels(labels)

"Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels"

fn metadata.withLabelsMixin

withLabelsMixin(labels)

"Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels"

Note: This function appends passed data to existing values

fn metadata.withName

withName(name)

"Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/identifiers#names"

fn metadata.withNamespace

withNamespace(namespace)

"Namespace defines the space within which each name must be unique. An empty namespace is equivalent to the \"default\" namespace, but \"default\" is the canonical representation. Not all objects are required to be scoped to a namespace - the value of this field for those objects will be empty.\n\nMust be a DNS_LABEL. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/namespaces"

fn metadata.withOwnerReferences

withOwnerReferences(ownerReferences)

"List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller."

fn metadata.withOwnerReferencesMixin

withOwnerReferencesMixin(ownerReferences)

"List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller."

Note: This function appends passed data to existing values

fn metadata.withResourceVersion

withResourceVersion(resourceVersion)

"An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources.\n\nPopulated by the system. Read-only. Value must be treated as opaque by clients and . More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency"

withSelfLink(selfLink)

"SelfLink is a URL representing this object. Populated by the system. Read-only.\n\nDEPRECATED Kubernetes will stop propagating this field in 1.20 release and the field is planned to be removed in 1.21 release."

fn metadata.withUid

withUid(uid)

"UID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations.\n\nPopulated by the system. Read-only. More info: http://kubernetes.io/docs/user-guide/identifiers#uids"

obj spec

fn spec.withDescription

withDescription(description)

"Entry description, which can consist of several sentences or paragraphs that describe entry contents."

fn spec.withDisplayName

withDisplayName(displayName)

"Display information such as title and description. A short name to identify the entry,\nfor example, \"Analytics Data - Jan 2011\"."

fn spec.withEntryGroup

withEntryGroup(entryGroup)

"Immutable. The name of the entry group this entry is in."

fn spec.withEntryId

withEntryId(entryId)

"Immutable. The id of the entry to create."

fn spec.withLinkedResource

withLinkedResource(linkedResource)

"The resource this metadata entry refers to.\nFor Google Cloud Platform resources, linkedResource is the full name of the resource.\nFor example, the linkedResource for a table resource from BigQuery is:\n//bigquery.googleapis.com/projects/projectId/datasets/datasetId/tables/tableId\nOutput only when Entry is of type in the EntryType enum. For entries with userSpecifiedType,\nthis field is optional and defaults to an empty string."

fn spec.withResourceID

withResourceID(resourceID)

"Immutable. Optional. The service-generated name of the resource. Used for acquisition only. Leave unset to create a new resource."

fn spec.withSchema

withSchema(schema)

"Schema of the entry (e.g. BigQuery, GoogleSQL, Avro schema), as a json string. An entry might not have any schema\nattached to it. See\nhttps://cloud.google.com/data-catalog/docs/reference/rest/v1/projects.locations.entryGroups.entries#schema\nfor what fields this schema can contain."

fn spec.withType

withType(type)

"Immutable. The type of the entry. Only used for Entries with types in the EntryType enum.\nCurrently, only FILESET enum value is allowed. All other entries created through Data Catalog must use userSpecifiedType. Possible values: [\"FILESET\"]."

fn spec.withUserSpecifiedSystem

withUserSpecifiedSystem(userSpecifiedSystem)

"This field indicates the entry's source system that Data Catalog does not integrate with.\nuserSpecifiedSystem strings must begin with a letter or underscore and can only contain letters, numbers,\nand underscores; are case insensitive; must be at least 1 character and at most 64 characters long."

fn spec.withUserSpecifiedType

withUserSpecifiedType(userSpecifiedType)

"Entry type if it does not fit any of the input-allowed values listed in EntryType enum above.\nWhen creating an entry, users should check the enum values first, if nothing matches the entry\nto be created, then provide a custom value, for example \"my_special_type\".\nuserSpecifiedType strings must begin with a letter or underscore and can only contain letters,\nnumbers, and underscores; are case insensitive; must be at least 1 character and at most 64 characters long."

obj spec.gcsFilesetSpec

"Specification that applies to a Cloud Storage fileset. This is only valid on entries of type FILESET."

fn spec.gcsFilesetSpec.withFilePatterns

withFilePatterns(filePatterns)

"Patterns to identify a set of files in Google Cloud Storage.\nSee Cloud Storage documentation\nfor more information. Note that bucket wildcards are currently not supported. Examples of valid filePatterns:\n\n gs://bucket_name/dir/: matches all files within bucket_name/dir directory.\n gs://bucket_name/dir/: matches all files in bucket_name/dir spanning all subdirectories.\n gs://bucket_name/file: matches files prefixed by file in bucket_name\n gs://bucket_name/??.txt: matches files with two characters followed by .txt in bucket_name\n gs://bucket_name/[aeiou].txt: matches files that contain a single vowel character followed by .txt in bucket_name\n gs://bucket_name/[a-m].txt: matches files that contain a, b, ... or m followed by .txt in bucket_name\n gs://bucket_name/a//b: matches all files in bucket_name that match a//b pattern, such as a/c/b, a/d/b\n gs://another_bucket/a.txt: matches gs://another_bucket/a.txt."

fn spec.gcsFilesetSpec.withFilePatternsMixin

withFilePatternsMixin(filePatterns)

"Patterns to identify a set of files in Google Cloud Storage.\nSee Cloud Storage documentation\nfor more information. Note that bucket wildcards are currently not supported. Examples of valid filePatterns:\n\n gs://bucket_name/dir/: matches all files within bucket_name/dir directory.\n gs://bucket_name/dir/: matches all files in bucket_name/dir spanning all subdirectories.\n gs://bucket_name/file: matches files prefixed by file in bucket_name\n gs://bucket_name/??.txt: matches files with two characters followed by .txt in bucket_name\n gs://bucket_name/[aeiou].txt: matches files that contain a single vowel character followed by .txt in bucket_name\n gs://bucket_name/[a-m].txt: matches files that contain a, b, ... or m followed by .txt in bucket_name\n gs://bucket_name/a//b: matches all files in bucket_name that match a//b pattern, such as a/c/b, a/d/b\n gs://another_bucket/a.txt: matches gs://another_bucket/a.txt."

Note: This function appends passed data to existing values

fn spec.gcsFilesetSpec.withSampleGcsFileSpecs

withSampleGcsFileSpecs(sampleGcsFileSpecs)

"Sample files contained in this fileset, not all files contained in this fileset are represented here."

fn spec.gcsFilesetSpec.withSampleGcsFileSpecsMixin

withSampleGcsFileSpecsMixin(sampleGcsFileSpecs)

"Sample files contained in this fileset, not all files contained in this fileset are represented here."

Note: This function appends passed data to existing values

obj spec.gcsFilesetSpec.sampleGcsFileSpecs

"Sample files contained in this fileset, not all files contained in this fileset are represented here."

fn spec.gcsFilesetSpec.sampleGcsFileSpecs.withFilePath

withFilePath(filePath)

"The full file path."

fn spec.gcsFilesetSpec.sampleGcsFileSpecs.withSizeBytes

withSizeBytes(sizeBytes)

"The size of the file, in bytes."