Class: Google::Cloud::ApiGateway::V1::Api

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/cloud/apigateway/v1/apigateway.rb

Overview

An API that can be served by one or more Gateways.

Defined Under Namespace

Modules: State Classes: LabelsEntry

Instance Attribute Summary collapse

Instance Attribute Details

#create_time ⇒ ::Google::Protobuf::Timestamp (readonly)

Returns Output only. Created time.

Returns:



52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
 
# File 'proto_docs/google/cloud/apigateway/v1/apigateway.rb', line 52

class Api
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # All the possible API states.
  module State
    # API does not have a state yet.
    STATE_UNSPECIFIED = 0

    # API is being created.
    CREATING = 1

    # API is active.
    ACTIVE = 2

    # API creation failed.
    FAILED = 3

    # API is being deleted.
    DELETING = 4

    # API is being updated.
    UPDATING = 5
  end
end

#display_name ⇒ ::String

Returns Optional. Display name.

Returns:

  • (::String) —

    Optional. Display name.



52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
 
# File 'proto_docs/google/cloud/apigateway/v1/apigateway.rb', line 52

class Api
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # All the possible API states.
  module State
    # API does not have a state yet.
    STATE_UNSPECIFIED = 0

    # API is being created.
    CREATING = 1

    # API is active.
    ACTIVE = 2

    # API creation failed.
    FAILED = 3

    # API is being deleted.
    DELETING = 4

    # API is being updated.
    UPDATING = 5
  end
end

#labels ⇒ ::Google::Protobuf::Map{::String => ::String}

Returns Optional. Resource labels to represent user-provided metadata. Refer to cloud documentation on labels for more details. https://cloud.google.com/compute/docs/labeling-resources.

Returns:



52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
 
# File 'proto_docs/google/cloud/apigateway/v1/apigateway.rb', line 52

class Api
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # All the possible API states.
  module State
    # API does not have a state yet.
    STATE_UNSPECIFIED = 0

    # API is being created.
    CREATING = 1

    # API is active.
    ACTIVE = 2

    # API creation failed.
    FAILED = 3

    # API is being deleted.
    DELETING = 4

    # API is being updated.
    UPDATING = 5
  end
end

#managed_service ⇒ ::String

Returns Optional. Immutable. The name of a Google Managed Service ( https://cloud.google.com/service-infrastructure/docs/glossary#managed). If not specified, a new Service will automatically be created in the same project as this API.

Returns:



52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
 
# File 'proto_docs/google/cloud/apigateway/v1/apigateway.rb', line 52

class Api
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # All the possible API states.
  module State
    # API does not have a state yet.
    STATE_UNSPECIFIED = 0

    # API is being created.
    CREATING = 1

    # API is active.
    ACTIVE = 2

    # API creation failed.
    FAILED = 3

    # API is being deleted.
    DELETING = 4

    # API is being updated.
    UPDATING = 5
  end
end

#name ⇒ ::String (readonly)

Returns Output only. Resource name of the API. Format: projects/{project}/locations/global/apis/{api}.

Returns:

  • (::String) —

    Output only. Resource name of the API. Format: projects/{project}/locations/global/apis/{api}



52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
 
# File 'proto_docs/google/cloud/apigateway/v1/apigateway.rb', line 52

class Api
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # All the possible API states.
  module State
    # API does not have a state yet.
    STATE_UNSPECIFIED = 0

    # API is being created.
    CREATING = 1

    # API is active.
    ACTIVE = 2

    # API creation failed.
    FAILED = 3

    # API is being deleted.
    DELETING = 4

    # API is being updated.
    UPDATING = 5
  end
end

#state ⇒ ::Google::Cloud::ApiGateway::V1::Api::State (readonly)

Returns Output only. State of the API.

Returns:



52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
 
# File 'proto_docs/google/cloud/apigateway/v1/apigateway.rb', line 52

class Api
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # All the possible API states.
  module State
    # API does not have a state yet.
    STATE_UNSPECIFIED = 0

    # API is being created.
    CREATING = 1

    # API is active.
    ACTIVE = 2

    # API creation failed.
    FAILED = 3

    # API is being deleted.
    DELETING = 4

    # API is being updated.
    UPDATING = 5
  end
end

#update_time ⇒ ::Google::Protobuf::Timestamp (readonly)

Returns Output only. Updated time.

Returns:



52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
 
# File 'proto_docs/google/cloud/apigateway/v1/apigateway.rb', line 52

class Api
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # All the possible API states.
  module State
    # API does not have a state yet.
    STATE_UNSPECIFIED = 0

    # API is being created.
    CREATING = 1

    # API is active.
    ACTIVE = 2

    # API creation failed.
    FAILED = 3

    # API is being deleted.
    DELETING = 4

    # API is being updated.
    UPDATING = 5
  end
end