nginstack

Module: @nginstack/engine/lib/cloud/ObjectStorage

Classes

DownloadResult
ObjectStorage

Type Definitions

AmazonOptions

Type:
  • Object
Properties:
Name Type Argument Description
bucketName string

Nome do espaço de armazenamento alocado no serviço do Amazon S3.
accessKeyId string

Chave de acesso da conta de usuário criado no serviço da Amazon.
secretAccessKey string

Segredo da chave de acesso.
region string

Região do globo onde o espaço de armazenamento está alocado.
endpoint string <optional>

Indica o endpoint que deve ser utilizado na comunicação. Esse parâmetro é util ao se utilizar uma ferramenta de armazenamento que emule a API do S3.
allowHttp boolean <optional>

Indica se deve ser utilizado o tráfego inseguro usando HTTP. Por padrão toda a comunicação é feita de forma segura utilizando HTTPS. Esse parâmetro é util apenas quando se está utilizando uma ferramenta de armazenamento de terceiro que emule a API do S3 e que esteja publicada sem utilizar HTTPS.

AzureOptions

Type:
  • Object
Properties:
Name Type Description
containerName string

Nome do espaço de armazenamento alocado no serviço do Azure Blob Storage.
accountName string

Nome da conta de armazenamento com acesso ao serviço.
accessKey string

Chave de acesso da conta de armazenamento.
clientId string

Identificador do cliente para autorizar acesso ao serviço de armazenamento.
clientSecret string

Segredo do cliente para autorizar acesso ao serviço de armazenamento.

GoogleOptions

Type:
  • Object
Properties:
Name Type Argument Description
bucketName string

Nome do espaço de armazenamento alocado no Google Cloud.
serviceAccountKey string <optional>

Conteúdo de um arquivo de chave de uma conta de serviço do Google no formato JSON.
applicationCredentials string <optional>

Caminho do arquivo de credenciais gerado pelo aplicativo de linha de comando do Google Cloud. Para mais informações consulte a documentação do Google

ObjectInfo

Type:
  • Object
Properties:
Name Type Argument Description
location string

Caminho do objeto no repositório remoto.
lastModified Date

Data da ultima atualização.
size number

Tamanho do objeto em bytes.
eTag string <optional>

Identificador único atribuído ao objeto pelo repositório remoto.
version string <optional>

Indicador de versão do objeto.
contentType string <optional>

Indica o tipo MIME do objeto ("text/plain" p.e.).
contentEncoding string <optional>

Indica a codificação aplicada ao objeto.
contentDisposition string <optional>

Indica como o objeto deve ser manipulado por um navegador.
cacheControl string <optional>

Indica a política de controle de cache do objeto.
metadata Record.<string, string> <optional>

Lista o conjunto de pares chave/valor que foram atribuídos ao objeto.

UploadOptions

Opções de parametrização do upload do objeto.

Type:
  • Object
Properties:
Name Type Argument Description
contentType string <optional>

Especifica o tipo MIME do objeto. Se não for informado um tipo ele será inferido a partir da extensão de arquivo extraída do parâmetro "location" do upload. Se o "location" informado não possuir uma extensão será considerado o tipo "application/octet-stream". Se o upload estiver sendo feito pelo método uploadText, o conteúdo textual será codificado em UTF-8 e será adicionada a informação do charset ao tipo ("application/octet-stream; charset=utf-8" p.e.).
contentEncoding string <optional>

Especifica a codificação aplicada ao objeto.
contentDisposition string <optional>

Especifica como o objeto deve ser manipulado por um navegador. Este parâmetro é relevante apenas nos casos em que os objetos forem acessíveis diretamente pelos navegadores.
cacheControl string <optional>

Define a política de controle de cache do objeto. Este parâmetro é relevante apenas nos casos em que os objetos forem acessíveis diretamente pelos navegadores.
metadata Record.<string, string> <optional>

Especifica um conjunto de pares chave/valor que serão atribuídos ao objeto.