Show / Hide Table of Contents

Class MeasurementProtocolSecretName

Resource name for the MeasurementProtocolSecret resource.

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

Constructors

MeasurementProtocolSecretName(string, string, string)

Constructs a new instance of a MeasurementProtocolSecretName class from the component parts of pattern properties/{property}/dataStreams/{data_stream}/measurementProtocolSecrets/{measurement_protocol_secret}

Declaration
public MeasurementProtocolSecretName(string propertyId, string dataStreamId, string measurementProtocolSecretId)
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 measurementProtocolSecretId

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

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

MeasurementProtocolSecretId

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

Declaration
public string MeasurementProtocolSecretId { 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 MeasurementProtocolSecretName.ResourceNameType of the contained resource name.

Declaration
public MeasurementProtocolSecretName.ResourceNameType Type { get; }
Property Value
Type Description
MeasurementProtocolSecretName.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 MeasurementProtocolSecretName with pattern properties/{property}/dataStreams/{data_stream}/measurementProtocolSecrets/{measurement_protocol_secret} .

Declaration
public static string Format(string propertyId, string dataStreamId, string measurementProtocolSecretId)
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 measurementProtocolSecretId

The MeasurementProtocolSecret ID. Must not be null or empty.

Returns
Type Description
string

The string representation of this MeasurementProtocolSecretName with pattern properties/{property}/dataStreams/{data_stream}/measurementProtocolSecrets/{measurement_protocol_secret} .

FormatPropertyDataStreamMeasurementProtocolSecret(string, string, string)

Formats the IDs into the string representation of this MeasurementProtocolSecretName with pattern properties/{property}/dataStreams/{data_stream}/measurementProtocolSecrets/{measurement_protocol_secret} .

Declaration
public static string FormatPropertyDataStreamMeasurementProtocolSecret(string propertyId, string dataStreamId, string measurementProtocolSecretId)
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 measurementProtocolSecretId

The MeasurementProtocolSecret ID. Must not be null or empty.

Returns
Type Description
string

The string representation of this MeasurementProtocolSecretName with pattern properties/{property}/dataStreams/{data_stream}/measurementProtocolSecrets/{measurement_protocol_secret} .

FromPropertyDataStreamMeasurementProtocolSecret(string, string, string)

Creates a MeasurementProtocolSecretName with the pattern properties/{property}/dataStreams/{data_stream}/measurementProtocolSecrets/{measurement_protocol_secret} .

Declaration
public static MeasurementProtocolSecretName FromPropertyDataStreamMeasurementProtocolSecret(string propertyId, string dataStreamId, string measurementProtocolSecretId)
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 measurementProtocolSecretId

The MeasurementProtocolSecret ID. Must not be null or empty.

Returns
Type Description
MeasurementProtocolSecretName

A new instance of MeasurementProtocolSecretName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

Creates a MeasurementProtocolSecretName containing an unparsed resource name.

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

The unparsed resource name. Must not be null.

Returns
Type Description
MeasurementProtocolSecretName

A new instance of MeasurementProtocolSecretName 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 MeasurementProtocolSecretName instance.

Declaration
public static MeasurementProtocolSecretName Parse(string measurementProtocolSecretName)
Parameters
Type Name Description
string measurementProtocolSecretName

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

Returns
Type Description
MeasurementProtocolSecretName

The parsed MeasurementProtocolSecretName if successful.

Remarks

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

  • properties/{property}/dataStreams/{data_stream}/measurementProtocolSecrets/{measurement_protocol_secret}

Parse(string, bool)

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

Declaration
public static MeasurementProtocolSecretName Parse(string measurementProtocolSecretName, bool allowUnparsed)
Parameters
Type Name Description
string measurementProtocolSecretName

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
MeasurementProtocolSecretName

The parsed MeasurementProtocolSecretName if successful.

Remarks

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

  • properties/{property}/dataStreams/{data_stream}/measurementProtocolSecrets/{measurement_protocol_secret}
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 MeasurementProtocolSecretName)

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

Declaration
public static bool TryParse(string measurementProtocolSecretName, out MeasurementProtocolSecretName result)
Parameters
Type Name Description
string measurementProtocolSecretName

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

MeasurementProtocolSecretName result

When this method returns, the parsed MeasurementProtocolSecretName, 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}/measurementProtocolSecrets/{measurement_protocol_secret}

TryParse(string, bool, out MeasurementProtocolSecretName)

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

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

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.

MeasurementProtocolSecretName result

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

Operators

operator ==(MeasurementProtocolSecretName, MeasurementProtocolSecretName)

Determines whether two specified resource names have the same value.

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

The first resource name to compare, or null.

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

Determines whether two specified resource names have different values.

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

The first resource name to compare, or null.

MeasurementProtocolSecretName 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