Class: Couchbase::Management::S3ExternalAnalyticsLink

Inherits:
Object
  • Object
show all
Defined in:
lib/couchbase/management/analytics_index_manager.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

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.

Parameters:

  • name (String) —

    the name of this link

  • dataverse (String) —

    the dataverse this link belongs to

  • access_key_id (String) —

    AWS S3 access key ID

  • secret_access_key (String) —

    AWS S3 secret key

  • region (String) —

    AWS S3 region

  • session_token (String, nil) (defaults to: nil) —

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

  • service_endpoint (String, nil) (defaults to: nil) —

    AWS S3 service endpoint

Yield Parameters:



1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
 
# File 'lib/couchbase/management/analytics_index_manager.rb', line 1099

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:

  • (String) 


1084
1085
1086
 
# File 'lib/couchbase/management/analytics_index_manager.rb', line 1084

def access_key_id
  @access_key_id
end

#dataverse ⇒ String

Returns:

  • (String) 


1083
1084
1085
 
# File 'lib/couchbase/management/analytics_index_manager.rb', line 1083

def dataverse
  @dataverse
end

#name ⇒ String

Returns:

  • (String) 


1082
1083
1084
 
# File 'lib/couchbase/management/analytics_index_manager.rb', line 1082

def name
  @name
end

#region ⇒ String

Returns:

  • (String) 


1087
1088
1089
 
# File 'lib/couchbase/management/analytics_index_manager.rb', line 1087

def region
  @region
end

#secret_access_key ⇒ String

Returns:

  • (String) 


1085
1086
1087
 
# File 'lib/couchbase/management/analytics_index_manager.rb', line 1085

def secret_access_key
  @secret_access_key
end

#service_endpoint ⇒ String?

Returns:

  • (String, nil) 


1088
1089
1090
 
# File 'lib/couchbase/management/analytics_index_manager.rb', line 1088

def service_endpoint
  @service_endpoint
end

#session_token ⇒ String?

Returns:

  • (String, nil) 


1086
1087
1088
 
# File 'lib/couchbase/management/analytics_index_manager.rb', line 1086

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. 



1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
 
# File 'lib/couchbase/management/analytics_index_manager.rb', line 1113

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