Reference documentation and code samples for the Google Cloud Memorystore V1 Client class CrossInstanceReplicationConfig.
Cross instance replication config.
Generated from protobuf message google.cloud.memorystore.v1.CrossInstanceReplicationConfig
Namespace
Google \ Cloud \ Memorystore \ V1Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ instance_role |
int
Required. The role of the instance in cross instance replication. |
↳ primary_instance |
CrossInstanceReplicationConfig\RemoteInstance
Optional. Details of the primary instance that is used as the replication source for this secondary instance. This field is only set for a secondary instance. |
↳ secondary_instances |
array<CrossInstanceReplicationConfig\RemoteInstance>
Optional. List of secondary instances that are replicating from this primary instance. This field is only set for a primary instance. |
↳ update_time |
Google\Protobuf\Timestamp
Output only. The last time cross instance replication config was updated. |
↳ membership |
CrossInstanceReplicationConfig\Membership
Output only. An output only view of all the member instances participating in the cross instance replication. This view will be provided by every member instance irrespective of its instance role(primary or secondary). A primary instance can provide information about all the secondary instances replicating from it. However, a secondary instance only knows about the primary instance from which it is replicating. However, for scenarios, where the primary instance is unavailable(e.g. regional outage), a Getinstance request can be sent to any other member instance and this field will list all the member instances participating in cross instance replication. |
getInstanceRole
Required. The role of the instance in cross instance replication.
| Returns | |
|---|---|
| Type | Description |
int |
|
setInstanceRole
Required. The role of the instance in cross instance replication.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getPrimaryInstance
Optional. Details of the primary instance that is used as the replication source for this secondary instance.
This field is only set for a secondary instance.
| Returns | |
|---|---|
| Type | Description |
CrossInstanceReplicationConfig\RemoteInstance|null |
|
hasPrimaryInstance
clearPrimaryInstance
setPrimaryInstance
Optional. Details of the primary instance that is used as the replication source for this secondary instance.
This field is only set for a secondary instance.
| Parameter | |
|---|---|
| Name | Description |
var |
CrossInstanceReplicationConfig\RemoteInstance
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getSecondaryInstances
Optional. List of secondary instances that are replicating from this primary instance.
This field is only set for a primary instance.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField |
|
setSecondaryInstances
Optional. List of secondary instances that are replicating from this primary instance.
This field is only set for a primary instance.
| Parameter | |
|---|---|
| Name | Description |
var |
array<CrossInstanceReplicationConfig\RemoteInstance>
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getUpdateTime
Output only. The last time cross instance replication config was updated.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null |
|
hasUpdateTime
clearUpdateTime
setUpdateTime
Output only. The last time cross instance replication config was updated.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Timestamp
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getMembership
Output only. An output only view of all the member instances participating in the cross instance replication. This view will be provided by every member instance irrespective of its instance role(primary or secondary).
A primary instance can provide information about all the secondary instances replicating from it. However, a secondary instance only knows about the primary instance from which it is replicating. However, for scenarios, where the primary instance is unavailable(e.g. regional outage), a Getinstance request can be sent to any other member instance and this field will list all the member instances participating in cross instance replication.
| Returns | |
|---|---|
| Type | Description |
CrossInstanceReplicationConfig\Membership|null |
|
hasMembership
clearMembership
setMembership
Output only. An output only view of all the member instances participating in the cross instance replication. This view will be provided by every member instance irrespective of its instance role(primary or secondary).
A primary instance can provide information about all the secondary instances replicating from it. However, a secondary instance only knows about the primary instance from which it is replicating. However, for scenarios, where the primary instance is unavailable(e.g. regional outage), a Getinstance request can be sent to any other member instance and this field will list all the member instances participating in cross instance replication.
| Parameter | |
|---|---|
| Name | Description |
var |
CrossInstanceReplicationConfig\Membership
|
| Returns | |
|---|---|
| Type | Description |
$this |
|