Google Cloud Logging v2 API - Class LogBucketName (4.1.0)

public sealed class LogBucketName : IResourceName, IEquatable<LogBucketName>

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

Resource name for the LogBucket resource.

Inheritance

object > LogBucketName

Implements

IResourceName, IEquatable LogBucketName

Inherited Members

object.GetType()

Namespace

Google.Cloud.Logging.V2

Assembly

Google.Cloud.Logging.V2.dll

Constructors

LogBucketName(string, string, string)

public LogBucketName(string projectId, string locationId, string bucketId)

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

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.

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`

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

The LogBucketName.ResourceNameType of the contained resource name.

Property Value
Type	Description
`LogBucketNameResourceNameType`

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

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

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.

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

FormatBillingAccountLocationBucket(string, string, string)

public static string FormatBillingAccountLocationBucket(string billingAccountId, string locationId, string bucketId)

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

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.

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

FormatFolderLocationBucket(string, string, string)

public static string FormatFolderLocationBucket(string folderId, string locationId, string bucketId)

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

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.

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

FormatOrganizationLocationBucket(string, string, string)

public static string FormatOrganizationLocationBucket(string organizationId, string locationId, string bucketId)

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

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.

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

FormatProjectLocationBucket(string, string, string)

public static string FormatProjectLocationBucket(string projectId, string locationId, string bucketId)

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

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.

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

FromBillingAccountLocationBucket(string, string, string)

public static LogBucketName FromBillingAccountLocationBucket(string billingAccountId, string locationId, string bucketId)

Creates a LogBucketName with the pattern billingAccounts/{billing_account}/locations/{location}/buckets/{bucket}.

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.

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

FromFolderLocationBucket(string, string, string)

public static LogBucketName FromFolderLocationBucket(string folderId, string locationId, string bucketId)

Creates a LogBucketName with the pattern folders/{folder}/locations/{location}/buckets/{bucket}.

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.

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

FromOrganizationLocationBucket(string, string, string)

public static LogBucketName FromOrganizationLocationBucket(string organizationId, string locationId, string bucketId)

Creates a LogBucketName with the pattern organizations/{organization}/locations/{location}/buckets/{bucket}.

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.

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

FromProjectLocationBucket(string, string, string)

public static LogBucketName FromProjectLocationBucket(string projectId, string locationId, string bucketId)

Creates a LogBucketName with the pattern projects/{project}/locations/{location}/buckets/{bucket}.

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.

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

FromUnparsed(UnparsedResourceName)

public static LogBucketName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a LogBucketName containing an unparsed resource name.

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

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

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

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

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

Remarks

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

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

Parse(string, bool)

public static LogBucketName Parse(string logBucketName, bool allowUnparsed)

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

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

Remarks

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

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

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

public static bool TryParse(string logBucketName, out LogBucketName result)

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

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

TryParse(string, bool, out LogBucketName)

public static bool TryParse(string logBucketName, bool allowUnparsed, out LogBucketName result)

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

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

Or may be in any format if allowUnparsed is true.

Operators

operator ==(LogBucketName, LogBucketName)

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

Parameters
Name	Description
`a`	`LogBucketName`
`b`	`LogBucketName`

Returns
Type	Description
`bool`

operator !=(LogBucketName, LogBucketName)

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

Parameters
Name	Description
`a`	`LogBucketName`
`b`	`LogBucketName`

Returns
Type	Description
`bool`