Skip to content

bigqueryanalyticshub.v1alpha1.bigQueryAnalyticsHubListing

"BigQueryAnalyticsHubListing is the Schema for the BigQueryAnalyticsHubListing API"

Index

Fields

fn new

new(name)

new returns an instance of BigQueryAnalyticsHubListing

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

"BigQueryAnalyticsHubListingSpec defines the desired state of BigQueryAnalyticsHubDataExchangeListing"

fn spec.withCategories

withCategories(categories)

"Optional. Categories of the listing. Up to two categories are allowed."

fn spec.withCategoriesMixin

withCategoriesMixin(categories)

"Optional. Categories of the listing. Up to two categories are allowed."

Note: This function appends passed data to existing values

fn spec.withDescription

withDescription(description)

"Optional. Short description of the listing. The description must contain only Unicode characters or tabs (HT), new lines (LF), carriage returns (CR), and page breaks (FF). Default value is an empty string. Max length: 2000 bytes."

fn spec.withDiscoveryType

withDiscoveryType(discoveryType)

"Optional. Type of discovery of the listing on the discovery page."

fn spec.withDisplayName

withDisplayName(displayName)

"Required. Human-readable display name of the listing. The display name must contain only Unicode letters, numbers (0-9), underscores (_), dashes (-), spaces ( ), ampersands (&) and can't start or end with spaces. Default value is an empty string. Max length: 63 bytes."

fn spec.withDocumentation

withDocumentation(documentation)

"Optional. Documentation describing the listing."

fn spec.withLocation

withLocation(location)

"Immutable. The name of the location this data exchange."

fn spec.withPrimaryContact

withPrimaryContact(primaryContact)

"Optional. Email or URL of the primary point of contact of the listing. Max Length: 1000 bytes."

fn spec.withRequestAccess

withRequestAccess(requestAccess)

"Optional. Email or URL of the request access of the listing. Subscribers can use this reference to request access. Max Length: 1000 bytes."

fn spec.withResourceID

withResourceID(resourceID)

"Immutable. The BigQueryAnalyticsHubDataExchangeListing name. If not given, the metadata.name will be used."

obj spec.dataExchangeRef

fn spec.dataExchangeRef.withExternal

withExternal(external)

"The DataExchange selfLink, when not managed by Config Connector."

fn spec.dataExchangeRef.withName

withName(name)

"The name field of a DataExchange resource."

fn spec.dataExchangeRef.withNamespace

withNamespace(namespace)

"The namespace field of a DataExchange resource."

obj spec.dataProvider

"Optional. Details of the data provider who owns the source data."

fn spec.dataProvider.withName

withName(name)

"Optional. Name of the data provider."

fn spec.dataProvider.withPrimaryContact

withPrimaryContact(primaryContact)

"Optional. Email or URL of the data provider. Max Length: 1000 bytes."

obj spec.projectRef

"The Project that this resource belongs to."

fn spec.projectRef.withExternal

withExternal(external)

"The projectID field of a project, when not managed by Config Connector."

fn spec.projectRef.withKind

withKind(kind)

"The kind of the Project resource; optional but must be Project if provided."

fn spec.projectRef.withName

withName(name)

"The name field of a Project resource."

fn spec.projectRef.withNamespace

withNamespace(namespace)

"The namespace field of a Project resource."

obj spec.publisher

"Optional. Details of the publisher who owns the listing and who can share the source data."

fn spec.publisher.withName

withName(name)

"Optional. Name of the listing publisher."

fn spec.publisher.withPrimaryContact

withPrimaryContact(primaryContact)

"Optional. Email or URL of the listing publisher. Max Length: 1000 bytes."

obj spec.source

obj spec.source.bigQueryDatasetSource

"One of the following fields must be set."

fn spec.source.bigQueryDatasetSource.withSelectedResources

withSelectedResources(selectedResources)

"Optional. Resources in this dataset that are selectively shared. If this field is empty, then the entire dataset (all resources) are shared. This field is only valid for data clean room exchanges."

fn spec.source.bigQueryDatasetSource.withSelectedResourcesMixin

withSelectedResourcesMixin(selectedResources)

"Optional. Resources in this dataset that are selectively shared. If this field is empty, then the entire dataset (all resources) are shared. This field is only valid for data clean room exchanges."

Note: This function appends passed data to existing values

obj spec.source.bigQueryDatasetSource.datasetRef

"Resource name of the dataset source for this listing. e.g. projects/myproject/datasets/123"

fn spec.source.bigQueryDatasetSource.datasetRef.withExternal

withExternal(external)

"If provided must be in the format projects/[project_id]/datasets/[dataset_id]."

fn spec.source.bigQueryDatasetSource.datasetRef.withName

withName(name)

"The metadata.name field of a BigQueryDataset resource."

fn spec.source.bigQueryDatasetSource.datasetRef.withNamespace

withNamespace(namespace)

"The metadata.namespace field of a BigQueryDataset resource."

obj spec.source.bigQueryDatasetSource.restrictedExportPolicy

"Optional. If set, restricted export policy will be propagated and enforced on the linked dataset."

obj spec.source.bigQueryDatasetSource.restrictedExportPolicy.enabled

"Optional. If true, enable restricted export."

fn spec.source.bigQueryDatasetSource.restrictedExportPolicy.enabled.withValue

withValue(value)

"The bool value."

obj spec.source.bigQueryDatasetSource.restrictedExportPolicy.restrictDirectTableAccess

"Optional. If true, restrict direct table access (read api/tabledata.list) on linked table."

fn spec.source.bigQueryDatasetSource.restrictedExportPolicy.restrictDirectTableAccess.withValue

withValue(value)

"The bool value."

obj spec.source.bigQueryDatasetSource.restrictedExportPolicy.restrictQueryResult

"Optional. If true, restrict export of query result derived from restricted linked dataset table."

fn spec.source.bigQueryDatasetSource.restrictedExportPolicy.restrictQueryResult.withValue

withValue(value)

"The bool value."

obj spec.source.bigQueryDatasetSource.selectedResources

"Optional. Resources in this dataset that are selectively shared. If this field is empty, then the entire dataset (all resources) are shared. This field is only valid for data clean room exchanges."

fn spec.source.bigQueryDatasetSource.selectedResources.withTable

withTable(table)

"Optional. Format: For table: projects/{projectId}/datasets/{datasetId}/tables/{tableId} Example:\"projects/test_project/datasets/test_dataset/tables/test_table\