Class protos.google.cloud.visionai.v1.Instance.InputResource (0.4.1)

Represents an InputResource.

Implements

Package

@google-cloud/visionai

Constructors

(constructor)(properties)

constructor(properties?: google.cloud.visionai.v1.Instance.IInputResource);

Constructs a new InputResource.

Parameter
Name Description
properties IInputResource

Properties to set

Properties

annotatedStream

public annotatedStream?: (google.cloud.visionai.v1.IStreamWithAnnotation|null);

InputResource annotatedStream.

annotations

public annotations?: (google.cloud.visionai.v1.IResourceAnnotations|null);

InputResource annotations.

consumerNode

public consumerNode: string;

InputResource consumerNode.

dataType

public dataType: (google.cloud.visionai.v1.DataType|keyof typeof google.cloud.visionai.v1.DataType);

InputResource dataType.

inputResource

public inputResource?: (string|null);

InputResource inputResource.

inputResourceBinding

public inputResourceBinding: string;

InputResource inputResourceBinding.

inputResourceInformation

public inputResourceInformation?: ("inputResource"|"annotatedStream");

InputResource inputResourceInformation.

Methods

create(properties)

public static create(properties?: google.cloud.visionai.v1.Instance.IInputResource): google.cloud.visionai.v1.Instance.InputResource;

Creates a new InputResource instance using the specified properties.

Parameter
Name Description
properties IInputResource

Properties to set

Returns
Type Description
InputResource

InputResource instance

decode(reader, length)

public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.visionai.v1.Instance.InputResource;

Decodes an InputResource 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
InputResource

InputResource

decodeDelimited(reader)

public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.visionai.v1.Instance.InputResource;

Decodes an InputResource message from the specified reader or buffer, length delimited.

Parameter
Name Description
reader (Reader|Uint8Array)

Reader or buffer to decode from

Returns
Type Description
InputResource

InputResource

encode(message, writer)

public static encode(message: google.cloud.visionai.v1.Instance.IInputResource, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified InputResource message. Does not implicitly messages.

Parameters
Name Description
message IInputResource

InputResource 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.visionai.v1.Instance.IInputResource, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified InputResource message, length delimited. Does not implicitly messages.

Parameters
Name Description
message IInputResource

InputResource 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.visionai.v1.Instance.InputResource;

Creates an InputResource 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
InputResource

InputResource

getTypeUrl(typeUrlPrefix)

public static getTypeUrl(typeUrlPrefix?: string): string;

Gets the default type url for InputResource

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 InputResource to JSON.

Returns
Type Description
{ [k: string]: any }

JSON object

toObject(message, options)

public static toObject(message: google.cloud.visionai.v1.Instance.InputResource, options?: $protobuf.IConversionOptions): { [k: string]: any };

Creates a plain object from an InputResource message. Also converts values to other types if specified.

Parameters
Name Description
message InputResource

InputResource

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 an InputResource message.

Parameter
Name Description
message { [k: string]: any }

Plain object to verify

Returns
Type Description
(string|null)

null if valid, otherwise the reason why it is not