Modelo do Cloud Pub/Sub para Cloud Storage

Use o modelo do Dataproc Serverless Cloud Pub/Sub para o Cloud Storage para extrair dados do Pub/Sub para o Cloud Storage.

Use o modelo

Execute o modelo usando a CLI gcloud ou a API Dataproc.

gcloud

Antes de usar os dados do comando abaixo, faça estas substituições:

• PROJECT_ID: obrigatório. O ID do projeto do Google Cloud listado nas Configurações do IAM.
• REGION: obrigatório. Região do Compute Engine.
• SUBNET: opcional. Se uma sub-rede não for especificada, a sub-rede na REGIÃO especificada na rede default será selecionada.

  Exemplo: projects/PROJECT_ID/regions/REGION/subnetworks/SUBNET_NAME

• TEMPLATE_VERSION: obrigatório. Especifique latest para a versão mais recente do modelo ou a data de uma versão específica, por exemplo, 2023-03-17_v0.1.0-beta. Acesse gs://dataproc-templates-binaries ou execute gcloud storage ls gs://dataproc-templates-binaries para listar as versões de modelo disponíveis.
• PUBSUB_SUBSCRIPTION_PROJECT_ID: obrigatório. O ID do projeto do Google Cloud listado nas Configurações do IAM que contém a assinatura de entrada do Pub/Sub a ser lida.
• SUBSCRIPTION: obrigatório. Nome da assinatura do Pub/Sub.
• CLOUD_STORAGE_OUTPUT_BUCKET_NAME: obrigatório. Nome do bucket do Cloud Storage em que a saída será armazenada.

  Observação:os arquivos de saída serão armazenados na pasta output/ dentro do bucket.

• FORMAT: obrigatório. Formato de dados de saída. Opções: avro ou json.

  Observação:se avro, adicione "file:///usr/lib/spark/connector/spark-avro.jar" à flag jars da CLI gcloud ou ao campo da API.

  Exemplo (o prefixo file:// faz referência a um arquivo JAR do Dataproc sem servidor):

  --jars=file:///usr/lib/spark/connector/spark-avro.jar, [ ... outros frascos]
• TIMEOUT: opcional. Tempo em milissegundos antes do encerramento da transmissão. O padrão é 60000.
• DURATION: opcional. Frequência em segundos de gravações no Cloud Storage. O padrão é 15 segundos.
• NUM_RECEIVERS: opcional. Número de streams lidos em paralelo de uma assinatura do Pub/Sub. O padrão é 5.
• BATCHSIZE: opcional. Número de registros a serem inseridos em uma ida e volta no Cloud Storage. O padrão é 1.000.
• SERVICE_ACCOUNT: opcional. Se não for fornecido, a conta de serviço padrão do Compute Engine será usada.
• PROPERTY e PROPERTY_VALUE: opcional. Lista separada por vírgulas de pares propriedade do Spark=value.
• LABEL e LABEL_VALUE: opcional. Lista separada por vírgulas de pares label=value.
• LOG_LEVEL: opcional. Nível de registro. Pode ser ALL, DEBUG, ERROR, FATAL, INFO, OFF, TRACE ou WARN. Padrão: INFO.
• KMS_KEY: opcional. A chave do Cloud Key Management Service a ser usada para criptografia. Se nenhuma chave for especificada, os dados serão criptografados em repouso usando uma chave de propriedade e gerenciada pelo Google.

  Exemplo: projects/PROJECT_ID/regions/REGION/keyRings/KEY_RING_NAME/cryptoKeys/KEY_NAME

Execute o seguinte comando:

Linux, macOS ou Cloud Shell

Observação: para inicializar a Google Cloud CLI com autenticação e um projeto, execute gcloud init. ou gcloud auth login e gcloud config set project.

gcloud dataproc batches submit spark \
    --class=com.google.cloud.dataproc.templates.main.DataProcTemplate \
    --version="1.2" \
    --project="PROJECT_ID" \
    --region="REGION" \
    --jars="gs://dataproc-templates-binaries/TEMPLATE_VERSION/java/dataproc-templates.jar" \
    --subnet="SUBNET" \
    --kms-key="KMS_KEY" \
    --service-account="SERVICE_ACCOUNT" \
    --properties="PROPERTY=PROPERTY_VALUE" \
    --labels="LABEL=LABEL_VALUE" \
    -- --template=PUBSUBTOGCS \
    --templateProperty log.level="LOG_LEVEL" \
    --templateProperty pubsubtogcs.input.project.id="PUBSUB_SUBSCRIPTION_PROJECT_ID" \
    --templateProperty pubsubtogcs.input.subscription="SUBSCRIPTION" \
    --templateProperty pubsubtogcs.gcs.bucket.name="CLOUD_STORAGE_OUTPUT_BUCKET_NAME" \
    --templateProperty pubsubtogcs.gcs.output.data.format="FORMAT" \
    --templateProperty pubsubtogcs.timeout.ms="TIMEOUT" \
    --templateProperty pubsubtogcs.streaming.duration.seconds="DURATION" \
    --templateProperty pubsubtogcs.total.receivers="NUM_RECEIVERS" \
    --templateProperty pubsubtogcs.batch.size="BATCHSIZE"

Windows (PowerShell)

Observação: para inicializar a Google Cloud CLI com autenticação e um projeto, execute gcloud init. ou gcloud auth login e gcloud config set project.

gcloud dataproc batches submit spark `
    --class=com.google.cloud.dataproc.templates.main.DataProcTemplate `
    --version="1.2" `
    --project="PROJECT_ID" `
    --region="REGION" `
    --jars="gs://dataproc-templates-binaries/TEMPLATE_VERSION/java/dataproc-templates.jar" `
    --subnet="SUBNET" `
    --kms-key="KMS_KEY" `
    --service-account="SERVICE_ACCOUNT" `
    --properties="PROPERTY=PROPERTY_VALUE" `
    --labels="LABEL=LABEL_VALUE" `
    -- --template=PUBSUBTOGCS `
    --templateProperty log.level="LOG_LEVEL" `
    --templateProperty pubsubtogcs.input.project.id="PUBSUB_SUBSCRIPTION_PROJECT_ID" `
    --templateProperty pubsubtogcs.input.subscription="SUBSCRIPTION" `
    --templateProperty pubsubtogcs.gcs.bucket.name="CLOUD_STORAGE_OUTPUT_BUCKET_NAME" `
    --templateProperty pubsubtogcs.gcs.output.data.format="FORMAT" `
    --templateProperty pubsubtogcs.timeout.ms="TIMEOUT" `
    --templateProperty pubsubtogcs.streaming.duration.seconds="DURATION" `
    --templateProperty pubsubtogcs.total.receivers="NUM_RECEIVERS" `
    --templateProperty pubsubtogcs.batch.size="BATCHSIZE"

Windows (cmd.exe)

Observação: para inicializar a Google Cloud CLI com autenticação e um projeto, execute gcloud init. ou gcloud auth login e gcloud config set project.

gcloud dataproc batches submit spark ^
    --class=com.google.cloud.dataproc.templates.main.DataProcTemplate ^
    --version="1.2" ^
    --project="PROJECT_ID" ^
    --region="REGION" ^
    --jars="gs://dataproc-templates-binaries/TEMPLATE_VERSION/java/dataproc-templates.jar" ^
    --subnet="SUBNET" ^
    --kms-key="KMS_KEY" ^
    --service-account="SERVICE_ACCOUNT" ^
    --properties="PROPERTY=PROPERTY_VALUE" ^
    --labels="LABEL=LABEL_VALUE" ^
    -- --template=PUBSUBTOGCS ^
    --templateProperty log.level="LOG_LEVEL" ^
    --templateProperty pubsubtogcs.input.project.id="PUBSUB_SUBSCRIPTION_PROJECT_ID" ^
    --templateProperty pubsubtogcs.input.subscription="SUBSCRIPTION" ^
    --templateProperty pubsubtogcs.gcs.bucket.name="CLOUD_STORAGE_OUTPUT_BUCKET_NAME" ^
    --templateProperty pubsubtogcs.gcs.output.data.format="FORMAT" ^
    --templateProperty pubsubtogcs.timeout.ms="TIMEOUT" ^
    --templateProperty pubsubtogcs.streaming.duration.seconds="DURATION" ^
    --templateProperty pubsubtogcs.total.receivers="NUM_RECEIVERS" ^
    --templateProperty pubsubtogcs.batch.size="BATCHSIZE"

REST

Antes de usar os dados da solicitação abaixo, faça as substituições a seguir:

• PROJECT_ID: obrigatório. O ID do projeto do Google Cloud listado nas Configurações do IAM.
• REGION: obrigatório. Região do Compute Engine.
• SUBNET: opcional. Se uma sub-rede não for especificada, a sub-rede na REGIÃO especificada na rede default será selecionada.

  Exemplo: projects/PROJECT_ID/regions/REGION/subnetworks/SUBNET_NAME

• TEMPLATE_VERSION: obrigatório. Especifique latest para a versão mais recente do modelo ou a data de uma versão específica, por exemplo, 2023-03-17_v0.1.0-beta. Acesse gs://dataproc-templates-binaries ou execute gcloud storage ls gs://dataproc-templates-binaries para listar as versões de modelo disponíveis.
• PUBSUB_SUBSCRIPTION_PROJECT_ID: obrigatório. O ID do projeto do Google Cloud listado nas Configurações do IAM que contém a assinatura de entrada do Pub/Sub a ser lida.
• SUBSCRIPTION: obrigatório. Nome da assinatura do Pub/Sub.
• CLOUD_STORAGE_OUTPUT_BUCKET_NAME: obrigatório. Nome do bucket do Cloud Storage em que a saída será armazenada.

  Observação:os arquivos de saída serão armazenados na pasta output/ dentro do bucket.

• FORMAT: obrigatório. Formato de dados de saída. Opções: avro ou json.

  Observação:se avro, adicione "file:///usr/lib/spark/connector/spark-avro.jar" à flag jars da CLI gcloud ou ao campo da API.

  Exemplo (o prefixo file:// faz referência a um arquivo JAR do Dataproc sem servidor):

  --jars=file:///usr/lib/spark/connector/spark-avro.jar, [ ... outros frascos]
• TIMEOUT: opcional. Tempo em milissegundos antes do encerramento da transmissão. O padrão é 60000.
• DURATION: opcional. Frequência em segundos de gravações no Cloud Storage. O padrão é 15 segundos.
• NUM_RECEIVERS: opcional. Número de streams lidos em paralelo de uma assinatura do Pub/Sub. O padrão é 5.
• BATCHSIZE: opcional. Número de registros a serem inseridos em uma ida e volta no Cloud Storage. O padrão é 1.000.
• SERVICE_ACCOUNT: opcional. Se não for fornecido, a conta de serviço padrão do Compute Engine será usada.
• PROPERTY e PROPERTY_VALUE: opcional. Lista separada por vírgulas de pares propriedade do Spark=value.
• LABEL e LABEL_VALUE: opcional. Lista separada por vírgulas de pares label=value.
• LOG_LEVEL: opcional. Nível de registro. Pode ser ALL, DEBUG, ERROR, FATAL, INFO, OFF, TRACE ou WARN. Padrão: INFO.
• KMS_KEY: opcional. A chave do Cloud Key Management Service a ser usada para criptografia. Se nenhuma chave for especificada, os dados serão criptografados em repouso usando uma chave de propriedade e gerenciada pelo Google.

  Exemplo: projects/PROJECT_ID/regions/REGION/keyRings/KEY_RING_NAME/cryptoKeys/KEY_NAME

Método HTTP e URL:

POST https://dataproc.googleapis.com/v1/projects/PROJECT_ID/locations/REGION/batches

Corpo JSON da solicitação:

{
  "environmentConfig":{
    "executionConfig":{
      "subnetworkUri":"SUBNET",
      "kmsKey": "KMS_KEY",
      "serviceAccount": "SERVICE_ACCOUNT"
    }
  },
  "labels": {
    "LABEL": "LABEL_VALUE"
  },
  "runtimeConfig": {
    "version": "1.2",
    "properties": {
      "PROPERTY": "PROPERTY_VALUE"
    }
  },
  "sparkBatch":{
    "mainClass":"com.google.cloud.dataproc.templates.main.DataProcTemplate",
    "args":[
      "--template","PUBSUBTOGCS",
      "--templateProperty","log.level=LOG_LEVEL",
      "--templateProperty","pubsubtogcs.input.project.id=PUBSUB_SUBSCRIPTION_PROJECT_ID",
      "--templateProperty","pubsubtogcs.input.subscription=SUBSCRIPTION",
      "--templateProperty","pubsubtogcs.gcs.bucket.name=CLOUD_STORAGE_OUTPUT_BUCKET_NAME",
      "--templateProperty","pubsubtogcs.gcs.output.data.format=FORMAT",
      "--templateProperty","pubsubtogcs.timeout.ms=TIMEOUT",
      "--templateProperty","pubsubtogcs.streaming.duration.seconds=DURATION",
      "--templateProperty","pubsubtogcs.total.receivers=NUM_RECEIVERS",
      "--templateProperty","pubsubtogcs.batch.size=BATCHSIZE"
    ],
    "jarFileUris":[
      "file:///usr/lib/spark/connector/spark-avro.jar", "gs://dataproc-templates-binaries/TEMPLATE_VERSION/java/dataproc-templates.jar"
    ]
  }
}

Para enviar a solicitação, expanda uma destas opções:

curl (Linux, macOS ou Cloud Shell)

Observação: o comando a seguir pressupõe que você fez login na CLI gcloud com sua conta de usuário executando gcloud init ou gcloud auth login, ou usando o Cloud Shell, que faz login automaticamente na CLI gcloud. . É possível verificar a conta ativa atual executando gcloud auth list.

Salve o corpo da solicitação em um arquivo com o nome request.json e execute o comando a seguir:

curl -X POST \
     -H "Authorization: Bearer $(gcloud auth print-access-token)" \
     -H "Content-Type: application/json; charset=utf-8" \
     -d @request.json \
     "https://dataproc.googleapis.com/v1/projects/PROJECT_ID/locations/REGION/batches"

PowerShell (Windows)

Observação: o comando a seguir pressupõe que você fez login na CLI gcloud com sua conta de usuário executando gcloud init ou gcloud auth login . É possível verificar a conta ativa atual executando gcloud auth list.

Salve o corpo da solicitação em um arquivo com o nome request.json e execute o comando a seguir:

$cred = gcloud auth print-access-token
$headers = @{ "Authorization" = "Bearer $cred" }

Invoke-WebRequest `
    -Method POST `
    -Headers $headers `
    -ContentType: "application/json; charset=utf-8" `
    -InFile request.json `
    -Uri "https://dataproc.googleapis.com/v1/projects/PROJECT_ID/locations/REGION/batches" | Select-Object -Expand Content

Você receberá uma resposta JSON semelhante a esta:

{
  "name": "projects/PROJECT_ID/regions/REGION/operations/OPERATION_ID",
  "metadata": {
    "@type": "type.googleapis.com/google.cloud.dataproc.v1.BatchOperationMetadata",
    "batch": "projects/PROJECT_ID/locations/REGION/batches/BATCH_ID",
    "batchUuid": "de8af8d4-3599-4a7c-915c-798201ed1583",
    "createTime": "2023-02-24T03:31:03.440329Z",
    "operationType": "BATCH",
    "description": "Batch"
  }
}