Chronicle v1 API - Class RuleDeploymentName (1.0.0-beta02) 

public sealed class RuleDeploymentName : IResourceName, IEquatable<RuleDeploymentName>

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

Resource name for the RuleDeployment resource.

Inheritance

object > RuleDeploymentName

Namespace

Google.Cloud.Chronicle.V1

Assembly

Google.Cloud.Chronicle.V1.dll

Constructors

RuleDeploymentName(string, string, string, string)

public RuleDeploymentName(string projectId, string locationId, string instanceId, string ruleId)

Constructs a new instance of a RuleDeploymentName class from the component parts of pattern projects/{project}/locations/{location}/instances/{instance}/rules/{rule}/deployment

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

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

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

RuleId

public string RuleId { get; }

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

Property Value
Type Description
string

Type

public RuleDeploymentName.ResourceNameType Type { get; }

The RuleDeploymentName.ResourceNameType of the contained resource name.

Property Value
Type Description
RuleDeploymentNameResourceNameType

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

Formats the IDs into the string representation of this RuleDeploymentName with pattern projects/{project}/locations/{location}/instances/{instance}/rules/{rule}/deployment.

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

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

The string representation of this RuleDeploymentName with pattern projects/{project}/locations/{location}/instances/{instance}/rules/{rule}/deployment.

FormatProjectLocationInstanceRule(string, string, string, string)

public static string FormatProjectLocationInstanceRule(string projectId, string locationId, string instanceId, string ruleId)

Formats the IDs into the string representation of this RuleDeploymentName with pattern projects/{project}/locations/{location}/instances/{instance}/rules/{rule}/deployment.

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

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

The string representation of this RuleDeploymentName with pattern projects/{project}/locations/{location}/instances/{instance}/rules/{rule}/deployment.

FromProjectLocationInstanceRule(string, string, string, string)

public static RuleDeploymentName FromProjectLocationInstanceRule(string projectId, string locationId, string instanceId, string ruleId)

Creates a RuleDeploymentName with the pattern projects/{project}/locations/{location}/instances/{instance}/rules/{rule}/deployment.

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

The Rule ID. Must not be null or empty.
Returns
Type Description
RuleDeploymentName

A new instance of RuleDeploymentName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static RuleDeploymentName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a RuleDeploymentName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

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

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

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

Parameter
Name Description
ruleDeploymentName string

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

The parsed RuleDeploymentName if successful.
Remarks

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

  • projects/{project}/locations/{location}/instances/{instance}/rules/{rule}/deployment

Parse(string, bool)

public static RuleDeploymentName Parse(string ruleDeploymentName, bool allowUnparsed)

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

Parameters
Name Description
ruleDeploymentName 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
RuleDeploymentName

The parsed RuleDeploymentName if successful.
Remarks

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

  • projects/{project}/locations/{location}/instances/{instance}/rules/{rule}/deployment
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 RuleDeploymentName)

public static bool TryParse(string ruleDeploymentName, out RuleDeploymentName result)

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

Parameters
Name Description
ruleDeploymentName string

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

When this method returns, the parsed RuleDeploymentName, 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}/rules/{rule}/deployment

TryParse(string, bool, out RuleDeploymentName)

public static bool TryParse(string ruleDeploymentName, bool allowUnparsed, out RuleDeploymentName result)

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

Parameters
Name Description
ruleDeploymentName 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 RuleDeploymentName

When this method returns, the parsed RuleDeploymentName, 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}/rules/{rule}/deployment
Or may be in any format if allowUnparsed is true.

Operators

operator ==(RuleDeploymentName, RuleDeploymentName)

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

Determines whether two specified resource names have the same value.

Parameters
Name Description
a RuleDeploymentName

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

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

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

Determines whether two specified resource names have different values.

Parameters
Name Description
a RuleDeploymentName

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

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.