Cloud AI Platform v1 API - Class FeatureViewSyncName (2.27.0)

public sealed class FeatureViewSyncName : IResourceName, IEquatable<FeatureViewSyncName>

Reference documentation and code samples for the Cloud AI Platform v1 API class FeatureViewSyncName.

Resource name for the FeatureViewSync resource.

Inheritance

object > FeatureViewSyncName

Implements

IResourceName, IEquatable FeatureViewSyncName

Inherited Members

object.GetType()

Namespace

Google.Cloud.AIPlatform.V1

Assembly

Google.Cloud.AIPlatform.V1.dll

Constructors

FeatureViewSyncName(string, string, string, string)

public FeatureViewSyncName(string projectId, string locationId, string featureOnlineStoreId, string featureViewId)

Constructs a new instance of a FeatureViewSyncName class from the component parts of pattern projects/{project}/locations/{location}/featureOnlineStores/{feature_online_store}/featureViews/{feature_view}/featureViewSyncs/feature_view_sync

Parameters
Name	Description
`projectId`	`string` The `Project` ID. Must not be `null` or empty.
`locationId`	`string` The `Location` ID. Must not be `null` or empty.
`featureOnlineStoreId`	`string` The `FeatureOnlineStore` ID. Must not be `null` or empty.
`featureViewId`	`string` The `FeatureView` ID. Must not be `null` or empty.

Properties

FeatureOnlineStoreId

public string FeatureOnlineStoreId { get; }

The FeatureOnlineStore ID. Will not be null, unless this instance contains an unparsed resource name.

Property Value
Type	Description
`string`

FeatureViewId

public string FeatureViewId { get; }

The FeatureView ID. Will not be null, unless this instance contains an unparsed resource name.

Property Value
Type	Description
`string`

IsKnownPattern

public bool IsKnownPattern { get; }

Whether this instance contains a resource name with a known pattern.

Property Value
Type	Description
`bool`

LocationId

public string LocationId { get; }

The Location ID. Will not be null, unless this instance contains an unparsed resource name.

Property Value
Type	Description
`string`

ProjectId

public string ProjectId { get; }

The Project ID. Will not be null, unless this instance contains an unparsed resource name.

Property Value
Type	Description
`string`

Type

public FeatureViewSyncName.ResourceNameType Type { get; }

The FeatureViewSyncName.ResourceNameType of the contained resource name.

Property Value
Type	Description
`FeatureViewSyncNameResourceNameType`

UnparsedResource

public UnparsedResourceName UnparsedResource { get; }

The contained UnparsedResourceName. Only non-null if this instance contains an unparsed resource name.

Property Value
Type	Description
`UnparsedResourceName`

Methods

Format(string, string, string, string)

public static string Format(string projectId, string locationId, string featureOnlineStoreId, string featureViewId)

Formats the IDs into the string representation of this FeatureViewSyncName with pattern projects/{project}/locations/{location}/featureOnlineStores/{feature_online_store}/featureViews/{feature_view}/featureViewSyncs/feature_view_sync .

Parameters
Name	Description
`projectId`	`string` The `Project` ID. Must not be `null` or empty.
`locationId`	`string` The `Location` ID. Must not be `null` or empty.
`featureOnlineStoreId`	`string` The `FeatureOnlineStore` ID. Must not be `null` or empty.
`featureViewId`	`string` The `FeatureView` ID. Must not be `null` or empty.

Returns
Type	Description
`string`	The string representation of this FeatureViewSyncName with pattern `projects/{project}/locations/{location}/featureOnlineStores/{feature_online_store}/featureViews/{feature_view}/featureViewSyncs/feature_view_sync` .

FormatProjectLocationFeatureOnlineStoreFeatureView(string, string, string, string)

public static string FormatProjectLocationFeatureOnlineStoreFeatureView(string projectId, string locationId, string featureOnlineStoreId, string featureViewId)

Parameters
Name	Description
`projectId`	`string` The `Project` ID. Must not be `null` or empty.
`locationId`	`string` The `Location` ID. Must not be `null` or empty.
`featureOnlineStoreId`	`string` The `FeatureOnlineStore` ID. Must not be `null` or empty.
`featureViewId`	`string` The `FeatureView` ID. Must not be `null` or empty.

Returns
Type	Description
`string`	The string representation of this FeatureViewSyncName with pattern `projects/{project}/locations/{location}/featureOnlineStores/{feature_online_store}/featureViews/{feature_view}/featureViewSyncs/feature_view_sync` .

FromProjectLocationFeatureOnlineStoreFeatureView(string, string, string, string)

public static FeatureViewSyncName FromProjectLocationFeatureOnlineStoreFeatureView(string projectId, string locationId, string featureOnlineStoreId, string featureViewId)

Creates a FeatureViewSyncName with the pattern projects/{project}/locations/{location}/featureOnlineStores/{feature_online_store}/featureViews/{feature_view}/featureViewSyncs/feature_view_sync .

Parameters
Name	Description
`projectId`	`string` The `Project` ID. Must not be `null` or empty.
`locationId`	`string` The `Location` ID. Must not be `null` or empty.
`featureOnlineStoreId`	`string` The `FeatureOnlineStore` ID. Must not be `null` or empty.
`featureViewId`	`string` The `FeatureView` ID. Must not be `null` or empty.

Returns
Type	Description
`FeatureViewSyncName`	A new instance of FeatureViewSyncName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static FeatureViewSyncName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a FeatureViewSyncName containing an unparsed resource name.

Parameter
Name	Description
`unparsedResourceName`	`UnparsedResourceName` The unparsed resource name. Must not be `null`.

Returns
Type	Description
`FeatureViewSyncName`	A new instance of FeatureViewSyncName containing the provided `unparsedResourceName`.

GetHashCode()

public override int GetHashCode()

Returns a hash code for this resource name.

Returns
Type	Description
`int`

Overrides

object.GetHashCode()

Parse(string)

public static FeatureViewSyncName Parse(string featureViewSyncName)

Parses the given resource name string into a new FeatureViewSyncName instance.

Parameter
Name	Description
`featureViewSyncName`	`string` The resource name in string form. Must not be `null`.

Returns
Type	Description
`FeatureViewSyncName`	The parsed FeatureViewSyncName if successful.

Remarks

To parse successfully, the resource name must be formatted as one of the following:

projects/{project}/locations/{location}/featureOnlineStores/{feature_online_store}/featureViews/{feature_view}/featureViewSyncs/feature_view_sync

Parse(string, bool)

public static FeatureViewSyncName Parse(string featureViewSyncName, bool allowUnparsed)

Parses the given resource name string into a new FeatureViewSyncName instance; optionally allowing an unparseable resource name.

Parameters
Name	Description
`featureViewSyncName`	`string` The resource name in string form. Must not be `null`.
`allowUnparsed`	`bool` If `true` will successfully store an unparseable resource name into the UnparsedResource property; otherwise will throw an ArgumentException if an unparseable resource name is specified.

Returns
Type	Description
`FeatureViewSyncName`	The parsed FeatureViewSyncName if successful.

Remarks

To parse successfully, the resource name must be formatted as one of the following:

projects/{project}/locations/{location}/featureOnlineStores/{feature_online_store}/featureViews/{feature_view}/featureViewSyncs/feature_view_sync

Or may be in any format if allowUnparsed is true.

ToString()

public override string ToString()

The string representation of the resource name.

Returns
Type	Description
`string`	The string representation of the resource name.

Overrides

object.ToString()

TryParse(string, out FeatureViewSyncName)

public static bool TryParse(string featureViewSyncName, out FeatureViewSyncName result)

Tries to parse the given resource name string into a new FeatureViewSyncName instance.

Parameters
Name	Description
`featureViewSyncName`	`string` The resource name in string form. Must not be `null`.
`result`	`FeatureViewSyncName` When this method returns, the parsed FeatureViewSyncName, or `null` if parsing failed.

Returns
Type	Description
`bool`	`true` if the name was parsed successfully; `false` otherwise.

Remarks

To parse successfully, the resource name must be formatted as one of the following:

projects/{project}/locations/{location}/featureOnlineStores/{feature_online_store}/featureViews/{feature_view}/featureViewSyncs/feature_view_sync

TryParse(string, bool, out FeatureViewSyncName)

public static bool TryParse(string featureViewSyncName, bool allowUnparsed, out FeatureViewSyncName result)

Tries to parse the given resource name string into a new FeatureViewSyncName instance; optionally allowing an unparseable resource name.

Parameters
Name	Description
`featureViewSyncName`	`string` The resource name in string form. Must not be `null`.
`allowUnparsed`	`bool` If `true` will successfully store an unparseable resource name into the UnparsedResource property; otherwise will throw an ArgumentException if an unparseable resource name is specified.
`result`	`FeatureViewSyncName` When this method returns, the parsed FeatureViewSyncName, or `null` if parsing failed.

Returns
Type	Description
`bool`	`true` if the name was parsed successfully; `false` otherwise.

Remarks

To parse successfully, the resource name must be formatted as one of the following:

projects/{project}/locations/{location}/featureOnlineStores/{feature_online_store}/featureViews/{feature_view}/featureViewSyncs/feature_view_sync

Or may be in any format if allowUnparsed is true.

Operators

operator ==(FeatureViewSyncName, FeatureViewSyncName)

public static bool operator ==(FeatureViewSyncName a, FeatureViewSyncName b)

Determines whether two specified resource names have the same value.

Parameters
Name	Description
`a`	`FeatureViewSyncName` The first resource name to compare, or null.
`b`	`FeatureViewSyncName` The second resource name to compare, or null.

Returns
Type	Description
`bool`	true if the value of `a` is the same as the value of `b`; otherwise, false.

operator !=(FeatureViewSyncName, FeatureViewSyncName)

public static bool operator !=(FeatureViewSyncName a, FeatureViewSyncName b)

Determines whether two specified resource names have different values.

Parameters
Name	Description
`a`	`FeatureViewSyncName` The first resource name to compare, or null.
`b`	`FeatureViewSyncName` The second resource name to compare, or null.

Returns
Type	Description
`bool`	true if the value of `a` is different from the value of `b`; otherwise, false.