AWS Contexto de comportamiento Reflexiones - Lumberyard Guía del usuario

Si proporcionásemos una traducción de la versión en inglés de la guía, prevalecerá la versión en inglés de la guía si hubiese algún conflicto. La traducción se proporciona mediante traducción automática.

AWS Contexto de comportamiento Reflexiones

La gema CloudGemAWSScriptBehaviors utiliza el contexto de comportamiento para exponer AWS servicios como como Amazon Cognitode AWS Lambdade Amazon S3y utilidades HTTP para del archivo de comandos. El\dev\CloudGemSamples\Scripts El directorio tiene código Lua de muestra para cada reflexión. Para probar los ejemplos, ejecute el nivel AWSBehaviorExamples en CloudGemSamples. del proyecto.

API de Servicio

Las reflexiones de contexto de comportamiento de servicio de API incluyen una clase y EBus que interactúan con Amazon API Gateway.

Clase AWSBehaviorAPI

Llama a métodos expuestos a través de la Amazon API Gateway servicio técnico. La clase firma correctamente con las credenciales adecuadas en una solicitud HTTP. La clase traduce la lógica nombres de recursos en Cloud Canvas a nombres físicos. Esto hace que la clase sea fácil de usar con otros las gemas en la nube.

Properties
Propiedad Descripción
string HTTPMethod Especifica el método HTTP que llama a la API. Este string es API específico de. Las cadenas válidas son: GETde POST, DELETEde PUT, y PATCH.
string Query Una consulta de URL estándar string que pasa parámetros a la API. Este string es solo la parte de consulta y función de la URL y tiene el formato player/messages?time=now&lang=eng.
string ResourceName Especifica el nombre de recurso lógico de la API que llamar a. Solo acepta API Gateway Nombres de recursos de. Devuelve un error si se especifican otros tipos de recursos.
Methods
Método Descripción
void Execute() : realiza la solicitud HTTP con las propiedades especificadas.

AWSBehaviorAPINotificationsBus

El AWSBehaviorAPINotificationsBus tiene los siguientes métodos.

Methods
Método Descripción
void GetResponse(int responseCode, string responseData) Se llama cuando la solicitud devuelve una respuesta. El responseCode El parámetro contiene el código de respuesta HTTP; el parámetro responseData parámetro contiene los datos de respuesta, que a menudo es una cadena JSON.
void OnError(string requestBody) Se llama cuando la llamada a la API falla. El requestBody parámetro contiene el cuerpo de la solicitud.
void OnSuccess(string resultBody) Se llama cuando la llamada a la API se realiza correctamente. El resultBody parámetro contiene el cuerpo de respuesta de la solicitud.

Lambda Servicio

Las reflexiones de contexto de comportamiento de servicio Lambda incluyen una clase y EBus que interactúan con AWS Lambda.

Clase AWSLambda

Llama a un AWS Lambda función.

Properties
Propiedad Descripción
string functionName El nombre de la función lógica en Cloud Canvas que desea invocar.
string requestBody Opcional. Especifica los parámetros de solicitud que se van a pasar a Lambda invocación.
Methods
Método Descripción
void InvokeAWSLambda() Invoca el especificado Lambda función.

AWSLambdaHandler

El AWSLambdaHandler El EBus tiene los siguientes métodos.

Methods
Método Descripción
void OnError(string errorBody) Se llama cuando el Lambda La invocación de produce un error. El errorBody parámetro contiene la información que se devolvió en la respuesta de error de Lambda.
void OnSuccess(string resultBody) Se llama cuando el Lambda La invocación de se realiza correctamente. El resultBody El parámetro contiene la información devuelta por el Lambda función, si la hay.

[EMPTY] Servicio

Las reflexiones de contexto de comportamiento de S3 incluyen clases y EBuses que interactúan con Amazon S3.

Clase AWSBehaviorS3Upload

Carga un archivo local en un Amazon S3 del bucket de.

Properties
Propiedad Descripción
string bucketName Especifica el nombre lógico en Cloud Canvas para el destino Amazon S3 del bucket de.
string contentType Especifica el tipo de archivo MIME del archivo que se va a cargar.
string keyName Especifica la clave de destino para el archivo. La clave de destino es el archivo nombre que aparece en Amazon S3 y deben ser únicos para el bucket.
string localFileName Especifica el nombre de ruta completo del archivo local que se va a cargado.
Methods
Método Descripción
void Upload() Carga el archivo con las propiedades especificadas.

AWSBehaviorS3UploadNotificationsBus

El AWSBehaviorS3UploadNotificationsBus tiene los siguientes métodos.

Methods
Método Descripción
void OnError(string errorBody) Se llama cuando la carga del archivo falla. El errorBody parámetro contiene la información de error devuelta por Amazon S3, si lo hay.
void OnSuccess(string resultBody) Se llama cuando la carga del archivo se realiza correctamente. El resultBody parámetro contiene la información que devuelve Amazon S3, si lo hay.

Clase AWSBehaviorS3Download

Descarga un archivo de un Amazon S3 del bucket de al sistema de archivos local.

Properties
Propiedad Descripción
string bucketName Especifica el nombre lógico en Cloud Canvas para Amazon S3 del bucket de origen de.
string keyName Especifica el nombre de clave (el nombre de archivo) del Amazon S3 archivo de origen.
string localFileName Especifica la ruta completa de la ubicación en la que se ha descargado el archivo está escrito.
Methods
Método Descripción
void Download() Descarga el archivo con las propiedades especificadas.

AWSBehaviorS3DownloadNotificationsBus

El AWSBehaviorS3DownloadNotificationsBus tiene lo siguiente métodos.

Methods
Método
void OnError(string errorBody) Se llama cuando la descarga del archivo falla. El errorBody parámetro contiene información de error devuelta por Amazon S3.
void OnSuccess(string resultBody) Se llama cuando la descarga del archivo se realiza correctamente. El resultBody parámetro contiene información devuelta por Amazon S3.

Clase AWSBehaviorS3Presign

Proporciona una URL prefirmada para una determinada Amazon S3 del archivo. Esta es una URL que se puede compartir que permite el acceso autenticado al archivo especificado.

Properties
Propiedad Descripción
string bucketName Especifica el nombre lógico en Cloud Canvas para el bucket de S3 de destino.
string keyName Especifica el nombre de clave (el nombre de archivo) del destino Amazon S3 del archivo.
string requestMethod El método HTTP que se va a generar para la URL. Las cadenas válidas son PUT, POSTde DELETE, y GET.
Methods
Método Descripción
void Presign() Obtiene una URL prefirmada para el especificado Amazon S3 del archivo.

AWSBehaviorS3PresignNotificationsBus

El AWSBehaviorS3PresignNotificationsBus tiene lo siguiente métodos.

Methods
Método Descripción
void OnError(string errorBody) Se llama cuando la operación falla. El errorBody parámetro contiene información de error devuelta por Amazon S3.
void OnSuccess(string resultBody) Se llama cuando la operación se realiza correctamente. El resultBody parámetro contiene la URL prefirmada devuelta por Amazon S3.

Utilities

Las clases de utilidad y los EBuses proporcionan funcionalidad para HTTP, JSON, URL y cadena de las operaciones de.

Clase AWSBehaviorHTTP

El AWSBehaviorHTTP La clase implementa un HTTP simple de uso general GET solicite. Puede utilizar la clase para obtener cualquier página web o prefirmada Dirección URL.

Properties
Propiedad Descripción
string URL La URL para obtener.
Methods
Método Descripción
void Get() Obtiene la URL especificada por el URL propiedad.

AWSBehaviorHTTPNotificationsBus

El AWSBehaviorHTTPNotificationsBus tiene los siguientes métodos.

Methods
Método Descripción
void OnSuccess(string resultBody) Se llama cuando el GET La operación de se realiza correctamente. El resultBody El parámetro contiene el cuerpo de la respuesta de la solicitud.
void OnError(string errorBody) Se llama cuando el GET La operación falla. El errorBody El parámetro contiene el cuerpo del error.
void GetResponse(int responseCode, StringMap headerMap, string contentType, string responseBody)

Se llama cuando la solicitud devuelve una respuesta. Los parámetros contienen el siguiente información:

responseCode – El código de respuesta HTTP.

headerMap – Contiene toda la información del encabezado. Puede pasarse a un Mapa de cadena map propiedad.

contentType – Contiene el tipo de contenido MIME para el datos de respuesta de.

responseBody – Contiene los datos de respuesta en la cadena de formateo.

Código JSON Clase

Atraviesa y analiza los datos JSON. Esta clase lee pero no escribe datos JSON. Para escribir Los datos JSON utilizan las utilidades de cadena proporcionadas en el lenguaje que está utilizando.

Algunos idiomas no proporcionan compatibilidad con iteradores para JSON. Para acomodar estos idiomas, el JSON la clase mantiene un estado de valor actual que se actualiza a medida que atraviesa el árbol de datos JSON. Dado que los datos JSON constan de objetos y matrices, el el valor actual es el valor de la clave de objeto actual o el valor en el valor actual en la matriz. Para ver ejemplos, consulte el código de muestra en la \dev\CloudGemSamples\Scripts\AWSBehaviorJSONTest.lua del archivo.

El JSON La clase no tiene propiedades. La siguiente tabla muestra su métodos.

Methods
Método Descripción
int EnterArray() Si el valor actual es una matriz, establece el valor actual en el primer elemento de la matriz y devuelve el número de elementos de la matriz.
void EnterObject(string key) Si el valor actual es un objeto , establece el valor actual en el valor de clave especificada.
void ExitArray() Si el valor actual se estableció mediante EnterArray, establece la corriente valor a la matriz que se introdujo antes de la llamada a EnterArray.
void ExitCurrentObject() Si el valor actual se estableció mediante EnterObject, establece el valor actual al objeto que se introdujo antes de la llamada a EnterObject.
void FromString(string JSONString) Carga el objeto JSON desde una cadena JSON. Los errores de análisis se registran en consola de.
boolean GetBoolean() Si el valor actual es un valor booleano, devuelve el valor del valor booleano. Si el el valor actual no es un valor booleano, devuelve un valor falso.
double GetDouble() Si el valor actual es un doble, devuelve el valor del doble. Si el el valor actual no es un doble, devuelve 0.
integer GetInteger() Si el valor actual es un entero, devuelve el valor del entero. Si el el valor actual no es un entero, devuelve 0.
string GetString() Si el valor actual es una cadena, devuelve el valor de la cadena. Si el El valor actual no es una cadena, devuelve una cadena vacía.
boolean IsArray() Devuelve true solo si el valor actual es una matriz.
boolean IsBoolean() Devuelve true solo si el valor actual es un valor booleano.
boolean IsDouble() Devuelve true solo si el valor actual es un doble.
boolean IsInteger() Devuelve true solo si el valor actual es un entero.
boolean IsObject() Devuelve true solo si el valor actual es un objeto.
boolean IsString() Devuelve true solo si el valor actual es una cadena.
void LogToDebugger() Muestra todo el objeto JSON en la consola de en humano legible de formateo.
boolean NextArrayItem() Establece el valor actual en el siguiente elemento de la matriz. Si el elemento actual es el último elemento de la matriz , devuelve el valor falso.
string ToString() Devuelve todo el objeto JSON como una cadena.

La clase JSON no tiene EBus correspondiente.

Clase AWSBehaviorURL

El AWSBehaviorURL La clase proporciona la funcionalidad "Descodificación de URL". Se elimina cualquier carácter de escape de la URL especificada y devuelve la cadena resultante.

Properties
Propiedad Descripción
string URL La URL para descodificar.
Methods
Método Descripción
void Decode() Descodifica la URL especificada.

AWSBehaviorURLNotificationsBus

El AWSBehaviorURLNotificationsBus tiene los siguientes métodos.

Methods
Método Descripción
void OnError(string error) Se llama si la URL no se descodificó correctamente. El error El parámetro contiene los motivos del error.
void OnSuccess(string result) Se llama si la URL se descodificó correctamente. El result parámetro contiene la cadena descodificada.

Clase StringMap

Una sencilla asignación de clave de cadena–del valor de. El StringMap la clase es se utiliza con más frecuencia con el HTTP Get pero es útil para el mapa de cadena general de las operaciones de.

Properties
Propiedad Descripción
map Contiene un mapa de cadena que se recibió de otro método para que analiza.
Methods
Método Descripción
void Clear() Elimina todas las teclas–de valor de la asignación.
int GetSize() Devuelve el número de claves–los pares de valores almacenados actualmente en el mapear.
string GetValue(string key) Devuelve el valor en la clave especificada. Si la clave que se especificó no existe, devuelve una cadena vacía sin añadir la clave al mapa.
boolean HasKey(string key) Devuelve true si el mapa contiene la clave especificada.
void LogToDebugger() Muestra todas las teclas–del valor de la consola de.
void RemoveKey(string key) Elimina la clave–del par de valores del mapa que corresponde al valor clave. Si la clave especificada no existe, produce un error sin devolver un error.
void SetValue(string key, string value) Establece el valor de la clave especificada en el valor especificado. Si la clave no existen, la clave–El par de valores se añade al mapa. Si la clave existe, su el valor existente se sobrescribe con el valor especificado.

El StringMap La clase no tiene controladores de EBus correspondientes.