public final class Operation extends GeneratedMessageV3 implements OperationOrBuilder
Represents information regarding an operation.
Protobuf type google.api.servicecontrol.v1.Operation
Static Fields
CONSUMER_ID_FIELD_NUMBER
public static final int CONSUMER_ID_FIELD_NUMBER
Field Value
END_TIME_FIELD_NUMBER
public static final int END_TIME_FIELD_NUMBER
Field Value
EXTENSIONS_FIELD_NUMBER
public static final int EXTENSIONS_FIELD_NUMBER
Field Value
IMPORTANCE_FIELD_NUMBER
public static final int IMPORTANCE_FIELD_NUMBER
Field Value
LABELS_FIELD_NUMBER
public static final int LABELS_FIELD_NUMBER
Field Value
LOG_ENTRIES_FIELD_NUMBER
public static final int LOG_ENTRIES_FIELD_NUMBER
Field Value
METRIC_VALUE_SETS_FIELD_NUMBER
public static final int METRIC_VALUE_SETS_FIELD_NUMBER
Field Value
OPERATION_ID_FIELD_NUMBER
public static final int OPERATION_ID_FIELD_NUMBER
Field Value
OPERATION_NAME_FIELD_NUMBER
public static final int OPERATION_NAME_FIELD_NUMBER
Field Value
START_TIME_FIELD_NUMBER
public static final int START_TIME_FIELD_NUMBER
Field Value
Static Methods
getDefaultInstance()
public static Operation getDefaultInstance()
Returns
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns
newBuilder()
public static Operation.Builder newBuilder()
Returns
newBuilder(Operation prototype)
public static Operation.Builder newBuilder(Operation prototype)
Parameter
Returns
public static Operation parseDelimitedFrom(InputStream input)
Parameter
Returns
Exceptions
public static Operation parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(byte[] data)
public static Operation parseFrom(byte[] data)
Parameter
| Name | Description |
| data | byte[]
|
Returns
Exceptions
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static Operation parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteString data)
public static Operation parseFrom(ByteString data)
Parameter
Returns
Exceptions
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static Operation parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static Operation parseFrom(CodedInputStream input)
Parameter
Returns
Exceptions
public static Operation parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static Operation parseFrom(InputStream input)
Parameter
Returns
Exceptions
public static Operation parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteBuffer data)
public static Operation parseFrom(ByteBuffer data)
Parameter
Returns
Exceptions
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static Operation parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parser()
public static Parser<Operation> parser()
Returns
Methods
containsLabels(String key)
public boolean containsLabels(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, such as App Engine, Compute Engine, or
Kubernetes Engine.
map<string, string> labels = 6;
equals(Object obj)
public boolean equals(Object obj)
Parameter
Returns
Overrides
getConsumerId()
public 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,
- projects/PROJECT_ID or PROJECT_NUMBER,
- folders/FOLDER_NUMBER,
- organizations/ORGANIZATION_NUMBER,
- api
_key:API_KEY.
string consumer_id = 3;
| Type | Description |
| String | The consumerId.
|
getConsumerIdBytes()
public 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,
- projects/PROJECT_ID or PROJECT_NUMBER,
- folders/FOLDER_NUMBER,
- organizations/ORGANIZATION_NUMBER,
- api
_key:API_KEY.
string consumer_id = 3;
| Type | Description |
| ByteString | The bytes for consumerId.
|
getDefaultInstanceForType()
public Operation getDefaultInstanceForType()
Returns
getEndTime()
public Timestamp getEndTime()
End time of the operation.
Required when the operation is used in
ServiceController.Report,
but optional when the operation is used in
ServiceController.Check.
.google.protobuf.Timestamp end_time = 5;
getEndTimeOrBuilder()
public TimestampOrBuilder getEndTimeOrBuilder()
End time of the operation.
Required when the operation is used in
ServiceController.Report,
but optional when the operation is used in
ServiceController.Check.
.google.protobuf.Timestamp end_time = 5;
getExtensions(int index)
public Any getExtensions(int index)
Unimplemented.
repeated .google.protobuf.Any extensions = 16;
getExtensionsCount()
public int getExtensionsCount()
Unimplemented.
repeated .google.protobuf.Any extensions = 16;
getExtensionsList()
public List<Any> getExtensionsList()
Unimplemented.
repeated .google.protobuf.Any extensions = 16;
getExtensionsOrBuilder(int index)
public AnyOrBuilder getExtensionsOrBuilder(int index)
Unimplemented.
repeated .google.protobuf.Any extensions = 16;
getExtensionsOrBuilderList()
public List<? extends AnyOrBuilder> getExtensionsOrBuilderList()
Unimplemented.
repeated .google.protobuf.Any extensions = 16;
| Type | Description |
| List<? extends com.google.protobuf.AnyOrBuilder> | |
getImportance()
public Operation.Importance getImportance()
DO NOT USE. This is an experimental field.
.google.api.servicecontrol.v1.Operation.Importance importance = 11;
getImportanceValue()
public int getImportanceValue()
DO NOT USE. This is an experimental field.
.google.api.servicecontrol.v1.Operation.Importance importance = 11;
| Type | Description |
| int | The enum numeric value on the wire for importance.
|
getLabels()
public Map<String,String> getLabels()
Returns
getLabelsCount()
public int getLabelsCount()
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, such as App Engine, Compute Engine, or
Kubernetes Engine.
map<string, string> labels = 6;
getLabelsMap()
public Map<String,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, such as App Engine, Compute Engine, or
Kubernetes Engine.
map<string, string> labels = 6;
getLabelsOrDefault(String key, String defaultValue)
public String getLabelsOrDefault(String key, 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, such as App Engine, Compute Engine, or
Kubernetes Engine.
map<string, string> labels = 6;
getLabelsOrThrow(String key)
public String getLabelsOrThrow(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, such as App Engine, Compute Engine, or
Kubernetes Engine.
map<string, string> labels = 6;
getLogEntries(int index)
public LogEntry getLogEntries(int index)
Represents information to be logged.
repeated .google.api.servicecontrol.v1.LogEntry log_entries = 8;
getLogEntriesCount()
public int getLogEntriesCount()
Represents information to be logged.
repeated .google.api.servicecontrol.v1.LogEntry log_entries = 8;
getLogEntriesList()
public List<LogEntry> getLogEntriesList()
Represents information to be logged.
repeated .google.api.servicecontrol.v1.LogEntry log_entries = 8;
getLogEntriesOrBuilder(int index)
public LogEntryOrBuilder getLogEntriesOrBuilder(int index)
Represents information to be logged.
repeated .google.api.servicecontrol.v1.LogEntry log_entries = 8;
getLogEntriesOrBuilderList()
public List<? extends LogEntryOrBuilder> getLogEntriesOrBuilderList()
Represents information to be logged.
repeated .google.api.servicecontrol.v1.LogEntry log_entries = 8;
| Type | Description |
| List<? extends com.google.api.servicecontrol.v1.LogEntryOrBuilder> | |
getMetricValueSets(int index)
public 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;
getMetricValueSetsCount()
public 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;
getMetricValueSetsList()
public 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;
getMetricValueSetsOrBuilder(int index)
public 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;
getMetricValueSetsOrBuilderList()
public 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;
| Type | Description |
| List<? extends com.google.api.servicecontrol.v1.MetricValueSetOrBuilder> | |
getOperationId()
public 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;
| Type | Description |
| String | The operationId.
|
getOperationIdBytes()
public 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;
| Type | Description |
| ByteString | The bytes for operationId.
|
getOperationName()
public String getOperationName()
Fully qualified name of the operation. Reserved for future use.
string operation_name = 2;
| Type | Description |
| String | The operationName.
|
getOperationNameBytes()
public ByteString getOperationNameBytes()
Fully qualified name of the operation. Reserved for future use.
string operation_name = 2;
| Type | Description |
| ByteString | The bytes for operationName.
|
getParserForType()
public Parser<Operation> getParserForType()
Returns
Overrides
getSerializedSize()
public int getSerializedSize()
Returns
Overrides
getStartTime()
public Timestamp getStartTime()
Required. Start time of the operation.
.google.protobuf.Timestamp start_time = 4;
getStartTimeOrBuilder()
public TimestampOrBuilder getStartTimeOrBuilder()
Required. Start time of the operation.
.google.protobuf.Timestamp start_time = 4;
getUnknownFields()
public final UnknownFieldSet getUnknownFields()
Returns
Overrides
hasEndTime()
public boolean hasEndTime()
End time of the operation.
Required when the operation is used in
ServiceController.Report,
but optional when the operation is used in
ServiceController.Check.
.google.protobuf.Timestamp end_time = 5;
| Type | Description |
| boolean | Whether the endTime field is set.
|
hasStartTime()
public boolean hasStartTime()
Required. Start time of the operation.
.google.protobuf.Timestamp start_time = 4;
| Type | Description |
| boolean | Whether the startTime field is set.
|
hashCode()
Returns
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Overrides
internalGetMapField(int number)
protected MapField internalGetMapField(int number)
Parameter
Returns
Overrides
isInitialized()
public final boolean isInitialized()
Returns
Overrides
newBuilderForType()
public Operation.Builder newBuilderForType()
Returns
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected Operation.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Returns
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Returns
Overrides
toBuilder()
public Operation.Builder toBuilder()
Returns
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Parameter
Overrides
Exceptions
