REST Resource: deltasharing.v1.projects.catalogs

Recurso: DeltaSharingCatalog

Representa um catálogo do Delta Sharing.

Representação JSON 
{
  "name": string,
  "location": string,
  "createTime": string,
  "updateTime": string,
  "serviceAccount": string,
  "refreshOptions": {
    object (RefreshOptions)
  },
  "refreshStatus": {
    object (RefreshStatus)
  },
  "federatedCatalogOptions": {
    object (FederatedCatalogOptions)
  },

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "sapConfig": {
    object (SapConfig)
  }
  // End of mutually exclusive fields.
  "encryptionConfig": {
    object (EncryptionConfig)
  }
}
Campos
name

string

Identificador. O nome do recurso. Formato: projects/{project}/catalogs/{catalog}
location

string

Obrigatório. Imutável. A localização do GCP fornecida pelo usuário para o catálogo. Este campo não pode ser modificado.
createTime

string (Timestamp format)

Apenas saída. A hora de criação do catálogo.

Usa o padrão RFC 3339, em que a saída gerada é sempre convertida em Z e tem 0, 3, 6 ou 9 dígitos fracionários. Além de Z, outros ajustes também são aceitos. Exemplos: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".
updateTime

string (Timestamp format)

Apenas saída. A hora da última modificação do catálogo.

Usa o padrão RFC 3339, em que a saída gerada é sempre convertida em Z e tem 0, 3, 6 ou 9 dígitos fracionários. Além de Z, outros ajustes também são aceitos. Exemplos: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".
serviceAccount

string

Apenas saída. A conta de serviço usada para o registro do SAP e criada como um efeito colateral da criação do recurso de catálogo do Delta Sharing.
refreshOptions

object (RefreshOptions)

Opcional. Configura opções para atualizar um catálogo do Delta Sharing.
refreshStatus

object (RefreshStatus)

Apenas saída. O status da atualização do catálogo em segundo plano.
federatedCatalogOptions

object (FederatedCatalogOptions)

Opcional. Opções de configuração para catálogos federados.
Configuração do catálogo. Exatamente um campo precisa ser definido, o que determina o tipo de catálogo. Confira a seguir uma lista de campos mutuamente exclusivos. No máximo um dos campos será definido em uma resposta:
sapConfig

object (SapConfig)

Opcional. Configuração de um catálogo que se conecta ao SAP Business Data Cloud (BDC).
Fim dos campos mutuamente exclusivos.
encryptionConfig

object (EncryptionConfig)

Opcional. Configuração de criptografia personalizada (por exemplo, chaves do Cloud KMS).

SapConfig

Configuração do SAP Business Data Cloud (BDC).

Representação JSON 
{
  "sapBdcEnrollmentConfig": {
    object (SapBdcEnrollmentConfig)
  },
  "sapRegion": string
}
Campos
sapBdcEnrollmentConfig

object (SapBdcEnrollmentConfig)

Opcional. Para criar um recurso de catálogo que se conecta ao SAP BDC, siga este processo de três etapas: 1. Defina SapConfig como vazio. Isso cria um recurso de catálogo com uma conta de serviço do GCP: serviceAccount. 2. Na sua instância do SAP BDC, usando este serviceAccount, siga o processo de inscrição e crie um conector do BDC. Você vai receber connectorEndpoint e invitationCode da SAP. 3. Com esses campos adicionais fornecidos pelo SAP, atualize o recurso de catálogo do BigLake criado anteriormente com o SapBdcEnrollmentConfig. Depois que o SapBdcEnrollmentConfig é definido, ele não pode ser mudado.
sapRegion

string

Opcional. Imutável. A região do GCP a ser usada para APIs do SAP BDC. Quando os metadados do catálogo são armazenados em uma multirregião (por exemplo, "us"), mas a instância física do SAP BDC reside em uma única região (por exemplo, "us-central1"), esse campo precisa ser definido explicitamente para apontar para essa única região. Se não for definido, o local fornecido durante a criação do catálogo será usado por padrão.

SapBdcEnrollmentConfig

Contém a configuração de inscrição recebida do SAP.

Representação JSON 
{
  "connectorEndpoint": string,
  "invitationCode": string,
  "invitationUrl": string,
  "federatedIdentityIssuer": string
}
Campos
connectorEndpoint

string

Opcional. O endpoint exclusivo do conector do SAP BDC.
invitationCode

string

Opcional. Um código de convite da SAP.
invitationUrl

string

Opcional. O URL de convite combinado que contém o endpoint e o código.
federatedIdentityIssuer

string

Apenas saída. O Lakehouse permite compartilhar produtos de dados com o SAP BDC. Quando o compartilhamento está ativado, o SAP BDC acessa os recursos subjacentes por uma identidade federada. Esse campo indica o emissor da identidade federada.

Mais especificamente, o pool de identidades e o provedor precisam ser criados da seguinte maneira:

$ gcloud iam workload-identity-pools create sap-bdc-pool \ --location="global" \ --display-name="SAP BDC Pool"

$ gcloud iam workload-identity-pools providers create-oidc sap-bdc-provider \ --location="global" \ --workload-identity-pool="sap-bdc-pool" \ --issuer-uri=""

Em seguida, o pool pode ser adicionado à política do IAM dos recursos compartilhados para que o BDC do SAP possa acessá-los:

$ gcloud projects add-iam-policy-binding PROJECT_ID \ --role="roles/biglake.viewer" \ --member="principal://iam.googleapis.com/projects/{PROJECT_NUMBER}/locations/global/workloadIdentityPools/sap-bdc-pool/subject/{TENANT_UUID}"

... em que o TENANT_UUID pode ser encontrado na instância do SAP BDC.

RefreshOptions

Configura opções para atualizar um catálogo do Delta Sharing.

Representação JSON 
{
  "refreshSchedule": {
    object (RefreshSchedule)
  }
}
Campos
refreshSchedule

object (RefreshSchedule)

Opcional. Define se e quando a atualização de metadados deve ser programada.

RefreshSchedule

Define se e quando a atualização de metadados deve ser programada.

Representação JSON 
{
  "refreshInterval": string
}
Campos
refreshInterval

string (Duration format)

Opcional. O intervalo para atualizar metadados do catálogo remoto. Se não for definido, mas a atualização for desejada, um padrão do sistema será usado.

Duração em segundos com até nove dígitos fracionários, terminando em "s". Exemplo: "3.5s".

RefreshStatus

Status da atualização em segundo plano do catálogo remoto.

Representação JSON 
{
  "startTime": string,
  "endTime": string,
  "status": {
    object (Status)
  }
}
Campos
startTime

string (Timestamp format)

Apenas saída. Quando a atualização do catálogo for iniciada, incluindo as atualizações em andamento.

Usa o padrão RFC 3339, em que a saída gerada é sempre convertida em Z e tem 0, 3, 6 ou 9 dígitos fracionários. Além de Z, outros ajustes também são aceitos. Exemplos: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".
endTime

string (Timestamp format)

Apenas saída. Quando a atualização do catálogo terminar, desmarque para atualizações em andamento.

Usa o padrão RFC 3339, em que a saída gerada é sempre convertida em Z e tem 0, 3, 6 ou 9 dígitos fracionários. Além de Z, outros ajustes também são aceitos. Exemplos: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".
status

object (Status)

Apenas saída. O status da última operação de atualização em segundo plano. Não definido para atualizações em andamento.

FederatedCatalogOptions

Opções de configuração para o catálogo federado.

Representação JSON 
{
  "serviceDirectoryName": string,
  "crossCloudCacheOptions": {
    object (CrossCloudCacheOptions)
  }
}
Campos
serviceDirectoryName

string

Opcional. O nome do recurso do diretório de serviços para rotear o tráfego por uma conexão de rede privada pelo Interconexão entre nuvens, no formato projects/{projectId}/locations/{locationId}/namespaces/{namespace_id}/services/{serviceId}.
crossCloudCacheOptions

object (CrossCloudCacheOptions)

Opcional. Opções de configuração para armazenamento em cache entre nuvens de arquivos de dados e metadados.

CrossCloudCacheOptions

Opções de configuração para armazenamento em cache entre nuvens de arquivos de dados e metadados.

Representação JSON 
{
  "enabled": boolean
}
Campos
enabled

boolean

Opcional. Especifica se o armazenamento em cache entre nuvens de arquivos de dados e metadados está ativado. Isso afeta apenas consultas pelo BigQuery.

Se esse valor for true, os dados e metadados de leitura serão armazenados em um cache, o que pode aumentar o desempenho e diminuir os custos de saída de rede para consultas entre nuvens.

Se esse valor for false, o armazenamento em cache entre nuvens será desativado.

EncryptionConfig

Configuração de criptografia personalizada (por exemplo, chaves do Cloud KMS).

Representação JSON 
{
  "kmsKeyName": string
}
Campos
kmsKeyName

string

Opcional. Nome da chave do Cloud KMS usada para criptografar dados armazenados em cache extraídos do catálogo. Formato: projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{cryptoKey}

Métodos

create

 Cria um catálogo do Delta Sharing.

delete

 Exclui um catálogo do Delta Sharing especificado pelo nome do recurso.

get

 Encontra o catálogo especificado pelo nome do recurso.

list

 Lista todos os catálogos do Delta Sharing em um projeto especificado.

patch

 Atualiza um catálogo do Delta Sharing.