public final class Operation extends com.google.protobuf.GeneratedMessageV3 implements OperationOrBuilder
Represents information regarding an operation.Protobuf type
google.api.servicecontrol.v1.Operation| Modifier and Type | Class and Description |
|---|---|
static class |
Operation.Builder
Represents information regarding an operation.
|
static class |
Operation.Importance
Defines the importance of the data contained in the operation.
|
com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage,BuilderType extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType,BuilderType>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable| Modifier and Type | Field and Description |
|---|---|
static int |
CONSUMER_ID_FIELD_NUMBER |
static int |
END_TIME_FIELD_NUMBER |
static int |
IMPORTANCE_FIELD_NUMBER |
static int |
LABELS_FIELD_NUMBER |
static int |
LOG_ENTRIES_FIELD_NUMBER |
static int |
METRIC_VALUE_SETS_FIELD_NUMBER |
static int |
OPERATION_ID_FIELD_NUMBER |
static int |
OPERATION_NAME_FIELD_NUMBER |
static int |
START_TIME_FIELD_NUMBER |
| Modifier and Type | Method and Description |
|---|---|
boolean |
containsLabels(java.lang.String key)
Labels describing the operation.
|
boolean |
equals(java.lang.Object obj) |
java.lang.String |
getConsumerId()
Identity of the consumer who is using the service.
|
com.google.protobuf.ByteString |
getConsumerIdBytes()
Identity of the consumer who is using the service.
|
static Operation |
getDefaultInstance() |
Operation |
getDefaultInstanceForType() |
static com.google.protobuf.Descriptors.Descriptor |
getDescriptor() |
com.google.protobuf.Timestamp |
getEndTime()
End time of the operation.
|
com.google.protobuf.TimestampOrBuilder |
getEndTimeOrBuilder()
End time of the operation.
|
Operation.Importance |
getImportance()
DO NOT USE.
|
int |
getImportanceValue()
DO NOT USE.
|
java.util.Map<java.lang.String,java.lang.String> |
getLabels()
Deprecated.
|
int |
getLabelsCount()
Labels describing the operation.
|
java.util.Map<java.lang.String,java.lang.String> |
getLabelsMap()
Labels describing the operation.
|
java.lang.String |
getLabelsOrDefault(java.lang.String key,
java.lang.String defaultValue)
Labels describing the operation.
|
java.lang.String |
getLabelsOrThrow(java.lang.String key)
Labels describing the operation.
|
LogEntry |
getLogEntries(int index)
Represents information to be logged.
|
int |
getLogEntriesCount()
Represents information to be logged.
|
java.util.List<LogEntry> |
getLogEntriesList()
Represents information to be logged.
|
LogEntryOrBuilder |
getLogEntriesOrBuilder(int index)
Represents information to be logged.
|
java.util.List<? extends LogEntryOrBuilder> |
getLogEntriesOrBuilderList()
Represents information to be logged.
|
MetricValueSet |
getMetricValueSets(int index)
Represents information about this operation.
|
int |
getMetricValueSetsCount()
Represents information about this operation.
|
java.util.List<MetricValueSet> |
getMetricValueSetsList()
Represents information about this operation.
|
MetricValueSetOrBuilder |
getMetricValueSetsOrBuilder(int index)
Represents information about this operation.
|
java.util.List<? extends MetricValueSetOrBuilder> |
getMetricValueSetsOrBuilderList()
Represents information about this operation.
|
java.lang.String |
getOperationId()
Identity of the operation.
|
com.google.protobuf.ByteString |
getOperationIdBytes()
Identity of the operation.
|
java.lang.String |
getOperationName()
Fully qualified name of the operation.
|
com.google.protobuf.ByteString |
getOperationNameBytes()
Fully qualified name of the operation.
|
com.google.protobuf.Parser<Operation> |
getParserForType() |
int |
getSerializedSize() |
com.google.protobuf.Timestamp |
getStartTime()
Required.
|
com.google.protobuf.TimestampOrBuilder |
getStartTimeOrBuilder()
Required.
|
com.google.protobuf.UnknownFieldSet |
getUnknownFields() |
boolean |
hasEndTime()
End time of the operation.
|
int |
hashCode() |
boolean |
hasStartTime()
Required.
|
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable |
internalGetFieldAccessorTable() |
protected com.google.protobuf.MapField |
internalGetMapField(int number) |
boolean |
isInitialized() |
static Operation.Builder |
newBuilder() |
static Operation.Builder |
newBuilder(Operation prototype) |
Operation.Builder |
newBuilderForType() |
protected Operation.Builder |
newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent) |
static Operation |
parseDelimitedFrom(java.io.InputStream input) |
static Operation |
parseDelimitedFrom(java.io.InputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static Operation |
parseFrom(byte[] data) |
static Operation |
parseFrom(byte[] data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static Operation |
parseFrom(com.google.protobuf.ByteString data) |
static Operation |
parseFrom(com.google.protobuf.ByteString data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static Operation |
parseFrom(com.google.protobuf.CodedInputStream input) |
static Operation |
parseFrom(com.google.protobuf.CodedInputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static Operation |
parseFrom(java.io.InputStream input) |
static Operation |
parseFrom(java.io.InputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static com.google.protobuf.Parser<Operation> |
parser() |
Operation.Builder |
toBuilder() |
void |
writeTo(com.google.protobuf.CodedOutputStream output) |
computeStringSize, computeStringSizeNoTag, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof, makeExtensionsImmutable, newBuilderForType, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTagfindInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toStringaddAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeToclone, finalize, getClass, notify, notifyAll, wait, wait, waitpublic static final int OPERATION_ID_FIELD_NUMBER
public static final int OPERATION_NAME_FIELD_NUMBER
public static final int CONSUMER_ID_FIELD_NUMBER
public static final int START_TIME_FIELD_NUMBER
public static final int END_TIME_FIELD_NUMBER
public static final int LABELS_FIELD_NUMBER
public static final int METRIC_VALUE_SETS_FIELD_NUMBER
public static final int LOG_ENTRIES_FIELD_NUMBER
public static final int IMPORTANCE_FIELD_NUMBER
public final com.google.protobuf.UnknownFieldSet getUnknownFields()
getUnknownFields in interface com.google.protobuf.MessageOrBuildergetUnknownFields in class com.google.protobuf.GeneratedMessageV3public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
protected com.google.protobuf.MapField internalGetMapField(int number)
internalGetMapField in class com.google.protobuf.GeneratedMessageV3protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3public java.lang.String getOperationId()
Identity of the operation. This must be unique within the scope of the service that generated the operation. If the service calls Check() and Report() on the same operation, the two calls should carry the same id. UUID version 4 is recommended, though not required. In scenarios where an operation is computed from existing information and an idempotent id is desirable for deduplication purpose, UUID version 5 is recommended. See RFC 4122 for details.
string operation_id = 1;getOperationId in interface OperationOrBuilderpublic com.google.protobuf.ByteString getOperationIdBytes()
Identity of the operation. This must be unique within the scope of the service that generated the operation. If the service calls Check() and Report() on the same operation, the two calls should carry the same id. UUID version 4 is recommended, though not required. In scenarios where an operation is computed from existing information and an idempotent id is desirable for deduplication purpose, UUID version 5 is recommended. See RFC 4122 for details.
string operation_id = 1;getOperationIdBytes in interface OperationOrBuilderpublic java.lang.String getOperationName()
Fully qualified name of the operation. Reserved for future use.
string operation_name = 2;getOperationName in interface OperationOrBuilderpublic com.google.protobuf.ByteString getOperationNameBytes()
Fully qualified name of the operation. Reserved for future use.
string operation_name = 2;getOperationNameBytes in interface OperationOrBuilderpublic java.lang.String getConsumerId()
Identity of the consumer who is using the service. This field should be filled in for the operations initiated by a consumer, but not for service-initiated operations that are not related to a specific consumer. This can be in one of the following formats: project:<project_id>, project_number:<project_number>, api_key:<api_key>.
string consumer_id = 3;getConsumerId in interface OperationOrBuilderpublic com.google.protobuf.ByteString getConsumerIdBytes()
Identity of the consumer who is using the service. This field should be filled in for the operations initiated by a consumer, but not for service-initiated operations that are not related to a specific consumer. This can be in one of the following formats: project:<project_id>, project_number:<project_number>, api_key:<api_key>.
string consumer_id = 3;getConsumerIdBytes in interface OperationOrBuilderpublic boolean hasStartTime()
Required. Start time of the operation.
.google.protobuf.Timestamp start_time = 4;hasStartTime in interface OperationOrBuilderpublic com.google.protobuf.Timestamp getStartTime()
Required. Start time of the operation.
.google.protobuf.Timestamp start_time = 4;getStartTime in interface OperationOrBuilderpublic com.google.protobuf.TimestampOrBuilder getStartTimeOrBuilder()
Required. Start time of the operation.
.google.protobuf.Timestamp start_time = 4;getStartTimeOrBuilder in interface OperationOrBuilderpublic boolean hasEndTime()
End time of the operation. Required when the operation is used in [ServiceController.Report][google.api.servicecontrol.v1.ServiceController.Report], but optional when the operation is used in [ServiceController.Check][google.api.servicecontrol.v1.ServiceController.Check].
.google.protobuf.Timestamp end_time = 5;hasEndTime in interface OperationOrBuilderpublic com.google.protobuf.Timestamp getEndTime()
End time of the operation. Required when the operation is used in [ServiceController.Report][google.api.servicecontrol.v1.ServiceController.Report], but optional when the operation is used in [ServiceController.Check][google.api.servicecontrol.v1.ServiceController.Check].
.google.protobuf.Timestamp end_time = 5;getEndTime in interface OperationOrBuilderpublic com.google.protobuf.TimestampOrBuilder getEndTimeOrBuilder()
End time of the operation. Required when the operation is used in [ServiceController.Report][google.api.servicecontrol.v1.ServiceController.Report], but optional when the operation is used in [ServiceController.Check][google.api.servicecontrol.v1.ServiceController.Check].
.google.protobuf.Timestamp end_time = 5;getEndTimeOrBuilder in interface OperationOrBuilderpublic int getLabelsCount()
OperationOrBuilder
Labels describing the operation. Only the following labels are allowed:
- Labels describing monitored resources as defined in
the service configuration.
- Default labels of metric values. When specified, labels defined in the
metric value override these default.
- The following labels defined by Google Cloud Platform:
- `cloud.googleapis.com/location` describing the location where the
operation happened,
- `servicecontrol.googleapis.com/user_agent` describing the user agent
of the API request,
- `servicecontrol.googleapis.com/service_agent` describing the service
used to handle the API request (e.g. ESP),
- `servicecontrol.googleapis.com/platform` describing the platform
where the API is served (e.g. GAE, GCE, GKE).
map<string, string> labels = 6;getLabelsCount in interface OperationOrBuilderpublic boolean containsLabels(java.lang.String key)
Labels describing the operation. Only the following labels are allowed:
- Labels describing monitored resources as defined in
the service configuration.
- Default labels of metric values. When specified, labels defined in the
metric value override these default.
- The following labels defined by Google Cloud Platform:
- `cloud.googleapis.com/location` describing the location where the
operation happened,
- `servicecontrol.googleapis.com/user_agent` describing the user agent
of the API request,
- `servicecontrol.googleapis.com/service_agent` describing the service
used to handle the API request (e.g. ESP),
- `servicecontrol.googleapis.com/platform` describing the platform
where the API is served (e.g. GAE, GCE, GKE).
map<string, string> labels = 6;containsLabels in interface OperationOrBuilder@Deprecated public java.util.Map<java.lang.String,java.lang.String> getLabels()
getLabelsMap() instead.getLabels in interface OperationOrBuilderpublic java.util.Map<java.lang.String,java.lang.String> getLabelsMap()
Labels describing the operation. Only the following labels are allowed:
- Labels describing monitored resources as defined in
the service configuration.
- Default labels of metric values. When specified, labels defined in the
metric value override these default.
- The following labels defined by Google Cloud Platform:
- `cloud.googleapis.com/location` describing the location where the
operation happened,
- `servicecontrol.googleapis.com/user_agent` describing the user agent
of the API request,
- `servicecontrol.googleapis.com/service_agent` describing the service
used to handle the API request (e.g. ESP),
- `servicecontrol.googleapis.com/platform` describing the platform
where the API is served (e.g. GAE, GCE, GKE).
map<string, string> labels = 6;getLabelsMap in interface OperationOrBuilderpublic java.lang.String getLabelsOrDefault(java.lang.String key,
java.lang.String defaultValue)
Labels describing the operation. Only the following labels are allowed:
- Labels describing monitored resources as defined in
the service configuration.
- Default labels of metric values. When specified, labels defined in the
metric value override these default.
- The following labels defined by Google Cloud Platform:
- `cloud.googleapis.com/location` describing the location where the
operation happened,
- `servicecontrol.googleapis.com/user_agent` describing the user agent
of the API request,
- `servicecontrol.googleapis.com/service_agent` describing the service
used to handle the API request (e.g. ESP),
- `servicecontrol.googleapis.com/platform` describing the platform
where the API is served (e.g. GAE, GCE, GKE).
map<string, string> labels = 6;getLabelsOrDefault in interface OperationOrBuilderpublic java.lang.String getLabelsOrThrow(java.lang.String key)
Labels describing the operation. Only the following labels are allowed:
- Labels describing monitored resources as defined in
the service configuration.
- Default labels of metric values. When specified, labels defined in the
metric value override these default.
- The following labels defined by Google Cloud Platform:
- `cloud.googleapis.com/location` describing the location where the
operation happened,
- `servicecontrol.googleapis.com/user_agent` describing the user agent
of the API request,
- `servicecontrol.googleapis.com/service_agent` describing the service
used to handle the API request (e.g. ESP),
- `servicecontrol.googleapis.com/platform` describing the platform
where the API is served (e.g. GAE, GCE, GKE).
map<string, string> labels = 6;getLabelsOrThrow in interface OperationOrBuilderpublic java.util.List<MetricValueSet> getMetricValueSetsList()
Represents information about this operation. Each MetricValueSet corresponds to a metric defined in the service configuration. The data type used in the MetricValueSet must agree with the data type specified in the metric definition. Within a single operation, it is not allowed to have more than one MetricValue instances that have the same metric names and identical label value combinations. If a request has such duplicated MetricValue instances, the entire request is rejected with an invalid argument error.
repeated .google.api.servicecontrol.v1.MetricValueSet metric_value_sets = 7;getMetricValueSetsList in interface OperationOrBuilderpublic java.util.List<? extends MetricValueSetOrBuilder> getMetricValueSetsOrBuilderList()
Represents information about this operation. Each MetricValueSet corresponds to a metric defined in the service configuration. The data type used in the MetricValueSet must agree with the data type specified in the metric definition. Within a single operation, it is not allowed to have more than one MetricValue instances that have the same metric names and identical label value combinations. If a request has such duplicated MetricValue instances, the entire request is rejected with an invalid argument error.
repeated .google.api.servicecontrol.v1.MetricValueSet metric_value_sets = 7;getMetricValueSetsOrBuilderList in interface OperationOrBuilderpublic int getMetricValueSetsCount()
Represents information about this operation. Each MetricValueSet corresponds to a metric defined in the service configuration. The data type used in the MetricValueSet must agree with the data type specified in the metric definition. Within a single operation, it is not allowed to have more than one MetricValue instances that have the same metric names and identical label value combinations. If a request has such duplicated MetricValue instances, the entire request is rejected with an invalid argument error.
repeated .google.api.servicecontrol.v1.MetricValueSet metric_value_sets = 7;getMetricValueSetsCount in interface OperationOrBuilderpublic MetricValueSet getMetricValueSets(int index)
Represents information about this operation. Each MetricValueSet corresponds to a metric defined in the service configuration. The data type used in the MetricValueSet must agree with the data type specified in the metric definition. Within a single operation, it is not allowed to have more than one MetricValue instances that have the same metric names and identical label value combinations. If a request has such duplicated MetricValue instances, the entire request is rejected with an invalid argument error.
repeated .google.api.servicecontrol.v1.MetricValueSet metric_value_sets = 7;getMetricValueSets in interface OperationOrBuilderpublic MetricValueSetOrBuilder getMetricValueSetsOrBuilder(int index)
Represents information about this operation. Each MetricValueSet corresponds to a metric defined in the service configuration. The data type used in the MetricValueSet must agree with the data type specified in the metric definition. Within a single operation, it is not allowed to have more than one MetricValue instances that have the same metric names and identical label value combinations. If a request has such duplicated MetricValue instances, the entire request is rejected with an invalid argument error.
repeated .google.api.servicecontrol.v1.MetricValueSet metric_value_sets = 7;getMetricValueSetsOrBuilder in interface OperationOrBuilderpublic java.util.List<LogEntry> getLogEntriesList()
Represents information to be logged.
repeated .google.api.servicecontrol.v1.LogEntry log_entries = 8;getLogEntriesList in interface OperationOrBuilderpublic java.util.List<? extends LogEntryOrBuilder> getLogEntriesOrBuilderList()
Represents information to be logged.
repeated .google.api.servicecontrol.v1.LogEntry log_entries = 8;getLogEntriesOrBuilderList in interface OperationOrBuilderpublic int getLogEntriesCount()
Represents information to be logged.
repeated .google.api.servicecontrol.v1.LogEntry log_entries = 8;getLogEntriesCount in interface OperationOrBuilderpublic LogEntry getLogEntries(int index)
Represents information to be logged.
repeated .google.api.servicecontrol.v1.LogEntry log_entries = 8;getLogEntries in interface OperationOrBuilderpublic LogEntryOrBuilder getLogEntriesOrBuilder(int index)
Represents information to be logged.
repeated .google.api.servicecontrol.v1.LogEntry log_entries = 8;getLogEntriesOrBuilder in interface OperationOrBuilderpublic int getImportanceValue()
DO NOT USE. This is an experimental field.
.google.api.servicecontrol.v1.Operation.Importance importance = 11;getImportanceValue in interface OperationOrBuilderpublic Operation.Importance getImportance()
DO NOT USE. This is an experimental field.
.google.api.servicecontrol.v1.Operation.Importance importance = 11;getImportance in interface OperationOrBuilderpublic final boolean isInitialized()
isInitialized in interface com.google.protobuf.MessageLiteOrBuilderisInitialized in class com.google.protobuf.GeneratedMessageV3public void writeTo(com.google.protobuf.CodedOutputStream output)
throws java.io.IOException
writeTo in interface com.google.protobuf.MessageLitewriteTo in class com.google.protobuf.GeneratedMessageV3java.io.IOExceptionpublic int getSerializedSize()
getSerializedSize in interface com.google.protobuf.MessageLitegetSerializedSize in class com.google.protobuf.GeneratedMessageV3public boolean equals(java.lang.Object obj)
equals in interface com.google.protobuf.Messageequals in class com.google.protobuf.AbstractMessagepublic int hashCode()
hashCode in interface com.google.protobuf.MessagehashCode in class com.google.protobuf.AbstractMessagepublic static Operation parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static Operation parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static Operation parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static Operation parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static Operation parseFrom(java.io.InputStream input) throws java.io.IOException
java.io.IOExceptionpublic static Operation parseFrom(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws java.io.IOException
java.io.IOExceptionpublic static Operation parseDelimitedFrom(java.io.InputStream input) throws java.io.IOException
java.io.IOExceptionpublic static Operation parseDelimitedFrom(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws java.io.IOException
java.io.IOExceptionpublic static Operation parseFrom(com.google.protobuf.CodedInputStream input) throws java.io.IOException
java.io.IOExceptionpublic static Operation parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws java.io.IOException
java.io.IOExceptionpublic Operation.Builder newBuilderForType()
newBuilderForType in interface com.google.protobuf.MessagenewBuilderForType in interface com.google.protobuf.MessageLitepublic static Operation.Builder newBuilder()
public static Operation.Builder newBuilder(Operation prototype)
public Operation.Builder toBuilder()
toBuilder in interface com.google.protobuf.MessagetoBuilder in interface com.google.protobuf.MessageLiteprotected Operation.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
newBuilderForType in class com.google.protobuf.GeneratedMessageV3public static Operation getDefaultInstance()
public static com.google.protobuf.Parser<Operation> parser()
public com.google.protobuf.Parser<Operation> getParserForType()
getParserForType in interface com.google.protobuf.MessagegetParserForType in interface com.google.protobuf.MessageLitegetParserForType in class com.google.protobuf.GeneratedMessageV3public Operation getDefaultInstanceForType()
getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuildergetDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder