Represents a ProfileInfo.
Package
@google-cloud/dataplexConstructors
(constructor)(properties)
constructor(properties?: google.cloud.dataplex.v1.DataProfileResult.Profile.Field.IProfileInfo);Constructs a new ProfileInfo.
| Parameter | |
|---|---|
| Name | Description |
properties |
IProfileInfo
Properties to set |
Properties
distinctRatio
public distinctRatio: number;ProfileInfo distinctRatio.
doubleProfile
public doubleProfile?: (google.cloud.dataplex.v1.DataProfileResult.Profile.Field.ProfileInfo.IDoubleFieldInfo|null);ProfileInfo doubleProfile.
fieldInfo
public fieldInfo?: ("stringProfile"|"integerProfile"|"doubleProfile");ProfileInfo fieldInfo.
integerProfile
public integerProfile?: (google.cloud.dataplex.v1.DataProfileResult.Profile.Field.ProfileInfo.IIntegerFieldInfo|null);ProfileInfo integerProfile.
nullRatio
public nullRatio: number;ProfileInfo nullRatio.
stringProfile
public stringProfile?: (google.cloud.dataplex.v1.DataProfileResult.Profile.Field.ProfileInfo.IStringFieldInfo|null);ProfileInfo stringProfile.
topNValues
public topNValues: google.cloud.dataplex.v1.DataProfileResult.Profile.Field.ProfileInfo.ITopNValue[];ProfileInfo topNValues.
Methods
create(properties)
public static create(properties?: google.cloud.dataplex.v1.DataProfileResult.Profile.Field.IProfileInfo): google.cloud.dataplex.v1.DataProfileResult.Profile.Field.ProfileInfo;Creates a new ProfileInfo instance using the specified properties.
| Parameter | |
|---|---|
| Name | Description |
properties |
IProfileInfo
Properties to set |
| Returns | |
|---|---|
| Type | Description |
ProfileInfo | ProfileInfo instance |
decode(reader, length)
public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.dataplex.v1.DataProfileResult.Profile.Field.ProfileInfo;Decodes a ProfileInfo 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 |
ProfileInfo | ProfileInfo |
decodeDelimited(reader)
public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.dataplex.v1.DataProfileResult.Profile.Field.ProfileInfo;Decodes a ProfileInfo message from the specified reader or buffer, length delimited.
| Parameter | |
|---|---|
| Name | Description |
reader |
(Reader|Uint8Array)
Reader or buffer to decode from |
| Returns | |
|---|---|
| Type | Description |
ProfileInfo | ProfileInfo |
encode(message, writer)
public static encode(message: google.cloud.dataplex.v1.DataProfileResult.Profile.Field.IProfileInfo, writer?: $protobuf.Writer): $protobuf.Writer;Encodes the specified ProfileInfo message. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message |
IProfileInfo
ProfileInfo 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.dataplex.v1.DataProfileResult.Profile.Field.IProfileInfo, writer?: $protobuf.Writer): $protobuf.Writer;Encodes the specified ProfileInfo message, length delimited. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message |
IProfileInfo
ProfileInfo 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.dataplex.v1.DataProfileResult.Profile.Field.ProfileInfo;Creates a ProfileInfo 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 |
ProfileInfo | ProfileInfo |
getTypeUrl(typeUrlPrefix)
public static getTypeUrl(typeUrlPrefix?: string): string;Gets the default type url for ProfileInfo
| 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 ProfileInfo to JSON.
| Returns | |
|---|---|
| Type | Description |
{ [k: string]: any } | JSON object |
toObject(message, options)
public static toObject(message: google.cloud.dataplex.v1.DataProfileResult.Profile.Field.ProfileInfo, options?: $protobuf.IConversionOptions): { [k: string]: any };Creates a plain object from a ProfileInfo message. Also converts values to other types if specified.
| Parameters | |
|---|---|
| Name | Description |
message |
ProfileInfo
ProfileInfo |
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 ProfileInfo message.
| Parameter | |
|---|---|
| Name | Description |
message |
{ [k: string]: any }
Plain object to verify |
| Returns | |
|---|---|
| Type | Description |
(string|null) |
|