Class Endpoint

Endpoint resource.

Inheritance
object
Endpoint
Implements
Inherited Members
Namespace: Google.Apis.CloudAlloyDBAdmin.v1beta.Data
Assembly: Google.Apis.CloudAlloyDBAdmin.v1beta.dll
Syntax
public class Endpoint : IDirectResponseSchema

Properties

Annotations

Annotations to allow client tools to store small amount of arbitrary data. This is distinct from labels. https://google.aip.dev/128

Declaration
[JsonProperty("annotations")]
public virtual IDictionary<string, string> Annotations { get; set; }
Property Value
Type Description
IDictionary<string, string>

CreateTime

object representation of CreateTimeRaw.

Declaration
[JsonIgnore]
[Obsolete("This property is obsolete and may behave unexpectedly; please use CreateTimeDateTimeOffset instead.")]
public virtual object CreateTime { get; set; }
Property Value
Type Description
object

CreateTimeDateTimeOffset

DateTimeOffset representation of CreateTimeRaw.

Declaration
[JsonIgnore]
public virtual DateTimeOffset? CreateTimeDateTimeOffset { get; set; }
Property Value
Type Description
DateTimeOffset?

CreateTimeRaw

Output only. Create time stamp

Declaration
[JsonProperty("createTime")]
public virtual string CreateTimeRaw { get; set; }
Property Value
Type Description
string

DeleteTime

object representation of DeleteTimeRaw.

Declaration
[JsonIgnore]
[Obsolete("This property is obsolete and may behave unexpectedly; please use DeleteTimeDateTimeOffset instead.")]
public virtual object DeleteTime { get; set; }
Property Value
Type Description
object

DeleteTimeDateTimeOffset

DateTimeOffset representation of DeleteTimeRaw.

Declaration
[JsonIgnore]
public virtual DateTimeOffset? DeleteTimeDateTimeOffset { get; set; }
Property Value
Type Description
DateTimeOffset?

DeleteTimeRaw

Output only. Delete time stamp

Declaration
[JsonProperty("deleteTime")]
public virtual string DeleteTimeRaw { get; set; }
Property Value
Type Description
string

DisplayName

User-settable and human-readable display name for the Endpoint.

Declaration
[JsonProperty("displayName")]
public virtual string DisplayName { get; set; }
Property Value
Type Description
string

DnsConfig

Output only. The DNS config for the endpoint. Each endpoint is associated with a specific DNS name and the DNS type. The DNS targets are the IP addresses of the target instances. The dns_type is the type of the DNS record, eg. Type "A" or Type "CNAME". This field is not configurable by the user, and it is updated when user specifies the target instances.

Declaration
[JsonProperty("dnsConfig")]
public virtual DNSConfig DnsConfig { get; set; }
Property Value
Type Description
DNSConfig

ETag

For Resource freshness validation (https://google.aip.dev/154)

Declaration
[JsonProperty("etag")]
public virtual string ETag { get; set; }
Property Value
Type Description
string

EffectiveTargetInstances

Output only. The effective target instances that the endpoint is associated with. This is a list of target instance names, e.g. projects/{project_number}/locations/{location}/clusters/{cluster_id}/instances/{instance_id} For write endpoint, there is only one effective target instance which has to be a primary instance. Effective target instances are only different from target instances after a switchover or cross-region failover operation. Otherwise, effective_target_instances are the same as target_instances. Note that after a cross-region failover operation, the effective_target_instances can be stale until the operation to update the endpoint is complete.

Declaration
[JsonProperty("effectiveTargetInstances")]
public virtual IList<string> EffectiveTargetInstances { get; set; }
Property Value
Type Description
IList<string>

EndpointType

The type of the endpoint, either write or read.

Declaration
[JsonProperty("endpointType")]
public virtual string EndpointType { get; set; }
Property Value
Type Description
string

Name

Output only. Identifier. The name of the endpoint resource with the format: * projects/{project}/locations/{region}/endpoints/{endpoint_id} where the endpoint ID segment should satisfy the regex expression [a-z0-9-]+. For more details see https://google.aip.dev/122. The prefix of the endpoint resource name is the name of the parent resource: * projects/{project}/locations/{region}

Declaration
[JsonProperty("name")]
public virtual string Name { get; set; }
Property Value
Type Description
string

Reconciling

Output only. Reconciling (https://google.aip.dev/128#reconciliation). Set to true if the current state of Endpoint does not match the user's intended state, and the service is actively updating the Endpoint to reconcile them. This can happen due to user-triggered updates or system actions like failover or maintenance.

Declaration
[JsonProperty("reconciling")]
public virtual bool? Reconciling { get; set; }
Property Value
Type Description
bool?

State

Output only. The state of the endpoint.

Declaration
[JsonProperty("state")]
public virtual string State { get; set; }
Property Value
Type Description
string

TargetInstances

The names of the target instances for the endpoint, should be of format projects/{project}/locations/{region}/clusters/{cluster}/instances/{instance}. For write endpoint, there is only one target instance which has to be a primary instance. For read endpoint, there can be multiple target instances which can be read or secondary instances. After a cross-region failover or switchover operation, the endpoint will be associated with a different target instance. This change will be reflected in the effective_target_instances field.

Declaration
[JsonProperty("targetInstances")]
public virtual IList<string> TargetInstances { get; set; }
Property Value
Type Description
IList<string>

Uid

Output only. The system-generated UID of the resource. The UID is assigned when the resource is created, and it is retained until it is deleted.

Declaration
[JsonProperty("uid")]
public virtual string Uid { get; set; }
Property Value
Type Description
string

UpdateTime

object representation of UpdateTimeRaw.

Declaration
[JsonIgnore]
[Obsolete("This property is obsolete and may behave unexpectedly; please use UpdateTimeDateTimeOffset instead.")]
public virtual object UpdateTime { get; set; }
Property Value
Type Description
object

UpdateTimeDateTimeOffset

DateTimeOffset representation of UpdateTimeRaw.

Declaration
[JsonIgnore]
public virtual DateTimeOffset? UpdateTimeDateTimeOffset { get; set; }
Property Value
Type Description
DateTimeOffset?

UpdateTimeRaw

Output only. Update time stamp

Declaration
[JsonProperty("updateTime")]
public virtual string UpdateTimeRaw { get; set; }
Property Value
Type Description
string

Implements