単一の機能を取得する

const feature = appConfigClient.getFeature('feature_id'); // feature can be null incase of an invalid feature id

if (feature !== null) {
   console.log(`Feature Name ${feature.getFeatureName()} `);
   console.log(`Feature Id ${feature.getFeatureId()} `);
   console.log(`Feature Type ${feature.getFeatureDataType()} `);
   if (feature.isEnabled()) {
      // feature flag is enabled
   } else {
      // feature flag is disabled
   }
}

すべての機能を取得する

const features = appConfigClient.getFeatures();
const feature = features['feature_id'];

if (feature !== null) {
   console.log(`Feature Name ${feature.getFeatureName()} `);
   console.log(`Feature Id ${feature.getFeatureId()} `);
   console.log(`Feature Type ${feature.getFeatureDataType()} `);
   console.log(`Is feature enabled? ${feature.isEnabled()} `);
}

機能評価

feature.getCurrentValue(entityId, entityAttributes) メソッドを使用して、機能フラグの値を評価できます。 このメソッドは、評価された値、機能フラグが有効な状況、および評価の詳細を含む JSON オブジェクトを返します。

const entityId = '<entityId>';
const entityAttributes = {
  city: 'Bangalore',
  country: 'India',
};

const result = feature.getCurrentValue(entityId, entityAttributes);
console.log(result.value); // Evaluated value of the feature flag. The type of evaluated value will match the type of feature flag (Boolean, String, Numeric).
console.log(result.isEnabled); // enabled status.
console.log(result.details); // a JSON object containing detailed information of the evaluation.

// the `result.details` will have the following
console.log(result.details.valueType); // a string value. Example: DISABLED_VALUE
console.log(result.details.reason); // a string value. Example: Disabled value of the feature flag since the feature flag is disabled.
console.log(result.details.segmentName); // (only if applicable, else it is undefined) a string value containing the segment name for which the feature flag was evaluated.
console.log(result.details.rolloutPercentageApplied); // (only if applicable, else it is undefined) a boolean value. True if the entityId was part of the rollout percentage evaluation, false otherwise.
console.log(result.details.errorType); // (only if applicable, else it is undefined) contains the error.message if any error was occured during the evaluation.

• entityId: エンティティーの ID。 これは、フィーチャーが評価されるエンティティーに関連するストリング ID です。 例えば、エンティティーは、モバイル・デバイス上で実行されるアプリのインスタンス、クラウド上で実行されるマイクロサービス、またはそのマイクロサービスを実行するインフラストラクチャーのコンポーネントの場合があります。 いずれかのエンティティーが App Configuration と対話するには、固有のエンティティー ID を提供する必要があります。

• entityAttributes: 指定されたエンティティーを定義する属性名とその値で構成される JSON オブジェクト。 フィーチャー・フラグがターゲット定義で構成されていない場合、これはオプション・パラメーターです。 ターゲットが構成されている場合は、ルール評価のために entityAttributes を指定する必要があります。 属性は、セグメントを定義するために使用されるパラメーターです。 SDK は、属性値を使用して、指定されたエンティティーがターゲット・ルールを満たしているかどうかを判別し、適切なフィーチャー・フラグ値を返します。

単一のプロパティーを取得する

const property = appConfigClient.getProperty('property_id'); // property can be null incase of an invalid property id

if (property != null) {
  console.log(`Property Name ${property.getPropertyName()} `);
  console.log(`Property Id ${property.getPropertyId()} `);
  console.log(`Property Type ${property.getPropertyDataType()} `);
}

すべてのプロパティーを取得する

const properties = appConfigClient.getProperties();
const property = properties['property_id'];

if (property != null) {
  console.log(`Property Name ${property.getPropertyName()} `);
  console.log(`Property Id ${property.getPropertyId()} `);
  console.log(`Property Type ${property.getPropertyDataType()} `);
}

プロパティーの評価

property.getCurrentValue(entityId, entityAttributes) メソッドを使用して、プロパティーの値を評価できます。 このメソッドは、評価された値と評価の詳細を含む JSON オブジェクトを返します。

const entityId = '<entityId>';
const entityAttributes = {
  city: 'Bangalore',
  country: 'India',
};

const result = property.getCurrentValue(entityId, entityAttributes);
console.log(result.value); // Evaluated value of the property. The type of evaluated value will match the type of property (Boolean, String, Numeric).
console.log(result.details); // a JSON object containing detailed information of the evaluation. See below

// the `result.details` will have the following
console.log(result.details.valueType); // a string value. Example: DEFAULT_VALUE
console.log(result.details.reason); // a string value. Example: Default value of the property.
console.log(result.details.segmentName); // (only if applicable, else it is undefined) a string value containing the segment name for which the property was evaluated.
console.log(result.details.errorType); // (only if applicable, else it is undefined) contains the error.message if any error was occured during the evaluation.

• entityId: エンティティーの ID。 これは、プロパティーが評価されるエンティティーに関連するストリング ID です。 例えば、エンティティーは、モバイル・デバイス上で実行されるアプリのインスタンス、クラウド上で実行されるマイクロサービス、またはそのマイクロサービスを実行するインフラストラクチャーのコンポーネントの場合があります。 いずれかのエンティティーが App Configuration と対話するには、固有のエンティティー ID を提供する必要があります。

• entityAttributes: 指定されたエンティティーを定義する属性名とその値で構成される JSON オブジェクト。 プロパティーがターゲット定義で構成されていない場合、これはオプション・パラメーターです。 ターゲットが構成されている場合は、ルール評価のために entityAttributes を指定する必要があります。 属性は、セグメントを定義するために使用されるパラメーターです。 SDK は、属性値を使用して、指定されたエンティティーがターゲット・ルールを満たしているかどうかを判別し、適切なプロパティー値を返します。

シークレット・プロパティーの取得

App Configurationに保管されている秘密参照を明示的に取得する方法。

const secretPropertyObject = appConfigClient.getSecret(propertyId, secretsManagerObject);

ここでは、

• propertyID: propertyID は固有のストリング ID です。これを使用すると、シークレットをフェッチするために必要なデータを提供するプロパティーをフェッチできます。

• secretsManagerObject: secretsManagerObject は、シークレット・プロパティーの評価時にシークレットを取得するために使用される Secrets Manager クライアント・オブジェクトです。 Secrets Manager クライアント・オブジェクトの作成方法について詳しくは、 こちらを参照してください。

シークレット・プロパティーの評価

secretPropertyObject.getCurrentValue(entityId, entityAttributes) メソッドを使用して、secret プロパティーの値を評価します。 このメソッド呼び出しの出力は、フィーチャーおよびプロパティー・オブジェクトを使用して開始された getCurrentValue とは異なります。 このメソッドは、 Secrets Manager からの応答で解決するか、エラーで拒否する Promise を返します。 解決される値は、評価されたシークレット参照の実際のシークレット値です。 応答には、本文、ヘッダー、状況コード、および状況テキストが含まれます。 async または await を使用している場合は、try または catch を使用してエラーを処理してください。

const entityId = 'john_doe';
const entityAttributes = {
   city: 'Bangalore',
   country: 'India',
};
try {
   const res = await secretPropertyObject.getCurrentValue(entityId, entityAttributes);
   console.log(JSON.stringify(res, null, 2)); // view entire response.
   console.log('Resulting secret:\n', res.result.resources[0].secret_data.payload); // the actual secret value.
} catch (err) {
   // handle the error
}

ここでは、

• entityId: entityId は、プロパティーの評価対象となるエンティティーに関連するストリング ID です。 たとえば、エンティティとは、モバイルデバイス上で動作するアプリケーションのインスタンス、クラウド上で動作するマイクロサービス、あるいはそのマイクロサービスを実行するインフラストラクチャのコンポーネントなどを指す場合があります。 いずれかのエンティティーが App Configuration と対話するには、固有のエンティティー ID を提供する必要があります。

• entityAttributes: entityAttributes は、指定されたエンティティーを定義する属性名とその値で構成される、タイプ map[string]interface{} のマップです。 プロパティーがターゲット定義で構成されていない場合、これはオプション・パラメーターです。 ターゲットが構成されている場合は、ルール評価のために entityAttributes を指定する必要があります。 属性は、セグメントを定義するために使用されるパラメーターです。 SDK は属性値を使用して、指定されたエンティティーがターゲット・ルールを満たしているかどうかを判別し、適切な値を返します。