Google Cloud Logging v2 API - Class LogViewName (4.1.0) 

public sealed class LogViewName : IResourceName, IEquatable<LogViewName>

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

Resource name for the LogView resource.

Inheritance

object > LogViewName

Namespace

Google.Cloud.Logging.V2

Assembly

Google.Cloud.Logging.V2.dll

Constructors

LogViewName(string, string, string, string)

public LogViewName(string projectId, string locationId, string bucketId, string viewId)

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

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

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

The LogViewName.ResourceNameType of the contained resource name.

Property Value
Type Description
LogViewNameResourceNameType

UnparsedResource

public UnparsedResourceName UnparsedResource { get; }

The contained UnparsedResourceName. Only non-null if this instance contains an unparsed resource name.

Property Value
Type Description
UnparsedResourceName

ViewId

public string ViewId { get; }

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

Property Value
Type Description
string

Methods

Format(string, string, string, string)

public static string Format(string projectId, string locationId, string bucketId, string viewId)

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

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

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

The string representation of this LogViewName with pattern projects/{project}/locations/{location}/buckets/{bucket}/views/{view}.

FormatBillingAccountLocationBucketView(string, string, string, string)

public static string FormatBillingAccountLocationBucketView(string billingAccountId, string locationId, string bucketId, string viewId)

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

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

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

The string representation of this LogViewName with pattern billingAccounts/{billing_account}/locations/{location}/buckets/{bucket}/views/{view}.

FormatFolderLocationBucketView(string, string, string, string)

public static string FormatFolderLocationBucketView(string folderId, string locationId, string bucketId, string viewId)

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

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

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

The string representation of this LogViewName with pattern folders/{folder}/locations/{location}/buckets/{bucket}/views/{view}.

FormatOrganizationLocationBucketView(string, string, string, string)

public static string FormatOrganizationLocationBucketView(string organizationId, string locationId, string bucketId, string viewId)

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

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

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

The string representation of this LogViewName with pattern organizations/{organization}/locations/{location}/buckets/{bucket}/views/{view}.

FormatProjectLocationBucketView(string, string, string, string)

public static string FormatProjectLocationBucketView(string projectId, string locationId, string bucketId, string viewId)

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

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

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

The string representation of this LogViewName with pattern projects/{project}/locations/{location}/buckets/{bucket}/views/{view}.

FromBillingAccountLocationBucketView(string, string, string, string)

public static LogViewName FromBillingAccountLocationBucketView(string billingAccountId, string locationId, string bucketId, string viewId)

Creates a LogViewName with the pattern billingAccounts/{billing_account}/locations/{location}/buckets/{bucket}/views/{view}.

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

The View ID. Must not be null or empty.
Returns
Type Description
LogViewName

A new instance of LogViewName constructed from the provided ids.

FromFolderLocationBucketView(string, string, string, string)

public static LogViewName FromFolderLocationBucketView(string folderId, string locationId, string bucketId, string viewId)

Creates a LogViewName with the pattern folders/{folder}/locations/{location}/buckets/{bucket}/views/{view}.

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

The View ID. Must not be null or empty.
Returns
Type Description
LogViewName

A new instance of LogViewName constructed from the provided ids.

FromOrganizationLocationBucketView(string, string, string, string)

public static LogViewName FromOrganizationLocationBucketView(string organizationId, string locationId, string bucketId, string viewId)

Creates a LogViewName with the pattern organizations/{organization}/locations/{location}/buckets/{bucket}/views/{view}.

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

The View ID. Must not be null or empty.
Returns
Type Description
LogViewName

A new instance of LogViewName constructed from the provided ids.

FromProjectLocationBucketView(string, string, string, string)

public static LogViewName FromProjectLocationBucketView(string projectId, string locationId, string bucketId, string viewId)

Creates a LogViewName with the pattern projects/{project}/locations/{location}/buckets/{bucket}/views/{view}.

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

The View ID. Must not be null or empty.
Returns
Type Description
LogViewName

A new instance of LogViewName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static LogViewName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a LogViewName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

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

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

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

Parameter
Name Description
logViewName string

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

The parsed LogViewName if successful.
Remarks

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

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

Parse(string, bool)

public static LogViewName Parse(string logViewName, bool allowUnparsed)

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

Parameters
Name Description
logViewName 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
LogViewName

The parsed LogViewName if successful.
Remarks

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

  • projects/{project}/locations/{location}/buckets/{bucket}/views/{view}
  • organizations/{organization}/locations/{location}/buckets/{bucket}/views/{view}
  • folders/{folder}/locations/{location}/buckets/{bucket}/views/{view}
  • billingAccounts/{billing_account}/locations/{location}/buckets/{bucket}/views/{view}
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 LogViewName)

public static bool TryParse(string logViewName, out LogViewName result)

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

Parameters
Name Description
logViewName string

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

When this method returns, the parsed LogViewName, 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}/views/{view}
  • organizations/{organization}/locations/{location}/buckets/{bucket}/views/{view}
  • folders/{folder}/locations/{location}/buckets/{bucket}/views/{view}
  • billingAccounts/{billing_account}/locations/{location}/buckets/{bucket}/views/{view}

TryParse(string, bool, out LogViewName)

public static bool TryParse(string logViewName, bool allowUnparsed, out LogViewName result)

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

Parameters
Name Description
logViewName 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 LogViewName

When this method returns, the parsed LogViewName, 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}/views/{view}
  • organizations/{organization}/locations/{location}/buckets/{bucket}/views/{view}
  • folders/{folder}/locations/{location}/buckets/{bucket}/views/{view}
  • billingAccounts/{billing_account}/locations/{location}/buckets/{bucket}/views/{view}
Or may be in any format if allowUnparsed is true.

Operators

operator ==(LogViewName, LogViewName)

public static bool operator ==(LogViewName a, LogViewName b)
Parameters
Name Description
a LogViewName
b LogViewName
Returns
Type Description
bool

operator !=(LogViewName, LogViewName)

public static bool operator !=(LogViewName a, LogViewName b)
Parameters
Name Description
a LogViewName
b LogViewName
Returns
Type Description
bool