Class: Google::Cloud::ApiHub::V1::Attribute
- Inherits:
-
Object
- Object
- Google::Cloud::ApiHub::V1::Attribute
- Extended by:
- Protobuf::MessageExts::ClassMethods
- Includes:
- Protobuf::MessageExts
- Defined in:
- proto_docs/google/cloud/apihub/v1/common_fields.rb
Overview
An attribute in the API Hub. An attribute is a name value pair which can be attached to different resources in the API hub based on the scope of the attribute. Attributes can either be pre-defined by the API Hub or created by users.
Defined Under Namespace
Modules: DataType, DefinitionType, Scope Classes: AllowedValue
Instance Attribute Summary collapse
-
#allowed_values ⇒ ::Array<::Google::Cloud::ApiHub::V1::Attribute::AllowedValue>
Optional.
-
#cardinality ⇒ ::Integer
Optional.
-
#create_time ⇒ ::Google::Protobuf::Timestamp
readonly
Output only.
-
#data_type ⇒ ::Google::Cloud::ApiHub::V1::Attribute::DataType
Required.
-
#definition_type ⇒ ::Google::Cloud::ApiHub::V1::Attribute::DefinitionType
readonly
Output only.
-
#description ⇒ ::String
Optional.
-
#display_name ⇒ ::String
Required.
-
#mandatory ⇒ ::Boolean
readonly
Output only.
-
#name ⇒ ::String
Identifier.
-
#scope ⇒ ::Google::Cloud::ApiHub::V1::Attribute::Scope
Required.
-
#update_time ⇒ ::Google::Protobuf::Timestamp
readonly
Output only.
Instance Attribute Details
#allowed_values ⇒ ::Array<::Google::Cloud::ApiHub::V1::Attribute::AllowedValue>
Returns Optional. The list of allowed values when the attribute value is of type enum. This is required when the data_type of the attribute is ENUM. The maximum number of allowed values of an attribute will be 1000.
571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 |
# File 'proto_docs/google/cloud/apihub/v1/common_fields.rb', line 571 class Attribute include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # The value that can be assigned to the attribute when the data type is # enum. # @!attribute [rw] id # @return [::String] # Required. The ID of the allowed value. # * If provided, the same will be used. The service will throw an error if # the specified id is already used by another allowed value in the same # attribute resource. # * If not provided, a system generated id derived from the display name # will be used. In this case, the service will handle conflict resolution # by adding a system generated suffix in case of duplicates. # # This value should be 4-63 characters, and valid characters # are /[a-z][0-9]-/. # @!attribute [rw] display_name # @return [::String] # Required. The display name of the allowed value. # @!attribute [rw] description # @return [::String] # Optional. The detailed description of the allowed value. # @!attribute [rw] immutable # @return [::Boolean] # Optional. When set to true, the allowed value cannot be updated or # deleted by the user. It can only be true for System defined attributes. class AllowedValue include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Enumeration of attribute definition types. module DefinitionType # Attribute definition type unspecified. DEFINITION_TYPE_UNSPECIFIED = 0 # The attribute is predefined by the API Hub. Note that only the list of # allowed values can be updated in this case via UpdateAttribute method. SYSTEM_DEFINED = 1 # The attribute is defined by the user. USER_DEFINED = 2 end # Enumeration for the scope of the attribute representing the resource in the # API Hub to which the attribute can be linked. module Scope # Scope Unspecified. SCOPE_UNSPECIFIED = 0 # Attribute can be linked to an API. API = 1 # Attribute can be linked to an API version. VERSION = 2 # Attribute can be linked to a Spec. SPEC = 3 # Attribute can be linked to an API Operation. API_OPERATION = 4 # Attribute can be linked to a Deployment. DEPLOYMENT = 5 # Attribute can be linked to a Dependency. DEPENDENCY = 6 # Attribute can be linked to a definition. DEFINITION = 7 # Attribute can be linked to a ExternalAPI. EXTERNAL_API = 8 # Attribute can be linked to a Plugin. PLUGIN = 9 end # Enumeration of attribute's data type. module DataType # Attribute data type unspecified. DATA_TYPE_UNSPECIFIED = 0 # Attribute's value is of type enum. ENUM = 1 # Attribute's value is of type json. JSON = 2 # Attribute's value is of type string. STRING = 3 end end |
#cardinality ⇒ ::Integer
Returns Optional. The maximum number of values that the attribute can have when associated with an API Hub resource. Cardinality 1 would represent a single-valued attribute. It must not be less than 1 or greater than 20. If not specified, the cardinality would be set to 1 by default and represent a single-valued attribute.
571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 |
# File 'proto_docs/google/cloud/apihub/v1/common_fields.rb', line 571 class Attribute include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # The value that can be assigned to the attribute when the data type is # enum. # @!attribute [rw] id # @return [::String] # Required. The ID of the allowed value. # * If provided, the same will be used. The service will throw an error if # the specified id is already used by another allowed value in the same # attribute resource. # * If not provided, a system generated id derived from the display name # will be used. In this case, the service will handle conflict resolution # by adding a system generated suffix in case of duplicates. # # This value should be 4-63 characters, and valid characters # are /[a-z][0-9]-/. # @!attribute [rw] display_name # @return [::String] # Required. The display name of the allowed value. # @!attribute [rw] description # @return [::String] # Optional. The detailed description of the allowed value. # @!attribute [rw] immutable # @return [::Boolean] # Optional. When set to true, the allowed value cannot be updated or # deleted by the user. It can only be true for System defined attributes. class AllowedValue include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Enumeration of attribute definition types. module DefinitionType # Attribute definition type unspecified. DEFINITION_TYPE_UNSPECIFIED = 0 # The attribute is predefined by the API Hub. Note that only the list of # allowed values can be updated in this case via UpdateAttribute method. SYSTEM_DEFINED = 1 # The attribute is defined by the user. USER_DEFINED = 2 end # Enumeration for the scope of the attribute representing the resource in the # API Hub to which the attribute can be linked. module Scope # Scope Unspecified. SCOPE_UNSPECIFIED = 0 # Attribute can be linked to an API. API = 1 # Attribute can be linked to an API version. VERSION = 2 # Attribute can be linked to a Spec. SPEC = 3 # Attribute can be linked to an API Operation. API_OPERATION = 4 # Attribute can be linked to a Deployment. DEPLOYMENT = 5 # Attribute can be linked to a Dependency. DEPENDENCY = 6 # Attribute can be linked to a definition. DEFINITION = 7 # Attribute can be linked to a ExternalAPI. EXTERNAL_API = 8 # Attribute can be linked to a Plugin. PLUGIN = 9 end # Enumeration of attribute's data type. module DataType # Attribute data type unspecified. DATA_TYPE_UNSPECIFIED = 0 # Attribute's value is of type enum. ENUM = 1 # Attribute's value is of type json. JSON = 2 # Attribute's value is of type string. STRING = 3 end end |
#create_time ⇒ ::Google::Protobuf::Timestamp (readonly)
Returns Output only. The time at which the attribute was created.
571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 |
# File 'proto_docs/google/cloud/apihub/v1/common_fields.rb', line 571 class Attribute include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # The value that can be assigned to the attribute when the data type is # enum. # @!attribute [rw] id # @return [::String] # Required. The ID of the allowed value. # * If provided, the same will be used. The service will throw an error if # the specified id is already used by another allowed value in the same # attribute resource. # * If not provided, a system generated id derived from the display name # will be used. In this case, the service will handle conflict resolution # by adding a system generated suffix in case of duplicates. # # This value should be 4-63 characters, and valid characters # are /[a-z][0-9]-/. # @!attribute [rw] display_name # @return [::String] # Required. The display name of the allowed value. # @!attribute [rw] description # @return [::String] # Optional. The detailed description of the allowed value. # @!attribute [rw] immutable # @return [::Boolean] # Optional. When set to true, the allowed value cannot be updated or # deleted by the user. It can only be true for System defined attributes. class AllowedValue include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Enumeration of attribute definition types. module DefinitionType # Attribute definition type unspecified. DEFINITION_TYPE_UNSPECIFIED = 0 # The attribute is predefined by the API Hub. Note that only the list of # allowed values can be updated in this case via UpdateAttribute method. SYSTEM_DEFINED = 1 # The attribute is defined by the user. USER_DEFINED = 2 end # Enumeration for the scope of the attribute representing the resource in the # API Hub to which the attribute can be linked. module Scope # Scope Unspecified. SCOPE_UNSPECIFIED = 0 # Attribute can be linked to an API. API = 1 # Attribute can be linked to an API version. VERSION = 2 # Attribute can be linked to a Spec. SPEC = 3 # Attribute can be linked to an API Operation. API_OPERATION = 4 # Attribute can be linked to a Deployment. DEPLOYMENT = 5 # Attribute can be linked to a Dependency. DEPENDENCY = 6 # Attribute can be linked to a definition. DEFINITION = 7 # Attribute can be linked to a ExternalAPI. EXTERNAL_API = 8 # Attribute can be linked to a Plugin. PLUGIN = 9 end # Enumeration of attribute's data type. module DataType # Attribute data type unspecified. DATA_TYPE_UNSPECIFIED = 0 # Attribute's value is of type enum. ENUM = 1 # Attribute's value is of type json. JSON = 2 # Attribute's value is of type string. STRING = 3 end end |
#data_type ⇒ ::Google::Cloud::ApiHub::V1::Attribute::DataType
Returns Required. The type of the data of the attribute.
571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 |
# File 'proto_docs/google/cloud/apihub/v1/common_fields.rb', line 571 class Attribute include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # The value that can be assigned to the attribute when the data type is # enum. # @!attribute [rw] id # @return [::String] # Required. The ID of the allowed value. # * If provided, the same will be used. The service will throw an error if # the specified id is already used by another allowed value in the same # attribute resource. # * If not provided, a system generated id derived from the display name # will be used. In this case, the service will handle conflict resolution # by adding a system generated suffix in case of duplicates. # # This value should be 4-63 characters, and valid characters # are /[a-z][0-9]-/. # @!attribute [rw] display_name # @return [::String] # Required. The display name of the allowed value. # @!attribute [rw] description # @return [::String] # Optional. The detailed description of the allowed value. # @!attribute [rw] immutable # @return [::Boolean] # Optional. When set to true, the allowed value cannot be updated or # deleted by the user. It can only be true for System defined attributes. class AllowedValue include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Enumeration of attribute definition types. module DefinitionType # Attribute definition type unspecified. DEFINITION_TYPE_UNSPECIFIED = 0 # The attribute is predefined by the API Hub. Note that only the list of # allowed values can be updated in this case via UpdateAttribute method. SYSTEM_DEFINED = 1 # The attribute is defined by the user. USER_DEFINED = 2 end # Enumeration for the scope of the attribute representing the resource in the # API Hub to which the attribute can be linked. module Scope # Scope Unspecified. SCOPE_UNSPECIFIED = 0 # Attribute can be linked to an API. API = 1 # Attribute can be linked to an API version. VERSION = 2 # Attribute can be linked to a Spec. SPEC = 3 # Attribute can be linked to an API Operation. API_OPERATION = 4 # Attribute can be linked to a Deployment. DEPLOYMENT = 5 # Attribute can be linked to a Dependency. DEPENDENCY = 6 # Attribute can be linked to a definition. DEFINITION = 7 # Attribute can be linked to a ExternalAPI. EXTERNAL_API = 8 # Attribute can be linked to a Plugin. PLUGIN = 9 end # Enumeration of attribute's data type. module DataType # Attribute data type unspecified. DATA_TYPE_UNSPECIFIED = 0 # Attribute's value is of type enum. ENUM = 1 # Attribute's value is of type json. JSON = 2 # Attribute's value is of type string. STRING = 3 end end |
#definition_type ⇒ ::Google::Cloud::ApiHub::V1::Attribute::DefinitionType (readonly)
Returns Output only. The definition type of the attribute.
571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 |
# File 'proto_docs/google/cloud/apihub/v1/common_fields.rb', line 571 class Attribute include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # The value that can be assigned to the attribute when the data type is # enum. # @!attribute [rw] id # @return [::String] # Required. The ID of the allowed value. # * If provided, the same will be used. The service will throw an error if # the specified id is already used by another allowed value in the same # attribute resource. # * If not provided, a system generated id derived from the display name # will be used. In this case, the service will handle conflict resolution # by adding a system generated suffix in case of duplicates. # # This value should be 4-63 characters, and valid characters # are /[a-z][0-9]-/. # @!attribute [rw] display_name # @return [::String] # Required. The display name of the allowed value. # @!attribute [rw] description # @return [::String] # Optional. The detailed description of the allowed value. # @!attribute [rw] immutable # @return [::Boolean] # Optional. When set to true, the allowed value cannot be updated or # deleted by the user. It can only be true for System defined attributes. class AllowedValue include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Enumeration of attribute definition types. module DefinitionType # Attribute definition type unspecified. DEFINITION_TYPE_UNSPECIFIED = 0 # The attribute is predefined by the API Hub. Note that only the list of # allowed values can be updated in this case via UpdateAttribute method. SYSTEM_DEFINED = 1 # The attribute is defined by the user. USER_DEFINED = 2 end # Enumeration for the scope of the attribute representing the resource in the # API Hub to which the attribute can be linked. module Scope # Scope Unspecified. SCOPE_UNSPECIFIED = 0 # Attribute can be linked to an API. API = 1 # Attribute can be linked to an API version. VERSION = 2 # Attribute can be linked to a Spec. SPEC = 3 # Attribute can be linked to an API Operation. API_OPERATION = 4 # Attribute can be linked to a Deployment. DEPLOYMENT = 5 # Attribute can be linked to a Dependency. DEPENDENCY = 6 # Attribute can be linked to a definition. DEFINITION = 7 # Attribute can be linked to a ExternalAPI. EXTERNAL_API = 8 # Attribute can be linked to a Plugin. PLUGIN = 9 end # Enumeration of attribute's data type. module DataType # Attribute data type unspecified. DATA_TYPE_UNSPECIFIED = 0 # Attribute's value is of type enum. ENUM = 1 # Attribute's value is of type json. JSON = 2 # Attribute's value is of type string. STRING = 3 end end |
#description ⇒ ::String
Returns Optional. The description of the attribute.
571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 |
# File 'proto_docs/google/cloud/apihub/v1/common_fields.rb', line 571 class Attribute include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # The value that can be assigned to the attribute when the data type is # enum. # @!attribute [rw] id # @return [::String] # Required. The ID of the allowed value. # * If provided, the same will be used. The service will throw an error if # the specified id is already used by another allowed value in the same # attribute resource. # * If not provided, a system generated id derived from the display name # will be used. In this case, the service will handle conflict resolution # by adding a system generated suffix in case of duplicates. # # This value should be 4-63 characters, and valid characters # are /[a-z][0-9]-/. # @!attribute [rw] display_name # @return [::String] # Required. The display name of the allowed value. # @!attribute [rw] description # @return [::String] # Optional. The detailed description of the allowed value. # @!attribute [rw] immutable # @return [::Boolean] # Optional. When set to true, the allowed value cannot be updated or # deleted by the user. It can only be true for System defined attributes. class AllowedValue include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Enumeration of attribute definition types. module DefinitionType # Attribute definition type unspecified. DEFINITION_TYPE_UNSPECIFIED = 0 # The attribute is predefined by the API Hub. Note that only the list of # allowed values can be updated in this case via UpdateAttribute method. SYSTEM_DEFINED = 1 # The attribute is defined by the user. USER_DEFINED = 2 end # Enumeration for the scope of the attribute representing the resource in the # API Hub to which the attribute can be linked. module Scope # Scope Unspecified. SCOPE_UNSPECIFIED = 0 # Attribute can be linked to an API. API = 1 # Attribute can be linked to an API version. VERSION = 2 # Attribute can be linked to a Spec. SPEC = 3 # Attribute can be linked to an API Operation. API_OPERATION = 4 # Attribute can be linked to a Deployment. DEPLOYMENT = 5 # Attribute can be linked to a Dependency. DEPENDENCY = 6 # Attribute can be linked to a definition. DEFINITION = 7 # Attribute can be linked to a ExternalAPI. EXTERNAL_API = 8 # Attribute can be linked to a Plugin. PLUGIN = 9 end # Enumeration of attribute's data type. module DataType # Attribute data type unspecified. DATA_TYPE_UNSPECIFIED = 0 # Attribute's value is of type enum. ENUM = 1 # Attribute's value is of type json. JSON = 2 # Attribute's value is of type string. STRING = 3 end end |
#display_name ⇒ ::String
Returns Required. The display name of the attribute.
571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 |
# File 'proto_docs/google/cloud/apihub/v1/common_fields.rb', line 571 class Attribute include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # The value that can be assigned to the attribute when the data type is # enum. # @!attribute [rw] id # @return [::String] # Required. The ID of the allowed value. # * If provided, the same will be used. The service will throw an error if # the specified id is already used by another allowed value in the same # attribute resource. # * If not provided, a system generated id derived from the display name # will be used. In this case, the service will handle conflict resolution # by adding a system generated suffix in case of duplicates. # # This value should be 4-63 characters, and valid characters # are /[a-z][0-9]-/. # @!attribute [rw] display_name # @return [::String] # Required. The display name of the allowed value. # @!attribute [rw] description # @return [::String] # Optional. The detailed description of the allowed value. # @!attribute [rw] immutable # @return [::Boolean] # Optional. When set to true, the allowed value cannot be updated or # deleted by the user. It can only be true for System defined attributes. class AllowedValue include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Enumeration of attribute definition types. module DefinitionType # Attribute definition type unspecified. DEFINITION_TYPE_UNSPECIFIED = 0 # The attribute is predefined by the API Hub. Note that only the list of # allowed values can be updated in this case via UpdateAttribute method. SYSTEM_DEFINED = 1 # The attribute is defined by the user. USER_DEFINED = 2 end # Enumeration for the scope of the attribute representing the resource in the # API Hub to which the attribute can be linked. module Scope # Scope Unspecified. SCOPE_UNSPECIFIED = 0 # Attribute can be linked to an API. API = 1 # Attribute can be linked to an API version. VERSION = 2 # Attribute can be linked to a Spec. SPEC = 3 # Attribute can be linked to an API Operation. API_OPERATION = 4 # Attribute can be linked to a Deployment. DEPLOYMENT = 5 # Attribute can be linked to a Dependency. DEPENDENCY = 6 # Attribute can be linked to a definition. DEFINITION = 7 # Attribute can be linked to a ExternalAPI. EXTERNAL_API = 8 # Attribute can be linked to a Plugin. PLUGIN = 9 end # Enumeration of attribute's data type. module DataType # Attribute data type unspecified. DATA_TYPE_UNSPECIFIED = 0 # Attribute's value is of type enum. ENUM = 1 # Attribute's value is of type json. JSON = 2 # Attribute's value is of type string. STRING = 3 end end |
#mandatory ⇒ ::Boolean (readonly)
Returns Output only. When mandatory is true, the attribute is mandatory for the resource specified in the scope. Only System defined attributes can be mandatory.
571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 |
# File 'proto_docs/google/cloud/apihub/v1/common_fields.rb', line 571 class Attribute include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # The value that can be assigned to the attribute when the data type is # enum. # @!attribute [rw] id # @return [::String] # Required. The ID of the allowed value. # * If provided, the same will be used. The service will throw an error if # the specified id is already used by another allowed value in the same # attribute resource. # * If not provided, a system generated id derived from the display name # will be used. In this case, the service will handle conflict resolution # by adding a system generated suffix in case of duplicates. # # This value should be 4-63 characters, and valid characters # are /[a-z][0-9]-/. # @!attribute [rw] display_name # @return [::String] # Required. The display name of the allowed value. # @!attribute [rw] description # @return [::String] # Optional. The detailed description of the allowed value. # @!attribute [rw] immutable # @return [::Boolean] # Optional. When set to true, the allowed value cannot be updated or # deleted by the user. It can only be true for System defined attributes. class AllowedValue include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Enumeration of attribute definition types. module DefinitionType # Attribute definition type unspecified. DEFINITION_TYPE_UNSPECIFIED = 0 # The attribute is predefined by the API Hub. Note that only the list of # allowed values can be updated in this case via UpdateAttribute method. SYSTEM_DEFINED = 1 # The attribute is defined by the user. USER_DEFINED = 2 end # Enumeration for the scope of the attribute representing the resource in the # API Hub to which the attribute can be linked. module Scope # Scope Unspecified. SCOPE_UNSPECIFIED = 0 # Attribute can be linked to an API. API = 1 # Attribute can be linked to an API version. VERSION = 2 # Attribute can be linked to a Spec. SPEC = 3 # Attribute can be linked to an API Operation. API_OPERATION = 4 # Attribute can be linked to a Deployment. DEPLOYMENT = 5 # Attribute can be linked to a Dependency. DEPENDENCY = 6 # Attribute can be linked to a definition. DEFINITION = 7 # Attribute can be linked to a ExternalAPI. EXTERNAL_API = 8 # Attribute can be linked to a Plugin. PLUGIN = 9 end # Enumeration of attribute's data type. module DataType # Attribute data type unspecified. DATA_TYPE_UNSPECIFIED = 0 # Attribute's value is of type enum. ENUM = 1 # Attribute's value is of type json. JSON = 2 # Attribute's value is of type string. STRING = 3 end end |
#name ⇒ ::String
Returns Identifier. The name of the attribute in the API Hub.
Format:
projects/{project}/locations/{location}/attributes/{attribute}
.
571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 |
# File 'proto_docs/google/cloud/apihub/v1/common_fields.rb', line 571 class Attribute include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # The value that can be assigned to the attribute when the data type is # enum. # @!attribute [rw] id # @return [::String] # Required. The ID of the allowed value. # * If provided, the same will be used. The service will throw an error if # the specified id is already used by another allowed value in the same # attribute resource. # * If not provided, a system generated id derived from the display name # will be used. In this case, the service will handle conflict resolution # by adding a system generated suffix in case of duplicates. # # This value should be 4-63 characters, and valid characters # are /[a-z][0-9]-/. # @!attribute [rw] display_name # @return [::String] # Required. The display name of the allowed value. # @!attribute [rw] description # @return [::String] # Optional. The detailed description of the allowed value. # @!attribute [rw] immutable # @return [::Boolean] # Optional. When set to true, the allowed value cannot be updated or # deleted by the user. It can only be true for System defined attributes. class AllowedValue include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Enumeration of attribute definition types. module DefinitionType # Attribute definition type unspecified. DEFINITION_TYPE_UNSPECIFIED = 0 # The attribute is predefined by the API Hub. Note that only the list of # allowed values can be updated in this case via UpdateAttribute method. SYSTEM_DEFINED = 1 # The attribute is defined by the user. USER_DEFINED = 2 end # Enumeration for the scope of the attribute representing the resource in the # API Hub to which the attribute can be linked. module Scope # Scope Unspecified. SCOPE_UNSPECIFIED = 0 # Attribute can be linked to an API. API = 1 # Attribute can be linked to an API version. VERSION = 2 # Attribute can be linked to a Spec. SPEC = 3 # Attribute can be linked to an API Operation. API_OPERATION = 4 # Attribute can be linked to a Deployment. DEPLOYMENT = 5 # Attribute can be linked to a Dependency. DEPENDENCY = 6 # Attribute can be linked to a definition. DEFINITION = 7 # Attribute can be linked to a ExternalAPI. EXTERNAL_API = 8 # Attribute can be linked to a Plugin. PLUGIN = 9 end # Enumeration of attribute's data type. module DataType # Attribute data type unspecified. DATA_TYPE_UNSPECIFIED = 0 # Attribute's value is of type enum. ENUM = 1 # Attribute's value is of type json. JSON = 2 # Attribute's value is of type string. STRING = 3 end end |
#scope ⇒ ::Google::Cloud::ApiHub::V1::Attribute::Scope
Returns Required. The scope of the attribute. It represents the resource in the API Hub to which the attribute can be linked.
571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 |
# File 'proto_docs/google/cloud/apihub/v1/common_fields.rb', line 571 class Attribute include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # The value that can be assigned to the attribute when the data type is # enum. # @!attribute [rw] id # @return [::String] # Required. The ID of the allowed value. # * If provided, the same will be used. The service will throw an error if # the specified id is already used by another allowed value in the same # attribute resource. # * If not provided, a system generated id derived from the display name # will be used. In this case, the service will handle conflict resolution # by adding a system generated suffix in case of duplicates. # # This value should be 4-63 characters, and valid characters # are /[a-z][0-9]-/. # @!attribute [rw] display_name # @return [::String] # Required. The display name of the allowed value. # @!attribute [rw] description # @return [::String] # Optional. The detailed description of the allowed value. # @!attribute [rw] immutable # @return [::Boolean] # Optional. When set to true, the allowed value cannot be updated or # deleted by the user. It can only be true for System defined attributes. class AllowedValue include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Enumeration of attribute definition types. module DefinitionType # Attribute definition type unspecified. DEFINITION_TYPE_UNSPECIFIED = 0 # The attribute is predefined by the API Hub. Note that only the list of # allowed values can be updated in this case via UpdateAttribute method. SYSTEM_DEFINED = 1 # The attribute is defined by the user. USER_DEFINED = 2 end # Enumeration for the scope of the attribute representing the resource in the # API Hub to which the attribute can be linked. module Scope # Scope Unspecified. SCOPE_UNSPECIFIED = 0 # Attribute can be linked to an API. API = 1 # Attribute can be linked to an API version. VERSION = 2 # Attribute can be linked to a Spec. SPEC = 3 # Attribute can be linked to an API Operation. API_OPERATION = 4 # Attribute can be linked to a Deployment. DEPLOYMENT = 5 # Attribute can be linked to a Dependency. DEPENDENCY = 6 # Attribute can be linked to a definition. DEFINITION = 7 # Attribute can be linked to a ExternalAPI. EXTERNAL_API = 8 # Attribute can be linked to a Plugin. PLUGIN = 9 end # Enumeration of attribute's data type. module DataType # Attribute data type unspecified. DATA_TYPE_UNSPECIFIED = 0 # Attribute's value is of type enum. ENUM = 1 # Attribute's value is of type json. JSON = 2 # Attribute's value is of type string. STRING = 3 end end |
#update_time ⇒ ::Google::Protobuf::Timestamp (readonly)
Returns Output only. The time at which the attribute was last updated.
571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 |
# File 'proto_docs/google/cloud/apihub/v1/common_fields.rb', line 571 class Attribute include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # The value that can be assigned to the attribute when the data type is # enum. # @!attribute [rw] id # @return [::String] # Required. The ID of the allowed value. # * If provided, the same will be used. The service will throw an error if # the specified id is already used by another allowed value in the same # attribute resource. # * If not provided, a system generated id derived from the display name # will be used. In this case, the service will handle conflict resolution # by adding a system generated suffix in case of duplicates. # # This value should be 4-63 characters, and valid characters # are /[a-z][0-9]-/. # @!attribute [rw] display_name # @return [::String] # Required. The display name of the allowed value. # @!attribute [rw] description # @return [::String] # Optional. The detailed description of the allowed value. # @!attribute [rw] immutable # @return [::Boolean] # Optional. When set to true, the allowed value cannot be updated or # deleted by the user. It can only be true for System defined attributes. class AllowedValue include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Enumeration of attribute definition types. module DefinitionType # Attribute definition type unspecified. DEFINITION_TYPE_UNSPECIFIED = 0 # The attribute is predefined by the API Hub. Note that only the list of # allowed values can be updated in this case via UpdateAttribute method. SYSTEM_DEFINED = 1 # The attribute is defined by the user. USER_DEFINED = 2 end # Enumeration for the scope of the attribute representing the resource in the # API Hub to which the attribute can be linked. module Scope # Scope Unspecified. SCOPE_UNSPECIFIED = 0 # Attribute can be linked to an API. API = 1 # Attribute can be linked to an API version. VERSION = 2 # Attribute can be linked to a Spec. SPEC = 3 # Attribute can be linked to an API Operation. API_OPERATION = 4 # Attribute can be linked to a Deployment. DEPLOYMENT = 5 # Attribute can be linked to a Dependency. DEPENDENCY = 6 # Attribute can be linked to a definition. DEFINITION = 7 # Attribute can be linked to a ExternalAPI. EXTERNAL_API = 8 # Attribute can be linked to a Plugin. PLUGIN = 9 end # Enumeration of attribute's data type. module DataType # Attribute data type unspecified. DATA_TYPE_UNSPECIFIED = 0 # Attribute's value is of type enum. ENUM = 1 # Attribute's value is of type json. JSON = 2 # Attribute's value is of type string. STRING = 3 end end |