Class KeyEventName
Resource name for the KeyEvent
resource.
Inherited Members
Namespace: Google.Analytics.Admin.V1Beta
Assembly: Google.Analytics.Admin.V1Beta.dll
Syntax
public sealed class KeyEventName : IResourceName, IEquatable<KeyEventName>
Constructors
KeyEventName(string, string)
Constructs a new instance of a Keyproperties/{property}/keyEvents/{key_event}
Declaration
public KeyEventName(string propertyId, string keyEventId)
Parameters
Type | Name | Description |
---|---|---|
string | propertyId | The |
string | keyEventId | The |
Properties
IsKnownPattern
Whether this instance contains a resource name with a known pattern.
Declaration
public bool IsKnownPattern { get; }
Property Value
Type | Description |
---|---|
bool |
Implements
KeyEventId
The KeyEvent
ID. Will not be null
, unless this instance contains an unparsed resource name.
Declaration
public string KeyEventId { get; }
Property Value
Type | Description |
---|---|
string |
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 Key
Declaration
public KeyEventName.ResourceNameType Type { get; }
Property Value
Type | Description |
---|---|
Key |
UnparsedResource
The contained Unparsednull
if this instance contains an
unparsed resource name.
Declaration
public UnparsedResourceName UnparsedResource { get; }
Property Value
Type | Description |
---|---|
Unparsed |
Methods
Format(string, string)
Formats the IDs into the string representation of this Keyproperties/{property}/keyEvents/{key_event}
.
Declaration
public static string Format(string propertyId, string keyEventId)
Parameters
Type | Name | Description |
---|---|---|
string | propertyId | The |
string | keyEventId | The |
Returns
Type | Description |
---|---|
string | The string representation of this Key |
FormatPropertyKeyEvent(string, string)
Formats the IDs into the string representation of this Keyproperties/{property}/keyEvents/{key_event}
.
Declaration
public static string FormatPropertyKeyEvent(string propertyId, string keyEventId)
Parameters
Type | Name | Description |
---|---|---|
string | propertyId | The |
string | keyEventId | The |
Returns
Type | Description |
---|---|
string | The string representation of this Key |
FromPropertyKeyEvent(string, string)
Creates a Keyproperties/{property}/keyEvents/{key_event}
.
Declaration
public static KeyEventName FromPropertyKeyEvent(string propertyId, string keyEventId)
Parameters
Type | Name | Description |
---|---|---|
string | propertyId | The |
string | keyEventId | The |
Returns
Type | Description |
---|---|
Key |
A new instance of Key |
FromUnparsed(UnparsedResourceName)
Creates a Key
Declaration
public static KeyEventName FromUnparsed(UnparsedResourceName unparsedResourceName)
Parameters
Type | Name | Description |
---|---|---|
Unparsed |
unparsedResourceName | The unparsed resource name. Must not be |
Returns
Type | Description |
---|---|
Key |
A new instance of Key |
GetHashCode()
Returns a hash code for this resource name.
Declaration
public override int GetHashCode()
Returns
Type | Description |
---|---|
int |
Overrides
Parse(string)
Parses the given resource name string into a new Key
Declaration
public static KeyEventName Parse(string keyEventName)
Parameters
Type | Name | Description |
---|---|---|
string | keyEventName | The resource name in string form. Must not be |
Returns
Type | Description |
---|---|
Key |
The parsed Key |
Remarks
To parse successfully, the resource name must be formatted as one of the following:
properties/{property}/keyEvents/{key_event}
Parse(string, bool)
Parses the given resource name string into a new Key
Declaration
public static KeyEventName Parse(string keyEventName, bool allowUnparsed)
Parameters
Type | Name | Description |
---|---|---|
string | keyEventName | The resource name in string form. Must not be |
bool | allowUnparsed | If |
Returns
Type | Description |
---|---|
Key |
The parsed Key |
Remarks
To parse successfully, the resource name must be formatted as one of the following:
properties/{property}/keyEvents/{key_event}
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
Implements
TryParse(string, out KeyEventName)
Tries to parse the given resource name string into a new Key
Declaration
public static bool TryParse(string keyEventName, out KeyEventName result)
Parameters
Type | Name | Description |
---|---|---|
string | keyEventName | The resource name in string form. Must not be |
Key |
result | When this method returns, the parsed Key |
Returns
Type | Description |
---|---|
bool |
|
Remarks
To parse successfully, the resource name must be formatted as one of the following:
properties/{property}/keyEvents/{key_event}
TryParse(string, bool, out KeyEventName)
Tries to parse the given resource name string into a new Key
Declaration
public static bool TryParse(string keyEventName, bool allowUnparsed, out KeyEventName result)
Parameters
Type | Name | Description |
---|---|---|
string | keyEventName | The resource name in string form. Must not be |
bool | allowUnparsed | If |
Key |
result | When this method returns, the parsed Key |
Returns
Type | Description |
---|---|
bool |
|
Remarks
To parse successfully, the resource name must be formatted as one of the following:
properties/{property}/keyEvents/{key_event}
allowUnparsed
is true
.
Operators
operator ==(KeyEventName, KeyEventName)
Determines whether two specified resource names have the same value.
Declaration
public static bool operator ==(KeyEventName a, KeyEventName b)
Parameters
Type | Name | Description |
---|---|---|
Key |
a | The first resource name to compare, or null. |
Key |
b | The second resource name to compare, or null. |
Returns
Type | Description |
---|---|
bool | true if the value of |
operator !=(KeyEventName, KeyEventName)
Determines whether two specified resource names have different values.
Declaration
public static bool operator !=(KeyEventName a, KeyEventName b)
Parameters
Type | Name | Description |
---|---|---|
Key |
a | The first resource name to compare, or null. |
Key |
b | The second resource name to compare, or null. |
Returns
Type | Description |
---|---|
bool | true if the value of |