Represents a Listing.
Package
@google-cloud/bigquery-analyticshubConstructors
(constructor)(properties)
constructor(properties?: google.cloud.bigquery.analyticshub.v1.IListing);Constructs a new Listing.
| Parameter | |
|---|---|
| Name | Description |
properties |
IListing
Properties to set |
Properties
bigqueryDataset
public bigqueryDataset?: (google.cloud.bigquery.analyticshub.v1.Listing.IBigQueryDatasetSource|null);Listing bigqueryDataset.
categories
public categories: google.cloud.bigquery.analyticshub.v1.Listing.Category[];Listing categories.
dataProvider
public dataProvider?: (google.cloud.bigquery.analyticshub.v1.IDataProvider|null);Listing dataProvider.
description
public description: string;Listing description.
displayName
public displayName: string;Listing displayName.
documentation
public documentation: string;Listing documentation.
icon
public icon: (Uint8Array|string);Listing icon.
name
public name: string;Listing name.
primaryContact
public primaryContact: string;Listing primaryContact.
publisher
public publisher?: (google.cloud.bigquery.analyticshub.v1.IPublisher|null);Listing publisher.
requestAccess
public requestAccess: string;Listing requestAccess.
restrictedExportConfig
public restrictedExportConfig?: (google.cloud.bigquery.analyticshub.v1.Listing.IRestrictedExportConfig|null);Listing restrictedExportConfig.
source
public source?: "bigqueryDataset";Listing source.
state
public state: (google.cloud.bigquery.analyticshub.v1.Listing.State|keyof typeof google.cloud.bigquery.analyticshub.v1.Listing.State);Listing state.
Methods
create(properties)
public static create(properties?: google.cloud.bigquery.analyticshub.v1.IListing): google.cloud.bigquery.analyticshub.v1.Listing;Creates a new Listing instance using the specified properties.
| Parameter | |
|---|---|
| Name | Description |
properties |
IListing
Properties to set |
| Returns | |
|---|---|
| Type | Description |
Listing | Listing instance |
decode(reader, length)
public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.bigquery.analyticshub.v1.Listing;Decodes a Listing message from the specified reader or buffer.
| Parameters | |
|---|---|
| Name | Description |
reader |
(Reader|Uint8Array)
Reader or buffer to decode from |
length |
number
Message length if known beforehand |
| Returns | |
|---|---|
| Type | Description |
Listing | Listing |
decodeDelimited(reader)
public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.bigquery.analyticshub.v1.Listing;Decodes a Listing message from the specified reader or buffer, length delimited.
| Parameter | |
|---|---|
| Name | Description |
reader |
(Reader|Uint8Array)
Reader or buffer to decode from |
| Returns | |
|---|---|
| Type | Description |
Listing | Listing |
encode(message, writer)
public static encode(message: google.cloud.bigquery.analyticshub.v1.IListing, writer?: $protobuf.Writer): $protobuf.Writer;Encodes the specified Listing message. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message |
IListing
Listing message or plain object to encode |
writer |
$protobuf.Writer
Writer to encode to |
| Returns | |
|---|---|
| Type | Description |
$protobuf.Writer | Writer |
encodeDelimited(message, writer)
public static encodeDelimited(message: google.cloud.bigquery.analyticshub.v1.IListing, writer?: $protobuf.Writer): $protobuf.Writer;Encodes the specified Listing message, length delimited. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message |
IListing
Listing message or plain object to encode |
writer |
$protobuf.Writer
Writer to encode to |
| Returns | |
|---|---|
| Type | Description |
$protobuf.Writer | Writer |
fromObject(object)
public static fromObject(object: { [k: string]: any }): google.cloud.bigquery.analyticshub.v1.Listing;Creates a Listing message from a plain object. Also converts values to their respective internal types.
| Parameter | |
|---|---|
| Name | Description |
object |
{ [k: string]: any }
Plain object |
| Returns | |
|---|---|
| Type | Description |
Listing | Listing |
getTypeUrl(typeUrlPrefix)
public static getTypeUrl(typeUrlPrefix?: string): string;Gets the default type url for Listing
| Parameter | |
|---|---|
| Name | Description |
typeUrlPrefix |
string
your custom typeUrlPrefix(default "type.googleapis.com") |
| Returns | |
|---|---|
| Type | Description |
string | The default type url |
toJSON()
public toJSON(): { [k: string]: any };Converts this Listing to JSON.
| Returns | |
|---|---|
| Type | Description |
{ [k: string]: any } | JSON object |
toObject(message, options)
public static toObject(message: google.cloud.bigquery.analyticshub.v1.Listing, options?: $protobuf.IConversionOptions): { [k: string]: any };Creates a plain object from a Listing message. Also converts values to other types if specified.
| Parameters | |
|---|---|
| Name | Description |
message |
Listing
Listing |
options |
$protobuf.IConversionOptions
Conversion options |
| Returns | |
|---|---|
| Type | Description |
{ [k: string]: any } | Plain object |
verify(message)
public static verify(message: { [k: string]: any }): (string|null);Verifies a Listing message.
| Parameter | |
|---|---|
| Name | Description |
message |
{ [k: string]: any }
Plain object to verify |
| Returns | |
|---|---|
| Type | Description |
(string|null) |
|