Represents a Dataset.
Package
@googlemaps/maps-platform-datasetsConstructors
(constructor)(properties)
constructor(properties?: google.maps.mapsplatformdatasets.v1alpha.IDataset);
Constructs a new Dataset.
Name | Description |
properties |
IDataset
Properties to set |
Properties
createTime
public createTime?: (google.protobuf.ITimestamp|null);
Dataset createTime.
dataSource
public dataSource?: ("localFileSource"|"gcsSource");
Dataset dataSource.
description
public description: string;
Dataset description.
displayName
public displayName: string;
Dataset displayName.
gcsSource
public gcsSource?: (google.maps.mapsplatformdatasets.v1alpha.IGcsSource|null);
Dataset gcsSource.
localFileSource
public localFileSource?: (google.maps.mapsplatformdatasets.v1alpha.ILocalFileSource|null);
Dataset localFileSource.
name
public name: string;
Dataset name.
status
public status: (google.maps.mapsplatformdatasets.v1alpha.State|keyof typeof google.maps.mapsplatformdatasets.v1alpha.State);
Dataset status.
updateTime
public updateTime?: (google.protobuf.ITimestamp|null);
Dataset updateTime.
usage
public usage: google.maps.mapsplatformdatasets.v1alpha.Usage[];
Dataset usage.
versionCreateTime
public versionCreateTime?: (google.protobuf.ITimestamp|null);
Dataset versionCreateTime.
versionDescription
public versionDescription: string;
Dataset versionDescription.
versionId
public versionId: string;
Dataset versionId.
Methods
create(properties)
public static create(properties?: google.maps.mapsplatformdatasets.v1alpha.IDataset): google.maps.mapsplatformdatasets.v1alpha.Dataset;
Creates a new Dataset instance using the specified properties.
Name | Description |
properties |
IDataset
Properties to set |
Type | Description |
google.maps.mapsplatformdatasets.v1alpha.Dataset | Dataset instance |
decode(reader, length)
public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.maps.mapsplatformdatasets.v1alpha.Dataset;
Decodes a Dataset message from the specified reader or buffer.
Name | Description |
reader |
($protobuf.Reader|Uint8Array)
Reader or buffer to decode from |
length |
number
Message length if known beforehand |
Type | Description |
google.maps.mapsplatformdatasets.v1alpha.Dataset | Dataset |
decodeDelimited(reader)
public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.maps.mapsplatformdatasets.v1alpha.Dataset;
Decodes a Dataset message from the specified reader or buffer, length delimited.
Name | Description |
reader |
($protobuf.Reader|Uint8Array)
Reader or buffer to decode from |
Type | Description |
google.maps.mapsplatformdatasets.v1alpha.Dataset | Dataset |
encode(message, writer)
public static encode(message: google.maps.mapsplatformdatasets.v1alpha.IDataset, writer?: $protobuf.Writer): $protobuf.Writer;
Encodes the specified Dataset message. Does not implicitly messages.
Name | Description |
message |
IDataset
Dataset message or plain object to encode |
writer |
$protobuf.Writer
Writer to encode to |
Type | Description |
$protobuf.Writer | Writer |
encodeDelimited(message, writer)
public static encodeDelimited(message: google.maps.mapsplatformdatasets.v1alpha.IDataset, writer?: $protobuf.Writer): $protobuf.Writer;
Encodes the specified Dataset message, length delimited. Does not implicitly messages.
Name | Description |
message |
IDataset
Dataset message or plain object to encode |
writer |
$protobuf.Writer
Writer to encode to |
Type | Description |
$protobuf.Writer | Writer |
fromObject(object)
public static fromObject(object: { [k: string]: any }): google.maps.mapsplatformdatasets.v1alpha.Dataset;
Creates a Dataset message from a plain object. Also converts values to their respective internal types.
Name | Description |
object |
{ [k: string]: any }
Plain object |
Type | Description |
google.maps.mapsplatformdatasets.v1alpha.Dataset | Dataset |
getTypeUrl(typeUrlPrefix)
public static getTypeUrl(typeUrlPrefix?: string): string;
Gets the default type url for Dataset
Name | Description |
typeUrlPrefix |
string
your custom typeUrlPrefix(default "type.googleapis.com") |
Type | Description |
string | The default type url |
toJSON()
public toJSON(): { [k: string]: any };
Converts this Dataset to JSON.
Type | Description |
{ [k: string]: any } | JSON object |
toObject(message, options)
public static toObject(message: google.maps.mapsplatformdatasets.v1alpha.Dataset, options?: $protobuf.IConversionOptions): { [k: string]: any };
Creates a plain object from a Dataset message. Also converts values to other types if specified.
Name | Description |
message |
google.maps.mapsplatformdatasets.v1alpha.Dataset
Dataset |
options |
$protobuf.IConversionOptions
Conversion options |
Type | Description |
{ [k: string]: any } | Plain object |
verify(message)
public static verify(message: { [k: string]: any }): (string|null);
Verifies a Dataset message.
Name | Description |
message |
{ [k: string]: any }
Plain object to verify |
Type | Description |
(string|null) |
|