Cloud Build v1 API - Class GithubEnterpriseConfigName (2.8.0)

public sealed class GithubEnterpriseConfigName : IResourceName, IEquatable<GithubEnterpriseConfigName>

Reference documentation and code samples for the Cloud Build v1 API class GithubEnterpriseConfigName.

Resource name for the GithubEnterpriseConfig resource.

Inheritance

object > GithubEnterpriseConfigName

Implements

IResourceName, IEquatable GithubEnterpriseConfigName

Inherited Members

object.GetType()

Namespace

Google.Cloud.CloudBuild.V1

Assembly

Google.Cloud.CloudBuild.V1.dll

Constructors

GithubEnterpriseConfigName(string, string)

public GithubEnterpriseConfigName(string projectId, string configId)

Constructs a new instance of a GithubEnterpriseConfigName class from the component parts of pattern projects/{project}/githubEnterpriseConfigs/{config}

Parameters
Name	Description
`projectId`	`string` The `Project` ID. Must not be `null` or empty.
`configId`	`string` The `Config` ID. Must not be `null` or empty.

Properties

ConfigId

public string ConfigId { get; }

The Config ID. May be null, depending on which resource name is contained by this instance.

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. May be null, depending on which resource name is contained by this instance.

Property Value
Type	Description
`string`

ProjectId

public string ProjectId { get; }

The Project ID. May be null, depending on which resource name is contained by this instance.

Property Value
Type	Description
`string`

Type

public GithubEnterpriseConfigName.ResourceNameType Type { get; }

The GithubEnterpriseConfigName.ResourceNameType of the contained resource name.

Property Value
Type	Description
`GithubEnterpriseConfigNameResourceNameType`

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)

public static string Format(string projectId, string configId)

Formats the IDs into the string representation of this GithubEnterpriseConfigName with pattern projects/{project}/githubEnterpriseConfigs/{config}.

Parameters
Name	Description
`projectId`	`string` The `Project` ID. Must not be `null` or empty.
`configId`	`string` The `Config` ID. Must not be `null` or empty.

Returns
Type	Description
`string`	The string representation of this GithubEnterpriseConfigName with pattern `projects/{project}/githubEnterpriseConfigs/{config}`.

FormatProjectConfig(string, string)

public static string FormatProjectConfig(string projectId, string configId)

Formats the IDs into the string representation of this GithubEnterpriseConfigName with pattern projects/{project}/githubEnterpriseConfigs/{config}.

Parameters
Name	Description
`projectId`	`string` The `Project` ID. Must not be `null` or empty.
`configId`	`string` The `Config` ID. Must not be `null` or empty.

Returns
Type	Description
`string`	The string representation of this GithubEnterpriseConfigName with pattern `projects/{project}/githubEnterpriseConfigs/{config}`.

FormatProjectLocationConfig(string, string, string)

public static string FormatProjectLocationConfig(string projectId, string locationId, string configId)

Formats the IDs into the string representation of this GithubEnterpriseConfigName with pattern projects/{project}/locations/{location}/githubEnterpriseConfigs/{config}.

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.
`configId`	`string` The `Config` ID. Must not be `null` or empty.

Returns
Type	Description
`string`	The string representation of this GithubEnterpriseConfigName with pattern `projects/{project}/locations/{location}/githubEnterpriseConfigs/{config}`.

FromProjectConfig(string, string)

public static GithubEnterpriseConfigName FromProjectConfig(string projectId, string configId)

Creates a GithubEnterpriseConfigName with the pattern projects/{project}/githubEnterpriseConfigs/{config}.

Parameters
Name	Description
`projectId`	`string` The `Project` ID. Must not be `null` or empty.
`configId`	`string` The `Config` ID. Must not be `null` or empty.

Returns
Type	Description
`GithubEnterpriseConfigName`	A new instance of GithubEnterpriseConfigName constructed from the provided ids.

FromProjectLocationConfig(string, string, string)

public static GithubEnterpriseConfigName FromProjectLocationConfig(string projectId, string locationId, string configId)

Creates a GithubEnterpriseConfigName with the pattern projects/{project}/locations/{location}/githubEnterpriseConfigs/{config}.

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.
`configId`	`string` The `Config` ID. Must not be `null` or empty.

Returns
Type	Description
`GithubEnterpriseConfigName`	A new instance of GithubEnterpriseConfigName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static GithubEnterpriseConfigName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a GithubEnterpriseConfigName containing an unparsed resource name.

Parameter
Name	Description
`unparsedResourceName`	`UnparsedResourceName` The unparsed resource name. Must not be `null`.

Returns
Type	Description
`GithubEnterpriseConfigName`	A new instance of GithubEnterpriseConfigName containing the provided `unparsedResourceName`.

GetHashCode()

public override int GetHashCode()

Returns a hash code for this resource name.

Returns
Type	Description
`int`

Overrides

object.GetHashCode()

Parse(string)

public static GithubEnterpriseConfigName Parse(string githubEnterpriseConfigName)

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

Parameter
Name	Description
`githubEnterpriseConfigName`	`string` The resource name in string form. Must not be `null`.

Returns
Type	Description
`GithubEnterpriseConfigName`	The parsed GithubEnterpriseConfigName if successful.

Remarks

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

projects/{project}/githubEnterpriseConfigs/{config}
projects/{project}/locations/{location}/githubEnterpriseConfigs/{config}

Parse(string, bool)

public static GithubEnterpriseConfigName Parse(string githubEnterpriseConfigName, bool allowUnparsed)

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

Parameters
Name	Description
`githubEnterpriseConfigName`	`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
`GithubEnterpriseConfigName`	The parsed GithubEnterpriseConfigName if successful.

Remarks

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

projects/{project}/githubEnterpriseConfigs/{config}
projects/{project}/locations/{location}/githubEnterpriseConfigs/{config}

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

object.ToString()

TryParse(string, out GithubEnterpriseConfigName)

public static bool TryParse(string githubEnterpriseConfigName, out GithubEnterpriseConfigName result)

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

Parameters
Name	Description
`githubEnterpriseConfigName`	`string` The resource name in string form. Must not be `null`.
`result`	`GithubEnterpriseConfigName` When this method returns, the parsed GithubEnterpriseConfigName, 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}/githubEnterpriseConfigs/{config}
projects/{project}/locations/{location}/githubEnterpriseConfigs/{config}

TryParse(string, bool, out GithubEnterpriseConfigName)

public static bool TryParse(string githubEnterpriseConfigName, bool allowUnparsed, out GithubEnterpriseConfigName result)

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

Parameters
Name	Description
`githubEnterpriseConfigName`	`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`	`GithubEnterpriseConfigName` When this method returns, the parsed GithubEnterpriseConfigName, 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}/githubEnterpriseConfigs/{config}
projects/{project}/locations/{location}/githubEnterpriseConfigs/{config}

Or may be in any format if allowUnparsed is true.

Operators

operator ==(GithubEnterpriseConfigName, GithubEnterpriseConfigName)

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

Determines whether two specified resource names have the same value.

Parameters
Name	Description
`a`	`GithubEnterpriseConfigName` The first resource name to compare, or null.
`b`	`GithubEnterpriseConfigName` 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 !=(GithubEnterpriseConfigName, GithubEnterpriseConfigName)

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

Determines whether two specified resource names have different values.

Parameters
Name	Description
`a`	`GithubEnterpriseConfigName` The first resource name to compare, or null.
`b`	`GithubEnterpriseConfigName` 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.