Chronicle v1 API - Class LogTypeSchemaName (1.1.0) 

public sealed class LogTypeSchemaName : IResourceName, IEquatable<LogTypeSchemaName>

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

Resource name for the LogTypeSchema resource.

Inheritance

object > LogTypeSchemaName

Namespace

Google.Cloud.Chronicle.V1

Assembly

Google.Cloud.Chronicle.V1.dll

Constructors

LogTypeSchemaName(string, string, string, string, string)

public LogTypeSchemaName(string projectId, string locationId, string instanceId, string feedSourceTypeId, string logTypeId)

Constructs a new instance of a LogTypeSchemaName class from the component parts of pattern projects/{project}/locations/{location}/instances/{instance}/feedSourceTypeSchemas/{feed_source_type}/logTypeSchemas/{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.
feedSourceTypeId string

The FeedSourceType ID. Must not be null or empty.
logTypeId string

The LogType ID. Must not be null or empty.

Properties

FeedSourceTypeId

public string FeedSourceTypeId { get; }

The FeedSourceType ID. Will not be null, unless this instance contains an unparsed resource name.

Property Value
Type Description
string

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

The LogTypeSchemaName.ResourceNameType of the contained resource name.

Property Value
Type Description
LogTypeSchemaNameResourceNameType

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

public static string Format(string projectId, string locationId, string instanceId, string feedSourceTypeId, string logTypeId)

Formats the IDs into the string representation of this LogTypeSchemaName with pattern projects/{project}/locations/{location}/instances/{instance}/feedSourceTypeSchemas/{feed_source_type}/logTypeSchemas/{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.
feedSourceTypeId string

The FeedSourceType 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 LogTypeSchemaName with pattern projects/{project}/locations/{location}/instances/{instance}/feedSourceTypeSchemas/{feed_source_type}/logTypeSchemas/{log_type} .

FormatProjectLocationInstanceFeedSourceTypeLogType(string, string, string, string, string)

public static string FormatProjectLocationInstanceFeedSourceTypeLogType(string projectId, string locationId, string instanceId, string feedSourceTypeId, string logTypeId)

Formats the IDs into the string representation of this LogTypeSchemaName with pattern projects/{project}/locations/{location}/instances/{instance}/feedSourceTypeSchemas/{feed_source_type}/logTypeSchemas/{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.
feedSourceTypeId string

The FeedSourceType 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 LogTypeSchemaName with pattern projects/{project}/locations/{location}/instances/{instance}/feedSourceTypeSchemas/{feed_source_type}/logTypeSchemas/{log_type} .

FromProjectLocationInstanceFeedSourceTypeLogType(string, string, string, string, string)

public static LogTypeSchemaName FromProjectLocationInstanceFeedSourceTypeLogType(string projectId, string locationId, string instanceId, string feedSourceTypeId, string logTypeId)

Creates a LogTypeSchemaName with the pattern projects/{project}/locations/{location}/instances/{instance}/feedSourceTypeSchemas/{feed_source_type}/logTypeSchemas/{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.
feedSourceTypeId string

The FeedSourceType ID. Must not be null or empty.
logTypeId string

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

A new instance of LogTypeSchemaName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static LogTypeSchemaName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a LogTypeSchemaName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

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

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

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

Parameter
Name Description
logTypeSchemaName string

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

The parsed LogTypeSchemaName if successful.
Remarks

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

  • projects/{project}/locations/{location}/instances/{instance}/feedSourceTypeSchemas/{feed_source_type}/logTypeSchemas/{log_type}

Parse(string, bool)

public static LogTypeSchemaName Parse(string logTypeSchemaName, bool allowUnparsed)

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

Parameters
Name Description
logTypeSchemaName 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
LogTypeSchemaName

The parsed LogTypeSchemaName if successful.
Remarks

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

  • projects/{project}/locations/{location}/instances/{instance}/feedSourceTypeSchemas/{feed_source_type}/logTypeSchemas/{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 LogTypeSchemaName)

public static bool TryParse(string logTypeSchemaName, out LogTypeSchemaName result)

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

Parameters
Name Description
logTypeSchemaName string

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

When this method returns, the parsed LogTypeSchemaName, 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}/feedSourceTypeSchemas/{feed_source_type}/logTypeSchemas/{log_type}

TryParse(string, bool, out LogTypeSchemaName)

public static bool TryParse(string logTypeSchemaName, bool allowUnparsed, out LogTypeSchemaName result)

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

Parameters
Name Description
logTypeSchemaName 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 LogTypeSchemaName

When this method returns, the parsed LogTypeSchemaName, 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}/feedSourceTypeSchemas/{feed_source_type}/logTypeSchemas/{log_type}

Or may be in any format if allowUnparsed is true.

Operators

operator ==(LogTypeSchemaName, LogTypeSchemaName)

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

Determines whether two specified resource names have the same value.

Parameters
Name Description
a LogTypeSchemaName

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

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

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

Determines whether two specified resource names have different values.

Parameters
Name Description
a LogTypeSchemaName

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

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.