Class: Couchbase::Management::S3ExternalAnalyticsLink

Inherits:

Object

• Object
• Couchbase::Management::S3ExternalAnalyticsLink

Defined in:

lib/couchbase/management/analytics_index_manager.rb

Instance Attribute Summary

• #access_key_id ⇒ String
• #dataverse ⇒ String
• #name ⇒ String
• #region ⇒ String
• #secret_access_key ⇒ String
• #service_endpoint ⇒ String^?
• #session_token ⇒ String^?

Instance Method Summary

• #initialize(name, dataverse, access_key_id, secret_access_key, region, session_token: nil, service_endpoint: nil) {|self| ... } ⇒ S3ExternalAnalyticsLink constructor

  A new instance of S3ExternalAnalyticsLink.

• #to_backend ⇒ Object private

Constructor Details

#initialize(name, dataverse, access_key_id, secret_access_key, region, session_token: nil, service_endpoint: nil) {|self| ... } ⇒ S3ExternalAnalyticsLink

Returns a new instance of S3ExternalAnalyticsLink.

Yield Parameters:

• self (S3ExternalAnalyticsLink)

Parameters:

• the name of this link

• the dataverse this link belongs to

• AWS S3 access key ID

• AWS S3 secret key

• AWS S3 region

• (defaults to: nil)

  AWS S3 token if temporary credentials are provided. Only available in 7.0+

• (defaults to: nil)

  AWS S3 service endpoint

# File 'lib/couchbase/management/analytics_index_manager.rb', line 1132

def initialize(name, dataverse, access_key_id, secret_access_key, region,
               session_token: nil,
               service_endpoint: nil)
  @name = name
  @dataverse = dataverse
  @access_key_id = access_key_id
  @secret_access_key = secret_access_key
  @session_token = session_token
  @region = region
  @service_endpoint = service_endpoint
  yield self if block_given?
end

Instance Attribute Details

#access_key_id ⇒ String

Returns:

# File 'lib/couchbase/management/analytics_index_manager.rb', line 1117

def access_key_id
  @access_key_id
end

#dataverse ⇒ String

Returns:

# File 'lib/couchbase/management/analytics_index_manager.rb', line 1116

def dataverse
  @dataverse
end

#name ⇒ String

Returns:

# File 'lib/couchbase/management/analytics_index_manager.rb', line 1115

def name
  @name
end

#region ⇒ String

Returns:

# File 'lib/couchbase/management/analytics_index_manager.rb', line 1120

def region
  @region
end

#secret_access_key ⇒ String

Returns:

# File 'lib/couchbase/management/analytics_index_manager.rb', line 1118

def secret_access_key
  @secret_access_key
end

#service_endpoint ⇒ String^?

Returns:

# File 'lib/couchbase/management/analytics_index_manager.rb', line 1121

def service_endpoint
  @service_endpoint
end

#session_token ⇒ String^?

Returns:

# File 'lib/couchbase/management/analytics_index_manager.rb', line 1119

def session_token
  @session_token
end

Instance Method Details

#to_backend ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

API:

• private

# File 'lib/couchbase/management/analytics_index_manager.rb', line 1146

def to_backend
  {
    type: :s3,
    link_name: @name,
    dataverse: @dataverse,
    access_key_id: @access_key_id,
    secret_access_key: @secret_access_key,
    session_token: @session_token,
    region: @region,
    service_endpoint: @service_endpoint,
  }
end