Represents a ResourceDescriptor.
Package
@google-cloud/datalabeling!Constructors
(constructor)(properties)
constructor(properties?: google.api.IResourceDescriptor);Constructs a new ResourceDescriptor.
| Type | Name | Description |
|---|---|---|
| IResourceDescriptor | properties |
Properties to set |
Properties
history
public history: (google.api.ResourceDescriptor.History|keyof typeof google.api.ResourceDescriptor.History);ResourceDescriptor history.
| Type | Description |
|---|---|
| (google.api.ResourceDescriptor.History|keyof typeof google.api.ResourceDescriptor.History) |
nameField
public nameField: string;ResourceDescriptor nameField.
| Type | Description |
|---|---|
| string |
pattern
public pattern: string[];ResourceDescriptor pattern.
| Type | Description |
|---|---|
| string[] |
plural
public plural: string;ResourceDescriptor plural.
| Type | Description |
|---|---|
| string |
singular
public singular: string;ResourceDescriptor singular.
| Type | Description |
|---|---|
| string |
style
public style: google.api.ResourceDescriptor.Style[];ResourceDescriptor style.
| Type | Description |
|---|---|
| google.api.ResourceDescriptor.Style[] |
type
public type: string;ResourceDescriptor type.
| Type | Description |
|---|---|
| string |
Methods
create(properties)
public static create(properties?: google.api.IResourceDescriptor): google.api.ResourceDescriptor;Creates a new ResourceDescriptor instance using the specified properties.
| Type | Name | Description |
|---|---|---|
| IResourceDescriptor | properties |
Properties to set |
| Type | Description |
|---|---|
| google.api.ResourceDescriptor | ResourceDescriptor instance |
decode(reader, length)
public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.api.ResourceDescriptor;Decodes a ResourceDescriptor message from the specified reader or buffer.
| Type | Name | Description |
|---|---|---|
| ($protobuf.Reader|Uint8Array) | reader |
Reader or buffer to decode from |
| number | length |
Message length if known beforehand |
| Type | Description |
|---|---|
| google.api.ResourceDescriptor | ResourceDescriptor |
decodeDelimited(reader)
public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.api.ResourceDescriptor;Decodes a ResourceDescriptor message from the specified reader or buffer, length delimited.
| Type | Name | Description |
|---|---|---|
| ($protobuf.Reader|Uint8Array) | reader |
Reader or buffer to decode from |
| Type | Description |
|---|---|
| google.api.ResourceDescriptor | ResourceDescriptor |
encode(message, writer)
public static encode(message: google.api.IResourceDescriptor, writer?: $protobuf.Writer): $protobuf.Writer;Encodes the specified ResourceDescriptor message. Does not implicitly messages.
| Type | Name | Description |
|---|---|---|
| IResourceDescriptor | message |
ResourceDescriptor message or plain object to encode |
| $protobuf.Writer | writer |
Writer to encode to |
| Type | Description |
|---|---|
| $protobuf.Writer | Writer |
encodeDelimited(message, writer)
public static encodeDelimited(message: google.api.IResourceDescriptor, writer?: $protobuf.Writer): $protobuf.Writer;Encodes the specified ResourceDescriptor message, length delimited. Does not implicitly messages.
| Type | Name | Description |
|---|---|---|
| IResourceDescriptor | message |
ResourceDescriptor message or plain object to encode |
| $protobuf.Writer | writer |
Writer to encode to |
| Type | Description |
|---|---|
| $protobuf.Writer | Writer |
fromObject(object)
public static fromObject(object: { [k: string]: any }): google.api.ResourceDescriptor;Creates a ResourceDescriptor message from a plain object. Also converts values to their respective internal types.
| Type | Name | Description |
|---|---|---|
| { [k: string]: any } | object |
Plain object |
| Type | Description |
|---|---|
| google.api.ResourceDescriptor | ResourceDescriptor |
toJSON()
public toJSON(): { [k: string]: any };Converts this ResourceDescriptor to JSON.
| Type | Description |
|---|---|
| { [k: string]: any } | JSON object |
toObject(message, options)
public static toObject(message: google.api.ResourceDescriptor, options?: $protobuf.IConversionOptions): { [k: string]: any };Creates a plain object from a ResourceDescriptor message. Also converts values to other types if specified.
| Type | Name | Description |
|---|---|---|
| google.api.ResourceDescriptor | message |
ResourceDescriptor |
| $protobuf.IConversionOptions | options |
Conversion options |
| Type | Description |
|---|---|
| { [k: string]: any } | Plain object |
verify(message)
public static verify(message: { [k: string]: any }): (string|null);Verifies a ResourceDescriptor message.
| Type | Name | Description |
|---|---|---|
| { [k: string]: any } | message |
Plain object to verify |
| Type | Description |
|---|---|
| (string|null) |
|