Class FeedName

public sealed class FeedName : IResourceName, IEquatable<FeedName>

Resource name for the Feed resource.

Inheritance

Object > FeedName

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
TypeNameDescription
StringprojectId

The Project ID. Must not be null or empty.

StringfeedId

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
TypeDescription
String

FolderId

public string FolderId { get; }

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

Property Value
TypeDescription
String

IsKnownPattern

public bool IsKnownPattern { get; }

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

Property Value
TypeDescription
Boolean

OrganizationId

public string OrganizationId { get; }

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

Property Value
TypeDescription
String

ProjectId

public string ProjectId { get; }

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

Property Value
TypeDescription
String

Type

public FeedName.ResourceNameType Type { get; }

The FeedName.ResourceNameType of the contained resource name.

Property Value
TypeDescription
FeedName.ResourceNameType

UnparsedResource

public UnparsedResourceName UnparsedResource { get; }

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

Property Value
TypeDescription
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
TypeNameDescription
StringprojectId

The Project ID. Must not be null or empty.

StringfeedId

The Feed ID. Must not be null or empty.

Returns
TypeDescription
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
TypeNameDescription
StringfolderId

The Folder ID. Must not be null or empty.

StringfeedId

The Feed ID. Must not be null or empty.

Returns
TypeDescription
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
TypeNameDescription
StringorganizationId

The Organization ID. Must not be null or empty.

StringfeedId

The Feed ID. Must not be null or empty.

Returns
TypeDescription
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
TypeNameDescription
StringprojectId

The Project ID. Must not be null or empty.

StringfeedId

The Feed ID. Must not be null or empty.

Returns
TypeDescription
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
TypeNameDescription
StringfolderId

The Folder ID. Must not be null or empty.

StringfeedId

The Feed ID. Must not be null or empty.

Returns
TypeDescription
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
TypeNameDescription
StringorganizationId

The Organization ID. Must not be null or empty.

StringfeedId

The Feed ID. Must not be null or empty.

Returns
TypeDescription
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
TypeNameDescription
StringprojectId

The Project ID. Must not be null or empty.

StringfeedId

The Feed ID. Must not be null or empty.

Returns
TypeDescription
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
TypeNameDescription
UnparsedResourceNameunparsedResourceName

The unparsed resource name. Must not be null.

Returns
TypeDescription
FeedName

A new instance of FeedName containing the provided unparsedResourceName.

GetHashCode()

public override int GetHashCode()

Returns a hash code for this resource name.

Returns
TypeDescription
Int32
Overrides

Parse(String)

public static FeedName Parse(string feedName)

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

Parameter
TypeNameDescription
StringfeedName

The resource name in string form. Must not be null.

Returns
TypeDescription
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
TypeNameDescription
StringfeedName

The resource name in string form. Must not be null.

BooleanallowUnparsed

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
TypeDescription
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
TypeDescription
String

The string representation of the resource name.

Overrides

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
TypeNameDescription
StringfeedName

The resource name in string form. Must not be null.

FeedNameresult

When this method returns, the parsed FeedName, or null if parsing failed.

Returns
TypeDescription
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
TypeNameDescription
StringfeedName

The resource name in string form. Must not be null.

BooleanallowUnparsed

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.

FeedNameresult

When this method returns, the parsed FeedName, or null if parsing failed.

Returns
TypeDescription
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
TypeNameDescription
FeedNamea
FeedNameb
Returns
TypeDescription
Boolean

Inequality(FeedName, FeedName)

public static bool operator !=(FeedName a, FeedName b)
Parameters
TypeNameDescription
FeedNamea
FeedNameb
Returns
TypeDescription
Boolean