BaseOutput¶
-
class
oci.fleet_apps_management.models.BaseOutput(**kwargs)¶ Bases:
objectBase output.
Attributes
TYPE_ARRAYA constant which can be used with the type property of a BaseOutput. TYPE_BOOLEANA constant which can be used with the type property of a BaseOutput. TYPE_COPYABLESTRINGA constant which can be used with the type property of a BaseOutput. TYPE_CSVA constant which can be used with the type property of a BaseOutput. TYPE_JSONA constant which can be used with the type property of a BaseOutput. TYPE_LINKA constant which can be used with the type property of a BaseOutput. TYPE_LISTA constant which can be used with the type property of a BaseOutput. TYPE_MAPA constant which can be used with the type property of a BaseOutput. TYPE_NUMBERA constant which can be used with the type property of a BaseOutput. TYPE_OCIDA constant which can be used with the type property of a BaseOutput. TYPE_STRINGA constant which can be used with the type property of a BaseOutput. descriptionGets the description of this BaseOutput. formatGets the format of this BaseOutput. is_sensitiveGets the is_sensitive of this BaseOutput. titleGets the title of this BaseOutput. typeGets the type of this BaseOutput. visibleGets the visible of this BaseOutput. Methods
__init__(**kwargs)Initializes a new BaseOutput object with values from keyword arguments. get_subtype(object_dictionary)Given the hash representation of a subtype of this class, use the info in the hash to return the class of the subtype. -
TYPE_ARRAY= 'ARRAY'¶ A constant which can be used with the type property of a BaseOutput. This constant has a value of “ARRAY”
-
TYPE_BOOLEAN= 'BOOLEAN'¶ A constant which can be used with the type property of a BaseOutput. This constant has a value of “BOOLEAN”
-
TYPE_COPYABLESTRING= 'COPYABLESTRING'¶ A constant which can be used with the type property of a BaseOutput. This constant has a value of “COPYABLESTRING”
-
TYPE_CSV= 'CSV'¶ A constant which can be used with the type property of a BaseOutput. This constant has a value of “CSV”
-
TYPE_JSON= 'JSON'¶ A constant which can be used with the type property of a BaseOutput. This constant has a value of “JSON”
-
TYPE_LINK= 'LINK'¶ A constant which can be used with the type property of a BaseOutput. This constant has a value of “LINK”
-
TYPE_LIST= 'LIST'¶ A constant which can be used with the type property of a BaseOutput. This constant has a value of “LIST”
-
TYPE_MAP= 'MAP'¶ A constant which can be used with the type property of a BaseOutput. This constant has a value of “MAP”
-
TYPE_NUMBER= 'NUMBER'¶ A constant which can be used with the type property of a BaseOutput. This constant has a value of “NUMBER”
-
TYPE_OCID= 'OCID'¶ A constant which can be used with the type property of a BaseOutput. This constant has a value of “OCID”
-
TYPE_STRING= 'STRING'¶ A constant which can be used with the type property of a BaseOutput. This constant has a value of “STRING”
-
__init__(**kwargs)¶ Initializes a new BaseOutput object with values from keyword arguments. This class has the following subclasses and if you are using this class as input to a service operations then you should favor using a subclass over the base class:
ListOutputOcidOutputCsvOutputCopyableStringOutputJsonOutputNumberOutputStringOutputMapOutputLinkOutputBoolOutput
The following keyword arguments are supported (corresponding to the getters/setters of this class):
Parameters: - type (str) – The value to assign to the type property of this BaseOutput. Allowed values for this property are: “ARRAY”, “BOOLEAN”, “NUMBER”, “STRING”, “COPYABLESTRING”, “MAP”, “LIST”, “JSON”, “CSV”, “LINK”, “OCID”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
- title (str) – The value to assign to the title property of this BaseOutput.
- description (str) – The value to assign to the description property of this BaseOutput.
- is_sensitive (bool) – The value to assign to the is_sensitive property of this BaseOutput.
- format (str) – The value to assign to the format property of this BaseOutput.
- visible (str) – The value to assign to the visible property of this BaseOutput.
-
description¶ Gets the description of this BaseOutput. Extended help or summary for understanding output.
Returns: The description of this BaseOutput. Return type: str
-
format¶ Gets the format of this BaseOutput. Hint about formatting or rendering the output value.
Returns: The format of this BaseOutput. Return type: str
-
static
get_subtype(object_dictionary)¶ Given the hash representation of a subtype of this class, use the info in the hash to return the class of the subtype.
-
is_sensitive¶ Gets the is_sensitive of this BaseOutput. If true, marks this output as sensitive.
Returns: The is_sensitive of this BaseOutput. Return type: bool
-
title¶ Gets the title of this BaseOutput. Output label shown to the user.
Returns: The title of this BaseOutput. Return type: str
-
type¶ Gets the type of this BaseOutput. Data type of the output value (such as STRING, NUMBER, OCID, etc).
Allowed values for this property are: “ARRAY”, “BOOLEAN”, “NUMBER”, “STRING”, “COPYABLESTRING”, “MAP”, “LIST”, “JSON”, “CSV”, “LINK”, “OCID”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
Returns: The type of this BaseOutput. Return type: str
-
visible¶ Gets the visible of this BaseOutput. Expression to show/hide this output.
Returns: The visible of this BaseOutput. Return type: str
-