Google Cloud Asset Inventory v1 API - Class FeedName (3.3.0)

public sealed class FeedName : IResourceName, IEquatable<FeedName>

Reference documentation and code samples for the Google Cloud Asset Inventory v1 API class FeedName.

Resource name for the Feed resource.

Inheritance

Object > FeedName

Implements

IResourceName, IEquatable<FeedName>

Inherited Members

Object.GetType()

Object.MemberwiseClone()

Namespace

Google.Cloud.Asset.V1

Assembly

Google.Cloud.Asset.V1.dll

Constructors

FeedName(String, String)

public FeedName(string projectId, string feedId)

Constructs a new instance of a FeedName class from the component parts of pattern projects/{project}/feeds/{feed}

Parameters
Name	Description
`projectId`	`String` The `Project` ID. Must not be `null` or empty.
`feedId`	`String` The `Feed` ID. Must not be `null` or empty.

Properties

FeedId

public string FeedId { get; }

The Feed ID. May be null, depending on which resource name is contained by this instance.

Property Value
Type	Description
`String`

FolderId

public string FolderId { get; }

The Folder ID. May be null, depending on which resource name is contained by this instance.

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
`Boolean`

OrganizationId

public string OrganizationId { get; }

The Organization ID. May be null, depending on which resource name is contained by this instance.

Property Value
Type	Description
`String`

ProjectId

public string ProjectId { get; }

The Project ID. May be null, depending on which resource name is contained by this instance.

Property Value
Type	Description
`String`

Type

public FeedName.ResourceNameType Type { get; }

The FeedName.ResourceNameType of the contained resource name.

Property Value
Type	Description
`FeedName.ResourceNameType`

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)

public static string Format(string projectId, string feedId)

Formats the IDs into the string representation of this FeedName with pattern projects/{project}/feeds/{feed}.

Parameters
Name	Description
`projectId`	`String` The `Project` ID. Must not be `null` or empty.
`feedId`	`String` The `Feed` ID. Must not be `null` or empty.

Returns
Type	Description
`String`	The string representation of this FeedName with pattern `projects/{project}/feeds/{feed}` .

FormatFolderFeed(String, String)

public static string FormatFolderFeed(string folderId, string feedId)

Formats the IDs into the string representation of this FeedName with pattern folders/{folder}/feeds/{feed}.

Parameters
Name	Description
`folderId`	`String` The `Folder` ID. Must not be `null` or empty.
`feedId`	`String` The `Feed` ID. Must not be `null` or empty.

Returns
Type	Description
`String`	The string representation of this FeedName with pattern `folders/{folder}/feeds/{feed}`.

FormatOrganizationFeed(String, String)

public static string FormatOrganizationFeed(string organizationId, string feedId)

Formats the IDs into the string representation of this FeedName with pattern organizations/{organization}/feeds/{feed}.

Parameters
Name	Description
`organizationId`	`String` The `Organization` ID. Must not be `null` or empty.
`feedId`	`String` The `Feed` ID. Must not be `null` or empty.

Returns
Type	Description
`String`	The string representation of this FeedName with pattern `organizations/{organization}/feeds/{feed}`.

FormatProjectFeed(String, String)

public static string FormatProjectFeed(string projectId, string feedId)

Formats the IDs into the string representation of this FeedName with pattern projects/{project}/feeds/{feed}.

Parameters
Name	Description
`projectId`	`String` The `Project` ID. Must not be `null` or empty.
`feedId`	`String` The `Feed` ID. Must not be `null` or empty.

Returns
Type	Description
`String`	The string representation of this FeedName with pattern `projects/{project}/feeds/{feed}` .

FromFolderFeed(String, String)

public static FeedName FromFolderFeed(string folderId, string feedId)

Creates a FeedName with the pattern folders/{folder}/feeds/{feed}.

Parameters
Name	Description
`folderId`	`String` The `Folder` ID. Must not be `null` or empty.
`feedId`	`String` The `Feed` ID. Must not be `null` or empty.

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

FromOrganizationFeed(String, String)

public static FeedName FromOrganizationFeed(string organizationId, string feedId)

Creates a FeedName with the pattern organizations/{organization}/feeds/{feed}.

Parameters
Name	Description
`organizationId`	`String` The `Organization` ID. Must not be `null` or empty.
`feedId`	`String` The `Feed` ID. Must not be `null` or empty.

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

FromProjectFeed(String, String)

public static FeedName FromProjectFeed(string projectId, string feedId)

Creates a FeedName with the pattern projects/{project}/feeds/{feed}.

Parameters
Name	Description
`projectId`	`String` The `Project` ID. Must not be `null` or empty.
`feedId`	`String` The `Feed` ID. Must not be `null` or empty.

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

FromUnparsed(UnparsedResourceName)

public static FeedName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a FeedName containing an unparsed resource name.

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

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

GetHashCode()

public override int GetHashCode()

Returns a hash code for this resource name.

Returns
Type	Description
`Int32`

Overrides

Object.GetHashCode()

Parse(String)

public static FeedName Parse(string feedName)

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

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

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

Remarks

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

projects/{project}/feeds/{feed}
folders/{folder}/feeds/{feed}
organizations/{organization}/feeds/{feed}

Parse(String, Boolean)

public static FeedName Parse(string feedName, bool allowUnparsed)

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

Parameters
Name	Description
`feedName`	`String` The resource name in string form. Must not be `null`.
`allowUnparsed`	`Boolean` 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
`FeedName`	The parsed FeedName if successful.

Remarks

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

projects/{project}/feeds/{feed}
folders/{folder}/feeds/{feed}
organizations/{organization}/feeds/{feed}

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 FeedName)

public static bool TryParse(string feedName, out FeedName result)

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

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

Returns
Type	Description
`Boolean`	`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}/feeds/{feed}
folders/{folder}/feeds/{feed}
organizations/{organization}/feeds/{feed}

TryParse(String, Boolean, out FeedName)

public static bool TryParse(string feedName, bool allowUnparsed, out FeedName result)

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

Parameters
Name	Description
`feedName`	`String` The resource name in string form. Must not be `null`.
`allowUnparsed`	`Boolean` 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`	`FeedName` When this method returns, the parsed FeedName, or `null` if parsing failed.

Returns
Type	Description
`Boolean`	`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}/feeds/{feed}
folders/{folder}/feeds/{feed}
organizations/{organization}/feeds/{feed}

Or may be in any format if allowUnparsed is true.

Operators

Equality(FeedName, FeedName)

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

Parameters
Name	Description
`a`	`FeedName`
`b`	`FeedName`

Returns
Type	Description
`Boolean`

Inequality(FeedName, FeedName)

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

Parameters
Name	Description
`a`	`FeedName`
`b`	`FeedName`

Returns
Type	Description
`Boolean`