Google Cloud Logging v2 API - Class LinkName (4.4.0)

public sealed class LinkName : IResourceName, IEquatable<LinkName>

Reference documentation and code samples for the Google Cloud Logging v2 API class LinkName.

Resource name for the Link resource.

Inheritance

object > LinkName

Implements

IResourceName, IEquatable LinkName

Inherited Members

object.GetType()

Namespace

Google.Cloud.Logging.V2

Assembly

Google.Cloud.Logging.V2.dll

Constructors

LinkName(string, string, string, string)

public LinkName(string projectId, string locationId, string bucketId, string linkId)

Constructs a new instance of a LinkName class from the component parts of pattern projects/{project}/locations/{location}/buckets/{bucket}/links/{link}

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.
`bucketId`	`string` The `Bucket` ID. Must not be `null` or empty.
`linkId`	`string` The `Link` ID. Must not be `null` or empty.

Properties

BillingAccountId

public string BillingAccountId { get; }

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

Property Value
Type	Description
`string`

BucketId

public string BucketId { get; }

The Bucket 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
`bool`

LinkId

public string LinkId { get; }

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

Property Value
Type	Description
`string`

LocationId

public string LocationId { get; }

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

Property Value
Type	Description
`string`

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

The LinkName.ResourceNameType of the contained resource name.

Property Value
Type	Description
`LinkNameResourceNameType`

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 bucketId, string linkId)

Formats the IDs into the string representation of this LinkName with pattern projects/{project}/locations/{location}/buckets/{bucket}/links/{link}.

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.
`bucketId`	`string` The `Bucket` ID. Must not be `null` or empty.
`linkId`	`string` The `Link` ID. Must not be `null` or empty.

Returns
Type	Description
`string`	The string representation of this LinkName with pattern `projects/{project}/locations/{location}/buckets/{bucket}/links/{link}`.

FormatBillingAccountLocationBucketLink(string, string, string, string)

public static string FormatBillingAccountLocationBucketLink(string billingAccountId, string locationId, string bucketId, string linkId)

Formats the IDs into the string representation of this LinkName with pattern billingAccounts/{billing_account}/locations/{location}/buckets/{bucket}/links/{link}.

Parameters
Name	Description
`billingAccountId`	`string` The `BillingAccount` ID. Must not be `null` or empty.
`locationId`	`string` The `Location` ID. Must not be `null` or empty.
`bucketId`	`string` The `Bucket` ID. Must not be `null` or empty.
`linkId`	`string` The `Link` ID. Must not be `null` or empty.

Returns
Type	Description
`string`	The string representation of this LinkName with pattern `billingAccounts/{billing_account}/locations/{location}/buckets/{bucket}/links/{link}`.

FormatFolderLocationBucketLink(string, string, string, string)

public static string FormatFolderLocationBucketLink(string folderId, string locationId, string bucketId, string linkId)

Formats the IDs into the string representation of this LinkName with pattern folders/{folder}/locations/{location}/buckets/{bucket}/links/{link}.

Parameters
Name	Description
`folderId`	`string` The `Folder` ID. Must not be `null` or empty.
`locationId`	`string` The `Location` ID. Must not be `null` or empty.
`bucketId`	`string` The `Bucket` ID. Must not be `null` or empty.
`linkId`	`string` The `Link` ID. Must not be `null` or empty.

Returns
Type	Description
`string`	The string representation of this LinkName with pattern `folders/{folder}/locations/{location}/buckets/{bucket}/links/{link}`.

FormatOrganizationLocationBucketLink(string, string, string, string)

public static string FormatOrganizationLocationBucketLink(string organizationId, string locationId, string bucketId, string linkId)

Formats the IDs into the string representation of this LinkName with pattern organizations/{organization}/locations/{location}/buckets/{bucket}/links/{link}.

Parameters
Name	Description
`organizationId`	`string` The `Organization` ID. Must not be `null` or empty.
`locationId`	`string` The `Location` ID. Must not be `null` or empty.
`bucketId`	`string` The `Bucket` ID. Must not be `null` or empty.
`linkId`	`string` The `Link` ID. Must not be `null` or empty.

Returns
Type	Description
`string`	The string representation of this LinkName with pattern `organizations/{organization}/locations/{location}/buckets/{bucket}/links/{link}`.

FormatProjectLocationBucketLink(string, string, string, string)

public static string FormatProjectLocationBucketLink(string projectId, string locationId, string bucketId, string linkId)

Formats the IDs into the string representation of this LinkName with pattern projects/{project}/locations/{location}/buckets/{bucket}/links/{link}.

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.
`bucketId`	`string` The `Bucket` ID. Must not be `null` or empty.
`linkId`	`string` The `Link` ID. Must not be `null` or empty.

Returns
Type	Description
`string`	The string representation of this LinkName with pattern `projects/{project}/locations/{location}/buckets/{bucket}/links/{link}`.

FromBillingAccountLocationBucketLink(string, string, string, string)

public static LinkName FromBillingAccountLocationBucketLink(string billingAccountId, string locationId, string bucketId, string linkId)

Creates a LinkName with the pattern billingAccounts/{billing_account}/locations/{location}/buckets/{bucket}/links/{link}.

Parameters
Name	Description
`billingAccountId`	`string` The `BillingAccount` ID. Must not be `null` or empty.
`locationId`	`string` The `Location` ID. Must not be `null` or empty.
`bucketId`	`string` The `Bucket` ID. Must not be `null` or empty.
`linkId`	`string` The `Link` ID. Must not be `null` or empty.

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

FromFolderLocationBucketLink(string, string, string, string)

public static LinkName FromFolderLocationBucketLink(string folderId, string locationId, string bucketId, string linkId)

Creates a LinkName with the pattern folders/{folder}/locations/{location}/buckets/{bucket}/links/{link}.

Parameters
Name	Description
`folderId`	`string` The `Folder` ID. Must not be `null` or empty.
`locationId`	`string` The `Location` ID. Must not be `null` or empty.
`bucketId`	`string` The `Bucket` ID. Must not be `null` or empty.
`linkId`	`string` The `Link` ID. Must not be `null` or empty.

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

FromOrganizationLocationBucketLink(string, string, string, string)

public static LinkName FromOrganizationLocationBucketLink(string organizationId, string locationId, string bucketId, string linkId)

Creates a LinkName with the pattern organizations/{organization}/locations/{location}/buckets/{bucket}/links/{link}.

Parameters
Name	Description
`organizationId`	`string` The `Organization` ID. Must not be `null` or empty.
`locationId`	`string` The `Location` ID. Must not be `null` or empty.
`bucketId`	`string` The `Bucket` ID. Must not be `null` or empty.
`linkId`	`string` The `Link` ID. Must not be `null` or empty.

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

FromProjectLocationBucketLink(string, string, string, string)

public static LinkName FromProjectLocationBucketLink(string projectId, string locationId, string bucketId, string linkId)

Creates a LinkName with the pattern projects/{project}/locations/{location}/buckets/{bucket}/links/{link}.

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.
`bucketId`	`string` The `Bucket` ID. Must not be `null` or empty.
`linkId`	`string` The `Link` ID. Must not be `null` or empty.

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

FromUnparsed(UnparsedResourceName)

public static LinkName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a LinkName containing an unparsed resource name.

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

Returns
Type	Description
`LinkName`	A new instance of LinkName 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 LinkName Parse(string linkName)

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

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

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

Remarks

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

projects/{project}/locations/{location}/buckets/{bucket}/links/{link}
organizations/{organization}/locations/{location}/buckets/{bucket}/links/{link}
folders/{folder}/locations/{location}/buckets/{bucket}/links/{link}
billingAccounts/{billing_account}/locations/{location}/buckets/{bucket}/links/{link}

Parse(string, bool)

public static LinkName Parse(string linkName, bool allowUnparsed)

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

Parameters
Name	Description
`linkName`	`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
`LinkName`	The parsed LinkName if successful.

Remarks

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

projects/{project}/locations/{location}/buckets/{bucket}/links/{link}
organizations/{organization}/locations/{location}/buckets/{bucket}/links/{link}
folders/{folder}/locations/{location}/buckets/{bucket}/links/{link}
billingAccounts/{billing_account}/locations/{location}/buckets/{bucket}/links/{link}

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

public static bool TryParse(string linkName, out LinkName result)

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

Parameters
Name	Description
`linkName`	`string` The resource name in string form. Must not be `null`.
`result`	`LinkName` When this method returns, the parsed LinkName, 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}/buckets/{bucket}/links/{link}
organizations/{organization}/locations/{location}/buckets/{bucket}/links/{link}
folders/{folder}/locations/{location}/buckets/{bucket}/links/{link}
billingAccounts/{billing_account}/locations/{location}/buckets/{bucket}/links/{link}

TryParse(string, bool, out LinkName)

public static bool TryParse(string linkName, bool allowUnparsed, out LinkName result)

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

Parameters
Name	Description
`linkName`	`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`	`LinkName` When this method returns, the parsed LinkName, 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}/buckets/{bucket}/links/{link}
organizations/{organization}/locations/{location}/buckets/{bucket}/links/{link}
folders/{folder}/locations/{location}/buckets/{bucket}/links/{link}
billingAccounts/{billing_account}/locations/{location}/buckets/{bucket}/links/{link}

Or may be in any format if allowUnparsed is true.

Operators

operator ==(LinkName, LinkName)

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

Determines whether two specified resource names have the same value.

Parameters
Name	Description
`a`	`LinkName` The first resource name to compare, or null.
`b`	`LinkName` 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 !=(LinkName, LinkName)

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

Determines whether two specified resource names have different values.

Parameters
Name	Description
`a`	`LinkName` The first resource name to compare, or null.
`b`	`LinkName` 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.