Class protos.google.cloud.contentwarehouse.v1.PropertyDefinition (0.3.0)

Represents a PropertyDefinition.

Package

Constructors

(constructor)(properties)

constructor(properties?: google.cloud.contentwarehouse.v1.IPropertyDefinition);

Constructs a new PropertyDefinition.

Parameter

Name	Description
`properties`	`IPropertyDefinition` Properties to set

Properties

dateTimeTypeOptions

public dateTimeTypeOptions?: (google.cloud.contentwarehouse.v1.IDateTimeTypeOptions|null);

PropertyDefinition dateTimeTypeOptions.

displayName

public displayName: string;

PropertyDefinition displayName.

enumTypeOptions

public enumTypeOptions?: (google.cloud.contentwarehouse.v1.IEnumTypeOptions|null);

PropertyDefinition enumTypeOptions.

floatTypeOptions

public floatTypeOptions?: (google.cloud.contentwarehouse.v1.IFloatTypeOptions|null);

PropertyDefinition floatTypeOptions.

integerTypeOptions

public integerTypeOptions?: (google.cloud.contentwarehouse.v1.IIntegerTypeOptions|null);

PropertyDefinition integerTypeOptions.

isFilterable

public isFilterable: boolean;

PropertyDefinition isFilterable.

isMetadata

public isMetadata: boolean;

PropertyDefinition isMetadata.

isRepeatable

public isRepeatable: boolean;

PropertyDefinition isRepeatable.

isRequired

public isRequired: boolean;

PropertyDefinition isRequired.

isSearchable

public isSearchable: boolean;

PropertyDefinition isSearchable.

mapTypeOptions

public mapTypeOptions?: (google.cloud.contentwarehouse.v1.IMapTypeOptions|null);

PropertyDefinition mapTypeOptions.

name

public name: string;

PropertyDefinition name.

propertyTypeOptions

public propertyTypeOptions?: (google.cloud.contentwarehouse.v1.IPropertyTypeOptions|null);

PropertyDefinition propertyTypeOptions.

textTypeOptions

public textTypeOptions?: (google.cloud.contentwarehouse.v1.ITextTypeOptions|null);

PropertyDefinition textTypeOptions.

timestampTypeOptions

public timestampTypeOptions?: (google.cloud.contentwarehouse.v1.ITimestampTypeOptions|null);

PropertyDefinition timestampTypeOptions.

valueTypeOptions

public valueTypeOptions?: ("integerTypeOptions"|"floatTypeOptions"|"textTypeOptions"|"propertyTypeOptions"|"enumTypeOptions"|"dateTimeTypeOptions"|"mapTypeOptions"|"timestampTypeOptions");

PropertyDefinition valueTypeOptions.

Methods

create(properties)

public static create(properties?: google.cloud.contentwarehouse.v1.IPropertyDefinition): google.cloud.contentwarehouse.v1.PropertyDefinition;

Creates a new PropertyDefinition instance using the specified properties.

Parameter

Name	Description
`properties`	`IPropertyDefinition` Properties to set

Returns

Type	Description
`google.cloud.contentwarehouse.v1.PropertyDefinition`	PropertyDefinition instance

decode(reader, length)

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

Decodes a PropertyDefinition message from the specified reader or buffer.

Parameters

Name	Description
`reader`	`($protobuf.Reader\|Uint8Array)` Reader or buffer to decode from
`length`	`number` Message length if known beforehand

Returns

Type	Description
`google.cloud.contentwarehouse.v1.PropertyDefinition`	PropertyDefinition

decodeDelimited(reader)

public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.contentwarehouse.v1.PropertyDefinition;

Decodes a PropertyDefinition message from the specified reader or buffer, length delimited.

Parameter

Name	Description
`reader`	`($protobuf.Reader\|Uint8Array)` Reader or buffer to decode from

Returns

Type	Description
`google.cloud.contentwarehouse.v1.PropertyDefinition`	PropertyDefinition

encode(message, writer)

public static encode(message: google.cloud.contentwarehouse.v1.IPropertyDefinition, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified PropertyDefinition message. Does not implicitly messages.

Parameters

Name	Description
`message`	`IPropertyDefinition` PropertyDefinition 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.contentwarehouse.v1.IPropertyDefinition, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters

Name	Description
`message`	`IPropertyDefinition` PropertyDefinition 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.contentwarehouse.v1.PropertyDefinition;

Creates a PropertyDefinition 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
`google.cloud.contentwarehouse.v1.PropertyDefinition`	PropertyDefinition

getTypeUrl(typeUrlPrefix)

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

Gets the default type url for PropertyDefinition

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

Returns

Type	Description
`{ [k: string]: any }`	JSON object

toObject(message, options)

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

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

Parameters

Name	Description
`message`	`google.cloud.contentwarehouse.v1.PropertyDefinition` PropertyDefinition
`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 PropertyDefinition 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