Chronicle v1 API - Class LogTypeName (1.1.0) 

public sealed class LogTypeName : IResourceName, IEquatable<LogTypeName>

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

Resource name for the LogType resource.

Inheritance

object > LogTypeName

Namespace

Google.Cloud.Chronicle.V1

Assembly

Google.Cloud.Chronicle.V1.dll

Constructors

LogTypeName(string, string, string, string)

public LogTypeName(string projectId, string locationId, string instanceId, string logTypeId)

Constructs a new instance of a LogTypeName class from the component parts of pattern projects/{project}/locations/{location}/instances/{instance}/logTypes/{log_type}

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

The LogType 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

LogTypeId

public string LogTypeId { get; }

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

The LogTypeName.ResourceNameType of the contained resource name.

Property Value
Type Description
LogTypeNameResourceNameType

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 instanceId, string logTypeId)

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

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

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

The string representation of this LogTypeName with pattern projects/{project}/locations/{location}/instances/{instance}/logTypes/{log_type}.

FormatProjectLocationInstanceLogType(string, string, string, string)

public static string FormatProjectLocationInstanceLogType(string projectId, string locationId, string instanceId, string logTypeId)

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

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

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

The string representation of this LogTypeName with pattern projects/{project}/locations/{location}/instances/{instance}/logTypes/{log_type}.

FromProjectLocationInstanceLogType(string, string, string, string)

public static LogTypeName FromProjectLocationInstanceLogType(string projectId, string locationId, string instanceId, string logTypeId)

Creates a LogTypeName with the pattern projects/{project}/locations/{location}/instances/{instance}/logTypes/{log_type}.

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

The LogType ID. Must not be null or empty.
Returns
Type Description
LogTypeName

A new instance of LogTypeName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static LogTypeName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a LogTypeName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

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

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

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

Parameter
Name Description
logTypeName string

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

The parsed LogTypeName if successful.
Remarks

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

  • projects/{project}/locations/{location}/instances/{instance}/logTypes/{log_type}

Parse(string, bool)

public static LogTypeName Parse(string logTypeName, bool allowUnparsed)

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

Parameters
Name Description
logTypeName 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
LogTypeName

The parsed LogTypeName if successful.
Remarks

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

  • projects/{project}/locations/{location}/instances/{instance}/logTypes/{log_type}

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

public static bool TryParse(string logTypeName, out LogTypeName result)

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

Parameters
Name Description
logTypeName string

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

When this method returns, the parsed LogTypeName, 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}/logTypes/{log_type}

TryParse(string, bool, out LogTypeName)

public static bool TryParse(string logTypeName, bool allowUnparsed, out LogTypeName result)

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

Parameters
Name Description
logTypeName 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 LogTypeName

When this method returns, the parsed LogTypeName, 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}/logTypes/{log_type}

Or may be in any format if allowUnparsed is true.

Operators

operator ==(LogTypeName, LogTypeName)

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

Determines whether two specified resource names have the same value.

Parameters
Name Description
a LogTypeName

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

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

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

Determines whether two specified resource names have different values.

Parameters
Name Description
a LogTypeName

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

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.