Class: Google::Cloud::ConfigService::V1::Preview

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

Overview

A preview represents a set of actions Infra Manager would perform to move the resources towards the desired state as specified in the configuration.

Defined Under Namespace

Modules: ErrorCode, PreviewMode, State Classes: AnnotationsEntry, LabelsEntry

Instance Attribute Summary collapse

Instance Attribute Details

#annotations ⇒ ::Google::Protobuf::Map{::String => ::String}

Returns Optional. Arbitrary key-value metadata storage e.g. to help client tools identifiy preview during automation. See https://google.aip.dev/148#annotations for details on format and size limitations.

Returns:

  • (::Google::Protobuf::Map{::String => ::String}) —

    Optional. Arbitrary key-value metadata storage e.g. to help client tools identifiy preview during automation. See https://google.aip.dev/148#annotations for details on format and size limitations.



1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
 
# File 'proto_docs/google/cloud/config/v1/config.rb', line 1231

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

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

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

  # Possible states of a preview.
  module State
    # The default value. This value is used if the state is unknown.
    STATE_UNSPECIFIED = 0

    # The preview is being created.
    CREATING = 1

    # The preview has succeeded.
    SUCCEEDED = 2

    # The preview is being applied.
    APPLYING = 3

    # The preview is stale. A preview can become stale if a revision has been
    # applied after this preview was created.
    STALE = 4

    # The preview is being deleted.
    DELETING = 5

    # The preview has encountered an unexpected error.
    FAILED = 6

    # The preview has been deleted.
    DELETED = 7
  end

  # Preview mode provides options for customizing preview operations.
  module PreviewMode
    # Unspecified policy, default mode will be used.
    PREVIEW_MODE_UNSPECIFIED = 0

    # DEFAULT mode generates an execution plan for reconciling current resource
    # state into expected resource state.
    DEFAULT = 1

    # DELETE mode generates as execution plan for destroying current resources.
    DELETE = 2
  end

  # Possible errors that can occur with previews.
  module ErrorCode
    # No error code was specified.
    ERROR_CODE_UNSPECIFIED = 0

    # Cloud Build failed due to a permissions issue.
    CLOUD_BUILD_PERMISSION_DENIED = 1

    # Cloud Storage bucket failed to create due to a permissions issue.
    BUCKET_CREATION_PERMISSION_DENIED = 2

    # Cloud Storage bucket failed for a non-permissions-related issue.
    BUCKET_CREATION_FAILED = 3

    # Acquiring lock on provided deployment reference failed.
    DEPLOYMENT_LOCK_ACQUIRE_FAILED = 4

    # Preview encountered an error when trying to access Cloud Build API.
    PREVIEW_BUILD_API_FAILED = 5

    # Preview created a build but build failed and logs were generated.
    PREVIEW_BUILD_RUN_FAILED = 6
  end
end

#artifacts_gcs_bucket ⇒ ::String

Returns Optional. User-defined location of Cloud Build logs, artifacts, and in Google Cloud Storage. Format: gs://{bucket}/{folder} A default bucket will be bootstrapped if the field is not set or empty Default Bucket Format: gs://<project number>-<region>-blueprint-config Constraints:

  • The bucket needs to be in the same project as the deployment
  • The path cannot be within the path of gcs_source If omitted and deployment resource ref provided has artifacts_gcs_bucket defined, that artifact bucket is used.

Returns:

  • (::String) —

    Optional. User-defined location of Cloud Build logs, artifacts, and in Google Cloud Storage. Format: gs://{bucket}/{folder} A default bucket will be bootstrapped if the field is not set or empty Default Bucket Format: gs://<project number>-<region>-blueprint-config Constraints:

    • The bucket needs to be in the same project as the deployment
    • The path cannot be within the path of gcs_source If omitted and deployment resource ref provided has artifacts_gcs_bucket defined, that artifact bucket is used.


1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
 
# File 'proto_docs/google/cloud/config/v1/config.rb', line 1231

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

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

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

  # Possible states of a preview.
  module State
    # The default value. This value is used if the state is unknown.
    STATE_UNSPECIFIED = 0

    # The preview is being created.
    CREATING = 1

    # The preview has succeeded.
    SUCCEEDED = 2

    # The preview is being applied.
    APPLYING = 3

    # The preview is stale. A preview can become stale if a revision has been
    # applied after this preview was created.
    STALE = 4

    # The preview is being deleted.
    DELETING = 5

    # The preview has encountered an unexpected error.
    FAILED = 6

    # The preview has been deleted.
    DELETED = 7
  end

  # Preview mode provides options for customizing preview operations.
  module PreviewMode
    # Unspecified policy, default mode will be used.
    PREVIEW_MODE_UNSPECIFIED = 0

    # DEFAULT mode generates an execution plan for reconciling current resource
    # state into expected resource state.
    DEFAULT = 1

    # DELETE mode generates as execution plan for destroying current resources.
    DELETE = 2
  end

  # Possible errors that can occur with previews.
  module ErrorCode
    # No error code was specified.
    ERROR_CODE_UNSPECIFIED = 0

    # Cloud Build failed due to a permissions issue.
    CLOUD_BUILD_PERMISSION_DENIED = 1

    # Cloud Storage bucket failed to create due to a permissions issue.
    BUCKET_CREATION_PERMISSION_DENIED = 2

    # Cloud Storage bucket failed for a non-permissions-related issue.
    BUCKET_CREATION_FAILED = 3

    # Acquiring lock on provided deployment reference failed.
    DEPLOYMENT_LOCK_ACQUIRE_FAILED = 4

    # Preview encountered an error when trying to access Cloud Build API.
    PREVIEW_BUILD_API_FAILED = 5

    # Preview created a build but build failed and logs were generated.
    PREVIEW_BUILD_RUN_FAILED = 6
  end
end

#build ⇒ ::String (readonly)

Returns Output only. Cloud Build instance UUID associated with this preview.

Returns:

  • (::String) —

    Output only. Cloud Build instance UUID associated with this preview.



1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
 
# File 'proto_docs/google/cloud/config/v1/config.rb', line 1231

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

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

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

  # Possible states of a preview.
  module State
    # The default value. This value is used if the state is unknown.
    STATE_UNSPECIFIED = 0

    # The preview is being created.
    CREATING = 1

    # The preview has succeeded.
    SUCCEEDED = 2

    # The preview is being applied.
    APPLYING = 3

    # The preview is stale. A preview can become stale if a revision has been
    # applied after this preview was created.
    STALE = 4

    # The preview is being deleted.
    DELETING = 5

    # The preview has encountered an unexpected error.
    FAILED = 6

    # The preview has been deleted.
    DELETED = 7
  end

  # Preview mode provides options for customizing preview operations.
  module PreviewMode
    # Unspecified policy, default mode will be used.
    PREVIEW_MODE_UNSPECIFIED = 0

    # DEFAULT mode generates an execution plan for reconciling current resource
    # state into expected resource state.
    DEFAULT = 1

    # DELETE mode generates as execution plan for destroying current resources.
    DELETE = 2
  end

  # Possible errors that can occur with previews.
  module ErrorCode
    # No error code was specified.
    ERROR_CODE_UNSPECIFIED = 0

    # Cloud Build failed due to a permissions issue.
    CLOUD_BUILD_PERMISSION_DENIED = 1

    # Cloud Storage bucket failed to create due to a permissions issue.
    BUCKET_CREATION_PERMISSION_DENIED = 2

    # Cloud Storage bucket failed for a non-permissions-related issue.
    BUCKET_CREATION_FAILED = 3

    # Acquiring lock on provided deployment reference failed.
    DEPLOYMENT_LOCK_ACQUIRE_FAILED = 4

    # Preview encountered an error when trying to access Cloud Build API.
    PREVIEW_BUILD_API_FAILED = 5

    # Preview created a build but build failed and logs were generated.
    PREVIEW_BUILD_RUN_FAILED = 6
  end
end

#create_time ⇒ ::Google::Protobuf::Timestamp (readonly)

Returns Output only. Time the preview was created.

Returns:



1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
 
# File 'proto_docs/google/cloud/config/v1/config.rb', line 1231

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

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

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

  # Possible states of a preview.
  module State
    # The default value. This value is used if the state is unknown.
    STATE_UNSPECIFIED = 0

    # The preview is being created.
    CREATING = 1

    # The preview has succeeded.
    SUCCEEDED = 2

    # The preview is being applied.
    APPLYING = 3

    # The preview is stale. A preview can become stale if a revision has been
    # applied after this preview was created.
    STALE = 4

    # The preview is being deleted.
    DELETING = 5

    # The preview has encountered an unexpected error.
    FAILED = 6

    # The preview has been deleted.
    DELETED = 7
  end

  # Preview mode provides options for customizing preview operations.
  module PreviewMode
    # Unspecified policy, default mode will be used.
    PREVIEW_MODE_UNSPECIFIED = 0

    # DEFAULT mode generates an execution plan for reconciling current resource
    # state into expected resource state.
    DEFAULT = 1

    # DELETE mode generates as execution plan for destroying current resources.
    DELETE = 2
  end

  # Possible errors that can occur with previews.
  module ErrorCode
    # No error code was specified.
    ERROR_CODE_UNSPECIFIED = 0

    # Cloud Build failed due to a permissions issue.
    CLOUD_BUILD_PERMISSION_DENIED = 1

    # Cloud Storage bucket failed to create due to a permissions issue.
    BUCKET_CREATION_PERMISSION_DENIED = 2

    # Cloud Storage bucket failed for a non-permissions-related issue.
    BUCKET_CREATION_FAILED = 3

    # Acquiring lock on provided deployment reference failed.
    DEPLOYMENT_LOCK_ACQUIRE_FAILED = 4

    # Preview encountered an error when trying to access Cloud Build API.
    PREVIEW_BUILD_API_FAILED = 5

    # Preview created a build but build failed and logs were generated.
    PREVIEW_BUILD_RUN_FAILED = 6
  end
end

#deployment ⇒ ::String

Returns Optional. Optional deployment reference. If specified, the preview will be performed using the provided deployment's current state and use any relevant fields from the deployment unless explicitly specified in the preview create request.

Returns:

  • (::String) —

    Optional. Optional deployment reference. If specified, the preview will be performed using the provided deployment's current state and use any relevant fields from the deployment unless explicitly specified in the preview create request.



1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
 
# File 'proto_docs/google/cloud/config/v1/config.rb', line 1231

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

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

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

  # Possible states of a preview.
  module State
    # The default value. This value is used if the state is unknown.
    STATE_UNSPECIFIED = 0

    # The preview is being created.
    CREATING = 1

    # The preview has succeeded.
    SUCCEEDED = 2

    # The preview is being applied.
    APPLYING = 3

    # The preview is stale. A preview can become stale if a revision has been
    # applied after this preview was created.
    STALE = 4

    # The preview is being deleted.
    DELETING = 5

    # The preview has encountered an unexpected error.
    FAILED = 6

    # The preview has been deleted.
    DELETED = 7
  end

  # Preview mode provides options for customizing preview operations.
  module PreviewMode
    # Unspecified policy, default mode will be used.
    PREVIEW_MODE_UNSPECIFIED = 0

    # DEFAULT mode generates an execution plan for reconciling current resource
    # state into expected resource state.
    DEFAULT = 1

    # DELETE mode generates as execution plan for destroying current resources.
    DELETE = 2
  end

  # Possible errors that can occur with previews.
  module ErrorCode
    # No error code was specified.
    ERROR_CODE_UNSPECIFIED = 0

    # Cloud Build failed due to a permissions issue.
    CLOUD_BUILD_PERMISSION_DENIED = 1

    # Cloud Storage bucket failed to create due to a permissions issue.
    BUCKET_CREATION_PERMISSION_DENIED = 2

    # Cloud Storage bucket failed for a non-permissions-related issue.
    BUCKET_CREATION_FAILED = 3

    # Acquiring lock on provided deployment reference failed.
    DEPLOYMENT_LOCK_ACQUIRE_FAILED = 4

    # Preview encountered an error when trying to access Cloud Build API.
    PREVIEW_BUILD_API_FAILED = 5

    # Preview created a build but build failed and logs were generated.
    PREVIEW_BUILD_RUN_FAILED = 6
  end
end

#error_code ⇒ ::Google::Cloud::ConfigService::V1::Preview::ErrorCode (readonly)

Returns Output only. Code describing any errors that may have occurred.

Returns:



1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
 
# File 'proto_docs/google/cloud/config/v1/config.rb', line 1231

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

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

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

  # Possible states of a preview.
  module State
    # The default value. This value is used if the state is unknown.
    STATE_UNSPECIFIED = 0

    # The preview is being created.
    CREATING = 1

    # The preview has succeeded.
    SUCCEEDED = 2

    # The preview is being applied.
    APPLYING = 3

    # The preview is stale. A preview can become stale if a revision has been
    # applied after this preview was created.
    STALE = 4

    # The preview is being deleted.
    DELETING = 5

    # The preview has encountered an unexpected error.
    FAILED = 6

    # The preview has been deleted.
    DELETED = 7
  end

  # Preview mode provides options for customizing preview operations.
  module PreviewMode
    # Unspecified policy, default mode will be used.
    PREVIEW_MODE_UNSPECIFIED = 0

    # DEFAULT mode generates an execution plan for reconciling current resource
    # state into expected resource state.
    DEFAULT = 1

    # DELETE mode generates as execution plan for destroying current resources.
    DELETE = 2
  end

  # Possible errors that can occur with previews.
  module ErrorCode
    # No error code was specified.
    ERROR_CODE_UNSPECIFIED = 0

    # Cloud Build failed due to a permissions issue.
    CLOUD_BUILD_PERMISSION_DENIED = 1

    # Cloud Storage bucket failed to create due to a permissions issue.
    BUCKET_CREATION_PERMISSION_DENIED = 2

    # Cloud Storage bucket failed for a non-permissions-related issue.
    BUCKET_CREATION_FAILED = 3

    # Acquiring lock on provided deployment reference failed.
    DEPLOYMENT_LOCK_ACQUIRE_FAILED = 4

    # Preview encountered an error when trying to access Cloud Build API.
    PREVIEW_BUILD_API_FAILED = 5

    # Preview created a build but build failed and logs were generated.
    PREVIEW_BUILD_RUN_FAILED = 6
  end
end

#error_logs ⇒ ::String (readonly)

Returns Output only. Link to tf-error.ndjson file, which contains the full list of the errors encountered during a Terraform preview. Format: gs://{bucket}/{object}.

Returns:

  • (::String) —

    Output only. Link to tf-error.ndjson file, which contains the full list of the errors encountered during a Terraform preview. Format: gs://{bucket}/{object}.



1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
 
# File 'proto_docs/google/cloud/config/v1/config.rb', line 1231

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

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

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

  # Possible states of a preview.
  module State
    # The default value. This value is used if the state is unknown.
    STATE_UNSPECIFIED = 0

    # The preview is being created.
    CREATING = 1

    # The preview has succeeded.
    SUCCEEDED = 2

    # The preview is being applied.
    APPLYING = 3

    # The preview is stale. A preview can become stale if a revision has been
    # applied after this preview was created.
    STALE = 4

    # The preview is being deleted.
    DELETING = 5

    # The preview has encountered an unexpected error.
    FAILED = 6

    # The preview has been deleted.
    DELETED = 7
  end

  # Preview mode provides options for customizing preview operations.
  module PreviewMode
    # Unspecified policy, default mode will be used.
    PREVIEW_MODE_UNSPECIFIED = 0

    # DEFAULT mode generates an execution plan for reconciling current resource
    # state into expected resource state.
    DEFAULT = 1

    # DELETE mode generates as execution plan for destroying current resources.
    DELETE = 2
  end

  # Possible errors that can occur with previews.
  module ErrorCode
    # No error code was specified.
    ERROR_CODE_UNSPECIFIED = 0

    # Cloud Build failed due to a permissions issue.
    CLOUD_BUILD_PERMISSION_DENIED = 1

    # Cloud Storage bucket failed to create due to a permissions issue.
    BUCKET_CREATION_PERMISSION_DENIED = 2

    # Cloud Storage bucket failed for a non-permissions-related issue.
    BUCKET_CREATION_FAILED = 3

    # Acquiring lock on provided deployment reference failed.
    DEPLOYMENT_LOCK_ACQUIRE_FAILED = 4

    # Preview encountered an error when trying to access Cloud Build API.
    PREVIEW_BUILD_API_FAILED = 5

    # Preview created a build but build failed and logs were generated.
    PREVIEW_BUILD_RUN_FAILED = 6
  end
end

#error_status ⇒ ::Google::Rpc::Status (readonly)

Returns Output only. Additional information regarding the current state.

Returns:



1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
 
# File 'proto_docs/google/cloud/config/v1/config.rb', line 1231

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

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

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

  # Possible states of a preview.
  module State
    # The default value. This value is used if the state is unknown.
    STATE_UNSPECIFIED = 0

    # The preview is being created.
    CREATING = 1

    # The preview has succeeded.
    SUCCEEDED = 2

    # The preview is being applied.
    APPLYING = 3

    # The preview is stale. A preview can become stale if a revision has been
    # applied after this preview was created.
    STALE = 4

    # The preview is being deleted.
    DELETING = 5

    # The preview has encountered an unexpected error.
    FAILED = 6

    # The preview has been deleted.
    DELETED = 7
  end

  # Preview mode provides options for customizing preview operations.
  module PreviewMode
    # Unspecified policy, default mode will be used.
    PREVIEW_MODE_UNSPECIFIED = 0

    # DEFAULT mode generates an execution plan for reconciling current resource
    # state into expected resource state.
    DEFAULT = 1

    # DELETE mode generates as execution plan for destroying current resources.
    DELETE = 2
  end

  # Possible errors that can occur with previews.
  module ErrorCode
    # No error code was specified.
    ERROR_CODE_UNSPECIFIED = 0

    # Cloud Build failed due to a permissions issue.
    CLOUD_BUILD_PERMISSION_DENIED = 1

    # Cloud Storage bucket failed to create due to a permissions issue.
    BUCKET_CREATION_PERMISSION_DENIED = 2

    # Cloud Storage bucket failed for a non-permissions-related issue.
    BUCKET_CREATION_FAILED = 3

    # Acquiring lock on provided deployment reference failed.
    DEPLOYMENT_LOCK_ACQUIRE_FAILED = 4

    # Preview encountered an error when trying to access Cloud Build API.
    PREVIEW_BUILD_API_FAILED = 5

    # Preview created a build but build failed and logs were generated.
    PREVIEW_BUILD_RUN_FAILED = 6
  end
end

#labels ⇒ ::Google::Protobuf::Map{::String => ::String}

Returns Optional. User-defined labels for the preview.

Returns:

  • (::Google::Protobuf::Map{::String => ::String}) —

    Optional. User-defined labels for the preview.



1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
 
# File 'proto_docs/google/cloud/config/v1/config.rb', line 1231

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

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

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

  # Possible states of a preview.
  module State
    # The default value. This value is used if the state is unknown.
    STATE_UNSPECIFIED = 0

    # The preview is being created.
    CREATING = 1

    # The preview has succeeded.
    SUCCEEDED = 2

    # The preview is being applied.
    APPLYING = 3

    # The preview is stale. A preview can become stale if a revision has been
    # applied after this preview was created.
    STALE = 4

    # The preview is being deleted.
    DELETING = 5

    # The preview has encountered an unexpected error.
    FAILED = 6

    # The preview has been deleted.
    DELETED = 7
  end

  # Preview mode provides options for customizing preview operations.
  module PreviewMode
    # Unspecified policy, default mode will be used.
    PREVIEW_MODE_UNSPECIFIED = 0

    # DEFAULT mode generates an execution plan for reconciling current resource
    # state into expected resource state.
    DEFAULT = 1

    # DELETE mode generates as execution plan for destroying current resources.
    DELETE = 2
  end

  # Possible errors that can occur with previews.
  module ErrorCode
    # No error code was specified.
    ERROR_CODE_UNSPECIFIED = 0

    # Cloud Build failed due to a permissions issue.
    CLOUD_BUILD_PERMISSION_DENIED = 1

    # Cloud Storage bucket failed to create due to a permissions issue.
    BUCKET_CREATION_PERMISSION_DENIED = 2

    # Cloud Storage bucket failed for a non-permissions-related issue.
    BUCKET_CREATION_FAILED = 3

    # Acquiring lock on provided deployment reference failed.
    DEPLOYMENT_LOCK_ACQUIRE_FAILED = 4

    # Preview encountered an error when trying to access Cloud Build API.
    PREVIEW_BUILD_API_FAILED = 5

    # Preview created a build but build failed and logs were generated.
    PREVIEW_BUILD_RUN_FAILED = 6
  end
end

#logs ⇒ ::String (readonly)

Returns Output only. Location of preview logs in gs://{bucket}/{object} format.

Returns:

  • (::String) —

    Output only. Location of preview logs in gs://{bucket}/{object} format.



1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
 
# File 'proto_docs/google/cloud/config/v1/config.rb', line 1231

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

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

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

  # Possible states of a preview.
  module State
    # The default value. This value is used if the state is unknown.
    STATE_UNSPECIFIED = 0

    # The preview is being created.
    CREATING = 1

    # The preview has succeeded.
    SUCCEEDED = 2

    # The preview is being applied.
    APPLYING = 3

    # The preview is stale. A preview can become stale if a revision has been
    # applied after this preview was created.
    STALE = 4

    # The preview is being deleted.
    DELETING = 5

    # The preview has encountered an unexpected error.
    FAILED = 6

    # The preview has been deleted.
    DELETED = 7
  end

  # Preview mode provides options for customizing preview operations.
  module PreviewMode
    # Unspecified policy, default mode will be used.
    PREVIEW_MODE_UNSPECIFIED = 0

    # DEFAULT mode generates an execution plan for reconciling current resource
    # state into expected resource state.
    DEFAULT = 1

    # DELETE mode generates as execution plan for destroying current resources.
    DELETE = 2
  end

  # Possible errors that can occur with previews.
  module ErrorCode
    # No error code was specified.
    ERROR_CODE_UNSPECIFIED = 0

    # Cloud Build failed due to a permissions issue.
    CLOUD_BUILD_PERMISSION_DENIED = 1

    # Cloud Storage bucket failed to create due to a permissions issue.
    BUCKET_CREATION_PERMISSION_DENIED = 2

    # Cloud Storage bucket failed for a non-permissions-related issue.
    BUCKET_CREATION_FAILED = 3

    # Acquiring lock on provided deployment reference failed.
    DEPLOYMENT_LOCK_ACQUIRE_FAILED = 4

    # Preview encountered an error when trying to access Cloud Build API.
    PREVIEW_BUILD_API_FAILED = 5

    # Preview created a build but build failed and logs were generated.
    PREVIEW_BUILD_RUN_FAILED = 6
  end
end

#name ⇒ ::String

Returns Identifier. Resource name of the preview. Resource name can be user provided or server generated ID if unspecified. Format: projects/{project}/locations/{location}/previews/{preview}.

Returns:

  • (::String) —

    Identifier. Resource name of the preview. Resource name can be user provided or server generated ID if unspecified. Format: projects/{project}/locations/{location}/previews/{preview}



1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
 
# File 'proto_docs/google/cloud/config/v1/config.rb', line 1231

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

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

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

  # Possible states of a preview.
  module State
    # The default value. This value is used if the state is unknown.
    STATE_UNSPECIFIED = 0

    # The preview is being created.
    CREATING = 1

    # The preview has succeeded.
    SUCCEEDED = 2

    # The preview is being applied.
    APPLYING = 3

    # The preview is stale. A preview can become stale if a revision has been
    # applied after this preview was created.
    STALE = 4

    # The preview is being deleted.
    DELETING = 5

    # The preview has encountered an unexpected error.
    FAILED = 6

    # The preview has been deleted.
    DELETED = 7
  end

  # Preview mode provides options for customizing preview operations.
  module PreviewMode
    # Unspecified policy, default mode will be used.
    PREVIEW_MODE_UNSPECIFIED = 0

    # DEFAULT mode generates an execution plan for reconciling current resource
    # state into expected resource state.
    DEFAULT = 1

    # DELETE mode generates as execution plan for destroying current resources.
    DELETE = 2
  end

  # Possible errors that can occur with previews.
  module ErrorCode
    # No error code was specified.
    ERROR_CODE_UNSPECIFIED = 0

    # Cloud Build failed due to a permissions issue.
    CLOUD_BUILD_PERMISSION_DENIED = 1

    # Cloud Storage bucket failed to create due to a permissions issue.
    BUCKET_CREATION_PERMISSION_DENIED = 2

    # Cloud Storage bucket failed for a non-permissions-related issue.
    BUCKET_CREATION_FAILED = 3

    # Acquiring lock on provided deployment reference failed.
    DEPLOYMENT_LOCK_ACQUIRE_FAILED = 4

    # Preview encountered an error when trying to access Cloud Build API.
    PREVIEW_BUILD_API_FAILED = 5

    # Preview created a build but build failed and logs were generated.
    PREVIEW_BUILD_RUN_FAILED = 6
  end
end

#preview_artifacts ⇒ ::Google::Cloud::ConfigService::V1::PreviewArtifacts (readonly)

Returns Output only. Artifacts from preview.

Returns:



1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
 
# File 'proto_docs/google/cloud/config/v1/config.rb', line 1231

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

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

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

  # Possible states of a preview.
  module State
    # The default value. This value is used if the state is unknown.
    STATE_UNSPECIFIED = 0

    # The preview is being created.
    CREATING = 1

    # The preview has succeeded.
    SUCCEEDED = 2

    # The preview is being applied.
    APPLYING = 3

    # The preview is stale. A preview can become stale if a revision has been
    # applied after this preview was created.
    STALE = 4

    # The preview is being deleted.
    DELETING = 5

    # The preview has encountered an unexpected error.
    FAILED = 6

    # The preview has been deleted.
    DELETED = 7
  end

  # Preview mode provides options for customizing preview operations.
  module PreviewMode
    # Unspecified policy, default mode will be used.
    PREVIEW_MODE_UNSPECIFIED = 0

    # DEFAULT mode generates an execution plan for reconciling current resource
    # state into expected resource state.
    DEFAULT = 1

    # DELETE mode generates as execution plan for destroying current resources.
    DELETE = 2
  end

  # Possible errors that can occur with previews.
  module ErrorCode
    # No error code was specified.
    ERROR_CODE_UNSPECIFIED = 0

    # Cloud Build failed due to a permissions issue.
    CLOUD_BUILD_PERMISSION_DENIED = 1

    # Cloud Storage bucket failed to create due to a permissions issue.
    BUCKET_CREATION_PERMISSION_DENIED = 2

    # Cloud Storage bucket failed for a non-permissions-related issue.
    BUCKET_CREATION_FAILED = 3

    # Acquiring lock on provided deployment reference failed.
    DEPLOYMENT_LOCK_ACQUIRE_FAILED = 4

    # Preview encountered an error when trying to access Cloud Build API.
    PREVIEW_BUILD_API_FAILED = 5

    # Preview created a build but build failed and logs were generated.
    PREVIEW_BUILD_RUN_FAILED = 6
  end
end

#preview_mode ⇒ ::Google::Cloud::ConfigService::V1::Preview::PreviewMode

Returns Optional. Current mode of preview.

Returns:



1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
 
# File 'proto_docs/google/cloud/config/v1/config.rb', line 1231

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

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

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

  # Possible states of a preview.
  module State
    # The default value. This value is used if the state is unknown.
    STATE_UNSPECIFIED = 0

    # The preview is being created.
    CREATING = 1

    # The preview has succeeded.
    SUCCEEDED = 2

    # The preview is being applied.
    APPLYING = 3

    # The preview is stale. A preview can become stale if a revision has been
    # applied after this preview was created.
    STALE = 4

    # The preview is being deleted.
    DELETING = 5

    # The preview has encountered an unexpected error.
    FAILED = 6

    # The preview has been deleted.
    DELETED = 7
  end

  # Preview mode provides options for customizing preview operations.
  module PreviewMode
    # Unspecified policy, default mode will be used.
    PREVIEW_MODE_UNSPECIFIED = 0

    # DEFAULT mode generates an execution plan for reconciling current resource
    # state into expected resource state.
    DEFAULT = 1

    # DELETE mode generates as execution plan for destroying current resources.
    DELETE = 2
  end

  # Possible errors that can occur with previews.
  module ErrorCode
    # No error code was specified.
    ERROR_CODE_UNSPECIFIED = 0

    # Cloud Build failed due to a permissions issue.
    CLOUD_BUILD_PERMISSION_DENIED = 1

    # Cloud Storage bucket failed to create due to a permissions issue.
    BUCKET_CREATION_PERMISSION_DENIED = 2

    # Cloud Storage bucket failed for a non-permissions-related issue.
    BUCKET_CREATION_FAILED = 3

    # Acquiring lock on provided deployment reference failed.
    DEPLOYMENT_LOCK_ACQUIRE_FAILED = 4

    # Preview encountered an error when trying to access Cloud Build API.
    PREVIEW_BUILD_API_FAILED = 5

    # Preview created a build but build failed and logs were generated.
    PREVIEW_BUILD_RUN_FAILED = 6
  end
end

#service_account ⇒ ::String

Returns Required. User-specified Service Account (SA) credentials to be used when previewing resources. Format: projects/{projectID}/serviceAccounts/{serviceAccount}.

Returns:

  • (::String) —

    Required. User-specified Service Account (SA) credentials to be used when previewing resources. Format: projects/{projectID}/serviceAccounts/{serviceAccount}



1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
 
# File 'proto_docs/google/cloud/config/v1/config.rb', line 1231

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

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

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

  # Possible states of a preview.
  module State
    # The default value. This value is used if the state is unknown.
    STATE_UNSPECIFIED = 0

    # The preview is being created.
    CREATING = 1

    # The preview has succeeded.
    SUCCEEDED = 2

    # The preview is being applied.
    APPLYING = 3

    # The preview is stale. A preview can become stale if a revision has been
    # applied after this preview was created.
    STALE = 4

    # The preview is being deleted.
    DELETING = 5

    # The preview has encountered an unexpected error.
    FAILED = 6

    # The preview has been deleted.
    DELETED = 7
  end

  # Preview mode provides options for customizing preview operations.
  module PreviewMode
    # Unspecified policy, default mode will be used.
    PREVIEW_MODE_UNSPECIFIED = 0

    # DEFAULT mode generates an execution plan for reconciling current resource
    # state into expected resource state.
    DEFAULT = 1

    # DELETE mode generates as execution plan for destroying current resources.
    DELETE = 2
  end

  # Possible errors that can occur with previews.
  module ErrorCode
    # No error code was specified.
    ERROR_CODE_UNSPECIFIED = 0

    # Cloud Build failed due to a permissions issue.
    CLOUD_BUILD_PERMISSION_DENIED = 1

    # Cloud Storage bucket failed to create due to a permissions issue.
    BUCKET_CREATION_PERMISSION_DENIED = 2

    # Cloud Storage bucket failed for a non-permissions-related issue.
    BUCKET_CREATION_FAILED = 3

    # Acquiring lock on provided deployment reference failed.
    DEPLOYMENT_LOCK_ACQUIRE_FAILED = 4

    # Preview encountered an error when trying to access Cloud Build API.
    PREVIEW_BUILD_API_FAILED = 5

    # Preview created a build but build failed and logs were generated.
    PREVIEW_BUILD_RUN_FAILED = 6
  end
end

#state ⇒ ::Google::Cloud::ConfigService::V1::Preview::State (readonly)

Returns Output only. Current state of the preview.

Returns:



1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
 
# File 'proto_docs/google/cloud/config/v1/config.rb', line 1231

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

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

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

  # Possible states of a preview.
  module State
    # The default value. This value is used if the state is unknown.
    STATE_UNSPECIFIED = 0

    # The preview is being created.
    CREATING = 1

    # The preview has succeeded.
    SUCCEEDED = 2

    # The preview is being applied.
    APPLYING = 3

    # The preview is stale. A preview can become stale if a revision has been
    # applied after this preview was created.
    STALE = 4

    # The preview is being deleted.
    DELETING = 5

    # The preview has encountered an unexpected error.
    FAILED = 6

    # The preview has been deleted.
    DELETED = 7
  end

  # Preview mode provides options for customizing preview operations.
  module PreviewMode
    # Unspecified policy, default mode will be used.
    PREVIEW_MODE_UNSPECIFIED = 0

    # DEFAULT mode generates an execution plan for reconciling current resource
    # state into expected resource state.
    DEFAULT = 1

    # DELETE mode generates as execution plan for destroying current resources.
    DELETE = 2
  end

  # Possible errors that can occur with previews.
  module ErrorCode
    # No error code was specified.
    ERROR_CODE_UNSPECIFIED = 0

    # Cloud Build failed due to a permissions issue.
    CLOUD_BUILD_PERMISSION_DENIED = 1

    # Cloud Storage bucket failed to create due to a permissions issue.
    BUCKET_CREATION_PERMISSION_DENIED = 2

    # Cloud Storage bucket failed for a non-permissions-related issue.
    BUCKET_CREATION_FAILED = 3

    # Acquiring lock on provided deployment reference failed.
    DEPLOYMENT_LOCK_ACQUIRE_FAILED = 4

    # Preview encountered an error when trying to access Cloud Build API.
    PREVIEW_BUILD_API_FAILED = 5

    # Preview created a build but build failed and logs were generated.
    PREVIEW_BUILD_RUN_FAILED = 6
  end
end

#terraform_blueprint ⇒ ::Google::Cloud::ConfigService::V1::TerraformBlueprint

Returns The terraform blueprint to preview.

Returns:



1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
 
# File 'proto_docs/google/cloud/config/v1/config.rb', line 1231

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

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

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

  # Possible states of a preview.
  module State
    # The default value. This value is used if the state is unknown.
    STATE_UNSPECIFIED = 0

    # The preview is being created.
    CREATING = 1

    # The preview has succeeded.
    SUCCEEDED = 2

    # The preview is being applied.
    APPLYING = 3

    # The preview is stale. A preview can become stale if a revision has been
    # applied after this preview was created.
    STALE = 4

    # The preview is being deleted.
    DELETING = 5

    # The preview has encountered an unexpected error.
    FAILED = 6

    # The preview has been deleted.
    DELETED = 7
  end

  # Preview mode provides options for customizing preview operations.
  module PreviewMode
    # Unspecified policy, default mode will be used.
    PREVIEW_MODE_UNSPECIFIED = 0

    # DEFAULT mode generates an execution plan for reconciling current resource
    # state into expected resource state.
    DEFAULT = 1

    # DELETE mode generates as execution plan for destroying current resources.
    DELETE = 2
  end

  # Possible errors that can occur with previews.
  module ErrorCode
    # No error code was specified.
    ERROR_CODE_UNSPECIFIED = 0

    # Cloud Build failed due to a permissions issue.
    CLOUD_BUILD_PERMISSION_DENIED = 1

    # Cloud Storage bucket failed to create due to a permissions issue.
    BUCKET_CREATION_PERMISSION_DENIED = 2

    # Cloud Storage bucket failed for a non-permissions-related issue.
    BUCKET_CREATION_FAILED = 3

    # Acquiring lock on provided deployment reference failed.
    DEPLOYMENT_LOCK_ACQUIRE_FAILED = 4

    # Preview encountered an error when trying to access Cloud Build API.
    PREVIEW_BUILD_API_FAILED = 5

    # Preview created a build but build failed and logs were generated.
    PREVIEW_BUILD_RUN_FAILED = 6
  end
end

#tf_errors ⇒ ::Array<::Google::Cloud::ConfigService::V1::TerraformError> (readonly)

Returns Output only. Summary of errors encountered during Terraform preview. It has a size limit of 10, i.e. only top 10 errors will be summarized here.

Returns:



1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
 
# File 'proto_docs/google/cloud/config/v1/config.rb', line 1231

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

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

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

  # Possible states of a preview.
  module State
    # The default value. This value is used if the state is unknown.
    STATE_UNSPECIFIED = 0

    # The preview is being created.
    CREATING = 1

    # The preview has succeeded.
    SUCCEEDED = 2

    # The preview is being applied.
    APPLYING = 3

    # The preview is stale. A preview can become stale if a revision has been
    # applied after this preview was created.
    STALE = 4

    # The preview is being deleted.
    DELETING = 5

    # The preview has encountered an unexpected error.
    FAILED = 6

    # The preview has been deleted.
    DELETED = 7
  end

  # Preview mode provides options for customizing preview operations.
  module PreviewMode
    # Unspecified policy, default mode will be used.
    PREVIEW_MODE_UNSPECIFIED = 0

    # DEFAULT mode generates an execution plan for reconciling current resource
    # state into expected resource state.
    DEFAULT = 1

    # DELETE mode generates as execution plan for destroying current resources.
    DELETE = 2
  end

  # Possible errors that can occur with previews.
  module ErrorCode
    # No error code was specified.
    ERROR_CODE_UNSPECIFIED = 0

    # Cloud Build failed due to a permissions issue.
    CLOUD_BUILD_PERMISSION_DENIED = 1

    # Cloud Storage bucket failed to create due to a permissions issue.
    BUCKET_CREATION_PERMISSION_DENIED = 2

    # Cloud Storage bucket failed for a non-permissions-related issue.
    BUCKET_CREATION_FAILED = 3

    # Acquiring lock on provided deployment reference failed.
    DEPLOYMENT_LOCK_ACQUIRE_FAILED = 4

    # Preview encountered an error when trying to access Cloud Build API.
    PREVIEW_BUILD_API_FAILED = 5

    # Preview created a build but build failed and logs were generated.
    PREVIEW_BUILD_RUN_FAILED = 6
  end
end

#tf_version ⇒ ::String (readonly)

Returns Output only. The current Terraform version set on the preview. It is in the format of "Major.Minor.Patch", for example, "1.3.10".

Returns:

  • (::String) —

    Output only. The current Terraform version set on the preview. It is in the format of "Major.Minor.Patch", for example, "1.3.10".



1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
 
# File 'proto_docs/google/cloud/config/v1/config.rb', line 1231

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

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

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

  # Possible states of a preview.
  module State
    # The default value. This value is used if the state is unknown.
    STATE_UNSPECIFIED = 0

    # The preview is being created.
    CREATING = 1

    # The preview has succeeded.
    SUCCEEDED = 2

    # The preview is being applied.
    APPLYING = 3

    # The preview is stale. A preview can become stale if a revision has been
    # applied after this preview was created.
    STALE = 4

    # The preview is being deleted.
    DELETING = 5

    # The preview has encountered an unexpected error.
    FAILED = 6

    # The preview has been deleted.
    DELETED = 7
  end

  # Preview mode provides options for customizing preview operations.
  module PreviewMode
    # Unspecified policy, default mode will be used.
    PREVIEW_MODE_UNSPECIFIED = 0

    # DEFAULT mode generates an execution plan for reconciling current resource
    # state into expected resource state.
    DEFAULT = 1

    # DELETE mode generates as execution plan for destroying current resources.
    DELETE = 2
  end

  # Possible errors that can occur with previews.
  module ErrorCode
    # No error code was specified.
    ERROR_CODE_UNSPECIFIED = 0

    # Cloud Build failed due to a permissions issue.
    CLOUD_BUILD_PERMISSION_DENIED = 1

    # Cloud Storage bucket failed to create due to a permissions issue.
    BUCKET_CREATION_PERMISSION_DENIED = 2

    # Cloud Storage bucket failed for a non-permissions-related issue.
    BUCKET_CREATION_FAILED = 3

    # Acquiring lock on provided deployment reference failed.
    DEPLOYMENT_LOCK_ACQUIRE_FAILED = 4

    # Preview encountered an error when trying to access Cloud Build API.
    PREVIEW_BUILD_API_FAILED = 5

    # Preview created a build but build failed and logs were generated.
    PREVIEW_BUILD_RUN_FAILED = 6
  end
end

#tf_version_constraint ⇒ ::String

Returns Optional. The user-specified Terraform version constraint. Example: "=1.3.10".

Returns:

  • (::String) —

    Optional. The user-specified Terraform version constraint. Example: "=1.3.10".



1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
 
# File 'proto_docs/google/cloud/config/v1/config.rb', line 1231

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

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

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

  # Possible states of a preview.
  module State
    # The default value. This value is used if the state is unknown.
    STATE_UNSPECIFIED = 0

    # The preview is being created.
    CREATING = 1

    # The preview has succeeded.
    SUCCEEDED = 2

    # The preview is being applied.
    APPLYING = 3

    # The preview is stale. A preview can become stale if a revision has been
    # applied after this preview was created.
    STALE = 4

    # The preview is being deleted.
    DELETING = 5

    # The preview has encountered an unexpected error.
    FAILED = 6

    # The preview has been deleted.
    DELETED = 7
  end

  # Preview mode provides options for customizing preview operations.
  module PreviewMode
    # Unspecified policy, default mode will be used.
    PREVIEW_MODE_UNSPECIFIED = 0

    # DEFAULT mode generates an execution plan for reconciling current resource
    # state into expected resource state.
    DEFAULT = 1

    # DELETE mode generates as execution plan for destroying current resources.
    DELETE = 2
  end

  # Possible errors that can occur with previews.
  module ErrorCode
    # No error code was specified.
    ERROR_CODE_UNSPECIFIED = 0

    # Cloud Build failed due to a permissions issue.
    CLOUD_BUILD_PERMISSION_DENIED = 1

    # Cloud Storage bucket failed to create due to a permissions issue.
    BUCKET_CREATION_PERMISSION_DENIED = 2

    # Cloud Storage bucket failed for a non-permissions-related issue.
    BUCKET_CREATION_FAILED = 3

    # Acquiring lock on provided deployment reference failed.
    DEPLOYMENT_LOCK_ACQUIRE_FAILED = 4

    # Preview encountered an error when trying to access Cloud Build API.
    PREVIEW_BUILD_API_FAILED = 5

    # Preview created a build but build failed and logs were generated.
    PREVIEW_BUILD_RUN_FAILED = 6
  end
end

#worker_pool ⇒ ::String

Returns Optional. The user-specified Worker Pool resource in which the Cloud Build job will execute. Format projects/{project}/locations/{location}/workerPools/{workerPoolId} If this field is unspecified, the default Cloud Build worker pool will be used. If omitted and deployment resource ref provided has worker_pool defined, that worker pool is used.

Returns:

  • (::String) —

    Optional. The user-specified Worker Pool resource in which the Cloud Build job will execute. Format projects/{project}/locations/{location}/workerPools/{workerPoolId} If this field is unspecified, the default Cloud Build worker pool will be used. If omitted and deployment resource ref provided has worker_pool defined, that worker pool is used.



1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
 
# File 'proto_docs/google/cloud/config/v1/config.rb', line 1231

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

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

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

  # Possible states of a preview.
  module State
    # The default value. This value is used if the state is unknown.
    STATE_UNSPECIFIED = 0

    # The preview is being created.
    CREATING = 1

    # The preview has succeeded.
    SUCCEEDED = 2

    # The preview is being applied.
    APPLYING = 3

    # The preview is stale. A preview can become stale if a revision has been
    # applied after this preview was created.
    STALE = 4

    # The preview is being deleted.
    DELETING = 5

    # The preview has encountered an unexpected error.
    FAILED = 6

    # The preview has been deleted.
    DELETED = 7
  end

  # Preview mode provides options for customizing preview operations.
  module PreviewMode
    # Unspecified policy, default mode will be used.
    PREVIEW_MODE_UNSPECIFIED = 0

    # DEFAULT mode generates an execution plan for reconciling current resource
    # state into expected resource state.
    DEFAULT = 1

    # DELETE mode generates as execution plan for destroying current resources.
    DELETE = 2
  end

  # Possible errors that can occur with previews.
  module ErrorCode
    # No error code was specified.
    ERROR_CODE_UNSPECIFIED = 0

    # Cloud Build failed due to a permissions issue.
    CLOUD_BUILD_PERMISSION_DENIED = 1

    # Cloud Storage bucket failed to create due to a permissions issue.
    BUCKET_CREATION_PERMISSION_DENIED = 2

    # Cloud Storage bucket failed for a non-permissions-related issue.
    BUCKET_CREATION_FAILED = 3

    # Acquiring lock on provided deployment reference failed.
    DEPLOYMENT_LOCK_ACQUIRE_FAILED = 4

    # Preview encountered an error when trying to access Cloud Build API.
    PREVIEW_BUILD_API_FAILED = 5

    # Preview created a build but build failed and logs were generated.
    PREVIEW_BUILD_RUN_FAILED = 6
  end
end