Google Cloud Logging v2 API - Class LogSinkName (4.1.0)

public sealed class LogSinkName : IResourceName, IEquatable<LogSinkName>

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

Resource name for the LogSink resource.

Inheritance

object > LogSinkName

Implements

IResourceName, IEquatable LogSinkName

Inherited Members

object.GetType()

Namespace

Google.Cloud.Logging.V2

Assembly

Google.Cloud.Logging.V2.dll

Constructors

LogSinkName(string, string)

public LogSinkName(string projectId, string sinkId)

Constructs a new instance of a LogSinkName class from the component parts of pattern projects/{project}/sinks/{sink}

Parameters
Name	Description
`projectId`	`string` The `Project` ID. Must not be `null` or empty.
`sinkId`	`string` The `Sink` 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`

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`

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`

SinkId

public string SinkId { get; }

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

Property Value
Type	Description
`string`

Type

public LogSinkName.ResourceNameType Type { get; }

The LogSinkName.ResourceNameType of the contained resource name.

Property Value
Type	Description
`LogSinkNameResourceNameType`

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

Formats the IDs into the string representation of this LogSinkName with pattern projects/{project}/sinks/{sink}.

Parameters
Name	Description
`projectId`	`string` The `Project` ID. Must not be `null` or empty.
`sinkId`	`string` The `Sink` ID. Must not be `null` or empty.

Returns
Type	Description
`string`	The string representation of this LogSinkName with pattern `projects/{project}/sinks/{sink}` .

FormatBillingAccountSink(string, string)

public static string FormatBillingAccountSink(string billingAccountId, string sinkId)

Formats the IDs into the string representation of this LogSinkName with pattern billingAccounts/{billing_account}/sinks/{sink}.

Parameters
Name	Description
`billingAccountId`	`string` The `BillingAccount` ID. Must not be `null` or empty.
`sinkId`	`string` The `Sink` ID. Must not be `null` or empty.

Returns
Type	Description
`string`	The string representation of this LogSinkName with pattern `billingAccounts/{billing_account}/sinks/{sink}`.

FormatFolderSink(string, string)

public static string FormatFolderSink(string folderId, string sinkId)

Formats the IDs into the string representation of this LogSinkName with pattern folders/{folder}/sinks/{sink}.

Parameters
Name	Description
`folderId`	`string` The `Folder` ID. Must not be `null` or empty.
`sinkId`	`string` The `Sink` ID. Must not be `null` or empty.

Returns
Type	Description
`string`	The string representation of this LogSinkName with pattern `folders/{folder}/sinks/{sink}` .

FormatOrganizationSink(string, string)

public static string FormatOrganizationSink(string organizationId, string sinkId)

Formats the IDs into the string representation of this LogSinkName with pattern organizations/{organization}/sinks/{sink}.

Parameters
Name	Description
`organizationId`	`string` The `Organization` ID. Must not be `null` or empty.
`sinkId`	`string` The `Sink` ID. Must not be `null` or empty.

Returns
Type	Description
`string`	The string representation of this LogSinkName with pattern `organizations/{organization}/sinks/{sink}`.

FormatProjectSink(string, string)

public static string FormatProjectSink(string projectId, string sinkId)

Formats the IDs into the string representation of this LogSinkName with pattern projects/{project}/sinks/{sink}.

Parameters
Name	Description
`projectId`	`string` The `Project` ID. Must not be `null` or empty.
`sinkId`	`string` The `Sink` ID. Must not be `null` or empty.

Returns
Type	Description
`string`	The string representation of this LogSinkName with pattern `projects/{project}/sinks/{sink}` .

FromBillingAccountSink(string, string)

public static LogSinkName FromBillingAccountSink(string billingAccountId, string sinkId)

Creates a LogSinkName with the pattern billingAccounts/{billing_account}/sinks/{sink}.

Parameters
Name	Description
`billingAccountId`	`string` The `BillingAccount` ID. Must not be `null` or empty.
`sinkId`	`string` The `Sink` ID. Must not be `null` or empty.

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

FromFolderSink(string, string)

public static LogSinkName FromFolderSink(string folderId, string sinkId)

Creates a LogSinkName with the pattern folders/{folder}/sinks/{sink}.

Parameters
Name	Description
`folderId`	`string` The `Folder` ID. Must not be `null` or empty.
`sinkId`	`string` The `Sink` ID. Must not be `null` or empty.

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

FromOrganizationSink(string, string)

public static LogSinkName FromOrganizationSink(string organizationId, string sinkId)

Creates a LogSinkName with the pattern organizations/{organization}/sinks/{sink}.

Parameters
Name	Description
`organizationId`	`string` The `Organization` ID. Must not be `null` or empty.
`sinkId`	`string` The `Sink` ID. Must not be `null` or empty.

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

FromProjectSink(string, string)

public static LogSinkName FromProjectSink(string projectId, string sinkId)

Creates a LogSinkName with the pattern projects/{project}/sinks/{sink}.

Parameters
Name	Description
`projectId`	`string` The `Project` ID. Must not be `null` or empty.
`sinkId`	`string` The `Sink` ID. Must not be `null` or empty.

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

FromUnparsed(UnparsedResourceName)

public static LogSinkName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a LogSinkName containing an unparsed resource name.

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

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

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

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

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

Remarks

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

projects/{project}/sinks/{sink}
organizations/{organization}/sinks/{sink}
folders/{folder}/sinks/{sink}
billingAccounts/{billing_account}/sinks/{sink}

Parse(string, bool)

public static LogSinkName Parse(string logSinkName, bool allowUnparsed)

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

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

Remarks

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

projects/{project}/sinks/{sink}
organizations/{organization}/sinks/{sink}
folders/{folder}/sinks/{sink}
billingAccounts/{billing_account}/sinks/{sink}

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

public static bool TryParse(string logSinkName, out LogSinkName result)

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

Parameters
Name	Description
`logSinkName`	`string` The resource name in string form. Must not be `null`.
`result`	`LogSinkName` When this method returns, the parsed LogSinkName, 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}/sinks/{sink}
organizations/{organization}/sinks/{sink}
folders/{folder}/sinks/{sink}
billingAccounts/{billing_account}/sinks/{sink}

TryParse(string, bool, out LogSinkName)

public static bool TryParse(string logSinkName, bool allowUnparsed, out LogSinkName result)

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

Parameters
Name	Description
`logSinkName`	`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`	`LogSinkName` When this method returns, the parsed LogSinkName, 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}/sinks/{sink}
organizations/{organization}/sinks/{sink}
folders/{folder}/sinks/{sink}
billingAccounts/{billing_account}/sinks/{sink}

Or may be in any format if allowUnparsed is true.

Operators

operator ==(LogSinkName, LogSinkName)

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

Parameters
Name	Description
`a`	`LogSinkName`
`b`	`LogSinkName`

Returns
Type	Description
`bool`

operator !=(LogSinkName, LogSinkName)

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

Parameters
Name	Description
`a`	`LogSinkName`
`b`	`LogSinkName`

Returns
Type	Description
`bool`