Class: Google::Apis::ApigeeV1::GoogleCloudApigeeV1ApiProxyRevision

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/apigee_v1/classes.rb,
lib/google/apis/apigee_v1/representations.rb,
lib/google/apis/apigee_v1/representations.rb

Overview

API proxy revision.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudApigeeV1ApiProxyRevision

Returns a new instance of GoogleCloudApigeeV1ApiProxyRevision.



966
967
968
# File 'lib/google/apis/apigee_v1/classes.rb', line 966

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#archiveString

Output only. The archive that generated this proxy revision. This field is only present on proxy revisions that were generated by an archive. Proxies generated by archives cannot be updated, deleted, or deployed to other environments. Format: organizations/*/environments/*/archiveDeployments/* Corresponds to the JSON property archive

Returns:

  • (String)


827
828
829
# File 'lib/google/apis/apigee_v1/classes.rb', line 827

def archive
  @archive
end

#basepathsArray<String>

Base URL of the API proxy. Corresponds to the JSON property basepaths

Returns:

  • (Array<String>)


832
833
834
# File 'lib/google/apis/apigee_v1/classes.rb', line 832

def basepaths
  @basepaths
end

#configuration_versionGoogle::Apis::ApigeeV1::GoogleCloudApigeeV1ConfigVersion

Version of the API proxy configuration schema. Currently, only 4.0 is supported. Corresponds to the JSON property configurationVersion



838
839
840
# File 'lib/google/apis/apigee_v1/classes.rb', line 838

def configuration_version
  @configuration_version
end

#context_infoString

Revision number, app name, and organization for the API proxy. Corresponds to the JSON property contextInfo

Returns:

  • (String)


843
844
845
# File 'lib/google/apis/apigee_v1/classes.rb', line 843

def context_info
  @context_info
end

#created_atFixnum

Time that the API proxy revision was created in milliseconds since epoch. Corresponds to the JSON property createdAt

Returns:

  • (Fixnum)


848
849
850
# File 'lib/google/apis/apigee_v1/classes.rb', line 848

def created_at
  @created_at
end

#descriptionString

Description of the API proxy revision. Corresponds to the JSON property description

Returns:

  • (String)


853
854
855
# File 'lib/google/apis/apigee_v1/classes.rb', line 853

def description
  @description
end

#display_nameString

Human-readable name of the API proxy. Corresponds to the JSON property displayName

Returns:

  • (String)


858
859
860
# File 'lib/google/apis/apigee_v1/classes.rb', line 858

def display_name
  @display_name
end

#entity_meta_data_as_propertiesHash<String,String>

Metadata describing the API proxy revision as a key-value map. Corresponds to the JSON property entityMetaDataAsProperties

Returns:

  • (Hash<String,String>)


863
864
865
# File 'lib/google/apis/apigee_v1/classes.rb', line 863

def 
  @entity_meta_data_as_properties
end

#has_extensible_policyBoolean Also known as: has_extensible_policy?

Output only. This field will be marked as true if revision contains any policies marked as extensible. Corresponds to the JSON property hasExtensiblePolicy

Returns:

  • (Boolean)


869
870
871
# File 'lib/google/apis/apigee_v1/classes.rb', line 869

def has_extensible_policy
  @has_extensible_policy
end

#integration_endpointsArray<String>

List of IntegrationEndpoints in the '/integration-endpoints' directory of the API proxy. This is a 'manifest' setting designed to provide visibility into the contents of the API proxy. Corresponds to the JSON property integrationEndpoints

Returns:

  • (Array<String>)


877
878
879
# File 'lib/google/apis/apigee_v1/classes.rb', line 877

def integration_endpoints
  @integration_endpoints
end

#last_modified_atFixnum

Time that the API proxy revision was last modified in milliseconds since epoch. Corresponds to the JSON property lastModifiedAt

Returns:

  • (Fixnum)


882
883
884
# File 'lib/google/apis/apigee_v1/classes.rb', line 882

def last_modified_at
  @last_modified_at
end

#nameString

Name of the API proxy. Corresponds to the JSON property name

Returns:

  • (String)


887
888
889
# File 'lib/google/apis/apigee_v1/classes.rb', line 887

def name
  @name
end

#policiesArray<String>

List of policy names included in the API proxy revision.. Corresponds to the JSON property policies

Returns:

  • (Array<String>)


892
893
894
# File 'lib/google/apis/apigee_v1/classes.rb', line 892

def policies
  @policies
end

#proxiesArray<String>

List of proxy names included in the API proxy revision. Corresponds to the JSON property proxies

Returns:

  • (Array<String>)


897
898
899
# File 'lib/google/apis/apigee_v1/classes.rb', line 897

def proxies
  @proxies
end

#proxy_endpointsArray<String>

List of ProxyEndpoints in the /proxies directory of the API proxy. Typically, this element is included only when the API proxy was created using the Edge UI. This is a 'manifest' setting designed to provide visibility into the contents of the API proxy. Corresponds to the JSON property proxyEndpoints

Returns:

  • (Array<String>)


905
906
907
# File 'lib/google/apis/apigee_v1/classes.rb', line 905

def proxy_endpoints
  @proxy_endpoints
end

#resource_filesGoogle::Apis::ApigeeV1::GoogleCloudApigeeV1ResourceFiles

List of resource files. Corresponds to the JSON property resourceFiles



910
911
912
# File 'lib/google/apis/apigee_v1/classes.rb', line 910

def resource_files
  @resource_files
end

#resourcesArray<String>

List of the resources included in the API proxy revision formatted as "type:/ /name". Corresponds to the JSON property resources

Returns:

  • (Array<String>)


916
917
918
# File 'lib/google/apis/apigee_v1/classes.rb', line 916

def resources
  @resources
end

#revisionString

API proxy revision. Corresponds to the JSON property revision

Returns:

  • (String)


921
922
923
# File 'lib/google/apis/apigee_v1/classes.rb', line 921

def revision
  @revision
end

#shared_flowsArray<String>

List of the shared flows included in the API proxy revision. Corresponds to the JSON property sharedFlows

Returns:

  • (Array<String>)


926
927
928
# File 'lib/google/apis/apigee_v1/classes.rb', line 926

def shared_flows
  @shared_flows
end

#specString

OpenAPI Specification that is associated with the API proxy. The value is set to a URL or to a path in the specification store. Corresponds to the JSON property spec

Returns:

  • (String)


932
933
934
# File 'lib/google/apis/apigee_v1/classes.rb', line 932

def spec
  @spec
end

#target_endpointsArray<String>

List of TargetEndpoints in the /targets directory of the API proxy. Typically, this element is included only when the API proxy was created using the Edge UI. This is a 'manifest' setting designed to provide visibility into the contents of the API proxy. Corresponds to the JSON property targetEndpoints

Returns:

  • (Array<String>)


940
941
942
# File 'lib/google/apis/apigee_v1/classes.rb', line 940

def target_endpoints
  @target_endpoints
end

#target_serversArray<String>

List of TargetServers referenced in any TargetEndpoint in the API proxy. Typically, you will see this element only when the API proxy was created using the Edge UI. This is a 'manifest' setting designed to provide visibility into the contents of the API proxy. Corresponds to the JSON property targetServers

Returns:

  • (Array<String>)


948
949
950
# File 'lib/google/apis/apigee_v1/classes.rb', line 948

def target_servers
  @target_servers
end

#targetsArray<String>

List of the targets included in the API proxy revision. Corresponds to the JSON property targets

Returns:

  • (Array<String>)


953
954
955
# File 'lib/google/apis/apigee_v1/classes.rb', line 953

def targets
  @targets
end

#teamsArray<String>

List of the teams included in the API proxy revision. Corresponds to the JSON property teams

Returns:

  • (Array<String>)


958
959
960
# File 'lib/google/apis/apigee_v1/classes.rb', line 958

def teams
  @teams
end

#typeString

Type. Set to Application. Maintained for compatibility with the Apigee Edge API. Corresponds to the JSON property type

Returns:

  • (String)


964
965
966
# File 'lib/google/apis/apigee_v1/classes.rb', line 964

def type
  @type
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
# File 'lib/google/apis/apigee_v1/classes.rb', line 971

def update!(**args)
  @archive = args[:archive] if args.key?(:archive)
  @basepaths = args[:basepaths] if args.key?(:basepaths)
  @configuration_version = args[:configuration_version] if args.key?(:configuration_version)
  @context_info = args[:context_info] if args.key?(:context_info)
  @created_at = args[:created_at] if args.key?(:created_at)
  @description = args[:description] if args.key?(:description)
  @display_name = args[:display_name] if args.key?(:display_name)
  @entity_meta_data_as_properties = args[:entity_meta_data_as_properties] if args.key?(:entity_meta_data_as_properties)
  @has_extensible_policy = args[:has_extensible_policy] if args.key?(:has_extensible_policy)
  @integration_endpoints = args[:integration_endpoints] if args.key?(:integration_endpoints)
  @last_modified_at = args[:last_modified_at] if args.key?(:last_modified_at)
  @name = args[:name] if args.key?(:name)
  @policies = args[:policies] if args.key?(:policies)
  @proxies = args[:proxies] if args.key?(:proxies)
  @proxy_endpoints = args[:proxy_endpoints] if args.key?(:proxy_endpoints)
  @resource_files = args[:resource_files] if args.key?(:resource_files)
  @resources = args[:resources] if args.key?(:resources)
  @revision = args[:revision] if args.key?(:revision)
  @shared_flows = args[:shared_flows] if args.key?(:shared_flows)
  @spec = args[:spec] if args.key?(:spec)
  @target_endpoints = args[:target_endpoints] if args.key?(:target_endpoints)
  @target_servers = args[:target_servers] if args.key?(:target_servers)
  @targets = args[:targets] if args.key?(:targets)
  @teams = args[:teams] if args.key?(:teams)
  @type = args[:type] if args.key?(:type)
end