Skip to content

GCS model

Base class for Google Cloud Storage assets.

Reference documentation

This is reference documentation covering the entire Atlan model. It is not the best place to start when trying to understand managing GCS assets in Atlan. For that, we would suggest starting with the manage Google Cloud Storage assets pattern.

classDiagram
    direction RL
    class GCS {
        <<abstract>>
    }
    link GCS "../gcs"
    class Google {
        <<abstract>>
    }
    link Google "../google"
    Google <|-- GCS : extends
    class Cloud {
        <<abstract>>
    }
    link Cloud "../entities/cloud"
    Cloud <|-- Google : extends
    class Asset {
        <<abstract>>
    }
    link Asset "../entities/asset"
    Asset <|-- Cloud : extends
    class Referenceable {
        <<abstract>>
    }
    link Referenceable "../entities/referenceable"
    Referenceable <|-- Asset : extends
    class ObjectStore {
        <<abstract>>
    }
    link ObjectStore "../entities/objectstore"
    ObjectStore <|-- GCS : extends
    class Catalog {
        <<abstract>>
    }
    link Catalog "../entities/catalog"
    Catalog <|-- ObjectStore : extends
    Asset <|-- Catalog : extends
    class GCSObject
    link GCSObject "../entities/gcsobject"
    GCS <|-- GCSObject : extends
    class GCSBucket
    link GCSBucket "../entities/gcsbucket"
    GCS <|-- GCSBucket : extends

Type-specific properties

Following are the properties uniquely available on GCS assets in Atlan.

gcsAccessControl
TBC
1
2
3
builder.gcsAccessControl("String0"); // (1)
gCS.getGcsAccessControl(); // (2)
client.assets.select().where(GCS.GCS_ACCESS_CONTROL.eq("String0")); // (3)

  1. Set the gcsAccessControl for a GCS.

    For more details

    For more information, see the asset CRUD snippets on either creating or updating assets.

  2. Retrieve the gcsAccessControl from a GCS.

    For more details

    For more information, see the asset CRUD snippets on retrieving assets.

  3. Find all assets in Atlan with their gcsAccessControl exactly matching the provided value.

    For more details

    For more information, see the searching section on term queries.

gcsETag
Entity tag for the asset. An entity tag is a hash of the object and represents changes to the contents of an object only, not its metadata.
1
2
3
builder.gcsETag("String0"); // (1)
gCS.getGcsETag(); // (2)
client.assets.select().where(GCS.GCS_E_TAG.eq("String0")); // (3)

  1. Set the gcsETag for a GCS.

    For more details

    For more information, see the asset CRUD snippets on either creating or updating assets.

  2. Retrieve the gcsETag from a GCS.

    For more details

    For more information, see the asset CRUD snippets on retrieving assets.

  3. Find all assets in Atlan with their gcsETag exactly matching the provided value.

    For more details

    For more information, see the searching section on term queries.

gcsEncryptionType
TBC
1
2
3
builder.gcsEncryptionType("String0"); // (1)
gCS.getGcsEncryptionType(); // (2)
client.assets.select().where(GCS.GCS_ENCRYPTION_TYPE.eq("String0")); // (3)

  1. Set the gcsEncryptionType for a GCS.

    For more details

    For more information, see the asset CRUD snippets on either creating or updating assets.

  2. Retrieve the gcsEncryptionType from a GCS.

    For more details

    For more information, see the asset CRUD snippets on retrieving assets.

  3. Find all assets in Atlan with their gcsEncryptionType exactly matching the provided value.

    For more details

    For more information, see the searching section on term queries.

gcsMetaGenerationId
TBC
1
2
3
builder.gcsMetaGenerationId(123456789L); // (1)
gCS.getGcsMetaGenerationId(); // (2)
client.assets.select().where(GCS.GCS_META_GENERATION_ID.gt(123456789L)); // (3)

  1. Set the gcsMetaGenerationId for a GCS.

    For more details

    For more information, see the asset CRUD snippets on either creating or updating assets.

  2. Retrieve the gcsMetaGenerationId from a GCS.

    For more details

    For more information, see the asset CRUD snippets on retrieving assets.

  3. Find all assets in Atlan with their gcsMetaGenerationId greater than the provided value.

    For more details

    For more information, see the searching section on range queries.

gcsRequesterPays
TBC
1
2
3
builder.gcsRequesterPays(true); // (1)
gCS.getGcsRequesterPays(); // (2)
client.assets.select().where(GCS.GCS_REQUESTER_PAYS.eq(true)); // (3)

  1. Set the gcsRequesterPays for a GCS.

    For more details

    For more information, see the asset CRUD snippets on either creating or updating assets.

  2. Retrieve the gcsRequesterPays from a GCS.

    For more details

    For more information, see the asset CRUD snippets on retrieving assets.

  3. Find all assets in Atlan with their gcsRequesterPays exactly matching the provided value.

    For more details

    For more information, see the searching section on term queries.

gcsStorageClass
TBC
1
2
3
builder.gcsStorageClass("String0"); // (1)
gCS.getGcsStorageClass(); // (2)
client.assets.select().where(GCS.GCS_STORAGE_CLASS.eq("String0")); // (3)

  1. Set the gcsStorageClass for a GCS.

    For more details

    For more information, see the asset CRUD snippets on either creating or updating assets.

  2. Retrieve the gcsStorageClass from a GCS.

    For more details

    For more information, see the asset CRUD snippets on retrieving assets.

  3. Find all assets in Atlan with their gcsStorageClass exactly matching the provided value.

    For more details

    For more information, see the searching section on term queries.

gcs_access_control
TBC
1
2
3
builder.gcs_access_control = ...  # (1)
g_c_s.gcs_access_control  # (2)
FluentSearch().where(FluentSearch.asset_type(GCS)).where(GCS.GCS_ACCESS_CONTROL.eq("String0"))  # (3)

  1. Set the gcs_access_control for a GCS.

    For more details

    For more information, see the asset CRUD snippets on either creating or updating assets.

  2. Retrieve the gcs_access_control from a GCS.

    For more details

    For more information, see the asset CRUD snippets on retrieving assets.

  3. Find all assets in Atlan with their gcs_access_control exactly matching the provided value.

    For more details

    For more information, see the searching section on term queries.

gcs_e_tag
TBC
1
2
3
builder.gcs_e_tag = ...  # (1)
g_c_s.gcs_e_tag  # (2)
FluentSearch().where(FluentSearch.asset_type(GCS)).where(GCS.GCS_E_TAG.eq("String0"))  # (3)

  1. Set the gcs_e_tag for a GCS.

    For more details

    For more information, see the asset CRUD snippets on either creating or updating assets.

  2. Retrieve the gcs_e_tag from a GCS.

    For more details

    For more information, see the asset CRUD snippets on retrieving assets.

  3. Find all assets in Atlan with their gcs_e_tag exactly matching the provided value.

    For more details

    For more information, see the searching section on term queries.

gcs_encryption_type
TBC
1
2
3
builder.gcs_encryption_type = ...  # (1)
g_c_s.gcs_encryption_type  # (2)
FluentSearch().where(FluentSearch.asset_type(GCS)).where(GCS.GCS_ENCRYPTION_TYPE.eq("String0"))  # (3)

  1. Set the gcs_encryption_type for a GCS.

    For more details

    For more information, see the asset CRUD snippets on either creating or updating assets.

  2. Retrieve the gcs_encryption_type from a GCS.

    For more details

    For more information, see the asset CRUD snippets on retrieving assets.

  3. Find all assets in Atlan with their gcs_encryption_type exactly matching the provided value.

    For more details

    For more information, see the searching section on term queries.

gcs_meta_generation_id
TBC
1
2
3
builder.gcs_meta_generation_id = ...  # (1)
g_c_s.gcs_meta_generation_id  # (2)
FluentSearch().where(FluentSearch.asset_type(GCS)).where(GCS.GCS_META_GENERATION_ID.gt(123))  # (3)

  1. Set the gcs_meta_generation_id for a GCS.

    For more details

    For more information, see the asset CRUD snippets on either creating or updating assets.

  2. Retrieve the gcs_meta_generation_id from a GCS.

    For more details

    For more information, see the asset CRUD snippets on retrieving assets.

  3. Find all assets in Atlan with their gcs_meta_generation_id greater than the provided value.

    For more details

    For more information, see the searching section on range queries.

gcs_requester_pays
TBC
1
2
3
builder.gcs_requester_pays = ...  # (1)
g_c_s.gcs_requester_pays  # (2)
FluentSearch().where(FluentSearch.asset_type(GCS)).where(GCS.GCS_REQUESTER_PAYS.eq(True))  # (3)

  1. Set the gcs_requester_pays for a GCS.

    For more details

    For more information, see the asset CRUD snippets on either creating or updating assets.

  2. Retrieve the gcs_requester_pays from a GCS.

    For more details

    For more information, see the asset CRUD snippets on retrieving assets.

  3. Find all assets in Atlan with their gcs_requester_pays exactly matching the provided value.

    For more details

    For more information, see the searching section on term queries.

gcs_storage_class
TBC
1
2
3
builder.gcs_storage_class = ...  # (1)
g_c_s.gcs_storage_class  # (2)
FluentSearch().where(FluentSearch.asset_type(GCS)).where(GCS.GCS_STORAGE_CLASS.eq("String0"))  # (3)

  1. Set the gcs_storage_class for a GCS.

    For more details

    For more information, see the asset CRUD snippets on either creating or updating assets.

  2. Retrieve the gcs_storage_class from a GCS.

    For more details

    For more information, see the asset CRUD snippets on retrieving assets.

  3. Find all assets in Atlan with their gcs_storage_class exactly matching the provided value.

    For more details

    For more information, see the searching section on term queries.

google_labels
TBC
1
2
3
builder.google_labels = [...]  # (1)
g_c_s.google_labels  # (2)
FluentSearch().where(FluentSearch.asset_type(GCS)).where(GCS.GOOGLE_LABELS.eq("String0"))  # (3)

  1. Set the google_labels for a GCS.

    For more details

    For more information, see the asset CRUD snippets on either creating or updating assets.

  2. Retrieve the google_labels from a GCS.

    For more details

    For more information, see the asset CRUD snippets on retrieving assets.

  3. Find all assets in Atlan with their google_labels exactly matching the provided value.

    For more details

    For more information, see the searching section on term queries.

google_location
TBC
1
2
3
builder.google_location = ...  # (1)
g_c_s.google_location  # (2)
FluentSearch().where(FluentSearch.asset_type(GCS)).where(GCS.GOOGLE_LOCATION.eq("String0"))  # (3)

  1. Set the google_location for a GCS.

    For more details

    For more information, see the asset CRUD snippets on either creating or updating assets.

  2. Retrieve the google_location from a GCS.

    For more details

    For more information, see the asset CRUD snippets on retrieving assets.

  3. Find all assets in Atlan with their google_location exactly matching the provided value.

    For more details

    For more information, see the searching section on term queries.

google_location_type
TBC
1
2
3
builder.google_location_type = ...  # (1)
g_c_s.google_location_type  # (2)
FluentSearch().where(FluentSearch.asset_type(GCS)).where(GCS.GOOGLE_LOCATION_TYPE.eq("String0"))  # (3)

  1. Set the google_location_type for a GCS.

    For more details

    For more information, see the asset CRUD snippets on either creating or updating assets.

  2. Retrieve the google_location_type from a GCS.

    For more details

    For more information, see the asset CRUD snippets on retrieving assets.

  3. Find all assets in Atlan with their google_location_type exactly matching the provided value.

    For more details

    For more information, see the searching section on term queries.

google_project_id
TBC
1
2
3
4
builder.google_project_id = ...  # (1)
g_c_s.google_project_id  # (2)
FluentSearch().where(FluentSearch.asset_type(GCS)).where(GCS.GOOGLE_PROJECT_ID.eq("String0"))  # (3)
FluentSearch().where(FluentSearch.asset_type(GCS)).where(GCS.GOOGLE_PROJECT_ID.match("String0"))  # (4)

  1. Set the google_project_id for a GCS.

    For more details

    For more information, see the asset CRUD snippets on either creating or updating assets.

  2. Retrieve the google_project_id from a GCS.

    For more details

    For more information, see the asset CRUD snippets on retrieving assets.

  3. Find all assets in Atlan with their google_project_id exactly matching the provided value.

    For more details

    For more information, see the searching section on term queries.

  4. Find all assets in Atlan with their google_project_id textually matching the provided value.

    For more details

    For more information, see the searching section on full text queries.

google_project_name
TBC
1
2
3
4
builder.google_project_name = ...  # (1)
g_c_s.google_project_name  # (2)
FluentSearch().where(FluentSearch.asset_type(GCS)).where(GCS.GOOGLE_PROJECT_NAME.eq("String0"))  # (3)
FluentSearch().where(FluentSearch.asset_type(GCS)).where(GCS.GOOGLE_PROJECT_NAME.match("String0"))  # (4)

  1. Set the google_project_name for a GCS.

    For more details

    For more information, see the asset CRUD snippets on either creating or updating assets.

  2. Retrieve the google_project_name from a GCS.

    For more details

    For more information, see the asset CRUD snippets on retrieving assets.

  3. Find all assets in Atlan with their google_project_name exactly matching the provided value.

    For more details

    For more information, see the searching section on term queries.

  4. Find all assets in Atlan with their google_project_name textually matching the provided value.

    For more details

    For more information, see the searching section on full text queries.

google_project_number
TBC
1
2
3
builder.google_project_number = ...  # (1)
g_c_s.google_project_number  # (2)
FluentSearch().where(FluentSearch.asset_type(GCS)).where(GCS.GOOGLE_PROJECT_NUMBER.gt(123))  # (3)

  1. Set the google_project_number for a GCS.

    For more details

    For more information, see the asset CRUD snippets on either creating or updating assets.

  2. Retrieve the google_project_number from a GCS.

    For more details

    For more information, see the asset CRUD snippets on retrieving assets.

  3. Find all assets in Atlan with their google_project_number greater than the provided value.

    For more details

    For more information, see the searching section on range queries.

google_service
TBC
1
2
3
builder.google_service = ...  # (1)
g_c_s.google_service  # (2)
FluentSearch().where(FluentSearch.asset_type(GCS)).where(GCS.GOOGLE_SERVICE.eq("String0"))  # (3)

  1. Set the google_service for a GCS.

    For more details

    For more information, see the asset CRUD snippets on either creating or updating assets.

  2. Retrieve the google_service from a GCS.

    For more details

    For more information, see the asset CRUD snippets on retrieving assets.

  3. Find all assets in Atlan with their google_service exactly matching the provided value.

    For more details

    For more information, see the searching section on term queries.

google_tags
TBC
1
2
3
builder.google_tags = [...]  # (1)
g_c_s.google_tags  # (2)
FluentSearch().where(FluentSearch.asset_type(GCS)).where(GCS.GOOGLE_TAGS.eq("String0"))  # (3)

  1. Set the google_tags for a GCS.

    For more details

    For more information, see the asset CRUD snippets on either creating or updating assets.

  2. Retrieve the google_tags from a GCS.

    For more details

    For more information, see the asset CRUD snippets on retrieving assets.

  3. Find all assets in Atlan with their google_tags exactly matching the provided value.

    For more details

    For more information, see the searching section on term queries.

gcsAccessControl
TBC
1
2
3
4
5
{
  "attributes": {
    "gcsAccessControl": "String0" // (1)
  }
}

  1. Set the gcsAccessControl for a GCS.

    For more details

    For more information, see the asset CRUD snippets.

gcsETag
Entity tag for the asset. An entity tag is a hash of the object and represents changes to the contents of an object only, not its metadata.
1
2
3
4
5
{
  "attributes": {
    "gcsETag": "String0" // (1)
  }
}

  1. Set the gcsETag for a GCS.

    For more details

    For more information, see the asset CRUD snippets.

gcsEncryptionType
TBC
1
2
3
4
5
{
  "attributes": {
    "gcsEncryptionType": "String0" // (1)
  }
}

  1. Set the gcsEncryptionType for a GCS.

    For more details

    For more information, see the asset CRUD snippets.

gcsMetaGenerationId
TBC
1
2
3
4
5
{
  "attributes": {
    "gcsMetaGenerationId": 123456789 // (1)
  }
}

  1. Set the gcsMetaGenerationId for a GCS.

    For more details

    For more information, see the asset CRUD snippets.

gcsRequesterPays
TBC
1
2
3
4
5
{
  "attributes": {
    "gcsRequesterPays": true // (1)
  }
}

  1. Set the gcsRequesterPays for a GCS.

    For more details

    For more information, see the asset CRUD snippets.

gcsStorageClass
TBC
1
2
3
4
5
{
  "attributes": {
    "gcsStorageClass": "String0" // (1)
  }
}

  1. Set the gcsStorageClass for a GCS.

    For more details

    For more information, see the asset CRUD snippets.

Relationships

The following illustrates how the various GCS objects inter-relate with each other:

erDiagram
    Connection ||..o{ GCSBucket : ""
    GCSBucket ||--o{ GCSObject : gcsObjects