Chronicle v1 API - Class ContentHubName (1.0.0-beta05) 

public sealed class ContentHubName : IResourceName, IEquatable<ContentHubName>

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

Resource name for the ContentHub resource.

Inheritance

object > ContentHubName

Namespace

Google.Cloud.Chronicle.V1

Assembly

Google.Cloud.Chronicle.V1.dll

Constructors

ContentHubName(string, string, string)

public ContentHubName(string projectId, string locationId, string instanceId)

Constructs a new instance of a ContentHubName class from the component parts of pattern projects/{project}/locations/{location}/instances/{instance}/contentHub

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.

Properties

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 ContentHubName.ResourceNameType Type { get; }

The ContentHubName.ResourceNameType of the contained resource name.

Property Value
Type Description
ContentHubNameResourceNameType

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)

public static string Format(string projectId, string locationId, string instanceId)

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

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.
Returns
Type Description
string

The string representation of this ContentHubName with pattern projects/{project}/locations/{location}/instances/{instance}/contentHub.

FormatProjectLocationInstance(string, string, string)

public static string FormatProjectLocationInstance(string projectId, string locationId, string instanceId)

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

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.
Returns
Type Description
string

The string representation of this ContentHubName with pattern projects/{project}/locations/{location}/instances/{instance}/contentHub.

FromProjectLocationInstance(string, string, string)

public static ContentHubName FromProjectLocationInstance(string projectId, string locationId, string instanceId)

Creates a ContentHubName with the pattern projects/{project}/locations/{location}/instances/{instance}/contentHub.

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.
Returns
Type Description
ContentHubName

A new instance of ContentHubName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static ContentHubName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a ContentHubName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

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

A new instance of ContentHubName 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 ContentHubName Parse(string contentHubName)

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

Parameter
Name Description
contentHubName string

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

The parsed ContentHubName if successful.
Remarks

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

  • projects/{project}/locations/{location}/instances/{instance}/contentHub

Parse(string, bool)

public static ContentHubName Parse(string contentHubName, bool allowUnparsed)

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

Parameters
Name Description
contentHubName 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
ContentHubName

The parsed ContentHubName if successful.
Remarks

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

  • projects/{project}/locations/{location}/instances/{instance}/contentHub

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

public static bool TryParse(string contentHubName, out ContentHubName result)

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

Parameters
Name Description
contentHubName string

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

When this method returns, the parsed ContentHubName, 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}/contentHub

TryParse(string, bool, out ContentHubName)

public static bool TryParse(string contentHubName, bool allowUnparsed, out ContentHubName result)

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

Parameters
Name Description
contentHubName 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 ContentHubName

When this method returns, the parsed ContentHubName, 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}/contentHub

Or may be in any format if allowUnparsed is true.

Operators

operator ==(ContentHubName, ContentHubName)

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

Determines whether two specified resource names have the same value.

Parameters
Name Description
a ContentHubName

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

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

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

Determines whether two specified resource names have different values.

Parameters
Name Description
a ContentHubName

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

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.