Class: Google::Cloud::ServiceManagement::V1::Rollout

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

Overview

A rollout resource that defines how service configuration versions are pushed to control plane systems. Typically, you create a new version of the service config, and then create a Rollout to push the service config.

Defined Under Namespace

Modules: RolloutStatus Classes: DeleteServiceStrategy, TrafficPercentStrategy

Instance Attribute Summary collapse

Instance Attribute Details

#create_time ⇒ ::Google::Protobuf::Timestamp

Returns Creation time of the rollout. Readonly.

Returns:



239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
 
# File 'proto_docs/google/api/servicemanagement/v1/resources.rb', line 239

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

  # Strategy that specifies how clients of Google Service Controller want to
  # send traffic to use different config versions. This is generally
  # used by API proxy to split traffic based on your configured percentage for
  # each config version.
  #
  # One example of how to gradually rollout a new service configuration using
  # this
  # strategy:
  # Day 1
  #
  #     Rollout {
  #       id: "example.googleapis.com/rollout_20160206"
  #       traffic_percent_strategy {
  #         percentages: {
  #           "example.googleapis.com/20160201": 70.00
  #           "example.googleapis.com/20160206": 30.00
  #         }
  #       }
  #     }
  #
  # Day 2
  #
  #     Rollout {
  #       id: "example.googleapis.com/rollout_20160207"
  #       traffic_percent_strategy: {
  #         percentages: {
  #           "example.googleapis.com/20160206": 100.00
  #         }
  #       }
  #     }
  # @!attribute [rw] percentages
  #   @return [::Google::Protobuf::Map{::String => ::Float}]
  #     Maps service configuration IDs to their corresponding traffic percentage.
  #     Key is the service configuration ID, Value is the traffic percentage
  #     which must be greater than 0.0 and the sum must equal to 100.0.
  class TrafficPercentStrategy
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # @!attribute [rw] key
    #   @return [::String]
    # @!attribute [rw] value
    #   @return [::Float]
    class PercentagesEntry
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # Strategy used to delete a service. This strategy is a placeholder only
  # used by the system generated rollout to delete a service.
  class DeleteServiceStrategy
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Status of a Rollout.
  module RolloutStatus
    # No status specified.
    ROLLOUT_STATUS_UNSPECIFIED = 0

    # The Rollout is in progress.
    IN_PROGRESS = 1

    # The Rollout has completed successfully.
    SUCCESS = 2

    # The Rollout has been cancelled. This can happen if you have overlapping
    # Rollout pushes, and the previous ones will be cancelled.
    CANCELLED = 3

    # The Rollout has failed and the rollback attempt has failed too.
    FAILED = 4

    # The Rollout has not started yet and is pending for execution.
    PENDING = 5

    # The Rollout has failed and rolled back to the previous successful
    # Rollout.
    FAILED_ROLLED_BACK = 6
  end
end

#created_by ⇒ ::String

Returns The user who created the Rollout. Readonly.

Returns:

  • (::String) —

    The user who created the Rollout. Readonly.



239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
 
# File 'proto_docs/google/api/servicemanagement/v1/resources.rb', line 239

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

  # Strategy that specifies how clients of Google Service Controller want to
  # send traffic to use different config versions. This is generally
  # used by API proxy to split traffic based on your configured percentage for
  # each config version.
  #
  # One example of how to gradually rollout a new service configuration using
  # this
  # strategy:
  # Day 1
  #
  #     Rollout {
  #       id: "example.googleapis.com/rollout_20160206"
  #       traffic_percent_strategy {
  #         percentages: {
  #           "example.googleapis.com/20160201": 70.00
  #           "example.googleapis.com/20160206": 30.00
  #         }
  #       }
  #     }
  #
  # Day 2
  #
  #     Rollout {
  #       id: "example.googleapis.com/rollout_20160207"
  #       traffic_percent_strategy: {
  #         percentages: {
  #           "example.googleapis.com/20160206": 100.00
  #         }
  #       }
  #     }
  # @!attribute [rw] percentages
  #   @return [::Google::Protobuf::Map{::String => ::Float}]
  #     Maps service configuration IDs to their corresponding traffic percentage.
  #     Key is the service configuration ID, Value is the traffic percentage
  #     which must be greater than 0.0 and the sum must equal to 100.0.
  class TrafficPercentStrategy
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # @!attribute [rw] key
    #   @return [::String]
    # @!attribute [rw] value
    #   @return [::Float]
    class PercentagesEntry
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # Strategy used to delete a service. This strategy is a placeholder only
  # used by the system generated rollout to delete a service.
  class DeleteServiceStrategy
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Status of a Rollout.
  module RolloutStatus
    # No status specified.
    ROLLOUT_STATUS_UNSPECIFIED = 0

    # The Rollout is in progress.
    IN_PROGRESS = 1

    # The Rollout has completed successfully.
    SUCCESS = 2

    # The Rollout has been cancelled. This can happen if you have overlapping
    # Rollout pushes, and the previous ones will be cancelled.
    CANCELLED = 3

    # The Rollout has failed and the rollback attempt has failed too.
    FAILED = 4

    # The Rollout has not started yet and is pending for execution.
    PENDING = 5

    # The Rollout has failed and rolled back to the previous successful
    # Rollout.
    FAILED_ROLLED_BACK = 6
  end
end

#delete_service_strategy ⇒ ::Google::Cloud::ServiceManagement::V1::Rollout::DeleteServiceStrategy

Returns The strategy associated with a rollout to delete a ManagedService. Readonly.

Returns:



239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
 
# File 'proto_docs/google/api/servicemanagement/v1/resources.rb', line 239

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

  # Strategy that specifies how clients of Google Service Controller want to
  # send traffic to use different config versions. This is generally
  # used by API proxy to split traffic based on your configured percentage for
  # each config version.
  #
  # One example of how to gradually rollout a new service configuration using
  # this
  # strategy:
  # Day 1
  #
  #     Rollout {
  #       id: "example.googleapis.com/rollout_20160206"
  #       traffic_percent_strategy {
  #         percentages: {
  #           "example.googleapis.com/20160201": 70.00
  #           "example.googleapis.com/20160206": 30.00
  #         }
  #       }
  #     }
  #
  # Day 2
  #
  #     Rollout {
  #       id: "example.googleapis.com/rollout_20160207"
  #       traffic_percent_strategy: {
  #         percentages: {
  #           "example.googleapis.com/20160206": 100.00
  #         }
  #       }
  #     }
  # @!attribute [rw] percentages
  #   @return [::Google::Protobuf::Map{::String => ::Float}]
  #     Maps service configuration IDs to their corresponding traffic percentage.
  #     Key is the service configuration ID, Value is the traffic percentage
  #     which must be greater than 0.0 and the sum must equal to 100.0.
  class TrafficPercentStrategy
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # @!attribute [rw] key
    #   @return [::String]
    # @!attribute [rw] value
    #   @return [::Float]
    class PercentagesEntry
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # Strategy used to delete a service. This strategy is a placeholder only
  # used by the system generated rollout to delete a service.
  class DeleteServiceStrategy
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Status of a Rollout.
  module RolloutStatus
    # No status specified.
    ROLLOUT_STATUS_UNSPECIFIED = 0

    # The Rollout is in progress.
    IN_PROGRESS = 1

    # The Rollout has completed successfully.
    SUCCESS = 2

    # The Rollout has been cancelled. This can happen if you have overlapping
    # Rollout pushes, and the previous ones will be cancelled.
    CANCELLED = 3

    # The Rollout has failed and the rollback attempt has failed too.
    FAILED = 4

    # The Rollout has not started yet and is pending for execution.
    PENDING = 5

    # The Rollout has failed and rolled back to the previous successful
    # Rollout.
    FAILED_ROLLED_BACK = 6
  end
end

#rollout_id ⇒ ::String

Returns Optional. Unique identifier of this Rollout. Must be no longer than 63 characters and only lower case letters, digits, '.', '_' and '-' are allowed.

If not specified by client, the server will generate one. The generated id will have the form of , where "date" is the create date in ISO 8601 format. "revision number" is a monotonically increasing positive number that is reset every day for each service. An example of the generated rollout_id is '2016-02-16r1'.

Returns:

  • (::String) —

    Optional. Unique identifier of this Rollout. Must be no longer than 63 characters and only lower case letters, digits, '.', '_' and '-' are allowed.

    If not specified by client, the server will generate one. The generated id will have the form of , where "date" is the create date in ISO 8601 format. "revision number" is a monotonically increasing positive number that is reset every day for each service. An example of the generated rollout_id is '2016-02-16r1'



239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
 
# File 'proto_docs/google/api/servicemanagement/v1/resources.rb', line 239

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

  # Strategy that specifies how clients of Google Service Controller want to
  # send traffic to use different config versions. This is generally
  # used by API proxy to split traffic based on your configured percentage for
  # each config version.
  #
  # One example of how to gradually rollout a new service configuration using
  # this
  # strategy:
  # Day 1
  #
  #     Rollout {
  #       id: "example.googleapis.com/rollout_20160206"
  #       traffic_percent_strategy {
  #         percentages: {
  #           "example.googleapis.com/20160201": 70.00
  #           "example.googleapis.com/20160206": 30.00
  #         }
  #       }
  #     }
  #
  # Day 2
  #
  #     Rollout {
  #       id: "example.googleapis.com/rollout_20160207"
  #       traffic_percent_strategy: {
  #         percentages: {
  #           "example.googleapis.com/20160206": 100.00
  #         }
  #       }
  #     }
  # @!attribute [rw] percentages
  #   @return [::Google::Protobuf::Map{::String => ::Float}]
  #     Maps service configuration IDs to their corresponding traffic percentage.
  #     Key is the service configuration ID, Value is the traffic percentage
  #     which must be greater than 0.0 and the sum must equal to 100.0.
  class TrafficPercentStrategy
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # @!attribute [rw] key
    #   @return [::String]
    # @!attribute [rw] value
    #   @return [::Float]
    class PercentagesEntry
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # Strategy used to delete a service. This strategy is a placeholder only
  # used by the system generated rollout to delete a service.
  class DeleteServiceStrategy
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Status of a Rollout.
  module RolloutStatus
    # No status specified.
    ROLLOUT_STATUS_UNSPECIFIED = 0

    # The Rollout is in progress.
    IN_PROGRESS = 1

    # The Rollout has completed successfully.
    SUCCESS = 2

    # The Rollout has been cancelled. This can happen if you have overlapping
    # Rollout pushes, and the previous ones will be cancelled.
    CANCELLED = 3

    # The Rollout has failed and the rollback attempt has failed too.
    FAILED = 4

    # The Rollout has not started yet and is pending for execution.
    PENDING = 5

    # The Rollout has failed and rolled back to the previous successful
    # Rollout.
    FAILED_ROLLED_BACK = 6
  end
end

#service_name ⇒ ::String

Returns The name of the service associated with this Rollout.

Returns:

  • (::String) —

    The name of the service associated with this Rollout.



239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
 
# File 'proto_docs/google/api/servicemanagement/v1/resources.rb', line 239

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

  # Strategy that specifies how clients of Google Service Controller want to
  # send traffic to use different config versions. This is generally
  # used by API proxy to split traffic based on your configured percentage for
  # each config version.
  #
  # One example of how to gradually rollout a new service configuration using
  # this
  # strategy:
  # Day 1
  #
  #     Rollout {
  #       id: "example.googleapis.com/rollout_20160206"
  #       traffic_percent_strategy {
  #         percentages: {
  #           "example.googleapis.com/20160201": 70.00
  #           "example.googleapis.com/20160206": 30.00
  #         }
  #       }
  #     }
  #
  # Day 2
  #
  #     Rollout {
  #       id: "example.googleapis.com/rollout_20160207"
  #       traffic_percent_strategy: {
  #         percentages: {
  #           "example.googleapis.com/20160206": 100.00
  #         }
  #       }
  #     }
  # @!attribute [rw] percentages
  #   @return [::Google::Protobuf::Map{::String => ::Float}]
  #     Maps service configuration IDs to their corresponding traffic percentage.
  #     Key is the service configuration ID, Value is the traffic percentage
  #     which must be greater than 0.0 and the sum must equal to 100.0.
  class TrafficPercentStrategy
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # @!attribute [rw] key
    #   @return [::String]
    # @!attribute [rw] value
    #   @return [::Float]
    class PercentagesEntry
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # Strategy used to delete a service. This strategy is a placeholder only
  # used by the system generated rollout to delete a service.
  class DeleteServiceStrategy
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Status of a Rollout.
  module RolloutStatus
    # No status specified.
    ROLLOUT_STATUS_UNSPECIFIED = 0

    # The Rollout is in progress.
    IN_PROGRESS = 1

    # The Rollout has completed successfully.
    SUCCESS = 2

    # The Rollout has been cancelled. This can happen if you have overlapping
    # Rollout pushes, and the previous ones will be cancelled.
    CANCELLED = 3

    # The Rollout has failed and the rollback attempt has failed too.
    FAILED = 4

    # The Rollout has not started yet and is pending for execution.
    PENDING = 5

    # The Rollout has failed and rolled back to the previous successful
    # Rollout.
    FAILED_ROLLED_BACK = 6
  end
end

#status ⇒ ::Google::Cloud::ServiceManagement::V1::Rollout::RolloutStatus

Returns The status of this rollout. Readonly. In case of a failed rollout, the system will automatically rollback to the current Rollout version. Readonly.

Returns:



239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
 
# File 'proto_docs/google/api/servicemanagement/v1/resources.rb', line 239

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

  # Strategy that specifies how clients of Google Service Controller want to
  # send traffic to use different config versions. This is generally
  # used by API proxy to split traffic based on your configured percentage for
  # each config version.
  #
  # One example of how to gradually rollout a new service configuration using
  # this
  # strategy:
  # Day 1
  #
  #     Rollout {
  #       id: "example.googleapis.com/rollout_20160206"
  #       traffic_percent_strategy {
  #         percentages: {
  #           "example.googleapis.com/20160201": 70.00
  #           "example.googleapis.com/20160206": 30.00
  #         }
  #       }
  #     }
  #
  # Day 2
  #
  #     Rollout {
  #       id: "example.googleapis.com/rollout_20160207"
  #       traffic_percent_strategy: {
  #         percentages: {
  #           "example.googleapis.com/20160206": 100.00
  #         }
  #       }
  #     }
  # @!attribute [rw] percentages
  #   @return [::Google::Protobuf::Map{::String => ::Float}]
  #     Maps service configuration IDs to their corresponding traffic percentage.
  #     Key is the service configuration ID, Value is the traffic percentage
  #     which must be greater than 0.0 and the sum must equal to 100.0.
  class TrafficPercentStrategy
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # @!attribute [rw] key
    #   @return [::String]
    # @!attribute [rw] value
    #   @return [::Float]
    class PercentagesEntry
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # Strategy used to delete a service. This strategy is a placeholder only
  # used by the system generated rollout to delete a service.
  class DeleteServiceStrategy
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Status of a Rollout.
  module RolloutStatus
    # No status specified.
    ROLLOUT_STATUS_UNSPECIFIED = 0

    # The Rollout is in progress.
    IN_PROGRESS = 1

    # The Rollout has completed successfully.
    SUCCESS = 2

    # The Rollout has been cancelled. This can happen if you have overlapping
    # Rollout pushes, and the previous ones will be cancelled.
    CANCELLED = 3

    # The Rollout has failed and the rollback attempt has failed too.
    FAILED = 4

    # The Rollout has not started yet and is pending for execution.
    PENDING = 5

    # The Rollout has failed and rolled back to the previous successful
    # Rollout.
    FAILED_ROLLED_BACK = 6
  end
end

#traffic_percent_strategy ⇒ ::Google::Cloud::ServiceManagement::V1::Rollout::TrafficPercentStrategy

Returns Google Service Control selects service configurations based on traffic percentage.

Returns:



239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
 
# File 'proto_docs/google/api/servicemanagement/v1/resources.rb', line 239

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

  # Strategy that specifies how clients of Google Service Controller want to
  # send traffic to use different config versions. This is generally
  # used by API proxy to split traffic based on your configured percentage for
  # each config version.
  #
  # One example of how to gradually rollout a new service configuration using
  # this
  # strategy:
  # Day 1
  #
  #     Rollout {
  #       id: "example.googleapis.com/rollout_20160206"
  #       traffic_percent_strategy {
  #         percentages: {
  #           "example.googleapis.com/20160201": 70.00
  #           "example.googleapis.com/20160206": 30.00
  #         }
  #       }
  #     }
  #
  # Day 2
  #
  #     Rollout {
  #       id: "example.googleapis.com/rollout_20160207"
  #       traffic_percent_strategy: {
  #         percentages: {
  #           "example.googleapis.com/20160206": 100.00
  #         }
  #       }
  #     }
  # @!attribute [rw] percentages
  #   @return [::Google::Protobuf::Map{::String => ::Float}]
  #     Maps service configuration IDs to their corresponding traffic percentage.
  #     Key is the service configuration ID, Value is the traffic percentage
  #     which must be greater than 0.0 and the sum must equal to 100.0.
  class TrafficPercentStrategy
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # @!attribute [rw] key
    #   @return [::String]
    # @!attribute [rw] value
    #   @return [::Float]
    class PercentagesEntry
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # Strategy used to delete a service. This strategy is a placeholder only
  # used by the system generated rollout to delete a service.
  class DeleteServiceStrategy
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Status of a Rollout.
  module RolloutStatus
    # No status specified.
    ROLLOUT_STATUS_UNSPECIFIED = 0

    # The Rollout is in progress.
    IN_PROGRESS = 1

    # The Rollout has completed successfully.
    SUCCESS = 2

    # The Rollout has been cancelled. This can happen if you have overlapping
    # Rollout pushes, and the previous ones will be cancelled.
    CANCELLED = 3

    # The Rollout has failed and the rollback attempt has failed too.
    FAILED = 4

    # The Rollout has not started yet and is pending for execution.
    PENDING = 5

    # The Rollout has failed and rolled back to the previous successful
    # Rollout.
    FAILED_ROLLED_BACK = 6
  end
end