Class: Google::Cloud::Connectors::V1::RoleGrant

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

Overview

This configuration defines all the Cloud IAM roles that needs to be granted to a particular GCP resource for the selected prinicpal like service account. These configurations will let UI display to customers what IAM roles need to be granted by them. Or these configurations can be used by the UI to render a 'grant' button to do the same on behalf of the user.

Defined Under Namespace

Modules: Principal Classes: Resource

Instance Attribute Summary collapse

Instance Attribute Details

#helper_text_template ⇒ ::String

Returns Template that UI can use to provide helper text to customers.

Returns:

  • (::String) —

    Template that UI can use to provide helper text to customers.



196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
 
# File 'proto_docs/google/cloud/connectors/v1/common.rb', line 196

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

  # Resource definition
  # @!attribute [rw] type
  #   @return [::Google::Cloud::Connectors::V1::RoleGrant::Resource::Type]
  #     Different types of resource supported.
  # @!attribute [rw] path_template
  #   @return [::String]
  #     Template to uniquely represent a GCP resource in a format IAM expects
  #     This is a template that can have references to other values provided in
  #     the config variable template.
  class Resource
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Resource Type definition.
    module Type
      # Value type is not specified.
      TYPE_UNSPECIFIED = 0

      # GCP Project Resource.
      GCP_PROJECT = 1

      # Any GCP Resource which is identified uniquely by IAM.
      GCP_RESOURCE = 2

      # GCP Secret Resource.
      GCP_SECRETMANAGER_SECRET = 3

      # GCP Secret Version Resource.
      GCP_SECRETMANAGER_SECRET_VERSION = 4
    end
  end

  # Supported Principal values.
  module Principal
    # Value type is not specified.
    PRINCIPAL_UNSPECIFIED = 0

    # Service Account used for Connector workload identity
    # This is either the default service account if unspecified or Service
    # Account provided by Customers through BYOSA.
    CONNECTOR_SA = 1
  end
end

#principal ⇒ ::Google::Cloud::Connectors::V1::RoleGrant::Principal

Returns Prinicipal/Identity for whom the role need to assigned.

Returns:



196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
 
# File 'proto_docs/google/cloud/connectors/v1/common.rb', line 196

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

  # Resource definition
  # @!attribute [rw] type
  #   @return [::Google::Cloud::Connectors::V1::RoleGrant::Resource::Type]
  #     Different types of resource supported.
  # @!attribute [rw] path_template
  #   @return [::String]
  #     Template to uniquely represent a GCP resource in a format IAM expects
  #     This is a template that can have references to other values provided in
  #     the config variable template.
  class Resource
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Resource Type definition.
    module Type
      # Value type is not specified.
      TYPE_UNSPECIFIED = 0

      # GCP Project Resource.
      GCP_PROJECT = 1

      # Any GCP Resource which is identified uniquely by IAM.
      GCP_RESOURCE = 2

      # GCP Secret Resource.
      GCP_SECRETMANAGER_SECRET = 3

      # GCP Secret Version Resource.
      GCP_SECRETMANAGER_SECRET_VERSION = 4
    end
  end

  # Supported Principal values.
  module Principal
    # Value type is not specified.
    PRINCIPAL_UNSPECIFIED = 0

    # Service Account used for Connector workload identity
    # This is either the default service account if unspecified or Service
    # Account provided by Customers through BYOSA.
    CONNECTOR_SA = 1
  end
end

#resource ⇒ ::Google::Cloud::Connectors::V1::RoleGrant::Resource

Returns Resource on which the roles needs to be granted for the principal.

Returns:



196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
 
# File 'proto_docs/google/cloud/connectors/v1/common.rb', line 196

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

  # Resource definition
  # @!attribute [rw] type
  #   @return [::Google::Cloud::Connectors::V1::RoleGrant::Resource::Type]
  #     Different types of resource supported.
  # @!attribute [rw] path_template
  #   @return [::String]
  #     Template to uniquely represent a GCP resource in a format IAM expects
  #     This is a template that can have references to other values provided in
  #     the config variable template.
  class Resource
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Resource Type definition.
    module Type
      # Value type is not specified.
      TYPE_UNSPECIFIED = 0

      # GCP Project Resource.
      GCP_PROJECT = 1

      # Any GCP Resource which is identified uniquely by IAM.
      GCP_RESOURCE = 2

      # GCP Secret Resource.
      GCP_SECRETMANAGER_SECRET = 3

      # GCP Secret Version Resource.
      GCP_SECRETMANAGER_SECRET_VERSION = 4
    end
  end

  # Supported Principal values.
  module Principal
    # Value type is not specified.
    PRINCIPAL_UNSPECIFIED = 0

    # Service Account used for Connector workload identity
    # This is either the default service account if unspecified or Service
    # Account provided by Customers through BYOSA.
    CONNECTOR_SA = 1
  end
end

#roles ⇒ ::Array<::String>

Returns List of roles that need to be granted.

Returns:

  • (::Array<::String>) —

    List of roles that need to be granted.



196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
 
# File 'proto_docs/google/cloud/connectors/v1/common.rb', line 196

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

  # Resource definition
  # @!attribute [rw] type
  #   @return [::Google::Cloud::Connectors::V1::RoleGrant::Resource::Type]
  #     Different types of resource supported.
  # @!attribute [rw] path_template
  #   @return [::String]
  #     Template to uniquely represent a GCP resource in a format IAM expects
  #     This is a template that can have references to other values provided in
  #     the config variable template.
  class Resource
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Resource Type definition.
    module Type
      # Value type is not specified.
      TYPE_UNSPECIFIED = 0

      # GCP Project Resource.
      GCP_PROJECT = 1

      # Any GCP Resource which is identified uniquely by IAM.
      GCP_RESOURCE = 2

      # GCP Secret Resource.
      GCP_SECRETMANAGER_SECRET = 3

      # GCP Secret Version Resource.
      GCP_SECRETMANAGER_SECRET_VERSION = 4
    end
  end

  # Supported Principal values.
  module Principal
    # Value type is not specified.
    PRINCIPAL_UNSPECIFIED = 0

    # Service Account used for Connector workload identity
    # This is either the default service account if unspecified or Service
    # Account provided by Customers through BYOSA.
    CONNECTOR_SA = 1
  end
end