Show / Hide Table of Contents

Class EventCreateRuleName

Resource name for the EventCreateRule resource.

Inheritance
object
EventCreateRuleName
Implements
IResourceName
IEquatable<EventCreateRuleName>
Inherited Members
object.GetType()
Namespace: Google.Analytics.Admin.V1Alpha
Assembly: Google.Analytics.Admin.V1Alpha.dll
Syntax
public sealed class EventCreateRuleName : IResourceName, IEquatable<EventCreateRuleName>

Constructors

EventCreateRuleName(string, string, string)

Constructs a new instance of a EventCreateRuleName class from the component parts of pattern properties/{property}/dataStreams/{data_stream}/eventCreateRules/{event_create_rule}

Declaration
public EventCreateRuleName(string propertyId, string dataStreamId, string eventCreateRuleId)
Parameters
Type Name Description
string propertyId

The Property ID. Must not be null or empty.

string dataStreamId

The DataStream ID. Must not be null or empty.

string eventCreateRuleId

The EventCreateRule ID. Must not be null or empty.

Properties

DataStreamId

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

Declaration
public string DataStreamId { get; }
Property Value
Type Description
string

EventCreateRuleId

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

Declaration
public string EventCreateRuleId { get; }
Property Value
Type Description
string

IsKnownPattern

Whether this instance contains a resource name with a known pattern.

Declaration
public bool IsKnownPattern { get; }
Property Value
Type Description
bool
Implements
IResourceName.IsKnownPattern

PropertyId

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

Declaration
public string PropertyId { get; }
Property Value
Type Description
string

Type

The EventCreateRuleName.ResourceNameType of the contained resource name.

Declaration
public EventCreateRuleName.ResourceNameType Type { get; }
Property Value
Type Description
EventCreateRuleName.ResourceNameType

UnparsedResource

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

Declaration
public UnparsedResourceName UnparsedResource { get; }
Property Value
Type Description
UnparsedResourceName

Methods

Format(string, string, string)

Formats the IDs into the string representation of this EventCreateRuleName with pattern properties/{property}/dataStreams/{data_stream}/eventCreateRules/{event_create_rule}.

Declaration
public static string Format(string propertyId, string dataStreamId, string eventCreateRuleId)
Parameters
Type Name Description
string propertyId

The Property ID. Must not be null or empty.

string dataStreamId

The DataStream ID. Must not be null or empty.

string eventCreateRuleId

The EventCreateRule ID. Must not be null or empty.

Returns
Type Description
string

The string representation of this EventCreateRuleName with pattern properties/{property}/dataStreams/{data_stream}/eventCreateRules/{event_create_rule}.

FormatPropertyDataStreamEventCreateRule(string, string, string)

Formats the IDs into the string representation of this EventCreateRuleName with pattern properties/{property}/dataStreams/{data_stream}/eventCreateRules/{event_create_rule}.

Declaration
public static string FormatPropertyDataStreamEventCreateRule(string propertyId, string dataStreamId, string eventCreateRuleId)
Parameters
Type Name Description
string propertyId

The Property ID. Must not be null or empty.

string dataStreamId

The DataStream ID. Must not be null or empty.

string eventCreateRuleId

The EventCreateRule ID. Must not be null or empty.

Returns
Type Description
string

The string representation of this EventCreateRuleName with pattern properties/{property}/dataStreams/{data_stream}/eventCreateRules/{event_create_rule}.

FromPropertyDataStreamEventCreateRule(string, string, string)

Creates a EventCreateRuleName with the pattern properties/{property}/dataStreams/{data_stream}/eventCreateRules/{event_create_rule}.

Declaration
public static EventCreateRuleName FromPropertyDataStreamEventCreateRule(string propertyId, string dataStreamId, string eventCreateRuleId)
Parameters
Type Name Description
string propertyId

The Property ID. Must not be null or empty.

string dataStreamId

The DataStream ID. Must not be null or empty.

string eventCreateRuleId

The EventCreateRule ID. Must not be null or empty.

Returns
Type Description
EventCreateRuleName

A new instance of EventCreateRuleName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

Creates a EventCreateRuleName containing an unparsed resource name.

Declaration
public static EventCreateRuleName FromUnparsed(UnparsedResourceName unparsedResourceName)
Parameters
Type Name Description
UnparsedResourceName unparsedResourceName

The unparsed resource name. Must not be null.

Returns
Type Description
EventCreateRuleName

A new instance of EventCreateRuleName containing the provided unparsedResourceName.

GetHashCode()

Returns a hash code for this resource name.

Declaration
public override int GetHashCode()
Returns
Type Description
int
Overrides
object.GetHashCode()

Parse(string)

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

Declaration
public static EventCreateRuleName Parse(string eventCreateRuleName)
Parameters
Type Name Description
string eventCreateRuleName

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

Returns
Type Description
EventCreateRuleName

The parsed EventCreateRuleName if successful.

Remarks

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

  • properties/{property}/dataStreams/{data_stream}/eventCreateRules/{event_create_rule}

Parse(string, bool)

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

Declaration
public static EventCreateRuleName Parse(string eventCreateRuleName, bool allowUnparsed)
Parameters
Type Name Description
string eventCreateRuleName

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

bool allowUnparsed

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
EventCreateRuleName

The parsed EventCreateRuleName if successful.

Remarks

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

  • properties/{property}/dataStreams/{data_stream}/eventCreateRules/{event_create_rule}
Or may be in any format if allowUnparsed is true.

ToString()

The string representation of the resource name.

Declaration
public override string ToString()
Returns
Type Description
string

The string representation of the resource name.

Overrides
object.ToString()
Implements
IResourceName.ToString()

TryParse(string, out EventCreateRuleName)

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

Declaration
public static bool TryParse(string eventCreateRuleName, out EventCreateRuleName result)
Parameters
Type Name Description
string eventCreateRuleName

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

EventCreateRuleName result

When this method returns, the parsed EventCreateRuleName, 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:

  • properties/{property}/dataStreams/{data_stream}/eventCreateRules/{event_create_rule}

TryParse(string, bool, out EventCreateRuleName)

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

Declaration
public static bool TryParse(string eventCreateRuleName, bool allowUnparsed, out EventCreateRuleName result)
Parameters
Type Name Description
string eventCreateRuleName

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

bool allowUnparsed

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.

EventCreateRuleName result

When this method returns, the parsed EventCreateRuleName, 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:

  • properties/{property}/dataStreams/{data_stream}/eventCreateRules/{event_create_rule}
Or may be in any format if allowUnparsed is true.

Operators

operator ==(EventCreateRuleName, EventCreateRuleName)

Determines whether two specified resource names have the same value.

Declaration
public static bool operator ==(EventCreateRuleName a, EventCreateRuleName b)
Parameters
Type Name Description
EventCreateRuleName a

The first resource name to compare, or null.

EventCreateRuleName b

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

Determines whether two specified resource names have different values.

Declaration
public static bool operator !=(EventCreateRuleName a, EventCreateRuleName b)
Parameters
Type Name Description
EventCreateRuleName a

The first resource name to compare, or null.

EventCreateRuleName b

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.

In this article
Back to top Generated by DocFX