Chronicle v1 API - Class FeedPackName (1.1.0) 

public sealed class FeedPackName : IResourceName, IEquatable<FeedPackName>

Reference documentation and code samples for the Chronicle v1 API class FeedPackName.

Resource name for the FeedPack resource.

Inheritance

object > FeedPackName

Namespace

Google.Cloud.Chronicle.V1

Assembly

Google.Cloud.Chronicle.V1.dll

Constructors

FeedPackName(string, string, string, string)

public FeedPackName(string projectId, string locationId, string instanceId, string feedPackId)

Constructs a new instance of a FeedPackName class from the component parts of pattern projects/{project}/locations/{location}/instances/{instance}/feedPacks/{feed_pack}

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.
instanceId string

The Instance ID. Must not be null or empty.
feedPackId string

The FeedPack ID. Must not be null or empty.

Properties

FeedPackId

public string FeedPackId { get; }

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

Property Value
Type Description
string

InstanceId

public string InstanceId { get; }

The Instance 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 FeedPackName.ResourceNameType Type { get; }

The FeedPackName.ResourceNameType of the contained resource name.

Property Value
Type Description
FeedPackNameResourceNameType

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 instanceId, string feedPackId)

Formats the IDs into the string representation of this FeedPackName with pattern projects/{project}/locations/{location}/instances/{instance}/feedPacks/{feed_pack}.

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.
instanceId string

The Instance ID. Must not be null or empty.
feedPackId string

The FeedPack ID. Must not be null or empty.
Returns
Type Description
string

The string representation of this FeedPackName with pattern projects/{project}/locations/{location}/instances/{instance}/feedPacks/{feed_pack}.

FormatProjectLocationInstanceFeedPack(string, string, string, string)

public static string FormatProjectLocationInstanceFeedPack(string projectId, string locationId, string instanceId, string feedPackId)

Formats the IDs into the string representation of this FeedPackName with pattern projects/{project}/locations/{location}/instances/{instance}/feedPacks/{feed_pack}.

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.
instanceId string

The Instance ID. Must not be null or empty.
feedPackId string

The FeedPack ID. Must not be null or empty.
Returns
Type Description
string

The string representation of this FeedPackName with pattern projects/{project}/locations/{location}/instances/{instance}/feedPacks/{feed_pack}.

FromProjectLocationInstanceFeedPack(string, string, string, string)

public static FeedPackName FromProjectLocationInstanceFeedPack(string projectId, string locationId, string instanceId, string feedPackId)

Creates a FeedPackName with the pattern projects/{project}/locations/{location}/instances/{instance}/feedPacks/{feed_pack}.

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.
instanceId string

The Instance ID. Must not be null or empty.
feedPackId string

The FeedPack ID. Must not be null or empty.
Returns
Type Description
FeedPackName

A new instance of FeedPackName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static FeedPackName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a FeedPackName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

The unparsed resource name. Must not be null.
Returns
Type Description
FeedPackName

A new instance of FeedPackName containing the provided unparsedResourceName .

GetHashCode()

public override int GetHashCode()

Returns a hash code for this resource name.

Returns
Type Description
int
Overrides

Parse(string)

public static FeedPackName Parse(string feedPackName)

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

Parameter
Name Description
feedPackName string

The resource name in string form. Must not be null.
Returns
Type Description
FeedPackName

The parsed FeedPackName if successful.
Remarks

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

  • projects/{project}/locations/{location}/instances/{instance}/feedPacks/{feed_pack}

Parse(string, bool)

public static FeedPackName Parse(string feedPackName, bool allowUnparsed)

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

Parameters
Name Description
feedPackName 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
FeedPackName

The parsed FeedPackName if successful.
Remarks

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

  • projects/{project}/locations/{location}/instances/{instance}/feedPacks/{feed_pack}

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

TryParse(string, out FeedPackName)

public static bool TryParse(string feedPackName, out FeedPackName result)

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

Parameters
Name Description
feedPackName string

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

When this method returns, the parsed FeedPackName, 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}/instances/{instance}/feedPacks/{feed_pack}

TryParse(string, bool, out FeedPackName)

public static bool TryParse(string feedPackName, bool allowUnparsed, out FeedPackName result)

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

Parameters
Name Description
feedPackName 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 FeedPackName

When this method returns, the parsed FeedPackName, 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}/instances/{instance}/feedPacks/{feed_pack}

Or may be in any format if allowUnparsed is true.

Operators

operator ==(FeedPackName, FeedPackName)

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

Determines whether two specified resource names have the same value.

Parameters
Name Description
a FeedPackName

The first resource name to compare, or null.
b FeedPackName

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 !=(FeedPackName, FeedPackName)

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

Determines whether two specified resource names have different values.

Parameters
Name Description
a FeedPackName

The first resource name to compare, or null.
b FeedPackName

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.