관점 유형 업데이트

관점 유형을 업데이트합니다.

코드 샘플

Java

이 샘플을 사용해 보기 전에 클라이언트 라이브러리 사용한 Dataplex 빠른 시작의 Java 설정 안내를 따르세요. 자세한 내용은 Dataplex Java API 참고 문서를 참고하세요.

Dataplex에 인증하려면 애플리케이션 기본 사용자 인증 정보를 설정합니다. 자세한 내용은 로컬 개발 환경의 인증 설정을 참조하세요.

import com.google.cloud.dataplex.v1.AspectType;
import com.google.cloud.dataplex.v1.AspectTypeName;
import com.google.cloud.dataplex.v1.CatalogServiceClient;
import com.google.protobuf.FieldMask;
import java.util.List;

public class UpdateAspectType {

  public static void main(String[] args) throws Exception {
    // TODO(developer): Replace these variables before running the sample.
    String projectId = "MY_PROJECT_ID";
    // Available locations: https://cloud.google.com/dataplex/docs/locations
    String location = "MY_LOCATION";
    String aspectTypeId = "MY_ASPECT_TYPE_ID";

    AspectType.MetadataTemplate aspectField =
        AspectType.MetadataTemplate.newBuilder()
            // The name must follow regex ^(([a-zA-Z]{1})([\\w\\-_]{0,62}))$
            // That means name must only contain alphanumeric character or dashes or underscores,
            // start with an alphabet, and must be less than 63 characters.
            .setName("name_of_the_field")
            // Metadata Template is recursive structure,
            // primitive types such as "string" or "integer" indicate leaf node,
            // complex types such as "record" or "array" would require nested Metadata Template
            .setType("string")
            .setIndex(1)
            .setAnnotations(
                AspectType.MetadataTemplate.Annotations.newBuilder()
                    .setDescription("updated description of the field")
                    .build())
            .setConstraints(
                AspectType.MetadataTemplate.Constraints.newBuilder()
                    // Specifies if field will be required in Aspect Type
                    .setRequired(true)
                    .build())
            .build();
    List<AspectType.MetadataTemplate> aspectFields = List.of(aspectField);
    AspectType updatedAspectType =
        updateAspectType(projectId, location, aspectTypeId, aspectFields);
    System.out.println("Successfully updated aspect type: " + updatedAspectType.getName());
  }

  // Method to update Aspect Type located in projectId, location and with aspectTypeId and
  // aspectFields specifying schema of the Aspect Type
  public static AspectType updateAspectType(
      String projectId,
      String location,
      String aspectTypeId,
      List<AspectType.MetadataTemplate> aspectFields)
      throws Exception {
    // Initialize client that will be used to send requests. This client only needs to be created
    // once, and can be reused for multiple requests.
    try (CatalogServiceClient client = CatalogServiceClient.create()) {
      AspectType aspectType =
          AspectType.newBuilder()
              .setName(AspectTypeName.of(projectId, location, aspectTypeId).toString())
              .setDescription("updated description of the aspect type")
              .setMetadataTemplate(
                  AspectType.MetadataTemplate.newBuilder()
                      // Because Record Fields is an array, it needs to be fully replaced.
                      // It is because you do not have a way to specify array elements in update
                      // mask.
                      .addAllRecordFields(aspectFields)
                      .build())
              .build();

      // Update mask specifies which fields will be updated.
      // For more information on update masks, see: https://google.aip.dev/161
      FieldMask updateMask =
          FieldMask.newBuilder()
              .addPaths("description")
              .addPaths("metadata_template.record_fields")
              .build();
      return client.updateAspectTypeAsync(aspectType, updateMask).get();
    }
  }
}

Python

이 샘플을 사용해 보기 전에 클라이언트 라이브러리 사용한 Dataplex 빠른 시작의 Python 설정 안내를 따르세요. 자세한 내용은 Dataplex Python API 참고 문서를 참고하세요.

Dataplex에 인증하려면 애플리케이션 기본 사용자 인증 정보를 설정합니다. 자세한 내용은 로컬 개발 환경의 인증 설정을 참조하세요.

from typing import List

from google.cloud import dataplex_v1


def update_aspect_type(
    project_id: str,
    location: str,
    aspect_type_id: str,
    aspect_fields: List[dataplex_v1.AspectType.MetadataTemplate],
) -> dataplex_v1.AspectType:
    """Method to update Aspect Type located in project_id, location and with aspect_type_id and
    aspect_fields specifying schema of the Aspect Type"""

    # Initialize client that will be used to send requests across threads. This
    # client only needs to be created once, and can be reused for multiple requests.
    # After completing all of your requests, call the "__exit__()" method to safely
    # clean up any remaining background resources. Alternatively, use the client as
    # a context manager.
    with dataplex_v1.CatalogServiceClient() as client:
        # The resource name of the Aspect Type
        name = (
            f"projects/{project_id}/locations/{location}/aspectTypes/{aspect_type_id}"
        )
        aspect_type = dataplex_v1.AspectType(
            name=name,
            description="updated description of the aspect type",
            metadata_template=dataplex_v1.AspectType.MetadataTemplate(
                # Because Record Fields is an array, it needs to be fully replaced.
                # It is because you do not have a way to specify array elements in update mask.
                record_fields=aspect_fields
            ),
        )

        # Update mask specifies which fields will be updated.
        # For more information on update masks, see: https://google.aip.dev/161
        update_mask = {"paths": ["description", "metadata_template.record_fields"]}
        update_operation = client.update_aspect_type(
            aspect_type=aspect_type, update_mask=update_mask
        )
        return update_operation.result(60)


if __name__ == "__main__":
    # TODO(developer): Replace these variables before running the sample.
    project_id = "MY_PROJECT_ID"
    # Available locations: https://cloud.google.com/dataplex/docs/locations
    location = "MY_LOCATION"
    aspect_type_id = "MY_ASPECT_TYPE_ID"
    aspect_field = dataplex_v1.AspectType.MetadataTemplate(
        # The name must follow regex ^(([a-zA-Z]{1})([\\w\\-_]{0,62}))$
        # That means name must only contain alphanumeric character or dashes or underscores,
        # start with an alphabet, and must be less than 63 characters.
        name="name_of_the_field",
        # Metadata Template is recursive structure,
        # primitive types such as "string" or "integer" indicate leaf node,
        # complex types such as "record" or "array" would require nested Metadata Template
        type="string",
        index=1,
        annotations=dataplex_v1.AspectType.MetadataTemplate.Annotations(
            description="updated description of the field"
        ),
        constraints=dataplex_v1.AspectType.MetadataTemplate.Constraints(
            # Specifies if field will be required in Aspect Type.
            required=True
        ),
    )
    aspect_fields = [aspect_field]

    updated_aspect_type = update_aspect_type(
        project_id, location, aspect_type_id, aspect_fields
    )
    print(f"Successfully updated aspect type: {updated_aspect_type.name}")

다음 단계

다른 Google Cloud 제품의 코드 샘플을 검색하고 필터링하려면 Google Cloud 샘플 브라우저를 참고하세요.