Class: Google::Cloud::ServiceControl::V1::CheckResponse

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/api/servicecontrol/v1/service_controller.rb

Overview

Response message for the Check method.

Defined Under Namespace

Classes: CheckInfo, ConsumerInfo

Instance Attribute Summary collapse

Instance Attribute Details

#check_errors ⇒ ::Array<::Google::Cloud::ServiceControl::V1::CheckError>

Returns Indicate the decision of the check.

If no check errors are present, the service should process the operation. Otherwise the service should use the list of errors to determine the appropriate action.

Returns:

  • (::Array<::Google::Cloud::ServiceControl::V1::CheckError>) —

    Indicate the decision of the check.

    If no check errors are present, the service should process the operation. Otherwise the service should use the list of errors to determine the appropriate action.



70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
 
# File 'proto_docs/google/api/servicecontrol/v1/service_controller.rb', line 70

class CheckResponse
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Contains additional information about the check operation.
  # @!attribute [rw] unused_arguments
  #   @return [::Array<::String>]
  #     A list of fields and label keys that are ignored by the server.
  #     The client doesn't need to send them for following requests to improve
  #     performance and allow better aggregation.
  # @!attribute [rw] consumer_info
  #   @return [::Google::Cloud::ServiceControl::V1::CheckResponse::ConsumerInfo]
  #     Consumer info of this check.
  # @!attribute [rw] api_key_uid
  #   @return [::String]
  #     The unique id of the api key in the format of "apikey:<UID>".
  #     This field will be populated when the consumer passed to Service Control
  #     is an API key and all the API key related validations are successful.
  class CheckInfo
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # `ConsumerInfo` provides information about the consumer.
  # @!attribute [rw] project_number
  #   @return [::Integer]
  #     The Google cloud project number, e.g. 1234567890. A value of 0 indicates
  #     no project number is found.
  #
  #     NOTE: This field is deprecated after we support flexible consumer
  #     id. New code should not depend on this field anymore.
  # @!attribute [rw] type
  #   @return [::Google::Cloud::ServiceControl::V1::CheckResponse::ConsumerInfo::ConsumerType]
  #     The type of the consumer which should have been defined in
  #     [Google Resource Manager](https://cloud.google.com/resource-manager/).
  # @!attribute [rw] consumer_number
  #   @return [::Integer]
  #     The consumer identity number, can be Google cloud project number, folder
  #     number or organization number e.g. 1234567890. A value of 0 indicates no
  #     consumer number is found.
  class ConsumerInfo
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # The type of the consumer as defined in
    # [Google Resource Manager](https://cloud.google.com/resource-manager/).
    module ConsumerType
      # This is never used.
      CONSUMER_TYPE_UNSPECIFIED = 0

      # The consumer is a Google Cloud Project.
      PROJECT = 1

      # The consumer is a Google Cloud Folder.
      FOLDER = 2

      # The consumer is a Google Cloud Organization.
      ORGANIZATION = 3

      # Service-specific resource container which is defined by the service
      # producer to offer their users the ability to manage service control
      # functionalities at a finer level of granularity than the PROJECT.
      SERVICE_SPECIFIC = 4
    end
  end
end

#check_info ⇒ ::Google::Cloud::ServiceControl::V1::CheckResponse::CheckInfo

Returns Feedback data returned from the server during processing a Check request.

Returns:



70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
 
# File 'proto_docs/google/api/servicecontrol/v1/service_controller.rb', line 70

class CheckResponse
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Contains additional information about the check operation.
  # @!attribute [rw] unused_arguments
  #   @return [::Array<::String>]
  #     A list of fields and label keys that are ignored by the server.
  #     The client doesn't need to send them for following requests to improve
  #     performance and allow better aggregation.
  # @!attribute [rw] consumer_info
  #   @return [::Google::Cloud::ServiceControl::V1::CheckResponse::ConsumerInfo]
  #     Consumer info of this check.
  # @!attribute [rw] api_key_uid
  #   @return [::String]
  #     The unique id of the api key in the format of "apikey:<UID>".
  #     This field will be populated when the consumer passed to Service Control
  #     is an API key and all the API key related validations are successful.
  class CheckInfo
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # `ConsumerInfo` provides information about the consumer.
  # @!attribute [rw] project_number
  #   @return [::Integer]
  #     The Google cloud project number, e.g. 1234567890. A value of 0 indicates
  #     no project number is found.
  #
  #     NOTE: This field is deprecated after we support flexible consumer
  #     id. New code should not depend on this field anymore.
  # @!attribute [rw] type
  #   @return [::Google::Cloud::ServiceControl::V1::CheckResponse::ConsumerInfo::ConsumerType]
  #     The type of the consumer which should have been defined in
  #     [Google Resource Manager](https://cloud.google.com/resource-manager/).
  # @!attribute [rw] consumer_number
  #   @return [::Integer]
  #     The consumer identity number, can be Google cloud project number, folder
  #     number or organization number e.g. 1234567890. A value of 0 indicates no
  #     consumer number is found.
  class ConsumerInfo
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # The type of the consumer as defined in
    # [Google Resource Manager](https://cloud.google.com/resource-manager/).
    module ConsumerType
      # This is never used.
      CONSUMER_TYPE_UNSPECIFIED = 0

      # The consumer is a Google Cloud Project.
      PROJECT = 1

      # The consumer is a Google Cloud Folder.
      FOLDER = 2

      # The consumer is a Google Cloud Organization.
      ORGANIZATION = 3

      # Service-specific resource container which is defined by the service
      # producer to offer their users the ability to manage service control
      # functionalities at a finer level of granularity than the PROJECT.
      SERVICE_SPECIFIC = 4
    end
  end
end

#operation_id ⇒ ::String

Returns The same operation_id value used in the CheckRequest. Used for logging and diagnostics purposes.

Returns:

  • (::String) —

    The same operation_id value used in the CheckRequest. Used for logging and diagnostics purposes.



70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
 
# File 'proto_docs/google/api/servicecontrol/v1/service_controller.rb', line 70

class CheckResponse
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Contains additional information about the check operation.
  # @!attribute [rw] unused_arguments
  #   @return [::Array<::String>]
  #     A list of fields and label keys that are ignored by the server.
  #     The client doesn't need to send them for following requests to improve
  #     performance and allow better aggregation.
  # @!attribute [rw] consumer_info
  #   @return [::Google::Cloud::ServiceControl::V1::CheckResponse::ConsumerInfo]
  #     Consumer info of this check.
  # @!attribute [rw] api_key_uid
  #   @return [::String]
  #     The unique id of the api key in the format of "apikey:<UID>".
  #     This field will be populated when the consumer passed to Service Control
  #     is an API key and all the API key related validations are successful.
  class CheckInfo
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # `ConsumerInfo` provides information about the consumer.
  # @!attribute [rw] project_number
  #   @return [::Integer]
  #     The Google cloud project number, e.g. 1234567890. A value of 0 indicates
  #     no project number is found.
  #
  #     NOTE: This field is deprecated after we support flexible consumer
  #     id. New code should not depend on this field anymore.
  # @!attribute [rw] type
  #   @return [::Google::Cloud::ServiceControl::V1::CheckResponse::ConsumerInfo::ConsumerType]
  #     The type of the consumer which should have been defined in
  #     [Google Resource Manager](https://cloud.google.com/resource-manager/).
  # @!attribute [rw] consumer_number
  #   @return [::Integer]
  #     The consumer identity number, can be Google cloud project number, folder
  #     number or organization number e.g. 1234567890. A value of 0 indicates no
  #     consumer number is found.
  class ConsumerInfo
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # The type of the consumer as defined in
    # [Google Resource Manager](https://cloud.google.com/resource-manager/).
    module ConsumerType
      # This is never used.
      CONSUMER_TYPE_UNSPECIFIED = 0

      # The consumer is a Google Cloud Project.
      PROJECT = 1

      # The consumer is a Google Cloud Folder.
      FOLDER = 2

      # The consumer is a Google Cloud Organization.
      ORGANIZATION = 3

      # Service-specific resource container which is defined by the service
      # producer to offer their users the ability to manage service control
      # functionalities at a finer level of granularity than the PROJECT.
      SERVICE_SPECIFIC = 4
    end
  end
end

#service_config_id ⇒ ::String

Returns The actual config id used to process the request.

Returns:

  • (::String) —

    The actual config id used to process the request.



70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
 
# File 'proto_docs/google/api/servicecontrol/v1/service_controller.rb', line 70

class CheckResponse
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Contains additional information about the check operation.
  # @!attribute [rw] unused_arguments
  #   @return [::Array<::String>]
  #     A list of fields and label keys that are ignored by the server.
  #     The client doesn't need to send them for following requests to improve
  #     performance and allow better aggregation.
  # @!attribute [rw] consumer_info
  #   @return [::Google::Cloud::ServiceControl::V1::CheckResponse::ConsumerInfo]
  #     Consumer info of this check.
  # @!attribute [rw] api_key_uid
  #   @return [::String]
  #     The unique id of the api key in the format of "apikey:<UID>".
  #     This field will be populated when the consumer passed to Service Control
  #     is an API key and all the API key related validations are successful.
  class CheckInfo
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # `ConsumerInfo` provides information about the consumer.
  # @!attribute [rw] project_number
  #   @return [::Integer]
  #     The Google cloud project number, e.g. 1234567890. A value of 0 indicates
  #     no project number is found.
  #
  #     NOTE: This field is deprecated after we support flexible consumer
  #     id. New code should not depend on this field anymore.
  # @!attribute [rw] type
  #   @return [::Google::Cloud::ServiceControl::V1::CheckResponse::ConsumerInfo::ConsumerType]
  #     The type of the consumer which should have been defined in
  #     [Google Resource Manager](https://cloud.google.com/resource-manager/).
  # @!attribute [rw] consumer_number
  #   @return [::Integer]
  #     The consumer identity number, can be Google cloud project number, folder
  #     number or organization number e.g. 1234567890. A value of 0 indicates no
  #     consumer number is found.
  class ConsumerInfo
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # The type of the consumer as defined in
    # [Google Resource Manager](https://cloud.google.com/resource-manager/).
    module ConsumerType
      # This is never used.
      CONSUMER_TYPE_UNSPECIFIED = 0

      # The consumer is a Google Cloud Project.
      PROJECT = 1

      # The consumer is a Google Cloud Folder.
      FOLDER = 2

      # The consumer is a Google Cloud Organization.
      ORGANIZATION = 3

      # Service-specific resource container which is defined by the service
      # producer to offer their users the ability to manage service control
      # functionalities at a finer level of granularity than the PROJECT.
      SERVICE_SPECIFIC = 4
    end
  end
end

#service_rollout_id ⇒ ::String

Returns The current service rollout id used to process the request.

Returns:

  • (::String) —

    The current service rollout id used to process the request.



70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
 
# File 'proto_docs/google/api/servicecontrol/v1/service_controller.rb', line 70

class CheckResponse
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Contains additional information about the check operation.
  # @!attribute [rw] unused_arguments
  #   @return [::Array<::String>]
  #     A list of fields and label keys that are ignored by the server.
  #     The client doesn't need to send them for following requests to improve
  #     performance and allow better aggregation.
  # @!attribute [rw] consumer_info
  #   @return [::Google::Cloud::ServiceControl::V1::CheckResponse::ConsumerInfo]
  #     Consumer info of this check.
  # @!attribute [rw] api_key_uid
  #   @return [::String]
  #     The unique id of the api key in the format of "apikey:<UID>".
  #     This field will be populated when the consumer passed to Service Control
  #     is an API key and all the API key related validations are successful.
  class CheckInfo
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # `ConsumerInfo` provides information about the consumer.
  # @!attribute [rw] project_number
  #   @return [::Integer]
  #     The Google cloud project number, e.g. 1234567890. A value of 0 indicates
  #     no project number is found.
  #
  #     NOTE: This field is deprecated after we support flexible consumer
  #     id. New code should not depend on this field anymore.
  # @!attribute [rw] type
  #   @return [::Google::Cloud::ServiceControl::V1::CheckResponse::ConsumerInfo::ConsumerType]
  #     The type of the consumer which should have been defined in
  #     [Google Resource Manager](https://cloud.google.com/resource-manager/).
  # @!attribute [rw] consumer_number
  #   @return [::Integer]
  #     The consumer identity number, can be Google cloud project number, folder
  #     number or organization number e.g. 1234567890. A value of 0 indicates no
  #     consumer number is found.
  class ConsumerInfo
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # The type of the consumer as defined in
    # [Google Resource Manager](https://cloud.google.com/resource-manager/).
    module ConsumerType
      # This is never used.
      CONSUMER_TYPE_UNSPECIFIED = 0

      # The consumer is a Google Cloud Project.
      PROJECT = 1

      # The consumer is a Google Cloud Folder.
      FOLDER = 2

      # The consumer is a Google Cloud Organization.
      ORGANIZATION = 3

      # Service-specific resource container which is defined by the service
      # producer to offer their users the ability to manage service control
      # functionalities at a finer level of granularity than the PROJECT.
      SERVICE_SPECIFIC = 4
    end
  end
end