Security Command Center v2 API - Class BigQueryExportName (1.0.0-beta02)

public sealed class BigQueryExportName : IResourceName, IEquatable<BigQueryExportName>

Reference documentation and code samples for the Security Command Center v2 API class BigQueryExportName.

Resource name for the BigQueryExport resource.

Inheritance

object > BigQueryExportName

Implements

IResourceName, IEquatable BigQueryExportName

Inherited Members

object.GetType()

Namespace

Google.Cloud.SecurityCenter.V2

Assembly

Google.Cloud.SecurityCenter.V2.dll

Constructors

BigQueryExportName(string, string, string)

public BigQueryExportName(string organizationId, string locationId, string exportId)

Constructs a new instance of a BigQueryExportName class from the component parts of pattern organizations/{organization}/locations/{location}/bigQueryExports/{export}

Parameters
Name	Description
`organizationId`	`string` The `Organization` ID. Must not be `null` or empty.
`locationId`	`string` The `Location` ID. Must not be `null` or empty.
`exportId`	`string` The `Export` ID. Must not be `null` or empty.

Properties

ExportId

public string ExportId { get; }

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

Property Value
Type	Description
`string`

FolderId

public string FolderId { get; }

The Folder 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`

OrganizationId

public string OrganizationId { get; }

The Organization 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 BigQueryExportName.ResourceNameType Type { get; }

The BigQueryExportName.ResourceNameType of the contained resource name.

Property Value
Type	Description
`BigQueryExportNameResourceNameType`

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, string)

public static string Format(string organizationId, string locationId, string exportId)

Formats the IDs into the string representation of this BigQueryExportName with pattern organizations/{organization}/locations/{location}/bigQueryExports/{export}.

Parameters
Name	Description
`organizationId`	`string` The `Organization` ID. Must not be `null` or empty.
`locationId`	`string` The `Location` ID. Must not be `null` or empty.
`exportId`	`string` The `Export` ID. Must not be `null` or empty.

Returns
Type	Description
`string`	The string representation of this BigQueryExportName with pattern `organizations/{organization}/locations/{location}/bigQueryExports/{export}`.

FormatFolderLocationExport(string, string, string)

public static string FormatFolderLocationExport(string folderId, string locationId, string exportId)

Formats the IDs into the string representation of this BigQueryExportName with pattern folders/{folder}/locations/{location}/bigQueryExports/{export}.

Parameters
Name	Description
`folderId`	`string` The `Folder` ID. Must not be `null` or empty.
`locationId`	`string` The `Location` ID. Must not be `null` or empty.
`exportId`	`string` The `Export` ID. Must not be `null` or empty.

Returns
Type	Description
`string`	The string representation of this BigQueryExportName with pattern `folders/{folder}/locations/{location}/bigQueryExports/{export}`.

FormatOrganizationLocationExport(string, string, string)

public static string FormatOrganizationLocationExport(string organizationId, string locationId, string exportId)

Formats the IDs into the string representation of this BigQueryExportName with pattern organizations/{organization}/locations/{location}/bigQueryExports/{export}.

Parameters
Name	Description
`organizationId`	`string` The `Organization` ID. Must not be `null` or empty.
`locationId`	`string` The `Location` ID. Must not be `null` or empty.
`exportId`	`string` The `Export` ID. Must not be `null` or empty.

Returns
Type	Description
`string`	The string representation of this BigQueryExportName with pattern `organizations/{organization}/locations/{location}/bigQueryExports/{export}`.

FormatProjectLocationExport(string, string, string)

public static string FormatProjectLocationExport(string projectId, string locationId, string exportId)

Formats the IDs into the string representation of this BigQueryExportName with pattern projects/{project}/locations/{location}/bigQueryExports/{export}.

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

Returns
Type	Description
`string`	The string representation of this BigQueryExportName with pattern `projects/{project}/locations/{location}/bigQueryExports/{export}`.

FromFolderLocationExport(string, string, string)

public static BigQueryExportName FromFolderLocationExport(string folderId, string locationId, string exportId)

Creates a BigQueryExportName with the pattern folders/{folder}/locations/{location}/bigQueryExports/{export}.

Parameters
Name	Description
`folderId`	`string` The `Folder` ID. Must not be `null` or empty.
`locationId`	`string` The `Location` ID. Must not be `null` or empty.
`exportId`	`string` The `Export` ID. Must not be `null` or empty.

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

FromOrganizationLocationExport(string, string, string)

public static BigQueryExportName FromOrganizationLocationExport(string organizationId, string locationId, string exportId)

Creates a BigQueryExportName with the pattern organizations/{organization}/locations/{location}/bigQueryExports/{export}.

Parameters
Name	Description
`organizationId`	`string` The `Organization` ID. Must not be `null` or empty.
`locationId`	`string` The `Location` ID. Must not be `null` or empty.
`exportId`	`string` The `Export` ID. Must not be `null` or empty.

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

FromProjectLocationExport(string, string, string)

public static BigQueryExportName FromProjectLocationExport(string projectId, string locationId, string exportId)

Creates a BigQueryExportName with the pattern projects/{project}/locations/{location}/bigQueryExports/{export}.

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

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

FromUnparsed(UnparsedResourceName)

public static BigQueryExportName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a BigQueryExportName containing an unparsed resource name.

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

Returns
Type	Description
`BigQueryExportName`	A new instance of BigQueryExportName 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 BigQueryExportName Parse(string bigQueryExportName)

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

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

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

Remarks

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

organizations/{organization}/locations/{location}/bigQueryExports/{export}
folders/{folder}/locations/{location}/bigQueryExports/{export}
projects/{project}/locations/{location}/bigQueryExports/{export}

Parse(string, bool)

public static BigQueryExportName Parse(string bigQueryExportName, bool allowUnparsed)

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

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

Remarks

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

organizations/{organization}/locations/{location}/bigQueryExports/{export}
folders/{folder}/locations/{location}/bigQueryExports/{export}
projects/{project}/locations/{location}/bigQueryExports/{export}

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 BigQueryExportName)

public static bool TryParse(string bigQueryExportName, out BigQueryExportName result)

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

Parameters
Name	Description
`bigQueryExportName`	`string` The resource name in string form. Must not be `null`.
`result`	`BigQueryExportName` When this method returns, the parsed BigQueryExportName, 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:

organizations/{organization}/locations/{location}/bigQueryExports/{export}
folders/{folder}/locations/{location}/bigQueryExports/{export}
projects/{project}/locations/{location}/bigQueryExports/{export}

TryParse(string, bool, out BigQueryExportName)

public static bool TryParse(string bigQueryExportName, bool allowUnparsed, out BigQueryExportName result)

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

Parameters
Name	Description
`bigQueryExportName`	`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`	`BigQueryExportName` When this method returns, the parsed BigQueryExportName, 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:

organizations/{organization}/locations/{location}/bigQueryExports/{export}
folders/{folder}/locations/{location}/bigQueryExports/{export}
projects/{project}/locations/{location}/bigQueryExports/{export}

Or may be in any format if allowUnparsed is true.

Operators

operator ==(BigQueryExportName, BigQueryExportName)

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

Determines whether two specified resource names have the same value.

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

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

Determines whether two specified resource names have different values.

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