Show / Hide Table of Contents

Class GoogleCloudDataplexV1Entity

Represents tables and fileset metadata contained within a zone.

Inheritance
object
GoogleCloudDataplexV1Entity
Implements
IDirectResponseSchema
Inherited Members
object.Equals(object)
object.Equals(object, object)
object.GetHashCode()
object.GetType()
object.MemberwiseClone()
object.ReferenceEquals(object, object)
object.ToString()
Namespace: Google.Apis.CloudDataplex.v1.Data
Assembly: Google.Apis.CloudDataplex.v1.dll
Syntax
public class GoogleCloudDataplexV1Entity : IDirectResponseSchema

Properties

Access

Output only. Identifies the access mechanism to the entity. Not user settable.

Declaration
[JsonProperty("access")]
public virtual GoogleCloudDataplexV1StorageAccess Access { get; set; }
Property Value
Type Description
GoogleCloudDataplexV1StorageAccess

Asset

Required. Immutable. The ID of the asset associated with the storage location containing the entity data. The entity must be with in the same zone with the asset.

Declaration
[JsonProperty("asset")]
public virtual string Asset { get; set; }
Property Value
Type Description
string

CatalogEntry

Output only. The name of the associated Data Catalog entry.

Declaration
[JsonProperty("catalogEntry")]
public virtual string CatalogEntry { get; set; }
Property Value
Type Description
string

Compatibility

Output only. Metadata stores that the entity is compatible with.

Declaration
[JsonProperty("compatibility")]
public virtual GoogleCloudDataplexV1EntityCompatibilityStatus Compatibility { get; set; }
Property Value
Type Description
GoogleCloudDataplexV1EntityCompatibilityStatus

CreateTime

object representation of CreateTimeRaw.

Declaration
[JsonIgnore]
[Obsolete("This property is obsolete and may behave unexpectedly; please use CreateTimeDateTimeOffset instead.")]
public virtual object CreateTime { get; set; }
Property Value
Type Description
object

CreateTimeDateTimeOffset

DateTimeOffset representation of CreateTimeRaw.

Declaration
[JsonIgnore]
public virtual DateTimeOffset? CreateTimeDateTimeOffset { get; set; }
Property Value
Type Description
DateTimeOffset?

CreateTimeRaw

Output only. The time when the entity was created.

Declaration
[JsonProperty("createTime")]
public virtual string CreateTimeRaw { get; set; }
Property Value
Type Description
string

DataPath

Required. Immutable. The storage path of the entity data. For Cloud Storage data, this is the fully-qualified path to the entity, such as gs://bucket/path/to/data. For BigQuery data, this is the name of the table resource, such as projects/project_id/datasets/dataset_id/tables/table_id.

Declaration
[JsonProperty("dataPath")]
public virtual string DataPath { get; set; }
Property Value
Type Description
string

DataPathPattern

Optional. The set of items within the data path constituting the data in the entity, represented as a glob path. Example: gs://bucket/path/to/data/**/*.csv.

Declaration
[JsonProperty("dataPathPattern")]
public virtual string DataPathPattern { get; set; }
Property Value
Type Description
string

Description

Optional. User friendly longer description text. Must be shorter than or equal to 1024 characters.

Declaration
[JsonProperty("description")]
public virtual string Description { get; set; }
Property Value
Type Description
string

DisplayName

Optional. Display name must be shorter than or equal to 256 characters.

Declaration
[JsonProperty("displayName")]
public virtual string DisplayName { get; set; }
Property Value
Type Description
string

ETag

Optional. The etag associated with the entity, which can be retrieved with a GetEntity request. Required for update and delete requests.

Declaration
[JsonProperty("etag")]
public virtual string ETag { get; set; }
Property Value
Type Description
string

Format

Required. Identifies the storage format of the entity data. It does not apply to entities with data stored in BigQuery.

Declaration
[JsonProperty("format")]
public virtual GoogleCloudDataplexV1StorageFormat Format { get; set; }
Property Value
Type Description
GoogleCloudDataplexV1StorageFormat

Id

Required. A user-provided entity ID. It is mutable, and will be used as the published table name. Specifying a new ID in an update entity request will override the existing value. The ID must contain only letters (a-z, A-Z), numbers (0-9), and underscores, and consist of 256 or fewer characters.

Declaration
[JsonProperty("id")]
public virtual string Id { get; set; }
Property Value
Type Description
string

Name

Output only. The resource name of the entity, of the form: projects/{project_number}/locations/{location_id}/lakes/{lake_id}/zones/{zone_id}/entities/{id}.

Declaration
[JsonProperty("name")]
public virtual string Name { get; set; }
Property Value
Type Description
string

Schema

Required. The description of the data structure and layout. The schema is not included in list responses. It is only included in SCHEMA and FULL entity views of a GetEntity response.

Declaration
[JsonProperty("schema")]
public virtual GoogleCloudDataplexV1Schema Schema { get; set; }
Property Value
Type Description
GoogleCloudDataplexV1Schema

System

Required. Immutable. Identifies the storage system of the entity data.

Declaration
[JsonProperty("system")]
public virtual string System { get; set; }
Property Value
Type Description
string

Type

Required. Immutable. The type of entity.

Declaration
[JsonProperty("type")]
public virtual string Type { get; set; }
Property Value
Type Description
string

Uid

Output only. System generated unique ID for the Entity. This ID will be different if the Entity is deleted and re-created with the same name.

Declaration
[JsonProperty("uid")]
public virtual string Uid { get; set; }
Property Value
Type Description
string

UpdateTime

object representation of UpdateTimeRaw.

Declaration
[JsonIgnore]
[Obsolete("This property is obsolete and may behave unexpectedly; please use UpdateTimeDateTimeOffset instead.")]
public virtual object UpdateTime { get; set; }
Property Value
Type Description
object

UpdateTimeDateTimeOffset

DateTimeOffset representation of UpdateTimeRaw.

Declaration
[JsonIgnore]
public virtual DateTimeOffset? UpdateTimeDateTimeOffset { get; set; }
Property Value
Type Description
DateTimeOffset?

UpdateTimeRaw

Output only. The time when the entity was last updated.

Declaration
[JsonProperty("updateTime")]
public virtual string UpdateTimeRaw { get; set; }
Property Value
Type Description
string

Implements

IDirectResponseSchema
In this article
Back to top Generated by DocFX