Class: Google::Cloud::BeyondCorp::AppConnectors::V1::AppConnector

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

Overview

A BeyondCorp connector resource that represents an application facing component deployed proximal to and with direct access to the application instances. It is used to establish connectivity between the remote enterprise environment and GCP. It initiates connections to the applications and can proxy the data from users over the connection.

Defined Under Namespace

Modules: State Classes: LabelsEntry, PrincipalInfo

Instance Attribute Summary collapse

Instance Attribute Details

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

Returns Output only. Timestamp when the resource was created.

Returns:



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
 
# File 'proto_docs/google/cloud/beyondcorp/appconnectors/v1/app_connectors_service.rb', line 253

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

  # PrincipalInfo represents an Identity oneof.
  # @!attribute [rw] service_account
  #   @return [::Google::Cloud::BeyondCorp::AppConnectors::V1::AppConnector::PrincipalInfo::ServiceAccount]
  #     A GCP service account.
  class PrincipalInfo
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # ServiceAccount represents a GCP service account.
    # @!attribute [rw] email
    #   @return [::String]
    #     Email address of the service account.
    class ServiceAccount
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

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

  # Represents the different states of a AppConnector.
  module State
    # Default value. This value is unused.
    STATE_UNSPECIFIED = 0

    # AppConnector is being created.
    CREATING = 1

    # AppConnector has been created.
    CREATED = 2

    # AppConnector's configuration is being updated.
    UPDATING = 3

    # AppConnector is being deleted.
    DELETING = 4

    # AppConnector is down and may be restored in the future.
    # This happens when CCFE sends ProjectState = OFF.
    DOWN = 5
  end
end

#display_name ⇒ ::String

Returns Optional. An arbitrary user-provided name for the AppConnector. Cannot exceed 64 characters.

Returns:

  • (::String) —

    Optional. An arbitrary user-provided name for the AppConnector. Cannot exceed 64 characters.



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
 
# File 'proto_docs/google/cloud/beyondcorp/appconnectors/v1/app_connectors_service.rb', line 253

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

  # PrincipalInfo represents an Identity oneof.
  # @!attribute [rw] service_account
  #   @return [::Google::Cloud::BeyondCorp::AppConnectors::V1::AppConnector::PrincipalInfo::ServiceAccount]
  #     A GCP service account.
  class PrincipalInfo
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # ServiceAccount represents a GCP service account.
    # @!attribute [rw] email
    #   @return [::String]
    #     Email address of the service account.
    class ServiceAccount
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

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

  # Represents the different states of a AppConnector.
  module State
    # Default value. This value is unused.
    STATE_UNSPECIFIED = 0

    # AppConnector is being created.
    CREATING = 1

    # AppConnector has been created.
    CREATED = 2

    # AppConnector's configuration is being updated.
    UPDATING = 3

    # AppConnector is being deleted.
    DELETING = 4

    # AppConnector is down and may be restored in the future.
    # This happens when CCFE sends ProjectState = OFF.
    DOWN = 5
  end
end

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

Returns Optional. Resource labels to represent user provided metadata.

Returns:

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

    Optional. Resource labels to represent user provided metadata.



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
 
# File 'proto_docs/google/cloud/beyondcorp/appconnectors/v1/app_connectors_service.rb', line 253

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

  # PrincipalInfo represents an Identity oneof.
  # @!attribute [rw] service_account
  #   @return [::Google::Cloud::BeyondCorp::AppConnectors::V1::AppConnector::PrincipalInfo::ServiceAccount]
  #     A GCP service account.
  class PrincipalInfo
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # ServiceAccount represents a GCP service account.
    # @!attribute [rw] email
    #   @return [::String]
    #     Email address of the service account.
    class ServiceAccount
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

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

  # Represents the different states of a AppConnector.
  module State
    # Default value. This value is unused.
    STATE_UNSPECIFIED = 0

    # AppConnector is being created.
    CREATING = 1

    # AppConnector has been created.
    CREATED = 2

    # AppConnector's configuration is being updated.
    UPDATING = 3

    # AppConnector is being deleted.
    DELETING = 4

    # AppConnector is down and may be restored in the future.
    # This happens when CCFE sends ProjectState = OFF.
    DOWN = 5
  end
end

#name ⇒ ::String

Returns Required. Unique resource name of the AppConnector. The name is ignored when creating a AppConnector.

Returns:

  • (::String) —

    Required. Unique resource name of the AppConnector. The name is ignored when creating a AppConnector.



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
 
# File 'proto_docs/google/cloud/beyondcorp/appconnectors/v1/app_connectors_service.rb', line 253

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

  # PrincipalInfo represents an Identity oneof.
  # @!attribute [rw] service_account
  #   @return [::Google::Cloud::BeyondCorp::AppConnectors::V1::AppConnector::PrincipalInfo::ServiceAccount]
  #     A GCP service account.
  class PrincipalInfo
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # ServiceAccount represents a GCP service account.
    # @!attribute [rw] email
    #   @return [::String]
    #     Email address of the service account.
    class ServiceAccount
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

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

  # Represents the different states of a AppConnector.
  module State
    # Default value. This value is unused.
    STATE_UNSPECIFIED = 0

    # AppConnector is being created.
    CREATING = 1

    # AppConnector has been created.
    CREATED = 2

    # AppConnector's configuration is being updated.
    UPDATING = 3

    # AppConnector is being deleted.
    DELETING = 4

    # AppConnector is down and may be restored in the future.
    # This happens when CCFE sends ProjectState = OFF.
    DOWN = 5
  end
end

#principal_info ⇒ ::Google::Cloud::BeyondCorp::AppConnectors::V1::AppConnector::PrincipalInfo

Returns Required. Principal information about the Identity of the AppConnector.

Returns:



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
 
# File 'proto_docs/google/cloud/beyondcorp/appconnectors/v1/app_connectors_service.rb', line 253

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

  # PrincipalInfo represents an Identity oneof.
  # @!attribute [rw] service_account
  #   @return [::Google::Cloud::BeyondCorp::AppConnectors::V1::AppConnector::PrincipalInfo::ServiceAccount]
  #     A GCP service account.
  class PrincipalInfo
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # ServiceAccount represents a GCP service account.
    # @!attribute [rw] email
    #   @return [::String]
    #     Email address of the service account.
    class ServiceAccount
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

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

  # Represents the different states of a AppConnector.
  module State
    # Default value. This value is unused.
    STATE_UNSPECIFIED = 0

    # AppConnector is being created.
    CREATING = 1

    # AppConnector has been created.
    CREATED = 2

    # AppConnector's configuration is being updated.
    UPDATING = 3

    # AppConnector is being deleted.
    DELETING = 4

    # AppConnector is down and may be restored in the future.
    # This happens when CCFE sends ProjectState = OFF.
    DOWN = 5
  end
end

#resource_info ⇒ ::Google::Cloud::BeyondCorp::AppConnectors::V1::ResourceInfo

Returns Optional. Resource info of the connector.

Returns:



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
 
# File 'proto_docs/google/cloud/beyondcorp/appconnectors/v1/app_connectors_service.rb', line 253

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

  # PrincipalInfo represents an Identity oneof.
  # @!attribute [rw] service_account
  #   @return [::Google::Cloud::BeyondCorp::AppConnectors::V1::AppConnector::PrincipalInfo::ServiceAccount]
  #     A GCP service account.
  class PrincipalInfo
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # ServiceAccount represents a GCP service account.
    # @!attribute [rw] email
    #   @return [::String]
    #     Email address of the service account.
    class ServiceAccount
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

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

  # Represents the different states of a AppConnector.
  module State
    # Default value. This value is unused.
    STATE_UNSPECIFIED = 0

    # AppConnector is being created.
    CREATING = 1

    # AppConnector has been created.
    CREATED = 2

    # AppConnector's configuration is being updated.
    UPDATING = 3

    # AppConnector is being deleted.
    DELETING = 4

    # AppConnector is down and may be restored in the future.
    # This happens when CCFE sends ProjectState = OFF.
    DOWN = 5
  end
end

#state ⇒ ::Google::Cloud::BeyondCorp::AppConnectors::V1::AppConnector::State (readonly)

Returns Output only. The current state of the AppConnector.

Returns:



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
 
# File 'proto_docs/google/cloud/beyondcorp/appconnectors/v1/app_connectors_service.rb', line 253

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

  # PrincipalInfo represents an Identity oneof.
  # @!attribute [rw] service_account
  #   @return [::Google::Cloud::BeyondCorp::AppConnectors::V1::AppConnector::PrincipalInfo::ServiceAccount]
  #     A GCP service account.
  class PrincipalInfo
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # ServiceAccount represents a GCP service account.
    # @!attribute [rw] email
    #   @return [::String]
    #     Email address of the service account.
    class ServiceAccount
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

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

  # Represents the different states of a AppConnector.
  module State
    # Default value. This value is unused.
    STATE_UNSPECIFIED = 0

    # AppConnector is being created.
    CREATING = 1

    # AppConnector has been created.
    CREATED = 2

    # AppConnector's configuration is being updated.
    UPDATING = 3

    # AppConnector is being deleted.
    DELETING = 4

    # AppConnector is down and may be restored in the future.
    # This happens when CCFE sends ProjectState = OFF.
    DOWN = 5
  end
end

#uid ⇒ ::String (readonly)

Returns Output only. A unique identifier for the instance generated by the system.

Returns:

  • (::String) —

    Output only. A unique identifier for the instance generated by the system.



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
 
# File 'proto_docs/google/cloud/beyondcorp/appconnectors/v1/app_connectors_service.rb', line 253

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

  # PrincipalInfo represents an Identity oneof.
  # @!attribute [rw] service_account
  #   @return [::Google::Cloud::BeyondCorp::AppConnectors::V1::AppConnector::PrincipalInfo::ServiceAccount]
  #     A GCP service account.
  class PrincipalInfo
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # ServiceAccount represents a GCP service account.
    # @!attribute [rw] email
    #   @return [::String]
    #     Email address of the service account.
    class ServiceAccount
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

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

  # Represents the different states of a AppConnector.
  module State
    # Default value. This value is unused.
    STATE_UNSPECIFIED = 0

    # AppConnector is being created.
    CREATING = 1

    # AppConnector has been created.
    CREATED = 2

    # AppConnector's configuration is being updated.
    UPDATING = 3

    # AppConnector is being deleted.
    DELETING = 4

    # AppConnector is down and may be restored in the future.
    # This happens when CCFE sends ProjectState = OFF.
    DOWN = 5
  end
end

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

Returns Output only. Timestamp when the resource was last modified.

Returns:



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
 
# File 'proto_docs/google/cloud/beyondcorp/appconnectors/v1/app_connectors_service.rb', line 253

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

  # PrincipalInfo represents an Identity oneof.
  # @!attribute [rw] service_account
  #   @return [::Google::Cloud::BeyondCorp::AppConnectors::V1::AppConnector::PrincipalInfo::ServiceAccount]
  #     A GCP service account.
  class PrincipalInfo
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # ServiceAccount represents a GCP service account.
    # @!attribute [rw] email
    #   @return [::String]
    #     Email address of the service account.
    class ServiceAccount
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

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

  # Represents the different states of a AppConnector.
  module State
    # Default value. This value is unused.
    STATE_UNSPECIFIED = 0

    # AppConnector is being created.
    CREATING = 1

    # AppConnector has been created.
    CREATED = 2

    # AppConnector's configuration is being updated.
    UPDATING = 3

    # AppConnector is being deleted.
    DELETING = 4

    # AppConnector is down and may be restored in the future.
    # This happens when CCFE sends ProjectState = OFF.
    DOWN = 5
  end
end