Class OrganizationName
Resource name for the Organization
resource.
Inherited Members
Namespace: Google.Ads.MarketingPlatform.Admin.V1Alpha
Assembly: Google.Ads.MarketingPlatform.Admin.V1Alpha.dll
Syntax
public sealed class OrganizationName : IResourceName, IEquatable<OrganizationName>
Constructors
OrganizationName(string)
Constructs a new instance of a OrganizationName class from the component parts of pattern
organizations/{organization}
Declaration
public OrganizationName(string organizationId)
Parameters
Type | Name | Description |
---|---|---|
string | organizationId | 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
OrganizationId
The Organization
ID. Will not be null
, unless this instance contains an unparsed resource
name.
Declaration
public string OrganizationId { get; }
Property Value
Type | Description |
---|---|
string |
Type
The OrganizationName.ResourceNameType of the contained resource name.
Declaration
public OrganizationName.ResourceNameType Type { get; }
Property Value
Type | Description |
---|---|
OrganizationName.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)
Formats the IDs into the string representation of this OrganizationName with pattern
organizations/{organization}
.
Declaration
public static string Format(string organizationId)
Parameters
Type | Name | Description |
---|---|---|
string | organizationId | The |
Returns
Type | Description |
---|---|
string | The string representation of this OrganizationName with pattern
|
FormatOrganization(string)
Formats the IDs into the string representation of this OrganizationName with pattern
organizations/{organization}
.
Declaration
public static string FormatOrganization(string organizationId)
Parameters
Type | Name | Description |
---|---|---|
string | organizationId | The |
Returns
Type | Description |
---|---|
string | The string representation of this OrganizationName with pattern
|
FromOrganization(string)
Creates a OrganizationName with the pattern organizations/{organization}
.
Declaration
public static OrganizationName FromOrganization(string organizationId)
Parameters
Type | Name | Description |
---|---|---|
string | organizationId | The |
Returns
Type | Description |
---|---|
OrganizationName | A new instance of OrganizationName constructed from the provided ids. |
FromUnparsed(UnparsedResourceName)
Creates a OrganizationName containing an unparsed resource name.
Declaration
public static OrganizationName FromUnparsed(UnparsedResourceName unparsedResourceName)
Parameters
Type | Name | Description |
---|---|---|
UnparsedResourceName | unparsedResourceName | The unparsed resource name. Must not be |
Returns
Type | Description |
---|---|
OrganizationName | A new instance of OrganizationName containing the provided
|
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 OrganizationName instance.
Declaration
public static OrganizationName Parse(string organizationName)
Parameters
Type | Name | Description |
---|---|---|
string | organizationName | The resource name in string form. Must not be |
Returns
Type | Description |
---|---|
OrganizationName | The parsed OrganizationName if successful. |
Remarks
To parse successfully, the resource name must be formatted as one of the following:
organizations/{organization}
Parse(string, bool)
Parses the given resource name string into a new OrganizationName instance; optionally allowing an unparseable resource name.
Declaration
public static OrganizationName Parse(string organizationName, bool allowUnparsed)
Parameters
Type | Name | Description |
---|---|---|
string | organizationName | The resource name in string form. Must not be |
bool | allowUnparsed | If |
Returns
Type | Description |
---|---|
OrganizationName | The parsed OrganizationName if successful. |
Remarks
To parse successfully, the resource name must be formatted as one of the following:
organizations/{organization}
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 OrganizationName)
Tries to parse the given resource name string into a new OrganizationName instance.
Declaration
public static bool TryParse(string organizationName, out OrganizationName result)
Parameters
Type | Name | Description |
---|---|---|
string | organizationName | The resource name in string form. Must not be |
OrganizationName | result | When this method returns, the parsed OrganizationName, or |
Returns
Type | Description |
---|---|
bool |
|
Remarks
To parse successfully, the resource name must be formatted as one of the following:
organizations/{organization}
TryParse(string, bool, out OrganizationName)
Tries to parse the given resource name string into a new OrganizationName instance; optionally allowing an unparseable resource name.
Declaration
public static bool TryParse(string organizationName, bool allowUnparsed, out OrganizationName result)
Parameters
Type | Name | Description |
---|---|---|
string | organizationName | The resource name in string form. Must not be |
bool | allowUnparsed | If |
OrganizationName | result | When this method returns, the parsed OrganizationName, or |
Returns
Type | Description |
---|---|
bool |
|
Remarks
To parse successfully, the resource name must be formatted as one of the following:
organizations/{organization}
allowUnparsed
is true
.
Operators
operator ==(OrganizationName, OrganizationName)
Determines whether two specified resource names have the same value.
Declaration
public static bool operator ==(OrganizationName a, OrganizationName b)
Parameters
Type | Name | Description |
---|---|---|
OrganizationName | a | The first resource name to compare, or null. |
OrganizationName | b | The second resource name to compare, or null. |
Returns
Type | Description |
---|---|
bool | true if the value of |
operator !=(OrganizationName, OrganizationName)
Determines whether two specified resource names have different values.
Declaration
public static bool operator !=(OrganizationName a, OrganizationName b)
Parameters
Type | Name | Description |
---|---|---|
OrganizationName | a | The first resource name to compare, or null. |
OrganizationName | b | The second resource name to compare, or null. |
Returns
Type | Description |
---|---|
bool | true if the value of |