REST Resource: projects.locations.instances

Recurso: instância

Uma instância do Memorystore.

Representação JSON 
{
  "name": string,
  "createTime": string,
  "updateTime": string,
  "labels": {
    string: string,
    ...
  },
  "state": enum (State),
  "stateInfo": {
    object (StateInfo)
  },
  "uid": string,
  "authorizationMode": enum (AuthorizationMode),
  "transitEncryptionMode": enum (TransitEncryptionMode),
  "shardCount": integer,
  "discoveryEndpoints": [
    {
      object (DiscoveryEndpoint)
    }
  ],
  "nodeType": enum (NodeType),
  "persistenceConfig": {
    object (PersistenceConfig)
  },
  "engineVersion": string,
  "engineConfigs": {
    string: string,
    ...
  },
  "nodeConfig": {
    object (NodeConfig)
  },
  "zoneDistributionConfig": {
    object (ZoneDistributionConfig)
  },
  "pscAutoConnections": [
    {
      object (PscAutoConnection)
    }
  ],
  "pscAttachmentDetails": [
    {
      object (PscAttachmentDetail)
    }
  ],
  "endpoints": [
    {
      object (InstanceEndpoint)
    }
  ],
  "mode": enum (Mode),
  "maintenancePolicy": {
    object (MaintenancePolicy)
  },
  "maintenanceSchedule": {
    object (MaintenanceSchedule)
  },
  "crossInstanceReplicationConfig": {
    object (CrossInstanceReplicationConfig)
  },
  "encryptionInfo": {
    object (EncryptionInfo)
  },
  "automatedBackupConfig": {
    object (AutomatedBackupConfig)
  },
  "availableMaintenanceVersions": [
    string
  ],
  "allowFewerZonesDeployment": boolean,
  "migrationConfig": {
    object (MigrationConfig)
  },
  "aclPolicyInfo": {
    object (AclPolicyInfo)
  },

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "gcsSource": {
    object (GcsBackupSource)
  },
  "managedBackupSource": {
    object (ManagedBackupSource)
  }
  // End of mutually exclusive fields.
  "replicaCount": integer,
  "deletionProtectionEnabled": boolean,
  "simulateMaintenanceEvent": boolean,
  "ondemandMaintenance": boolean,
  "satisfiesPzs": boolean,
  "satisfiesPzi": boolean,
  "asyncInstanceEndpointsDeletionEnabled": boolean,
  "kmsKey": string,
  "backupCollection": string,
  "maintenanceVersion": string,
  "effectiveMaintenanceVersion": string,
  "serverCaMode": enum (ServerCaMode),
  "serverCaPool": string,
  "rotateServerCertificate": boolean,
  "aclPolicy": string,
  "aclPolicyInSync": boolean
}
Campos
name

string

Identificador. Nome exclusivo da instância. Formato: projects/{project}/locations/{location}/instances/{instance}
createTime

string (Timestamp format)

Apenas saída. Carimbo de data/hora de criação da instância.

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. Carimbo de data/hora da última atualização da instância.

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".
labels

map (key: string, value: string)

Opcional. Rótulos para representar metadados fornecidos pelo usuário.

Um objeto com uma lista de pares "key": value. Exemplo: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
state

enum (State)

Apenas saída. Estado atual da instância.
stateInfo

object (StateInfo)

Apenas saída. Informações adicionais sobre o estado da instância.
uid

string

Apenas saída. Identificador exclusivo atribuído pelo sistema para a instância.
authorizationMode

enum (AuthorizationMode)

Opcional. Modo de autorização da instância.
transitEncryptionMode

enum (TransitEncryptionMode)

Opcional. Imutável. Modo de criptografia em trânsito da instância.
shardCount

integer

Opcional. Número de fragmentos da instância.
discoveryEndpoints[]
(deprecated)

object (DiscoveryEndpoint)

Apenas saída. Descontinuado: o parâmetro "discoveryEndpoints" foi descontinuado. Como resultado, ele não será preenchido se as conexões forem criadas usando o parâmetro "endpoints". Em vez desse parâmetro, para descoberta, use endpoints.connections.pscConnection e endpoints.connections.pscAutoConnection com connectionType CONNECTION_TYPE_DISCOVERY.
nodeType

enum (NodeType)

Opcional. Tipo de máquina para nós individuais da instância.
persistenceConfig

object (PersistenceConfig)

Opcional. Configuração de persistência da instância.
engineVersion

string

Opcional. Versão do mecanismo da instância.
engineConfigs

map (key: string, value: string)

Opcional. Configurações do mecanismo fornecidas pelo usuário para a instância.

Um objeto com uma lista de pares "key": value. Exemplo: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
nodeConfig

object (NodeConfig)

Apenas saída. Configuração de nós individuais da instância.
zoneDistributionConfig

object (ZoneDistributionConfig)

Opcional. Imutável. Configuração de distribuição de zona da instância para alocação de nós.
pscAutoConnections[]
(deprecated)

object (PscAutoConnection)

Opcional. Imutável. Descontinuado: use o valor endpoints.connections.psc_auto_connection.
pscAttachmentDetails[]

object (PscAttachmentDetail)

Apenas saída. Detalhes do anexo de serviço para configurar conexões do PSC.
endpoints[]

object (InstanceEndpoint)

Opcional. Endpoints da instância.
mode

enum (Mode)

Opcional. Imutável. A configuração de modo da instância.
maintenancePolicy

object (MaintenancePolicy)

Opcional. A política de manutenção da instância. Se não for fornecido, o evento de manutenção será realizado com base no cronograma de lançamento interno do Memorystore.
maintenanceSchedule

object (MaintenanceSchedule)

Apenas saída. Programação de manutenção publicada.
crossInstanceReplicationConfig

object (CrossInstanceReplicationConfig)

Opcional. A configuração para replicação entre instâncias.
encryptionInfo

object (EncryptionInfo)

Apenas saída. Informações de criptografia dos dados em repouso do cluster.
automatedBackupConfig

object (AutomatedBackupConfig)

Opcional. A configuração de backup automatizado da instância.
availableMaintenanceVersions[]

string

Apenas saída. Esse campo é usado para determinar as versões de manutenção disponíveis para a atualização de autoatendimento.
allowFewerZonesDeployment
(deprecated)

boolean

Opcional. Imutável. Descontinuado, não use.
migrationConfig

object (MigrationConfig)

Apenas saída. Configuração de migração para a instância.
aclPolicyInfo

object (AclPolicyInfo)

Apenas saída. Detalhes da política de ACL aplicada.
A origem da importação. Confira a seguir uma lista de campos mutuamente exclusivos. No máximo um dos campos será definido em uma resposta:
gcsSource

object (GcsBackupSource)

Opcional. Imutável. Backups armazenados em buckets do Cloud Storage. Os buckets do Cloud Storage precisam estar na mesma região que as instâncias. A permissão de leitura é necessária para importar dos objetos do Cloud Storage fornecidos.
managedBackupSource

object (ManagedBackupSource)

Opcional. Imutável. Backups gerados e gerenciados pelo serviço do Memorystore.
Fim dos campos mutuamente exclusivos.
replicaCount

integer

Opcional. Número de nós de réplica por fragmento. Se omitido, o padrão será zero réplicas.
deletionProtectionEnabled

boolean

Opcional. Se definido como verdadeiro, a exclusão da instância vai falhar.
simulateMaintenanceEvent

boolean

Opcional. Somente entrada. Simule um evento de manutenção.
ondemandMaintenance
(deprecated)

boolean

Opcional. Somente entrada. Manutenção sob demanda para a instância.
satisfiesPzs

boolean

Opcional. Apenas saída. Reservado para uso futuro.
satisfiesPzi

boolean

Opcional. Apenas saída. Reservado para uso futuro.
asyncInstanceEndpointsDeletionEnabled

boolean

Opcional. Se for verdadeiro, os endpoints de instância criados e registrados pelos clientes poderão ser excluídos de forma assíncrona. Ou seja, um endpoint de instância pode ser cancelado antes que as regras de encaminhamento no endpoint de instância sejam excluídas.
kmsKey

string

Opcional. A chave do KMS usada para criptografar os dados em repouso do cluster.
backupCollection

string

Apenas saída. O nome completo do recurso da coleção de backups. Exemplo: projects/{project}/locations/{location}/backupCollections/{collection}
maintenanceVersion

string

Opcional. Esse campo pode ser usado para acionar a atualização de autoatendimento e indicar a versão de manutenção desejada. A entrada para esse campo pode ser determinada pelo campo "availableMaintenanceVersions".
effectiveMaintenanceVersion

string

Apenas saída. Esse campo representa a versão de manutenção real da instância.
serverCaMode

enum (ServerCaMode)

Opcional. Imutável. O modo de AC do servidor para a instância.
serverCaPool

string

Opcional. Imutável. O pool de AC gerenciado pelo cliente para a instância. Aplicável apenas se o modo da AC do servidor for CUSTOMER_MANAGED_CAS_CA. Formato: "projects/{project}/locations/{region}/caPools/{ca_pool}".
rotateServerCertificate

boolean

Opcional. Somente entrada. Troque os certificados do servidor.
aclPolicy

string

Opcional. A política de ACL da instância. Formato: projects/{project}/locations/{location}/aclPolicies/{aclPolicy}
aclPolicyInSync
(deprecated)

boolean

Apenas saída. Descontinuado: indica se as regras de ACL aplicadas à instância estão sincronizadas.

GcsBackupSource

Backups armazenados em buckets do Cloud Storage. Os buckets do Cloud Storage precisam estar na mesma região que as instâncias.

Representação JSON 
{
  "uris": [
    string
  ]
}
Campos
uris[]

string

Opcional. Exemplo: gs://bucket1/object1, gs://bucket2/folder2/object2

ManagedBackupSource

Backups gerados e gerenciados pelo Memorystore.

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

string

Opcional. Exemplo: //memorystore.googleapis.com/projects/{project}/locations/{location}/backupCollections/{collection}/backups/{backup}. Uma versão mais curta (sem o prefixo) do nome do backup também é aceita, como projects/{project}/locations/{location}/backupCollections/{collection}/backups/{backupId}. Nesse caso, presume-se que o backup esteja em memorystore.googleapis.com.

Estado

Estados possíveis da instância.

Tipos enumerados
STATE_UNSPECIFIED Não definido.
CREATING A instância está sendo criada.
ACTIVE A instância foi criada e pode ser usada.
UPDATING A instância está sendo atualizada.
DELETING A instância está sendo excluída.
MIGRATING A instância está sendo migrada.

StateInfo

Informações adicionais sobre o estado da instância.

Representação JSON 
{

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "updateInfo": {
    object (UpdateInfo)
  }
  // End of mutually exclusive fields.
}
Campos
Confira a seguir uma lista de campos mutuamente exclusivos. No máximo um dos campos será definido em uma resposta:
updateInfo

object (UpdateInfo)

Apenas saída. Descreve a atualização em andamento quando o estado da instância é UPDATING.
Fim dos campos mutuamente exclusivos.

UpdateInfo

Representa informações sobre a instância com o estado UPDATING.

Representação JSON 
{
  "targetShardCount": integer,
  "targetReplicaCount": integer,
  "targetEngineVersion": string,
  "targetNodeType": enum (NodeType)
}
Campos
targetShardCount

integer

Apenas saída. Número de fragmentos de destino para a instância.
targetReplicaCount

integer

Apenas saída. Número de destino de nós de réplica por fragmento para a instância.
targetEngineVersion

string

Apenas saída. Versão do mecanismo de destino para a instância.
targetNodeType

enum (NodeType)

Apenas saída. Tipo de nó de destino para a instância.

AuthorizationMode

Modos de autorização possíveis da instância.

Tipos enumerados
AUTHORIZATION_MODE_UNSPECIFIED Não definido.
AUTH_DISABLED Autorização desativada.
IAM_AUTH Autorização básica do IAM.
TOKEN_AUTH Autorização baseada em token.

TransitEncryptionMode

Possíveis modos de criptografia em trânsito da instância.

Tipos enumerados
TRANSIT_ENCRYPTION_MODE_UNSPECIFIED Não definido.
TRANSIT_ENCRYPTION_DISABLED A criptografia em trânsito está desativada.
SERVER_AUTHENTICATION A criptografia gerenciada pelo servidor é usada para a criptografia em trânsito.

DiscoveryEndpoint

Representa um endpoint para os clientes se conectarem à instância.

Representação JSON 
{
  "address": string,
  "port": integer,
  "network": string
}
Campos
address

string

Apenas saída. Endereço IP do endpoint exposto a que os clientes se conectam.
port

integer

Apenas saída. O número da porta do endpoint exposto.
network

string

Apenas saída. A rede em que o endereço IP do endpoint de descoberta será reservado, no formato projects/{networkProject}/global/networks/{network_name}.

PersistenceConfig

Representa a configuração de persistência de uma instância.

Representação JSON 
{
  "mode": enum (PersistenceMode),
  "rdbConfig": {
    object (RDBConfig)
  },
  "aofConfig": {
    object (AOFConfig)
  }
}
Campos
mode

enum (PersistenceMode)

Opcional. Modo de persistência atual.
rdbConfig

object (RDBConfig)

Opcional. Configuração do RDB. Esse campo será ignorado se o modo não for RDB.
aofConfig

object (AOFConfig)

Opcional. Configuração de AOF. Esse campo será ignorado se o modo não for AOF.

PersistenceMode

Modos de persistência possíveis.

Tipos enumerados
PERSISTENCE_MODE_UNSPECIFIED Não definido.
DISABLED A persistência é desativada, e todos os dados de snapshot são excluídos.
RDB A persistência baseada em RDB está ativada.
AOF A persistência baseada em AOF está ativada.

RDBConfig

Configuração para persistência baseada em RDB.

Representação JSON 
{
  "rdbSnapshotPeriod": enum (SnapshotPeriod),
  "rdbSnapshotStartTime": string
}
Campos
rdbSnapshotPeriod

enum (SnapshotPeriod)

Opcional. Período entre snapshots do RDB.
rdbSnapshotStartTime

string (Timestamp format)

Opcional. O momento em que o primeiro snapshot foi/será tentado e a que snapshots futuros serão alinhados. Se não for informado, o horário atual será usado.

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".

SnapshotPeriod

Possíveis períodos de snapshot.

Tipos enumerados
SNAPSHOT_PERIOD_UNSPECIFIED Não definido.
ONE_HOUR Uma hora.
SIX_HOURS Seis horas.
TWELVE_HOURS 12 horas.
TWENTY_FOUR_HOURS 24 horas.

AOFConfig

Configuração para persistência baseada em AOF.

Representação JSON 
{
  "appendFsync": enum (AppendFsync)
}
Campos
appendFsync

enum (AppendFsync)

Opcional. O modo fsync.

AppendFsync

Modos fsync possíveis.

Tipos enumerados
APPEND_FSYNC_UNSPECIFIED Não definido. Padrão: EVERY_SEC
NEVER Nunca faça fsync. Normalmente, o Linux libera dados a cada 30 segundos com essa configuração, mas isso depende da sintonia exata do kernel.
EVERY_SEC Sincronização a cada segundo. Você pode perder um segundo de dados se houver um desastre.
ALWAYS Fsync sempre que novos comandos de gravação são anexados ao AOF. A melhor proteção contra perda de dados ao custo da performance.

NodeConfig

Representa a configuração dos nós da instância.

Representação JSON 
{
  "sizeGb": number
}
Campos
sizeGb

number

Apenas saída. Tamanho da memória em GB do nó.

ZoneDistributionConfig

Configuração de distribuição de zona para alocação de recursos de instância.

Representação JSON 
{
  "zone": string,
  "zones": [
    string
  ],
  "mode": enum (ZoneDistributionMode)
}
Campos
zone

string

Opcional. Define a zona em que todos os recursos serão alocados com o modo SINGLE_ZONE. Ignorado no modo MULTI_ZONE.
zones[]

string

Opcional. Especifique as zonas de uma instância multizonal em que a instância do Memorystore aloca recursos. Essa flag não é aplicável a instâncias de zona única.
mode

enum (ZoneDistributionMode)

Opcional. Modo de distribuição de zona atual. O padrão é MULTI_ZONE.

ZoneDistributionMode

Modos possíveis de distribuição de zonas.

Tipos enumerados
ZONE_DISTRIBUTION_MODE_UNSPECIFIED Não definido. Padrão: MULTI_ZONE
MULTI_ZONE Distribua recursos em três zonas escolhidas aleatoriamente na região.
SINGLE_ZONE Provisione recursos em uma única zona. O campo "Zona" precisa ser especificado.

PscAutoConnection

Detalhes dos recursos do consumidor em uma conexão do PSC.

Representação JSON 
{
  "pscConnectionId": string,
  "ipAddress": string,
  "forwardingRule": string,
  "projectId": string,
  "network": string,
  "serviceAttachment": string,
  "pscConnectionStatus": enum (PscConnectionStatus),
  "connectionType": enum (ConnectionType),

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "port": integer
  // End of mutually exclusive fields.
}
Campos
pscConnectionId

string

Apenas saída. O ID da conexão PSC da regra de encaminhamento conectada ao anexo de serviço.
ipAddress

string

Apenas saída. O IP alocado na rede do consumidor para a regra de encaminhamento do PSC.
forwardingRule

string

Apenas saída. O URI da regra de encaminhamento do lado do consumidor. Formato: projects/{project}/regions/{region}/forwardingRules/{forwardingRule}
projectId

string

Obrigatório. O consumerProjectId em que as conexões do PSC são estabelecidas. Precisa ser o mesmo projectId em que a instância está sendo criada.
network

string

Obrigatório. A rede em que os endpoints do PSC são criados, no formato projects/{projectId}/global/networks/{network_name}.
serviceAttachment

string

Apenas saída. O anexo de serviço que é o destino da conexão PSC, no formato projects/{project-id}/regions/{region}/serviceAttachments/{service-attachment-id}.
pscConnectionStatus

enum (PscConnectionStatus)

Apenas saída. O status da conexão do PSC: se uma conexão existe e está ATIVA ou se ela não existe mais. Esse valor é atualizado periodicamente. Use as APIs do Private Service Connect para conferir o status mais recente.
connectionType

enum (ConnectionType)

Apenas saída. Tipo da conexão PSC.
Portas do endpoint exposto. Confira a seguir uma lista de campos mutuamente exclusivos. No máximo um dos campos será definido em uma resposta:
port

integer

Opcional. A porta só será definida para o endpoint principal/leitor ou de descoberta.
Fim dos campos mutuamente exclusivos.

PscConnectionStatus

Status da conexão do PSC.

Tipos enumerados
PSC_CONNECTION_STATUS_UNSPECIFIED O status da conexão do PSC não foi especificado.
ACTIVE A conexão está ativa
NOT_FOUND Conexão não encontrada

ConnectionType

Tipo de conexão PSC

Tipos enumerados
CONNECTION_TYPE_UNSPECIFIED O tipo de conexão não está definido
CONNECTION_TYPE_DISCOVERY Conexão que será usada para descoberta de topologia.
CONNECTION_TYPE_PRIMARY Conexão que será usada como endpoint principal para acessar o principal.
CONNECTION_TYPE_READER Conexão que será usada como endpoint de leitura para acessar réplicas.

PscAttachmentDetail

Configuração de um anexo de serviço do cluster para criar conexões do PSC.

Representação JSON 
{
  "serviceAttachment": string,
  "connectionType": enum (ConnectionType)
}
Campos
serviceAttachment

string

Apenas saída. URI do anexo de serviço que sua PscConnection criada por você mesmo deve usar como destino.
connectionType

enum (ConnectionType)

Apenas saída. Tipo de endpoint do PSC.

InstanceEndpoint

O InstanceEndpoint consiste em conexões do PSC criadas como um grupo em cada rede VPC para acessar a instância. Em cada grupo, haverá uma conexão para cada anexo de serviço no cluster.

Representação JSON 
{
  "connections": [
    {
      object (ConnectionDetail)
    }
  ]
}
Campos
connections[]

object (ConnectionDetail)

Opcional. Um grupo de conexões do PSC. Eles são criados na mesma rede VPC, um para cada anexo de serviço no cluster.

ConnectionDetail

Informações de cada conexão do PSC.

Representação JSON 
{

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "pscAutoConnection": {
    object (PscAutoConnection)
  },
  "pscConnection": {
    object (PscConnection)
  }
  // End of mutually exclusive fields.
}
Campos
Uma conexão do PSC com uma instância pode ser criada pela automação de conectividade do serviço (conexão automática) durante a criação do cluster ou pelos próprios clientes (conexão criada pelo usuário). Confira a seguir uma lista de campos mutuamente exclusivos. No máximo um dos campos será definido em uma resposta:
pscAutoConnection

object (PscAutoConnection)

Imutável. Informações detalhadas de uma conexão do PSC criada pela automação de conectividade do serviço.
pscConnection

object (PscConnection)

Informações detalhadas de uma conexão do PSC criada pelo usuário.
Fim dos campos mutuamente exclusivos.

PscConnection

Configuração de conexão do PSC criada pelo usuário.

Representação JSON 
{
  "pscConnectionId": string,
  "ipAddress": string,
  "forwardingRule": string,
  "projectId": string,
  "network": string,
  "serviceAttachment": string,
  "pscConnectionStatus": enum (PscConnectionStatus),
  "connectionType": enum (ConnectionType),

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "port": integer
  // End of mutually exclusive fields.
}
Campos
pscConnectionId

string

Obrigatório. O ID da conexão PSC da regra de encaminhamento conectada ao anexo de serviço.
ipAddress

string

Obrigatório. O IP alocado na rede do consumidor para a regra de encaminhamento do PSC.
forwardingRule

string

Obrigatório. O URI da regra de encaminhamento do lado do consumidor. Formato: projects/{project}/regions/{region}/forwardingRules/{forwardingRule}
projectId

string

Apenas saída. O consumerProjectId de onde a regra de encaminhamento é criada.
network

string

Obrigatório. A rede do consumidor em que o endereço IP reside, no formato projects/{projectId}/global/networks/{network_name}.
serviceAttachment

string

Obrigatório. O anexo de serviço que é o destino da conexão PSC, no formato projects/{project-id}/regions/{region}/serviceAttachments/{service-attachment-id}.
pscConnectionStatus

enum (PscConnectionStatus)

Apenas saída. O status da conexão do PSC: se uma conexão existe e está ATIVA ou se ela não existe mais. Esse valor é atualizado periodicamente. Use as APIs do Private Service Connect para conferir o status mais recente.
connectionType

enum (ConnectionType)

Apenas saída. Tipo da conexão PSC.
Portas do endpoint exposto. Confira a seguir uma lista de campos mutuamente exclusivos. No máximo um dos campos será definido em uma resposta:
port

integer

Opcional. A porta só será definida para o endpoint principal/leitor ou de descoberta.
Fim dos campos mutuamente exclusivos.

Modo

A configuração do modo, que é usada para ativar/desativar o modo de cluster.

Tipos enumerados
MODE_UNSPECIFIED O modo não foi especificado.
STANDALONE

Descontinuado: use CLUSTER_DISABLED.
CLUSTER A instância está no modo de cluster.
CLUSTER_DISABLED O modo de cluster está desativado para a instância.

MaintenancePolicy

Política de manutenção por instância.

Representação JSON 
{
  "createTime": string,
  "updateTime": string,
  "weeklyMaintenanceWindow": [
    {
      object (WeeklyMaintenanceWindow)
    }
  ]
}
Campos
createTime

string (Timestamp format)

Apenas saída. A hora em que a política foi criada.

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. O horário em que a política foi atualizada.

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".
weeklyMaintenanceWindow[]

object (WeeklyMaintenanceWindow)

Opcional. Janela de manutenção aplicada aos recursos cobertos por esta política. Mínimo de 1. Para a versão atual, o número máximo de weekly_window esperado é um.

WeeklyMaintenanceWindow

Período especificado para operações semanais.

Representação JSON 
{
  "day": enum (DayOfWeek),
  "startTime": {
    object (TimeOfDay)
  }
}
Campos
day

enum (DayOfWeek)

Opcional. Permite definir uma programação que é executada em um dia específico da semana.
startTime

object (TimeOfDay)

Opcional. Horário de início da janela em UTC.

MaintenanceSchedule

Próxima manutenção programada.

Representação JSON 
{
  "startTime": string,
  "endTime": string
}
Campos
startTime

string (Timestamp format)

Apenas saída. O horário de início de qualquer manutenção agendada futura dessa instância.

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. O horário de término de qualquer manutenção programada futura para esta instância.

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".

CrossInstanceReplicationConfig

Configuração de replicação entre instâncias.

Representação JSON 
{
  "instanceRole": enum (InstanceRole),
  "primaryInstance": {
    object (RemoteInstance)
  },
  "secondaryInstances": [
    {
      object (RemoteInstance)
    }
  ],
  "updateTime": string,
  "membership": {
    object (Membership)
  }
}
Campos
instanceRole

enum (InstanceRole)

Obrigatório. A função da instância na replicação entre instâncias.
primaryInstance

object (RemoteInstance)

Opcional. Detalhes da instância principal usada como origem de replicação para esta instância secundária.

Esse campo só é definido para uma instância secundária.
secondaryInstances[]

object (RemoteInstance)

Opcional. Lista de instâncias secundárias que estão replicando desta instância principal.

Esse campo só é definido para uma instância principal.
updateTime

string (Timestamp format)

Apenas saída. A última vez que a configuração de replicação entre instâncias foi atualizada.

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".
membership

object (Membership)

Apenas saída. Uma visualização somente de saída de todas as instâncias de membros que participam da replicação entre instâncias. Essa visualização é fornecida por todas as instâncias de membro, independente da função da instância(primária ou secundária).

Uma instância principal pode fornecer informações sobre todas as instâncias secundárias que estão replicando dela. No entanto, uma instância secundária só conhece a instância principal de que está replicando. No entanto, em cenários em que a instância principal não está disponível(por exemplo, uma interrupção regional), uma solicitação "GetInstance" pode ser enviada para qualquer outra instância de membro, e esse campo vai listar todas as instâncias de membro que participam da replicação entre instâncias.

InstanceRole

A função da instância na replicação entre instâncias.

Tipos enumerados
INSTANCE_ROLE_UNSPECIFIED a função da instância não está definida. O comportamento é equivalente a NONE.
NONE Esta instância não participa da replicação entre instâncias. Ela é uma instância independente e não faz replicação para nem de outras instâncias.
PRIMARY Uma instância que permite leituras e gravações. Todos os dados gravados nessa instância também são replicados para as instâncias secundárias anexadas.
SECONDARY Uma instância que permite apenas leituras e replica dados de uma instância principal.

RemoteInstance

Detalhes da instância remota associada a esta instância em uma configuração de replicação entre instâncias.

Representação JSON 
{
  "instance": string,
  "uid": string
}
Campos
instance

string

Opcional. O caminho completo do recurso da instância remota no formato: projects//locations//instances/
uid

string

Apenas saída. O identificador exclusivo da instância remota.

Associação

Uma visualização somente de saída de todas as instâncias de membros que participam da replicação entre instâncias.

Representação JSON 
{
  "primaryInstance": {
    object (RemoteInstance)
  },
  "secondaryInstances": [
    {
      object (RemoteInstance)
    }
  ]
}
Campos
primaryInstance

object (RemoteInstance)

Apenas saída. A instância principal que atua como origem da replicação para as instâncias secundárias.
secondaryInstances[]

object (RemoteInstance)

Apenas saída. A lista de instâncias secundárias replicadas da instância principal.

AutomatedBackupConfig

A configuração de backup automatizado para uma instância.

Representação JSON 
{
  "automatedBackupMode": enum (AutomatedBackupMode),
  "retention": string,

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "fixedFrequencySchedule": {
    object (FixedFrequencySchedule)
  }
  // End of mutually exclusive fields.
}
Campos
automatedBackupMode

enum (AutomatedBackupMode)

Opcional. O modo de backup automatizado. Se o modo estiver desativado, os outros campos serão ignorados.
retention

string (Duration format)

Opcional. Por quanto tempo manter os backups automatizados antes que eles sejam excluídos. O valor precisa estar entre 1 dia e 365 dias. Se não for especificado, o valor padrão será de 35 dias.

Duração em segundos com até nove dígitos fracionários, terminando em "s". Exemplo: "3.5s".
A programação de backups automatizados. Confira a seguir uma lista de campos mutuamente exclusivos. No máximo um dos campos será definido em uma resposta:
fixedFrequencySchedule

object (FixedFrequencySchedule)

Opcional. Acionar backups automatizados com uma frequência fixa.
Fim dos campos mutuamente exclusivos.

FixedFrequencySchedule

Com essa programação, o backup é acionado em uma frequência fixa (atualmente, apenas diária).

Representação JSON 
{
  "startTime": {
    object (TimeOfDay)
  }
}
Campos
startTime

object (TimeOfDay)

Obrigatório. O horário de início de cada backup automatizado em UTC. Ele precisa ser definido para o início de uma hora. Este campo é obrigatório.

AutomatedBackupMode

O modo de backup automatizado.

Tipos enumerados
AUTOMATED_BACKUP_MODE_UNSPECIFIED Valor padrão. A configuração de backup automatizado não foi especificada.
DISABLED Configuração de backup automatizado desativada.
ENABLED A configuração de backup automático está ativada.

ServerCaMode

O modo de AC do servidor para a instância.

Tipos enumerados
SERVER_CA_MODE_UNSPECIFIED O modo da AC do servidor não foi especificado.
GOOGLE_MANAGED_PER_INSTANCE_CA Cada instância tem uma AC gerenciada pelo Google.
GOOGLE_MANAGED_SHARED_CA A instância usa uma AC compartilhada gerenciada pelo Google para a região da instância.
CUSTOMER_MANAGED_CAS_CA A instância usa uma AC gerenciada pelo cliente do CAS.
SERVER_CA_MODE_GOOGLE_MANAGED_PER_INSTANCE_CA

Descontinuado: use GOOGLE_MANAGED_PER_INSTANCE_CA.
SERVER_CA_MODE_GOOGLE_MANAGED_SHARED_CA

Descontinuado: use GOOGLE_MANAGED_SHARED_CA.
SERVER_CA_MODE_CUSTOMER_MANAGED_CAS_CA

Descontinuado: use CUSTOMER_MANAGED_CAS_CA.

MigrationConfig

Configuração para a migração de uma instância.

Representação JSON 
{
  "state": enum (State),
  "forceFinishMigration": boolean,

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "selfManagedSource": {
    object (SelfManagedSource)
  }
  // End of mutually exclusive fields.
}
Campos
state

enum (State)

Apenas saída. Estado da migração da instância.
forceFinishMigration

boolean

Apenas saída. Representa uma flag booleana para forçar a finalização da migração sem validação de recuperação de atraso de compensação entre origem e destino antes de interromper a replicação.
Detalhes sobre a origem da migração. Confira a seguir uma lista de campos mutuamente exclusivos. No máximo um dos campos será definido em uma resposta:
selfManagedSource

object (SelfManagedSource)

Apenas saída. Configuração para migrar de uma instância autogerenciada do Valkey/Redis
Fim dos campos mutuamente exclusivos.

SelfManagedSource

Detalhes da instância de origem autogerenciada.

Representação JSON 
{
  "ipAddress": string,
  "port": integer,
  "networkAttachment": string
}
Campos
ipAddress

string

Obrigatório. O endereço IP da instância de origem. Esse endereço IP precisa ser estável e acessível pela instância do Memorystore durante todo o processo de migração.
port

integer

Obrigatório. A porta da instância de origem. Essa porta precisa ser estável e acessível pela instância do Memorystore durante todo o processo de migração.
networkAttachment

string

Obrigatório. O nome do recurso do anexo de rede do Private Service Connect usado para estabelecer conectividade com a instância de origem. Esse anexo de rede tem os seguintes requisitos: 1. Precisa estar no mesmo projeto que a instância do Memorystore. 2. Ele precisa estar na mesma região que a instância do Memorystore. 3. A sub-rede anexada ao anexo de rede precisa estar na mesma rede VPC que os nós da instância de origem.

Formato: projects/{project}/regions/{region}/networkAttachments/{networkAttachment}

Estado

Estado da migração da instância. Novos valores podem ser adicionados no futuro.

Tipos enumerados
STATE_UNSPECIFIED A instância não tem atividade relacionada à migração. Esse é o estado inicial.
ROLLED_BACK A instância não está sendo migrada no momento. A instância passou por uma tentativa de migração que falhou, e o rollback subsequente foi concluído. A instância está pronta para uma nova tentativa de migração, se necessário.
ROLLING_BACK Indica que uma tentativa de migração anterior falhou. O estado de alto nível da instância será MIGRATING. A instância não está pronta para uma nova tentativa de migração. A reversão está em andamento para restaurar a instância ao estado original. A instância vai permanecer nesse estado até que o rollback seja concluído.
REPLICATION_ESTABLISHED A instância está em processo de migração. A instância estabeleceu uma replicação bem-sucedida e está pronta para a transição.
MIGRATED A instância foi migrada.

AclPolicyInfo

Detalhes da política de ACL aplicada.

Representação JSON 
{
  "appliedAclPolicy": string,
  "appliedAclPolicyRevision": string,
  "appliedAclPolicyRevisionNumber": string,
  "aclPolicyRevisionStatuses": [
    {
      object (AclPolicyRevisionStatus)
    }
  ]
}
Campos
appliedAclPolicy

string

Apenas saída. O nome do recurso da política de ACL aplicada. Formato: "projects/{project}/locations/{location}/aclPolicies/{aclPolicy}"
appliedAclPolicyRevision

string

Apenas saída. O nome do recurso da revisão da política de ACL aplicada. Formato: "projects/{project}/locations/{location}/aclPolicies/{aclPolicy}/revisions/{revision}"
appliedAclPolicyRevisionNumber

string (int64 format)

Apenas saída. O número da revisão da política de ACL aplicada.
aclPolicyRevisionStatuses[]

object (AclPolicyRevisionStatus)

Apenas saída. Uma lista de status para várias revisões dessa política de ACL na instância.

Métodos

addTokenAuthUser

 Adiciona um usuário de autenticação por token a uma instância com autenticação por token ativada.

backup

 Instância de backup.

create

 Cria uma nova instância em um determinado projeto e local.

delete

 Exclui uma única instância.

finishMigration

 Finaliza o processo de migração.

get

 Recebe detalhes de uma única instância.

getCertificateAuthority

 Recebe detalhes sobre a autoridade certificadora de uma instância.

list

 Lista instâncias em um determinado projeto e local.

patch

 Atualiza os parâmetros de uma única instância.

rescheduleMaintenance

 Reprograma o próximo evento de manutenção.

startMigration

 Inicia a migração de uma instância de origem para a instância de destino do Memorystore.