Reference documentation and code samples for the Chronicle V1 API class Google::Cloud::Chronicle::V1::CustomAPIRequestConfig.
Configuration for the outgoing API request.
Inherits
- Object
Extended By
- Google::Protobuf::MessageExts::ClassMethods
Includes
- Google::Protobuf::MessageExts
Methods
#custom_headers
def custom_headers() -> ::Array<::Google::Cloud::Chronicle::V1::HeaderKeyValue>
Returns
- (::Array<::Google::Cloud::Chronicle::V1::HeaderKeyValue>) — Optional. Define specialized key-value pairs sent with the request, often used for custom API versioning or specific vendor requirements.
#custom_headers=
def custom_headers=(value) -> ::Array<::Google::Cloud::Chronicle::V1::HeaderKeyValue>
Parameter
- value (::Array<::Google::Cloud::Chronicle::V1::HeaderKeyValue>) — Optional. Define specialized key-value pairs sent with the request, often used for custom API versioning or specific vendor requirements.
Returns
- (::Array<::Google::Cloud::Chronicle::V1::HeaderKeyValue>) — Optional. Define specialized key-value pairs sent with the request, often used for custom API versioning or specific vendor requirements.
#endpoint_path
def endpoint_path() -> ::String
Returns
- (::String) — Required. Enter the specific API route appended to the Base URL to fetch the data (e.g., /v1/alerts).
#endpoint_path=
def endpoint_path=(value) -> ::String
Parameter
- value (::String) — Required. Enter the specific API route appended to the Base URL to fetch the data (e.g., /v1/alerts).
Returns
- (::String) — Required. Enter the specific API route appended to the Base URL to fetch the data (e.g., /v1/alerts).
#http_method
def http_method() -> ::Google::Cloud::Chronicle::V1::CustomAPIRequestConfig::HttpMethod
Returns
- (::Google::Cloud::Chronicle::V1::CustomAPIRequestConfig::HttpMethod) — Required. Select the type of action to perform on the API endpoint (usually GET to retrieve data or POST to submit a query).
#http_method=
def http_method=(value) -> ::Google::Cloud::Chronicle::V1::CustomAPIRequestConfig::HttpMethod
Parameter
- value (::Google::Cloud::Chronicle::V1::CustomAPIRequestConfig::HttpMethod) — Required. Select the type of action to perform on the API endpoint (usually GET to retrieve data or POST to submit a query).
Returns
- (::Google::Cloud::Chronicle::V1::CustomAPIRequestConfig::HttpMethod) — Required. Select the type of action to perform on the API endpoint (usually GET to retrieve data or POST to submit a query).
#max_requests_per_minute
def max_requests_per_minute() -> ::Integer
Returns
- (::Integer) — Optional. Set a safety limit to ensure the connector does not exceed the third-party vendor's API rate limits.
#max_requests_per_minute=
def max_requests_per_minute=(value) -> ::Integer
Parameter
- value (::Integer) — Optional. Set a safety limit to ensure the connector does not exceed the third-party vendor's API rate limits.
Returns
- (::Integer) — Optional. Set a safety limit to ensure the connector does not exceed the third-party vendor's API rate limits.
#query_parameters
def query_parameters() -> ::Array<::Google::Cloud::Chronicle::V1::HeaderKeyValue>
Returns
- (::Array<::Google::Cloud::Chronicle::V1::HeaderKeyValue>) — Optional. Add extra filters or settings appended to the end of the URL (e.g., ?status=critical).
#query_parameters=
def query_parameters=(value) -> ::Array<::Google::Cloud::Chronicle::V1::HeaderKeyValue>
Parameter
- value (::Array<::Google::Cloud::Chronicle::V1::HeaderKeyValue>) — Optional. Add extra filters or settings appended to the end of the URL (e.g., ?status=critical).
Returns
- (::Array<::Google::Cloud::Chronicle::V1::HeaderKeyValue>) — Optional. Add extra filters or settings appended to the end of the URL (e.g., ?status=critical).
#request_body
def request_body() -> ::String
Returns
- (::String) — Optional. Provide the data payload sent to the API to specify what information you want, typically formatted in JSON.
#request_body=
def request_body=(value) -> ::String
Parameter
- value (::String) — Optional. Provide the data payload sent to the API to specify what information you want, typically formatted in JSON.
Returns
- (::String) — Optional. Provide the data payload sent to the API to specify what information you want, typically formatted in JSON.