Package io.grpc.xds.client
Class XdsClient.ResourceMetadata
- java.lang.Object
-
- io.grpc.xds.client.XdsClient.ResourceMetadata
-
- Enclosing class:
- XdsClient
public static final class XdsClient.ResourceMetadata extends java.lang.Object
The metadata of the xDS resource; used by the xDS config dump.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
XdsClient.ResourceMetadata.ResourceMetadataStatus
Resource status from the view of a xDS client, which tells the synchronization status between the xDS client and the xDS server.static class
XdsClient.ResourceMetadata.UpdateFailureState
Captures error metadata of failed resource updates.
-
Field Summary
Fields Modifier and Type Field Description private XdsClient.ResourceMetadata.UpdateFailureState
errorState
private com.google.protobuf.Any
rawResource
private XdsClient.ResourceMetadata.ResourceMetadataStatus
status
private long
updateTimeNanos
private java.lang.String
version
-
Constructor Summary
Constructors Modifier Constructor Description private
ResourceMetadata(XdsClient.ResourceMetadata.ResourceMetadataStatus status, java.lang.String version, long updateTimeNanos, com.google.protobuf.Any rawResource, XdsClient.ResourceMetadata.UpdateFailureState errorState)
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description XdsClient.ResourceMetadata.UpdateFailureState
getErrorState()
The metadata capturing the error details of the last rejected update of the resource.com.google.protobuf.Any
getRawResource()
The last successfully updated xDS resource as it was returned by the server.XdsClient.ResourceMetadata.ResourceMetadataStatus
getStatus()
The client status of this resource.long
getUpdateTimeNanos()
The timestamp when the resource was last successfully updated.java.lang.String
getVersion()
The last successfully updated version of the resource.static XdsClient.ResourceMetadata
newResourceMetadataAcked(com.google.protobuf.Any rawResource, java.lang.String version, long updateTimeNanos)
(package private) static XdsClient.ResourceMetadata
newResourceMetadataDoesNotExist()
(package private) static XdsClient.ResourceMetadata
newResourceMetadataNacked(XdsClient.ResourceMetadata metadata, java.lang.String failedVersion, long failedUpdateTime, java.lang.String failedDetails)
(package private) static XdsClient.ResourceMetadata
newResourceMetadataRequested()
(package private) static XdsClient.ResourceMetadata
newResourceMetadataUnknown()
-
-
-
Field Detail
-
version
private final java.lang.String version
-
status
private final XdsClient.ResourceMetadata.ResourceMetadataStatus status
-
updateTimeNanos
private final long updateTimeNanos
-
rawResource
@Nullable private final com.google.protobuf.Any rawResource
-
errorState
@Nullable private final XdsClient.ResourceMetadata.UpdateFailureState errorState
-
-
Constructor Detail
-
ResourceMetadata
private ResourceMetadata(XdsClient.ResourceMetadata.ResourceMetadataStatus status, java.lang.String version, long updateTimeNanos, @Nullable com.google.protobuf.Any rawResource, @Nullable XdsClient.ResourceMetadata.UpdateFailureState errorState)
-
-
Method Detail
-
newResourceMetadataUnknown
static XdsClient.ResourceMetadata newResourceMetadataUnknown()
-
newResourceMetadataRequested
static XdsClient.ResourceMetadata newResourceMetadataRequested()
-
newResourceMetadataDoesNotExist
static XdsClient.ResourceMetadata newResourceMetadataDoesNotExist()
-
newResourceMetadataAcked
public static XdsClient.ResourceMetadata newResourceMetadataAcked(com.google.protobuf.Any rawResource, java.lang.String version, long updateTimeNanos)
-
newResourceMetadataNacked
static XdsClient.ResourceMetadata newResourceMetadataNacked(XdsClient.ResourceMetadata metadata, java.lang.String failedVersion, long failedUpdateTime, java.lang.String failedDetails)
-
getVersion
public java.lang.String getVersion()
The last successfully updated version of the resource.
-
getStatus
public XdsClient.ResourceMetadata.ResourceMetadataStatus getStatus()
The client status of this resource.
-
getUpdateTimeNanos
public long getUpdateTimeNanos()
The timestamp when the resource was last successfully updated.
-
getRawResource
@Nullable public com.google.protobuf.Any getRawResource()
The last successfully updated xDS resource as it was returned by the server.
-
getErrorState
@Nullable public XdsClient.ResourceMetadata.UpdateFailureState getErrorState()
The metadata capturing the error details of the last rejected update of the resource.
-
-