Package com.google.api.servicecontrol.v1

Interface OperationOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
Operation, Operation.Builder
@Generated public interface OperationOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Details

    • getOperationId

      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;
      Returns:
      The operationId.

    • getOperationIdBytes

      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;
      Returns:
      The bytes for operationId.

    • getOperationName

      String getOperationName()
       Fully qualified name of the operation. Reserved for future use.
      string operation_name = 2;
      Returns:
      The operationName.

    • getOperationNameBytes

      com.google.protobuf.ByteString getOperationNameBytes()
       Fully qualified name of the operation. Reserved for future use.
      string operation_name = 2;
      Returns:
      The bytes for operationName.

    • getConsumerId

      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;
      Returns:
      The consumerId.

    • getConsumerIdBytes

      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,
 - projects/PROJECT_ID or PROJECT_NUMBER,
 - folders/FOLDER_NUMBER,
 - organizations/ORGANIZATION_NUMBER,
 - api`_`key:API_KEY.
      string consumer_id = 3;
      Returns:
      The bytes for consumerId.

    • hasStartTime

      boolean hasStartTime()
       Required. Start time of the operation.
      .google.protobuf.Timestamp start_time = 4;
      Returns:
      Whether the startTime field is set.

    • getStartTime

      com.google.protobuf.Timestamp getStartTime()
       Required. Start time of the operation.
      .google.protobuf.Timestamp start_time = 4;
      Returns:
      The startTime.

    • getStartTimeOrBuilder

      com.google.protobuf.TimestampOrBuilder getStartTimeOrBuilder()
       Required. Start time of the operation.
      .google.protobuf.Timestamp start_time = 4;

    • hasEndTime

      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;
      Returns:
      Whether the endTime field is set.

    • getEndTime

      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;
      Returns:
      The endTime.

    • getEndTimeOrBuilder

      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;

    • getLabelsCount

      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;

    • containsLabels

      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;

    • getLabels

      @Deprecated Map<String,String> getLabels()
      Deprecated.
      Use getLabelsMap() instead.

    • getLabelsMap

      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 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 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;

    • getMetricValueSetsList

      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;

    • getMetricValueSets

      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

      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;

    • getMetricValueSetsOrBuilderList

      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;

    • getMetricValueSetsOrBuilder

      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;

    • getLogEntriesList

      List<LogEntry> getLogEntriesList()
       Represents information to be logged.
      repeated .google.api.servicecontrol.v1.LogEntry log_entries = 8;

    • getLogEntries

      LogEntry getLogEntries(int index)
       Represents information to be logged.
      repeated .google.api.servicecontrol.v1.LogEntry log_entries = 8;

    • getLogEntriesCount

      int getLogEntriesCount()
       Represents information to be logged.
      repeated .google.api.servicecontrol.v1.LogEntry log_entries = 8;

    • getLogEntriesOrBuilderList

      List<? extends LogEntryOrBuilder> getLogEntriesOrBuilderList()
       Represents information to be logged.
      repeated .google.api.servicecontrol.v1.LogEntry log_entries = 8;

    • getLogEntriesOrBuilder

      LogEntryOrBuilder getLogEntriesOrBuilder(int index)
       Represents information to be logged.
      repeated .google.api.servicecontrol.v1.LogEntry log_entries = 8;

    • getImportanceValue

      int getImportanceValue()
       DO NOT USE. This is an experimental field.
      .google.api.servicecontrol.v1.Operation.Importance importance = 11;
      Returns:
      The enum numeric value on the wire for importance.

    • getImportance

      Operation.Importance getImportance()
       DO NOT USE. This is an experimental field.
      .google.api.servicecontrol.v1.Operation.Importance importance = 11;
      Returns:
      The importance.

    • getExtensionsList

      List<com.google.protobuf.Any> getExtensionsList()
       Unimplemented.
      repeated .google.protobuf.Any extensions = 16;

    • getExtensions

      com.google.protobuf.Any getExtensions(int index)
       Unimplemented.
      repeated .google.protobuf.Any extensions = 16;

    • getExtensionsCount

      int getExtensionsCount()
       Unimplemented.
      repeated .google.protobuf.Any extensions = 16;

    • getExtensionsOrBuilderList

      List<? extends com.google.protobuf.AnyOrBuilder> getExtensionsOrBuilderList()
       Unimplemented.
      repeated .google.protobuf.Any extensions = 16;

    • getExtensionsOrBuilder

      com.google.protobuf.AnyOrBuilder getExtensionsOrBuilder(int index)
       Unimplemented.
      repeated .google.protobuf.Any extensions = 16;