Class: Couchbase::Management::AzureBlobExternalAnalyticsLink

Inherits:

Object

• Object
• Couchbase::Management::AzureBlobExternalAnalyticsLink

Defined in:

lib/couchbase/management/analytics_index_manager.rb

Instance Attribute Summary

• #account_key ⇒ String^?
• #account_name ⇒ String^?
• #blob_endpoint ⇒ String^?
• #connection_string ⇒ String^?
• #dataverse ⇒ String
• #endpoint_suffix ⇒ String^?
• #name ⇒ String
• #shared_access_signature ⇒ String^?

Instance Method Summary

• #initialize(name, dataverse, connection_string: nil, account_name: nil, account_key: nil, shared_access_signature: nil, blob_endpoint: nil, endpoint_suffix: nil) {|self| ... } ⇒ AzureBlobExternalAnalyticsLink constructor

  A new instance of AzureBlobExternalAnalyticsLink.

• #to_backend ⇒ Object private

Constructor Details

#initialize(name, dataverse, connection_string: nil, account_name: nil, account_key: nil, shared_access_signature: nil, blob_endpoint: nil, endpoint_suffix: nil) {|self| ... } ⇒ AzureBlobExternalAnalyticsLink

Returns a new instance of AzureBlobExternalAnalyticsLink.

Parameters:

• name (String) —

  the name of this link

• dataverse (String) —

  the dataverse this link belongs to

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

  the connection string can be used as an authentication method, connection_string contains other authentication methods embedded inside the string. Only a single authentication method can be used. (e.g. “AccountName=myAccountName;AccountKey=myAccountKey”).

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

  Azure blob storage account name

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

  Azure blob storage account key

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

  token that can be used for authentication

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

  Azure blob storage endpoint

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

  Azure blob endpoint suffix

Yield Parameters:

• self (AzureBlobExternalAnalyticsLink)

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

def initialize(name, dataverse,
               connection_string: nil,
               account_name: nil,
               account_key: nil,
               shared_access_signature: nil,
               blob_endpoint: nil,
               endpoint_suffix: nil)
  @name = name
  @dataverse = dataverse
  @connection_string = connection_string
  @account_name = account_name
  @account_key = account_key
  @shared_access_signature = shared_access_signature
  @blob_endpoint = blob_endpoint
  @endpoint_suffix = endpoint_suffix
  yield self if block_given?
end

Instance Attribute Details

#account_key ⇒ String^?

Returns:

• (String, nil)

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

def account_key
  @account_key
end

#account_name ⇒ String^?

Returns:

• (String, nil)

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

def account_name
  @account_name
end

#blob_endpoint ⇒ String^?

Returns:

• (String, nil)

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

def blob_endpoint
  @blob_endpoint
end

#connection_string ⇒ String^?

Returns:

• (String, nil)

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

def connection_string
  @connection_string
end

#dataverse ⇒ String

Returns:

• (String)

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

def dataverse
  @dataverse
end

#endpoint_suffix ⇒ String^?

Returns:

• (String, nil)

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

def endpoint_suffix
  @endpoint_suffix
end

#name ⇒ String

Returns:

• (String)

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

def name
  @name
end

#shared_access_signature ⇒ String^?

Returns:

• (String, nil)

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

def shared_access_signature
  @shared_access_signature
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.

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

def to_backend
  {
    type: :azureblob,
    link_name: @name,
    dataverse: @dataverse,
    connection_string: @connection_string,
    account_name: @account_name,
    account_key: @account_key,
    shared_access_signature: @shared_access_signature,
    blob_endpoint: @blob_endpoint,
    endpoint_suffix: @endpoint_suffix,
  }
end